Class: CyberSource::CapturePaymentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/capture_payment_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CapturePaymentRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



107
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
163
164
165
166
167
168
169
170
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 107

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'clientReferenceInformation')
    self.client_reference_information = attributes[:'clientReferenceInformation']
  end

  if attributes.has_key?(:'processingInformation')
    self.processing_information = attributes[:'processingInformation']
  end

  if attributes.has_key?(:'paymentInformation')
    self.payment_information = attributes[:'paymentInformation']
  end

  if attributes.has_key?(:'orderInformation')
    self.order_information = attributes[:'orderInformation']
  end

  if attributes.has_key?(:'buyerInformation')
    self.buyer_information = attributes[:'buyerInformation']
  end

  if attributes.has_key?(:'deviceInformation')
    self.device_information = attributes[:'deviceInformation']
  end

  if attributes.has_key?(:'merchantInformation')
    self.merchant_information = attributes[:'merchantInformation']
  end

  if attributes.has_key?(:'aggregatorInformation')
    self.aggregator_information = attributes[:'aggregatorInformation']
  end

  if attributes.has_key?(:'pointOfSaleInformation')
    self.point_of_sale_information = attributes[:'pointOfSaleInformation']
  end

  if attributes.has_key?(:'merchantDefinedInformation')
    if (value = attributes[:'merchantDefinedInformation']).is_a?(Array)
      self.merchant_defined_information = value
    end
  end

  if attributes.has_key?(:'merchantDefinedSecureInformation')
    self.merchant_defined_secure_information = attributes[:'merchantDefinedSecureInformation']
  end

  if attributes.has_key?(:'installmentInformation')
    self.installment_information = attributes[:'installmentInformation']
  end

  if attributes.has_key?(:'travelInformation')
    self.travel_information = attributes[:'travelInformation']
  end

  if attributes.has_key?(:'promotionInformation')
    self.promotion_information = attributes[:'promotionInformation']
  end
end

Instance Attribute Details

#aggregator_information ⇒ Object

Returns the value of attribute aggregator_information.



30
31
32
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 30

def aggregator_information
  @aggregator_information
end

#buyer_information ⇒ Object

Returns the value of attribute buyer_information.



24
25
26
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 24

def buyer_information
  @buyer_information
end

#client_reference_information ⇒ Object

Returns the value of attribute client_reference_information.



16
17
18
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 16

def client_reference_information
  @client_reference_information
end

#device_information ⇒ Object

Returns the value of attribute device_information.



26
27
28
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 26

def device_information
  @device_information
end

#installment_information ⇒ Object

Returns the value of attribute installment_information.



39
40
41
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 39

def installment_information
  @installment_information
end

#merchant_defined_information ⇒ Object

The object containing the custom data that the merchant defines.



35
36
37
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 35

def merchant_defined_information
  @merchant_defined_information
end

#merchant_defined_secure_information ⇒ Object

Returns the value of attribute merchant_defined_secure_information.



37
38
39
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 37

def merchant_defined_secure_information
  @merchant_defined_secure_information
end

#merchant_information ⇒ Object

Returns the value of attribute merchant_information.



28
29
30
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 28

def merchant_information
  @merchant_information
end

#order_information ⇒ Object

Returns the value of attribute order_information.



22
23
24
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 22

def order_information
  @order_information
end

#payment_information ⇒ Object

Returns the value of attribute payment_information.



20
21
22
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 20

def payment_information
  @payment_information
end

#point_of_sale_information ⇒ Object

Returns the value of attribute point_of_sale_information.



32
33
34
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 32

def point_of_sale_information
  @point_of_sale_information
end

#processing_information ⇒ Object

Returns the value of attribute processing_information.



18
19
20
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 18

def processing_information
  @processing_information
end

#promotion_information ⇒ Object

Returns the value of attribute promotion_information.



43
44
45
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 43

def promotion_information
  @promotion_information
end

#travel_information ⇒ Object

Returns the value of attribute travel_information.



41
42
43
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 41

def travel_information
  @travel_information
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 46

