peddler 3.0.0.beta1 → 3.0.0

data/lib/peddler/api/product_pricing_v0.rb

@@ -3,33 +3,42 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def product_pricing_v0(...)
+      API::ProductPricingV0.new(...)
+    end
+  end
+
   class API
     # 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.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_pricing(marketplace_id, item_type, asins: nil, skus: nil, item_condition: nil, offer_type: nil)
+      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.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_competitive_pricing(marketplace_id, item_type, asins: nil, skus: nil, customer_type: nil)
+      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.
+      # @param customer_type [String] Indicates whether to request Consumer or Business offers. Default is Consumer.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_listing_offers(marketplace_id, item_condition, seller_sku, customer_type: nil)
+      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.
+      # @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 [Hash] The API response
-      def get_item_offers(marketplace_id, item_condition, asin, customer_type: nil)
+      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
+      # @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 [Hash] The API response
-      def get_item_offers_batch(get_item_offers_batch_request_body)
+      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
+      # @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 [Hash] The API response
-      def get_listing_offers_batch(get_listing_offers_batch_request_body)
+      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/product_type_definitions_2020_09_01.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def product_type_definitions_2020_09_01(...)
+      API::ProductTypeDefinitions20200901.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Product Type Definitions
     #
@@ -10,22 +16,25 @@ module Peddler
     # 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.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] 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.
+      # @param rate_limit [Float] Requests per second
       # @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)
+      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/replenishment_2022_11_07.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def replenishment_2022_11_07(...)
+      API::Replenishment20221107.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for 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.
+      # @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 [Hash] The API response
-      def get_selling_partner_metrics(body: nil)
+      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.
+      # @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 [Hash] The API response
-      def list_offer_metrics(body: nil)
+      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.
+      # @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 [Hash] The API response
-      def list_offers(body: nil)
+      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

data/lib/peddler/api/reports_2021_06_30.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def reports_2021_06_30(...)
+      API::Reports20210630.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Reports
     #
@@ -11,26 +17,28 @@ module Peddler
     class Reports20210630 < API
       # Returns report details for the reports that match the filters that you specify.
       #
-      # @param [Array<String>] report_types A list of report types used to filter reports. Refer to [Report Type
+      # @note This operation can make a static sandbox call.
+      # @param report_types [Array<String>] A list of report types used to filter reports. Refer to [Report Type
       #   Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When
       #   reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince,
       #   createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.
-      # @param [Array<String>] processing_statuses A list of processing statuses used to filter reports.
-      # @param [Array<String>] marketplace_ids A list of marketplace identifiers used to filter reports. The reports
+      # @param processing_statuses [Array<String>] A list of processing statuses used to filter reports.
+      # @param marketplace_ids [Array<String>] A list of marketplace identifiers used to filter reports. The reports
       #   returned will match at least one of the marketplaces that you specify.
-      # @param [Integer] page_size The maximum number of reports to return in a single call.
-      # @param [String] created_since The earliest report creation date and time for reports to include in the response,
-      #   in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. The default is 90 days
+      # @param page_size [Integer] The maximum number of reports to return in a single call.
+      # @param created_since [String] The earliest report creation date and time for reports to include in the response,
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} date time format. The default is 90 days
       #   ago. Reports are retained for a maximum of 90 days.
-      # @param [String] created_until The latest report creation date and time for reports to include in the response,
-      #   in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. The default is now.
-      # @param [String] next_token A string token returned in the response to your previous request. `nextToken` is
+      # @param created_until [String] The latest report creation date and time for reports to include in the response,
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} date time format. The default is now.
+      # @param next_token [String] A string token returned in the response to your previous request. `nextToken` is
       #   returned when the number of results exceeds the specified `pageSize` value. To get the next page of results,
       #   call the `getReports` operation and include this token as the only parameter. Specifying `nextToken` with any
       #   other parameters will cause the request to fail.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_reports(report_types: nil, processing_statuses: nil, marketplace_ids: nil, page_size: nil,
