gib/GibSend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs and sdk for schedule

Browse Source
This commit is contained in:
KMKoushik
2024-08-21 18:32:56 +10:00
parent 9b54fc1793
commit 0df42698d0
6 changed files with 186 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
apps/docs/api-reference/emails/cancel-schedule.mdx Normal file
View File

@@ -0,0 +1,3 @@
---
openapi: post /v1/emails/{emailId}/cancel
---

3
apps/docs/api-reference/emails/update-schedule.mdx Normal file
View File

@@ -0,0 +1,3 @@
---
openapi: patch /v1/emails/{emailId}
---

91
apps/docs/api-reference/openapi.json
View File

@@ -215,6 +215,7 @@
"status": {
"type": "string",
"enum": [
"SCHEDULED",
"QUEUED",
"SENT",
"DELIVERY_DELAYED",
@@ -225,7 +226,8 @@
"OPENED",
"CLICKED",
"COMPLAINED",
"FAILED"
"FAILED",
"CANCELLED"
]
},
"createdAt": {
@@ -260,6 +262,56 @@
}
}
}
},
"patch": {
"parameters": [
{
"schema": {
"type": "string",
"minLength": 3,
"example": "cuiwqdj74rygf74"
},
"required": true,
"name": "emailId",
"in": "path"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scheduledAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"scheduledAt"
]
}
}
}
},
"responses": {
"200": {
"description": "Retrieve the user",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"emailId": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/v1/emails": {
@@ -352,6 +404,10 @@
"content"
]
}
},
"scheduledAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
@@ -382,6 +438,39 @@
}
}
},
"/v1/emails/{emailId}/cancel": {
"post": {
"parameters": [
{
"schema": {
"type": "string",
"minLength": 3,
"example": "cuiwqdj74rygf74"
},
"required": true,
"name": "emailId",
"in": "path"
}
],
"responses": {
"200": {
"description": "Retrieve the user",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"emailId": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/v1/contactBooks/{contactBookId}/contacts": {
"post": {
"parameters": [

4
apps/docs/mint.json
View File

@@ -70,7 +70,9 @@
"group": "Emails",
"pages": [
"api-reference/emails/get-email",
"api-reference/emails/send-email"
"api-reference/emails/send-email",
"api-reference/emails/update-schedule",
"api-reference/emails/cancel-schedule"
]
},
{

40
packages/sdk/src/email.ts
View File

@@ -25,6 +25,27 @@ type GetEmailResponse = {
error: ErrorResponse | null;
};
type UpdateEmailPayload =
paths["/v1/emails/{emailId}"]["patch"]["requestBody"]["content"]["application/json"] & {
react?: React.ReactElement;
};
type UpdateEmailResponse = {
data: UpdateEmailResponseSuccess | null;
error: ErrorResponse | null;
};
type UpdateEmailResponseSuccess =
paths["/v1/emails/{emailId}"]["patch"]["responses"]["200"]["content"]["application/json"];
type CancelEmailResponse = {
data: CancelEmailResponseSuccess | null;
error: ErrorResponse | null;
};
type CancelEmailResponseSuccess =
paths["/v1/emails/{emailId}/cancel"]["post"]["responses"]["200"]["content"]["application/json"];
export class Emails {
constructor(private readonly unsend: Unsend) {
this.unsend = unsend;
@@ -54,4 +75,23 @@ export class Emails {
);
return data;
}
async update(
id: string,
payload: UpdateEmailPayload
): Promise<UpdateEmailResponse> {
const data = await this.unsend.patch<UpdateEmailResponseSuccess>(
`/emails/${id}`,
payload
);
return data;
}
async cancel(id: string): Promise<CancelEmailResponse> {
const data = await this.unsend.post<CancelEmailResponseSuccess>(
`/emails/${id}/cancel`,
{}
);
return data;
}
}

48
packages/sdk/types/schema.d.ts vendored
View File

@@ -73,7 +73,7 @@ export interface paths {
emailEvents: ({
emailId: string;
/** @enum {string} */
status: "QUEUED" | "SENT" | "DELIVERY_DELAYED" | "BOUNCED" | "REJECTED" | "RENDERING_FAILURE" | "DELIVERED" | "OPENED" | "CLICKED" | "COMPLAINED" | "FAILED";
status: "SCHEDULED" | "QUEUED" | "SENT" | "DELIVERY_DELAYED" | "BOUNCED" | "REJECTED" | "RENDERING_FAILURE" | "DELIVERED" | "OPENED" | "CLICKED" | "COMPLAINED" | "FAILED" | "CANCELLED";
createdAt: string;
data?: unknown;
})[];
@@ -82,6 +82,31 @@ export interface paths {
};
};
};
patch: {
parameters: {
path: {
emailId: string;
};
};
requestBody: {
content: {
"application/json": {
/** Format: date-time */
scheduledAt: string;
};
};
};
responses: {
/** @description Retrieve the user */
200: {
content: {
"application/json": {
emailId?: string;
};
};
};
};
};
};
"/v1/emails": {
post: {
@@ -100,6 +125,8 @@ export interface paths {
filename: string;
content: string;
}[];
/** Format: date-time */
scheduledAt?: string;
};
};
};
@@ -115,6 +142,25 @@ export interface paths {
};
};
};
"/v1/emails/{emailId}/cancel": {
post: {
parameters: {
path: {
emailId: string;
};
};
responses: {
/** @description Retrieve the user */
200: {
content: {
"application/json": {
emailId?: string;
};
};
};
};
};
};
"/v1/contactBooks/{contactBookId}/contacts": {
post: {
parameters: {