@sentdm/sentdm 0.26.0 → 0.27.0

package/src/resources/contacts.ts

@@ -1,6 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as ContactsAPI from './contacts';
+import * as WebhooksAPI from './webhooks';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
@@ -16,10 +18,10 @@ export class Contacts extends APIResource {
    *
    * @example
    * ```ts
-   * const contact = await client.contacts.create();
+   * const apiResponseOfContact = await client.contacts.create();
    * ```
    */
-  create(params: ContactCreateParams, options?: RequestOptions): APIPromise<ContactCreateResponse> {
+  create(params: ContactCreateParams, options?: RequestOptions): APIPromise<APIResponseOfContact> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.post('/v3/contacts', {
       body,
@@ -41,7 +43,7 @@ export class Contacts extends APIResource {
    *
    * @example
    * ```ts
-   * const contact = await client.contacts.retrieve(
+   * const apiResponseOfContact = await client.contacts.retrieve(
    *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
    * );
    * ```
@@ -50,7 +52,7 @@ export class Contacts extends APIResource {
     id: string,
     params: ContactRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ContactRetrieveResponse> {
+  ): APIPromise<APIResponseOfContact> {
     const { 'x-profile-id': xProfileID } = params ?? {};
     return this._client.get(path`/v3/contacts/${id}`, {
       ...options,
@@ -67,7 +69,7 @@ export class Contacts extends APIResource {
    *
    * @example
    * ```ts
-   * const contact = await client.contacts.update(
+   * const apiResponseOfContact = await client.contacts.update(
    *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
    * );
    * ```
@@ -76,7 +78,7 @@ export class Contacts extends APIResource {
     id: string,
     params: ContactUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<ContactUpdateResponse> {
+  ): APIPromise<APIResponseOfContact> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.patch(path`/v3/contacts/${id}`, {
       body,
@@ -142,21 +144,21 @@ export class Contacts extends APIResource {
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface ContactCreateResponse {
+export interface APIResponseOfContact {
   /**
    * Contact response for v3 API Uses snake_case for JSON property names
    */
-  data?: ContactCreateResponse.Data | null;
+  data?: ContactResponse | null;
 
   /**
    * Error information
    */
-  error?: ContactCreateResponse.Error | null;
+  error?: WebhooksAPI.ErrorDetail | null;
 
   /**
    * Request and response metadata
    */
-  meta?: ContactCreateResponse.Meta;
+  meta?: WebhooksAPI.APIMeta;
 
   /**
    * Indicates whether the request was successful
@@ -164,423 +166,80 @@ export interface ContactCreateResponse {
   success?: boolean;
 }
 
-export namespace ContactCreateResponse {
-  /**
-   * Contact response for v3 API Uses snake_case for JSON property names
-   */
-  export interface Data {
-    /**
-     * Unique identifier for the contact
-     */
-    id?: string;
-
-    /**
-     * Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
-     */
-    available_channels?: string;
-
-    /**
-     * Country calling code (e.g., 1 for US/Canada)
-     */
-    country_code?: string;
-
-    /**
-     * When the contact was created
-     */
-    created_at?: string;
-
-    /**
-     * Default messaging channel to use (e.g., "sms" or "whatsapp")
-     */
-    default_channel?: string;
-
-    /**
-     * Phone number in E.164 format (e.g., +1234567890)
-     */
-    format_e164?: string;
-
-    /**
-     * Phone number in international format (e.g., +1 234-567-890)
-     */
-    format_international?: string;
-
-    /**
-     * Phone number in national format (e.g., (234) 567-890)
-     */
-    format_national?: string;
-
-    /**
-     * Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
-     */
-    format_rfc?: string;
-
-    /**
-     * Whether this is an inherited contact (read-only)
-     */
-    is_inherited?: boolean;
-
-    /**
-     * Whether the contact has opted out of messaging. Single source of truth — opt-out
-     * is per-contact, not per-channel.
-     */
-    opt_out?: boolean;
-
-    /**
-     * Phone number in original format
-     */
-    phone_number?: string;
-
-    /**
-     * ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
-     */
-    region_code?: string;
-
-    /**
-     * When the contact was last updated
-     */
-    updated_at?: string | null;
-  }
-
-  /**
-   * Error information
-   */
-  export interface Error {
-    /**
-     * Machine-readable error code (e.g., "RESOURCE_001")
-     */
-    code?: string;
-
-    /**
-     * Additional validation error details (field-level errors)
-     */
-    details?: { [key: string]: Array<string> } | null;
-
-    /**
-     * URL to documentation about this error
-     */
-    doc_url?: string | null;
-
-    /**
-     * Human-readable error message
-     */
-    message?: string;
-  }
-
-  /**
-   * Request and response metadata
-   */
-  export interface Meta {
-    /**
-     * Unique identifier for this request (for tracing and support)
-     */
-    request_id?: string;
-
-    /**
-     * Server timestamp when the response was generated
-     */
-    timestamp?: string;
-
-    /**
-     * API version used for this request
-     */
-    version?: string;
-  }
-}
-
 /**
- * Standard API response envelope for all v3 endpoints
+ * Contact response for v3 API Uses snake_case for JSON property names
  */
-export interface ContactRetrieveResponse {
+export interface ContactResponse {
   /**
-   * Contact response for v3 API Uses snake_case for JSON property names
+   * Unique identifier for the contact
    */
-  data?: ContactRetrieveResponse.Data | null;
+  id?: string;
 
   /**
-   * Error information
+   * Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
    */
-  error?: ContactRetrieveResponse.Error | null;
+  available_channels?: string;
 
   /**
-   * Request and response metadata
+   * Country calling code (e.g., 1 for US/Canada)
    */
-  meta?: ContactRetrieveResponse.Meta;
+  country_code?: string;
 
   /**
-   * Indicates whether the request was successful
+   * When the contact was created
    */
-  success?: boolean;
-}
+  created_at?: string;
 
-export namespace ContactRetrieveResponse {
   /**
-   * Contact response for v3 API Uses snake_case for JSON property names
+   * Default messaging channel to use (e.g., "sms" or "whatsapp")
    */
-  export interface Data {
-    /**
-     * Unique identifier for the contact
-     */
-    id?: string;
-
-    /**
-     * Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
-     */
-    available_channels?: string;
-
-    /**
-     * Country calling code (e.g., 1 for US/Canada)
-     */
-    country_code?: string;
-
-    /**
-     * When the contact was created
-     */
-    created_at?: string;
-
-    /**
-     * Default messaging channel to use (e.g., "sms" or "whatsapp")
-     */
-    default_channel?: string;
-
-    /**
-     * Phone number in E.164 format (e.g., +1234567890)
-     */
-    format_e164?: string;
-
-    /**
-     * Phone number in international format (e.g., +1 234-567-890)
-     */
-    format_international?: string;
-
-    /**
-     * Phone number in national format (e.g., (234) 567-890)
-     */
-    format_national?: string;
-
-    /**
-     * Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
-     */
-    format_rfc?: string;
-
-    /**
-     * Whether this is an inherited contact (read-only)
-     */
-    is_inherited?: boolean;
-
-    /**
-     * Whether the contact has opted out of messaging. Single source of truth — opt-out
-     * is per-contact, not per-channel.
-     */
-    opt_out?: boolean;
-
-    /**
-     * Phone number in original format
-     */
-    phone_number?: string;
-
-    /**
-     * ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
-     */
-    region_code?: string;
-
-    /**
-     * When the contact was last updated
-     */
-    updated_at?: string | null;
-  }
+  default_channel?: string;
 
   /**
-   * Error information
+   * Phone number in E.164 format (e.g., +1234567890)
    */
-  export interface Error {
-    /**
-     * Machine-readable error code (e.g., "RESOURCE_001")
-     */
-    code?: string;
-
-    /**
-     * Additional validation error details (field-level errors)
-     */
-    details?: { [key: string]: Array<string> } | null;
-
-    /**
-     * URL to documentation about this error
-     */
-    doc_url?: string | null;
-
-    /**
-     * Human-readable error message
-     */
-    message?: string;
-  }
+  format_e164?: string;
 
   /**
-   * Request and response metadata
+   * Phone number in international format (e.g., +1 234-567-890)
    */
-  export interface Meta {
-    /**
-     * Unique identifier for this request (for tracing and support)
-     */
-    request_id?: string;
-
-    /**
-     * Server timestamp when the response was generated
-     */
-    timestamp?: string;
-
-    /**
-     * API version used for this request
-     */
-    version?: string;
-  }
-}
+  format_international?: string;
 
-/**
- * Standard API response envelope for all v3 endpoints
- */
-export interface ContactUpdateResponse {
   /**
-   * Contact response for v3 API Uses snake_case for JSON property names
+   * Phone number in national format (e.g., (234) 567-890)
    */
-  data?: ContactUpdateResponse.Data | null;
+  format_national?: string;
 
   /**
-   * Error information
+   * Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
    */
-  error?: ContactUpdateResponse.Error | null;
+  format_rfc?: string;
 
   /**
-   * Request and response metadata
+   * Whether this is an inherited contact (read-only)
    */
-  meta?: ContactUpdateResponse.Meta;
+  is_inherited?: boolean;
 
   /**
-   * Indicates whether the request was successful
+   * Whether the contact has opted out of messaging. Single source of truth — opt-out
+   * is per-contact, not per-channel.
    */
-  success?: boolean;
-}
+  opt_out?: boolean;
 
-export namespace ContactUpdateResponse {
   /**
-   * Contact response for v3 API Uses snake_case for JSON property names
+   * Phone number in original format
    */
-  export interface Data {
-    /**
-     * Unique identifier for the contact
-     */
-    id?: string;
-
-    /**
-     * Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
-     */
-    available_channels?: string;
-
-    /**
-     * Country calling code (e.g., 1 for US/Canada)
-     */
-    country_code?: string;
-
-    /**
-     * When the contact was created
-     */
-    created_at?: string;
-
-    /**
-     * Default messaging channel to use (e.g., "sms" or "whatsapp")
-     */
-    default_channel?: string;
-
-    /**
-     * Phone number in E.164 format (e.g., +1234567890)
-     */
-    format_e164?: string;
-
-    /**
-     * Phone number in international format (e.g., +1 234-567-890)
-     */
-    format_international?: string;
-
-    /**
-     * Phone number in national format (e.g., (234) 567-890)
-     */
-    format_national?: string;
-
-    /**
-     * Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
-     */
-    format_rfc?: string;
-
-    /**
-     * Whether this is an inherited contact (read-only)
-     */
-    is_inherited?: boolean;
-
-    /**
-     * Whether the contact has opted out of messaging. Single source of truth — opt-out
-     * is per-contact, not per-channel.
-     */
-    opt_out?: boolean;
-
-    /**
-     * Phone number in original format
-     */
-    phone_number?: string;
-
-    /**
-     * ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
-     */
-    region_code?: string;
-
-    /**
-     * When the contact was last updated
-     */
-    updated_at?: string | null;
-  }
+  phone_number?: string;
 
   /**
-   * Error information
+   * ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
    */
-  export interface Error {
-    /**
-     * Machine-readable error code (e.g., "RESOURCE_001")
-     */
-    code?: string;
-
-    /**
-     * Additional validation error details (field-level errors)
-     */
-    details?: { [key: string]: Array<string> } | null;
-
-    /**
-     * URL to documentation about this error
-     */
-    doc_url?: string | null;
-
-    /**
-     * Human-readable error message
-     */
-    message?: string;
-  }
+  region_code?: string;
 
   /**
-   * Request and response metadata
+   * When the contact was last updated
    */
-  export interface Meta {
-    /**
-     * Unique identifier for this request (for tracing and support)
-     */
-    request_id?: string;
-
-    /**
-     * Server timestamp when the response was generated
-     */
-    timestamp?: string;
-
-    /**
-     * API version used for this request
-     */
-    version?: string;
-  }
+  updated_at?: string | null;
 }
 
 /**
@@ -595,12 +254,12 @@ export interface ContactListResponse {
   /**
    * Error information
    */
-  error?: ContactListResponse.Error | null;
+  error?: WebhooksAPI.ErrorDetail | null;
 
   /**
    * Request and response metadata
    */
-  meta?: ContactListResponse.Meta;
+  meta?: WebhooksAPI.APIMeta;
 
   /**
    * Indicates whether the request was successful
@@ -616,187 +275,12 @@ export namespace ContactListResponse {
     /**
      * List of contacts
      */
-    contacts?: Array<Data.Contact>;
-
-    /**
-     * Pagination metadata for list responses
-     */
-    pagination?: Data.Pagination;
-  }
-
-  export namespace Data {
-    /**
-     * Contact response for v3 API Uses snake_case for JSON property names
-     */
-    export interface Contact {
-      /**
-       * Unique identifier for the contact
-       */
-      id?: string;
-
-      /**
-       * Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
-       */
-      available_channels?: string;
-
-      /**
-       * Country calling code (e.g., 1 for US/Canada)
-       */
-      country_code?: string;
-
-      /**
-       * When the contact was created
-       */
-      created_at?: string;
-
-      /**
-       * Default messaging channel to use (e.g., "sms" or "whatsapp")
-       */
-      default_channel?: string;
-
-      /**
-       * Phone number in E.164 format (e.g., +1234567890)
-       */
-      format_e164?: string;
-
-      /**
-       * Phone number in international format (e.g., +1 234-567-890)
-       */
-      format_international?: string;
-
-      /**
-       * Phone number in national format (e.g., (234) 567-890)
-       */
-      format_national?: string;
-
-      /**
-       * Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
-       */
-      format_rfc?: string;
-
-      /**
-       * Whether this is an inherited contact (read-only)
-       */
-      is_inherited?: boolean;
-
-      /**
-       * Whether the contact has opted out of messaging. Single source of truth — opt-out
-       * is per-contact, not per-channel.
-       */
-      opt_out?: boolean;
-
-      /**
-       * Phone number in original format
-       */
-      phone_number?: string;
-
-      /**
-       * ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
-       */
-      region_code?: string;
-
-      /**
-       * When the contact was last updated
-       */
-      updated_at?: string | null;
-    }
+    contacts?: Array<ContactsAPI.ContactResponse>;
 
     /**
      * Pagination metadata for list responses
      */
-    export interface Pagination {
-      /**
-       * Cursor-based pagination pointers
-       */
-      cursors?: Pagination.Cursors | null;
-
-      /**
-       * Whether there are more pages after this one
-       */
-      has_more?: boolean;
-
-      /**
-       * Current page number (1-indexed)
-       */
-      page?: number;
-
-      /**
-       * Number of items per page
-       */
-      page_size?: number;
-
-      /**
-       * Total number of items across all pages
-       */
-      total_count?: number;
-
-      /**
-       * Total number of pages
-       */
-      total_pages?: number;
-    }
-
-    export namespace Pagination {
-      /**
-       * Cursor-based pagination pointers
-       */
-      export interface Cursors {
-        /**
-         * Cursor to fetch the next page
-         */
-        after?: string | null;
-
-        /**
-         * Cursor to fetch the previous page
-         */
-        before?: string | null;
-      }
-    }
-  }
-
-  /**
-   * Error information
-   */
-  export interface Error {
-    /**
-     * Machine-readable error code (e.g., "RESOURCE_001")
-     */
-    code?: string;
-
-    /**
-     * Additional validation error details (field-level errors)
-     */
-    details?: { [key: string]: Array<string> } | null;
-
-    /**
-     * URL to documentation about this error
-     */
-    doc_url?: string | null;
-
-    /**
-     * Human-readable error message
-     */
-    message?: string;
-  }
-
-  /**
-   * Request and response metadata
-   */
-  export interface Meta {
-    /**
-     * Unique identifier for this request (for tracing and support)
-     */
-    request_id?: string;
-
-    /**
-     * Server timestamp when the response was generated
-     */
-    timestamp?: string;
-
-    /**
-     * API version used for this request
-     */
-    version?: string;
+    pagination?: WebhooksAPI.PaginationMeta;
   }
 }
 
@@ -919,9 +403,8 @@ export interface ContactDeleteParams {
 
 export declare namespace Contacts {
   export {
-    type ContactCreateResponse as ContactCreateResponse,
-    type ContactRetrieveResponse as ContactRetrieveResponse,
-    type ContactUpdateResponse as ContactUpdateResponse,
+    type APIResponseOfContact as APIResponseOfContact,
+    type ContactResponse as ContactResponse,
     type ContactListResponse as ContactListResponse,
     type ContactCreateParams as ContactCreateParams,
     type ContactRetrieveParams as ContactRetrieveParams,