peddler 4.1.1 → 4.2.0

data/lib/peddler/apis/finances_2024_06_19.rb

@@ -12,26 +12,23 @@ module Peddler
   module APIs
     # The Selling Partner API for Finances
     #
-    # The Selling Partner API for Finances provides financial information relevant to a seller's business. You can
-    # obtain financial events for a given order or date range without having to wait until a statement period closes.
+    # The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You
+    # can obtain financial events for a given order 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.
+      # Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your
+      # transaction 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 posted_after [String] A date used for selecting transactions 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 date time format.
+      # @param posted_before [String] A date used for selecting transactions 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 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no
+      #   transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore
+      #   parameter. Default: Now minus two minutes.
+      # @param marketplace_id [String] A string token used to select Marketplace ID.
+      # @param next_token [String] A string token returned in the response of your previous request.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def list_transactions(posted_after, posted_before: nil, marketplace_id: nil, next_token: nil, rate_limit: 0.5)

data/lib/peddler/apis/fulfillment_inbound_2024_03_20.rb

@@ -10,7 +10,7 @@ module Peddler
   end
 
   module APIs
-    # Fulfillment Inbound v2024-03-20
+    # The Selling Partner API for FBA inbound operations.
     #
     # The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound
     # workflows to create, manage, and send shipments into Amazon's fulfillment network. The API has interoperability
@@ -542,7 +542,8 @@ module Peddler
         meter(rate_limit).get(path, params:)
       end
 
-      # Cancels a self-ship appointment slot against a shipment.
+      # Cancels a self-ship appointment slot against a shipment. Only available in the following
+      # [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
       #
       # @note This operation can make a static sandbox call.
       # @param inbound_plan_id [String] Identifier of an inbound plan.
@@ -556,7 +557,9 @@ module Peddler
         meter(rate_limit).put(path, body:)
       end
 
-      # Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse.
+      # Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only
+      # available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX,
+      # BR, EG, SA, AE, IN.
       #
       # @note This operation can make a static sandbox call.
       # @param inbound_plan_id [String] Identifier of an inbound plan.
@@ -579,7 +582,8 @@ module Peddler
         meter(rate_limit).get(path, params:)
       end
 
-      # Initiates the process of generating the appointment slots list.
+      # Initiates the process of generating the appointment slots list. Only available in the following
+      # [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
       #
       # @note This operation can make a static sandbox call.
       # @param inbound_plan_id [String] Identifier of an inbound plan.
@@ -593,7 +597,8 @@ module Peddler
         meter(rate_limit).post(path, body:)
       end
 
-      # Confirms or reschedules a self-ship appointment slot against a shipment.
+      # Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following
+      # [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
       #
       # @note This operation can make a static sandbox call.
       # @param inbound_plan_id [String] Identifier of an inbound plan.

data/lib/peddler/apis/fulfillment_inbound_v0.rb

@@ -15,92 +15,6 @@ module Peddler
     # The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound
     # shipments of inventory to Amazon's fulfillment network.
     class FulfillmentInboundV0 < API
