Class: CyberSource::VasV2PaymentsPost201ResponseTaxInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VasV2PaymentsPost201ResponseTaxInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 49

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

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

Instance Attribute Details

#commit_indicator ⇒ Object

Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is “Committed.” For an uncommitted tax transaction, the status in the Tax Detail Report is “Uncommitted.” Possible values: - ‘true`: This is a committed tax transaction. - `false` (default): This is not a committed tax transaction. A committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed. The committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit. Use a void service request to cancel a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders. Optional for U.S., Canadian, international tax, and value added taxes. For more information on Tax Detail Report features refer the [Tax Service Guide](developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).



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

def commit_indicator
  @commit_indicator
end

#refund_indicator ⇒ Object

Indicates whether this is a refund tax transaction. For a refund tax transaction, amounts in the Tax Detail Report will be negative. Possible values: - ‘true`: This is a refund tax transaction. - `false` (default): This is not a refund tax transaction. A refund tax request is a tax service request that sets the transaction type field in the Tax Detail Report to refunded and makes the reported amount negative. Tax amounts are returned as positive amounts in reply messages, but they are saved in reports as negative amounts which enables the reporting software to accurately calculate the aggregate amounts. Optional for U.S., Canadian, international tax, and value added taxes. For more information on Tax Detail Report features refer the [Tax Service Guide](developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).



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

def refund_indicator
  @refund_indicator
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 24

def self.attribute_map
  {
    :'commit_indicator' => :'commitIndicator',
    :'refund_indicator' => :'refundIndicator'
  }
end

.json_map ⇒ Object

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



32
33
34
35
36
37
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 32

def self.json_map
  {
    :'commit_indicator' => :'commit_indicator',
    :'refund_indicator' => :'refund_indicator'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 40

def self.swagger_types
  {
    :'commit_indicator' => :'BOOLEAN',
    :'refund_indicator' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



79
80
81
82
83
84
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 79

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      commit_indicator == o.commit_indicator &&
      refund_indicator == o.refund_indicator
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



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
158
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 122

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



188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 188

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 101

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


88
89
90
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 88

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



94
95
96
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 94

def hash
  [commit_indicator, refund_indicator].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



66
67
68
69
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 66

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



168
169
170
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 168

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



174
175
176
177
178
179
180
181
182
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 174

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



162
163
164
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 162

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



73
74
75
 
# File 'lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb', line 73

def valid?
  true
end