Class: CyberSource::Vasv2taxOrderInformationLineItems

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Vasv2taxOrderInformationLineItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#buyer_vat_registration_number ⇒ Object

Buyer’s VAT registration number. NOTE If this field appears in a ‘lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes.



52
53
54
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 52

def buyer_vat_registration_number
  @buyer_vat_registration_number
end

#order_acceptance ⇒ Object

Returns the value of attribute order_acceptance.



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

def order_acceptance
  @order_acceptance
end

#order_origin ⇒ Object

Returns the value of attribute order_origin.



37
38
39
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 37

def order_origin
  @order_origin
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. 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/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. To use the tax calculation service, use values listed in the Tax Product Code Guide. For information about this document, contact customer support. See "Product Codes," page 14, for more information.



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

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



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

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.



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

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.



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

def quantity
  @quantity
end

#seller_vat_registration_number ⇒ Object

VAT seller registration number. For details, see "International Taxes and Value-Added Tax (VAT)" in [Tax Calculation Service Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/Tax_SCMP_API/html/). NOTE If this field appears in a ‘lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes.



55
56
57
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 55

def seller_vat_registration_number
  @seller_vat_registration_number
end

#ship_from_administrative_area ⇒ Object

State from which the order is shipped. This field is used only when ‘orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromCountry` are present. Use the [State, Province, and Territory Codes for the United States and Canada](apps.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.



43
44
45
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 43

def ship_from_administrative_area
  @ship_from_administrative_area
end

#ship_from_country ⇒ Object

Country from which the order is shipped. This field is used only when ‘orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromAdministrativeArea` are present. Use the [ISO Standard Country Codes](apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/ or rates applied to the transaction based on sourcing. Optional for U.S., Canadian, international tax, and value added taxes.



40
41
42
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 40

def ship_from_country
  @ship_from_country
end

#ship_from_locality ⇒ Object

City where the product is shipped from. This field is used only when the ‘orderInformation.shipTo.administrativeArea` and `orderInformation.shipTo.country` fields are present. NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.



46
47
48
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 46

def ship_from_locality
  @ship_from_locality
end

#ship_from_postal_code ⇒ Object

Postal code where the product is shipped from. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.



49
50
51
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 49

def ship_from_postal_code
  @ship_from_postal_code
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



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

def tax_amount
  @tax_amount
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. #### 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/) #### 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)



30
31
32
 
# File 'lib/cybersource_rest_client/models/vasv2tax_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.



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

def self.attribute_map
  {
    :'product_sku' => :'productSKU',
    :'product_code' => :'productCode',
    :'quantity' => :'quantity',
    :'product_name' => :'productName',
    :'unit_price' => :'unitPrice',
    :'tax_amount' => :'taxAmount',
    :'order_acceptance' => :'orderAcceptance',
    :'order_origin' => :'orderOrigin',
    :'ship_from_country' => :'shipFromCountry',
    :'ship_from_administrative_area' => :'shipFromAdministrativeArea',
    :'ship_from_locality' => :'shipFromLocality',
    :'ship_from_postal_code' => :'shipFromPostalCode',
    :'buyer_vat_registration_number' => :'buyerVatRegistrationNumber',
    :'seller_vat_registration_number' => :'sellerVatRegistrationNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 78

def self.swagger_types
  {
    :'product_sku' => :'String',
    :'product_code' => :'String',
    :'quantity' => :'Integer',
    :'product_name' => :'String',
    :'unit_price' => :'String',
    :'tax_amount' => :'String',
    :'order_acceptance' => :'Vasv2taxOrderInformationOrderAcceptance',
    :'order_origin' => :'Vasv2taxOrderInformationOrderOrigin',
    :'ship_from_country' => :'String',
    :'ship_from_administrative_area' => :'String',
    :'ship_from_locality' => :'String',
    :'ship_from_postal_code' => :'String',
    :'buyer_vat_registration_number' => :'String',
    :'seller_vat_registration_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 366

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      product_sku == o.product_sku &&
      product_code == o.product_code &&
      quantity == o.quantity &&
      product_name == o.product_name &&
      unit_price == o.unit_price &&
      tax_amount == o.tax_amount &&
      order_acceptance == o.order_acceptance &&
      order_origin == o.order_origin &&
      ship_from_country == o.ship_from_country &&
      ship_from_administrative_area == o.ship_from_administrative_area &&
      ship_from_locality == o.ship_from_locality &&
      ship_from_postal_code == o.ship_from_postal_code &&
      buyer_vat_registration_number == o.buyer_vat_registration_number &&
      seller_vat_registration_number == o.seller_vat_registration_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



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 421

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



487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 487

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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 400

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



393
394
395
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 393

def hash
  [product_sku, product_code, quantity, product_name, unit_price, tax_amount, order_acceptance, order_origin, ship_from_country, ship_from_administrative_area, ship_from_locality, ship_from_postal_code, buyer_vat_registration_number, seller_vat_registration_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



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

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

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

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

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

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

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

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

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



467
468
469
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 467

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



473
474
475
476
477
478
479
480
481
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 473

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



461
462
463
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 461

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb', line 223

def valid?
  return false if !@product_sku.nil? && @product_sku.to_s.length > 255
  return false if !@product_code.nil? && @product_code.to_s.length > 255
  return false if !@quantity.nil? && @quantity > 999999999
  return false if !@quantity.nil? && @quantity < 1
  return false if !@product_name.nil? && @product_name.to_s.length > 255
  return false if !@unit_price.nil? && @unit_price.to_s.length > 15
  return false if !@tax_amount.nil? && @tax_amount.to_s.length > 15
  return false if !@ship_from_country.nil? && @ship_from_country.to_s.length > 2
  return false if !@ship_from_administrative_area.nil? && @ship_from_administrative_area.to_s.length > 2
  return false if !@ship_from_locality.nil? && @ship_from_locality.to_s.length > 50
  return false if !@ship_from_postal_code.nil? && @ship_from_postal_code.to_s.length > 10
  return false if !@buyer_vat_registration_number.nil? && @buyer_vat_registration_number.to_s.length > 25
  return false if !@seller_vat_registration_number.nil? && @seller_vat_registration_number.to_s.length > 25
  true
end