Class: TripletexRubyClient::BankBalanceEstimation

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/bank_balance_estimation.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BankBalanceEstimation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 121

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#batch_idObject

Returns the value of attribute batch_id.



51
52
53
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 51

def batch_id
  @batch_id
end

#categoryObject

Category



44
45
46
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 44

def category
  @category
end

#changesObject

Returns the value of attribute changes.



19
20
21
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 19

def changes
  @changes
end

#dateObject

Returns the value of attribute date.



23
24
25
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 23

def date
  @date
end

#descriptionObject

java.lang.String



26
27
28
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 26

def description
  @description
end

#idObject

Returns the value of attribute id.



15
16
17
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 15

def id
  @id
end

#invoice_amountObject

java.math.BigDecimal



35
36
37
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 35

def invoice_amount
  @invoice_amount
end

#invoice_idObject

Returns the value of attribute invoice_id.



30
31
32
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 30

def invoice_id
  @invoice_id
end

#invoice_numberObject

Returns the value of attribute invoice_number.



32
33
34
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 32

def invoice_number
  @invoice_number
end

#is_incoming_invoiceObject

boolean



38
39
40
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 38

def is_incoming_invoice
  @is_incoming_invoice
end

#is_manually_addedObject

boolean



49
50
51
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 49

def is_manually_added
  @is_manually_added
end

#recurrenceObject

Recurrence type



41
42
43
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 41

def recurrence
  @recurrence
end

#urlObject

Returns the value of attribute url.



21
22
23
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 21

def url
  @url
end

#vendor_or_customer_nameObject

Returns the value of attribute vendor_or_customer_name.



46
47
48
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 46

def vendor_or_customer_name
  @vendor_or_customer_name
end

#versionObject

Returns the value of attribute version.



17
18
19
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 17

def version
  @version
end

#voucher_idObject

Returns the value of attribute voucher_id.



28
29
30
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 28

def voucher_id
  @voucher_id
end

Class Method Details

.attribute_mapObject

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
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'date' => :'date',
    :'description' => :'description',
    :'voucher_id' => :'voucherId',
    :'invoice_id' => :'invoiceId',
    :'invoice_number' => :'invoiceNumber',
    :'invoice_amount' => :'invoiceAmount',
    :'is_incoming_invoice' => :'isIncomingInvoice',
    :'recurrence' => :'recurrence',
    :'category' => :'category',
    :'vendor_or_customer_name' => :'vendorOrCustomerName',
    :'is_manually_added' => :'isManuallyAdded',
    :'batch_id' => :'batchId'
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'date' => :'String',
    :'description' => :'String',
    :'voucher_id' => :'Integer',
    :'invoice_id' => :'Integer',
    :'invoice_number' => :'String',
    :'invoice_amount' => :'Float',
    :'is_incoming_invoice' => :'BOOLEAN',
    :'recurrence' => :'String',
    :'category' => :'String',
    :'vendor_or_customer_name' => :'String',
    :'is_manually_added' => :'BOOLEAN',
    :'batch_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      date == o.date &&
      description == o.description &&
      voucher_id == o.voucher_id &&
      invoice_id == o.invoice_id &&
      invoice_number == o.invoice_number &&
      invoice_amount == o.invoice_amount &&
      is_incoming_invoice == o.is_incoming_invoice &&
      recurrence == o.recurrence &&
      category == o.category &&
      vendor_or_customer_name == o.vendor_or_customer_name &&
      is_manually_added == o.is_manually_added &&
      batch_id == o.batch_id
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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 339

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



405
406
407
408
409
410
411
412
413
414
415
416
417
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 405

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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 318

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


305
306
307
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 305

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



311
312
313
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 311

def hash
  [id, version, changes, url, date, description, voucher_id, invoice_id, invoice_number, invoice_amount, is_incoming_invoice, recurrence, category, vendor_or_customer_name, is_manually_added, batch_id].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 196

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

  if @description.to_s.length > 255
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
  end

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

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

  if !@batch_id.nil? && @batch_id.to_s.length > 255
    invalid_properties.push('invalid value for "batch_id", the character length must be smaller than or equal to 255.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



385
386
387
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 385

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



391
392
393
394
395
396
397
398
399
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 391

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



379
380
381
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 379

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



223
224
225
226
227
228
229
230
231
232
233
234
# File 'lib/tripletex_ruby_client/models/bank_balance_estimation.rb', line 223

def valid?
  return false if @description.nil?
  return false if @description.to_s.length > 255
  return false if @recurrence.nil?
  recurrence_validator = EnumAttributeValidator.new('String', ['NONE', 'DAILY', 'WEEKLY', 'MONTHLY'])
  return false unless recurrence_validator.valid?(@recurrence)
  return false if @category.nil?
  category_validator = EnumAttributeValidator.new('String', ['DUPLICATE', 'STARTING_BALANCE', 'NONE', 'SALARY', 'ENI', 'TAX', 'VAT_RETURNS'])
  return false unless category_validator.valid?(@category)
  return false if !@batch_id.nil? && @batch_id.to_s.length > 255
  true
end