Class: NucleusApi::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/document.rb

Overview

Document Object

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



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
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
 
# File 'lib/nucleus_api/models/document.rb', line 143

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.has_key?(:'business_id')
    self.business_id = attributes[:'business_id']
  end

  if attributes.has_key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.has_key?(:'country_of_issue')
    self.country_of_issue = attributes[:'country_of_issue']
  end

  if attributes.has_key?(:'create_date')
    self.create_date = attributes[:'create_date']
  end

  if attributes.has_key?(:'doc_file')
    self.doc_file = attributes[:'doc_file']
  end

  if attributes.has_key?(:'doc_image_back')
    self.doc_image_back = attributes[:'doc_image_back']
  end

  if attributes.has_key?(:'doc_image_front')
    self.doc_image_front = attributes[:'doc_image_front']
  end

  if attributes.has_key?(:'doc_name')
    self.doc_name = attributes[:'doc_name']
  end

  if attributes.has_key?(:'doc_number')
    self.doc_number = attributes[:'doc_number']
  end

  if attributes.has_key?(:'doc_size')
    self.doc_size = attributes[:'doc_size']
  end

  if attributes.has_key?(:'doc_type')
    self.doc_type = attributes[:'doc_type']
  end

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

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

  if attributes.has_key?(:'is_active')
    self.is_active = attributes[:'is_active']
  end

  if attributes.has_key?(:'is_sensitive')
    self.is_sensitive = attributes[:'is_sensitive']
  end

  if attributes.has_key?(:'is_verified')
    self.is_verified = attributes[:'is_verified']
  end

  if attributes.has_key?(:'issue_date')
    self.issue_date = attributes[:'issue_date']
  end

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

  if attributes.has_key?(:'secondary_id')
    self.secondary_id = attributes[:'secondary_id']
  end

  if attributes.has_key?(:'state_of_issue')
    self.state_of_issue = attributes[:'state_of_issue']
  end

  if attributes.has_key?(:'update_date')
    self.update_date = attributes[:'update_date']
  end

  if attributes.has_key?(:'url_path')
    self.url_path = attributes[:'url_path']
  end
end

Instance Attribute Details

#account_id ⇒ Object

accountId



19
20
21
 
# File 'lib/nucleus_api/models/document.rb', line 19

def 
  @account_id
end

#business_id ⇒ Object

businessId



22
23
24
 
# File 'lib/nucleus_api/models/document.rb', line 22

def business_id
  @business_id
end

#client_id ⇒ Object

clientId



25
26
27
 
# File 'lib/nucleus_api/models/document.rb', line 25

def client_id
  @client_id
end

#country_of_issue ⇒ Object

country_of_issue



28
29
30
 
# File 'lib/nucleus_api/models/document.rb', line 28

def country_of_issue
  @country_of_issue
end

#create_date ⇒ Object

Returns the value of attribute create_date.



30
31
32
 
# File 'lib/nucleus_api/models/document.rb', line 30

def create_date
  @create_date
end

#doc_file ⇒ Object

doc_file



33
34
35
 
# File 'lib/nucleus_api/models/document.rb', line 33

def doc_file
  @doc_file
end

#doc_image_back ⇒ Object

doc_image_back



36
37
38
 
# File 'lib/nucleus_api/models/document.rb', line 36

def doc_image_back
  @doc_image_back
end

#doc_image_front ⇒ Object

doc_image_front



39
40
41
 
# File 'lib/nucleus_api/models/document.rb', line 39

def doc_image_front
  @doc_image_front
end

#doc_name ⇒ Object

doc_name



42
43
44
 
# File 'lib/nucleus_api/models/document.rb', line 42

def doc_name
  @doc_name
end

#doc_number ⇒ Object

doc_number



45
46
47
 
# File 'lib/nucleus_api/models/document.rb', line 45

def doc_number
  @doc_number
end

#doc_size ⇒ Object

doc_size



48
49
50
 
# File 'lib/nucleus_api/models/document.rb', line 48

def doc_size
  @doc_size
end

#doc_type ⇒ Object

doc_type



51
52
53
 
# File 'lib/nucleus_api/models/document.rb', line 51

def doc_type
  @doc_type
end

#expiry_date ⇒ Object

expiry_date



54
55
56
 
# File 'lib/nucleus_api/models/document.rb', line 54

def expiry_date
  @expiry_date
end

#id ⇒ Object

Returns the value of attribute id.



56
57
58
 
# File 'lib/nucleus_api/models/document.rb', line 56

def id
  @id
end

#is_active ⇒ Object

is_active



59
60
61
 
# File 'lib/nucleus_api/models/document.rb', line 59

def is_active
  @is_active
end

#is_sensitive ⇒ Object

is_sensitive



62
63
64
 
# File 'lib/nucleus_api/models/document.rb', line 62

def is_sensitive
  @is_sensitive
end

#is_verified ⇒ Object

is_verified



65
66
67
 
# File 'lib/nucleus_api/models/document.rb', line 65

def is_verified
  @is_verified
end

#issue_date ⇒ Object

issue_date



68
69
70
 
# File 'lib/nucleus_api/models/document.rb', line 68

