peddler 4.4.0 → 4.6.0

data/lib/peddler/types/listings_items_2021_08_01/issue_enforcement_action.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # The enforcement action taken by Amazon that affect the publishing or status of a listing
+      IssueEnforcementAction = Structure.new do
+        # @return [String] The enforcement action name.
+        #
+        # Possible values:
+        #
+        # * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability.
+        #
+        # * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected
+        # by Amazon.
+        #
+        # * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the
+        # applicable marketplace are non-buyable.
+        #
+        # * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results.
+        attribute(:action, String)
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/issue_enforcements.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_items_2021_08_01/issue_enforcement_action"
+require "peddler/types/listings_items_2021_08_01/issue_exemption"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # This field provides information about the enforcement actions taken by Amazon that affect the publishing or
+      # status of a listing. It also includes details about any associated exemptions.
+      IssueEnforcements = Structure.new do
+        # @return [Array<IssueEnforcementAction>] List of enforcement actions taken by Amazon that affect the publishing
+        # or status of a listing.
+        attribute(:actions, [IssueEnforcementAction])
+
+        # @return [IssueExemption] The "exemption" field serves to convey the status of enforcement actions by Amazon.
+        attribute(:exemption, IssueExemption)
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/issue_exemption.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # Conveying the status of the listed enforcement actions and, if applicable, provides information about the
+      # exemption's expiry date.
+      IssueExemption = Structure.new do
+        # @return [String] This field indicates the current exemption status for the listed enforcement actions. It can
+        # take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary
+        # exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were
+        # already applied.
+        attribute(:status, String)
+
+        # @return [String] Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary
+        # exemptions expires, and Amazon begins enforcing the listed actions.
+        attribute(:expiry_date, String, from: "expiryDate")
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_items_2021_08_01/item_summary_by_marketplace"
+require "peddler/types/listings_items_2021_08_01/item_attributes"
+require "peddler/types/listings_items_2021_08_01/issue"
+require "peddler/types/listings_items_2021_08_01/item_offer_by_marketplace"
+require "peddler/types/listings_items_2021_08_01/fulfillment_availability"
+require "peddler/types/listings_items_2021_08_01/item_procurement"
+require "peddler/types/listings_items_2021_08_01/item_relationships_by_marketplace"
+require "peddler/types/listings_items_2021_08_01/item_product_type_by_marketplace"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # A listings item.
+      Item = Structure.new do
+        # @return [String] A selling partner provided identifier for an Amazon listing.
+        attribute(:sku, String)
+
+        # @return [Array<ItemSummaryByMarketplace>]
+        attribute(:summaries, [ItemSummaryByMarketplace])
+
+        # @return [ItemAttributes]
+        attribute(:attributes, ItemAttributes)
+
+        # @return [Array<Issue>]
+        attribute(:issues, [Issue])
+
+        # @return [Array<ItemOfferByMarketplace>]
+        attribute(:offers, [ItemOfferByMarketplace])
+
+        # @return [Array<FulfillmentAvailability>] The fulfillment availability for the listings item.
+        attribute(:fulfillment_availability, [FulfillmentAvailability], from: "fulfillmentAvailability")
+
+        # @return [Array<ItemProcurement>] The vendor procurement information for the listings item.
+        attribute(:procurement, [ItemProcurement])
+
+        # @return [Array<ItemRelationshipsByMarketplace>]
+        attribute(:relationships, [ItemRelationshipsByMarketplace])
+
+        # @return [Array<ItemProductTypeByMarketplace>]
+        attribute(:product_types, [ItemProductTypeByMarketplace], from: "productTypes")
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # A JSON object containing structured listings item attribute data keyed by attribute name.
+      ItemAttributes = Structure.new do
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_identifiers_by_marketplace.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # Identity attributes associated with the item in the Amazon catalog for the indicated Amazon marketplace.
+      ItemIdentifiersByMarketplace = Structure.new do
+        # @return [String] A marketplace identifier. Identifies the Amazon marketplace for the listings item.
+        attribute(:marketplace_id, String, from: "marketplaceId")
+
+        # @return [String] Amazon Standard Identification Number (ASIN) of the listings item.
+        attribute(:asin, String)
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_image.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # The image for the listings item.
+      ItemImage = Structure.new do
+        # @return [String] The link, or URL, to the image.
+        attribute(:link, String)
+
+        # @return [Integer] The height of the image in pixels.
+        attribute(:height, Integer)
+
+        # @return [Integer] The width of the image in pixels.
+        attribute(:width, Integer)
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_offer_by_marketplace.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "peddler/money"
+require "peddler/types/listings_items_2021_08_01/points"
+require "peddler/types/listings_items_2021_08_01/audience"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # Offer details of a listings item for an Amazon marketplace.
+      ItemOfferByMarketplace = Structure.new do
+        # @return [String] The Amazon marketplace identifier.
+        attribute(:marketplace_id, String, from: "marketplaceId")
+
+        # @return [String] Type of offer for the listings item.
+        attribute(:offer_type, String, from: "offerType")
+
+        # @return [Money] The purchase price of the listings item
+        attribute(:price, Money)
+
+        # @return [Points]
+        attribute(:points, Points)
+
+        # @return [Audience] Buyer segment or program this offer is applicable to.
+        attribute(:audience, Audience)
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_procurement.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "peddler/money"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # The vendor procurement information for the listings item.
+      ItemProcurement = Structure.new do
+        # @return [Money] The price (numeric value) that you want Amazon to pay you for this product.
+        attribute(:cost_price, Money, from: "costPrice")
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_product_type_by_marketplace.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # Product types that are associated with the listing item for the specified marketplace.
+      ItemProductTypeByMarketplace = Structure.new do
+        # @return [String] Amazon marketplace identifier.
+        attribute(:marketplace_id, String, from: "marketplaceId")
+
+        # @return [String] The name of the product type that is submitted by the Selling Partner.
+        attribute(:product_type, String, from: "productType")
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_relationship.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_items_2021_08_01/item_variation_theme"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # The relationship details for a listing item.
+      ItemRelationship = Structure.new do
+        # @return [Array<String>] Identifiers (SKUs) of the related items that are children of this listing item.
+        attribute(:child_skus, [String], from: "childSkus")
+
+        # @return [Array<String>] Identifiers (SKUs) of the related items that are parents of this listing item.
+        attribute(:parent_skus, [String], from: "parentSkus")
+
+        # @return [ItemVariationTheme] For `VARIATION` relationships, the variation theme is the combination of listing
+        # item attributes that define the variation family.
+        attribute(:variation_theme, ItemVariationTheme, from: "variationTheme")
+
+        # @return [String] The type of relationship.
+        attribute(:type, String)
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_relationships_by_marketplace.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_items_2021_08_01/item_relationship"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # Relationship details for the listing item in the specified marketplace.
+      ItemRelationshipsByMarketplace = Structure.new do
+        # @return [String] Amazon marketplace identifier.
+        attribute(:marketplace_id, String, from: "marketplaceId")
+
+        # @return [Array<ItemRelationship>] Relationships for the listing item.
+        attribute(:relationships, [ItemRelationship])
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_search_results.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_items_2021_08_01/pagination"
+require "peddler/types/listings_items_2021_08_01/item"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # Selling partner listings items and search related metadata.
+      ItemSearchResults = Structure.new do
+        # @return [Integer] The total number of selling partner listings items found for the search criteria (only
+        # results up to the page count limit is returned per request regardless of the number found).
+        #
+        # Note: The maximum number of items (SKUs) that can be returned and paged through is 1000.
+        attribute(:number_of_results, Integer, from: "numberOfResults")
+
+        # @return [Pagination] If available, the `nextToken` and/or `previousToken` values required to return paginated
+        # results.
+        attribute(:pagination, Pagination)
+
+        # @return [Array<Item>] A list of listings items.
+        attribute(:items, [Item])
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_summary_by_marketplace.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_items_2021_08_01/item_image"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # Summary details of a listings item for an Amazon marketplace.
+      ItemSummaryByMarketplace = Structure.new do
+        # @return [String] A marketplace identifier. Identifies the Amazon marketplace for the listings item.
+        attribute(:marketplace_id, String, from: "marketplaceId")
+
+        # @return [String] Amazon Standard Identification Number (ASIN) of the listings item.
+        attribute(:asin, String)
+
+        # @return [String] The Amazon product type of the listings item.
+        attribute(:product_type, String, from: "productType")
+
+        # @return [String] Identifies the condition of the listings item.
+        attribute(:condition_type, String, from: "conditionType")
+
+        # @return [Array<String>] Statuses that apply to the listings item.
+        attribute(:status, [String])
+
+        # @return [String] The fulfillment network stock keeping unit is an identifier used by Amazon fulfillment
+        # centers to identify each unique item.
+        attribute(:fn_sku, String, from: "fnSku")
+
+        # @return [String] The name or title associated with an Amazon catalog item.
+        attribute(:item_name, String, from: "itemName")
+
+        # @return [String] The date the listings item was created in ISO 8601 format.
+        attribute(:created_date, String, from: "createdDate")
+
+        # @return [String] The date the listings item was last updated in ISO 8601 format.
+        attribute(:last_updated_date, String, from: "lastUpdatedDate")
+
+        # @return [ItemImage] The main image for the listings item.
+        attribute(:main_image, ItemImage, from: "mainImage")
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/item_variation_theme.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # A variation theme that indicates the combination of listing item attributes that define the variation family.
+      ItemVariationTheme = Structure.new do
+        # @return [Array<String>] The names of the listing item attributes that are associated with the variation theme.
+        attribute(:attributes, [String])
+
+        # @return [String] The variation theme that indicates the combination of listing item attributes that define the
+        # variation family.
+        attribute(:theme, String)
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/listings_item_patch_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_items_2021_08_01/patch_operation"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # The request body schema for the `patchListingsItem` operation.
+      ListingsItemPatchRequest = Structure.new do
+        # @return [String] The Amazon product type of the listings item.
+        attribute(:product_type, String, from: "productType")
+
+        # @return [Array<PatchOperation>] One or more JSON Patch operations to perform on the listings item.
+        attribute(:patches, [PatchOperation])
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/listings_item_put_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # The request body schema for the `putListingsItem` operation.
+      ListingsItemPutRequest = Structure.new do
+        # @return [String] The Amazon product type of the listings item.
+        attribute(:product_type, String, from: "productType")
+
+        # @return [String] The name of the requirements set for the provided data.
+        attribute(:requirements, String)
+
+        # @return [Hash] A JSON object containing structured listings item attribute data keyed by attribute name.
+        attribute(:attributes, Hash)
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/listings_item_submission_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_items_2021_08_01/issue"
+require "peddler/types/listings_items_2021_08_01/item_identifiers_by_marketplace"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # Response containing the results of a submission to the Selling Partner API for Listings Items.
+      ListingsItemSubmissionResponse = Structure.new do
+        # @return [String] A selling partner provided identifier for an Amazon listing.
+        attribute(:sku, String)
+
+        # @return [String] The status of the listings item submission.
+        attribute(:status, String)
+
+        # @return [String] The unique identifier of the listings item submission.
+        attribute(:submission_id, String, from: "submissionId")
+
+        # @return [Array<Issue>] Listings item issues related to the listings item submission.
+        attribute(:issues, [Issue])
+
+        # @return [Array<ItemIdentifiersByMarketplace>] Identity attributes associated with the item in the Amazon
+        # catalog, such as the ASIN.
+        attribute(:identifiers, [ItemIdentifiersByMarketplace])
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/pagination.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is
+      # divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken`
+      # value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last
+      # page, there is no `nextToken` key in the pagination object.
+      Pagination = Structure.new do
+        # @return [String] A token that can be used to fetch the next page.
+        attribute(:next_token, String, from: "nextToken")
+
+        # @return [String] A token that can be used to fetch the previous page.
+        attribute(:previous_token, String, from: "previousToken")
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/patch_operation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # Individual JSON Patch operation for an HTTP PATCH request.
+      PatchOperation = Structure.new do
+        # @return [String] Type of JSON Patch operation. Supported JSON Patch operations include `add`, `replace`,
+        # `merge` and `delete`. Refer to <https://tools.ietf.org/html/rfc6902>.
+        attribute(:op, String)
+
+        # @return [String] JSON Pointer path of the element to patch. Refer to [JavaScript Object Notation (JSON)
+        # Patch](https://tools.ietf.org/html/rfc6902) for more information.
+        attribute(:path, String)
+
+        # @return [Array<Object>] JSON value to `add`, `replace`, `merge` or `delete`.
+        attribute(:value, Array)
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01/points.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsItems20210801
+      # The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the
+      # `Points` element is only returned in Japan (JP).
+      Points = Structure.new do
+        # @return [Integer]
+        attribute(:points_number, Integer, from: "pointsNumber")
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_items_2021_08_01.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_items_2021_08_01/audience"
+require "peddler/types/listings_items_2021_08_01/error"
+require "peddler/types/listings_items_2021_08_01/error_list"
+require "peddler/types/listings_items_2021_08_01/fulfillment_availability"
+require "peddler/types/listings_items_2021_08_01/issue"
+require "peddler/types/listings_items_2021_08_01/issue_enforcement_action"
+require "peddler/types/listings_items_2021_08_01/issue_enforcements"
+require "peddler/types/listings_items_2021_08_01/issue_exemption"
+require "peddler/types/listings_items_2021_08_01/item"
+require "peddler/types/listings_items_2021_08_01/item_attributes"
+require "peddler/types/listings_items_2021_08_01/item_identifiers_by_marketplace"
+require "peddler/types/listings_items_2021_08_01/item_image"
+require "peddler/types/listings_items_2021_08_01/item_offer_by_marketplace"
+require "peddler/types/listings_items_2021_08_01/item_procurement"
+require "peddler/types/listings_items_2021_08_01/item_product_type_by_marketplace"
+require "peddler/types/listings_items_2021_08_01/item_relationship"
+require "peddler/types/listings_items_2021_08_01/item_relationships_by_marketplace"
+require "peddler/types/listings_items_2021_08_01/item_search_results"
+require "peddler/types/listings_items_2021_08_01/item_summary_by_marketplace"
+require "peddler/types/listings_items_2021_08_01/item_variation_theme"
+require "peddler/types/listings_items_2021_08_01/listings_item_patch_request"
+require "peddler/types/listings_items_2021_08_01/listings_item_put_request"
+require "peddler/types/listings_items_2021_08_01/listings_item_submission_response"
+require "peddler/types/listings_items_2021_08_01/pagination"
+require "peddler/types/listings_items_2021_08_01/patch_operation"
+require "peddler/types/listings_items_2021_08_01/points"

