Class: Zernio::ListPhoneNumberCountries200ResponseCountriesInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ListPhoneNumberCountries200ResponseCountriesInner

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 118

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::ListPhoneNumberCountries200ResponseCountriesInner` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::ListPhoneNumberCountries200ResponseCountriesInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'code')
    self.code = attributes[:'code']
  end

  if attributes.key?(:'tier')
    self.tier = attributes[:'tier']
  end

  if attributes.key?(:'monthly_cents')
    self.monthly_cents = attributes[:'monthly_cents']
  end

  if attributes.key?(:'needs_kyc')
    self.needs_kyc = attributes[:'needs_kyc']
  end

  if attributes.key?(:'calls_available')
    self.calls_available = attributes[:'calls_available']
  end

  if attributes.key?(:'whatsapp_available')
    self.whatsapp_available = attributes[:'whatsapp_available']
  end

  if attributes.key?(:'sms_available')
    self.sms_available = attributes[:'sms_available']
  end

  if attributes.key?(:'outbound_calling_available')
    self.outbound_calling_available = attributes[:'outbound_calling_available']
  end

  if attributes.key?(:'in_stock')
    self.in_stock = attributes[:'in_stock']
  end

  if attributes.key?(:'types')
    if (value = attributes[:'types']).is_a?(Array)
      self.types = value
    end
  end
end

Instance Attribute Details

#calls_available ⇒ Object

Regular phone (PSTN) calling on the number, inbound + outbound. Available on every offerable country.



29
30
31
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 29

def calls_available
  @calls_available
end

#code ⇒ Object

ISO 3166-1 alpha-2



19
20
21
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 19

def code
  @code
end

#in_stock ⇒ Object

Live carrier-stock snapshot (refreshed every 6h + on availability checks): false when NO offered type currently has deliverable inventory, so a purchase would fail. Treat as advisory; the purchase itself re-checks.



41
42
43
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 41

def in_stock
  @in_stock
end

#monthly_cents ⇒ Object

Price a NEW number in this country costs per month, in cents, for the default (first) type. 1.5x the carrier's monthly cost, rounded up to a whole dollar, minimum $3.



24
25
26
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 24

def monthly_cents
  @monthly_cents
end

#needs_kyc ⇒ Object

Returns the value of attribute needs_kyc.



26
27
28
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 26

def needs_kyc
  @needs_kyc
end

#outbound_calling_available ⇒ Object

WhatsApp Business Calling (BIC) outbound availability, a Meta feature blocked in some countries. NOT the PSTN Calls feature (callsAvailable).



38
39
40
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 38

def outbound_calling_available
  @outbound_calling_available
end

#sms_available ⇒ Object

Whether this country's number type can do SMS. Use it to filter the picker when the buyer wants SMS (pair with wantsSms on purchase).



35
36
37
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 35

def sms_available
  @sms_available
end

#tier ⇒ Object

Returns the value of attribute tier.



21
22
23
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 21

def tier
  @tier
end

#types ⇒ Object

Every number type offered in this country (default first). Capabilities, KYC tier, monthly price, and stock are per type. The country-level fields above mirror the first (default) entry. Pass the chosen numberType to POST /v1/phone-numbers/purchase.



44
45
46
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 44

def types
  @types
end

#whatsapp_available ⇒ Object

WhatsApp can be enabled on numbers from this country.



32
33
34
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 32

def whatsapp_available
  @whatsapp_available
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



85
86
87
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 85

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 90

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 69

def self.attribute_map
  {
    :'code' => :'code',
    :'tier' => :'tier',
    :'monthly_cents' => :'monthlyCents',
    :'needs_kyc' => :'needsKyc',
    :'calls_available' => :'callsAvailable',
    :'whatsapp_available' => :'whatsappAvailable',
    :'sms_available' => :'smsAvailable',
    :'outbound_calling_available' => :'outboundCallingAvailable',
    :'in_stock' => :'inStock',
    :'types' => :'types'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 234

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 111

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 95

def self.openapi_types
  {
    :'code' => :'String',
    :'tier' => :'Integer',
    :'monthly_cents' => :'Integer',
    :'needs_kyc' => :'Boolean',
    :'calls_available' => :'Boolean',
    :'whatsapp_available' => :'Boolean',
    :'sms_available' => :'Boolean',
    :'outbound_calling_available' => :'Boolean',
    :'in_stock' => :'Boolean',
    :'types' => :'Array<ListPhoneNumberCountries200ResponseCountriesInnerTypesInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      tier == o.tier &&
      monthly_cents == o.monthly_cents &&
      needs_kyc == o.needs_kyc &&
      calls_available == o.calls_available &&
      whatsapp_available == o.whatsapp_available &&
      sms_available == o.sms_available &&
      outbound_calling_available == o.outbound_calling_available &&
      in_stock == o.in_stock &&
      types == o.types
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


221
222
223
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



227
228
229
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 227

def hash
  [code, tier, monthly_cents, needs_kyc, calls_available, whatsapp_available, sms_available, outbound_calling_available, in_stock, types].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



177
178
179
180
181
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 177

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 256

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



185
186
187
188
189
190
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner.rb', line 185

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  tier_validator = EnumAttributeValidator.new('Integer', [1, 2, 3, 4])
  return false unless tier_validator.valid?(@tier)
  true
end