peddler 4.5.0 → 4.6.1

data/lib/peddler/apis/product_pricing_2022_05_01.rb

@@ -13,8 +13,12 @@ module Peddler
     # Selling Partner API for Pricing
     #
     # The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing
-    # information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use
-    # Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+    # information for Amazon Marketplace products.
+    #
+    # For more information, refer to the [Product Pricing v2022-05-01 Use Case
+    # Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+    #
+    # @see https://github.com/amzn/selling-partner-api-models/blob/main/models/productPricing_2022-05-01.json
     class ProductPricing20220501 < API
       # Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request
       # body. The response for each successful (HTTP status code 200) request in the set includes the computed listing
@@ -32,8 +36,8 @@ module Peddler
         rate_limit: 0.033)
         path = "/batches/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice"
         body = get_featured_offer_expected_price_batch_request_body
-
-        meter(rate_limit).post(path, body:)
+        parser = Peddler::Types::ProductPricing20220501::GetFeaturedOfferExpectedPriceBatchResponse if typed?
+        meter(rate_limit).post(path, body:, parser:)
       end
 
       # Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId`
@@ -46,8 +50,14 @@ module Peddler
       def get_competitive_summary(requests, rate_limit: 0.033)
         path = "/batches/products/pricing/2022-05-01/items/competitiveSummary"
         body = requests
+        parser = Peddler::Types::ProductPricing20220501::CompetitiveSummaryBatchResponse if typed?
+        meter(rate_limit).post(path, body:, parser:)
+      end
+
+      private
 
-        meter(rate_limit).post(path, body:)
+      def load_types
+        require "peddler/types/product_pricing_2022_05_01"
       end
     end
   end

data/lib/peddler/apis/product_pricing_v0.rb

@@ -14,10 +14,13 @@ module Peddler
     #
     # The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for
     # Amazon Marketplace products.
+    #
+    # @see https://github.com/amzn/selling-partner-api-models/blob/main/models/productPricingV0.json
     class ProductPricingV0 < API
-      # Returns pricing information for a seller's offer listings based on seller SKU or ASIN. **Note:** The parameters
-      # associated with this operation may contain special characters that require URL encoding to call the API. To
-      # avoid errors with SKUs when encoding URLs, refer to [URL
+      # Returns pricing information for a seller's offer listings based on seller SKU or ASIN.
+      #
+      # **Note:** The parameters associated with this operation may contain special characters that require URL encoding
+      # to call the API. To avoid errors with SKUs when encoding URLs, refer to [URL
       # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).
       #
       # @note This operation can make a static sandbox call.
@@ -48,13 +51,14 @@ module Peddler
           "ItemCondition" => item_condition,
           "OfferType" => offer_type,
         }.compact
-
-        meter(rate_limit).get(path, params:)
+        parser = Peddler::Types::ProductPricingV0::GetPricingResponse if typed?
+        meter(rate_limit).get(path, params:, parser:)
       end
 
-      # Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN. **Note:** The
-      # parameters associated with this operation may contain special characters that require URL encoding to call the
-      # API. To avoid errors with SKUs when encoding URLs, refer to [URL
+      # Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN.
+      #
+      # **Note:** The parameters associated with this operation may contain special characters that require URL encoding
+      # to call the API. To avoid errors with SKUs when encoding URLs, refer to [URL
       # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).
       #
       # @note This operation can make a static sandbox call.
@@ -81,13 +85,15 @@ module Peddler
           "ItemType" => item_type,
           "CustomerType" => customer_type,
         }.compact
-
-        meter(rate_limit).get(path, params:)
+        parser = Peddler::Types::ProductPricingV0::GetPricingResponse if typed?
+        meter(rate_limit).get(path, params:, parser:)
       end
 
-      # Returns the lowest priced offers for a single SKU listing. **Note:** The parameters associated with this
-      # operation may contain special characters that require URL encoding to call the API. To avoid errors with SKUs
-      # when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).
+      # Returns the lowest priced offers for a single SKU listing.
+      #
+      # **Note:** The parameters associated with this operation may contain special characters that require URL encoding
+      # to call the API. To avoid errors with SKUs when encoding URLs, refer to [URL
+      # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).
       #
       # @note This operation can make a static sandbox call.
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which prices are
@@ -106,8 +112,8 @@ module Peddler
           "ItemCondition" => item_condition,
           "CustomerType" => customer_type,
         }.compact
-
-        meter(rate_limit).get(path, params:)
+        parser = Peddler::Types::ProductPricingV0::GetOffersResponse if typed?
+        meter(rate_limit).get(path, params:, parser:)
       end
 
       # Returns the lowest priced offers for a single item based on ASIN.
@@ -128,8 +134,8 @@ module Peddler
           "ItemCondition" => item_condition,
           "CustomerType" => customer_type,
         }.compact
-
-        meter(rate_limit).get(path, params:)
+        parser = Peddler::Types::ProductPricingV0::GetOffersResponse if typed?
+        meter(rate_limit).get(path, params:, parser:)
       end
 
       # Returns the lowest priced offers for a batch of items based on ASIN.
