telnyx 5.102.1 → 5.103.0

data/lib/telnyx/models/uac_inbound.rb

@@ -1,210 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    class UacInbound < Telnyx::Internal::Type::BaseModel
-      # @!attribute ani_number_format
-      #   This setting allows you to set the format with which the caller's number (ANI)
-      #   is sent for inbound phone calls.
-      #
-      #   @return [Symbol, Telnyx::Models::UacInbound::AniNumberFormat, nil]
-      optional :ani_number_format, enum: -> { Telnyx::UacInbound::AniNumberFormat }
-
-      # @!attribute channel_limit
-      #   When set, this will limit the total number of inbound calls to phone numbers
-      #   associated with this connection.
-      #
-      #   @return [Integer, nil]
-      optional :channel_limit, Integer
-
-      # @!attribute codecs
-      #   Defines the list of codecs that Telnyx will send for inbound calls to a specific
-      #   number on your portal account, in priority order. This only works when the
-      #   Connection the number is assigned to uses Media Handling mode: default. OPUS and
-      #   H.264 codecs are available only when using TCP or TLS transport for SIP.
-      #
-      #   @return [Array<String>, nil]
-      optional :codecs, Telnyx::Internal::Type::ArrayOf[String]
-
-      # @!attribute default_routing_method
-      #   Default routing method to be used when a number is associated with the
-      #   connection. Must be one of the routing method types or left blank, other values
-      #   are not allowed.
-      #
-      #   @return [Symbol, Telnyx::Models::UacInbound::DefaultRoutingMethod, nil]
-      optional :default_routing_method, enum: -> { Telnyx::UacInbound::DefaultRoutingMethod }
-
-      # @!attribute dnis_number_format
-      #
-      #   @return [Symbol, Telnyx::Models::UacInbound::DnisNumberFormat, nil]
-      optional :dnis_number_format, enum: -> { Telnyx::UacInbound::DnisNumberFormat }
-
-      # @!attribute generate_ringback_tone
-      #   Generate ringback tone through 183 session progress message with early media.
-      #
-      #   @return [Boolean, nil]
-      optional :generate_ringback_tone, Telnyx::Internal::Type::Boolean
-
-      # @!attribute isup_headers_enabled
-      #   When set, inbound phone calls will receive ISUP parameters via SIP headers.
-      #   (Only when available and only when using TCP or TLS transport.)
-      #
-      #   @return [Boolean, nil]
-      optional :isup_headers_enabled, Telnyx::Internal::Type::Boolean
-
-      # @!attribute prack_enabled
-      #   Enable PRACK messages as defined in RFC3262.
-      #
-      #   @return [Boolean, nil]
-      optional :prack_enabled, Telnyx::Internal::Type::Boolean
-
-      # @!attribute shaken_stir_enabled
-      #   When enabled the SIP Connection will receive the Identity header with
-      #   Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
-      #   transport.
-      #
-      #   @return [Boolean, nil]
-      optional :shaken_stir_enabled, Telnyx::Internal::Type::Boolean
-
-      # @!attribute simultaneous_ringing
-      #   When enabled, allows multiple devices to ring simultaneously on incoming calls.
-      #
-      #   @return [Symbol, Telnyx::Models::UacInbound::SimultaneousRinging, nil]
-      optional :simultaneous_ringing, enum: -> { Telnyx::UacInbound::SimultaneousRinging }
-
-      # @!attribute sip_compact_headers_enabled
-      #   Defaults to true.
-      #
-      #   @return [Boolean, nil]
-      optional :sip_compact_headers_enabled, Telnyx::Internal::Type::Boolean
-
-      # @!attribute sip_subdomain
-      #   The Telnyx-generated SIP subdomain for this UAC connection.
-      #
-      #   @return [String, nil]
-      optional :sip_subdomain, String
-
-      # @!attribute sip_subdomain_receive_settings
-      #   Controls which SIP URI callers may reach this connection.
-      #
-      #   @return [Symbol, Telnyx::Models::UacInbound::SipSubdomainReceiveSettings, nil]
-      optional :sip_subdomain_receive_settings, enum: -> { Telnyx::UacInbound::SipSubdomainReceiveSettings }
-
-      # @!attribute timeout_1xx_secs
-      #   Time(sec) before aborting if connection is not made.
-      #
-      #   @return [Integer, nil]
-      optional :timeout_1xx_secs, Integer
-
-      # @!attribute timeout_2xx_secs
-      #   Time(sec) before aborting if call is unanswered (min: 1, max: 600).
-      #
-      #   @return [Integer, nil]
-      optional :timeout_2xx_secs, Integer
-
-      # @!method initialize(ani_number_format: nil, channel_limit: nil, codecs: nil, default_routing_method: nil, dnis_number_format: nil, generate_ringback_tone: nil, isup_headers_enabled: nil, prack_enabled: nil, shaken_stir_enabled: nil, simultaneous_ringing: nil, sip_compact_headers_enabled: nil, sip_subdomain: nil, sip_subdomain_receive_settings: nil, timeout_1xx_secs: nil, timeout_2xx_secs: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::UacInbound} for more details.
-      #
-      #   @param ani_number_format [Symbol, Telnyx::Models::UacInbound::AniNumberFormat] This setting allows you to set the format with which the caller's number (ANI) i
-      #
-      #   @param channel_limit [Integer] When set, this will limit the total number of inbound calls to phone numbers ass
-      #
-      #   @param codecs [Array<String>] Defines the list of codecs that Telnyx will send for inbound calls to a specific
-      #
-      #   @param default_routing_method [Symbol, Telnyx::Models::UacInbound::DefaultRoutingMethod] Default routing method to be used when a number is associated with the connectio
-      #
-      #   @param dnis_number_format [Symbol, Telnyx::Models::UacInbound::DnisNumberFormat]
-      #
-      #   @param generate_ringback_tone [Boolean] Generate ringback tone through 183 session progress message with early media.
-      #
-      #   @param isup_headers_enabled [Boolean] When set, inbound phone calls will receive ISUP parameters via SIP headers. (Onl
-      #
-      #   @param prack_enabled [Boolean] Enable PRACK messages as defined in RFC3262.
-      #
-      #   @param shaken_stir_enabled [Boolean] When enabled the SIP Connection will receive the Identity header with Shaken/Sti
-      #
-      #   @param simultaneous_ringing [Symbol, Telnyx::Models::UacInbound::SimultaneousRinging] When enabled, allows multiple devices to ring simultaneously on incoming calls.
-      #
-      #   @param sip_compact_headers_enabled [Boolean] Defaults to true.
-      #
-      #   @param sip_subdomain [String] The Telnyx-generated SIP subdomain for this UAC connection.
-      #
-      #   @param sip_subdomain_receive_settings [Symbol, Telnyx::Models::UacInbound::SipSubdomainReceiveSettings] Controls which SIP URI callers may reach this connection.
-      #
-      #   @param timeout_1xx_secs [Integer] Time(sec) before aborting if connection is not made.
-      #
-      #   @param timeout_2xx_secs [Integer] Time(sec) before aborting if call is unanswered (min: 1, max: 600).
-
-      # This setting allows you to set the format with which the caller's number (ANI)
-      # is sent for inbound phone calls.
-      #
-      # @see Telnyx::Models::UacInbound#ani_number_format
-      module AniNumberFormat
-        extend Telnyx::Internal::Type::Enum
-
-        PLUS_E_164 = :"+E.164"
-        E_164 = :"E.164"
-        PLUS_E_164_NATIONAL = :"+E.164-national"
-        E_164_NATIONAL = :"E.164-national"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # Default routing method to be used when a number is associated with the
-      # connection. Must be one of the routing method types or left blank, other values
-      # are not allowed.
-      #
-      # @see Telnyx::Models::UacInbound#default_routing_method
-      module DefaultRoutingMethod
-        extend Telnyx::Internal::Type::Enum
-
-        SEQUENTIAL = :sequential
-        ROUND_ROBIN = :"round-robin"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # @see Telnyx::Models::UacInbound#dnis_number_format
-      module DnisNumberFormat
-        extend Telnyx::Internal::Type::Enum
-
-        PLUS_E164 = :"+e164"
-        E164 = :e164
-        NATIONAL = :national
-        SIP_USERNAME = :sip_username
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # When enabled, allows multiple devices to ring simultaneously on incoming calls.
-      #
-      # @see Telnyx::Models::UacInbound#simultaneous_ringing
-      module SimultaneousRinging
-        extend Telnyx::Internal::Type::Enum
-
-        DISABLED = :disabled
-        ENABLED = :enabled
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # Controls which SIP URI callers may reach this connection.
-      #
-      # @see Telnyx::Models::UacInbound#sip_subdomain_receive_settings
-      module SipSubdomainReceiveSettings
-        extend Telnyx::Internal::Type::Enum
-
-        ONLY_MY_CONNECTIONS = :only_my_connections
-        FROM_ANYONE = :from_anyone
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/telnyx/models/uac_internal_settings.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    class UacInternalSettings < Telnyx::Internal::Type::BaseModel
-      # @!attribute destination_uri
-      #   The SIP URI that Telnyx will call when handling an inbound request from the
-      #   external peer. Do not include a `sip:` prefix. The value must be in the format
-      #   `userinfo@[subdomain.]sip.telnyx.com` or
-      #   `userinfo@[subdomain.]sipdev.telnyx.com`; the userinfo portion may contain only
-      #   letters, digits, hyphens, and underscores.
-      #
-      #   @return [String, nil]
-      optional :destination_uri, String
-
-      # @!method initialize(destination_uri: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::UacInternalSettings} for more details.
-      #
-      #   Internal Telnyx-side settings for a UAC connection.
-      #
-      #   @param destination_uri [String] The SIP URI that Telnyx will call when handling an inbound request from the exte
-    end
-  end
-end

