class AmzSpApi::FbaInboundEligibilityApiModel::ItemEligibilityPreview

The response object which contains the ASIN, marketplaceId if required, eligibility program, the eligibility status (boolean), and a list of ineligibility reason codes.

Attributes

asin[RW]

The ASIN for which eligibility was determined.

ineligibility_reason_list[RW]

Potential Ineligibility Reason Codes.

is_eligible_for_program[RW]

Indicates if the item is eligible for the program.

marketplace_id[RW]

The marketplace for which eligibility was determined.

program[RW]

The program for which eligibility was determined.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 55
def self.attribute_map
  {
    :'asin' => :'asin',
    :'marketplace_id' => :'marketplaceId',
    :'program' => :'program',
    :'is_eligible_for_program' => :'isEligibleForProgram',
    :'ineligibility_reason_list' => :'ineligibilityReasonList'
  }
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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 187
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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 84
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FbaInboundEligibilityApiModel::ItemEligibilityPreview` 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::FbaInboundEligibilityApiModel::ItemEligibilityPreview`. 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?(:'asin')
    self.asin = attributes[:'asin']
  end

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

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

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

  if attributes.key?(:'ineligibility_reason_list')
    if (value = attributes[:'ineligibility_reason_list']).is_a?(Array)
      self.ineligibility_reason_list = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 77
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 66
def self.openapi_types
  {
    :'asin' => :'Object',
    :'marketplace_id' => :'Object',
    :'program' => :'Object',
    :'is_eligible_for_program' => :'Object',
    :'ineligibility_reason_list' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 162
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      asin == o.asin &&
      marketplace_id == o.marketplace_id &&
      program == o.program &&
      is_eligible_for_program == o.is_eligible_for_program &&
      ineligibility_reason_list == o.ineligibility_reason_list
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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.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
    AmzSpApi::FbaInboundEligibilityApiModel.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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 286
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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 194
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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 174
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 180
def hash
  [asin, marketplace_id, program, is_eligible_for_program, ineligibility_reason_list].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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 122
def list_invalid_properties
  invalid_properties = Array.new
  if @asin.nil?
    invalid_properties.push('invalid value for "asin", asin cannot be nil.')
  end

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

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

  invalid_properties
end
program=(program) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] program Object to be assigned

# File lib/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 152
def program=(program)
  validator = EnumAttributeValidator.new('Object', ['INBOUND', 'COMMINGLING'])
  unless validator.valid?(program)
    fail ArgumentError, "invalid value for \"program\", must be one of #{validator.allowable_values}."
  end
  @program = program
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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 262
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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 268
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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 256
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/fba-inbound-eligibility-api-model/models/item_eligibility_preview.rb, line 141
def valid?
  return false if @asin.nil?
  return false if @program.nil?
  program_validator = EnumAttributeValidator.new('Object', ['INBOUND', 'COMMINGLING'])
  return false unless program_validator.valid?(@program)
  return false if @is_eligible_for_program.nil?
  true
end