Class: Telnyx::Models::SipRegistrationStatusRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/sip_registration_status_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Modules: CredentialType, SipRegistrationStatus Classes: SipRegistrationDetails

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(auth_retries: nil, expires: nil, failures: nil, next_action_at: nil, sip_uri_user_host: nil, uptime: nil) ⇒ Object

Detailed registration information reported by the registrar.

Parameters:

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

    Number of authentication retries on the last attempt.

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

    Unix timestamp when the current registration expires.

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

    Count of consecutive registration failures.

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

    Unix timestamp of the next scheduled registration action.

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

    SIP URI user@host of the registered contact.

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

    Registration uptime reported by the registrar.




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

Instance Attribute Details

#connection_id ⇒ String?

Identifier of the UAC connection.

Returns:

  • (String, nil) 


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

optional :connection_id, String

#connection_name ⇒ String?

Human-readable connection name.

Returns:

  • (String, nil) 


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

optional :connection_name, String

#credential_type ⇒ Symbol, ...

The credential type that was looked up.

Returns:



23
24
 
# File 'lib/telnyx/models/sip_registration_status_retrieve_response.rb', line 23

optional :credential_type,
enum: -> { Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType }

#credential_username ⇒ String?

SIP username used for the registration.

Returns:

  • (String, nil) 


30
 
# File 'lib/telnyx/models/sip_registration_status_retrieve_response.rb', line 30

optional :credential_username, String

#last_registration_response ⇒ String?

SIP response from the last registration attempt.

Returns:

  • (String, nil) 


36
 
# File 'lib/telnyx/models/sip_registration_status_retrieve_response.rb', line 36

optional :last_registration_response, String

#registered ⇒ Boolean?

True if the endpoint is currently registered.

Returns:

  • (Boolean, nil) 


42
 
# File 'lib/telnyx/models/sip_registration_status_retrieve_response.rb', line 42

optional :registered, Telnyx::Internal::Type::Boolean

#sip_registration_details ⇒ Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails?

Detailed registration information reported by the registrar.

Returns:



48
49
 
# File 'lib/telnyx/models/sip_registration_status_retrieve_response.rb', line 48

optional :sip_registration_details,
-> { Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails }

#sip_registration_status ⇒ Symbol, ...

Human-readable registration status derived from the registrar state.

Returns:



55
56
 
# File 'lib/telnyx/models/sip_registration_status_retrieve_response.rb', line 55

optional :sip_registration_status,
enum: -> { Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/sip_registration_status_retrieve_response.rb', line 83