@medusajs/js-sdk 3.0.0-preview-20250211091350 → 3.0.0-preview-20250406164537

package/dist/esm/admin/return.js

@@ -14,6 +14,53 @@ export class Return {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a list of returns. It sends a request to the
+     * [List Returns](https://docs.medusajs.com/api/admin#returns_getreturns)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of returns.
+     *
+     * @example
+     * To retrieve the list of returns:
+     *
+     * ```ts
+     * sdk.admin.return.list()
+     * .then(({ returns, count, limit, offset }) => {
+     *   console.log(returns)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.return.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ returns, count, limit, offset }) => {
+     *   console.log(returns)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each return:
+     *
+     * ```ts
+     * sdk.admin.return.list({
+     *   fields: "id,*items"
+     * })
+     * .then(({ returns, count, limit, offset }) => {
+     *   console.log(returns)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns`, {
@@ -22,6 +69,39 @@ export class Return {
             });
         });
     }
+    /**
+     * This method retrieves a return by ID. It sends a request to the
+     * [Get Return](https://docs.medusajs.com/api/admin#returns_getreturnsid)
+     * API route.
+     *
+     * @param id - The ID of the return to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * To retrieve a return by its ID:
+     *
+     * ```ts
+     * sdk.admin.return.retrieve("return_123")
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.return.retrieve("return_123", {
+     *   fields: "id,*items"
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     retrieve(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}`, {
@@ -30,6 +110,24 @@ export class Return {
             });
         });
     }
+    /**
+     * This method initiates a return request by creating a return. It sends a request to the
+     * [Create Return](https://docs.medusajs.com/api/admin#returns_postreturns)
+     * API route.
+     *
+     * @param body - The details of the return to create.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.initiateRequest({
+     *   order_id: "order_123",
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     initiateRequest(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns`, {
@@ -40,6 +138,22 @@ export class Return {
             });
         });
     }
+    /**
+     * This method cancels a return. It sends a request to the
+     * [Cancel Return](https://docs.medusajs.com/api/admin#returns_postreturnsidcancel)
+     * API route.
+     *
+     * @param id - The ID of the return to cancel.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.cancel("return_123")
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     cancel(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/cancel`, {
@@ -49,6 +163,22 @@ export class Return {
             });
         });
     }
+    /**
+     * This method cancels a return request. It sends a request to the
+     * [Cancel Return Request](https://docs.medusajs.com/api/admin#returns_deletereturnsidrequest)
+     * API route.
+     *
+     * @param id - The ID of the return to cancel.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.cancelRequest("return_123")
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     cancelRequest(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/request`, {
@@ -58,6 +188,26 @@ export class Return {
             });
         });
     }
+    /**
+     * This method adds an item to a return request. It sends a request to the
+     * [Add Return Item](https://docs.medusajs.com/api/admin#returns_postreturnsidrequestitems)
+     * API route.
+     *
+     * @param id - The ID of the return to add the item to.
+     * @param body - The details of the item to add to the return.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.addReturnItem("return_123", {
+     *   id: "orlitem_123",
+     *   quantity: 1,
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     addReturnItem(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/request-items`, {
@@ -68,6 +218,31 @@ export class Return {
             });
         });
     }
+    /**
+     * This method updates an item in a return request by the ID of the item's `RETURN_ITEM` action.
+     * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
+     * using its `action` property, and use the value of the `id` property. For example,
+     * `item.actions.find((action) => action.action === "RETURN_ITEM")?.id` is the ID of an item's `RETURN_ITEM` action.
+     *
+     * This method sends a request to the
+     * [Update Requested Return Item](https://docs.medusajs.com/api/admin#returns_postreturnsidrequestitemsaction_id)
+     * API route.
+     *
+     * @param id - The ID of the return to update the item in.
+     * @param actionId - The ID of the item's `RETURN_ITEM` action.
+     * @param body - The details of the item to update.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.updateReturnItem("return_123", "orchach_123", {
+     *   quantity: 2,
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     updateReturnItem(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/request-items/${actionId}`, {
@@ -78,6 +253,29 @@ export class Return {
             });
         });
     }
+    /**
+     * This method removes an item from a return request by the ID of the item's `RETURN_ITEM` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
+     * using its `action` property, and use the value of the `id` property. For example,
+     * `item.actions.find((action) => action.action === "RETURN_ITEM")?.id` is the ID of an item's `RETURN_ITEM` action.
+     *
+     * This method sends a request to the
+     * [Remove Item from Return](https://docs.medusajs.com/api/admin#returns_deletereturnsidrequestitemsaction_id)
+     * API route.
+     *
+     * @param id - The ID of the return to remove the item from.
+     * @param actionId - The ID of the item's `RETURN_ITEM` action.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.removeReturnItem("return_123", "orchach_123")
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     removeReturnItem(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/request-items/${actionId}`, {
@@ -87,6 +285,25 @@ export class Return {
             });
         });
     }
+    /**
+     * This method adds a shipping method to a return request. It sends a request to the
+     * [Add Shipping Method to Return](https://docs.medusajs.com/api/admin#returns_postreturnsidshippingmethod)
+     * API route.
+     *
+     * @param id - The ID of the return to add the shipping method to.
+     * @param body - The details of the shipping method to add to the return.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.addReturnShipping("return_123", {
+     *   shipping_option_id: "so_123",
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     addReturnShipping(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/shipping-method`, {
@@ -97,6 +314,34 @@ export class Return {
             });
         });
     }
+    /**
+     * This method updates a shipping method in a return request by the ID of the shipping method's `SHIPPING_ADD` action.
+     *
+     * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name
+     * using its `action` property, and use the value of the `id` property.
+     *
+     * For example, `shipping_method.actions.find((action) => action.action === "SHIPPING_ADD")?.id` is
+     * the ID of a shipping method's `SHIPPING_ADD` action.
+     *
+     * This method sends a request to the
+     * [Update Shipping Method in Return](https://docs.medusajs.com/api/admin#returns_postreturnsidshippingmethodaction_id)
+     * API route.
+     *
+     * @param id - The ID of the return to update the shipping method in.
+     * @param actionId - The ID of the shipping method's `SHIPPING_ADD` action.
+     * @param body - The details of the shipping method to update.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.updateReturnShipping("return_123", "orchach_123", {
+     *   custom_amount: 100,
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     updateReturnShipping(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/shipping-method/${actionId}`, {
@@ -107,6 +352,31 @@ export class Return {
             });
         });
     }
+    /**
+     * This method removes a shipping method from a return request by the ID of the shipping method's `SHIPPING_ADD` action.
+     *
+     * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name
+     * using its `action` property, and use the value of the `id` property.
+     *
+     * For example, `shipping_method.actions.find((action) => action.action === "SHIPPING_ADD")?.id` is
+     * the ID of a shipping method's `SHIPPING_ADD` action.
+     *
+     * This method sends a request to the
+     * [Remove Shipping Method from Return](https://docs.medusajs.com/api/admin#returns_deletereturnsidshippingmethodaction_id)
+     * API route.
+     *
+     * @param id - The ID of the return to remove the shipping method from.
+     * @param actionId - The ID of the shipping method's `SHIPPING_ADD` action.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.deleteReturnShipping("return_123", "orchach_123")
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     deleteReturnShipping(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/shipping-method/${actionId}`, {
@@ -116,6 +386,25 @@ export class Return {
             });
         });
     }
+    /**
+     * This method updates a return request. It sends a request to the
+     * [Update Return](https://docs.medusajs.com/api/admin#returns_postreturnsid)
+     * API route.
+     *
+     * @param id - The ID of the return to update.
+     * @param body - The details of the return to update.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.updateRequest("return_123", {
+     *   location_id: "sloc_123",
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     updateRequest(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}`, {
@@ -126,6 +415,30 @@ export class Return {
             });
         });
     }
+    /**
+     * This method confirms a return request. The return's changes are applied on the inventory quantity of the return
+     * items and the order only after the return has been confirmed as received using the
+     * [Confirm Return Receival](https://docs.medusajs.com/api/admin#returns_postreturnsidreceiveconfirm)
+     * API route.
+     *
+     * This method sends a request to the
+     * [Confirm Return Request](https://docs.medusajs.com/api/admin#returns_postreturnsidrequest)
+     * API route.
+     *
+     * @param id - The ID of the return to confirm.
+     * @param body - The details of the return to confirm.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.confirmRequest("return_123", {
+     *   no_notification: true,
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     confirmRequest(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/request`, {
@@ -136,6 +449,25 @@ export class Return {
             });
         });
     }
+    /**
+     * This method starts the return receival process. It sends a request to the
+     * [Start Return Receival](https://docs.medusajs.com/api/admin#returns_postreturnsidreceive)
+     * API route.
+     *
+     * @param id - The ID of the return to start the receival process.
+     * @param body - The details of the return to start the receival process.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.initiateReceive("return_123", {
+     *   internal_note: "Return received by the customer",
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     initiateReceive(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/receive`, {
@@ -146,6 +478,29 @@ export class Return {
             });
         });
     }
+    /**
+     * This method adds received items to a return. These items will have the action `RECEIVE_RETURN_ITEM`.
+     *
+     * The method sends a request to the
+     * [Add Received Items](https://docs.medusajs.com/api/admin#returns_postreturnsidreceiveitems)
+     * API route.
+     *
+     * @param id - The ID of the return to add the received items to.
+     * @param body - The details of the received items to add to the return.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.receiveItems("return_123", {
+     *   items: [
+     *     { id: "item_123", quantity: 1 },
+     *   ],
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     receiveItems(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/receive-items`, {
@@ -156,6 +511,34 @@ export class Return {
             });
         });
     }
+    /**
+     * This method updates a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
+     * using its `action` property, and use the value of the `id` property.
+     *
+     * For example, `received_item.actions.find((action) => action.action === "RECEIVE_RETURN_ITEM")?.id` is
+     * the ID of a received item's `RECEIVE_RETURN_ITEM` action.
+     *
+     * This method sends a request to the
+     * [Update Received Item](https://docs.medusajs.com/api/admin#returns_postreturnsidreceiveitemsaction_id)
+     * API route.
+     *
+     * @param id - The ID of the return to update the received item in.
+     * @param actionId - The ID of the received item's `RECEIVE_RETURN_ITEM` action.
+     * @param body - The details of the received item to update.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.updateReceiveItem("return_123", "orchach_123", {
+     *   quantity: 2,
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     updateReceiveItem(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/receive-items/${actionId}`, {
@@ -166,6 +549,31 @@ export class Return {
             });
         });
     }
+    /**
+     * This method removes a received item from the return by the ID of the item's `RECEIVE_RETURN_ITEM` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
+     * using its `action` property, and use the value of the `id` property.
+     *
+     * For example, `received_item.actions.find((action) => action.action === "RECEIVE_RETURN_ITEM")?.id` is
+     * the ID of a received item's `RECEIVE_RETURN_ITEM` action.
+     *
+     * This method sends a request to the
+     * [Remove Received Item](https://docs.medusajs.com/api/admin#returns_deletereturnsidreceiveitemsaction_id)
+     * API route.
+     *
+     * @param id - The ID of the return to remove the received item from.
+     * @param actionId - The ID of the received item's `RECEIVE_RETURN_ITEM` action.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.removeReceiveItem("return_123", "orchach_123")
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     removeReceiveItem(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/receive-items/${actionId}`, {
@@ -175,6 +583,32 @@ export class Return {
             });
         });
     }
+    /**
+     * This method adds damaged items to the return. These items will have the action `RECEIVE_DAMAGED_RETURN_ITEM`.
+     *
+     * A damaged item's quantity is not added back to the associated inventory item's quantity in the
+     * stock location where the return is initiated from.
+     *
+     * The method sends a request to the
+     * [Add Damaged Items](https://docs.medusajs.com/api/admin#returns_postreturnsiddismissitems)
+     * API route.
+     *
+     * @param id - The ID of the return to add the damaged items to.
+     * @param body - The details of the damaged items to add to the return.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.dismissItems("return_123", {
+     *   items: [
+     *     { id: "orli_123", quantity: 1 },
+     *   ],
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     dismissItems(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/dismiss-items`, {
@@ -185,6 +619,34 @@ export class Return {
             });
         });
     }
+    /**
+     * This method updates a damaged item in the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
+     * using its `action` property, and use the value of the `id` property.
+     *
+     * For example, `item.actions.find((action) => action.action === "RECEIVE_DAMAGED_RETURN_ITEM")?.id` is
+     * the ID of a damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
+     *
+     * This method sends a request to the
+     * [Update Damaged Item](https://docs.medusajs.com/api/admin#returns_postreturnsiddismissitemsaction_id)
+     * API route.
+     *
+     * @param id - The ID of the return to update the damaged item in.
+     * @param actionId - The ID of the damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
+     * @param body - The details of the damaged item to update.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.updateDismissItem("return_123", "orchach_123", {
+     *   quantity: 2,
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     updateDismissItem(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/dismiss-items/${actionId}`, {
@@ -195,6 +657,31 @@ export class Return {
             });
         });
     }
+    /**
+     * This method removes a damaged item from the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
+     * using its `action` property, and use the value of the `id` property.
+     *
+     * For example, `item.actions.find((action) => action.action === "RECEIVE_DAMAGED_RETURN_ITEM")?.id` is
+     * the ID of a damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
+     *
+     * This method sends a request to the
+     * [Remove Damaged Item](https://docs.medusajs.com/api/admin#returns_deletereturnsiddismissitemsaction_id)
+     * API route.
+     *
+     * @param id - The ID of the return to remove the damaged item from.
+     * @param actionId - The ID of the damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.removeDismissItem("return_123", "orchach_123")
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     removeDismissItem(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/dismiss-items/${actionId}`, {
@@ -204,6 +691,25 @@ export class Return {
             });
         });
     }
+    /**
+     * This method confirms the return receival. It sends a request to the
+     * [Confirm Return Receival](https://docs.medusajs.com/api/admin#returns_postreturnsidreceiveconfirm)
+     * API route.
+     *
+     * @param id - The ID of the return to confirm the receival of.
+     * @param body - The details of the receival confirmation.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.confirmReceive("return_123", {
+     *   no_notification: true,
+     * })
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     confirmReceive(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/receive/confirm`, {
@@ -214,6 +720,22 @@ export class Return {
             });
         });
     }
+    /**
+     * This method cancels a return receival. It sends a request to the
+     * [Cancel Return Receival](https://docs.medusajs.com/api/admin#returns_deletereturnsidreceive)
+     * API route.
+     *
+     * @param id - The ID of the return to cancel the receival of.
+     * @param query - Configure the fields and relations to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The return's details.
+     *
+     * @example
+     * sdk.admin.return.cancelReceive("return_123")
+     * .then(({ return }) => {
+     *   console.log(return)
+     * })
+     */
     cancelReceive(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/returns/${id}/receive`, {

package/dist/esm/admin/return.js.map

@@ -1 +1 @@
-{"version":3,"file":"return.js","sourceRoot":"","sources":["../../../src/admin/return.ts"],"names":[],"mappings":";;;;;;;;;AAKA,MAAM,OAAO,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CAAC,KAAoC,EAAE,OAAuB;;YACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,eAAe,CACnB,IAA0C,EAC1C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,SAAS,EAC7B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,UAAU,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,aAAa,CACjB,EAAU,EACV,IAAmC,EACnC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,gBAAgB,EACpC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,gBAAgB,CACpB,EAAU,EACV,QAAgB,EAChB,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,gBAAgB,CACpB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,EAAU,EACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,EACtC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,oBAAoB,CACxB,EAAU,EACV,QAAgB,EAChB,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,oBAAoB,QAAQ,EAAE,EAClD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,oBAAoB,CACxB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,oBAAoB,QAAQ,EAAE,EAClD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,aAAa,CACjB,EAAU,EACV,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,cAAc,CAClB,EAAU,EACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,UAAU,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,eAAe,CACnB,EAAU,EACV,IAA0C,EAC1C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,UAAU,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,YAAY,CAChB,EAAU,EACV,IAAiC,EACjC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,gBAAgB,EACpC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,IAAuC,EACvC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,YAAY,CAChB,EAAU,EACV,IAAiC,EACjC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,gBAAgB,EACpC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,IAAuC,EACvC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,cAAc,CAClB,EAAU,EACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,EACtC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,UAAU,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"return.js","sourceRoot":"","sources":["../../../src/admin/return.ts"],"names":[],"mappings":";;;;;;;;;AAKA,MAAM,OAAO,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CAAC,KAAoC,EAAE,OAAuB;;YACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,eAAe,CACnB,IAA0C,EAC1C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACV,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,SAAS,EAC7B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,UAAU,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CACjB,EAAU,EACV,IAAmC,EACnC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,gBAAgB,EACpC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,gBAAgB,CACpB,EAAU,EACV,QAAgB,EAChB,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,gBAAgB,CACpB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,iBAAiB,CACrB,EAAU,EACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,EACtC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,oBAAoB,CACxB,EAAU,EACV,QAAgB,EAChB,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,oBAAoB,QAAQ,EAAE,EAClD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,oBAAoB,CACxB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,oBAAoB,QAAQ,EAAE,EAClD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,aAAa,CACjB,EAAU,EACV,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,cAAc,CAClB,EAAU,EACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,UAAU,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,eAAe,CACnB,EAAU,EACV,IAA0C,EAC1C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,UAAU,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,YAAY,CAChB,EAAU,EACV,IAAiC,EACjC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,gBAAgB,EACpC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,IAAuC,EACvC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,YAAY,CAChB,EAAU,EACV,IAAiC,EACjC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,gBAAgB,EACpC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,IAAuC,EACvC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,EAAU,EACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,kBAAkB,EACtC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,UAAU,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}