peddler 4.9.0 → 5.0.0.pre.2

data/lib/peddler/apis/external_fulfillment_returns_2024_09_11.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "peddler/api"
+
+module Peddler
+  class << self
+    def external_fulfillment_returns_2024_09_11
+      APIs::ExternalFulfillmentReturns20240911
+    end
+  end
+
+  module APIs
+    # The Selling Partner API for Amazon External Fulfillment Return Item Processing
+    #
+    # You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return
+    # items through Amazon's External Fulfillment returns management system.
+    #
+    # @see https://github.com/amzn/selling-partner-api-models/blob/main/models/external-fulfillment/externalFulfillmentReturns_2024-09-11.json
+    class ExternalFulfillmentReturns20240911 < API
+      # Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param return_location_id [String] The SmartConnect location ID of the location from which you want to retrieve
+      #   return items.
+      # @param rma_id [String] The RMA ID of the return items you want to list.
+      # @param status [String] The status of return items you want to list. You can retrieve all new return items with
+      #   the `CREATED` status.
+      # @param reverse_tracking_id [String] The reverse tracking ID of the return items you want to list.
+      # @param created_since [String] Return items created after the specified date are included in the response. In
+      #   [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+      # @param created_until [String] Return items created before the specified date are included in the response. In
+      #   [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+      # @param last_updated_since [String] Return items updated after the specified date are included in the response.
+      #   In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this
+      #   parameter, you must also supply `returnLocationId` and `status`.
+      # @param last_updated_until [String] Return items whose most recent update is before the specified date are
+      #   included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time
+      #   format. If you supply this parameter, you must also supply `returnLocationId` and `status`.
+      # @param last_updated_after [String] DEPRECATED. Use the `createdSince` parameter.
+      # @param last_updated_before [String] DEPRECATED. Use the `createdUntil` parameter.
+      # @param max_results [Integer] The number of return items you want to include in the response. **Default:** 10
+      #   **Maximum:** 100
+      # @param next_token [String] A token that you use to retrieve the next page of results. The response includes
+      #   `nextToken` when there are multiple pages of results. To get the next page of results, call the operation with
+      #   this token and include the same arguments as the call that produced the token. To get a complete list, call
+      #   this operation until `nextToken` is null. Note that this operation can return empty pages.
+      # @return [Peddler::Response] The API response
+      def list_returns(return_location_id: nil, rma_id: nil, status: nil, reverse_tracking_id: nil, created_since: nil,
+        created_until: nil, last_updated_since: nil, last_updated_until: nil, last_updated_after: nil,
+        last_updated_before: nil, max_results: nil, next_token: nil)
+        path = "/externalFulfillment/2024-09-11/returns"
+        params = {
+          "returnLocationId" => return_location_id,
+          "rmaId" => rma_id,
+          "status" => status,
+          "reverseTrackingId" => reverse_tracking_id,
+          "createdSince" => created_since,
+          "createdUntil" => created_until,
+          "lastUpdatedSince" => last_updated_since,
+          "lastUpdatedUntil" => last_updated_until,
+          "lastUpdatedAfter" => last_updated_after,
+          "lastUpdatedBefore" => last_updated_before,
+          "maxResults" => max_results,
+          "nextToken" => next_token,
+        }.compact
+        parser = -> {
+          require "peddler/types/external_fulfillment_returns_2024_09_11"
+          Types::ExternalFulfillmentReturns20240911::ReturnsResponse
+        }
+        get(path, params:, parser:)
+      end
+
+      # Retrieve the return item with the specified ID.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param return_id [String] The ID of the return item you want.
+      # @return [Peddler::Response] The API response
+      def get_return(return_id)
+        path = "/externalFulfillment/2024-09-11/returns/#{percent_encode(return_id)}"
+        parser = -> {
+          require "peddler/types/external_fulfillment_returns_2024_09_11"
+          Types::ExternalFulfillmentReturns20240911::Return
+        }
+        get(path, parser:)
+      end
+    end
+  end
+end

