peddler 3.0.0.beta1 → 3.0.0

data/lib/peddler/api/listings_items_2021_08_01.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def listings_items_2021_08_01(...)
+      API::ListingsItems20210801.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Listings Items
     #
@@ -12,43 +18,46 @@ module Peddler
     # information, see the [Listings Items API Use Case
     # Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-use-case-guide).
     class ListingsItems20210801 < API
-      # Delete a listings item for a selling partner.
-      # @note The parameters associated with this operation may contain special characters that must be encoded to
-      #   successfully 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).
+      # Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may
+      # contain special characters that must be encoded to successfully 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] seller_id A selling partner identifier, such as a merchant account or vendor code.
-      # @param [String] sku A selling partner provided identifier for an Amazon listing.
-      # @param [Array<String>] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request.
-      # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code
+      # @note This operation can make a static sandbox call.
+      # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code.
+      # @param sku [String] A selling partner provided identifier for an Amazon listing.
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers for the request.
+      # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code
       #   of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US`
       #   when a localization is not available in the specified locale.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def delete_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil)
+      def delete_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, rate_limit: 5.0)
         path = "/listings/2021-08-01/items/#{seller_id}/#{sku}"
         params = {
           "marketplaceIds" => marketplace_ids,
           "issueLocale" => issue_locale,
         }.compact
 
-        rate_limit(5.0).delete(path, params:)
+        meter(rate_limit).delete(path, params:)
       end
 
-      # Returns details about a listings item for a selling partner.
-      # @note The parameters associated with this operation may contain special characters that must be encoded to
-      #   successfully 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 details about a listings item for a selling partner. **Note:** The parameters associated with this
+      # operation may contain special characters that must be encoded to successfully 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] seller_id A selling partner identifier, such as a merchant account or vendor code.
-      # @param [String] sku A selling partner provided identifier for an Amazon listing.
-      # @param [Array<String>] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request.
-      # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code
+      # @note This operation can make a static sandbox call.
+      # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code.
+      # @param sku [String] A selling partner provided identifier for an Amazon listing.
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers for the request.
+      # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code
       #   of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US`
       #   when a localization is not available in the specified locale.
-      # @param [Array<String>] included_data A comma-delimited list of data sets to include in the response. Default:
+      # @param included_data [Array<String>] A comma-delimited list of data sets to include in the response. Default:
       #   `summaries`.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, included_data: nil)
+      def get_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, included_data: ["summaries"],
+        rate_limit: 5.0)
         path = "/listings/2021-08-01/items/#{seller_id}/#{sku}"
         params = {
           "marketplaceIds" => marketplace_ids,
@@ -56,28 +65,30 @@ module Peddler
           "includedData" => included_data,
         }.compact
 
-        rate_limit(5.0).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be
-      # patched. Patching nested attributes is not supported.
-      # @note This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`.
-      # @note The parameters associated with this operation may contain special characters that must be encoded to
-      #   successfully 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).
+      # patched. Patching nested attributes is not supported. **Note:** This operation has a throttling rate of one
+      # request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation
+      # may contain special characters that must be encoded to successfully 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] seller_id A selling partner identifier, such as a merchant account or vendor code.
-      # @param [String] sku A selling partner provided identifier for an Amazon listing.
-      # @param [Array<String>] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request.
-      # @param [Array<String>] included_data A comma-delimited list of data sets to include in the response. Default:
+      # @note This operation can make a static sandbox call.
+      # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code.
+      # @param sku [String] A selling partner provided identifier for an Amazon listing.
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers for the request.
+      # @param included_data [Array<String>] A comma-delimited list of data sets to include in the response. Default:
       #   `issues`.
-      # @param [String] mode The mode of operation for the request.
-      # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code
+      # @param mode [String] The mode of operation for the request.
+      # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code
       #   of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US`
       #   when a localization is not available in the specified locale.
-      # @param [Hash] body The request body schema for the `patchListingsItem` operation.
+      # @param body [Hash] The request body schema for the `patchListingsItem` operation.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def patch_listings_item(seller_id, sku, marketplace_ids, body, included_data: nil, mode: nil, issue_locale: nil)
+      def patch_listings_item(seller_id, sku, marketplace_ids, body, included_data: ["issues"], mode: nil,
+        issue_locale: nil, rate_limit: 5.0)
         path = "/listings/2021-08-01/items/#{seller_id}/#{sku}"
         params = {
           "marketplaceIds" => marketplace_ids,
@@ -86,27 +97,30 @@ module Peddler
           "issueLocale" => issue_locale,
         }.compact
 
