@sentdm/sentdm 0.34.0 → 0.36.0

package/src/resources/profiles/campaigns.ts

@@ -1,50 +1,37 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as WebhooksAPI from '../webhooks';
+import * as CampaignsAPI from './campaigns';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 /**
- * 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 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}',
-   *             ],
-   *           },
-   *         ],
-   *       },
-   *     },
-   *   );
-   * ```
+   * @deprecated
    */
   create(
     profileID: string,
     params: CampaignCreateParams,
     options?: RequestOptions,
-  ): APIPromise<APIResponseOfBrandCampaign> {
+  ): APIPromise<CampaignCreateResponse> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.post(path`/v3/profiles/${profileID}/campaigns`, {
       body,
@@ -60,40 +47,22 @@ export 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.
+   *
    * 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}',
-   *             ],
-   *           },
-   *         ],
-   *       },
-   *     },
-   *   );
-   * ```
+   * @deprecated
    */
   update(
     campaignID: string,
     params: CampaignUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<APIResponseOfBrandCampaign> {
+  ): APIPromise<CampaignUpdateResponse> {
     const { profileId, 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.put(path`/v3/profiles/${profileId}/campaigns/${campaignID}`, {
       body,
@@ -109,22 +78,22 @@ export 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.
+   *
    * 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> {
+  ): APIPromise<CampaignListResponse> {
     const { 'x-profile-id': xProfileID } = params ?? {};
     return this._client.get(path`/v3/profiles/${profileID}/campaigns`, {
       ...options,
@@ -136,16 +105,16 @@ export 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.
+   *
    * 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> {
     const { profileId, 'x-profile-id': xProfileID, ...body } = params;
@@ -160,24 +129,39 @@ export class Campaigns extends APIResource {
   }
 }
 
+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
@@ -185,253 +169,550 @@ export interface APIResponseOfBrandCampaign {
   success?: boolean;
 }
 
-/**
- * Standard API response envelope for all v3 endpoints
- */
-export interface APIResponseOfListOfBrandCampaign {
+export namespace CampaignCreateResponse {
   /**
-   * The response data (null if error)
+   * A 10DLC campaign registered for a brand.
    */
-  data?: Array<BrandCampaign> | null;
+  export interface Data {
+    id?: string;
 
-  /**
-   * Error information
-   */
-  error?: WebhooksAPI.ErrorDetail | null;
+    billedDate?: string | null;
 
-  /**
-   * Request and response metadata
-   */
-  meta?: WebhooksAPI.APIMeta;
+    brandId?: string | null;
 
-  /**
-   * Indicates whether the request was successful
-   */
-  success?: boolean;
-}
+    cost?: number | null;
 
-/**
- * A 10DLC campaign registered for a brand.
- */
-export interface BrandCampaign {
-  id?: string;
+    createdAt?: string;
 
-  billedDate?: string | null;
+    customerId?: string;
 
-  brandId?: string | null;
+    /**
+     * True once every carrier has completed its DCA election and the campaign is
+     * operationally ready for traffic.
+     */
+    dcaElectionsComplete?: boolean | null;
 
-  cost?: number | null;
+    dcaElectionsCompletedAt?: string | null;
 
-  createdAt?: string;
+    description?: string;
 
-  customerId?: string;
+    /**
+     * True when the one-time campaign submission fee has already been charged.
+     */
+    hasSubmissionTransaction?: boolean;
 
-  /**
-   * True once every carrier has completed its DCA election and the campaign is
-   * operationally ready for traffic.
-   */
-  dcaElectionsComplete?: boolean | null;
+    helpKeywords?: string | null;
 
-  dcaElectionsCompletedAt?: string | null;
+    helpMessage?: string | null;
 
-  description?: string;
+    messageFlow?: string | null;
 
-  /**
-   * True when the one-time campaign submission fee has already been charged.
-   */
-  hasSubmissionTransaction?: boolean;
+    name?: string;
 
-  helpKeywords?: string | null;
+    optinKeywords?: string | null;
 
-  helpMessage?: string | null;
+    optinMessage?: string | null;
 
-  messageFlow?: string | null;
+    optoutKeywords?: string | null;
 
-  name?: string;
+    optoutMessage?: string | null;
 
-  optinKeywords?: string | null;
+    privacyPolicyLink?: string | null;
 
-  optinMessage?: string | null;
+    status?: 'SENT_CREATED' | 'ACTIVE' | 'EXPIRED' | null;
 
-  optoutKeywords?: string | null;
+    submittedAt?: string | null;
 
-  optoutMessage?: string | null;
+    submittedToTCR?: boolean;
 
-  privacyPolicyLink?: string | null;
+    /**
+     * The Campaign Registry identifier, once the campaign has been accepted.
+     */
+    tcrCampaignId?: string | null;
 
-  status?: 'SENT_CREATED' | 'ACTIVE' | 'EXPIRED' | null;
+    /**
+     * Surfaced so customers can see why a submission did not reach the registry.
+     */
+    tcrSyncError?: string | null;
 
-  submittedAt?: string | null;
+    termsAndConditionsLink?: string | null;
 
-  submittedToTCR?: boolean;
+    /**
+     * Campaign type (for example KYC or App).
+     */
+    type?: string;
 
-  /**
-   * The Campaign Registry identifier, once the campaign has been accepted.
-   */
-  tcrCampaignId?: string | null;
+    updatedAt?: string | null;
 
-  /**
-   * Surfaced so customers can see why a submission did not reach the registry.
-   */
-  tcrSyncError?: string | null;
+    useCases?: Array<Data.UseCase>;
 
-  termsAndConditionsLink?: string | null;
+    /**
+     * 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 type (for example KYC or App).
-   */
-  type?: string;
+  export 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.
+     */
+    export interface UseCase {
+      id?: string;
 
-  updatedAt?: string | null;
+      campaignId?: string;
 
-  useCases?: Array<CampaignUseCase>;
+      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
+   */
+  export 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;
+  }
 
   /**
-   * 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.
+   * Request and response metadata
    */
-  volume?: string | null;
+  export 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;
+  }
 }
 
 /**
- * Campaign data for create or update operation
+ * Standard API response envelope for all v3 endpoints
  */
-export interface CampaignData {
+export interface CampaignUpdateResponse {
   /**
-   * Campaign description
+   * A 10DLC campaign registered for a brand.
    */
-  description: string;
+  data?: CampaignUpdateResponse.Data | null;
 
   /**
-   * Campaign name
+   * Error information
    */
-  name: string;
+  error?: CampaignUpdateResponse.Error | null;
 
   /**
-   * Campaign type (e.g., "KYC", "App")
+   * Request and response metadata
    */
-  type: string;
+  meta?: CampaignUpdateResponse.Meta;
 
   /**
-   * List of use cases with sample messages
+   * Indicates whether the request was successful
    */
-  useCases: Array<CampaignUseCaseData>;
+  success?: boolean;
+}
 
+export namespace CampaignUpdateResponse {
   /**
-   * Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
+   * A 10DLC campaign registered for a brand.
    */
-  helpKeywords?: string | null;
+  export interface Data {
+    id?: string;
 
-  /**
-   * Message sent when user requests help
-   */
-  helpMessage?: string | null;
+    billedDate?: string | null;
 
-  /**
-   * Description of how messages flow in the campaign
-   */
-  messageFlow?: 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;
+  }
+
+  export 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.
+     */
+    export 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;
+  export 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;
+  export 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 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;
-}
+  export interface Data {
+    id?: string;
 
-/**
- * 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;
+    billedDate?: string | null;
 
-  campaignId?: string;
+    brandId?: string | null;
 
-  createdAt?: string;
+    cost?: number | null;
 
-  customerId?: string;
+    createdAt?: string;
 
-  messagingUseCaseUs?: MessagingUseCaseUs;
+    customerId?: string;
 
-  /**
-   * Sample messages submitted to the registry for this use case.
-   */
-  sampleMessages?: Array<string>;
+    /**
+     * True once every carrier has completed its DCA election and the campaign is
+     * operationally ready for traffic.
+     */
+    dcaElectionsComplete?: boolean | null;
 
-  updatedAt?: string | null;
-}
+    dcaElectionsCompletedAt?: string | null;
 
-/**
- * Campaign use case with sample messages
- */
-export interface CampaignUseCaseData {
-  messagingUseCaseUs: MessagingUseCaseUs;
+    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;
+  }
+
+  export 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.
+     */
+    export 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 for this use case (1-5 messages, max 1024 characters each)
+   * Error information
    */
-  sampleMessages: Array<string>;
-}
+  export 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;
+  }
 
-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';
+  /**
+   * Request and response metadata
+   */
+  export 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 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
@@ -454,6 +735,104 @@ export interface CampaignCreateParams {
   'x-profile-id'?: string;
 }
 
+export namespace CampaignCreateParams {
+  /**
+   * Campaign data for create or update operation
+   */
+  export 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;
+  }
+
+  export namespace Campaign {
+    /**
+     * Campaign use case with sample messages
+     */
+    export 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
@@ -463,7 +842,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
@@ -486,6 +865,104 @@ export interface CampaignUpdateParams {
   'x-profile-id'?: string;
 }
 
+export namespace CampaignUpdateParams {
+  /**
+   * Campaign data for create or update operation
+   */
+  export 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;
+  }
+
+  export namespace Campaign {
+    /**
+     * Campaign use case with sample messages
+     */
+    export 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
@@ -516,13 +993,10 @@ export interface CampaignDeleteParams {
 
 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 CampaignCreateResponse as CampaignCreateResponse,
+    type CampaignUpdateResponse as CampaignUpdateResponse,
+    type CampaignListResponse as CampaignListResponse,
     type CampaignCreateParams as CampaignCreateParams,
     type CampaignUpdateParams as CampaignUpdateParams,
     type CampaignListParams as CampaignListParams,