-        created_since: nil, created_until: nil, next_token: nil)
+      def get_reports(report_types: nil, processing_statuses: nil, marketplace_ids: nil, page_size: 10,
+        created_since: nil, created_until: nil, next_token: nil, rate_limit: 0.0222)
         path = "/reports/2021-06-30/reports"
         params = {
           "reportTypes" => report_types,
@@ -42,97 +50,113 @@ module Peddler
           "nextToken" => next_token,
         }.compact
 
-        rate_limit(0.0222).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Creates a report.
       #
-      # @param [Hash] body Information required to create the report.
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Information required to create the report.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def create_report(body)
+      def create_report(body, rate_limit: 0.0167)
         path = "/reports/2021-06-30/reports"
 
-        rate_limit(0.0167).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Cancels the report that you specify. Only reports with `processingStatus=IN_QUEUE` can be cancelled. Cancelled
       # reports are returned in subsequent calls to the `getReport` and `getReports` operations.
       #
-      # @param [String] report_id The identifier for the report. This identifier is unique only in combination with a
+      # @note This operation can make a static sandbox call.
+      # @param report_id [String] The identifier for the report. This identifier is unique only in combination with a
       #   seller ID.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def cancel_report(report_id)
+      def cancel_report(report_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/reports/#{report_id}"
 
-        rate_limit(0.0222).delete(path)
+        meter(rate_limit).delete(path)
       end
 
       # Returns report details (including the `reportDocumentId`, if available) for the report that you specify.
       #
-      # @param [String] report_id The identifier for the report. This identifier is unique only in combination with a
+      # @note This operation can make a static sandbox call.
+      # @param report_id [String] The identifier for the report. This identifier is unique only in combination with a
       #   seller ID.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_report(report_id)
+      def get_report(report_id, rate_limit: 2.0)
         path = "/reports/2021-06-30/reports/#{report_id}"
 
-        rate_limit(2.0).get(path)
+        meter(rate_limit).get(path)
       end
 
       # Returns report schedule details that match the filters that you specify.
       #
-      # @param [Array<String>] report_types A list of report types used to filter report schedules. Refer to [Report
+      # @note This operation can make a static sandbox call.
+      # @param report_types [Array<String>] A list of report types used to filter report schedules. Refer to [Report
       #   Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_report_schedules(report_types)
+      def get_report_schedules(report_types, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules"
         params = {
           "reportTypes" => report_types,
         }.compact
 
-        rate_limit(0.0222).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it
       # will be cancelled and replaced with this one.
       #
-      # @param [Hash] body Information required to create the report schedule.
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Information required to create the report schedule.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def create_report_schedule(body)
+      def create_report_schedule(body, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules"
 
-        rate_limit(0.0222).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Cancels the report schedule that you specify.
       #
-      # @param [String] report_schedule_id The identifier for the report schedule. This identifier is unique only in
+      # @note This operation can make a static sandbox call.
+      # @param report_schedule_id [String] The identifier for the report schedule. This identifier is unique only in
       #   combination with a seller ID.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def cancel_report_schedule(report_schedule_id)
+      def cancel_report_schedule(report_schedule_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules/#{report_schedule_id}"
 
-        rate_limit(0.0222).delete(path)
+        meter(rate_limit).delete(path)
       end
 
       # Returns report schedule details for the report schedule that you specify.
       #
-      # @param [String] report_schedule_id The identifier for the report schedule. This identifier is unique only in
+      # @note This operation can make a static sandbox call.
+      # @param report_schedule_id [String] The identifier for the report schedule. This identifier is unique only in
       #   combination with a seller ID.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_report_schedule(report_schedule_id)
+      def get_report_schedule(report_schedule_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules/#{report_schedule_id}"
 
-        rate_limit(0.0222).get(path)
+        meter(rate_limit).get(path)
       end
 
       # Returns the information required for retrieving a report document's contents.
       #
-      # @param [String] report_document_id The identifier for the report document.
+      # @note This operation can make a static sandbox call.
+      # @param report_document_id [String] The identifier for the report document.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_report_document(report_document_id)
+      def get_report_document(report_document_id, rate_limit: 0.0167)
         path = "/reports/2021-06-30/documents/#{report_document_id}"
 
-        rate_limit(0.0167).get(path)
+        meter(rate_limit).get(path)
       end
     end
   end

data/lib/peddler/api/sales_v1.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def sales_v1(...)
+      API::SalesV1.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Sales
     #
@@ -10,45 +16,47 @@ module Peddler
     class SalesV1 < API
       # Returns aggregated order metrics for given interval, broken down by granularity, for given buyer type.
       #
-      # @param [Array<String>] marketplace_ids A marketplace identifier. This specifies the marketplace in which the
+      # @note This operation can make a static sandbox call.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
       #   order was placed. Only one marketplace can be specified. For example, ATVPDKIKX0DER indicates the US
       #   marketplace.
-      # @param [String] interval A time interval used for selecting order metrics. This takes the form of two dates
+      # @param interval [String] A time interval used for selecting order metrics. This takes the form of two dates
       #   separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and
       #   must represent absolute time (either Z notation or offset notation). Example:
       #   2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the
       #   -07:00 zone.
-      # @param [String] granularity_time_zone An IANA-compatible time zone for determining the day boundary. Required
+      # @param granularity_time_zone [String] An IANA-compatible time zone for determining the day boundary. Required
       #   when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the
       #   offset of the specified interval value. For example, if the interval value uses Z notation, then
       #   granularityTimeZone must be UTC. If the interval value uses an offset, then granularityTimeZone must be an
       #   IANA-compatible time zone that matches the offset. Example: US/Pacific to compute day boundaries, accounting
       #   for daylight time savings, for US/Pacific zone.
-      # @param [String] granularity The granularity of the grouping of order metrics, based on a unit of time.
+      # @param granularity [String] The granularity of the grouping of order metrics, based on a unit of time.
       #   Specifying granularity=Hour results in a successful request only if the interval specified is less than or
       #   equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2
       #   years from now. Specifying granularity=Total results in order metrics that are aggregated over the entire
       #   interval that you specify. If the interval start and end date don’t align with the specified granularity, the
       #   head and tail end of the response interval will contain partial data. Example: Day to get a daily breakdown of
       #   the request interval, where the day boundary is defined by the granularityTimeZone.
-      # @param [String] buyer_type Filters the results by the buyer type that you specify, B2B (business to business) or
+      # @param buyer_type [String] Filters the results by the buyer type that you specify, B2B (business to business) or
       #   B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B
       #   buyers.
-      # @param [String] fulfillment_network Filters the results by the fulfillment network that you specify, MFN
+      # @param fulfillment_network [String] Filters the results by the fulfillment network that you specify, MFN
       #   (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the
       #   response to include order metrics for all fulfillment networks. Example: AFN, if you want the response to
       #   include order metrics for only Amazon fulfillment network.
-      # @param [String] first_day_of_week Specifies the day that the week starts on when granularity=Week, either Monday
+      # @param first_day_of_week [String] Specifies the day that the week starts on when granularity=Week, either Monday
       #   or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
-      # @param [String] asin Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an
+      # @param asin [String] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an
       #   error. Do not include this filter if you want the response to include order metrics for all ASINs. Example:
       #   B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
-      # @param [String] sku Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an
+      # @param sku [String] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an
       #   error. Do not include this filter if you want the response to include order metrics for all SKUs. Example:
       #   TestSKU, if you want the response to include order metrics for only SKU TestSKU.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_order_metrics(marketplace_ids, interval, granularity, granularity_time_zone: nil, buyer_type: nil,
-        fulfillment_network: nil, first_day_of_week: nil, asin: nil, sku: nil)
+      def get_order_metrics(marketplace_ids, interval, granularity, granularity_time_zone: nil, buyer_type: "All",
+        fulfillment_network: nil, first_day_of_week: "Monday", asin: nil, sku: nil, rate_limit: 0.5)
         path = "/sales/v1/orderMetrics"
         params = {
           "marketplaceIds" => marketplace_ids,
@@ -62,7 +70,7 @@ module Peddler
           "sku" => sku,
         }.compact
 
-        rate_limit(0.5).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
     end
   end