class CyberSource::Riskv1addressverificationsOrderInformationLineItems

Attributes

product_code[RW]

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.

product_name[RW]

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.

product_risk[RW]

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.

product_sku[RW]

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.

quantity[RW]

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.

unit_price[RW]

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)

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 36
def self.attribute_map
  {
    :'unit_price' => :'unitPrice',
    :'quantity' => :'quantity',
    :'product_sku' => :'productSKU',
    :'product_risk' => :'productRisk',
    :'product_name' => :'productName',
    :'product_code' => :'productCode'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 61
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 48
def self.swagger_types
  {
    :'unit_price' => :'String',
    :'quantity' => :'Integer',
    :'product_sku' => :'String',
    :'product_risk' => :'String',
    :'product_name' => :'String',
    :'product_code' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 170
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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 217
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 283
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 196
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 183
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 189
def hash
  [unit_price, quantity, product_sku, product_risk, product_name, product_code].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

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

  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
product_code=(product_code) click to toggle source

Custom attribute writer method with validation @param [Object] product_code Value to be assigned

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 164
def product_code=(product_code)
  @product_code = product_code
end
product_name=(product_name) click to toggle source

Custom attribute writer method with validation @param [Object] product_name Value to be assigned

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 158
def product_name=(product_name)
  @product_name = product_name
end
product_risk=(product_risk) click to toggle source

Custom attribute writer method with validation @param [Object] product_risk Value to be assigned

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 152
def product_risk=(product_risk)
  @product_risk = product_risk
end
product_sku=(product_sku) click to toggle source

Custom attribute writer method with validation @param [Object] product_sku Value to be assigned

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 146
def product_sku=(product_sku)
  @product_sku = product_sku
end
quantity=(quantity) click to toggle source

Custom attribute writer method with validation @param [Object] quantity Value to be assigned

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 132
def quantity=(quantity)
  if !quantity.nil? && quantity > 999999999
    fail ArgumentError, 'invalid value for "quantity", must be smaller than or equal to 999999999.'
  end

  if !quantity.nil? && quantity < 1
    fail ArgumentError, 'invalid value for "quantity", must be greater than or equal to 1.'
  end

  @quantity = quantity
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 263
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 269
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 257
def to_s
  to_hash.to_s
end
unit_price=(unit_price) click to toggle source

Custom attribute writer method with validation @param [Object] unit_price Value to be assigned

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 122
def unit_price=(unit_price)
  if unit_price.nil?
    fail ArgumentError, 'unit_price cannot be nil'
  end

  @unit_price = unit_price
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb, line 113
def valid?
  return false if @unit_price.nil?
  return false if !@quantity.nil? && @quantity > 999999999
  return false if !@quantity.nil? && @quantity < 1
  true
end