Class: Telnyx::Models::RequirementRetrieveResponse::Data

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

Overview

See Also:

Defined Under Namespace

Modules: Action, PhoneNumberType

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, action: nil, country_code: nil, created_at: nil, locality: nil, phone_number_type: nil, record_type: nil, requirements_types: nil, updated_at: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::RequirementRetrieveResponse::Data for more details.

Parameters:

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

    Identifies the associated document

  • action (Symbol, Telnyx::Models::RequirementRetrieveResponse::Data::Action) (defaults to: nil) —

    Indicates whether this requirement applies to branded_calling, ordering, porting

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

    The 2-character (ISO 3166-1 alpha-2) country code where this requirement applies

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

    ISO 8601 formatted date-time indicating when the resource was created.

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

    The locality where this requirement applies

  • phone_number_type (Symbol, Telnyx::Models::RequirementRetrieveResponse::Data::PhoneNumberType) (defaults to: nil) —

    Indicates the phone_number_type this requirement applies to. Leave blank if this

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

    Identifies the type of the resource.

  • requirements_types (Array<Telnyx::Models::DocReqsRequirementType>) (defaults to: nil) —

    Lists the requirement types necessary to fulfill this requirement

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

    ISO 8601 formatted date-time indicating when the resource was last updated.




# File 'lib/telnyx/models/requirement_retrieve_response.rb', line 76

Instance Attribute Details

#action ⇒ Symbol, ...

Indicates whether this requirement applies to branded_calling, ordering, porting, or both ordering and porting

Returns:



22
 
# File 'lib/telnyx/models/requirement_retrieve_response.rb', line 22

optional :action, enum: -> { Telnyx::Models::RequirementRetrieveResponse::Data::Action }

#country_code ⇒ String?

The 2-character (ISO 3166-1 alpha-2) country code where this requirement applies

Returns:

  • (String, nil) 


28
 
# File 'lib/telnyx/models/requirement_retrieve_response.rb', line 28

optional :country_code, String

#locality ⇒ String?

The locality where this requirement applies

Returns:

  • (String, nil) 


34
 
# File 'lib/telnyx/models/requirement_retrieve_response.rb', line 34

optional :locality, String

#phone_number_type ⇒ Symbol, ...

Indicates the phone_number_type this requirement applies to. Leave blank if this requirement applies to all number_types.

Returns:



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

optional :phone_number_type,
enum: -> { Telnyx::Models::RequirementRetrieveResponse::Data::PhoneNumberType }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/requirement_retrieve_response.rb', line 110