Class: CyberSource::InlineResponse2002OrderInformationAmountDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineResponse2002OrderInformationAmountDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 75

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

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

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

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

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

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

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

Instance Attribute Details

#authorized_amount ⇒ Object

Amount that was authorized.



18
19
20
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 18

def authorized_amount
  @authorized_amount
end

#currency ⇒ Object

Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.



24
25
26
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 24

def currency
  @currency
end

#discount_amount ⇒ Object

Total discount amount applied to the order. For processor-specific information, see the order_discount_amount field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



27
28
29
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 27

def discount_amount
  @discount_amount
end

#duty_amount ⇒ Object

Total charges for any import or export duties included in the order. For processor-specific information, see the duty_amount field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



30
31
32
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 30

def duty_amount
  @duty_amount
end

#freight_amount ⇒ Object

Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the totalAmount field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



39
40
41
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 39

def freight_amount
  @freight_amount
end

#national_tax_included ⇒ Object

Flag that indicates whether a national tax is included in the order total. Possible values: - 0: national tax not included - 1: national tax included For processor-specific information, see the national_tax_indicator field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



36
37
38
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 36

def national_tax_included
  @national_tax_included
end

#tax_amount ⇒ Object

Total tax amount for all the items in the order. For processor-specific information, see the total_tax_amount field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



33
34
35
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 33

def tax_amount
  @tax_amount
end

#tax_details ⇒ Object

Returns the value of attribute tax_details.



41
42
43
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 41

def tax_details
  @tax_details
end

#total_amount ⇒ Object

Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



21
22
23
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 21

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_client/models/inline_response_200_2_order_information_amount_details.rb', line 44

def self.attribute_map
  {
    :'authorized_amount' => :'authorizedAmount',
    :'total_amount' => :'totalAmount',
    :'currency' => :'currency',
    :'discount_amount' => :'discountAmount',
    :'duty_amount' => :'dutyAmount',
    :'tax_amount' => :'taxAmount',
    :'national_tax_included' => :'nationalTaxIncluded',
    :'freight_amount' => :'freightAmount',
    :'tax_details' => :'taxDetails'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'authorized_amount' => :'String',
    :'total_amount' => :'String',
    :'currency' => :'String',
    :'discount_amount' => :'String',
    :'duty_amount' => :'String',
    :'tax_amount' => :'String',
    :'national_tax_included' => :'String',
    :'freight_amount' => :'String',
    :'tax_details' => :'Array<V2paymentsOrderInformationAmountDetailsTaxDetails>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 255

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authorized_amount == o.authorized_amount &&
      total_amount == o.total_amount &&
      currency == o.currency &&
      discount_amount == o.discount_amount &&
      duty_amount == o.duty_amount &&
      tax_amount == o.tax_amount &&
      national_tax_included == o.national_tax_included &&
      freight_amount == o.freight_amount &&
      tax_details == o.tax_details
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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 305

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 371

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 284

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("#{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


271
272
273
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



277
278
279
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 277

def hash
  [authorized_amount, total_amount, currency, discount_amount, duty_amount, tax_amount, national_tax_included, freight_amount, tax_details].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



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
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 122

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

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

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

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

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

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

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

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



351
352
353
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 351

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



357
358
359
360
361
362
363
364
365
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 357

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



345
346
347
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 345

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



161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_amount_details.rb', line 161

def valid?
  return false if !@authorized_amount.nil? && @authorized_amount.to_s.length > 15
  return false if !@total_amount.nil? && @total_amount.to_s.length > 19
  return false if !@currency.nil? && @currency.to_s.length > 3
  return false if !@discount_amount.nil? && @discount_amount.to_s.length > 15
  return false if !@duty_amount.nil? && @duty_amount.to_s.length > 15
  return false if !@tax_amount.nil? && @tax_amount.to_s.length > 12
  return false if !@national_tax_included.nil? && @national_tax_included.to_s.length > 1
  return false if !@freight_amount.nil? && @freight_amount.to_s.length > 13
  true
end