peddler 3.0.0.beta1 → 4.0.0

data/lib/peddler/{api → apis}/product_pricing_2022_05_01.rb

@@ -3,7 +3,13 @@
 require "peddler/api"
 
 module Peddler
-  class API
+  class << self
+    def product_pricing_2022_05_01(...)
+      APIs::ProductPricing20220501.new(...)
+    end
+  end
+
+  module APIs
     # Selling Partner API for Pricing
     #
     # The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing
@@ -13,30 +19,35 @@ module Peddler
       # Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request
       # body. The response for each successful (HTTP status code 200) request in the set includes the computed listing
       # price at or below which a seller can expect to become the featured offer (before applicable promotions). This is
-      # called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may
-      # change, and different offers may be featured based on other factors, including fulfillment capabilities to a
-      # specific customer. The response to an unsuccessful request includes the available error text.
+      # called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might
+      # change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer.
+      # The response to an unsuccessful request includes the available error text.
       #
-      # @param [Hash] get_featured_offer_expected_price_batch_request_body The batch of `getFeaturedOfferExpectedPrice`
+      # @note This operation can make a static sandbox call.
+      # @param get_featured_offer_expected_price_batch_request_body [Hash] The batch of `getFeaturedOfferExpectedPrice`
       #   requests.
-      # @return [Hash] The API response
-      def get_featured_offer_expected_price_batch(get_featured_offer_expected_price_batch_request_body)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_featured_offer_expected_price_batch(get_featured_offer_expected_price_batch_request_body,
+        rate_limit: 0.033)
         path = "/batches/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice"
         body = get_featured_offer_expected_price_batch_request_body
 
-        rate_limit(0.033).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
-      # Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId`
+      # Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId`
       # combination.
       #
-      # @param [Hash] requests The batch of `getCompetitiveSummary` requests.
-      # @return [Hash] The API response
-      def get_competitive_summary(requests)
+      # @note This operation can make a static sandbox call.
+      # @param requests [Hash] The batch of `getCompetitiveSummary` requests.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_competitive_summary(requests, rate_limit: 0.033)
         path = "/batches/products/pricing/2022-05-01/items/competitiveSummary"
         body = requests
 
-        rate_limit(0.033).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
     end
   end

data/lib/peddler/{api → apis}/product_pricing_v0.rb

@@ -3,33 +3,42 @@
 require "peddler/api"
 
 module Peddler
-  class API
+  class << self
+    def product_pricing_v0(...)
+      APIs::ProductPricingV0.new(...)
+    end
+  end
+
+  module APIs
     # Selling Partner API for Pricing
     #
     # The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for
     # Amazon Marketplace products.
     class ProductPricingV0 < API
-      # Returns pricing information for a seller's offer listings based on seller SKU or ASIN.
-      # @note The parameters associated with this operation may contain special characters that require URL encoding to
-      #   call the API. To avoid errors with SKUs when encoding URLs, refer to [URL
-      #   Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).
+      # Returns pricing information for a seller's offer listings based on seller SKU or ASIN. **Note:** The parameters
+      # associated with this operation may contain special characters that require URL encoding to call the API. To
+      # avoid errors with SKUs when encoding URLs, refer to [URL
+      # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).
       #
-      # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for which prices are
+      # @note This operation can make a static sandbox call.
+      # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which prices are
       #   returned.
-      # @param [Array<String>] asins A list of up to twenty Amazon Standard Identification Number (ASIN) values used to
+      # @param asins [Array<String>] A list of up to twenty Amazon Standard Identification Number (ASIN) values used to
       #   identify items in the given marketplace.
-      # @param [Array<String>] skus A list of up to twenty seller SKU values used to identify items in the given
+      # @param skus [Array<String>] A list of up to twenty seller SKU values used to identify items in the given
       #   marketplace.
-      # @param [String] item_type Indicates whether ASIN values or seller SKU values are used to identify items. If you
+      # @param item_type [String] Indicates whether ASIN values or seller SKU values are used to identify items. If you
       #   specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins
       #   parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you
       #   provide in the Skus parameter.
-      # @param [String] item_condition Filters the offer listings based on item condition. Possible values: New, Used,
+      # @param item_condition [String] Filters the offer listings based on item condition. Possible values: New, Used,
       #   Collectible, Refurbished, Club.
-      # @param [String] offer_type Indicates whether to request pricing information for the seller's B2C or B2B offers.
+      # @param offer_type [String] Indicates whether to request pricing information for the seller's B2C or B2B offers.
       #   Default is B2C.
