peddler 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7677959689b208211817ca535b18ec25d495df736d1e502e8b758cdb2c826603
-  data.tar.gz: c4c4f26d97ab8bcbb18e2ee0bbac890e7e2284b475a0d19286ea1c15e456b942
+  metadata.gz: f24fcbe5356adc88b3eff33d9f5ca86631c96c4c3187c189594b5771034f111c
+  data.tar.gz: d605c37bade2f932f1661a8351db41e2e77f4c6684796e583dbf28939d08489e
 SHA512:
-  metadata.gz: cc020ae6bda468c2d82044b8a7b226f6101ea141b63d3cd8731ae1c58507b93f11c9e8e18040cb8a31ff0c8dcef40617bdc080f76346f029ddab1b35076027e3
-  data.tar.gz: 9e8d25fbdfe70c203331fa4ffda8147000b59e66b0ec0658b99d17a25342e975706d9366d6b7c2d6d9314593cfc6a4fbd7e4bc50b4ff5613aaf452337b7b1061
+  metadata.gz: bd19ca60dfbbfefdf17ef1152dc4ab5906265e1266ad66a13fc4bcf3cb4190a1b34b5b6b1908c1ed093ff5fa702c31e0275c7d00d24a1c39c5ea696abd2a6887
+  data.tar.gz: 61f4b5e4238fd997cf7e2606caf39138b8dcda336aa63c6685ef3d67ee41d9c64357577e0831961ef40a7974d6d9e1c567093d5ea2b1884489e3e5835aaaebb7

data/README.md