data/lib/telnyx/models/uac_outbound.rb

@@ -1,131 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    class UacOutbound < Telnyx::Internal::Type::BaseModel
-      # @!attribute ani_override
-      #   Set a phone number as the ani_override value to override caller id number on
-      #   outbound calls.
-      #
-      #   @return [String, nil]
-      optional :ani_override, String
-
-      # @!attribute ani_override_type
-      #   Specifies when we apply your ani_override setting. Only applies when
-      #   ani_override is not blank.
-      #
-      #   @return [Symbol, Telnyx::Models::UacOutbound::AniOverrideType, nil]
-      optional :ani_override_type, enum: -> { Telnyx::UacOutbound::AniOverrideType }
-
-      # @!attribute call_parking_enabled
-      #   Forces all SIP calls originated on this connection to be "parked" instead of
-      #   "bridged" to the destination specified on the URI. Parked calls will return
-      #   ringback to the caller and will await for a Call Control command to define which
-      #   action will be taken next.
-      #
-      #   @return [Boolean, nil]
-      optional :call_parking_enabled, Telnyx::Internal::Type::Boolean, nil?: true
-
-      # @!attribute channel_limit
-      #   When set, this will limit the total number of outbound calls to phone numbers
-      #   associated with this connection.
-      #
-      #   @return [Integer, nil]
-      optional :channel_limit, Integer
-
-      # @!attribute generate_ringback_tone
-      #   Generate ringback tone through 183 session progress message with early media.
-      #
-      #   @return [Boolean, nil]
-      optional :generate_ringback_tone, Telnyx::Internal::Type::Boolean
-
-      # @!attribute instant_ringback_enabled
-      #   When set, ringback will not wait for indication before sending ringback tone to
-      #   calling party.
-      #
-      #   @return [Boolean, nil]
-      optional :instant_ringback_enabled, Telnyx::Internal::Type::Boolean
-
-      # @!attribute localization
-      #   A 2-character country code specifying the country whose national dialing rules
-      #   should be used. For example, if set to `US` then any US number can be dialed
-      #   without preprending +1 to the number. When left blank, Telnyx will try US and GB
-      #   dialing rules, in that order, by default.
-      #
-      #   @return [String, nil]
-      optional :localization, String
-
-      # @!attribute outbound_voice_profile_id
-      #   Identifies the associated outbound voice profile.
-      #
-      #   @return [String, nil]
-      optional :outbound_voice_profile_id, String
-
-      # @!attribute t38_reinvite_source
-      #   This setting only affects connections with Fax-type Outbound Voice Profiles. The
-      #   setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
-      #   default, Telnyx will send the re-invite. If set to `customer`, the caller is
-      #   expected to send the t.38 reinvite.
-      #
-      #   @return [Symbol, Telnyx::Models::UacOutbound::T38ReinviteSource, nil]
-      optional :t38_reinvite_source, enum: -> { Telnyx::UacOutbound::T38ReinviteSource }
-
-      # @!method initialize(ani_override: nil, ani_override_type: nil, call_parking_enabled: nil, channel_limit: nil, generate_ringback_tone: nil, instant_ringback_enabled: nil, localization: nil, outbound_voice_profile_id: nil, t38_reinvite_source: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::UacOutbound} for more details.
-      #
-      #   @param ani_override [String] Set a phone number as the ani_override value to override caller id number on out
-      #
-      #   @param ani_override_type [Symbol, Telnyx::Models::UacOutbound::AniOverrideType] Specifies when we apply your ani_override setting. Only applies when ani_overrid
-      #
-      #   @param call_parking_enabled [Boolean, nil] Forces all SIP calls originated on this connection to be "parked" instead of "br
-      #
-      #   @param channel_limit [Integer] When set, this will limit the total number of outbound calls to phone numbers as
-      #
-      #   @param generate_ringback_tone [Boolean] Generate ringback tone through 183 session progress message with early media.
-      #
-      #   @param instant_ringback_enabled [Boolean] When set, ringback will not wait for indication before sending ringback tone to
-      #
-      #   @param localization [String] A 2-character country code specifying the country whose national dialing rules s
-      #
-      #   @param outbound_voice_profile_id [String] Identifies the associated outbound voice profile.
-      #
-      #   @param t38_reinvite_source [Symbol, Telnyx::Models::UacOutbound::T38ReinviteSource] This setting only affects connections with Fax-type Outbound Voice Profiles. The
-
-      # Specifies when we apply your ani_override setting. Only applies when
-      # ani_override is not blank.
-      #
-      # @see Telnyx::Models::UacOutbound#ani_override_type
-      module AniOverrideType
-        extend Telnyx::Internal::Type::Enum
-
-        ALWAYS = :always
-        NORMAL = :normal
-        EMERGENCY = :emergency
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # This setting only affects connections with Fax-type Outbound Voice Profiles. The
-      # setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
-      # default, Telnyx will send the re-invite. If set to `customer`, the caller is
-      # expected to send the t.38 reinvite.
-      #
-      # @see Telnyx::Models::UacOutbound#t38_reinvite_source
-      module T38ReinviteSource
-        extend Telnyx::Internal::Type::Enum
-
-        TELNYX = :telnyx
-        CUSTOMER = :customer
-        DISABLED = :disabled
-        PASSTHRU = :passthru
-        CALLER_PASSTHRU = :"caller-passthru"
-        CALLEE_PASSTHRU = :"callee-passthru"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/telnyx/models/xai_voice_settings.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    class XaiVoiceSettings < Telnyx::Internal::Type::BaseModel
-      # @!attribute type
-      #   Voice settings provider type
-      #
-      #   @return [Symbol, Telnyx::Models::XaiVoiceSettings::Type]
-      required :type, enum: -> { Telnyx::XaiVoiceSettings::Type }
-
-      # @!attribute language
-      #   Language code, or `auto` to detect automatically.
-      #
-      #   @return [String, nil]
-      optional :language, String
-
-      # @!method initialize(type:, language: nil)
-      #   @param type [Symbol, Telnyx::Models::XaiVoiceSettings::Type] Voice settings provider type
-      #
-      #   @param language [String] Language code, or `auto` to detect automatically.
-
-      # Voice settings provider type
-      #
-      # @see Telnyx::Models::XaiVoiceSettings#type
-      module Type
-        extend Telnyx::Internal::Type::Enum
-
-        XAI = :xai
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/rbi/telnyx/models/ai/assistant_integration.rbi

