fulfillment_inbound_v0.rb in peddler-4.1.0

- old
+ new

@@ -23,62 +23,66 @@
       # 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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def create_inbound_shipment_plan(body, rate_limit: 2.0)
+      def create_inbound_shipment_plan(body, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/plans"
 
-        meter(rate_limit).post(path, body:)
+        meter(rate_limit, tries:).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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def create_inbound_shipment(body, shipment_id, rate_limit: 2.0)
+      def create_inbound_shipment(body, shipment_id, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}"
 
-        meter(rate_limit).post(path, body:)
+        meter(rate_limit, tries:).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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def update_inbound_shipment(body, shipment_id, rate_limit: 2.0)
+      def update_inbound_shipment(body, shipment_id, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}"
 
-        meter(rate_limit).put(path, body:)
+        meter(rate_limit, tries:).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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def get_preorder_info(shipment_id, marketplace_id, rate_limit: 2.0)
+      def get_preorder_info(shipment_id, marketplace_id, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/preorder"
         params = {
           "MarketplaceId" => marketplace_id,
         }.compact
 
-        meter(rate_limit).get(path, params:)
+        meter(rate_limit, tries:).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.
       #
@@ -88,19 +92,20 @@
       # @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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def confirm_preorder(shipment_id, need_by_date, marketplace_id, rate_limit: 2.0)
+      def confirm_preorder(shipment_id, need_by_date, marketplace_id, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/preorder/confirm"
         params = {
           "NeedByDate" => need_by_date,
           "MarketplaceId" => marketplace_id,
         }.compact
 
-        meter(rate_limit).put(path, params:)
+        meter(rate_limit, tries:).put(path, params:)
       end
 
       # Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's
       # fulfillment network.
       #
@@ -118,47 +123,50 @@
       #   catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in
       #   the product catalog for at least one of the marketplaces that the seller participates in is returned in the
       #   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
+      # @param tries [Integer] Total request attempts, including retries
       # @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)
+      def get_prep_instructions(ship_to_country_code, seller_sku_list: nil, asin_list: nil, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/prepInstructions"
         params = {
           "ShipToCountryCode" => ship_to_country_code,
           "SellerSKUList" => seller_sku_list,
           "ASINList" => asin_list,
         }.compact
 
-        meter(rate_limit).get(path, params:)
+        meter(rate_limit, tries:).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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def get_transport_details(shipment_id, rate_limit: 2.0)
+      def get_transport_details(shipment_id, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/transport"
 
-        meter(rate_limit).get(path)
+        meter(rate_limit, tries:).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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def put_transport_details(shipment_id, body, rate_limit: 2.0)
+      def put_transport_details(shipment_id, body, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/transport"
 
-        meter(rate_limit).put(path, body:)
+        meter(rate_limit, tries:).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
@@ -168,30 +176,32 @@
       #
       # @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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def void_transport(shipment_id, rate_limit: 2.0)
+      def void_transport(shipment_id, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/void"
 
-        meter(rate_limit).post(path)
+        meter(rate_limit, tries:).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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def estimate_transport(shipment_id, rate_limit: 2.0)
+      def estimate_transport(shipment_id, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/estimate"
 
-        meter(rate_limit).post(path)
+        meter(rate_limit, tries:).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
@@ -204,15 +214,16 @@
       #
       # @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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def confirm_transport(shipment_id, rate_limit: 2.0)
+      def confirm_transport(shipment_id, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/confirm"
 
-        meter(rate_limit).post(path)
+        meter(rate_limit, tries:).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.
@@ -237,13 +248,14 @@
       # @param page_size [Integer] The page size for paginating through the total packages' labels. This is a required
       #   parameter for Non-Partnered LTL Shipments. Max value:1000.
       # @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
+      # @param tries [Integer] Total request attempts, including retries
       # @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)
+        number_of_pallets: nil, page_size: nil, page_start_index: nil, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/labels"
         params = {
           "PageType" => page_type,
           "LabelType" => label_type,
           "NumberOfPackages" => number_of_packages,
@@ -251,26 +263,27 @@
           "NumberOfPallets" => number_of_pallets,
           "PageSize" => page_size,
           "PageStartIndex" => page_start_index,
         }.compact
 
-        meter(rate_limit).get(path, params:)
+        meter(rate_limit, tries:).get(path, params:)
       end
 
       # Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading
       # operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than
       # Truckload/Full Truckload (LTL/FTL) 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
+      # @param tries [Integer] Total request attempts, including retries
       # @return [Peddler::Response] The API response
-      def get_bill_of_lading(shipment_id, rate_limit: 2.0)
+      def get_bill_of_lading(shipment_id, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/billOfLading"
 
-        meter(rate_limit).get(path)
+        meter(rate_limit, tries:).get(path)
       end
 
       # Returns a list of inbound shipments based on criteria that you specify.
       #
       # @note This operation can make a static sandbox call.
@@ -289,13 +302,14 @@
       #   request.
       # @param next_token [String] A string token returned in the response to your previous request.
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be
       #   stored.
       # @param rate_limit [Float] Requests per second
+      # @param tries [Integer] Total request attempts, including retries
       # @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)
+        last_updated_after: nil, last_updated_before: nil, next_token: nil, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments"
         params = {
           "ShipmentStatusList" => shipment_status_list,
           "ShipmentIdList" => shipment_id_list,
           "LastUpdatedAfter" => last_updated_after,
@@ -303,28 +317,29 @@
           "QueryType" => query_type,
           "NextToken" => next_token,
           "MarketplaceId" => marketplace_id,
         }.compact
 
-        meter(rate_limit).get(path, params:)
+        meter(rate_limit, tries:).get(path, params:)
       end
 
       # Returns a list of items in a specified inbound shipment.
       #
       # @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 rate_limit [Float] Requests per second
+      # @param tries [Integer] Total request attempts, including retries
       # @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, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipments/#{shipment_id}/items"
         params = {
           "MarketplaceId" => marketplace_id,
         }.compact
 
-        meter(rate_limit).get(path, params:)
+        meter(rate_limit, tries:).get(path, params:)
       end
 
       # Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified
       # time frame.
       #
@@ -338,22 +353,23 @@
       #   specified in a previous request.
       # @param next_token [String] A string token returned in the response to your previous request.
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be
       #   stored.
       # @param rate_limit [Float] Requests per second
+      # @param tries [Integer] Total request attempts, including retries
       # @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)
+        next_token: nil, rate_limit: 2.0, tries: 2)
         path = "/fba/inbound/v0/shipmentItems"
         params = {
           "LastUpdatedAfter" => last_updated_after,
           "LastUpdatedBefore" => last_updated_before,
           "QueryType" => query_type,
           "NextToken" => next_token,
           "MarketplaceId" => marketplace_id,
         }.compact
 
-        meter(rate_limit).get(path, params:)
+        meter(rate_limit, tries:).get(path, params:)
       end
     end
   end
 end