@sentdm/sentdm 0.34.0 → 0.35.0

package/src/resources/conversations.ts

@@ -1,12 +1,18 @@
 // 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';
 
+/**
+ * Inbound and outbound messages, grouped by the person they are with.
+ *
+ * A conversation is the thread for one contact across every channel — a reply by SMS and one by WhatsApp belong to the same conversation, because they are the same person talking to you.
+ *
+ * Read-only. Sending is **Messages**; a reply arrives here and through your webhooks.
+ */
 export class Conversations extends APIResource {
   /**
    * Retrieves a paginated list of the authenticated customer's messages across all
@@ -14,17 +20,13 @@ export class Conversations extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseOfConversationMessagesList =
-   *   await client.conversations.list({
-   *     page: 0,
-   *     page_size: 0,
-   *   });
+   * const conversations = await client.conversations.list({
+   *   page: 0,
+   *   page_size: 0,
+   * });
    * ```
    */
-  list(
-    params: ConversationListParams,
-    options?: RequestOptions,
-  ): APIPromise<APIResponseOfConversationMessagesList> {
+  list(params: ConversationListParams, options?: RequestOptions): APIPromise<ConversationListResponse> {
     const { 'x-profile-id': xProfileID, ...query } = params;
     return this._client.get('/v3/conversations', {
       query,
@@ -42,18 +44,17 @@ export class Conversations extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseOfConversationMessagesList =
-   *   await client.conversations.listMessages(
-   *     '08fab313-c9e2-502c-975e-08b0356c432e',
-   *     { page: 0, page_size: 0 },
-   *   );
+   * const response = await client.conversations.listMessages(
+   *   '08fab313-c9e2-502c-975e-08b0356c432e',
+   *   { page: 0, page_size: 0 },
+   * );
    * ```
    */
   listMessages(
     id: string,
     params: ConversationListMessagesParams,
     options?: RequestOptions,
-  ): APIPromise<APIResponseOfConversationMessagesList> {
+  ): APIPromise<ConversationListMessagesResponse> {
     const { 'x-profile-id': xProfileID, ...query } = params;
     return this._client.get(path`/v3/conversations/${id}`, {
       query,
@@ -69,21 +70,21 @@ export class Conversations extends APIResource {
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface APIResponseOfConversationMessagesList {
+export interface ConversationListResponse {
   /**
    * A paginated list of messages — used by both conversation read endpoints.
    */
-  data?: ConversationMessagesList | null;
+  data?: ConversationListResponse.Data | null;
 
   /**
    * Error information
    */
-  error?: WebhooksAPI.ErrorDetail | null;
+  error?: ConversationListResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: WebhooksAPI.APIMeta;
+  meta?: ConversationListResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -91,102 +92,424 @@ export interface APIResponseOfConversationMessagesList {
   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;
+  }
+}
+
 /**
- * A paginated list of messages — used by both conversation read endpoints.
+ * Standard API response envelope for all v3 endpoints
  */
-export interface ConversationMessagesList {
+export interface ConversationListMessagesResponse {
   /**
-   * The messages on this page, most recent first.
+   * A paginated list of messages — used by both conversation read endpoints.
+   */
+  data?: ConversationListMessagesResponse.Data | null;
+
+  /**
+   * Error information
    */
-  messages?: Array<ConversationMessagesList.Message>;
+  error?: ConversationListMessagesResponse.Error | null;
 
   /**
-   * Pagination metadata for list responses
+   * Request and response metadata
+   */
+  meta?: ConversationListMessagesResponse.Meta;
+
+  /**
+   * Indicates whether the request was successful
    */
-  pagination?: WebhooksAPI.PaginationMeta;
+  success?: boolean;
 }
 
-export namespace ConversationMessagesList {
+export namespace ConversationListMessagesResponse {
   /**
-   * Message response for v3 API — same shape as v2 with snake_case JSON conventions
+   * A paginated list of messages — used by both conversation read endpoints.
    */
-  export interface Message {
-    id?: string;
+  export interface Data {
+    /**
+     * The messages on this page.
+     */
+    messages?: Array<Data.Message>;
 
-    active_contact_price?: number | null;
+    /**
+     * Pagination metadata for list responses
+     */
+    pagination?: Data.Pagination;
+  }
 
-    channel?: string;
+  export namespace Data {
+    /**
+     * Message response for v3 API — same shape as v2 with snake_case JSON conventions
+     */
+    export interface Message {
+      id?: string;
 
-    contact_id?: string;
+      active_contact_price?: number | null;
 
-    created_at?: string;
+      channel?: string;
 
-    customer_id?: string;
+      contact_id?: string;
 
-    direction?: string;
+      created_at?: string;
 
-    events?: Array<Message.Event> | null;
+      customer_id?: string;
 
-    /**
-     * Structured message body format for database storage. Preserves channel-specific
-     * components (header, body, footer, buttons).
-     */
-    message_body?: Message.MessageBody | null;
+      direction?: string;
 
-    phone?: string;
+      events?: Array<Message.Event> | null;
 
-    phone_international?: string;
+      /**
+       * Structured message body format for database storage. Preserves channel-specific
+       * components (header, body, footer, buttons).
+       */
+      message_body?: Message.MessageBody | null;
 
-    price?: number | null;
+      phone?: string;
 
-    region_code?: string;
+      phone_international?: string;
 
-    status?: string;
+      price?: number | null;
 
-    template_category?: string | null;
+      region_code?: string;
 
-    template_id?: string | null;
+      status?: string;
 
-    template_name?: string | null;
-  }
+      template_category?: string | null;
 
-  export namespace Message {
-    /**
-     * Represents a status change event in a message's lifecycle (v3)
-     */
-    export interface Event {
-      status: string;
+      template_id?: string | null;
 
-      timestamp: string;
+      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;
+      }
 
-      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;
+        }
+      }
     }
 
     /**
-     * Structured message body format for database storage. Preserves channel-specific
-     * components (header, body, footer, buttons).
+     * Pagination metadata for list responses
      */
-    export interface MessageBody {
-      buttons?: Array<MessageBody.Button> | null;
+    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;
+    }
 
-      content?: 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;
+      }
+    }
+  }
 
-      footer?: string | null;
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
 
-      header?: string | null;
-    }
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
 
-    export namespace MessageBody {
-      export interface Button {
-        postbackData?: string | null;
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
 
-        text?: string | null;
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
 
-        type?: string;
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
 
-        value?: string;
-      }
-    }
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
   }
 }
 
@@ -230,8 +553,8 @@ export interface ConversationListMessagesParams {
 
 export declare namespace Conversations {
   export {
-    type APIResponseOfConversationMessagesList as APIResponseOfConversationMessagesList,
-    type ConversationMessagesList as ConversationMessagesList,
+    type ConversationListResponse as ConversationListResponse,
+    type ConversationListMessagesResponse as ConversationListMessagesResponse,
     type ConversationListParams as ConversationListParams,
     type ConversationListMessagesParams as ConversationListMessagesParams,
   };

package/src/resources/index.ts

@@ -2,11 +2,11 @@
 
 export {
   Contacts,
-  type APIResponseOfContact,
-  type APIResponseOfContactMessageSummary,
-  type ContactMessageSummary,
-  type ContactResponse,
+  type ContactCreateResponse,
+  type ContactRetrieveResponse,
+  type ContactUpdateResponse,
   type ContactListResponse,
+  type ContactRetrieveMessageSummaryResponse,
   type ContactCreateParams,
   type ContactRetrieveParams,
   type ContactUpdateParams,
@@ -16,12 +16,12 @@ export {
 } from './contacts';
 export {
   Conversations,
-  type APIResponseOfConversationMessagesList,
-  type ConversationMessagesList,
+  type ConversationListResponse,
+  type ConversationListMessagesResponse,
   type ConversationListParams,
   type ConversationListMessagesParams,
 } from './conversations';
-export { Me, type ProfileSettings, type MeRetrieveResponse, type MeRetrieveParams } from './me';
+export { Me, type MeRetrieveResponse, type MeRetrieveParams } from './me';
 export {
   Messages,
   type MessageRetrieveActivitiesResponse,
@@ -34,17 +34,12 @@ export {
 export { Numbers, type NumberLookupResponse, type NumberLookupParams } from './numbers';
 export {
   Profiles,
-  type APIResponseOfProfileDetail,
-  type BillingContactInfo,
-  type BrandBusinessInfo,
-  type BrandComplianceInfo,
-  type BrandContactInfo,
-  type BrandsBrandData,
   type DestinationCountry,
-  type PaymentDetails,
-  type ProfileDetail,
   type TcrBrandRelationship,
   type TcrVertical,
+  type ProfileCreateResponse,
+  type ProfileRetrieveResponse,
+  type ProfileUpdateResponse,
   type ProfileListResponse,
   type ProfileCompleteResponse,
   type ProfileCreateParams,
@@ -56,9 +51,7 @@ export {
 } from './profiles/profiles';
 export {
   Templates,
-  type APIResponseTemplate,
   type AuthenticationConfig,
-  type Template,
   type TemplateBody,
   type TemplateBodyContent,
   type TemplateButton,
@@ -67,6 +60,9 @@ export {
   type TemplateFooter,
   type TemplateHeader,
   type TemplateVariable,
+  type TemplateCreateResponse,
+  type TemplateRetrieveResponse,
+  type TemplateUpdateResponse,
   type TemplateListResponse,
   type TemplateCreateParams,
   type TemplateRetrieveParams,
@@ -76,9 +72,10 @@ export {
 } from './templates';
 export {
   Users,
-  type APIResponseOfUser,
-  type UserResponse,
+  type UserRetrieveResponse,
   type UserListResponse,
+  type UserInviteResponse,
+  type UserUpdateRoleResponse,
   type UserRetrieveParams,
   type UserListParams,
   type UserInviteParams,
@@ -87,24 +84,21 @@ export {
 } from './users';
 export {
   Webhooks,
-  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 WebhookCreateResponse,
+  type WebhookRetrieveResponse,
+  type WebhookUpdateResponse,
   type WebhookListResponse,
   type WebhookListEventTypesResponse,
   type WebhookListEventsResponse,
   type WebhookRotateSecretResponse,
   type WebhookTestResponse,
+  type WebhookToggleStatusResponse,
   type WebhookCreateParams,
   type WebhookRetrieveParams,
   type WebhookUpdateParams,