-        rate_limit(5.0).patch(path, body:, params:)
+        meter(rate_limit).patch(path, body:, params:)
       end
 
-      # Creates or fully updates an existing listings item for a selling partner.
-      # @note This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`.
-      # @note The parameters associated with this operation may contain special characters that must be encoded to
-      #   successfully 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).
+      # Creates or fully updates an existing listings item for a selling partner. **Note:** This operation has a
+      # throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters
+      # associated with this operation may contain special characters that must be encoded to successfully 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] seller_id A selling partner identifier, such as a merchant account or vendor code.
-      # @param [String] sku A selling partner provided identifier for an Amazon listing.
-      # @param [Array<String>] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request.
-      # @param [Array<String>] included_data A comma-delimited list of data sets to include in the response. Default:
+      # @note This operation can make a static sandbox call.
+      # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code.
+      # @param sku [String] A selling partner provided identifier for an Amazon listing.
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers for the request.
+      # @param included_data [Array<String>] A comma-delimited list of data sets to include in the response. Default:
       #   `issues`.
-      # @param [String] mode The mode of operation for the request.
-      # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code
+      # @param mode [String] The mode of operation for the request.
+      # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code
       #   of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US`
       #   when a localization is not available in the specified locale.
-      # @param [Hash] body The request body schema for the `putListingsItem` operation.
+      # @param body [Hash] The request body schema for the `putListingsItem` operation.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def put_listings_item(seller_id, sku, marketplace_ids, body, included_data: nil, mode: nil, issue_locale: nil)
+      def put_listings_item(seller_id, sku, marketplace_ids, body, included_data: ["issues"], mode: nil,
+        issue_locale: nil, rate_limit: 5.0)
         path = "/listings/2021-08-01/items/#{seller_id}/#{sku}"
         params = {
           "marketplaceIds" => marketplace_ids,
@@ -115,27 +129,29 @@ module Peddler
           "issueLocale" => issue_locale,
         }.compact
 
-        rate_limit(5.0).put(path, body:, params:)
+        meter(rate_limit).put(path, body:, params:)
       end
 
       # Search for and return list of listings items and respective details for a selling partner.
       #
-      # @param [String] seller_id A selling partner identifier, such as a merchant account or vendor code.
-      # @param [Array<String>] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request.
-      # @param [Array<String>] identifiers A comma-delimited list of product identifiers to search for listings items
+      # @note This operation can make a static sandbox call.
+      # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code.
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers for the request.
+      # @param identifiers [Array<String>] A comma-delimited list of product identifiers to search for listings items
       #   by. **Note**: 1. Required when `identifiersType` is provided.
-      # @param [String] identifiers_type Type of product identifiers to search for listings items by. **Note**: 1.
+      # @param identifiers_type [String] Type of product identifiers to search for listings items by. **Note**: 1.
       #   Required when `identifiers` is provided.
-      # @param [Integer] page_size Number of results to be returned per page.
-      # @param [String] page_token A token to fetch a certain page when there are multiple pages worth of results.
-      # @param [Array<String>] included_data A comma-delimited list of data sets to include in the response. Default:
+      # @param page_size [Integer] Number of results to be returned per page.
+      # @param page_token [String] A token to fetch a certain page when there are multiple pages worth of results.
+      # @param included_data [Array<String>] A comma-delimited list of data sets to include in the response. Default:
       #   summaries.
-      # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code
+      # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code
       #   of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US"
       #   when a localization is not available in the specified locale.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def search_listings_items(seller_id, marketplace_ids, identifiers: nil, identifiers_type: nil, page_size: nil,
-        page_token: nil, included_data: nil, issue_locale: nil)
+      def search_listings_items(seller_id, marketplace_ids, identifiers: nil, identifiers_type: nil, page_size: 10,
+        page_token: nil, included_data: ["summaries"], issue_locale: nil, rate_limit: 5.0)
         path = "/listings/2021-08-01/items/#{seller_id}"
         params = {
           "marketplaceIds" => marketplace_ids,
@@ -147,7 +163,7 @@ module Peddler
           "issueLocale" => issue_locale,
         }.compact
 
-        rate_limit(5.0).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
     end
   end

