@sentdm/sentdm 0.35.0 → 0.37.0

package/resources/contacts.d.ts

@@ -1,4 +1,6 @@
 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";
 /**
@@ -15,12 +17,12 @@ export declare class Contacts extends APIResource {
      *
      * @example
      * ```ts
-     * const contact = await client.contacts.create({
+     * const apiResponseOfContact = await client.contacts.create({
      *   phone_number: '+1234567890',
      * });
      * ```
      */
-    create(params: ContactCreateParams, options?: RequestOptions): APIPromise<ContactCreateResponse>;
+    create(params: ContactCreateParams, options?: RequestOptions): APIPromise<APIResponseOfContact>;
     /**
      * Retrieves a specific contact by their unique identifier. Returns detailed
      * contact information including phone formats, available channels, and opt-out
@@ -28,23 +30,23 @@ export declare class Contacts extends APIResource {
      *
      * @example
      * ```ts
-     * const contact = await client.contacts.retrieve(
+     * const apiResponseOfContact = await client.contacts.retrieve(
      *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
      * );
      * ```
      */
-    retrieve(id: string, params?: ContactRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ContactRetrieveResponse>;
+    retrieve(id: string, params?: ContactRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfContact>;
     /**
      * Updates a contact's default channel and/or opt-out status.
      *
      * @example
      * ```ts
-     * const contact = await client.contacts.update(
+     * const apiResponseOfContact = await client.contacts.update(
      *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
      * );
      * ```
      */
-    update(id: string, params: ContactUpdateParams, options?: RequestOptions): APIPromise<ContactUpdateResponse>;
+    update(id: string, params: ContactUpdateParams, options?: RequestOptions): APIPromise<APIResponseOfContact>;
     /**
      * Retrieves a paginated list of contacts for the authenticated customer. Supports
      * filtering by search term, channel, or phone number.
@@ -81,687 +83,181 @@ export declare class Contacts extends APIResource {
      *
      * @example
      * ```ts
-     * const response =
+     * const apiResponseOfContactMessageSummary =
      *   await client.contacts.retrieveMessageSummary(
      *     '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
      *   );
      * ```
      */
-    retrieveMessageSummary(contactID: string, params?: ContactRetrieveMessageSummaryParams | null | undefined, options?: RequestOptions): APIPromise<ContactRetrieveMessageSummaryResponse>;
+    retrieveMessageSummary(contactID: string, params?: ContactRetrieveMessageSummaryParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfContactMessageSummary>;
 }
 /**
  * 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
      */
     success?: boolean;
 }
-export declare namespace ContactCreateResponse {
-    /**
-     * Contact response for v3 API Uses snake_case for JSON property names
-     */
-    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;
-        /**
-         * Which customer owns this — the key's own, or the profile named in x-profile-id.
-         * Says whose resource this is, which the resource's own id does not.
-         */
-        customer_id?: 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;
-        /**
-         * @deprecated Always false. Contacts are no longer shared or inherited between
-         * sender profiles — a profile sees only the contacts it owns. Retained so existing
-         * v3 clients reading is_inherited keep deserializing; it carries no information.
-         */
-        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 {
+export interface APIResponseOfContactMessageSummary {
     /**
-     * Contact response for v3 API Uses snake_case for JSON property names
+     * The response data (null if error)
      */
-    data?: ContactRetrieveResponse.Data | null;
+    data?: ContactMessageSummary | null;
     /**
      * Error information
      */
-    error?: ContactRetrieveResponse.Error | null;
+    error?: WebhooksAPI.ErrorDetail | null;
     /**
      * Request and response metadata
      */
-    meta?: ContactRetrieveResponse.Meta;
+    meta?: WebhooksAPI.APIMeta;
     /**
      * Indicates whether the request was successful
      */
     success?: boolean;
 }
-export declare namespace ContactRetrieveResponse {
-    /**
-     * Contact response for v3 API Uses snake_case for JSON property names
-     */
-    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;
-        /**
-         * Which customer owns this — the key's own, or the profile named in x-profile-id.
-         * Says whose resource this is, which the resource's own id does not.
-         */
-        customer_id?: 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;
-        /**
-         * @deprecated Always false. Contacts are no longer shared or inherited between
-         * sender profiles — a profile sees only the contacts it owns. Retained so existing
-         * v3 clients reading is_inherited keep deserializing; it carries no information.
-         */
-        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;
+export interface ContactMessageSummary {
+    channel_scores?: Array<ContactMessageSummary.ChannelScore>;
+    channels_used?: Array<string>;
+    contact_id?: string;
+    first_message_at?: string | null;
+    last_message_at?: string | null;
+    message_count?: number;
+}
+export declare namespace ContactMessageSummary {
+    interface ChannelScore {
+        channel?: string;
         /**
-         * Server timestamp when the response was generated
+         * Percentage (0-100) of messages on this channel that ended in FAILED.
          */
-        timestamp?: string;
+        fail_score?: number;
         /**
-         * API version used for this request
+         * Percentage (0-100) of messages on this channel that reached a successful
+         * terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
          */
-        version?: string;
+        success_score?: number;
     }
 }
 /**
- * Standard API response envelope for all v3 endpoints
+ * Contact response for v3 API Uses snake_case for JSON property names
  */
-export interface ContactUpdateResponse {
+export interface ContactResponse {
     /**
-     * Contact response for v3 API Uses snake_case for JSON property names
+     * Unique identifier for the contact
      */
-    data?: ContactUpdateResponse.Data | null;
+    id?: string;
     /**
-     * Error information
+     * Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
      */
-    error?: ContactUpdateResponse.Error | null;
+    available_channels?: string;
     /**
-     * Request and response metadata
+     * Country calling code (e.g., 1 for US/Canada)
      */
-    meta?: ContactUpdateResponse.Meta;
+    country_code?: string;
     /**
-     * Indicates whether the request was successful
+     * When the contact was created
      */
-    success?: boolean;
-}
-export declare namespace ContactUpdateResponse {
+    created_at?: string;
     /**
-     * Contact response for v3 API Uses snake_case for JSON property names
+     * Which customer owns this — the key's own, or the profile named in x-profile-id.
+     * Says whose resource this is, which the resource's own id does not.
      */
-    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;
-        /**
-         * Which customer owns this — the key's own, or the profile named in x-profile-id.
-         * Says whose resource this is, which the resource's own id does not.
-         */
-        customer_id?: 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;
-        /**
-         * @deprecated Always false. Contacts are no longer shared or inherited between
-         * sender profiles — a profile sees only the contacts it owns. Retained so existing
-         * v3 clients reading is_inherited keep deserializing; it carries no information.
-         */
-        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;
-    }
+    customer_id?: string;
     /**
-     * Error information
+     * Default messaging channel to use (e.g., "sms" or "whatsapp")
      */
-    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;
-    }
+    default_channel?: string;
     /**
-     * Request and response metadata
+     * Phone number in E.164 format (e.g., +1234567890)
      */
-    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 ContactListResponse {
+    format_e164?: string;
     /**
-     * A paginated list of contacts.
+     * Phone number in international format (e.g., +1 234-567-890)
      */
-    data?: ContactListResponse.Data | null;
+    format_international?: string;
     /**
-     * Error information
+     * Phone number in national format (e.g., (234) 567-890)
      */
-    error?: ContactListResponse.Error | null;
+    format_national?: string;
     /**
-     * Request and response metadata
+     * Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
      */
-    meta?: ContactListResponse.Meta;
+    format_rfc?: string;
     /**
-     * Indicates whether the request was successful
+     * @deprecated Always false. Contacts are no longer shared or inherited between
+     * sender profiles — a profile sees only the contacts it owns. Retained so existing
+     * v3 clients reading is_inherited keep deserializing; it carries no information.
      */
-    success?: boolean;
-}
-export declare namespace ContactListResponse {
+    is_inherited?: boolean;
     /**
-     * A paginated list of contacts.
+     * Whether the contact has opted out of messaging. Single source of truth — opt-out
+     * is per-contact, not per-channel.
      */
-    interface Data {
-        /**
-         * The contacts on this page.
-         */
-        contacts?: Array<Data.Contact>;
-        /**
-         * Pagination metadata for list responses
-         */
-        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;
-            /**
-             * Which customer owns this — the key's own, or the profile named in x-profile-id.
-             * Says whose resource this is, which the resource's own id does not.
-             */
-            customer_id?: 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;
-            /**
-             * @deprecated Always false. Contacts are no longer shared or inherited between
-             * sender profiles — a profile sees only the contacts it owns. Retained so existing
-             * v3 clients reading is_inherited keep deserializing; it carries no information.
-             */
-            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 {
-            /**
-             * @deprecated Cursor-based pagination. Never populated — see Cursors.
-             */
-            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 {
-            /**
-             * @deprecated Cursor-based pagination. Never populated — see Cursors.
-             */
-            interface Cursors {
-                /**
-                 * Cursor to fetch the next page.
-                 */
-                after?: string | null;
-                /**
-                 * Cursor to fetch the previous page.
-                 */
-                before?: string | null;
-            }
-        }
-    }
+    opt_out?: boolean;
     /**
-     * Error information
+     * Phone number in original format
      */
-    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?: string;
     /**
-     * Request and response metadata
+     * ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
      */
-    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;
-    }
+    region_code?: string;
+    /**
+     * When the contact was last updated
+     */
+    updated_at?: string | null;
 }
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface ContactRetrieveMessageSummaryResponse {
+export interface ContactListResponse {
     /**
-     * The response data (null if error)
+     * A paginated list of contacts.
      */
-    data?: ContactRetrieveMessageSummaryResponse.Data | null;
+    data?: ContactListResponse.Data | null;
     /**
      * Error information
      */
-    error?: ContactRetrieveMessageSummaryResponse.Error | null;
+    error?: WebhooksAPI.ErrorDetail | null;
     /**
      * Request and response metadata
      */
-    meta?: ContactRetrieveMessageSummaryResponse.Meta;
+    meta?: WebhooksAPI.APIMeta;
     /**
      * Indicates whether the request was successful
      */
     success?: boolean;
 }
-export declare namespace ContactRetrieveMessageSummaryResponse {
+export declare namespace ContactListResponse {
     /**
-     * The response data (null if error)
+     * A paginated list of contacts.
      */
     interface Data {
-        channel_scores?: Array<Data.ChannelScore>;
-        channels_used?: Array<string>;
-        contact_id?: string;
-        first_message_at?: string | null;
-        last_message_at?: string | null;
-        message_count?: number;
-    }
-    namespace Data {
-        interface ChannelScore {
-            channel?: string;
-            /**
-             * Percentage (0-100) of messages on this channel that ended in FAILED.
-             */
-            fail_score?: number;
-            /**
-             * Percentage (0-100) of messages on this channel that reached a successful
-             * terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
-             */
-            success_score?: number;
-        }
-    }
-    /**
-     * 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
+         * The contacts on this page.
          */
-        timestamp?: string;
+        contacts?: Array<ContactsAPI.ContactResponse>;
         /**
-         * API version used for this request
+         * Pagination metadata for list responses
          */
-        version?: string;
+        pagination?: WebhooksAPI.PaginationMeta;
     }
 }
 export interface ContactCreateParams {
@@ -871,6 +367,6 @@ export interface ContactRetrieveMessageSummaryParams {
     'x-profile-id'?: string;
 }
 export declare namespace Contacts {
-    export { type ContactCreateResponse as ContactCreateResponse, type ContactRetrieveResponse as ContactRetrieveResponse, type ContactUpdateResponse as ContactUpdateResponse, type ContactListResponse as ContactListResponse, type ContactRetrieveMessageSummaryResponse as ContactRetrieveMessageSummaryResponse, type ContactCreateParams as ContactCreateParams, type ContactRetrieveParams as ContactRetrieveParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactDeleteParams as ContactDeleteParams, type ContactRetrieveMessageSummaryParams as ContactRetrieveMessageSummaryParams, };
+    export { type APIResponseOfContact as APIResponseOfContact, type APIResponseOfContactMessageSummary as APIResponseOfContactMessageSummary, type ContactMessageSummary as ContactMessageSummary, 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, type ContactRetrieveMessageSummaryParams as ContactRetrieveMessageSummaryParams, };
 }
 //# sourceMappingURL=contacts.d.ts.map