telnyx 5.36.0 → 5.36.2

data/rbi/telnyx/resources/messaging_hosted_numbers.rbi

@@ -3,6 +3,83 @@
 module Telnyx
   module Resources
     class MessagingHostedNumbers
+      # Retrieve a specific messaging hosted number by its ID or phone number.
+      sig do
+        params(
+          id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MessagingHostedNumberRetrieveResponse)
+      end
+      def retrieve(
+        # The ID or phone number of the hosted number.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update the messaging settings for a hosted number.
+      sig do
+        params(
+          id: String,
+          messaging_product: String,
+          messaging_profile_id: String,
+          tags: T::Array[String],
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MessagingHostedNumberUpdateResponse)
+      end
+      def update(
+        # The ID or phone number of the hosted number.
+        id,
+        # 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: nil,
+        # 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: nil,
+        # Tags to set on this phone number.
+        tags: nil,
+        request_options: {}
+      )
+      end
+
+      # List all hosted numbers associated with the authenticated user.
+      sig do
+        params(
+          filter_messaging_profile_id: String,
+          filter_phone_number: String,
+          filter_phone_number_contains: String,
+          page_number: Integer,
+          page_size: Integer,
+          sort_phone_number:
+            Telnyx::MessagingHostedNumberListParams::SortPhoneNumber::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::PhoneNumberWithMessagingSettings
+          ]
+        )
+      end
+      def list(
+        # Filter by messaging profile ID.
+        filter_messaging_profile_id: nil,
+        # Filter by exact phone number.
+        filter_phone_number: nil,
+        # Filter by phone number substring.
+        filter_phone_number_contains: nil,
+        page_number: nil,
+        page_size: nil,
+        # Sort by phone number.
+        sort_phone_number: nil,
+        request_options: {}
+      )
+      end
+
       # Delete a messaging hosted number
       sig do
         params(

data/rbi/telnyx/resources/messaging_numbers_bulk_updates.rbi

@@ -8,6 +8,7 @@ module Telnyx
         params(
           messaging_profile_id: String,
           numbers: T::Array[String],
+          assign_only: T::Boolean,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(Telnyx::Models::MessagingNumbersBulkUpdateCreateResponse)
       end
@@ -21,6 +22,8 @@ module Telnyx
         messaging_profile_id:,
         # The list of phone numbers to update.
         numbers:,
+        # If true, only assign numbers to the profile without changing other settings.
+        assign_only: nil,
         request_options: {}
       )
       end

data/rbi/telnyx/resources/messaging_profile_metrics.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class MessagingProfileMetrics
+      # List high-level metrics for all messaging profiles belonging to the
+      # authenticated user.
+      sig do
+        params(
+          time_frame:
+            Telnyx::MessagingProfileMetricListParams::TimeFrame::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MessagingProfileMetricListResponse)
+      end
+      def list(
+        # The time frame for metrics.
+        time_frame: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/messaging_profiles/actions.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class MessagingProfiles
+      class Actions
+        # Regenerate the v1 secret for a messaging profile.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::MessagingProfiles::ActionRegenerateSecretResponse
+          )
+        end
+        def regenerate_secret(
+          # The identifier of the messaging profile.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/messaging_profiles.rbi

@@ -6,19 +6,25 @@ module Telnyx
       sig { returns(Telnyx::Resources::MessagingProfiles::AutorespConfigs) }
       attr_reader :autoresp_configs
 
+      sig { returns(Telnyx::Resources::MessagingProfiles::Actions) }
+      attr_reader :actions
+
       # Create a messaging profile
       sig do
         params(
           name: String,
           whitelisted_destinations: T::Array[String],
+          ai_assistant_id: T.nilable(String),
           alpha_sender: T.nilable(String),
           daily_spend_limit: String,
           daily_spend_limit_enabled: T::Boolean,
           enabled: T::Boolean,
+          health_webhook_url: T.nilable(String),
           mms_fall_back_to_sms: T::Boolean,
           mms_transcoding: T::Boolean,
           mobile_only: T::Boolean,
           number_pool_settings: T.nilable(Telnyx::NumberPoolSettings::OrHash),
+          resource_group_id: T.nilable(String),
           smart_encoding: T::Boolean,
           url_shortener_settings:
             T.nilable(Telnyx::URLShortenerSettings::OrHash),
@@ -36,6 +42,8 @@ module Telnyx
         # the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]` all
         # destinations will be allowed.
         whitelisted_destinations:,
+        # The AI assistant ID to associate with this messaging profile.
+        ai_assistant_id: nil,
         # The alphanumeric sender ID to use when sending to destinations that require an
         # alphanumeric sender ID.
         alpha_sender: nil,
@@ -46,6 +54,8 @@ module Telnyx
         daily_spend_limit_enabled: nil,
         # Specifies whether the messaging profile is enabled or not.
         enabled: nil,
+        # A URL to receive health check webhooks for numbers in this profile.
+        health_webhook_url: nil,
         # enables SMS fallback for MMS messages.
         mms_fall_back_to_sms: nil,
         # enables automated resizing of MMS media.
@@ -58,6 +68,8 @@ module Telnyx
         #
         # To disable this feature, set the object field to `null`.
         number_pool_settings: nil,
+        # The resource group ID to associate with this messaging profile.
+        resource_group_id: nil,
         # Enables automatic character encoding optimization for SMS messages. When
         # enabled, the system automatically selects the most efficient encoding (GSM-7 or
         # UCS-2) based on message content to maximize character limits and minimize costs.
@@ -184,6 +196,8 @@ module Telnyx
       sig do
         params(
           filter: Telnyx::MessagingProfileListParams::Filter::OrHash,
+          filter_name_contains: String,
+          filter_name_eq: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Telnyx::RequestOptions::OrHash
@@ -194,6 +208,10 @@ module Telnyx
       def list(
         # Consolidated filter parameter (deepObject style). Originally: filter[name]
         filter: nil,
+        # Filter profiles by name containing the given string.
+        filter_name_contains: nil,
+        # Filter profiles by exact name match.
+        filter_name_eq: nil,
         page_number: nil,
         page_size: nil,
         request_options: {}
@@ -214,6 +232,28 @@ module Telnyx
       )
       end
 
+      # List all alphanumeric sender IDs associated with a specific messaging profile.
+      sig do
+        params(
+          id: String,
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse
+          ]
+        )
+      end
+      def list_alphanumeric_sender_ids(
+        # The identifier of the messaging profile.
+        id,
+        page_number: nil,
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
       # List phone numbers associated with a messaging profile
       sig do
         params(
@@ -254,6 +294,25 @@ module Telnyx
       )
       end
 
+      # Get detailed metrics for a specific messaging profile, broken down by time
+      # interval.
+      sig do
+        params(
+          id: String,
+          time_frame:
+            Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MessagingProfileRetrieveMetricsResponse)
+      end
+      def retrieve_metrics(
+        # The identifier of the messaging profile.
+        id,
+        # The time frame for metrics.
+        time_frame: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Telnyx::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi

@@ -19,7 +19,6 @@ module Telnyx
               business_state: String,
               business_zip: String,
               corporate_website: String,
-              isv_reseller: String,
               message_volume:
                 Telnyx::MessagingTollfree::Verification::Volume::OrSymbol,
               opt_in_workflow: String,
@@ -45,6 +44,7 @@ module Telnyx
                   Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::OrSymbol
                 ),
               help_message_response: T.nilable(String),
+              isv_reseller: T.nilable(String),
               opt_in_confirmation_response: T.nilable(String),
               opt_in_keywords: T.nilable(String),
               privacy_policy_url: T.nilable(String),
@@ -81,8 +81,6 @@ module Telnyx
             business_zip:,
             # A URL, including the scheme, pointing to the corporate website
             corporate_website:,
-            # ISV name
-            isv_reseller:,
             # Message Volume Enums
             message_volume:,
             # Human-readable description of how end users will opt into receiving messages
@@ -122,6 +120,8 @@ module Telnyx
             entity_type: nil,
             # The message returned when users text 'HELP'
             help_message_response: nil,
+            # ISV name
+            isv_reseller: nil,
             # Message sent to users confirming their opt-in to receive messages
             opt_in_confirmation_response: nil,
             # Keywords used to collect and process consumer opt-ins
@@ -166,7 +166,6 @@ module Telnyx
               business_state: String,
               business_zip: String,
               corporate_website: String,
-              isv_reseller: String,
               message_volume:
                 Telnyx::MessagingTollfree::Verification::Volume::OrSymbol,
               opt_in_workflow: String,
@@ -192,6 +191,7 @@ module Telnyx
                   Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::OrSymbol
                 ),
               help_message_response: T.nilable(String),
+              isv_reseller: T.nilable(String),
               opt_in_confirmation_response: T.nilable(String),
               opt_in_keywords: T.nilable(String),
               privacy_policy_url: T.nilable(String),
@@ -229,8 +229,6 @@ module Telnyx
             business_zip:,
             # A URL, including the scheme, pointing to the corporate website
             corporate_website:,
-            # ISV name
-            isv_reseller:,
             # Message Volume Enums
             message_volume:,
             # Human-readable description of how end users will opt into receiving messages
@@ -270,6 +268,8 @@ module Telnyx
             entity_type: nil,
             # The message returned when users text 'HELP'
             help_message_response: nil,
+            # ISV name
+            isv_reseller: nil,
             # Message sent to users confirming their opt-in to receive messages
             opt_in_confirmation_response: nil,
             # Keywords used to collect and process consumer opt-ins
@@ -291,6 +291,7 @@ module Telnyx
             params(
               page: Integer,
               page_size: Integer,
+              business_name: String,
               date_end: Time,
               date_start: Time,
               phone_number: String,
@@ -309,6 +310,8 @@ module Telnyx
             #
             #         This value is automatically clamped if the provided value is too large.
             page_size:,
+            # Filter verification requests by business name
+            business_name: nil,
             date_end: nil,
             date_start: nil,
             phone_number: nil,
@@ -334,6 +337,30 @@ module Telnyx
           def delete(id, request_options: {})
           end
 
+          # Get the history of status changes for a verification request.
+          #
+          # Returns a paginated list of historical status changes including the reason for
+          # each change and when it occurred.
+          sig do
+            params(
+              id: String,
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(
+              Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse
+            )
+          end
+          def retrieve_status_history(
+            id,
+            page_number:,
+            # Request this many records per page. This value is automatically clamped if the
+            # provided value is too large.
+            page_size:,
+            request_options: {}
+          )
+          end
+
           # @api private
           sig { params(client: Telnyx::Client).returns(T.attached_class) }
           def self.new(client:)

data/rbi/telnyx/resources/phone_numbers/messaging.rbi

@@ -24,6 +24,7 @@ module Telnyx
             id: String,
             messaging_product: String,
             messaging_profile_id: String,
+            tags: T::Array[String],
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::PhoneNumbers::MessagingUpdateResponse)
         end
@@ -42,6 +43,8 @@ module Telnyx
           # - Set this field to a quoted UUID of a messaging profile to assign this number
           #   to that messaging profile
           messaging_profile_id: nil,
+          # Tags to set on this phone number.
+          tags: nil,
           request_options: {}
         )
         end
@@ -49,8 +52,15 @@ module Telnyx
         # List phone numbers with messaging settings
         sig do
           params(
+            filter_messaging_profile_id: String,
+            filter_phone_number: String,
+            filter_phone_number_contains: String,
+            filter_type:
+              Telnyx::PhoneNumbers::MessagingListParams::FilterType::OrSymbol,
             page_number: Integer,
             page_size: Integer,
+            sort_phone_number:
+              Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber::OrSymbol,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(
             Telnyx::Internal::DefaultFlatPagination[
@@ -58,7 +68,21 @@ module Telnyx
             ]
           )
         end
-        def list(page_number: nil, page_size: nil, request_options: {})
+        def list(
+          # Filter by messaging profile ID.
+          filter_messaging_profile_id: nil,
+          # Filter by exact phone number (supports comma-separated list).
+          filter_phone_number: nil,
+          # Filter by phone number substring.
+          filter_phone_number_contains: nil,
+          # Filter by phone number type.
+          filter_type: nil,
+          page_number: nil,
+          page_size: nil,
+          # Sort by phone number.
+          sort_phone_number: nil,
+          request_options: {}
+        )
         end
 
         # @api private

data/rbi/telnyx/resources/verify_profiles.rbi

@@ -10,6 +10,7 @@ module Telnyx
           call: Telnyx::VerifyProfileCreateParams::Call::OrHash,
           flashcall: Telnyx::VerifyProfileCreateParams::Flashcall::OrHash,
           language: String,
+          rcs: Telnyx::VerifyProfileCreateParams::Rcs::OrHash,
           sms: Telnyx::VerifyProfileCreateParams::SMS::OrHash,
           webhook_failover_url: String,
           webhook_url: String,
@@ -21,6 +22,7 @@ module Telnyx
         call: nil,
         flashcall: nil,
         language: nil,
+        rcs: nil,
         sms: nil,
         webhook_failover_url: nil,
         webhook_url: nil,
@@ -50,6 +52,7 @@ module Telnyx
           flashcall: Telnyx::VerifyProfileUpdateParams::Flashcall::OrHash,
           language: String,
           name: String,
+          rcs: Telnyx::VerifyProfileUpdateParams::Rcs::OrHash,
           sms: Telnyx::VerifyProfileUpdateParams::SMS::OrHash,
           webhook_failover_url: String,
           webhook_url: String,
@@ -63,6 +66,7 @@ module Telnyx
         flashcall: nil,
         language: nil,
         name: nil,
+        rcs: nil,
         sms: nil,
         webhook_failover_url: nil,
         webhook_url: nil,

data/sig/telnyx/client.rbs

@@ -318,6 +318,10 @@ module Telnyx
 
     attr_reader organizations: Telnyx::Resources::Organizations
 
+    attr_reader alphanumeric_sender_ids: Telnyx::Resources::AlphanumericSenderIDs
+
+    attr_reader messaging_profile_metrics: Telnyx::Resources::MessagingProfileMetrics
+
     private def auth_headers: -> ::Hash[String, String]
 
     private def bearer_auth: -> ::Hash[String, String]

data/sig/telnyx/models/alphanumeric_sender_id_create_params.rbs

@@ -0,0 +1,38 @@
+module Telnyx
+  module Models
+    type alphanumeric_sender_id_create_params =
+      {
+        alphanumeric_sender_id: String,
+        messaging_profile_id: String,
+        us_long_code_fallback: String
+      }
+      & Telnyx::Internal::Type::request_parameters
+
+    class AlphanumericSenderIDCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor alphanumeric_sender_id: String
+
+      attr_accessor messaging_profile_id: String
+
+      attr_reader us_long_code_fallback: String?
+
+      def us_long_code_fallback=: (String) -> String
+
+      def initialize: (
+        alphanumeric_sender_id: String,
+        messaging_profile_id: String,
+        ?us_long_code_fallback: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        alphanumeric_sender_id: String,
+        messaging_profile_id: String,
+        us_long_code_fallback: String,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/alphanumeric_sender_id_create_response.rbs

@@ -0,0 +1,88 @@
+module Telnyx
+  module Models
+    type alphanumeric_sender_id_create_response =
+      { data: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data }
+
+    class AlphanumericSenderIDCreateResponse < Telnyx::Internal::Type::BaseModel
+      attr_reader data: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data?
+
+      def data=: (
+        Telnyx::Models::AlphanumericSenderIDCreateResponse::Data
+      ) -> Telnyx::Models::AlphanumericSenderIDCreateResponse::Data
+
+      def initialize: (
+        ?data: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data
+      ) -> void
+
+      def to_hash: -> {
+        data: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data
+      }
+
+      type data =
+        {
+          id: String,
+          alphanumeric_sender_id: String,
+          messaging_profile_id: String,
+          organization_id: String,
+          record_type: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::record_type,
+          us_long_code_fallback: String
+        }
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader alphanumeric_sender_id: String?
+
+        def alphanumeric_sender_id=: (String) -> String
+
+        attr_reader messaging_profile_id: String?
+
+        def messaging_profile_id=: (String) -> String
+
+        attr_reader organization_id: String?
+
+        def organization_id=: (String) -> String
+
+        attr_reader record_type: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::record_type?
+
+        def record_type=: (
+          Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::record_type
+        ) -> Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::record_type
+
+        attr_reader us_long_code_fallback: String?
+
+        def us_long_code_fallback=: (String) -> String
+
+        def initialize: (
+          ?id: String,
+          ?alphanumeric_sender_id: String,
+          ?messaging_profile_id: String,
+          ?organization_id: String,
+          ?record_type: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::record_type,
+          ?us_long_code_fallback: String
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          alphanumeric_sender_id: String,
+          messaging_profile_id: String,
+          organization_id: String,
+          record_type: Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::record_type,
+          us_long_code_fallback: String
+        }
+
+        type record_type = :alphanumeric_sender_id
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          ALPHANUMERIC_SENDER_ID: :alphanumeric_sender_id
+
+          def self?.values: -> ::Array[Telnyx::Models::AlphanumericSenderIDCreateResponse::Data::record_type]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/alphanumeric_sender_id_delete_params.rbs

@@ -0,0 +1,15 @@
+module Telnyx
+  module Models
+    type alphanumeric_sender_id_delete_params =
+      {  } & Telnyx::Internal::Type::request_parameters
+
+    class AlphanumericSenderIDDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Telnyx::request_opts) -> void
+
+      def to_hash: -> { request_options: Telnyx::RequestOptions }
+    end
+  end
+end