feat: add inbound listing method (#668)

Author: lucasfcosta

src/emails/receiving/interfaces/index.ts

@@ -1 +1,2 @@
 export * from './get-inbound-email.interface';
+export * from './list-inbound-emails.interface';

src/emails/receiving/interfaces/list-inbound-emails.interface.ts

@@ -0,0 +1,26 @@
+import type { PaginationOptions } from '../../../common/interfaces';
+import type { ErrorResponse } from '../../../interfaces';
+import type { GetInboundEmailResponseSuccess } from './get-inbound-email.interface';
+
+export type ListInboundEmailsOptions = PaginationOptions;
+
+export type ListInboundEmail = Omit<
+  GetInboundEmailResponseSuccess,
+  'html' | 'text' | 'headers' | 'object'
+>;
+
+export interface ListInboundEmailsResponseSuccess {
+  object: 'list';
+  has_more: boolean;
+  data: ListInboundEmail[];
+}
+
+export type ListInboundEmailsResponse =
+  | {
+      data: ListInboundEmailsResponseSuccess;
+      error: null;
+    }
+  | {
+      data: null;
+      error: ErrorResponse;
+    };

src/emails/receiving/receiving.spec.ts

@@ -11,7 +11,7 @@ describe('Receiving', () => {
       it('returns error', async () => {
         const response: ErrorResponse = {
           name: 'not_found',
-          message: 'Inbound email not found',
+          message: 'Email not found',
         };
 
         fetchMock.mockOnce(JSON.stringify(response), {
@@ -30,7 +30,7 @@ describe('Receiving', () => {
 {
   "data": null,
   "error": {
-    "message": "Inbound email not found",
+    "message": "Email not found",
     "name": "not_found",
   },
 }
@@ -170,4 +170,220 @@ describe('Receiving', () => {
       });
     });
   });
+
+  describe('list', () => {
+    describe('when no inbound emails found', () => {
+      it('returns empty list', async () => {
+        const response = {
+          object: 'list' as const,
+          has_more: false,
+          data: [],
+        };
+
+        fetchMock.mockOnce(JSON.stringify(response), {
+          status: 200,
+          headers: {
+            'content-type': 'application/json',
+            Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+          },
+        });
+
+        const result = await resend.emails.receiving.list();
+
+        expect(result).toMatchInlineSnapshot(`
+{
+  "data": {
+    "data": [],
+    "has_more": false,
+    "object": "list",
+  },
+  "error": null,
+}
+`);
+      });
+    });
+
+    describe('when inbound emails found', () => {
+      it('returns list of inbound emails with transformed fields', async () => {
+        const apiResponse = {
+          object: 'list' as const,
+          has_more: true,
+          data: [
+            {
+              id: '67d9bcdb-5a02-42d7-8da9-0d6feea18cff',
+              to: ['[email protected]'],
+              from: '[email protected]',
+              created_at: '2023-04-07T23:13:52.669661+00:00',
+              subject: 'Test inbound email 1',
+              bcc: null,
+              cc: ['[email protected]'],
+              reply_to: ['[email protected]'],
+              attachments: [
+                {
+                  id: 'att_123',
+                  filename: 'document.pdf',
+                  content_type: 'application/pdf',
+                  content_id: 'cid_123',
+                  content_disposition: 'attachment' as const,
+                  size: 12345,
+                },
+              ],
+            },
+            {
+              id: '87e9bcdb-6b03-43e8-9ea0-1e7gffa19d00',
+              to: ['[email protected]'],
+              from: '[email protected]',
+              created_at: '2023-04-08T10:20:30.123456+00:00',
+              subject: 'Test inbound email 2',
+              bcc: ['[email protected]'],
+              cc: null,
+              reply_to: null,
+              attachments: [],
+            },
+          ],
+        };
+
+        fetchMock.mockOnce(JSON.stringify(apiResponse), {
+          status: 200,
+          headers: {
+            'content-type': 'application/json',
+            Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+          },
+        });
+
+        const result = await resend.emails.receiving.list();
+
+        expect(result).toMatchInlineSnapshot(`
+{
+  "data": {
+    "data": [
+      {
+        "attachments": [
+          {
+            "content_disposition": "attachment",
+            "content_id": "cid_123",
+            "content_type": "application/pdf",
+            "filename": "document.pdf",
+            "id": "att_123",
+            "size": 12345,
+          },
+        ],
+        "bcc": null,
+        "cc": [
+          "[email protected]",
+        ],
+        "created_at": "2023-04-07T23:13:52.669661+00:00",
+        "from": "[email protected]",
+        "id": "67d9bcdb-5a02-42d7-8da9-0d6feea18cff",
+        "reply_to": [
+          "[email protected]",
+        ],
+        "subject": "Test inbound email 1",
+        "to": [
+          "[email protected]",
+        ],
+      },
+      {
+        "attachments": [],
+        "bcc": [
+          "[email protected]",
+        ],
+        "cc": null,
+        "created_at": "2023-04-08T10:20:30.123456+00:00",
+        "from": "[email protected]",
+        "id": "87e9bcdb-6b03-43e8-9ea0-1e7gffa19d00",
+        "reply_to": null,
+        "subject": "Test inbound email 2",
+        "to": [
+          "[email protected]",
+        ],
+      },
+    ],
+    "has_more": true,
+    "object": "list",
+  },
+  "error": null,
+}
+`);
+      });
+
+      it('supports pagination with limit parameter', async () => {
+        const apiResponse = {
+          object: 'list' as const,
+          has_more: true,
+          data: [
+            {
+              id: '67d9bcdb-5a02-42d7-8da9-0d6feea18cff',
+              to: ['[email protected]'],
+              from: '[email protected]',
+              created_at: '2023-04-07T23:13:52.669661+00:00',
+              subject: 'Test inbound email',
+              bcc: null,
+              cc: null,
+              reply_to: null,
+              attachments: [],
+            },
+          ],
+        };
+
+        fetchMock.mockOnce(JSON.stringify(apiResponse), {
+          status: 200,
+          headers: {
+            'content-type': 'application/json',
+            Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+          },
+        });
+
+        await resend.emails.receiving.list({ limit: 10 });
+
+        expect(fetchMock.mock.calls[0][0]).toBe(
+          'https://api.resend.com/emails/receiving?limit=10',
+        );
+      });
+
+      it('supports pagination with after parameter', async () => {
+        const apiResponse = {
+          object: 'list' as const,
+          has_more: false,
+          data: [],
+        };
+
+        fetchMock.mockOnce(JSON.stringify(apiResponse), {
+          status: 200,
+          headers: {
+            'content-type': 'application/json',
+            Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+          },
+        });
+
+        await resend.emails.receiving.list({ after: 'cursor123' });
+
+        expect(fetchMock.mock.calls[0][0]).toBe(
+          'https://api.resend.com/emails/receiving?after=cursor123',
+        );
+      });
+
+      it('supports pagination with before parameter', async () => {
+        const apiResponse = {
+          object: 'list' as const,
+          has_more: false,
+          data: [],
+        };
+
+        fetchMock.mockOnce(JSON.stringify(apiResponse), {
+          status: 200,
+          headers: {
+            'content-type': 'application/json',
+            Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+          },
+        });
+
+        await resend.emails.receiving.list({ before: 'cursor456' });
+
+        expect(fetchMock.mock.calls[0][0]).toBe(
+          'https://api.resend.com/emails/receiving?before=cursor456',
+        );
+      });
+    });
+  });
 });

src/emails/receiving/receiving.ts

@@ -1,8 +1,14 @@
+import { buildPaginationQuery } from '../../common/utils/build-pagination-query';
 import type { Resend } from '../../resend';
 import type {
   GetInboundEmailResponse,
   GetInboundEmailResponseSuccess,
 } from './interfaces/get-inbound-email.interface';
+import type {
+  ListInboundEmailsOptions,
+  ListInboundEmailsResponse,
+  ListInboundEmailsResponseSuccess,
+} from './interfaces/list-inbound-emails.interface';
 
 export class Receiving {
   constructor(private readonly resend: Resend) {}
@@ -14,4 +20,17 @@ export class Receiving {
 
     return data;
   }
+
+  async list(
+    options: ListInboundEmailsOptions = {},
+  ): Promise<ListInboundEmailsResponse> {
+    const queryString = buildPaginationQuery(options);
+    const url = queryString
+      ? `/emails/receiving?${queryString}`
+      : '/emails/receiving';
+
+    const data = await this.resend.get<ListInboundEmailsResponseSuccess>(url);
+
+    return data;
+  }
 }