class AmzSpApi::FinancesApiModel::AffordabilityExpenseEvent

An expense related to an affordability promotion.

Attributes

amazon_order_id[RW]

An Amazon-defined identifier for an order.

base_expense[RW]
marketplace_id[RW]

An encrypted, Amazon-defined marketplace identifier.

posted_date[RW]
tax_type_cgst[RW]
tax_type_igst[RW]
tax_type_sgst[RW]
total_expense[RW]
transaction_type[RW]

Indicates the type of transaction. Possible values: * Charge - For an affordability promotion expense. * Refund - For an affordability promotion expense reversal.

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/affordability_expense_event.rb, line 39
def self.attribute_map
  {
    :'amazon_order_id' => :'AmazonOrderId',
    :'posted_date' => :'PostedDate',
    :'marketplace_id' => :'MarketplaceId',
    :'transaction_type' => :'TransactionType',
    :'base_expense' => :'BaseExpense',
    :'tax_type_cgst' => :'TaxTypeCGST',
    :'tax_type_sgst' => :'TaxTypeSGST',
    :'tax_type_igst' => :'TaxTypeIGST',
    :'total_expense' => :'TotalExpense'
  }
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/affordability_expense_event.rb, line 185
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/affordability_expense_event.rb, line 76
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FinancesApiModel::AffordabilityExpenseEvent` 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::AffordabilityExpenseEvent`. 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?(:'amazon_order_id')
    self.amazon_order_id = attributes[:'amazon_order_id']
  end

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

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

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/finances-api-model/models/affordability_expense_event.rb, line 54
def self.openapi_types
  {
    :'amazon_order_id' => :'Object',
    :'posted_date' => :'Object',
    :'marketplace_id' => :'Object',
    :'transaction_type' => :'Object',
    :'base_expense' => :'Object',
    :'tax_type_cgst' => :'Object',
    :'tax_type_sgst' => :'Object',
    :'tax_type_igst' => :'Object',
    :'total_expense' => :'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/affordability_expense_event.rb, line 156
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amazon_order_id == o.amazon_order_id &&
      posted_date == o.posted_date &&
      marketplace_id == o.marketplace_id &&
      transaction_type == o.transaction_type &&
      base_expense == o.base_expense &&
      tax_type_cgst == o.tax_type_cgst &&
      tax_type_sgst == o.tax_type_sgst &&
      tax_type_igst == o.tax_type_igst &&
      total_expense == o.total_expense
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/affordability_expense_event.rb, line 215
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/affordability_expense_event.rb, line 284
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/affordability_expense_event.rb, line 192
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/affordability_expense_event.rb, line 172
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/affordability_expense_event.rb, line 178
def hash
  [amazon_order_id, posted_date, marketplace_id, transaction_type, base_expense, tax_type_cgst, tax_type_sgst, tax_type_igst, total_expense].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/affordability_expense_event.rb, line 128
def list_invalid_properties
  invalid_properties = Array.new
  if @tax_type_cgst.nil?
    invalid_properties.push('invalid value for "tax_type_cgst", tax_type_cgst cannot be nil.')
  end

  if @tax_type_sgst.nil?
    invalid_properties.push('invalid value for "tax_type_sgst", tax_type_sgst cannot be nil.')
  end

  if @tax_type_igst.nil?
    invalid_properties.push('invalid value for "tax_type_igst", tax_type_igst cannot be nil.')
  end

  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/affordability_expense_event.rb, line 260
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/affordability_expense_event.rb, line 266
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/affordability_expense_event.rb, line 254
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/affordability_expense_event.rb, line 147
def valid?
  return false if @tax_type_cgst.nil?
  return false if @tax_type_sgst.nil?
  return false if @tax_type_igst.nil?
  true
end