Class: BudgeaClient::Document

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

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'income')
    self.income = attributes[:'income']
  else
    self.income = true
  end

  if attributes.has_key?(:'readonly')
    self.readonly = attributes[:'readonly']
  else
    self.readonly = true
  end

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

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

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

  if attributes.has_key?(:'has_file_on_website')
    self.has_file_on_website = attributes[:'has_file_on_website']
  else
    self.has_file_on_website = true
  end

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

Instance Attribute Details

#currency ⇒ Object

Document currency



60
61
62
 
# File 'lib/budgea_client/models/document.rb', line 60

def currency
  @currency
end

#date ⇒ Object

Returns the value of attribute date.



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

def date
  @date
end

#duedate ⇒ Object

Returns the value of attribute duedate.



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

def duedate
  @duedate
end

#has_file_on_website ⇒ Object

Boolean to set if file is available on website



57
58
59
 
# File 'lib/budgea_client/models/document.rb', line 57

def has_file_on_website
  @has_file_on_website
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#id_category ⇒ Object

Returns the value of attribute id_category.



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

def id_category
  @id_category
end

#id_file ⇒ Object

Returns the value of attribute id_file.



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

def id_file
  @id_file
end

#id_subscription ⇒ Object

Returns the value of attribute id_subscription.



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

def id_subscription
  @id_subscription
end

#id_thumbnail ⇒ Object

Returns the value of attribute id_thumbnail.



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

def id_thumbnail
  @id_thumbnail
end

#id_type ⇒ Object

Returns the value of attribute id_type.



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

def id_type
  @id_type
end

#id_user ⇒ Object

Returns the value of attribute id_user.



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

def id_user
  @id_user
end

#income ⇒ Object

Returns the value of attribute income.



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

def income
  @income
end

#issuer ⇒ Object

Returns the value of attribute issuer.



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

def issuer
  @issuer
end

#last_update ⇒ Object

Last successful update of the document



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

def last_update
  @last_update
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#number ⇒ Object

Returns the value of attribute number.



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

def number
  @number
end

#readonly ⇒ Object

Returns the value of attribute readonly.



47
48
49
 
# File 'lib/budgea_client/models/document.rb', line 47

def readonly
  @readonly
end

#timestamp ⇒ Object

Returns the value of attribute timestamp.



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

def timestamp
  @timestamp
end

#total_amount ⇒ Object

Returns the value of attribute total_amount.



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

def total_amount
  @total_amount
end

#untaxed_amount ⇒ Object

Returns the value of attribute untaxed_amount.



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

def untaxed_amount
  @untaxed_amount
end

#vat ⇒ Object

Returns the value of attribute vat.



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

def vat
  @vat
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/budgea_client/models/document.rb', line 63

def self.attribute_map
  {
    :'id' => :'id',
    :'id_type' => :'id_type',
    :'id_category' => :'id_category',
    :'id_user' => :'id_user',
    :'id_subscription' => :'id_subscription',
    :'id_file' => :'id_file',
    :'id_thumbnail' => :'id_thumbnail',
    :'name' => :'name',
    :'timestamp' => :'timestamp',
    :'date' => :'date',
    :'duedate' => :'duedate',
    :'total_amount' => :'total_amount',
    :'untaxed_amount' => :'untaxed_amount',
    :'vat' => :'vat',
    :'income' => :'income',
    :'readonly' => :'readonly',
    :'number' => :'number',
    :'issuer' => :'issuer',
    :'last_update' => :'last_update',
    :'has_file_on_website' => :'has_file_on_website',
    :'currency' => :'currency'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/budgea_client/models/document.rb', line 90

def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_type' => :'Integer',
    :'id_category' => :'Integer',
    :'id_user' => :'Integer',
    :'id_subscription' => :'Integer',
    :'id_file' => :'Integer',
    :'id_thumbnail' => :'Integer',
    :'name' => :'String',
    :'timestamp' => :'DateTime',
    :'date' => :'DateTime',
    :'duedate' => :'Date',
    :'total_amount' => :'Float',
    :'untaxed_amount' => :'Float',
    :'vat' => :'Float',
    :'income' => :'BOOLEAN',
    :'readonly' => :'BOOLEAN',
    :'number' => :'String',
    :'issuer' => :'String',
    :'last_update' => :'DateTime',
    :'has_file_on_website' => :'BOOLEAN',
    :'currency' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/budgea_client/models/document.rb', line 255

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      id_type == o.id_type &&
      id_category == o.id_category &&
      id_user == o.id_user &&
      id_subscription == o.id_subscription &&
      id_file == o.id_file &&
      id_thumbnail == o.id_thumbnail &&
      name == o.name &&
      timestamp == o.timestamp &&
      date == o.date &&
      duedate == o.duedate &&
      total_amount == o.total_amount &&
      untaxed_amount == o.untaxed_amount &&
      vat == o.vat &&
      income == o.income &&
      readonly == o.readonly &&
      number == o.number &&
      issuer == o.issuer &&
      last_update == o.last_update &&
      has_file_on_website == o.has_file_on_website &&
      currency == o.currency
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



317
318
319
320
321
322
323
324
325
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
 
# File 'lib/budgea_client/models/document.rb', line 317

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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/budgea_client/models/document.rb', line 383

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/budgea_client/models/document.rb', line 296

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


283
284
285
 
# File 'lib/budgea_client/models/document.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



289
290
291
 
# File 'lib/budgea_client/models/document.rb', line 289

def hash
  [id, id_type, id_category, id_user, id_subscription, id_file, id_thumbnail, name, timestamp, date, duedate, total_amount, untaxed_amount, vat, income, readonly, number, issuer, last_update, has_file_on_website, currency].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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/budgea_client/models/document.rb', line 217

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

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

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

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

  if @has_file_on_website.nil?
    invalid_properties.push('invalid value for "has_file_on_website", has_file_on_website 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



363
364
365
 
# File 'lib/budgea_client/models/document.rb', line 363

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



369
370
371
372
373
374
375
376
377
 
# File 'lib/budgea_client/models/document.rb', line 369

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



357
358
359
 
# File 'lib/budgea_client/models/document.rb', line 357

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



244
245
246
247
248
249
250
251
 
# File 'lib/budgea_client/models/document.rb', line 244

def valid?
  return false if @id.nil?
  return false if @id_user.nil?
  return false if @timestamp.nil?
  return false if @readonly.nil?
  return false if @has_file_on_website.nil?
  true
end