Class: CyberSource::VasV2PaymentsPost201ResponseOrderInformationJurisdiction

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VasV2PaymentsPost201ResponseOrderInformationJurisdiction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
132
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb', line 91

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

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

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

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

Jurisdiction code assigned by the tax provider. Returned only if the ‘taxInformation.showTaxPerLineItem` field is set to `Yes`.



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

def code
  @code
end

#country ⇒ Object

Tax jurisdiction country for the item. Returned only if the ‘taxInformation.showTaxPerLineItem` field is set to `Yes`.



42
43
44
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb', line 42

def country
  @country
end

#name ⇒ Object

Free-text description of the jurisdiction for the item. For example, San Mateo County. Returned only if the ‘taxInformation.showTaxPerLineItem` field is set to `Yes`.



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

def name
  @name
end

#rate ⇒ Object

Jurisdiction tax rate for the item. Returned only if the ‘taxInformation.showTaxPerLineItem` field is set to `Yes`.



36
37
38
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb', line 36

def rate
  @rate
end

#region ⇒ Object

Free-text description of the jurisdiction region for the item. For example, CA (California State) or GB (Great Britain). Returned only if the ‘taxInformation.showTaxPerLineItem` field is set to `Yes`.



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

def region
  @region
end

#tax_amount ⇒ Object

Jurisdiction tax amount for the item. Returned only if the ‘taxInformation.showTaxPerLineItem` field is set to `Yes`.



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

def tax_amount
  @tax_amount
end

#tax_name ⇒ Object

Name of the jurisdiction tax for the item. For example, CA State Tax. Returned only if the ‘taxInformation.showTaxPerLineItem` field is set to `Yes`.



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

def tax_name
  @tax_name
end

#taxable ⇒ Object

Jurisdiction taxable amount for the item, not including product level exemptions. Returned only if the ‘taxInformation.showTaxPerLineItem` field is set to `Yes`.



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

def taxable
  @taxable
end

#type ⇒ Object

Type of tax jurisdiction for the item. Returned only if the ‘taxInformation.showTaxPerLineItem` field is set to `Yes`. Possible values: - `city` - `county` - `state` - `country` - `special`



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'type' => :'type',
    :'tax_name' => :'taxName',
    :'tax_amount' => :'taxAmount',
    :'taxable' => :'taxable',
    :'name' => :'name',
    :'code' => :'code',
    :'rate' => :'rate',
    :'region' => :'region',
    :'country' => :'country'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'type' => :'type',
    :'tax_name' => :'tax_name',
    :'tax_amount' => :'tax_amount',
    :'taxable' => :'taxable',
    :'name' => :'name',
    :'code' => :'code',
    :'rate' => :'rate',
    :'region' => :'region',
    :'country' => :'country'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'type' => :'String',
    :'tax_name' => :'String',
    :'tax_amount' => :'String',
    :'taxable' => :'String',
    :'name' => :'String',
    :'code' => :'String',
    :'rate' => :'String',
    :'region' => :'String',
    :'country' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      tax_name == o.tax_name &&
      tax_amount == o.tax_amount &&
      taxable == o.taxable &&
      name == o.name &&
      code == o.code &&
      rate == o.rate &&
      region == o.region &&
      country == o.country
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



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
289
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb', line 253

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



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

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



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

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


219
220
221
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



225
226
227
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb', line 225

def hash
  [type, tax_name, tax_amount, taxable, name, code, rate, region, country].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



136
137
138
139
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb', line 136

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



299
300
301
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb', line 299

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



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

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



293
294
295
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb', line 293

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



143
144
145
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb', line 143

def valid?
  true
end