peddler 3.0.0 → 4.0.0

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def fulfillment_outbound_2020_07_01(...)
-      API::FulfillmentOutbound20200701.new(...)
+      APIs::FulfillmentOutbound20200701.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner APIs for Fulfillment Outbound
     #
     # The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill
@@ -21,7 +21,7 @@ module Peddler
       # @note This operation can make a dynamic sandbox call.
       # @param body [Hash] GetFulfillmentPreviewRequest parameter
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_fulfillment_preview(body, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/fulfillmentOrders/preview"
 
@@ -34,7 +34,7 @@ module Peddler
       # @note This operation can make a dynamic sandbox call.
       # @param body [Hash] GetDeliveryOffersRequest parameter
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def delivery_offers(body, rate_limit: 5.0)
         path = "/fba/outbound/2020-07-01/deliveryOffers"
 
@@ -50,7 +50,7 @@ module Peddler
       #   new fulfillment order.
       # @param next_token [String] A string token returned in the response to your previous request.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_all_fulfillment_orders(query_start_date: nil, next_token: nil, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/fulfillmentOrders"
         params = {
@@ -67,7 +67,7 @@ module Peddler
       # @note This operation can make a dynamic sandbox call.
       # @param body [Hash] CreateFulfillmentOrderRequest parameter
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_fulfillment_order(body, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/fulfillmentOrders"
 
@@ -81,7 +81,7 @@ module Peddler
       # @param package_number [Integer] The unencrypted package identifier returned by the `getFulfillmentOrder`
       #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_package_tracking_details(package_number, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/tracking"
         params = {
@@ -104,7 +104,7 @@ module Peddler
       # @param language [String] The language that the `TranslatedDescription` property of the `ReasonCodeDetails`
       #   response object should be translated into.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_return_reason_codes(seller_sku, marketplace_id: nil, seller_fulfillment_order_id: nil, language: nil,
         rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/returnReasonCodes"
@@ -126,7 +126,7 @@ module Peddler
       #   time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value
       #   based on the buyer's request to return items.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_fulfillment_return(body, seller_fulfillment_order_id, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}/return"
 
@@ -139,7 +139,7 @@ module Peddler
       # @param seller_fulfillment_order_id [String] The identifier assigned to the item by the seller when the
       #   fulfillment order was created.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}"
 
@@ -153,7 +153,7 @@ module Peddler
       # @param seller_fulfillment_order_id [String] The identifier assigned to the item by the seller when the
       #   fulfillment order was created.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_fulfillment_order(body, seller_fulfillment_order_id, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}"
 
@@ -167,7 +167,7 @@ module Peddler
       # @param seller_fulfillment_order_id [String] The identifier assigned to the item by the seller when the
       #   fulfillment order was created.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def cancel_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}/cancel"
 
@@ -185,7 +185,7 @@ module Peddler
       #   fulfillment order was created.
       # @param body [Hash] The identifier assigned to the item by the seller when the fulfillment order was created.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def submit_fulfillment_order_status_update(seller_fulfillment_order_id, body, rate_limit: nil)
         must_sandbox!
 
@@ -200,7 +200,7 @@ module Peddler
       # @note This operation can make a dynamic sandbox call.
       # @param marketplace_id [String] The marketplace for which to return the list of features.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_features(marketplace_id, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/features"
         params = {
@@ -222,7 +222,7 @@ module Peddler
       #   specified date. An update is defined as any change in feature-enabled inventory availability. The date must be
       #   in the format yyyy-MM-ddTHH:mm:ss.sssZ
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_feature_inventory(marketplace_id, feature_name, next_token: nil, query_start_date: nil, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/features/inventory/#{feature_name}"
         params = {
@@ -245,7 +245,7 @@ module Peddler
       # @param seller_sku [String] Used to identify an item 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 get_feature_sku(marketplace_id, feature_name, seller_sku, rate_limit: 2.0)
         path = "/fba/outbound/2020-07-01/features/inventory/#{feature_name}/#{seller_sku}"
         params = {

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def invoices_2024_06_19(...)
-      API::Invoices20240619.new(...)
+      APIs::Invoices20240619.new(...)
     end
   end
 
-  class API
+  module APIs
     # The Selling Partner API for Invoices.
     #
     # Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling
@@ -20,7 +20,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param marketplace_id [String] The marketplace identifier.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_invoices_attributes(marketplace_id, rate_limit: 1.0)
         path = "/tax/invoices/2024-06-19/attributes"
         params = {
@@ -36,7 +36,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param invoices_document_id [String] The export document identifier.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_invoices_document(invoices_document_id, rate_limit: 0.0167)
         path = "/tax/invoices/2024-06-19/documents/#{invoices_document_id}"
 
@@ -48,7 +48,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] Information required to create the export request.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_invoices_export(body, rate_limit: 0.167)
         path = "/tax/invoices/2024-06-19/exports"
 
@@ -72,7 +72,7 @@ module Peddler
       #   The default value is the time of the request.
       # @param status [String] Return exports matching the status specified.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_invoices_exports(marketplace_id, date_start: nil, next_token: nil, page_size: nil, date_end: nil,
         status: nil, rate_limit: 0.1)
         path = "/tax/invoices/2024-06-19/exports"
@@ -93,7 +93,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param export_id [String] The unique identifier for the export.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_invoices_export(export_id, rate_limit: 2.0)
         path = "/tax/invoices/2024-06-19/exports/#{export_id}"
 
@@ -133,7 +133,7 @@ module Peddler
       #   Government Invoice ID.
       # @param sort_by [String] The attribute by which you want to sort the invoices in the response.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_invoices(marketplace_id, transaction_identifier_name: nil, page_size: nil, date_end: nil,
         transaction_type: nil, transaction_identifier_id: nil, date_start: nil, series: nil, next_token: nil,
         sort_order: nil, invoice_type: nil, statuses: nil, external_invoice_id: nil, sort_by: nil, rate_limit: 0.1)
@@ -166,7 +166,7 @@ module Peddler
       # @param marketplace_id [String] The marketplace from which you want the invoice.
       # @param invoice_id [String] The invoice identifier.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_invoice(marketplace_id, invoice_id, rate_limit: 2.0)
         path = "/tax/invoices/2024-06-19/invoices/#{invoice_id}"
         params = {

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def listings_items_2020_09_01(...)
-      API::ListingsItems20200901.new(...)
+      APIs::ListingsItems20200901.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Listings Items
     #
     # The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner
@@ -30,7 +30,7 @@ module Peddler
       #   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
+      # @return [Peddler::Response] The API response
       def delete_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, rate_limit: 5.0)
         path = "/listings/2020-09-01/items/#{seller_id}/#{sku}"
         params = {
@@ -55,7 +55,7 @@ module Peddler
       #   when a localization is not available in the specified locale.
       # @param body [Hash] The request body schema for the patchListingsItem operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def patch_listings_item(seller_id, sku, marketplace_ids, body, issue_locale: nil, rate_limit: 5.0)
         path = "/listings/2020-09-01/items/#{seller_id}/#{sku}"
         params = {
@@ -80,7 +80,7 @@ module Peddler
       #   when a localization is not available in the specified locale.
       # @param body [Hash] The request body schema for the putListingsItem operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def put_listings_item(seller_id, sku, marketplace_ids, body, issue_locale: nil, rate_limit: 5.0)
         path = "/listings/2020-09-01/items/#{seller_id}/#{sku}"
         params = {

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

@@ -5,12 +5,12 @@ require "peddler/api"
 module Peddler
   class << self
     def listings_items_2021_08_01(...)
-      API::ListingsItems20210801.new(...)
+      APIs::ListingsItems20210801.new(...)
     end
   end
 
-  class API
-    # Selling Partner API for Listings Items
+  module APIs
+    # Listings Items v2021-08-01
     #
     # The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner
     # listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which
@@ -30,7 +30,7 @@ module Peddler
       #   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
+      # @return [Peddler::Response] The API response
       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 = {
@@ -55,7 +55,7 @@ module Peddler
       # @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
+      # @return [Peddler::Response] The API response
       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}"
@@ -86,7 +86,7 @@ module Peddler
       #   when a localization is not available in the specified locale.
       # @param body [Hash] The request body schema for the `patchListingsItem` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       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}"
@@ -118,7 +118,7 @@ module Peddler
       #   when a localization is not available in the specified locale.
       # @param body [Hash] The request body schema for the `putListingsItem` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       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}"
@@ -131,40 +131,6 @@ module Peddler
 
         meter(rate_limit).put(path, body:, params:)
       end
-
-      # Search for and return list of listings items and respective details for a selling partner.
-      #
-      # @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 identifiers_type [String] Type of product identifiers to search for listings items by. **Note**: 1.
-      #   Required when `identifiers` is provided.
-      # @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 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: 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,
-          "identifiers" => identifiers,
-          "identifiersType" => identifiers_type,
-          "pageSize" => page_size,
-          "pageToken" => page_token,
-          "includedData" => included_data,
-          "issueLocale" => issue_locale,
-        }.compact
-
-        meter(rate_limit).get(path, params:)
-      end
     end
   end
 end

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def listings_restrictions_2021_08_01(...)
-      API::ListingsRestrictions20210801.new(...)
+      APIs::ListingsRestrictions20210801.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Listings Restrictions
     #
     # The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog
@@ -28,7 +28,7 @@ module Peddler
       #   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
+      # @return [Peddler::Response] The API response
       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"

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

@@ -5,23 +5,23 @@ require "peddler/api"
 module Peddler
   class << self
     def merchant_fulfillment_v0(...)
-      API::MerchantFulfillmentV0.new(...)
+      APIs::MerchantFulfillmentV0.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Merchant Fulfillment
     #
-    # The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping
-    # for non-Prime and Prime orders using Amazon’s Buy Shipping Services.
+    # With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase
+    # shipping for non-Prime and Prime orders using Amazon's Buy Shipping Services.
     class MerchantFulfillmentV0 < API
       # Returns a list of shipping service offers that satisfy the specified shipment request details.
       #
       # @note This operation can make a static sandbox call.
-      # @param body [Hash] Request schema for GetEligibleShipmentServices operation.
+      # @param body [Hash] The request schema for the `GetEligibleShipmentServices` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
-      def get_eligible_shipment_services(body, rate_limit: 5.0)
+      # @return [Peddler::Response] The API response
+      def get_eligible_shipment_services(body, rate_limit: 6.0)
         path = "/mfn/v0/eligibleShippingServices"
 
         meter(rate_limit).post(path, body:)
@@ -32,7 +32,7 @@ module Peddler
       # @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
+      # @return [Peddler::Response] The API response
       def get_shipment(shipment_id, rate_limit: 1.0)
         path = "/mfn/v0/shipments/#{shipment_id}"
 
@@ -44,7 +44,7 @@ module Peddler
       # @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
+      # @return [Peddler::Response] The API response
       def cancel_shipment(shipment_id, rate_limit: 1.0)
         path = "/mfn/v0/shipments/#{shipment_id}"
 
@@ -54,10 +54,10 @@ module Peddler
       # Create a shipment with the information provided.
       #
       # @note This operation can make a static sandbox call.
-      # @param body [Hash] Request schema for CreateShipment operation.
+      # @param body [Hash] The request schema for the `CreateShipment` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
-      def create_shipment(body, rate_limit: 1.0)
+      # @return [Peddler::Response] The API response
+      def create_shipment(body, rate_limit: 2.0)
         path = "/mfn/v0/shipments"
 
         meter(rate_limit).post(path, body:)
@@ -67,9 +67,9 @@ module Peddler
       # shipping.
       #
       # @note This operation can make a static sandbox call.
-      # @param body [Hash] Request schema for GetAdditionalSellerInputs operation.
+      # @param body [Hash] The request schema for the `GetAdditionalSellerInputs` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_additional_seller_inputs(body, rate_limit: 1.0)
         path = "/mfn/v0/additionalSellerInputs"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def messaging_v1(...)
-      API::MessagingV1.new(...)
+      APIs::MessagingV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Messaging
     #
     # With the Messaging API you can build applications that send messages to buyers. You can get a list of message
@@ -27,7 +27,7 @@ module Peddler
       # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
       #   order was placed. Only one marketplace can be specified.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_messaging_actions_for_order(amazon_order_id, marketplace_ids, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}"
         params = {
@@ -47,7 +47,7 @@ module Peddler
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def confirm_customization_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmCustomizationDetails"
         params = {
@@ -66,7 +66,7 @@ module Peddler
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_confirm_delivery_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmDeliveryDetails"
         params = {
@@ -86,7 +86,7 @@ module Peddler
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_legal_disclosure(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/legalDisclosure"
         params = {
@@ -105,7 +105,7 @@ module Peddler
       # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
       #   order was placed. Only one marketplace can be specified.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_negative_feedback_removal(amazon_order_id, marketplace_ids, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/negativeFeedbackRemoval"
         params = {
@@ -124,7 +124,7 @@ module Peddler
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_confirm_order_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmOrderDetails"
         params = {
@@ -144,7 +144,7 @@ module Peddler
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_confirm_service_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmServiceDetails"
         params = {
@@ -164,7 +164,7 @@ module Peddler
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_amazon_motors(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/amazonMotors"
         params = {
@@ -183,7 +183,7 @@ module Peddler
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_warranty(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/warranty"
         params = {
@@ -201,7 +201,7 @@ module Peddler
       # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
       #   order was placed. Only one marketplace can be specified.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_attributes(amazon_order_id, marketplace_ids, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/attributes"
         params = {
@@ -220,7 +220,7 @@ module Peddler
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_digital_access_key(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/digitalAccessKey"
         params = {
@@ -240,7 +240,7 @@ module Peddler
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_unexpected_problem(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/unexpectedProblem"
         params = {
@@ -259,7 +259,7 @@ module Peddler
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def send_invoice(amazon_order_id, marketplace_ids, body, rate_limit: nil)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/invoice"
         params = {

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def notifications_v1(...)
-      API::NotificationsV1.new(...)
+      APIs::NotificationsV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Notifications
     #
     # The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling
@@ -27,7 +27,7 @@ module Peddler
       # @param rate_limit [Float] Requests per second
       # @param notification_type [String] The type of notification. For more information about notification types, refer
       #   to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_subscription(notification_type, payload_version: nil, rate_limit: 1.0)
         path = "/notifications/v1/subscriptions/#{notification_type}"
         params = {
@@ -47,7 +47,7 @@ module Peddler
       # @param rate_limit [Float] Requests per second
       # @param notification_type [String] The type of notification. For more information about notification types, refer
       #   to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_subscription(body, notification_type, rate_limit: 1.0)
         path = "/notifications/v1/subscriptions/#{notification_type}"
 
@@ -63,7 +63,7 @@ module Peddler
       # @param rate_limit [Float] Requests per second
       # @param notification_type [String] The type of notification. For more information about notification types, refer
       #   to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_subscription_by_id(subscription_id, notification_type, rate_limit: 1.0)
         path = "/notifications/v1/subscriptions/#{notification_type}/#{subscription_id}"
 
@@ -81,7 +81,7 @@ module Peddler
       # @param rate_limit [Float] Requests per second
       # @param notification_type [String] The type of notification. For more information about notification types, refer
       #   to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def delete_subscription_by_id(subscription_id, notification_type, rate_limit: 1.0)
         path = "/notifications/v1/subscriptions/#{notification_type}/#{subscription_id}"
 
@@ -93,7 +93,7 @@ module Peddler
       #
       # @note This operation can make a static sandbox call.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_destinations(rate_limit: 1.0)
         path = "/notifications/v1/destinations"
 
@@ -107,7 +107,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_destination(body, rate_limit: 1.0)
         path = "/notifications/v1/destinations"
 
@@ -121,7 +121,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param destination_id [String] The identifier generated when you created the destination.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_destination(destination_id, rate_limit: 1.0)
         path = "/notifications/v1/destinations/#{destination_id}"
 
@@ -134,7 +134,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param destination_id [String] The identifier for the destination that you want to delete.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def delete_destination(destination_id, rate_limit: 1.0)
         path = "/notifications/v1/destinations/#{destination_id}"