Class: Telnyx::Models::FqdnConnections::FqdnConnectionsFqdnAuthentication

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/fqdn_connections/fqdn_authentication.rb,
sig/telnyx/models/fqdn_connections/fqdn_authentication.rbs

Defined Under Namespace

Modules: FqdnOutboundAuthentication, IPAuthenticationMethod

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(id: nil, connection_id: nil, failover_url: nil, fqdn_outbound_authentication: nil, ip_authentication_method: nil, microsoft_teams_sbc: nil, password: nil, record_type: nil, txt_name: nil, txt_ttl: nil, txt_value: nil, user_name: nil, webhook_url: nil) ⇒ Object

Parameters:

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

    Identifies the resource.

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

    The ID of the FQDN connection this authentication strategy belongs to.

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

    The failover webhook URL.

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

    The outbound authentication type.

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

    The IP authentication method.

  • microsoft_teams_sbc (Boolean) (defaults to: nil) —

    Whether the connection is a Microsoft Teams SBC.

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

    The password for authentication.

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

    Identifies the type of the resource.

  • 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.




# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 87

Instance Attribute Details

#connection_id ⇒ String?

The ID of the FQDN connection this authentication strategy belongs to.

Parameters:

  • (String)

Returns:

  • (String, nil) 


17
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 17

optional :connection_id, String

#failover_url ⇒ String?

The failover webhook URL.

Parameters:

  • (String)

Returns:

  • (String, nil) 


23
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 23

optional :failover_url, String

#fqdn_outbound_authentication ⇒ Symbol, ...

The outbound authentication type.

Returns:



29
30
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 29

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

#id ⇒ String?

Identifies the resource.

Parameters:

  • (String)

Returns:

  • (String, nil) 


11
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 11

optional :id, String

#ip_authentication_method ⇒ Symbol, ...

The IP authentication method.

Returns:



36
37
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 36

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

#microsoft_teams_sbc ⇒ Boolean?

Whether the connection is a Microsoft Teams SBC.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


43
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 43

optional :microsoft_teams_sbc, Telnyx::Internal::Type::Boolean

#password ⇒ String?

The password for authentication.

Parameters:

  • (String)

Returns:

  • (String, nil) 


49
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 49

optional :password, String

#record_type ⇒ String?

Identifies the type of the resource.

Parameters:

  • (String)

Returns:

  • (String, nil) 


55
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 55

optional :record_type, String

#txt_name ⇒ String?

The TXT record name for Microsoft Teams SBC DNS verification.

Parameters:

  • (String)

Returns:

  • (String, nil) 


61
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 61

optional :txt_name, String

#txt_ttl ⇒ Integer?

The TTL for the TXT record.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


67
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 67

optional :txt_ttl, Integer

#txt_value ⇒ String?

The TXT record value for Microsoft Teams SBC DNS verification.

Parameters:

  • (String)

Returns:

  • (String, nil) 


73
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 73

optional :txt_value, String

#user_name ⇒ String?

The username for authentication.

Parameters:

  • (String)

Returns:

  • (String, nil) 


79
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 79

optional :user_name, String

#webhook_url ⇒ String?

The webhook URL for authentication events.

Parameters:

  • (String)

Returns:

  • (String, nil) 


85
 
# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 85

optional :webhook_url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/fqdn_connections/fqdn_authentication.rb', line 123

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


94
 
# File 'sig/telnyx/models/fqdn_connections/fqdn_authentication.rbs', line 94

def to_hash: -> {