peddler 3.0.0 → 4.0.1

data/lib/peddler/{api → apis}/easy_ship_2022_03_23.rb

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def easy_ship_2022_03_23(...)
-      API::EasyShip20220323.new(...)
+      APIs::EasyShip20220323.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Easy Ship
     #
     # The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy
@@ -30,7 +30,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param list_handover_slots_request [Hash] The request schema for the `listHandoverSlots` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_handover_slots(list_handover_slots_request: nil, rate_limit: 1.0)
         path = "/easyShip/2022-03-23/timeSlot"
         body = list_handover_slots_request
@@ -46,7 +46,7 @@ module Peddler
       #   to deliver using Amazon Easy Ship.
       # @param marketplace_id [String] An identifier for the marketplace in which the seller is selling.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_scheduled_package(amazon_order_id, marketplace_id, rate_limit: 1.0)
         path = "/easyShip/2022-03-23/package"
         params = {
@@ -71,7 +71,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param create_scheduled_package_request [Hash] The request schema for the `createScheduledPackage` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_scheduled_package(create_scheduled_package_request, rate_limit: 1.0)
         path = "/easyShip/2022-03-23/package"
         body = create_scheduled_package_request
@@ -88,7 +88,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param update_scheduled_packages_request [Hash] The request schema for the `updateScheduledPackages` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_scheduled_packages(update_scheduled_packages_request: nil, rate_limit: 1.0)
         path = "/easyShip/2022-03-23/package"
         body = update_scheduled_packages_request
@@ -96,26 +96,25 @@ module Peddler
         meter(rate_limit).patch(path, body:)
       end
 
-      # This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the
-      # associated shipping labels, along with other compliance documents according to the marketplace (refer to the
-      # {https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table
-      # marketplace document support table}). Developers calling this operation may optionally assign a `packageDetails`
-      # object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will
-      # try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time
-      # slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label's file
-      # format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly.
-      # This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file
-      # containing the generated shipping labels and the other documents enabled for your marketplace. If at least an
-      # order couldn't be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an
-      # entry for each order we couldn't process. Each entry is composed of an error message describing the reason of
-      # the failure, so that sellers can take action. The table below displays the supported request and burst maximum
-      # rates:
+      # This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the
+      # associated shipping labels and compliance documents based on the marketplace. For more information, refer to the
+      # [marketplace support
+      # table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table).
+      # You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your
+      # request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you
+      # don't specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your
+      # shipping label's file format and Amazon creates the label accordingly. This operation returns an array that
+      # contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file
+      # includes the generated shipping labels and any other documents that are required for your marketplace. If an
+      # order can't be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry
+      # for each order that could not be processed. Each entry contains an error message that describes the reason for
+      # the failure. The following table contains the supported request and burst maximum rates:
       #
       # @note This operation can make a static sandbox call.
       # @param create_scheduled_packages_request [Hash] The request schema for the `createScheduledPackageBulk`
       #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_scheduled_package_bulk(create_scheduled_packages_request, rate_limit: 1.0)
         path = "/easyShip/2022-03-23/packages/bulk"
         body = create_scheduled_packages_request

data/lib/peddler/{api → apis}/fba_inbound_eligibility_v1.rb

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def fba_inbound_eligibility_v1(...)
-      API::FBAInboundEligibilityV1.new(...)
+      APIs::FBAInboundEligibilityV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for FBA Inbound Eligibilty
     #
     # With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for
@@ -28,7 +28,7 @@ module Peddler
       # @param asin [String] The ASIN of the item for which you want an eligibility preview.
       # @param program [String] The program that you want to check eligibility against.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_item_eligibility_preview(asin, program, marketplace_ids: nil, rate_limit: 1.0)
         path = "/fba/inbound/v1/eligibility/itemPreview"
         params = {

data/lib/peddler/{api → apis}/fba_inventory_v1.rb

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def fba_inventory_v1(...)
-      API::FBAInventoryV1.new(...)
+      APIs::FBAInventoryV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for FBA Inventory
     #
     # The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in
@@ -44,7 +44,7 @@ module Peddler
       # @param marketplace_ids [Array<String>] The marketplace ID for the marketplace for which to return inventory
       #   summaries.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_inventory_summaries(granularity_type, granularity_id, marketplace_ids, details: nil, start_date_time: nil,
         seller_skus: nil, seller_sku: nil, next_token: nil, rate_limit: 2.0)
         path = "/fba/inventory/v1/summaries"
@@ -69,7 +69,7 @@ module Peddler
       # @note This operation can make a dynamic sandbox call.
       # @param create_inventory_item_request_body [Hash] CreateInventoryItem Request Body Parameter.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_inventory_item(create_inventory_item_request_body, rate_limit: nil)
         must_sandbox!
 
@@ -87,7 +87,7 @@ module Peddler
       # @param seller_sku [String] A single seller SKU used for querying the specified seller SKU inventory summaries.
       # @param marketplace_id [String] The marketplace ID for the marketplace for which the sellerSku is to be deleted.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def delete_inventory_item(seller_sku, marketplace_id, rate_limit: nil)
         must_sandbox!
 
@@ -108,7 +108,7 @@ module Peddler
       # @param x_amzn_idempotency_token [String] A unique token/requestId provided with each call to ensure idempotency.
       # @param add_inventory_request_body [Hash] List of items to add to Sandbox inventory.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def add_inventory(x_amzn_idempotency_token, add_inventory_request_body, rate_limit: nil)
         must_sandbox!
 

data/lib/peddler/{api → apis}/feeds_2021_06_30.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
 require "peddler/api"
+require "peddler/helpers/feeds_2021_06_30"
 
 module Peddler
   class << self
     def feeds_2021_06_30(...)
-      API::Feeds20210630.new(...)
+      APIs::Feeds20210630.new(...)
     end
   end
 
-  class API
-    # Selling Partner API for Feeds
+  module APIs
+    # Feeds v2021-06-30
     #
     # The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
     class Feeds20210630 < API
+      include Peddler::Helpers::Feeds20210630
+
       # Returns feed details for the feeds that match the filters that you specify.
       #
       # @note This operation can make a static sandbox call.
@@ -33,7 +36,7 @@ module Peddler
       #   call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other
       #   parameters will cause the request to fail.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_feeds(feed_types: nil, marketplace_ids: nil, page_size: 10, processing_statuses: nil, created_since: nil,
         created_until: nil, next_token: nil, rate_limit: 0.0222)
         path = "/feeds/2021-06-30/feeds"
