peddler 2.4.5 → 3.0.0.beta1

data/lib/peddler/api/vendor_direct_fulfillment_orders_v1.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 VendorDirectFulfillmentOrdersV1 < 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/v1/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/v1/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 that contains the order acknowledgement.
+      # @return [Hash] The API response
+      def submit_acknowledgement(body)
+        path = "/vendor/directFulfillment/orders/v1/acknowledgements"
+
+        rate_limit(10.0).post(path, body:)
+      end
+    end
+  end
+end

data/lib/peddler/api/vendor_direct_fulfillment_payments_v1.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Direct Fulfillment Payments
+    #
+    # The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment
+    # vendor's invoice data.
+    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.
+      # @return [Hash] The API response
+      def submit_invoice(body)
+        path = "/vendor/directFulfillment/payments/v1/invoices"
+
+        rate_limit(10.0).post(path, body:)
+      end
+    end
+  end
+end

data/lib/peddler/api/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # 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
+    # direct fulfillment sandbox test data.
+    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.
+      # @return [Hash] The API response
+      def generate_order_scenarios(body)
+        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.
+      #
+      # @param [String] transaction_id The transaction identifier returned in the response for the
+      #   `generateOrderScenarios` operation.
+      # @return [Hash] The API response
+      def get_order_scenarios(transaction_id)
+        path = "/vendor/directFulfillment/sandbox/2021-10-28/transactions/#{transaction_id}"
+
+        get(path)
+      end
+    end
+  end
+end

data/lib/peddler/api/vendor_direct_fulfillment_shipping_2021_12_28.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Direct Fulfillment Shipping
+    #
+    # The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment
+    # vendor's shipping data.
+    class VendorDirectFulfillmentShipping20211228 < API
+      # Returns a list of shipping labels created during the time frame that you specify. You define that time frame
+      # using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to
+      # search must not be more than 7 days.
+      #
+      # @param [String] ship_from_party_id The vendor warehouseId for order fulfillment. If not specified, the result
+      #   will contain orders for all warehouses.
+      # @param [Integer] limit The limit to the number of records returned.
+      # @param [String] created_after Shipping labels 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 Shipping labels 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 ASC or DESC by order creation date.
+      # @param [String] next_token Used for pagination when there are more ship labels than the specified result size
+      #   limit. The token value is returned in the previous API call.
+      # @return [Hash] The API response
+      def get_shipping_labels(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil,
+        next_token: nil)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels"
+        params = {
+          "shipFromPartyId" => ship_from_party_id,
+          "limit" => limit,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+        }.compact
+
+        rate_limit(10.0).get(path, params:)
+      end
+
+      # Creates a shipping label for a purchase order and returns a transactionId for reference.
+      #
+      # @param [Hash] body Request body that contains the shipping labels data.
+      # @return [Hash] The API response
+      def submit_shipping_label_request(body)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels"
+
+        rate_limit(10.0).post(path, body:)
+      end
+
+      # Returns a shipping label for the purchaseOrderNumber that you specify.
+      #
+      # @param [String] purchase_order_number The purchase order number for which you want to return the shipping label.
+      #   Should be the same `purchaseOrderNumber` as received in the order.
+      # @return [Hash] The API response
+      def get_shipping_label(purchase_order_number)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels/#{purchase_order_number}"
+
+        rate_limit(10.0).get(path)
+      end
+
+      # Creates shipping labels for a purchase order and returns the labels.
+      #
+      # @param [String] purchase_order_number The purchase order number for which you want to return the shipping
+      #   labels. It should be the same purchaseOrderNumber as received in the order.
+      # @param [Hash] body The request payload that contains parameters for creating shipping labels.
+      # @return [Hash] The API response
+      def create_shipping_labels(purchase_order_number, body)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels/#{purchase_order_number}"
+
+        rate_limit(10.0).post(path, body:)
+      end
+
+      # Submits one or more shipment confirmations for vendor orders.
+      #
+      # @param [Hash] body Request body containing the shipment confirmations data.
+      # @return [Hash] The API response
+      def submit_shipment_confirmations(body)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/shipmentConfirmations"
+
+        rate_limit(10.0).post(path, body:)
+      end
+
+      # This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment
+      # status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their
+      # order, when the package is outside of Amazon Network visibility.
+      #
+      # @param [Hash] body Request body that contains the shipment status update data.
+      # @return [Hash] The API response
+      def submit_shipment_status_updates(body)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/shipmentStatusUpdates"
+
+        rate_limit(10.0).post(path, body:)
+      end
+
+      # Returns a list of customer invoices created during a time frame that you specify. You define the time frame
+      # using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to
+      # search must be no more than 7 days.
+      #
+      # @param [String] ship_from_party_id The vendor warehouseId for order fulfillment. If not specified, the result
+      #   will contain orders for all warehouses.
+      # @param [Integer] limit The limit to the number of records returned
+      # @param [String] created_after 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 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 ASC or DESC 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.
+      # @return [Hash] The API response
+      def get_customer_invoices(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil,
+        next_token: nil)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/customerInvoices"
+        params = {
+          "shipFromPartyId" => ship_from_party_id,
+          "limit" => limit,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+        }.compact
+
+        rate_limit(10.0).get(path, params:)
+      end
+
+      # Returns a customer invoice based on the purchaseOrderNumber that you specify.
+      #
+      # @param [String] purchase_order_number Purchase order number of the shipment for which to return the invoice.
+      # @return [Hash] The API response
+      def get_customer_invoice(purchase_order_number)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/customerInvoices/#{purchase_order_number}"
+
+        rate_limit(10.0).get(path)
+      end
+
+      # Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search
+      # must not be more than 7 days.
+      #
+      # @param [String] ship_from_party_id The vendor warehouseId for order fulfillment. If not specified the result
+      #   will contain orders for all warehouses.
+      # @param [Integer] limit The limit to the number of records returned
+      # @param [String] created_after Packing slips 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 Packing slips 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 ASC or DESC by packing slip creation date.
+      # @param [String] next_token Used for pagination when there are more packing slips than the specified result size
+      #   limit. The token value is returned in the previous API call.
+      # @return [Hash] The API response
+      def get_packing_slips(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil,
+        next_token: nil)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/packingSlips"
+        params = {
+          "shipFromPartyId" => ship_from_party_id,
+          "limit" => limit,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+        }.compact
+
+        rate_limit(10.0).get(path, params:)
+      end
+
+      # Returns a packing slip based on the purchaseOrderNumber that you specify.
+      #
+      # @param [String] purchase_order_number The purchaseOrderNumber for the packing slip you want.
+      # @return [Hash] The API response
+      def get_packing_slip(purchase_order_number)
+        path = "/vendor/directFulfillment/shipping/2021-12-28/packingSlips/#{purchase_order_number}"
+
+        rate_limit(10.0).get(path)
+      end
+    end
+  end
+end

