peddler 3.0.0.beta1 → 4.0.0

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

@@ -3,34 +3,42 @@
 require "peddler/api"
 
 module Peddler
-  class API
-    # Selling Partner API for Reports
+  class << self
+    def reports_2021_06_30(...)
+      APIs::Reports20210630.new(...)
+    end
+  end
+
+  module APIs
+    # Report v2021-06-30
     #
     # The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling
     # partners manage their businesses.
     class Reports20210630 < API
       # Returns report details for the reports that match the filters that you specify.
       #
-      # @param [Array<String>] report_types A list of report types used to filter reports. Refer to [Report Type
+      # @note This operation can make a static sandbox call.
+      # @param report_types [Array<String>] A list of report types used to filter reports. Refer to [Report Type
       #   Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When
       #   reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince,
       #   createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.
-      # @param [Array<String>] processing_statuses A list of processing statuses used to filter reports.
-      # @param [Array<String>] marketplace_ids A list of marketplace identifiers used to filter reports. The reports
+      # @param processing_statuses [Array<String>] A list of processing statuses used to filter reports.
+      # @param marketplace_ids [Array<String>] A list of marketplace identifiers used to filter reports. The reports
       #   returned will match at least one of the marketplaces that you specify.
-      # @param [Integer] page_size The maximum number of reports to return in a single call.
-      # @param [String] created_since The earliest report creation date and time for reports to include in the response,
-      #   in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. The default is 90 days
+      # @param page_size [Integer] The maximum number of reports to return in a single call.
+      # @param created_since [String] The earliest report creation date and time for reports to include in the response,
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} date time format. The default is 90 days
       #   ago. Reports are retained for a maximum of 90 days.
-      # @param [String] created_until The latest report creation date and time for reports to include in the response,
-      #   in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. The default is now.
-      # @param [String] next_token A string token returned in the response to your previous request. `nextToken` is
+      # @param created_until [String] The latest report creation date and time for reports to include in the response,
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} date time format. The default is now.
+      # @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 `getReports` operation and include this token as the only parameter. Specifying `nextToken` with any
       #   other parameters will cause the request to fail.
-      # @return [Hash] The API response
-      def get_reports(report_types: nil, processing_statuses: nil, marketplace_ids: nil, page_size: nil,
-        created_since: nil, created_until: nil, next_token: nil)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_reports(report_types: nil, processing_statuses: nil, marketplace_ids: nil, page_size: 10,
+        created_since: nil, created_until: nil, next_token: nil, rate_limit: 0.0222)
         path = "/reports/2021-06-30/reports"
         params = {
           "reportTypes" => report_types,
@@ -42,97 +50,113 @@ module Peddler
           "nextToken" => next_token,
         }.compact
 
-        rate_limit(0.0222).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Creates a report.
       #
-      # @param [Hash] body Information required to create the report.
-      # @return [Hash] The API response
-      def create_report(body)
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Information required to create the report.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def create_report(body, rate_limit: 0.0167)
         path = "/reports/2021-06-30/reports"
 
-        rate_limit(0.0167).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Cancels the report that you specify. Only reports with `processingStatus=IN_QUEUE` can be cancelled. Cancelled
       # reports are returned in subsequent calls to the `getReport` and `getReports` operations.
       #
-      # @param [String] report_id The identifier for the report. This identifier is unique only in combination with a
+      # @note This operation can make a static sandbox call.
+      # @param report_id [String] The identifier for the report. This identifier is unique only in combination with a
       #   seller ID.
