@sentdm/sentdm 0.7.2 → 0.14.0

package/src/resources/contacts.ts

@@ -1,142 +1,420 @@
 // 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';
+import { path } from '../internal/utils/path';
 
+/**
+ * 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();
+   * ```
    */
-  list(query: ContactListParams, options?: RequestOptions): APIPromise<ContactListResponse> {
-    return this._client.get('/v2/contacts', { query, ...options });
+  create(params: ContactCreateParams, options?: RequestOptions): APIPromise<APIResponseOfContact> {
+    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 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.
+   * 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',
+   * );
+   * ```
    */
-  retrieveByPhone(
-    query: ContactRetrieveByPhoneParams,
+  retrieve(
+    id: string,
+    params: ContactRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ContactListItem> {
-    return this._client.get('/v2/contacts/phone', { query, ...options });
+  ): APIPromise<APIResponseOfContact> {
+    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,
+      ]),
+    });
+  }
+
+  /**
+   * 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> {
+    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,
+   * });
+   * ```
+   */
+  list(params: ContactListParams, options?: RequestOptions): APIPromise<ContactListResponse> {
+    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: ContactRetrieveIDParams, options?: RequestOptions): APIPromise<ContactListItem> {
-    return this._client.get('/v2/contacts/id', { query, ...options });
+  delete(id: string, params: ContactDeleteParams, options?: RequestOptions): APIPromise<void> {
+    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,
+      ]),
+    });
   }
 }
 
 /**
- * Represents a contact in the customer's contact list
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfContact {
+  /**
+   * Contact response for v3 API Uses snake_case for JSON property names
+   */
+  data?: ContactResponse | null;
+
+  /**
+   * Error information
+   */
+  error?: WebhooksAPI.ErrorDetail | null;
+
+  /**
+   * Request and response metadata
+   */
+  meta?: WebhooksAPI.APIMeta;
+
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
+
+/**
+ * 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")
+   */
+  default_channel?: string;
+
+  /**
+   * Phone number in E.164 format (e.g., +1234567890)
    */
-  availableChannels?: string;
+  format_e164?: string;
 
   /**
-   * The country calling code (e.g., 1 for US/Canada)
+   * Phone number in international format (e.g., +1 234-567-890)
    */
-  countryCode?: string;
+  format_international?: string;
 
   /**
-   * The default messaging channel to use for this contact (e.g., "sms" or
-   * "whatsapp")
+   * Phone number in national format (e.g., (234) 567-890)
    */
-  defaultChannel?: string;
+  format_national?: string;
 
   /**
-   * The phone number formatted in E.164 standard (e.g., +1234567890)
+   * Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
    */
-  formatE164?: string;
+  format_rfc?: string;
 
   /**
-   * The phone number formatted for international dialing (e.g., +1 234-567-890)
+   * Whether this is an inherited contact (read-only)
    */
-  formatInternational?: string;
+  is_inherited?: boolean;
 
   /**
-   * The phone number formatted for national dialing (e.g., (234) 567-890)
+   * Whether the contact has opted out of messaging
    */
-  formatNational?: string;
+  opt_out?: boolean;
 
   /**
-   * The phone number formatted according to RFC 3966 (e.g., tel:+1-234-567-890)
+   * Phone number in original format
    */
-  formatRfc?: string;
+  phone_number?: string;
 
   /**
-   * The phone number in its original format
+   * ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
    */
-  phoneNumber?: string;
+  region_code?: string;
 
   /**
-   * The ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+   * When the contact was last updated
    */
