feat: return response headers on all responses

src/api-keys/api-keys.spec.ts

@@ -39,14 +39,18 @@ describe('API Keys', () => {
       await expect(
         resend.apiKeys.create(payload),
       ).resolves.toMatchInlineSnapshot(`
-{
-  "data": {
-    "id": "430eed87-632a-4ea6-90db-0aace67ec228",
-    "token": "re_PKr4RCko_Lhm9ost2YjNCctnPjbLw8Nqk",
-  },
-  "error": null,
-}
-`);
+        {
+          "data": {
+            "id": "430eed87-632a-4ea6-90db-0aace67ec228",
+            "token": "re_PKr4RCko_Lhm9ost2YjNCctnPjbLw8Nqk",
+          },
+          "error": null,
+          "headers": {
+            "authorization": "Bearer re_924b3rjh2387fbewf823",
+            "content-type": "application/json",
+          },
+        }
+      `);
     });
 
     it('throws error when missing name', async () => {
@@ -71,14 +75,18 @@ describe('API Keys', () => {
       const result = resend.apiKeys.create(payload);
 
       await expect(result).resolves.toMatchInlineSnapshot(`
-{
-  "data": null,
-  "error": {
-    "message": "String must contain at least 1 character(s)",
-    "name": "validation_error",
-  },
-}
-`);
+        {
+          "data": null,
+          "error": {
+            "message": "String must contain at least 1 character(s)",
+            "name": "validation_error",
+          },
+          "headers": {
+            "authorization": "Bearer re_924b3rjh2387fbewf823",
+            "content-type": "application/json",
+          },
+        }
+      `);
     });
 
     describe('with access', () => {
@@ -106,14 +114,18 @@ describe('API Keys', () => {
         await expect(
           resend.apiKeys.create(payload),
         ).resolves.toMatchInlineSnapshot(`
-{
-  "data": {
-    "id": "430eed87-632a-4ea6-90db-0aace67ec228",
-    "token": "re_PKr4RCko_Lhm9ost2YjNCctnPjbLw8Nqk",
-  },
-  "error": null,
-}
-`);
+          {
+            "data": {
+              "id": "430eed87-632a-4ea6-90db-0aace67ec228",
+              "token": "re_PKr4RCko_Lhm9ost2YjNCctnPjbLw8Nqk",
+            },
+            "error": null,
+            "headers": {
+              "authorization": "Bearer re_924b3rjh2387fbewf823",
+              "content-type": "application/json",
+            },
+          }
+        `);
       });
 
       it('creates api key with access `sending_access`', async () => {
@@ -139,14 +151,18 @@ describe('API Keys', () => {
         await expect(
           resend.apiKeys.create(payload),
         ).resolves.toMatchInlineSnapshot(`
-{
-  "data": {
-    "id": "430eed87-632a-4ea6-90db-0aace67ec228",
-    "token": "re_PKr4RCko_Lhm9ost2YjNCctnPjbLw8Nqk",
-  },
-  "error": null,
-}
-`);
+          {
+            "data": {
+              "id": "430eed87-632a-4ea6-90db-0aace67ec228",
+              "token": "re_PKr4RCko_Lhm9ost2YjNCctnPjbLw8Nqk",
+            },
+            "error": null,
+            "headers": {
+              "authorization": "Bearer re_924b3rjh2387fbewf823",
+              "content-type": "application/json",
+            },
+          }
+        `);
       });
 
       it('throws error with wrong access', async () => {
@@ -173,14 +189,18 @@ describe('API Keys', () => {
         await expect(
           resend.apiKeys.create(payload),
         ).resolves.toMatchInlineSnapshot(`
-{
-  "data": null,
-  "error": {
-    "message": "Access must be "full_access" | "sending_access"",
-    "name": "invalid_access",
-  },
-}
-`);
+          {
+            "data": null,
+            "error": {
+              "message": "Access must be "full_access" | "sending_access"",
+              "name": "invalid_access",
+            },
+            "headers": {
+              "authorization": "Bearer re_924b3rjh2387fbewf823",
+              "content-type": "application/json",
+            },
+          }
+        `);
       });
     });
 
@@ -281,7 +301,9 @@ describe('API Keys', () => {
     describe('when no pagination options are provided', () => {
       it('lists api keys', async () => {
         mockSuccessResponse(response, {
-          headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
+          headers: {
+            Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+          },
         });
 
         const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
@@ -290,6 +312,10 @@ describe('API Keys', () => {
         expect(result).toEqual({
           data: response,
           error: null,
+          headers: {
+            authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+            'content-type': 'application/json',
+          },
         });
 
         expect(fetchMock).toHaveBeenCalledWith(
@@ -305,14 +331,20 @@ describe('API Keys', () => {
     describe('when pagination options are provided', () => {
       it('passes limit param and returns a response', async () => {
         mockSuccessResponse(response, {
-          headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
+          headers: {
+            Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+          },
         });
 
         const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
         const result = await resend.apiKeys.list({ limit: 1 });
         expect(result).toEqual({
           data: response,
           error: null,
+          headers: {
+            authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+            'content-type': 'application/json',
+          },
         });
 
         expect(fetchMock).toHaveBeenCalledWith(
@@ -326,7 +358,9 @@ describe('API Keys', () => {
 
       it('passes after param and returns a response', async () => {
         mockSuccessResponse(response, {
-          headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
+          headers: {
+            Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+          },
         });
 
         const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
@@ -337,6 +371,10 @@ describe('API Keys', () => {
         expect(result).toEqual({
           data: response,
           error: null,
+          headers: {
+            authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+            'content-type': 'application/json',
+          },
         });
 
         expect(fetchMock).toHaveBeenCalledWith(
@@ -350,7 +388,9 @@ describe('API Keys', () => {
 
       it('passes before param and returns a response', async () => {
         mockSuccessResponse(response, {
-          headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
+          headers: {
+            Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+          },
         });
 
         const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
@@ -361,6 +401,10 @@ describe('API Keys', () => {
         expect(result).toEqual({
           data: response,
           error: null,
+          headers: {
+            authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+            'content-type': 'application/json',
+          },
         });
 
         expect(fetchMock).toHaveBeenCalledWith(
@@ -390,11 +434,15 @@ describe('API Keys', () => {
       const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
 
       await expect(resend.apiKeys.remove(id)).resolves.toMatchInlineSnapshot(`
-{
-  "data": {},
-  "error": null,
-}
-`);
+        {
+          "data": {},
+          "error": null,
+          "headers": {
+            "authorization": "Bearer re_924b3rjh2387fbewf823",
+            "content-type": "application/json",
+          },
+        }
+      `);
     });
 
     it('throws error when missing id', async () => {
@@ -416,14 +464,18 @@ describe('API Keys', () => {
       const result = resend.apiKeys.remove('');
 
       await expect(result).resolves.toMatchInlineSnapshot(`
-{
-  "data": null,
-  "error": {
-    "message": "Something went wrong",
-    "name": "application_error",
-  },
-}
-`);
+        {
+          "data": null,
+          "error": {
+            "message": "Something went wrong",
+            "name": "application_error",
+          },
+          "headers": {
+            "authorization": "Bearer re_924b3rjh2387fbewf823",
+            "content-type": "application/json",
+          },
+        }
+      `);
     });
 
     it('throws error when wrong id', async () => {
@@ -447,14 +499,18 @@ describe('API Keys', () => {
       );
 
       await expect(result).resolves.toMatchInlineSnapshot(`
-{
-  "data": null,
-  "error": {
-    "message": "API key not found",
-    "name": "not_found",
-  },
-}
-`);
+        {
+          "data": null,
+          "error": {
+            "message": "API key not found",
+            "name": "not_found",
+          },
+          "headers": {
+            "authorization": "Bearer re_924b3rjh2387fbewf823",
+            "content-type": "application/json",
+          },
+        }
+      `);
     });
   });
 });

