@sentdm/sentdm 0.36.0 → 0.37.0

package/src/resources/conversations.ts

@@ -1,6 +1,7 @@
 // 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';
@@ -20,13 +21,17 @@ export class Conversations extends APIResource {
    *
    * @example
    * ```ts
-   * const conversations = await client.conversations.list({
-   *   page: 0,
-   *   page_size: 0,
-   * });
+   * const apiResponseOfConversationMessagesList =
+   *   await client.conversations.list({
+   *     page: 0,
+   *     page_size: 0,
+   *   });
    * ```
    */
-  list(params: ConversationListParams, options?: RequestOptions): APIPromise<ConversationListResponse> {
+  list(
+    params: ConversationListParams,
+    options?: RequestOptions,
+  ): APIPromise<APIResponseOfConversationMessagesList> {
     const { 'x-profile-id': xProfileID, ...query } = params;
     return this._client.get('/v3/conversations', {
       query,
@@ -44,17 +49,18 @@ export class Conversations extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.conversations.listMessages(
-   *   '08fab313-c9e2-502c-975e-08b0356c432e',
-   *   { page: 0, page_size: 0 },
-   * );
+   * const apiResponseOfConversationMessagesList =
+   *   await client.conversations.listMessages(
+   *     '08fab313-c9e2-502c-975e-08b0356c432e',
+   *     { page: 0, page_size: 0 },
+   *   );
    * ```
    */
   listMessages(
     id: string,
     params: ConversationListMessagesParams,
     options?: RequestOptions,
-  ): APIPromise<ConversationListMessagesResponse> {
+  ): APIPromise<APIResponseOfConversationMessagesList> {
     const { 'x-profile-id': xProfileID, ...query } = params;
     return this._client.get(path`/v3/conversations/${id}`, {
       query,
@@ -70,21 +76,21 @@ export class Conversations extends APIResource {
 /**
  * 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,424 +98,102 @@ 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 {
+export interface ConversationMessagesList {
   /**
-   * A paginated list of messages — used by both conversation read endpoints.
+   * The messages on this page.
    */
-  data?: ConversationListMessagesResponse.Data | null;
+  messages?: Array<ConversationMessagesList.Message>;
 
   /**
-   * Error information
-   */
-  error?: ConversationListMessagesResponse.Error | null;
-
-  /**
-   * Request and response metadata
-   */
-  meta?: ConversationListMessagesResponse.Meta;
-
-  /**
-   * 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>;
-
-    /**
-     * 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;
+  export interface Message {
+    id?: string;
 
-      phone?: string;
+    active_contact_price?: number | null;
 
-      phone_international?: string;
+    channel?: string;
 
-      price?: number | null;
+    contact_id?: string;
 
-      region_code?: string;
+    created_at?: string;
 
-      status?: string;
+    customer_id?: string;
 
-      template_category?: string | null;
+    direction?: string;
 
-      template_id?: string | null;
+    events?: Array<Message.Event> | 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;
+      }
+    }
   }
 }
 
@@ -553,8 +237,8 @@ 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 ConversationListParams as ConversationListParams,
     type ConversationListMessagesParams as ConversationListMessagesParams,
   };

package/src/resources/index.ts

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