@sentdm/sentdm 0.7.1 → 0.14.0

package/src/resources/numbers.ts

@@ -0,0 +1,102 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as WebhooksAPI from './webhooks';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Manage and lookup phone numbers
+ */
+export class Numbers extends APIResource {
+  /**
+   * Retrieves detailed information about a phone number including carrier, line
+   * type, porting status, and VoIP detection. Uses the customer's messaging provider
+   * for rich data, with fallback to the internal index.
+   *
+   * @example
+   * ```ts
+   * const response = await client.numbers.lookup(
+   *   '+12025551234',
+   * );
+   * ```
+   */
+  lookup(
+    phoneNumber: string,
+    params: NumberLookupParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<NumberLookupResponse> {
+    const { 'x-profile-id': xProfileID } = params ?? {};
+    return this._client.get(path`/v3/numbers/lookup/${phoneNumber}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface NumberLookupResponse {
+  /**
+   * The response data (null if error)
+   */
+  data?: NumberLookupResponse.Data | null;
+
+  /**
+   * Error information
+   */
+  error?: WebhooksAPI.ErrorDetail | null;
+
+  /**
+   * Request and response metadata
+   */
+  meta?: WebhooksAPI.APIMeta;
+
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
+
+export namespace NumberLookupResponse {
+  /**
+   * The response data (null if error)
+   */
+  export interface Data {
+    carrier_name?: string | null;
+
+    country_code?: string | null;
+
+    is_ported?: boolean | null;
+
+    is_valid?: boolean;
+
+    is_voip?: boolean | null;
+
+    line_type?: string | null;
+
+    mobile_country_code?: string | null;
+
+    mobile_network_code?: string | null;
+
+    phone_number?: string;
+  }
+}
+
+export interface NumberLookupParams {
+  /**
+   * 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 Numbers {
+  export { type NumberLookupResponse as NumberLookupResponse, type NumberLookupParams as NumberLookupParams };
+}

package/src/resources/profiles/campaigns.ts

@@ -0,0 +1,501 @@
+// 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';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Manage organization profiles
+ */
+export 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> {
+    const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+    return this._client.post(path`/v3/profiles/${profileID}/campaigns`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+          ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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> {
+    const { profileId, 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+    return this._client.put(path`/v3/profiles/${profileId}/campaigns/${campaignID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+          ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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> {
+    const { 'x-profile-id': xProfileID } = params ?? {};
+    return this._client.get(path`/v3/profiles/${profileID}/campaigns`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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> {
+    const { profileId, body, 'x-profile-id': xProfileID } = params;
+    return this._client.delete(path`/v3/profiles/${profileId}/campaigns/${campaignID}`, {
+      body: body,
+      ...options,
+      headers: buildHeaders([
+        { Accept: '*/*', ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+/**
+ * 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 namespace TcrCampaignWithUseCases {
+  export 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 namespace CampaignDeleteParams {
+  /**
+   * Request to delete a campaign from a brand
+   */
+  export 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,
+  };
+}

package/src/resources/profiles/index.ts

@@ -0,0 +1,38 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Campaigns,
+  type APIResponseOfTcrCampaignWithUseCases,
+  type BaseDto,
+  type CampaignData,
+  type MessagingUseCaseUs,
+  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData,
+  type TcrCampaignWithUseCases,
+  type CampaignListResponse,
+  type CampaignCreateParams,
+  type CampaignUpdateParams,
+  type CampaignListParams,
+  type CampaignDeleteParams,
+} from './campaigns';
+export {
+  Profiles,
+  type APIResponseOfProfileDetail,
+  type BillingContactInfo,
+  type BrandsBrandData,
+  type DestinationCountry,
+  type PaymentDetails,
+  type ProfileDetail,
+  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo,
+  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo,
+  type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo,
+  type TcrBrandRelationship,
+  type TcrVertical,
+  type ProfileListResponse,
+  type ProfileCompleteResponse,
+  type ProfileCreateParams,
+  type ProfileRetrieveParams,
+  type ProfileUpdateParams,
+  type ProfileListParams,
+  type ProfileDeleteParams,
+  type ProfileCompleteParams,
+} from './profiles';