Class: Zernio::CheckPhoneNumberAvailability200Response

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address_constraint ⇒ Object

Returns the value of attribute address_constraint.



28
29
30
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 28

def address_constraint
  @address_constraint
end

#area_options ⇒ Object

Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen ndc as areaCode on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area.



34
35
36
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 34

def area_options
  @area_options
end

#areas ⇒ Object

For geo only: the area(s) the registered address must be in.



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

def areas
  @areas
end

#available ⇒ Object

Whether deliverable voice inventory exists right now.



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

def available
  @available
end

#country ⇒ Object

Returns the value of attribute country.



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

def country
  @country
end

#number_type ⇒ Object

Returns the value of attribute number_type.



20
21
22
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 20

def number_type
  @number_type
end

#pre_orderable ⇒ Object

Nothing deliverable now, but this pair can be pre-ordered: submit KYC as usual and 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.



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

def pre_orderable
  @pre_orderable
end

#sold_out_areas ⇒ Object

Areas that had stock in the last 90 days and have none now. Pass one as areaCode with preOrder: true on the KYC submit when preOrderable is true, or watch it with POST /v1/phone-numbers/stock-watches.



37
38
39
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 37

def sold_out_areas
  @sold_out_areas
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 62

def self.attribute_map
  {
    :'country' => :'country',
    :'number_type' => :'numberType',
    :'available' => :'available',
    :'pre_orderable' => :'preOrderable',
    :'address_constraint' => :'addressConstraint',
    :'areas' => :'areas',
    :'area_options' => :'areaOptions',
    :'sold_out_areas' => :'soldOutAreas'
  }
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 217

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



100
101
102
103
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 86

def self.openapi_types
  {
    :'country' => :'String',
    :'number_type' => :'String',
    :'available' => :'Boolean',
    :'pre_orderable' => :'Boolean',
    :'address_constraint' => :'String',
    :'areas' => :'Array<String>',
    :'area_options' => :'Array<CheckPhoneNumberAvailability200ResponseAreaOptionsInner>',
    :'sold_out_areas' => :'Array<CheckPhoneNumberAvailability200ResponseSoldOutAreasInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      country == o.country &&
      number_type == o.number_type &&
      available == o.available &&
      pre_orderable == o.pre_orderable &&
      address_constraint == o.address_constraint &&
      areas == o.areas &&
      area_options == o.area_options &&
      sold_out_areas == o.sold_out_areas
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


204
205
206
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 210

def hash
  [country, number_type, available, pre_orderable, address_constraint, areas, area_options, sold_out_areas].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



162
163
164
165
166
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 162

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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 239

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



170
171
172
173
174
175
 
# File 'lib/zernio-sdk/models/check_phone_number_availability200_response.rb', line 170

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  address_constraint_validator = EnumAttributeValidator.new('String', ["geo", "country", "none"])
  return false unless address_constraint_validator.valid?(@address_constraint)
  true
end