@zavudev/sdk 0.57.0 → 0.58.0

package/src/resources/email-domains.ts

@@ -1,37 +1,32 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
+import type * as T from '../types';
 
 export class EmailDomains extends APIResource {
   /**
+   * Add an email domain
+   *
    * Add a domain to send email from. Returns the DNS records to publish (DKIM CNAMEs
    * are required; SPF, DMARC, and MAIL FROM are recommended). Publish them at your
    * DNS provider, then verify.
    *
-   * @example
-   * ```ts
-   * const emailDomain = await client.emailDomains.create({
-   *   domain: 'example.com',
-   * });
-   * ```
+   * `POST /v1/email-domains`
    */
   create(body: EmailDomainCreateParams, options?: RequestOptions): APIPromise<EmailDomainCreateResponse> {
     return this._client.post('/v1/email-domains', { body, ...options });
   }
 
   /**
+   * Get an email domain
+   *
    * Fetch a domain with its DNS records and current status.
    *
-   * @example
-   * ```ts
-   * const emailDomain = await client.emailDomains.retrieve(
-   *   'domainId',
-   * );
-   * ```
+   * `GET /v1/email-domains/{domainId}`
    */
   retrieve(domainID: string, options?: RequestOptions): APIPromise<EmailDomainRetrieveResponse> {
     return this._client.get(path`/v1/email-domains/${domainID}`, options);
@@ -40,10 +35,7 @@ export class EmailDomains extends APIResource {
   /**
    * List email domains
    *
-   * @example
-   * ```ts
-   * const emailDomains = await client.emailDomains.list();
-   * ```
+   * `GET /v1/email-domains`
    */
   list(options?: RequestOptions): APIPromise<EmailDomainListResponse> {
     return this._client.get('/v1/email-domains', options);
@@ -52,10 +44,7 @@ export class EmailDomains extends APIResource {
   /**
    * Remove an email domain
    *
-   * @example
-   * ```ts
-   * await client.emailDomains.delete('domainId');
-   * ```
+   * `DELETE /v1/email-domains/{domainId}`
    */
   delete(domainID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/v1/email-domains/${domainID}`, {
@@ -65,266 +54,50 @@ export class EmailDomains extends APIResource {
   }
 
   /**
+   * Verify an email domain
+   *
    * Re-check the domain's published DNS records and refresh its status.
    *
-   * @example
-   * ```ts
-   * const response = await client.emailDomains.verify(
-   *   'domainId',
-   * );
-   * ```
+   * `POST /v1/email-domains/{domainId}/verify`
    */
   verify(domainID: string, options?: RequestOptions): APIPromise<EmailDomainVerifyResponse> {
     return this._client.post(path`/v1/email-domains/${domainID}/verify`, options);
   }
 }
 
-export interface EmailDomainCreateResponse {
-  domain: EmailDomainCreateResponse.Domain;
-}
-
+export type EmailDomainCreateResponse = T.AddEmailDomainResponse;
 export namespace EmailDomainCreateResponse {
-  export interface Domain {
-    id: string;
-
-    dkimStatus: string;
-
-    domain: string;
-
-    /**
-     * Overall verification status.
-     */
-    status: string;
-
-    /**
-     * DNS records to publish. Present when fetching a single domain or after adding
-     * one.
-     */
-    dnsRecords?: Array<Domain.DNSRecord>;
-  }
-
+  export type Domain = T.EmailDomain;
   export namespace Domain {
-    export interface DNSRecord {
-      /**
-       * Record host/name to create.
-       */
-      name: string;
-
-      /**
-       * What the record is for.
-       */
-      purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
-
-      /**
-       * Whether the record is required to verify + send (DKIM) or recommended for
-       * deliverability.
-       */
-      required: boolean;
-
-      /**
-       * DNS record type.
-       */
-      type: string;
-
-      /**
-       * Record value.
-       */
-      value: string;
-
-      /**
-       * Priority (MX records only).
-       */
-      priority?: number;
-    }
+    export type DNSRecord = T.EmailDomainDnsRecord;
   }
 }
 
-export interface EmailDomainRetrieveResponse {
-  domain: EmailDomainRetrieveResponse.Domain;
-}
-
+export type EmailDomainRetrieveResponse = T.GetEmailDomainResponse;
 export namespace EmailDomainRetrieveResponse {
-  export interface Domain {
-    id: string;
-
-    dkimStatus: string;
-
-    domain: string;
-
-    /**
-     * Overall verification status.
-     */
-    status: string;
-
-    /**
-     * DNS records to publish. Present when fetching a single domain or after adding
-     * one.
-     */
-    dnsRecords?: Array<Domain.DNSRecord>;
-  }
-
+  export type Domain = T.EmailDomain;
   export namespace Domain {
-    export interface DNSRecord {
-      /**
-       * Record host/name to create.
-       */
-      name: string;
-
-      /**
-       * What the record is for.
-       */
-      purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
-
-      /**
-       * Whether the record is required to verify + send (DKIM) or recommended for
-       * deliverability.
-       */
-      required: boolean;
-
-      /**
-       * DNS record type.
-       */
-      type: string;
-
-      /**
-       * Record value.
-       */
-      value: string;
-
-      /**
-       * Priority (MX records only).
-       */
-      priority?: number;
-    }
+    export type DNSRecord = T.EmailDomainDnsRecord;
   }
 }
 
-export interface EmailDomainListResponse {
-  items: Array<EmailDomainListResponse.Item>;
-}
-
+export type EmailDomainListResponse = T.ListEmailDomainsResponse;
 export namespace EmailDomainListResponse {
-  export interface Item {
-    id: string;
-
-    dkimStatus: string;
-
-    domain: string;
-
-    /**
-     * Overall verification status.
-     */
-    status: string;
-
-    /**
-     * DNS records to publish. Present when fetching a single domain or after adding
-     * one.
-     */
-    dnsRecords?: Array<Item.DNSRecord>;
-  }
-
+  export type Item = T.EmailDomain;
   export namespace Item {
-    export interface DNSRecord {
-      /**
-       * Record host/name to create.
-       */
-      name: string;
-
-      /**
-       * What the record is for.
-       */
-      purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
-
-      /**
-       * Whether the record is required to verify + send (DKIM) or recommended for
-       * deliverability.
-       */
-      required: boolean;
-
-      /**
-       * DNS record type.
-       */
-      type: string;
-
-      /**
-       * Record value.
-       */
-      value: string;
-
-      /**
-       * Priority (MX records only).
-       */
-      priority?: number;
-    }
+    export type DNSRecord = T.EmailDomainDnsRecord;
   }
 }
 
-export interface EmailDomainVerifyResponse {
-  domain: EmailDomainVerifyResponse.Domain;
-}
-
+export type EmailDomainVerifyResponse = T.VerifyEmailDomainResponse;
 export namespace EmailDomainVerifyResponse {
-  export interface Domain {
-    id: string;
-
-    dkimStatus: string;
-
-    domain: string;
-
-    /**
-     * Overall verification status.
-     */
-    status: string;
-
-    /**
-     * DNS records to publish. Present when fetching a single domain or after adding
-     * one.
-     */
-    dnsRecords?: Array<Domain.DNSRecord>;
-  }
-
+  export type Domain = T.EmailDomain;
   export namespace Domain {
-    export interface DNSRecord {
-      /**
-       * Record host/name to create.
-       */
-      name: string;
-
-      /**
-       * What the record is for.
-       */
-      purpose: 'dkim' | 'spf' | 'dmarc' | 'mail_from';
-
-      /**
-       * Whether the record is required to verify + send (DKIM) or recommended for
-       * deliverability.
-       */
-      required: boolean;
-
-      /**
-       * DNS record type.
-       */
-      type: string;
-
-      /**
-       * Record value.
-       */
-      value: string;
-
-      /**
-       * Priority (MX records only).
-       */
-      priority?: number;
-    }
+    export type DNSRecord = T.EmailDomainDnsRecord;
   }
 }
 
-export interface EmailDomainCreateParams {
-  /**
-   * Bare domain, e.g. example.com.
-   */
-  domain: string;
-}
+export type EmailDomainCreateParams = T.EmailDomainsCreateParams;
 
 export declare namespace EmailDomains {
   export {