fix(domains): fix bulkCreateLoginLinks response types

Yizack · Yizack · commit b61bb654e421 · 2025-09-17T22:55:13.000+02:00
diff --git a/docs/modules/domains.md b/docs/modules/domains.md
@@ -513,7 +513,7 @@ const { results } = await mailchannels.domains.bulkCreateLoginLinks([
   **Bulk Create Login Links type declarations**
 
   <<< @/snippets/domains-bulk-create-login-link-result.ts
-  <<< @/snippets/domains-bulk-create-login-link.ts
+  <<< @/snippets/domains-bulk-create-login-links.ts
   <<< @/snippets/domains-bulk-create-login-links-response.ts
 </details>
 
diff --git a/src/modules/domains.ts b/src/modules/domains.ts
@@ -7,7 +7,7 @@ import type { DomainsBulkProvisionOptions, DomainsBulkProvisionResponse, Domains
 import type { DomainsListOptions, DomainsListResponse } from "../types/domains/list";
 import type { DomainsCreateLoginLinkResponse } from "../types/domains/create-login-link";
 import type { DomainsDownstreamAddress, DomainsListDownstreamAddressesOptions, DomainsListDownstreamAddressesResponse } from "../types/domains/downstream-addresses";
-import type { DomainsBulkCreateLoginLink, DomainsBulkCreateLoginLinksResponse } from "../types/domains/bulk-create-login-links";
+import type { DomainsBulkCreateLoginLinks, DomainsBulkCreateLoginLinksResponse } from "../types/domains/bulk-create-login-links";
 import { ErrorCode, getStatusError } from "../utils/errors";
 
 export class Domains {
@@ -486,7 +486,7 @@ export class Domains {
    * ```
    */
   async bulkCreateLoginLinks (domains: string[]): Promise<DomainsBulkCreateLoginLinksResponse> {
-    const data: DomainsBulkCreateLoginLinksResponse = { results: [], error: null };
+    const data: DomainsBulkCreateLoginLinksResponse = { results: null, error: null };
 
     if (!domains || !domains.length) {
       data.error = "No domains provided.";
@@ -498,7 +498,7 @@ export class Domains {
       return data;
     }
 
-    const response = await this.mailchannels.post<DomainsBulkCreateLoginLink[]>("/inbound/v1/domains/batch/login-link", {
+    const response = await this.mailchannels.post<DomainsBulkCreateLoginLinks>("/inbound/v1/domains/batch/login-link", {
       body: {
         domains: domains.map(domain => ({ domain }))
       },
diff --git a/src/types/domains/bulk-create-login-links.d.ts b/src/types/domains/bulk-create-login-links.d.ts
@@ -1,3 +1,5 @@
+import type { Optional } from "../internal";
+
 interface DomainsBulkCreateLoginLinkResult {
   /**
    * The domain the request was for.
@@ -8,19 +10,18 @@ interface DomainsBulkCreateLoginLinkResult {
    * More information about the result of creating the login link.
    */
   comment?: string;
+  /**
+   * If a user browses to this URL, they will be automatically logged in as a domain admin.
+   */
+  loginLink: string;
 }
 
-export interface DomainsBulkCreateLoginLink {
-  successes: DomainsBulkCreateLoginLinkResult & {
-    /**
-     * If a user browses to this URL, they will be automatically logged in as a domain admin.
-     */
-    loginLink: string;
-  }[];
-  errors: DomainsBulkCreateLoginLinkResult[];
+export interface DomainsBulkCreateLoginLinks {
+  successes: DomainsBulkCreateLoginLinkResult[];
+  errors: Omit<DomainsBulkCreateLoginLinkResult, "loginLink">[];
 }
 
 export interface DomainsBulkCreateLoginLinksResponse {
-  results: DomainsCreateLoginLink[];
+  results: DomainsBulkCreateLoginLinks | null;
   error: string | null;
 }
diff --git a/test/domains.test.ts b/test/domains.test.ts
@@ -5,6 +5,7 @@ import type { DomainsData, DomainsProvisionOptions } from "../src/types/domains/
 import { ErrorCode } from "../src/utils/errors";
 import type { ListEntryOptions } from "../src/types/lists/entry";
 import type { DomainsAddListEntryApiResponse } from "../src/types/domains/internal";
+import type { DomainsBulkCreateLoginLinksResponse } from "../src/types/domains/bulk-create-login-links";
 
 const fake = {
   provision: {
@@ -88,23 +89,25 @@ const fake = {
     ]
   },
   bulkCreateLoginLinksResponse: {
-    successes: [
-      {
-        domain: "example1.com",
-        code: 200,
-        comment: "string",
-        loginLink: "string"
-      }
-    ],
-    errors: [
-      {
-        domain: "example2.com",
-        code: 400,
-        comment: "string",
-        loginLink: "string"
-      }
-    ]
-  }
+    results: {
+      successes: [
+        {
+          domain: "example1.com",
+          code: 200,
+          comment: "string",
+          loginLink: "string"
+        }
+      ],
+      errors: [
+        {
+          domain: "example2.com",
+          code: 400,
+          comment: "string"
+        }
+      ]
+    },
+    error: null
+  } satisfies DomainsBulkCreateLoginLinksResponse
 };
 
 describe("provision", () => {
@@ -744,7 +747,7 @@ describe("bulkCreateLoginLinks", () => {
     const { results, error } = await domains.bulkCreateLoginLinks([]);
 
     expect(error).toBe("No domains provided.");
-    expect(results).toEqual([]);
+    expect(results).toBeNull();
     expect(mockClient.post).not.toHaveBeenCalled();
   });
 
@@ -757,7 +760,7 @@ describe("bulkCreateLoginLinks", () => {
     const { results, error } = await domains.bulkCreateLoginLinks(new Array(1001).fill("example.com"));
 
     expect(error).toBe("The maximum number of domains to create login links for is 1000.");
-    expect(results).toEqual([]);
+    expect(results).toBeNull();
     expect(mockClient.post).not.toHaveBeenCalled();
   });
 
@@ -776,7 +779,7 @@ describe("bulkCreateLoginLinks", () => {
     ]);
 
     expect(error).toBeTruthy();
-    expect(results).toEqual([]);
+    expect(results).toBeNull();
     expect(mockClient.post).toHaveBeenCalled();
   });
 });
