@sentdm/sentdm 0.34.0 → 0.36.0

package/src/resources/me.ts

@@ -1,14 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as MeAPI from './me';
-import * as WebhooksAPI from './webhooks';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 
 /**
- * Retrieve account details
+ * Who the current key is.
+ *
+ * `GET /v3/me` answers with the account the key authenticates as, which is the quickest way to tell a live key from a test one, an organization key from a sender profile's, and to confirm `x-profile-id` resolved to the profile you meant.
  */
 export class Me extends APIResource {
   /**
@@ -27,6 +27,17 @@ export class Me extends APIResource {
    * **Channels:** The `channels` object always includes `sms`, `whatsapp`, and
    * `rcs`. Each channel has a `configured` boolean. Configured channels expose
    * additional details such as `phone_number`.
+   *
+   * **Sending number:** `sending_phone_number` is the account's US SMS sender. It is
+   * intentionally the same value as `channels.sms.phone_number` — the two are kept
+   * in step, and it is published under both names because `sending_phone_number` is
+   * what this value is called on `GET /v3/profiles`. Read either. One difference:
+   * `sending_phone_number` is always present, including as `null`, while
+   * `channels.sms.phone_number` is omitted when there is no sender.
+   *
+   * `sending_phone_number_profile_id` names the account that holds that number in
+   * inventory — normally this account, and a different one where a number is shared.
+   * Both are `null` when the account has no US SMS sender.
    */
   retrieve(
     params: MeRetrieveParams | null | undefined = {},
@@ -43,46 +54,6 @@ export class Me extends APIResource {
   }
 }
 
-/**
- * Profile configuration settings
- */
-export interface ProfileSettings {
-  /**
-   * Whether contacts are shared across profiles in the organization
-   */
-  allow_contact_sharing?: boolean | null;
-
-  /**
-   * Whether templates are shared across profiles in the organization
-   */
-  allow_template_sharing?: boolean | null;
-
-  /**
-   * Billing model: profile, organization, or profile_and_organization
-   */
-  billing_model?: string | null;
-
-  /**
-   * Whether this profile inherits contacts from the organization
-   */
-  inherit_contacts?: boolean | null;
-
-  /**
-   * Whether this profile inherits TCR brand from the organization
-   */
-  inherit_tcr_brand?: boolean | null;
-
-  /**
-   * Whether this profile inherits TCR campaign from the organization
-   */
-  inherit_tcr_campaign?: boolean | null;
-
-  /**
-   * Whether this profile inherits templates from the organization
-   */
-  inherit_templates?: boolean | null;
-}
-
 /**
  * Standard API response envelope for all v3 endpoints
  */
@@ -97,12 +68,12 @@ export interface MeRetrieveResponse {
   /**
    * Error information
    */
-  error?: WebhooksAPI.ErrorDetail | null;
+  error?: MeRetrieveResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: WebhooksAPI.APIMeta;
+  meta?: MeRetrieveResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -164,10 +135,34 @@ export namespace MeRetrieveResponse {
      */
     profiles?: Array<Data.Profile>;
 
+    /**
+     * The SMS sender this account sends from in the United States, in E.164 form. Null
+     * when the account has no US SMS sender.
+     *
+     * The same value as channels.sms.phone_number, published under both names on
+     * purpose: sending_phone_number is what this value is already called on GET
+     * /v3/profiles, so the same key answers the same question whichever of the two
+     * endpoints you ask. Neither name is preferred over the other and neither is
+     * deprecated.
+     *
+     * The same value, not the same presence: this key is always written, including as
+     * null, whereas channels.sms.phone_number is left out entirely when there is no
+     * sender.
+     */
+    sending_phone_number?: string | null;
+
+    /**
+     * The account that holds sending_phone_number in number inventory: normally this
+     * account itself, and a different account when the number is held elsewhere. Null
+     * when there is no US sender, or when the sender is not a number drawn from
+     * inventory — an alphanumeric sender ID or a short code.
+     */
+    sending_phone_number_profile_id?: string | null;
+
     /**
      * Profile configuration settings
      */
-    settings?: MeAPI.ProfileSettings | null;
+    settings?: Data.Settings | null;
 
     /**
      * Short name / abbreviation (only for profile type)
@@ -301,7 +296,7 @@ export namespace MeRetrieveResponse {
       /**
        * Profile configuration settings
        */
-      settings?: MeAPI.ProfileSettings;
+      settings?: Profile.Settings;
 
       /**
        * Profile short name (abbreviation)
@@ -313,6 +308,149 @@ export namespace MeRetrieveResponse {
        */
       status?: string | null;
     }
+
+    export namespace Profile {
+      /**
+       * Profile configuration settings
+       */
+      export interface Settings {
+        /**
+         * @deprecated Always false. A profile no longer shares contacts with sibling
+         * profiles — it sees only what it owns. Retained so existing v3 clients reading
+         * allow_contact_sharing keep deserializing; it carries no information.
+         */
+        allow_contact_sharing?: boolean | null;
+
+        /**
+         * @deprecated Always false. A profile no longer shares templates with sibling
+         * profiles. Retained so existing v3 clients reading allow_template_sharing keep
+         * deserializing; it carries no information.
+         */
+        allow_template_sharing?: boolean | null;
+
+        /**
+         * Billing model: profile, organization, or profile_and_organization
+         */
+        billing_model?: string | null;
+
+        /**
+         * @deprecated Always false. A profile no longer inherits its organization's
+         * contacts. Retained so existing v3 clients reading inherit_contacts keep
+         * deserializing; it carries no information.
+         */
+        inherit_contacts?: boolean | null;
+
+        /**
+         * Whether this profile inherits TCR brand from the organization
+         */
+        inherit_tcr_brand?: boolean | null;
+
+        /**
+         * Whether this profile inherits TCR campaign from the organization
+         */
+        inherit_tcr_campaign?: boolean | null;
+
+        /**
+         * @deprecated Always false. A profile no longer inherits its organization's
+         * templates. Retained so existing v3 clients reading inherit_templates keep
+         * deserializing; it carries no information.
+         */
+        inherit_templates?: boolean | null;
+      }
+    }
+
+    /**
+     * Profile configuration settings
+     */
+    export interface Settings {
+      /**
+       * @deprecated Always false. A profile no longer shares contacts with sibling
+       * profiles — it sees only what it owns. Retained so existing v3 clients reading
+       * allow_contact_sharing keep deserializing; it carries no information.
+       */
+      allow_contact_sharing?: boolean | null;
+
+      /**
+       * @deprecated Always false. A profile no longer shares templates with sibling
+       * profiles. Retained so existing v3 clients reading allow_template_sharing keep
+       * deserializing; it carries no information.
+       */
+      allow_template_sharing?: boolean | null;
+
+      /**
+       * Billing model: profile, organization, or profile_and_organization
+       */
+      billing_model?: string | null;
+
+      /**
+       * @deprecated Always false. A profile no longer inherits its organization's
+       * contacts. Retained so existing v3 clients reading inherit_contacts keep
+       * deserializing; it carries no information.
+       */
+      inherit_contacts?: boolean | null;
+
+      /**
+       * Whether this profile inherits TCR brand from the organization
+       */
+      inherit_tcr_brand?: boolean | null;
+
+      /**
+       * Whether this profile inherits TCR campaign from the organization
+       */
+      inherit_tcr_campaign?: boolean | null;
+
+      /**
+       * @deprecated Always false. A profile no longer inherits its organization's
+       * templates. Retained so existing v3 clients reading inherit_templates keep
+       * deserializing; it carries no information.
+       */
+      inherit_templates?: boolean | 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;
   }
 }
 
@@ -325,9 +463,5 @@ export interface MeRetrieveParams {
 }
 
 export declare namespace Me {
-  export {
-    type ProfileSettings as ProfileSettings,
-    type MeRetrieveResponse as MeRetrieveResponse,
-    type MeRetrieveParams as MeRetrieveParams,
-  };
+  export { type MeRetrieveResponse as MeRetrieveResponse, type MeRetrieveParams as MeRetrieveParams };
 }

package/src/resources/messages.ts

@@ -1,14 +1,17 @@
 // 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';
 
 /**
- * Send and track SMS and WhatsApp messages
+ * Send a message and follow what happened to it.
+ *
+ * One endpoint sends on any channel: pass `channel: "sent"` and we pick between SMS, WhatsApp and RCS per recipient using your routing rules, or name a channel to pin it. A send is accepted asynchronously — `POST /v3/messages` returns an id, and delivery is reported through `GET /v3/messages/{id}`, its activities, or a webhook.
+ *
+ * **A message needs a sender.** What you can send, where, and at what cost is decided by the markets under **Channels** — so a recipient in a country you hold no sender for is refused here rather than queued.
  */
 export class Messages extends APIResource {
   /**
@@ -108,12 +111,12 @@ export interface MessageRetrieveActivitiesResponse {
   /**
    * Error information
    */
-  error?: WebhooksAPI.ErrorDetail | null;
+  error?: MessageRetrieveActivitiesResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: WebhooksAPI.APIMeta;
+  meta?: MessageRetrieveActivitiesResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -135,6 +138,11 @@ export namespace MessageRetrieveActivitiesResponse {
      * The message ID these activities belong to
      */
     message_id?: string;
+
+    /**
+     * Pagination metadata for list responses
+     */
+    pagination?: Data.Pagination;
   }
 
   export namespace Data {
@@ -177,6 +185,103 @@ export namespace MessageRetrieveActivitiesResponse {
        */
       timestamp?: 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;
   }
 }
 
@@ -192,12 +297,12 @@ export interface MessageRetrieveStatusResponse {
   /**
    * Error information
    */
-  error?: WebhooksAPI.ErrorDetail | null;
+  error?: MessageRetrieveStatusResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: WebhooksAPI.APIMeta;
+  meta?: MessageRetrieveStatusResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -287,6 +392,51 @@ export namespace MessageRetrieveStatusResponse {
       }
     }
   }
+
+  /**
+   * 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;
+  }
 }
 
 /**
@@ -294,19 +444,28 @@ export namespace MessageRetrieveStatusResponse {
  */
 export interface MessageSendResponse {
   /**
-   * Response for the multi-recipient send message endpoint
+   * The result of a multi-recipient send.
+   *
+   * Declared here rather than in the service layer. POST /v3/messages used to
+   * publish MessageSendResult — a type in Common.Services.Messaging.Contracts — so
+   * the public contract was whatever the send service happened to return, and
+   * changing that service for an internal reason changed the API. The service keeps
+   * its result; this is what a caller sees, and the mapping between them is a
+   * decision the endpoint makes.
+   *
+   * The wire is unchanged by the move: same names, same values.
    */
   data?: MessageSendResponse.Data | null;
 
   /**
    * Error information
    */
-  error?: WebhooksAPI.ErrorDetail | null;
+  error?: MessageSendResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: WebhooksAPI.APIMeta;
+  meta?: MessageSendResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -316,58 +475,102 @@ export interface MessageSendResponse {
 
 export namespace MessageSendResponse {
   /**
-   * Response for the multi-recipient send message endpoint
+   * The result of a multi-recipient send.
+   *
+   * Declared here rather than in the service layer. POST /v3/messages used to
+   * publish MessageSendResult — a type in Common.Services.Messaging.Contracts — so
+   * the public contract was whatever the send service happened to return, and
+   * changing that service for an internal reason changed the API. The service keeps
+   * its result; this is what a caller sees, and the mapping between them is a
+   * decision the endpoint makes.
+   *
+   * The wire is unchanged by the move: same names, same values.
    */
   export interface Data {
-    /**
-     * Per-recipient message results
-     */
     recipients?: Array<Data.Recipient>;
 
     /**
-     * Overall request status: "QUEUED" when the batch has been accepted for delivery.
+     * Overall status — QUEUED once the batch is accepted for delivery.
      */
     status?: string;
 
-    /**
-     * Template ID that was used
-     */
     template_id?: string;
 
-    /**
-     * Template display name
-     */
     template_name?: string;
   }
 
   export namespace Data {
     /**
-     * Per-recipient result in the send message response
+     * What one recipient of a send got, as the API reports it.
      */
     export interface Recipient {
       /**
-       * Resolved template body text for this recipient's channel, or null for
-       * auto-detect
+       * Resolved template body for this recipient's channel, or null when the channel is
+       * auto-detected.
        */
       body?: string | null;
 
       /**
-       * Channel this message will be sent on (e.g. "sms", "whatsapp"), or null for
-       * auto-detect
+       * Channel this message will be sent on — sms, whatsapp — or null to auto-detect.
        */
       channel?: string | null;
 
       /**
-       * Unique message identifier for tracking this recipient's message
+       * Identifier for tracking this recipient's message.
        */
       message_id?: string;
 
       /**
-       * Phone number in E.164 format
+       * Phone number in E.164 format.
        */
       to?: string;
     }
   }
+
+  /**
+   * 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;
+  }
 }
 
 export interface MessageRetrieveActivitiesParams {