telnyx 6.83.0 → 7.1.0

package/src/resources/messaging-hosted-numbers.ts

@@ -78,6 +78,31 @@ export class MessagingHostedNumbers extends APIResource {
   }
 }
 
+export interface UpdatePhoneNumberMessagingSettingsRequest {
+  /**
+   * Configure the messaging product for this number:
+   *
+   * - Omit this field or set its value to `null` to keep the current value.
+   * - Set this field to a quoted product ID to set this phone number to that product
+   */
+  messaging_product?: string;
+
+  /**
+   * Configure the messaging profile this phone number is assigned to:
+   *
+   * - Omit this field or set its value to `null` to keep the current value.
+   * - Set this field to `""` to unassign the number from its messaging profile
+   * - Set this field to a quoted UUID of a messaging profile to assign this number
+   *   to that messaging profile
+   */
+  messaging_profile_id?: string;
+
+  /**
+   * Tags to set on this phone number.
+   */
+  tags?: Array<string>;
+}
+
 export interface MessagingHostedNumberRetrieveResponse {
   data?: Shared.PhoneNumberWithMessagingSettings;
 }
@@ -139,6 +164,7 @@ export interface MessagingHostedNumberListParams extends DefaultFlatPaginationPa
 
 export declare namespace MessagingHostedNumbers {
   export {
+    type UpdatePhoneNumberMessagingSettingsRequest as UpdatePhoneNumberMessagingSettingsRequest,
     type MessagingHostedNumberRetrieveResponse as MessagingHostedNumberRetrieveResponse,
     type MessagingHostedNumberUpdateResponse as MessagingHostedNumberUpdateResponse,
     type MessagingHostedNumberDeleteResponse as MessagingHostedNumberDeleteResponse,

package/src/resources/messaging-profile-metrics.ts

@@ -18,6 +18,11 @@ export class MessagingProfileMetrics extends APIResource {
   }
 }
 
+/**
+ * The time frame for metrics aggregation.
+ */
+export type MessagingMetricsTimeFrame = '1h' | '3h' | '24h' | '3d' | '7d' | '30d';
+
 export interface MessagingProfileMetricListResponse {
   data?: Array<{ [key: string]: unknown }>;
 
@@ -28,11 +33,12 @@ export interface MessagingProfileMetricListParams {
   /**
    * The time frame for metrics.
    */
-  time_frame?: '1h' | '3h' | '24h' | '3d' | '7d' | '30d';
+  time_frame?: MessagingMetricsTimeFrame;
 }
 
 export declare namespace MessagingProfileMetrics {
   export {
+    type MessagingMetricsTimeFrame as MessagingMetricsTimeFrame,
     type MessagingProfileMetricListResponse as MessagingProfileMetricListResponse,
     type MessagingProfileMetricListParams as MessagingProfileMetricListParams,
   };

package/src/resources/messaging-profiles/autoresp-configs.ts

@@ -183,12 +183,15 @@ export interface AutorespConfigCreateParams {
 }
 
 export interface AutorespConfigRetrieveParams {
+  /**
+   * Unique identifier of the profile.
+   */
   profile_id: string;
 }
 
 export interface AutorespConfigUpdateParams {
   /**
-   * Path param
+   * Path param: Unique identifier of the profile.
    */
   profile_id: string;
 
@@ -214,6 +217,9 @@ export interface AutorespConfigUpdateParams {
 }
 
 export interface AutorespConfigListParams {
+  /**
+   * Filter results by country code.
+   */
   country_code?: string;
 
   /**
@@ -252,6 +258,9 @@ export namespace AutorespConfigListParams {
 }
 
 export interface AutorespConfigDeleteParams {
+  /**
+   * Unique identifier of the profile.
+   */
   profile_id: string;
 }
 

package/src/resources/messaging-profiles/messaging-profiles.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../core/resource';
 import * as AlphanumericSenderIDsAPI from '../alphanumeric-sender-ids';
 import { AlphanumericSenderIDsDefaultFlatPagination } from '../alphanumeric-sender-ids';
+import * as MessagingProfileMetricsAPI from '../messaging-profile-metrics';
 import * as Shared from '../shared';
 import {
   PhoneNumberWithMessagingSettingsDefaultFlatPagination,
@@ -596,6 +597,11 @@ export interface MessagingProfileCreateParams {
 }
 
 export interface MessagingProfileUpdateParams {
+  /**
+   * The ID of the AI assistant associated with this messaging profile.
+   */
+  ai_assistant_id?: string | null;
+
   /**
    * The alphanumeric sender ID to use when sending to destinations that require an
    * alphanumeric sender ID.
@@ -736,7 +742,7 @@ export interface MessagingProfileRetrieveMetricsParams {
   /**
    * The time frame for metrics.
    */
-  time_frame?: '1h' | '3h' | '24h' | '3d' | '7d' | '30d';
+  time_frame?: MessagingProfileMetricsAPI.MessagingMetricsTimeFrame;
 }
 
 MessagingProfiles.AutorespConfigs = AutorespConfigs;

package/src/resources/messaging-tollfree/verification/requests.ts

@@ -1062,24 +1062,35 @@ export interface RequestListParams extends DefaultPaginationForMessagingTollfree
    */
   business_name?: string;
 
+  /**
+   * End of the date range filter (inclusive, ISO 8601).
+   */
   date_end?: string;
 
+  /**
+   * Start of the date range filter (inclusive, ISO 8601).
+   */
   date_start?: string;
 
+  /**
+   * Filter results by phone number.
+   */
   phone_number?: string;
 
   /**
-   * Tollfree verification status
+   * Filter results by status.
    */
   status?: TfVerificationStatus;
 }
 
 export interface RequestRetrieveStatusHistoryParams {
+  /**
+   * Page number to retrieve (1-based).
+   */
   'page[number]': number;
 
   /**
-   * Request this many records per page. This value is automatically clamped if the
-   * provided value is too large.
+   * Number of items to return per page.
    */
   'page[size]': number;
 }

package/src/resources/mobile-phone-numbers/index.ts

@@ -2,10 +2,10 @@
 
 export {
   Messaging,
+  type MobilePhoneNumberWithMessagingSettings,
   type MessagingRetrieveResponse,
-  type MessagingListResponse,
   type MessagingListParams,
-  type MessagingListResponsesDefaultFlatPagination,
+  type MobilePhoneNumberWithMessagingSettingsDefaultFlatPagination,
 } from './messaging';
 export {
   MobilePhoneNumbers,

package/src/resources/mobile-phone-numbers/messaging.ts

@@ -21,99 +21,22 @@ export class Messaging extends APIResource {
   list(
     query: MessagingListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<MessagingListResponsesDefaultFlatPagination, MessagingListResponse> {
+  ): PagePromise<
+    MobilePhoneNumberWithMessagingSettingsDefaultFlatPagination,
+    MobilePhoneNumberWithMessagingSettings
+  > {
     return this._client.getAPIList(
       '/mobile_phone_numbers/messaging',
-      DefaultFlatPagination<MessagingListResponse>,
+      DefaultFlatPagination<MobilePhoneNumberWithMessagingSettings>,
       { query, ...options },
     );
   }
 }
 
-export type MessagingListResponsesDefaultFlatPagination = DefaultFlatPagination<MessagingListResponse>;
+export type MobilePhoneNumberWithMessagingSettingsDefaultFlatPagination =
+  DefaultFlatPagination<MobilePhoneNumberWithMessagingSettings>;
 
-export interface MessagingRetrieveResponse {
-  data?: MessagingRetrieveResponse.Data;
-}
-
-export namespace MessagingRetrieveResponse {
-  export interface Data {
-    /**
-     * Identifies the type of resource.
-     */
-    id?: string;
-
-    /**
-     * ISO 3166-1 alpha-2 country code.
-     */
-    country_code?: string;
-
-    /**
-     * ISO 8601 formatted date indicating when the resource was created.
-     */
-    created_at?: string;
-
-    features?: Data.Features;
-
-    /**
-     * The messaging product that the number is registered to use
-     */
-    messaging_product?: string;
-
-    /**
-     * Unique identifier for a messaging profile.
-     */
-    messaging_profile_id?: string | null;
-
-    /**
-     * The organization that owns this phone number.
-     */
-    organization_id?: string;
-
-    /**
-     * +E.164 formatted phone number.
-     */
-    phone_number?: string;
-
-    /**
-     * Identifies the type of the resource.
-     */
-    record_type?: 'messaging_phone_number' | 'messaging_settings';
-
-    /**
-     * Tags associated with this phone number.
-     */
-    tags?: Array<string>;
-
-    /**
-     * The messaging traffic or use case for which the number is currently configured.
-     */
-    traffic_type?: string;
-
-    /**
-     * The type of the phone number
-     */
-    type?: 'longcode';
-
-    /**
-     * ISO 8601 formatted date indicating when the resource was updated.
-     */
-    updated_at?: string;
-  }
-
-  export namespace Data {
-    export interface Features {
-      /**
-       * The set of features available for a specific messaging use case (SMS or MMS).
-       * Features can vary depending on the characteristics the phone number, as well as
-       * its current product configuration.
-       */
-      sms?: Shared.MessagingFeatureSet | null;
-    }
-  }
-}
-
-export interface MessagingListResponse {
+export interface MobilePhoneNumberWithMessagingSettings {
   /**
    * Identifies the type of resource.
    */
@@ -129,7 +52,7 @@ export interface MessagingListResponse {
    */
   created_at?: string;
 
-  features?: MessagingListResponse.Features;
+  features?: MobilePhoneNumberWithMessagingSettings.Features;
 
   /**
    * The messaging product that the number is registered to use
@@ -177,7 +100,7 @@ export interface MessagingListResponse {
   updated_at?: string;
 }
 
-export namespace MessagingListResponse {
+export namespace MobilePhoneNumberWithMessagingSettings {
   export interface Features {
     /**
      * The set of features available for a specific messaging use case (SMS or MMS).
@@ -188,13 +111,17 @@ export namespace MessagingListResponse {
   }
 }
 
+export interface MessagingRetrieveResponse {
+  data?: MobilePhoneNumberWithMessagingSettings;
+}
+
 export interface MessagingListParams extends DefaultFlatPaginationParams {}
 
 export declare namespace Messaging {
   export {
+    type MobilePhoneNumberWithMessagingSettings as MobilePhoneNumberWithMessagingSettings,
     type MessagingRetrieveResponse as MessagingRetrieveResponse,
-    type MessagingListResponse as MessagingListResponse,
-    type MessagingListResponsesDefaultFlatPagination as MessagingListResponsesDefaultFlatPagination,
+    type MobilePhoneNumberWithMessagingSettingsDefaultFlatPagination as MobilePhoneNumberWithMessagingSettingsDefaultFlatPagination,
     type MessagingListParams as MessagingListParams,
   };
 }

package/src/resources/mobile-phone-numbers/mobile-phone-numbers.ts

@@ -5,9 +5,9 @@ import * as MessagingAPI from './messaging';
 import {
   Messaging,
   MessagingListParams,
-  MessagingListResponse,
-  MessagingListResponsesDefaultFlatPagination,
   MessagingRetrieveResponse,
+  MobilePhoneNumberWithMessagingSettings,
+  MobilePhoneNumberWithMessagingSettingsDefaultFlatPagination,
 } from './messaging';
 import { APIPromise } from '../../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
@@ -287,9 +287,9 @@ export declare namespace MobilePhoneNumbers {
 
   export {
     Messaging as Messaging,
+    type MobilePhoneNumberWithMessagingSettings as MobilePhoneNumberWithMessagingSettings,
     type MessagingRetrieveResponse as MessagingRetrieveResponse,
-    type MessagingListResponse as MessagingListResponse,
-    type MessagingListResponsesDefaultFlatPagination as MessagingListResponsesDefaultFlatPagination,
+    type MobilePhoneNumberWithMessagingSettingsDefaultFlatPagination as MobilePhoneNumberWithMessagingSettingsDefaultFlatPagination,
     type MessagingListParams as MessagingListParams,
   };
 }

package/src/resources/networks/default-gateway.ts

@@ -11,7 +11,7 @@ import { path } from '../../internal/utils/path';
 /**
  * Network operations
  */
-export class DefaultGateway extends APIResource {
+export class DefaultGatewayResource extends APIResource {
   /**
    * Create Default Gateway.
    *
@@ -62,81 +62,41 @@ export class DefaultGateway extends APIResource {
   }
 }
 
-export interface DefaultGatewayCreateResponse {
-  data?: Array<DefaultGatewayCreateResponse.Data>;
-
-  meta?: AuthenticationProvidersAPI.PaginationMeta;
-}
-
-export namespace DefaultGatewayCreateResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record {
-    /**
-     * Network ID.
-     */
-    network_id?: string;
+export interface DefaultGateway extends GlobalIPAssignmentsAPI.Record {
+  /**
+   * Network ID.
+   */
+  network_id?: string;
 
-    /**
-     * The current status of the interface deployment.
-     */
-    status?: NetworksAPI.InterfaceStatus;
+  /**
+   * The current status of the interface deployment.
+   */
+  status?: NetworksAPI.InterfaceStatus;
 
-    /**
-     * Wireguard peer ID.
-     */
-    wireguard_peer_id?: string;
-  }
+  /**
+   * Wireguard peer ID.
+   */
+  wireguard_peer_id?: string;
 }
 
-export interface DefaultGatewayRetrieveResponse {
-  data?: Array<DefaultGatewayRetrieveResponse.Data>;
+export interface DefaultGatewayCreateResponse {
+  data?: Array<DefaultGateway>;
 
   meta?: AuthenticationProvidersAPI.PaginationMeta;
 }
 
-export namespace DefaultGatewayRetrieveResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record {
-    /**
-     * Network ID.
-     */
-    network_id?: string;
-
-    /**
-     * The current status of the interface deployment.
-     */
-    status?: NetworksAPI.InterfaceStatus;
+export interface DefaultGatewayRetrieveResponse {
+  data?: Array<DefaultGateway>;
 
-    /**
-     * Wireguard peer ID.
-     */
-    wireguard_peer_id?: string;
-  }
+  meta?: AuthenticationProvidersAPI.PaginationMeta;
 }
 
 export interface DefaultGatewayDeleteResponse {
-  data?: Array<DefaultGatewayDeleteResponse.Data>;
+  data?: Array<DefaultGateway>;
 
   meta?: AuthenticationProvidersAPI.PaginationMeta;
 }
 
-export namespace DefaultGatewayDeleteResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record {
-    /**
-     * Network ID.
-     */
-    network_id?: string;
-
-    /**
-     * The current status of the interface deployment.
-     */
-    status?: NetworksAPI.InterfaceStatus;
-
-    /**
-     * Wireguard peer ID.
-     */
-    wireguard_peer_id?: string;
-  }
-}
-
 export interface DefaultGatewayCreateParams {
   /**
    * Wireguard peer ID.
@@ -144,8 +104,9 @@ export interface DefaultGatewayCreateParams {
   wireguard_peer_id?: string;
 }
 
-export declare namespace DefaultGateway {
+export declare namespace DefaultGatewayResource {
   export {
+    type DefaultGateway as DefaultGateway,
     type DefaultGatewayCreateResponse as DefaultGatewayCreateResponse,
     type DefaultGatewayRetrieveResponse as DefaultGatewayRetrieveResponse,
     type DefaultGatewayDeleteResponse as DefaultGatewayDeleteResponse,

package/src/resources/networks/index.ts

@@ -1,7 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  DefaultGateway,
+  DefaultGatewayResource,
+  type DefaultGateway,
   type DefaultGatewayCreateResponse,
   type DefaultGatewayRetrieveResponse,
   type DefaultGatewayDeleteResponse,
@@ -10,17 +11,17 @@ export {
 export {
   Networks,
   type InterfaceStatus,
+  type Network,
   type NetworkCreate,
   type NetworkCreateResponse,
   type NetworkRetrieveResponse,
   type NetworkUpdateResponse,
-  type NetworkListResponse,
   type NetworkDeleteResponse,
   type NetworkListInterfacesResponse,
   type NetworkCreateParams,
   type NetworkUpdateParams,
   type NetworkListParams,
   type NetworkListInterfacesParams,
-  type NetworkListResponsesDefaultFlatPagination,
+  type NetworksDefaultFlatPagination,
   type NetworkListInterfacesResponsesDefaultFlatPagination,
 } from './networks';