-      # Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound
-      # shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items
-      # can be optimally placed in Amazon's fulfillment network—for example, positioning inventory closer to the
-      # customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center
-      # destination if the two shipment plans require different processing—for example, items that require labels must
-      # be shipped separately from stickerless, commingled inventory.
-      #
-      # @note This operation can make a static sandbox call.
-      # @param body [Hash] The request schema for the CreateInboundShipmentPlanRequest operation.
-      # @param rate_limit [Float] Requests per second
-      # @return [Peddler::Response] The API response
-      def create_inbound_shipment_plan(body, rate_limit: 2.0)
-        path = "/fba/inbound/v0/plans"
-
-        meter(rate_limit).post(path, body:)
-      end
-
-      # Returns a new inbound shipment based on the specified shipmentId that was returned by the
-      # createInboundShipmentPlan operation.
-      #
-      # @note This operation can make a static sandbox call.
-      # @param body [Hash] The request schema for the InboundShipmentRequest operation.
-      # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
-      #   operation.
-      # @param rate_limit [Float] Requests per second
-      # @return [Peddler::Response] The API response
-      def create_inbound_shipment(body, shipment_id, rate_limit: 2.0)
-        path = "/fba/inbound/v0/shipments/#{shipment_id}"
-
-        meter(rate_limit).post(path, body:)
-      end
-
-      # Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new
-      # items is not supported.
-      #
-      # @note This operation can make a static sandbox call.
-      # @param body [Hash] The request schema for the InboundShipmentRequest operation.
-      # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
-      #   operation.
-      # @param rate_limit [Float] Requests per second
-      # @return [Peddler::Response] The API response
-      def update_inbound_shipment(body, shipment_id, rate_limit: 2.0)
-        path = "/fba/inbound/v0/shipments/#{shipment_id}"
-
-        meter(rate_limit).put(path, body:)
-      end
-
-      # Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order.
-      #
-      # @note This operation can make a static sandbox call.
-      # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
-      #   operation.
-      # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace the shipment is tied to.
-      # @param rate_limit [Float] Requests per second
-      # @return [Peddler::Response] The API response
-      def get_preorder_info(shipment_id, marketplace_id, rate_limit: 2.0)
-        path = "/fba/inbound/v0/shipments/#{shipment_id}/preorder"
-        params = {
-          "MarketplaceId" => marketplace_id,
-        }.compact
-
-        meter(rate_limit).get(path, params:)
-      end
-
-      # Returns information needed to confirm a shipment for pre-order. Call this operation after calling the
-      # getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment.
-      #
-      # @note This operation can make a static sandbox call.
-      # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
-      #   operation.
-      # @param need_by_date [String] Date that the shipment must arrive at the Amazon fulfillment center to avoid
-      #   delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the
-      #   getPreorderInfo operation returns this value.
-      # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace the shipment is tied to.
-      # @param rate_limit [Float] Requests per second
-      # @return [Peddler::Response] The API response
-      def confirm_preorder(shipment_id, need_by_date, marketplace_id, rate_limit: 2.0)
-        path = "/fba/inbound/v0/shipments/#{shipment_id}/preorder/confirm"
-        params = {
-          "NeedByDate" => need_by_date,
-          "MarketplaceId" => marketplace_id,
-        }.compact
-
-        meter(rate_limit).put(path, params:)
-      end
-
       # Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's
       # fulfillment network.
       #
@@ -132,87 +46,6 @@ module Peddler
         meter(rate_limit).get(path, params:)
       end
 
