peddler 3.0.0 → 4.0.1

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

@@ -5,12 +5,12 @@ require "peddler/api"
 module Peddler
   class << self
     def orders_v0(...)
-      API::OrdersV0.new(...)
+      APIs::OrdersV0.new(...)
     end
   end
 
-  class API
-    # Selling Partner API for Orders
+  module APIs
+    # Orders v0
     #
     # Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop
     # fast, flexible, and custom applications to manage order synchronization, perform order research, and create
@@ -110,7 +110,7 @@ module Peddler
       #   at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601)
       #   format.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_orders(marketplace_ids, created_after: nil, created_before: nil, last_updated_after: nil,
         last_updated_before: nil, order_statuses: nil, fulfillment_channels: nil, payment_methods: nil,
         buyer_email: nil, seller_order_id: nil, max_results_per_page: nil, easy_ship_shipment_statuses: nil,
@@ -152,7 +152,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_order(order_id, rate_limit: 0.5)
         path = "/orders/v0/orders/#{order_id}"
 
@@ -164,7 +164,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param order_id [String] An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_order_buyer_info(order_id, rate_limit: 0.5)
         path = "/orders/v0/orders/#{order_id}/buyerInfo"
 
@@ -176,7 +176,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param order_id [String] An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_order_address(order_id, rate_limit: 0.5)
         path = "/orders/v0/orders/#{order_id}/address"
 
@@ -195,7 +195,7 @@ module Peddler
       # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
       # @param next_token [String] A string token returned in the response of your previous request.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_order_items(order_id, next_token: nil, rate_limit: 0.5)
         path = "/orders/v0/orders/#{order_id}/orderItems"
         params = {
@@ -211,7 +211,7 @@ module Peddler
       # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
       # @param next_token [String] A string token returned in the response of your previous request.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_order_items_buyer_info(order_id, next_token: nil, rate_limit: 0.5)
         path = "/orders/v0/orders/#{order_id}/orderItems/buyerInfo"
         params = {
@@ -227,7 +227,7 @@ module Peddler
       # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
       # @param payload [Hash] The request body for the `updateShipmentStatus` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_shipment_status(order_id, payload, rate_limit: 5.0)
         path = "/orders/v0/orders/#{order_id}/shipment"
         body = payload
@@ -240,7 +240,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_order_regulated_info(order_id, rate_limit: 0.5)
         path = "/orders/v0/orders/#{order_id}/regulatedInfo"
 
@@ -253,7 +253,7 @@ module Peddler
       # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
       # @param payload [Hash] The request body for the `updateVerificationStatus` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_verification_status(order_id, payload, rate_limit: 0.5)
         path = "/orders/v0/orders/#{order_id}/regulatedInfo"
         body = payload
@@ -267,7 +267,7 @@ module Peddler
       # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format.
       # @param payload [Hash] Request body of `confirmShipment`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def confirm_shipment(order_id, payload, rate_limit: 2.0)
         path = "/orders/v0/orders/#{order_id}/shipmentConfirmation"
         body = payload

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def product_fees_v0(...)
-      API::ProductFeesV0.new(...)
+      APIs::ProductFeesV0.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Product Fees
     #
     # The Selling Partner API for Product Fees lets you programmatically retrieve estimated fees for a product. You can
@@ -33,7 +33,7 @@ module Peddler
       # @param seller_sku [String] Used to identify an item in the given marketplace. SellerSKU is qualified by the
       #   seller's SellerId, which is included with every operation that you submit.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_my_fees_estimate_for_sku(body, seller_sku, rate_limit: 1.0)
         path = "/products/fees/v0/listings/#{seller_sku}/feesEstimate"
 
@@ -54,7 +54,7 @@ module Peddler
       # @param body [Hash]
       # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_my_fees_estimate_for_asin(body, asin, rate_limit: 1.0)
         path = "/products/fees/v0/items/#{asin}/feesEstimate"
 
@@ -66,7 +66,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_my_fees_estimates(body, rate_limit: 0.5)
         path = "/products/fees/v0/feesEstimate"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def product_pricing_2022_05_01(...)
-      API::ProductPricing20220501.new(...)
+      APIs::ProductPricing20220501.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Pricing
     #
     # The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing
@@ -19,15 +19,15 @@ module Peddler
       # 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
       # price at or below which a seller can expect to become the featured offer (before applicable promotions). This is
-      # called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may
-      # change, and different offers may be featured based on other factors, including fulfillment capabilities to a
-      # specific customer. The response to an unsuccessful request includes the available error text.
+      # called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might
+      # change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer.
+      # The response to an unsuccessful request includes the available error text.
       #
       # @note This operation can make a static sandbox call.
       # @param get_featured_offer_expected_price_batch_request_body [Hash] The batch of `getFeaturedOfferExpectedPrice`
       #   requests.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_featured_offer_expected_price_batch(get_featured_offer_expected_price_batch_request_body,
         rate_limit: 0.033)
         path = "/batches/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice"
@@ -36,13 +36,13 @@ module Peddler
         meter(rate_limit).post(path, body:)
       end
 
-      # Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId`
+      # Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId`
       # combination.
       #
       # @note This operation can make a static sandbox call.
       # @param requests [Hash] The batch of `getCompetitiveSummary` requests.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_competitive_summary(requests, rate_limit: 0.033)
         path = "/batches/products/pricing/2022-05-01/items/competitiveSummary"
         body = requests

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def product_pricing_v0(...)
-      API::ProductPricingV0.new(...)
+      APIs::ProductPricingV0.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Pricing
     #
     # The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for
@@ -36,7 +36,7 @@ module Peddler
       # @param offer_type [String] Indicates whether to request pricing information for the seller's B2C or B2B offers.
       #   Default is B2C.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_pricing(marketplace_id, item_type, asins: nil, skus: nil, item_condition: nil, offer_type: nil,
         rate_limit: 0.5)
         path = "/products/pricing/v0/price"
