peddler 3.0.0.beta1 → 4.0.0

data/lib/peddler/api/shipping_v1.rb

@@ -1,107 +0,0 @@
-# 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/supply_sources_2020_07_01.rb

@@ -1,82 +0,0 @@
-# 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/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.rb

@@ -1,35 +0,0 @@
-# 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_v1.rb

@@ -1,165 +0,0 @@
-# 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_invoices_v1.rb

@@ -1,22 +0,0 @@
-# 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

data/lib/peddler/api/vendor_shipments_v1.rb

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-require "peddler/api"
-
-module Peddler
-  class API
-    # Selling Partner API for Retail Procurement Shipments
-    #
-    # The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for
-    # vendors.
-    class VendorShipmentsV1 < API
-      # Submits one or more shipment confirmations for vendor orders.
-      #
-      # @param [Hash] body A request to submit shipment confirmation.
-      # @return [Hash] The API response
-      def submit_shipment_confirmations(body)
-        path = "/vendor/shipping/v1/shipmentConfirmations"
-
-        rate_limit(10.0).post(path, body:)
-      end
-
-      # Submits one or more shipment request for vendor Orders.
-      #
-      # @param [Hash] body A request to submit shipment request.
-      # @return [Hash] The API response
-      def submit_shipments(body)
-        path = "/vendor/shipping/v1/shipments"
-
-        rate_limit(10.0).post(path, body:)
-      end
-
-      # Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details
-      # related to shipment based on the filter parameters value that you specify.
-      #
-      # @param [Integer] limit The limit to the number of records returned. Default value is 50 records.
-      # @param [String] sort_order Sort in ascending or descending order by purchase order creation date.
-      # @param [String] next_token Used for pagination when there are more shipments than the specified result size
-      #   limit.
-      # @param [String] created_after Get Shipment Details that became available after this timestamp will be included
-      #   in the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] created_before Get Shipment Details that became available before this timestamp will be included
-      #   in the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] shipment_confirmed_before Get Shipment Details by passing Shipment confirmed create Date Before.
-      #   Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] shipment_confirmed_after Get Shipment Details by passing Shipment confirmed create Date After.
-      #   Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] package_label_created_before Get Shipment Details by passing Package label create Date by buyer.
-      #   Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] package_label_created_after Get Shipment Details by passing Package label create Date After by
-      #   buyer. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] shipped_before Get Shipment Details by passing Shipped Date Before. Must be in [ISO
-      #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] shipped_after Get Shipment Details by passing Shipped Date After. Must be in [ISO
-      #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] estimated_delivery_before Get Shipment Details by passing Estimated Delivery Date Before. Must
-      #   be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] estimated_delivery_after Get Shipment Details by passing Estimated Delivery Date Before. Must be
-      #   in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] shipment_delivery_before Get Shipment Details by passing Shipment Delivery Date Before. Must be
-      #   in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] shipment_delivery_after Get Shipment Details by passing Shipment Delivery Date After. Must be in
-      #   [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] requested_pick_up_before Get Shipment Details by passing Before Requested pickup date. Must be
-      #   in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] requested_pick_up_after Get Shipment Details by passing After Requested pickup date. Must be in
-      #   [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] scheduled_pick_up_before Get Shipment Details by passing Before scheduled pickup date. Must be
-      #   in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] scheduled_pick_up_after Get Shipment Details by passing After Scheduled pickup date. Must be in
-      #   [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-      # @param [String] current_shipment_status Get Shipment Details by passing Current shipment status.
-      # @param [String] vendor_shipment_identifier Get Shipment Details by passing Vendor Shipment ID
-      # @param [String] buyer_reference_number Get Shipment Details by passing buyer Reference ID
-      # @param [String] buyer_warehouse_code Get Shipping Details based on buyer warehouse code. This value should be
-      #   same as 'shipToParty.partyId' in the Shipment.
-      # @param [String] seller_warehouse_code Get Shipping Details based on vendor warehouse code. This value should be
-      #   same as 'sellingParty.partyId' in the Shipment.
-      # @return [Hash] The API response
-      def get_shipment_details(
-        limit: nil, sort_order: nil, next_token: nil, created_after: nil, created_before: nil,
-        shipment_confirmed_before: nil, shipment_confirmed_after: nil, package_label_created_before: nil,
-        package_label_created_after: nil, shipped_before: nil, shipped_after: nil, estimated_delivery_before: nil,
-        estimated_delivery_after: nil, shipment_delivery_before: nil, shipment_delivery_after: nil,
-        requested_pick_up_before: nil, requested_pick_up_after: nil, scheduled_pick_up_before: nil,
-        scheduled_pick_up_after: nil, current_shipment_status: nil, vendor_shipment_identifier: nil,
-        buyer_reference_number: nil, buyer_warehouse_code: nil, seller_warehouse_code: nil
-      )
-        path = "/vendor/shipping/v1/shipments"
-        params = {
-          "limit" => limit,
-          "sortOrder" => sort_order,
-          "nextToken" => next_token,
-          "createdAfter" => created_after,
-          "createdBefore" => created_before,
-          "shipmentConfirmedBefore" => shipment_confirmed_before,
-          "shipmentConfirmedAfter" => shipment_confirmed_after,
-          "packageLabelCreatedBefore" => package_label_created_before,
-          "packageLabelCreatedAfter" => package_label_created_after,
-          "shippedBefore" => shipped_before,
-          "shippedAfter" => shipped_after,
-          "estimatedDeliveryBefore" => estimated_delivery_before,
-          "estimatedDeliveryAfter" => estimated_delivery_after,
-          "shipmentDeliveryBefore" => shipment_delivery_before,
-          "shipmentDeliveryAfter" => shipment_delivery_after,
-          "requestedPickUpBefore" => requested_pick_up_before,
-          "requestedPickUpAfter" => requested_pick_up_after,
-          "scheduledPickUpBefore" => scheduled_pick_up_before,
-          "scheduledPickUpAfter" => scheduled_pick_up_after,
-          "currentShipmentStatus" => current_shipment_status,
-          "vendorShipmentIdentifier" => vendor_shipment_identifier,
-          "buyerReferenceNumber" => buyer_reference_number,
-          "buyerWarehouseCode" => buyer_warehouse_code,
-          "sellerWarehouseCode" => seller_warehouse_code,
-        }.compact
-
-        rate_limit(10.0).get(path, params:)
-      end
-    end
-  end
-end

data/lib/peddler/region.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "uri"
-
-module Peddler
-  class Region
-    class UnknownRegion < ArgumentError; end
-
-    # @see https://developer-docs.amazon.com/sp-api/docs/sp-api-endpoints
-    ENDPOINTS = {
-      "us-east-1" => "https://sellingpartnerapi-na.amazon.com",
-      "us-west-2" => "https://sellingpartnerapi-fe.amazon.com",
-      "eu-west-1" => "https://sellingpartnerapi-eu.amazon.com",
-    }
-
-    attr_reader :name
-
-    # @param [String] name
-    def initialize(name)
-      @name = name
-    end
-
-    # @return [String]
-    def endpoint
-      ENDPOINTS.fetch(name) do
-        raise UnknownRegion, "#{name} not found"
-      end
-    end
-  end
-end