Class: CyberSource::Ptsv2paymentsOrderInformationAmountDetailsOrder

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsOrderInformationAmountDetailsOrder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
123
124
125
126
127
128
129
130
131
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 90

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?(:'totalAmount')
    self.total_amount = attributes[:'totalAmount']
  end

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

  if attributes.has_key?(:'subTotalAmount')
    self.sub_total_amount = attributes[:'subTotalAmount']
  end

  if attributes.has_key?(:'handlingAmount')
    self.handling_amount = attributes[:'handlingAmount']
  end

  if attributes.has_key?(:'shippingAmount')
    self.shipping_amount = attributes[:'shippingAmount']
  end

  if attributes.has_key?(:'shippingDiscountAmount')
    self.shipping_discount_amount = attributes[:'shippingDiscountAmount']
  end

  if attributes.has_key?(:'taxAmount')
    self.tax_amount = attributes[:'taxAmount']
  end

  if attributes.has_key?(:'insuranceAmount')
    self.insurance_amount = attributes[:'insuranceAmount']
  end

  if attributes.has_key?(:'giftWrapAmount')
    self.gift_wrap_amount = attributes[:'giftWrapAmount']
  end
end

Instance Attribute Details

#currency ⇒ Object

Currency used for the order



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

def currency
  @currency
end

#gift_wrap_amount ⇒ Object

Amount being charged as gift wrap fee.



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

def gift_wrap_amount
  @gift_wrap_amount
end

#handling_amount ⇒ Object

Aggregate handling charges for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value.



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

def handling_amount
  @handling_amount
end

#insurance_amount ⇒ Object

Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal.



38
39
40
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 38

def insurance_amount
  @insurance_amount
end

#shipping_amount ⇒ Object

Aggregate shipping charges for the transaction If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value.



29
30
31
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 29

def shipping_amount
  @shipping_amount
end

#shipping_discount_amount ⇒ Object

Shipping discount amount for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value.



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

def shipping_discount_amount
  @shipping_discount_amount
end

#sub_total_amount ⇒ Object

Shipping discount amount for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value.



23
24
25
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 23

def sub_total_amount
  @sub_total_amount
end

#tax_amount ⇒ Object

Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation.



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

def tax_amount
  @tax_amount
end

#total_amount ⇒ Object

Grand total for the order. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places



17
18
19
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 17

def total_amount
  @total_amount
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 44

def self.attribute_map
  {
    :'total_amount' => :'totalAmount',
    :'currency' => :'currency',
    :'sub_total_amount' => :'subTotalAmount',
    :'handling_amount' => :'handlingAmount',
    :'shipping_amount' => :'shippingAmount',
    :'shipping_discount_amount' => :'shippingDiscountAmount',
    :'tax_amount' => :'taxAmount',
    :'insurance_amount' => :'insuranceAmount',
    :'gift_wrap_amount' => :'giftWrapAmount'
  }
end

.json_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 59

def self.json_map
  {
    :'total_amount' => :'total_amount',
    :'currency' => :'currency',
    :'sub_total_amount' => :'sub_total_amount',
    :'handling_amount' => :'handling_amount',
    :'shipping_amount' => :'shipping_amount',
    :'shipping_discount_amount' => :'shipping_discount_amount',
    :'tax_amount' => :'tax_amount',
    :'insurance_amount' => :'insurance_amount',
    :'gift_wrap_amount' => :'gift_wrap_amount'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 74

def self.swagger_types
  {
    :'total_amount' => :'String',
    :'currency' => :'String',
    :'sub_total_amount' => :'String',
    :'handling_amount' => :'String',
    :'shipping_amount' => :'String',
    :'shipping_discount_amount' => :'String',
    :'tax_amount' => :'String',
    :'insurance_amount' => :'String',
    :'gift_wrap_amount' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total_amount == o.total_amount &&
      currency == o.currency &&
      sub_total_amount == o.sub_total_amount &&
      handling_amount == o.handling_amount &&
      shipping_amount == o.shipping_amount &&
      shipping_discount_amount == o.shipping_discount_amount &&
      tax_amount == o.tax_amount &&
      insurance_amount == o.insurance_amount &&
      gift_wrap_amount == o.gift_wrap_amount
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



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
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 252

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 318

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 231

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


218
219
220
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



224
225
226
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 224

def hash
  [total_amount, currency, sub_total_amount, handling_amount, shipping_amount, shipping_discount_amount, tax_amount, insurance_amount, gift_wrap_amount].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



135
136
137
138
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 135

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



298
299
300
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 298

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



304
305
306
307
308
309
310
311
312
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 304

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



292
293
294
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 292

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



142
143
144
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb', line 142

def valid?
  true
end