Class: Zernio::ListPhoneNumberCountries200ResponseCountriesInnerTypesInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_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 = {}) ⇒ ListPhoneNumberCountries200ResponseCountriesInnerTypesInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::ListPhoneNumberCountries200ResponseCountriesInnerTypesInner` 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::ListPhoneNumberCountries200ResponseCountriesInnerTypesInner`. 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?(:'number_type')
    self.number_type = attributes[:'number_type']
  end

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

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

  if attributes.key?(:'monthly_cents')
    self.monthly_cents = attributes[:'monthly_cents']
  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?(:'calls_available')
    self.calls_available = attributes[:'calls_available']
  end

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

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

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

Instance Attribute Details

#calls_available ⇒ Object

Returns the value of attribute calls_available.



33
34
35
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 33

def calls_available
  @calls_available
end

#fulfilment ⇒ Object

request: the carrier stocks this type nowhere and only sources it to order, so it is always a pre-order.



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

def fulfilment
  @fulfilment
end

#in_stock ⇒ Object

Returns the value of attribute in_stock.



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

def in_stock
  @in_stock
end

#monthly_cents ⇒ Object

Price a NEW number of this type costs per month, in cents.



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

def monthly_cents
  @monthly_cents
end

#needs_kyc ⇒ Object

Returns the value of attribute needs_kyc.



23
24
25
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 23

def needs_kyc
  @needs_kyc
end

#number_type ⇒ Object

Returns the value of attribute number_type.



18
19
20
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 18

def number_type
  @number_type
end

#pre_orderable ⇒ Object

Out of stock but orderable anyway. Submit KYC as usual (POST /v1/phone-numbers/kyc): we buy regular stock the moment it returns, otherwise the carrier sources the number. Usually 2 to 4 weeks, never guaranteed. Only document tiers (3/4) qualify, and nothing is billed until the number is active.



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

def pre_orderable
  @pre_orderable
end

#sms_available ⇒ Object

Returns the value of attribute sms_available.



31
32
33
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 31

def sms_available
  @sms_available
end

#tier ⇒ Object

Null on a fulfilment: request type, whose document tier is only known once its requirements are read.



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

def tier
  @tier
end

#whatsapp_available ⇒ Object

Always false for toll_free (WhatsApp does not reliably register toll-free numbers).



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

def whatsapp_available
  @whatsapp_available
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



82
83
84
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 82

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 87

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 66

def self.attribute_map
  {
    :'number_type' => :'numberType',
    :'tier' => :'tier',
    :'needs_kyc' => :'needsKyc',
    :'monthly_cents' => :'monthlyCents',
    :'whatsapp_available' => :'whatsappAvailable',
    :'sms_available' => :'smsAvailable',
    :'calls_available' => :'callsAvailable',
    :'in_stock' => :'inStock',
    :'fulfilment' => :'fulfilment',
    :'pre_orderable' => :'preOrderable'
  }
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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 254

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



108
109
110
111
112
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 108

def self.openapi_nullable
  Set.new([
    :'tier',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 92

def self.openapi_types
  {
    :'number_type' => :'String',
    :'tier' => :'Integer',
    :'needs_kyc' => :'Boolean',
    :'monthly_cents' => :'Integer',
    :'whatsapp_available' => :'Boolean',
    :'sms_available' => :'Boolean',
    :'calls_available' => :'Boolean',
    :'in_stock' => :'Boolean',
    :'fulfilment' => :'String',
    :'pre_orderable' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      number_type == o.number_type &&
      tier == o.tier &&
      needs_kyc == o.needs_kyc &&
      monthly_cents == o.monthly_cents &&
      whatsapp_available == o.whatsapp_available &&
      sms_available == o.sms_available &&
      calls_available == o.calls_available &&
      in_stock == o.in_stock &&
      fulfilment == o.fulfilment &&
      pre_orderable == o.pre_orderable
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 247

def hash
  [number_type, tier, needs_kyc, monthly_cents, whatsapp_available, sms_available, calls_available, in_stock, fulfilment, pre_orderable].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



173
174
175
176
177
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 173

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 276

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



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/zernio-sdk/models/list_phone_number_countries200_response_countries_inner_types_inner.rb', line 181

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  number_type_validator = EnumAttributeValidator.new('String', ["local", "mobile", "national", "toll_free"])
  return false unless number_type_validator.valid?(@number_type)
  tier_validator = EnumAttributeValidator.new('Integer', [1, 2, 3, 4])
  return false unless tier_validator.valid?(@tier)
  fulfilment_validator = EnumAttributeValidator.new('String', ["instant", "request"])
  return false unless fulfilment_validator.valid?(@fulfilment)
  true
end