Class: CyberSource::Ptsv2paymentsTravelInformationAutoRentalTaxDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsTravelInformationAutoRentalTaxDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 61

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Indicates the amount of tax based on the ‘type` field as described in the table below:



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

def amount
  @amount
end

#applied ⇒ Object

Flag that indicates whether the tax amount (‘travelInformation.autoRental.taxDetails.amount`) is included in the request. Possible values: - `false`: tax amount is not included in the request. - `true`: tax amount is included in the request.



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

def applied
  @applied
end

#exemption_code ⇒ Object

Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.



27
28
29
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 27

def exemption_code
  @exemption_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)



21
22
23
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 21

def rate
  @rate
end

#tax_summary ⇒ Object

Summary of all tax types



33
34
35
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 33

def tax_summary
  @tax_summary
end

#tax_type ⇒ Object

Different taxes the rental agency applies to the rental agreement such as tourist tax, airport tax, or rental tax.



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

def tax_type
  @tax_type
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 36

def self.attribute_map
  {
    :'amount' => :'amount',
    :'rate' => :'rate',
    :'applied' => :'applied',
    :'exemption_code' => :'exemptionCode',
    :'tax_type' => :'taxType',
    :'tax_summary' => :'taxSummary'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 48

def self.swagger_types
  {
    :'amount' => :'String',
    :'rate' => :'String',
    :'applied' => :'BOOLEAN',
    :'exemption_code' => :'String',
    :'tax_type' => :'String',
    :'tax_summary' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 182

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



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
261
262
263
264
265
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 229

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 295

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 208

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


195
196
197
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



201
202
203
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 201

def hash
  [amount, rate, applied, exemption_code, tax_type, tax_summary].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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 94

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

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

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



275
276
277
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 275

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



281
282
283
284
285
286
287
288
289
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 281

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



269
270
271
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 269

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



121
122
123
124
125
126
127
128
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb', line 121

def valid?
  return false if !@amount.nil? && @amount.to_s.length > 13
  return false if !@rate.nil? && @rate.to_s.length > 6
  return false if !@exemption_code.nil? && @exemption_code.to_s.length > 1
  return false if !@tax_type.nil? && @tax_type.to_s.length > 10
  return false if !@tax_summary.nil? && @tax_summary.to_s.length > 12
  true
end