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

package/dist/esm/admin/stock-location.d.ts

@@ -10,13 +10,203 @@ export declare class StockLocation {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a new stock location. It sends a request to the
+     * [Create Stock Location](https://docs.medusajs.com/api/admin#stock-locations_poststocklocations)
+     * API route.
+     *
+     * @param body - The details of the stock location to create.
+     * @param query - Configure the fields and relations to retrieve in the stock location.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.create({
+     *   name: "Main Warehouse",
+     *   address_id: "addr_123",
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
     create(body: HttpTypes.AdminCreateStockLocation, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminStockLocationResponse>;
+    /**
+     * This method updates a stock location. It sends a request to the
+     * [Update Stock Location](https://docs.medusajs.com/api/admin#stock-locations_poststocklocationsid)
+     * API route.
+     *
+     * @param id - The ID of the stock location to update.
+     * @param body - The details of the stock location to update.
+     * @param query - Configure the fields and relations to retrieve in the stock location.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.update("sloc_123", {
+     *   name: "European Warehouse",
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateStockLocation, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminStockLocationResponse>;
+    /**
+     * This method deletes a stock location. It sends a request to the
+     * [Delete Stock Location](https://docs.medusajs.com/api/admin#stock-locations_deletestocklocationsid)
+     * API route.
+     *
+     * @param id - The ID of the stock location to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.delete("sloc_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminStockLocationDeleteResponse>;
+    /**
+     * This method retrieves a stock location. It sends a request to the
+     * [Get Stock Location](https://docs.medusajs.com/api/admin#stock-locations_getstocklocationsid)
+     * API route.
+     *
+     * @param id - The ID of the stock location to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the stock location.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * To retrieve a stock location by its ID:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.retrieve("sloc_123")
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.retrieve("sloc_123", {
+     *   fields: "id,*sales_channels"
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminStockLocationResponse>;
+    /**
+     * This method retrieves a list of stock locations. It sends a request to the
+     * [List Stock Locations](https://docs.medusajs.com/api/admin#stock-locations_getstocklocations)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of stock locations.
+     *
+     * @example
+     * To retrieve the list of stock locations:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.list()
+     * .then(({ stock_locations, count, limit, offset }) => {
+     *   console.log(stock_locations)
+     * })
+     * ```
+     *
+     * 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.stockLocation.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ stock_locations, count, limit, offset }) => {
+     *   console.log(stock_locations)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each stock location:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.list({
+     *   fields: "id,*sales_channels"
+     * })
+     * .then(({ stock_locations, count, limit, offset }) => {
+     *   console.log(stock_locations)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminStockLocationListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminStockLocationListResponse>;
+    /**
+     * This method manages the sales channels of a stock location by adding or removing them. It sends a request to the
+     * [Manage Stock Location Sales Channels](https://docs.medusajs.com/api/admin#stock-locations_poststocklocationsidsaleschannels)
+     * API route.
+     *
+     * @param id - The ID of the stock location to update the sales channels for.
+     * @param body - The details of the sales channels to update.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.updateSalesChannels("sloc_123", {
+     *   add: ["sc_123"],
+     *   remove: ["sc_456"],
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
     updateSalesChannels(id: string, body: HttpTypes.AdminUpdateStockLocationSalesChannels, headers?: ClientHeaders): Promise<HttpTypes.AdminStockLocationResponse>;
+    /**
+     * This method adds a new fulfillment set to a stock location. It sends a request to the
+     * [Add Fulfillment Set to Stock Location](https://docs.medusajs.com/api/admin#stock-locations_poststocklocationsidfulfillmentsets)
+     * API route.
+     *
+     * @param id - The ID of the stock location to add the fulfillment set to.
+     * @param body - The details of the fulfillment set to add.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.createFulfillmentSet("sloc_123", {
+     *   name: "Shipping",
+     *   type: "shipping",
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
     createFulfillmentSet(id: string, body: HttpTypes.AdminCreateStockLocationFulfillmentSet, headers?: ClientHeaders): Promise<HttpTypes.AdminStockLocationResponse>;
+    /**
+     * This method manages the fulfillment providers of a stock location by adding or removing them. It sends a request to the
+     * [Manage Fulfillment Providers of Stock Location](https://docs.medusajs.com/api/admin#stock-locations_poststocklocationsidfulfillmentproviders)
+     * API route.
+     *
+     * @param id - The ID of the stock location to manage the fulfillment providers for.
+     * @param body - The details of the fulfillment providers to manage.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.updateFulfillmentProviders("sloc_123", {
+     *   add: ["fp_manual_manual"],
+     *   remove: ["fp_shipstation_shipstation"],
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
     updateFulfillmentProviders(id: string, body: HttpTypes.AdminBatchLink, headers?: ClientHeaders): Promise<HttpTypes.AdminStockLocationResponse>;
 }
 //# sourceMappingURL=stock-location.d.ts.map

package/dist/esm/admin/stock-location.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stock-location.d.ts","sourceRoot":"","sources":["../../../src/admin/stock-location.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;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,YAAY,EACpB,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,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAWlE,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,4BAA4B,EAC9C,OAAO,CAAC,EAAE,aAAa;IAYnB,mBAAmB,CACvB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qCAAqC,EACrD,OAAO,CAAC,EAAE,aAAa;IAYnB,oBAAoB,CACxB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sCAAsC,EACtD,OAAO,CAAC,EAAE,aAAa;IAYnB,0BAA0B,CAC9B,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"stock-location.d.ts","sourceRoot":"","sources":["../../../src/admin/stock-location.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;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,YAAY,EACpB,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;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAWxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,4BAA4B,EAC9C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;OAkBG;IACG,mBAAmB,CACvB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qCAAqC,EACrD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;OAkBG;IACG,oBAAoB,CACxB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sCAAsC,EACtD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;OAkBG;IACG,0BAA0B,CAC9B,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/esm/admin/stock-location.js

@@ -14,6 +14,25 @@ export class StockLocation {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a new stock location. It sends a request to the
+     * [Create Stock Location](https://docs.medusajs.com/api/admin#stock-locations_poststocklocations)
+     * API route.
+     *
+     * @param body - The details of the stock location to create.
+     * @param query - Configure the fields and relations to retrieve in the stock location.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.create({
+     *   name: "Main Warehouse",
+     *   address_id: "addr_123",
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/stock-locations`, {
@@ -24,6 +43,25 @@ export class StockLocation {
             });
         });
     }
+    /**
+     * This method updates a stock location. It sends a request to the
+     * [Update Stock Location](https://docs.medusajs.com/api/admin#stock-locations_poststocklocationsid)
+     * API route.
+     *
+     * @param id - The ID of the stock location to update.
+     * @param body - The details of the stock location to update.
+     * @param query - Configure the fields and relations to retrieve in the stock location.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.update("sloc_123", {
+     *   name: "European Warehouse",
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
     update(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/stock-locations/${id}`, {
@@ -34,6 +72,21 @@ export class StockLocation {
             });
         });
     }
+    /**
+     * This method deletes a stock location. It sends a request to the
+     * [Delete Stock Location](https://docs.medusajs.com/api/admin#stock-locations_deletestocklocationsid)
+     * API route.
+     *
+     * @param id - The ID of the stock location to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.delete("sloc_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/stock-locations/${id}`, {
@@ -42,6 +95,39 @@ export class StockLocation {
             });
         });
     }
+    /**
+     * This method retrieves a stock location. It sends a request to the
+     * [Get Stock Location](https://docs.medusajs.com/api/admin#stock-locations_getstocklocationsid)
+     * API route.
+     *
+     * @param id - The ID of the stock location to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the stock location.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * To retrieve a stock location by its ID:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.retrieve("sloc_123")
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.retrieve("sloc_123", {
+     *   fields: "id,*sales_channels"
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     * ```
+     *
+     * 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/stock-locations/${id}`, {
@@ -51,6 +137,53 @@ export class StockLocation {
             });
         });
     }
+    /**
+     * This method retrieves a list of stock locations. It sends a request to the
+     * [List Stock Locations](https://docs.medusajs.com/api/admin#stock-locations_getstocklocations)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of stock locations.
+     *
+     * @example
+     * To retrieve the list of stock locations:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.list()
+     * .then(({ stock_locations, count, limit, offset }) => {
+     *   console.log(stock_locations)
+     * })
+     * ```
+     *
+     * 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.stockLocation.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ stock_locations, count, limit, offset }) => {
+     *   console.log(stock_locations)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each stock location:
+     *
+     * ```ts
+     * sdk.admin.stockLocation.list({
+     *   fields: "id,*sales_channels"
+     * })
+     * .then(({ stock_locations, count, limit, offset }) => {
+     *   console.log(stock_locations)
+     * })
+     * ```
+     *
+     * 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/stock-locations`, {
@@ -60,6 +193,25 @@ export class StockLocation {
             });
         });
     }
+    /**
+     * This method manages the sales channels of a stock location by adding or removing them. It sends a request to the
+     * [Manage Stock Location Sales Channels](https://docs.medusajs.com/api/admin#stock-locations_poststocklocationsidsaleschannels)
+     * API route.
+     *
+     * @param id - The ID of the stock location to update the sales channels for.
+     * @param body - The details of the sales channels to update.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.updateSalesChannels("sloc_123", {
+     *   add: ["sc_123"],
+     *   remove: ["sc_456"],
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
     updateSalesChannels(id, body, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/stock-locations/${id}/sales-channels`, {
@@ -69,6 +221,25 @@ export class StockLocation {
             });
         });
     }
+    /**
+     * This method adds a new fulfillment set to a stock location. It sends a request to the
+     * [Add Fulfillment Set to Stock Location](https://docs.medusajs.com/api/admin#stock-locations_poststocklocationsidfulfillmentsets)
+     * API route.
+     *
+     * @param id - The ID of the stock location to add the fulfillment set to.
+     * @param body - The details of the fulfillment set to add.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.createFulfillmentSet("sloc_123", {
+     *   name: "Shipping",
+     *   type: "shipping",
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
     createFulfillmentSet(id, body, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/stock-locations/${id}/fulfillment-sets`, {
@@ -78,6 +249,25 @@ export class StockLocation {
             });
         });
     }
+    /**
+     * This method manages the fulfillment providers of a stock location by adding or removing them. It sends a request to the
+     * [Manage Fulfillment Providers of Stock Location](https://docs.medusajs.com/api/admin#stock-locations_poststocklocationsidfulfillmentproviders)
+     * API route.
+     *
+     * @param id - The ID of the stock location to manage the fulfillment providers for.
+     * @param body - The details of the fulfillment providers to manage.
+     * @param headers - Headers to pass in the request.
+     * @returns The stock location's details.
+     *
+     * @example
+     * sdk.admin.stockLocation.updateFulfillmentProviders("sloc_123", {
+     *   add: ["fp_manual_manual"],
+     *   remove: ["fp_shipstation_shipstation"],
+     * })
+     * .then(({ stock_location }) => {
+     *   console.log(stock_location)
+     * })
+     */
     updateFulfillmentProviders(id, body, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/stock-locations/${id}/fulfillment-providers`, {

package/dist/esm/admin/stock-location.js.map

@@ -1 +1 @@
-{"version":3,"file":"stock-location.js","sourceRoot":"","sources":["../../../src/admin/stock-location.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,aAAa;IAKxB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,mBAAmB,CACvB,EAAU,EACV,IAAqD,EACrD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,iBAAiB,EAC7C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAEK,oBAAoB,CACxB,EAAU,EACV,IAAsD,EACtD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,mBAAmB,EAC/C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAEK,0BAA0B,CAC9B,EAAU,EACV,IAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,wBAAwB,EACpD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"stock-location.js","sourceRoot":"","sources":["../../../src/admin/stock-location.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,aAAa;IAKxB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,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,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,mBAAmB,CACvB,EAAU,EACV,IAAqD,EACrD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,iBAAiB,EAC7C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,oBAAoB,CACxB,EAAU,EACV,IAAsD,EACtD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,mBAAmB,EAC/C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,0BAA0B,CAC9B,EAAU,EACV,IAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,wBAAwB,EACpD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/admin/store.d.ts

@@ -10,8 +10,107 @@ export declare class Store {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a store by its ID. It sends a request to the
+     * [Get Store](https://docs.medusajs.com/api/admin#stores_getstoresid)
+     * API route.
+     *
+     * @param id - The ID of the store to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the store.
+     * @param headers - Headers to pass in the request.
+     * @returns The store's details.
+     *
+     * @example
+     * To retrieve a store by its ID:
+     *
+     * ```ts
+     * sdk.admin.store.retrieve("store_123")
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.store.retrieve("store_123", {
+     *   fields: "id,*supported_currencies"
+     * })
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.AdminStoreParams, headers?: ClientHeaders): Promise<HttpTypes.AdminStoreResponse>;
+    /**
+     * This method retrieves a list of stores. It sends a request to the
+     * [List Stores](https://docs.medusajs.com/api/admin#stores_getstores)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of stores.
+     *
+     * @example
+     * To retrieve the list of stores:
+     *
+     * ```ts
+     * sdk.admin.store.list()
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * 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.store.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each store:
+     *
+     * ```ts
+     * sdk.admin.store.list({
+     *   fields: "id,*supported_currencies"
+     * })
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminStoreListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminStoreListResponse>;
+    /**
+     * This method updates a store. It sends a request to the
+     * [Update Store](https://docs.medusajs.com/api/admin#stores_poststoresid)
+     * API route.
+     *
+     * @param id - The ID of the store to update.
+     * @param body - The details of the store to update.
+     * @param query - Configure the fields and relations to retrieve in the store.
+     * @param headers - Headers to pass in the request.
+     * @returns The store's details.
+     *
+     * @example
+     * sdk.admin.store.update("store_123", {
+     *   name: "My Store",
+     * })
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateStore, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminStoreResponse>;
 }
 //# sourceMappingURL=store.d.ts.map

package/dist/esm/admin/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../src/admin/store.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,KAAK;IAChB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,gBAAgB,EAClC,OAAO,CAAC,EAAE,aAAa;IAYnB,IAAI,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,EAAE,aAAa;IAWpE,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gBAAgB,EAChC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../src/admin/store.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,KAAK;IAChB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,gBAAgB,EAClC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,EAAE,aAAa;IAW1E;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gBAAgB,EAChC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}