peddler 3.0.0 → 4.0.0

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

@@ -5,12 +5,12 @@ require "peddler/api"
 module Peddler
   class << self
     def fulfillment_inbound_2024_03_20(...)
-      API::FulfillmentInbound20240320.new(...)
+      APIs::FulfillmentInbound20240320.new(...)
     end
   end
 
-  class API
-    # The Selling Partner API for FBA inbound operations.
+  module APIs
+    # Fulfillment Inbound v2024-03-20
     #
     # 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
@@ -27,7 +27,7 @@ module Peddler
       # @param sort_by [String] Sort by field.
       # @param sort_order [String] The sort order.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_inbound_plans(page_size: 10, pagination_token: nil, status: nil, sort_by: nil, sort_order: nil,
         rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans"
@@ -48,7 +48,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param body [Hash] The body of the request to `createInboundPlan`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_inbound_plan(body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans"
 
@@ -60,7 +60,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_inbound_plan(inbound_plan_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}"
 
@@ -76,7 +76,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_inbound_plan_boxes(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/boxes"
         params = {
@@ -94,7 +94,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def cancel_inbound_plan(inbound_plan_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/cancellation"
 
@@ -110,7 +110,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_inbound_plan_items(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/items"
         params = {
@@ -127,7 +127,7 @@ module Peddler
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param body [Hash] The body of the request to `updateInboundPlanName`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_inbound_plan_name(inbound_plan_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/name"
 
@@ -146,7 +146,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_packing_group_boxes(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil,
         rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingGroups/#{packing_group_id}/boxes"
@@ -169,7 +169,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_packing_group_items(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil,
         rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingGroups/#{packing_group_id}/items"
@@ -188,7 +188,7 @@ module Peddler
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param body [Hash] The body of the request to `setPackingInformation`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def set_packing_information(inbound_plan_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingInformation"
 
@@ -205,7 +205,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_packing_options(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingOptions"
         params = {
@@ -221,7 +221,7 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def generate_packing_options(inbound_plan_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingOptions"
 
@@ -234,7 +234,7 @@ module Peddler
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param packing_option_id [String] Identifier of a packing option.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def confirm_packing_option(inbound_plan_id, packing_option_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingOptions/#{packing_option_id}/confirmation"
 
@@ -251,7 +251,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_inbound_plan_pallets(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/pallets"
         params = {
@@ -272,7 +272,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_placement_options(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/placementOptions"
         params = {
@@ -289,7 +289,7 @@ module Peddler
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param body [Hash] The body of the request to `generatePlacementOptions`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def generate_placement_options(inbound_plan_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/placementOptions"
 
@@ -303,7 +303,7 @@ module Peddler
       # @param placement_option_id [String] The identifier of a placement option. A placement option represents the
       #   shipment splits and destinations of SKUs.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def confirm_placement_option(inbound_plan_id, placement_option_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/placementOptions/#{placement_option_id}/confirmation"
 
@@ -317,7 +317,7 @@ module Peddler
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_shipment(inbound_plan_id, shipment_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}"
 
@@ -334,7 +334,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_shipment_boxes(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/boxes"
         params = {
@@ -357,7 +357,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_shipment_content_update_previews(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil,
         rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/contentUpdatePreviews"
@@ -378,7 +378,7 @@ module Peddler
       # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
       # @param body [Hash] The body of the request to `generateShipmentContentUpdatePreviews`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def generate_shipment_content_update_previews(inbound_plan_id, shipment_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/contentUpdatePreviews"
 
@@ -394,7 +394,7 @@ module Peddler
       # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
       # @param content_update_preview_id [String] Identifier of a content update preview.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/contentUpdatePreviews/#{content_update_preview_id}"
 
@@ -408,7 +408,7 @@ module Peddler
       # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
       # @param content_update_preview_id [String] Identifier of a content update preview.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def confirm_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id,
         rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/contentUpdatePreviews/#{content_update_preview_id}/confirmation"
@@ -422,7 +422,7 @@ module Peddler
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_delivery_challan_document(inbound_plan_id, shipment_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/deliveryChallanDocument"
 
@@ -441,7 +441,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_delivery_window_options(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil,
         rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/deliveryWindowOptions"
@@ -459,7 +459,7 @@ module Peddler
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param shipment_id [String] The shipment to generate delivery window options for.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def generate_delivery_window_options(inbound_plan_id, shipment_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/deliveryWindowOptions"
 
@@ -478,7 +478,7 @@ module Peddler
       # @param shipment_id [String] The shipment to confirm the delivery window option for.
       # @param delivery_window_option_id [String] The id of the delivery window option to be confirmed.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def confirm_delivery_window_options(inbound_plan_id, shipment_id, delivery_window_option_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/deliveryWindowOptions/#{delivery_window_option_id}/confirmation"
 
@@ -495,7 +495,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_shipment_items(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/items"
         params = {
@@ -513,7 +513,7 @@ module Peddler
       # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
       # @param body [Hash] The body of the request to `updateShipmentName`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_shipment_name(inbound_plan_id, shipment_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/name"
 
@@ -531,7 +531,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_shipment_pallets(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/pallets"
         params = {
@@ -549,7 +549,7 @@ module Peddler
       # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
       # @param body [Hash] The body of the request to `cancelSelfShipAppointment`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def cancel_self_ship_appointment(inbound_plan_id, shipment_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/selfShipAppointmentCancellation"
 
@@ -567,7 +567,7 @@ module Peddler
       #   The value of this token is fetched from the `pagination` returned in the API response. In the absence of the
       #   token value from the query parameter the API returns the first page of the result.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_self_ship_appointment_slots(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil,
         rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/selfShipAppointmentSlots"
@@ -586,7 +586,7 @@ module Peddler
       # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
       # @param body [Hash] The body of the request to `generateSelfShipAppointmentSlots`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def generate_self_ship_appointment_slots(inbound_plan_id, shipment_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/selfShipAppointmentSlots"
 
@@ -601,7 +601,7 @@ module Peddler
       # @param slot_id [String] An identifier to a self-ship appointment slot.
       # @param body [Hash] The body of the request to `scheduleSelfShipAppointment`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def schedule_self_ship_appointment(inbound_plan_id, shipment_id, slot_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/selfShipAppointmentSlots/#{slot_id}/schedule"
 
@@ -618,7 +618,7 @@ module Peddler
       # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
       # @param body [Hash] The body of the request to `updateShipmentSourceAddress`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_shipment_source_address(inbound_plan_id, shipment_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/sourceAddress"
 
@@ -632,7 +632,7 @@ module Peddler
       # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded.
       # @param body [Hash] The body of the request to `updateShipmentTrackingDetails`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_shipment_tracking_details(inbound_plan_id, shipment_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/trackingDetails"
 
@@ -654,7 +654,7 @@ module Peddler
       # @param shipment_id [String] The shipment to get transportation options for. Either `placementOptionId` or
       #   `shipmentId` must be specified.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_transportation_options(inbound_plan_id, page_size: 10, pagination_token: nil, placement_option_id: nil,
         shipment_id: nil, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/transportationOptions"
@@ -674,7 +674,7 @@ module Peddler
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param body [Hash] The body of the request to `generateTransportationOptions`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def generate_transportation_options(inbound_plan_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/transportationOptions"
 
@@ -688,7 +688,7 @@ module Peddler
       # @param inbound_plan_id [String] Identifier of an inbound plan.
       # @param body [Hash] The body of the request to `confirmTransportationOptions`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def confirm_transportation_options(inbound_plan_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/transportationOptions/confirmation"
 
@@ -698,11 +698,11 @@ module Peddler
       # List the inbound compliance details for MSKUs in a given marketplace.
       #
       # @note This operation can make a static sandbox call.
-      # @param mskus [Array<String>] List of merchant SKUs - a merchant-supplied identifier for a specific SKU.
-      # @param marketplace_id [String] The Marketplace ID. Refer to [Marketplace
-      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
+      # @param mskus [Array<String>] A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
+      # @param marketplace_id [String] The Marketplace ID. For a list of possible values, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def list_item_compliance_details(mskus, marketplace_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/items/compliance"
         params = {
@@ -713,15 +713,15 @@ module Peddler
         meter(rate_limit).get(path, params:)
       end
 
-      # Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace
-      # compliance validation.
+      # Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN -
+      # A21TJRUUN4KGV) marketplace compliance validation.
       #
       # @note This operation can make a static sandbox call.
-      # @param marketplace_id [String] The Marketplace ID. Refer to [Marketplace
-      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
+      # @param marketplace_id [String] The Marketplace ID. For a list of possible values, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
       # @param body [Hash] The body of the request to `updateItemComplianceDetails`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_item_compliance_details(marketplace_id, body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/items/compliance"
         params = {
@@ -731,24 +731,54 @@ module Peddler
         meter(rate_limit).put(path, body:, params:)
       end
 
-      # For a given marketplace - creates labels for a list of mskus.
+      # For a given marketplace - creates labels for a list of MSKUs.
       #
       # @note This operation can make a static sandbox call.
       # @param body [Hash] The body of the request to `createMarketplaceItemLabels`.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_marketplace_item_labels(body, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/items/labels"
 
         meter(rate_limit).post(path, body:)
       end
 
+      # Get preparation details for a list of MSKUs in a specified marketplace.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param marketplace_id [String] The marketplace ID. For a list of possible values, refer to [Marketplace
+      #   IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+      # @param mskus [Array<String>] A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def list_prep_details(marketplace_id, mskus, rate_limit: 2.0)
+        path = "/inbound/fba/2024-03-20/items/prepDetails"
+        params = {
+          "marketplaceId" => marketplace_id,
+          "mskus" => mskus,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Set the preparation details for a list of MSKUs in a specified marketplace.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] The body of the request to `setPrepDetails`.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def set_prep_details(body, rate_limit: 2.0)
+        path = "/inbound/fba/2024-03-20/items/prepDetails"
+
+        meter(rate_limit).post(path, body:)
+      end
+
       # Gets the status of the processing of an asynchronous API call.
       #
       # @note This operation can make a static sandbox call.
       # @param operation_id [String] Identifier of an asynchronous operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_inbound_operation_status(operation_id, rate_limit: 2.0)
         path = "/inbound/fba/2024-03-20/operations/#{operation_id}"
 

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

@@ -5,11 +5,11 @@ require "peddler/api"
 module Peddler
   class << self
     def fulfillment_inbound_v0(...)
-      API::FulfillmentInboundV0.new(...)
+      APIs::FulfillmentInboundV0.new(...)
     end
   end
 
-  class API
+  module APIs
     # Selling Partner API for Fulfillment Inbound
     #
     # The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound
@@ -25,7 +25,7 @@ module Peddler
       # @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 [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_inbound_shipment_plan(body, rate_limit: 2.0)
         path = "/fba/inbound/v0/plans"
 
@@ -40,7 +40,7 @@ module Peddler
       # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
       #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def create_inbound_shipment(body, shipment_id, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments/#{shipment_id}"
 
@@ -55,7 +55,7 @@ module Peddler
       # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
       #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def update_inbound_shipment(body, shipment_id, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments/#{shipment_id}"
 
@@ -69,7 +69,7 @@ module Peddler
       #   operation.
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace the shipment is tied to.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @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 = {
@@ -90,7 +90,7 @@ module Peddler
       #   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 [Hash] The API response
+      # @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 = {
@@ -120,7 +120,7 @@ module Peddler
       #   InvalidASINList property in the response. You can find out which marketplaces a seller participates in by
       #   calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_prep_instructions(ship_to_country_code, seller_sku_list: nil, asin_list: nil, rate_limit: 2.0)
         path = "/fba/inbound/v0/prepInstructions"
         params = {
@@ -138,7 +138,7 @@ module Peddler
       # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
       #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_transport_details(shipment_id, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/transport"
 
@@ -152,7 +152,7 @@ module Peddler
       #   operation.
       # @param body [Hash] The request schema for the PutTransportDetailsRequest operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @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"
 
@@ -170,7 +170,7 @@ module Peddler
       # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
       #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def void_transport(shipment_id, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/void"
 
@@ -185,7 +185,7 @@ module Peddler
       # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
       #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def estimate_transport(shipment_id, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/estimate"
 
@@ -206,7 +206,7 @@ module Peddler
       # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
       #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def confirm_transport(shipment_id, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/confirm"
 
@@ -223,8 +223,15 @@ module Peddler
       # @param label_type [String] The type of labels requested.
       # @param number_of_packages [Integer] The number of packages in the shipment.
       # @param package_labels_to_print [Array<String>] A list of identifiers that specify packages for which you want
-      #   package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton
-      #   Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code.
+      #   package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton
+      #   Information
+      #   Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed),
+      #   then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box
+      #   content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the
+      #   `boxID` values from the
+      #   [`listShipmentBoxes`](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentboxes)
+      #   response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier`
+      #   error code.
       # @param number_of_pallets [Integer] The number of pallets in the shipment. This returns four identical labels for
       #   each pallet.
       # @param page_size [Integer] The page size for paginating through the total packages' labels. This is a required
@@ -232,7 +239,7 @@ module Peddler
       # @param page_start_index [Integer] The page start index for paginating through the total packages' labels. This
       #   is a required parameter for Non-Partnered LTL Shipments.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_labels(shipment_id, page_type, label_type, number_of_packages: nil, package_labels_to_print: nil,
         number_of_pallets: nil, page_size: nil, page_start_index: nil, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/labels"
@@ -257,7 +264,7 @@ module Peddler
       # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan
       #   operation.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_bill_of_lading(shipment_id, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/billOfLading"
 
@@ -284,7 +291,7 @@ module Peddler
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be
       #   stored.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_shipments(query_type, marketplace_id, shipment_status_list: nil, shipment_id_list: nil,
         last_updated_after: nil, last_updated_before: nil, next_token: nil, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments"
@@ -308,7 +315,7 @@ module Peddler
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be
       #   stored.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_shipment_items_by_shipment_id(shipment_id, marketplace_id, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/items"
         params = {
@@ -333,7 +340,7 @@ module Peddler
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be
       #   stored.
       # @param rate_limit [Float] Requests per second
-      # @return [Hash] The API response
+      # @return [Peddler::Response] The API response
       def get_shipment_items(query_type, marketplace_id, last_updated_after: nil, last_updated_before: nil,
         next_token: nil, rate_limit: 2.0)
         path = "/fba/inbound/v0/shipmentItems"