Class: Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb,
sig/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rbs

Overview

See Also:

  • Telnyx::Resources::FqdnConnections::FqdnAuthentication#patch_all

Defined Under Namespace

Modules: FqdnOutboundAuthentication, IPAuthenticationMethod

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(fqdn_connection_id:, failover_url: nil, fqdn_outbound_authentication: nil, ip_authentication_method: nil, password: nil, txt_name: nil, txt_ttl: nil, txt_value: nil, user_name: nil, webhook_url: nil, request_options: {}) ⇒ Object

Parameters:

  • fqdn_connection_id (String)
  • failover_url (String) (defaults to: nil) —

    The failover webhook URL.

  • fqdn_outbound_authentication (Symbol, Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllParams::FqdnOutboundAuthentication) (defaults to: nil) —

    The outbound authentication type.

  • ip_authentication_method (Symbol, Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllParams::IPAuthenticationMethod) (defaults to: nil) —

    The IP authentication method.

  • password (String) (defaults to: nil) —

    The password for authentication.

  • txt_name (String) (defaults to: nil) —

    The TXT record name for Microsoft Teams SBC DNS verification.

  • txt_ttl (Integer) (defaults to: nil) —

    The TTL for the TXT record.

  • txt_value (String) (defaults to: nil) —

    The TXT record value for Microsoft Teams SBC DNS verification.

  • user_name (String) (defaults to: nil) —

    The username for authentication.

  • webhook_url (String) (defaults to: nil) —

    The webhook URL for authentication events.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 72

Instance Attribute Details

#failover_url ⇒ String?

The failover webhook URL.

Parameters:

  • (String)

Returns:

  • (String, nil) 


20
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 20

optional :failover_url, String

#fqdn_connection_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 14

required :fqdn_connection_id, String

#fqdn_outbound_authentication ⇒ Symbol, ...

The outbound authentication type.

Returns:



26
27
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 26

optional :fqdn_outbound_authentication,
enum: -> { Telnyx::FqdnConnections::FqdnAuthenticationPatchAllParams::FqdnOutboundAuthentication }

#ip_authentication_method ⇒ Symbol, ...

The IP authentication method.

Returns:



33
34
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 33

optional :ip_authentication_method,
enum: -> { Telnyx::FqdnConnections::FqdnAuthenticationPatchAllParams::IPAuthenticationMethod }

#password ⇒ String?

The password for authentication.

Parameters:

  • (String)

Returns:

  • (String, nil) 


40
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 40

optional :password, String

#txt_name ⇒ String?

The TXT record name for Microsoft Teams SBC DNS verification.

Parameters:

  • (String)

Returns:

  • (String, nil) 


46
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 46

optional :txt_name, String

#txt_ttl ⇒ Integer?

The TTL for the TXT record.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


52
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 52

optional :txt_ttl, Integer

#txt_value ⇒ String?

The TXT record value for Microsoft Teams SBC DNS verification.

Parameters:

  • (String)

Returns:

  • (String, nil) 


58
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 58

optional :txt_value, String

#user_name ⇒ String?

The username for authentication.

Parameters:

  • (String)

Returns:

  • (String, nil) 


64
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 64

optional :user_name, String

#webhook_url ⇒ String?

The webhook URL for authentication events.

Parameters:

  • (String)

Returns:

  • (String, nil) 


70
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 70

optional :webhook_url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb', line 102

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


79
 
# File 'sig/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rbs', line 79

def to_hash: -> {