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



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
193
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 160

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
end

Instance Attribute Details

#amount_includes_tax ⇒ Object

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



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

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.



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

def commodity_code
  @commodity_code
end

#discount_amount ⇒ Object

Discount applied to the item.



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

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



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

def discount_applied
  @discount_applied
end

#discount_rate ⇒ Object

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



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

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/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

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



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

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. 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 any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of "gift_card". For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def product_code
  @product_code
end

#product_name ⇒ Object

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.



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

def product_name
  @product_name
end

#product_sku ⇒ Object

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.



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

def product_sku
  @product_sku
end

#quantity ⇒ Object

Number of units for this order. 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 set to default or one of the other values that are related to shipping and/or handling. When orderInformation.lineItems[].productCode is "gift_card", this is the total count of individual prepaid gift cards purchased.



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

def quantity
  @quantity
end

#reference_data_code ⇒ Object

Code that identifies the value of the corresponding item_#referenceData#_number field. See Numbered Elements. 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.



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

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.



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

def reference_data_number
  @reference_data_number
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. If you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. 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/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

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.



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

def tax_applied_after_discount
  @tax_applied_after_discount
end

#tax_details ⇒ Object

Returns the value of attribute tax_details.



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

def tax_details
  @tax_details
end

#tax_rate ⇒ Object

Tax rate applied to the item. For details, see ‘tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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_rest_client/models/ptsv2payments_order_information_line_items.rb', line 42

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



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

def tax_status_indicator
  @tax_status_indicator
end

#tax_type_code ⇒ Object

Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm): #### 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`



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

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



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

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



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

def type_of_supply
  @type_of_supply
end

#unit_of_measure ⇒ Object

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



33
34
35
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_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 description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) Important Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. See these guides for details: - [Merchant Descriptors Using the SCMP API Guide] (apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - "Capture Information for Specific Processors" section in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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. For details, see "Dynamic Currency Conversion with a Third Party Provider" in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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. See "Zero Amount Authorizations" in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def unit_price
  @unit_price
end

#weight ⇒ Object

Weight of the item. See Numbered Elements.



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

def weight
  @weight
end

#weight_identifier ⇒ Object

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



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

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). See Numbered Elements.



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

def weight_unit
  @weight_unit
end

Class Method Details

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 95

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'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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_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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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
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



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 694

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



760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 760

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



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 673

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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].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



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

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

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

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

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

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

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

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



740
741
742
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 740

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



746
747
748
749
750
751
752
753
754
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 746

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



734
735
736
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 734

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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb', line 374

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_applied_after_discount.nil? && @tax_applied_after_discount.to_s.length > 1
  return false if !@tax_status_indicator.nil? && @tax_status_indicator.to_s.length > 1
  return false if !@tax_type_code.nil? && @tax_type_code.to_s.length > 4
  return false if !@type_of_supply.nil? && @type_of_supply.to_s.length > 2
  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
  return false if !@weight.nil? && @weight.to_s.length > 9
  return false if !@weight_identifier.nil? && @weight_identifier.to_s.length > 1
  return false if !@weight_unit.nil? && @weight_unit.to_s.length > 2
  return false if !@reference_data_code.nil? && @reference_data_code.to_s.length > 2
  return false if !@reference_data_number.nil? && @reference_data_number.to_s.length > 30
  true
end