@sentdm/sentdm 0.31.0 → 0.33.0

package/src/client.ts

@@ -19,15 +19,25 @@ import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
 import {
   APIResponseOfContact,
+  APIResponseOfContactMessageSummary,
   ContactCreateParams,
   ContactDeleteParams,
   ContactListParams,
   ContactListResponse,
+  ContactMessageSummary,
   ContactResponse,
+  ContactRetrieveMessageSummaryParams,
   ContactRetrieveParams,
   ContactUpdateParams,
   Contacts,
 } from './resources/contacts';
+import {
+  APIResponseOfConversationMessagesList,
+  ConversationListMessagesParams,
+  ConversationListParams,
+  ConversationMessagesList,
+  Conversations,
+} from './resources/conversations';
 import { Me, MeRetrieveParams, MeRetrieveResponse, ProfileSettings } from './resources/me';
 import {
   MessageRetrieveActivitiesParams,
@@ -41,17 +51,17 @@ import {
 import { NumberLookupParams, NumberLookupResponse, Numbers } from './resources/numbers';
 import {
   APIResponseTemplate,
-  SentDmServicesCommonContractsPocOsAuthenticationConfig,
-  SentDmServicesCommonContractsPocOsTemplateBody,
-  SentDmServicesCommonContractsPocOsTemplateButton,
-  SentDmServicesCommonContractsPocOsTemplateButtonProps,
-  SentDmServicesCommonContractsPocOsTemplateFooter,
-  SentDmServicesCommonContractsPocOsTemplateHeader,
+  AuthenticationConfig,
   Template,
+  TemplateBody,
   TemplateBodyContent,
+  TemplateButton,
+  TemplateButtonProps,
   TemplateCreateParams,
   TemplateDefinition,
   TemplateDeleteParams,
+  TemplateFooter,
+  TemplateHeader,
   TemplateListParams,
   TemplateListResponse,
   TemplateRetrieveParams,
@@ -98,6 +108,9 @@ import {
 import {
   APIResponseOfProfileDetail,
   BillingContactInfo,
+  BrandBusinessInfo,
+  BrandComplianceInfo,
+  BrandContactInfo,
   BrandsBrandData,
   DestinationCountry,
   PaymentDetails,
@@ -111,9 +124,6 @@ import {
   ProfileRetrieveParams,
   ProfileUpdateParams,
   Profiles,
-  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo,
-  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo,
-  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo,
   TcrBrandRelationship,
   TcrVertical,
 } from './resources/profiles/profiles';
@@ -865,6 +875,7 @@ export class Sent {
    * Create, update, and manage customer contact lists
    */
   contacts: API.Contacts = new API.Contacts(this);
+  conversations: API.Conversations = new API.Conversations(this);
   /**
    * Retrieve account details
    */
@@ -878,6 +889,7 @@ Sent.Profiles = Profiles;
 Sent.Numbers = Numbers;
 Sent.Messages = Messages;
 Sent.Contacts = Contacts;
+Sent.Conversations = Conversations;
 Sent.Me = Me;
 
 export declare namespace Sent {
@@ -924,15 +936,15 @@ export declare namespace Sent {
   export {
     Templates as Templates,
     type APIResponseTemplate as APIResponseTemplate,
-    type SentDmServicesCommonContractsPocOsAuthenticationConfig as SentDmServicesCommonContractsPocOsAuthenticationConfig,
-    type SentDmServicesCommonContractsPocOsTemplateBody as SentDmServicesCommonContractsPocOsTemplateBody,
-    type SentDmServicesCommonContractsPocOsTemplateButton as SentDmServicesCommonContractsPocOsTemplateButton,
-    type SentDmServicesCommonContractsPocOsTemplateButtonProps as SentDmServicesCommonContractsPocOsTemplateButtonProps,
-    type SentDmServicesCommonContractsPocOsTemplateFooter as SentDmServicesCommonContractsPocOsTemplateFooter,
-    type SentDmServicesCommonContractsPocOsTemplateHeader as SentDmServicesCommonContractsPocOsTemplateHeader,
+    type AuthenticationConfig as AuthenticationConfig,
     type Template as Template,
+    type TemplateBody as TemplateBody,
     type TemplateBodyContent as TemplateBodyContent,
+    type TemplateButton as TemplateButton,
+    type TemplateButtonProps as TemplateButtonProps,
     type TemplateDefinition as TemplateDefinition,
+    type TemplateFooter as TemplateFooter,
+    type TemplateHeader as TemplateHeader,
     type TemplateVariable as TemplateVariable,
     type TemplateListResponse as TemplateListResponse,
     type TemplateCreateParams as TemplateCreateParams,
@@ -946,13 +958,13 @@ export declare namespace Sent {
     Profiles as Profiles,
     type APIResponseOfProfileDetail as APIResponseOfProfileDetail,
     type BillingContactInfo as BillingContactInfo,
+    type BrandBusinessInfo as BrandBusinessInfo,
+    type BrandComplianceInfo as BrandComplianceInfo,
+    type BrandContactInfo as BrandContactInfo,
     type BrandsBrandData as BrandsBrandData,
     type DestinationCountry as DestinationCountry,
     type PaymentDetails as PaymentDetails,
     type ProfileDetail as ProfileDetail,
-    type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo as SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo,
-    type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo as SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo,
-    type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo as SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo,
     type TcrBrandRelationship as TcrBrandRelationship,
     type TcrVertical as TcrVertical,
     type ProfileListResponse as ProfileListResponse,
@@ -984,6 +996,8 @@ export declare namespace Sent {
   export {
     Contacts as Contacts,
     type APIResponseOfContact as APIResponseOfContact,
+    type APIResponseOfContactMessageSummary as APIResponseOfContactMessageSummary,
+    type ContactMessageSummary as ContactMessageSummary,
     type ContactResponse as ContactResponse,
     type ContactListResponse as ContactListResponse,
     type ContactCreateParams as ContactCreateParams,
@@ -991,6 +1005,15 @@ export declare namespace Sent {
     type ContactUpdateParams as ContactUpdateParams,
     type ContactListParams as ContactListParams,
     type ContactDeleteParams as ContactDeleteParams,
+    type ContactRetrieveMessageSummaryParams as ContactRetrieveMessageSummaryParams,
+  };
+
+  export {
+    Conversations as Conversations,
+    type APIResponseOfConversationMessagesList as APIResponseOfConversationMessagesList,
+    type ConversationMessagesList as ConversationMessagesList,
+    type ConversationListParams as ConversationListParams,
+    type ConversationListMessagesParams as ConversationListMessagesParams,
   };
 
   export {

package/src/resources/contacts.ts

@@ -141,6 +141,35 @@ export class Contacts extends APIResource {
       ]),
     });
   }
+
+  /**
+   * Returns aggregate message counts, time bounds, channels used, and per-channel
+   * success/fail scores (each as a percentage 0-100 of messages on that channel) for
+   * one of your contacts. Successful terminal states: SENT/DELIVERED/READ for
+   * outbound, RECEIVED for inbound. Fail: FAILED.
+   *
+   * @example
+   * ```ts
+   * const apiResponseOfContactMessageSummary =
+   *   await client.contacts.retrieveMessageSummary(
+   *     '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+   *   );
+   * ```
+   */
+  retrieveMessageSummary(
+    contactID: string,
+    params: ContactRetrieveMessageSummaryParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<APIResponseOfContactMessageSummary> {
+    const { 'x-profile-id': xProfileID } = params ?? {};
+    return this._client.get(path`/v3/contacts/${contactID}/message-summary`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
 }
 
 /**
@@ -168,6 +197,62 @@ export interface APIResponseOfContact {
   success?: boolean;
 }
 
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfContactMessageSummary {
+  /**
+   * The response data (null if error)
+   */
+  data?: ContactMessageSummary | null;
+
+  /**
+   * Error information
+   */
+  error?: WebhooksAPI.ErrorDetail | null;
+
+  /**
+   * Request and response metadata
+   */
+  meta?: WebhooksAPI.APIMeta;
+
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
+
+export interface ContactMessageSummary {
+  channel_scores?: Array<ContactMessageSummary.ChannelScore>;
+
+  channels_used?: Array<string>;
+
+  contact_id?: string;
+
+  first_message_at?: string | null;
+
+  last_message_at?: string | null;
+
+  message_count?: number;
+}
+
+export namespace ContactMessageSummary {
+  export interface ChannelScore {
+    channel?: string;
+
+    /**
+     * Percentage (0-100) of messages on this channel that ended in FAILED.
+     */
+    fail_score?: number;
+
+    /**
+     * Percentage (0-100) of messages on this channel that reached a successful
+     * terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
+     */
+    success_score?: number;
+  }
+}
+
 /**
  * Contact response for v3 API Uses snake_case for JSON property names
  */
@@ -403,9 +488,19 @@ export interface ContactDeleteParams {
   'x-profile-id'?: string;
 }
 
+export interface ContactRetrieveMessageSummaryParams {
+  /**
+   * 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 Contacts {
   export {
     type APIResponseOfContact as APIResponseOfContact,
+    type APIResponseOfContactMessageSummary as APIResponseOfContactMessageSummary,
+    type ContactMessageSummary as ContactMessageSummary,
     type ContactResponse as ContactResponse,
     type ContactListResponse as ContactListResponse,
     type ContactCreateParams as ContactCreateParams,
@@ -413,5 +508,6 @@ export declare namespace Contacts {
     type ContactUpdateParams as ContactUpdateParams,
     type ContactListParams as ContactListParams,
     type ContactDeleteParams as ContactDeleteParams,
+    type ContactRetrieveMessageSummaryParams as ContactRetrieveMessageSummaryParams,
   };
 }

package/src/resources/conversations.ts

@@ -0,0 +1,238 @@
+// 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';
+
+export class Conversations extends APIResource {
+  /**
+   * Retrieves a paginated list of the authenticated customer's messages across all
+   * conversations, ordered by created date (most recent first).
+   *
+   * @example
+   * ```ts
+   * const apiResponseOfConversationMessagesList =
+   *   await client.conversations.list({
+   *     page: 0,
+   *     page_size: 0,
+   *   });
+   * ```
+   */
+  list(
+    params: ConversationListParams,
+    options?: RequestOptions,
+  ): APIPromise<APIResponseOfConversationMessagesList> {
+    const { 'x-profile-id': xProfileID, ...query } = params;
+    return this._client.get('/v3/conversations', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Retrieves a paginated list of the messages in a single conversation (scoped to
+   * the authenticated customer), ordered by created date (most recent first).
+   *
+   * @example
+   * ```ts
+   * const apiResponseOfConversationMessagesList =
+   *   await client.conversations.listMessages(
+   *     '08fab313-c9e2-502c-975e-08b0356c432e',
+   *     { page: 0, page_size: 0 },
+   *   );
+   * ```
+   */
+  listMessages(
+    id: string,
+    params: ConversationListMessagesParams,
+    options?: RequestOptions,
+  ): APIPromise<APIResponseOfConversationMessagesList> {
+    const { 'x-profile-id': xProfileID, ...query } = params;
+    return this._client.get(path`/v3/conversations/${id}`, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfConversationMessagesList {
+  /**
+   * A paginated list of messages — used by both conversation read endpoints.
+   */
+  data?: ConversationMessagesList | null;
+
+  /**
+   * Error information
+   */
+  error?: WebhooksAPI.ErrorDetail | null;
+
+  /**
+   * Request and response metadata
+   */
+  meta?: WebhooksAPI.APIMeta;
+
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
+
+/**
+ * A paginated list of messages — used by both conversation read endpoints.
+ */
+export interface ConversationMessagesList {
+  /**
+   * The messages on this page, most recent first.
+   */
+  messages?: Array<ConversationMessagesList.Message>;
+
+  /**
+   * Pagination metadata for list responses
+   */
+  pagination?: WebhooksAPI.PaginationMeta;
+}
+
+export namespace ConversationMessagesList {
+  /**
+   * Message response for v3 API — same shape as v2 with snake_case JSON conventions
+   */
+  export interface Message {
+    id?: string;
+
+    active_contact_price?: number | null;
+
+    channel?: string;
+
+    contact_id?: string;
+
+    created_at?: string;
+
+    customer_id?: string;
+
+    direction?: string;
+
+    events?: Array<Message.Event> | null;
+
+    /**
+     * Structured message body format for database storage. Preserves channel-specific
+     * components (header, body, footer, buttons).
+     */
+    message_body?: Message.MessageBody | null;
+
+    phone?: string;
+
+    phone_international?: string;
+
+    price?: number | null;
+
+    region_code?: string;
+
+    status?: string;
+
+    template_category?: string | null;
+
+    template_id?: string | null;
+
+    template_name?: string | null;
+  }
+
+  export namespace Message {
+    /**
+     * Represents a status change event in a message's lifecycle (v3)
+     */
+    export interface Event {
+      status: string;
+
+      timestamp: string;
+
+      description?: string | null;
+    }
+
+    /**
+     * Structured message body format for database storage. Preserves channel-specific
+     * components (header, body, footer, buttons).
+     */
+    export interface MessageBody {
+      buttons?: Array<MessageBody.Button> | null;
+
+      content?: string;
+
+      footer?: string | null;
+
+      header?: string | null;
+    }
+
+    export namespace MessageBody {
+      export interface Button {
+        postbackData?: string | null;
+
+        text?: string | null;
+
+        type?: string;
+
+        value?: string;
+      }
+    }
+  }
+}
+
+export interface ConversationListParams {
+  /**
+   * Query param
+   */
+  page: number;
+
+  /**
+   * Query param
+   */
+  page_size: number;
+
+  /**
+   * 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 ConversationListMessagesParams {
+  /**
+   * Query param
+   */
+  page: number;
+
+  /**
+   * Query param
+   */
+  page_size: number;
+
+  /**
+   * 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 Conversations {
+  export {
+    type APIResponseOfConversationMessagesList as APIResponseOfConversationMessagesList,
+    type ConversationMessagesList as ConversationMessagesList,
+    type ConversationListParams as ConversationListParams,
+    type ConversationListMessagesParams as ConversationListMessagesParams,
+  };
+}

package/src/resources/index.ts

@@ -3,6 +3,8 @@
 export {
   Contacts,
   type APIResponseOfContact,
+  type APIResponseOfContactMessageSummary,
+  type ContactMessageSummary,
   type ContactResponse,
   type ContactListResponse,
   type ContactCreateParams,
@@ -10,7 +12,15 @@ export {
   type ContactUpdateParams,
   type ContactListParams,
   type ContactDeleteParams,
+  type ContactRetrieveMessageSummaryParams,
 } from './contacts';
+export {
+  Conversations,
+  type APIResponseOfConversationMessagesList,
+  type ConversationMessagesList,
+  type ConversationListParams,
+  type ConversationListMessagesParams,
+} from './conversations';
 export { Me, type ProfileSettings, type MeRetrieveResponse, type MeRetrieveParams } from './me';
 export {
   Messages,
@@ -26,13 +36,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,
@@ -47,15 +57,15 @@ export {
 export {
   Templates,
   type APIResponseTemplate,
-  type SentDmServicesCommonContractsPocOsAuthenticationConfig,
-  type SentDmServicesCommonContractsPocOsTemplateBody,
-  type SentDmServicesCommonContractsPocOsTemplateButton,
-  type SentDmServicesCommonContractsPocOsTemplateButtonProps,
-  type SentDmServicesCommonContractsPocOsTemplateFooter,
-  type SentDmServicesCommonContractsPocOsTemplateHeader,
+  type AuthenticationConfig,
   type Template,
+  type TemplateBody,
   type TemplateBodyContent,
+  type TemplateButton,
+  type TemplateButtonProps,
   type TemplateDefinition,
+  type TemplateFooter,
+  type TemplateHeader,
   type TemplateVariable,
   type TemplateListResponse,
   type TemplateCreateParams,

package/src/resources/messages.ts

@@ -68,7 +68,10 @@ export class Messages extends APIResource {
    * multi-channel broadcast — when multiple channels are specified (e.g. ["sms",
    * "whatsapp"]), a separate message is created for each (recipient, channel) pair.
    * Returns immediately with per-recipient message IDs for async tracking via
-   * webhooks or the GET /messages/{id} endpoint.
+   * webhooks or the GET /messages/{id} endpoint. Account-level preconditions such as
+   * insufficient balance do not reject the request: the send is accepted with 202
+   * and the affected messages are reported as BLOCKED on GET /messages/{id} and the
+   * message status webhook.
    *
    * @example
    * ```ts
@@ -320,8 +323,7 @@ export namespace MessageSendResponse {
     recipients?: Array<Data.Recipient>;
 
     /**
-     * Overall request status: "QUEUED" when the batch has been accepted and published
-     * to Kafka.
+     * Overall request status: "QUEUED" when the batch has been accepted for delivery.
      */
     status?: string;