Class: Wallee::DebtCollectionCase

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-ruby-sdk/models/debt_collection_case.rb

Overview

The debt collection case represents a try to collect the money from the debtor.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DebtCollectionCase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
243
244
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
281
282
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
320
321
322
323
324
325
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 192

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The amount is the total amount of the not paid items. The amount cannot be change once the case is reviewed.



24
25
26
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 24

def amount
  @amount
end

#billing_address ⇒ Object

The billing address of the case identifies the debtor.



27
28
29
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 27

def billing_address
  @billing_address
end

#closed_on ⇒ Object

The closed on date indicates when the case is closed on.



30
31
32
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 30

def closed_on
  @closed_on
end

#collector_configuration ⇒ Object

The collector configuration determines how the debt collection case is processed.



33
34
35
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 33

def collector_configuration
  @collector_configuration
end

#contract_date ⇒ Object

The contract date is the date on which the contract with the debtor was signed on.



36
37
38
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 36

def contract_date
  @contract_date
end

#created_on ⇒ Object

The date and time when the object was created.



39
40
41
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 39

def created_on
  @created_on
end

#creator ⇒ Object

The creator references the user which has created the debt collection case.



42
43
44
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 42

def creator
  @creator
end

#currency ⇒ Object

The currency defines the billing currency of the debt collection case.



45
46
47
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 45

def currency
  @currency
end

#due_date ⇒ Object

The due date indicates the date on which the amount receivable was due. This date has to be always in the past.



48
49
50
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 48

def due_date
  @due_date
end

#environment ⇒ Object

The environment in which this case will be processed. There must be a debt collector configuration present which supports the chosen environment.



51
52
53
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 51

def environment
  @environment
end

#external_id ⇒ Object

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.



54
55
56
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 54

def external_id
  @external_id
end

#failed_on ⇒ Object

The failed on date indicates when the case is failed on.



57
58
59
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 57

def failed_on
  @failed_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



60
61
62
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 60

def failure_reason
  @failure_reason
end

#id ⇒ Object

A unique identifier for the object.



63
64
65
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 63

def id
  @id
end

#labels ⇒ Object

Returns the value of attribute labels.



66
67
68
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 66

def labels
  @labels
end

#language ⇒ Object

The language indicates the language to be used in the communication with the debtor.



69
70
71
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 69

def language
  @language
end

#line_items ⇒ Object

The line items of the debt collection case will be shown on documents sent to the debtor and the total of them makes up total amount to collect.



72
73
74
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 72

def line_items
  @line_items
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



75
76
77
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 75

def linked_space_id
  @linked_space_id
end

#next_attempt_on ⇒ Object

Returns the value of attribute next_attempt_on.



78
79
80
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 78

def next_attempt_on
  @next_attempt_on
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



81
82
83
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 81

def planned_purge_date
  @planned_purge_date
end

#processing_started_on ⇒ Object

The processing started on date indicates the date on which the processing of the case started on.



84
85
86
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 84

def processing_started_on
  @processing_started_on
end

#processing_timeout_on ⇒ Object

Returns the value of attribute processing_timeout_on.



87
88
89
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 87

def processing_timeout_on
  @processing_timeout_on
end

#reference ⇒ Object

The case reference is used in the communication with the debtor. It should be unique and it should be linkable with the source of the debt collection case.



90
91
92
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 90

def reference
  @reference
end

#review_started_on ⇒ Object

Returns the value of attribute review_started_on.



93
94
95
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 93

def review_started_on
  @review_started_on
end

#reviewed_on ⇒ Object

The reviewed on date indicates when the review of the case was conducted on.



96
97
98
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 96

def reviewed_on
  @reviewed_on
end

#reviewer ⇒ Object

The reviewer references the user which has reviewed the case.



99
100
101
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 99

def reviewer
  @reviewer
end

#source ⇒ Object

The source of the debt collection case indicates the origin of the amount receivable.



102
103
104
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 102

def source
  @source
end

#source_entity_id ⇒ Object

The source entity ID points to the object which is the origin of the debt collection case. This ID is only set when the case was triggered by an internal process.



105
106
107
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 105

def source_entity_id
  @source_entity_id
end

#space_view_id ⇒ Object

Returns the value of attribute space_view_id.



108
109
110
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 108

def space_view_id
  @space_view_id
end

#state ⇒ Object

The object’s current state.



111
112
113
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 111

def state
  @state
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



114
115
116
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 114

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



117
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
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 117

