Class: PCPServerSDK::PaymentExecution

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/payment_execution.rb

Overview

Object contains information of the payment with a specific payment method.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentExecution

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
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
156
157
158
159
160
161
162
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 108

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PCPServerSDK::PaymentExecution` 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|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PCPServerSDK::PaymentExecution`. 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?(:'payment_execution_id')
    self.payment_execution_id = attributes[:'payment_execution_id']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#card_payment_method_specific_input ⇒ Object

Returns the value of attribute card_payment_method_specific_input.



25
26
27
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 25

def card_payment_method_specific_input
  @card_payment_method_specific_input
end

#events ⇒ Object

Returns the value of attribute events.



39
40
41
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 39

def events
  @events
end

#financing_payment_method_specific_input ⇒ Object

Returns the value of attribute financing_payment_method_specific_input.



33
34
35
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 33

def financing_payment_method_specific_input
  @financing_payment_method_specific_input
end

#mobile_payment_method_specific_input ⇒ Object

Returns the value of attribute mobile_payment_method_specific_input.



27
28
29
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 27

def mobile_payment_method_specific_input
  @mobile_payment_method_specific_input
end

#payment_channel ⇒ Object

Returns the value of attribute payment_channel.



35
36
37
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 35

def payment_channel
  @payment_channel
end

#payment_execution_id ⇒ Object

Unique ID of paymentExecution.



20
21
22
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 20

def payment_execution_id
  @payment_execution_id
end

#payment_id ⇒ Object

Unique payment transaction identifier of the payment gateway.



23
24
25
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 23

def payment_id
  @payment_id
end

#redirect_payment_method_specific_input ⇒ Object

Returns the value of attribute redirect_payment_method_specific_input.



29
30
31
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 29

def redirect_payment_method_specific_input
  @redirect_payment_method_specific_input
end

#references ⇒ Object

Returns the value of attribute references.



37
38
39
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 37

def references
  @references
end

#sepa_direct_debit_payment_method_specific_input ⇒ Object

Returns the value of attribute sepa_direct_debit_payment_method_specific_input.



31
32
33
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 31

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



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
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 235

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



80
81
82
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 64

def self.attribute_map
  {
    :'payment_execution_id' => :'paymentExecutionId',
    :'payment_id' => :'paymentId',
    :'card_payment_method_specific_input' => :'cardPaymentMethodSpecificInput',
    :'mobile_payment_method_specific_input' => :'mobilePaymentMethodSpecificInput',
    :'redirect_payment_method_specific_input' => :'redirectPaymentMethodSpecificInput',
    :'sepa_direct_debit_payment_method_specific_input' => :'sepaDirectDebitPaymentMethodSpecificInput',
    :'financing_payment_method_specific_input' => :'financingPaymentMethodSpecificInput',
    :'payment_channel' => :'paymentChannel',
    :'references' => :'references',
    :'events' => :'events'
  }
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 211

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



101
102
103
104
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 85

def self.openapi_types
  {
    :'payment_execution_id' => :'String',
    :'payment_id' => :'String',
    :'card_payment_method_specific_input' => :'CardPaymentMethodSpecificInput',
    :'mobile_payment_method_specific_input' => :'MobilePaymentMethodSpecificInput',
    :'redirect_payment_method_specific_input' => :'RedirectPaymentMethodSpecificInput',
    :'sepa_direct_debit_payment_method_specific_input' => :'SepaDirectDebitPaymentMethodSpecificInput',
    :'financing_payment_method_specific_input' => :'FinancingPaymentMethodSpecificInput',
    :'payment_channel' => :'PaymentChannel',
    :'references' => :'References',
    :'events' => :'Array<PaymentEvent>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_execution_id == o.payment_execution_id &&
      payment_id == o.payment_id &&
      card_payment_method_specific_input == o.card_payment_method_specific_input &&
      mobile_payment_method_specific_input == o.mobile_payment_method_specific_input &&
      redirect_payment_method_specific_input == o.redirect_payment_method_specific_input &&
      sepa_direct_debit_payment_method_specific_input == o.sepa_direct_debit_payment_method_specific_input &&
      financing_payment_method_specific_input == o.financing_payment_method_specific_input &&
      payment_channel == o.payment_channel &&
      references == o.references &&
      events == o.events
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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 306

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


198
199
200
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 204

def hash
  [payment_execution_id, payment_id, card_payment_method_specific_input, mobile_payment_method_specific_input, redirect_payment_method_specific_input, sepa_direct_debit_payment_method_specific_input, financing_payment_method_specific_input, payment_channel, references, events].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



166
167
168
169
170
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 166

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



282
283
284
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 282

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 288

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



276
277
278
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 276

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



174
175
176
177
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_execution.rb', line 174

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