data/lib/peddler/types/listings_restrictions_2021_08_01/error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsRestrictions20210801
+      # Error response returned when the request is unsuccessful.
+      Error = 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
+    end
+  end
+end

data/lib/peddler/types/listings_restrictions_2021_08_01/link.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module ListingsRestrictions20210801
+      # A link to resources related to a listing restriction.
+      Link = Structure.new do
+        # @return [String] The URI of the related resource.
+        attribute(:resource, String)
+
+        # @return [String] The HTTP verb used to interact with the related resource.
+        attribute(:verb, String)
+
+        # @return [String] The title of the related resource.
+        attribute(:title, String)
+
+        # @return [String] The media type of the related resource.
+        attribute(:type, String)
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_restrictions_2021_08_01/reason.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_restrictions_2021_08_01/link"
+
+module Peddler
+  module Types
+    module ListingsRestrictions20210801
+      # A reason for the restriction, including path forward links that may allow Selling Partners to remove the
+      # restriction, if available.
+      Reason = Structure.new do
+        # @return [String] A message describing the reason for the restriction.
+        attribute(:message, String)
+
+        # @return [String] A code indicating why the listing is restricted.
+        attribute(:reason_code, String, from: "reasonCode")
+
+        # @return [Array<Link>] A list of path forward links that may allow Selling Partners to remove the restriction.
+        attribute(:links, [Link])
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_restrictions_2021_08_01/restriction.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_restrictions_2021_08_01/reason"
+
+module Peddler
+  module Types
+    module ListingsRestrictions20210801
+      # A listing restriction, optionally qualified by a condition, with a list of reasons for the restriction.
+      Restriction = Structure.new do
+        # @return [String] A marketplace identifier. Identifies the Amazon marketplace where the restriction is
+        # enforced.
+        attribute(:marketplace_id, String, from: "marketplaceId")
+
+        # @return [String] The condition that applies to the restriction.
+        attribute(:condition_type, String, from: "conditionType")
+
+        # @return [Array<Reason>] A list of reasons for the restriction.
+        attribute(:reasons, [Reason])
+      end
+    end
+  end
+end

data/lib/peddler/types/listings_restrictions_2021_08_01/restriction_list.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "peddler/types/listings_restrictions_2021_08_01/restriction"
+
+module Peddler
+  module Types
+    module ListingsRestrictions20210801
+      # A list of restrictions for the specified Amazon catalog item.
+      RestrictionList = Structure.new do
+        # @return [Array<Restriction>]
+        attribute(:restrictions, [Restriction])
+      end
+    end
+  end
+end