feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 40
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sent%2Fsent-dm-38aaadafbb2bf0c5d5bb9330a0a5e7a89052fe3e791569c8a12051e040193edf.yml
-openapi_spec_hash: 2d35c1223beebaf2c1b8d8a474cbf7c2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sent%2Fsent-dm-2566cdc5d8e0bffe2a8c442692b0fc1b35d3bfe7e9bf578331fc19d402361c1f.yml
+openapi_spec_hash: 85e1feeb9bbc8d59bb34d6cdd679575a
 config_hash: ad652575976c2c8db09e4575778f0e77

src/resources/contacts.ts

@@ -147,17 +147,17 @@ export class Contacts extends APIResource {
  */
 export interface APIResponseOfContact {
   /**
-   * The response data (null if error)
+   * Contact response for v3 API Uses snake_case for JSON property names
    */
   data?: ContactResponse | null;
 
   /**
-   * Error details (null if successful)
+   * Error information
    */
   error?: WebhooksAPI.APIError | null;
 
   /**
-   * Metadata about the request and response
+   * Request and response metadata
    */
   meta?: WebhooksAPI.APIMeta;
 
@@ -247,17 +247,17 @@ export interface ContactResponse {
  */
 export interface ContactListResponse {
   /**
-   * The response data (null if error)
+   * Paginated list of contacts response
    */
   data?: ContactListResponse.Data | null;
 
   /**
-   * Error details (null if successful)
+   * Error information
    */
   error?: WebhooksAPI.APIError | null;
 
   /**
-   * Metadata about the request and response
+   * Request and response metadata
    */
   meta?: WebhooksAPI.APIMeta;
 
@@ -269,7 +269,7 @@ export interface ContactListResponse {
 
 export namespace ContactListResponse {
   /**
-   * The response data (null if error)
+   * Paginated list of contacts response
    */
   export interface Data {
     /**
@@ -278,7 +278,7 @@ export namespace ContactListResponse {
     contacts?: Array<ContactsAPI.ContactResponse>;
 
     /**
-     * Pagination metadata
+     * Pagination metadata for list responses
      */
     pagination?: WebhooksAPI.PaginationMeta;
   }

src/resources/me.ts

@@ -88,17 +88,19 @@ export interface ProfileSettings {
  */
 export interface MeRetrieveResponse {
   /**
-   * The response data (null if error)
+   * Account response for GET /v3/me endpoint. Returns organization (with profiles),
+   * user (standalone), or profile (child of an organization) data depending on the
+   * API key type. Always includes messaging channel configuration.
    */
   data?: MeRetrieveResponse.Data | null;
 
   /**
-   * Error details (null if successful)
+   * Error information
    */
   error?: WebhooksAPI.APIError | null;
 
   /**
-   * Metadata about the request and response
+   * Request and response metadata
    */
   meta?: WebhooksAPI.APIMeta;
 
@@ -110,7 +112,9 @@ export interface MeRetrieveResponse {
 
 export namespace MeRetrieveResponse {
   /**
-   * The response data (null if error)
+   * Account response for GET /v3/me endpoint. Returns organization (with profiles),
+   * user (standalone), or profile (child of an organization) data depending on the
+   * API key type. Always includes messaging channel configuration.
    */
   export interface Data {
     /**
@@ -119,7 +123,8 @@ export namespace MeRetrieveResponse {
     id?: string;
 
     /**
-     * Messaging channel configuration
+     * Messaging channel configuration. All three channels are always present. Each
+     * channel has a "configured" flag; configured channels expose additional details.
      */
     channels?: Data.Channels;
 
@@ -160,7 +165,7 @@ export namespace MeRetrieveResponse {
     profiles?: Array<Data.Profile>;
 
     /**
-     * Profile settings (only for profile type)
+     * Profile configuration settings
      */
     settings?: MeAPI.ProfileSettings | null;
 
@@ -184,28 +189,30 @@ export namespace MeRetrieveResponse {
 
   export namespace Data {
     /**
-     * Messaging channel configuration
+     * Messaging channel configuration. All three channels are always present. Each
+     * channel has a "configured" flag; configured channels expose additional details.
      */
     export interface Channels {
       /**
-       * RCS channel (provider: vibes)
+       * RCS channel configuration. When configured, includes the RCS phone number.
        */
       rcs?: Channels.Rcs;
 
       /**
-       * SMS channel (providers: telnyx, sinch)
+       * SMS channel configuration. When configured, includes the sending phone number.
        */
       sms?: Channels.SMS;
 
       /**
-       * WhatsApp Business channel (provider: meta)
+       * WhatsApp Business channel configuration. When configured, includes the WhatsApp
+       * phone number and business name.
        */
       whatsapp?: Channels.Whatsapp;
     }
 
     export namespace Channels {
       /**
-       * RCS channel (provider: vibes)
+       * RCS channel configuration. When configured, includes the RCS phone number.
        */
       export interface Rcs {
         /**
@@ -220,7 +227,7 @@ export namespace MeRetrieveResponse {
       }
 
       /**
-       * SMS channel (providers: telnyx, sinch)
+       * SMS channel configuration. When configured, includes the sending phone number.
        */
       export interface SMS {
         /**
@@ -235,7 +242,8 @@ export namespace MeRetrieveResponse {
       }
 
       /**
-       * WhatsApp Business channel (provider: meta)
+       * WhatsApp Business channel configuration. When configured, includes the WhatsApp
+       * phone number and business name.
        */
       export interface Whatsapp {
         /**

src/resources/messages.ts

@@ -96,17 +96,17 @@ export class Messages extends APIResource {
  */
 export interface MessageRetrieveActivitiesResponse {
   /**
-   * The response data (null if error)
+   * Response for GET /messages/{id}/activities
    */
   data?: MessageRetrieveActivitiesResponse.Data | null;
 
   /**
-   * Error details (null if successful)
+   * Error information
    */
   error?: WebhooksAPI.APIError | null;
 
   /**
-   * Metadata about the request and response
+   * Request and response metadata
    */
   meta?: WebhooksAPI.APIMeta;
 
@@ -118,7 +118,7 @@ export interface MessageRetrieveActivitiesResponse {
 
 export namespace MessageRetrieveActivitiesResponse {
   /**
-   * The response data (null if error)
+   * Response for GET /messages/{id}/activities
    */
   export interface Data {
     /**
@@ -172,17 +172,17 @@ export namespace MessageRetrieveActivitiesResponse {
  */
 export interface MessageRetrieveStatusResponse {
   /**
-   * The response data (null if error)
+   * Message response for v3 API — same shape as v2 with snake_case JSON conventions
    */
   data?: MessageRetrieveStatusResponse.Data | null;
 
   /**
-   * Error details (null if successful)
+   * Error information
    */
   error?: WebhooksAPI.APIError | null;
 
   /**
-   * Metadata about the request and response
+   * Request and response metadata
    */
   meta?: WebhooksAPI.APIMeta;
 
@@ -194,7 +194,7 @@ export interface MessageRetrieveStatusResponse {
 
 export namespace MessageRetrieveStatusResponse {
   /**
-   * The response data (null if error)
+   * Message response for v3 API — same shape as v2 with snake_case JSON conventions
    */
   export interface Data {
     id?: string;
@@ -275,17 +275,17 @@ export namespace MessageRetrieveStatusResponse {
  */
 export interface MessageSendResponse {
   /**
-   * The response data (null if error)
+   * Response for the multi-recipient send message endpoint
    */
   data?: MessageSendResponse.Data | null;
 
   /**
-   * Error details (null if successful)
+   * Error information
    */
   error?: WebhooksAPI.APIError | null;
 
   /**
-   * Metadata about the request and response
+   * Request and response metadata
    */
   meta?: WebhooksAPI.APIMeta;
 
@@ -297,7 +297,7 @@ export interface MessageSendResponse {
 
 export namespace MessageSendResponse {
   /**
-   * The response data (null if error)
+   * Response for the multi-recipient send message endpoint
    */
   export interface Data {
     /**
@@ -381,7 +381,8 @@ export interface MessageSendParams {
   sandbox?: boolean;
 
   /**
-   * Body param: Template reference (by id or name, with optional parameters)
+   * Body param: SDK-style template reference: resolve by ID or by name, with
+   * optional parameters.
    */
   template?: MessageSendParams.Template;
 
@@ -408,7 +409,8 @@ export interface MessageSendParams {
 
 export namespace MessageSendParams {
   /**
-   * Template reference (by id or name, with optional parameters)
+   * SDK-style template reference: resolve by ID or by name, with optional
+   * parameters.
    */
   export interface Template {
     /**

src/resources/numbers.ts

@@ -49,12 +49,12 @@ export interface NumberLookupResponse {
   data?: NumberLookupResponse.Data | null;
 
   /**
-   * Error details (null if successful)
+   * Error information
    */
   error?: WebhooksAPI.APIError | null;
 
   /**
-   * Metadata about the request and response
+   * Request and response metadata
    */
   meta?: WebhooksAPI.APIMeta;
 

src/resources/profiles/campaigns.ts

@@ -174,12 +174,12 @@ export interface APIResponseOfTcrCampaignWithUseCases {
   data?: TcrCampaignWithUseCases | null;
 
   /**
-   * Error details (null if successful)
+   * Error information
    */
   error?: WebhooksAPI.APIError | null;
 
   /**
-   * Metadata about the request and response
+   * Request and response metadata
    */
   meta?: WebhooksAPI.APIMeta;
 
@@ -278,9 +278,6 @@ export type MessagingUseCaseUs =
  * Campaign use case with sample messages
  */
 export interface SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData {
-  /**
-   * US messaging use case category
-   */
   messagingUseCaseUs: MessagingUseCaseUs;
 
   /**
@@ -369,12 +366,12 @@ export interface CampaignListResponse {
   data?: Array<TcrCampaignWithUseCases> | null;
 
   /**
-   * Error details (null if successful)
+   * Error information
    */
   error?: WebhooksAPI.APIError | null;
 
   /**
-   * Metadata about the request and response
+   * Request and response metadata
    */
   meta?: WebhooksAPI.APIMeta;
 
@@ -386,7 +383,7 @@ export interface CampaignListResponse {
 
 export interface CampaignCreateParams {
   /**
-   * Body param: Campaign data
+   * Body param: Campaign data for create or update operation
    */
   campaign: CampaignData;
 
@@ -418,7 +415,7 @@ export interface CampaignUpdateParams {
   profileId: string;
 
   /**
-   * Body param: Campaign data
+   * Body param: Campaign data for create or update operation
    */
   campaign: CampaignData;