Class: CyberSource::V2paymentsOrderInformationAmountDetailsTaxDetails

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V2paymentsOrderInformationAmountDetailsTaxDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Please see below table for related decription based on above type field. | type | amount description | |———–|——————–| | alternate | Total amount of alternate tax for the order. | | local | Sales tax for the order. | | national | National tax for the order. | | vat | Total amount of VAT or other tax included in the order. |



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

def amount
  @amount
end

#applied ⇒ Object

The tax is applied. Valid value is ‘true` or `false`.



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

def applied
  @applied
end

#code ⇒ Object

Type of tax being applied to the item. Possible values: Below values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, Litle - 0000: unknown tax type - 0001: federal/national sales tax - 0002: state sales tax - 0003: city sales tax - 0004: local sales tax - 0005: municipal sales tax - 0006: other tax - 0010: value-added tax - 0011: goods and services tax - 0012: provincial sales tax - 0013: harmonized sales tax - 0014: Quebec sales tax (QST) - 0020: room tax - 0021: occupancy tax - 0022: energy tax - Blank: Tax not supported on line item.



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

def code
  @code
end

#rate ⇒ Object

Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated)



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

def rate
  @rate
end

#tax_id ⇒ Object

Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount.



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

def tax_id
  @tax_id
end

#type ⇒ Object

This is used to determine what type of tax related data should be inclued under taxDetails object.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 58

def self.attribute_map
  {
    :'type' => :'type',
    :'amount' => :'amount',
    :'rate' => :'rate',
    :'code' => :'code',
    :'tax_id' => :'taxId',
    :'applied' => :'applied'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 70

def self.swagger_types
  {
    :'type' => :'String',
    :'amount' => :'String',
    :'rate' => :'String',
    :'code' => :'String',
    :'tax_id' => :'String',
    :'applied' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 201

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      amount == o.amount &&
      rate == o.rate &&
      code == o.code &&
      tax_id == o.tax_id &&
      applied == o.applied
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



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
279
280
281
282
283
284
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 248

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 314

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 227

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


214
215
216
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 220

def hash
  [type, amount, rate, code, tax_id, applied].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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 116

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

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

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

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



294
295
296
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 294

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



300
301
302
303
304
305
306
307
308
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 300

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



288
289
290
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 288

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



139
140
141
142
143
144
145
146
147
 
# File 'lib/cyberSource_client/models/v2payments_order_information_amount_details_tax_details.rb', line 139

def valid?
  type_validator = EnumAttributeValidator.new('String', ['alternate', 'local', 'national', 'vat'])
  return false unless type_validator.valid?(@type)
  return false if !@amount.nil? && @amount.to_s.length > 13
  return false if !@rate.nil? && @rate.to_s.length > 6
  return false if !@code.nil? && @code.to_s.length > 4
  return false if !@tax_id.nil? && @tax_id.to_s.length > 15
  true
end