peddler 3.0.0.beta1 → 3.0.0

data/lib/peddler/api/feeds_2021_06_30.rb

@@ -3,6 +3,12 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def feeds_2021_06_30(...)
+      API::Feeds20210630.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Feeds
     #
@@ -10,24 +16,26 @@ module Peddler
     class Feeds20210630 < API
       # Returns feed details for the feeds that match the filters that you specify.
       #
-      # @param [Array<String>] feed_types A list of feed types used to filter feeds. When feedTypes is provided, the
+      # @note This operation can make a static sandbox call.
+      # @param feed_types [Array<String>] A list of feed types used to filter feeds. When feedTypes is provided, the
       #   other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also
       #   be provided. Either feedTypes or nextToken is required.
-      # @param [Array<String>] marketplace_ids A list of marketplace identifiers used to filter feeds. The feeds
+      # @param marketplace_ids [Array<String>] A list of marketplace identifiers used to filter feeds. The feeds
       #   returned will match at least one of the marketplaces that you specify.
-      # @param [Integer] page_size The maximum number of feeds to return in a single call.
-      # @param [Array<String>] processing_statuses A list of processing statuses used to filter feeds.
-      # @param [String] created_since The earliest feed creation date and time for feeds included in the response, in
+      # @param page_size [Integer] The maximum number of feeds to return in a single call.
+      # @param processing_statuses [Array<String>] A list of processing statuses used to filter feeds.
+      # @param created_since [String] The earliest feed creation date and time for feeds included in the response, in
       #   ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.
-      # @param [String] created_until The latest feed creation date and time for feeds included in the response, in ISO
+      # @param created_until [String] The latest feed creation date and time for feeds included in the response, in ISO
       #   8601 format. The default is now.
-      # @param [String] next_token A string token returned in the response to your previous request. nextToken is
+      # @param next_token [String] A string token returned in the response to your previous request. nextToken is
       #   returned when the number of results exceeds the specified pageSize value. To get the next page of results,
       #   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
-      def get_feeds(feed_types: nil, marketplace_ids: nil, page_size: nil, processing_statuses: nil,
-        created_since: nil, created_until: nil, next_token: nil)
+      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"
         params = {
           "feedTypes" => feed_types,
@@ -39,17 +47,19 @@ module Peddler
           "nextToken" => next_token,
         }.compact
 
-        rate_limit(0.0222).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Creates a feed. Upload the contents of the feed document before calling this operation.
       #
-      # @param [Hash] body Information required to create the feed.
+      # @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
-      def create_feed(body)
+      def create_feed(body, rate_limit: 0.0083)
         path = "/feeds/2021-06-30/feeds"
 
-        rate_limit(0.0083).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds
@@ -57,24 +67,28 @@ module Peddler
       # [`getFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeed) and
       # [`getFeeds`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeeds) operations.
       #
-      # @param [String] feed_id The identifier for the feed. This identifier is unique only in combination with a seller
+      # @note This operation can make a static sandbox call.
+      # @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
-      def cancel_feed(feed_id)
+      def cancel_feed(feed_id, rate_limit: 2.0)
         path = "/feeds/2021-06-30/feeds/#{feed_id}"
 
-        rate_limit(2.0).delete(path)
+        meter(rate_limit).delete(path)
       end
 
       # Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify.
       #
-      # @param [String] feed_id The identifier for the feed. This identifier is unique only in combination with a seller
+      # @note This operation can make a static sandbox call.
+      # @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
-      def get_feed(feed_id)
+      def get_feed(feed_id, rate_limit: 2.0)
         path = "/feeds/2021-06-30/feeds/#{feed_id}"
 
-        rate_limit(2.0).get(path)
+        meter(rate_limit).get(path)
       end
 
       # Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading
@@ -82,22 +96,26 @@ module Peddler
       # to the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#createfeed)
       # operation.
       #
-      # @param [Hash] body Specifies the content type for the createFeedDocument operation.
+      # @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
-      def create_feed_document(body)
+      def create_feed_document(body, rate_limit: 0.5)
         path = "/feeds/2021-06-30/documents"
 
-        rate_limit(0.5).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Returns the information required for retrieving a feed document's contents.
       #
-      # @param [String] feed_document_id The identifier of the feed document.
+      # @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
-      def get_feed_document(feed_document_id)
+      def get_feed_document(feed_document_id, rate_limit: 0.0222)
         path = "/feeds/2021-06-30/documents/#{feed_document_id}"
 
-        rate_limit(0.0222).get(path)
+        meter(rate_limit).get(path)
       end
     end
   end

