@sentdm/sentdm 0.7.2 → 0.14.0

package/resources/contacts.d.ts

@@ -1,103 +1,297 @@
 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";
+/**
+ * Create, update, and manage customer contact lists
+ */
 export declare class Contacts extends APIResource {
+    /**
+     * Creates a new contact by phone number and associates it with the authenticated
+     * customer.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfContact = await client.contacts.create();
+     * ```
+     */
+    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
+     * status.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfContact = await client.contacts.retrieve(
+     *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+     * );
+     * ```
+     */
+    retrieve(id: string, params?: ContactRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfContact>;
+    /**
+     * Updates a contact's default channel and/or opt-out status. Inherited contacts
+     * cannot be updated.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfContact = await client.contacts.update(
+     *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+     * );
+     * ```
+     */
+    update(id: string, params: ContactUpdateParams, options?: RequestOptions): APIPromise<APIResponseOfContact>;
     /**
      * Retrieves a paginated list of contacts for the authenticated customer. Supports
-     * server-side pagination with configurable page size. The customer ID is extracted
-     * from the authentication token.
+     * filtering by search term, channel, or phone number.
+     *
+     * @example
+     * ```ts
+     * const contacts = await client.contacts.list({
+     *   page: 0,
+     *   page_size: 0,
+     * });
+     * ```
+     */
+    list(params: ContactListParams, options?: RequestOptions): APIPromise<ContactListResponse>;
+    /**
+     * Dissociates a contact from the authenticated customer. Inherited contacts cannot
+     * be deleted.
+     *
+     * @example
+     * ```ts
+     * await client.contacts.delete(
+     *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+     *   { body: {} },
+     * );
+     * ```
      */
-    list(query: ContactListParams, options?: RequestOptions): APIPromise<ContactListResponse>;
+    delete(id: string, params: ContactDeleteParams, options?: RequestOptions): APIPromise<void>;
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfContact {
     /**
-     * Retrieves a contact by their phone number for the authenticated customer. Phone
-     * number should be in international format (e.g., +1234567890). The customer ID is
-     * extracted from the authentication token.
+     * Contact response for v3 API Uses snake_case for JSON property names
      */
-    retrieveByPhone(query: ContactRetrieveByPhoneParams, options?: RequestOptions): APIPromise<ContactListItem>;
+    data?: ContactResponse | null;
     /**
-     * Retrieves a specific contact by their unique identifier for the authenticated
-     * customer. The customer ID is extracted from the authentication token. Returns
-     * detailed contact information including phone number and creation timestamp.
+     * Error information
      */
-    retrieveID(query: ContactRetrieveIDParams, options?: RequestOptions): APIPromise<ContactListItem>;
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
 }
 /**
- * Represents a contact in the customer's contact list
+ * Contact response for v3 API Uses snake_case for JSON property names
  */
-export interface ContactListItem {
+export interface ContactResponse {
     /**
-     * The unique identifier of the contact
+     * Unique identifier for the contact
      */
     id?: string;
     /**
-     * Comma-separated list of available messaging channels for this contact (e.g.,
-     * "sms,whatsapp")
+     * 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")
      */
-    availableChannels?: string;
+    default_channel?: string;
     /**
-     * The country calling code (e.g., 1 for US/Canada)
+     * Phone number in E.164 format (e.g., +1234567890)
      */
-    countryCode?: string;
+    format_e164?: string;
     /**
-     * The default messaging channel to use for this contact (e.g., "sms" or
-     * "whatsapp")
+     * Phone number in international format (e.g., +1 234-567-890)
      */
-    defaultChannel?: string;
+    format_international?: string;
     /**
-     * The phone number formatted in E.164 standard (e.g., +1234567890)
+     * Phone number in national format (e.g., (234) 567-890)
      */
-    formatE164?: string;
+    format_national?: string;
     /**
-     * The phone number formatted for international dialing (e.g., +1 234-567-890)
+     * Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
      */
-    formatInternational?: string;
+    format_rfc?: string;
     /**
-     * The phone number formatted for national dialing (e.g., (234) 567-890)
+     * Whether this is an inherited contact (read-only)
      */
-    formatNational?: string;
+    is_inherited?: boolean;
     /**
-     * The phone number formatted according to RFC 3966 (e.g., tel:+1-234-567-890)
+     * Whether the contact has opted out of messaging
      */
-    formatRfc?: string;
+    opt_out?: boolean;
     /**
-     * The phone number in its original format
+     * Phone number in original format
      */
-    phoneNumber?: string;
+    phone_number?: string;
     /**
-     * The ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+     * ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
      */
-    regionCode?: string;
+    region_code?: string;
+    /**
+     * When the contact was last updated
+     */
+    updated_at?: string | null;
 }
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
 export interface ContactListResponse {
-    items?: Array<ContactListItem>;
-    page?: number;
-    pageSize?: number;
-    totalCount?: number;
-    totalPages?: number;
+    /**
+     * Paginated list of contacts response
+     */
+    data?: ContactListResponse.Data | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+export declare namespace ContactListResponse {
+    /**
+     * Paginated list of contacts response
+     */
+    interface Data {
+        /**
+         * List of contacts
+         */
+        contacts?: Array<ContactsAPI.ContactResponse>;
+        /**
+         * Pagination metadata for list responses
+         */
+        pagination?: WebhooksAPI.PaginationMeta;
+    }
+}
+export interface ContactCreateParams {
+    /**
+     * Body param: Phone number of the contact to create
+     */
+    phone_number?: string;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface ContactRetrieveParams {
+    /**
+     * Profile UUID to scope the request to a child profile. Only organization API keys
+     * can use this header. The profile must belong to the calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface ContactUpdateParams {
+    /**
+     * Body param: Default messaging channel: "sms" or "whatsapp"
+     */
+    default_channel?: string | null;
+    /**
+     * Body param: Whether the contact has opted out of messaging
+     */
+    opt_out?: boolean | null;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
 }
 export interface ContactListParams {
     /**
-     * The page number (zero-indexed). Default is 0.
+     * Query param: Page number (1-indexed)
      */
     page: number;
     /**
-     * The number of items per page. Default is 20.
+     * Query param: Number of items per page
+     */
+    page_size: number;
+    /**
+     * Query param: Optional channel filter (sms, whatsapp)
      */
-    pageSize: number;
+    channel?: string | null;
+    /**
+     * Query param: Optional phone number filter (alternative to list view)
+     */
+    phone?: string | null;
+    /**
+     * Query param: Optional search term for filtering contacts
+     */
+    search?: string | null;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
 }
-export interface ContactRetrieveByPhoneParams {
+export interface ContactDeleteParams {
+    /**
+     * Body param: Request to delete/dissociate a contact
+     */
+    body: ContactDeleteParams.Body;
     /**
-     * The phone number in international format (e.g., +1234567890)
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
      */
-    phoneNumber: string;
+    'x-profile-id'?: string;
 }
-export interface ContactRetrieveIDParams {
+export declare namespace ContactDeleteParams {
     /**
-     * The unique identifier (GUID) of the resource to retrieve
+     * Request to delete/dissociate a contact
      */
-    id: string;
+    interface Body extends WebhooksAPI.MutationRequest {
+    }
 }
 export declare namespace Contacts {
-    export { type ContactListItem as ContactListItem, type ContactListResponse as ContactListResponse, type ContactListParams as ContactListParams, type ContactRetrieveByPhoneParams as ContactRetrieveByPhoneParams, type ContactRetrieveIDParams as ContactRetrieveIDParams, };
+    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, };
 }
 //# sourceMappingURL=contacts.d.ts.map

package/resources/contacts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contacts.d.ts","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIzF;;;;OAIG;IACH,eAAe,CACb,KAAK,EAAE,4BAA4B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAI9B;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;CAGlG;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE/B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"contacts.d.ts","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAe/F;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAWnC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAenC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAY1F;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAW5F;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAE9C;;WAEG;QACH,UAAU,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;KACzC;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAK,SAAQ,WAAW,CAAC,eAAe;KAAG;CAC7D;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/contacts.js

@@ -3,30 +3,127 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Contacts = void 0;
 const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Create, update, and manage customer contact lists
+ */
 class Contacts extends resource_1.APIResource {
     /**
-     * Retrieves a paginated list of contacts for the authenticated customer. Supports
-     * server-side pagination with configurable page size. The customer ID is extracted
-     * from the authentication token.
+     * Creates a new contact by phone number and associates it with the authenticated
+     * customer.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfContact = await client.contacts.create();
+     * ```
+     */
+    create(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+        return this._client.post('/v3/contacts', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves a specific contact by their unique identifier. Returns detailed
+     * contact information including phone formats, available channels, and opt-out
+     * status.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfContact = await client.contacts.retrieve(
+     *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+     * );
+     * ```
      */
-    list(query, options) {
-        return this._client.get('/v2/contacts', { query, ...options });
+    retrieve(id, params = {}, options) {
+        const { 'x-profile-id': xProfileID } = params ?? {};
+        return this._client.get((0, path_1.path) `/v3/contacts/${id}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
     }
     /**
-     * Retrieves a contact by their phone number for the authenticated customer. Phone
-     * number should be in international format (e.g., +1234567890). The customer ID is
-     * extracted from the authentication token.
+     * Updates a contact's default channel and/or opt-out status. Inherited contacts
+     * cannot be updated.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfContact = await client.contacts.update(
+     *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+     * );
+     * ```
+     */
+    update(id, params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+        return this._client.patch((0, path_1.path) `/v3/contacts/${id}`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves a paginated list of contacts for the authenticated customer. Supports
+     * filtering by search term, channel, or phone number.
+     *
+     * @example
+     * ```ts
+     * const contacts = await client.contacts.list({
+     *   page: 0,
+     *   page_size: 0,
+     * });
+     * ```
      */
-    retrieveByPhone(query, options) {
-        return this._client.get('/v2/contacts/phone', { query, ...options });
+    list(params, options) {
+        const { 'x-profile-id': xProfileID, ...query } = params;
+        return this._client.get('/v3/contacts', {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
     }
     /**
-     * Retrieves a specific contact by their unique identifier for the authenticated
-     * customer. The customer ID is extracted from the authentication token. Returns
-     * detailed contact information including phone number and creation timestamp.
+     * Dissociates a contact from the authenticated customer. Inherited contacts cannot
+     * be deleted.
+     *
+     * @example
+     * ```ts
+     * await client.contacts.delete(
+     *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+     *   { body: {} },
+     * );
+     * ```
      */
-    retrieveID(query, options) {
-        return this._client.get('/v2/contacts/id', { query, ...options });
+    delete(id, params, options) {
+        const { body, 'x-profile-id': xProfileID } = params;
+        return this._client.delete((0, path_1.path) `/v3/contacts/${id}`, {
+            body: body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { Accept: '*/*', ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
     }
 }
 exports.Contacts = Contacts;

package/resources/contacts.js.map

@@ -1 +1 @@
-{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;OAIG;IACH,IAAI,CAAC,KAAwB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACH,eAAe,CACb,KAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,KAA8B,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;CACF;AA9BD,4BA8BC"}
+{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;OAQG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YAClD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAyB,EAAE,OAAwB;QACtD,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YACtC,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,IAAI,EAAE,IAAI;YACV,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAjID,4BAiIC"}

package/resources/contacts.mjs

@@ -1,29 +1,126 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * Create, update, and manage customer contact lists
+ */
 export class Contacts extends APIResource {
     /**
-     * Retrieves a paginated list of contacts for the authenticated customer. Supports
-     * server-side pagination with configurable page size. The customer ID is extracted
-     * from the authentication token.
+     * Creates a new contact by phone number and associates it with the authenticated
+     * customer.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfContact = await client.contacts.create();
+     * ```
+     */
+    create(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+        return this._client.post('/v3/contacts', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves a specific contact by their unique identifier. Returns detailed
+     * contact information including phone formats, available channels, and opt-out
+     * status.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfContact = await client.contacts.retrieve(
+     *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+     * );
+     * ```
      */
-    list(query, options) {
-        return this._client.get('/v2/contacts', { query, ...options });
+    retrieve(id, params = {}, options) {
+        const { 'x-profile-id': xProfileID } = params ?? {};
+        return this._client.get(path `/v3/contacts/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
     }
     /**
-     * Retrieves a contact by their phone number for the authenticated customer. Phone
-     * number should be in international format (e.g., +1234567890). The customer ID is
-     * extracted from the authentication token.
+     * Updates a contact's default channel and/or opt-out status. Inherited contacts
+     * cannot be updated.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfContact = await client.contacts.update(
+     *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+     * );
+     * ```
+     */
+    update(id, params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+        return this._client.patch(path `/v3/contacts/${id}`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves a paginated list of contacts for the authenticated customer. Supports
+     * filtering by search term, channel, or phone number.
+     *
+     * @example
+     * ```ts
+     * const contacts = await client.contacts.list({
+     *   page: 0,
+     *   page_size: 0,
+     * });
+     * ```
      */
-    retrieveByPhone(query, options) {
-        return this._client.get('/v2/contacts/phone', { query, ...options });
+    list(params, options) {
+        const { 'x-profile-id': xProfileID, ...query } = params;
+        return this._client.get('/v3/contacts', {
+            query,
+            ...options,
+            headers: buildHeaders([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
     }
     /**
-     * Retrieves a specific contact by their unique identifier for the authenticated
-     * customer. The customer ID is extracted from the authentication token. Returns
-     * detailed contact information including phone number and creation timestamp.
+     * Dissociates a contact from the authenticated customer. Inherited contacts cannot
+     * be deleted.
+     *
+     * @example
+     * ```ts
+     * await client.contacts.delete(
+     *   '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+     *   { body: {} },
+     * );
+     * ```
      */
-    retrieveID(query, options) {
-        return this._client.get('/v2/contacts/id', { query, ...options });
+    delete(id, params, options) {
+        const { body, 'x-profile-id': xProfileID } = params;
+        return this._client.delete(path `/v3/contacts/${id}`, {
+            body: body,
+            ...options,
+            headers: buildHeaders([
+                { Accept: '*/*', ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
     }
 }
 //# sourceMappingURL=contacts.mjs.map