Class: Zernio::SubmitPhoneNumberKycRequest

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/submit_phone_number_kyc_request.rb

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 = {}) ⇒ SubmitPhoneNumberKycRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  if attributes.key?(:'quantity')
    self.quantity = attributes[:'quantity']
  else
    self.quantity = 1
  end

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

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

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

  if attributes.key?(:'area_code')
    self.area_code = attributes[:'area_code']
  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?(:'values')
    if (value = attributes[:'values']).is_a?(Hash)
      self.values = value
    end
  end

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#area_code ⇒ Object

Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.



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

def area_code
  @area_code
end

#country ⇒ Object

Returns the value of attribute country.



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

def country
  @country
end

#documents ⇒ Object

One per document requirement. Each is EITHER inline base64 OR a documentId returned by POST /v1/phone-numbers/kyc/upload-document (use the upload endpoint for large files to stay under the request-size limit).



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

def documents
  @documents
end

#end_user_first_name ⇒ Object

End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.



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

def end_user_first_name
  @end_user_first_name
end

#end_user_last_name ⇒ Object

End user's legal last name. Same condition as endUserFirstName.



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

def end_user_last_name
  @end_user_last_name
end

#profile_id ⇒ Object

Returns the value of attribute profile_id.



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

def profile_id
  @profile_id
end

#quantity ⇒ Object

Provision several same-country numbers from one submission (1-5). The single verification covers all of them; each number is billed only when it activates. Numbers that fail to order are skipped (best-effort).



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

def quantity
  @quantity
end

#reuse ⇒ Object

Reuse a prior approved verification for this country (skips document/field collection; places the order immediately).



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

def reuse
  @reuse
end

#reuse_from ⇒ Object

Legacy fallback for reuseOptionId: the source phone number (GET reusable.options.fromPhoneNumber). Ambiguous when a number labels two verifications — prefer reuseOptionId. Omitted = the approved default. No match = 409.



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

def reuse_from
  @reuse_from
end

#reuse_option_id ⇒ Object

Which reusable verification to use (GET reusable.options.id). The unambiguous selection key. Omitted = the approved default. No match = 409.



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

def reuse_option_id
  @reuse_option_id
end

#submission_id ⇒ Object

Idempotency token for this submission attempt. A retry/double-submit with the same token returns the same number; omit and each call creates a new number.



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

def submission_id
  @submission_id
end

#values ⇒ Object

requirementId → textual value



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

def values
  @values
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



74
75
76
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 74

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 79

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 55

def self.attribute_map
  {
    :'profile_id' => :'profileId',
    :'country' => :'country',
    :'submission_id' => :'submissionId',
    :'quantity' => :'quantity',
    :'reuse' => :'reuse',
    :'reuse_option_id' => :'reuseOptionId',
    :'reuse_from' => :'reuseFrom',
    :'area_code' => :'areaCode',
    :'end_user_first_name' => :'endUserFirstName',
    :'end_user_last_name' => :'endUserLastName',
    :'values' => :'values',
    :'documents' => :'documents',
    :'address' => :'address'
  }
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 316

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



103
104
105
106
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 84

def self.openapi_types
  {
    :'profile_id' => :'String',
    :'country' => :'String',
    :'submission_id' => :'String',
    :'quantity' => :'Integer',
    :'reuse' => :'Boolean',
    :'reuse_option_id' => :'String',
    :'reuse_from' => :'String',
    :'area_code' => :'String',
    :'end_user_first_name' => :'String',
    :'end_user_last_name' => :'String',
    :'values' => :'Hash<String, String>',
    :'documents' => :'Array<SubmitPhoneNumberKycRequestDocumentsInner>',
    :'address' => :'SubmitPhoneNumberKycRequestAddress'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 283

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      profile_id == o.profile_id &&
      country == o.country &&
      submission_id == o.submission_id &&
      quantity == o.quantity &&
      reuse == o.reuse &&
      reuse_option_id == o.reuse_option_id &&
      reuse_from == o.reuse_from &&
      area_code == o.area_code &&
      end_user_first_name == o.end_user_first_name &&
      end_user_last_name == o.end_user_last_name &&
      values == o.values &&
      documents == o.documents &&
      address == o.address
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


303
304
305
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



309
310
311
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 309

def hash
  [profile_id, country, submission_id, quantity, reuse, reuse_option_id, reuse_from, area_code, end_user_first_name, end_user_last_name, values, documents, address].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @profile_id.nil?
    invalid_properties.push('invalid value for "profile_id", profile_id cannot be nil.')
  end

  if @country.nil?
    invalid_properties.push('invalid value for "country", country cannot be nil.')
  end

  if !@quantity.nil? && @quantity > 5
    invalid_properties.push('invalid value for "quantity", must be smaller than or equal to 5.')
  end

  if !@quantity.nil? && @quantity < 1
    invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
  end

  pattern = Regexp.new(/^\d{1,4}$/)
  if !@area_code.nil? && @area_code !~ pattern
    invalid_properties.push("invalid value for \"area_code\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 338

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



218
219
220
221
222
223
224
225
226
 
# File 'lib/zernio-sdk/models/submit_phone_number_kyc_request.rb', line 218

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @profile_id.nil?
  return false if @country.nil?
  return false if !@quantity.nil? && @quantity > 5
  return false if !@quantity.nil? && @quantity < 1
  return false if !@area_code.nil? && @area_code !~ Regexp.new(/^\d{1,4}$/)
  true
end