Class: WhiteLabelMachineName::Refund

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

Overview

The refund represents a credit back to the customer. It can be issued by the merchant or by the customer (reversal).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Refund

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 197

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?(:'baseLineItems')
    if (value = attributes[:'baseLineItems']).is_a?(Array)
      self.base_line_items = value
    end
  end

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

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

  if attributes.has_key?(:'createdOn')
    self.created_on = attributes[:'createdOn']
  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?(:'merchantReference')
    self.merchant_reference = attributes[:'merchantReference']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



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

def amount
  @amount
end

#base_line_items ⇒ Object

Returns the value of attribute base_line_items.



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

def base_line_items
  @base_line_items
end

#completion ⇒ Object

Returns the value of attribute completion.



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

def completion
  @completion
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#created_on ⇒ Object

The created on date indicates the date on which the entity was stored into the database.



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

def created_on
  @created_on
end

#environment ⇒ Object

Returns the value of attribute environment.



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

def environment
  @environment
end

#external_id ⇒ Object

The external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.



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

def external_id
  @external_id
end

#failed_on ⇒ Object

Returns the value of attribute failed_on.



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

def failed_on
  @failed_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



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

def failure_reason
  @failure_reason
end

#id ⇒ Object

The ID is the primary key of the entity. The ID identifies the entity uniquely.



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

def id
  @id
end

#labels ⇒ Object

Returns the value of attribute labels.



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

def labels
  @labels
end

#language ⇒ Object

Returns the value of attribute language.



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

def language
  @language
end

#line_items ⇒ Object

Returns the value of attribute line_items.



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

def line_items
  @line_items
end

#linked_space_id ⇒ Object

The linked space id holds the ID of the space to which the entity belongs to.



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

def linked_space_id
  @linked_space_id
end

#merchant_reference ⇒ Object

Returns the value of attribute merchant_reference.



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

def merchant_reference
  @merchant_reference
end

#next_update_on ⇒ Object

Returns the value of attribute next_update_on.



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

def next_update_on
  @next_update_on
end

#planned_purge_date ⇒ Object

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.



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

def planned_purge_date
  @planned_purge_date
end

#processing_on ⇒ Object

Returns the value of attribute processing_on.



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

def processing_on
  @processing_on
end

#processor_reference ⇒ Object

Returns the value of attribute processor_reference.



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

def processor_reference
  @processor_reference
end

#reduced_line_items ⇒ Object

Returns the value of attribute reduced_line_items.



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

def reduced_line_items
  @reduced_line_items
end

#reductions ⇒ Object

Returns the value of attribute reductions.



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

def reductions
  @reductions
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#succeeded_on ⇒ Object

Returns the value of attribute succeeded_on.



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

def succeeded_on
  @succeeded_on
end

#taxes ⇒ Object

Returns the value of attribute taxes.



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

def taxes
  @taxes
end

#time_zone ⇒ Object

Returns the value of attribute time_zone.



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

def time_zone
  @time_zone
end

#timeout_on ⇒ Object

Returns the value of attribute timeout_on.



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

def timeout_on
  @timeout_on
end

#total_applied_fees ⇒ Object

The total applied fees is the sum of all fees that have been applied so far.



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

def total_applied_fees
  @total_applied_fees
end

#total_settled_amount ⇒ Object

The total settled amount is the total amount which has been settled so far.



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

def total_settled_amount
  @total_settled_amount
end

#transaction ⇒ Object

Returns the value of attribute transaction.



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

def transaction
  @transaction
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#updated_invoice ⇒ Object

Returns the value of attribute updated_invoice.



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

def updated_invoice
  @updated_invoice
end

#version ⇒ Object

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.



117
118
119
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 117

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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
152
153
154
155
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 120

