Class: Yapstone::PaymentResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/yapstone-payments/models/payment_response.rb

Overview

The PaymentResponse schema provides details about a payment that enable you to track the payment and refer to it easily

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 72

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

The action that was taken for this phase of the payment.



19
20
21
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 19

def action
  @action
end

#client_correlation_id ⇒ Object

Optionally provide your system’s internal identifier for this entity, for use later if you need to correlate data across systems or consolidate records.



22
23
24
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 22

def client_correlation_id
  @client_correlation_id
end

#client_unique_transaction_id ⇒ Object

This is the unique transaction ID for one transaction to do with a payment being processed. You can use this to retrieve a specific transaction vs. a set of associated transactions (which is what you would use the clientCorrelationId for).



25
26
27
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 25

def client_unique_transaction_id
  @client_unique_transaction_id
end

#custom_data ⇒ Object

Returns the value of attribute custom_data.



36
37
38
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 36

def custom_data
  @custom_data
end

#customer ⇒ Object

Returns the value of attribute customer.



32
33
34
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 32

def customer
  @customer
end

#marketplace ⇒ Object

Returns the value of attribute marketplace.



34
35
36
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 34

def marketplace
  @marketplace
end

#payment ⇒ Object

Returns the value of attribute payment.



30
31
32
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 30

def payment
  @payment
end

#payment_id ⇒ Object

The payment ID allows you to reference the payment if you need to cancel it or retrieve it.



28
29
30
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 28

def payment_id
  @payment_id
end

#refund_id ⇒ Object

Returns the value of attribute refund_id.



38
39
40
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 38

def refund_id
  @refund_id
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 41

def self.attribute_map
  {
    :'action' => :'action',
    :'client_correlation_id' => :'clientCorrelationId',
    :'client_unique_transaction_id' => :'clientUniqueTransactionId',
    :'payment_id' => :'paymentId',
    :'payment' => :'payment',
    :'customer' => :'customer',
    :'marketplace' => :'marketplace',
    :'custom_data' => :'customData',
    :'refund_id' => :'refundId'
  }
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



168
169
170
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 168

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 56

def self.openapi_types
  {
    :'action' => :'String',
    :'client_correlation_id' => :'String',
    :'client_unique_transaction_id' => :'String',
    :'payment_id' => :'String',
    :'payment' => :'Payment',
    :'customer' => :'CustomerDetails',
    :'marketplace' => :'Merketplace',
    :'custom_data' => :'Hash<String, String>',
    :'refund_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 139

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      client_correlation_id == o.client_correlation_id &&
      client_unique_transaction_id == o.client_unique_transaction_id &&
      payment_id == o.payment_id &&
      payment == o.payment &&
      customer == o.customer &&
      marketplace == o.marketplace &&
      custom_data == o.custom_data &&
      refund_id == o.refund_id
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



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
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 196

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
    Yapstone.const_get(type).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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 261

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 175

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


155
156
157
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



161
162
163
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 161

def hash
  [action, client_correlation_id, client_unique_transaction_id, payment_id, payment, customer, marketplace, custom_data, refund_id].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



126
127
128
129
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 126

def list_invalid_properties
  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



241
242
243
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 241

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



247
248
249
250
251
252
253
254
255
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 247

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



235
236
237
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 235

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



133
134
135
 
# File 'lib/yapstone-payments/models/payment_response.rb', line 133

def valid?
  true
end