-      # Returns current transportation information about an inbound shipment.
-      #
-      # @note This operation can make a static sandbox call.
-      # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
-      #   operation.
-      # @param rate_limit [Float] Requests per second
-      # @return [Peddler::Response] The API response
-      def get_transport_details(shipment_id, rate_limit: 2.0)
-        path = "/fba/inbound/v0/shipments/#{shipment_id}/transport"
-
-        meter(rate_limit).get(path)
-      end
-
-      # Sends transportation information to Amazon about an inbound shipment.
-      #
-      # @note This operation can make a static sandbox call.
-      # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
-      #   operation.
-      # @param body [Hash] The request schema for the PutTransportDetailsRequest operation.
-      # @param rate_limit [Float] Requests per second
-      # @return [Peddler::Response] The API response
-      def put_transport_details(shipment_id, body, rate_limit: 2.0)
-        path = "/fba/inbound/v0/shipments/#{shipment_id}/transport"
-
-        meter(rate_limit).put(path, body:)
-      end
-
-      # Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be
-      # successful, you must call this operation before the VoidDeadline date that is returned by the
-      # getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel
-      # shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL)
-      # shipment transportation request. After the void deadline passes, your account will be charged for the shipping
-      # cost.
-      #
-      # @note This operation can make a static sandbox call.
-      # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
-      #   operation.
-      # @param rate_limit [Float] Requests per second
-      # @return [Peddler::Response] The API response
-      def void_transport(shipment_id, rate_limit: 2.0)
-        path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/void"
-
-        meter(rate_limit).post(path)
-      end
-
-      # Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier.
-      # Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide
-      # Amazon with the transportation information for the inbound shipment.
-      #
-      # @note This operation can make a static sandbox call.
-      # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
-      #   operation.
-      # @param rate_limit [Float] Requests per second
-      # @return [Peddler::Response] The API response
-      def estimate_transport(shipment_id, rate_limit: 2.0)
-        path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/estimate"
-
-        meter(rate_limit).post(path)
-      end
-
-      # Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their
-      # account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior
-      # to calling the confirmTransport operation, you should call the getTransportDetails operation to get the
-      # Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller
-      # decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the
-      # voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller
-      # has 24 hours after confirming a transportation request to void the transportation request. For a Less Than
-      # Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request
-      # to void it. After the grace period has expired the seller's account will be charged for the shipping cost.
-      #
-      # @note This operation can make a static sandbox call.
-      # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
-      #   operation.
-      # @param rate_limit [Float] Requests per second
-      # @return [Peddler::Response] The API response
-      def confirm_transport(shipment_id, rate_limit: 2.0)
-        path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/confirm"
-
-        meter(rate_limit).post(path)
-      end
-
       # Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.
       #
       # @note This operation can make a static sandbox call.
@@ -312,11 +145,10 @@ module Peddler
       #
       # @note This operation can make a static sandbox call.
       # @param shipment_id [String] A shipment identifier used for selecting items in a specific inbound shipment.