data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "peddler/api"
+
+module Peddler
+  class << self
+    def external_fulfillment_shipments_2024_09_11
+      APIs::ExternalFulfillmentShipments20240911
+    end
+  end
+
+  module APIs
+    # The Selling Partner API for Amazon External Fulfillment Shipments Processing
+    #
+    # You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through
+    # Amazon's external fulfillment network. Use this API to get shipment details, monitor status changes, and access
+    # fulfillment requirements.
+    #
+    # @see https://github.com/amzn/selling-partner-api-models/blob/main/models/external-fulfillment/externalFulfillmentShipments_2024-09-11.json
+    class ExternalFulfillmentShipments20240911 < API
+      # Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered
+      # based on the fulfillment node or the time of the shipments' last update.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param location_id [String] The Amazon channel location identifier for the shipments you want to retrieve.
+      # @param marketplace_id [String] The marketplace ID associated with the location. To find the ID for your
+      #   marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+      # @param channel_name [String] The channel name associated with the location.
+      # @param status [String] The status of shipment you want to include in the response. To retrieve all new
+      #   shipments, set this value to `ACCEPTED`.
+      # @param last_updated_after [String] The response includes shipments whose latest update is after the specified
+      #   time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+      # @param last_updated_before [String] The response includes shipments whose latest update is before the specified
+      #   time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+      # @param max_results [Integer] The maximum number of shipments to include in the response.
+      # @param pagination_token [String] A token that you use to retrieve the next page of results. The response
+      #   includes `nextToken` when there are multiple pages of results. To get the next page of results, call the
+      #   operation with this token and include the same arguments as the call that produced the token. To get a
+      #   complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
+      # @return [Peddler::Response] The API response
+      def get_shipments(status, location_id: nil, marketplace_id: nil, channel_name: nil, last_updated_after: nil,
+        last_updated_before: nil, max_results: nil, pagination_token: nil)
+        path = "/externalFulfillment/2024-09-11/shipments"
+        params = {
+          "locationId" => location_id,
+          "marketplaceId" => marketplace_id,
+          "channelName" => channel_name,
+          "status" => status,
+          "lastUpdatedAfter" => last_updated_after,
+          "lastUpdatedBefore" => last_updated_before,
+          "maxResults" => max_results,
+          "paginationToken" => pagination_token,
+        }.compact
+        parser = -> {
+          require "peddler/types/external_fulfillment_shipments_2024_09_11"
+          Types::ExternalFulfillmentShipments20240911::ShipmentsResponse
+        }
+        get(path, params:, parser:)
+      end
+
+      # Get a single shipment with the ID you specify.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The ID of the shipment you want to retrieve.
+      # @return [Peddler::Response] The API response
+      def get_shipment(shipment_id)
+        path = "/externalFulfillment/2024-09-11/shipments/#{percent_encode(shipment_id)}"
+        parser = -> {
+          require "peddler/types/external_fulfillment_shipments_2024_09_11"
+          Types::ExternalFulfillmentShipments20240911::Shipment
+        }
+        get(path, parser:)
+      end
+
+      # Confirm or reject the specified shipment.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The ID of the shipment you want to confirm or reject.
+      # @param operation [String] The status of the shipment.
+      # @param body [Hash] Information about the shipment and its line items.
+      # @return [Peddler::Response] The API response
+      def process_shipment(shipment_id, operation, body: nil)
+        path = "/externalFulfillment/2024-09-11/shipments/#{percent_encode(shipment_id)}"
+        params = {
+          "operation" => operation,
+        }.compact
+        post(path, body:, params:)
+      end
+
+      # Provide details about the packages in the specified shipment.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The ID of the shipment.
+      # @param body [Hash] A list of packages in the shipment.
+      # @return [Peddler::Response] The API response
+      def create_packages(shipment_id, body)
+        path = "/externalFulfillment/2024-09-11/shipments/#{percent_encode(shipment_id)}/packages"
+        post(path, body:)
+      end
+
+      # Updates the details about the packages that will be used to fulfill the specified shipment.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The ID of the shipment to which the package belongs.
+      # @param package_id [String] The ID of the package whose information you want to update.
+      # @param body [Hash] The body of the request.
+      # @return [Peddler::Response] The API response
+      def update_package(shipment_id, package_id, body)
+        path = "/externalFulfillment/2024-09-11/shipments/#{percent_encode(shipment_id)}/packages/#{percent_encode(package_id)}"
+        put(path, body:)
+      end
+
+      # Updates the status of the packages.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The ID of the shipment to which the package belongs.
+      # @param package_id [String] The ID of the package whose status you want to update.
+      # @param status [String] **DEPRECATED**. Do not use. Package status is defined in the body parameter.
+      # @param body [Hash] The body of the request.
+      # @return [Peddler::Response] The API response
+      def update_package_status(shipment_id, package_id, status: nil, body: nil)
+        path = "/externalFulfillment/2024-09-11/shipments/#{percent_encode(shipment_id)}/packages/#{percent_encode(package_id)}"
+        params = {
+          "status" => status,
+        }.compact
+        patch(path, body:, params:)
+      end
+
+      # Get a list of shipping options for a package in a shipment given the shipment's marketplace and channel. If the
+      # marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The ID of the shipment to which the package belongs.
+      # @param package_id [String] The ID of the package for which you want to retrieve shipping options.
+      # @return [Peddler::Response] The API response
+      def retrieve_shipping_options(shipment_id, package_id)
+        path = "/externalFulfillment/2024-09-11/shipments/#{percent_encode(shipment_id)}/shippingOptions"
+        params = {
+          "packageId" => package_id,
+        }.compact
+        parser = -> {
+          require "peddler/types/external_fulfillment_shipments_2024_09_11"
+          Types::ExternalFulfillmentShipments20240911::ShippingOptionsResponse
+        }
+        get(path, params:, parser:)
+      end
+
+      # Get invoices for the shipment you specify.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The ID of the shipment whose invoice you want.
+      # @return [Peddler::Response] The API response
+      def generate_invoice(shipment_id)
+        path = "/externalFulfillment/2024-09-11/shipments/#{percent_encode(shipment_id)}/invoice"
+        parser = -> {
+          require "peddler/types/external_fulfillment_shipments_2024_09_11"
+          Types::ExternalFulfillmentShipments20240911::InvoiceResponse
+        }
+        post(path, parser:)
+      end
+
+      # Retrieve invoices for the shipment you specify.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The ID of the shipment whose invoice you want to retrieve.
+      # @return [Peddler::Response] The API response
+      def retrieve_invoice(shipment_id)
+        path = "/externalFulfillment/2024-09-11/shipments/#{percent_encode(shipment_id)}/invoice"
+        parser = -> {
+          require "peddler/types/external_fulfillment_shipments_2024_09_11"
+          Types::ExternalFulfillmentShipments20240911::InvoiceResponse
+        }
+        get(path, parser:)
+      end
+
+      # Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] The ID of the shipment whose shipping labels you want to generate and retrieve.
+      # @param shipping_option_id [String] The ID of the shipping option whose shipping labels you want.
+      # @param operation [String] Specify whether you want to generate or regenerate a label.
+      # @param body [Hash] Shipping details for when shipping is not done by the marketplace channel.
+      # @return [Peddler::Response] The API response
+      def generate_ship_labels(shipment_id, operation, shipping_option_id: nil, body: nil)
+        path = "/externalFulfillment/2024-09-11/shipments/#{percent_encode(shipment_id)}/shipLabels"
+        params = {
+          "shippingOptionId" => shipping_option_id,
+          "operation" => operation,
+        }.compact
+        parser = -> {
+          require "peddler/types/external_fulfillment_shipments_2024_09_11"
+          Types::ExternalFulfillmentShipments20240911::ShipLabelsResponse
+        }
+        put(path, body:, params:, parser:)
+      end
+    end
+  end
+end

