peddler 2.4.4 → 3.0.0.beta1

data/lib/peddler/api/shipping_v1.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Shipping
+    #
+    # Provides programmatic access to Amazon Shipping APIs. **Note:** If you are new to the Amazon Shipping API, refer
+    # to the latest version of <a
+    # href="https://developer-docs.amazon.com/amazon-shipping/docs/shipping-api-v2-reference">Amazon Shipping API
+    # (v2)</a> on the <a href="https://developer-docs.amazon.com/amazon-shipping/">Amazon Shipping Developer
+    # Documentation</a> site.
+    class ShippingV1 < API
+      # Create a new shipment.
+      #
+      # @param [Hash] body
+      # @return [Hash] The API response
+      def create_shipment(body)
+        path = "/shipping/v1/shipments"
+
+        rate_limit(5.0).post(path, body:)
+      end
+
+      # Return the entire shipment object for the shipmentId.
+      #
+      # @param [String] shipment_id
+      # @return [Hash] The API response
+      def get_shipment(shipment_id)
+        path = "/shipping/v1/shipments/#{shipment_id}"
+
+        rate_limit(5.0).get(path)
+      end
+
+      # Cancel a shipment by the given shipmentId.
+      #
+      # @param [String] shipment_id
+      # @return [Hash] The API response
+      def cancel_shipment(shipment_id)
+        path = "/shipping/v1/shipments/#{shipment_id}/cancel"
+
+        rate_limit(5.0).post(path)
+      end
+
+      # Purchase shipping labels based on a given rate.
+      #
+      # @param [String] shipment_id
+      # @param [Hash] body
+      # @return [Hash] The API response
+      def purchase_labels(shipment_id, body)
+        path = "/shipping/v1/shipments/#{shipment_id}/purchaseLabels"
+
+        rate_limit(5.0).post(path, body:)
+      end
+
+      # Retrieve shipping label based on the shipment id and tracking id.
+      #
+      # @param [String] shipment_id
+      # @param [String] tracking_id
+      # @param [Hash] body
+      # @return [Hash] The API response
+      def retrieve_shipping_label(shipment_id, tracking_id, body)
+        path = "/shipping/v1/shipments/#{shipment_id}/containers/#{tracking_id}/label"
+
+        rate_limit(5.0).post(path, body:)
+      end
+
+      # Purchase shipping labels.
+      #
+      # @param [Hash] body
+      # @return [Hash] The API response
+      def purchase_shipment(body)
+        path = "/shipping/v1/purchaseShipment"
+
+        rate_limit(5.0).post(path, body:)
+      end
+
+      # Get service rates.
+      #
+      # @param [Hash] body
+      # @return [Hash] The API response
+      def get_rates(body)
+        path = "/shipping/v1/rates"
+
+        rate_limit(5.0).post(path, body:)
+      end
+
+      # Verify if the current account is valid.
+      # @return [Hash] The API response
+      def get_account
+        path = "/shipping/v1/account"
+
+        rate_limit(5.0).get(path)
+      end
+
+      # Return the tracking information of a shipment.
+      #
+      # @param [String] tracking_id
+      # @return [Hash] The API response
+      def get_tracking_information(tracking_id)
+        path = "/shipping/v1/tracking/#{tracking_id}"
+
+        rate_limit(1.0).get(path)
+      end
+    end
+  end
+end

