Class: CyberSource::Ptsv2paymentsOrderInformationLineItems

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsOrderInformationLineItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 236

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

  if attributes.has_key?(:'taxStatusIndicator')
    self.tax_status_indicator = attributes[:'taxStatusIndicator']
  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?(:'typeOfSupply')
    self.type_of_supply = attributes[:'typeOfSupply']
  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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allowed_export_countries ⇒ Object

Returns the value of attribute allowed_export_countries.



110
111
112
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 110

def allowed_export_countries
  @allowed_export_countries
end

#amount_includes_tax ⇒ Object

Flag that indicates whether the tax amount is included in the Line Item Total. Possible values: - true - false



53
54
55
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 53

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.



59
60
61
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 59

def commodity_code
  @commodity_code
end

#discount_amount ⇒ Object

Discount applied to the item.



62
63
64
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 62

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. Possible values: - true - false



65
66
67
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 65

def discount_applied
  @discount_applied
end

#discount_rate ⇒ Object

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



68
69
70
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 68

def discount_rate
  @discount_rate
end

#fulfillment_type ⇒ Object

Information about the product code used for the line item. Possible values: - ‘E`: The product code is `electronic_software`. - `P`: The product code is not `electronic_software`. For details, see the `fulfillmentType` field description in [Business Center Reporting User Guide.] (apps.cybersource.com/library/documentation/dev_guides/reporting_and_reconciliation/Reporting_User/html/)



76
77
78
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 76

def fulfillment_type
  @fulfillment_type
end

#gift ⇒ Object

This field is only used in DM service. Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - true: Orders are assigned only slight additional risk if billing and shipping addresses are different. - false: Orders are assigned higher additional risk if billing and shipping addresses are different.



106
107
108
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 106

def gift
  @gift
end

#gift_card_currency ⇒ Object

When ‘orderInformation.lineItems[].productCode` is "gift_card", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)



100
101
102
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 100

def gift_card_currency
  @gift_card_currency
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.



71
72
73
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 71

def invoice_number
  @invoice_number
end

#passenger ⇒ Object

Returns the value of attribute passenger.



108
109
110
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 108

def passenger
  @passenger
end

#product_code ⇒ Object

Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is ‘default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don’t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you’ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].



17
18
19
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 17

def product_code
  @product_code
end

#product_description ⇒ Object

Brief description of item.



97
98
99
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 97

def product_description
  @product_description
end

#product_name ⇒ Object

