Class: CyberSource::TssV2TransactionsGet200ResponseOrderInformationLineItems

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TssV2TransactionsGet200ResponseOrderInformationLineItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
91
92
93
94
95
96
97
98
99
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 66

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

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

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

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

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

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

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

Instance Attribute Details

#fulfillment_type ⇒ Object

The description for this field is not available.



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

def fulfillment_type
  @fulfillment_type
end

#product_code ⇒ Object

Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is default. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields quantity, productName, and productSKU are required.



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

def product_code
  @product_code
end

#product_name ⇒ Object

For PAYMENT and CAPTURE API, this field is required when above productCode is not default or one of the values related to shipping and handling.



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

def product_name
  @product_name
end

#product_sku ⇒ Object

Identification code for the product. For Payment and Capture APIs, this field is required when above ‘productCode` is not default or one of the values related to shipping and/or handling.



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

def product_sku
  @product_sku
end

#quantity ⇒ Object

For a payment or capture, this field is required when productCode is not default or one of the values related to shipping and handling.



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

def quantity
  @quantity
end

#tax_amount ⇒ Object

Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. - 1st line item has ‘amount=10.00`, `quantity=1`, and `taxAmount=0.80` - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60` 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. For details, see `tax_amount` field description in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)



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

def tax_amount
  @tax_amount
end

#unit_price ⇒ Object

Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def unit_price
  @unit_price
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 39

def self.attribute_map
  {
    :'product_code' => :'productCode',
    :'product_name' => :'productName',
    :'product_sku' => :'productSku',
    :'tax_amount' => :'taxAmount',
    :'quantity' => :'quantity',
    :'unit_price' => :'unitPrice',
    :'fulfillment_type' => :'fulfillmentType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'product_code' => :'String',
    :'product_name' => :'String',
    :'product_sku' => :'String',
    :'tax_amount' => :'String',
    :'quantity' => :'Integer',
    :'unit_price' => :'String',
    :'fulfillment_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      product_code == o.product_code &&
      product_name == o.product_name &&
      product_sku == o.product_sku &&
      tax_amount == o.tax_amount &&
      quantity == o.quantity &&
      unit_price == o.unit_price &&
      fulfillment_type == o.fulfillment_type
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



218
219
220
221
222
223
224
225
226
227
228
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
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 218

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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 284

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 197

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


184
185
186
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 190

def hash
  [product_code, product_name, product_sku, tax_amount, quantity, unit_price, fulfillment_type].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



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 103

def list_invalid_properties
  invalid_properties = Array.new
  if !@quantity.nil? && @quantity > 999999999
    invalid_properties.push('invalid value for "quantity", must be smaller than or equal to 999999999.')
  end

  if !@quantity.nil? && @quantity < 1
    invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
  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



264
265
266
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 264

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



270
271
272
273
274
275
276
277
278
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 270

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



258
259
260
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 258

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



118
119
120
121
122
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb', line 118

def valid?
  return false if !@quantity.nil? && @quantity > 999999999
  return false if !@quantity.nil? && @quantity < 1
  true
end