data/lib/peddler/apis/fba_inbound_eligibility_v1.rb

@@ -6,8 +6,8 @@ require "peddler/api"
 
 module Peddler
   class << self
-    def fba_inbound_eligibility_v1(...)
-      APIs::FBAInboundEligibilityV1.new(...)
+    def fba_inbound_eligibility_v1
+      APIs::FBAInboundEligibilityV1
     end
   end
 
@@ -40,15 +40,12 @@ module Peddler
           "asin" => asin,
           "program" => program,
         }.compact
-        parser = Peddler::Types::FBAInboundEligibilityV1::GetItemEligibilityPreviewResponse if typed?
+        parser = -> {
+          require "peddler/types/fba_inbound_eligibility_v1"
+          Types::FBAInboundEligibilityV1::GetItemEligibilityPreviewResponse
+        }
         meter(rate_limit).get(path, params:, parser:)
       end
-
-      private
-
-      def load_types
-        require "peddler/types/fba_inbound_eligibility_v1"
-      end
     end
   end
 end

data/lib/peddler/apis/fba_inventory_v1.rb

@@ -6,8 +6,8 @@ require "peddler/api"
 
 module Peddler
   class << self
-    def fba_inventory_v1(...)
-      APIs::FBAInventoryV1.new(...)
+    def fba_inventory_v1
+      APIs::FBAInventoryV1
     end
   end
 