@@ -4,8 +4,6 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/281e6176048f3c0a1ed3/maintainability)][maintainability]
 [![Test Coverage](https://api.codeclimate.com/v1/badges/281e6176048f3c0a1ed3/test_coverage)][test-coverage]
 
-> **_NOTE:_** This README explains the main branch, which may contain unreleased code. For the README of the latest release, please refer to [this link][latest-release-readme].
-
 **Peddler** is a Ruby interface to the [Amazon Selling Partner API (SP-API)][docs-overview]. The SP-API enables Amazon sellers and vendors to programmatically access their data on orders, shipments, payments, and more.
 
 Peddler is automatically generated from the Open API models provided by Amazon.
@@ -515,7 +513,6 @@ response.parse
 [build]: https://github.com/hakanensari/peddler/actions
 [maintainability]: https://codeclimate.com/github/hakanensari/peddler/maintainability
 [test-coverage]: https://codeclimate.com/github/hakanensari/peddler/test_coverage
-[latest-release-readme]: https://github.com/lineofflight/peddler/tree/v3.0.0
 [docs-overview]: https://developer.amazonservices.com/sp-api-docs/overview
 [register-as-developer]: https://developer-docs.amazon.com/sp-api/docs/registering-as-a-developer
 [register-application]: https://developer-docs.amazon.com/sp-api/docs/registering-your-application

data/lib/peddler/api.rb

@@ -30,8 +30,9 @@ module Peddler
     # @return [Integer]
     attr_reader :retries
 
-    # @param [String] aws_region
-    # @param [String] access_token
+    # @param [String] aws_region The AWS region to use for the endpoint
+    # @param [String] access_token The access token for authentication
+    # @param [Integer] retries The number of retries if throttled (default: 0)
     def initialize(aws_region, access_token, retries: 0)
       @endpoint = Endpoint.find(aws_region)
       @access_token = access_token

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09.rb

@@ -15,6 +15,69 @@ module Peddler
     # The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information
     # about AWD shipments and inventory.
     class AmazonWarehousingAndDistribution20240509 < API
+      # Creates a draft AWD inbound order with a list of packages for inbound shipment. The operation creates one
+      # shipment per order.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Payload for creating an inbound order.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def create_inbound(body, rate_limit: 1.0)
+        path = "/awd/2024-05-09/inboundOrders"
+
+        meter(rate_limit).post(path, body:)
+      end
+
+      # Retrieves an AWD inbound order.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] The ID of the inbound order that you want to retrieve.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_inbound(order_id, rate_limit: 2.0)
+        path = "/awd/2024-05-09/inboundOrders/#{order_id}"
+
+        meter(rate_limit).get(path)
+      end
+
+      # Updates an AWD inbound order that is in `DRAFT` status and not yet confirmed. Use this operation to update the
+      # `packagesToInbound`, `originAddress` and `preferences` attributes.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] The ID of the inbound order that you want to update.
+      # @param body [Hash] Represents an AWD inbound order.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def update_inbound(order_id, body, rate_limit: 1.0)
+        path = "/awd/2024-05-09/inboundOrders/#{order_id}"
+
+        meter(rate_limit).put(path, body:)
+      end
+
+      # Cancels an AWD Inbound order and its associated shipment.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] The ID of the inbound order you want to cancel.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def cancel_inbound(order_id, rate_limit: 1.0)
+        path = "/awd/2024-05-09/inboundOrders/#{order_id}/cancellation"
+
+        meter(rate_limit).post(path)
+      end
+
+      # Confirms an AWD inbound order in `DRAFT` status.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] The ID of the inbound order that you want to confirm.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def confirm_inbound(order_id, rate_limit: 1.0)
+        path = "/awd/2024-05-09/inboundOrders/#{order_id}/confirmation"
+
+        meter(rate_limit).post(path)
+      end
+
       # Retrieves an AWD inbound shipment.
       #
       # @note This operation can make a static sandbox call.
@@ -32,6 +95,52 @@ module Peddler
         meter(rate_limit).get(path, params:)
       end
 
+      # Retrieves the box labels for a shipment ID that you specify. This is an asynchronous operation. If the label
+      # status is `GENERATED`, then the label URL is available.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] ID for the shipment.
+      # @param page_type [String] Page type for the generated labels. The default is `PLAIN_PAPER`.
+      # @param format_type [String] The format type of the output file that contains your labels. The default format
+      #   type is `PDF`.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_inbound_shipment_labels(shipment_id, page_type: nil, format_type: nil, rate_limit: 1.0)
+        path = "/awd/2024-05-09/inboundShipments/#{shipment_id}/labels"
+        params = {
+          "pageType" => page_type,
+          "formatType" => format_type,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Updates transport details for an AWD shipment.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The shipment ID.
+      # @param body [Hash] Transportation details for the shipment.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def update_inbound_shipment_transport_details(shipment_id, body, rate_limit: 1.0)
+        path = "/awd/2024-05-09/inboundShipments/#{shipment_id}/transport"
+
+        meter(rate_limit).put(path, body:)
+      end
+
+      # Determines if the packages you specify are eligible for an AWD inbound order and contains error details for
+      # ineligible packages.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Represents the packages you want to inbound.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def check_inbound_eligibility(body, rate_limit: 1.0)
+        path = "/awd/2024-05-09/inboundEligibility"
+
+        meter(rate_limit).post(path, body:)
+      end
+
       # Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply
       # optional filters.
       #
@@ -45,7 +154,11 @@ module Peddler
       # @param updated_before [String] List the inbound shipments that were updated before a certain time (inclusive).
       #   The date must be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
       # @param max_results [Integer] Maximum number of results to return.
-      # @param next_token [String] Token to retrieve the next set of paginated results.
+      # @param next_token [String] A token that is used to retrieve the next page of results. The response includes
+      #   `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of
+      #   results, call the operation with this token and include the same arguments as the call that produced the
+      #   token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can
+      #   return empty pages.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def list_inbound_shipments(sort_by: nil, sort_order: nil, shipment_status: nil, updated_after: nil,
@@ -71,7 +184,11 @@ module Peddler
       # @param sort_order [String] Sort the response in `ASCENDING` or `DESCENDING` order.
       # @param details [String] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,`
       #   which returns only inventory summary totals.
-      # @param next_token [String] Token to retrieve the next set of paginated results.
+      # @param next_token [String] A token that is used to retrieve the next page of results. The response includes
+      #   `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of
+      #   results, call the operation with this token and include the same arguments as the call that produced the
+      #   token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can
+      #   return empty pages.
       # @param max_results [Integer] Maximum number of results to return.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response

data/lib/peddler/apis/aplus_content_2020_11_01.rb

@@ -12,21 +12,18 @@ module Peddler
   module APIs
     # Selling Partner API for A+ Content Management
     #
-    # With the A+ Content API, you can build applications that help selling partners add rich marketing content to their
-    # Amazon product detail pages. A+ content helps selling partners share their brand and product story, which helps
-    # buyers make informed purchasing decisions. Selling partners assemble content by choosing from content modules and
-    # adding images and text.
+    # Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon
+    # product detail pages. Selling partners can use A+ content to share their brand and product story, which helps
+    # buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
     class AplusContent20201101 < API
-      # Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the
-      # metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+
-      # Content documents.
+      # Returns a list of all A+ Content documents, including metadata, that are assigned to a selling partner. To get
+      # the actual contents of the A+ Content documents, call the `getContentDocument` operation.
       #
-      # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
-      # @param page_token [String] A page token from the nextPageToken response element returned by your previous call
-      #   to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next
-      #   page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any
-      #   other parameter will cause the request to fail. When no nextPageToken value is returned there are no more
-      #   pages to return. A pageToken value is not usable across different operations.
+      # @param marketplace_id [String] The marketplace ID is the globally unique identifier of a marketplace. To find
+      #   the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+      # @param page_token [String] A token that you use to fetch a specific page when there are multiple pages of
+      #   results.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def search_content_documents(marketplace_id, page_token: nil, rate_limit: 10.0)
@@ -43,7 +40,9 @@ module Peddler
 
       # Creates a new A+ Content document.
       #
-      # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
+      # @param marketplace_id [String] The marketplace ID is the globally unique identifier of a marketplace. To find
+      #   the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
       # @param post_content_document_request [Hash] The content document request details.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
@@ -62,9 +61,11 @@ module Peddler
       # Returns an A+ Content document, if available.
       #
       # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference
-      #   key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match
+      #   key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match
       #   any A+ Content identifier.
-      # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
+      # @param marketplace_id [String] The marketplace ID is the globally unique identifier of a marketplace. To find
+      #   the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
       # @param included_data_set [Array<String>] The set of A+ Content data types to include in the response.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
@@ -83,9 +84,11 @@ module Peddler
       # Updates an existing A+ Content document.
       #
       # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference
-      #   key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match
+      #   key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match
       #   any A+ Content identifier.
-      # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
+      # @param marketplace_id [String] The marketplace ID is the globally unique identifier of a marketplace. To find
+      #   the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
       # @param post_content_document_request [Hash] The content document request details.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
@@ -102,21 +105,20 @@ module Peddler
         meter(rate_limit).post(path, body:, params:)
       end
 
-      # Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the
-      # asinSet parameter, the operation returns all ASINs related to the content document.
+      # Returns a list of ASINs that are related to the specified A+ Content document, if available. If you don't
+      # include the `asinSet` parameter, this operation returns all ASINs related to the content document.
       #
       # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference
-      #   key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match
+      #   key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match
       #   any A+ Content identifier.
-      # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
-      # @param included_data_set [Array<String>] The set of A+ Content data types to include in the response. If you do
-      #   not include this parameter, the operation returns the related ASINs without metadata.
+      # @param marketplace_id [String] The marketplace ID is the globally unique identifier of a marketplace. To find
+      #   the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+      # @param included_data_set [Array<String>] The set of A+ Content data types to include in the response. If you
+      #   don't include this parameter, the operation returns the related ASINs without metadata.
       # @param asin_set [Array<String>] The set of ASINs.
-      # @param page_token [String] A page token from the nextPageToken response element returned by your previous call
-      #   to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next
-      #   page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any
-      #   other parameter will cause the request to fail. When no nextPageToken value is returned there are no more
-      #   pages to return. A pageToken value is not usable across different operations.
+      # @param page_token [String] A token that you use to fetch a specific page when there are multiple pages of
+      #   results.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def list_content_document_asin_relations(content_reference_key, marketplace_id, included_data_set: nil,
@@ -134,15 +136,18 @@ module Peddler
         meter(rate_limit).get(path, params:)
       end
 
-      # Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs,
-      # depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content
-      # document from that ASIN.
+      # Replaces all ASINs related to the specified A+ Content document, if available. This operation can add or remove
+      # ASINs, depending on the current set of related ASINs. Removing an ASIN will suspend the content document from
+      # that ASIN.
       #
       # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference
-      #   key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match
+      #   key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match
       #   any A+ content identifier.
-      # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
-      # @param post_content_document_asin_relations_request [Hash] The content document ASIN relations request details.
+      # @param marketplace_id [String] The marketplace ID is the globally unique identifier of a marketplace. To find
+      #   the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+      # @param post_content_document_asin_relations_request [Hash] The request details for the content document ASIN
+      #   relations.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def post_content_document_asin_relations(content_reference_key, marketplace_id,
@@ -160,7 +165,9 @@ module Peddler
 
       # Checks if the A+ Content document is valid for use on a set of ASINs.
       #
-      # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
+      # @param marketplace_id [String] The marketplace ID is the globally unique identifier of a marketplace. To find
+      #   the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
       # @param asin_set [Array<String>] The set of ASINs.
       # @param post_content_document_request [Hash] The content document request details.
       # @param rate_limit [Float] Requests per second
@@ -181,13 +188,13 @@ module Peddler
 
       # Searches for A+ Content publishing records, if available.
       #
-      # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
-      # @param asin [String] The Amazon Standard Identification Number (ASIN).
-      # @param page_token [String] A page token from the nextPageToken response element returned by your previous call
-      #   to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next
-      #   page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any
-      #   other parameter will cause the request to fail. When no nextPageToken value is returned there are no more
-      #   pages to return. A pageToken value is not usable across different operations.
+      # @param marketplace_id [String] The marketplace ID is the globally unique identifier of a marketplace. To find
+      #   the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+      # @param asin [String] The Amazon Standard Identification Number (ASIN) is the unique identifier of a product
+      #   within a marketplace.
+      # @param page_token [String] A token that you use to fetch a specific page when there are multiple pages of
+      #   results.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def search_content_publish_records(marketplace_id, asin, page_token: nil, rate_limit: 10.0)
@@ -206,9 +213,11 @@ module Peddler
       # Submits an A+ Content document for review, approval, and publishing.
       #
       # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference
-      #   key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match
+      #   key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match
       #   any A+ content identifier.
-      # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
+      # @param marketplace_id [String] The marketplace ID is the globally unique identifier of a marketplace. To find
+      #   the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def post_content_document_approval_submission(content_reference_key, marketplace_id, rate_limit: 10.0)
@@ -222,13 +231,14 @@ module Peddler
         meter(rate_limit).post(path, params:)
       end
 
-      # Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN
-      # relations.
+      # Submits a request to suspend visible A+ Content. This doesn't delete the content document or the ASIN relations.
       #
       # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference
-      #   key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match
+      #   key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match
       #   any A+ content identifier.
-      # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
+      # @param marketplace_id [String] The marketplace ID is the globally unique identifier of a marketplace. To find
+      #   the ID for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def post_content_document_suspend_submission(content_reference_key, marketplace_id, rate_limit: 10.0)

data/lib/peddler/apis/catalog_items_2022_04_01.rb

@@ -10,43 +10,44 @@ module Peddler
   end
 
   module APIs
-    # Catalog Items v2022-04-01
+    # Selling Partner API for Catalog Items
     #
-    # The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon
-    # catalog. For more information, refer to the
-    # {https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide Catalog Items API Use
-    # Case Guide}.
+    # Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more
+    # information, refer to the [Catalog Items API Use Case
+    # Guide](https://developer-docs.amazon.com/sp-api/docs/:catalog-items-api-v2022-04-01-use-case-guide).
     class CatalogItems20220401 < API
-      # Search for and return a list of Amazon catalog items and associated information either by identifier or by
+      # Search for a list of Amazon catalog items and item-related information. You can search by identifier or by
       # keywords.
       #
       # @note This operation can make a static sandbox call.
-      # @param identifiers [Array<String>] A comma-delimited list of product identifiers to search the Amazon catalog
-      #   for. **Note:** Cannot be used with `keywords`.
-      # @param identifiers_type [String] Type of product identifiers to search the Amazon catalog for. **Note:**
-      #   Required when `identifiers` are provided.
-      # @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:
-      #   `summaries`.
-      # @param locale [String] Locale for retrieving localized summaries. Defaults to the primary locale of the
-      #   marketplace.
+      # @param identifiers [Array<String>] A comma-delimited list of product identifiers that you can use to search the
+      #   Amazon catalog. **Note:** You cannot include `identifiers` and `keywords` in the same request.
+      # @param identifiers_type [String] The type of product identifiers that you can use to search the Amazon catalog.
+      #   **Note:** `identifiersType` is required when `identifiers` is in the request.
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers. To find the ID
+      #   for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+      # @param included_data [Array<String>] A comma-delimited list of datasets to include in the response.
+      # @param locale [String] The locale for which you want to retrieve localized summaries. Defaults to the primary
+      #   locale of the marketplace.
       # @param seller_id [String] A selling partner identifier, such as a seller account or vendor code. **Note:**
       #   Required when `identifiersType` is `SKU`.
-      # @param keywords [Array<String>] A comma-delimited list of words to search the Amazon catalog for. **Note:**
-      #   Cannot be used with `identifiers`.
-      # @param brand_names [Array<String>] A comma-delimited list of brand names to limit the search for
-      #   `keywords`-based queries. **Note:** Cannot be used with `identifiers`.
-      # @param classification_ids [Array<String>] A comma-delimited list of classification identifiers to limit the
-      #   search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`.
-      # @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 keywords_locale [String] The language of the keywords provided for `keywords`-based queries. Defaults to
-      #   the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`.
+      # @param keywords [Array<String>] A comma-delimited list of keywords that you can use to search the Amazon
+      #   catalog. **Note:** You cannot include `keywords` and `identifiers` in the same request.
+      # @param brand_names [Array<String>] A comma-delimited list of brand names that you can use to limit the search in
+      #   queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
+      # @param classification_ids [Array<String>] A comma-delimited list of classification identifiers that you can use
+      #   to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
+      # @param page_size [Integer] The number of results to include on each page.
+      # @param page_token [String] A token that you can use to fetch a specific page when there are multiple pages of
+      #   results.
+      # @param keywords_locale [String] The language of the keywords that are included in queries based on `keywords`.
+      #   Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def search_catalog_items(marketplace_ids, identifiers: nil, identifiers_type: nil, included_data: ["summaries"],
         locale: nil, seller_id: nil, keywords: nil, brand_names: nil, classification_ids: nil, page_size: 10,
-        page_token: nil, keywords_locale: nil, rate_limit: 2.0)
+        page_token: nil, keywords_locale: nil, rate_limit: 5.0)
         path = "/catalog/2022-04-01/items"
         params = {
           "identifiers" => identifiers,
@@ -70,15 +71,15 @@ module Peddler
       #
       # @note This operation can make a static sandbox call.
       # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item.
-      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers. Data sets in
-      #   the response contain data only for the specified marketplaces.
-      # @param included_data [Array<String>] A comma-delimited list of data sets to include in the response. Default:
-      #   `summaries`.
-      # @param locale [String] Locale for retrieving localized summaries. Defaults to the primary locale of the
-      #   marketplace.
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers. To find the ID
+      #   for your marketplace, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+      # @param included_data [Array<String>] A comma-delimited list of datasets to include in the response.
+      # @param locale [String] The locale for which you want to retrieve localized summaries. Defaults to the primary
+      #   locale of the marketplace.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def get_catalog_item(asin, marketplace_ids, included_data: ["summaries"], locale: nil, rate_limit: 2.0)
+      def get_catalog_item(asin, marketplace_ids, included_data: ["summaries"], locale: nil, rate_limit: 5.0)
         path = "/catalog/2022-04-01/items/#{asin}"
         params = {
           "marketplaceIds" => marketplace_ids,

data/lib/peddler/apis/easy_ship_2022_03_23.rb

@@ -12,11 +12,11 @@ module Peddler
   module APIs
     # Selling Partner API for Easy Ship
     #
-    # The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy
-    # Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for
-    # delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the
-    # {https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table
-    # Marketplace Support Table} for the differences in Easy Ship operations by marketplace.
+    # Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship
+    # orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print
+    # shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer
+    # to [Marketplace
+    # support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
     class EasyShip20220323 < API
       # Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions
       # that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace
@@ -96,19 +96,20 @@ module Peddler
         meter(rate_limit).patch(path, body:)
       end
 
-      # This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the
-      # associated shipping labels and compliance documents based on the marketplace. For more information, refer to the
-      # [marketplace support
-      # table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table).
-      # You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your
-      # request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you
-      # don't specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your
-      # shipping label's file format and Amazon creates the label accordingly. This operation returns an array that
-      # contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file
-      # includes the generated shipping labels and any other documents that are required for your marketplace. If an
-      # order can't be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry
-      # for each order that could not be processed. Each entry contains an error message that describes the reason for
-      # the failure. The following table contains the supported request and burst maximum rates:
+      # This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the
+      # associated shipping labels, along with other compliance documents according to the marketplace (refer to the
+      # {https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table
+      # marketplace document support table}). Developers calling this operation may optionally assign a `packageDetails`
+      # object, allowing them to input a preferred time slot for each order in their request. In this case, Amazon will
+      # try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time
+      # slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label's file
+      # format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly.
+      # This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file
+      # containing the generated shipping labels and the other documents enabled for your marketplace. If at least an
+      # order couldn't be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an
+      # entry for each order we couldn't process. Each entry is composed of an error message describing the reason of
+      # the failure, so that sellers can take action. The table below displays the supported request and burst maximum
+      # rates:
       #
       # @note This operation can make a static sandbox call.
       # @param create_scheduled_packages_request [Hash] The request schema for the `createScheduledPackageBulk`

data/lib/peddler/apis/feeds_2021_06_30.rb

@@ -11,7 +11,7 @@ module Peddler
   end
 
   module APIs
-    # Feeds v2021-06-30
+    # Selling Partner API for Feeds
     #
     # The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
     class Feeds20210630 < API

data/lib/peddler/apis/finances_2024_06_01.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class << self
+    def finances_2024_06_01(...)
+      APIs::Finances20240601.new(...)
+    end
+  end
+
+  module APIs
+    # The Selling Partner API for Transfers.
+    #
+    # The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts
+    # for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
+    class Finances20240601 < API
+      # Initiates an on-demand payout to the seller's default deposit method in Seller Central for the given
+      # `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace
+      # and account type within a 24-hour period.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] The request body for the `initiatePayout` operation.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def initiate_payout(body, rate_limit: 0.017)
+        path = "/finances/transfers/2024-06-01/payouts"
+
+        meter(rate_limit).post(path, body:)
+      end
+
+      # Returns the list of payment methods for the seller, which can be filtered by method type.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param marketplace_id [String] The identifier of the marketplace from which you want to retrieve payment
+      #   methods. For the list of possible marketplace identifiers, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+      # @param payment_method_types [Array<String>] A comma-separated list of the payment method types you want to
+      #   include in the response.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_payment_methods(marketplace_id, payment_method_types: nil, rate_limit: 0.5)
+        path = "/finances/transfers/2024-06-01/paymentMethods"
+        params = {
+          "marketplaceId" => marketplace_id,
+          "paymentMethodTypes" => payment_method_types,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+    end
+  end
+end