Class: TripletexApi::Reminder

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/models/reminder.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Reminder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/tripletex_api/models/reminder.rb', line 149

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#bank ⇒ Object

Returns the value of attribute bank.



69
70
71
 
# File 'lib/tripletex_api/models/reminder.rb', line 69

def bank
  @bank
end

#bank_account_iban ⇒ Object

Returns the value of attribute bank_account_iban.



65
66
67
 
# File 'lib/tripletex_api/models/reminder.rb', line 65

def 
  @bank_account_iban
end

#bank_account_number ⇒ Object

Returns the value of attribute bank_account_number.



63
64
65
 
# File 'lib/tripletex_api/models/reminder.rb', line 63

def 
  @bank_account_number
end

#bank_account_swift ⇒ Object

Returns the value of attribute bank_account_swift.



67
68
69
 
# File 'lib/tripletex_api/models/reminder.rb', line 67

def 
  @bank_account_swift
end

#changes ⇒ Object

Returns the value of attribute changes.



22
23
24
 
# File 'lib/tripletex_api/models/reminder.rb', line 22

def changes
  @changes
end

#charge ⇒ Object

The fee part of the reminder, in the company’s currency.



30
31
32
 
# File 'lib/tripletex_api/models/reminder.rb', line 30

def charge
  @charge
end

#charge_currency ⇒ Object

The fee part of the reminder, in the invoice currency.



33
34
35
 
# File 'lib/tripletex_api/models/reminder.rb', line 33

def charge_currency
  @charge_currency
end

#comment ⇒ Object

Returns the value of attribute comment.



58
59
60
 
# File 'lib/tripletex_api/models/reminder.rb', line 58

def comment
  @comment
end

#currency ⇒ Object

The reminder currency.



54
55
56
 
# File 'lib/tripletex_api/models/reminder.rb', line 54

def currency
  @currency
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/tripletex_api/models/reminder.rb', line 18

def id
  @id
end

#interest_rate ⇒ Object

The reminder interest rate.



48
49
50
 
# File 'lib/tripletex_api/models/reminder.rb', line 48

def interest_rate
  @interest_rate
end

#interests ⇒ Object

The interests part of the reminder.



45
46
47
 
# File 'lib/tripletex_api/models/reminder.rb', line 45

def interests
  @interests
end

#kid ⇒ Object

KID - Kundeidentifikasjonsnummer.



61
62
63
 
# File 'lib/tripletex_api/models/reminder.rb', line 61

def kid
  @kid
end

#reminder_date ⇒ Object

Creation date of the invoice reminder.



27
28
29
 
# File 'lib/tripletex_api/models/reminder.rb', line 27

def reminder_date
  @reminder_date
end

#term_of_payment ⇒ Object

The reminder term of payment date.



51
52
53
 
# File 'lib/tripletex_api/models/reminder.rb', line 51

def term_of_payment
  @term_of_payment
end

#total_amount_currency ⇒ Object

The total amount to pay in reminder’s currency.



42
43
44
 
# File 'lib/tripletex_api/models/reminder.rb', line 42

def total_amount_currency
  @total_amount_currency
end

#total_charge ⇒ Object

The total fee part of all reminders, in the company’s currency.



36
37
38
 
# File 'lib/tripletex_api/models/reminder.rb', line 36

def total_charge
  @total_charge
end

#total_charge_currency ⇒ Object

The total fee part of all reminders, in the invoice currency.



39
40
41
 
# File 'lib/tripletex_api/models/reminder.rb', line 39

def total_charge_currency
  @total_charge_currency
end

#type ⇒ Object

Returns the value of attribute type.



56
57
58
 
# File 'lib/tripletex_api/models/reminder.rb', line 56

def type
  @type
end

#url ⇒ Object

Returns the value of attribute url.



24
25
26
 
# File 'lib/tripletex_api/models/reminder.rb', line 24

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



20
21
22
 
