Class: Telnyx::Models::CountryCoverageRetrieveResponse::Data

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

Defined Under Namespace

Classes: Local, TollFree

Instance Attribute 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(features: nil, full_pstn_replacement: nil, international_sms: nil, p2p: nil, quickship: nil, reservable: nil) ⇒ Object

Parameters:

  • features (Array<String>) (defaults to: nil)
  • full_pstn_replacement (Boolean) (defaults to: nil)
  • international_sms (Boolean) (defaults to: nil)
  • p2p (Boolean) (defaults to: nil)
  • quickship (Boolean) (defaults to: nil)
  • reservable (Boolean) (defaults to: nil) 


16
17
18
19
20
21
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 16

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

  # @!attribute features
  #   Set of features supported
  #
  #   @return [Array<String>, nil]
  optional :features, Telnyx::Internal::Type::ArrayOf[String]

  # @!attribute international_sms
  #
  #   @return [Boolean, nil]
  optional :international_sms, Telnyx::Internal::Type::Boolean

  # @!attribute inventory_coverage
  #   Indicates whether country can be queried with inventory coverage endpoint
  #
  #   @return [Boolean, nil]
  optional :inventory_coverage, Telnyx::Internal::Type::Boolean

  # @!attribute local
  #
  #   @return [Telnyx::Models::CountryCoverageRetrieveResponse::Data::Local, nil]
  optional :local, -> { Telnyx::Models::CountryCoverageRetrieveResponse::Data::Local }

  # @!attribute mobile
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :mobile, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

  # @!attribute national
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :national, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

  # @!attribute numbers
  #
  #   @return [Boolean, nil]
  optional :numbers, Telnyx::Internal::Type::Boolean

  # @!attribute p2p
  #
  #   @return [Boolean, nil]
  optional :p2p, Telnyx::Internal::Type::Boolean

  # @!attribute phone_number_type
  #   Phone number type
  #
  #   @return [Array<String>, nil]
  optional :phone_number_type, Telnyx::Internal::Type::ArrayOf[String]

  # @!attribute quickship
  #   Supports quickship
  #
  #   @return [Boolean, nil]
  optional :quickship, Telnyx::Internal::Type::Boolean

  # @!attribute region
  #   Geographic region (e.g., AMER, EMEA, APAC)
  #
  #   @return [String, nil]
  optional :region, String, nil?: true

  # @!attribute reservable
  #   Supports reservable
  #
  #   @return [Boolean, nil]
  optional :reservable, Telnyx::Internal::Type::Boolean

  # @!attribute shared_cost
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :shared_cost, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

  # @!attribute toll_free
  #
  #   @return [Telnyx::Models::CountryCoverageRetrieveResponse::Data::TollFree, nil]
  optional :toll_free, -> { Telnyx::Models::CountryCoverageRetrieveResponse::Data::TollFree }

  # @!method initialize(code: nil, features: nil, international_sms: nil, inventory_coverage: nil, local: nil, mobile: nil, national: nil, numbers: nil, p2p: nil, phone_number_type: nil, quickship: nil, region: nil, reservable: nil, shared_cost: nil, toll_free: nil)
  #   @param code [String] Country ISO code
  #
  #   @param features [Array<String>] Set of features supported
  #
  #   @param international_sms [Boolean]
  #
  #   @param inventory_coverage [Boolean] Indicates whether country can be queried with inventory coverage endpoint
  #
  #   @param local [Telnyx::Models::CountryCoverageRetrieveResponse::Data::Local]
  #
  #   @param mobile [Hash{Symbol=>Object}]
  #
  #   @param national [Hash{Symbol=>Object}]
  #
  #   @param numbers [Boolean]
  #
  #   @param p2p [Boolean]
  #
  #   @param phone_number_type [Array<String>] Phone number type
  #
  #   @param quickship [Boolean] Supports quickship
  #
  #   @param region [String, nil] Geographic region (e.g., AMER, EMEA, APAC)
  #
  #   @param reservable [Boolean] Supports reservable
  #
  #   @param shared_cost [Hash{Symbol=>Object}]
  #
  #   @param toll_free [Telnyx::Models::CountryCoverageRetrieveResponse::Data::TollFree]

  # @see Telnyx::Models::CountryCoverageRetrieveResponse::Data#local
  class Local < Telnyx::Internal::Type::BaseModel
    # @!attribute features
    #
    #   @return [Array<String>, nil]
    optional :features, Telnyx::Internal::Type::ArrayOf[String]

    # @!attribute full_pstn_replacement
    #
    #   @return [Boolean, nil]
    optional :full_pstn_replacement, Telnyx::Internal::Type::Boolean

    # @!attribute international_sms
    #
    #   @return [Boolean, nil]
    optional :international_sms, Telnyx::Internal::Type::Boolean

    # @!attribute p2p
    #
    #   @return [Boolean, nil]
    optional :p2p, Telnyx::Internal::Type::Boolean

    # @!attribute quickship
    #
    #   @return [Boolean, nil]
    optional :quickship, Telnyx::Internal::Type::Boolean

    # @!attribute reservable
    #
    #   @return [Boolean, nil]
    optional :reservable, Telnyx::Internal::Type::Boolean

    # @!method initialize(features: nil, full_pstn_replacement: nil, international_sms: nil, p2p: nil, quickship: nil, reservable: nil)
    #   @param features [Array<String>]
    #   @param full_pstn_replacement [Boolean]
    #   @param international_sms [Boolean]
    #   @param p2p [Boolean]
    #   @param quickship [Boolean]
    #   @param reservable [Boolean]
  end

  # @see Telnyx::Models::CountryCoverageRetrieveResponse::Data#toll_free
  class TollFree < Telnyx::Internal::Type::BaseModel
    # @!attribute features
    #
    #   @return [Array<String>, nil]
    optional :features, Telnyx::Internal::Type::ArrayOf[String]

    # @!attribute full_pstn_replacement
    #
    #   @return [Boolean, nil]
    optional :full_pstn_replacement, Telnyx::Internal::Type::Boolean

    # @!attribute international_sms
    #
    #   @return [Boolean, nil]
    optional :international_sms, Telnyx::Internal::Type::Boolean

    # @!attribute p2p
    #
    #   @return [Boolean, nil]
    optional :p2p, Telnyx::Internal::Type::Boolean

    # @!attribute quickship
    #
    #   @return [Boolean, nil]
    optional :quickship, Telnyx::Internal::Type::Boolean

    # @!attribute reservable
    #
    #   @return [Boolean, nil]
    optional :reservable, Telnyx::Internal::Type::Boolean

    # @!method initialize(features: nil, full_pstn_replacement: nil, international_sms: nil, p2p: nil, quickship: nil, reservable: nil)
    #   @param features [Array<String>]
    #   @param full_pstn_replacement [Boolean]
    #   @param international_sms [Boolean]
    #   @param p2p [Boolean]
    #   @param quickship [Boolean]
    #   @param reservable [Boolean]
  end