def issue_date
  @issue_date
end

#metadata ⇒ Object

metadata



71
72
73
 
# File 'lib/nucleus_api/models/document.rb', line 71

def metadata
  @metadata
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



73
74
75
 
# File 'lib/nucleus_api/models/document.rb', line 73

def secondary_id
  @secondary_id
end

#state_of_issue ⇒ Object

state_of_issue



76
77
78
 
# File 'lib/nucleus_api/models/document.rb', line 76

def state_of_issue
  @state_of_issue
end

#update_date ⇒ Object

Returns the value of attribute update_date.



78
79
80
 
# File 'lib/nucleus_api/models/document.rb', line 78

def update_date
  @update_date
end

#url_path ⇒ Object

url_path



81
82
83
 
# File 'lib/nucleus_api/models/document.rb', line 81

def url_path
  @url_path
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/nucleus_api/models/document.rb', line 84

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'business_id' => :'business_id',
    :'client_id' => :'client_id',
    :'country_of_issue' => :'country_of_issue',
    :'create_date' => :'create_date',
    :'doc_file' => :'doc_file',
    :'doc_image_back' => :'doc_image_back',
    :'doc_image_front' => :'doc_image_front',
    :'doc_name' => :'doc_name',
    :'doc_number' => :'doc_number',
    :'doc_size' => :'doc_size',
    :'doc_type' => :'doc_type',
    :'expiry_date' => :'expiry_date',
    :'id' => :'id',
    :'is_active' => :'is_active',
    :'is_sensitive' => :'is_sensitive',
    :'is_verified' => :'is_verified',
    :'issue_date' => :'issue_date',
    :'metadata' => :'metadata',
    :'secondary_id' => :'secondary_id',
    :'state_of_issue' => :'state_of_issue',
    :'update_date' => :'update_date',
    :'url_path' => :'url_path'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/nucleus_api/models/document.rb', line 113

def self.swagger_types
  {
    :'account_id' => :'String',
    :'business_id' => :'String',
    :'client_id' => :'String',
    :'country_of_issue' => :'String',
    :'create_date' => :'DateTime',
    :'doc_file' => :'String',
    :'doc_image_back' => :'String',
    :'doc_image_front' => :'String',
    :'doc_name' => :'String',
    :'doc_number' => :'String',
    :'doc_size' => :'Integer',
    :'doc_type' => :'String',
    :'expiry_date' => :'Date',
    :'id' => :'String',
    :'is_active' => :'BOOLEAN',
    :'is_sensitive' => :'BOOLEAN',
    :'is_verified' => :'BOOLEAN',
    :'issue_date' => :'Date',
    :'metadata' => :'Hash<String, String>',
    :'secondary_id' => :'String',
    :'state_of_issue' => :'String',
    :'update_date' => :'DateTime',
    :'url_path' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/nucleus_api/models/document.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      business_id == o.business_id &&
      client_id == o.client_id &&
      country_of_issue == o.country_of_issue &&
      create_date == o.create_date &&
      doc_file == o.doc_file &&
      doc_image_back == o.doc_image_back &&
      doc_image_front == o.doc_image_front &&
      doc_name == o.doc_name &&
      doc_number == o.doc_number &&
      doc_size == o.doc_size &&
      doc_type == o.doc_type &&
      expiry_date == o.expiry_date &&
      id == o.id &&
      is_active == o.is_active &&
      is_sensitive == o.is_sensitive &&
      is_verified == o.is_verified &&
      issue_date == o.issue_date &&
      metadata == o.metadata &&
      secondary_id == o.secondary_id &&
      state_of_issue == o.state_of_issue &&
      update_date == o.update_date &&
      url_path == o.url_path
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/nucleus_api/models/document.rb', line 326

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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 = NucleusApi.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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/nucleus_api/models/document.rb', line 392

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/nucleus_api/models/document.rb', line 307

def build_from_hash(attributes)
  self.class.swagger_types.each_pair do |key, type|
    if 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[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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


294
295
296
 
# File 'lib/nucleus_api/models/document.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



300
301
302
 
# File 'lib/nucleus_api/models/document.rb', line 300

def hash
  [, business_id, client_id, country_of_issue, create_date, doc_file, doc_image_back, doc_image_front, doc_name, doc_number, doc_size, doc_type, expiry_date, id, is_active, is_sensitive, is_verified, issue_date, metadata, secondary_id, state_of_issue, update_date, url_path].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



246
247
248
249
250
251
252
253
 
# File 'lib/nucleus_api/models/document.rb', line 246

def list_invalid_properties
  invalid_properties = Array.new
  if @doc_name.nil?
    invalid_properties.push('invalid value for "doc_name", doc_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



373
374
375
 
# File 'lib/nucleus_api/models/document.rb', line 373

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



379
380
381
382
383
384
385
386
 
# File 'lib/nucleus_api/models/document.rb', line 379

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



367
368
369
 
# File 'lib/nucleus_api/models/document.rb', line 367

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



257
258
259
260
 
# File 'lib/nucleus_api/models/document.rb', line 257

def valid?
  return false if @doc_name.nil?
  true
end