peddler 3.0.0 → 4.0.1

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def shipment_invoicing_v0(...)
-      API::ShipmentInvoicingV0.new(...)
+      APIs::ShipmentInvoicingV0.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Shipment Invoicing
     #
     # The Selling Partner API for Shipment Invoicing helps you programmatically retrieve shipment invoice information in
@@ -23,7 +23,7 @@ module Peddler
       #   {https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide Notifications API Use Case
       #   Guide}.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_shipment_details(shipment_id, rate_limit: 1.133)
         path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}"
 
@@ -36,7 +36,7 @@ module Peddler
       # @param shipment_id [String] The identifier for the shipment.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def submit_invoice(shipment_id, body, rate_limit: 1.133)
         path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}/invoice"
 
@@ -48,7 +48,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param shipment_id [String] The 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_invoice_status(shipment_id, rate_limit: 1.133)
         path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}/invoice/status"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def shipping_v1(...)
-      API::ShippingV1.new(...)
+      APIs::ShippingV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Shipping
     #
     # Provides programmatic access to Amazon Shipping APIs. **Note:** If you are new to the Amazon Shipping API, refer
@@ -23,7 +23,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_shipment(body, rate_limit: 5.0)
         path = "/shipping/v1/shipments"
 
@@ -35,7 +35,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param shipment_id [String]
       # @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: 5.0)
         path = "/shipping/v1/shipments/#{shipment_id}"
 
@@ -47,7 +47,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param shipment_id [String]
       # @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: 5.0)
         path = "/shipping/v1/shipments/#{shipment_id}/cancel"
 
@@ -60,7 +60,7 @@ module Peddler
       # @param shipment_id [String]
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def purchase_labels(shipment_id, body, rate_limit: 5.0)
         path = "/shipping/v1/shipments/#{shipment_id}/purchaseLabels"
 
@@ -74,7 +74,7 @@ module Peddler
       # @param tracking_id [String]
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def retrieve_shipping_label(shipment_id, tracking_id, body, rate_limit: 5.0)
         path = "/shipping/v1/shipments/#{shipment_id}/containers/#{tracking_id}/label"
 
@@ -86,7 +86,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 purchase_shipment(body, rate_limit: 5.0)
         path = "/shipping/v1/purchaseShipment"
 
@@ -98,7 +98,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 get_rates(body, rate_limit: 5.0)
         path = "/shipping/v1/rates"
 
@@ -109,7 +109,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_account(rate_limit: 5.0)
         path = "/shipping/v1/account"
 
@@ -121,7 +121,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param tracking_id [String]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_tracking_information(tracking_id, rate_limit: 1.0)
         path = "/shipping/v1/tracking/#{tracking_id}"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def shipping_v2(...)
-      API::ShippingV2.new(...)
+      APIs::ShippingV2.new(...)
     end
   end
 
-  class API
+  module APIs
     # Amazon Shipping API
     #
     # The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on