For an authorization or capture transaction (‘processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes.



20
21
22
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 20

def product_name
  @product_name
end

#product_sku ⇒ Object

Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (‘processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to default or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling.



23
24
25
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 23

def product_sku
  @product_sku
end

#quantity ⇒ Object

Number of units for this order. Must be a non-negative integer. The default is ‘1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes.



26
27
28
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 26

def quantity
  @quantity
end

#reference_data_code ⇒ Object

Code that identifies the value of the corresponding ‘orderInformation.lineItems[].referenceDataNumber` field. Possible values: - AN: Client-defined asset code - MG: Manufacturer’s part number - PO: Purchase order number - SK: Supplier stock keeping unit number - UP: Universal product code - VC: Supplier catalog number - VP: Vendor part number This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.



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

def reference_data_code
  @reference_data_code
end

#reference_data_number ⇒ Object

Reference number. The meaning of this value is identified by the value of the corresponding ‘referenceDataCode` field. See Numbered Elements. The maximum length for this field depends on the value of the corresponding `referenceDataCode` field: - When the code is `PO`, the maximum length for the reference number is 22. - When the code is `VC`, the maximum length for the reference number is 20. - For all other codes, the maximum length for the reference number is 30. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.



91
92
93
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 91

def reference_data_number
  @reference_data_number
end

#restricted_export_countries ⇒ Object

Returns the value of attribute restricted_export_countries.



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

def restricted_export_countries
  @restricted_export_countries
end

#shipping_destination_types ⇒ Object

Destination to where the item will be shipped. Example: Commercial, Residential, Store



103
104
105
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 103

def shipping_destination_types
  @shipping_destination_types
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. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine



38
39
40
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 38

def tax_amount
  @tax_amount
end

#tax_applied_after_discount ⇒ Object

Flag to indicate how you handle discount at the line item level. - 0: no line level discount provided - 1: tax was calculated on the post-discount line item total - 2: tax was calculated on the pre-discount line item total ‘Note` Visa will inset 0 (zero) if an invalid value is included in this field. This field relates to the value in the lineItems[].discountAmount field.



44
45
46
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 44

def tax_applied_after_discount
  @tax_applied_after_discount
end

#tax_details ⇒ Object

Returns the value of attribute tax_details.



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

def tax_details
  @tax_details
end

#tax_rate ⇒ Object

Tax rate applied to the item. 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%).



41
42
43
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 41

def tax_rate
  @tax_rate
end

#tax_status_indicator ⇒ Object

Flag to indicate whether tax is exempted or not included. - 0: tax not included - 1: tax included - 2: transaction is not subject to tax



47
48
49
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 47

def tax_status_indicator
  @tax_status_indicator
end

#tax_type_code ⇒ Object

Type of tax being applied to the item. #### FDC Nashville Global - ‘alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator`



50
51
52
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 50

def tax_type_code
  @tax_type_code
end

#total_amount ⇒ Object

Total amount for the item. Normally calculated as the unit price times quantity. When ‘orderInformation.lineItems[].productCode` is "gift_card", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123



35
36
37
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 35

def total_amount
  @total_amount
end

#type_of_supply ⇒ Object

Flag to indicate whether the purchase is categorized as goods or services. Possible values: - 00: goods - 01: services



56
57
58
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 56

def type_of_supply
  @type_of_supply
end

#unit_of_measure ⇒ Object

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



32
33
34
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 32

def unit_of_measure
  @unit_of_measure
end

#unit_price ⇒ Object

Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field ‘orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15)



29
30
31
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 29

def unit_price
  @unit_price
end

#unit_tax_amount ⇒ Object

Per-item tax amount of the product. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point.



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

def unit_tax_amount
  @unit_tax_amount
end

#weight ⇒ Object

Weight of the item.



79
80
81
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 79

def weight
  @weight
end

#weight_identifier ⇒ Object

Type of weight. Possible values: - B: Billed weight - N: Actual net weight



82
83
84
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 82

def weight_identifier
  @weight_identifier
end

#weight_unit ⇒ Object

Code that specifies the unit of measurement for the weight amount. For example, ‘OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC).



85
86
87
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 85

def weight_unit
  @weight_unit
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 115

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_applied_after_discount' => :'taxAppliedAfterDiscount',
    :'tax_status_indicator' => :'taxStatusIndicator',
    :'tax_type_code' => :'taxTypeCode',
    :'amount_includes_tax' => :'amountIncludesTax',
    :'type_of_supply' => :'typeOfSupply',
    :'commodity_code' => :'commodityCode',
    :'discount_amount' => :'discountAmount',
    :'discount_applied' => :'discountApplied',
    :'discount_rate' => :'discountRate',
    :'invoice_number' => :'invoiceNumber',
    :'tax_details' => :'taxDetails',
    :'fulfillment_type' => :'fulfillmentType',
    :'weight' => :'weight',
    :'weight_identifier' => :'weightIdentifier',
    :'weight_unit' => :'weightUnit',
    :'reference_data_code' => :'referenceDataCode',
    :'reference_data_number' => :'referenceDataNumber',
    :'unit_tax_amount' => :'unitTaxAmount',
    :'product_description' => :'productDescription',
    :'gift_card_currency' => :'giftCardCurrency',
    :'shipping_destination_types' => :'shippingDestinationTypes',
    :'gift' => :'gift',
    :'passenger' => :'passenger',
    :'allowed_export_countries' => :'allowedExportCountries',
    :'restricted_export_countries' => :'restrictedExportCountries'
  }
end

.json_map ⇒ Object

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



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
191
192
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 155

def self.json_map
  {
    :'product_code' => :'product_code',
    :'product_name' => :'product_name',
    :'product_sku' => :'product_sku',
    :'quantity' => :'quantity',
    :'unit_price' => :'unit_price',
    :'unit_of_measure' => :'unit_of_measure',
    :'total_amount' => :'total_amount',
    :'tax_amount' => :'tax_amount',
    :'tax_rate' => :'tax_rate',
    :'tax_applied_after_discount' => :'tax_applied_after_discount',
    :'tax_status_indicator' => :'tax_status_indicator',
    :'tax_type_code' => :'tax_type_code',
    :'amount_includes_tax' => :'amount_includes_tax',
    :'type_of_supply' => :'type_of_supply',
    :'commodity_code' => :'commodity_code',
    :'discount_amount' => :'discount_amount',
    :'discount_applied' => :'discount_applied',
    :'discount_rate' => :'discount_rate',
    :'invoice_number' => :'invoice_number',
    :'tax_details' => :'tax_details',
    :'fulfillment_type' => :'fulfillment_type',
    :'weight' => :'weight',
    :'weight_identifier' => :'weight_identifier',
    :'weight_unit' => :'weight_unit',
    :'reference_data_code' => :'reference_data_code',
    :'reference_data_number' => :'reference_data_number',
    :'unit_tax_amount' => :'unit_tax_amount',
    :'product_description' => :'product_description',
    :'gift_card_currency' => :'gift_card_currency',
    :'shipping_destination_types' => :'shipping_destination_types',
    :'gift' => :'gift',
    :'passenger' => :'passenger',
    :'allowed_export_countries' => :'allowed_export_countries',
    :'restricted_export_countries' => :'restricted_export_countries'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 195

def self.swagger_types
  {
    :'product_code' => :'String',
    :'product_name' => :'String',
    :'product_sku' => :'String',
    :'quantity' => :'Integer',
    :'unit_price' => :'String',
    :'unit_of_measure' => :'String',
    :'total_amount' => :'String',
    :'tax_amount' => :'String',
    :'tax_rate' => :'String',
    :'tax_applied_after_discount' => :'String',
    :'tax_status_indicator' => :'String',
    :'tax_type_code' => :'String',
    :'amount_includes_tax' => :'BOOLEAN',
    :'type_of_supply' => :'String',
    :'commodity_code' => :'String',
    :'discount_amount' => :'String',
    :'discount_applied' => :'BOOLEAN',
    :'discount_rate' => :'String',
    :'invoice_number' => :'String',
    :'tax_details' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails>',
    :'fulfillment_type' => :'String',
    :'weight' => :'String',
    :'weight_identifier' => :'String',
    :'weight_unit' => :'String',
    :'reference_data_code' => :'String',
    :'reference_data_number' => :'String',
    :'unit_tax_amount' => :'String',
    :'product_description' => :'String',
    :'gift_card_currency' => :'Integer',
    :'shipping_destination_types' => :'String',
    :'gift' => :'BOOLEAN',
    :'passenger' => :'Ptsv2paymentsOrderInformationPassenger',
    :'allowed_export_countries' => :'Array<String>',
    :'restricted_export_countries' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 544

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_applied_after_discount == o.tax_applied_after_discount &&
      tax_status_indicator == o.tax_status_indicator &&
      tax_type_code == o.tax_type_code &&
      amount_includes_tax == o.amount_includes_tax &&
      type_of_supply == o.type_of_supply &&
      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 &&
      fulfillment_type == o.fulfillment_type &&
      weight == o.weight &&
      weight_identifier == o.weight_identifier &&
      weight_unit == o.weight_unit &&
      reference_data_code == o.reference_data_code &&
      reference_data_number == o.reference_data_number &&
      unit_tax_amount == o.unit_tax_amount &&
      product_description == o.product_description &&
      gift_card_currency == o.gift_card_currency &&
      shipping_destination_types == o.shipping_destination_types &&
      gift == o.gift &&
      passenger == o.passenger &&
      allowed_export_countries == o.allowed_export_countries &&
      restricted_export_countries == o.restricted_export_countries
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



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 619

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



685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 685

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



598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 598

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


585
586
587
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 585

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



591
592
593
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 591

def hash
  [product_code, product_name, product_sku, quantity, unit_price, unit_of_measure, total_amount, tax_amount, tax_rate, tax_applied_after_discount, tax_status_indicator, tax_type_code, amount_includes_tax, type_of_supply, commodity_code, discount_amount, discount_applied, discount_rate, invoice_number, tax_details, fulfillment_type, weight, weight_identifier, weight_unit, reference_data_code, reference_data_number, unit_tax_amount, product_description, gift_card_currency, shipping_destination_types, gift, passenger, allowed_export_countries, restricted_export_countries].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



387
388
389
390
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 387

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



665
666
667
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 665

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



671
672
673
674
675
676
677
678
679
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 671

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



659
660
661
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 659

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



394
395
396
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 394

def valid?
  true
end