Class: PostfinancecheckoutRubySdk::Refund

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

Overview

A refund is a credit issued to the customer, which can be initiated either by the merchant or by the customer as a reversal.

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
364
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/postfinancecheckout-ruby-sdk/models/refund.rb', line 236

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::Refund` 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 `PostfinancecheckoutRubySdk::Refund`. 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?(:'total_settled_amount')
    self.total_settled_amount = attributes[:'total_settled_amount']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The total monetary amount of the refund, representing the exact credit issued to the customer.



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

def amount
  @amount
end

#base_line_items ⇒ Object

The original base line items from the transaction prior to the refund, serving as a reference for the refunded amounts.



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

def base_line_items
  @base_line_items
end

#completion ⇒ Object

The transaction completion that the refund belongs to.



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

def completion
  @completion
end

#created_by ⇒ Object

The ID of the user the refund was created by.



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

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#environment ⇒ Object

Returns the value of attribute environment.



96
97
98
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.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.



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

def external_id
  @external_id
end

#failed_on ⇒ Object

The date and time when the refund failed.



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

def failed_on
  @failed_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



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

def failure_reason
  @failure_reason
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#labels ⇒ Object

The labels providing additional information about the object.



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

def labels
  @labels
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#line_items ⇒ Object

The line items included in the refund, representing the reductions.



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

def line_items
  @line_items
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#merchant_reference ⇒ Object

The merchant’s reference used to identify the refund.



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

def merchant_reference
  @merchant_reference
end

#next_update_on ⇒ Object

The date and time when the next update of the object’s state is planned.



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

def next_update_on
  @next_update_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.



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

def planned_purge_date
  @planned_purge_date
end

#processing_on ⇒ Object

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



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

def processing_on
  @processing_on
end

#processor_reference ⇒ Object

The reference ID provided by the payment processor, used to trace the refund through the external payment system.



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

def processor_reference
  @processor_reference
end

#reduced_line_items ⇒ Object

The line items from the original transaction, adjusted to reflect any reductions applied during the refund process.



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

def reduced_line_items
  @reduced_line_items
end

#reductions ⇒ Object

The reductions applied on the original transaction items, detailing specific adjustments associated with the refund.



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

def reductions
  @reductions
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#succeeded_on ⇒ Object

The date and time when the refund succeeded.



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

def succeeded_on
  @succeeded_on
end

#taxes ⇒ Object

The tax breakdown applied to the refund amount, helping with tax calculations or reporting.



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

def taxes
  @taxes
end

#time_zone ⇒ Object

The time zone that this object is associated with.



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

def time_zone
  @time_zone
end

#timeout_on ⇒ Object

The date and time when the object will expire.



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

def timeout_on
  @timeout_on
end

#total_applied_fees ⇒ Object

The sum of fees applied to the refund transaction, such as processing or service charges.



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

def total_applied_fees
  @total_applied_fees
end

#total_settled_amount ⇒ Object

The total amount settled for the refund, factoring in reductions, taxes, and any additional applied fees.



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

def total_settled_amount
  @total_settled_amount
end

#transaction ⇒ Object

Returns the value of attribute transaction.



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

def transaction
  @transaction
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#updated_invoice ⇒ Object

An updated invoice reflecting adjustments made by the refund.



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

def updated_invoice
  @updated_invoice
end

#version ⇒ Object

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



85
86
87
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.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



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 592

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



181
182
183
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 181

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



186
187
188
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 186

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 568

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



229
230
231
232
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 229

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 516

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



663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 663

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


555
556
557
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 555

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



561
562
563
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 561

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



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

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

  pattern = Regexp.new(/[ \x20-\x7e]*/)
  if !@merchant_reference.nil? && @merchant_reference !~ pattern
    invalid_properties.push("invalid value for \"merchant_reference\", must conform to the pattern #{pattern}.")
  end

  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

  pattern = Regexp.new(/[ \x20-\x7e]*/)
  if !@external_id.nil? && @external_id !~ pattern
    invalid_properties.push("invalid value for \"external_id\", must conform to the pattern #{pattern}.")
  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



639
640
641
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 639

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



645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 645

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



633
634
635
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 633

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



427
428
429
430
431
432
433
434
435
436
 
# File 'lib/postfinancecheckout-ruby-sdk/models/refund.rb', line 427

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100
  return false if !@merchant_reference.nil? && @merchant_reference !~ Regexp.new(/[ \x20-\x7e]*/)
  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 !@external_id.nil? && @external_id !~ Regexp.new(/[ \x20-\x7e]*/)
  return false if !@processor_reference.nil? && @processor_reference.to_s.length > 150
  true
end