Class: WalleeRubySdk::DebtCollectionCaseCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-ruby-sdk/models/debt_collection_case_create.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 = {}) ⇒ DebtCollectionCaseCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#collector_configuration ⇒ Object

The configuration that the case is processed with.



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

def collector_configuration
  @collector_configuration
end

#contract_date ⇒ Object

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



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

def contract_date
  @contract_date
end

#currency ⇒ Object

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



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

def currency
  @currency
end

#due_date ⇒ Object

The date and time when the claim was due.



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

def due_date
  @due_date
end

#environment ⇒ Object

Returns the value of attribute environment.



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

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.



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

def external_id
  @external_id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#line_items ⇒ Object

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



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

def line_items
  @line_items
end

#reference ⇒ Object

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



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

def reference
  @reference
end

#space_view_id ⇒ Object

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



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

def space_view_id
  @space_view_id
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



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

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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 83

def self.attribute_map
  {
    :'line_items' => :'lineItems',
    :'contract_date' => :'contractDate',
    :'environment' => :'environment',
    :'due_date' => :'dueDate',
    :'currency' => :'currency',
    :'language' => :'language',
    :'billing_address' => :'billingAddress',
    :'space_view_id' => :'spaceViewId',
    :'reference' => :'reference',
    :'external_id' => :'externalId',
    :'collector_configuration' => :'collectorConfiguration'
  }
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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 284

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



133
134
135
136
137
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 133

def self.openapi_all_of
  [
  :'AbstractDebtCollectionCaseUpdate'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 110

def self.openapi_types
  {
    :'line_items' => :'Array<LineItemCreate>',
    :'contract_date' => :'Time',
    :'environment' => :'DebtCollectionEnvironment',
    :'due_date' => :'Time',
    :'currency' => :'String',
    :'language' => :'String',
    :'billing_address' => :'AddressCreate',
    :'space_view_id' => :'Integer',
    :'reference' => :'String',
    :'external_id' => :'String',
    :'collector_configuration' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      line_items == o.line_items &&
      contract_date == o.contract_date &&
      environment == o.environment &&
      due_date == o.due_date &&
      currency == o.currency &&
      language == o.language &&
      billing_address == o.billing_address &&
      space_view_id == o.space_view_id &&
      reference == o.reference &&
      external_id == o.external_id &&
      collector_configuration == o.collector_configuration
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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 379

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


271
272
273
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 277

def hash
  [line_items, contract_date, environment, due_date, currency, language, billing_address, space_view_id, reference, external_id, collector_configuration].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



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 208

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @reference.nil?
    invalid_properties.push('invalid value for "reference", reference cannot be nil.')
  end

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



355
356
357
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 355

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 361

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



349
350
351
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 349

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



224
225
226
227
228
229
 
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_create.rb', line 224

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @reference.nil?
  return false if @external_id.nil?
  true
end