Class: Telnyx::Models::PhoneNumber

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

Defined Under Namespace

Modules: PhoneNumberType, RequirementsStatus, Status

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, bundle_id: nil, country_code: nil, country_iso_alpha2: nil, phone_number: nil, phone_number_type: nil, record_type: nil, regulatory_requirements: nil, requirements_met: nil, requirements_status: nil, status: nil) ⇒ Object

Parameters:

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

    Country code of the phone number

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

    The ISO 3166-1 alpha-2 country code of the phone number.

  • phone_number (String) (defaults to: nil)
  • phone_number_type (Symbol, Telnyx::Models::PhoneNumber::PhoneNumberType) (defaults to: nil) —

    Phone number type

  • record_type (String) (defaults to: nil)
  • regulatory_requirements (Array<Telnyx::Models::SubNumberOrderRegulatoryRequirementWithValue>) (defaults to: nil)
  • requirements_met (Boolean) (defaults to: nil) —

    True if all requirements are met for a phone number, false otherwise.

  • requirements_status (Symbol, Telnyx::Models::PhoneNumber::RequirementsStatus) (defaults to: nil) —

    Status of document requirements (if applicable)

  • status (Symbol, Telnyx::Models::PhoneNumber::Status) (defaults to: nil) —

    The status of the phone number in the order.




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

Instance Attribute Details

#bundle_id ⇒ String? (readonly)

Returns the value of attribute bundle_id.

Returns:

  • (String, nil) 


33
34
35
 
# File 'sig/telnyx/models/phone_number.rbs', line 33

def bundle_id
  @bundle_id
end

#country_code ⇒ String? (readonly)

Returns the value of attribute country_code.

Returns:

  • (String, nil) 


37
38
39
 
# File 'sig/telnyx/models/phone_number.rbs', line 37

def country_code
  @country_code
end

#country_iso_alpha2 ⇒ String? (readonly)

Returns the value of attribute country_iso_alpha2.

Returns:

  • (String, nil) 


41
42
43
 
# File 'sig/telnyx/models/phone_number.rbs', line 41

def country_iso_alpha2
  @country_iso_alpha2
end

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


29
30
31
 
# File 'sig/telnyx/models/phone_number.rbs', line 29

def id
  @id
end

#phone_number ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


9
 
# File 'lib/telnyx/models/phone_number.rb', line 9

optional :phone_number, String

#phone_number_type ⇒ Telnyx::Models::PhoneNumber::phone_number_type? (readonly)

Returns the value of attribute phone_number_type.

Returns:

  • (Telnyx::Models::PhoneNumber::phone_number_type, nil) 


45
46
47
 
# File 'sig/telnyx/models/phone_number.rbs', line 45

def phone_number_type
  @phone_number_type
end

#record_type ⇒ String? (readonly)

Returns the value of attribute record_type.

Returns:

  • (String, nil) 


51
52
53
 
# File 'sig/telnyx/models/phone_number.rbs', line 51

def record_type
  @record_type
end

#regulatory_requirements ⇒ Array<Telnyx::Models::SubNumberOrderRegulatoryRequirementWithValue>?

Returns:



14
15
 
# File 'lib/telnyx/models/phone_number.rb', line 14

optional :regulatory_requirements,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::SubNumberOrderRegulatoryRequirementWithValue] }

#requirements_met ⇒ Boolean? (readonly)

Returns the value of attribute requirements_met.

Returns:

  • (Boolean, nil) 


55
56
57
 
# File 'sig/telnyx/models/phone_number.rbs', line 55

def requirements_met
  @requirements_met
end

#requirements_status ⇒ Telnyx::Models::PhoneNumber::requirements_status? (readonly)

Returns the value of attribute requirements_status.

Returns:

  • (Telnyx::Models::PhoneNumber::requirements_status, nil) 


59
60
61
 
# File 'sig/telnyx/models/phone_number.rbs', line 59

def requirements_status
  @requirements_status
end

#status ⇒ Telnyx::Models::PhoneNumber::status? (readonly)

Returns the value of attribute status.

Returns:

  • (Telnyx::Models::PhoneNumber::status, nil) 


65
66
67
 
# File 'sig/telnyx/models/phone_number.rbs', line 65

def status
  @status
end

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/phone_number.rb', line 105

Instance Method Details

#bundle_id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


35
 
# File 'sig/telnyx/models/phone_number.rbs', line 35

def bundle_id=: (String) -> String

#country_code= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


39
 
# File 'sig/telnyx/models/phone_number.rbs', line 39

def country_code=: (String) -> String

#country_iso_alpha2= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


43
 
# File 'sig/telnyx/models/phone_number.rbs', line 43

def country_iso_alpha2=: (String) -> String

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


31
 
# File 'sig/telnyx/models/phone_number.rbs', line 31

def id=: (String) -> String

#phone_number_type= ⇒ Object (readonly) 



47
 
# File 'sig/telnyx/models/phone_number.rbs', line 47

def phone_number_type=: (

#record_type= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


53
 
# File 'sig/telnyx/models/phone_number.rbs', line 53

def record_type=: (String) -> String

#requirements_met= ⇒ Boolean (readonly)

Parameters:

  • (Boolean)

Returns:

  • (Boolean) 


57
 
# File 'sig/telnyx/models/phone_number.rbs', line 57

def requirements_met=: (bool) -> bool

#requirements_status= ⇒ Object (readonly) 



61
 
# File 'sig/telnyx/models/phone_number.rbs', line 61

def requirements_status=: (

#status= ⇒ Object (readonly) 



67
 
# File 'sig/telnyx/models/phone_number.rbs', line 67

def status=: (

#to_hash ⇒ {

Returns:

  • ({) 


85
 
# File 'sig/telnyx/models/phone_number.rbs', line 85

def to_hash: -> {