src/api-keys/interfaces/create-api-key-options.interface.ts

@@ -1,5 +1,5 @@
 import type { PostOptions } from '../../common/interfaces';
-import type { ErrorResponse } from '../../interfaces';
+import type { Response } from '../../interfaces';
 
 export interface CreateApiKeyOptions {
   name: string;
@@ -14,12 +14,4 @@ export interface CreateApiKeyResponseSuccess {
   id: string;
 }
 
-export type CreateApiKeyResponse =
-  | {
-      data: CreateApiKeyResponseSuccess;
-      error: null;
-    }
-  | {
-      data: null;
-      error: ErrorResponse;
-    };
+export type CreateApiKeyResponse = Response<CreateApiKeyResponseSuccess>;

src/api-keys/interfaces/list-api-keys.interface.ts

@@ -1,5 +1,5 @@
 import type { PaginationOptions } from '../../common/interfaces';
-import type { ErrorResponse } from '../../interfaces';
+import type { Response } from '../../interfaces';
 import type { ApiKey } from './api-key';
 
 export type ListApiKeysOptions = PaginationOptions;
@@ -10,12 +10,4 @@ export type ListApiKeysResponseSuccess = {
   data: Pick<ApiKey, 'name' | 'id' | 'created_at'>[];
 };
 
-export type ListApiKeysResponse =
-  | {
-      data: ListApiKeysResponseSuccess;
-      error: null;
-    }
-  | {
-      data: null;
-      error: ErrorResponse;
-    };
+export type ListApiKeysResponse = Response<ListApiKeysResponseSuccess>;

src/api-keys/interfaces/remove-api-keys.interface.ts

@@ -1,14 +1,6 @@
-import type { ErrorResponse } from '../../interfaces';
+import type { Response } from '../../interfaces';
 
 // biome-ignore lint/complexity/noBannedTypes: allow empty types
 export type RemoveApiKeyResponseSuccess = {};
 
-export type RemoveApiKeyResponse =
-  | {
-      data: RemoveApiKeyResponseSuccess;
-      error: null;
-    }
-  | {
-      data: null;
-      error: ErrorResponse;
-    };
+export type RemoveApiKeyResponse = Response<RemoveApiKeyResponseSuccess>;