@@ -68,7 +68,10 @@ module Peddler
           "nextToken" => next_token,
           "marketplaceIds" => stringify_array(marketplace_ids),
         }.compact
-        parser = Peddler::Types::FBAInventoryV1::GetInventorySummariesResponse if typed?
+        parser = -> {
+          require "peddler/types/fba_inventory_v1"
+          Types::FBAInventoryV1::GetInventorySummariesResponse
+        }
         meter(rate_limit).get(path, params:, parser:)
       end
 
@@ -84,7 +87,10 @@ module Peddler
 
         path = "/fba/inventory/v1/items"
         body = create_inventory_item_request_body
-        parser = Peddler::Types::FBAInventoryV1::CreateInventoryItemResponse if typed?
+        parser = -> {
+          require "peddler/types/fba_inventory_v1"
+          Types::FBAInventoryV1::CreateInventoryItemResponse
+        }
         post(path, body:, parser:)
       end
 
@@ -103,7 +109,10 @@ module Peddler
         params = {
           "marketplaceId" => marketplace_id,
         }.compact
-        parser = Peddler::Types::FBAInventoryV1::DeleteInventoryItemResponse if typed?
+        parser = -> {
+          require "peddler/types/fba_inventory_v1"
+          Types::FBAInventoryV1::DeleteInventoryItemResponse
+        }
         delete(path, params:, parser:)
       end
 
@@ -121,15 +130,12 @@ module Peddler
 
         path = "/fba/inventory/v1/items/inventory"
         body = add_inventory_request_body
-        parser = Peddler::Types::FBAInventoryV1::AddInventoryResponse if typed?
+        parser = -> {
+          require "peddler/types/fba_inventory_v1"
+          Types::FBAInventoryV1::AddInventoryResponse
+        }
         post(path, body:, parser:)
       end
-
-      private
-
-      def load_types
-        require "peddler/types/fba_inventory_v1"
-      end
     end
   end
 end

data/lib/peddler/apis/feeds_2021_06_30.rb

@@ -7,8 +7,8 @@ require "peddler/helpers/feeds_2021_06_30"
 
 module Peddler
   class << self
-    def feeds_2021_06_30(...)
-      APIs::Feeds20210630.new(...)
+    def feeds_2021_06_30
+      APIs::Feeds20210630
     end
   end
 
@@ -53,7 +53,10 @@ module Peddler
           "createdUntil" => created_until,
           "nextToken" => next_token,
         }.compact
-        parser = Peddler::Types::Feeds20210630::GetFeedsResponse if typed?
+        parser = -> {
+          require "peddler/types/feeds_2021_06_30"
+          Types::Feeds20210630::GetFeedsResponse
+        }
         meter(rate_limit).get(path, params:, parser:)
       end
 
@@ -65,7 +68,10 @@ module Peddler
       # @return [Peddler::Response] The API response
       def create_feed(body, rate_limit: 0.0083)
         path = "/feeds/2021-06-30/feeds"
-        parser = Peddler::Types::Feeds20210630::CreateFeedResponse if typed?
+        parser = -> {
+          require "peddler/types/feeds_2021_06_30"
+          Types::Feeds20210630::CreateFeedResponse
+        }
         meter(rate_limit).post(path, body:, parser:)
       end
 
@@ -92,7 +98,10 @@ module Peddler
       # @return [Peddler::Response] The API response
       def get_feed(feed_id, rate_limit: 2.0)
         path = "/feeds/2021-06-30/feeds/#{percent_encode(feed_id)}"
-        parser = Peddler::Types::Feeds20210630::Feed if typed?
+        parser = -> {
+          require "peddler/types/feeds_2021_06_30"
+          Types::Feeds20210630::Feed
+        }
         meter(rate_limit).get(path, parser:)
       end
 