-      # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be
-      #   stored.
+      # @param marketplace_id [String] Deprecated. Do not use.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def get_shipment_items_by_shipment_id(shipment_id, marketplace_id, rate_limit: 2.0)
+      def get_shipment_items_by_shipment_id(shipment_id, marketplace_id: nil, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/items"
         params = {
           "MarketplaceId" => marketplace_id,

data/lib/peddler/apis/listings_items_2021_08_01.rb

@@ -10,7 +10,7 @@ module Peddler
   end
 
   module APIs
-    # Listings Items v2021-08-01
+    # Selling Partner API for Listings Items
     #
     # The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner
     # listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which
@@ -69,10 +69,7 @@ module Peddler
       end
 
       # Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be
-      # patched. Patching nested attributes is not supported. **Note:** This operation has a throttling rate of one
-      # request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation
-      # may contain special characters that must be encoded to successfully 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).
+      # patched. Patching nested attributes is not supported.
       #
       # @note This operation can make a static sandbox call.
       # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code.
@@ -131,6 +128,81 @@ module Peddler
 
         meter(rate_limit).put(path, body:, params:)
       end
+
+      # Search for and return a list of selling partner listings items and their respective details.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code.
+      # @param marketplace_ids [Array<String>] A comma-delimited list of Amazon marketplace identifiers for the request.
+      # @param issue_locale [String] A locale that is used to localize issues. When not provided, the default language
+      #   code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". When a localization is not
+      #   available in the specified locale, localized messages default to "en_US".
+      # @param included_data [Array<String>] A comma-delimited list of datasets that you want to include in the
+      #   response. Default: `summaries`.
+      # @param identifiers [Array<String>] A comma-delimited list of product identifiers that you can use to search for
+      #   listings items. **Note**: 1. This is required when you specify `identifiersType`. 2. You cannot use
+      #   'identifiers' if you specify `variationParentSku` or `packageHierarchySku`.
+      # @param identifiers_type [String] A type of product identifiers that you can use to search for listings items.
+      #   **Note**: This is required when `identifiers` is provided.
+      # @param variation_parent_sku [String] Filters results to include listing items that are variation children of the
+      #   specified SKU. **Note**: You cannot use `variationParentSku` if you include `identifiers` or
+      #   `packageHierarchySku` in your request.
+      # @param package_hierarchy_sku [String] Filter results to include listing items that contain or are contained by
+      #   the specified SKU. **Note**: You cannot use `packageHierarchySku` if you include `identifiers` or
+      #   `variationParentSku` in your request.
+      # @param created_after [String] A date-time that is used to filter listing items. The response includes listings
+      #   items that were created at or after this time. Values are in [ISO
+      #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+      # @param created_before [String] A date-time that is used to filter listing items. The response includes listings
+      #   items that were created at or before this time. Values are in [ISO
+      #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+      # @param last_updated_after [String] A date-time that is used to filter listing items. The response includes
+      #   listings items that were last updated at or after this time. Values are in [ISO
+      #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+      # @param last_updated_before [String] A date-time that is used to filter listing items. The response includes
+      #   listings items that were last updated at or before this time. Values are in [ISO
+      #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+      # @param with_issue_severity [Array<String>] Filter results to include only listing items that have issues that
+      #   match one or more of the specified severity levels.
+      # @param with_status [Array<String>] Filter results to include only listing items that have the specified status.
+      # @param without_status [Array<String>] Filter results to include only listing items that don't contain the
+      #   specified statuses.
+      # @param sort_by [String] An attribute by which to sort the returned listing items.
+      # @param sort_order [String] The order in which to sort the result items.
+      # @param page_size [Integer] The number of results that you want to include on each page.
+      # @param page_token [String] A token that you can use to fetch a specific page when there are multiple pages of
+      #   results.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def search_listings_items(seller_id, marketplace_ids, issue_locale: nil, included_data: ["summaries"],
+        identifiers: nil, identifiers_type: nil, variation_parent_sku: nil, package_hierarchy_sku: nil,
+        created_after: nil, created_before: nil, last_updated_after: nil, last_updated_before: nil,
+        with_issue_severity: nil, with_status: nil, without_status: nil, sort_by: "lastUpdatedDate", sort_order: "DESC",
+        page_size: 10, page_token: nil, rate_limit: 5.0)
+        path = "/listings/2021-08-01/items/#{seller_id}"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+          "issueLocale" => issue_locale,
+          "includedData" => included_data,
+          "identifiers" => identifiers,
+          "identifiersType" => identifiers_type,
+          "variationParentSku" => variation_parent_sku,
+          "packageHierarchySku" => package_hierarchy_sku,
+          "createdAfter" => created_after,
+          "createdBefore" => created_before,
+          "lastUpdatedAfter" => last_updated_after,
+          "lastUpdatedBefore" => last_updated_before,
+          "withIssueSeverity" => with_issue_severity,
+          "withStatus" => with_status,
+          "withoutStatus" => without_status,
+          "sortBy" => sort_by,
+          "sortOrder" => sort_order,
+          "pageSize" => page_size,
+          "pageToken" => page_token,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
     end
   end
 end

data/lib/peddler/apis/messaging_v1.rb

@@ -24,8 +24,8 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which you want a list
       #   of available message types.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def get_messaging_actions_for_order(amazon_order_id, marketplace_ids, rate_limit: 1.0)
@@ -41,11 +41,11 @@ module Peddler
       # initials, etc.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
-      # @param body [Hash]
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
+      # @param body [Hash] This contains the message body for a message.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def confirm_customization_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -60,11 +60,11 @@ module Peddler
       # Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
-      # @param body [Hash]
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
+      # @param body [Hash] This contains the message body for a message.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_confirm_delivery_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -80,11 +80,11 @@ module Peddler
       # This message should only be used to deliver documents that are required by law.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
-      # @param body [Hash]
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
+      # @param body [Hash] This contains the message body for a message.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_legal_disclosure(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -100,10 +100,10 @@ module Peddler
       # sent after the seller has resolved the buyer's problem.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_negative_feedback_removal(amazon_order_id, marketplace_ids, rate_limit: 1.0)
@@ -118,11 +118,11 @@ module Peddler
       # Sends a message to ask a buyer an order-related question prior to shipping their order.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
-      # @param body [Hash]
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
+      # @param body [Hash] This contains the message body for a message.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_confirm_order_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -138,11 +138,11 @@ module Peddler
       # service call.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
-      # @param body [Hash]
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
+      # @param body [Hash] This contains the message body for a message.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_confirm_service_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -158,11 +158,11 @@ module Peddler
       # Amazon Motors sellers.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
-      # @param body [Hash]
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
+      # @param body [Hash] This contains the message body for a message.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_amazon_motors(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -177,11 +177,11 @@ module Peddler
       # Sends a message to a buyer to provide details about warranty information on a purchase in their order.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
-      # @param body [Hash]
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
+      # @param body [Hash] This contains the message body for a message.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_warranty(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -196,10 +196,10 @@ module Peddler
       # Returns a response containing attributes related to an order. This includes buyer preferences.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def get_attributes(amazon_order_id, marketplace_ids, rate_limit: 1.0)
@@ -211,14 +211,15 @@ module Peddler
         meter(rate_limit).get(path, params:)
       end
 
-      # Sends a message to a buyer to share a digital access key needed to utilize digital content in their order.
+      # Sends a buyer a message to share a digital access key that is required to utilize digital content in their
+      # order.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
-      # @param body [Hash]
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
+      # @param body [Hash] This contains the message body for a message.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_digital_access_key(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -234,11 +235,11 @@ module Peddler
       # order.
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
-      # @param body [Hash]
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
+      # @param body [Hash] This contains the message body for a message.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def create_unexpected_problem(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
@@ -253,11 +254,11 @@ module Peddler
       # Sends a message providing the buyer an invoice
       #
       # @note This operation can make a static sandbox call.
-      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      # @param amazon_order_id [String] An Amazon order identifier. This identifies the order for which a message is
       #   sent.
-      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
-      #   order was placed. Only one marketplace can be specified.
-      # @param body [Hash]
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This identifies the marketplace in which the
+      #   order was placed. You can only specify one marketplace.
+      # @param body [Hash] This contains the message body for a message.
       # @return [Peddler::Response] The API response
       def send_invoice(amazon_order_id, marketplace_ids, body)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/invoice"

data/lib/peddler/apis/orders_v0.rb

@@ -10,7 +10,7 @@ module Peddler
   end
 
   module APIs
-    # Orders v0
+    # Selling Partner API for Orders
     #
     # 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

data/lib/peddler/apis/product_pricing_v0.rb

@@ -135,7 +135,7 @@ module Peddler
       # Returns the lowest priced offers for a batch of items based on ASIN.
       #
       # @note This operation can make a static sandbox call.
-      # @param get_item_offers_batch_request_body [Hash]
+      # @param get_item_offers_batch_request_body [Hash] The request associated with the `getItemOffersBatch` API call.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def get_item_offers_batch(get_item_offers_batch_request_body, rate_limit: 0.1)
@@ -148,7 +148,8 @@ module Peddler
       # Returns the lowest priced offers for a batch of listings by SKU.
       #
       # @note This operation can make a static sandbox call.
-      # @param get_listing_offers_batch_request_body [Hash]
+      # @param get_listing_offers_batch_request_body [Hash] The request associated with the `getListingOffersBatch` API
+      #   call.
       # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def get_listing_offers_batch(get_listing_offers_batch_request_body, rate_limit: 0.5)

data/lib/peddler/apis/reports_2021_06_30.rb

@@ -10,7 +10,7 @@ module Peddler
   end
 
   module APIs
-    # Report v2021-06-30
+    # Selling Partner API for Reports
     #
     # The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling
     # partners manage their businesses.