-  regionCode?: string;
+  updated_at?: string | null;
 }
 
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
 export interface ContactListResponse {
-  items?: Array<ContactListItem>;
+  /**
+   * Paginated list of contacts response
+   */
+  data?: ContactListResponse.Data | null;
 
-  page?: number;
+  /**
+   * Error information
+   */
+  error?: WebhooksAPI.ErrorDetail | null;
 
-  pageSize?: number;
+  /**
+   * Request and response metadata
+   */
+  meta?: WebhooksAPI.APIMeta;
 
-  totalCount?: number;
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
 
-  totalPages?: number;
+export namespace ContactListResponse {
+  /**
+   * Paginated list of contacts response
+   */
+  export 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 namespace ContactDeleteParams {
   /**
-   * The unique identifier (GUID) of the resource to retrieve
+   * Request to delete/dissociate a contact
    */
-  id: string;
+  export interface Body extends WebhooksAPI.MutationRequest {}
 }
 
 export declare namespace Contacts {
   export {
-    type ContactListItem as ContactListItem,
+    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 ContactRetrieveByPhoneParams as ContactRetrieveByPhoneParams,
-    type ContactRetrieveIDParams as ContactRetrieveIDParams,
+    type ContactDeleteParams as ContactDeleteParams,
   };
 }

package/src/resources/index.ts

@@ -2,31 +2,100 @@
 
 export {
   Contacts,
-  type ContactListItem,
+  type APIResponseOfContact,
+  type ContactResponse,
   type ContactListResponse,
+  type ContactCreateParams,
+  type ContactRetrieveParams,
+  type ContactUpdateParams,
   type ContactListParams,
-  type ContactRetrieveByPhoneParams,
-  type ContactRetrieveIDParams,
+  type ContactDeleteParams,
 } from './contacts';
+export { Me, type ProfileSettings, type MeRetrieveResponse, type MeRetrieveParams } from './me';
 export {
   Messages,
-  type MessageRetrieveResponse,
-  type MessageSendQuickMessageParams,
-  type MessageSendToContactParams,
-  type MessageSendToPhoneParams,
+  type MessageRetrieveActivitiesResponse,
+  type MessageRetrieveStatusResponse,
+  type MessageSendResponse,
+  type MessageRetrieveActivitiesParams,
+  type MessageRetrieveStatusParams,
+  type MessageSendParams,
 } from './messages';
+export { Numbers, type NumberLookupResponse, type NumberLookupParams } from './numbers';
 export {
-  NumberLookup,
-  type NumberLookupRetrieveResponse,
-  type NumberLookupRetrieveParams,
-} from './number-lookup';
+  Profiles,
+  type APIResponseOfProfileDetail,
+  type BillingContactInfo,
+  type BrandsBrandData,
+  type DestinationCountry,
+  type PaymentDetails,
+  type ProfileDetail,
+  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo,
+  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo,
+  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo,
+  type TcrBrandRelationship,
+  type TcrVertical,
+  type ProfileListResponse,
+  type ProfileCompleteResponse,
+  type ProfileCreateParams,
+  type ProfileRetrieveParams,
+  type ProfileUpdateParams,
+  type ProfileListParams,
+  type ProfileDeleteParams,
+  type ProfileCompleteParams,
+} from './profiles/profiles';
 export {
   Templates,
+  type APIResponseTemplate,
+  type SentDmServicesCommonContractsPocOsAuthenticationConfig,
+  type SentDmServicesCommonContractsPocOsTemplateBody,
+  type SentDmServicesCommonContractsPocOsTemplateButton,
+  type SentDmServicesCommonContractsPocOsTemplateButtonProps,
+  type SentDmServicesCommonContractsPocOsTemplateFooter,
+  type SentDmServicesCommonContractsPocOsTemplateHeader,
+  type Template,
   type TemplateBodyContent,
   type TemplateDefinition,
-  type TemplateResponseV2,
   type TemplateVariable,
   type TemplateListResponse,
   type TemplateCreateParams,
+  type TemplateRetrieveParams,
+  type TemplateUpdateParams,
   type TemplateListParams,
+  type TemplateDeleteParams,
 } from './templates';
+export {
+  Users,
+  type APIResponseOfUser,
+  type UserResponse,
+  type UserListResponse,
+  type UserRetrieveParams,
+  type UserListParams,
+  type UserInviteParams,
+  type UserRemoveParams,
+  type UserUpdateRoleParams,
+} from './users';
+export {
+  Webhooks,
+  type APIMeta,
+  type APIResponseWebhook,
+  type ErrorDetail,
+  type MutationRequest,
+  type PaginationMeta,
+  type WebhookResponse,
+  type WebhookListResponse,
+  type WebhookListEventTypesResponse,
+  type WebhookListEventsResponse,
+  type WebhookRotateSecretResponse,
+  type WebhookTestResponse,
+  type WebhookCreateParams,
+  type WebhookRetrieveParams,
+  type WebhookUpdateParams,
+  type WebhookListParams,
+  type WebhookDeleteParams,
+  type WebhookListEventTypesParams,
+  type WebhookListEventsParams,
+  type WebhookRotateSecretParams,
+  type WebhookTestParams,
+  type WebhookToggleStatusParams,
+} from './webhooks';