Class: CyberSource::InlineResponse2002OrderInformationLineItems

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineResponse2002OrderInformationLineItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



115
116
117
118
119
120
121
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 115

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'taxDetails')
    if (value = attributes[:'taxDetails']).is_a?(Array)
      self.tax_details = value
    end
  end
end

Instance Attribute Details

#amount_includes_tax ⇒ Object

Flag that indicates whether the tax amount is included in the Line Item Total.



48
49
50
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 48

def amount_includes_tax
  @amount_includes_tax
end

#commodity_code ⇒ Object

Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes.



51
52
53
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 51

def commodity_code
  @commodity_code
end

#discount_amount ⇒ Object

Discount applied to the item.



54
55
56
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 54

def discount_amount
  @discount_amount
end

#discount_applied ⇒ Object

Flag that indicates whether the amount is discounted. If you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets this field to true.



57
58
59
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 57

def discount_applied
  @discount_applied
end

#discount_rate ⇒ Object

Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%)



60
61
62
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 60

def discount_rate
  @discount_rate
end

#invoice_number ⇒ Object

Field to support an invoice number for a transaction. You must specify the number of line items that will include an invoice number. By default, the first line item will include an invoice number field. The invoice number field can be included for up to 10 line items.



63
64
65
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 63

def invoice_number
  @invoice_number
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_client/models/inline_response_200_2_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_client/models/inline_response_200_2_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 API, 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_client/models/inline_response_200_2_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.



27
28
29
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 27

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.



39
40
41
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 39

def tax_amount
  @tax_amount
end

#tax_details ⇒ Object

Returns the value of attribute tax_details.



65
66
67
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 65

def tax_details
  @tax_details
end

#tax_rate ⇒ Object

Tax rate applied to the item. See "Numbered Elements," page 14. 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%).



42
43
44
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 42

def tax_rate
  @tax_rate
end

#tax_type_code ⇒ Object

Type of tax being applied to the item. Possible values: Below values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, Litle - 0000: unknown tax type - 0001: federal/national sales tax - 0002: state sales tax - 0003: city sales tax - 0004: local sales tax - 0005: municipal sales tax - 0006: other tax - 0010: value-added tax - 0011: goods and services tax - 0012: provincial sales tax - 0013: harmonized sales tax - 0014: Quebec sales tax (QST) - 0020: room tax - 0021: occupancy tax - 0022: energy tax - Blank: Tax not supported on line item.



45
46
47
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 45

def tax_type_code
  @tax_type_code
end

#total_amount ⇒ Object

Total amount for the item. Normally calculated as the unit price x quantity.



36
37
38
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 36

def total_amount
  @total_amount
end

#unit_of_measure ⇒ Object

Unit of measure, or unit of measure code, for the item.



33
34
35
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 33

def unit_of_measure
  @unit_of_measure
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)



30
31
32
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 30

def unit_price
  @unit_price
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 68

