Class: TransferZero::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/transferzero-sdk/models/document.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Document

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
187
188
189
190
 
# File 'lib/transferzero-sdk/models/document.rb', line 120

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#category ⇒ Object

uncategorised



34
35
36
 
# File 'lib/transferzero-sdk/models/document.rb', line 34

def category
  @category
end

#document_id ⇒ Object

Document ID issued by government



48
49
50
 
# File 'lib/transferzero-sdk/models/document.rb', line 48

def document_id
  @document_id
end

#document_type ⇒ Object

This is a brief description of the document type



40
41
42
 
# File 'lib/transferzero-sdk/models/document.rb', line 40

def document_type
  @document_type
end

#errors ⇒ Object

The fields that have some problems and don’t pass validation



54
55
56
 
# File 'lib/transferzero-sdk/models/document.rb', line 54

def errors
  @errors
end

#expiry_date ⇒ Object

Document expiry date issued by government



51
52
53
 
# File 'lib/transferzero-sdk/models/document.rb', line 51

def expiry_date
  @expiry_date
end

#id ⇒ Object

Returns the value of attribute id.



45
46
47
 
# File 'lib/transferzero-sdk/models/document.rb', line 45

def id
  @id
end

#issuing_country ⇒ Object

Issuing country of ID in 2-character alpha ISO 3166-2 country format



43
44
45
 
# File 'lib/transferzero-sdk/models/document.rb', line 43

def issuing_country
  @issuing_country
end

#metadata ⇒ Object

Metadata of document



27
28
29
 
# File 'lib/transferzero-sdk/models/document.rb', line 27

def metadata
  @metadata
end

#side ⇒ Object

The side of the KYC ID. One of ‘front’ or ‘back’



37
38
39
 
# File 'lib/transferzero-sdk/models/document.rb', line 37

def side
  @side
end

#upload ⇒ Object

Base64 encoded data uri of an image/pdf file or a fully qualified url



18
19
20
 
# File 'lib/transferzero-sdk/models/document.rb', line 18

def upload
  @upload
end

#upload_content_type ⇒ Object

Returns the value of attribute upload_content_type.



29
30
31
 
# File 'lib/transferzero-sdk/models/document.rb', line 29

def upload_content_type
  @upload_content_type
end

#upload_file_name ⇒ Object

Name of the upload



24
25
26
 
# File 'lib/transferzero-sdk/models/document.rb', line 24

def upload_file_name
  @upload_file_name
end

#upload_file_size ⇒ Object

Returns the value of attribute upload_file_size.



31
32
33
 
# File 'lib/transferzero-sdk/models/document.rb', line 31

def upload_file_size
  @upload_file_size
end

#url ⇒ Object

URL of the document location



21
22
23
 
# File 'lib/transferzero-sdk/models/document.rb', line 21

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/transferzero-sdk/models/document.rb', line 79

def self.attribute_map
  {
    :'upload' => :'upload',
    :'url' => :'url',
    :'upload_file_name' => :'upload_file_name',
    :'metadata' => :'metadata',
    :'upload_content_type' => :'upload_content_type',
    :'upload_file_size' => :'upload_file_size',
    :'category' => :'category',
    :'side' => :'side',
    :'document_type' => :'document_type',
    :'issuing_country' => :'issuing_country',
    :'id' => :'id',
    :'document_id' => :'document_id',
    :'expiry_date' => :'expiry_date',
    :'errors' => :'errors'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/transferzero-sdk/models/document.rb', line 99

def self.openapi_types
  {
    :'upload' => :'String',
    :'url' => :'String',
    :'upload_file_name' => :'String',
    :'metadata' => :'Object',
    :'upload_content_type' => :'String',
    :'upload_file_size' => :'Integer',
    :'category' => :'String',
    :'side' => :'String',
    :'document_type' => :'String',
    :'issuing_country' => :'String',
    :'id' => :'String',
    :'document_id' => :'String',
    :'expiry_date' => :'Date',
    :'errors' => :'Hash<String, Array<ValidationErrorDescription>>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/transferzero-sdk/models/document.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      upload == o.upload &&
      url == o.url &&
      upload_file_name == o.upload_file_name &&
      metadata == o.metadata &&
      upload_content_type == o.upload_content_type &&
      upload_file_size == o.upload_file_size &&
      category == o.category &&
      side == o.side &&
      document_type == o.document_type &&
      issuing_country == o.issuing_country &&
      id == o.id &&
      document_id == o.document_id &&
      expiry_date == o.expiry_date &&
      errors == o.errors
end

#[](key) ⇒ Object 



348
349
350
 
# File 'lib/transferzero-sdk/models/document.rb', line 348

def [](key)
  to_hash[key]
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/transferzero-sdk/models/document.rb', line 286

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = TransferZero.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/transferzero-sdk/models/document.rb', line 360

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Returns the model itself

Returns:

  • (Object) —

    Returns the model itself



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/transferzero-sdk/models/document.rb', line 265

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#dig(*args) ⇒ Object 



352
353
354
 
# File 'lib/transferzero-sdk/models/document.rb', line 352

def dig(*args)
  to_hash.dig(*args)
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


250
251
252
 
# File 'lib/transferzero-sdk/models/document.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



256
257
258
 
# File 'lib/transferzero-sdk/models/document.rb', line 256

def hash
  [upload, url, upload_file_name, metadata, upload_content_type, upload_file_size, category, side, document_type, issuing_country, id, document_id, expiry_date, errors].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



194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/transferzero-sdk/models/document.rb', line 194

def list_invalid_properties
  invalid_properties = Array.new
  if @upload.nil?
    invalid_properties.push('invalid value for "upload", upload cannot be nil.')
  end

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



332
333
334
 
# File 'lib/transferzero-sdk/models/document.rb', line 332

def to_body
  to_hash
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
 
# File 'lib/transferzero-sdk/models/document.rb', line 338

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



326
327
328
 
# File 'lib/transferzero-sdk/models/document.rb', line 326

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



209
210
211
212
213
214
215
 
# File 'lib/transferzero-sdk/models/document.rb', line 209

def valid?
  return false if @upload.nil?
  return false if @upload_file_name.nil?
  side_validator = EnumAttributeValidator.new('String', ["front", "back"])
  return false unless side_validator.valid?(@side)
  true
end