@sentdm/sentdm 0.32.0 → 0.34.0

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,
@@ -80,8 +90,14 @@ export {
   type APIMeta,
   type APIResponseWebhook,
   type ErrorDetail,
+  type InboundMessageEvent,
+  type InboundMessageEventPayload,
+  type MessageEvent,
+  type MessageEventPayload,
   type MutationRequest,
   type PaginationMeta,
+  type TemplateEvent,
+  type TemplateEventPayload,
   type WebhookEventType,
   type WebhookResponse,
   type WebhookListResponse,

package/src/resources/messages.ts

@@ -68,7 +68,12 @@ 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. Sends gated before any delivery
+   * attempt do not reject the request — an account-level precondition such as
+   * insufficient balance, a template not approved for sending, or free-form content
+   * with no open conversation with the contact. The send is accepted with 202 and
+   * the affected messages are reported as BLOCKED on GET /messages/{id} and the
+   * message.blocked webhook.
    *
    * @example
    * ```ts
@@ -320,8 +325,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;