-      # @return [Hash] The API response
-      def get_pricing(marketplace_id, item_type, asins: nil, skus: nil, item_condition: nil, offer_type: nil)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_pricing(marketplace_id, item_type, asins: nil, skus: nil, item_condition: nil, offer_type: nil,
+        rate_limit: 0.5)
         path = "/products/pricing/v0/price"
         params = {
           "MarketplaceId" => marketplace_id,
@@ -40,28 +49,30 @@ module Peddler
           "OfferType" => offer_type,
         }.compact
 
-        rate_limit(0.5).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
-      # Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN.
-      # @note The parameters associated with this operation may contain special characters that require URL encoding to
-      #   call the API. To avoid errors with SKUs when encoding URLs, refer to [URL
-      #   Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).
+      # Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN. **Note:** The
+      # parameters associated with this operation may contain special characters that require URL encoding to call the
+      # API. To avoid errors with SKUs when encoding URLs, refer to [URL
+      # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).
       #
-      # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for which prices are
+      # @note This operation can make a static sandbox call.
+      # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which prices are
       #   returned.
-      # @param [Array<String>] asins A list of up to twenty Amazon Standard Identification Number (ASIN) values used to
+      # @param asins [Array<String>] A list of up to twenty Amazon Standard Identification Number (ASIN) values used to
       #   identify items in the given marketplace.
-      # @param [Array<String>] skus A list of up to twenty seller SKU values used to identify items in the given
+      # @param skus [Array<String>] A list of up to twenty seller SKU values used to identify items in the given
       #   marketplace.
-      # @param [String] item_type Indicates whether ASIN values or seller SKU values are used to identify items. If you
+      # @param item_type [String] Indicates whether ASIN values or seller SKU values are used to identify items. If you
       #   specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins
       #   parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you
       #   provide in the Skus parameter. Possible values: Asin, Sku.
-      # @param [String] customer_type Indicates whether to request pricing information from the point of view of
+      # @param customer_type [String] Indicates whether to request pricing information from the point of view of
       #   Consumer or Business buyers. Default is Consumer.
-      # @return [Hash] The API response
-      def get_competitive_pricing(marketplace_id, item_type, asins: nil, skus: nil, customer_type: nil)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_competitive_pricing(marketplace_id, item_type, asins: nil, skus: nil, customer_type: nil, rate_limit: 0.5)
         path = "/products/pricing/v0/competitivePrice"
         params = {
           "MarketplaceId" => marketplace_id,
@@ -71,23 +82,24 @@ module Peddler
           "CustomerType" => customer_type,
         }.compact
 
-        rate_limit(0.5).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
-      # Returns the lowest priced offers for a single SKU listing.
-      # @note The parameters associated with this operation may contain special characters that require URL encoding to
-      #   call the API. To avoid errors with SKUs when encoding URLs, refer to [URL
-      #   Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).
+      # Returns the lowest priced offers for a single SKU listing. **Note:** The parameters associated with this
+      # operation may contain special characters that require URL encoding to call the API. To avoid errors with SKUs
+      # when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).
       #
-      # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for which prices are
+      # @note This operation can make a static sandbox call.
+      # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which prices are
       #   returned.
-      # @param [String] item_condition Filters the offer listings based on item condition. Possible values: New, Used,
+      # @param item_condition [String] Filters the offer listings based on item condition. Possible values: New, Used,
       #   Collectible, Refurbished, Club.
-      # @param [String] seller_sku Identifies an item in the given marketplace. SellerSKU is qualified by the seller's
+      # @param seller_sku [String] Identifies an item in the given marketplace. SellerSKU is qualified by the seller's
       #   SellerId, which is included with every operation that you submit.
-      # @param [String] customer_type Indicates whether to request Consumer or Business offers. Default is Consumer.
-      # @return [Hash] The API response
-      def get_listing_offers(marketplace_id, item_condition, seller_sku, customer_type: nil)
+      # @param customer_type [String] Indicates whether to request Consumer or Business offers. Default is Consumer.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_listing_offers(marketplace_id, item_condition, seller_sku, customer_type: nil, rate_limit: 1.0)
         path = "/products/pricing/v0/listings/#{seller_sku}/offers"
         params = {
           "MarketplaceId" => marketplace_id,
@@ -95,19 +107,21 @@ module Peddler
           "CustomerType" => customer_type,
         }.compact
 
