@sentdm/sentdm 0.7.1 → 0.14.0

package/resources/profiles/campaigns.d.mts

@@ -0,0 +1,339 @@
+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";
+/**
+ * Manage organization profiles
+ */
+export declare class Campaigns extends APIResource {
+    /**
+     * 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 apiResponseOfTcrCampaignWithUseCases =
+     *   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<APIResponseOfTcrCampaignWithUseCases>;
+    /**
+     * Updates an existing campaign under the brand of the specified profile. Cannot
+     * update campaigns that have already been submitted to TCR.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfTcrCampaignWithUseCases =
+     *   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<APIResponseOfTcrCampaignWithUseCases>;
+    /**
+     * 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 campaigns = await client.profiles.campaigns.list(
+     *   '770e8400-e29b-41d4-a716-446655440002',
+     * );
+     * ```
+     */
+    list(profileID: string, params?: CampaignListParams | null | undefined, options?: RequestOptions): APIPromise<CampaignListResponse>;
+    /**
+     * 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',
+     *     body: {},
+     *   },
+     * );
+     * ```
+     */
+    delete(campaignID: string, params: CampaignDeleteParams, options?: RequestOptions): APIPromise<void>;
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfTcrCampaignWithUseCases {
+    /**
+     * The response data (null if error)
+     */
+    data?: TcrCampaignWithUseCases | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+export interface BaseDto {
+    /**
+     * Unique identifier
+     */
+    id?: string;
+    createdAt?: string;
+    updatedAt?: string | null;
+}
+/**
+ * Campaign data for create or update operation
+ */
+export interface CampaignData {
+    /**
+     * Campaign description
+     */
+    description: string;
+    /**
+     * Campaign name
+     */
+    name: string;
+    /**
+     * Campaign type (e.g., "KYC", "App")
+     */
+    type: string;
+    /**
+     * List of use cases with sample messages
+     */
+    useCases: Array<SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData>;
+    /**
+     * 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;
+}
+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';
+/**
+ * Campaign use case with sample messages
+ */
+export interface SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData {
+    messagingUseCaseUs: MessagingUseCaseUs;
+    /**
+     * Sample messages for this use case (1-5 messages, max 1024 characters each)
+     */
+    sampleMessages: Array<string>;
+}
+export interface TcrCampaignWithUseCases extends BaseDto {
+    billedDate?: string | null;
+    brandId?: string | null;
+    cost?: number | null;
+    cspId?: string | null;
+    customerId?: string;
+    description?: string;
+    helpKeywords?: string | null;
+    helpMessage?: string | null;
+    kycSubmissionFormId?: string | null;
+    messageFlow?: string | null;
+    name?: string;
+    optinKeywords?: string | null;
+    optinMessage?: string | null;
+    optoutKeywords?: string | null;
+    optoutMessage?: string | null;
+    privacyPolicyLink?: string | null;
+    resellerId?: string | null;
+    sharingStatus?: 'PENDING' | 'ACCEPTED' | 'DECLINED' | null;
+    status?: 'SENT_CREATED' | 'ACTIVE' | 'EXPIRED' | null;
+    submittedAt?: string | null;
+    submittedToTCR?: boolean;
+    tcrCampaignId?: string | null;
+    tcrSyncError?: string | null;
+    telnyxCampaignId?: string | null;
+    termsAndConditionsLink?: string | null;
+    type?: string;
+    upstreamCnpId?: string | null;
+    useCases?: Array<TcrCampaignWithUseCases.UseCase>;
+}
+export declare namespace TcrCampaignWithUseCases {
+    interface UseCase extends CampaignsAPI.BaseDto {
+        campaignId?: string;
+        customerId?: string;
+        messagingUseCaseUs?: CampaignsAPI.MessagingUseCaseUs;
+        sampleMessages?: Array<string>;
+    }
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface CampaignListResponse {
+    /**
+     * The response data (null if error)
+     */
+    data?: Array<TcrCampaignWithUseCases> | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+export interface CampaignCreateParams {
+    /**
+     * Body param: Campaign data for create or update operation
+     */
+    campaign: CampaignData;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface CampaignUpdateParams {
+    /**
+     * Path param: Profile ID from route
+     */
+    profileId: string;
+    /**
+     * Body param: Campaign data for create or update operation
+     */
+    campaign: CampaignData;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface CampaignListParams {
+    /**
+     * Profile UUID to scope the request to a child profile. Only organization API keys
+     * can use this header. The profile must belong to the calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface CampaignDeleteParams {
+    /**
+     * Path param: Profile ID from route parameter
+     */
+    profileId: string;
+    /**
+     * Body param: Request to delete a campaign from a brand
+     */
+    body: CampaignDeleteParams.Body;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export declare namespace CampaignDeleteParams {
+    /**
+     * Request to delete a campaign from a brand
+     */
+    interface Body extends WebhooksAPI.MutationRequest {
+    }
+}
+export declare namespace Campaigns {
+    export { type APIResponseOfTcrCampaignWithUseCases as APIResponseOfTcrCampaignWithUseCases, type BaseDto as BaseDto, type CampaignData as CampaignData, type MessagingUseCaseUs as MessagingUseCaseUs, type SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData as SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData, type TcrCampaignWithUseCases as TcrCampaignWithUseCases, type CampaignListResponse as CampaignListResponse, type CampaignCreateParams as CampaignCreateParams, type CampaignUpdateParams as CampaignUpdateParams, type CampaignListParams as CampaignListParams, type CampaignDeleteParams as CampaignDeleteParams, };
+}
+//# sourceMappingURL=campaigns.d.mts.map

package/resources/profiles/campaigns.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaigns.d.mts","sourceRoot":"","sources":["../../src/resources/profiles/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAenD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAenD;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAWnC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAWrG;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,IAAI,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,iFAAiF,CAAC,CAAC;IAEnG;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,MAAM,MAAM,kBAAkB,GAC1B,WAAW,GACX,sBAAsB,GACtB,eAAe,GACf,aAAa,GACb,QAAQ,GACR,uBAAuB,GACvB,gBAAgB,GAChB,KAAK,GACL,OAAO,GACP,kBAAkB,GAClB,gBAAgB,GAChB,6BAA6B,GAC7B,YAAY,CAAC;AAEjB;;GAEG;AACH,MAAM,WAAW,iFAAiF;IAChG,kBAAkB,EAAE,kBAAkB,CAAC;IAEvC;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,uBAAwB,SAAQ,OAAO;IACtD,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,aAAa,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,IAAI,CAAC;IAE3D,MAAM,CAAC,EAAE,cAAc,GAAG,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAC;IAEtD,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,QAAQ,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;CACnD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,OAAQ,SAAQ,YAAY,CAAC,OAAO;QACnD,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,kBAAkB,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC;QAErD,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAChC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;IAEhC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAK,SAAQ,WAAW,CAAC,eAAe;KAAG;CAC7D;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iFAAiF,IAAI,iFAAiF,EAC3K,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/profiles/campaigns.d.ts

@@ -0,0 +1,339 @@
+import { APIResource } from "../../core/resource.js";
+import * as CampaignsAPI from "./campaigns.js";
+import * as WebhooksAPI from "../webhooks.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Manage organization profiles
+ */
+export declare class Campaigns extends APIResource {
+    /**
+     * 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 apiResponseOfTcrCampaignWithUseCases =
+     *   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<APIResponseOfTcrCampaignWithUseCases>;
+    /**
+     * Updates an existing campaign under the brand of the specified profile. Cannot
+     * update campaigns that have already been submitted to TCR.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfTcrCampaignWithUseCases =
+     *   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<APIResponseOfTcrCampaignWithUseCases>;
+    /**
+     * 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 campaigns = await client.profiles.campaigns.list(
+     *   '770e8400-e29b-41d4-a716-446655440002',
+     * );
+     * ```
+     */
+    list(profileID: string, params?: CampaignListParams | null | undefined, options?: RequestOptions): APIPromise<CampaignListResponse>;
+    /**
+     * 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',
+     *     body: {},
+     *   },
+     * );
+     * ```
+     */
+    delete(campaignID: string, params: CampaignDeleteParams, options?: RequestOptions): APIPromise<void>;
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfTcrCampaignWithUseCases {
+    /**
+     * The response data (null if error)
+     */
+    data?: TcrCampaignWithUseCases | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+export interface BaseDto {
+    /**
+     * Unique identifier
+     */
+    id?: string;
+    createdAt?: string;
+    updatedAt?: string | null;
+}
+/**
+ * Campaign data for create or update operation
+ */
+export interface CampaignData {
+    /**
+     * Campaign description
+     */
+    description: string;
+    /**
+     * Campaign name
+     */
+    name: string;
+    /**
+     * Campaign type (e.g., "KYC", "App")
+     */
+    type: string;
+    /**
+     * List of use cases with sample messages
+     */
+    useCases: Array<SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData>;
+    /**
+     * 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;
+}
+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';
+/**
+ * Campaign use case with sample messages
+ */
+export interface SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData {
+    messagingUseCaseUs: MessagingUseCaseUs;
+    /**
+     * Sample messages for this use case (1-5 messages, max 1024 characters each)
+     */
+    sampleMessages: Array<string>;
+}
+export interface TcrCampaignWithUseCases extends BaseDto {
+    billedDate?: string | null;
+    brandId?: string | null;
+    cost?: number | null;
+    cspId?: string | null;
+    customerId?: string;
+    description?: string;
+    helpKeywords?: string | null;
+    helpMessage?: string | null;
+    kycSubmissionFormId?: string | null;
+    messageFlow?: string | null;
+    name?: string;
+    optinKeywords?: string | null;
+    optinMessage?: string | null;
+    optoutKeywords?: string | null;
+    optoutMessage?: string | null;
+    privacyPolicyLink?: string | null;
+    resellerId?: string | null;
+    sharingStatus?: 'PENDING' | 'ACCEPTED' | 'DECLINED' | null;
+    status?: 'SENT_CREATED' | 'ACTIVE' | 'EXPIRED' | null;
+    submittedAt?: string | null;
+    submittedToTCR?: boolean;
+    tcrCampaignId?: string | null;
+    tcrSyncError?: string | null;
+    telnyxCampaignId?: string | null;
+    termsAndConditionsLink?: string | null;
+    type?: string;
+    upstreamCnpId?: string | null;
+    useCases?: Array<TcrCampaignWithUseCases.UseCase>;
+}
+export declare namespace TcrCampaignWithUseCases {
+    interface UseCase extends CampaignsAPI.BaseDto {
+        campaignId?: string;
+        customerId?: string;
+        messagingUseCaseUs?: CampaignsAPI.MessagingUseCaseUs;
+        sampleMessages?: Array<string>;
+    }
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface CampaignListResponse {
+    /**
+     * The response data (null if error)
+     */
+    data?: Array<TcrCampaignWithUseCases> | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+export interface CampaignCreateParams {
+    /**
+     * Body param: Campaign data for create or update operation
+     */
+    campaign: CampaignData;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface CampaignUpdateParams {
+    /**
+     * Path param: Profile ID from route
+     */
+    profileId: string;
+    /**
+     * Body param: Campaign data for create or update operation
+     */
+    campaign: CampaignData;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface CampaignListParams {
+    /**
+     * Profile UUID to scope the request to a child profile. Only organization API keys
+     * can use this header. The profile must belong to the calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface CampaignDeleteParams {
+    /**
+     * Path param: Profile ID from route parameter
+     */
+    profileId: string;
+    /**
+     * Body param: Request to delete a campaign from a brand
+     */
+    body: CampaignDeleteParams.Body;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export declare namespace CampaignDeleteParams {
+    /**
+     * Request to delete a campaign from a brand
+     */
+    interface Body extends WebhooksAPI.MutationRequest {
+    }
+}
+export declare namespace Campaigns {
+    export { type APIResponseOfTcrCampaignWithUseCases as APIResponseOfTcrCampaignWithUseCases, type BaseDto as BaseDto, type CampaignData as CampaignData, type MessagingUseCaseUs as MessagingUseCaseUs, type SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData as SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData, type TcrCampaignWithUseCases as TcrCampaignWithUseCases, type CampaignListResponse as CampaignListResponse, type CampaignCreateParams as CampaignCreateParams, type CampaignUpdateParams as CampaignUpdateParams, type CampaignListParams as CampaignListParams, type CampaignDeleteParams as CampaignDeleteParams, };
+}
+//# sourceMappingURL=campaigns.d.ts.map