Class: WalleeRubySdk::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.

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
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
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 223

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::DebtCollectionCase` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `WalleeRubySdk::DebtCollectionCase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The sum of all unpaid item prices in the case’s currency. The amount can no longer be changed once the case has been reviewed.



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

def amount
  @amount
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#closed_on ⇒ Object

The date and time when the case was closed.



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

def closed_on
  @closed_on
end

#collector_configuration ⇒ Object

Returns the value of attribute collector_configuration.



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

def collector_configuration
  @collector_configuration
end

#contract_date ⇒ Object

The date and time when the contract with the debtor was signed.



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

def contract_date
  @contract_date
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#creator ⇒ Object

The ID of the user the case was created by.



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

def creator
  @creator
end

#currency ⇒ Object

The three-letter code (ISO 4217 format) of the case’s currency.



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

def currency
  @currency
end

#due_date ⇒ Object

The date and time when the claim was due.



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

def due_date
  @due_date
end

#environment ⇒ Object

Returns the value of attribute environment.



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

def environment
  @environment
end

#external_id ⇒ Object

A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.



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

def external_id
  @external_id
end

#failed_on ⇒ Object

The date and time when the case failed.



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

def failed_on
  @failed_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



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

def failure_reason
  @failure_reason
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#labels ⇒ Object

The labels providing additional information about the object.



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

def labels
  @labels
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#line_items ⇒ Object

The line items that are subject of this debt collection case.



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

def line_items
  @line_items
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#next_attempt_on ⇒ Object

The date and time when the next attempt at processing the case will be made.



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

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.



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

def planned_purge_date
  @planned_purge_date
end

#processing_started_on ⇒ Object

The date and time when the processing of the case was started.



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

def processing_started_on
  @processing_started_on
end

#processing_timeout_on ⇒ Object

The date and time when the processing of the case times out.



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

def processing_timeout_on
  @processing_timeout_on
end

#reference ⇒ Object

A unique reference to identify the debt collection case in communication with the debtor.



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

def reference
  @reference
end

#review_started_on ⇒ Object

The date and time when the review of the case was started.



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

def review_started_on
  @review_started_on
end

#reviewed_on ⇒ Object

The date and time when the case was reviewed.



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

def reviewed_on
  @reviewed_on
end

#reviewer ⇒ Object

The ID of the user the case was reviewed by.



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

def reviewer
  @reviewer
end

#source ⇒ Object

Returns the value of attribute source.



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

def source
  @source
end

#source_entity_id ⇒ Object

The ID of the object that is the source of the case. Only defined if the case was created by an internal process.



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

def source_entity_id
  @source_entity_id
end

#space_view_id ⇒ Object

The ID of the space view this object is linked to.



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

def space_view_id
  @space_view_id
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

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



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 465

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = WalleeRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



174
175
176
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 174

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.build_from_hash(attributes) ⇒ Object

Returns the model itself

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 441

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



216
217
218
219
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 216

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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/wallee-ruby-sdk/models/debt_collection_case.rb', line 179

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 392

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



536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 536

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


430
431
432
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 430

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



436
437
438
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 436

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



367
368
369
370
371
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 367

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



512
513
514
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 512

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



518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 518

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



506
507
508
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 506

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



375
376
377
378
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case.rb', line 375

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end