mailchannels-sdk 0.4.0 → 0.4.2

package/dist/modules.mjs

@@ -184,6 +184,144 @@ class Emails {
     };
     return data;
   }
+  /**
+   * Create a DKIM key pair for a specified domain and selector using the specified algorithm and key length, for the current customer.
+   * @param domain - The domain to create the DKIM key for.
+   * @param options - DKIM key creation options.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { key, error } = await mailchannels.emails.createDkimKey('example.com', {
+   *   selector: 'mailchannels'
+   * })
+   * ```
+   */
+  async createDkimKey(domain, options) {
+    const data = { key: null, error: null };
+    if (!options.selector || options.selector.length > 63) {
+      data.error = "Selector must be between 1 and 63 characters.";
+    }
+    if (data.error) return data;
+    const payload = {
+      algorithm: options.algorithm,
+      key_length: options.length,
+      selector: options.selector
+    };
+    const response = await this.mailchannels.post(`/tx/v1/domains/${domain}/dkim-keys`, {
+      body: payload,
+      onResponseError: async ({ response: response2 }) => {
+        data.error = getStatusError(response2, {
+          [ErrorCode.BadRequest]: "Bad Request.",
+          [ErrorCode.Conflict]: "Key pair already created for customer_handle, domain, and selector."
+        });
+      }
+    }).catch(() => null);
+    if (!response) return data;
+    data.key = {
+      algorithm: response.algorithm,
+      createdAt: response.created_at,
+      dnsRecords: response.dkim_dns_records,
+      domain: response.domain,
+      length: response.key_length,
+      publicKey: response.public_key,
+      selector: response.selector,
+      status: response.status,
+      statusModifiedAt: response.status_modified_at
+    };
+    return data;
+  }
+  /**
+   * Search for DKIM keys by customer handle and domain, with optional filters. If selector is provided, at most one key will be returned.
+   * @param domain - The domain to search DKIM keys for.
+   * @param options - The options to filter DKIM keys by.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { keys } = await mailchannels.getDkimKeys('example.com', {
+   *   includeDnsRecord: true
+   * })
+   * ```
+   */
+  async getDkimKeys(domain, options) {
+    const data = { keys: [], error: null };
+    if (options?.selector && options.selector.length > 63) {
+      data.error = "Selector must be a maximum of 63 characters.";
+      return data;
+    }
+    if (typeof options?.limit === "number" && (options.limit < 1 || options.limit > 100)) {
+      data.error = "Limit must be between 1 and 100.";
+      return data;
+    }
+    if (typeof options?.offset === "number" && options.offset < 0) {
+      data.error = "Offset value is invalid. Only positive values are allowed.";
+      return data;
+    }
+    const payload = {
+      selector: options?.selector,
+      status: options?.status,
+      offset: options?.offset,
+      limit: options?.limit,
+      include_dns_record: options?.includeDnsRecord
+    };
+    const response = await this.mailchannels.get(`/tx/v1/domains/${domain}/dkim-keys`, {
+      query: payload,
+      onResponseError: async ({ response: response2 }) => {
+        data.error = getStatusError(response2, {
+          [ErrorCode.BadRequest]: "Bad Request."
+        });
+      }
+    }).catch(() => null);
+    if (!response) return data;
+    data.keys = response.keys.map((key) => ({
+      algorithm: key.algorithm,
+      createdAt: key.created_at,
+      dnsRecords: key.dkim_dns_records,
+      domain: key.domain,
+      length: key.key_length,
+      publicKey: key.public_key,
+      selector: key.selector,
+      status: key.status,
+      statusModifiedAt: key.status_modified_at
+    }));
+    return data;
+  }
+  /**
+   * Update fields of an existing DKIM key pair for the specified domain and selector, for the current customer. Currently, only the `status` field can be updated.
+   * @param domain - The domain the DKIM key belongs to.
+   * @param options - The options to update the DKIM key.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success } = await mailchannels.emails.updateDkimKey('example.com', {
+   *   selector: 'mailchannels',
+   *   status: 'retired'
+   * })
+   */
+  async updateDkimKey(domain, options) {
+    const data = { success: false, error: null };
+    if (!options.selector || options.selector.length > 63) {
+      data.error = "Selector must be between 1 and 63 characters.";
+      return data;
+    }
+    const payload = {
+      status: options.status
+    };
+    await this.mailchannels.patch(`/tx/v1/domains/${domain}/dkim-keys/${options.selector}`, {
+      body: payload,
+      ignoreResponseError: true,
+      onResponse: async ({ response }) => {
+        if (response.ok) {
+          data.success = true;
+          return;
+        }
+        data.error = getStatusError(response, {
+          [ErrorCode.BadRequest]: "Bad Request.",
+          [ErrorCode.NotFound]: "Specified key pair not found, or the DKIM domain or selector path parameter is missing."
+        });
+      }
+    });
+    return data;
+  }
 }
 
 class Webhooks {
@@ -989,7 +1127,7 @@ class Suppressions {
    * @example
    * ```ts
    * const mailchannels = new MailChannels('your-api-key')
-   * const response = await mailchannels.suppressions.create({
+   * const { success } = await mailchannels.suppressions.create({
    * // ...
    * });
    */
@@ -1028,7 +1166,7 @@ class Suppressions {
    * @example
    * ```ts
    * const mailchannels = new MailChannels('your-api-key')
-   * const response = await mailchannels.suppressions.delete('name@example.com', 'api');
+   * const { success } = await mailchannels.suppressions.delete('name@example.com', 'api');
    * ```
    */
   async delete(recipient, source) {
@@ -1055,7 +1193,7 @@ class Suppressions {
    * @example
    * ```ts
    * const mailchannels = new MailChannels('your-api-key')
-   * const response = await mailchannels.suppressions.list();
+   * const { list }= await mailchannels.suppressions.list();
    * ```
    * @param options - Options to filter and customize the suppression entries retrieval.
    */
@@ -1389,7 +1527,7 @@ class Domains {
     return data;
   }
   /**
-   * Sets the list of downstream addreses for the domain. This action deletes any existing downstream address for the domain before creating new ones. If the `records` parameter is an empty array, all downstream address records will be deleted.
+   * Sets the list of downstream addresses for the domain. This action deletes any existing downstream address for the domain before creating new ones. If the `records` parameter is an empty array, all downstream address records will be deleted.
    * @param domain - The domain name.
    * @param records - The list of records to set for the domain. A maximum of 10 records can be set.
    * @example
@@ -1504,6 +1642,39 @@ class Domains {
     });
     return data;
   }
+  /**
+   * Generate a batch of links that allow a user to log in as a domain administrator to their different domains.
+   * @param domains - The list of domain names. Maximum of `1000` links per request.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { results } = await mailchannels.domains.bulkCreateLoginLinks(['example.com', 'example2.com'])
+   * ```
+   */
+  async bulkCreateLoginLinks(domains) {
+    const data = { results: null, error: null };
+    if (!domains || !domains.length) {
+      data.error = "No domains provided.";
+      return data;
+    }
+    if (domains.length > 1e3) {
+      data.error = "The maximum number of domains to create login links for is 1000.";
+      return data;
+    }
+    const response = await this.mailchannels.post("/inbound/v1/domains/batch/login-link", {
+      body: {
+        domains: domains.map((domain) => ({ domain }))
+      },
+      onResponseError: async ({ response: response2 }) => {
+        data.error = getStatusError(response2, {
+          [ErrorCode.BadRequest]: "Bad Request."
+        });
+      }
+    }).catch(() => null);
+    if (!response) return data;
+    data.results = response;
+    return data;
+  }
 }
 
 class Lists {