@@ -71,7 +71,7 @@ module Peddler
       # @param customer_type [String] Indicates whether to request pricing information from the point of view of
       #   Consumer or Business buyers. Default is Consumer.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_competitive_pricing(marketplace_id, item_type, asins: nil, skus: nil, customer_type: nil, rate_limit: 0.5)
         path = "/products/pricing/v0/competitivePrice"
         params = {
@@ -98,7 +98,7 @@ module Peddler
       #   SellerId, which is included with every operation that you submit.
       # @param customer_type [String] Indicates whether to request Consumer or Business offers. Default is Consumer.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_listing_offers(marketplace_id, item_condition, seller_sku, customer_type: nil, rate_limit: 1.0)
         path = "/products/pricing/v0/listings/#{seller_sku}/offers"
         params = {
@@ -120,7 +120,7 @@ module Peddler
       # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item.
       # @param customer_type [String] Indicates whether to request Consumer or Business offers. Default is Consumer.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_item_offers(marketplace_id, item_condition, asin, customer_type: nil, rate_limit: 0.5)
         path = "/products/pricing/v0/items/#{asin}/offers"
         params = {
@@ -137,7 +137,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param get_item_offers_batch_request_body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       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
@@ -150,7 +150,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param get_listing_offers_batch_request_body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       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

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def product_type_definitions_2020_09_01(...)
-      API::ProductTypeDefinitions20200901.new(...)
+      APIs::ProductTypeDefinitions20200901.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Product Type Definitions
     #
     # The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data
@@ -32,7 +32,7 @@ module Peddler
       # @param search_locale [String] The locale used for the `keywords` and `itemName` parameters. Defaults to the
       #   primary locale of the marketplace.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def search_definitions_product_types(marketplace_ids, keywords: nil, item_name: nil, locale: nil,
         search_locale: nil, rate_limit: 5.0)
         path = "/definitions/2020-09-01/productTypes"
@@ -66,7 +66,7 @@ module Peddler
       # @param locale [String] Locale for retrieving display labels and other presentation details. Defaults to the
       #   default language of the first marketplace in the request.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_definitions_product_type(product_type, marketplace_ids, seller_id: nil, product_type_version: "LATEST",
         requirements: "LISTING", requirements_enforced: "ENFORCED", locale: "DEFAULT", rate_limit: 5.0)
         path = "/definitions/2020-09-01/productTypes/#{product_type}"

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def replenishment_2022_11_07(...)
-      API::Replenishment20221107.new(...)
+      APIs::Replenishment20221107.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Replenishment
     #
     # The Selling Partner API for Replenishment (Replenishment API) provides programmatic access to replenishment
@@ -22,7 +22,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] The request body for the `getSellingPartnerMetrics` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @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"
 
@@ -34,7 +34,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] The request body for the `listOfferMetrics` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_offer_metrics(body: nil, rate_limit: 1.0)
         path = "/replenishment/2022-11-07/offers/metrics/search"
 
