@sentdm/sentdm 0.7.2 → 0.15.0

package/resources/profiles/profiles.d.mts

@@ -0,0 +1,967 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as ProfilesAPI from "./profiles.mjs";
+import * as WebhooksAPI from "../webhooks.mjs";
+import * as CampaignsAPI from "./campaigns.mjs";
+import { APIResponseOfTcrCampaignWithUseCases, BaseDto, CampaignCreateParams, CampaignData, CampaignDeleteParams, CampaignListParams, CampaignListResponse, CampaignUpdateParams, Campaigns, MessagingUseCaseUs, SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData, TcrCampaignWithUseCases } from "./campaigns.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Manage organization profiles
+ */
+export declare class Profiles extends APIResource {
+    campaigns: CampaignsAPI.Campaigns;
+    /**
+     * Creates a new sender profile within an organization. Profiles represent
+     * different brands, departments, or use cases, each with their own messaging
+     * configuration and settings. Requires admin role in the organization.
+     *
+     * ## WhatsApp Business Account
+     *
+     * Every profile must be linked to a WhatsApp Business Account. There are two ways
+     * to do this:
+     *
+     * **1. Inherit from organization (default)** — Omit the
+     * `whatsapp_business_account` field. The profile will share the organization's
+     * WhatsApp Business Account, which must have been set up via WhatsApp Embedded
+     * Signup. This is the recommended path for most use cases.
+     *
+     * **2. Direct credentials** — Provide a `whatsapp_business_account` object with
+     * `waba_id`, `phone_number_id`, and `access_token`. Use this when the profile
+     * needs its own independent WhatsApp Business Account. Obtain these from Meta
+     * Business Manager by creating a System User with `whatsapp_business_messaging`
+     * and `whatsapp_business_management` permissions.
+     *
+     * If the `whatsapp_business_account` field is omitted and the organization has no
+     * WhatsApp Business Account configured, the request will be rejected with
+     * HTTP 422.
+     *
+     * ## Brand
+     *
+     * Include the optional `brand` field to create the brand for this profile at the
+     * same time. Cannot be used when `inherit_tcr_brand` is `true`.
+     *
+     * ## Payment Details
+     *
+     * When `billing_model` is `"profile"` or `"profile_and_organization"` you may
+     * include a `payment_details` object containing the card number, expiry (MM/YY),
+     * CVC, and billing ZIP code. Payment details are **never stored** on our servers
+     * and are forwarded directly to the payment processor. Providing `payment_details`
+     * when `billing_model` is `"organization"` is not allowed.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfProfileDetail =
+     *   await client.profiles.create();
+     * ```
+     */
+    create(params: ProfileCreateParams, options?: RequestOptions): APIPromise<APIResponseOfProfileDetail>;
+    /**
+     * Retrieves detailed information about a specific sender profile within an
+     * organization, including brand and KYC information if a brand has been
+     * configured.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfProfileDetail =
+     *   await client.profiles.retrieve('profileId');
+     * ```
+     */
+    retrieve(profileID: string, params?: ProfileRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfProfileDetail>;
+    /**
+     * Updates a profile's configuration and settings. Requires admin role in the
+     * organization. Only provided fields will be updated (partial update).
+     *
+     * ## Brand Management
+     *
+     * Include the optional `brand` field to create or update the brand associated with
+     * this profile. The brand holds KYC and TCR compliance data (legal business info,
+     * contact details, messaging vertical). Once a brand has been submitted to TCR it
+     * cannot be modified. Setting `inherit_tcr_brand: true` and providing `brand` in
+     * the same request is not allowed.
+     *
+     * ## Payment Details
+     *
+     * When `billing_model` is `"profile"` or `"profile_and_organization"` you may
+     * include a `payment_details` object containing the card number, expiry (MM/YY),
+     * CVC, and billing ZIP code. Payment details are **never stored** on our servers
+     * and are forwarded directly to the payment processor. Providing `payment_details`
+     * when `billing_model` is `"organization"` is not allowed.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfProfileDetail =
+     *   await client.profiles.update('profileId');
+     * ```
+     */
+    update(profileID: string, params: ProfileUpdateParams, options?: RequestOptions): APIPromise<APIResponseOfProfileDetail>;
+    /**
+     * Retrieves all sender profiles within an organization, including brand
+     * information for each profile. Profiles represent different brands, departments,
+     * or use cases within an organization, each with their own messaging
+     * configuration.
+     *
+     * @example
+     * ```ts
+     * const profiles = await client.profiles.list();
+     * ```
+     */
+    list(params?: ProfileListParams | null | undefined, options?: RequestOptions): APIPromise<ProfileListResponse>;
+    /**
+     * Soft deletes a sender profile. The profile will be marked as deleted but data is
+     * retained. Requires admin role in the organization.
+     *
+     * @example
+     * ```ts
+     * await client.profiles.delete('profileId', { body: {} });
+     * ```
+     */
+    delete(profileID: string, params: ProfileDeleteParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * 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.
+     *
+     *                 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
+     *
+     *                 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
+     *
+     * @example
+     * ```ts
+     * const response = await client.profiles.complete(
+     *   '660e8400-e29b-41d4-a716-446655440000',
+     *   {
+     *     webHookUrl:
+     *       'https://your-app.com/webhook/profile-complete',
+     *   },
+     * );
+     * ```
+     */
+    complete(profileID: string, params: ProfileCompleteParams, options?: RequestOptions): APIPromise<unknown>;
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfProfileDetail {
+    /**
+     * Detailed profile response for v3 API
+     */
+    data?: ProfileDetail | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+/**
+ * Billing contact information for a profile. Required when billing_model is
+ * "profile" or "profile_and_organization".
+ */
+export interface BillingContactInfo {
+    /**
+     * Email address where invoices will be sent (required)
+     */
+    email: string;
+    /**
+     * Full name of the billing contact or company (required)
+     */
+    name: string;
+    /**
+     * Billing address (optional). Free-form text including street, city, state, postal
+     * code, and country.
+     */
+    address?: string | null;
+    /**
+     * Phone number for the billing contact (optional)
+     */
+    phone?: string | null;
+}
+/**
+ * Brand and KYC data grouped into contact, business, and compliance sections
+ */
+export interface BrandsBrandData {
+    /**
+     * Compliance and TCR information for brand registration
+     */
+    compliance: SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo;
+    /**
+     * Contact information for brand KYC
+     */
+    contact: SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo;
+    /**
+     * Business details and address for brand KYC
+     */
+    business?: SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo | null;
+}
+export interface DestinationCountry {
+    id?: string;
+    isMain?: boolean;
+}
+/**
+ * Payment card details for a profile. Accepted when billing_model is "profile" or
+ * "profile_and_organization". These details are not stored on our servers and will
+ * be forwarded to the payment processor.
+ */
+export interface PaymentDetails {
+    /**
+     * Card number (digits only, 13–19 characters)
+     */
+    card_number: string;
+    /**
+     * Card security code (3–4 digits)
+     */
+    cvc: string;
+    /**
+     * Card expiry date in MM/YY format (e.g. "09/27")
+     */
+    expiry: string;
+    /**
+     * Billing ZIP / postal code associated with the card
+     */
+    zip_code: string;
+}
+/**
+ * Detailed profile response for v3 API
+ */
+export interface ProfileDetail {
+    /**
+     * Profile unique identifier
+     */
+    id?: string;
+    /**
+     * Whether contacts are shared across profiles in the organization
+     */
+    allow_contact_sharing?: boolean;
+    /**
+     * Whether number changes are allowed during onboarding
+     */
+    allow_number_change_during_onboarding?: boolean | null;
+    /**
+     * Whether templates are shared across profiles in the organization
+     */
+    allow_template_sharing?: boolean;
+    /**
+     * Billing contact info returned in profile responses
+     */
+    billing_contact?: ProfileDetail.BillingContact | null;
+    /**
+     * Billing model: profile, organization, or profile_and_organization
+     */
+    billing_model?: string;
+    /**
+     * Brand response with nested contact, business, and compliance sections — mirrors
+     * the request structure.
+     */
+    brand?: ProfileDetail.Brand | null;
+    /**
+     * When the profile was created
+     */
+    created_at?: string;
+    /**
+     * Profile description
+     */
+    description?: string | null;
+    /**
+     * Profile email (inherited from organization)
+     */
+    email?: string | null;
+    /**
+     * Profile icon URL
+     */
+    icon?: string | null;
+    /**
+     * Whether this profile inherits contacts from the organization
+     */
+    inherit_contacts?: boolean;
+    /**
+     * Whether this profile inherits TCR brand from the organization
+     */
+    inherit_tcr_brand?: boolean;
+    /**
+     * Whether this profile inherits TCR campaign from the organization
+     */
+    inherit_tcr_campaign?: boolean;
+    /**
+     * Whether this profile inherits templates from the organization
+     */
+    inherit_templates?: boolean;
+    /**
+     * Profile name
+     */
+    name?: string;
+    /**
+     * Parent organization ID
+     */
+    organization_id?: string | null;
+    /**
+     * Direct SMS phone number
+     */
+    sending_phone_number?: string | null;
+    /**
+     * Reference to another profile for SMS/Telnyx configuration
+     */
+    sending_phone_number_profile_id?: string | null;
+    /**
+     * Reference to another profile for WhatsApp configuration
+     */
+    sending_whatsapp_number_profile_id?: string | null;
+    /**
+     * Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces
+     * only, with at least one letter.
+     */
+    short_name?: string | null;
+    /**
+     * Profile setup status: incomplete, pending_review, approved, rejected
+     */
+    status?: string;
+    /**
+     * When the profile was last updated
+     */
+    updated_at?: string | null;
+    /**
+     * WhatsApp Business Account ID associated with this profile. Present whether the
+     * WABA is inherited from the organization or configured directly.
+     */
+    waba_id?: string | null;
+    /**
+     * Direct WhatsApp phone number
+     */
+    whatsapp_phone_number?: string | null;
+}
+export declare namespace ProfileDetail {
+    /**
+     * Billing contact info returned in profile responses
+     */
+    interface BillingContact {
+        address?: string | null;
+        email?: string | null;
+        name?: string | null;
+        phone?: string | null;
+    }
+    /**
+     * Brand response with nested contact, business, and compliance sections — mirrors
+     * the request structure.
+     */
+    interface Brand {
+        /**
+         * Unique identifier for the brand
+         */
+        id?: string;
+        /**
+         * Business details and address information
+         */
+        business?: Brand.Business | null;
+        /**
+         * Compliance and TCR-related information
+         */
+        compliance?: Brand.Compliance | null;
+        /**
+         * Contact information for the brand
+         */
+        contact?: Brand.Contact | null;
+        /**
+         * When the brand was created
+         */
+        created_at?: string;
+        /**
+         * CSP (Campaign Service Provider) ID
+         */
+        csp_id?: string | null;
+        identity_status?: 'SELF_DECLARED' | 'UNVERIFIED' | 'VERIFIED' | 'VETTED_VERIFIED' | null;
+        /**
+         * Whether this brand is inherited from the parent organization
+         */
+        is_inherited?: boolean;
+        status?: 'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | null;
+        /**
+         * When the brand was submitted to TCR
+         */
+        submitted_at?: string | null;
+        /**
+         * Whether this brand has been submitted to TCR
+         */
+        submitted_to_tcr?: boolean;
+        /**
+         * TCR brand ID (populated after TCR submission)
+         */
+        tcr_brand_id?: string | null;
+        /**
+         * Universal EIN from TCR
+         */
+        universal_ein?: string | null;
+        /**
+         * When the brand was last updated
+         */
+        updated_at?: string | null;
+    }
+    namespace Brand {
+        /**
+         * Business details and address information
+         */
+        interface Business {
+            /**
+             * City
+             */
+            city?: string | null;
+            /**
+             * Country code (e.g., US, CA)
+             */
+            country?: string | null;
+            /**
+             * Country where the business is registered
+             */
+            country_of_registration?: string | null;
+            /**
+             * Business entity type
+             */
+            entity_type?: string | null;
+            /**
+             * Legal business name
+             */
+            legal_name?: string | null;
+            /**
+             * Postal/ZIP code
+             */
+            postal_code?: string | null;
+            /**
+             * State/province code
+             */
+            state?: string | null;
+            /**
+             * Street address
+             */
+            street?: string | null;
+            /**
+             * Tax ID/EIN number
+             */
+            tax_id?: string | null;
+            /**
+             * Type of tax ID (e.g., us_ein, ca_bn)
+             */
+            tax_id_type?: string | null;
+            /**
+             * Business website URL
+             */
+            url?: string | null;
+        }
+        /**
+         * Compliance and TCR-related information
+         */
+        interface Compliance {
+            brand_relationship?: ProfilesAPI.TcrBrandRelationship | null;
+            /**
+             * List of destination countries for messaging
+             */
+            destination_countries?: Array<ProfilesAPI.DestinationCountry>;
+            /**
+             * Expected daily messaging volume
+             */
+            expected_messaging_volume?: string | null;
+            /**
+             * Whether this is a TCR (Campaign Registry) application
+             */
+            is_tcr_application?: boolean;
+            /**
+             * Additional notes about the business or use case
+             */
+            notes?: string | null;
+            /**
+             * Phone number prefix for messaging (e.g., "+1")
+             */
+            phone_number_prefix?: string | null;
+            /**
+             * Primary messaging use case description
+             */
+            primary_use_case?: string | null;
+            vertical?: ProfilesAPI.TcrVertical | null;
+        }
+        /**
+         * Contact information for the brand
+         */
+        interface Contact {
+            /**
+             * Business/brand name
+             */
+            business_name?: string | null;
+            /**
+             * Contact email address
+             */
+            email?: string | null;
+            /**
+             * Primary contact name
+             */
+            name?: string;
+            /**
+             * Contact phone number in E.164 format
+             */
+            phone?: string | null;
+            /**
+             * Contact phone country code (e.g., "1" for US)
+             */
+            phone_country_code?: string | null;
+            /**
+             * Contact's role in the business
+             */
+            role?: string | null;
+        }
+    }
+}
+/**
+ * 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' | 'LARGE_ACCOUNT' | 'SMALL_ACCOUNT' | 'KEY_ACCOUNT';
+export type TcrVertical = 'PROFESSIONAL' | 'REAL_ESTATE' | 'HEALTHCARE' | 'HUMAN_RESOURCES' | 'ENERGY' | 'ENTERTAINMENT' | 'RETAIL' | 'TRANSPORTATION' | 'AGRICULTURE' | 'INSURANCE' | 'POSTAL' | 'EDUCATION' | 'HOSPITALITY' | 'FINANCIAL' | 'POLITICAL' | 'GAMBLING' | 'LEGAL' | 'CONSTRUCTION' | 'NGO' | 'MANUFACTURING' | 'GOVERNMENT' | 'TECHNOLOGY' | 'COMMUNICATION';
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface ProfileListResponse {
+    /**
+     * List of profiles response
+     */
+    data?: ProfileListResponse.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 ProfileListResponse {
+    /**
+     * List of profiles response
+     */
+    interface Data {
+        /**
+         * List of profiles in the organization
+         */
+        profiles?: Array<ProfilesAPI.ProfileDetail>;
+    }
+}
+export type ProfileCompleteResponse = unknown;
+export interface ProfileCreateParams {
+    /**
+     * Body param: Whether contacts are shared across profiles (default: false)
+     */
+    allow_contact_sharing?: boolean;
+    /**
+     * Body param: Whether templates are shared across profiles (default: false)
+     */
+    allow_template_sharing?: boolean;
+    /**
+     * Body param: Billing contact information for a profile. Required when
+     * billing_model is "profile" or "profile_and_organization".
+     */
+    billing_contact?: BillingContactInfo | null;
+    /**
+     * Body param: Billing model: profile, organization, or profile_and_organization
+     * (default: profile).
+     *
+     * - "organization": the organization's billing details are used; no profile-level
+     *   billing info needed.
+     * - "profile": the profile is billed independently; billing_contact is required.
+     * - "profile_and_organization": the profile is billed first with the organization
+     *   as fallback; billing_contact is required.
+     */
+    billing_model?: string | null;
+    /**
+     * Body param: Brand and KYC data grouped into contact, business, and compliance
+     * sections
+     */
+    brand?: BrandsBrandData | null;
+    /**
+     * Body param: Profile description (optional)
+     */
+    description?: string | null;
+    /**
+     * Body param: Profile icon URL (optional)
+     */
+    icon?: string | null;
+    /**
+     * Body param: Whether this profile inherits contacts from organization (default:
+     * true)
+     */
+    inherit_contacts?: boolean | null;
+    /**
+     * Body param: Whether this profile inherits TCR brand from organization (default:
+     * true)
+     */
+    inherit_tcr_brand?: boolean | null;
+    /**
+     * Body param: Whether this profile inherits TCR campaign from organization
+     * (default: true)
+     */
+    inherit_tcr_campaign?: boolean | null;
+    /**
+     * Body param: Whether this profile inherits templates from organization (default:
+     * true)
+     */
+    inherit_templates?: boolean | null;
+    /**
+     * Body param: Profile name (required)
+     */
+    name?: string;
+    /**
+     * Body param: Payment card details for a profile. Accepted when billing_model is
+     * "profile" or "profile_and_organization". These details are not stored on our
+     * servers and will be forwarded to the payment processor.
+     */
+    payment_details?: PaymentDetails | null;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Body param: Profile short name/abbreviation (optional). Must be 3–11 characters,
+     * contain only letters, numbers, and spaces, and include at least one letter.
+     * Example: "SALES", "Mkt 2", "Support1".
+     */
+    short_name?: string | null;
+    /**
+     * Body param: Direct WhatsApp Business Account credentials for a profile. Use this
+     * when the profile should have its own WhatsApp Business Account instead of
+     * inheriting from the organization. Credentials must be obtained from Meta
+     * Business Manager by creating a System User with whatsapp_business_messaging and
+     * whatsapp_business_management scopes.
+     */
+    whatsapp_business_account?: ProfileCreateParams.WhatsappBusinessAccount | null;
+    /**
+     * 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 declare namespace ProfileCreateParams {
+    /**
+     * Direct WhatsApp Business Account credentials for a profile. Use this when the
+     * profile should have its own WhatsApp Business Account instead of inheriting from
+     * the organization. Credentials must be obtained from Meta Business Manager by
+     * creating a System User with whatsapp_business_messaging and
+     * whatsapp_business_management scopes.
+     */
+    interface WhatsappBusinessAccount {
+        /**
+         * System User access token with whatsapp_business_messaging and
+         * whatsapp_business_management permissions. This value is stored securely and
+         * never returned in API responses.
+         */
+        access_token: string;
+        /**
+         * WhatsApp Business Account ID from Meta Business Manager
+         */
+        waba_id: string;
+        /**
+         * Phone Number ID of an existing number already registered under this WABA in Meta
+         * Business Manager. Optional — when omitted, a number will be provisioned from our
+         * pool and registered in the WABA during the onboarding flow. When provided, the
+         * number must already exist in the WABA.
+         */
+        phone_number_id?: string | null;
+    }
+}
+export interface ProfileRetrieveParams {
+    /**
+     * 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 ProfileUpdateParams {
+    /**
+     * Body param: Whether contacts are shared across profiles (optional)
+     */
+    allow_contact_sharing?: boolean | null;
+    /**
+     * Body param: Whether number changes are allowed during onboarding (optional)
+     */
+    allow_number_change_during_onboarding?: boolean | null;
+    /**
+     * Body param: Whether templates are shared across profiles (optional)
+     */
+    allow_template_sharing?: boolean | null;
+    /**
+     * Body param: Billing contact information for a profile. Required when
+     * billing_model is "profile" or "profile_and_organization".
+     */
+    billing_contact?: BillingContactInfo | null;
+    /**
+     * Body param: Billing model: profile, organization, or profile_and_organization
+     * (optional).
+     *
+     * - "organization": the organization's billing details are used; no profile-level
+     *   billing info needed.
+     * - "profile": the profile is billed independently; billing_contact is required.
+     * - "profile_and_organization": the profile is billed first with the organization
+     *   as fallback; billing_contact is required.
+     */
+    billing_model?: string | null;
+    /**
+     * Body param: Brand and KYC data grouped into contact, business, and compliance
+     * sections
+     */
+    brand?: BrandsBrandData | null;
+    /**
+     * Body param: Profile description (optional)
+     */
+    description?: string | null;
+    /**
+     * Body param: Profile icon URL (optional)
+     */
+    icon?: string | null;
+    /**
+     * Body param: Whether this profile inherits contacts from organization (optional)
+     */
+    inherit_contacts?: boolean | null;
+    /**
+     * Body param: Whether this profile inherits TCR brand from organization (optional)
+     */
+    inherit_tcr_brand?: boolean | null;
+    /**
+     * Body param: Whether this profile inherits TCR campaign from organization
+     * (optional)
+     */
+    inherit_tcr_campaign?: boolean | null;
+    /**
+     * Body param: Whether this profile inherits templates from organization (optional)
+     */
+    inherit_templates?: boolean | null;
+    /**
+     * Body param: Profile name (optional)
+     */
+    name?: string | null;
+    /**
+     * Body param: Payment card details for a profile. Accepted when billing_model is
+     * "profile" or "profile_and_organization". These details are not stored on our
+     * servers and will be forwarded to the payment processor.
+     */
+    payment_details?: PaymentDetails | null;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Body param: Direct phone number for SMS sending (optional)
+     */
+    sending_phone_number?: string | null;
+    /**
+     * Body param: Reference to another profile to use for SMS/Telnyx configuration
+     * (optional)
+     */
+    sending_phone_number_profile_id?: string | null;
+    /**
+     * Body param: Reference to another profile to use for WhatsApp configuration
+     * (optional)
+     */
+    sending_whatsapp_number_profile_id?: string | null;
+    /**
+     * Body param: Profile short name/abbreviation (optional). Must be 3–11 characters,
+     * contain only letters, numbers, and spaces, and include at least one letter.
+     * Example: "SALES", "Mkt 2", "Support1".
+     */
+    short_name?: string | null;
+    /**
+     * Body param: Direct phone number for WhatsApp sending (optional)
+     */
+    whatsapp_phone_number?: string | null;
+    /**
+     * 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 ProfileListParams {
+    /**
+     * 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 ProfileDeleteParams {
+    /**
+     * Body param: Request to delete a profile
+     */
+    body: ProfileDeleteParams.Body;
+    /**
+     * 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 declare namespace ProfileDeleteParams {
+    /**
+     * Request to delete a profile
+     */
+    interface Body extends WebhooksAPI.MutationRequest {
+    }
+}
+export interface ProfileCompleteParams {
+    /**
+     * Body param: Webhook URL to call when profile completion finishes (success or
+     * failure)
+     */
+    webHookUrl: 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 declare namespace Profiles {
+    export { type APIResponseOfProfileDetail as APIResponseOfProfileDetail, type BillingContactInfo as BillingContactInfo, 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, type ProfileCompleteResponse as ProfileCompleteResponse, type ProfileCreateParams as ProfileCreateParams, type ProfileRetrieveParams as ProfileRetrieveParams, type ProfileUpdateParams as ProfileUpdateParams, type ProfileListParams as ProfileListParams, type ProfileDeleteParams as ProfileDeleteParams, type ProfileCompleteParams as ProfileCompleteParams, };
+    export { Campaigns as Campaigns, type APIResponseOfTcrCampaignWithUseCases as APIResponseOfTcrCampaignWithUseCases, type BaseDto as BaseDto, type CampaignData as CampaignData, 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, type CampaignDeleteParams as CampaignDeleteParams, };
+}
+//# sourceMappingURL=profiles.d.mts.map