Class: CyberSource::Invoicingv2invoicesOrderInformationAmountDetailsFreight

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

Overview

Contains all of the shipping-related fields for the invoice.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Invoicingv2invoicesOrderInformationAmountDetailsFreight

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 56

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

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

Instance Attribute Details

#amount ⇒ Object

Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the totalAmount field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



19
20
21
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 19

def amount
  @amount
end

#tax_rate ⇒ Object

Shipping Tax rate applied to the freight amount. Visa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). Mastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).



25
26
27
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 25

def tax_rate
  @tax_rate
end

#taxable ⇒ Object

Flag that indicates whether an order is taxable. This value must be true if the sum of all lineItems[].taxAmount values > 0. If you do not include any ‘lineItems[].taxAmount` values in your request, CyberSource does not include `invoiceDetails.taxable` in the data it sends to the processor. For processor-specific information, see the `tax_indicator` field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) Possible values: - true - false



22
23
24
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 22

def taxable
  @taxable
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 28

def self.attribute_map
  {
    :'amount' => :'amount',
    :'taxable' => :'taxable',
    :'tax_rate' => :'taxRate'
  }
end

.json_map ⇒ Object

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



37
38
39
40
41
42
43
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 37

def self.json_map
  {
    :'amount' => :'amount',
    :'taxable' => :'taxable',
    :'tax_rate' => :'tax_rate'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 46

def self.swagger_types
  {
    :'amount' => :'String',
    :'taxable' => :'BOOLEAN',
    :'tax_rate' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 102

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 146

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



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 212

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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 125

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


112
113
114
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 112

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



118
119
120
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 118

def hash
  [amount, taxable, tax_rate].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



77
78
79
80
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 77

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



192
193
194
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 192

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



198
199
200
201
202
203
204
205
206
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 198

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



186
187
188
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 186

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



84
85
86
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb', line 84

def valid?
  true
end