def self.attribute_map
  {
    :'product_code' => :'productCode',
    :'product_name' => :'productName',
    :'product_sku' => :'productSku',
    :'quantity' => :'quantity',
    :'unit_price' => :'unitPrice',
    :'unit_of_measure' => :'unitOfMeasure',
    :'total_amount' => :'totalAmount',
    :'tax_amount' => :'taxAmount',
    :'tax_rate' => :'taxRate',
    :'tax_type_code' => :'taxTypeCode',
    :'amount_includes_tax' => :'amountIncludesTax',
    :'commodity_code' => :'commodityCode',
    :'discount_amount' => :'discountAmount',
    :'discount_applied' => :'discountApplied',
    :'discount_rate' => :'discountRate',
    :'invoice_number' => :'invoiceNumber',
    :'tax_details' => :'taxDetails'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 91

def self.swagger_types
  {
    :'product_code' => :'String',
    :'product_name' => :'String',
    :'product_sku' => :'String',
    :'quantity' => :'Float',
    :'unit_price' => :'String',
    :'unit_of_measure' => :'String',
    :'total_amount' => :'String',
    :'tax_amount' => :'String',
    :'tax_rate' => :'String',
    :'tax_type_code' => :'String',
    :'amount_includes_tax' => :'BOOLEAN',
    :'commodity_code' => :'String',
    :'discount_amount' => :'String',
    :'discount_applied' => :'BOOLEAN',
    :'discount_rate' => :'String',
    :'invoice_number' => :'String',
    :'tax_details' => :'Array<V2paymentsOrderInformationAmountDetailsTaxDetails>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 426

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 &&
      quantity == o.quantity &&
      unit_price == o.unit_price &&
      unit_of_measure == o.unit_of_measure &&
      total_amount == o.total_amount &&
      tax_amount == o.tax_amount &&
      tax_rate == o.tax_rate &&
      tax_type_code == o.tax_type_code &&
      amount_includes_tax == o.amount_includes_tax &&
      commodity_code == o.commodity_code &&
      discount_amount == o.discount_amount &&
      discount_applied == o.discount_applied &&
      discount_rate == o.discount_rate &&
      invoice_number == o.invoice_number &&
      tax_details == o.tax_details
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



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 484

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



550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 550

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



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 463

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


450
451
452
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 450

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



456
457
458
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 456

def hash
  [product_code, product_name, product_sku, quantity, unit_price, unit_of_measure, total_amount, tax_amount, tax_rate, tax_type_code, amount_includes_tax, commodity_code, discount_amount, discount_applied, discount_rate, invoice_number, tax_details].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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
255
256
257
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 194

def list_invalid_properties
  invalid_properties = Array.new
  if !@product_code.nil? && @product_code.to_s.length > 255
    invalid_properties.push('invalid value for "product_code", the character length must be smaller than or equal to 255.')
  end

  if !@product_name.nil? && @product_name.to_s.length > 255
    invalid_properties.push('invalid value for "product_name", the character length must be smaller than or equal to 255.')
  end

  if !@product_sku.nil? && @product_sku.to_s.length > 255
    invalid_properties.push('invalid value for "product_sku", the character length must be smaller than or equal to 255.')
  end

  if !@quantity.nil? && @quantity > 9999999999
    invalid_properties.push('invalid value for "quantity", must be smaller than or equal to 9999999999.')
  end

  if !@quantity.nil? && @quantity < 1
    invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
  end

  if !@unit_price.nil? && @unit_price.to_s.length > 15
    invalid_properties.push('invalid value for "unit_price", the character length must be smaller than or equal to 15.')
  end

  if !@unit_of_measure.nil? && @unit_of_measure.to_s.length > 12
    invalid_properties.push('invalid value for "unit_of_measure", the character length must be smaller than or equal to 12.')
  end

  if !@total_amount.nil? && @total_amount.to_s.length > 13
    invalid_properties.push('invalid value for "total_amount", the character length must be smaller than or equal to 13.')
  end

  if !@tax_amount.nil? && @tax_amount.to_s.length > 15
    invalid_properties.push('invalid value for "tax_amount", the character length must be smaller than or equal to 15.')
  end

  if !@tax_rate.nil? && @tax_rate.to_s.length > 7
    invalid_properties.push('invalid value for "tax_rate", the character length must be smaller than or equal to 7.')
  end

  if !@tax_type_code.nil? && @tax_type_code.to_s.length > 4
    invalid_properties.push('invalid value for "tax_type_code", the character length must be smaller than or equal to 4.')
  end

  if !@commodity_code.nil? && @commodity_code.to_s.length > 15
    invalid_properties.push('invalid value for "commodity_code", the character length must be smaller than or equal to 15.')
  end

  if !@discount_amount.nil? && @discount_amount.to_s.length > 13
    invalid_properties.push('invalid value for "discount_amount", the character length must be smaller than or equal to 13.')
  end

  if !@discount_rate.nil? && @discount_rate.to_s.length > 6
    invalid_properties.push('invalid value for "discount_rate", the character length must be smaller than or equal to 6.')
  end

  if !@invoice_number.nil? && @invoice_number.to_s.length > 23
    invalid_properties.push('invalid value for "invoice_number", the character length must be smaller than or equal to 23.')
  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



530
531
532
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 530

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



536
537
538
539
540
541
542
543
544
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 536

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



524
525
526
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 524

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/cyberSource_client/models/inline_response_200_2_order_information_line_items.rb', line 261

def valid?
  return false if !@product_code.nil? && @product_code.to_s.length > 255
  return false if !@product_name.nil? && @product_name.to_s.length > 255
  return false if !@product_sku.nil? && @product_sku.to_s.length > 255
  return false if !@quantity.nil? && @quantity > 9999999999
  return false if !@quantity.nil? && @quantity < 1
  return false if !@unit_price.nil? && @unit_price.to_s.length > 15
  return false if !@unit_of_measure.nil? && @unit_of_measure.to_s.length > 12
  return false if !@total_amount.nil? && @total_amount.to_s.length > 13
  return false if !@tax_amount.nil? && @tax_amount.to_s.length > 15
  return false if !@tax_rate.nil? && @tax_rate.to_s.length > 7
  return false if !@tax_type_code.nil? && @tax_type_code.to_s.length > 4
  return false if !@commodity_code.nil? && @commodity_code.to_s.length > 15
  return false if !@discount_amount.nil? && @discount_amount.to_s.length > 13
  return false if !@discount_rate.nil? && @discount_rate.to_s.length > 6
  return false if !@invoice_number.nil? && @invoice_number.to_s.length > 23
  true
end