Module: Peddler::Types::ProductTypeDefinitions20200901

Defined in:

lib/peddler/types/product_type_definitions_2020_09_01/error.rb,
lib/peddler/types/product_type_definitions_2020_09_01/error_list.rb,
lib/peddler/types/product_type_definitions_2020_09_01/schema_link.rb,
lib/peddler/types/product_type_definitions_2020_09_01/product_type.rb,
lib/peddler/types/product_type_definitions_2020_09_01/property_group.rb,
lib/peddler/types/product_type_definitions_2020_09_01/product_type_list.rb,
lib/peddler/types/product_type_definitions_2020_09_01/product_type_version.rb,
lib/peddler/types/product_type_definitions_2020_09_01/product_type_definition.rb

Constant Summary

Error =

Error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition.
  attribute(:message, String)

  # @return [String] Additional details that can help the caller understand or fix the issue.
  attribute(:details, String)
end

ErrorList =

A list of error responses returned when a request is unsuccessful.

Structure.new do
  # @return [Array<Error>]
  attribute(:errors, [Error])
end

SchemaLink =

Structure.new do
  # @return [Hash] Link to retrieve the schema.
  attribute(:link, Hash)

  # @return [String] Checksum hash of the schema (Base64 MD5). Can be used to verify schema contents, identify
  # changes between schema versions, and for caching.
  attribute(:checksum, String)
end

ProductType =

An Amazon product type with a definition available.

Structure.new do
  # @return [String] The name of the Amazon product type.
  attribute(:name, String)

  # @return [String] The human-readable and localized description of the Amazon product type.
  attribute(:display_name, String, from: "displayName")

  # @return [Array<String>] The Amazon marketplace identifiers for which the product type definition is available.
  attribute(:marketplace_ids, [String], from: "marketplaceIds")
end

PropertyGroup =

A property group represents a logical grouping of schema properties that can be used for display or informational purposes.

Structure.new do
  # @return [String] The display label of the property group.
  attribute(:title, String)

  # @return [String] The description of the property group.
  attribute(:description, String)

  # @return [Array<String>] The names of the schema properties for the property group.
  attribute(:property_names, [String], from: "propertyNames")
end

ProductTypeList =

A list of Amazon product types with definitions available.

Structure.new do
  # @return [Array<ProductType>]
  attribute(:product_types, [ProductType], from: "productTypes")

  # @return [String] Amazon product type version identifier.
  attribute(:product_type_version, String, from: "productTypeVersion")
end

ProductTypeVersion =

The version details for an Amazon product type.

Structure.new do
  # @return [String] Version identifier.
  attribute(:version, String)

  # @return [:boolean] When true, the version indicated by the version identifier is the latest available for the
  # Amazon product type.
  attribute(:latest, :boolean)

  # @return [:boolean] When true, the version indicated by the version identifier is the prerelease (release
  # candidate) for the Amazon product type.
  attribute(:release_candidate, :boolean, from: "releaseCandidate")
end

ProductTypeDefinition =

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.

Structure.new do
  # @return [SchemaLink] Link to meta-schema describing the vocabulary used by the product type schema.
  attribute(:meta_schema, SchemaLink, from: "metaSchema")

  # @return [SchemaLink] Link to schema describing the attributes and requirements for the product type.
  attribute(:schema, SchemaLink)

  # @return [String] Name of the requirements set represented in this product type definition.
  attribute(:requirements, String)

  # @return [String] 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).
  attribute(:requirements_enforced, String, from: "requirementsEnforced")

  # @return [Hash] 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.
  attribute(:property_groups, Hash, from: "propertyGroups")

  # @return [String] Locale of the display elements contained in the product type definition.
  attribute(:locale, String)

  # @return [Array<String>] Amazon marketplace identifiers for which the product type definition is applicable.
  attribute(:marketplace_ids, [String], from: "marketplaceIds")

  # @return [String] The name of the Amazon product type that this product type definition applies to.
  attribute(:product_type, String, from: "productType")

  # @return [String] Human-readable and localized description of the Amazon product type.
  attribute(:display_name, String, from: "displayName")

  # @return [ProductTypeVersion] The version details for the Amazon product type.
  attribute(:product_type_version, ProductTypeVersion, from: "productTypeVersion")
end