Class: Telnyx::Models::InventoryCoverageListResponse::Data

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

Defined Under Namespace

Modules: CoverageType, NumberType, 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(administrative_area: nil, advance_requirements: nil, count: nil, coverage_type: nil, group: nil, group_type: nil, number_range: nil, number_type: nil, phone_number_type: nil, record_type: nil) ⇒ Object

Parameters:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/telnyx/models/inventory_coverage_list_response.rb', line 22

class Data < Telnyx::Internal::Type::BaseModel
  # @!attribute administrative_area
  #
  #   @return [String, nil]
  optional :administrative_area, String

  # @!attribute advance_requirements
  #   Indicates if the phone number requires advance requirements.
  #
  #   @return [Boolean, nil]
  optional :advance_requirements, Telnyx::Internal::Type::Boolean

  # @!attribute count
  #
  #   @return [Integer, nil]
  optional :count, Integer

  # @!attribute coverage_type
  #
  #   @return [Symbol, Telnyx::Models::InventoryCoverageListResponse::Data::CoverageType, nil]
  optional :coverage_type, enum: -> { Telnyx::Models::InventoryCoverageListResponse::Data::CoverageType }

  # @!attribute group
  #
  #   @return [String, nil]
  optional :group, String

  # @!attribute group_type
  #
  #   @return [String, nil]
  optional :group_type, String

  # @!attribute number_range
  #
  #   @return [Integer, nil]
  optional :number_range, Integer

  # @!attribute number_type
  #
  #   @return [Symbol, Telnyx::Models::InventoryCoverageListResponse::Data::NumberType, nil]
  optional :number_type, enum: -> { Telnyx::Models::InventoryCoverageListResponse::Data::NumberType }

  # @!attribute phone_number_type
  #
  #   @return [Symbol, Telnyx::Models::InventoryCoverageListResponse::Data::PhoneNumberType, nil]
  optional :phone_number_type,
           enum: -> { Telnyx::Models::InventoryCoverageListResponse::Data::PhoneNumberType }

  # @!attribute record_type
  #
  #   @return [String, nil]
  optional :record_type, String

  # @!method initialize(administrative_area: nil, advance_requirements: nil, count: nil, coverage_type: nil, group: nil, group_type: nil, number_range: nil, number_type: nil, phone_number_type: nil, record_type: nil)
  #   @param administrative_area [String]
  #
  #   @param advance_requirements [Boolean] Indicates if the phone number requires advance requirements.
  #
  #   @param count [Integer]
  #
  #   @param coverage_type [Symbol, Telnyx::Models::InventoryCoverageListResponse::Data::CoverageType]
  #
  #   @param group [String]
  #
  #   @param group_type [String]
  #
  #   @param number_range [Integer]
  #
  #   @param number_type [Symbol, Telnyx::Models::InventoryCoverageListResponse::Data::NumberType]
  #
  #   @param phone_number_type [Symbol, Telnyx::Models::InventoryCoverageListResponse::Data::PhoneNumberType]
  #
  #   @param record_type [String]

  # @see Telnyx::Models::InventoryCoverageListResponse::Data#coverage_type
  module CoverageType
    extend Telnyx::Internal::Type::Enum

    NUMBER = :number
    BLOCK = :block

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Telnyx::Models::InventoryCoverageListResponse::Data#number_type
  module NumberType
    extend Telnyx::Internal::Type::Enum

    DID = :did
    TOLL_FREE = :"toll-free"

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Telnyx::Models::InventoryCoverageListResponse::Data#phone_number_type
  module PhoneNumberType
    extend Telnyx::Internal::Type::Enum

    LOCAL = :local
    TOLL_FREE = :toll_free
    NATIONAL = :national
    LANDLINE = :landline
    SHARED_COST = :shared_cost
    MOBILE = :mobile

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#administrative_area ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


26
 
# File 'lib/telnyx/models/inventory_coverage_list_response.rb', line 26

optional :administrative_area, String

#advance_requirements ⇒ Boolean?

Indicates if the phone number requires advance requirements.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


32
 
# File 'lib/telnyx/models/inventory_coverage_list_response.rb', line 32

optional :advance_requirements, Telnyx::Internal::Type::Boolean

#count ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


37
 
# File 'lib/telnyx/models/inventory_coverage_list_response.rb', line 37

optional :count, Integer

#coverage_type ⇒ Symbol, ...

Returns:



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

optional :coverage_type, enum: -> { Telnyx::Models::InventoryCoverageListResponse::Data::CoverageType }

#group ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


47
 
# File 'lib/telnyx/models/inventory_coverage_list_response.rb', line 47

optional :group, String

#group_type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :group_type, String

#number_range ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


57
 
# File 'lib/telnyx/models/inventory_coverage_list_response.rb', line 57

optional :number_range, Integer

#number_type ⇒ Symbol, ...

Returns:



62
 
# File 'lib/telnyx/models/inventory_coverage_list_response.rb', line 62

optional :number_type, enum: -> { Telnyx::Models::InventoryCoverageListResponse::Data::NumberType }

#phone_number_type ⇒ Symbol, ...

Returns:



67
68
 
# File 'lib/telnyx/models/inventory_coverage_list_response.rb', line 67

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

#record_type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :record_type, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/inventory_coverage_list_response.rb', line 103

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


106
 
# File 'sig/telnyx/models/inventory_coverage_list_response.rbs', line 106

def to_hash: -> {