# File 'lib/tripletex_api/models/reminder.rb', line 20

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/tripletex_api/models/reminder.rb', line 94

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'reminder_date' => :'reminderDate',
    :'charge' => :'charge',
    :'charge_currency' => :'chargeCurrency',
    :'total_charge' => :'totalCharge',
    :'total_charge_currency' => :'totalChargeCurrency',
    :'total_amount_currency' => :'totalAmountCurrency',
    :'interests' => :'interests',
    :'interest_rate' => :'interestRate',
    :'term_of_payment' => :'termOfPayment',
    :'currency' => :'currency',
    :'type' => :'type',
    :'comment' => :'comment',
    :'kid' => :'kid',
    :'bank_account_number' => :'bankAccountNumber',
    :'bank_account_iban' => :'bankAccountIBAN',
    :'bank_account_swift' => :'bankAccountSWIFT',
    :'bank' => :'bank'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'reminder_date' => :'String',
    :'charge' => :'Float',
    :'charge_currency' => :'Float',
    :'total_charge' => :'Float',
    :'total_charge_currency' => :'Float',
    :'total_amount_currency' => :'Float',
    :'interests' => :'Float',
    :'interest_rate' => :'Float',
    :'term_of_payment' => :'String',
    :'currency' => :'Currency',
    :'type' => :'String',
    :'comment' => :'String',
    :'kid' => :'String',
    :'bank_account_number' => :'String',
    :'bank_account_iban' => :'String',
    :'bank_account_swift' => :'String',
    :'bank' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/tripletex_api/models/reminder.rb', line 365

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      reminder_date == o.reminder_date &&
      charge == o.charge &&
      charge_currency == o.charge_currency &&
      total_charge == o.total_charge &&
      total_charge_currency == o.total_charge_currency &&
      total_amount_currency == o.total_amount_currency &&
      interests == o.interests &&
      interest_rate == o.interest_rate &&
      term_of_payment == o.term_of_payment &&
      currency == o.currency &&
      type == o.type &&
      comment == o.comment &&
      kid == o.kid &&
       == o. &&
       == o. &&
       == o. &&
      bank == o.bank
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



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/tripletex_api/models/reminder.rb', line 427

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



493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/tripletex_api/models/reminder.rb', line 493

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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/tripletex_api/models/reminder.rb', line 406

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


393
394
395
 
# File 'lib/tripletex_api/models/reminder.rb', line 393

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



399
400
401
 
# File 'lib/tripletex_api/models/reminder.rb', line 399

def hash
  [id, version, changes, url, reminder_date, charge, charge_currency, total_charge, total_charge_currency, total_amount_currency, interests, interest_rate, term_of_payment, currency, type, comment, kid, , , , bank].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



245
246
247
248
249
250
251
252
253
254
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
280
 
# File 'lib/tripletex_api/models/reminder.rb', line 245

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

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

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

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

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

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

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

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

  return 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



473
474
475
 
# File 'lib/tripletex_api/models/reminder.rb', line 473

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



479
480
481
482
483
484
485
486
487
 
# File 'lib/tripletex_api/models/reminder.rb', line 479

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



467
468
469
 
# File 'lib/tripletex_api/models/reminder.rb', line 467

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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/tripletex_api/models/reminder.rb', line 284

def valid?
  return false if @reminder_date.nil?
  return false if @term_of_payment.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["SOFT_REMINDER", "REMINDER", "NOTICE_OF_DEBT_COLLECTION", "DEBT_COLLECTION"])
  return false unless type_validator.valid?(@type)
  return false if !@kid.nil? && @kid.to_s.length > 25
  return false if !@bank_account_number.nil? && @bank_account_number.to_s.length > 255
  return false if !@bank_account_iban.nil? && @bank_account_iban.to_s.length > 255
  return false if !@bank_account_swift.nil? && @bank_account_swift.to_s.length > 255
  return false if !@bank.nil? && @bank.to_s.length > 255
  return true
end