telnyx 5.112.0 → 5.113.0

data/lib/telnyx/models/uac_external_settings.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class UacExternalSettings < Telnyx::Internal::Type::BaseModel
+      # @!attribute auth_username
+      #   The authentication username used in SIP digest authentication. If not set, the
+      #   Username value will be used.
+      #
+      #   @return [String, nil]
+      optional :auth_username, String, nil?: true
+
+      # @!attribute expiration_sec
+      #   The registration interval, in seconds, indicating how often the system refreshes
+      #   the SIP registration with the external SIP peer.
+      #
+      #   @return [Integer, nil]
+      optional :expiration_sec, Integer, nil?: true
+
+      # @!attribute from_user
+      #   The user portion of the SIP From header used in outbound requests. This controls
+      #   the caller identity presented to the external SIP peer.
+      #
+      #   @return [String, nil]
+      optional :from_user, String, nil?: true
+
+      # @!attribute outbound_proxy
+      #   An optional SIP proxy used to route outbound requests before reaching the
+      #   external SIP peer.
+      #
+      #   @return [String, nil]
+      optional :outbound_proxy, String, nil?: true
+
+      # @!attribute password
+      #   The SIP password used for digest authentication with the external SIP peer.
+      #
+      #   @return [String, nil]
+      optional :password, String
+
+      # @!attribute proxy
+      #   The SIP proxy address of the external SIP peer used for registrations and
+      #   outbound call routing.
+      #
+      #   @return [String, nil]
+      optional :proxy, String
+
+      # @!attribute transport
+      #   The transport protocol used for SIP signaling when communicating with the
+      #   external SIP peer. One of UDP, TLS, or TCP.
+      #
+      #   @return [Symbol, Telnyx::Models::UacExternalSettings::Transport, nil]
+      optional :transport, enum: -> { Telnyx::UacExternalSettings::Transport }, nil?: true
+
+      # @!attribute username
+      #   The SIP username used to authenticate with the external SIP peer for
+      #   registrations and outbound calls. Must start with a letter or number and contain
+      #   only letters, numbers, hyphens, and underscores.
+      #
+      #   @return [String, nil]
+      optional :username, String
+
+      # @!method initialize(auth_username: nil, expiration_sec: nil, from_user: nil, outbound_proxy: nil, password: nil, proxy: nil, transport: nil, username: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::UacExternalSettings} for more details.
+      #
+      #   External SIP peer settings used by Telnyx when registering to your PBX and
+      #   routing outbound calls.
+      #
+      #   @param auth_username [String, nil] The authentication username used in SIP digest authentication. If not set, the U
+      #
+      #   @param expiration_sec [Integer, nil] The registration interval, in seconds, indicating how often the system refreshes
+      #
+      #   @param from_user [String, nil] The user portion of the SIP From header used in outbound requests. This controls
+      #
+      #   @param outbound_proxy [String, nil] An optional SIP proxy used to route outbound requests before reaching the extern
+      #
+      #   @param password [String] The SIP password used for digest authentication with the external SIP peer.
+      #
+      #   @param proxy [String] The SIP proxy address of the external SIP peer used for registrations and outbou
+      #
+      #   @param transport [Symbol, Telnyx::Models::UacExternalSettings::Transport, nil] The transport protocol used for SIP signaling when communicating with the extern
+      #
+      #   @param username [String] The SIP username used to authenticate with the external SIP peer for registratio
+
+      # The transport protocol used for SIP signaling when communicating with the
+      # external SIP peer. One of UDP, TLS, or TCP.
+      #
+      # @see Telnyx::Models::UacExternalSettings#transport
+      module Transport
+        extend Telnyx::Internal::Type::Enum
+
+        UDP = :UDP
+        TLS = :TLS
+        TCP = :TCP
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/uac_inbound.rb

