Class: Yapstone::ProcessPayment

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

Overview

Process payment object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProcessPayment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
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
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 63

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

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

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

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

Instance Attribute Details

#channel ⇒ Object

The mode of communication (or channel) used to process the payment.



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

def channel
  @channel
end

#client_correlation_id ⇒ Object

A unique identifier that is attached to all transactions that have to do with a particular payment. You can track all the steps a payment went through using this ID.



22
23
24
 
# File 'lib/yapstone-payments/models/process_payment.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). You can use this to identify duplicate requests.



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

def client_unique_transaction_id
  @client_unique_transaction_id
end

#custom_data ⇒ Object

Returns the value of attribute custom_data.



33
34
35
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 33

def custom_data
  @custom_data
end

#customer ⇒ Object

Returns the value of attribute customer.



29
30
31
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 29

def customer
  @customer
end

#marketplace ⇒ Object

Returns the value of attribute marketplace.



27
28
29
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 27

def marketplace
  @marketplace
end

#payment_details ⇒ Object

Returns the value of attribute payment_details.



31
32
33
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 31

def payment_details
  @payment_details
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 36

def self.attribute_map
  {
    :'channel' => :'channel',
    :'client_correlation_id' => :'clientCorrelationId',
    :'client_unique_transaction_id' => :'clientUniqueTransactionId',
    :'marketplace' => :'marketplace',
    :'customer' => :'customer',
    :'payment_details' => :'paymentDetails',
    :'custom_data' => :'customData'
  }
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



197
198
199
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 197

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 49

def self.openapi_types
  {
    :'channel' => :'String',
    :'client_correlation_id' => :'String',
    :'client_unique_transaction_id' => :'String',
    :'marketplace' => :'MarketplaceData',
    :'customer' => :'Customer',
    :'payment_details' => :'PaymentDetails',
    :'custom_data' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 170

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



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

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 290

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 204

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


184
185
186
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



190
191
192
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 190

def hash
  [channel, client_correlation_id, client_unique_transaction_id, marketplace, customer, payment_details, custom_data].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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 109

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

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

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

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



270
271
272
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 270

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



276
277
278
279
280
281
282
283
284
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 276

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



264
265
266
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 264

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



132
133
134
135
136
137
138
 
# File 'lib/yapstone-payments/models/process_payment.rb', line 132

def valid?
  return false if !@client_correlation_id.nil? && @client_correlation_id.to_s.length > 128
  return false if !@client_correlation_id.nil? && @client_correlation_id.to_s.length < 0
  return false if !@client_unique_transaction_id.nil? && @client_unique_transaction_id.to_s.length > 128
  return false if !@client_unique_transaction_id.nil? && @client_unique_transaction_id.to_s.length < 0
  true
end