@@ -1,60 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      class AssistantIntegration < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Telnyx::AI::AssistantIntegration, Telnyx::Internal::AnyHash)
-          end
-
-        # Catalog integration ID to attach. This is the `id` from the integrations catalog
-        # at `/ai/integrations` (the same value also appears as `integration_id` on
-        # entries returned by `/ai/integrations/connections`). It is **not** the
-        # connection-level `id` from `/ai/integrations/connections`.
-        sig { returns(String) }
-        attr_accessor :integration_id
-
-        # Optional per-assistant allowlist of integration tool names. When omitted or
-        # empty, all tools allowed by the connected integration are available to the
-        # assistant.
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :allowed_list
-
-        sig { params(allowed_list: T::Array[String]).void }
-        attr_writer :allowed_list
-
-        # Reference to a connected integration attached to an assistant. Discover
-        # available integrations with `/ai/integrations` and connected integrations with
-        # `/ai/integrations/connections`.
-        sig do
-          params(
-            integration_id: String,
-            allowed_list: T::Array[String]
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Catalog integration ID to attach. This is the `id` from the integrations catalog
-          # at `/ai/integrations` (the same value also appears as `integration_id` on
-          # entries returned by `/ai/integrations/connections`). It is **not** the
-          # connection-level `id` from `/ai/integrations/connections`.
-          integration_id:,
-          # Optional per-assistant allowlist of integration tool names. When omitted or
-          # empty, all tools allowed by the connected integration are available to the
-          # assistant.
-          allowed_list: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            { integration_id: String, allowed_list: T::Array[String] }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/ai/assistant_mcp_server.rbi

@@ -1,51 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      class AssistantMcpServer < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Telnyx::AI::AssistantMcpServer, Telnyx::Internal::AnyHash)
-          end
-
-        # ID of the MCP server to attach. This must be the `id` of an MCP server returned
-        # by the `/ai/mcp_servers` endpoints.
-        sig { returns(String) }
-        attr_accessor :id
-
-        # Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
-        # uses the MCP server's configured `allowed_tools`.
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :allowed_tools
-
-        sig { params(allowed_tools: T::Array[String]).void }
-        attr_writer :allowed_tools
-
-        # Reference to an MCP server attached to an assistant. Create and manage MCP
-        # servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
-        # ID.
-        sig do
-          params(id: String, allowed_tools: T::Array[String]).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # ID of the MCP server to attach. This must be the `id` of an MCP server returned
-          # by the `/ai/mcp_servers` endpoints.
-          id:,
-          # Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
-          # uses the MCP server's configured `allowed_tools`.
-          allowed_tools: nil
-        )
-        end
-
-        sig do
-          override.returns({ id: String, allowed_tools: T::Array[String] })
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/ai/assistants/clause.rbi