-      # @return [Hash] The API response
-      def cancel_report(report_id)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def cancel_report(report_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/reports/#{report_id}"
 
-        rate_limit(0.0222).delete(path)
+        meter(rate_limit).delete(path)
       end
 
       # Returns report details (including the `reportDocumentId`, if available) for the report that you specify.
       #
-      # @param [String] report_id The identifier for the report. This identifier is unique only in combination with a
+      # @note This operation can make a static sandbox call.
+      # @param report_id [String] The identifier for the report. This identifier is unique only in combination with a
       #   seller ID.
-      # @return [Hash] The API response
-      def get_report(report_id)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_report(report_id, rate_limit: 2.0)
         path = "/reports/2021-06-30/reports/#{report_id}"
 
-        rate_limit(2.0).get(path)
+        meter(rate_limit).get(path)
       end
 
       # Returns report schedule details that match the filters that you specify.
       #
-      # @param [Array<String>] report_types A list of report types used to filter report schedules. Refer to [Report
+      # @note This operation can make a static sandbox call.
+      # @param report_types [Array<String>] A list of report types used to filter report schedules. Refer to [Report
       #   Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.
-      # @return [Hash] The API response
-      def get_report_schedules(report_types)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_report_schedules(report_types, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules"
         params = {
           "reportTypes" => report_types,
         }.compact
 
-        rate_limit(0.0222).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
 
       # Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it
       # will be cancelled and replaced with this one.
       #
-      # @param [Hash] body Information required to create the report schedule.
-      # @return [Hash] The API response
-      def create_report_schedule(body)
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Information required to create the report schedule.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def create_report_schedule(body, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules"
 
-        rate_limit(0.0222).post(path, body:)
+        meter(rate_limit).post(path, body:)
       end
 
       # Cancels the report schedule that you specify.
       #
-      # @param [String] report_schedule_id The identifier for the report schedule. This identifier is unique only in
+      # @note This operation can make a static sandbox call.
+      # @param report_schedule_id [String] The identifier for the report schedule. This identifier is unique only in
       #   combination with a seller ID.
-      # @return [Hash] The API response
-      def cancel_report_schedule(report_schedule_id)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def cancel_report_schedule(report_schedule_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules/#{report_schedule_id}"
 
-        rate_limit(0.0222).delete(path)
+        meter(rate_limit).delete(path)
       end
 
       # Returns report schedule details for the report schedule that you specify.
       #
-      # @param [String] report_schedule_id The identifier for the report schedule. This identifier is unique only in
+      # @note This operation can make a static sandbox call.
+      # @param report_schedule_id [String] The identifier for the report schedule. This identifier is unique only in
       #   combination with a seller ID.
-      # @return [Hash] The API response
-      def get_report_schedule(report_schedule_id)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_report_schedule(report_schedule_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules/#{report_schedule_id}"
 
-        rate_limit(0.0222).get(path)
+        meter(rate_limit).get(path)
       end
 
       # Returns the information required for retrieving a report document's contents.
       #
-      # @param [String] report_document_id The identifier for the report document.
-      # @return [Hash] The API response
-      def get_report_document(report_document_id)
+      # @note This operation can make a static sandbox call.
+      # @param report_document_id [String] The identifier for the report document.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_report_document(report_document_id, rate_limit: 0.0167)
         path = "/reports/2021-06-30/documents/#{report_document_id}"
 
-        rate_limit(0.0167).get(path)
+        meter(rate_limit).get(path)
       end
     end
   end

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

@@ -3,52 +3,60 @@
 require "peddler/api"
 
 module Peddler
-  class API
+  class << self
+    def sales_v1(...)
+      APIs::SalesV1.new(...)
+    end
+  end
+
+  module APIs
     # Selling Partner API for Sales
     #
     # The Selling Partner API for Sales provides APIs related to sales performance.
     class SalesV1 < API
       # Returns aggregated order metrics for given interval, broken down by granularity, for given buyer type.
       #
-      # @param [Array<String>] marketplace_ids A marketplace identifier. This specifies the marketplace in which the
+      # @note This operation can make a static sandbox call.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
       #   order was placed. Only one marketplace can be specified. For example, ATVPDKIKX0DER indicates the US
       #   marketplace.
-      # @param [String] interval A time interval used for selecting order metrics. This takes the form of two dates
+      # @param interval [String] A time interval used for selecting order metrics. This takes the form of two dates
       #   separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and
       #   must represent absolute time (either Z notation or offset notation). Example:
       #   2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the
       #   -07:00 zone.
-      # @param [String] granularity_time_zone An IANA-compatible time zone for determining the day boundary. Required
+      # @param granularity_time_zone [String] An IANA-compatible time zone for determining the day boundary. Required
       #   when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the
       #   offset of the specified interval value. For example, if the interval value uses Z notation, then
       #   granularityTimeZone must be UTC. If the interval value uses an offset, then granularityTimeZone must be an
       #   IANA-compatible time zone that matches the offset. Example: US/Pacific to compute day boundaries, accounting
       #   for daylight time savings, for US/Pacific zone.
-      # @param [String] granularity The granularity of the grouping of order metrics, based on a unit of time.
+      # @param granularity [String] The granularity of the grouping of order metrics, based on a unit of time.
       #   Specifying granularity=Hour results in a successful request only if the interval specified is less than or
       #   equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2
       #   years from now. Specifying granularity=Total results in order metrics that are aggregated over the entire
       #   interval that you specify. If the interval start and end date don’t align with the specified granularity, the
       #   head and tail end of the response interval will contain partial data. Example: Day to get a daily breakdown of
       #   the request interval, where the day boundary is defined by the granularityTimeZone.
-      # @param [String] buyer_type Filters the results by the buyer type that you specify, B2B (business to business) or
+      # @param buyer_type [String] Filters the results by the buyer type that you specify, B2B (business to business) or
       #   B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B
       #   buyers.
-      # @param [String] fulfillment_network Filters the results by the fulfillment network that you specify, MFN
+      # @param fulfillment_network [String] Filters the results by the fulfillment network that you specify, MFN
       #   (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the
       #   response to include order metrics for all fulfillment networks. Example: AFN, if you want the response to
       #   include order metrics for only Amazon fulfillment network.
-      # @param [String] first_day_of_week Specifies the day that the week starts on when granularity=Week, either Monday
+      # @param first_day_of_week [String] Specifies the day that the week starts on when granularity=Week, either Monday
       #   or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
-      # @param [String] asin Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an
+      # @param asin [String] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an
       #   error. Do not include this filter if you want the response to include order metrics for all ASINs. Example:
       #   B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
-      # @param [String] sku Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an
+      # @param sku [String] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an
       #   error. Do not include this filter if you want the response to include order metrics for all SKUs. Example:
       #   TestSKU, if you want the response to include order metrics for only SKU TestSKU.
-      # @return [Hash] The API response
-      def get_order_metrics(marketplace_ids, interval, granularity, granularity_time_zone: nil, buyer_type: nil,
-        fulfillment_network: nil, first_day_of_week: nil, asin: nil, sku: nil)
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_order_metrics(marketplace_ids, interval, granularity, granularity_time_zone: nil, buyer_type: "All",
+        fulfillment_network: nil, first_day_of_week: "Monday", asin: nil, sku: nil, rate_limit: 0.5)
         path = "/sales/v1/orderMetrics"
         params = {
           "marketplaceIds" => marketplace_ids,
@@ -62,7 +70,7 @@ module Peddler
           "sku" => sku,
         }.compact
 
-        rate_limit(0.5).get(path, params:)
+        meter(rate_limit).get(path, params:)
       end
     end
   end

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

@@ -3,7 +3,13 @@
 require "peddler/api"
 
 module Peddler
-  class API
+  class << self
+    def sellers_v1(...)
+      APIs::SellersV1.new(...)
+    end
+  end
+
+  module APIs
     # Selling Partner API for Sellers
     #
     # The [Selling Partner API for Sellers](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference)
@@ -14,19 +20,25 @@ module Peddler
     class SellersV1 < API
       # Returns a list of marketplaces where the seller can list items and information about the seller's participation
       # in those marketplaces.
-      # @return [Hash] The API response
-      def get_marketplace_participations
+      #
+      # @note This operation can make a static sandbox call.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_marketplace_participations(rate_limit: 0.016)
         path = "/sellers/v1/marketplaceParticipations"
 
-        rate_limit(0.016).get(path)
+        meter(rate_limit).get(path)
       end
 
       # Returns information about a seller account and its marketplaces.
-      # @return [Hash] The API response
-      def get_account
+      #
+      # @note This operation can make a static sandbox call.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_account(rate_limit: 0.016)
         path = "/sellers/v1/account"
 
-        rate_limit(0.016).get(path)
+        meter(rate_limit).get(path)
       end
     end
   end