end

Instance Attribute Details

#code ⇒ String?

Country ISO code

Returns:

  • (String, nil) 


21
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 21

optional :code, String

#features ⇒ Array<String>?

Set of features supported

Returns:

  • (Array<String>, nil) 


27
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 27

optional :features, Telnyx::Internal::Type::ArrayOf[String]

#international_sms ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

optional :international_sms, Telnyx::Internal::Type::Boolean

#inventory_coverage ⇒ Boolean?

Indicates whether country can be queried with inventory coverage endpoint

Returns:

  • (Boolean, nil) 


38
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 38

optional :inventory_coverage, Telnyx::Internal::Type::Boolean

#local ⇒ Telnyx::Models::CountryCoverageRetrieveResponse::Data::Local?

Returns:



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

optional :local, -> { Telnyx::Models::CountryCoverageRetrieveResponse::Data::Local }

#mobile ⇒ Hash{Symbol=>Object}?

Returns:

  • (Hash{Symbol=>Object}, nil) 


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

optional :mobile, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#national ⇒ Hash{Symbol=>Object}?

Returns:

  • (Hash{Symbol=>Object}, nil) 


53
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 53

optional :national, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#numbers ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

optional :numbers, Telnyx::Internal::Type::Boolean

#p2p ⇒ Boolean?

Returns:

  • (Boolean, nil) 


63
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 63

optional :p2p, Telnyx::Internal::Type::Boolean

#phone_number_type ⇒ Array<String>?

Phone number type

Returns:

  • (Array<String>, nil) 


69
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 69

optional :phone_number_type, Telnyx::Internal::Type::ArrayOf[String]

#quickship ⇒ Boolean?

Supports quickship

Returns:

  • (Boolean, nil) 


75
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 75

optional :quickship, Telnyx::Internal::Type::Boolean

#region ⇒ String?

Geographic region (e.g., AMER, EMEA, APAC)

Returns:

  • (String, nil) 


81
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 81

optional :region, String, nil?: true

#reservable ⇒ Boolean?

Supports reservable

Returns:

  • (Boolean, nil) 


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

optional :reservable, Telnyx::Internal::Type::Boolean

#shared_cost ⇒ Hash{Symbol=>Object}?

Returns:

  • (Hash{Symbol=>Object}, nil) 


92
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 92

optional :shared_cost, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#toll_free ⇒ Telnyx::Models::CountryCoverageRetrieveResponse::Data::TollFree?

Returns:



97
 
# File 'lib/telnyx/models/country_coverage_retrieve_response.rb', line 97

optional :toll_free, -> { Telnyx::Models::CountryCoverageRetrieveResponse::Data::TollFree }