def self.attribute_map
  {
    :'amount' => :'amount',
    :'base_line_items' => :'baseLineItems',
    :'completion' => :'completion',
    :'created_by' => :'createdBy',
    :'created_on' => :'createdOn',
    :'environment' => :'environment',
    :'external_id' => :'externalId',
    :'failed_on' => :'failedOn',
    :'failure_reason' => :'failureReason',
    :'id' => :'id',
    :'labels' => :'labels',
    :'language' => :'language',
    :'line_items' => :'lineItems',
    :'linked_space_id' => :'linkedSpaceId',
    :'merchant_reference' => :'merchantReference',
    :'next_update_on' => :'nextUpdateOn',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'processing_on' => :'processingOn',
    :'processor_reference' => :'processorReference',
    :'reduced_line_items' => :'reducedLineItems',
    :'reductions' => :'reductions',
    :'state' => :'state',
    :'succeeded_on' => :'succeededOn',
    :'taxes' => :'taxes',
    :'time_zone' => :'timeZone',
    :'timeout_on' => :'timeoutOn',
    :'total_applied_fees' => :'totalAppliedFees',
    :'total_settled_amount' => :'totalSettledAmount',
    :'transaction' => :'transaction',
    :'type' => :'type',
    :'updated_invoice' => :'updatedInvoice',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 158

def self.swagger_types
  {
    :'amount' => :'Float',
    :'base_line_items' => :'Array<LineItem>',
    :'completion' => :'Integer',
    :'created_by' => :'Integer',
    :'created_on' => :'DateTime',
    :'environment' => :'Environment',
    :'external_id' => :'String',
    :'failed_on' => :'DateTime',
    :'failure_reason' => :'FailureReason',
    :'id' => :'Integer',
    :'labels' => :'Array<Label>',
    :'language' => :'String',
    :'line_items' => :'Array<LineItem>',
    :'linked_space_id' => :'Integer',
    :'merchant_reference' => :'String',
    :'next_update_on' => :'DateTime',
    :'planned_purge_date' => :'DateTime',
    :'processing_on' => :'DateTime',
    :'processor_reference' => :'String',
    :'reduced_line_items' => :'Array<LineItem>',
    :'reductions' => :'Array<LineItemReduction>',
    :'state' => :'RefundState',
    :'succeeded_on' => :'DateTime',
    :'taxes' => :'Array<Tax>',
    :'time_zone' => :'String',
    :'timeout_on' => :'DateTime',
    :'total_applied_fees' => :'Float',
    :'total_settled_amount' => :'Float',
    :'transaction' => :'Transaction',
    :'type' => :'RefundType',
    :'updated_invoice' => :'Integer',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



413
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 413

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      base_line_items == o.base_line_items &&
      completion == o.completion &&
      created_by == o.created_by &&
      created_on == o.created_on &&
      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 &&
      merchant_reference == o.merchant_reference &&
      next_update_on == o.next_update_on &&
      planned_purge_date == o.planned_purge_date &&
      processing_on == o.processing_on &&
      processor_reference == o.processor_reference &&
      reduced_line_items == o.reduced_line_items &&
      reductions == o.reductions &&
      state == o.state &&
      succeeded_on == o.succeeded_on &&
      taxes == o.taxes &&
      time_zone == o.time_zone &&
      timeout_on == o.timeout_on &&
      total_applied_fees == o.total_applied_fees &&
      total_settled_amount == o.total_settled_amount &&
      transaction == o.transaction &&
      type == o.type &&
      updated_invoice == o.updated_invoice &&
      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



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 486

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



552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 552

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



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 465

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


452
453
454
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 452

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



458
459
460
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 458

def hash
  [amount, base_line_items, completion, created_by, created_on, environment, external_id, failed_on, failure_reason, id, labels, language, line_items, linked_space_id, merchant_reference, next_update_on, planned_purge_date, processing_on, processor_reference, reduced_line_items, reductions, state, succeeded_on, taxes, time_zone, timeout_on, total_applied_fees, total_settled_amount, transaction, type, updated_invoice, 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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 346

def list_invalid_properties
  invalid_properties = Array.new
  if !@external_id.nil? && @external_id.to_s.length > 100
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 100.')
  end

  if !@external_id.nil? && @external_id.to_s.length < 1
    invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
  end

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

  if !@processor_reference.nil? && @processor_reference.to_s.length > 150
    invalid_properties.push('invalid value for "processor_reference", the character length must be smaller than or equal to 150.')
  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



532
533
534
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 532

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



538
539
540
541
542
543
544
545
546
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 538

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



526
527
528
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 526

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



369
370
371
372
373
374
375
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/refund.rb', line 369

def valid?
  return false if !@external_id.nil? && @external_id.to_s.length > 100
  return false if !@external_id.nil? && @external_id.to_s.length < 1
  return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100
  return false if !@processor_reference.nil? && @processor_reference.to_s.length > 150
  true
end