Class: CyberSource::Riskv1decisionsOrderInformationLineItems

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1decisionsOrderInformationLineItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
161
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 100

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

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

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

Instance Attribute Details

#distributor_product_sku ⇒ Object

Product’s identifier code. This field is inserted into the outgoing message without being parsed or formatted. This field is included as Distributor product SKU (Offer) in the list of API fields with which you can create custom rules.



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

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



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

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 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/riskv1decisions_order_information_line_items.rb', line 27

def gift_card_currency
  @gift_card_currency
end

#passenger ⇒ Object

Returns the value of attribute passenger.



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

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



42
43
44
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 42

def product_code
  @product_code
end

#product_description ⇒ Object

Brief description of item.



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

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.



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

def product_name
  @product_name
end

#product_risk ⇒ Object

Indicates the level of risk for the product. This field can contain one of the following values: - ‘low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks.



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

def product_risk
  @product_risk
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/riskv1decisions_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/riskv1decisions_order_information_line_items.rb', line 24

def quantity
  @quantity
end

#shipping_destination_types ⇒ Object

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



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

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



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

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/riskv1decisions_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/riskv1decisions_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.



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

def self.attribute_map
  {
    :'total_amount' => :'totalAmount',
    :'unit_price' => :'unitPrice',
    :'quantity' => :'quantity',
    :'gift_card_currency' => :'giftCardCurrency',
    :'product_sku' => :'productSKU',
    :'product_risk' => :'productRisk',
    :'product_description' => :'productDescription',
    :'product_name' => :'productName',
    :'product_code' => :'productCode',
    :'gift' => :'gift',
    :'distributor_product_sku' => :'distributorProductSku',
    :'passenger' => :'passenger',
    :'shipping_destination_types' => :'shippingDestinationTypes',
    :'tax_amount' => :'taxAmount'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'total_amount' => :'String',
    :'unit_price' => :'String',
    :'quantity' => :'Integer',
    :'gift_card_currency' => :'Integer',
    :'product_sku' => :'String',
    :'product_risk' => :'String',
    :'product_description' => :'String',
    :'product_name' => :'String',
    :'product_code' => :'String',
    :'gift' => :'BOOLEAN',
    :'distributor_product_sku' => :'String',
    :'passenger' => :'Ptsv2paymentsOrderInformationPassenger',
    :'shipping_destination_types' => :'String',
    :'tax_amount' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 256

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_risk == o.product_risk &&
      product_description == o.product_description &&
      product_name == o.product_name &&
      product_code == o.product_code &&
      gift == o.gift &&
      distributor_product_sku == o.distributor_product_sku &&
      passenger == o.passenger &&
      shipping_destination_types == o.shipping_destination_types &&
      tax_amount == o.tax_amount
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



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

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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 377

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 290

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


277
278
279
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 277

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



283
284
285
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 283

def hash
  [total_amount, unit_price, quantity, gift_card_currency, product_sku, product_risk, product_description, product_name, product_code, gift, distributor_product_sku, passenger, shipping_destination_types, tax_amount].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



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 165

def list_invalid_properties
  invalid_properties = Array.new
  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

  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



357
358
359
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 357

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



363
364
365
366
367
368
369
370
371
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 363

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



351
352
353
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 351

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



180
181
182
183
184
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb', line 180

def valid?
  return false if !@quantity.nil? && @quantity > 999999999
  return false if !@quantity.nil? && @quantity < 1
  true
end