@sentdm/sentdm 0.25.4 → 0.26.0

package/resources/contacts.d.ts

@@ -1,6 +1,4 @@
 import { APIResource } from "../core/resource.js";
-import * as ContactsAPI from "./contacts.js";
-import * as WebhooksAPI from "./webhooks.js";
 import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
 /**
@@ -13,10 +11,10 @@ export declare class Contacts extends APIResource {
      *
      * @example
      * ```ts
-     * const apiResponseOfContact = await client.contacts.create();
+     * const contact = await client.contacts.create();
      * ```
      */
-    create(params: ContactCreateParams, options?: RequestOptions): APIPromise<APIResponseOfContact>;
+    create(params: ContactCreateParams, options?: RequestOptions): APIPromise<ContactCreateResponse>;
     /**
      * Retrieves a specific contact by their unique identifier. Returns detailed
      * contact information including phone formats, available channels, and opt-out
@@ -24,24 +22,24 @@ export declare class Contacts extends APIResource {
      *
      * @example
      * ```ts
-     * const apiResponseOfContact = await client.contacts.retrieve(
+     * const contact = await client.contacts.retrieve(
      *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
      * );
      * ```
      */
-    retrieve(id: string, params?: ContactRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfContact>;
+    retrieve(id: string, params?: ContactRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ContactRetrieveResponse>;
     /**
      * Updates a contact's default channel and/or opt-out status. Inherited contacts
      * cannot be updated.
      *
      * @example
      * ```ts
-     * const apiResponseOfContact = await client.contacts.update(
+     * const contact = await client.contacts.update(
      *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
      * );
      * ```
      */
-    update(id: string, params: ContactUpdateParams, options?: RequestOptions): APIPromise<APIResponseOfContact>;
+    update(id: string, params: ContactUpdateParams, options?: RequestOptions): APIPromise<ContactUpdateResponse>;
     /**
      * Retrieves a paginated list of contacts for the authenticated customer. Supports
      * filtering by search term, channel, or phone number.
@@ -71,93 +69,377 @@ export declare class Contacts extends APIResource {
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface APIResponseOfContact {
+export interface ContactCreateResponse {
     /**
      * Contact response for v3 API Uses snake_case for JSON property names
      */
-    data?: ContactResponse | null;
+    data?: ContactCreateResponse.Data | null;
     /**
      * Error information
      */
-    error?: WebhooksAPI.ErrorDetail | null;
+    error?: ContactCreateResponse.Error | null;
     /**
      * Request and response metadata
      */
-    meta?: WebhooksAPI.APIMeta;
+    meta?: ContactCreateResponse.Meta;
     /**
      * Indicates whether the request was successful
      */
     success?: boolean;
 }
-/**
- * Contact response for v3 API Uses snake_case for JSON property names
- */
-export interface ContactResponse {
+export declare namespace ContactCreateResponse {
     /**
-     * Unique identifier for the contact
+     * Contact response for v3 API Uses snake_case for JSON property names
      */
-    id?: string;
+    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
+     */
+    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
+     */
+    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
+ */
+export interface ContactRetrieveResponse {
     /**
-     * Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+     * Contact response for v3 API Uses snake_case for JSON property names
      */
-    available_channels?: string;
+    data?: ContactRetrieveResponse.Data | null;
     /**
-     * Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in",
-     * "opted_out". All channels will have the same status because consent is global
-     * across channels. A STOP on any channel opts out of all channels; a START opts in
-     * to all.
+     * Error information
      */
-    channel_consent?: {
-        [key: string]: string;
-    } | null;
+    error?: ContactRetrieveResponse.Error | null;
     /**
-     * Country calling code (e.g., 1 for US/Canada)
+     * Request and response metadata
      */
-    country_code?: string;
+    meta?: ContactRetrieveResponse.Meta;
     /**
-     * When the contact was created
+     * Indicates whether the request was successful
      */
-    created_at?: string;
+    success?: boolean;
+}
+export declare namespace ContactRetrieveResponse {
     /**
-     * Default messaging channel to use (e.g., "sms" or "whatsapp")
+     * Contact response for v3 API Uses snake_case for JSON property names
      */
-    default_channel?: string;
+    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 in E.164 format (e.g., +1234567890)
+     * Error information
      */
-    format_e164?: string;
+    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;
+    }
     /**
-     * Phone number in international format (e.g., +1 234-567-890)
+     * Request and response metadata
      */
-    format_international?: string;
+    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
+ */
+export interface ContactUpdateResponse {
     /**
-     * Phone number in national format (e.g., (234) 567-890)
+     * Contact response for v3 API Uses snake_case for JSON property names
      */
-    format_national?: string;
+    data?: ContactUpdateResponse.Data | null;
     /**
-     * Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+     * Error information
      */
-    format_rfc?: string;
+    error?: ContactUpdateResponse.Error | null;
     /**
-     * Whether this is an inherited contact (read-only)
+     * Request and response metadata
      */
-    is_inherited?: boolean;
+    meta?: ContactUpdateResponse.Meta;
     /**
-     * Whether the contact has opted out of messaging
+     * Indicates whether the request was successful
      */
-    opt_out?: boolean;
+    success?: boolean;
+}
+export declare namespace ContactUpdateResponse {
     /**
-     * Phone number in original format
+     * Contact response for v3 API Uses snake_case for JSON property names
      */
-    phone_number?: string;
+    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;
+    }
     /**
-     * ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+     * Error information
      */
-    region_code?: string;
+    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;
+    }
     /**
-     * When the contact was last updated
+     * Request and response metadata
      */
-    updated_at?: string | null;
+    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
@@ -170,11 +452,11 @@ export interface ContactListResponse {
     /**
      * Error information
      */
-    error?: WebhooksAPI.ErrorDetail | null;
+    error?: ContactListResponse.Error | null;
     /**
      * Request and response metadata
      */
-    meta?: WebhooksAPI.APIMeta;
+    meta?: ContactListResponse.Meta;
     /**
      * Indicates whether the request was successful
      */
@@ -188,11 +470,159 @@ export declare namespace ContactListResponse {
         /**
          * List of contacts
          */
-        contacts?: Array<ContactsAPI.ContactResponse>;
+        contacts?: Array<Data.Contact>;
         /**
          * Pagination metadata for list responses
          */
-        pagination?: WebhooksAPI.PaginationMeta;
+        pagination?: Data.Pagination;
+    }
+    namespace Data {
+        /**
+         * Contact response for v3 API Uses snake_case for JSON property names
+         */
+        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;
+        }
+        /**
+         * Pagination metadata for list responses
+         */
+        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;
+        }
+        namespace Pagination {
+            /**
+             * Cursor-based pagination pointers
+             */
+            interface Cursors {
+                /**
+                 * Cursor to fetch the next page
+                 */
+                after?: string | null;
+                /**
+                 * Cursor to fetch the previous page
+                 */
+                before?: string | null;
+            }
+        }
+    }
+    /**
+     * Error information
+     */
+    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
+     */
+    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;
     }
 }
 export interface ContactCreateParams {
@@ -226,23 +656,13 @@ export interface ContactRetrieveParams {
     'x-profile-id'?: string;
 }
 export interface ContactUpdateParams {
-    /**
-     * Body param: Consent status by channel. Keys: "sms", "whatsapp". Values:
-     * "opted_in", "opted_out". All entries must have the same status — mixed values
-     * (e.g., sms: opted_out + whatsapp: opted_in) are rejected with 400. The provided
-     * status is applied to ALL channels regardless of which keys are specified,
-     * because consent is global across channels. When provided, takes precedence over
-     * the opt_out field.
-     */
-    channel_consent?: {
-        [key: string]: string;
-    } | null;
     /**
      * Body param: Default messaging channel: "sms" or "whatsapp"
      */
     default_channel?: string | null;
     /**
-     * Body param: Whether the contact has opted out of messaging
+     * Body param: Whether the contact has opted out of messaging. Single source of
+     * truth — opt-out is per-contact, not per-channel.
      */
     opt_out?: boolean | null;
     /**
@@ -305,6 +725,6 @@ export interface ContactDeleteParams {
     'x-profile-id'?: string;
 }
 export declare namespace Contacts {
-    export { type APIResponseOfContact as APIResponseOfContact, type ContactResponse as ContactResponse, type ContactListResponse as ContactListResponse, type ContactCreateParams as ContactCreateParams, type ContactRetrieveParams as ContactRetrieveParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactDeleteParams as ContactDeleteParams, };
+    export { type ContactCreateResponse as ContactCreateResponse, type ContactRetrieveResponse as ContactRetrieveResponse, type ContactUpdateResponse as ContactUpdateResponse, type ContactListResponse as ContactListResponse, type ContactCreateParams as ContactCreateParams, type ContactRetrieveParams as ContactRetrieveParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactDeleteParams as ContactDeleteParams, };
 }
 //# sourceMappingURL=contacts.d.ts.map