@sentdm/sentdm 0.36.0 → 0.38.0

package/src/resources/conversations.ts

@@ -1,7 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import { APIPromise } from '../core/api-promise';
+import * as WebhooksAPI from './webhooks';
+import { ConversationsPage, type ConversationsPageParams, PagePromise } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -20,15 +21,18 @@ export class Conversations extends APIResource {
    *
    * @example
    * ```ts
-   * const conversations = await client.conversations.list({
-   *   page: 0,
-   *   page_size: 0,
-   * });
+   * // Automatically fetches more pages as needed.
+   * for await (const conversation of client.conversations.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(params: ConversationListParams, options?: RequestOptions): APIPromise<ConversationListResponse> {
-    const { 'x-profile-id': xProfileID, ...query } = params;
-    return this._client.get('/v3/conversations', {
+  list(
+    params: ConversationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ConversationMessagesListMessagesConversationsPage, ConversationMessagesList.Message> {
+    const { 'x-profile-id': xProfileID, ...query } = params ?? {};
+    return this._client.getAPIList('/v3/conversations', ConversationsPage<ConversationMessagesList.Message>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -44,47 +48,56 @@ export class Conversations extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.conversations.listMessages(
+   * // Automatically fetches more pages as needed.
+   * for await (const conversation of client.conversations.listMessages(
    *   '08fab313-c9e2-502c-975e-08b0356c432e',
-   *   { page: 0, page_size: 0 },
-   * );
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   listMessages(
     id: string,
-    params: ConversationListMessagesParams,
+    params: ConversationListMessagesParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ConversationListMessagesResponse> {
-    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,
-      ]),
-    });
+  ): PagePromise<ConversationMessagesListMessagesConversationsPage, ConversationMessagesList.Message> {
+    const { 'x-profile-id': xProfileID, ...query } = params ?? {};
+    return this._client.getAPIList(
+      path`/v3/conversations/${id}`,
+      ConversationsPage<ConversationMessagesList.Message>,
+      {
+        query,
+        ...options,
+        headers: buildHeaders([
+          { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+          options?.headers,
+        ]),
+      },
+    );
   }
 }
 
+export type ConversationMessagesListMessagesConversationsPage =
+  ConversationsPage<ConversationMessagesList.Message>;
+
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface ConversationListResponse {
+export interface APIResponseOfConversationMessagesList {
   /**
    * A paginated list of messages — used by both conversation read endpoints.
    */
-  data?: ConversationListResponse.Data | null;
+  data?: ConversationMessagesList | null;
 
   /**
    * Error information
    */
-  error?: ConversationListResponse.Error | null;
+  error?: WebhooksAPI.ErrorDetail | null;
 
   /**
    * Request and response metadata
    */
-  meta?: ConversationListResponse.Meta;
+  meta?: WebhooksAPI.APIMeta;
 
   /**
    * Indicates whether the request was successful
@@ -92,438 +105,106 @@ export interface ConversationListResponse {
   success?: boolean;
 }
 
-export namespace ConversationListResponse {
-  /**
-   * A paginated list of messages — used by both conversation read endpoints.
-   */
-  export interface Data {
-    /**
-     * The messages on this page.
-     */
-    messages?: Array<Data.Message>;
-
-    /**
-     * Pagination metadata for list responses
-     */
-    pagination?: Data.Pagination;
-  }
-
-  export namespace Data {
-    /**
-     * 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;
-        }
-      }
-    }
-
-    /**
-     * Pagination metadata for list responses
-     */
-    export interface Pagination {
-      /**
-       * @deprecated Cursor-based pagination. Never populated — see Cursors.
-       */
-      cursors?: Pagination.Cursors | null;
-
-      /**
-       * Whether there are more pages after this one
-       */
-      has_more?: boolean;
-
-      /**
-       * Current page number (1-indexed)
-       */
-      page?: number;
-
-      /**
-       * Number of items per page
-       */
-      page_size?: number;
-
-      /**
-       * Total number of items across all pages
-       */
-      total_count?: number;
-
-      /**
-       * Total number of pages
-       */
-      total_pages?: number;
-    }
-
-    export namespace Pagination {
-      /**
-       * @deprecated Cursor-based pagination. Never populated — see Cursors.
-       */
-      export interface Cursors {
-        /**
-         * Cursor to fetch the next page.
-         */
-        after?: string | null;
-
-        /**
-         * Cursor to fetch the previous page.
-         */
-        before?: string | null;
-      }
-    }
-  }
-
-  /**
-   * Error information
-   */
-  export interface Error {
-    /**
-     * Machine-readable error code (e.g., "RESOURCE_001")
-     */
-    code?: string;
-
-    /**
-     * Additional validation error details (field-level errors)
-     */
-    details?: { [key: string]: Array<string> } | null;
-
-    /**
-     * URL to documentation about this error
-     */
-    doc_url?: string | null;
-
-    /**
-     * Human-readable error message
-     */
-    message?: string;
-  }
-
-  /**
-   * Request and response metadata
-   */
-  export interface Meta {
-    /**
-     * Unique identifier for this request (for tracing and support)
-     */
-    request_id?: string;
-
-    /**
-     * Server timestamp when the response was generated
-     */
-    timestamp?: string;
-
-    /**
-     * API version used for this request
-     */
-    version?: string;
-  }
-}
-
 /**
- * Standard API response envelope for all v3 endpoints
+ * A paginated list of messages — used by both conversation read endpoints.
  */
-export interface ConversationListMessagesResponse {
-  /**
-   * A paginated list of messages — used by both conversation read endpoints.
-   */
-  data?: ConversationListMessagesResponse.Data | null;
-
+export interface ConversationMessagesList {
   /**
-   * Error information
-   */
-  error?: ConversationListMessagesResponse.Error | null;
-
-  /**
-   * Request and response metadata
+   * The messages on this page.
    */
-  meta?: ConversationListMessagesResponse.Meta;
+  messages?: Array<ConversationMessagesList.Message>;
 
   /**
-   * Indicates whether the request was successful
+   * Pagination metadata for list responses
    */
-  success?: boolean;
+  pagination?: WebhooksAPI.PaginationMeta;
 }
 
-export namespace ConversationListMessagesResponse {
+export namespace ConversationMessagesList {
   /**
-   * A paginated list of messages — used by both conversation read endpoints.
+   * Message response for v3 API — same shape as v2 with snake_case JSON conventions
    */
-  export interface Data {
-    /**
-     * The messages on this page.
-     */
-    messages?: Array<Data.Message>;
+  export interface Message {
+    id?: string;
 
-    /**
-     * Pagination metadata for list responses
-     */
-    pagination?: Data.Pagination;
-  }
-
-  export namespace Data {
-    /**
-     * 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;
+    active_contact_price?: number | null;
 
-      events?: Array<Message.Event> | null;
+    channel?: string;
 
-      /**
-       * Structured message body format for database storage. Preserves channel-specific
-       * components (header, body, footer, buttons).
-       */
-      message_body?: Message.MessageBody | null;
+    contact_id?: string;
 
-      phone?: string;
+    created_at?: string;
 
-      phone_international?: string;
+    customer_id?: string;
 
-      price?: number | null;
+    direction?: string;
 
-      region_code?: string;
+    events?: Array<Message.Event> | null;
 
-      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).
+     */
+    message_body?: Message.MessageBody | null;
 
-      /**
-       * Structured message body format for database storage. Preserves channel-specific
-       * components (header, body, footer, buttons).
-       */
-      export interface MessageBody {
-        buttons?: Array<MessageBody.Button> | null;
+    phone?: string;
 
-        content?: string;
+    phone_international?: string;
 
-        footer?: string | null;
+    price?: number | null;
 
-        header?: string | null;
-      }
+    region_code?: string;
 
-      export namespace MessageBody {
-        export interface Button {
-          postbackData?: string | null;
+    status?: string;
 
-          text?: string | null;
+    template_category?: string | null;
 
-          type?: string;
+    template_id?: string | null;
 
-          value?: string;
-        }
-      }
-    }
+    template_name?: string | null;
+  }
 
+  export namespace Message {
     /**
-     * Pagination metadata for list responses
+     * Represents a status change event in a message's lifecycle (v3)
      */
-    export interface Pagination {
-      /**
-       * @deprecated Cursor-based pagination. Never populated — see Cursors.
-       */
-      cursors?: Pagination.Cursors | null;
-
-      /**
-       * Whether there are more pages after this one
-       */
-      has_more?: boolean;
-
-      /**
-       * Current page number (1-indexed)
-       */
-      page?: number;
-
-      /**
-       * Number of items per page
-       */
-      page_size?: number;
-
-      /**
-       * Total number of items across all pages
-       */
-      total_count?: number;
-
-      /**
-       * Total number of pages
-       */
-      total_pages?: number;
-    }
+    export interface Event {
+      status: string;
 
-    export namespace Pagination {
-      /**
-       * @deprecated Cursor-based pagination. Never populated — see Cursors.
-       */
-      export interface Cursors {
-        /**
-         * Cursor to fetch the next page.
-         */
-        after?: string | null;
-
-        /**
-         * Cursor to fetch the previous page.
-         */
-        before?: string | null;
-      }
+      timestamp: string;
+
+      description?: string | null;
     }
-  }
 
-  /**
-   * Error information
-   */
-  export interface Error {
     /**
-     * Machine-readable error code (e.g., "RESOURCE_001")
+     * Structured message body format for database storage. Preserves channel-specific
+     * components (header, body, footer, buttons).
      */
-    code?: string;
+    export interface MessageBody {
+      buttons?: Array<MessageBody.Button> | null;
 
-    /**
-     * Additional validation error details (field-level errors)
-     */
-    details?: { [key: string]: Array<string> } | null;
+      content?: string;
 
-    /**
-     * URL to documentation about this error
-     */
-    doc_url?: string | null;
+      footer?: string | null;
 
-    /**
-     * Human-readable error message
-     */
-    message?: string;
-  }
+      header?: string | null;
+    }
 
-  /**
-   * Request and response metadata
-   */
-  export interface Meta {
-    /**
-     * Unique identifier for this request (for tracing and support)
-     */
-    request_id?: string;
+    export namespace MessageBody {
+      export interface Button {
+        postbackData?: string | null;
 
-    /**
-     * Server timestamp when the response was generated
-     */
-    timestamp?: string;
+        text?: string | null;
 
-    /**
-     * API version used for this request
-     */
-    version?: string;
+        type?: string;
+
+        value?: string;
+      }
+    }
   }
 }
 
-export interface ConversationListParams {
-  /**
-   * Query param
-   */
-  page: number;
-
-  /**
-   * Query param
-   */
-  page_size: number;
-
+export interface ConversationListParams extends ConversationsPageParams {
   /**
    * 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
@@ -532,17 +213,7 @@ export interface ConversationListParams {
   'x-profile-id'?: string;
 }
 
-export interface ConversationListMessagesParams {
-  /**
-   * Query param
-   */
-  page: number;
-
-  /**
-   * Query param
-   */
-  page_size: number;
-
+export interface ConversationListMessagesParams extends ConversationsPageParams {
   /**
    * 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
@@ -553,8 +224,9 @@ export interface ConversationListMessagesParams {
 
 export declare namespace Conversations {
   export {
-    type ConversationListResponse as ConversationListResponse,
-    type ConversationListMessagesResponse as ConversationListMessagesResponse,
+    type APIResponseOfConversationMessagesList as APIResponseOfConversationMessagesList,
+    type ConversationMessagesList as ConversationMessagesList,
+    type ConversationMessagesListMessagesConversationsPage as ConversationMessagesListMessagesConversationsPage,
     type ConversationListParams as ConversationListParams,
     type ConversationListMessagesParams as ConversationListMessagesParams,
   };