data/lib/peddler/api/vendor_direct_fulfillment_shipping_v1.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Direct Fulfillment Shipping
+    #
+    # The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment
+    # vendor's shipping data.
+    class VendorDirectFulfillmentShippingV1 < API
+      # Returns a list of shipping labels created during the time frame that you specify. You define that time frame
+      # using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range
+      # to search must not be more than 7 days.
+      #
+      # @param [String] ship_from_party_id The vendor `warehouseId` for order fulfillment. If not specified, the result
+      #   will contain orders for all warehouses.
+      # @param [Integer] limit The limit to the number of records returned.
+      # @param [String] created_after Shipping labels that became available after this date and time will be included in
+      #   the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format.
+      # @param [String] created_before Shipping labels that became available before this date and time will be included
+      #   in the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format.
+      # @param [String] sort_order Sort ASC or DESC by order creation date.
+      # @param [String] next_token Used for pagination when there are more ship labels than the specified result size
+      #   limit. The token value is returned in the previous API call.
+      # @return [Hash] The API response
+      def get_shipping_labels(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil,
+        next_token: nil)
+        path = "/vendor/directFulfillment/shipping/v1/shippingLabels"
+        params = {
+          "shipFromPartyId" => ship_from_party_id,
+          "limit" => limit,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+        }.compact
+
+        rate_limit(10.0).get(path, params:)
+      end
+
+      # Creates a shipping label for a purchase order and returns a `transactionId` for reference.
+      #
+      # @param [Hash] body Request body containing one or more shipping labels data.
+      # @return [Hash] The API response
+      def submit_shipping_label_request(body)
+        path = "/vendor/directFulfillment/shipping/v1/shippingLabels"
+
+        rate_limit(10.0).post(path, body:)
+      end
+
+      # Returns a shipping label for the `purchaseOrderNumber` that you specify.
+      #
+      # @param [String] purchase_order_number The purchase order number for which you want to return the shipping label.
+      #   It should be the same `purchaseOrderNumber` as received in the order.
+      # @return [Hash] The API response
+      def get_shipping_label(purchase_order_number)
+        path = "/vendor/directFulfillment/shipping/v1/shippingLabels/#{purchase_order_number}"
+
+        rate_limit(10.0).get(path)
+      end
+
+      # Submits one or more shipment confirmations for vendor orders.
+      #
+      # @param [Hash] body Request body containing the shipment confirmations data.
+      # @return [Hash] The API response
+      def submit_shipment_confirmations(body)
+        path = "/vendor/directFulfillment/shipping/v1/shipmentConfirmations"
+
+        rate_limit(10.0).post(path, body:)
+      end
+
+      # This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment
+      # status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their
+      # order, when the package is outside of Amazon Network visibility.
+      #
+      # @param [Hash] body Request body containing the shipment status update data.
+      # @return [Hash] The API response
+      def submit_shipment_status_updates(body)
+        path = "/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates"
+
+        rate_limit(10.0).post(path, body:)
+      end
+
+      # Returns a list of customer invoices created during a time frame that you specify. You define the time frame
+      # using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range
+      # to search must be no more than 7 days.
+      #
+      # @param [String] ship_from_party_id The vendor `warehouseId` for order fulfillment. If not specified, the result
+      #   will contain orders for all warehouses.
+      # @param [Integer] limit The limit to the number of records returned
+      # @param [String] created_after Orders that became available after this date and time will be included in the
+      #   result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format.
+      # @param [String] created_before Orders that became available before this date and time will be included in the
+      #   result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format.
+      # @param [String] sort_order Sort ASC or DESC 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.
+      # @return [Hash] The API response
+      def get_customer_invoices(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil,
+        next_token: nil)
+        path = "/vendor/directFulfillment/shipping/v1/customerInvoices"
+        params = {
+          "shipFromPartyId" => ship_from_party_id,
+          "limit" => limit,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+        }.compact
+
+        rate_limit(10.0).get(path, params:)
+      end
+
+      # Returns a customer invoice based on the `purchaseOrderNumber` that you specify.
+      #
+      # @param [String] purchase_order_number Purchase order number of the shipment for which to return the invoice.
+      # @return [Hash] The API response
+      def get_customer_invoice(purchase_order_number)
+        path = "/vendor/directFulfillment/shipping/v1/customerInvoices/#{purchase_order_number}"
+
+        rate_limit(10.0).get(path)
+      end
+
+      # Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search
+      # must not be more than 7 days.
+      #
+      # @param [String] ship_from_party_id The vendor `warehouseId` for order fulfillment. If not specified the result
+      #   will contain orders for all warehouses.
+      # @param [Integer] limit The limit to the number of records returned
+      # @param [String] created_after Packing slips that became available after this date and time will be included in
+      #   the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format.
+      # @param [String] created_before Packing slips that became available before this date and time will be included in
+      #   the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format.
+      # @param [String] sort_order Sort ASC or DESC by packing slip creation date.
+      # @param [String] next_token Used for pagination when there are more packing slips than the specified result size
+      #   limit. The token value is returned in the previous API call.
+      # @return [Hash] The API response
+      def get_packing_slips(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil,
+        next_token: nil)
+        path = "/vendor/directFulfillment/shipping/v1/packingSlips"
+        params = {
+          "shipFromPartyId" => ship_from_party_id,
+          "limit" => limit,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "sortOrder" => sort_order,
+          "nextToken" => next_token,
+        }.compact
+
+        rate_limit(10.0).get(path, params:)
+      end
+
+      # Returns a packing slip based on the `purchaseOrderNumber` that you specify.
+      #
+      # @param [String] purchase_order_number The `purchaseOrderNumber` for the packing slip you want.
+      # @return [Hash] The API response
+      def get_packing_slip(purchase_order_number)
+        path = "/vendor/directFulfillment/shipping/v1/packingSlips/#{purchase_order_number}"
+
+        rate_limit(10.0).get(path)
+      end
+    end
+  end
+end

