class CyberSource::VasV2PaymentsPost201ResponseOrderInformationJurisdiction

Attributes

code[RW]

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

country[RW]

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

name[RW]

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`.

rate[RW]

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

region[RW]

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`.

tax_amount[RW]

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

tax_name[RW]

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

taxable[RW]

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

type[RW]

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`

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 76
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
swagger_types() click to toggle source

Attribute type mapping.

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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 188
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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 238
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 304
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 217
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
code=(code) click to toggle source

Custom attribute writer method with validation @param [Object] code Value to be assigned

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 164
def code=(code)
  @code = code
end
country=(country) click to toggle source

Custom attribute writer method with validation @param [Object] country Value to be assigned

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 182
def country=(country)
  @country = country
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 204
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 210
def hash
  [type, tax_name, tax_amount, taxable, name, code, rate, region, country].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 121
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 158
def name=(name)
  @name = name
end
rate=(rate) click to toggle source

Custom attribute writer method with validation @param [Object] rate Value to be assigned

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 170
def rate=(rate)
  @rate = rate
end
region=(region) click to toggle source

Custom attribute writer method with validation @param [Object] region Value to be assigned

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 176
def region=(region)
  @region = region
end
tax_amount=(tax_amount) click to toggle source

Custom attribute writer method with validation @param [Object] tax_amount Value to be assigned

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 146
def tax_amount=(tax_amount)
  @tax_amount = tax_amount
end
tax_name=(tax_name) click to toggle source

Custom attribute writer method with validation @param [Object] tax_name Value to be assigned

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 140
def tax_name=(tax_name)
  @tax_name = tax_name
end
taxable=(taxable) click to toggle source

Custom attribute writer method with validation @param [Object] taxable Value to be assigned

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 152
def taxable=(taxable)
  @taxable = taxable
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 284
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 290
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 278
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method with validation @param [Object] type Value to be assigned

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 134
def type=(type)
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb, line 128
def valid?
  true
end