-        rate_limit(1.0).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Returns the lowest priced offers for a single item based on ASIN.
       #
-      # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for which prices are
+      # @note This operation can make a static sandbox call.
+      # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which prices are
       #   returned.
-      # @param [String] item_condition Filters the offer listings to be considered based on item condition. Possible
+      # @param item_condition [String] Filters the offer listings to be considered based on item condition. Possible
       #   values: New, Used, Collectible, Refurbished, Club.
-      # @param [String] asin The Amazon Standard Identification Number (ASIN) of the item.
-      # @param [String] customer_type Indicates whether to request Consumer or Business offers. Default is Consumer.
-      # @return [Hash] The API response
-      def get_item_offers(marketplace_id, item_condition, asin, customer_type: nil)
+      # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item.
+      # @param customer_type [String] Indicates whether to request Consumer or Business offers. Default is Consumer.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_item_offers(marketplace_id, item_condition, asin, customer_type: nil, rate_limit: 0.5)
         path = "/products/pricing/v0/items/#{asin}/offers"
         params = {
           "MarketplaceId" => marketplace_id,
@@ -115,29 +129,33 @@ module Peddler
           "CustomerType" => customer_type,
         }.compact
 
-        rate_limit(0.5).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Returns the lowest priced offers for a batch of items based on ASIN.
       #
-      # @param [Hash] get_item_offers_batch_request_body
-      # @return [Hash] The API response
-      def get_item_offers_batch(get_item_offers_batch_request_body)
+      # @note This operation can make a static sandbox call.
+      # @param get_item_offers_batch_request_body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_item_offers_batch(get_item_offers_batch_request_body, rate_limit: 0.1)
         path = "/batches/products/pricing/v0/itemOffers"
         body = get_item_offers_batch_request_body
 
-        rate_limit(0.1).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Returns the lowest priced offers for a batch of listings by SKU.
       #
-      # @param [Hash] get_listing_offers_batch_request_body
-      # @return [Hash] The API response
-      def get_listing_offers_batch(get_listing_offers_batch_request_body)
+      # @note This operation can make a static sandbox call.
+      # @param get_listing_offers_batch_request_body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_listing_offers_batch(get_listing_offers_batch_request_body, rate_limit: 0.5)
         path = "/batches/products/pricing/v0/listingOffers"
         body = get_listing_offers_batch_request_body
 
-        rate_limit(0.5).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
     end
   end

data/lib/peddler/{api → apis}/product_type_definitions_2020_09_01.rb

@@ -3,29 +3,38 @@
 require "peddler/api"
 
 module Peddler
-  class API
+  class << self
+    def product_type_definitions_2020_09_01(...)
+      APIs::ProductTypeDefinitions20200901.new(...)
+    end
+  end
+
+  module APIs
     # Selling Partner API for Product Type Definitions
     #
     # The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data
     # requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type
     # that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the
     # Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For
-    # more information, see the [Product Type Definitions API Use Case Guide](doc:product-type-api-use-case-guide).
+    # more information, see the {https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide Product
+    # Type Definitions API Use Case Guide}.
     class ProductTypeDefinitions20200901 < API
       # Search for and return a list of Amazon product types that have definitions available.
       #
-      # @param [Array<String>] keywords A comma-delimited list of keywords to search product types. **Note:** Cannot be
+      # @note This operation can make a static sandbox call.
+      # @param keywords [Array<String>] A comma-delimited list of keywords to search product types. **Note:** Cannot be
       #   used with `itemName`.
-      # @param [Array<String>] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request.
-      # @param [String] item_name The title of the ASIN to get the product type recommendation. **Note:** Cannot be used
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers for the request.
+      # @param item_name [String] The title of the ASIN to get the product type recommendation. **Note:** Cannot be used
       #   with `keywords`.
-      # @param [String] locale The locale for the display names in the response. Defaults to the primary locale of the
+      # @param locale [String] The locale for the display names in the response. Defaults to the primary locale of the
       #   marketplace.
-      # @param [String] search_locale The locale used for the `keywords` and `itemName` parameters. Defaults to the
+      # @param search_locale [String] The locale used for the `keywords` and `itemName` parameters. Defaults to the
       #   primary locale of the marketplace.
