domain apis (#146)

* fix: create domain api

* add domain apis

* fix url

---------

Co-authored-by: harshsbhat <harsh121102@gmail.com>
This commit is contained in:
KM Koushik
2025-04-05 06:48:03 +11:00
committed by GitHub
parent 43600419cb
commit 70026cb11d
11 changed files with 415 additions and 12 deletions

View File

@@ -1,6 +1,6 @@
{
"name": "unsend",
"version": "1.4.0",
"version": "1.4.1",
"description": "",
"main": "./dist/index.js",
"module": "./dist/index.mjs",

View File

@@ -0,0 +1,57 @@
import { paths } from "../types/schema";
import { ErrorResponse } from "../types";
import { Unsend } from "./unsend";
type CreateDomainPayload =
paths["/v1/domains"]["post"]["requestBody"]["content"]["application/json"];
type CreateDomainResponse = {
data: CreateDomainResponseSuccess | null;
error: ErrorResponse | null;
};
type CreateDomainResponseSuccess =
paths["/v1/domains"]["post"]["responses"]["200"]["content"]["application/json"];
type GetDomainsResponse = {
data: GetDomainsResponseSuccess | null;
error: ErrorResponse | null;
};
type GetDomainsResponseSuccess =
paths["/v1/domains"]["get"]["responses"]["200"]["content"]["application/json"];
type VerifyDomainResponse = {
data: VerifyDomainResponseSuccess | null;
error: ErrorResponse | null;
};
type VerifyDomainResponseSuccess =
paths["/v1/domains/{id}/verify"]["put"]["responses"]["200"]["content"]["application/json"];
export class Domains {
constructor(private readonly unsend: Unsend) {
this.unsend = unsend;
}
async list(): Promise<GetDomainsResponse> {
const data = await this.unsend.get<GetDomainsResponseSuccess>("/domains");
return data;
}
async create(payload: CreateDomainPayload): Promise<CreateDomainResponse> {
const data = await this.unsend.post<CreateDomainResponseSuccess>(
"/domains",
payload
);
return data;
}
async verify(id: number): Promise<VerifyDomainResponse> {
const data = await this.unsend.put<VerifyDomainResponseSuccess>(
`/domains/${id}/verify`,
{}
);
return data;
}
}

View File

@@ -40,11 +40,89 @@ export interface paths {
spfDetails?: string | null;
createdAt: string;
updatedAt: string;
/** @default false */
dmarcAdded?: boolean;
/** @default false */
isVerifying?: boolean;
errorMessage?: string | null;
subdomain?: string | null;
})[];
};
};
};
};
post: {
requestBody: {
content: {
"application/json": {
name: string;
region: string;
};
};
};
responses: {
/** @description Create a new domain */
200: {
content: {
"application/json": {
/**
* @description The ID of the domain
* @example 1
*/
id: number;
/**
* @description The name of the domain
* @example example.com
*/
name: string;
/**
* @description The ID of the team
* @example 1
*/
teamId: number;
/** @enum {string} */
status: "NOT_STARTED" | "PENDING" | "SUCCESS" | "FAILED" | "TEMPORARY_FAILURE";
/** @default us-east-1 */
region?: string;
/** @default false */
clickTracking?: boolean;
/** @default false */
openTracking?: boolean;
publicKey: string;
dkimStatus?: string | null;
spfDetails?: string | null;
createdAt: string;
updatedAt: string;
/** @default false */
dmarcAdded?: boolean;
/** @default false */
isVerifying?: boolean;
errorMessage?: string | null;
subdomain?: string | null;
};
};
};
};
};
};
"/v1/domains/{id}/verify": {
put: {
parameters: {
path: {
id: number;
};
};
responses: {
/** @description Create a new domain */
200: {
content: {
"application/json": {
message: string;
};
};
};
};
};
};
"/v1/emails/{emailId}": {
get: {