telnyx 5.103.0 → 5.103.1

data/rbi/telnyx/models/uac_outbound.rbi

@@ -0,0 +1,224 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class UacOutbound < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Telnyx::UacOutbound, Telnyx::Internal::AnyHash) }
+
+      # Set a phone number as the ani_override value to override caller id number on
+      # outbound calls.
+      sig { returns(T.nilable(String)) }
+      attr_reader :ani_override
+
+      sig { params(ani_override: String).void }
+      attr_writer :ani_override
+
+      # Specifies when we apply your ani_override setting. Only applies when
+      # ani_override is not blank.
+      sig { returns(T.nilable(Telnyx::UacOutbound::AniOverrideType::OrSymbol)) }
+      attr_reader :ani_override_type
+
+      sig do
+        params(
+          ani_override_type: Telnyx::UacOutbound::AniOverrideType::OrSymbol
+        ).void
+      end
+      attr_writer :ani_override_type
+
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :call_parking_enabled
+
+      # When set, this will limit the total number of outbound calls to phone numbers
+      # associated with this connection.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :channel_limit
+
+      sig { params(channel_limit: Integer).void }
+      attr_writer :channel_limit
+
+      # Generate ringback tone through 183 session progress message with early media.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :generate_ringback_tone
+
+      sig { params(generate_ringback_tone: T::Boolean).void }
+      attr_writer :generate_ringback_tone
+
+      # When set, ringback will not wait for indication before sending ringback tone to
+      # calling party.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :instant_ringback_enabled
+
+      sig { params(instant_ringback_enabled: T::Boolean).void }
+      attr_writer :instant_ringback_enabled
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :localization
+
+      sig { params(localization: String).void }
+      attr_writer :localization
+
+      # Identifies the associated outbound voice profile.
+      sig { returns(T.nilable(String)) }
+      attr_reader :outbound_voice_profile_id
+
+      sig { params(outbound_voice_profile_id: String).void }
+      attr_writer :outbound_voice_profile_id
+
+      # 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.
+      sig do
+        returns(T.nilable(Telnyx::UacOutbound::T38ReinviteSource::OrSymbol))
+      end
+      attr_reader :t38_reinvite_source
+
+      sig do
+        params(
+          t38_reinvite_source: Telnyx::UacOutbound::T38ReinviteSource::OrSymbol
+        ).void
+      end
+      attr_writer :t38_reinvite_source
+
+      sig do
+        params(
+          ani_override: String,
+          ani_override_type: Telnyx::UacOutbound::AniOverrideType::OrSymbol,
+          call_parking_enabled: T.nilable(T::Boolean),
+          channel_limit: Integer,
+          generate_ringback_tone: T::Boolean,
+          instant_ringback_enabled: T::Boolean,
+          localization: String,
+          outbound_voice_profile_id: String,
+          t38_reinvite_source: Telnyx::UacOutbound::T38ReinviteSource::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Set a phone number as the ani_override value to override caller id number on
+        # outbound calls.
+        ani_override: nil,
+        # Specifies when we apply your ani_override setting. Only applies when
+        # ani_override is not blank.
+        ani_override_type: nil,
+        # 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.
+        call_parking_enabled: nil,
+        # When set, this will limit the total number of outbound calls to phone numbers
+        # associated with this connection.
+        channel_limit: nil,
+        # Generate ringback tone through 183 session progress message with early media.
+        generate_ringback_tone: nil,
+        # When set, ringback will not wait for indication before sending ringback tone to
+        # calling party.
+        instant_ringback_enabled: nil,
+        # 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.
+        localization: nil,
+        # Identifies the associated outbound voice profile.
+        outbound_voice_profile_id: nil,
+        # 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.
+        t38_reinvite_source: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            ani_override: String,
+            ani_override_type: Telnyx::UacOutbound::AniOverrideType::OrSymbol,
+            call_parking_enabled: T.nilable(T::Boolean),
+            channel_limit: Integer,
+            generate_ringback_tone: T::Boolean,
+            instant_ringback_enabled: T::Boolean,
+            localization: String,
+            outbound_voice_profile_id: String,
+            t38_reinvite_source:
+              Telnyx::UacOutbound::T38ReinviteSource::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Specifies when we apply your ani_override setting. Only applies when
+      # ani_override is not blank.
+      module AniOverrideType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::UacOutbound::AniOverrideType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALWAYS =
+          T.let(:always, Telnyx::UacOutbound::AniOverrideType::TaggedSymbol)
+        NORMAL =
+          T.let(:normal, Telnyx::UacOutbound::AniOverrideType::TaggedSymbol)
+        EMERGENCY =
+          T.let(:emergency, Telnyx::UacOutbound::AniOverrideType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::UacOutbound::AniOverrideType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      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.
+      module T38ReinviteSource
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::UacOutbound::T38ReinviteSource) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TELNYX =
+          T.let(:telnyx, Telnyx::UacOutbound::T38ReinviteSource::TaggedSymbol)
+        CUSTOMER =
+          T.let(:customer, Telnyx::UacOutbound::T38ReinviteSource::TaggedSymbol)
+        DISABLED =
+          T.let(:disabled, Telnyx::UacOutbound::T38ReinviteSource::TaggedSymbol)
+        PASSTHRU =
+          T.let(:passthru, Telnyx::UacOutbound::T38ReinviteSource::TaggedSymbol)
+        CALLER_PASSTHRU =
+          T.let(
+            :"caller-passthru",
+            Telnyx::UacOutbound::T38ReinviteSource::TaggedSymbol
+          )
+        CALLEE_PASSTHRU =
+          T.let(
+            :"callee-passthru",
+            Telnyx::UacOutbound::T38ReinviteSource::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::UacOutbound::T38ReinviteSource::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/virtual_cross_connect_combined.rbi

@@ -0,0 +1,345 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class VirtualCrossConnectCombined < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::VirtualCrossConnectCombined, Telnyx::Internal::AnyHash)
+        end
+
+      # The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
+      # Connect.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :bandwidth_mbps
+
+      sig { params(bandwidth_mbps: Float).void }
+      attr_writer :bandwidth_mbps
+
+      # The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+      sig { returns(T.nilable(Float)) }
+      attr_reader :bgp_asn
+
+      sig { params(bgp_asn: Float).void }
+      attr_writer :bgp_asn
+
+      # The Virtual Private Cloud with which you would like to establish a cross
+      # connect.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::VirtualCrossConnectCombined::CloudProvider::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :cloud_provider
+
+      sig do
+        params(
+          cloud_provider:
+            Telnyx::VirtualCrossConnectCombined::CloudProvider::OrSymbol
+        ).void
+      end
+      attr_writer :cloud_provider
+
+      # The region where your Virtual Private Cloud hosts are located.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cloud_provider_region
+
+      sig { params(cloud_provider_region: String).void }
+      attr_writer :cloud_provider_region
+
+      # A user specified name for the interface.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # The id of the network associated with the interface.
+      sig { returns(T.nilable(String)) }
+      attr_reader :network_id
+
+      sig { params(network_id: String).void }
+      attr_writer :network_id
+
+      # The authentication key for BGP peer configuration.
+      sig { returns(T.nilable(String)) }
+      attr_reader :primary_bgp_key
+
+      sig { params(primary_bgp_key: String).void }
+      attr_writer :primary_bgp_key
+
+      # The identifier for your Virtual Private Cloud.
+      sig { returns(T.nilable(String)) }
+      attr_reader :primary_cloud_account_id
+
+      sig { params(primary_cloud_account_id: String).void }
+      attr_writer :primary_cloud_account_id
+
+      # The IP address assigned for your side of the Virtual Cross Connect.
+      sig { returns(T.nilable(String)) }
+      attr_reader :primary_cloud_ip
+
+      sig { params(primary_cloud_ip: String).void }
+      attr_writer :primary_cloud_ip
+
+      # Indicates whether the primary circuit is enabled.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :primary_enabled
+
+      sig { params(primary_enabled: T::Boolean).void }
+      attr_writer :primary_enabled
+
+      # Whether
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :primary_routing_announcement
+
+      sig { params(primary_routing_announcement: T::Boolean).void }
+      attr_writer :primary_routing_announcement
+
+      # The IP address assigned to the Telnyx side of the Virtual Cross Connect.
+      sig { returns(T.nilable(String)) }
+      attr_reader :primary_telnyx_ip
+
+      sig { params(primary_telnyx_ip: String).void }
+      attr_writer :primary_telnyx_ip
+
+      sig { returns(T.nilable(Telnyx::VirtualCrossConnectCombined::Region)) }
+      attr_reader :region
+
+      sig do
+        params(region: Telnyx::VirtualCrossConnectCombined::Region::OrHash).void
+      end
+      attr_writer :region
+
+      # The region interface is deployed to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :region_code
+
+      sig { params(region_code: String).void }
+      attr_writer :region_code
+
+      # Identifies the resource.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # ISO 8601 formatted date-time indicating when the resource was created.
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_at
+
+      sig { params(created_at: String).void }
+      attr_writer :created_at
+
+      # Identifies the type of the resource.
+      sig { returns(T.nilable(String)) }
+      attr_reader :record_type
+
+      sig { params(record_type: String).void }
+      attr_writer :record_type
+
+      # The current status of the interface deployment.
+      sig { returns(T.nilable(Telnyx::InterfaceStatus::TaggedSymbol)) }
+      attr_reader :status
+
+      sig { params(status: Telnyx::InterfaceStatus::OrSymbol).void }
+      attr_writer :status
+
+      # ISO 8601 formatted date-time indicating when the resource was updated.
+      sig { returns(T.nilable(String)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: String).void }
+      attr_writer :updated_at
+
+      sig do
+        params(
+          id: String,
+          bandwidth_mbps: Float,
+          bgp_asn: Float,
+          cloud_provider:
+            Telnyx::VirtualCrossConnectCombined::CloudProvider::OrSymbol,
+          cloud_provider_region: String,
+          created_at: String,
+          name: String,
+          network_id: String,
+          primary_bgp_key: String,
+          primary_cloud_account_id: String,
+          primary_cloud_ip: String,
+          primary_enabled: T::Boolean,
+          primary_routing_announcement: T::Boolean,
+          primary_telnyx_ip: String,
+          record_type: String,
+          region: Telnyx::VirtualCrossConnectCombined::Region::OrHash,
+          region_code: String,
+          status: Telnyx::InterfaceStatus::OrSymbol,
+          updated_at: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Identifies the resource.
+        id: nil,
+        # The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
+        # Connect.
+        bandwidth_mbps: nil,
+        # The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+        bgp_asn: nil,
+        # The Virtual Private Cloud with which you would like to establish a cross
+        # connect.
+        cloud_provider: nil,
+        # The region where your Virtual Private Cloud hosts are located.
+        cloud_provider_region: nil,
+        # ISO 8601 formatted date-time indicating when the resource was created.
+        created_at: nil,
+        # A user specified name for the interface.
+        name: nil,
+        # The id of the network associated with the interface.
+        network_id: nil,
+        # The authentication key for BGP peer configuration.
+        primary_bgp_key: nil,
+        # The identifier for your Virtual Private Cloud.
+        primary_cloud_account_id: nil,
+        # The IP address assigned for your side of the Virtual Cross Connect.
+        primary_cloud_ip: nil,
+        # Indicates whether the primary circuit is enabled.
+        primary_enabled: nil,
+        # Whether
+        primary_routing_announcement: nil,
+        # The IP address assigned to the Telnyx side of the Virtual Cross Connect.
+        primary_telnyx_ip: nil,
+        # Identifies the type of the resource.
+        record_type: nil,
+        region: nil,
+        # The region interface is deployed to.
+        region_code: nil,
+        # The current status of the interface deployment.
+        status: nil,
+        # ISO 8601 formatted date-time indicating when the resource was updated.
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            bandwidth_mbps: Float,
+            bgp_asn: Float,
+            cloud_provider:
+              Telnyx::VirtualCrossConnectCombined::CloudProvider::TaggedSymbol,
+            cloud_provider_region: String,
+            created_at: String,
+            name: String,
+            network_id: String,
+            primary_bgp_key: String,
+            primary_cloud_account_id: String,
+            primary_cloud_ip: String,
+            primary_enabled: T::Boolean,
+            primary_routing_announcement: T::Boolean,
+            primary_telnyx_ip: String,
+            record_type: String,
+            region: Telnyx::VirtualCrossConnectCombined::Region,
+            region_code: String,
+            status: Telnyx::InterfaceStatus::TaggedSymbol,
+            updated_at: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The Virtual Private Cloud with which you would like to establish a cross
+      # connect.
+      module CloudProvider
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::VirtualCrossConnectCombined::CloudProvider)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AWS =
+          T.let(
+            :aws,
+            Telnyx::VirtualCrossConnectCombined::CloudProvider::TaggedSymbol
+          )
+        AZURE =
+          T.let(
+            :azure,
+            Telnyx::VirtualCrossConnectCombined::CloudProvider::TaggedSymbol
+          )
+        GCE =
+          T.let(
+            :gce,
+            Telnyx::VirtualCrossConnectCombined::CloudProvider::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::VirtualCrossConnectCombined::CloudProvider::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Region < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::VirtualCrossConnectCombined::Region,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Region code of the interface.
+        sig { returns(T.nilable(String)) }
+        attr_reader :code
+
+        sig { params(code: String).void }
+        attr_writer :code
+
+        # Region name of the interface.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Identifies the type of the resource.
+        sig { returns(T.nilable(String)) }
+        attr_reader :record_type
+
+        sig { params(record_type: String).void }
+        attr_writer :record_type
+
+        sig do
+          params(code: String, name: String, record_type: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Region code of the interface.
+          code: nil,
+          # Region name of the interface.
+          name: nil,
+          # Identifies the type of the resource.
+          record_type: nil
+        )
+        end
+
+        sig do
+          override.returns({ code: String, name: String, record_type: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi

@@ -11,53 +11,23 @@ module Telnyx
           )
         end
 
-      sig do
-        returns(
-          T.nilable(Telnyx::Models::VirtualCrossConnectCreateResponse::Data)
-        )
-      end
+      sig { returns(T.nilable(Telnyx::VirtualCrossConnectCombined)) }
       attr_reader :data
 
-      sig do
-        params(
-          data: Telnyx::Models::VirtualCrossConnectCreateResponse::Data::OrHash
-        ).void
-      end
+      sig { params(data: Telnyx::VirtualCrossConnectCombined::OrHash).void }
       attr_writer :data
 
       sig do
-        params(
-          data: Telnyx::Models::VirtualCrossConnectCreateResponse::Data::OrHash
-        ).returns(T.attached_class)
+        params(data: Telnyx::VirtualCrossConnectCombined::OrHash).returns(
+          T.attached_class
+        )
       end
       def self.new(data: nil)
       end
 
-      sig do
-        override.returns(
-          { data: Telnyx::Models::VirtualCrossConnectCreateResponse::Data }
-        )
-      end
+      sig { override.returns({ data: Telnyx::VirtualCrossConnectCombined }) }
       def to_hash
       end
-
-      class Data < Telnyx::Models::Record
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::Models::VirtualCrossConnectCreateResponse::Data,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        sig { returns(T.attached_class) }
-        def self.new
-        end
-
-        sig { override.returns({}) }
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi

@@ -11,53 +11,23 @@ module Telnyx
           )
         end
 
-      sig do
-        returns(
-          T.nilable(Telnyx::Models::VirtualCrossConnectDeleteResponse::Data)
-        )
-      end
+      sig { returns(T.nilable(Telnyx::VirtualCrossConnectCombined)) }
       attr_reader :data
 
-      sig do
-        params(
-          data: Telnyx::Models::VirtualCrossConnectDeleteResponse::Data::OrHash
-        ).void
-      end
+      sig { params(data: Telnyx::VirtualCrossConnectCombined::OrHash).void }
       attr_writer :data
 
       sig do
-        params(
-          data: Telnyx::Models::VirtualCrossConnectDeleteResponse::Data::OrHash
-        ).returns(T.attached_class)
+        params(data: Telnyx::VirtualCrossConnectCombined::OrHash).returns(
+          T.attached_class
+        )
       end
       def self.new(data: nil)
       end
 
-      sig do
-        override.returns(
-          { data: Telnyx::Models::VirtualCrossConnectDeleteResponse::Data }
-        )
-      end
+      sig { override.returns({ data: Telnyx::VirtualCrossConnectCombined }) }
       def to_hash
       end
-
-      class Data < Telnyx::Models::Record
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::Models::VirtualCrossConnectDeleteResponse::Data,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        sig { returns(T.attached_class) }
-        def self.new
-        end
-
-        sig { override.returns({}) }
-        def to_hash
-        end
-      end
     end
   end
 end