@@ -55,7 +58,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] Information required to create the feed.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_feed(body, rate_limit: 0.0083)
         path = "/feeds/2021-06-30/feeds"
 
@@ -71,7 +74,7 @@ module Peddler
       # @param feed_id [String] The identifier for the feed. This identifier is unique only in combination with a seller
       #   ID.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def cancel_feed(feed_id, rate_limit: 2.0)
         path = "/feeds/2021-06-30/feeds/#{feed_id}"
 
@@ -84,7 +87,7 @@ module Peddler
       # @param feed_id [String] The identifier for the feed. This identifier is unique only in combination with a seller
       #   ID.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_feed(feed_id, rate_limit: 2.0)
         path = "/feeds/2021-06-30/feeds/#{feed_id}"
 
@@ -99,7 +102,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] Specifies the content type for the createFeedDocument operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_feed_document(body, rate_limit: 0.5)
         path = "/feeds/2021-06-30/documents"
 
@@ -111,7 +114,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param feed_document_id [String] The identifier of the feed document.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_feed_document(feed_document_id, rate_limit: 0.0222)
         path = "/feeds/2021-06-30/documents/#{feed_document_id}"
 

data/lib/peddler/{api → apis}/finances_2024_06_19.rb

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def finances_2024_06_19(...)
-      API::Finances20240619.new(...)
+      APIs::Finances20240619.new(...)
     end
   end
 
-  class API
+  module APIs
     # The Selling Partner API for Finances
     #
     # The Selling Partner API for Finances provides financial information relevant to a seller's business. You can