@@ -46,7 +46,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] The request body for the `listOffers` operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_offers(body: nil, rate_limit: 1.0)
         path = "/replenishment/2022-11-07/offers/search"
 

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

@@ -5,12 +5,12 @@ require "peddler/api"
 module Peddler
   class << self
     def reports_2021_06_30(...)
-      API::Reports20210630.new(...)
+      APIs::Reports20210630.new(...)
     end
   end
 
-  class API
-    # Selling Partner API for Reports
+  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.
@@ -36,7 +36,7 @@ module Peddler
       #   call the `getReports` 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_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"
@@ -58,7 +58,7 @@ module Peddler
       # @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 [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_report(body, rate_limit: 0.0167)
         path = "/reports/2021-06-30/reports"
 
@@ -72,7 +72,7 @@ module Peddler
       # @param report_id [String] The identifier for the report. 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_report(report_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/reports/#{report_id}"
 
@@ -85,7 +85,7 @@ module Peddler
       # @param report_id [String] The identifier for the report. 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_report(report_id, rate_limit: 2.0)
         path = "/reports/2021-06-30/reports/#{report_id}"
 
@@ -98,7 +98,7 @@ module Peddler
       # @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.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_report_schedules(report_types, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules"
         params = {
@@ -114,7 +114,7 @@ module Peddler
       # @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 [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_report_schedule(body, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules"
 
@@ -127,7 +127,7 @@ module Peddler
       # @param report_schedule_id [String] The identifier for the report schedule. 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_report_schedule(report_schedule_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules/#{report_schedule_id}"
 
@@ -140,7 +140,7 @@ module Peddler
       # @param report_schedule_id [String] The identifier for the report schedule. 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_report_schedule(report_schedule_id, rate_limit: 0.0222)
         path = "/reports/2021-06-30/schedules/#{report_schedule_id}"
 
@@ -152,7 +152,7 @@ module Peddler
       # @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 [Hash] The API response
+      # @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}"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def sales_v1(...)
-      API::SalesV1.new(...)
+      APIs::SalesV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Sales
     #
     # The Selling Partner API for Sales provides APIs related to sales performance.
@@ -54,7 +54,7 @@ module Peddler
       #   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.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @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"

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def sellers_v1(...)
-      API::SellersV1.new(...)
+      APIs::SellersV1.new(...)
     end
   end
 
-  class API
+  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)
@@ -23,7 +23,7 @@ module Peddler
       #
       # @note This operation can make a static sandbox call.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_marketplace_participations(rate_limit: 0.016)
         path = "/sellers/v1/marketplaceParticipations"
 
@@ -34,7 +34,7 @@ module Peddler
       #
       # @note This operation can make a static sandbox call.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_account(rate_limit: 0.016)
         path = "/sellers/v1/account"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def services_v1(...)
-      API::ServicesV1.new(...)
+      APIs::ServicesV1.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Services
     #
     # With the Services API, you can build applications that help service providers get and modify their service orders
@@ -20,7 +20,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param service_job_id [String] A service job identifier.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_service_job_by_service_job_id(service_job_id, rate_limit: 20.0)
         path = "/service/v1/serviceJobs/#{service_job_id}"
 
@@ -34,7 +34,7 @@ module Peddler
       # @param cancellation_reason_code [String] A cancel reason code that specifies the reason for cancelling a service
       #   job.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def cancel_service_job_by_service_job_id(service_job_id, cancellation_reason_code, rate_limit: 5.0)
         path = "/service/v1/serviceJobs/#{service_job_id}/cancellations"
         params = {
@@ -49,7 +49,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param service_job_id [String] An Amazon defined service job identifier.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def complete_service_job_by_service_job_id(service_job_id, rate_limit: 5.0)
         path = "/service/v1/serviceJobs/#{service_job_id}/completions"
 
@@ -90,7 +90,7 @@ module Peddler
       # @param store_ids [Array<String>] List of Amazon-defined identifiers for the region scope. Max values supported
       #   is 50.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_service_jobs(marketplace_ids, service_order_ids: nil, service_job_status: nil, page_token: nil,
         page_size: 20, sort_field: nil, sort_order: nil, created_after: nil, created_before: nil,
         last_updated_after: nil, last_updated_before: nil, schedule_start_date: nil, schedule_end_date: nil, asins: nil,
@@ -124,7 +124,7 @@ module Peddler
       # @param service_job_id [String] An Amazon defined service job identifier.
       # @param body [Hash] Add appointment operation input details.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def add_appointment_for_service_job_by_service_job_id(service_job_id, body, rate_limit: 5.0)
         path = "/service/v1/serviceJobs/#{service_job_id}/appointments"
 
@@ -138,7 +138,7 @@ module Peddler
       # @param appointment_id [String] An existing appointment identifier for the Service Job.
       # @param body [Hash] Reschedule appointment operation input details.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def reschedule_appointment_for_service_job_by_service_job_id(service_job_id, appointment_id, body,
         rate_limit: 5.0)
         path = "/service/v1/serviceJobs/#{service_job_id}/appointments/#{appointment_id}"