@@ -1,91 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      module Assistants
-        class Clause < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(Telnyx::AI::Assistants::Clause, Telnyx::Internal::AnyHash)
-            end
-
-          # Attribute name from the routing context
-          sig { returns(String) }
-          attr_accessor :attribute
-
-          # Match operator
-          sig { returns(Telnyx::AI::Assistants::Clause::Operator::OrSymbol) }
-          attr_accessor :operator
-
-          sig { returns(T::Array[String]) }
-          attr_accessor :values
-
-          # A single attribute/operator/values check.
-          #
-          # A clause matches when the routing context's value for `attribute` satisfies
-          # `operator` against any of `values`.
-          sig do
-            params(
-              attribute: String,
-              operator: Telnyx::AI::Assistants::Clause::Operator::OrSymbol,
-              values: T::Array[String]
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Attribute name from the routing context
-            attribute:,
-            # Match operator
-            operator:,
-            values:
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                attribute: String,
-                operator: Telnyx::AI::Assistants::Clause::Operator::OrSymbol,
-                values: T::Array[String]
-              }
-            )
-          end
-          def to_hash
-          end
-
-          # Match operator
-          module Operator
-            extend Telnyx::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(Symbol, Telnyx::AI::Assistants::Clause::Operator)
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            IN =
-              T.let(:in, Telnyx::AI::Assistants::Clause::Operator::TaggedSymbol)
-            NOT_IN =
-              T.let(
-                :not_in,
-                Telnyx::AI::Assistants::Clause::Operator::TaggedSymbol
-              )
-            STARTS_WITH =
-              T.let(
-                :starts_with,
-                Telnyx::AI::Assistants::Clause::Operator::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[Telnyx::AI::Assistants::Clause::Operator::TaggedSymbol]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi

@@ -1,36 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      module Assistants
-        class RolloutSlot < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::AI::Assistants::RolloutSlot,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          sig { returns(String) }
-          attr_accessor :version_id
-
-          sig { returns(Float) }
-          attr_accessor :weight
-
-          # One slot in a percentage rollout.
-          sig do
-            params(version_id: String, weight: Float).returns(T.attached_class)
-          end
-          def self.new(version_id:, weight:)
-          end
-
-          sig { override.returns({ version_id: String, weight: Float }) }
-          def to_hash
-          end
-        end
-      end
-    end
-  end
-end