Class: TreezorClient::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/treezor_client/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



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
191
192
193
194
195
196
 
# File 'lib/treezor_client/models/document.rb', line 123

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?(:'documentId')
    self.document_id = attributes[:'documentId']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#client_id ⇒ Object

Returns the value of attribute client_id.



29
30
31
 
# File 'lib/treezor_client/models/document.rb', line 29

def client_id
  @client_id
end

#created_date ⇒ Object

Date YYYY-MM-DD HH:MM:SS



46
47
48
 
# File 'lib/treezor_client/models/document.rb', line 46

def created_date
  @created_date
end

#document_id ⇒ Object

Returns the value of attribute document_id.



17
18
19
 
# File 'lib/treezor_client/models/document.rb', line 17

def document_id
  @document_id
end

#document_status ⇒ Object

Returns the value of attribute document_status.



21
22
23
 
# File 'lib/treezor_client/models/document.rb', line 21

def document_status
  @document_status
end

#document_tag ⇒ Object

Returns the value of attribute document_tag.



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

def document_tag
  @document_tag
end

#document_type ⇒ Object

Returns the value of attribute document_type.



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

def document_type
  @document_type
end

#document_type_id ⇒ Object

Returns the value of attribute document_type_id.



23
24
25
 
# File 'lib/treezor_client/models/document.rb', line 23

def document_type_id
  @document_type_id
end

#file_name ⇒ Object

Returns the value of attribute file_name.



37
38
39
 
# File 'lib/treezor_client/models/document.rb', line 37

def file_name
  @file_name
end

#information_status ⇒ Object

Returns the value of attribute information_status.



43
44
45
 
# File 'lib/treezor_client/models/document.rb', line 43

def information_status
  @information_status
end

#modified_date ⇒ Object

Date YYYY-MM-DD HH:MM:SS



49
50
51
 
# File 'lib/treezor_client/models/document.rb', line 49

def modified_date
  @modified_date
end

#residence_id ⇒ Object

Returns the value of attribute residence_id.



27
28
29
 
# File 'lib/treezor_client/models/document.rb', line 27

def residence_id
  @residence_id
end

#temporary_url ⇒ Object

Returns the value of attribute temporary_url.



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

def temporary_url
  @temporary_url
end

#temporary_url_thumb ⇒ Object

Returns the value of attribute temporary_url_thumb.



41
42
43
 
# File 'lib/treezor_client/models/document.rb', line 41

def temporary_url_thumb
  @temporary_url_thumb
end

#total_rows ⇒ Object

Returns the value of attribute total_rows.



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

def total_rows
  @total_rows
end

#user_firstname ⇒ Object

Returns the value of attribute user_firstname.



35
36
37
 
# File 'lib/treezor_client/models/document.rb', line 35

def user_firstname
  @user_firstname
end

#user_id ⇒ Object

Returns the value of attribute user_id.



31
32
33
 
# File 'lib/treezor_client/models/document.rb', line 31

def user_id
  @user_id
end

#user_lastname ⇒ Object

Returns the value of attribute user_lastname.



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

def user_lastname
  @user_lastname
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'document_id' => :'documentId',
    :'document_tag' => :'documentTag',
    :'document_status' => :'documentStatus',
    :'document_type_id' => :'documentTypeId',
    :'document_type' => :'documentType',
    :'residence_id' => :'residenceId',
    :'client_id' => :'clientId',
    :'user_id' => :'userId',
    :'user_lastname' => :'userLastname',
    :'user_firstname' => :'userFirstname',
    :'file_name' => :'fileName',
    :'temporary_url' => :'temporaryUrl',
    :'temporary_url_thumb' => :'temporaryUrlThumb',
    :'information_status' => :'informationStatus',
    :'created_date' => :'createdDate',
    :'modified_date' => :'modifiedDate',
    :'total_rows' => :'totalRows'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'document_id' => :'Integer',
    :'document_tag' => :'String',
    :'document_status' => :'String',
    :'document_type_id' => :'Integer',
    :'document_type' => :'String',
    :'residence_id' => :'Integer',
    :'client_id' => :'Integer',
    :'user_id' => :'Integer',
    :'user_lastname' => :'String',
    :'user_firstname' => :'String',
    :'file_name' => :'String',
    :'temporary_url' => :'String',
    :'temporary_url_thumb' => :'String',
    :'information_status' => :'String',
    :'created_date' => :'String',
    :'modified_date' => :'String',
    :'total_rows' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/treezor_client/models/document.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      document_id == o.document_id &&
      document_tag == o.document_tag &&
      document_status == o.document_status &&
      document_type_id == o.document_type_id &&
      document_type == o.document_type &&
      residence_id == o.residence_id &&
      client_id == o.client_id &&
      user_id == o.user_id &&
      user_lastname == o.user_lastname &&
      user_firstname == o.user_firstname &&
      file_name == o.file_name &&
      temporary_url == o.temporary_url &&
      temporary_url_thumb == o.temporary_url_thumb &&
      information_status == o.information_status &&
      created_date == o.created_date &&
      modified_date == o.modified_date &&
      total_rows == o.total_rows
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



283
284
285
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
 
# File 'lib/treezor_client/models/document.rb', line 283

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 = TreezorClient.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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/treezor_client/models/document.rb', line 349

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/treezor_client/models/document.rb', line 262

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


249
250
251
 
# File 'lib/treezor_client/models/document.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/treezor_client/models/document.rb', line 255

def hash
  [document_id, document_tag, document_status, document_type_id, document_type, residence_id, client_id, user_id, user_lastname, user_firstname, file_name, temporary_url, temporary_url_thumb, information_status, created_date, modified_date, total_rows].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



200
201
202
203
 
# File 'lib/treezor_client/models/document.rb', line 200

def list_invalid_properties
  invalid_properties = Array.new
  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



329
330
331
 
# File 'lib/treezor_client/models/document.rb', line 329

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



335
336
337
338
339
340
341
342
343
 
# File 'lib/treezor_client/models/document.rb', line 335

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
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



323
324
325
 
# File 'lib/treezor_client/models/document.rb', line 323

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



207
208
209
210
211
 
# File 'lib/treezor_client/models/document.rb', line 207

def valid?
  document_status_validator = EnumAttributeValidator.new('String', ['PENDING', 'CANCELED', 'VALIDATED', 'REFUSED'])
  return false unless document_status_validator.valid?(@document_status)
  true
end