@@ -33,7 +33,7 @@ module Peddler
       #   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.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_transactions(posted_after, posted_before: nil, marketplace_id: nil, next_token: nil, rate_limit: 0.5)
         path = "/finances/2024-06-19/transactions"
         params = {

data/lib/peddler/apis/finances_v0.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class << self
+    def finances_v0(...)
+      APIs::FinancesV0.new(...)
+    end
+  end
+
+  module APIs
+    # Selling Partner API for Finances
+    #
+    # The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You
+    # can obtain financial events for a given order, financial event group, or date range without having to wait until a
+    # statement period closes. You can also obtain financial event groups for a given date range.
+    class FinancesV0 < API
+      # Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your
+      # financial events.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param max_results_per_page [Integer] The maximum number of results to return per page. If the response exceeds
+      #   the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.
+      # @param financial_event_group_started_before [String] A date used for selecting financial event groups that
+      #   opened before (but not at) a specified date and time, in [ISO
+      #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than
+      #   FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If
+      #   FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no
+      #   financial event groups are returned.
+      # @param financial_event_group_started_after [String] A date used for selecting financial event groups that opened
+      #   after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601)
+      #   format. The date-time must be no later than two minutes before the request was submitted.
+      # @param next_token [String] A string token returned in the response of your previous request.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def list_financial_event_groups(max_results_per_page: 10, financial_event_group_started_before: nil,
+        financial_event_group_started_after: nil, next_token: nil, rate_limit: 0.5)
+        path = "/finances/v0/financialEventGroups"
+        params = {
+          "MaxResultsPerPage" => max_results_per_page,
+          "FinancialEventGroupStartedBefore" => financial_event_group_started_before,
+          "FinancialEventGroupStartedAfter" => financial_event_group_started_after,
+          "NextToken" => next_token,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to
+      # appear in your financial events. **Note:** This operation will only retrieve group's data for the past two
+      # years. If a request is submitted for data spanning more than two years, an empty response is returned.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param max_results_per_page [Integer] The maximum number of results to return per page. If the response exceeds
+      #   the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.
+      # @param posted_after [String] A date used for selecting financial events posted after (or at) a specified time.
+      #   The date-time **must** be more than two minutes before the time of the request, in [ISO
+      #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
+      # @param posted_before [String] A date used for selecting financial events posted before (but not at) a specified
+      #   time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was
+      #   submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If
+      #   `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must
+      #   specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two
+      #   minutes.
+      # @param event_group_id [String] The identifier of the financial event group to which the events belong.
+      # @param next_token [String] A string token returned in the response of your previous request.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def list_financial_events_by_group_id(event_group_id, max_results_per_page: 100, posted_after: nil,
+        posted_before: nil, next_token: nil, rate_limit: 0.5)
+        path = "/finances/v0/financialEventGroups/#{event_group_id}/financialEvents"
+        params = {
+          "MaxResultsPerPage" => max_results_per_page,
+          "PostedAfter" => posted_after,
+          "PostedBefore" => posted_before,
+          "NextToken" => next_token,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your
+      # financial events.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
+      # @param max_results_per_page [Integer] The maximum number of results to return per page. If the response exceeds
+      #   the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.
+      # @param next_token [String] A string token returned in the response of your previous request.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def list_financial_events_by_order_id(order_id, max_results_per_page: 100, next_token: nil, rate_limit: 0.5)
+        path = "/finances/v0/orders/#{order_id}/financialEvents"
+        params = {
+          "MaxResultsPerPage" => max_results_per_page,
+          "NextToken" => next_token,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your
+      # financial events. **Note:** in `ListFinancialEvents`, deferred events don't show up in responses until in they
+      # are released.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param max_results_per_page [Integer] The maximum number of results to return per page. If the response exceeds
+      #   the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.
+      # @param posted_after [String] A date used for selecting financial events posted after (or at) a specified time.
+      #   The date-time must be no later than two minutes before the request was submitted, in [ISO
+      #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
+      # @param posted_before [String] A date used for selecting financial events posted before (but not at) a specified
+      #   time. The date-time must be later than PostedAfter and no later than two minutes before the request was
+      #   submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If
+      #   PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify
+      #   the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
+      # @param next_token [String] A string token returned in the response of your previous request.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def list_financial_events(max_results_per_page: 100, posted_after: nil, posted_before: nil, next_token: nil,
+        rate_limit: 0.5)
+        path = "/finances/v0/financialEvents"
+        params = {
+          "MaxResultsPerPage" => max_results_per_page,
+          "PostedAfter" => posted_after,
+          "PostedBefore" => posted_before,
+          "NextToken" => next_token,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+    end
+  end
+end