-      # @return [Hash] The API response
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
       def search_definitions_product_types(marketplace_ids, keywords: nil, item_name: nil, locale: nil,
-        search_locale: nil)
+        search_locale: nil, rate_limit: 5.0)
         path = "/definitions/2020-09-01/productTypes"
         params = {
           "keywords" => keywords,
@@ -35,29 +44,31 @@ module Peddler
           "searchLocale" => search_locale,
         }.compact
 
-        rate_limit(5.0).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Retrieve an Amazon product type definition.
       #
-      # @param [String] product_type The Amazon product type name.
-      # @param [String] seller_id A selling partner identifier. When provided, seller-specific requirements and values
+      # @note This operation can make a static sandbox call.
+      # @param product_type [String] The Amazon product type name.
+      # @param seller_id [String] A selling partner identifier. When provided, seller-specific requirements and values
       #   are populated within the product type definition schema, such as brand names associated with the selling
       #   partner.
-      # @param [Array<String>] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request.
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers for the request.
       #   Note: This parameter is limited to one marketplaceId at this time.
-      # @param [String] product_type_version The version of the Amazon product type to retrieve. Defaults to "LATEST",.
+      # @param product_type_version [String] The version of the Amazon product type to retrieve. Defaults to "LATEST",.
       #   Prerelease versions of product type definitions may be retrieved with "RELEASE_CANDIDATE". If no prerelease
       #   version is currently available, the "LATEST" live version will be provided.
-      # @param [String] requirements The name of the requirements set to retrieve requirements for.
-      # @param [String] requirements_enforced Identifies if the required attributes for a requirements set are enforced
+      # @param requirements [String] The name of the requirements set to retrieve requirements for.
+      # @param requirements_enforced [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 the required attributes being present (such as for partial updates).
-      # @param [String] locale Locale for retrieving display labels and other presentation details. Defaults to the
+      # @param locale [String] Locale for retrieving display labels and other presentation details. Defaults to the
       #   default language of the first marketplace in the request.
-      # @return [Hash] The API response
-      def get_definitions_product_type(product_type, marketplace_ids, seller_id: nil, product_type_version: nil,
-        requirements: nil, requirements_enforced: nil, locale: nil)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_definitions_product_type(product_type, marketplace_ids, seller_id: nil, product_type_version: "LATEST",
+        requirements: "LISTING", requirements_enforced: "ENFORCED", locale: "DEFAULT", rate_limit: 5.0)
         path = "/definitions/2020-09-01/productTypes/#{product_type}"
         params = {
           "sellerId" => seller_id,
@@ -68,7 +79,7 @@ module Peddler
           "locale" => locale,
         }.compact
 
-        rate_limit(5.0).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
     end
   end

data/lib/peddler/{api → apis}/replenishment_2022_11_07.rb

@@ -3,7 +3,13 @@
 require "peddler/api"
 
 module Peddler
-  class API
+  class << self
+    def replenishment_2022_11_07(...)
+      APIs::Replenishment20221107.new(...)
+    end
+  end
+
+  module APIs
     # Selling Partner API for Replenishment
     #
     # The Selling Partner API for Replenishment (Replenishment API) provides programmatic access to replenishment
@@ -13,32 +19,38 @@ module Peddler
     class Replenishment20221107 < API
       # Returns aggregated replenishment program metrics for a selling partner.
       #
-      # @param [Hash] body The request body for the `getSellingPartnerMetrics` operation.
-      # @return [Hash] The API response
-      def get_selling_partner_metrics(body: nil)
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] The request body for the `getSellingPartnerMetrics` operation.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_selling_partner_metrics(body: nil, rate_limit: 1.0)
         path = "/replenishment/2022-11-07/sellingPartners/metrics/search"
 
-        rate_limit(1.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Returns aggregated replenishment program metrics for a selling partner's offers.
       #
-      # @param [Hash] body The request body for the `listOfferMetrics` operation.
-      # @return [Hash] The API response
-      def list_offer_metrics(body: nil)
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] The request body for the `listOfferMetrics` operation.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def list_offer_metrics(body: nil, rate_limit: 1.0)
         path = "/replenishment/2022-11-07/offers/metrics/search"
 
-        rate_limit(1.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Returns the details of a selling partner's replenishment program offers.
       #
-      # @param [Hash] body The request body for the `listOffers` operation.
-      # @return [Hash] The API response
-      def list_offers(body: nil)
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] The request body for the `listOffers` operation.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def list_offers(body: nil, rate_limit: 1.0)
         path = "/replenishment/2022-11-07/offers/search"
 
-        rate_limit(1.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
     end
   end