Class: CyberSource::Riskv1authenticationsOrderInformationLineItems

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1authenticationsOrderInformationLineItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#gift_card_currency ⇒ Object

When ‘orderInformation.lineItems[].productCode` is "gift_card", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)



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

def gift_card_currency
  @gift_card_currency
end

#passenger ⇒ Object

Returns the value of attribute passenger.



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

def passenger
  @passenger
end

#product_description ⇒ Object

Brief description of item.



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

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.



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

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.



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

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/riskv1authentications_order_information_line_items.rb', line 24

def quantity
  @quantity
end

#shipping_address1 ⇒ Object

Address where item will be shipped



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

def shipping_address1
  @shipping_address1
end

#shipping_address2 ⇒ Object

Address where item will be shipped



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

def shipping_address2
  @shipping_address2
end

#shipping_city ⇒ Object

City where item will be shipped



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

def shipping_city
  @shipping_city
end

#shipping_country_code ⇒ Object

Country where item will be shipped



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

def shipping_country_code
  @shipping_country_code
end

#shipping_destination_types ⇒ Object

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



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

def shipping_destination_types
  @shipping_destination_types
end

#shipping_first_name ⇒ Object

Customer’s first name



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

def shipping_first_name
  @shipping_first_name
end

#shipping_last_name ⇒ Object

Customer’s last name



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

def shipping_last_name
  @shipping_last_name
end

#shipping_middle_name ⇒ Object

Customer’s middle name



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

def shipping_middle_name
  @shipping_middle_name
end

#shipping_phone ⇒ Object

Phone number where item will be shipped



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

def shipping_phone
  @shipping_phone
end

#shipping_postal_code ⇒ Object

Postal code where item will be shipped



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

def shipping_postal_code
  @shipping_postal_code
end

#shipping_state ⇒ Object

State where item will be shipped



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

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



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

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



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

def total_amount
  @total_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)



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

def unit_price
  @unit_price
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 77

def self.attribute_map
  {
    :'total_amount' => :'totalAmount',
    :'unit_price' => :'unitPrice',
    :'quantity' => :'quantity',
    :'gift_card_currency' => :'giftCardCurrency',
    :'product_sku' => :'productSKU',
    :'product_description' => :'productDescription',
    :'product_name' => :'productName',
    :'passenger' => :'passenger',
    :'shipping_destination_types' => :'shippingDestinationTypes',
    :'tax_amount' => :'taxAmount',
    :'shipping_address1' => :'shippingAddress1',
    :'shipping_address2' => :'shippingAddress2',
    :'shipping_city' => :'shippingCity',
    :'shipping_country_code' => :'shippingCountryCode',
    :'shipping_first_name' => :'shippingFirstName',
    :'shipping_last_name' => :'shippingLastName',
    :'shipping_middle_name' => :'shippingMiddleName',
    :'shipping_phone' => :'shippingPhone',
    :'shipping_postal_code' => :'shippingPostalCode',
    :'shipping_state' => :'shippingState'
  }
end

.json_map ⇒ Object

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 103

def self.json_map
  {
    :'total_amount' => :'total_amount',
    :'unit_price' => :'unit_price',
    :'quantity' => :'quantity',
    :'gift_card_currency' => :'gift_card_currency',
    :'product_sku' => :'product_sku',
    :'product_description' => :'product_description',
    :'product_name' => :'product_name',
    :'passenger' => :'passenger',
    :'shipping_destination_types' => :'shipping_destination_types',
    :'tax_amount' => :'tax_amount',
    :'shipping_address1' => :'shipping_address1',
    :'shipping_address2' => :'shipping_address2',
    :'shipping_city' => :'shipping_city',
    :'shipping_country_code' => :'shipping_country_code',
    :'shipping_first_name' => :'shipping_first_name',
    :'shipping_last_name' => :'shipping_last_name',
    :'shipping_middle_name' => :'shipping_middle_name',
    :'shipping_phone' => :'shipping_phone',
    :'shipping_postal_code' => :'shipping_postal_code',
    :'shipping_state' => :'shipping_state'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/riskv1authentications_order_information_line_items.rb', line 129

def self.swagger_types
  {
    :'total_amount' => :'String',
    :'unit_price' => :'String',
    :'quantity' => :'Integer',
    :'gift_card_currency' => :'Integer',
    :'product_sku' => :'String',
    :'product_description' => :'String',
    :'product_name' => :'String',
    :'passenger' => :'Ptsv2paymentsOrderInformationPassenger',
    :'shipping_destination_types' => :'String',
    :'tax_amount' => :'String',
    :'shipping_address1' => :'String',
    :'shipping_address2' => :'String',
    :'shipping_city' => :'String',
    :'shipping_country_code' => :'String',
    :'shipping_first_name' => :'String',
    :'shipping_last_name' => :'String',
    :'shipping_middle_name' => :'String',
    :'shipping_phone' => :'Integer',
    :'shipping_postal_code' => :'Integer',
    :'shipping_state' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 357

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total_amount == o.total_amount &&
      unit_price == o.unit_price &&
      quantity == o.quantity &&
      gift_card_currency == o.gift_card_currency &&
      product_sku == o.product_sku &&
      product_description == o.product_description &&
      product_name == o.product_name &&
      passenger == o.passenger &&
      shipping_destination_types == o.shipping_destination_types &&
      tax_amount == o.tax_amount &&
      shipping_address1 == o.shipping_address1 &&
      shipping_address2 == o.shipping_address2 &&
      shipping_city == o.shipping_city &&
      shipping_country_code == o.shipping_country_code &&
      shipping_first_name == o.shipping_first_name &&
      shipping_last_name == o.shipping_last_name &&
      shipping_middle_name == o.shipping_middle_name &&
      shipping_phone == o.shipping_phone &&
      shipping_postal_code == o.shipping_postal_code &&
      shipping_state == o.shipping_state
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



418
419
420
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
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 418

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



484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 484

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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 397

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


384
385
386
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 384

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



390
391
392
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 390

def hash
  [total_amount, unit_price, quantity, gift_card_currency, product_sku, product_description, product_name, passenger, shipping_destination_types, tax_amount, shipping_address1, shipping_address2, shipping_city, shipping_country_code, shipping_first_name, shipping_last_name, shipping_middle_name, shipping_phone, shipping_postal_code, shipping_state].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



245
246
247
248
249
250
251
252
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 245

def list_invalid_properties
  invalid_properties = Array.new
  if @unit_price.nil?
    invalid_properties.push('invalid value for "unit_price", unit_price cannot be nil.')
  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



464
465
466
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 464

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



470
471
472
473
474
475
476
477
478
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 470

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



458
459
460
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 458

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



256
257
258
259
 
# File 'lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb', line 256

def valid?
  return false if @unit_price.nil?
  true
end