telnyx 5.170.0 → 5.171.0

data/rbi/telnyx/models/spend_limit_delete_params.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class SpendLimitDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::SpendLimitDeleteParams, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :product
+
+      # Limit period. Defaults to `daily`; send it explicitly.
+      sig { returns(T.nilable(Telnyx::SpendLimitPeriod::OrSymbol)) }
+      attr_reader :period
+
+      sig { params(period: Telnyx::SpendLimitPeriod::OrSymbol).void }
+      attr_writer :period
+
+      # Why the limit is removed, kept for audit. At most 500 characters.
+      sig { returns(T.nilable(String)) }
+      attr_reader :reason
+
+      sig { params(reason: String).void }
+      attr_writer :reason
+
+      sig do
+        params(
+          product: String,
+          period: Telnyx::SpendLimitPeriod::OrSymbol,
+          reason: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        product:,
+        # Limit period. Defaults to `daily`; send it explicitly.
+        period: nil,
+        # Why the limit is removed, kept for audit. At most 500 characters.
+        reason: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            product: String,
+            period: Telnyx::SpendLimitPeriod::OrSymbol,
+            reason: String,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/spend_limit_list_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class SpendLimitListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::SpendLimitListParams, Telnyx::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Telnyx::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Telnyx::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/spend_limit_list_response.rbi

@@ -0,0 +1,109 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class SpendLimitListResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::SpendLimitListResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[Telnyx::SpendLimit]) }
+      attr_accessor :data
+
+      sig { returns(T.nilable(Telnyx::Models::SpendLimitListResponse::Meta)) }
+      attr_reader :meta
+
+      sig do
+        params(meta: Telnyx::Models::SpendLimitListResponse::Meta::OrHash).void
+      end
+      attr_writer :meta
+
+      sig do
+        params(
+          data: T::Array[Telnyx::SpendLimit::OrHash],
+          meta: Telnyx::Models::SpendLimitListResponse::Meta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:, meta: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Array[Telnyx::SpendLimit],
+            meta: Telnyx::Models::SpendLimitListResponse::Meta
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Meta < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::SpendLimitListResponse::Meta,
+              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 { returns(T.nilable(Integer)) }
+        attr_reader :total_pages
+
+        sig { params(total_pages: Integer).void }
+        attr_writer :total_pages
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :total_results
+
+        sig { params(total_results: Integer).void }
+        attr_writer :total_results
+
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            total_pages: Integer,
+            total_results: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          page_number: nil,
+          page_size: nil,
+          total_pages: nil,
+          total_results: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              page_number: Integer,
+              page_size: Integer,
+              total_pages: Integer,
+              total_results: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/spend_limit_period.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    # `daily` is the current UTC day; `monthly` is the current UTC calendar month.
+    module SpendLimitPeriod
+      extend Telnyx::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Telnyx::SpendLimitPeriod) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      DAILY = T.let(:daily, Telnyx::SpendLimitPeriod::TaggedSymbol)
+      MONTHLY = T.let(:monthly, Telnyx::SpendLimitPeriod::TaggedSymbol)
+
+      sig { override.returns(T::Array[Telnyx::SpendLimitPeriod::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/telnyx/models/spend_limit_response.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class SpendLimitResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::SpendLimitResponse, Telnyx::Internal::AnyHash)
+        end
+
+      # The spend limit, spend and block state of one product and period.
+      sig { returns(Telnyx::SpendLimit) }
+      attr_reader :data
+
+      sig { params(data: Telnyx::SpendLimit::OrHash).void }
+      attr_writer :data
+
+      sig { params(data: Telnyx::SpendLimit::OrHash).returns(T.attached_class) }
+      def self.new(
+        # The spend limit, spend and block state of one product and period.
+        data:
+      )
+      end
+
+      sig { override.returns({ data: Telnyx::SpendLimit }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/spend_limit_update_params.rbi

@@ -0,0 +1,280 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class SpendLimitUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::SpendLimitUpdateParams, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :product
+
+      # Send exactly one of `amount` and `unlimited: true`.
+      sig do
+        returns(
+          T.any(
+            Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount,
+            Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited
+          )
+        )
+      end
+      attr_accessor :body
+
+      # Limit period. Defaults to `daily`; send it explicitly.
+      sig { returns(T.nilable(Telnyx::SpendLimitPeriod::OrSymbol)) }
+      attr_reader :period
+
+      sig { params(period: Telnyx::SpendLimitPeriod::OrSymbol).void }
+      attr_writer :period
+
+      sig do
+        params(
+          product: String,
+          body:
+            T.any(
+              Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount::OrHash,
+              Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited::OrHash
+            ),
+          period: Telnyx::SpendLimitPeriod::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        product:,
+        # Send exactly one of `amount` and `unlimited: true`.
+        body:,
+        # Limit period. Defaults to `daily`; send it explicitly.
+        period: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            product: String,
+            body:
+              T.any(
+                Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount,
+                Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited
+              ),
+            period: Telnyx::SpendLimitPeriod::OrSymbol,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Send exactly one of `amount` and `unlimited: true`.
+      module Body
+        extend Telnyx::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount,
+              Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited
+            )
+          end
+
+        class UpdateSpendLimitWithAmount < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Limit in USD. `0` blocks at the first cent of spend.
+          sig { returns(Float) }
+          attr_accessor :amount
+
+          # Why the limit is set or changed, kept for audit.
+          sig { returns(T.nilable(String)) }
+          attr_reader :reason
+
+          sig { params(reason: String).void }
+          attr_writer :reason
+
+          # Optional; only `false` is allowed together with `amount`.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount::Unlimited::OrBoolean
+              )
+            )
+          end
+          attr_reader :unlimited
+
+          sig do
+            params(
+              unlimited:
+                Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount::Unlimited::OrBoolean
+            ).void
+          end
+          attr_writer :unlimited
+
+          # A new limit in USD.
+          sig do
+            params(
+              amount: Float,
+              reason: String,
+              unlimited:
+                Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount::Unlimited::OrBoolean
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Limit in USD. `0` blocks at the first cent of spend.
+            amount:,
+            # Why the limit is set or changed, kept for audit.
+            reason: nil,
+            # Optional; only `false` is allowed together with `amount`.
+            unlimited: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                amount: Float,
+                reason: String,
+                unlimited:
+                  Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount::Unlimited::OrBoolean
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Optional; only `false` is allowed together with `amount`.
+          module Unlimited
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedBoolean =
+              T.type_alias do
+                T.all(
+                  T::Boolean,
+                  Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount::Unlimited
+                )
+              end
+            OrBoolean = T.type_alias { T::Boolean }
+
+            FALSE =
+              T.let(
+                false,
+                Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount::Unlimited::TaggedBoolean
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount::Unlimited::TaggedBoolean
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        class UpdateSpendLimitUnlimited < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # `true`: explicitly no cap.
+          sig do
+            returns(
+              Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited::Unlimited::OrBoolean
+            )
+          end
+          attr_accessor :unlimited
+
+          # Why the limit is set or changed, kept for audit.
+          sig { returns(T.nilable(String)) }
+          attr_reader :reason
+
+          sig { params(reason: String).void }
+          attr_writer :reason
+
+          # Explicitly no cap.
+          sig do
+            params(
+              unlimited:
+                Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited::Unlimited::OrBoolean,
+              reason: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # `true`: explicitly no cap.
+            unlimited:,
+            # Why the limit is set or changed, kept for audit.
+            reason: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                unlimited:
+                  Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited::Unlimited::OrBoolean,
+                reason: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # `true`: explicitly no cap.
+          module Unlimited
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedBoolean =
+              T.type_alias do
+                T.all(
+                  T::Boolean,
+                  Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited::Unlimited
+                )
+              end
+            OrBoolean = T.type_alias { T::Boolean }
+
+            TRUE =
+              T.let(
+                true,
+                Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited::Unlimited::TaggedBoolean
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited::Unlimited::TaggedBoolean
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::SpendLimitUpdateParams::Body::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/terms_of_service/tos_agreement.rbi

@@ -27,24 +27,28 @@ module Telnyx
         end
         attr_writer :product_type
 
+        # The version of the terms you accepted.
         sig { returns(T.nilable(String)) }
         attr_reader :terms_version
 
         sig { params(terms_version: String).void }
         attr_writer :terms_version
 
+        # The unique identifier of this recorded agreement.
         sig { returns(T.nilable(String)) }
         attr_reader :id
 
         sig { params(id: String).void }
         attr_writer :id
 
+        # When you accepted this version of the terms.
         sig { returns(T.nilable(Time)) }
         attr_reader :agreed_at
 
         sig { params(agreed_at: Time).void }
         attr_writer :agreed_at
 
+        # When this agreement record was created.
         sig { returns(T.nilable(Time)) }
         attr_reader :created_at
 
@@ -72,11 +76,15 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
+          # The unique identifier of this recorded agreement.
           id: nil,
+          # When you accepted this version of the terms.
           agreed_at: nil,
+          # When this agreement record was created.
           created_at: nil,
           # Telnyx product the Terms of Service apply to.
           product_type: nil,
+          # The version of the terms you accepted.
           terms_version: nil,
           # Convenience alias of `terms_version`. Both keys are present on every response.
           version: nil

data/rbi/telnyx/models/terms_of_service_retrieve_info_response.rbi

@@ -65,18 +65,21 @@ module Telnyx
             )
           end
 
+        # The latest published version of these terms.
         sig { returns(T.nilable(String)) }
         attr_reader :current_version
 
         sig { params(current_version: String).void }
         attr_writer :current_version
 
+        # A short summary of the product these terms cover.
         sig { returns(T.nilable(String)) }
         attr_reader :description
 
         sig { params(description: String).void }
         attr_writer :description
 
+        # The date this version took effect.
         sig { returns(T.nilable(Date)) }
         attr_reader :effective_date
 
@@ -98,6 +101,7 @@ module Telnyx
         end
         attr_writer :product_type
 
+        # A link to the full terms text.
         sig { returns(T.nilable(String)) }
         attr_reader :terms_url
 
@@ -114,11 +118,15 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
+          # The latest published version of these terms.
           current_version: nil,
+          # A short summary of the product these terms cover.
           description: nil,
+          # The date this version took effect.
           effective_date: nil,
           # Telnyx product the Terms of Service apply to.
           product_type: nil,
+          # A link to the full terms text.
           terms_url: nil
         )
         end

data/rbi/telnyx/models/terms_of_service_retrieve_status_response.rbi

@@ -73,6 +73,7 @@ module Telnyx
         sig { returns(Telnyx::TermsOfService::TosProductType::TaggedSymbol) }
         attr_accessor :product_type
 
+        # When you accepted the terms, or null if you have not.
         sig { returns(T.nilable(Time)) }
         attr_accessor :agreed_at
 
@@ -103,6 +104,7 @@ module Telnyx
           has_agreed:,
           # Telnyx product the Terms of Service apply to.
           product_type:,
+          # When you accepted the terms, or null if you have not.
           agreed_at: nil,
           # Version the user previously agreed to (may be older than
           # `current_terms_version`). `null` if the user has never agreed.

data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi

@@ -14,7 +14,9 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :connection_id
 
-      # The ID of the AI assistant to use for the call.
+      # The ID of the AI assistant to use for the call. Telnyx attempts to warm up this
+      # assistant before the call is placed and starts it automatically when the called
+      # party answers.
       sig { returns(String) }
       attr_accessor :ai_assistant_id
 
@@ -576,7 +578,9 @@ module Telnyx
       end
       def self.new(
         connection_id:,
-        # The ID of the AI assistant to use for the call.
+        # The ID of the AI assistant to use for the call. Telnyx attempts to warm up this
+        # assistant before the call is placed and starts it automatically when the called
+        # party answers.
         ai_assistant_id:,
         # The phone number of the party initiating the call. Phone numbers are formatted
         # with a `+` and country code.

data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi

@@ -1390,8 +1390,10 @@ module Telnyx
         sig { params(sampling_rate: Integer).void }
         attr_writer :sampling_rate
 
-        # Voice speed multiplier. Applies to all models except `Bayan` and `Sukhan`, which
-        # don't support it. Range: 0.5 to 2.0.
+        # Voice speed multiplier. Telnyx `Ultra` voices accept values from 0.6 to 1.5 —
+        # requests outside that range are rejected by the synthesis engine. `KokoroTTS`
+        # and `Qwen3TTS` accept the field but do not apply it. `Bayan` and `Sukhan` don't
+        # support it.
         sig { returns(T.nilable(Float)) }
         attr_reader :voice_speed
 
@@ -1430,8 +1432,10 @@ module Telnyx
           response_format: nil,
           # Audio sampling rate in Hz.
           sampling_rate: nil,
-          # Voice speed multiplier. Applies to all models except `Bayan` and `Sukhan`, which
-          # don't support it. Range: 0.5 to 2.0.
+          # Voice speed multiplier. Telnyx `Ultra` voices accept values from 0.6 to 1.5 —
+          # requests outside that range are rejected by the synthesis engine. `KokoroTTS`
+          # and `Qwen3TTS` accept the field but do not apply it. `Bayan` and `Sukhan` don't
+          # support it.
           voice_speed: nil,
           # Volume level for the Ultra model. Telnyx `Ultra` voices accept values from 0.5
           # to 2.0 — requests outside that range are rejected by the synthesis engine.