@@ -141,8 +147,8 @@ module Peddler
       def get_item_offers_batch(get_item_offers_batch_request_body, rate_limit: 0.1)
         path = "/batches/products/pricing/v0/itemOffers"
         body = get_item_offers_batch_request_body
-
-        meter(rate_limit).post(path, body:)
+        parser = Peddler::Types::ProductPricingV0::GetItemOffersBatchResponse if typed?
+        meter(rate_limit).post(path, body:, parser:)
       end
 
       # Returns the lowest priced offers for a batch of listings by SKU.
@@ -155,8 +161,14 @@ module Peddler
       def get_listing_offers_batch(get_listing_offers_batch_request_body, rate_limit: 0.5)
         path = "/batches/products/pricing/v0/listingOffers"
         body = get_listing_offers_batch_request_body
+        parser = Peddler::Types::ProductPricingV0::GetListingOffersBatchResponse if typed?
+        meter(rate_limit).post(path, body:, parser:)
+      end
+
+      private
 
-        meter(rate_limit).post(path, body:)
+      def load_types
+        require "peddler/types/product_pricing_v0"
       end
     end
   end

data/lib/peddler/apis/product_type_definitions_2020_09_01.rb

@@ -15,9 +15,12 @@ module Peddler
     # The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data
     # requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type
     # that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the
-    # Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For
-    # more information, see the {https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide Product
-    # Type Definitions API Use Case Guide}.
+    # Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds).
+    #
+    # For more information, see the {https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide
+    # Product Type Definitions API Use Case Guide}.
+    #
+    # @see https://github.com/amzn/selling-partner-api-models/blob/main/models/definitionsProductTypes_2020-09-01.json
     class ProductTypeDefinitions20200901 < API
       # Search for and return a list of Amazon product types that have definitions available.
       #
@@ -43,8 +46,8 @@ module Peddler
           "locale" => locale,
           "searchLocale" => search_locale,
         }.compact
-
-        meter(rate_limit).get(path, params:)
+        parser = Peddler::Types::ProductTypeDefinitions20200901::ProductTypeList if typed?
+        meter(rate_limit).get(path, params:, parser:)
       end
 
       # Retrieve an Amazon product type definition.
@@ -78,8 +81,14 @@ module Peddler
           "requirementsEnforced" => requirements_enforced,
           "locale" => locale,
         }.compact
+        parser = Peddler::Types::ProductTypeDefinitions20200901::ProductTypeDefinition if typed?
+        meter(rate_limit).get(path, params:, parser:)
+      end
+
+      private
 
-        meter(rate_limit).get(path, params:)
+      def load_types
+        require "peddler/types/product_type_definitions_2020_09_01"
       end
     end
   end

data/lib/peddler/apis/replenishment_2022_11_07.rb

@@ -14,8 +14,12 @@ module Peddler
     #
     # The Selling Partner API for Replenishment (Replenishment API) provides programmatic access to replenishment
     # program metrics and offers. These programs provide recurring delivery of any replenishable item at a frequency
-    # chosen by the customer. The Replenishment API is available worldwide wherever Amazon Subscribe & Save is available
-    # or is supported. The API is available to vendors and FBA selling partners.
+    # chosen by the customer.
+    #
+    # The Replenishment API is available worldwide wherever Amazon Subscribe & Save is available or is supported. The
+    # API is available to vendors and FBA selling partners.
+    #
+    # @see https://github.com/amzn/selling-partner-api-models/blob/main/models/replenishment-2022-11-07.json
     class Replenishment20221107 < API
       # Returns aggregated replenishment program metrics for a selling partner.
       #
@@ -25,8 +29,8 @@ module Peddler
       # @return [Peddler::Response] The API response
       def get_selling_partner_metrics(body: nil, rate_limit: 1.0)
         path = "/replenishment/2022-11-07/sellingPartners/metrics/search"
-
-        meter(rate_limit).post(path, body:)
+        parser = Peddler::Types::Replenishment20221107::GetSellingPartnerMetricsResponse if typed?
+        meter(rate_limit).post(path, body:, parser:)
       end
 
       # Returns aggregated replenishment program metrics for a selling partner's offers.
@@ -37,8 +41,8 @@ module Peddler
       # @return [Peddler::Response] The API response
       def list_offer_metrics(body: nil, rate_limit: 1.0)
         path = "/replenishment/2022-11-07/offers/metrics/search"
-
-        meter(rate_limit).post(path, body:)
+        parser = Peddler::Types::Replenishment20221107::ListOfferMetricsResponse if typed?
+        meter(rate_limit).post(path, body:, parser:)
       end
 
       # Returns the details of a selling partner's replenishment program offers.
@@ -49,8 +53,14 @@ module Peddler
       # @return [Peddler::Response] The API response
       def list_offers(body: nil, rate_limit: 1.0)
         path = "/replenishment/2022-11-07/offers/search"
+        parser = Peddler::Types::Replenishment20221107::ListOffersResponse if typed?
+        meter(rate_limit).post(path, body:, parser:)
+      end
+
+      private
 
