Class: Zernio::ListPhoneNumbers200ResponseNumbersInner

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 161

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_id ⇒ Object

Returns the value of attribute _id.



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

def _id
  @_id
end

#calling_enabled ⇒ Object

Whether WhatsApp Business Calling is enabled on this number (manage via /v1/whatsapp/phone-numbers/id/calling).



60
61
62
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 60

def calling_enabled
  @calling_enabled
end

#country ⇒ Object

Returns the value of attribute country.



22
23
24
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 22

def country
  @country
end

#created_at ⇒ Object

Returns the value of attribute created_at.



62
63
64
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 62

def created_at
  @created_at
end

#end_user_first_name ⇒ Object

Returns the value of attribute end_user_first_name.



52
53
54
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 52

def end_user_first_name
  @end_user_first_name
end

#end_user_last_name ⇒ Object

Returns the value of attribute end_user_last_name.



54
55
56
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 54

def end_user_last_name
  @end_user_last_name
end

#hosted_by_zernio ⇒ Object

False for numbers you brought yourself (connected via Meta embedded signup) — they live on your own carrier, so SMS/Calls can't be enabled on them.



36
37
38
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 36

def hosted_by_zernio
  @hosted_by_zernio
end

#meta_preverified_id ⇒ Object

Returns the value of attribute meta_preverified_id.



45
46
47
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 45

def meta_preverified_id
  @meta_preverified_id
end

#meta_verification_status ⇒ Object

Returns the value of attribute meta_verification_status.



47
48
49
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 47

def meta_verification_status
  @meta_verification_status
end

#monthly_cents ⇒ Object

Per-country monthly price in cents ($2..$25).



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

def monthly_cents
  @monthly_cents
end

#onfido_verification_url ⇒ Object

For regulated (Tier 3/4) numbers with an Onfido ID-verification step — the link to forward to the end user. Set once the order is placed; null otherwise. Poll this field after submitting KYC.



50
51
52
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 50

def onfido_verification_url
  @onfido_verification_url
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



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

def phone_number
  @phone_number
end

#profile_id ⇒ Object

Returns the value of attribute profile_id.



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

def profile_id
  @profile_id
end

#provisioned_at ⇒ Object

Returns the value of attribute provisioned_at.



43
44
45
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 43

def provisioned_at
  @provisioned_at
end

#registrant_name ⇒ Object

For regulated numbers, who it's registered for (company or person) — set from the submitted KYC.



27
28
29
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 27

def registrant_name
  @registrant_name
end

#regulatory_decline_reason ⇒ Object

Reviewer rejection reason when status is regulatory_declined.



57
58
59
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 57

def regulatory_decline_reason
  @regulatory_decline_reason
end

#sip_trunk_id ⇒ Object

SIP trunk the number is attached to; null when not trunked. While attached, enabling Calls or WhatsApp calling, requesting WhatsApp verification, and releasing the number all return 409.



39
40
41
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 39

def sip_trunk_id
  @sip_trunk_id
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#telnyx_order_id ⇒ Object

Present once the number order has been placed (i.e. the requirement group was approved). Absent while still in identity review.



30
31
32
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 30

def telnyx_order_id
  @telnyx_order_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



117
118
119
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 117

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 87

def self.attribute_map
  {
    :'_id' => :'_id',
    :'phone_number' => :'phoneNumber',
    :'country' => :'country',
    :'status' => :'status',
    :'registrant_name' => :'registrantName',
    :'telnyx_order_id' => :'telnyxOrderId',
    :'monthly_cents' => :'monthlyCents',
    :'hosted_by_zernio' => :'hostedByZernio',
    :'sip_trunk_id' => :'sipTrunkId',
    :'profile_id' => :'profileId',
    :'provisioned_at' => :'provisionedAt',
    :'meta_preverified_id' => :'metaPreverifiedId',
    :'meta_verification_status' => :'metaVerificationStatus',
    :'onfido_verification_url' => :'onfidoVerificationUrl',
    :'end_user_first_name' => :'endUserFirstName',
    :'end_user_last_name' => :'endUserLastName',
    :'regulatory_decline_reason' => :'regulatoryDeclineReason',
    :'calling_enabled' => :'callingEnabled',
    :'created_at' => :'createdAt'
  }
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 320

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



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 147

def self.openapi_nullable
  Set.new([
    :'registrant_name',
    :'telnyx_order_id',
    :'sip_trunk_id',
    :'onfido_verification_url',
    :'end_user_first_name',
    :'end_user_last_name',
    :'regulatory_decline_reason',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 122

def self.openapi_types
  {
    :'_id' => :'String',
    :'phone_number' => :'String',
    :'country' => :'String',
    :'status' => :'String',
    :'registrant_name' => :'String',
    :'telnyx_order_id' => :'String',
    :'monthly_cents' => :'Integer',
    :'hosted_by_zernio' => :'Boolean',
    :'sip_trunk_id' => :'String',
    :'profile_id' => :'Object',
    :'provisioned_at' => :'Time',
    :'meta_preverified_id' => :'String',
    :'meta_verification_status' => :'String',
    :'onfido_verification_url' => :'String',
    :'end_user_first_name' => :'String',
    :'end_user_last_name' => :'String',
    :'regulatory_decline_reason' => :'String',
    :'calling_enabled' => :'Boolean',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 281

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _id == o._id &&
      phone_number == o.phone_number &&
      country == o.country &&
      status == o.status &&
      registrant_name == o.registrant_name &&
      telnyx_order_id == o.telnyx_order_id &&
      monthly_cents == o.monthly_cents &&
      hosted_by_zernio == o.hosted_by_zernio &&
      sip_trunk_id == o.sip_trunk_id &&
      profile_id == o.profile_id &&
      provisioned_at == o.provisioned_at &&
      meta_preverified_id == o.meta_preverified_id &&
      meta_verification_status == o.meta_verification_status &&
      onfido_verification_url == o.onfido_verification_url &&
      end_user_first_name == o.end_user_first_name &&
      end_user_last_name == o.end_user_last_name &&
      regulatory_decline_reason == o.regulatory_decline_reason &&
      calling_enabled == o.calling_enabled &&
      created_at == o.created_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


307
308
309
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 307

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



313
314
315
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 313

def hash
  [_id, phone_number, country, status, registrant_name, telnyx_order_id, monthly_cents, hosted_by_zernio, sip_trunk_id, profile_id, provisioned_at, meta_preverified_id, meta_verification_status, onfido_verification_url, end_user_first_name, end_user_last_name, regulatory_decline_reason, calling_enabled, created_at].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



254
255
256
257
258
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 254

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 342

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



262
263
264
265
266
267
 
# File 'lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb', line 262

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["pending_payment", "pending_regulatory", "regulatory_declined", "provisioning", "verifying", "active", "suspended", "releasing", "released"])
  return false unless status_validator.valid?(@status)
  true
end