@@ -106,7 +115,10 @@ module Peddler
       # @return [Peddler::Response] The API response
       def create_feed_document(body, rate_limit: 0.5)
         path = "/feeds/2021-06-30/documents"
-        parser = Peddler::Types::Feeds20210630::CreateFeedDocumentResponse if typed?
+        parser = -> {
+          require "peddler/types/feeds_2021_06_30"
+          Types::Feeds20210630::CreateFeedDocumentResponse
+        }
         meter(rate_limit).post(path, body:, parser:)
       end
 
@@ -118,15 +130,12 @@ module Peddler
       # @return [Peddler::Response] The API response
       def get_feed_document(feed_document_id, rate_limit: 0.0222)
         path = "/feeds/2021-06-30/documents/#{percent_encode(feed_document_id)}"
-        parser = Peddler::Types::Feeds20210630::FeedDocument if typed?
+        parser = -> {
+          require "peddler/types/feeds_2021_06_30"
+          Types::Feeds20210630::FeedDocument
+        }
         meter(rate_limit).get(path, parser:)
       end
-
-      private
-
-      def load_types
-        require "peddler/types/feeds_2021_06_30"
-      end
     end
   end
 end

data/lib/peddler/apis/finances_2024_06_19.rb

@@ -6,8 +6,8 @@ require "peddler/api"
 
 module Peddler
   class << self
-    def finances_2024_06_19(...)
-      APIs::Finances20240619.new(...)
+    def finances_2024_06_19
+      APIs::Finances20240619
     end
   end
 
@@ -51,15 +51,12 @@ module Peddler
           "transactionStatus" => transaction_status,
           "nextToken" => next_token,
         }.compact
-        parser = Peddler::Types::Finances20240619::ListTransactionsResponse if typed?
+        parser = -> {
+          require "peddler/types/finances_2024_06_19"
+          Types::Finances20240619::ListTransactionsResponse
+        }
         meter(rate_limit).get(path, params:, parser:)
       end
-
-      private
-
-      def load_types
-        require "peddler/types/finances_2024_06_19"
-      end
     end
   end
 end

data/lib/peddler/apis/finances_v0.rb

@@ -6,8 +6,8 @@ require "peddler/api"
 
 module Peddler
   class << self
-    def finances_v0(...)
-      APIs::FinancesV0.new(...)
+    def finances_v0
+      APIs::FinancesV0
     end
   end
 
@@ -47,7 +47,10 @@ module Peddler
           "FinancialEventGroupStartedAfter" => financial_event_group_started_after,
           "NextToken" => next_token,
         }.compact
-        parser = Peddler::Types::FinancesV0::ListFinancialEventGroupsResponse if typed?
+        parser = -> {
+          require "peddler/types/finances_v0"
+          Types::FinancesV0::ListFinancialEventGroupsResponse
+        }
         meter(rate_limit).get(path, params:, parser:)
       end
 
@@ -82,7 +85,10 @@ module Peddler
           "PostedBefore" => posted_before,
           "NextToken" => next_token,
         }.compact
-        parser = Peddler::Types::FinancesV0::ListFinancialEventsResponse if typed?
+        parser = -> {
+          require "peddler/types/finances_v0"
+          Types::FinancesV0::ListFinancialEventsResponse
+        }
         meter(rate_limit).get(path, params:, parser:)
       end
 
@@ -102,7 +108,10 @@ module Peddler
           "MaxResultsPerPage" => max_results_per_page,
           "NextToken" => next_token,
         }.compact
-        parser = Peddler::Types::FinancesV0::ListFinancialEventsResponse if typed?
+        parser = -> {
+          require "peddler/types/finances_v0"
+          Types::FinancesV0::ListFinancialEventsResponse
+        }
         meter(rate_limit).get(path, params:, parser:)
       end
 
@@ -134,15 +143,12 @@ module Peddler
           "PostedBefore" => posted_before,
           "NextToken" => next_token,
         }.compact
-        parser = Peddler::Types::FinancesV0::ListFinancialEventsResponse if typed?
+        parser = -> {
+          require "peddler/types/finances_v0"
+          Types::FinancesV0::ListFinancialEventsResponse
+        }
         meter(rate_limit).get(path, params:, parser:)
       end
-
-      private
-
-      def load_types
-        require "peddler/types/finances_v0"
-      end
     end
   end
 end