Class: AmznSpApi::FbaInboundEligibilityApiModel::ItemEligibilityPreview

Inherits:
Object
  • Object
show all
Defined in:
lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb

Overview

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemEligibilityPreview

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 80

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FbaInboundEligibilityApiModel::ItemEligibilityPreview` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::FbaInboundEligibilityApiModel::ItemEligibilityPreview`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.asin = attributes[:asin] if attributes.key?(:asin)

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

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

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

  return unless attributes.key?(:ineligibility_reason_list)
  return unless (value = attributes[:ineligibility_reason_list]).is_a?(Array)

  self.ineligibility_reason_list = value
end

Instance Attribute Details

#asin ⇒ Object

The ASIN for which eligibility was determined.



16
17
18
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 16

def asin
  @asin
end

#ineligibility_reason_list ⇒ Object

Potential Ineligibility Reason Codes.



28
29
30
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 28

def ineligibility_reason_list
  @ineligibility_reason_list
end

#is_eligible_for_program ⇒ Object

Indicates if the item is eligible for the program.



25
26
27
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 25

def is_eligible_for_program
  @is_eligible_for_program
end

#marketplace_id ⇒ Object

The marketplace for which eligibility was determined.



19
20
21
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 19

def marketplace_id
  @marketplace_id
end

#program ⇒ Object

The program for which eligibility was determined.



22
23
24
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 22

def program
  @program
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 52

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



167
168
169
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 167

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 74

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 63

def self.openapi_types
  {
    'asin': :Object,
    'marketplace_id': :Object,
    'program': :Object,
    'is_eligible_for_program': :Object,
    'ineligibility_reason_list': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 141

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    asin == other.asin &&
    marketplace_id == other.marketplace_id &&
    program == other.program &&
    is_eligible_for_program == other.is_eligible_for_program &&
    ineligibility_reason_list == other.ineligibility_reason_list
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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 196

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
    AmznSpApi::FbaInboundEligibilityApiModel.const_get(type).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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 265

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 174

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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


154
155
156
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 154

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



160
161
162
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 160

def hash
  [asin, marketplace_id, program, is_eligible_for_program, ineligibility_reason_list].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



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 106

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "asin", asin cannot be nil.') if @asin.nil?

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

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

  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



241
242
243
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 241

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 247

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



235
236
237
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 235

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



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/fba_inbound_eligibility_api_model/models/item_eligibility_preview.rb', line 119

def valid?
  return false if @asin.nil?
  return false if @program.nil?

  program_validator = EnumAttributeValidator.new('Object', %w[INBOUND COMMINGLING])
  return false unless program_validator.valid?(@program)
  return false if @is_eligible_for_program.nil?

  true
end