def self.attribute_map
  {
    :'amount' => :'amount',
    :'billing_address' => :'billingAddress',
    :'closed_on' => :'closedOn',
    :'collector_configuration' => :'collectorConfiguration',
    :'contract_date' => :'contractDate',
    :'created_on' => :'createdOn',
    :'creator' => :'creator',
    :'currency' => :'currency',
    :'due_date' => :'dueDate',
    :'environment' => :'environment',
    :'external_id' => :'externalId',
    :'failed_on' => :'failedOn',
    :'failure_reason' => :'failureReason',
    :'id' => :'id',
    :'labels' => :'labels',
    :'language' => :'language',
    :'line_items' => :'lineItems',
    :'linked_space_id' => :'linkedSpaceId',
    :'next_attempt_on' => :'nextAttemptOn',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'processing_started_on' => :'processingStartedOn',
    :'processing_timeout_on' => :'processingTimeoutOn',
    :'reference' => :'reference',
    :'review_started_on' => :'reviewStartedOn',
    :'reviewed_on' => :'reviewedOn',
    :'reviewer' => :'reviewer',
    :'source' => :'source',
    :'source_entity_id' => :'sourceEntityId',
    :'space_view_id' => :'spaceViewId',
    :'state' => :'state',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 154

def self.swagger_types
  {
    :'amount' => :'Float',
    :'billing_address' => :'Address',
    :'closed_on' => :'DateTime',
    :'collector_configuration' => :'DebtCollectorConfiguration',
    :'contract_date' => :'DateTime',
    :'created_on' => :'DateTime',
    :'creator' => :'Integer',
    :'currency' => :'String',
    :'due_date' => :'DateTime',
    :'environment' => :'DebtCollectionEnvironment',
    :'external_id' => :'String',
    :'failed_on' => :'DateTime',
    :'failure_reason' => :'FailureReason',
    :'id' => :'Integer',
    :'labels' => :'Array<Label>',
    :'language' => :'String',
    :'line_items' => :'Array<LineItem>',
    :'linked_space_id' => :'Integer',
    :'next_attempt_on' => :'DateTime',
    :'planned_purge_date' => :'DateTime',
    :'processing_started_on' => :'DateTime',
    :'processing_timeout_on' => :'DateTime',
    :'reference' => :'String',
    :'review_started_on' => :'DateTime',
    :'reviewed_on' => :'DateTime',
    :'reviewer' => :'Integer',
    :'source' => :'DebtCollectionCaseSource',
    :'source_entity_id' => :'Integer',
    :'space_view_id' => :'Integer',
    :'state' => :'DebtCollectionCaseState',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
376
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 342

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      billing_address == o.billing_address &&
      closed_on == o.closed_on &&
      collector_configuration == o.collector_configuration &&
      contract_date == o.contract_date &&
      created_on == o.created_on &&
      creator == o.creator &&
      currency == o.currency &&
      due_date == o.due_date &&
      environment == o.environment &&
      external_id == o.external_id &&
      failed_on == o.failed_on &&
      failure_reason == o.failure_reason &&
      id == o.id &&
      labels == o.labels &&
      language == o.language &&
      line_items == o.line_items &&
      linked_space_id == o.linked_space_id &&
      next_attempt_on == o.next_attempt_on &&
      planned_purge_date == o.planned_purge_date &&
      processing_started_on == o.processing_started_on &&
      processing_timeout_on == o.processing_timeout_on &&
      reference == o.reference &&
      review_started_on == o.review_started_on &&
      reviewed_on == o.reviewed_on &&
      reviewer == o.reviewer &&
      source == o.source &&
      source_entity_id == o.source_entity_id &&
      space_view_id == o.space_view_id &&
      state == o.state &&
      version == o.version
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



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 414

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



480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 480

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



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 393

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


380
381
382
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 380

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



386
387
388
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 386

def hash
  [amount, billing_address, closed_on, collector_configuration, contract_date, created_on, creator, currency, due_date, environment, external_id, failed_on, failure_reason, id, labels, language, line_items, linked_space_id, next_attempt_on, planned_purge_date, processing_started_on, processing_timeout_on, reference, review_started_on, reviewed_on, reviewer, source, source_entity_id, space_view_id, state, version].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



329
330
331
332
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 329

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



460
461
462
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 460

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



466
467
468
469
470
471
472
473
474
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 466

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



454
455
456
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 454

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



336
337
338
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 336

def valid?
  true
end