@@ -23,7 +23,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_rates(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         path = "/shipping/v2/shipments/rates"
 
@@ -42,7 +42,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def direct_purchase_shipment(body, x_amzn_idempotency_key: nil, locale: nil, x_amzn_shipping_business_id: nil,
         rate_limit: 80.0)
         cannot_sandbox!
@@ -64,7 +64,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def purchase_shipment(body, x_amzn_idempotency_key: nil, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         path = "/shipping/v2/shipments"
 
@@ -78,7 +78,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def one_click_shipment(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         path = "/shipping/v2/oneClickShipment"
 
@@ -95,7 +95,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_tracking(tracking_id, carrier_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         path = "/shipping/v2/tracking"
         params = {
@@ -119,7 +119,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_shipment_documents(shipment_id, package_client_reference_id, format: nil, dpi: nil,
         x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         path = "/shipping/v2/shipments/#{shipment_id}/documents"
@@ -139,7 +139,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def cancel_shipment(shipment_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         path = "/shipping/v2/shipments/#{shipment_id}/cancel"
 
@@ -157,7 +157,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_additional_inputs(request_token, rate_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         path = "/shipping/v2/shipments/additionalInputs/schema"
         params = {
@@ -173,7 +173,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_carrier_account_form_inputs(x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         cannot_sandbox!
 
@@ -188,7 +188,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_carrier_accounts(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         cannot_sandbox!
 
@@ -204,7 +204,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def link_carrier_account(carrier_id, body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         cannot_sandbox!
 
@@ -220,7 +220,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def unlink_carrier_account(carrier_id, body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         cannot_sandbox!
 
@@ -237,7 +237,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def generate_collection_form(body, x_amzn_idempotency_key: nil, x_amzn_shipping_business_id: nil,
         rate_limit: 80.0)
         cannot_sandbox!
@@ -253,7 +253,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_collection_form_history(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         cannot_sandbox!
 
@@ -269,7 +269,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_unmanifested_shipments(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         cannot_sandbox!
 
@@ -284,7 +284,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_collection_form(collection_form_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0)
         cannot_sandbox!
 
@@ -302,7 +302,7 @@ module Peddler
       # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is
       #   AmazonShipping_UK.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_access_points(access_point_types, country_code, postal_code, x_amzn_shipping_business_id: nil,
         rate_limit: 80.0)
         path = "/shipping/v2/accessPoints"

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def solicitations_v1(...)
-      API::SolicitationsV1.new(...)
+      APIs::SolicitationsV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Solicitations
     #
     # With the Solicitations API you can build applications that send non-critical solicitations to buyers. You can get
@@ -30,7 +30,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_solicitation_actions_for_order(amazon_order_id, marketplace_ids, rate_limit: 1.0)
         path = "/solicitations/v1/orders/#{amazon_order_id}"
         params = {
@@ -49,7 +49,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_product_review_and_seller_feedback_solicitation(amazon_order_id, marketplace_ids, rate_limit: 1.0)
         path = "/solicitations/v1/orders/#{amazon_order_id}/solicitations/productReviewAndSellerFeedback"
         params = {

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def supply_sources_2020_07_01(...)
-      API::SupplySources20200701.new(...)
+      APIs::SupplySources20200701.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Supply Sources
     #
     # Manage configurations and capabilities of seller supply sources.
@@ -20,7 +20,7 @@ module Peddler
       # @param next_page_token [String] The pagination token to retrieve a specific page of results.
       # @param page_size [Number] The number of supply sources to return per paginated request.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_supply_sources(next_page_token: nil, page_size: 10, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources"
         params = {
@@ -36,7 +36,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param payload [Hash] A request to create a supply source.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_supply_source(payload, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources"
         body = payload
@@ -49,7 +49,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param supply_source_id [String] The unique identifier of a supply source.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_supply_source(supply_source_id, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
 
@@ -62,7 +62,7 @@ module Peddler
       # @param supply_source_id [String] The unique identitier of a supply source.
       # @param payload [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_supply_source(supply_source_id, payload: nil, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
         body = payload
@@ -75,7 +75,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param supply_source_id [String] The unique identifier of a supply source.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def archive_supply_source(supply_source_id, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
 
@@ -88,7 +88,7 @@ module Peddler
       # @param supply_source_id [String] The unique identifier of a supply source.
       # @param payload [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_supply_source_status(supply_source_id, payload: nil, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}/status"
         body = payload

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def tokens_2021_03_01(...)
-      API::Tokens20210301.new(...)
+      APIs::Tokens20210301.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Tokens
     #
     # The Selling Partner API for Tokens provides a secure way to access a customer's PII (Personally Identifiable
@@ -27,7 +27,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] The restricted data token request details.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_restricted_data_token(body, rate_limit: 1.0)
         path = "/tokens/2021-03-01/restrictedDataToken"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def uploads_2020_11_01(...)
-      API::Uploads20201101.new(...)
+      APIs::Uploads20201101.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Uploads
     #
     # The Uploads API lets you upload files that you can programmatically access using other Selling Partner APIs, such
@@ -31,7 +31,7 @@ module Peddler
       #   `/uploads/v1/uploadDestinations/aplus/2020-11-01/contentDocuments`.
       # @param content_type [String] The content type of the file to be uploaded.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_upload_destination_for_resource(marketplace_ids, content_md5, resource, content_type: nil,
         rate_limit: 10.0)
         cannot_sandbox!

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def vendor_direct_fulfillment_inventory_v1(...)
-      API::VendorDirectFulfillmentInventoryV1.new(...)
+      APIs::VendorDirectFulfillmentInventoryV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Direct Fulfillment Inventory Updates
     #
     # The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct
@@ -18,10 +18,10 @@ module Peddler
       # Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.
       #
       # @note This operation can make a static sandbox call.
-      # @param body [Hash] The request body that contains the inventory update data to submit.
+      # @param body [Hash] The request body containing the inventory update data to submit.
       # @param warehouse_id [String] Identifier for the warehouse for which to update inventory.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def submit_inventory_update(body, warehouse_id, rate_limit: 10.0)
         path = "/vendor/directFulfillment/inventory/v1/warehouses/#{warehouse_id}/items"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def vendor_direct_fulfillment_orders_2021_12_28(...)
-      API::VendorDirectFulfillmentOrders20211228.new(...)
+      APIs::VendorDirectFulfillmentOrders20211228.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Direct Fulfillment Orders
     #
     # The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment
@@ -37,7 +37,7 @@ module Peddler
       # @param include_details [String] When true, returns the complete purchase order details. Otherwise, only purchase
       #   order numbers are returned.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil, sort_order: nil,
         next_token: nil, include_details: "true", rate_limit: 10.0)
         path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders"
@@ -61,7 +61,7 @@ module Peddler
       # @param purchase_order_number [String] The order identifier for the purchase order that you want. Formatting
       #   Notes: alpha-numeric code.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_order(purchase_order_number, rate_limit: 10.0)
         path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders/#{purchase_order_number}"
 
@@ -73,7 +73,7 @@ module Peddler
       # @note This operation can make a dynamic sandbox call.
       # @param body [Hash] The request body containing the acknowledgement to an order
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def submit_acknowledgement(body, rate_limit: 10.0)
         path = "/vendor/directFulfillment/orders/2021-12-28/acknowledgements"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def vendor_direct_fulfillment_orders_v1(...)
-      API::VendorDirectFulfillmentOrdersV1.new(...)
+      APIs::VendorDirectFulfillmentOrdersV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Direct Fulfillment Orders
     #
     # The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment
@@ -37,7 +37,7 @@ module Peddler
       # @param include_details [String] When true, returns the complete purchase order details. Otherwise, only purchase
       #   order numbers are returned.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil, sort_order: nil,
         next_token: nil, include_details: "true", rate_limit: 10.0)
         path = "/vendor/directFulfillment/orders/v1/purchaseOrders"
@@ -61,7 +61,7 @@ module Peddler
       # @param purchase_order_number [String] The order identifier for the purchase order that you want. Formatting
       #   Notes: alpha-numeric code.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_order(purchase_order_number, rate_limit: 10.0)
         path = "/vendor/directFulfillment/orders/v1/purchaseOrders/#{purchase_order_number}"
 
@@ -71,9 +71,9 @@ module Peddler
       # Submits acknowledgements for one or more purchase orders.
       #
       # @note This operation can make a static sandbox call.
-      # @param body [Hash] The request body that contains the order acknowledgement.
+      # @param body [Hash] The request body containing the acknowledgement to an order.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def submit_acknowledgement(body, rate_limit: 10.0)
         path = "/vendor/directFulfillment/orders/v1/acknowledgements"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def vendor_direct_fulfillment_payments_v1(...)
-      API::VendorDirectFulfillmentPaymentsV1.new(...)
+      APIs::VendorDirectFulfillmentPaymentsV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Direct Fulfillment Payments
     #
     # The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment
@@ -18,9 +18,9 @@ module Peddler
       # Submits one or more invoices for a vendor's direct fulfillment orders.
       #
       # @note This operation can make a static sandbox call.
-      # @param body [Hash] The request body that contains one or more invoices for vendor orders.
+      # @param body [Hash] The request body containing one or more invoices for vendor orders.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def submit_invoice(body, rate_limit: 10.0)
         path = "/vendor/directFulfillment/payments/v1/invoices"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def vendor_direct_fulfillment_sandbox_test_data_2021_10_28(...)
-      API::VendorDirectFulfillmentSandboxTestData20211028.new(...)
+      APIs::VendorDirectFulfillmentSandboxTestData20211028.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Vendor Direct Fulfillment Sandbox Test Data
     #
     # The Selling Partner API for Vendor Direct Fulfillment Sandbox Test Data provides programmatic access to vendor
@@ -18,23 +18,23 @@ module Peddler
       # Submits a request to generate test order data for Vendor Direct Fulfillment API entities.
       #
       # @note This operation can make a dynamic sandbox call.
-      # @param body [Hash] The request payload that contain parameters to generate test order data scenarios.
+      # @param body [Hash] The request payload containing parameters for generating test order data scenarios.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def generate_order_scenarios(body, rate_limit: nil)
         path = "/vendor/directFulfillment/sandbox/2021-10-28/orders"
 
         post(path, body:)
       end
 
-      # Retrieves the transaction status identified by the specified `transactionId`, and returns the requested test
-      # order data if the transaction is successful.
+      # Returns the status of the transaction indicated by the specified transactionId. If the transaction was
+      # successful, also returns the requested test order data.
       #
       # @note This operation can make a dynamic sandbox call.
-      # @param transaction_id [String] The transaction identifier returned in the response for the
-      #   `generateOrderScenarios` operation.
+      # @param transaction_id [String] The transaction identifier returned in the response to the generateOrderScenarios
+      #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_order_scenarios(transaction_id, rate_limit: nil)
         path = "/vendor/directFulfillment/sandbox/2021-10-28/transactions/#{transaction_id}"