Class: PostfinancecheckoutRubySdk::TransactionVoid

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionVoid

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  if attributes.key?(:'created_on')
    self.created_on = attributes[:'created_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?(:'mode')
    self.mode = attributes[:'mode']
  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?(:'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?(:'failure_reason')
    self.failure_reason = attributes[:'failure_reason']
  end

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

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

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

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

#created_by ⇒ Object

The ID of the user the transaction void was created by.



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

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#failed_on ⇒ Object

The date and time when the transaction void failed.



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

def failed_on
  @failed_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



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

def failure_reason
  @failure_reason
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#labels ⇒ Object

The labels providing additional information about the object.



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

def labels
  @labels
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#linked_transaction ⇒ Object

The payment transaction this object is linked to.



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

def linked_transaction
  @linked_transaction
end

#mode ⇒ Object

Returns the value of attribute mode.



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

def mode
  @mode
end

#next_update_on ⇒ Object

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



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

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.



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

def planned_purge_date
  @planned_purge_date
end

#processor_reference ⇒ Object

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



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

def processor_reference
  @processor_reference
end

#space_view_id ⇒ Object

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



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

def space_view_id
  @space_view_id
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#succeeded_on ⇒ Object

The date and time when the transaction void succeeded.



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

def succeeded_on
  @succeeded_on
end

#timeout_on ⇒ Object

The date and time when the object will expire.



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

def timeout_on
  @timeout_on
end

#transaction ⇒ Object

Returns the value of attribute transaction.



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

def transaction
  @transaction
end

#version ⇒ Object

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



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

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



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
390
391
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 354

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



129
130
131
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 129

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



134
135
136
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 134

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 104

def self.attribute_map
  {
    :'planned_purge_date' => :'plannedPurgeDate',
    :'language' => :'language',
    :'space_view_id' => :'spaceViewId',
    :'created_on' => :'createdOn',
    :'version' => :'version',
    :'labels' => :'labels',
    :'mode' => :'mode',
    :'linked_space_id' => :'linkedSpaceId',
    :'timeout_on' => :'timeoutOn',
    :'created_by' => :'createdBy',
    :'next_update_on' => :'nextUpdateOn',
    :'failure_reason' => :'failureReason',
    :'succeeded_on' => :'succeededOn',
    :'id' => :'id',
    :'state' => :'state',
    :'linked_transaction' => :'linkedTransaction',
    :'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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 330

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



164
165
166
167
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 164

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

.openapi_types ⇒ Object

Attribute type mapping.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 139

def self.openapi_types
  {
    :'planned_purge_date' => :'Time',
    :'language' => :'String',
    :'space_view_id' => :'Integer',
    :'created_on' => :'Time',
    :'version' => :'Integer',
    :'labels' => :'Array<Label>',
    :'mode' => :'TransactionVoidMode',
    :'linked_space_id' => :'Integer',
    :'timeout_on' => :'Time',
    :'created_by' => :'Integer',
    :'next_update_on' => :'Time',
    :'failure_reason' => :'FailureReason',
    :'succeeded_on' => :'Time',
    :'id' => :'Integer',
    :'state' => :'TransactionVoidState',
    :'linked_transaction' => :'Integer',
    :'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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 291

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      planned_purge_date == o.planned_purge_date &&
      language == o.language &&
      space_view_id == o.space_view_id &&
      created_on == o.created_on &&
      version == o.version &&
      labels == o.labels &&
      mode == o.mode &&
      linked_space_id == o.linked_space_id &&
      timeout_on == o.timeout_on &&
      created_by == o.created_by &&
      next_update_on == o.next_update_on &&
      failure_reason == o.failure_reason &&
      succeeded_on == o.succeeded_on &&
      id == o.id &&
      state == o.state &&
      linked_transaction == o.linked_transaction &&
      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



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

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


317
318
319
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



323
324
325
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 323

def hash
  [planned_purge_date, language, space_view_id, created_on, version, labels, mode, linked_space_id, timeout_on, created_by, next_update_on, failure_reason, succeeded_on, id, state, linked_transaction, 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



266
267
268
269
270
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 266

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



401
402
403
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 401

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 407

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



395
396
397
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 395

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



274
275
276
277
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_void.rb', line 274

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