@medusajs/js-sdk 1.0.0-rc-20241016093905 → 1.0.0-rc-20241022152047

package/dist/admin/inventory-item.d.ts

@@ -2,16 +2,273 @@ import { HttpTypes, SelectParams } from "@medusajs/types";
 import { Client } from "../client";
 import { ClientHeaders } from "../types";
 export declare class InventoryItem {
+    /**
+     * @ignore
+     */
     private client;
+    /**
+     * @ignore
+     */
     constructor(client: Client);
+    /**
+     * This method creates an inventory item. It sends a request to the
+     * [Create Inventory Item](https://docs.medusajs.com/v2/api/admin#inventory-items_postinventoryitems)
+     * API route.
+     *
+     * @param body - The inventory item's details.
+     * @param query - Configure the fields to retrieve in the inventory item.
+     * @param headers - Headers to pass in the request.
+     * @returns The inventory item's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.create({
+     *   sku: "SHIRT"
+     * })
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     */
     create(body: HttpTypes.AdminCreateInventoryItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
+    /**
+     * This method updates an inventory level. It sends a request to the
+     * [Update Inventory Item](https://docs.medusajs.com/v2/api/admin#inventory-items_postinventoryitemsid)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param body - The data to update.
+     * @param query - Configure the fields to retrieve in the inventory item.
+     * @param headers - Headers to pass in the request.
+     * @returns The inventory item's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.update("iitem_123", {
+     *   sku: "SHIRT"
+     * })
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateInventoryItem, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
+    /**
+     * This method retrieves a paginated list of inventory items. It sends a request to the
+     * [List Inventory Items](https://docs.medusajs.com/v2/api/admin#inventory-items_getinventoryitems)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of inventory items.
+     *
+     * @example
+     * To retrieve the list of inventory items:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.list()
+     * .then(({ inventory_items, count, limit, offset }) => {
+     *   console.log(inventory_items)
+     * })
+     * ```
+     *
+     * 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.inventoryItem.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ inventory_items, count, limit, offset }) => {
+     *   console.log(inventory_items)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each inventory item:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.list({
+     *   fields: "id,*location_levels"
+     * })
+     * .then(({ inventory_items, count, limit, offset }) => {
+     *   console.log(inventory_items)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminInventoryItemParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemListResponse>;
+    /**
+     * This method retrieves an inventory item by its ID. It sends a request to the
+     * [Get Inventory Item](https://docs.medusajs.com/v2/api/admin#inventory-items_getinventoryitemsid) API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param query - Configure the fields to retrieve in the inventory item.
+     * @param headers - Headers to pass in the request
+     * @returns The inventory item's details.
+     *
+     * @example
+     * To retrieve an inventory item by its ID:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.retrieve("iitem_123")
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.retrieve("iitem_123", {
+     *   fields: "id,*location_levels"
+     * })
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
+    /**
+     * This method deletes an inventory item. This sends a request to the
+     * [Delete Inventory Item](https://docs.medusajs.com/v2/api/admin#inventory-items_deleteinventoryitemsid)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.delete("iitem_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemDeleteResponse>;
+    /**
+     * This method retrieves a paginated list of inventory levels that belong to an inventory item.
+     * It sends a request to the [List Inventory Items](https://docs.medusajs.com/v2/api/admin#inventory-items_getinventoryitems)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of inventory levels.
+     *
+     * @example
+     * To retrieve the list of inventory levels:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.listLevels("iitem_123")
+     * .then(({ inventory_levels, count, limit, offset }) => {
+     *   console.log(inventory_levels)
+     * })
+     * ```
+     *
+     * 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.inventoryItem.listLevels("iitem_123", {
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ inventory_levels, count, limit, offset }) => {
+     *   console.log(inventory_levels)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each inventory level:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.listLevels("iitem_123", {
+     *   fields: "id,*inventory_item"
+     * })
+     * .then(({ inventory_levels, count, limit, offset }) => {
+     *   console.log(inventory_levels)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     listLevels(id: string, query?: HttpTypes.AdminInventoryLevelFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryLevelListResponse>;
+    /**
+     * This method updates the inventory level of the specified inventory item and
+     * stock location.
+     *
+     * This method sends a request to the
+     * [Update Inventory Level](https://docs.medusajs.com/v2/api/admin#inventory-items_postinventoryitemsidlocationlevelslocation_id)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param locationId - The stock location's ID.
+     * @param body - The details to update.
+     * @param query - Configure the fields to retrieve in the inventory item.
+     * @param headers - Headers to pass in the request
+     * @returns The inventory item's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.updateLevel(
+     *   "iitem_123",
+     *   "sloc_123",
+     *   {
+     *     stocked_quantity: 10
+     *   }
+     * )
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     */
     updateLevel(id: string, locationId: string, body: HttpTypes.AdminUpdateInventoryLevel, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
-    deleteLevel(id: string, locationId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemDeleteResponse>;
+    /**
+     * This method deletes an inventory level associated with an inventory item
+     * and a stock location.
+     *
+     * This method sends a request to the
+     * [Remove Inventory Level](https://docs.medusajs.com/v2/api/admin#inventory-items_deleteinventoryitemsidlocationlevelslocation_id)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param locationId - The stock location's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.deleteLevel(
+     *   "iitem_123",
+     *   "sloc_123",
+     * )
+     * .then(({ deleted, parent: inventoryItem }) => {
+     *   console.log(deleted, inventoryItem)
+     * })
+     */
+    deleteLevel(id: string, locationId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryLevelDeleteResponse>;
+    /**
+     * This method manages the inventory levels of an inventory item. It sends a request to the
+     * [Manage Inventory Levels](https://docs.medusajs.com/v2/api/admin#inventory-items_postinventoryitemsidlocationlevelsbatch)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param body - The inventory levels to create or delete.
+     * @param query - Configure the fields to retrieve in the inventory item.
+     * @param headers - Headers to pass in the request
+     * @returns The inventory item's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.batchUpdateLevels("iitem_123", {
+     *   create: [{
+     *     location_id: "sloc_123",
+     *     stocked_quantity: 10
+     *   }],
+     *   delete: ["sloc_123"]
+     * })
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     */
     batchUpdateLevels(id: string, body: HttpTypes.AdminBatchUpdateInventoryLevelLocation, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
 }
 //# sourceMappingURL=inventory-item.d.ts.map

package/dist/admin/inventory-item.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inventory-item.d.ts","sourceRoot":"","sources":["../../src/admin/inventory-item.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAQ;gBACV,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAanB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,wBAAwB,EAC1C,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUlE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,UAAU,CACd,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAWnB,WAAW,CACf,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAanB,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUnE,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sCAAsC,EACtD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}
+{"version":3,"file":"inventory-item.d.ts","sourceRoot":"","sources":["../../src/admin/inventory-item.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,aAAa;IACxB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,wBAAwB,EAC1C,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUzE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sCAAsC,EACtD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}

package/dist/admin/inventory-item.js

@@ -2,9 +2,30 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InventoryItem = void 0;
 class InventoryItem {
+    /**
+     * @ignore
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates an inventory item. It sends a request to the
+     * [Create Inventory Item](https://docs.medusajs.com/v2/api/admin#inventory-items_postinventoryitems)
+     * API route.
+     *
+     * @param body - The inventory item's details.
+     * @param query - Configure the fields to retrieve in the inventory item.
+     * @param headers - Headers to pass in the request.
+     * @returns The inventory item's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.create({
+     *   sku: "SHIRT"
+     * })
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     */
     async create(body, query, headers) {
         return await this.client.fetch(`/admin/inventory-items`, {
             method: "POST",
@@ -13,6 +34,25 @@ class InventoryItem {
             query,
         });
     }
+    /**
+     * This method updates an inventory level. It sends a request to the
+     * [Update Inventory Item](https://docs.medusajs.com/v2/api/admin#inventory-items_postinventoryitemsid)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param body - The data to update.
+     * @param query - Configure the fields to retrieve in the inventory item.
+     * @param headers - Headers to pass in the request.
+     * @returns The inventory item's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.update("iitem_123", {
+     *   sku: "SHIRT"
+     * })
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     */
     async update(id, body, query, headers) {
         return await this.client.fetch(`/admin/inventory-items/${id}`, {
             method: "POST",
@@ -21,30 +61,199 @@ class InventoryItem {
             query,
         });
     }
+    /**
+     * This method retrieves a paginated list of inventory items. It sends a request to the
+     * [List Inventory Items](https://docs.medusajs.com/v2/api/admin#inventory-items_getinventoryitems)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of inventory items.
+     *
+     * @example
+     * To retrieve the list of inventory items:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.list()
+     * .then(({ inventory_items, count, limit, offset }) => {
+     *   console.log(inventory_items)
+     * })
+     * ```
+     *
+     * 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.inventoryItem.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ inventory_items, count, limit, offset }) => {
+     *   console.log(inventory_items)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each inventory item:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.list({
+     *   fields: "id,*location_levels"
+     * })
+     * .then(({ inventory_items, count, limit, offset }) => {
+     *   console.log(inventory_items)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     async list(query, headers) {
         return await this.client.fetch(`/admin/inventory-items`, {
             query,
             headers,
         });
     }
+    /**
+     * This method retrieves an inventory item by its ID. It sends a request to the
+     * [Get Inventory Item](https://docs.medusajs.com/v2/api/admin#inventory-items_getinventoryitemsid) API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param query - Configure the fields to retrieve in the inventory item.
+     * @param headers - Headers to pass in the request
+     * @returns The inventory item's details.
+     *
+     * @example
+     * To retrieve an inventory item by its ID:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.retrieve("iitem_123")
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.retrieve("iitem_123", {
+     *   fields: "id,*location_levels"
+     * })
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     async retrieve(id, query, headers) {
         return await this.client.fetch(`/admin/inventory-items/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * This method deletes an inventory item. This sends a request to the
+     * [Delete Inventory Item](https://docs.medusajs.com/v2/api/admin#inventory-items_deleteinventoryitemsid)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.delete("iitem_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return await this.client.fetch(`/admin/inventory-items/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method retrieves a paginated list of inventory levels that belong to an inventory item.
+     * It sends a request to the [List Inventory Items](https://docs.medusajs.com/v2/api/admin#inventory-items_getinventoryitems)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of inventory levels.
+     *
+     * @example
+     * To retrieve the list of inventory levels:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.listLevels("iitem_123")
+     * .then(({ inventory_levels, count, limit, offset }) => {
+     *   console.log(inventory_levels)
+     * })
+     * ```
+     *
+     * 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.inventoryItem.listLevels("iitem_123", {
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ inventory_levels, count, limit, offset }) => {
+     *   console.log(inventory_levels)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each inventory level:
+     *
+     * ```ts
+     * sdk.admin.inventoryItem.listLevels("iitem_123", {
+     *   fields: "id,*inventory_item"
+     * })
+     * .then(({ inventory_levels, count, limit, offset }) => {
+     *   console.log(inventory_levels)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     async listLevels(id, query, headers) {
         return await this.client.fetch(`/admin/inventory-items/${id}/location-levels`, {
             query,
             headers,
         });
     }
+    /**
+     * This method updates the inventory level of the specified inventory item and
+     * stock location.
+     *
+     * This method sends a request to the
+     * [Update Inventory Level](https://docs.medusajs.com/v2/api/admin#inventory-items_postinventoryitemsidlocationlevelslocation_id)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param locationId - The stock location's ID.
+     * @param body - The details to update.
+     * @param query - Configure the fields to retrieve in the inventory item.
+     * @param headers - Headers to pass in the request
+     * @returns The inventory item's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.updateLevel(
+     *   "iitem_123",
+     *   "sloc_123",
+     *   {
+     *     stocked_quantity: 10
+     *   }
+     * )
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     */
     async updateLevel(id, locationId, body, query, headers) {
         return await this.client.fetch(`/admin/inventory-items/${id}/location-levels/${locationId}`, {
             method: "POST",
@@ -53,12 +262,57 @@ class InventoryItem {
             query,
         });
     }
+    /**
+     * This method deletes an inventory level associated with an inventory item
+     * and a stock location.
+     *
+     * This method sends a request to the
+     * [Remove Inventory Level](https://docs.medusajs.com/v2/api/admin#inventory-items_deleteinventoryitemsidlocationlevelslocation_id)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param locationId - The stock location's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.deleteLevel(
+     *   "iitem_123",
+     *   "sloc_123",
+     * )
+     * .then(({ deleted, parent: inventoryItem }) => {
+     *   console.log(deleted, inventoryItem)
+     * })
+     */
     async deleteLevel(id, locationId, headers) {
         return await this.client.fetch(`/admin/inventory-items/${id}/location-levels/${locationId}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method manages the inventory levels of an inventory item. It sends a request to the
+     * [Manage Inventory Levels](https://docs.medusajs.com/v2/api/admin#inventory-items_postinventoryitemsidlocationlevelsbatch)
+     * API route.
+     *
+     * @param id - The inventory item's ID.
+     * @param body - The inventory levels to create or delete.
+     * @param query - Configure the fields to retrieve in the inventory item.
+     * @param headers - Headers to pass in the request
+     * @returns The inventory item's details.
+     *
+     * @example
+     * sdk.admin.inventoryItem.batchUpdateLevels("iitem_123", {
+     *   create: [{
+     *     location_id: "sloc_123",
+     *     stocked_quantity: 10
+     *   }],
+     *   delete: ["sloc_123"]
+     * })
+     * .then(({ inventory_item }) => {
+     *   console.log(inventory_item)
+     * })
+     */
     async batchUpdateLevels(id, body, query, headers) {
         return await this.client.fetch(`/admin/inventory-items/${id}/location-levels/batch`, {
             method: "POST",

package/dist/admin/inventory-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"inventory-item.js","sourceRoot":"","sources":["../../src/admin/inventory-item.ts"],"names":[],"mappings":";;;AAIA,MAAa,aAAa;IAExB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAA0C,EAC1C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CACd,EAAU,EACV,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,kBAAkB,EAC9C;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CACf,EAAU,EACV,UAAkB,EAClB,IAAyC,EACzC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,oBAAoB,UAAU,EAAE,EAC5D;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,EAAU,EAAE,UAAkB,EAAE,OAAuB;QACvE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,oBAAoB,UAAU,EAAE,EAC5D;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,EAAU,EACV,IAAsD,EACtD,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,wBAAwB,EACpD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAlID,sCAkIC"}
+{"version":3,"file":"inventory-item.js","sourceRoot":"","sources":["../../src/admin/inventory-item.ts"],"names":[],"mappings":";;;AAIA,MAAa,aAAa;IAKxB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA0C,EAC1C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,KAAK,CAAC,UAAU,CACd,EAAU,EACV,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,kBAAkB,EAC9C;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,WAAW,CACf,EAAU,EACV,UAAkB,EAClB,IAAyC,EACzC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,oBAAoB,UAAU,EAAE,EAC5D;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,WAAW,CAAC,EAAU,EAAE,UAAkB,EAAE,OAAuB;QACvE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,oBAAoB,UAAU,EAAE,EAC5D;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,iBAAiB,CACrB,EAAU,EACV,IAAsD,EACtD,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,wBAAwB,EACpD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAnYD,sCAmYC"}