@sentdm/sentdm 0.34.0 → 0.36.0

package/resources/profiles/campaigns.d.mts

@@ -1,297 +1,503 @@
 import { APIResource } from "../../core/resource.mjs";
-import * as WebhooksAPI from "../webhooks.mjs";
+import * as CampaignsAPI from "./campaigns.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 /**
- * Manage organization profiles
+ * **Deprecated — use Sender Profiles.**
+ *
+ * The original profile resource, kept because it has live callers. It still works, and its replacement is `/v3/sender-profiles`, which takes the identity and the campaign in one call instead of across three.
+ *
+ * New integrations should not start here.
  */
 export declare class Campaigns extends APIResource {
     /**
+     * **Deprecated.** This endpoint is replaced by `/v3/sender-profiles` and will be
+     * removed in a future release. It still behaves exactly as before, so nothing
+     * needs to change today — but new integrations should use `/v3/sender-profiles`,
+     * which models a profile's markets, compliance, brand, campaigns and billing
+     * explicitly.
+     *
      * Creates a new campaign scoped under the brand of the specified profile. Each
      * campaign must include at least one use case with sample messages.
      *
-     * @example
-     * ```ts
-     * const apiResponseOfBrandCampaign =
-     *   await client.profiles.campaigns.create(
-     *     '770e8400-e29b-41d4-a716-446655440002',
-     *     {
-     *       campaign: {
-     *         description:
-     *           'Appointment reminders and account notifications',
-     *         name: 'Customer Notifications',
-     *         type: 'App',
-     *         useCases: [
-     *           {
-     *             messagingUseCaseUs: 'ACCOUNT_NOTIFICATION',
-     *             sampleMessages: [
-     *               'Hi {name}, your appointment is confirmed for {date} at {time}.',
-     *               'Your order #{order_id} has been shipped. Track at {url}',
-     *             ],
-     *           },
-     *         ],
-     *       },
-     *     },
-     *   );
-     * ```
-     */
-    create(profileID: string, params: CampaignCreateParams, options?: RequestOptions): APIPromise<APIResponseOfBrandCampaign>;
+     * @deprecated
+     */
+    create(profileID: string, params: CampaignCreateParams, options?: RequestOptions): APIPromise<CampaignCreateResponse>;
     /**
+     * **Deprecated.** This endpoint is replaced by `/v3/sender-profiles` and will be
+     * removed in a future release. It still behaves exactly as before, so nothing
+     * needs to change today — but new integrations should use `/v3/sender-profiles`,
+     * which models a profile's markets, compliance, brand, campaigns and billing
+     * explicitly.
+     *
      * Updates an existing campaign under the brand of the specified profile. Cannot
      * update campaigns that have already been submitted to TCR.
      *
-     * @example
-     * ```ts
-     * const apiResponseOfBrandCampaign =
-     *   await client.profiles.campaigns.update(
-     *     'b2c3d4e5-f6a7-8901-bcde-f12345678901',
-     *     {
-     *       profileId: '770e8400-e29b-41d4-a716-446655440002',
-     *       campaign: {
-     *         description:
-     *           'Updated appointment reminders and account notifications',
-     *         name: 'Customer Notifications Updated',
-     *         type: 'App',
-     *         useCases: [
-     *           {
-     *             messagingUseCaseUs: 'ACCOUNT_NOTIFICATION',
-     *             sampleMessages: [
-     *               'Hi {name}, your appointment is confirmed for {date} at {time}.',
-     *               'Your order #{order_id} has been shipped. Track at {url}',
-     *             ],
-     *           },
-     *         ],
-     *       },
-     *     },
-     *   );
-     * ```
-     */
-    update(campaignID: string, params: CampaignUpdateParams, options?: RequestOptions): APIPromise<APIResponseOfBrandCampaign>;
+     * @deprecated
+     */
+    update(campaignID: string, params: CampaignUpdateParams, options?: RequestOptions): APIPromise<CampaignUpdateResponse>;
     /**
+     * **Deprecated.** This endpoint is replaced by `/v3/sender-profiles` and will be
+     * removed in a future release. It still behaves exactly as before, so nothing
+     * needs to change today — but new integrations should use `/v3/sender-profiles`,
+     * which models a profile's markets, compliance, brand, campaigns and billing
+     * explicitly.
+     *
      * Retrieves all campaigns linked to the profile's brand, including use cases and
      * sample messages. Returns inherited campaigns if inherit_tcr_campaign=true.
      *
-     * @example
-     * ```ts
-     * const apiResponseOfListOfBrandCampaign =
-     *   await client.profiles.campaigns.list(
-     *     '770e8400-e29b-41d4-a716-446655440002',
-     *   );
-     * ```
+     * @deprecated
      */
-    list(profileID: string, params?: CampaignListParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfListOfBrandCampaign>;
+    list(profileID: string, params?: CampaignListParams | null | undefined, options?: RequestOptions): APIPromise<CampaignListResponse>;
     /**
+     * **Deprecated.** This endpoint is replaced by `/v3/sender-profiles` and will be
+     * removed in a future release. It still behaves exactly as before, so nothing
+     * needs to change today — but new integrations should use `/v3/sender-profiles`,
+     * which models a profile's markets, compliance, brand, campaigns and billing
+     * explicitly.
+     *
      * Deletes a campaign by ID from the brand of the specified profile. The profile
      * must belong to the authenticated organization.
      *
-     * @example
-     * ```ts
-     * await client.profiles.campaigns.delete(
-     *   'b2c3d4e5-f6a7-8901-bcde-f12345678901',
-     *   { profileId: '770e8400-e29b-41d4-a716-446655440002' },
-     * );
-     * ```
+     * @deprecated
      */
     delete(campaignID: string, params: CampaignDeleteParams, options?: RequestOptions): APIPromise<void>;
 }
+export type MessagingUseCaseUs = 'MARKETING' | 'ACCOUNT_NOTIFICATION' | 'CUSTOMER_CARE' | 'FRAUD_ALERT' | 'TWO_FA' | 'DELIVERY_NOTIFICATION' | 'SECURITY_ALERT' | 'M2M' | 'MIXED' | 'HIGHER_EDUCATION' | 'POLLING_VOTING' | 'PUBLIC_SERVICE_ANNOUNCEMENT' | 'LOW_VOLUME';
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface APIResponseOfBrandCampaign {
+export interface CampaignCreateResponse {
     /**
      * A 10DLC campaign registered for a brand.
      */
-    data?: BrandCampaign | null;
+    data?: CampaignCreateResponse.Data | null;
     /**
      * Error information
      */
-    error?: WebhooksAPI.ErrorDetail | null;
+    error?: CampaignCreateResponse.Error | null;
     /**
      * Request and response metadata
      */
-    meta?: WebhooksAPI.APIMeta;
+    meta?: CampaignCreateResponse.Meta;
     /**
      * Indicates whether the request was successful
      */
     success?: boolean;
 }
-/**
- * Standard API response envelope for all v3 endpoints
- */
-export interface APIResponseOfListOfBrandCampaign {
+export declare namespace CampaignCreateResponse {
     /**
-     * The response data (null if error)
+     * A 10DLC campaign registered for a brand.
      */
-    data?: Array<BrandCampaign> | null;
+    interface Data {
+        id?: string;
+        billedDate?: string | null;
+        brandId?: string | null;
+        cost?: number | null;
+        createdAt?: string;
+        customerId?: string;
+        /**
+         * True once every carrier has completed its DCA election and the campaign is
+         * operationally ready for traffic.
+         */
+        dcaElectionsComplete?: boolean | null;
+        dcaElectionsCompletedAt?: string | null;
+        description?: string;
+        /**
+         * True when the one-time campaign submission fee has already been charged.
+         */
+        hasSubmissionTransaction?: boolean;
+        helpKeywords?: string | null;
+        helpMessage?: string | null;
+        messageFlow?: string | null;
+        name?: string;
+        optinKeywords?: string | null;
+        optinMessage?: string | null;
+        optoutKeywords?: string | null;
+        optoutMessage?: string | null;
+        privacyPolicyLink?: string | null;
+        status?: 'SENT_CREATED' | 'ACTIVE' | 'EXPIRED' | null;
+        submittedAt?: string | null;
+        submittedToTCR?: boolean;
+        /**
+         * The Campaign Registry identifier, once the campaign has been accepted.
+         */
+        tcrCampaignId?: string | null;
+        /**
+         * Surfaced so customers can see why a submission did not reach the registry.
+         */
+        tcrSyncError?: string | null;
+        termsAndConditionsLink?: string | null;
+        /**
+         * Campaign type (for example KYC or App).
+         */
+        type?: string;
+        updatedAt?: string | null;
+        useCases?: Array<Data.UseCase>;
+        /**
+         * Expected messaging volume for this campaign — customer-supplied on
+         * create/update, and the input to both the TCR usecase classification (LOW_VOLUME
+         * vs MIXED/specific) and the campaign fee tier. Surfaced so customers can read
+         * back the value they set.
+         */
+        volume?: string | null;
+    }
+    namespace Data {
+        /**
+         * Customer-facing use-case representation for the public v3 campaign contract.
+         * Exists for the same reason as BrandCampaignV3Response: nesting the
+         * TcrCampaignUseCase database entity in a public response means any column added
+         * to that table silently becomes part of the customer-facing contract. This DTO is
+         * an explicit allowlist, so a new column stays invisible until it is added here on
+         * purpose. This mirrors exactly the fields the entity already serialized, so it
+         * removes nothing from the current response shape. It only closes the future-leak
+         * path.
+         */
+        interface UseCase {
+            id?: string;
+            campaignId?: string;
+            createdAt?: string;
+            customerId?: string;
+            messagingUseCaseUs?: CampaignsAPI.MessagingUseCaseUs;
+            /**
+             * Sample messages submitted to the registry for this use case.
+             */
+            sampleMessages?: Array<string>;
+            updatedAt?: string | null;
+        }
+    }
     /**
      * Error information
      */
-    error?: WebhooksAPI.ErrorDetail | null;
+    interface Error {
+        /**
+         * Machine-readable error code (e.g., "RESOURCE_001")
+         */
+        code?: string;
+        /**
+         * Additional validation error details (field-level errors)
+         */
+        details?: {
+            [key: string]: Array<string>;
+        } | null;
+        /**
+         * URL to documentation about this error
+         */
+        doc_url?: string | null;
+        /**
+         * Human-readable error message
+         */
+        message?: string;
+    }
     /**
      * Request and response metadata
      */
-    meta?: WebhooksAPI.APIMeta;
-    /**
-     * Indicates whether the request was successful
-     */
-    success?: boolean;
+    interface Meta {
+        /**
+         * Unique identifier for this request (for tracing and support)
+         */
+        request_id?: string;
+        /**
+         * Server timestamp when the response was generated
+         */
+        timestamp?: string;
+        /**
+         * API version used for this request
+         */
+        version?: string;
+    }
 }
 /**
- * A 10DLC campaign registered for a brand.
- */
-export interface BrandCampaign {
-    id?: string;
-    billedDate?: string | null;
-    brandId?: string | null;
-    cost?: number | null;
-    createdAt?: string;
-    customerId?: string;
-    /**
-     * True once every carrier has completed its DCA election and the campaign is
-     * operationally ready for traffic.
-     */
-    dcaElectionsComplete?: boolean | null;
-    dcaElectionsCompletedAt?: string | null;
-    description?: string;
-    /**
-     * True when the one-time campaign submission fee has already been charged.
-     */
-    hasSubmissionTransaction?: boolean;
-    helpKeywords?: string | null;
-    helpMessage?: string | null;
-    messageFlow?: string | null;
-    name?: string;
-    optinKeywords?: string | null;
-    optinMessage?: string | null;
-    optoutKeywords?: string | null;
-    optoutMessage?: string | null;
-    privacyPolicyLink?: string | null;
-    status?: 'SENT_CREATED' | 'ACTIVE' | 'EXPIRED' | null;
-    submittedAt?: string | null;
-    submittedToTCR?: boolean;
-    /**
-     * The Campaign Registry identifier, once the campaign has been accepted.
-     */
-    tcrCampaignId?: string | null;
-    /**
-     * Surfaced so customers can see why a submission did not reach the registry.
-     */
-    tcrSyncError?: string | null;
-    termsAndConditionsLink?: string | null;
-    /**
-     * Campaign type (for example KYC or App).
-     */
-    type?: string;
-    updatedAt?: string | null;
-    useCases?: Array<CampaignUseCase>;
-    /**
-     * Expected messaging volume for this campaign — customer-supplied on
-     * create/update, and the input to both the TCR usecase classification (LOW_VOLUME
-     * vs MIXED/specific) and the campaign fee tier. Surfaced so customers can read
-     * back the value they set.
-     */
-    volume?: string | null;
-}
-/**
- * Campaign data for create or update operation
+ * Standard API response envelope for all v3 endpoints
  */
-export interface CampaignData {
-    /**
-     * Campaign description
-     */
-    description: string;
-    /**
-     * Campaign name
-     */
-    name: string;
+export interface CampaignUpdateResponse {
     /**
-     * Campaign type (e.g., "KYC", "App")
+     * A 10DLC campaign registered for a brand.
      */
-    type: string;
+    data?: CampaignUpdateResponse.Data | null;
     /**
-     * List of use cases with sample messages
+     * Error information
      */
-    useCases: Array<CampaignUseCaseData>;
+    error?: CampaignUpdateResponse.Error | null;
     /**
-     * Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
+     * Request and response metadata
      */
-    helpKeywords?: string | null;
+    meta?: CampaignUpdateResponse.Meta;
     /**
-     * Message sent when user requests help
+     * Indicates whether the request was successful
      */
-    helpMessage?: string | null;
+    success?: boolean;
+}
+export declare namespace CampaignUpdateResponse {
     /**
-     * Description of how messages flow in the campaign
+     * A 10DLC campaign registered for a brand.
      */
-    messageFlow?: string | null;
+    interface Data {
+        id?: string;
+        billedDate?: string | null;
+        brandId?: string | null;
+        cost?: number | null;
+        createdAt?: string;
+        customerId?: string;
+        /**
+         * True once every carrier has completed its DCA election and the campaign is
+         * operationally ready for traffic.
+         */
+        dcaElectionsComplete?: boolean | null;
+        dcaElectionsCompletedAt?: string | null;
+        description?: string;
+        /**
+         * True when the one-time campaign submission fee has already been charged.
+         */
+        hasSubmissionTransaction?: boolean;
+        helpKeywords?: string | null;
+        helpMessage?: string | null;
+        messageFlow?: string | null;
+        name?: string;
+        optinKeywords?: string | null;
+        optinMessage?: string | null;
+        optoutKeywords?: string | null;
+        optoutMessage?: string | null;
+        privacyPolicyLink?: string | null;
+        status?: 'SENT_CREATED' | 'ACTIVE' | 'EXPIRED' | null;
+        submittedAt?: string | null;
+        submittedToTCR?: boolean;
+        /**
+         * The Campaign Registry identifier, once the campaign has been accepted.
+         */
+        tcrCampaignId?: string | null;
+        /**
+         * Surfaced so customers can see why a submission did not reach the registry.
+         */
+        tcrSyncError?: string | null;
+        termsAndConditionsLink?: string | null;
+        /**
+         * Campaign type (for example KYC or App).
+         */
+        type?: string;
+        updatedAt?: string | null;
+        useCases?: Array<Data.UseCase>;
+        /**
+         * Expected messaging volume for this campaign — customer-supplied on
+         * create/update, and the input to both the TCR usecase classification (LOW_VOLUME
+         * vs MIXED/specific) and the campaign fee tier. Surfaced so customers can read
+         * back the value they set.
+         */
+        volume?: string | null;
+    }
+    namespace Data {
+        /**
+         * Customer-facing use-case representation for the public v3 campaign contract.
+         * Exists for the same reason as BrandCampaignV3Response: nesting the
+         * TcrCampaignUseCase database entity in a public response means any column added
+         * to that table silently becomes part of the customer-facing contract. This DTO is
+         * an explicit allowlist, so a new column stays invisible until it is added here on
+         * purpose. This mirrors exactly the fields the entity already serialized, so it
+         * removes nothing from the current response shape. It only closes the future-leak
+         * path.
+         */
+        interface UseCase {
+            id?: string;
+            campaignId?: string;
+            createdAt?: string;
+            customerId?: string;
+            messagingUseCaseUs?: CampaignsAPI.MessagingUseCaseUs;
+            /**
+             * Sample messages submitted to the registry for this use case.
+             */
+            sampleMessages?: Array<string>;
+            updatedAt?: string | null;
+        }
+    }
     /**
-     * Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
+     * Error information
      */
-    optinKeywords?: string | null;
+    interface Error {
+        /**
+         * Machine-readable error code (e.g., "RESOURCE_001")
+         */
+        code?: string;
+        /**
+         * Additional validation error details (field-level errors)
+         */
+        details?: {
+            [key: string]: Array<string>;
+        } | null;
+        /**
+         * URL to documentation about this error
+         */
+        doc_url?: string | null;
+        /**
+         * Human-readable error message
+         */
+        message?: string;
+    }
     /**
-     * Message sent when user opts in
+     * Request and response metadata
      */
-    optinMessage?: string | null;
+    interface Meta {
+        /**
+         * Unique identifier for this request (for tracing and support)
+         */
+        request_id?: string;
+        /**
+         * Server timestamp when the response was generated
+         */
+        timestamp?: string;
+        /**
+         * API version used for this request
+         */
+        version?: string;
+    }
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface CampaignListResponse {
     /**
-     * Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
+     * The response data (null if error)
      */
-    optoutKeywords?: string | null;
+    data?: Array<CampaignListResponse.Data> | null;
     /**
-     * Message sent when user opts out
+     * Error information
      */
-    optoutMessage?: string | null;
+    error?: CampaignListResponse.Error | null;
     /**
-     * URL to privacy policy
+     * Request and response metadata
      */
-    privacyPolicyLink?: string | null;
+    meta?: CampaignListResponse.Meta;
     /**
-     * URL to terms and conditions
+     * Indicates whether the request was successful
      */
-    termsAndConditionsLink?: string | null;
+    success?: boolean;
+}
+export declare namespace CampaignListResponse {
     /**
-     * Expected messaging volume for this campaign. Numeric string (e.g. "1999",
-     * "5000"). Values below 2000 bill at the low-volume tier.
+     * A 10DLC campaign registered for a brand.
      */
-    volume?: string | null;
-}
-/**
- * Customer-facing use-case representation for the public v3 campaign contract.
- * Exists for the same reason as BrandCampaignV3Response: nesting the
- * TcrCampaignUseCase database entity in a public response means any column added
- * to that table silently becomes part of the customer-facing contract. This DTO is
- * an explicit allowlist, so a new column stays invisible until it is added here on
- * purpose. This mirrors exactly the fields the entity already serialized, so it
- * removes nothing from the current response shape. It only closes the future-leak
- * path.
- */
-export interface CampaignUseCase {
-    id?: string;
-    campaignId?: string;
-    createdAt?: string;
-    customerId?: string;
-    messagingUseCaseUs?: MessagingUseCaseUs;
+    interface Data {
+        id?: string;
+        billedDate?: string | null;
+        brandId?: string | null;
+        cost?: number | null;
+        createdAt?: string;
+        customerId?: string;
+        /**
+         * True once every carrier has completed its DCA election and the campaign is
+         * operationally ready for traffic.
+         */
+        dcaElectionsComplete?: boolean | null;
+        dcaElectionsCompletedAt?: string | null;
+        description?: string;
+        /**
+         * True when the one-time campaign submission fee has already been charged.
+         */
+        hasSubmissionTransaction?: boolean;
+        helpKeywords?: string | null;
+        helpMessage?: string | null;
+        messageFlow?: string | null;
+        name?: string;
+        optinKeywords?: string | null;
+        optinMessage?: string | null;
+        optoutKeywords?: string | null;
+        optoutMessage?: string | null;
+        privacyPolicyLink?: string | null;
+        status?: 'SENT_CREATED' | 'ACTIVE' | 'EXPIRED' | null;
+        submittedAt?: string | null;
+        submittedToTCR?: boolean;
+        /**
+         * The Campaign Registry identifier, once the campaign has been accepted.
+         */
+        tcrCampaignId?: string | null;
+        /**
+         * Surfaced so customers can see why a submission did not reach the registry.
+         */
+        tcrSyncError?: string | null;
+        termsAndConditionsLink?: string | null;
+        /**
+         * Campaign type (for example KYC or App).
+         */
+        type?: string;
+        updatedAt?: string | null;
+        useCases?: Array<Data.UseCase>;
+        /**
+         * Expected messaging volume for this campaign — customer-supplied on
+         * create/update, and the input to both the TCR usecase classification (LOW_VOLUME
+         * vs MIXED/specific) and the campaign fee tier. Surfaced so customers can read
+         * back the value they set.
+         */
+        volume?: string | null;
+    }
+    namespace Data {
+        /**
+         * Customer-facing use-case representation for the public v3 campaign contract.
+         * Exists for the same reason as BrandCampaignV3Response: nesting the
+         * TcrCampaignUseCase database entity in a public response means any column added
+         * to that table silently becomes part of the customer-facing contract. This DTO is
+         * an explicit allowlist, so a new column stays invisible until it is added here on
+         * purpose. This mirrors exactly the fields the entity already serialized, so it
+         * removes nothing from the current response shape. It only closes the future-leak
+         * path.
+         */
+        interface UseCase {
+            id?: string;
+            campaignId?: string;
+            createdAt?: string;
+            customerId?: string;
+            messagingUseCaseUs?: CampaignsAPI.MessagingUseCaseUs;
+            /**
+             * Sample messages submitted to the registry for this use case.
+             */
+            sampleMessages?: Array<string>;
+            updatedAt?: string | null;
+        }
+    }
     /**
-     * Sample messages submitted to the registry for this use case.
+     * Error information
      */
-    sampleMessages?: Array<string>;
-    updatedAt?: string | null;
-}
-/**
- * Campaign use case with sample messages
- */
-export interface CampaignUseCaseData {
-    messagingUseCaseUs: MessagingUseCaseUs;
+    interface Error {
+        /**
+         * Machine-readable error code (e.g., "RESOURCE_001")
+         */
+        code?: string;
+        /**
+         * Additional validation error details (field-level errors)
+         */
+        details?: {
+            [key: string]: Array<string>;
+        } | null;
+        /**
+         * URL to documentation about this error
+         */
+        doc_url?: string | null;
+        /**
+         * Human-readable error message
+         */
+        message?: string;
+    }
     /**
-     * Sample messages for this use case (1-5 messages, max 1024 characters each)
+     * Request and response metadata
      */
-    sampleMessages: Array<string>;
+    interface Meta {
+        /**
+         * Unique identifier for this request (for tracing and support)
+         */
+        request_id?: string;
+        /**
+         * Server timestamp when the response was generated
+         */
+        timestamp?: string;
+        /**
+         * API version used for this request
+         */
+        version?: string;
+    }
 }
-export type MessagingUseCaseUs = 'MARKETING' | 'ACCOUNT_NOTIFICATION' | 'CUSTOMER_CARE' | 'FRAUD_ALERT' | 'TWO_FA' | 'DELIVERY_NOTIFICATION' | 'SECURITY_ALERT' | 'M2M' | 'MIXED' | 'HIGHER_EDUCATION' | 'POLLING_VOTING' | 'PUBLIC_SERVICE_ANNOUNCEMENT' | 'LOW_VOLUME';
 export interface CampaignCreateParams {
     /**
      * Body param: Campaign data for create or update operation
      */
-    campaign: CampaignData;
+    campaign: CampaignCreateParams.Campaign;
     /**
      * Body param: Sandbox flag - when true, the operation is simulated without side
      * effects Useful for testing integrations without actual execution
@@ -310,6 +516,88 @@ export interface CampaignCreateParams {
      */
     'x-profile-id'?: string;
 }
+export declare namespace CampaignCreateParams {
+    /**
+     * Campaign data for create or update operation
+     */
+    interface Campaign {
+        /**
+         * Campaign description
+         */
+        description: string;
+        /**
+         * Campaign name
+         */
+        name: string;
+        /**
+         * Campaign type (e.g., "KYC", "App").
+         *
+         * Still required of a caller, and consulted by nothing. It named the signup path
+         * that produced the campaign, was written to a column no query filters on, no TCR
+         * payload carries and no fee or status decision reads, and is now defaulted at the
+         * entity instead. It stays required so that a request which was valid before is
+         * still valid — dropping it would be the client-visible change, not keeping it.
+         */
+        type: string;
+        /**
+         * List of use cases with sample messages
+         */
+        useCases: Array<Campaign.UseCase>;
+        /**
+         * Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
+         */
+        helpKeywords?: string | null;
+        /**
+         * Message sent when user requests help
+         */
+        helpMessage?: string | null;
+        /**
+         * Description of how messages flow in the campaign
+         */
+        messageFlow?: string | null;
+        /**
+         * Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
+         */
+        optinKeywords?: string | null;
+        /**
+         * Message sent when user opts in
+         */
+        optinMessage?: string | null;
+        /**
+         * Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
+         */
+        optoutKeywords?: string | null;
+        /**
+         * Message sent when user opts out
+         */
+        optoutMessage?: string | null;
+        /**
+         * URL to privacy policy
+         */
+        privacyPolicyLink?: string | null;
+        /**
+         * URL to terms and conditions
+         */
+        termsAndConditionsLink?: string | null;
+        /**
+         * Expected messaging volume for this campaign. Numeric string (e.g. "1999",
+         * "5000"). Values below 2000 bill at the low-volume tier.
+         */
+        volume?: string | null;
+    }
+    namespace Campaign {
+        /**
+         * Campaign use case with sample messages
+         */
+        interface UseCase {
+            messagingUseCaseUs: CampaignsAPI.MessagingUseCaseUs;
+            /**
+             * Sample messages for this use case (1-5 messages, max 1024 characters each)
+             */
+            sampleMessages: Array<string>;
+        }
+    }
+}
 export interface CampaignUpdateParams {
     /**
      * Path param: Profile ID from route
@@ -318,7 +606,7 @@ export interface CampaignUpdateParams {
     /**
      * Body param: Campaign data for create or update operation
      */
-    campaign: CampaignData;
+    campaign: CampaignUpdateParams.Campaign;
     /**
      * Body param: Sandbox flag - when true, the operation is simulated without side
      * effects Useful for testing integrations without actual execution
@@ -337,6 +625,88 @@ export interface CampaignUpdateParams {
      */
     'x-profile-id'?: string;
 }
+export declare namespace CampaignUpdateParams {
+    /**
+     * Campaign data for create or update operation
+     */
+    interface Campaign {
+        /**
+         * Campaign description
+         */
+        description: string;
+        /**
+         * Campaign name
+         */
+        name: string;
+        /**
+         * Campaign type (e.g., "KYC", "App").
+         *
+         * Still required of a caller, and consulted by nothing. It named the signup path
+         * that produced the campaign, was written to a column no query filters on, no TCR
+         * payload carries and no fee or status decision reads, and is now defaulted at the
+         * entity instead. It stays required so that a request which was valid before is
+         * still valid — dropping it would be the client-visible change, not keeping it.
+         */
+        type: string;
+        /**
+         * List of use cases with sample messages
+         */
+        useCases: Array<Campaign.UseCase>;
+        /**
+         * Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
+         */
+        helpKeywords?: string | null;
+        /**
+         * Message sent when user requests help
+         */
+        helpMessage?: string | null;
+        /**
+         * Description of how messages flow in the campaign
+         */
+        messageFlow?: string | null;
+        /**
+         * Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
+         */
+        optinKeywords?: string | null;
+        /**
+         * Message sent when user opts in
+         */
+        optinMessage?: string | null;
+        /**
+         * Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
+         */
+        optoutKeywords?: string | null;
+        /**
+         * Message sent when user opts out
+         */
+        optoutMessage?: string | null;
+        /**
+         * URL to privacy policy
+         */
+        privacyPolicyLink?: string | null;
+        /**
+         * URL to terms and conditions
+         */
+        termsAndConditionsLink?: string | null;
+        /**
+         * Expected messaging volume for this campaign. Numeric string (e.g. "1999",
+         * "5000"). Values below 2000 bill at the low-volume tier.
+         */
+        volume?: string | null;
+    }
+    namespace Campaign {
+        /**
+         * Campaign use case with sample messages
+         */
+        interface UseCase {
+            messagingUseCaseUs: CampaignsAPI.MessagingUseCaseUs;
+            /**
+             * Sample messages for this use case (1-5 messages, max 1024 characters each)
+             */
+            sampleMessages: Array<string>;
+        }
+    }
+}
 export interface CampaignListParams {
     /**
      * Profile UUID to scope the request to a child profile. Only organization API keys
@@ -362,6 +732,6 @@ export interface CampaignDeleteParams {
     'x-profile-id'?: string;
 }
 export declare namespace Campaigns {
-    export { 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 CampaignCreateParams as CampaignCreateParams, type CampaignUpdateParams as CampaignUpdateParams, type CampaignListParams as CampaignListParams, type CampaignDeleteParams as CampaignDeleteParams, };
+    export { type MessagingUseCaseUs as MessagingUseCaseUs, type CampaignCreateResponse as CampaignCreateResponse, type CampaignUpdateResponse as CampaignUpdateResponse, type CampaignListResponse as CampaignListResponse, type CampaignCreateParams as CampaignCreateParams, type CampaignUpdateParams as CampaignUpdateParams, type CampaignListParams as CampaignListParams, type CampaignDeleteParams as CampaignDeleteParams, };
 }
 //# sourceMappingURL=campaigns.d.mts.map