data/lib/peddler/api/vendor_direct_fulfillment_transactions_2021_12_28.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Direct Fulfillment Transaction Status
+    #
+    # The Selling Partner API for Direct Fulfillment Transaction Status provides programmatic access to a direct
+    # fulfillment vendor's transaction status.
+    class VendorDirectFulfillmentTransactions20211228 < API
+      # Returns the status of the transaction indicated by the specified `transactionId`.
+      #
+      # @param [String] transaction_id Previously returned in the response to the POST request of a specific
+      #   transaction.
+      # @return [Hash] The API response
+      def get_transaction_status(transaction_id)
+        path = "/vendor/directFulfillment/transactions/2021-12-28/transactions/#{transaction_id}"
+
+        rate_limit(10.0).get(path)
+      end
+    end
+  end
+end

data/lib/peddler/api/vendor_direct_fulfillment_transactions_v1.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Direct Fulfillment Transaction Status
+    #
+    # The Selling Partner API for Direct Fulfillment Transaction Status provides programmatic access to a direct
+    # fulfillment vendor's transaction status.
+    class VendorDirectFulfillmentTransactionsV1 < API
+      # Returns the status of the transaction indicated by the specified `transactionId`.
+      #
+      # @param [String] transaction_id Previously returned in the response to the POST request of a specific
+      #   transaction.
+      # @return [Hash] The API response
+      def get_transaction_status(transaction_id)
+        path = "/vendor/directFulfillment/transactions/v1/transactions/#{transaction_id}"
+
+        rate_limit(10.0).get(path)
+      end
+    end
+  end
+end

data/lib/peddler/api/vendor_invoices_v1.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class API
+    # Selling Partner API for Retail Procurement Payments
+    #
+    # The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data.
+    class VendorInvoicesV1 < API
+      # Submit new invoices to Amazon.
+      #
+      # @param [Hash] body The request body containing the invoice data to submit.
+      # @return [Hash] The API response
+      def submit_invoices(body)
+        path = "/vendor/payments/v1/invoices"
+
+        rate_limit(10.0).post(path, body:)
+      end
+    end
+  end
+end