peddler 3.0.0.beta1 → 3.0.0

data/lib/peddler/api/supply_sources_2020_07_01.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def supply_sources_2020_07_01(...)
+      API::SupplySources20200701.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Supply Sources
     #
@@ -10,10 +16,12 @@ module Peddler
     class SupplySources20200701 < API
       # The path to retrieve paginated supply sources.
       #
-      # @param [String] next_page_token The pagination token to retrieve a specific page of results.
-      # @param [Number] page_size The number of supply sources to return per paginated request.
+      # @note This operation can make a static sandbox call.
+      # @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
-      def get_supply_sources(next_page_token: nil, page_size: nil)
+      def get_supply_sources(next_page_token: nil, page_size: 10, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources"
         params = {
           "nextPageToken" => next_page_token,
@@ -25,9 +33,11 @@ module Peddler
 
       # Create a new supply source.
       #
-      # @param [Hash] payload A request to create a supply source.
+      # @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
-      def create_supply_source(payload)
+      def create_supply_source(payload, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources"
         body = payload
 
@@ -36,9 +46,11 @@ module Peddler
 
       # Retrieve a supply source.
       #
-      # @param [String] supply_source_id The unique identifier of a supply source.
+      # @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
-      def get_supply_source(supply_source_id)
+      def get_supply_source(supply_source_id, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
 
         get(path)
@@ -46,10 +58,12 @@ module Peddler
 
       # Update the configuration and capabilities of a supply source.
       #
-      # @param [String] supply_source_id The unique identitier of a supply source.
-      # @param [Hash] payload
+      # @note This operation can make a static sandbox call.
+      # @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
-      def update_supply_source(supply_source_id, payload: nil)
+      def update_supply_source(supply_source_id, payload: nil, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
         body = payload
 
@@ -58,9 +72,11 @@ module Peddler
 
       # Archive a supply source, making it inactive. Cannot be undone.
       #
-      # @param [String] supply_source_id The unique identifier of a supply source.
+      # @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
-      def archive_supply_source(supply_source_id)
+      def archive_supply_source(supply_source_id, rate_limit: nil)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
 
         delete(path)
@@ -68,10 +84,12 @@ module Peddler
 
       # Update the status of a supply source.
       #
-      # @param [String] supply_source_id The unique identifier of a supply source.
-      # @param [Hash] payload
+      # @note This operation can make a static sandbox call.
+      # @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
-      def update_supply_source_status(supply_source_id, payload: nil)
+      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/tokens_2021_03_01.rb

@@ -3,14 +3,20 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def tokens_2021_03_01(...)
+      API::Tokens20210301.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Tokens
     #
     # The Selling Partner API for Tokens provides a secure way to access a customer's PII (Personally Identifiable
     # Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted
     # resources that you specify. The RDT authorizes subsequent calls to restricted operations that correspond to the
-    # restricted resources that you specified. For more information, see the [Tokens API Use Case
-    # Guide](doc:tokens-api-use-case-guide).
+    # restricted resources that you specified. For more information, see the
+    # {https://developer-docs.amazon.com/sp-api/docs/tokens-api-use-case-guide Tokens API Use Case Guide}.
     class Tokens20210301 < API
       # Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted
       # resource is the HTTP method and path from a restricted operation that returns Personally Identifiable
@@ -18,12 +24,14 @@ module Peddler
       # Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent
       # calls to the corresponding restricted operations.
       #
-      # @param [Hash] body The restricted data token request details.
+      # @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
-      def create_restricted_data_token(body)
+      def create_restricted_data_token(body, rate_limit: 1.0)
         path = "/tokens/2021-03-01/restrictedDataToken"
 
-        rate_limit(1.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
     end
   end

data/lib/peddler/api/uploads_2020_11_01.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def uploads_2020_11_01(...)
+      API::Uploads20201101.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Uploads
     #
@@ -12,20 +18,24 @@ module Peddler
       # Creates an upload destination, returning the information required to upload a file to the destination and to
       # programmatically access the file.
       #
-      # @param [Array<String>] marketplace_ids A list of marketplace identifiers. This specifies the marketplaces where
+      # @param marketplace_ids [Array<String>] A list of marketplace identifiers. This specifies the marketplaces where
       #   the upload will be available. Only one marketplace can be specified.
-      # @param [String] content_md5 An MD5 hash of the content to be submitted to the upload destination. This value is
+      # @param content_md5 [String] An MD5 hash of the content to be submitted to the upload destination. This value is
       #   used to determine if the data has been corrupted or tampered with during transit.
-      # @param [String] resource The resource for the upload destination that you are creating. For example, if you are
+      # @param resource [String] The resource for the upload destination that you are creating. For example, if you are
       #   creating an upload destination for the createLegalDisclosure operation of the Messaging API, the `{resource}`
       #   would be `/messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure`, and the entire path would be
       #   `/uploads/2020-11-01/uploadDestinations/messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure`. If you
       #   are creating an upload destination for an Aplus content document, the `{resource}` would be
       #   `aplus/2020-11-01/contentDocuments` and the path would be
       #   `/uploads/v1/uploadDestinations/aplus/2020-11-01/contentDocuments`.
-      # @param [String] content_type The content type of the file to be uploaded.
+      # @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
-      def create_upload_destination_for_resource(marketplace_ids, content_md5, resource, content_type: nil)
+      def create_upload_destination_for_resource(marketplace_ids, content_md5, resource, content_type: nil,
+        rate_limit: 10.0)
+        cannot_sandbox!
+
         path = "/uploads/2020-11-01/uploadDestinations/#{resource}"
         params = {
           "marketplaceIds" => marketplace_ids,
@@ -33,7 +43,7 @@ module Peddler
           "contentType" => content_type,
         }.compact
 
-        rate_limit(10.0).post(path, params:)
+        meter(rate_limit).post(path, params:)
       end
     end
   end

data/lib/peddler/api/vendor_direct_fulfillment_inventory_v1.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def vendor_direct_fulfillment_inventory_v1(...)
+      API::VendorDirectFulfillmentInventoryV1.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Direct Fulfillment Inventory Updates
     #
@@ -11,13 +17,15 @@ module Peddler
     class VendorDirectFulfillmentInventoryV1 < API
       # Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.
       #
-      # @param [Hash] body The request body that contains the inventory update data to submit.
-      # @param [String] warehouse_id Identifier for the warehouse for which to update inventory.
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] The request body that contains 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
-      def submit_inventory_update(body, warehouse_id)
+      def submit_inventory_update(body, warehouse_id, rate_limit: 10.0)
         path = "/vendor/directFulfillment/inventory/v1/warehouses/#{warehouse_id}/items"
 
-        rate_limit(10.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
     end
   end

data/lib/peddler/api/vendor_direct_fulfillment_orders_2021_12_28.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def vendor_direct_fulfillment_orders_2021_12_28(...)
+      API::VendorDirectFulfillmentOrders20211228.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Direct Fulfillment Orders
     #
@@ -15,23 +21,25 @@ module Peddler
       # a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific
       # order.
       #
-      # @param [String] ship_from_party_id The vendor warehouse identifier for the fulfillment warehouse. If not
+      # @note This operation can make a dynamic sandbox call.
+      # @param ship_from_party_id [String] The vendor warehouse identifier for the fulfillment warehouse. If not
       #   specified, the result will contain orders for all warehouses.
-      # @param [String] status Returns only the purchase orders that match the specified status. If not specified, the
+      # @param status [String] Returns only the purchase orders that match the specified status. If not specified, the
       #   result will contain orders that match any status.
-      # @param [Integer] limit The limit to the number of purchase orders returned.
-      # @param [String] created_after Purchase orders that became available after this date and time will be included in
+      # @param limit [Integer] The limit to the number of purchase orders returned.
+      # @param created_after [String] Purchase orders that became available after this date and time will be included in
       #   the result. Must be in ISO-8601 date/time format.
-      # @param [String] created_before Purchase orders that became available before this date and time will be included
+      # @param created_before [String] Purchase orders that became available before this date and time will be included
       #   in the result. Must be in ISO-8601 date/time format.
-      # @param [String] sort_order Sort the list in ascending or descending order by order creation date.
-      # @param [String] next_token Used for pagination when there are more orders than the specified result size limit.
+      # @param sort_order [String] Sort the list in ascending or descending order by order creation date.
+      # @param next_token [String] Used for pagination when there are more orders than the specified result size limit.
       #   The token value is returned in the previous API call.
-      # @param [String] include_details When true, returns the complete purchase order details. Otherwise, only purchase
+      # @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
-      def get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil,
-        sort_order: nil, next_token: nil, include_details: nil)
+      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"
         params = {
           "shipFromPartyId" => ship_from_party_id,
@@ -44,28 +52,32 @@ module Peddler
           "includeDetails" => include_details,
         }.compact
 
-        rate_limit(10.0).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Returns purchase order information for the purchaseOrderNumber that you specify.
       #
-      # @param [String] purchase_order_number The order identifier for the purchase order that you want. Formatting
+      # @note This operation can make a dynamic sandbox call.
+      # @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
-      def get_order(purchase_order_number)
+      def get_order(purchase_order_number, rate_limit: 10.0)
         path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders/#{purchase_order_number}"
 
-        rate_limit(10.0).get(path)
+        meter(rate_limit).get(path)
       end
 
       # Submits acknowledgements for one or more purchase orders.
       #
-      # @param [Hash] body The request body containing the acknowledgement to an order
+      # @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
-      def submit_acknowledgement(body)
+      def submit_acknowledgement(body, rate_limit: 10.0)
         path = "/vendor/directFulfillment/orders/2021-12-28/acknowledgements"
 
-        rate_limit(10.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
     end
   end

data/lib/peddler/api/vendor_direct_fulfillment_orders_v1.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def vendor_direct_fulfillment_orders_v1(...)
+      API::VendorDirectFulfillmentOrdersV1.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Direct Fulfillment Orders
     #
@@ -15,23 +21,25 @@ module Peddler
       # a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific
       # order.
       #
-      # @param [String] ship_from_party_id The vendor warehouse identifier for the fulfillment warehouse. If not
+      # @note This operation can make a static sandbox call.
+      # @param ship_from_party_id [String] The vendor warehouse identifier for the fulfillment warehouse. If not
       #   specified, the result will contain orders for all warehouses.
-      # @param [String] status Returns only the purchase orders that match the specified status. If not specified, the
+      # @param status [String] Returns only the purchase orders that match the specified status. If not specified, the
       #   result will contain orders that match any status.
-      # @param [Integer] limit The limit to the number of purchase orders returned.
-      # @param [String] created_after Purchase orders that became available after this date and time will be included in
+      # @param limit [Integer] The limit to the number of purchase orders returned.
+      # @param created_after [String] Purchase orders that became available after this date and time will be included in
       #   the result. Must be in ISO-8601 date/time format.
-      # @param [String] created_before Purchase orders that became available before this date and time will be included
+      # @param created_before [String] Purchase orders that became available before this date and time will be included
       #   in the result. Must be in ISO-8601 date/time format.
-      # @param [String] sort_order Sort the list in ascending or descending order by order creation date.
-      # @param [String] next_token Used for pagination when there are more orders than the specified result size limit.
+      # @param sort_order [String] Sort the list in ascending or descending order by order creation date.
+      # @param next_token [String] Used for pagination when there are more orders than the specified result size limit.
       #   The token value is returned in the previous API call.
-      # @param [String] include_details When true, returns the complete purchase order details. Otherwise, only purchase
+      # @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
-      def get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil,
-        sort_order: nil, next_token: nil, include_details: nil)
+      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"
         params = {
           "shipFromPartyId" => ship_from_party_id,
@@ -44,28 +52,32 @@ module Peddler
           "includeDetails" => include_details,
         }.compact
 
-        rate_limit(10.0).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Returns purchase order information for the purchaseOrderNumber that you specify.
       #
-      # @param [String] purchase_order_number The order identifier for the purchase order that you want. Formatting
+      # @note This operation can make a static sandbox call.
+      # @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
-      def get_order(purchase_order_number)
+      def get_order(purchase_order_number, rate_limit: 10.0)
         path = "/vendor/directFulfillment/orders/v1/purchaseOrders/#{purchase_order_number}"
 
-        rate_limit(10.0).get(path)
+        meter(rate_limit).get(path)
       end
 
       # Submits acknowledgements for one or more purchase orders.
       #
-      # @param [Hash] body The request body that contains the order acknowledgement.
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] The request body that contains the order acknowledgement.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def submit_acknowledgement(body)
+      def submit_acknowledgement(body, rate_limit: 10.0)
         path = "/vendor/directFulfillment/orders/v1/acknowledgements"
 
-        rate_limit(10.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
     end
   end

data/lib/peddler/api/vendor_direct_fulfillment_payments_v1.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def vendor_direct_fulfillment_payments_v1(...)
+      API::VendorDirectFulfillmentPaymentsV1.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Direct Fulfillment Payments
     #
@@ -11,12 +17,14 @@ module Peddler
     class VendorDirectFulfillmentPaymentsV1 < API
       # Submits one or more invoices for a vendor's direct fulfillment orders.
       #
-      # @param [Hash] body The request body that contains one or more invoices for vendor 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 rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def submit_invoice(body)
+      def submit_invoice(body, rate_limit: 10.0)
         path = "/vendor/directFulfillment/payments/v1/invoices"
 
-        rate_limit(10.0).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
     end
   end

data/lib/peddler/api/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def vendor_direct_fulfillment_sandbox_test_data_2021_10_28(...)
+      API::VendorDirectFulfillmentSandboxTestData20211028.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Vendor Direct Fulfillment Sandbox Test Data
     #
@@ -11,9 +17,11 @@ module Peddler
     class VendorDirectFulfillmentSandboxTestData20211028 < API
       # Submits a request to generate test order data for Vendor Direct Fulfillment API entities.
       #
-      # @param [Hash] body The request payload that contain parameters to generate test order data scenarios.
+      # @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 rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def generate_order_scenarios(body)
+      def generate_order_scenarios(body, rate_limit: nil)
         path = "/vendor/directFulfillment/sandbox/2021-10-28/orders"
 
         post(path, body:)
@@ -22,10 +30,12 @@ module Peddler
       # Retrieves the transaction status identified by the specified `transactionId`, and returns the requested test
       # order data if the transaction is successful.
       #
-      # @param [String] transaction_id The transaction identifier returned in the response for the
+      # @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 rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def get_order_scenarios(transaction_id)
+      def get_order_scenarios(transaction_id, rate_limit: nil)
         path = "/vendor/directFulfillment/sandbox/2021-10-28/transactions/#{transaction_id}"
 
         get(path)