peddler 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18b989739aa0f7ab2781e4f2f921b61a6f188ffc72145eb9308e47d3f5072e96
-  data.tar.gz: 0ea9798e14b2e7474fef0c8b492d43e90d427fee962d4f837fc46722750733b8
+  metadata.gz: 989f5bec7dce426405b687e65c4677fe8b359b355d815df799a048ef1907809f
+  data.tar.gz: eec2f1236bf285bf00c7d32e1482ae2fadaadeb2db9f0bc0a9beb64cf3ec7072
 SHA512:
-  metadata.gz: 9acfcab4a74ef4842c1cb28e94b1a57591caba5080e07a6db34d8f20f69b0d215efdcfb98761fefeaf840cb4a0c91cc574807651c8beb309dbfc91ad66502b05
-  data.tar.gz: 281d96aa87b0ea0c480282049124c8ed3037e4a31ef8251b7a6cc3e8c17acbb53e8253a41f248a6e3a95eea7c6d3363d740e0d23dffe2b6e1caaf82bbbdbea09
+  metadata.gz: 361ce5ea21116bbc09efb9590d080db5275f35dbc6717ccd318c291eb32e4b122b24d06ad4f78c9c693298d8e6e70fc81f3d7a128b843b7949579a601683bf91
+  data.tar.gz: 956ad0c6b2b7d1a490dffbf846a4c4415e1323510ac52c0eebdb2b42835f5a2f14354f2e0d16fa19099d0823ed47f09218255e98973735e7ccfa1579f08ccefa

data/README.md

