@sentdm/sentdm 0.35.0 → 0.37.0

package/resources/profiles/campaigns.d.mts

@@ -1,5 +1,5 @@
 import { APIResource } from "../../core/resource.mjs";
-import * as CampaignsAPI from "./campaigns.mjs";
+import * as WebhooksAPI from "../webhooks.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 /**
@@ -22,7 +22,7 @@ export declare class Campaigns extends APIResource {
      *
      * @deprecated
      */
-    create(profileID: string, params: CampaignCreateParams, options?: RequestOptions): APIPromise<CampaignCreateResponse>;
+    create(profileID: string, params: CampaignCreateParams, options?: RequestOptions): APIPromise<APIResponseOfBrandCampaign>;
     /**
      * **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
@@ -35,7 +35,7 @@ export declare class Campaigns extends APIResource {
      *
      * @deprecated
      */
-    update(campaignID: string, params: CampaignUpdateParams, options?: RequestOptions): APIPromise<CampaignUpdateResponse>;
+    update(campaignID: string, params: CampaignUpdateParams, options?: RequestOptions): APIPromise<APIResponseOfBrandCampaign>;
     /**
      * **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
@@ -48,7 +48,7 @@ export declare class Campaigns extends APIResource {
      *
      * @deprecated
      */
-    list(profileID: string, params?: CampaignListParams | null | undefined, options?: RequestOptions): APIPromise<CampaignListResponse>;
+    list(profileID: string, params?: CampaignListParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfListOfBrandCampaign>;
     /**
      * **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
@@ -63,441 +63,210 @@ export declare class Campaigns extends APIResource {
      */
     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 CampaignCreateResponse {
+export interface APIResponseOfBrandCampaign {
     /**
      * A 10DLC campaign registered for a brand.
      */
-    data?: CampaignCreateResponse.Data | null;
+    data?: BrandCampaign | null;
     /**
      * Error information
      */
-    error?: CampaignCreateResponse.Error | null;
+    error?: WebhooksAPI.ErrorDetail | null;
     /**
      * Request and response metadata
      */
-    meta?: CampaignCreateResponse.Meta;
+    meta?: WebhooksAPI.APIMeta;
     /**
      * Indicates whether the request was successful
      */
     success?: boolean;
 }
-export declare namespace CampaignCreateResponse {
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfListOfBrandCampaign {
     /**
-     * A 10DLC campaign registered for a brand.
+     * The response data (null if error)
      */
-    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;
-        }
-    }
+    data?: Array<BrandCampaign> | null;
     /**
      * Error information
      */
-    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;
-    }
+    error?: WebhooksAPI.ErrorDetail | null;
     /**
      * Request and response metadata
      */
-    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;
-    }
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
 }
 /**
- * Standard API response envelope for all v3 endpoints
+ * A 10DLC campaign registered for a brand.
  */
-export interface CampaignUpdateResponse {
+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
+ */
+export interface CampaignData {
     /**
-     * A 10DLC campaign registered for a brand.
+     * Campaign description
      */
-    data?: CampaignUpdateResponse.Data | null;
+    description: string;
     /**
-     * Error information
+     * Campaign name
      */
-    error?: CampaignUpdateResponse.Error | null;
+    name: string;
     /**
-     * Request and response metadata
+     * 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.
      */
-    meta?: CampaignUpdateResponse.Meta;
+    type: string;
     /**
-     * Indicates whether the request was successful
+     * List of use cases with sample messages
      */
-    success?: boolean;
-}
-export declare namespace CampaignUpdateResponse {
+    useCases: Array<CampaignUseCaseData>;
     /**
-     * A 10DLC campaign registered for a brand.
+     * Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
      */
-    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;
-        }
-    }
+    helpKeywords?: string | null;
     /**
-     * Error information
+     * Message sent when user requests help
      */
-    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;
-    }
+    helpMessage?: string | null;
     /**
-     * Request and response metadata
+     * Description of how messages flow in the campaign
      */
-    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 {
+    messageFlow?: string | null;
     /**
-     * The response data (null if error)
+     * Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
      */
-    data?: Array<CampaignListResponse.Data> | null;
+    optinKeywords?: string | null;
     /**
-     * Error information
+     * Message sent when user opts in
      */
-    error?: CampaignListResponse.Error | null;
+    optinMessage?: string | null;
     /**
-     * Request and response metadata
+     * Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
      */
-    meta?: CampaignListResponse.Meta;
+    optoutKeywords?: string | null;
     /**
-     * Indicates whether the request was successful
+     * Message sent when user opts out
      */
-    success?: boolean;
-}
-export declare namespace CampaignListResponse {
+    optoutMessage?: string | null;
     /**
-     * A 10DLC campaign registered for a brand.
+     * URL to privacy policy
      */
-    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;
-        }
-    }
+    privacyPolicyLink?: string | null;
     /**
-     * Error information
+     * URL to terms and conditions
      */
-    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;
-    }
+    termsAndConditionsLink?: string | null;
     /**
-     * Request and response metadata
+     * Expected messaging volume for this campaign. Numeric string (e.g. "1999",
+     * "5000"). Values below 2000 bill at the low-volume tier.
      */
-    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;
-    }
+    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;
+    /**
+     * Sample messages submitted to the registry for this use case.
+     */
+    sampleMessages?: Array<string>;
+    updatedAt?: string | null;
+}
+/**
+ * Campaign use case with sample messages
+ */
+export interface CampaignUseCaseData {
+    messagingUseCaseUs: MessagingUseCaseUs;
+    /**
+     * Sample messages for this use case (1-5 messages, max 1024 characters each)
+     */
+    sampleMessages: Array<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: CampaignCreateParams.Campaign;
+    campaign: CampaignData;
     /**
      * Body param: Sandbox flag - when true, the operation is simulated without side
      * effects Useful for testing integrations without actual execution
@@ -516,88 +285,6 @@ 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
@@ -606,7 +293,7 @@ export interface CampaignUpdateParams {
     /**
      * Body param: Campaign data for create or update operation
      */
-    campaign: CampaignUpdateParams.Campaign;
+    campaign: CampaignData;
     /**
      * Body param: Sandbox flag - when true, the operation is simulated without side
      * effects Useful for testing integrations without actual execution
@@ -625,88 +312,6 @@ 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
@@ -732,6 +337,6 @@ export interface CampaignDeleteParams {
     'x-profile-id'?: string;
 }
 export declare namespace Campaigns {
-    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, };
+    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, };
 }
 //# sourceMappingURL=campaigns.d.mts.map