@@ -0,0 +1,210 @@
+# 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

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,131 @@
+# 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/virtual_cross_connect_combined.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::VirtualCrossConnects#list
+    class VirtualCrossConnectCombined < Telnyx::Internal::Type::BaseModel
+      # @!attribute bandwidth_mbps
+      #   The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
+      #   Connect.
+      #
+      #   @return [Float, nil]
+      optional :bandwidth_mbps, Float
+
+      # @!attribute bgp_asn
+      #   The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+      #
+      #   @return [Float, nil]
+      optional :bgp_asn, Float
+
+      # @!attribute cloud_provider
+      #   The Virtual Private Cloud with which you would like to establish a cross
+      #   connect.
+      #
+      #   @return [Symbol, Telnyx::Models::VirtualCrossConnectCombined::CloudProvider, nil]
+      optional :cloud_provider, enum: -> { Telnyx::VirtualCrossConnectCombined::CloudProvider }
+
+      # @!attribute cloud_provider_region
+      #   The region where your Virtual Private Cloud hosts are located.
+      #
+      #   @return [String, nil]
+      optional :cloud_provider_region, String
+
+      # @!attribute name
+      #   A user specified name for the interface.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute network_id
+      #   The id of the network associated with the interface.
+      #
+      #   @return [String, nil]
+      optional :network_id, String
+
+      # @!attribute primary_bgp_key
+      #   The authentication key for BGP peer configuration.
+      #
+      #   @return [String, nil]
+      optional :primary_bgp_key, String
+
+      # @!attribute primary_cloud_account_id
+      #   The identifier for your Virtual Private Cloud.
+      #
+      #   @return [String, nil]
+      optional :primary_cloud_account_id, String
+
+      # @!attribute primary_cloud_ip
+      #   The IP address assigned for your side of the Virtual Cross Connect.
+      #
+      #   @return [String, nil]
+      optional :primary_cloud_ip, String
+
+      # @!attribute primary_enabled
+      #   Indicates whether the primary circuit is enabled.
+      #
+      #   @return [Boolean, nil]
+      optional :primary_enabled, Telnyx::Internal::Type::Boolean
+
+      # @!attribute primary_routing_announcement
+      #   Whether
+      #
+      #   @return [Boolean, nil]
+      optional :primary_routing_announcement, Telnyx::Internal::Type::Boolean
+
+      # @!attribute primary_telnyx_ip
+      #   The IP address assigned to the Telnyx side of the Virtual Cross Connect.
+      #
+      #   @return [String, nil]
+      optional :primary_telnyx_ip, String
+
+      # @!attribute region
+      #
+      #   @return [Telnyx::Models::VirtualCrossConnectCombined::Region, nil]
+      optional :region, -> { Telnyx::VirtualCrossConnectCombined::Region }
+
+      # @!attribute region_code
+      #   The region interface is deployed to.
+      #
+      #   @return [String, nil]
+      optional :region_code, String
+
+      response_only do
+        # @!attribute id
+        #   Identifies the resource.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #   ISO 8601 formatted date-time indicating when the resource was created.
+        #
+        #   @return [String, nil]
+        optional :created_at, String
+
+        # @!attribute record_type
+        #   Identifies the type of the resource.
+        #
+        #   @return [String, nil]
+        optional :record_type, String
+
+        # @!attribute status
+        #   The current status of the interface deployment.
+        #
+        #   @return [Symbol, Telnyx::Models::InterfaceStatus, nil]
+        optional :status, enum: -> { Telnyx::InterfaceStatus }
+
+        # @!attribute updated_at
+        #   ISO 8601 formatted date-time indicating when the resource was updated.
+        #
+        #   @return [String, nil]
+        optional :updated_at, String
+      end
+
+      # @!method initialize(id: nil, bandwidth_mbps: nil, bgp_asn: nil, cloud_provider: nil, cloud_provider_region: nil, created_at: nil, name: nil, network_id: nil, primary_bgp_key: nil, primary_cloud_account_id: nil, primary_cloud_ip: nil, primary_enabled: nil, primary_routing_announcement: nil, primary_telnyx_ip: nil, record_type: nil, region: nil, region_code: nil, status: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::VirtualCrossConnectCombined} for more details.
+      #
+      #   @param id [String] Identifies the resource.
+      #
+      #   @param bandwidth_mbps [Float] The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Conn
+      #
+      #   @param bgp_asn [Float] The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+      #
+      #   @param cloud_provider [Symbol, Telnyx::Models::VirtualCrossConnectCombined::CloudProvider] The Virtual Private Cloud with which you would like to establish a cross connect
+      #
+      #   @param cloud_provider_region [String] The region where your Virtual Private Cloud hosts are located.
+      #
+      #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
+      #
+      #   @param name [String] A user specified name for the interface.
+      #
+      #   @param network_id [String] The id of the network associated with the interface.
+      #
+      #   @param primary_bgp_key [String] The authentication key for BGP peer configuration.
+      #
+      #   @param primary_cloud_account_id [String] The identifier for your Virtual Private Cloud.
+      #
+      #   @param primary_cloud_ip [String] The IP address assigned for your side of the Virtual Cross Connect.
+      #
+      #   @param primary_enabled [Boolean] Indicates whether the primary circuit is enabled.
+      #
+      #   @param primary_routing_announcement [Boolean] Whether
+      #
+      #   @param primary_telnyx_ip [String] The IP address assigned to the Telnyx side of the Virtual Cross Connect.
+      #
+      #   @param record_type [String] Identifies the type of the resource.
+      #
+      #   @param region [Telnyx::Models::VirtualCrossConnectCombined::Region]
+      #
+      #   @param region_code [String] The region interface is deployed to.
+      #
+      #   @param status [Symbol, Telnyx::Models::InterfaceStatus] The current status of the interface deployment.
+      #
+      #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
+
+      # The Virtual Private Cloud with which you would like to establish a cross
+      # connect.
+      #
+      # @see Telnyx::Models::VirtualCrossConnectCombined#cloud_provider
+      module CloudProvider
+        extend Telnyx::Internal::Type::Enum
+
+        AWS = :aws
+        AZURE = :azure
+        GCE = :gce
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::VirtualCrossConnectCombined#region
+      class Region < Telnyx::Internal::Type::BaseModel
+        # @!attribute code
+        #   Region code of the interface.
+        #
+        #   @return [String, nil]
+        optional :code, String
+
+        # @!attribute name
+        #   Region name of the interface.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        response_only do
+          # @!attribute record_type
+          #   Identifies the type of the resource.
+          #
+          #   @return [String, nil]
+          optional :record_type, String
+        end
+
+        # @!method initialize(code: nil, name: nil, record_type: nil)
+        #   @param code [String] Region code of the interface.
+        #
+        #   @param name [String] Region name of the interface.
+        #
+        #   @param record_type [String] Identifies the type of the resource.
+      end
+    end
+  end
+end