-        meter(rate_limit).post(path, body:)
+      def load_types
+        require "peddler/types/replenishment_2022_11_07"
       end
     end
   end

data/lib/peddler/apis/reports_2021_06_30.rb

@@ -15,6 +15,8 @@ module Peddler
     #
     # The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling
     # partners manage their businesses.
+    #
+    # @see https://github.com/amzn/selling-partner-api-models/blob/main/models/reports_2021-06-30.json
     class Reports20210630 < API
       include Peddler::Helpers::Reports20210630
 
@@ -52,8 +54,8 @@ module Peddler
           "createdUntil" => created_until,
           "nextToken" => next_token,
         }.compact
-
-        meter(rate_limit).get(path, params:)
+        parser = Peddler::Types::Reports20210630::GetReportsResponse if typed?
+        meter(rate_limit).get(path, params:, parser:)
       end
 
       # Creates a report.
@@ -64,8 +66,8 @@ module Peddler
       # @return [Peddler::Response] The API response
       def create_report(body, rate_limit: 0.0167)
         path = "/reports/2021-06-30/reports"
-
-        meter(rate_limit).post(path, body:)
+        parser = Peddler::Types::Reports20210630::CreateReportResponse if typed?
+        meter(rate_limit).post(path, body:, parser:)
       end
 
       # Cancels the report that you specify. Only reports with `processingStatus=IN_QUEUE` can be cancelled. Cancelled
@@ -78,7 +80,6 @@ module Peddler
       # @return [Peddler::Response] The API response
       def cancel_report(report_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/reports/#{percent_encode(report_id)}"
-
         meter(rate_limit).delete(path)
       end
 
@@ -91,8 +92,8 @@ module Peddler
       # @return [Peddler::Response] The API response
       def get_report(report_id, rate_limit: 2.0)
         path = "/reports/2021-06-30/reports/#{percent_encode(report_id)}"
-
-        meter(rate_limit).get(path)
+        parser = Peddler::Types::Reports20210630::Report if typed?
+        meter(rate_limit).get(path, parser:)
       end
 
       # Returns report schedule details that match the filters that you specify.
@@ -107,8 +108,8 @@ module Peddler
         params = {
           "reportTypes" => stringify_array(report_types),
         }.compact
-
-        meter(rate_limit).get(path, params:)
+        parser = Peddler::Types::Reports20210630::ReportScheduleList if typed?
+        meter(rate_limit).get(path, params:, parser:)
       end
 
       # Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it
@@ -120,8 +121,8 @@ module Peddler
       # @return [Peddler::Response] The API response
       def create_report_schedule(body, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules"
-
-        meter(rate_limit).post(path, body:)
+        parser = Peddler::Types::Reports20210630::CreateReportScheduleResponse if typed?
+        meter(rate_limit).post(path, body:, parser:)
       end
 
       # Cancels the report schedule that you specify.
@@ -133,7 +134,6 @@ module Peddler
       # @return [Peddler::Response] The API response
       def cancel_report_schedule(report_schedule_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules/#{percent_encode(report_schedule_id)}"
-
         meter(rate_limit).delete(path)
       end
 
@@ -146,8 +146,8 @@ module Peddler
       # @return [Peddler::Response] The API response
       def get_report_schedule(report_schedule_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules/#{percent_encode(report_schedule_id)}"
-
-        meter(rate_limit).get(path)
+        parser = Peddler::Types::Reports20210630::ReportSchedule if typed?
+        meter(rate_limit).get(path, parser:)
       end
 
       # Returns the information required for retrieving a report document's contents.
@@ -158,8 +158,14 @@ module Peddler
       # @return [Peddler::Response] The API response
       def get_report_document(report_document_id, rate_limit: 0.0167)
         path = "/reports/2021-06-30/documents/#{percent_encode(report_document_id)}"
+        parser = Peddler::Types::Reports20210630::ReportDocument if typed?
+        meter(rate_limit).get(path, parser:)
+      end
+
+      private
 
-        meter(rate_limit).get(path)
+      def load_types
+        require "peddler/types/reports_2021_06_30"
       end
     end
   end

data/lib/peddler/apis/sales_v1.rb

@@ -13,6 +13,8 @@ module Peddler
     # Selling Partner API for Sales
     #
     # The Selling Partner API for Sales provides APIs related to sales performance.
+    #
+    # @see https://github.com/amzn/selling-partner-api-models/blob/main/models/sales.json
     class SalesV1 < API
       # Returns aggregated order metrics for given interval, broken down by granularity, for given buyer type.
       #
@@ -74,8 +76,14 @@ module Peddler
           "sku" => sku,
           "amazonProgram" => amazon_program,
         }.compact
+        parser = Peddler::Types::SalesV1::GetOrderMetricsResponse if typed?
+        meter(rate_limit).get(path, params:, parser:)
+      end
+
+      private
 
-        meter(rate_limit).get(path, params:)
+      def load_types
+        require "peddler/types/sales_v1"
       end
     end
   end