@medusajs/types 1.12.0-snapshot-20240405070935 → 1.12.0-snapshot-20240406075900

package/dist/stock-location/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/stock-location/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AAIpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAA;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG;IACxD;;OAEG;IACH,cAAc,CAAC,EAAE,GAAG,EAAE,CAAA;CACvB,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,4BAA4B,CAAC;IACpD;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CAC/C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAA;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,yBAAyB,CAAA;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG,wBAAwB,GAAG;IACpE,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAA"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/stock-location/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AAIpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAA;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG;IACxD;;OAEG;IACH,cAAc,CAAC,EAAE,GAAG,EAAE,CAAA;CACvB,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,4BAA4B,CAAC;IACpD;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CAC/C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAA;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,yBAAyB,CAAA;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,wBAAwB,GAAG;IACpE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAA"}

package/dist/stock-location/service-next.d.ts

@@ -4,283 +4,275 @@ import { Context } from "../shared-context";
 import { FindConfig } from "../common/common";
 import { IModuleService } from "../modules-sdk";
 /**
- * The main service interface for the stock location's module.
+ * The main service interface for the Stock Location Module.
  */
 export interface IStockLocationServiceNext extends IModuleService {
     /**
-     * This method is used to retrieve a paginated list of stock locations based on optional filters and configuration.
+     * This method retrieves a paginated list of stock locations based on optional filters and configuration.
      *
      * @param {FilterableStockLocationProps} selector - The filters to apply on the retrieved stock locations.
-     * @param {FindConfig<StockLocationDTO>} config -
-     * The configurations determining how the stock locations are retrieved. Its properties, such as `select` or `relations`, accept the
+     * @param {FindConfig<StockLocationDTO>} config - The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the
      * attributes or relations associated with a stock location.
      * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
-     * @return {Promise<StockLocationDTO[]>} The list of stock locations.
+     * @returns {Promise<StockLocationDTO[]>} The list of stock locations.
      *
      * @example
      * To retrieve a list of stock locations using their IDs:
      *
      * ```ts
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function listStockLocations (ids: string[]) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
-     *
-     *   const stockLocations = await stockLocationModule.list({
-     *     id: ids
-     *   })
-     *
-     *   // do something with the stock locations or return them
-     * }
+     * const stockLocations = await stockLocationModuleService.list({
+     *   id: ["sloc_123", "sloc_321"],
+     * })
      * ```
      *
      * To specify relations that should be retrieved within the stock locations:
      *
      * ```ts
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function listStockLocations (ids: string[]) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
-     *
-     *   const stockLocations = await stockLocationModule.list({
-     *     id: ids
-     *   }, {
-     *     relations: ["address"]
-     *   })
-     *
-     *   // do something with the stock locations or return them
-     * }
+     * const stockLocations = await stockLocationModuleService.list(
+     *   {
+     *     id: ["sloc_123", "sloc_321"],
+     *   },
+     *   {
+     *     relations: ["address"],
+     *   }
+     * )
      * ```
      *
      * By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
      *
      * ```ts
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function listStockLocations (ids: string[], skip: number, take: number) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
-     *
-     *   const stockLocations = await stockLocationModule.list({
-     *     id: ids
-     *   }, {
+     * const stockLocations = await stockLocationModuleService.list(
+     *   {
+     *     id: ["sloc_123", "sloc_321"],
+     *   },
+     *   {
      *     relations: ["address"],
-     *     skip,
-     *     take
-     *   })
-     *
-     *   // do something with the stock locations or return them
-     * }
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
      * ```
      */
     list(selector: FilterableStockLocationProps, config?: FindConfig<StockLocationDTO>, context?: Context): Promise<StockLocationDTO[]>;
     /**
-     * This method is used to retrieve a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters.
+     * This method retrieves a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters.
      *
      * @param {FilterableStockLocationProps} selector - The filters to apply on the retrieved stock locations.
-     * @param {FindConfig<StockLocationDTO>} config -
-     * The configurations determining how the stock locations are retrieved. Its properties, such as `select` or `relations`, accept the
+     * @param {FindConfig<StockLocationDTO>} config - The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the
      * attributes or relations associated with a stock location.
      * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
-     * @return {Promise<[StockLocationDTO[], number]>} The list of stock locations along with the total count.
+     * @returns {Promise<[StockLocationDTO[], number]>} The list of stock locations along with their total count.
      *
      * @example
      * To retrieve a list of stock locations using their IDs:
      *
      * ```ts
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function listStockLocations (ids: string[]) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
-     *
-     *   const [stockLocations, count] = await stockLocationModule.listAndCount({
-     *     id: ids
+     * const [stockLocations, count] =
+     *   await stockLocationModuleService.list({
+     *     id: ["sloc_123", "sloc_321"],
      *   })
-     *
-     *   // do something with the stock locations or return them
-     * }
      * ```
      *
      * To specify relations that should be retrieved within the stock locations:
      *
      * ```ts
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function listStockLocations (ids: string[]) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
-     *
-     *   const [stockLocations, count] = await stockLocationModule.listAndCount({
-     *     id: ids
-     *   }, {
-     *     relations: ["address"]
-     *   })
-     *
-     *   // do something with the stock locations or return them
-     * }
+     * const [stockLocations, count] =
+     *   await stockLocationModuleService.list(
+     *     {
+     *       id: ["sloc_123", "sloc_321"],
+     *     },
+     *     {
+     *       relations: ["address"],
+     *     }
+     *   )
      * ```
      *
      * By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
      *
      * ```ts
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function listStockLocations (ids: string[], skip: number, take: number) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
-     *
-     *   const [stockLocations, count] = await stockLocationModule.listAndCount({
-     *     id: ids
-     *   }, {
-     *     relations: ["address"],
-     *     skip,
-     *     take
-     *   })
-     *
-     *   // do something with the stock locations or return them
-     * }
+     * const [stockLocations, count] =
+     *   await stockLocationModuleService.list(
+     *     {
+     *       id: ["sloc_123", "sloc_321"],
+     *     },
+     *     {
+     *       relations: ["address"],
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
      * ```
      */
     listAndCount(selector: FilterableStockLocationProps, config?: FindConfig<StockLocationDTO>, context?: Context): Promise<[StockLocationDTO[], number]>;
     /**
-     * This method is used to retrieve a stock location by its ID
+     * This method retrieves a stock location by its ID.
      *
-     * @param {string} id - The ID of the stock location
-     * @param {FindConfig<StockLocationDTO>} config -
-     * The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the
+     * @param {string} id - The ID of the stock location.
+     * @param {FindConfig<StockLocationDTO>} config - The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the
      * attributes or relations associated with a stock location.
      * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<StockLocationDTO>} The stock location's details.
+     * @returns {Promise<StockLocationDTO>} The retrieved stock location.
      *
      * @example
-     * A simple example that retrieves a inventory item by its ID:
-     *
-     * ```ts
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function retrieveStockLocation (id: string) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
-     *
-     *   const stockLocation = await stockLocationModule.retrieve(id)
-     *
-     *   // do something with the stock location or return it
-     * }
-     * ```
-     *
-     * To specify relations that should be retrieved:
-     *
-     * ```ts
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function retrieveStockLocation (id: string) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
-     *
-     *   const stockLocation = await stockLocationModule.retrieve(id, {
-     *     relations: ["address"]
-     *   })
-     *
-     *   // do something with the stock location or return it
-     * }
-     * ```
+     * const stockLocation =
+     *   await stockLocationModuleService.retrieve("sloc_123")
      */
     retrieve(id: string, config?: FindConfig<StockLocationDTO>, context?: Context): Promise<StockLocationDTO>;
     /**
-     * This method is used to create a stock location.
+     * This method creates a stock location.
      *
-     * @param {CreateStockLocationInput} input - The details of the stock location to create.
+     * @param {CreateStockLocationInput} input - The stock location to create.
      * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<StockLocationDTO>} The created stock location's details.
+     * @returns {Promise<StockLocationDTO>} The created stock location.
      *
      * @example
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function createStockLocation (name: string) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
+     * const stockLocation = await stockLocationModuleService.create(
+     *   {
+     *     name: "Warehouse",
+     *     address: {
+     *       address_1: "1855 Powder Mill Rd",
+     *       country_code: "us",
+     *     },
+     *   }
+     * )
+     */
+    create(input: CreateStockLocationInput, context?: Context): Promise<StockLocationDTO>;
+    /**
+     * This method creates stock locations.
      *
-     *   const stockLocation = await stockLocationModule.create({
-     *     name
-     *   })
+     * @param {CreateStockLocationInput[]} input - The stock locations to create.
+     * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StockLocationDTO[]>} The created stock locations.
      *
-     *   // do something with the stock location or return it
-     * }
+     * @example
+     * const stockLocations =
+     *   await stockLocationModuleService.create([
+     *     {
+     *       name: "Warehouse",
+     *       address: {
+     *         address_1: "1855 Powder Mill Rd",
+     *         country_code: "us",
+     *       },
+     *     },
+     *     {
+     *       name: "Warehouse 2",
+     *       address_id: "laddr_123",
+     *     },
+     *   ])
      */
-    create(input: CreateStockLocationInput, context?: Context): Promise<StockLocationDTO>;
     create(input: CreateStockLocationInput[], context?: Context): Promise<StockLocationDTO[]>;
+    /**
+     * This method updates or creates stock location service nexts if they don't exist.
+     *
+     * @param {Partial<UpdateStockLocationNextInput>[]} data - The list of Make all properties in t optional
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StockLocationDTO[]>} The created or updated stock location service nexts.
+     *
+     * @example
+     * {example-code}
+     */
     upsert(data: UpsertStockLocationInput[], sharedContext?: Context): Promise<StockLocationDTO[]>;
+    /**
+     * This method updates or creates a stock location service next if it doesn't exist.
+     *
+     * @param {Partial<UpdateStockLocationNextInput>} data - Make all properties in T optional
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StockLocationDTO>} The created or updated stock location service next.
+     *
+     * @example
+     * {example-code}
+     */
     upsert(data: UpsertStockLocationInput, sharedContext?: Context): Promise<StockLocationDTO>;
     /**
-     * This method is used to update a stock location.
+     * This method updates existing stock locations.
      *
-     * @param {string} id - The ID of the stock location.
-     * @param {UpdateStockLocationInput} input - The attributes to update in the stock location.
+     * @param {UpdateStockLocationNextInput[]} input - The attributes to update in the stock locations.
      * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<StockLocationDTO>} The stock location's details.
+     * @returns {Promise<StockLocationDTO[]>} The updated stock locations.
      *
      * @example
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function updateStockLocation (id:string, name: string) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
+     * const stockLocations =
+     *   await stockLocationModuleService.update([
+     *     {
+     *       id: "sloc_123",
+     *       name: "Warehouse",
+     *     },
+     *     {
+     *       id: "sloc_321",
+     *       address_id: "laddr_123",
+     *     },
+     *   ])
+     */
+    update(id: string, input: UpdateStockLocationInput, context?: Context): Promise<StockLocationDTO>;
+    /**
+     * This method updates existing stock locations matching the specified filters.
      *
-     *   const stockLocation = await stockLocationModule.update(id, {
-     *     name
-     *   })
+     * @param {FilterableStockLocationProps} selector - The filters specifying which stock locations to update.
+     * @param {UpdateStockLocationInput} input - The attributes to update in the stock locations.
+     * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<StockLocationDTO[]>} The updated stock locations.
      *
-     *   // do something with the stock location or return it
-     * }
+     * @example
+     * const stockLocations =
+     *   await stockLocationModuleService.update(
+     *     {
+     *       name: "Warehouse",
+     *     },
+     *     {
+     *       address_id: "laddr_123",
+     *     }
+     *   )
      */
-    update(id: string, input: UpdateStockLocationInput, context?: Context): Promise<StockLocationDTO>;
     update(selector: FilterableStockLocationProps, input: UpdateStockLocationInput, context?: Context): Promise<StockLocationDTO[]>;
     /**
-     * This method is used to delete a stock location.
+     * This method deletes a stock location by its ID.
      *
      * @param {string} id - The ID of the stock location.
      * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<void>} Resolves when the stock location is successfully deleted.
+     * @returns {Promise<void>} Resolves when the stock location is deleted successfully.
      *
      * @example
-     * import {
-     *   initialize as initializeStockLocationModule,
-     * } from "@medusajs/stock-location"
-     *
-     * async function deleteStockLocation (id:string) {
-     *   const stockLocationModule = await initializeStockLocationModule({})
-     *
-     *   await stockLocationModule.delete(id)
-     * }
+     * await stockLocationModuleService.delete("sloc_123")
      */
     delete(id: string, context?: Context): Promise<void>;
     /**
-     * Soft delete stock locations
-     * @param stockLocationIds
-     * @param config
-     * @param sharedContext
+     * This method soft deletes stock locations by their IDs.
+     *
+     * @param {string[]} stockLocationIds - The IDs of the stock locations.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated address.
+     * The object's keys are the ID attribute names of the stock location entity's relations, such as `address_id`, and its value is an array of strings, each being the ID of a record associated
+     * with the stock location through this relation, such as the IDs of associated address.
+     *
+     * If there are no related records, the promise resolves to `void`.
+     *
+     * @example
+     * await stockLocationModuleService.softDelete([
+     *   "sloc_123",
+     *   "sloc_321",
+     * ])
      */
     softDelete<TReturnableLinkableKeys extends string = string>(stockLocationIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
     /**
-     * This method is used to restore a stock location or multiple stock locations that were previously deleted using the {@link softDelete} method.
+     * This method restores soft deleted stock locations by their IDs.
      *
-     * @param {string[]} stockLocationIds - The ID(s) of the stock location(s) to restore.
-     * @param {RestoreReturn<TReturnableLinkableKeys>} config - Restore config
-     * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<void>} Resolves when the stock location(s) are successfully restored.
+     * @param {string[]} stockLocationIds - The IDs of the stock locations.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the stock location. You can pass to its `returnLinkableKeys`
+     * property any of the stock location's relation attribute names, such as `address`.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored, such as the ID of associated address.
+     * The object's keys are the ID attribute names of the stock location entity's relations, such as `address_id`,
+     * and its value is an array of strings, each being the ID of the record associated with the stock location through this relation,
+     * such as the ID of associated address.
+     *
+     * If there are no related records restored, the promise resolves to `void`.
+     *
+     * @example
+     * await stockLocationModuleService.restore([
+     *   "sloc_123",
+     *   "sloc_321",
+     * ])
      */
     restore<TReturnableLinkableKeys extends string = string>(stockLocationIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
 }

package/dist/stock-location/service-next.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service-next.d.ts","sourceRoot":"","sources":["../../src/stock-location/service-next.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,wBAAwB,EAExB,wBAAwB,EACzB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AAExD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,cAAc;IAC/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,IAAI,CACF,QAAQ,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,YAAY,CACV,QAAQ,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAC5B,MAAM,CACJ,KAAK,EAAE,wBAAwB,EAAE,EACjC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B,MAAM,CACJ,IAAI,EAAE,wBAAwB,EAAE,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAC9B,MAAM,CACJ,IAAI,EAAE,wBAAwB,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAC5B,MAAM,CACJ,QAAQ,EAAE,4BAA4B,EACtC,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpD;;;;;OAKG;IACH,UAAU,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACxD,gBAAgB,EAAE,MAAM,EAAE,EAC1B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;OAOG;IACH,OAAO,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACrD,gBAAgB,EAAE,MAAM,EAAE,EAC1B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CAC5C"}
+{"version":3,"file":"service-next.d.ts","sourceRoot":"","sources":["../../src/stock-location/service-next.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,wBAAwB,EAExB,wBAAwB,EACzB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,cAAc;IAC/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,IAAI,CACF,QAAQ,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,YAAY,CACV,QAAQ,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CACJ,KAAK,EAAE,wBAAwB,EAAE,EACjC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,MAAM,CACJ,IAAI,EAAE,wBAAwB,EAAE,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,MAAM,CACJ,IAAI,EAAE,wBAAwB,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,QAAQ,EAAE,4BAA4B,EACtC,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpD;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACxD,gBAAgB,EAAE,MAAM,EAAE,EAC1B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACrD,gBAAgB,EAAE,MAAM,EAAE,EAC1B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CAC5C"}

package/dist/store/common/store.d.ts

@@ -1,18 +1,60 @@
 import { BaseFilterable } from "../../dal";
+/**
+ * The store details.
+ */
 export interface StoreDTO {
+    /**
+     * The ID of the store.
+     */
     id: string;
+    /**
+     * The name of the store.
+     */
     name: string;
+    /**
+     * The supported currency codes of the store.
+     */
     supported_currency_codes: string[];
+    /**
+     * The default currency code of the store.
+     */
     default_currency_code?: string;
+    /**
+     * The associated default sales channel's ID.
+     */
     default_sales_channel_id?: string;
+    /**
+     * The associated default region's ID.
+     */
     default_region_id?: string;
+    /**
+     * The associated default location's ID.
+     */
     default_location_id?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata: Record<string, any> | null;
+    /**
+     * The created at of the store.
+     */
     created_at: string;
+    /**
+     * The updated at of the store.
+     */
     updated_at: string;
 }
+/**
+ * The filters to apply on the retrieved stores.
+ */
 export interface FilterableStoreProps extends BaseFilterable<FilterableStoreProps> {
+    /**
+     * The IDs to filter the stores by.
+     */
     id?: string | string[];
+    /**
+     * Filter stores by their names.
+     */
     name?: string | string[];
 }
 //# sourceMappingURL=store.d.ts.map

package/dist/store/common/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../src/store/common/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,wBAAwB,EAAE,MAAM,EAAE,CAAA;IAClC,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AACD,MAAM,WAAW,oBACf,SAAQ,cAAc,CAAC,oBAAoB,CAAC;IAC5C,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../src/store/common/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,wBAAwB,EAAE,MAAM,EAAE,CAAA;IAElC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;IAEjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,oBACf,SAAQ,cAAc,CAAC,oBAAoB,CAAC;IAC5C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB"}