def self.attribute_map
  {
    :'client_reference_information' => :'clientReferenceInformation',
    :'processing_information' => :'processingInformation',
    :'payment_information' => :'paymentInformation',
    :'order_information' => :'orderInformation',
    :'buyer_information' => :'buyerInformation',
    :'device_information' => :'deviceInformation',
    :'merchant_information' => :'merchantInformation',
    :'aggregator_information' => :'aggregatorInformation',
    :'point_of_sale_information' => :'pointOfSaleInformation',
    :'merchant_defined_information' => :'merchantDefinedInformation',
    :'merchant_defined_secure_information' => :'merchantDefinedSecureInformation',
    :'installment_information' => :'installmentInformation',
    :'travel_information' => :'travelInformation',
    :'promotion_information' => :'promotionInformation'
  }
end

.json_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 66

def self.json_map
  {
    :'client_reference_information' => :'client_reference_information',
    :'processing_information' => :'processing_information',
    :'payment_information' => :'payment_information',
    :'order_information' => :'order_information',
    :'buyer_information' => :'buyer_information',
    :'device_information' => :'device_information',
    :'merchant_information' => :'merchant_information',
    :'aggregator_information' => :'aggregator_information',
    :'point_of_sale_information' => :'point_of_sale_information',
    :'merchant_defined_information' => :'merchant_defined_information',
    :'merchant_defined_secure_information' => :'merchant_defined_secure_information',
    :'installment_information' => :'installment_information',
    :'travel_information' => :'travel_information',
    :'promotion_information' => :'promotion_information'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 86

def self.swagger_types
  {
    :'client_reference_information' => :'Ptsv2paymentsClientReferenceInformation',
    :'processing_information' => :'Ptsv2paymentsidcapturesProcessingInformation',
    :'payment_information' => :'Ptsv2paymentsidcapturesPaymentInformation',
    :'order_information' => :'Ptsv2paymentsidcapturesOrderInformation',
    :'buyer_information' => :'Ptsv2paymentsidcapturesBuyerInformation',
    :'device_information' => :'Ptsv2paymentsidcapturesDeviceInformation',
    :'merchant_information' => :'Ptsv2paymentsidcapturesMerchantInformation',
    :'aggregator_information' => :'Ptsv2paymentsidcapturesAggregatorInformation',
    :'point_of_sale_information' => :'Ptsv2paymentsidcapturesPointOfSaleInformation',
    :'merchant_defined_information' => :'Array<Ptsv2paymentsMerchantDefinedInformation>',
    :'merchant_defined_secure_information' => :'Ptsv2paymentsMerchantDefinedSecureInformation',
    :'installment_information' => :'Ptsv2paymentsidcapturesInstallmentInformation',
    :'travel_information' => :'Ptsv2paymentsTravelInformation',
    :'promotion_information' => :'Ptsv2paymentsPromotionInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_reference_information == o.client_reference_information &&
      processing_information == o.processing_information &&
      payment_information == o.payment_information &&
      order_information == o.order_information &&
      buyer_information == o.buyer_information &&
      device_information == o.device_information &&
      merchant_information == o.merchant_information &&
      aggregator_information == o.aggregator_information &&
      point_of_sale_information == o.point_of_sale_information &&
      merchant_defined_information == o.merchant_defined_information &&
      merchant_defined_secure_information == o.merchant_defined_secure_information &&
      installment_information == o.installment_information &&
      travel_information == o.travel_information &&
      promotion_information == o.promotion_information
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



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
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 242

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
    temp_model = CyberSource.const_get(type).new
    temp_model.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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 308

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 221

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


208
209
210
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



214
215
216
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 214

def hash
  [client_reference_information, processing_information, payment_information, order_information, buyer_information, device_information, merchant_information, aggregator_information, point_of_sale_information, merchant_defined_information, merchant_defined_secure_information, installment_information, travel_information, promotion_information].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



174
175
176
177
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 174

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



288
289
290
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 288

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



294
295
296
297
298
299
300
301
302
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 294

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



282
283
284
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 282

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



181
182
183
 
# File 'lib/cybersource_rest_client/models/capture_payment_request.rb', line 181

def valid?
  true
end