Class: CyberSource::Riskv1addressverificationsOrderInformationLineItems

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1addressverificationsOrderInformationLineItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

Instance Attribute Details

#product_code ⇒ Object

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



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

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.



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

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.



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

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.



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

def product_sku
  @product_sku
end

#quantity ⇒ Object

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



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

def quantity
  @quantity
end

#unit_price ⇒ Object

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



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

def unit_price
  @unit_price
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 35

def self.attribute_map
  {
    :'unit_price' => :'unitPrice',
    :'quantity' => :'quantity',
    :'product_sku' => :'productSKU',
    :'product_risk' => :'productRisk',
    :'product_name' => :'productName',
    :'product_code' => :'productCode'
  }
end

.json_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 47

def self.json_map
  {
    :'unit_price' => :'unit_price',
    :'quantity' => :'quantity',
    :'product_sku' => :'product_sku',
    :'product_risk' => :'product_risk',
    :'product_name' => :'product_name',
    :'product_code' => :'product_code'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 59

def self.swagger_types
  {
    :'unit_price' => :'String',
    :'quantity' => :'Integer',
    :'product_sku' => :'String',
    :'product_risk' => :'String',
    :'product_name' => :'String',
    :'product_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      unit_price == o.unit_price &&
      quantity == o.quantity &&
      product_sku == o.product_sku &&
      product_risk == o.product_risk &&
      product_name == o.product_name &&
      product_code == o.product_code
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



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

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 276

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 189

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


176
177
178
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 182

def hash
  [unit_price, quantity, product_sku, product_risk, product_name, product_code].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



105
106
107
108
109
110
111
112
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 105

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



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

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



262
263
264
265
266
267
268
269
270
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 262

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



250
251
252
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 250

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



116
117
118
119
 
# File 'lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb', line 116

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