data/lib/peddler/api/listings_restrictions_2021_08_01.rb

@@ -3,24 +3,34 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def listings_restrictions_2021_08_01(...)
+      API::ListingsRestrictions20210801.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Listings Restrictions
     #
     # The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog
-    # listings. For more information, see the [Listings Restrictions API Use Case
-    # Guide](doc:listings-restrictions-api-v2021-08-01-use-case-guide).
+    # listings. For more information, see the
+    # {https://developer-docs.amazon.com/sp-api/docs/listings-restrictions-api-v2021-08-01-use-case-guide Listings
+    # Restrictions API Use Case Guide}.
     class ListingsRestrictions20210801 < API
       # Returns listing restrictions for an item in the Amazon Catalog.
       #
-      # @param [String] asin The Amazon Standard Identification Number (ASIN) of the item.
-      # @param [String] condition_type The condition used to filter restrictions.
-      # @param [String] seller_id A selling partner identifier, such as a merchant account.
-      # @param [Array<String>] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request.
-      # @param [String] reason_locale A locale for reason text localization. When not provided, the default language
+      # @note This operation can make a static sandbox call.
+      # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item.
+      # @param condition_type [String] The condition used to filter restrictions.
+      # @param seller_id [String] A selling partner identifier, such as a merchant account.
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers for the request.
+      # @param reason_locale [String] A locale for reason text localization. When not provided, the default language
       #   code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to
       #   "en_US" when a localization is not available in the specified locale.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_listings_restrictions(asin, seller_id, marketplace_ids, condition_type: nil, reason_locale: nil)
+      def get_listings_restrictions(asin, seller_id, marketplace_ids, condition_type: nil, reason_locale: nil,
+        rate_limit: 5.0)
         path = "/listings/2021-08-01/restrictions"
         params = {
           "asin" => asin,
@@ -30,7 +40,7 @@ module Peddler
           "reasonLocale" => reason_locale,
         }.compact
 
-        rate_limit(5.0).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
     end
   end

data/lib/peddler/api/merchant_fulfillment_v0.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def merchant_fulfillment_v0(...)
+      API::MerchantFulfillmentV0.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Merchant Fulfillment
     #
@@ -11,53 +17,63 @@ module Peddler
     class MerchantFulfillmentV0 < API
       # Returns a list of shipping service offers that satisfy the specified shipment request details.
       #
-      # @param [Hash] body Request schema for GetEligibleShipmentServices operation.
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Request schema for GetEligibleShipmentServices operation.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_eligible_shipment_services(body)
+      def get_eligible_shipment_services(body, rate_limit: 5.0)
         path = "/mfn/v0/eligibleShippingServices"
 
-        rate_limit(5.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Returns the shipment information for an existing shipment.
       #
-      # @param [String] shipment_id The Amazon-defined shipment identifier for the shipment.
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The Amazon-defined shipment identifier for the shipment.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_shipment(shipment_id)
+      def get_shipment(shipment_id, rate_limit: 1.0)
         path = "/mfn/v0/shipments/#{shipment_id}"
 
-        rate_limit(1.0).get(path)
+        meter(rate_limit).get(path)
       end
 
       # Cancel the shipment indicated by the specified shipment identifier.
       #
-      # @param [String] shipment_id The Amazon-defined shipment identifier for the shipment to cancel.
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The Amazon-defined shipment identifier for the shipment to cancel.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def cancel_shipment(shipment_id)
+      def cancel_shipment(shipment_id, rate_limit: 1.0)
         path = "/mfn/v0/shipments/#{shipment_id}"
 
-        rate_limit(1.0).delete(path)
+        meter(rate_limit).delete(path)
       end
 
       # Create a shipment with the information provided.
       #
-      # @param [Hash] body Request schema for CreateShipment operation.
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Request schema for CreateShipment operation.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def create_shipment(body)
+      def create_shipment(body, rate_limit: 1.0)
         path = "/mfn/v0/shipments"
 
-        rate_limit(1.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Gets a list of additional seller inputs required for a ship method. This is generally used for international
       # shipping.
       #
-      # @param [Hash] body Request schema for GetAdditionalSellerInputs operation.
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Request schema for GetAdditionalSellerInputs operation.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_additional_seller_inputs(body)
+      def get_additional_seller_inputs(body, rate_limit: 1.0)
         path = "/mfn/v0/additionalSellerInputs"
 
-        rate_limit(1.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
     end
   end