Class: AmzSpApi::ProductTypeDefinitionsApiModel::ProductTypeDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/product-type-definitions-api-model/models/product_type_definition.rb

Overview

A product type definition represents the attributes and data requirements for a product type in the Amazon catalog. Product type definitions are used interchangeably between the Selling Partner API for Listings Items, Selling Partner API for Catalog Items, and JSON-based listings feeds in the Selling Partner API for Feeds.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProductTypeDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::ProductTypeDefinitionsApiModel::ProductTypeDefinition` 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::ProductTypeDefinitionsApiModel::ProductTypeDefinition`. 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?(:'meta_schema')
    self.meta_schema = attributes[:'meta_schema']
  end

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

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

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

  if attributes.key?(:'property_groups')
    if (value = attributes[:'property_groups']).is_a?(Hash)
      self.property_groups = value
    end
  end

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

  if attributes.key?(:'marketplace_ids')
    if (value = attributes[:'marketplace_ids']).is_a?(Array)
      self.marketplace_ids = value
    end
  end

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

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

Instance Attribute Details

#locale ⇒ Object

Locale of the display elements contained in the product type definition.



31
32
33
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 31

def locale
  @locale
end

#marketplace_ids ⇒ Object

Amazon marketplace identifiers for which the product type definition is applicable.



34
35
36
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 34

def marketplace_ids
  @marketplace_ids
end

#meta_schema ⇒ Object

Returns the value of attribute meta_schema.



17
18
19
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 17

def meta_schema
  @meta_schema
end

#product_type ⇒ Object

The name of the Amazon product type that this product type definition applies to.



37
38
39
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 37

def product_type
  @product_type
end

#product_type_version ⇒ Object

Returns the value of attribute product_type_version.



39
40
41
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 39

def product_type_version
  @product_type_version
end

#property_groups ⇒ Object

Mapping of property group names to property groups. Property groups represent logical groupings of schema properties that can be used for display or informational purposes.



28
29
30
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 28

def property_groups
  @property_groups
end

#requirements ⇒ Object

Name of the requirements set represented in this product type definition.



22
23
24
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 22

def requirements
  @requirements
end

#requirements_enforced ⇒ Object

Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all of the required attributes being present (such as for partial updates).



25
26
27
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 25

def requirements_enforced
  @requirements_enforced
end

#schema ⇒ Object

Returns the value of attribute schema.



19
20
21
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 19

def schema
  @schema
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 64

def self.attribute_map
  {
    :'meta_schema' => :'metaSchema',
    :'schema' => :'schema',
    :'requirements' => :'requirements',
    :'requirements_enforced' => :'requirementsEnforced',
    :'property_groups' => :'propertyGroups',
    :'locale' => :'locale',
    :'marketplace_ids' => :'marketplaceIds',
    :'product_type' => :'productType',
    :'product_type_version' => :'productTypeVersion'
  }
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



263
264
265
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 263

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 79

def self.openapi_types
  {
    :'meta_schema' => :'Object',
    :'schema' => :'Object',
    :'requirements' => :'Object',
    :'requirements_enforced' => :'Object',
    :'property_groups' => :'Object',
    :'locale' => :'Object',
    :'marketplace_ids' => :'Object',
    :'product_type' => :'Object',
    :'product_type_version' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      meta_schema == o.meta_schema &&
      schema == o.schema &&
      requirements == o.requirements &&
      requirements_enforced == o.requirements_enforced &&
      property_groups == o.property_groups &&
      locale == o.locale &&
      marketplace_ids == o.marketplace_ids &&
      product_type == o.product_type &&
      product_type_version == o.product_type_version
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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 293

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::ProductTypeDefinitionsApiModel.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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 362

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 270

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


250
251
252
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



256
257
258
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 256

def hash
  [meta_schema, schema, requirements, requirements_enforced, property_groups, locale, marketplace_ids, product_type, product_type_version].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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  if @schema.nil?
    invalid_properties.push('invalid value for "schema", schema cannot be nil.')
  end

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

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

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

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

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

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

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

  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



338
339
340
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 338

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 344

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



332
333
334
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 332

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/product-type-definitions-api-model/models/product_type_definition.rb', line 196

def valid?
  return false if @schema.nil?
  return false if @requirements.nil?
  requirements_validator = EnumAttributeValidator.new('Object', ['LISTING', 'LISTING_PRODUCT_ONLY', 'LISTING_OFFER_ONLY'])
  return false unless requirements_validator.valid?(@requirements)
  return false if @requirements_enforced.nil?
  requirements_enforced_validator = EnumAttributeValidator.new('Object', ['ENFORCED', 'NOT_ENFORCED'])
  return false unless requirements_enforced_validator.valid?(@requirements_enforced)
  return false if @property_groups.nil?
  return false if @locale.nil?
  return false if @marketplace_ids.nil?
  return false if @product_type.nil?
  return false if @product_type_version.nil?
  true
end