@sentdm/sentdm 0.32.0 → 0.34.0

package/src/resources/profiles/campaigns.ts

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as CampaignsAPI from './campaigns';
 import * as WebhooksAPI from '../webhooks';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
@@ -18,7 +17,7 @@ export class Campaigns extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseOfTcrCampaignWithUseCases =
+   * const apiResponseOfBrandCampaign =
    *   await client.profiles.campaigns.create(
    *     '770e8400-e29b-41d4-a716-446655440002',
    *     {
@@ -45,7 +44,7 @@ export class Campaigns extends APIResource {
     profileID: string,
     params: CampaignCreateParams,
     options?: RequestOptions,
-  ): APIPromise<APIResponseOfTcrCampaignWithUseCases> {
+  ): APIPromise<APIResponseOfBrandCampaign> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.post(path`/v3/profiles/${profileID}/campaigns`, {
       body,
@@ -66,7 +65,7 @@ export class Campaigns extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseOfTcrCampaignWithUseCases =
+   * const apiResponseOfBrandCampaign =
    *   await client.profiles.campaigns.update(
    *     'b2c3d4e5-f6a7-8901-bcde-f12345678901',
    *     {
@@ -94,7 +93,7 @@ export class Campaigns extends APIResource {
     campaignID: string,
     params: CampaignUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<APIResponseOfTcrCampaignWithUseCases> {
+  ): APIPromise<APIResponseOfBrandCampaign> {
     const { profileId, 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.put(path`/v3/profiles/${profileId}/campaigns/${campaignID}`, {
       body,
@@ -115,16 +114,17 @@ export class Campaigns extends APIResource {
    *
    * @example
    * ```ts
-   * const campaigns = await client.profiles.campaigns.list(
-   *   '770e8400-e29b-41d4-a716-446655440002',
-   * );
+   * const apiResponseOfListOfBrandCampaign =
+   *   await client.profiles.campaigns.list(
+   *     '770e8400-e29b-41d4-a716-446655440002',
+   *   );
    * ```
    */
   list(
     profileID: string,
     params: CampaignListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CampaignListResponse> {
+  ): APIPromise<APIResponseOfListOfBrandCampaign> {
     const { 'x-profile-id': xProfileID } = params ?? {};
     return this._client.get(path`/v3/profiles/${profileID}/campaigns`, {
       ...options,
@@ -163,11 +163,11 @@ export class Campaigns extends APIResource {
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface APIResponseOfTcrCampaignWithUseCases {
+export interface APIResponseOfBrandCampaign {
   /**
-   * The response data (null if error)
+   * A 10DLC campaign registered for a brand.
    */
-  data?: TcrCampaignWithUseCases | null;
+  data?: BrandCampaign | null;
 
   /**
    * Error information
@@ -185,15 +185,114 @@ export interface APIResponseOfTcrCampaignWithUseCases {
   success?: boolean;
 }
 
-export interface BaseDto {
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfListOfBrandCampaign {
+  /**
+   * The response data (null if error)
+   */
+  data?: Array<BrandCampaign> | null;
+
+  /**
+   * Error information
+   */
+  error?: WebhooksAPI.ErrorDetail | null;
+
   /**
-   * Unique identifier
+   * Request and response metadata
    */
+  meta?: WebhooksAPI.APIMeta;
+
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
+
+/**
+ * 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;
 }
 
 /**
@@ -218,7 +317,7 @@ export interface CampaignData {
   /**
    * List of use cases with sample messages
    */
-  useCases: Array<SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData>;
+  useCases: Array<CampaignUseCaseData>;
 
   /**
    * Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
@@ -264,141 +363,70 @@ export interface CampaignData {
    * 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)
+   * Expected messaging volume for this campaign. Numeric string (e.g. "1999",
+   * "5000"). Values below 2000 bill at the low-volume tier.
    */
-  sampleMessages: Array<string>;
+  volume?: string | null;
 }
 
-export interface TcrCampaignWithUseCases extends BaseDto {
-  description: string;
-
-  name: string;
-
-  type: string;
-
-  billedDate?: 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;
 
-  brandId?: string | null;
+  campaignId?: string;
 
-  cost?: number | null;
-
-  cspId?: string | null;
+  createdAt?: string;
 
   customerId?: string;
 
-  dcaElectionsComplete?: boolean | null;
-
-  dcaElectionsCompletedAt?: string | null;
+  messagingUseCaseUs?: MessagingUseCaseUs;
 
   /**
-   * True when this campaign already has a billing transaction of reference type
-   * TCR_CAMPAIGN_SUBMISSION (the one-time submission fee was charged). Populated
-   * only by the campaigns-list path; defaults false on other responses.
+   * Sample messages submitted to the registry for this use case.
    */
-  hasSubmissionTransaction?: boolean;
-
-  helpKeywords?: string | null;
-
-  helpMessage?: string | null;
-
-  kycSubmissionFormId?: string | null;
-
-  messageFlow?: string | null;
-
-  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;
+  sampleMessages?: Array<string>;
 
-  tcrCampaignId?: string | null;
-
-  tcrSyncError?: string | null;
-
-  telnyxCampaignId?: string | null;
-
-  termsAndConditionsLink?: string | null;
-
-  upstreamCnpId?: string | null;
-
-  useCases?: Array<TcrCampaignWithUseCases.UseCase>;
-}
-
-export namespace TcrCampaignWithUseCases {
-  export interface UseCase extends CampaignsAPI.BaseDto {
-    sampleMessages: Array<string>;
-
-    campaignId?: string;
-
-    customerId?: string;
-
-    messagingUseCaseUs?: CampaignsAPI.MessagingUseCaseUs;
-  }
+  updatedAt?: string | null;
 }
 
 /**
- * Standard API response envelope for all v3 endpoints
+ * Campaign use case with sample messages
  */
-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;
+export interface CampaignUseCaseData {
+  messagingUseCaseUs: MessagingUseCaseUs;
 
   /**
-   * Indicates whether the request was successful
+   * Sample messages for this use case (1-5 messages, max 1024 characters each)
    */
-  success?: boolean;
+  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
@@ -488,13 +516,13 @@ export interface CampaignDeleteParams {
 
 export declare namespace Campaigns {
   export {
-    type APIResponseOfTcrCampaignWithUseCases as APIResponseOfTcrCampaignWithUseCases,
-    type BaseDto as BaseDto,
+    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 SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData as SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData,
-    type TcrCampaignWithUseCases as TcrCampaignWithUseCases,
-    type CampaignListResponse as CampaignListResponse,
     type CampaignCreateParams as CampaignCreateParams,
     type CampaignUpdateParams as CampaignUpdateParams,
     type CampaignListParams as CampaignListParams,

package/src/resources/profiles/index.ts

@@ -2,13 +2,13 @@
 
 export {
   Campaigns,
-  type APIResponseOfTcrCampaignWithUseCases,
-  type BaseDto,
+  type APIResponseOfBrandCampaign,
+  type APIResponseOfListOfBrandCampaign,
+  type BrandCampaign,
   type CampaignData,
+  type CampaignUseCase,
+  type CampaignUseCaseData,
   type MessagingUseCaseUs,
-  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData,
-  type TcrCampaignWithUseCases,
-  type CampaignListResponse,
   type CampaignCreateParams,
   type CampaignUpdateParams,
   type CampaignListParams,
@@ -18,13 +18,13 @@ export {
   Profiles,
   type APIResponseOfProfileDetail,
   type BillingContactInfo,
+  type BrandBusinessInfo,
+  type BrandComplianceInfo,
+  type BrandContactInfo,
   type BrandsBrandData,
   type DestinationCountry,
   type PaymentDetails,
   type ProfileDetail,
-  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo,
-  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo,
-  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo,
   type TcrBrandRelationship,
   type TcrVertical,
   type ProfileListResponse,