@sentdm/sentdm 0.32.0 → 0.34.0

package/src/resources/profiles/profiles.ts

@@ -5,18 +5,18 @@ import * as ProfilesAPI from './profiles';
 import * as WebhooksAPI from '../webhooks';
 import * as CampaignsAPI from './campaigns';
 import {
-  APIResponseOfTcrCampaignWithUseCases,
-  BaseDto,
+  APIResponseOfBrandCampaign,
+  APIResponseOfListOfBrandCampaign,
+  BrandCampaign,
   CampaignCreateParams,
   CampaignData,
   CampaignDeleteParams,
   CampaignListParams,
-  CampaignListResponse,
   CampaignUpdateParams,
+  CampaignUseCase,
+  CampaignUseCaseData,
   Campaigns,
   MessagingUseCaseUs,
-  SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData,
-  TcrCampaignWithUseCases,
 } from './campaigns';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
@@ -96,7 +96,9 @@ export class Profiles extends APIResource {
    * @example
    * ```ts
    * const apiResponseOfProfileDetail =
-   *   await client.profiles.retrieve('profileId');
+   *   await client.profiles.retrieve(
+   *     '770e8400-e29b-41d4-a716-446655440002',
+   *   );
    * ```
    */
   retrieve(
@@ -137,7 +139,9 @@ export class Profiles extends APIResource {
    * @example
    * ```ts
    * const apiResponseOfProfileDetail =
-   *   await client.profiles.update('profileId');
+   *   await client.profiles.update(
+   *     '770e8400-e29b-41d4-a716-446655440002',
+   *   );
    * ```
    */
   update(
@@ -190,7 +194,9 @@ export class Profiles extends APIResource {
    *
    * @example
    * ```ts
-   * await client.profiles.delete('profileId');
+   * await client.profiles.delete(
+   *   '770e8400-e29b-41d4-a716-446655440002',
+   * );
    * ```
    */
   delete(profileID: string, params: ProfileDeleteParams, options?: RequestOptions): APIPromise<void> {
@@ -206,24 +212,36 @@ export class Profiles extends APIResource {
   }
 
   /**
-   * Final step in profile compliance workflow. Validates all prerequisites (general
-   * data, brand, campaigns), connects profile to Telnyx/WhatsApp, and sets status
-   * based on configuration. The process runs in the background and calls the
-   * provided webhook URL when finished.
+   * Final step in the profile compliance workflow. Validates all prerequisites (KYC,
+   * brand, campaigns, required documents), connects the profile to the SMS and
+   * WhatsApp channels, and sets its status based on configuration. Prerequisites are
+   * always validated first: if any fail the call returns 400. If they pass and the
+   * profile is already completed, the call returns 200 and does nothing. Otherwise
+   * it returns 202 and calls the provided webhook URL when background processing
+   * finishes.
+   *
+   * Prerequisites:
    *
-   *                 Prerequisites:
-   *                 - Profile must be completed
-   *                 - If inheritTcrBrand=false: Profile must have existing brand
-   *                 - If inheritTcrBrand=true: Parent must have existing brand
-   *                 - If TCR application: Must have at least one campaign (own or inherited)
-   *                 - If inheritTcrCampaign=false: Profile should have campaigns
-   *                 - If inheritTcrCampaign=true: Parent must have campaigns
+   * - Profile must have a name, short name, and description (short name max 50
+   *   characters, description max 5000)
+   * - webHookUrl must be supplied on the request
+   * - A KYC form submission is required
+   * - A brand is required, either on the profile or inherited from the parent
+   *   organization
+   * - TCR applications must have at least one campaign, own or inherited
+   * - Destination countries marked as main must have their required compliance
+   *   documents uploaded
    *
-   *                 Status Logic:
-   *                 - If both SMS and WhatsApp channels are missing → SUBMITTED
-   *                 - If TCR application and not inheriting brand/campaigns → SUBMITTED
-   *                 - If non-TCR with destination country (IsMain=true) → SUBMITTED
-   *                 - Otherwise → COMPLETED
+   * Resulting status:
+   *
+   * - If either the SMS or WhatsApp channel is unconfigured, the profile is
+   *   SUBMITTED
+   * - For a TCR application that inherits both its brand and its campaigns, the
+   *   profile is COMPLETED
+   * - For a TCR application that owns either its brand or its campaigns, the profile
+   *   is COMPLETED once both have been submitted to TCR, and SUBMITTED until then
+   * - For a non-TCR application, the profile is SUBMITTED when a main destination
+   *   country is set, and COMPLETED otherwise
    *
    * @example
    * ```ts
@@ -308,6 +326,132 @@ export interface BillingContactInfo {
   phone?: string | null;
 }
 
+/**
+ * Business details and address for brand KYC
+ */
+export interface BrandBusinessInfo {
+  /**
+   * City
+   */
+  city?: string | null;
+
+  /**
+   * Country code (e.g., US, CA)
+   */
+  country?: string | null;
+
+  /**
+   * Country where the business is registered
+   */
+  countryOfRegistration?: string | null;
+
+  entityType?: 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'SOLE_PROPRIETOR' | 'GOVERNMENT' | null;
+
+  /**
+   * Legal business name
+   */
+  legalName?: string | null;
+
+  /**
+   * Postal/ZIP code
+   */
+  postalCode?: string | null;
+
+  /**
+   * State/province code
+   */
+  state?: string | null;
+
+  /**
+   * Street address
+   */
+  street?: string | null;
+
+  /**
+   * Tax ID/EIN number
+   */
+  taxId?: string | null;
+
+  /**
+   * Type of tax ID (e.g., us_ein, ca_bn)
+   */
+  taxIdType?: string | null;
+
+  /**
+   * Business website URL
+   */
+  url?: string | null;
+}
+
+/**
+ * Compliance and TCR information for brand registration
+ */
+export interface BrandComplianceInfo {
+  brandRelationship: TcrBrandRelationship;
+
+  vertical: TcrVertical;
+
+  /**
+   * List of destination countries for messaging
+   */
+  destinationCountries?: Array<DestinationCountry> | null;
+
+  /**
+   * Whether this is a TCR (Campaign Registry) application
+   */
+  isTcrApplication?: boolean | null;
+
+  /**
+   * Additional notes about the business or use case
+   */
+  notes?: string | null;
+
+  /**
+   * Phone number prefix for messaging (e.g., "+1")
+   */
+  phoneNumberPrefix?: string | null;
+
+  /**
+   * Primary messaging use case description
+   */
+  primaryUseCase?: string | null;
+}
+
+/**
+ * Contact information for brand KYC
+ */
+export interface BrandContactInfo {
+  /**
+   * Primary contact name (required)
+   */
+  name: string;
+
+  /**
+   * Business/brand name
+   */
+  businessName?: string | null;
+
+  /**
+   * Contact email address
+   */
+  email?: string | null;
+
+  /**
+   * Contact phone number in E.164 format
+   */
+  phone?: string | null;
+
+  /**
+   * Contact phone country code (e.g., "1" for US)
+   */
+  phoneCountryCode?: string | null;
+
+  /**
+   * Contact's role in the business
+   */
+  role?: string | null;
+}
+
 /**
  * Brand and KYC data grouped into contact, business, and compliance sections
  */
@@ -315,17 +459,17 @@ export interface BrandsBrandData {
   /**
    * Compliance and TCR information for brand registration
    */
-  compliance: SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo;
+  compliance: BrandComplianceInfo;
 
   /**
    * Contact information for brand KYC
    */
-  contact: SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo;
+  contact: BrandContactInfo;
 
   /**
    * Business details and address for brand KYC
    */
-  business?: SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo | null;
+  business?: BrandBusinessInfo | null;
 }
 
 export interface DestinationCountry {
@@ -457,7 +601,7 @@ export interface ProfileDetail {
   sending_phone_number?: string | null;
 
   /**
-   * Reference to another profile for SMS/Telnyx configuration
+   * Reference to another profile whose SMS configuration this profile uses
    */
   sending_phone_number_profile_id?: string | null;
 
@@ -539,7 +683,10 @@ export namespace ProfileDetail {
     created_at?: string;
 
     /**
-     * CSP (Campaign Service Provider) ID
+     * @deprecated Deprecated and scheduled for removal. Identifies the Campaign
+     * Service Provider that registered the brand, which is Sent, so the value is the
+     * same for every brand and every account. Nothing on your side can act on it and
+     * there is no replacement. Stop reading it.
      */
     csp_id?: string | null;
 
@@ -650,11 +797,6 @@ export namespace ProfileDetail {
        */
       destination_countries?: Array<ProfilesAPI.DestinationCountry>;
 
-      /**
-       * Expected daily messaging volume
-       */
-      expected_messaging_volume?: string | null;
-
       /**
        * Whether this is a TCR (Campaign Registry) application
        */
@@ -715,137 +857,6 @@ export namespace ProfileDetail {
   }
 }
 
-/**
- * Business details and address for brand KYC
- */
-export interface SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo {
-  /**
-   * City
-   */
-  city?: string | null;
-
-  /**
-   * Country code (e.g., US, CA)
-   */
-  country?: string | null;
-
-  /**
-   * Country where the business is registered
-   */
-  countryOfRegistration?: string | null;
-
-  entityType?: 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'SOLE_PROPRIETOR' | 'GOVERNMENT' | null;
-
-  /**
-   * Legal business name
-   */
-  legalName?: string | null;
-
-  /**
-   * Postal/ZIP code
-   */
-  postalCode?: string | null;
-
-  /**
-   * State/province code
-   */
-  state?: string | null;
-
-  /**
-   * Street address
-   */
-  street?: string | null;
-
-  /**
-   * Tax ID/EIN number
-   */
-  taxId?: string | null;
-
-  /**
-   * Type of tax ID (e.g., us_ein, ca_bn)
-   */
-  taxIdType?: string | null;
-
-  /**
-   * Business website URL
-   */
-  url?: string | null;
-}
-
-/**
- * Compliance and TCR information for brand registration
- */
-export interface SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo {
-  brandRelationship: TcrBrandRelationship;
-
-  vertical: TcrVertical;
-
-  /**
-   * List of destination countries for messaging
-   */
-  destinationCountries?: Array<DestinationCountry> | null;
-
-  /**
-   * Expected daily messaging volume
-   */
-  expectedMessagingVolume?: string | null;
-
-  /**
-   * Whether this is a TCR (Campaign Registry) application
-   */
-  isTcrApplication?: boolean | null;
-
-  /**
-   * Additional notes about the business or use case
-   */
-  notes?: string | null;
-
-  /**
-   * Phone number prefix for messaging (e.g., "+1")
-   */
-  phoneNumberPrefix?: string | null;
-
-  /**
-   * Primary messaging use case description
-   */
-  primaryUseCase?: string | null;
-}
-
-/**
- * Contact information for brand KYC
- */
-export interface SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo {
-  /**
-   * Primary contact name (required)
-   */
-  name: string;
-
-  /**
-   * Business/brand name
-   */
-  businessName?: string | null;
-
-  /**
-   * Contact email address
-   */
-  email?: string | null;
-
-  /**
-   * Contact phone number in E.164 format
-   */
-  phone?: string | null;
-
-  /**
-   * Contact phone country code (e.g., "1" for US)
-   */
-  phoneCountryCode?: string | null;
-
-  /**
-   * Contact's role in the business
-   */
-  role?: string | null;
-}
-
 export type TcrBrandRelationship =
   | 'BASIC_ACCOUNT'
   | 'MEDIUM_ACCOUNT'
@@ -1212,8 +1223,7 @@ export interface ProfileUpdateParams {
   sending_phone_number?: string | null;
 
   /**
-   * Body param: Reference to another profile to use for SMS/Telnyx configuration
-   * (optional)
+   * Body param: Reference to another profile to use for SMS configuration (optional)
    */
   sending_phone_number_profile_id?: string | null;
 
@@ -1307,13 +1317,13 @@ export declare namespace Profiles {
   export {
     type APIResponseOfProfileDetail as APIResponseOfProfileDetail,
     type BillingContactInfo as BillingContactInfo,
+    type BrandBusinessInfo as BrandBusinessInfo,
+    type BrandComplianceInfo as BrandComplianceInfo,
+    type BrandContactInfo as BrandContactInfo,
     type BrandsBrandData as BrandsBrandData,
     type DestinationCountry as DestinationCountry,
     type PaymentDetails as PaymentDetails,
     type ProfileDetail as ProfileDetail,
-    type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo as SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo,
-    type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo as SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo,
-    type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo as SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo,
     type TcrBrandRelationship as TcrBrandRelationship,
     type TcrVertical as TcrVertical,
     type ProfileListResponse as ProfileListResponse,
@@ -1328,13 +1338,13 @@ export declare namespace Profiles {
 
   export {
     Campaigns as Campaigns,
-    type APIResponseOfTcrCampaignWithUseCases as APIResponseOfTcrCampaignWithUseCases,
-    type BaseDto as BaseDto,
+    type APIResponseOfBrandCampaign as APIResponseOfBrandCampaign,
+    type APIResponseOfListOfBrandCampaign as APIResponseOfListOfBrandCampaign,
+    type BrandCampaign as BrandCampaign,
     type CampaignData as CampaignData,
+    type CampaignUseCase as CampaignUseCase,
+    type CampaignUseCaseData as CampaignUseCaseData,
     type MessagingUseCaseUs as MessagingUseCaseUs,
-    type SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData as SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData,
-    type TcrCampaignWithUseCases as TcrCampaignWithUseCases,
-    type CampaignListResponse as CampaignListResponse,
     type CampaignCreateParams as CampaignCreateParams,
     type CampaignUpdateParams as CampaignUpdateParams,
     type CampaignListParams as CampaignListParams,