@@ -154,7 +154,7 @@ module Peddler
       # @param appointment_id [String] An Amazon-defined identifier of active service job appointment.
       # @param body [Hash]
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def assign_appointment_resources(service_job_id, appointment_id, body, rate_limit: 1.0)
         path = "/service/v1/serviceJobs/#{service_job_id}/appointments/#{appointment_id}/resources"
 
@@ -169,7 +169,7 @@ module Peddler
       # @param appointment_id [String] An Amazon-defined identifier of active service job appointment.
       # @param body [Hash] Appointment fulfillment data collection details.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def set_appointment_fulfillment_data(service_job_id, appointment_id, body, rate_limit: 5.0)
         path = "/service/v1/serviceJobs/#{service_job_id}/appointments/#{appointment_id}/fulfillment"
 
@@ -184,7 +184,7 @@ module Peddler
       # @param marketplace_ids [Array<String>] An identifier for the marketplace in which the resource operates.
       # @param next_page_token [String] Next page token returned in the response of your previous request.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_range_slot_capacity(resource_id, body, marketplace_ids, next_page_token: nil, rate_limit: 5.0)
         path = "/service/v1/serviceResources/#{resource_id}/capacity/range"
         params = {
@@ -203,7 +203,7 @@ module Peddler
       # @param marketplace_ids [Array<String>] An identifier for the marketplace in which the resource operates.
       # @param next_page_token [String] Next page token returned in the response of your previous request.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_fixed_slot_capacity(resource_id, body, marketplace_ids, next_page_token: nil, rate_limit: 5.0)
         path = "/service/v1/serviceResources/#{resource_id}/capacity/fixed"
         params = {
@@ -221,7 +221,7 @@ module Peddler
       # @param body [Hash] Schedule details
       # @param marketplace_ids [Array<String>] An identifier for the marketplace in which the resource operates.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_schedule(resource_id, body, marketplace_ids, rate_limit: 5.0)
         path = "/service/v1/serviceResources/#{resource_id}/schedules"
         params = {
@@ -237,7 +237,7 @@ module Peddler
       # @param body [Hash] Reservation details
       # @param marketplace_ids [Array<String>] An identifier for the marketplace in which the resource operates.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_reservation(body, marketplace_ids, rate_limit: 5.0)
         path = "/service/v1/reservation"
         params = {
@@ -254,7 +254,7 @@ module Peddler
       # @param body [Hash] Reservation details
       # @param marketplace_ids [Array<String>] An identifier for the marketplace in which the resource operates.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_reservation(reservation_id, body, marketplace_ids, rate_limit: 5.0)
         path = "/service/v1/reservation/#{reservation_id}"
         params = {
@@ -270,7 +270,7 @@ module Peddler
       # @param reservation_id [String] Reservation Identifier
       # @param marketplace_ids [Array<String>] An identifier for the marketplace in which the resource operates.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def cancel_reservation(reservation_id, marketplace_ids, rate_limit: 5.0)
         path = "/service/v1/reservation/#{reservation_id}"
         params = {
@@ -292,7 +292,7 @@ module Peddler
       #   in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per
       #   business configuration. Maximum range of appointment slots can be 90 days.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_appointmment_slots_by_job_id(service_job_id, marketplace_ids, start_time: nil, end_time: nil,
         rate_limit: 5.0)
         path = "/service/v1/serviceJobs/#{service_job_id}/appointmentSlots"
@@ -318,7 +318,7 @@ module Peddler
       #   in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per
       #   business configuration. Maximum range of appointment slots can be 90 days.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_appointment_slots(asin, store_id, marketplace_ids, start_time: nil, end_time: nil, rate_limit: 20.0)
         path = "/service/v1/appointmentSlots"
         params = {
@@ -337,7 +337,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] Upload document operation input details.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_service_document_upload_destination(body, rate_limit: 5.0)
         path = "/service/v1/documents"