telnyx 7.3.0 → 7.5.0

package/src/resources/messages/messages.ts

@@ -18,75 +18,6 @@ import { path } from '../../internal/utils/path';
 export class Messages extends APIResource {
   rcs: RcsAPI.Rcs = new RcsAPI.Rcs(this._client);
 
-  /**
-   * Note: This API endpoint can only retrieve messages that are no older than 10
-   * days since their creation. If you require messages older than this, please
-   * generate an
-   * [MDR report.](https://developers.telnyx.com/api-reference/mdr-usage-reports/create-mdr-usage-report)
-   *
-   * @example
-   * ```ts
-   * const message = await client.messages.retrieve(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<MessageRetrieveResponse> {
-    return this._client.get(path`/messages/${id}`, options);
-  }
-
-  /**
-   * Cancel a scheduled message that has not yet been sent. Only messages with
-   * `status=scheduled` and `send_at` more than a minute from now can be cancelled.
-   *
-   * @example
-   * ```ts
-   * const response = await client.messages.cancelScheduled(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
-   * ```
-   */
-  cancelScheduled(id: string, options?: RequestOptions): APIPromise<MessageCancelScheduledResponse> {
-    return this._client.delete(path`/messages/${id}`, options);
-  }
-
-  /**
-   * Retrieve all messages in a group MMS conversation by the group message ID.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.messages.retrieveGroupMessages(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   );
-   * ```
-   */
-  retrieveGroupMessages(
-    messageID: string,
-    options?: RequestOptions,
-  ): APIPromise<MessageRetrieveGroupMessagesResponse> {
-    return this._client.get(path`/messages/group/${messageID}`, options);
-  }
-
-  /**
-   * Schedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or
-   * Number Pool.
-   *
-   * This endpoint allows you to schedule a message with any messaging resource.
-   * Current messaging resources include: long-code, short-code, number-pool, and
-   * alphanumeric-sender-id.
-   *
-   * @example
-   * ```ts
-   * const response = await client.messages.schedule({
-   *   to: '+18445550001',
-   * });
-   * ```
-   */
-  schedule(body: MessageScheduleParams, options?: RequestOptions): APIPromise<MessageScheduleResponse> {
-    return this._client.post('/messages/schedule', { body, ...options });
-  }
-
   /**
    * Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number
    * Pool.
@@ -106,24 +37,6 @@ export class Messages extends APIResource {
     return this._client.post('/messages', { body, ...options });
   }
 
-  /**
-   * Send a group MMS message
-   *
-   * @example
-   * ```ts
-   * const response = await client.messages.sendGroupMms({
-   *   from: '+13125551234',
-   *   to: ['+18655551234', '+14155551234'],
-   * });
-   * ```
-   */
-  sendGroupMms(
-    body: MessageSendGroupMmsParams,
-    options?: RequestOptions,
-  ): APIPromise<MessageSendGroupMmsResponse> {
-    return this._client.post('/messages/group_mms', { body, ...options });
-  }
-
   /**
    * Send a long code message
    *
@@ -179,6 +92,24 @@ export class Messages extends APIResource {
     return this._client.post('/messages/short_code', { body, ...options });
   }
 
+  /**
+   * Send a group MMS message
+   *
+   * @example
+   * ```ts
+   * const response = await client.messages.sendGroupMms({
+   *   from: '+13125551234',
+   *   to: ['+18655551234', '+14155551234'],
+   * });
+   * ```
+   */
+  sendGroupMms(
+    body: MessageSendGroupMmsParams,
+    options?: RequestOptions,
+  ): APIPromise<MessageSendGroupMmsResponse> {
+    return this._client.post('/messages/group_mms', { body, ...options });
+  }
+
   /**
    * Send a Whatsapp message
    *
@@ -198,6 +129,57 @@ export class Messages extends APIResource {
     return this._client.post('/messages/whatsapp', { body, ...options });
   }
 
+  /**
+   * Schedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or
+   * Number Pool.
+   *
+   * This endpoint allows you to schedule a message with any messaging resource.
+   * Current messaging resources include: long-code, short-code, number-pool, and
+   * alphanumeric-sender-id.
+   *
+   * @example
+   * ```ts
+   * const response = await client.messages.schedule({
+   *   to: '+18445550001',
+   * });
+   * ```
+   */
+  schedule(body: MessageScheduleParams, options?: RequestOptions): APIPromise<MessageScheduleResponse> {
+    return this._client.post('/messages/schedule', { body, ...options });
+  }
+
+  /**
+   * Cancel a scheduled message that has not yet been sent. Only messages with
+   * `status=scheduled` and `send_at` more than a minute from now can be cancelled.
+   *
+   * @example
+   * ```ts
+   * const response = await client.messages.cancelScheduled(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  cancelScheduled(id: string, options?: RequestOptions): APIPromise<MessageCancelScheduledResponse> {
+    return this._client.delete(path`/messages/${id}`, options);
+  }
+
+  /**
+   * Note: This API endpoint can only retrieve messages that are no older than 10
+   * days since their creation. If you require messages older than this, please
+   * generate an
+   * [MDR report.](https://developers.telnyx.com/api-reference/mdr-usage-reports/create-mdr-usage-report)
+   *
+   * @example
+   * ```ts
+   * const message = await client.messages.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<MessageRetrieveResponse> {
+    return this._client.get(path`/messages/${id}`, options);
+  }
+
   /**
    * Send an SMS message using an alphanumeric sender ID. This is SMS only.
    *
@@ -219,6 +201,24 @@ export class Messages extends APIResource {
   ): APIPromise<MessageSendWithAlphanumericSenderResponse> {
     return this._client.post('/messages/alphanumeric_sender_id', { body, ...options });
   }
+
+  /**
+   * Retrieve all messages in a group MMS conversation by the group message ID.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.messages.retrieveGroupMessages(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  retrieveGroupMessages(
+    messageID: string,
+    options?: RequestOptions,
+  ): APIPromise<MessageRetrieveGroupMessagesResponse> {
+    return this._client.get(path`/messages/group/${messageID}`, options);
+  }
 }
 
 export interface OutboundMessagePayload {
@@ -1626,7 +1626,7 @@ export interface MessageSendWithAlphanumericSenderResponse {
   data?: OutboundMessagePayload;
 }
 
-export interface MessageScheduleParams {
+export interface MessageSendParams {
   /**
    * Receiving address (+E.164 formatted phone number or short code).
    */
@@ -1638,6 +1638,15 @@ export interface MessageScheduleParams {
    */
   auto_detect?: boolean;
 
+  /**
+   * Encoding to use for the message. `auto` (default) uses smart encoding to
+   * automatically select the most efficient encoding. `gsm7` forces GSM-7 encoding
+   * (returns 400 if message contains characters that cannot be encoded). `ucs2`
+   * forces UCS-2 encoding and disables smart encoding. When set, this overrides the
+   * messaging profile's `smart_encoding` setting.
+   */
+  encoding?: 'auto' | 'gsm7' | 'ucs2';
+
   /**
    * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
    * code).
@@ -1665,7 +1674,7 @@ export interface MessageScheduleParams {
    * ISO 8601 formatted date indicating when to send the message - accurate up till a
    * minute.
    */
-  send_at?: string;
+  send_at?: string | null;
 
   /**
    * Subject of multimedia message
@@ -1703,7 +1712,12 @@ export interface MessageScheduleParams {
   webhook_url?: string;
 }
 
-export interface MessageSendParams {
+export interface MessageSendLongCodeParams {
+  /**
+   * Phone number, in +E.164 format, used to send the message.
+   */
+  from: string;
+
   /**
    * Receiving address (+E.164 formatted phone number or short code).
    */
@@ -1724,15 +1738,6 @@ export interface MessageSendParams {
    */
   encoding?: 'auto' | 'gsm7' | 'ucs2';
 
-  /**
-   * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
-   * code).
-   *
-   * **Required if sending with a phone number, short code, or alphanumeric sender
-   * ID.**
-   */
-  from?: string;
-
   /**
    * A list of media URLs. The total media size must be less than 1 MB.
    *
@@ -1740,19 +1745,6 @@ export interface MessageSendParams {
    */
   media_urls?: Array<string>;
 
-  /**
-   * Unique identifier for a messaging profile.
-   *
-   * **Required if sending via number pool or with an alphanumeric sender ID.**
-   */
-  messaging_profile_id?: string;
-
-  /**
-   * ISO 8601 formatted date indicating when to send the message - accurate up till a
-   * minute.
-   */
-  send_at?: string | null;
-
   /**
    * Subject of multimedia message
    */
@@ -1789,19 +1781,36 @@ export interface MessageSendParams {
   webhook_url?: string;
 }
 
-export interface MessageSendGroupMmsParams {
+export interface MessageSendNumberPoolParams {
   /**
-   * Phone number, in +E.164 format, used to send the message.
+   * Unique identifier for a messaging profile.
    */
-  from: string;
+  messaging_profile_id: string;
 
   /**
-   * A list of destinations. No more than 8 destinations are allowed.
+   * Receiving address (+E.164 formatted phone number or short code).
    */
-  to: Array<string>;
+  to: string;
+
+  /**
+   * Automatically detect if an SMS message is unusually long and exceeds a
+   * recommended limit of message parts.
+   */
+  auto_detect?: boolean;
+
+  /**
+   * Encoding to use for the message. `auto` (default) uses smart encoding to
+   * automatically select the most efficient encoding. `gsm7` forces GSM-7 encoding
+   * (returns 400 if message contains characters that cannot be encoded). `ucs2`
+   * forces UCS-2 encoding and disables smart encoding. When set, this overrides the
+   * messaging profile's `smart_encoding` setting.
+   */
+  encoding?: 'auto' | 'gsm7' | 'ucs2';
 
   /**
    * A list of media URLs. The total media size must be less than 1 MB.
+   *
+   * **Required for MMS**
    */
   media_urls?: Array<string>;
 
@@ -1812,9 +1821,16 @@ export interface MessageSendGroupMmsParams {
 
   /**
    * Message body (i.e., content) as a non-empty string.
+   *
+   * **Required for SMS**
    */
   text?: string;
 
+  /**
+   * The protocol for sending the message, either SMS or MMS.
+   */
+  type?: 'SMS' | 'MMS';
+
   /**
    * If the profile this number is associated with has webhooks, use them for
    * delivery notifications. If webhooks are also specified on the message itself,
@@ -1834,7 +1850,7 @@ export interface MessageSendGroupMmsParams {
   webhook_url?: string;
 }
 
-export interface MessageSendLongCodeParams {
+export interface MessageSendShortCodeParams {
   /**
    * Phone number, in +E.164 format, used to send the message.
    */
@@ -1903,36 +1919,19 @@ export interface MessageSendLongCodeParams {
   webhook_url?: string;
 }
 
-export interface MessageSendNumberPoolParams {
-  /**
-   * Unique identifier for a messaging profile.
-   */
-  messaging_profile_id: string;
-
-  /**
-   * Receiving address (+E.164 formatted phone number or short code).
-   */
-  to: string;
-
+export interface MessageSendGroupMmsParams {
   /**
-   * Automatically detect if an SMS message is unusually long and exceeds a
-   * recommended limit of message parts.
+   * Phone number, in +E.164 format, used to send the message.
    */
-  auto_detect?: boolean;
+  from: string;
 
   /**
-   * Encoding to use for the message. `auto` (default) uses smart encoding to
-   * automatically select the most efficient encoding. `gsm7` forces GSM-7 encoding
-   * (returns 400 if message contains characters that cannot be encoded). `ucs2`
-   * forces UCS-2 encoding and disables smart encoding. When set, this overrides the
-   * messaging profile's `smart_encoding` setting.
+   * A list of destinations. No more than 8 destinations are allowed.
    */
-  encoding?: 'auto' | 'gsm7' | 'ucs2';
+  to: Array<string>;
 
   /**
    * A list of media URLs. The total media size must be less than 1 MB.
-   *
-   * **Required for MMS**
    */
   media_urls?: Array<string>;
 
@@ -1943,16 +1942,9 @@ export interface MessageSendNumberPoolParams {
 
   /**
    * Message body (i.e., content) as a non-empty string.
-   *
-   * **Required for SMS**
    */
   text?: string;
 
-  /**
-   * The protocol for sending the message, either SMS or MMS.
-   */
-  type?: 'SMS' | 'MMS';
-
   /**
    * If the profile this number is associated with has webhooks, use them for
    * delivery notifications. If webhooks are also specified on the message itself,
@@ -1972,12 +1964,36 @@ export interface MessageSendNumberPoolParams {
   webhook_url?: string;
 }
 
-export interface MessageSendShortCodeParams {
+export interface MessageSendWhatsappParams {
   /**
-   * Phone number, in +E.164 format, used to send the message.
+   * Phone number in +E.164 format associated with Whatsapp account
    */
   from: string;
 
+  /**
+   * Phone number in +E.164 format
+   */
+  to: string;
+
+  whatsapp_message: WhatsappMessageContent;
+
+  /**
+   * Messaging profile ID - required if the 'from' number is not SMS-enabled
+   */
+  messaging_profile_id?: string;
+
+  /**
+   * Message type - must be set to "WHATSAPP"
+   */
+  type?: 'WHATSAPP';
+
+  /**
+   * The URL where webhooks related to this message will be sent.
+   */
+  webhook_url?: string;
+}
+
+export interface MessageScheduleParams {
   /**
    * Receiving address (+E.164 formatted phone number or short code).
    */
@@ -1990,13 +2006,13 @@ export interface MessageSendShortCodeParams {
   auto_detect?: boolean;
 
   /**
-   * Encoding to use for the message. `auto` (default) uses smart encoding to
-   * automatically select the most efficient encoding. `gsm7` forces GSM-7 encoding
-   * (returns 400 if message contains characters that cannot be encoded). `ucs2`
-   * forces UCS-2 encoding and disables smart encoding. When set, this overrides the
-   * messaging profile's `smart_encoding` setting.
+   * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+   * code).
+   *
+   * **Required if sending with a phone number, short code, or alphanumeric sender
+   * ID.**
    */
-  encoding?: 'auto' | 'gsm7' | 'ucs2';
+  from?: string;
 
   /**
    * A list of media URLs. The total media size must be less than 1 MB.
@@ -2005,6 +2021,19 @@ export interface MessageSendShortCodeParams {
    */
   media_urls?: Array<string>;
 
+  /**
+   * Unique identifier for a messaging profile.
+   *
+   * **Required if sending via number pool or with an alphanumeric sender ID.**
+   */
+  messaging_profile_id?: string;
+
+  /**
+   * ISO 8601 formatted date indicating when to send the message - accurate up till a
+   * minute.
+   */
+  send_at?: string;
+
   /**
    * Subject of multimedia message
    */
@@ -2041,35 +2070,6 @@ export interface MessageSendShortCodeParams {
   webhook_url?: string;
 }
 
-export interface MessageSendWhatsappParams {
-  /**
-   * Phone number in +E.164 format associated with Whatsapp account
-   */
-  from: string;
-
-  /**
-   * Phone number in +E.164 format
-   */
-  to: string;
-
-  whatsapp_message: WhatsappMessageContent;
-
-  /**
-   * Messaging profile ID - required if the 'from' number is not SMS-enabled
-   */
-  messaging_profile_id?: string;
-
-  /**
-   * Message type - must be set to "WHATSAPP"
-   */
-  type?: 'WHATSAPP';
-
-  /**
-   * The URL where webhooks related to this message will be sent.
-   */
-  webhook_url?: string;
-}
-
 export interface MessageSendWithAlphanumericSenderParams {
   /**
    * A valid alphanumeric sender ID on the user's account.
@@ -2134,13 +2134,13 @@ export declare namespace Messages {
     type MessageSendShortCodeResponse as MessageSendShortCodeResponse,
     type MessageSendWhatsappResponse as MessageSendWhatsappResponse,
     type MessageSendWithAlphanumericSenderResponse as MessageSendWithAlphanumericSenderResponse,
-    type MessageScheduleParams as MessageScheduleParams,
     type MessageSendParams as MessageSendParams,
-    type MessageSendGroupMmsParams as MessageSendGroupMmsParams,
     type MessageSendLongCodeParams as MessageSendLongCodeParams,
     type MessageSendNumberPoolParams as MessageSendNumberPoolParams,
     type MessageSendShortCodeParams as MessageSendShortCodeParams,
+    type MessageSendGroupMmsParams as MessageSendGroupMmsParams,
     type MessageSendWhatsappParams as MessageSendWhatsappParams,
+    type MessageScheduleParams as MessageScheduleParams,
     type MessageSendWithAlphanumericSenderParams as MessageSendWithAlphanumericSenderParams,
   };
 

package/src/resources/messaging/index.ts

@@ -7,7 +7,7 @@ export {
   type RcInviteTestNumberResponse,
   type RcListBulkCapabilitiesResponse,
   type RcRetrieveCapabilitiesResponse,
-  type RcInviteTestNumberParams,
   type RcListBulkCapabilitiesParams,
   type RcRetrieveCapabilitiesParams,
+  type RcInviteTestNumberParams,
 } from './rcs/index';

package/src/resources/messaging/messaging.ts

@@ -26,8 +26,8 @@ export declare namespace Messaging {
     type RcInviteTestNumberResponse as RcInviteTestNumberResponse,
     type RcListBulkCapabilitiesResponse as RcListBulkCapabilitiesResponse,
     type RcRetrieveCapabilitiesResponse as RcRetrieveCapabilitiesResponse,
-    type RcInviteTestNumberParams as RcInviteTestNumberParams,
     type RcListBulkCapabilitiesParams as RcListBulkCapabilitiesParams,
     type RcRetrieveCapabilitiesParams as RcRetrieveCapabilitiesParams,
+    type RcInviteTestNumberParams as RcInviteTestNumberParams,
   };
 }

package/src/resources/messaging/rcs/agents.ts

@@ -16,6 +16,27 @@ import { path } from '../../../internal/utils/path';
  * Send RCS messages
  */
 export class Agents extends APIResource {
+  /**
+   * List all RCS agents
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const rcsAgent of client.messaging.rcs.agents.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: AgentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RcsAgentsDefaultFlatPagination, RcsAgentsAPI.RcsAgent> {
+    return this._client.getAPIList('/messaging/rcs/agents', DefaultFlatPagination<RcsAgentsAPI.RcsAgent>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Retrieve an RCS agent
    *
@@ -45,29 +66,10 @@ export class Agents extends APIResource {
   ): APIPromise<RcsAgentsAPI.RcsAgentResponse> {
     return this._client.patch(path`/messaging/rcs/agents/${id}`, { body, ...options });
   }
-
-  /**
-   * List all RCS agents
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const rcsAgent of client.messaging.rcs.agents.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: AgentListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<RcsAgentsDefaultFlatPagination, RcsAgentsAPI.RcsAgent> {
-    return this._client.getAPIList('/messaging/rcs/agents', DefaultFlatPagination<RcsAgentsAPI.RcsAgent>, {
-      query,
-      ...options,
-    });
-  }
 }
 
+export interface AgentListParams extends DefaultFlatPaginationParams {}
+
 export interface AgentUpdateParams {
   /**
    * Messaging profile ID associated with the RCS Agent
@@ -85,10 +87,8 @@ export interface AgentUpdateParams {
   webhook_url?: string | null;
 }
 
-export interface AgentListParams extends DefaultFlatPaginationParams {}
-
 export declare namespace Agents {
-  export { type AgentUpdateParams as AgentUpdateParams, type AgentListParams as AgentListParams };
+  export { type AgentListParams as AgentListParams, type AgentUpdateParams as AgentUpdateParams };
 }
 
 export { type RcsAgentsDefaultFlatPagination };

package/src/resources/messaging/rcs/index.ts

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Agents, type AgentUpdateParams, type AgentListParams } from './agents';
+export { Agents, type AgentListParams, type AgentUpdateParams } from './agents';
 export {
   Rcs,
   type RcsCapabilities,
   type RcInviteTestNumberResponse,
   type RcListBulkCapabilitiesResponse,
   type RcRetrieveCapabilitiesResponse,
-  type RcInviteTestNumberParams,
   type RcListBulkCapabilitiesParams,
   type RcRetrieveCapabilitiesParams,
+  type RcInviteTestNumberParams,
 } from './rcs';