telnyx 5.36.0 → 5.36.2

data/rbi/telnyx/models/messaging_hosted_number_update_response.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingHostedNumberUpdateResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::MessagingHostedNumberUpdateResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Telnyx::PhoneNumberWithMessagingSettings)) }
+      attr_reader :data
+
+      sig do
+        params(data: Telnyx::PhoneNumberWithMessagingSettings::OrHash).void
+      end
+      attr_writer :data
+
+      sig do
+        params(data: Telnyx::PhoneNumberWithMessagingSettings::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(data: nil)
+      end
+
+      sig do
+        override.returns({ data: Telnyx::PhoneNumberWithMessagingSettings })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_numbers_bulk_update_create_params.rbi

@@ -27,10 +27,18 @@ module Telnyx
       sig { returns(T::Array[String]) }
       attr_accessor :numbers
 
+      # If true, only assign numbers to the profile without changing other settings.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :assign_only
+
+      sig { params(assign_only: T::Boolean).void }
+      attr_writer :assign_only
+
       sig do
         params(
           messaging_profile_id: String,
           numbers: T::Array[String],
+          assign_only: T::Boolean,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -44,6 +52,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
@@ -53,6 +63,7 @@ module Telnyx
           {
             messaging_profile_id: String,
             numbers: T::Array[String],
+            assign_only: T::Boolean,
             request_options: Telnyx::RequestOptions
           }
         )

data/rbi/telnyx/models/messaging_profile.rbi

@@ -8,6 +8,10 @@ module Telnyx
           T.any(Telnyx::MessagingProfile, Telnyx::Internal::AnyHash)
         end
 
+      # The AI assistant ID associated with this messaging profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ai_assistant_id
+
       # The alphanumeric sender ID to use when sending to destinations that require an
       # alphanumeric sender ID.
       sig { returns(T.nilable(String)) }
@@ -82,6 +86,13 @@ module Telnyx
       end
       attr_writer :number_pool_settings
 
+      # The organization that owns this messaging profile.
+      sig { returns(T.nilable(String)) }
+      attr_reader :organization_id
+
+      sig { params(organization_id: String).void }
+      attr_writer :organization_id
+
       # Indicates whether message content redaction is enabled for this profile.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :redaction_enabled
@@ -97,6 +108,10 @@ module Telnyx
       sig { params(redaction_level: Integer).void }
       attr_writer :redaction_level
 
+      # The resource group ID associated with this messaging profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :resource_group_id
+
       # 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.
@@ -201,6 +216,7 @@ module Telnyx
       sig do
         params(
           id: String,
+          ai_assistant_id: T.nilable(String),
           alpha_sender: T.nilable(String),
           created_at: Time,
           daily_spend_limit: String,
@@ -212,9 +228,11 @@ module Telnyx
           mobile_only: T::Boolean,
           name: String,
           number_pool_settings: T.nilable(Telnyx::NumberPoolSettings::OrHash),
+          organization_id: String,
           record_type: Telnyx::MessagingProfile::RecordType::OrSymbol,
           redaction_enabled: T::Boolean,
           redaction_level: Integer,
+          resource_group_id: T.nilable(String),
           smart_encoding: T::Boolean,
           updated_at: Time,
           url_shortener_settings:
@@ -230,6 +248,8 @@ module Telnyx
       def self.new(
         # Identifies the type of resource.
         id: nil,
+        # The AI assistant ID associated 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,
@@ -258,6 +278,8 @@ module Telnyx
         #
         # To disable this feature, set the object field to `null`.
         number_pool_settings: nil,
+        # The organization that owns this messaging profile.
+        organization_id: nil,
         # Identifies the type of the resource.
         record_type: nil,
         # Indicates whether message content redaction is enabled for this profile.
@@ -265,6 +287,8 @@ module Telnyx
         # Determines how much information is redacted in messages for privacy or
         # compliance purposes.
         redaction_level: nil,
+        # The resource group ID associated 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.
@@ -300,6 +324,7 @@ module Telnyx
         override.returns(
           {
             id: String,
+            ai_assistant_id: T.nilable(String),
             alpha_sender: T.nilable(String),
             created_at: Time,
             daily_spend_limit: String,
@@ -311,9 +336,11 @@ module Telnyx
             mobile_only: T::Boolean,
             name: String,
             number_pool_settings: T.nilable(Telnyx::NumberPoolSettings),
+            organization_id: String,
             record_type: Telnyx::MessagingProfile::RecordType::TaggedSymbol,
             redaction_enabled: T::Boolean,
             redaction_level: Integer,
+            resource_group_id: T.nilable(String),
             smart_encoding: T::Boolean,
             updated_at: Time,
             url_shortener_settings: T.nilable(Telnyx::URLShortenerSettings),

data/rbi/telnyx/models/messaging_profile_create_params.rbi

@@ -21,6 +21,10 @@ module Telnyx
       sig { returns(T::Array[String]) }
       attr_accessor :whitelisted_destinations
 
+      # The AI assistant ID to associate with this messaging profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ai_assistant_id
+
       # The alphanumeric sender ID to use when sending to destinations that require an
       # alphanumeric sender ID.
       sig { returns(T.nilable(String)) }
@@ -48,6 +52,10 @@ module Telnyx
       sig { params(enabled: T::Boolean).void }
       attr_writer :enabled
 
+      # A URL to receive health check webhooks for numbers in this profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :health_webhook_url
+
       # enables SMS fallback for MMS messages.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :mms_fall_back_to_sms
@@ -84,6 +92,10 @@ module Telnyx
       end
       attr_writer :number_pool_settings
 
+      # The resource group ID to associate with this messaging profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :resource_group_id
+
       # 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.
@@ -143,14 +155,17 @@ module Telnyx
         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),
@@ -168,6 +183,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,
@@ -178,6 +195,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.
@@ -190,6 +209,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.
@@ -219,14 +240,17 @@ module Telnyx
           {
             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),
+            resource_group_id: T.nilable(String),
             smart_encoding: T::Boolean,
             url_shortener_settings: T.nilable(Telnyx::URLShortenerSettings),
             webhook_api_version:

data/rbi/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingProfileListAlphanumericSenderIDsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::MessagingProfileListAlphanumericSenderIDsParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      sig do
+        params(
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(page_number: nil, page_size: nil, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_response.rbi

@@ -0,0 +1,138 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingProfileListAlphanumericSenderIDsResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Uniquely identifies the alphanumeric sender ID resource.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # The alphanumeric sender ID string.
+      sig { returns(T.nilable(String)) }
+      attr_reader :alphanumeric_sender_id
+
+      sig { params(alphanumeric_sender_id: String).void }
+      attr_writer :alphanumeric_sender_id
+
+      # The messaging profile this sender ID belongs to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :messaging_profile_id
+
+      sig { params(messaging_profile_id: String).void }
+      attr_writer :messaging_profile_id
+
+      # The organization that owns this sender ID.
+      sig { returns(T.nilable(String)) }
+      attr_reader :organization_id
+
+      sig { params(organization_id: String).void }
+      attr_writer :organization_id
+
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse::RecordType::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :record_type
+
+      sig do
+        params(
+          record_type:
+            Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse::RecordType::OrSymbol
+        ).void
+      end
+      attr_writer :record_type
+
+      # A US long code number to use as fallback when sending to US destinations.
+      sig { returns(T.nilable(String)) }
+      attr_reader :us_long_code_fallback
+
+      sig { params(us_long_code_fallback: String).void }
+      attr_writer :us_long_code_fallback
+
+      sig do
+        params(
+          id: String,
+          alphanumeric_sender_id: String,
+          messaging_profile_id: String,
+          organization_id: String,
+          record_type:
+            Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse::RecordType::OrSymbol,
+          us_long_code_fallback: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Uniquely identifies the alphanumeric sender ID resource.
+        id: nil,
+        # The alphanumeric sender ID string.
+        alphanumeric_sender_id: nil,
+        # The messaging profile this sender ID belongs to.
+        messaging_profile_id: nil,
+        # The organization that owns this sender ID.
+        organization_id: nil,
+        record_type: nil,
+        # A US long code number to use as fallback when sending to US destinations.
+        us_long_code_fallback: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            alphanumeric_sender_id: String,
+            messaging_profile_id: String,
+            organization_id: String,
+            record_type:
+              Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse::RecordType::TaggedSymbol,
+            us_long_code_fallback: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse::RecordType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALPHANUMERIC_SENDER_ID =
+          T.let(
+            :alphanumeric_sender_id,
+            Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse::RecordType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::Models::MessagingProfileListAlphanumericSenderIDsResponse::RecordType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_profile_list_params.rbi

@@ -20,6 +20,20 @@ module Telnyx
       end
       attr_writer :filter
 
+      # Filter profiles by name containing the given string.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_name_contains
+
+      sig { params(filter_name_contains: String).void }
+      attr_writer :filter_name_contains
+
+      # Filter profiles by exact name match.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_name_eq
+
+      sig { params(filter_name_eq: String).void }
+      attr_writer :filter_name_eq
+
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
 
@@ -35,6 +49,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
@@ -43,6 +59,10 @@ module Telnyx
       def self.new(
         # 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: {}
@@ -53,6 +73,8 @@ module Telnyx
         override.returns(
           {
             filter: Telnyx::MessagingProfileListParams::Filter,
+            filter_name_contains: String,
+            filter_name_eq: String,
             page_number: Integer,
             page_size: Integer,
             request_options: Telnyx::RequestOptions

data/rbi/telnyx/models/messaging_profile_metric_list_params.rbi

@@ -0,0 +1,114 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingProfileMetricListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::MessagingProfileMetricListParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # The time frame for metrics.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::MessagingProfileMetricListParams::TimeFrame::OrSymbol
+          )
+        )
+      end
+      attr_reader :time_frame
+
+      sig do
+        params(
+          time_frame:
+            Telnyx::MessagingProfileMetricListParams::TimeFrame::OrSymbol
+        ).void
+      end
+      attr_writer :time_frame
+
+      sig do
+        params(
+          time_frame:
+            Telnyx::MessagingProfileMetricListParams::TimeFrame::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The time frame for metrics.
+        time_frame: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            time_frame:
+              Telnyx::MessagingProfileMetricListParams::TimeFrame::OrSymbol,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The time frame for metrics.
+      module TimeFrame
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::MessagingProfileMetricListParams::TimeFrame)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TIME_FRAME_1H =
+          T.let(
+            :"1h",
+            Telnyx::MessagingProfileMetricListParams::TimeFrame::TaggedSymbol
+          )
+        TIME_FRAME_3H =
+          T.let(
+            :"3h",
+            Telnyx::MessagingProfileMetricListParams::TimeFrame::TaggedSymbol
+          )
+        TIME_FRAME_24H =
+          T.let(
+            :"24h",
+            Telnyx::MessagingProfileMetricListParams::TimeFrame::TaggedSymbol
+          )
+        TIME_FRAME_3D =
+          T.let(
+            :"3d",
+            Telnyx::MessagingProfileMetricListParams::TimeFrame::TaggedSymbol
+          )
+        TIME_FRAME_7D =
+          T.let(
+            :"7d",
+            Telnyx::MessagingProfileMetricListParams::TimeFrame::TaggedSymbol
+          )
+        TIME_FRAME_30D =
+          T.let(
+            :"30d",
+            Telnyx::MessagingProfileMetricListParams::TimeFrame::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::MessagingProfileMetricListParams::TimeFrame::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_profile_metric_list_response.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingProfileMetricListResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::MessagingProfileMetricListResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
+      attr_reader :data
+
+      sig { params(data: T::Array[T::Hash[Symbol, T.anything]]).void }
+      attr_writer :data
+
+      sig { returns(T.nilable(Telnyx::MessagingPaginationMeta)) }
+      attr_reader :meta
+
+      sig { params(meta: Telnyx::MessagingPaginationMeta::OrHash).void }
+      attr_writer :meta
+
+      sig do
+        params(
+          data: T::Array[T::Hash[Symbol, T.anything]],
+          meta: Telnyx::MessagingPaginationMeta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data: nil, meta: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Array[T::Hash[Symbol, T.anything]],
+            meta: Telnyx::MessagingPaginationMeta
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end