data/lib/peddler/api/finances_2024_06_19.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class << self
+    def finances_2024_06_19(...)
+      API::Finances20240619.new(...)
+    end
+  end
+
+  class API
+    # The Selling Partner API for Finances
+    #
+    # The Selling Partner API for Finances provides financial information relevant to a seller's business. You can
+    # obtain financial events for a given order or date range without having to wait until a statement period closes.
+    class Finances20240619 < API
+      # Returns transactions for the given parameters. Orders from the last 48 hours might not be included in financial
+      # events.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param posted_after [String] The response includes financial events posted after (or on) this date. This date
+      #   must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time
+      #   must be more than two minutes before the time of the request.
+      # @param posted_before [String] The response includes financial events posted before (but not on) this date. This
+      #   date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The
+      #   date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If
+      #   `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes
+      #   before the time of the request.
+      # @param marketplace_id [String] The ID of the marketplace from which you want to retrieve transactions.
+      # @param next_token [String] The response includes `nextToken` when the number of results exceeds the specified
+      #   `pageSize` value. 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.
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] 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 = {
+          "postedAfter" => posted_after,
+          "postedBefore" => posted_before,
+          "marketplaceId" => marketplace_id,
+          "nextToken" => next_token,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+    end
+  end
+end

data/lib/peddler/api/finances_v0.rb

@@ -3,31 +3,42 @@
 require "peddler/api"
 
 module Peddler
+  class << self
+    def finances_v0(...)
+      API::FinancesV0.new(...)
+    end
+  end
+
   class API
     # Selling Partner API for Finances
     #
-    # The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You
+    # The Selling Partner API for Finances provides financial information that is 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
+      # Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in
       # financial events.
       #
-      # @param [Integer] max_results_per_page 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 [String] financial_event_group_started_before 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
+      # @note This operation can make a static sandbox call.
+      # @param max_results_per_page [Integer] The maximum number of results per page. If the response exceeds the
+      #   maximum number of transactions or 10 MB, the response is `InvalidInput`.
+      # @param financial_event_group_started_before [String] A date that selects 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 after
+      #   `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If
+      #   `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no
       #   financial event groups are returned.
-      # @param [String] financial_event_group_started_after 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 [String] next_token A string token returned in the response of your previous request.
+      # @param financial_event_group_started_after [String] A date that selects 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 more than two minutes before you submit the request.
+      # @param next_token [String] The response includes `nextToken` when the number of results exceeds the specified
+      #   `pageSize` value. 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.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def list_financial_event_groups(max_results_per_page: nil, financial_event_group_started_before: nil,
-        financial_event_group_started_after: nil, next_token: nil)
+      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,
@@ -36,30 +47,34 @@ module Peddler
           "NextToken" => next_token,
         }.compact
 
-        rate_limit(0.5).get(path, params:)
+        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.
+      # Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be
+      # included in financial events. **Note:** This operation only retrieves a group's data for the past two years. A
+      # request for data spanning more than two years produces an empty response.
       #
-      # @param [Integer] max_results_per_page 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 [String] posted_after 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 [String] posted_before 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 [String] event_group_id The identifier of the financial event group to which the events belong.
-      # @param [String] next_token A string token returned in the response of your previous request.
+      # @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 response is `InvalidInput`.
+      # @param posted_after [String] The response includes financial events posted after (or on) this date. This date
+      #   must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time
+      #   must be more than two minutes before the time of the request.
+      # @param posted_before [String] The response includes financial events posted before (but not on) this date. This
+      #   date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The
+      #   date-time must be later than `PostedAfter` and more than two minutes before the requestd was submitted. If
+      #   `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the
+      #   `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two
+      #   minutes before the time of the request.
+      # @param event_group_id [String] The identifier of the financial event group to which the events belong.
+      # @param next_token [String] The response includes `nextToken` when the number of results exceeds the specified
+      #   `pageSize` value. 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.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def list_financial_events_by_group_id(event_group_id, max_results_per_page: nil, posted_after: nil,
-        posted_before: nil, next_token: nil)
+      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,
@@ -68,44 +83,56 @@ module Peddler
           "NextToken" => next_token,
         }.compact
 
-        rate_limit(0.5).get(path, params:)
+        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
+      # Returns all financial events for the specified order. Orders from the last 48 hours might not be included in
       # financial events.
       #
-      # @param [String] order_id An Amazon-defined order identifier, in 3-7-7 format.
-      # @param [Integer] max_results_per_page 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 [String] next_token A string token returned in the response of your previous request.
+      # @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 response is `InvalidInput`.
+      # @param next_token [String] The response includes `nextToken` when the number of results exceeds the specified
+      #   `pageSize` value. 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.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def list_financial_events_by_order_id(order_id, max_results_per_page: nil, next_token: nil)
+      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
 
-        rate_limit(0.5).get(path, params:)
+        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.
+      # Returns financial events for the specified data range. Orders from the last 48 hours might not be included in
+      # financial events. **Note:** in `ListFinancialEvents`, deferred events don't show up in responses until in they
+      # are released.
       #
-      # @param [Integer] max_results_per_page 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 [String] posted_after 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 [String] posted_before 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 [String] next_token A string token returned in the response of your previous request.
+      # @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 response is `InvalidInput`.
+      # @param posted_after [String] The response includes financial events posted after (or on) this date. This date
+      #   must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time
+      #   must be more than two minutes before the time of the request.
+      # @param posted_before [String] The response includes financial events posted before (but not on) this date. This
+      #   date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The
+      #   date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If
+      #   `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the
+      #   `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two
+      #   minutes before the time of the request.
+      # @param next_token [String] The response includes `nextToken` when the number of results exceeds the specified
+      #   `pageSize` value. 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.
+      # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
-      def list_financial_events(max_results_per_page: nil, posted_after: nil, posted_before: nil, next_token: nil)
+      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,
@@ -114,7 +141,7 @@ module Peddler
           "NextToken" => next_token,
         }.compact
 
-        rate_limit(0.5).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
     end
   end