@@ -4,10 +4,17 @@
 [![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.
+
 To begin using the Amazon SP-API, you must [register as a developer][register-as-developer] and [register your application][register-application]. Once registered, [obtain your Login with Amazon (LWA) credentials][view-credentials] to access your own or other selling partners' data.
 
+- [API models][api-models]
+- [API samples][api-samples]
+
 ![Peddler](https://github.com/hakanensari/peddler/blob/main/images/peddler.jpg?raw=true)
 
 ## Installation
@@ -15,7 +22,7 @@ To begin using the Amazon SP-API, you must [register as a developer][register-as
 Add this line to your Gemfile.
 
 ```ruby
-gem "peddler", "3.0.0.beta1"
+gem "peddler", "~> 3.0"
 ```
 
 And then execute:
@@ -113,7 +120,7 @@ response = api.get_catalog_item(
   marketplaceIds: ["ATVPDKIKX0DER"],
   asin: "B08N5WRWNW"
 )
-items = response.parse.dig("items")
+items = response.dig("items")
 ```
 
 #### Orders API (v0)
@@ -126,7 +133,7 @@ response = api.get_orders(
   marketplaceIds: ["ATVPDKIKX0DER"],
   createdAfter: "2023-01-01T00:00:00Z"
 )
-response.parse.dig("orders")
+response.dig("orders")
 ```
 
 #### Feeds API (2021-06-30)
@@ -145,7 +152,7 @@ upload_url = response.parse["url"]
 
 # Upload the feed content to the provided URL
 feed_content = File.read("inventory_update.xml")
-api.upload_feed_document(upload_url, feed_content)
+api.upload_feed_document(upload_url, feed_content, "text/xml; charset=UTF-8")
 
 # Create the feed
 response = api.create_feed(
@@ -338,7 +345,6 @@ purchase_orders = response.parse["purchaseOrders"]
 
 Enables vendors to manage shipping labels and shipping information for direct fulfillment orders.
 
-
 ```ruby
 api = Peddler.vendor_direct_fulfillment_shipping_2021_12_28(aws_region, access_token)
 response = api.get_packing_slip(
@@ -351,7 +357,6 @@ response.parse
 
 Allows vendors to receive orders for direct fulfillment and provide shipment confirmations.
 
-
 ```ruby
 api = Peddler.vendor_direct_fulfillment_orders_2021_12_28(aws_region, access_token)
 response = api.get_orders(
@@ -496,9 +501,12 @@ 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
+[api-models]: https://github.com/amzn/selling-partner-api-models
+[api-samples]: https://github.com/amzn/selling-partner-api-samples
 [view-credentials]: https://developer-docs.amazon.com/sp-api/docs/viewing-your-application-information-and-credentials
 [authorization]: https://developer-docs.amazon.com/sp-api/docs/authorizing-selling-partner-api-applications
 [rate-limits]: https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits

data/lib/peddler/api.rb

@@ -4,6 +4,8 @@ require "http"
 
 require "peddler/endpoint"
 require "peddler/error"
+require "peddler/marketplace"
+require "peddler/response"
 require "peddler/version"
 
 module Peddler
@@ -12,6 +14,11 @@ module Peddler
     class CannotSandbox < StandardError; end
     class MustSandbox < StandardError; end
 
+    class << self
+      # @return [#call]
+      attr_accessor :parser
+    end
+
     # @return [Peddler::Endpoint]
     attr_reader :endpoint
 
@@ -31,6 +38,8 @@ module Peddler
       sandbox? ? endpoint.sandbox : endpoint.production
     end
 
+    # Switches to the SP-API sandbox to make test calls
+    #
     # @see https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox
     # @return [self]
     def sandbox
@@ -43,16 +52,6 @@ module Peddler
       @sandbox
     end
 
-    # @raise [CannotSandbox] if in a sandbox environment
-    def cannot_sandbox!
-      raise CannotSandbox, "cannot run in a sandbox" if sandbox?
-    end
-
-    # @raise [MustSandbox] unless in a sandbox environment
-    def must_sandbox!
-      raise MustSandbox, "must run in a sandbox" unless sandbox?
-    end
-
     # @see https://developer-docs.amazon.com/sp-api/docs/include-a-user-agent-header-in-all-requests
     # @see https://developer-docs.amazon.com/amazon-shipping/docs/connecting-to-the-selling-partner-api#step-3-add-headers-to-the-uri
     # @return [HTTP::Client]
@@ -73,7 +72,7 @@ module Peddler
       # HTTP v6.0 will implement retriable. Until then, point to their GitHub repo, or it's a no-op.
       # https://github.com/httprb/http/pull/790
       delay = sandbox? ? 0.2 : 1.0 / rate_limit
-      retriable(delay: delay, retry_statuses: [429]) if @http.respond_to?(:retriable)
+      retriable(delay: delay, retry_statuses: [429])
 
       self
     end
@@ -98,7 +97,7 @@ module Peddler
     #   @return [self]
     [:via, :use, :retriable].each do |method|
       define_method(method) do |*args, &block|
-        @http = http.send(method, *args, &block)
+        @http = http.send(method, *args, &block) if http.respond_to?(method)
         self
       end
     end
@@ -121,12 +120,28 @@ module Peddler
           raise error if error
         end
 
-        response
+        Response.decorate(response, parser:)
       end
     end
 
+    attr_writer :parser
+
+    # @!attribute parser
+    # @return [#call]
+    def parser
+      @parser || self.class.parser
+    end
+
     private
 
+    def cannot_sandbox!
+      raise CannotSandbox, "cannot run in a sandbox" if sandbox?
+    end
+
+    def must_sandbox!
+      raise MustSandbox, "must run in a sandbox" unless sandbox?
+    end
+
     def user_agent
       "Peddler/#{Peddler::VERSION} (Language=Ruby; #{Socket.gethostname})"
     end

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def amazon_warehousing_and_distribution_2024_05_09(...)
-      API::AmazonWarehousingAndDistribution20240509.new(...)
+      APIs::AmazonWarehousingAndDistribution20240509.new(...)
     end
   end
 
-  class API
+  module APIs
     # The Selling Partner API for Amazon Warehousing and Distribution
     #
     # The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information
@@ -22,7 +22,7 @@ module Peddler
       # @param sku_quantities [String] If equal to `SHOW`, the response includes the shipment SKU quantity details.
       #   Defaults to `HIDE`, in which case the response does not contain SKU quantities
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_inbound_shipment(shipment_id, sku_quantities: nil, rate_limit: 2.0)
         path = "/awd/2024-05-09/inboundShipments/#{shipment_id}"
         params = {
@@ -47,7 +47,7 @@ module Peddler
       # @param max_results [Integer] Maximum number of results to return.
       # @param next_token [String] Token to retrieve the next set of paginated results.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_inbound_shipments(sort_by: nil, sort_order: nil, shipment_status: nil, updated_after: nil,
         updated_before: nil, max_results: 25, next_token: nil, rate_limit: 1.0)
         path = "/awd/2024-05-09/inboundShipments"
@@ -74,7 +74,7 @@ module Peddler
       # @param next_token [String] Token to retrieve the next set of paginated results.
       # @param max_results [Integer] Maximum number of results to return.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_inventory(sku: nil, sort_order: nil, details: nil, next_token: nil, max_results: 25, rate_limit: 2.0)
         path = "/awd/2024-05-09/inventory"
         params = {

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def aplus_content_2020_11_01(...)
-      API::AplusContent20201101.new(...)
+      APIs::AplusContent20201101.new(...)
     end
   end
 
-  class API
+  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
@@ -28,7 +28,7 @@ module Peddler
       #   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 rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def search_content_documents(marketplace_id, page_token: nil, rate_limit: 10.0)
         cannot_sandbox!
 
@@ -46,7 +46,7 @@ module Peddler
       # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
       # @param post_content_document_request [Hash] The content document request details.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_content_document(marketplace_id, post_content_document_request, rate_limit: 10.0)
         cannot_sandbox!
 
@@ -67,7 +67,7 @@ module Peddler
       # @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.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_content_document(content_reference_key, marketplace_id, included_data_set, rate_limit: 10.0)
         cannot_sandbox!
 
@@ -88,7 +88,7 @@ module Peddler
       # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
       # @param post_content_document_request [Hash] The content document request details.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_content_document(content_reference_key, marketplace_id, post_content_document_request,
         rate_limit: 10.0)
         cannot_sandbox!
@@ -118,7 +118,7 @@ module Peddler
       #   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 rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_content_document_asin_relations(content_reference_key, marketplace_id, included_data_set: nil,
         asin_set: nil, page_token: nil, rate_limit: 10.0)
         cannot_sandbox!
@@ -144,7 +144,7 @@ module Peddler
       # @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 rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def post_content_document_asin_relations(content_reference_key, marketplace_id,
         post_content_document_asin_relations_request, rate_limit: 10.0)
         cannot_sandbox!
@@ -164,7 +164,7 @@ module Peddler
       # @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
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def validate_content_document_asin_relations(marketplace_id, post_content_document_request, asin_set: nil,
         rate_limit: 10.0)
         cannot_sandbox!
@@ -189,7 +189,7 @@ module Peddler
       #   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 rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def search_content_publish_records(marketplace_id, asin, page_token: nil, rate_limit: 10.0)
         cannot_sandbox!
 
@@ -210,7 +210,7 @@ module Peddler
       #   any A+ content identifier.
       # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def post_content_document_approval_submission(content_reference_key, marketplace_id, rate_limit: 10.0)
         cannot_sandbox!
 
@@ -230,7 +230,7 @@ module Peddler
       #   any A+ content identifier.
       # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def post_content_document_suspend_submission(content_reference_key, marketplace_id, rate_limit: 10.0)
         cannot_sandbox!
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def application_integrations_2024_04_01(...)
-      API::ApplicationIntegrations20240401.new(...)
+      APIs::ApplicationIntegrations20240401.new(...)
     end
   end
 
-  class API
+  module APIs
     # The Selling Partner API for third party application integrations.
     #
     # With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the
@@ -20,7 +20,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] The request body for the `createNotification` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_notification(body, rate_limit: 1.0)
         path = "/appIntegrations/2024-04-01/notifications"
 
@@ -32,7 +32,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] The request body for the `deleteNotifications` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def delete_notifications(body, rate_limit: 1.0)
         path = "/appIntegrations/2024-04-01/notifications/deletion"
 
@@ -45,7 +45,7 @@ module Peddler
       # @param notification_id [String] A `notificationId` uniquely identifies a notification.
       # @param body [Hash] The request body for the `recordActionFeedback` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def record_action_feedback(notification_id, body, rate_limit: 1.0)
         path = "/appIntegrations/2024-04-01/notifications/#{notification_id}/feedback"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def application_management_2023_11_30(...)
-      API::ApplicationManagement20231130.new(...)
+      APIs::ApplicationManagement20231130.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Application Management
     #
     # The Selling Partner API for Application Management lets you programmatically update the client secret on
@@ -22,7 +22,7 @@ module Peddler
       # secret](https://developer-docs.amazon.com/sp-api/v0/docs/application-management-api-v2023-11-30-use-case-guide#tutorial-rotate-your-applications-client-secret).
       #
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def rotate_application_client_secret(rate_limit: 0.0167)
         cannot_sandbox!
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def catalog_items_2020_12_01(...)
-      API::CatalogItems20201201.new(...)
+      APIs::CatalogItems20201201.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Catalog Items
     #
     # The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon
@@ -35,7 +35,7 @@ module Peddler
       # @param locale [String] Locale for retrieving localized summaries. Defaults to the primary locale of the
       #   marketplace.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def search_catalog_items(keywords, marketplace_ids, included_data: "summaries", brand_names: nil,
         classification_ids: nil, page_size: 10, page_token: nil, keywords_locale: nil, locale: nil, rate_limit: 2.0)
         path = "/catalog/2020-12-01/items"
@@ -65,7 +65,7 @@ module Peddler
       # @param locale [String] Locale for retrieving localized summaries. Defaults to the primary locale of the
       #   marketplace.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_catalog_item(asin, marketplace_ids, included_data: "summaries", locale: nil, rate_limit: 2.0)
         path = "/catalog/2020-12-01/items/#{asin}"
         params = {

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

@@ -5,12 +5,12 @@ require "peddler/api"
 module Peddler
   class << self
     def catalog_items_2022_04_01(...)
-      API::CatalogItems20220401.new(...)
+      APIs::CatalogItems20220401.new(...)
     end
   end
 
-  class API
-    # Selling Partner API for Catalog Items
+  module APIs
+    # Catalog Items v2022-04-01
     #
     # The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon
     # catalog. For more information, refer to the
@@ -43,7 +43,7 @@ module Peddler
       # @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 rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @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)
@@ -77,7 +77,7 @@ module Peddler
       # @param locale [String] Locale for retrieving localized summaries. Defaults to the primary locale of the
       #   marketplace.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_catalog_item(asin, marketplace_ids, included_data: ["summaries"], locale: nil, rate_limit: 2.0)
         path = "/catalog/2022-04-01/items/#{asin}"
         params = {

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def catalog_items_v0(...)
-      API::CatalogItemsV0.new(...)
+      APIs::CatalogItemsV0.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Catalog Items
     #
     # The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the
@@ -40,7 +40,7 @@ module Peddler
       # @param jan [String] A Japanese article number that uniquely identifies the product, manufacturer, and its
       #   attributes.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_catalog_items(marketplace_id, query: nil, query_context_id: nil, seller_sku: nil, upc: nil, ean: nil,
         isbn: nil, jan: nil, rate_limit: nil)
         path = "/catalog/v0/items"
@@ -69,7 +69,7 @@ module Peddler
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for the item.
       # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_catalog_item(marketplace_id, asin, rate_limit: nil)
         path = "/catalog/v0/items/#{asin}"
         params = {
@@ -87,7 +87,7 @@ module Peddler
       # @param seller_sku [String] Used to identify items in the given marketplace. SellerSKU is qualified by the
       #   seller's SellerId, which is included with every operation that you submit.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_catalog_categories(marketplace_id, asin: nil, seller_sku: nil, rate_limit: 1.0)
         path = "/catalog/v0/categories"
         params = {

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def data_kiosk_2023_11_15(...)
-      API::DataKiosk20231115.new(...)
+      APIs::DataKiosk20231115.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Data Kiosk
     #
     # The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling
@@ -31,7 +31,7 @@ module Peddler
       #   with the request that generated this token, with the exception of `pageSize` which can be modified between
       #   calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_queries(processing_statuses: nil, page_size: 10, created_since: nil, created_until: nil,
         pagination_token: nil, rate_limit: 0.0222)
         path = "/dataKiosk/2023-11-15/queries"
@@ -55,7 +55,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] The body of the request.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_query(body, rate_limit: 0.0167)
         path = "/dataKiosk/2023-11-15/queries"
 
@@ -71,7 +71,7 @@ module Peddler
       # @param query_id [String] The identifier for the query. This identifier is unique only in combination with a
       #   selling partner account ID.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def cancel_query(query_id, rate_limit: 0.0222)
         path = "/dataKiosk/2023-11-15/queries/#{query_id}"
 
@@ -84,7 +84,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param query_id [String] The query identifier.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_query(query_id, rate_limit: 2.0)
         path = "/dataKiosk/2023-11-15/queries/#{query_id}"
 
@@ -97,7 +97,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param document_id [String] The identifier for the Data Kiosk document.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_document(document_id, rate_limit: 0.0167)
         path = "/dataKiosk/2023-11-15/documents/#{document_id}"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def easy_ship_2022_03_23(...)
-      API::EasyShip20220323.new(...)
+      APIs::EasyShip20220323.new(...)
     end
   end
 
-  class API
+  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
@@ -30,7 +30,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param list_handover_slots_request [Hash] The request schema for the `listHandoverSlots` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_handover_slots(list_handover_slots_request: nil, rate_limit: 1.0)
         path = "/easyShip/2022-03-23/timeSlot"
         body = list_handover_slots_request
@@ -46,7 +46,7 @@ module Peddler
       #   to deliver using Amazon Easy Ship.
       # @param marketplace_id [String] An identifier for the marketplace in which the seller is selling.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_scheduled_package(amazon_order_id, marketplace_id, rate_limit: 1.0)
         path = "/easyShip/2022-03-23/package"
         params = {
@@ -71,7 +71,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param create_scheduled_package_request [Hash] The request schema for the `createScheduledPackage` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_scheduled_package(create_scheduled_package_request, rate_limit: 1.0)
         path = "/easyShip/2022-03-23/package"
         body = create_scheduled_package_request
@@ -88,7 +88,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param update_scheduled_packages_request [Hash] The request schema for the `updateScheduledPackages` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_scheduled_packages(update_scheduled_packages_request: nil, rate_limit: 1.0)
         path = "/easyShip/2022-03-23/package"
         body = update_scheduled_packages_request
@@ -96,26 +96,25 @@ module Peddler
         meter(rate_limit).patch(path, body:)
       end
 
-      # 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 ther 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:
+      # 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:
       #
       # @note This operation can make a static sandbox call.
       # @param create_scheduled_packages_request [Hash] The request schema for the `createScheduledPackageBulk`
       #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_scheduled_package_bulk(create_scheduled_packages_request, rate_limit: 1.0)
         path = "/easyShip/2022-03-23/packages/bulk"
         body = create_scheduled_packages_request