data/lib/peddler/api/shipping_v2.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Amazon Shipping API
+    #
+    # The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on
+    # Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping
+    # rates, create shipments, cancel shipments, and track shipments.
+    class ShippingV2 < API
+      # Returns the available shipping service offerings.
+      #
+      # @param [Hash] body
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def get_rates(body, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/shipments/rates"
+
+        rate_limit(80.0).post(path, body:)
+      end
+
+      # Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related
+      # details and documents.
+      #
+      # @param [Hash] body
+      # @param [String] x_amzn_idempotency_key A unique value which the server uses to recognize subsequent retries of
+      #   the same request.
+      # @param [String] locale The IETF Language Tag. Note that this only supports the primary language subtag with one
+      #   secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional
+      #   designation. This does not support additional subtags beyond the primary and secondary language subtags.
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def direct_purchase_shipment(body, x_amzn_idempotency_key: nil, locale: nil, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/shipments/directPurchase"
+
+        rate_limit(80.0).post(path, body:)
+      end
+
+      # Purchases a shipping service and returns purchase related details and documents. Note: You must complete the
+      # purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the
+      # 10 minutes have expired, you will receive an error response with the error code equal to "TOKEN_EXPIRED". If you
+      # receive this error response, you must get the rates for the shipment again.
+      #
+      # @param [Hash] body
+      # @param [String] x_amzn_idempotency_key A unique value which the server uses to recognize subsequent retries of
+      #   the same request.
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def purchase_shipment(body, x_amzn_idempotency_key: nil, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/shipments"
+
+        rate_limit(80.0).post(path, body:)
+      end
+
+      # Purchases a shipping service identifier and returns purchase-related details and documents.
+      #
+      # @param [Hash] body
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def one_click_shipment(body, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/oneClickShipment"
+
+        rate_limit(80.0).post(path, body:)
+      end
+
+      # Returns tracking information for a purchased shipment.
+      #
+      # @param [String] tracking_id A carrier-generated tracking identifier originally returned by the purchaseShipment
+      #   operation.
+      # @param [String] carrier_id A carrier identifier originally returned by the getRates operation for the selected
+      #   rate.
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def get_tracking(tracking_id, carrier_id, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/tracking"
+        params = {
+          "trackingId" => tracking_id,
+          "carrierId" => carrier_id,
+        }.compact
+
+        rate_limit(80.0).get(path, params:)
+      end
+
+      # Returns the shipping documents associated with a package in a shipment.
+      #
+      # @param [String] shipment_id The shipment identifier originally returned by the purchaseShipment operation.
+      # @param [String] package_client_reference_id The package client reference identifier originally provided in the
+      #   request body parameter for the getRates operation.
+      # @param [String] format The file format of the document. Must be one of the supported formats returned by the
+      #   getRates operation.
+      # @param [Number] dpi The resolution of the document (for example, 300 means 300 dots per inch). Must be one of
+      #   the supported resolutions returned in the response to the getRates operation.
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def get_shipment_documents(shipment_id, package_client_reference_id, format: nil, dpi: nil,
+        x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/shipments/#{shipment_id}/documents"
+        params = {
+          "packageClientReferenceId" => package_client_reference_id,
+          "format" => format,
+          "dpi" => dpi,
+        }.compact
+
+        rate_limit(80.0).get(path, params:)
+      end
+
+      # Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled.
+      #
+      # @param [String] shipment_id The shipment identifier originally returned by the purchaseShipment operation.
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def cancel_shipment(shipment_id, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/shipments/#{shipment_id}/cancel"
+
+        rate_limit(80.0).put(path)
+      end
+
+      # Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call
+      # the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that
+      # additional inputs are required for the rate (shipping offering) that you want to purchase.
+      #
+      # @param [String] request_token The request token returned in the response to the getRates operation.
+      # @param [String] rate_id The rate identifier for the shipping offering (rate) returned in the response to the
+      #   getRates operation.
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def get_additional_inputs(request_token, rate_id, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/shipments/additionalInputs/schema"
+        params = {
+          "requestToken" => request_token,
+          "rateId" => rate_id,
+        }.compact
+
+        rate_limit(80.0).get(path, params:)
+      end
+
+      # This API will return a list of input schema required to register a shipper account with the carrier.
+      #
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def get_carrier_account_form_inputs(x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/carrierAccountFormInputs"
+
+        rate_limit(80.0).get(path)
+      end
+
+      # This API will return Get all carrier accounts for a merchant.
+      #
+      # @param [Hash] body
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def get_carrier_accounts(body, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/carrierAccounts"
+
+        rate_limit(80.0).put(path, body:)
+      end
+
+      # This API associates/links the specified carrier account with the merchant.
+      #
+      # @param [String] carrier_id The unique identifier associated with the carrier account.
+      # @param [Hash] body
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def link_carrier_account(carrier_id, body, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/carrierAccounts/#{carrier_id}"
+
+        rate_limit(80.0).put(path, body:)
+      end
+
+      # This API Unlink the specified carrier account with the merchant.
+      #
+      # @param [String] carrier_id carrier Id to unlink with merchant.
+      # @param [Hash] body
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def unlink_carrier_account(carrier_id, body, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/carrierAccounts/#{carrier_id}/unlink"
+
+        rate_limit(80.0).put(path, body:)
+      end
+
+      # This API Call to generate the collection form.
+      #
+      # @param [Hash] body
+      # @param [String] x_amzn_idempotency_key A unique value which the server uses to recognize subsequent retries of
+      #   the same request.
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def generate_collection_form(body, x_amzn_idempotency_key: nil, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/collectionForms"
+
+        rate_limit(80.0).post(path, body:)
+      end
+
+      # This API Call to get the history of the previously generated collection forms.
+      #
+      # @param [Hash] body
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def get_collection_form_history(body, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/collectionForms/history"
+
+        rate_limit(80.0).put(path, body:)
+      end
+
+      # This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments
+      # with an eligible carrier for manifesting shall be returned.
+      #
+      # @param [Hash] body
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def get_unmanifested_shipments(body, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/unmanifestedShipments"
+
+        rate_limit(80.0).put(path, body:)
+      end
+
+      # This API reprint a collection form.
+      #
+      # @param [String] collection_form_id collection form Id to reprint a collection.
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def get_collection_form(collection_form_id, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/collectionForms/#{collection_form_id}"
+
+        rate_limit(80.0).get(path)
+      end
+
+      # Returns a list of access points in proximity of input postal code.
+      #
+      # @param [Array<String>] access_point_types
+      # @param [String] country_code
+      # @param [String] postal_code
+      # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is
+      #   AmazonShipping_UK.
+      # @return [Hash] The API response
+      def get_access_points(access_point_types, country_code, postal_code, x_amzn_shipping_business_id: nil)
+        path = "/shipping/v2/accessPoints"
+        params = {
+          "accessPointTypes" => access_point_types,
+          "countryCode" => country_code,
+          "postalCode" => postal_code,
+        }.compact
+
+        rate_limit(80.0).get(path, params:)
+      end
+    end
+  end
+end

data/lib/peddler/api/solicitations_v1.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Solicitations
+    #
+    # With the Solicitations API you can build applications that send non-critical solicitations to buyers. You can get
+    # a list of solicitation types that are available for an order that you specify, then call an operation that sends a
+    # solicitation to the buyer for that order. Buyers cannot respond to solicitations sent by this API, and these
+    # solicitations do not appear in the Messaging section of Seller Central or in the recipient's Message Center. The
+    # Solicitations API returns responses that are formed according to the <a
+    # href=https://tools.ietf.org/html/draft-kelly-json-hal-08>JSON Hypertext Application Language</a> (HAL) standard.
+    class SolicitationsV1 < API
+      # Returns a list of solicitation types that are available for an order that you specify. A solicitation type is
+      # represented by an actions object, which contains a path and query parameter(s). You can use the path and
+      # parameter(s) to call an operation that sends a solicitation. Currently only the
+      # productReviewAndSellerFeedbackSolicitation solicitation type is available.
+      #
+      # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which you want a list
+      #   of available solicitation types.
+      # @param [Array<String>] marketplace_ids A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @return [Hash] The API response
+      def get_solicitation_actions_for_order(amazon_order_id, marketplace_ids)
+        path = "/solicitations/v1/orders/#{amazon_order_id}"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        rate_limit(1.0).get(path, params:)
+      end
+
+      # Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send
+      # only one productReviewAndSellerFeedback or free form proactive message per order.
+      #
+      # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a solicitation is
+      #   sent.
+      # @param [Array<String>] marketplace_ids A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @return [Hash] The API response
+      def create_product_review_and_seller_feedback_solicitation(amazon_order_id, marketplace_ids)
+        path = "/solicitations/v1/orders/#{amazon_order_id}/solicitations/productReviewAndSellerFeedback"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        rate_limit(1.0).post(path, params:)
+      end
+    end
+  end
+end

data/lib/peddler/api/supply_sources_2020_07_01.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Supply Sources
+    #
+    # Manage configurations and capabilities of seller supply sources.
+    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.
+      # @return [Hash] The API response
+      def get_supply_sources(next_page_token: nil, page_size: nil)
+        path = "/supplySources/2020-07-01/supplySources"
+        params = {
+          "nextPageToken" => next_page_token,
+          "pageSize" => page_size,
+        }.compact
+
+        get(path, params:)
+      end
+
+      # Create a new supply source.
+      #
+      # @param [Hash] payload A request to create a supply source.
+      # @return [Hash] The API response
+      def create_supply_source(payload)
+        path = "/supplySources/2020-07-01/supplySources"
+        body = payload
+
+        post(path, body:)
+      end
+
+      # Retrieve a supply source.
+      #
+      # @param [String] supply_source_id The unique identifier of a supply source.
+      # @return [Hash] The API response
+      def get_supply_source(supply_source_id)
+        path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
+
+        get(path)
+      end
+
+      # Update the configuration and capabilities of a supply source.
+      #
+      # @param [String] supply_source_id The unique identitier of a supply source.
+      # @param [Hash] payload
+      # @return [Hash] The API response
+      def update_supply_source(supply_source_id, payload: nil)
+        path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
+        body = payload
+
+        put(path, body:)
+      end
+
+      # Archive a supply source, making it inactive. Cannot be undone.
+      #
+      # @param [String] supply_source_id The unique identifier of a supply source.
+      # @return [Hash] The API response
+      def archive_supply_source(supply_source_id)
+        path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
+
+        delete(path)
+      end
+
+      # Update the status of a supply source.
+      #
+      # @param [String] supply_source_id The unique identifier of a supply source.
+      # @param [Hash] payload
+      # @return [Hash] The API response
+      def update_supply_source_status(supply_source_id, payload: nil)
+        path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}/status"
+        body = payload
+
+        put(path, body:)
+      end
+    end
+  end
+end

data/lib/peddler/api/tokens_2021_03_01.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  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).
+    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
+      # Information (PII), plus a dataElements value that indicates the type of PII requested. See the Tokens API Use
+      # 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.
+      # @return [Hash] The API response
+      def create_restricted_data_token(body)
+        path = "/tokens/2021-03-01/restrictedDataToken"
+
+        rate_limit(1.0).post(path, body:)
+      end
+    end
+  end
+end

data/lib/peddler/api/uploads_2020_11_01.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Uploads
+    #
+    # The Uploads API lets you upload files that you can programmatically access using other Selling Partner APIs, such
+    # as the A+ Content API and the Messaging API.
+    class Uploads20201101 < API
+      # 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
+      #   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
+      #   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
+      #   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.
+      # @return [Hash] The API response
+      def create_upload_destination_for_resource(marketplace_ids, content_md5, resource, content_type: nil)
+        path = "/uploads/2020-11-01/uploadDestinations/#{resource}"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+          "contentMD5" => content_md5,
+          "contentType" => content_type,
+        }.compact
+
+        rate_limit(10.0).post(path, params:)
+      end
+    end
+  end
+end

data/lib/peddler/api/vendor_direct_fulfillment_inventory_v1.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Direct Fulfillment Inventory Updates
+    #
+    # The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct
+    # fulfillment vendor's inventory updates.
+    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.
+      # @return [Hash] The API response
+      def submit_inventory_update(body, warehouse_id)
+        path = "/vendor/directFulfillment/inventory/v1/warehouses/#{warehouse_id}/items"
+
+        rate_limit(10.0).post(path, body:)
+      end
+    end
+  end
+end

data/lib/peddler/api/vendor_direct_fulfillment_orders_2021_12_28.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Direct Fulfillment Orders
+    #
+    # The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment
+    # vendor's order data.
+    class VendorDirectFulfillmentOrders20211228 < API
+      # Returns a list of purchase orders created during the time frame that you specify. You define the time frame
+      # using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only
+      # the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns
+      # 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
+      #   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
+      #   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
+      #   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
+      #   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.
+      #   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
+      #   order numbers are returned.
+      # @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)
+        path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders"
+        params = {
+          "shipFromPartyId" => ship_from_party_id,
+          "status" => status,
+          "limit" => limit,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+          "includeDetails" => include_details,
+        }.compact
+
+        rate_limit(10.0).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
+      #   Notes: alpha-numeric code.
+      # @return [Hash] The API response
+      def get_order(purchase_order_number)
+        path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders/#{purchase_order_number}"
+
+        rate_limit(10.0).get(path)
+      end
+
+      # Submits acknowledgements for one or more purchase orders.
+      #
+      # @param [Hash] body The request body containing the acknowledgement to an order
+      # @return [Hash] The API response
+      def submit_acknowledgement(body)
+        path = "/vendor/directFulfillment/orders/2021-12-28/acknowledgements"
+
+        rate_limit(10.0).post(path, body:)
+      end
+    end
+  end
+end