class AmzSpApi::FinancesApiModel::AdjustmentItem

An item in an adjustment to the seller's account.

Attributes

asin[RW]

The Amazon Standard Identification Number (ASIN) of the item.

fn_sku[RW]

A unique identifier assigned to products stored in and fulfilled from a fulfillment center.

per_unit_amount[RW]
product_description[RW]

A short description of the item.

quantity[RW]

Represents the number of units in the seller's inventory when the AdustmentType is FBAInventoryReimbursement.

seller_sku[RW]

The seller SKU of the item. The seller SKU is qualified by the seller's seller ID, which is included with every call to the Selling Partner API.

total_amount[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/finances-api-model/models/adjustment_item.rb, line 37
def self.attribute_map
  {
    :'quantity' => :'Quantity',
    :'per_unit_amount' => :'PerUnitAmount',
    :'total_amount' => :'TotalAmount',
    :'seller_sku' => :'SellerSKU',
    :'fn_sku' => :'FnSKU',
    :'product_description' => :'ProductDescription',
    :'asin' => :'ASIN'
  }
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/finances-api-model/models/adjustment_item.rb, line 154
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/finances-api-model/models/adjustment_item.rb, line 70
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FinancesApiModel::AdjustmentItem` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `AmzSpApi::FinancesApiModel::AdjustmentItem`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'per_unit_amount')
    self.per_unit_amount = attributes[:'per_unit_amount']
  end

  if attributes.key?(:'total_amount')
    self.total_amount = attributes[:'total_amount']
  end

  if attributes.key?(:'seller_sku')
    self.seller_sku = attributes[:'seller_sku']
  end

  if attributes.key?(:'fn_sku')
    self.fn_sku = attributes[:'fn_sku']
  end

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

  if attributes.key?(:'asin')
    self.asin = attributes[:'asin']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/finances-api-model/models/adjustment_item.rb, line 63
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/finances-api-model/models/adjustment_item.rb, line 50
def self.openapi_types
  {
    :'quantity' => :'Object',
    :'per_unit_amount' => :'Object',
    :'total_amount' => :'Object',
    :'seller_sku' => :'Object',
    :'fn_sku' => :'Object',
    :'product_description' => :'Object',
    :'asin' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/finances-api-model/models/adjustment_item.rb, line 127
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      quantity == o.quantity &&
      per_unit_amount == o.per_unit_amount &&
      total_amount == o.total_amount &&
      seller_sku == o.seller_sku &&
      fn_sku == o.fn_sku &&
      product_description == o.product_description &&
      asin == o.asin
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/finances-api-model/models/adjustment_item.rb, line 184
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
    AmzSpApi::FinancesApiModel.const_get(type).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/finances-api-model/models/adjustment_item.rb, line 253
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/finances-api-model/models/adjustment_item.rb, line 161
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end
eql?(o) click to toggle source

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

# File lib/finances-api-model/models/adjustment_item.rb, line 141
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/finances-api-model/models/adjustment_item.rb, line 147
def hash
  [quantity, per_unit_amount, total_amount, seller_sku, fn_sku, product_description, asin].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/finances-api-model/models/adjustment_item.rb, line 114
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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/finances-api-model/models/adjustment_item.rb, line 229
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/finances-api-model/models/adjustment_item.rb, line 235
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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/finances-api-model/models/adjustment_item.rb, line 223
def to_s
  to_hash.to_s
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/finances-api-model/models/adjustment_item.rb, line 121
def valid?
  true
end