@medusajs/js-sdk 2.6.2-snapshot-20250328151043 → 2.7.0-preview-20250411080918

package/dist/admin/draft-order.js

@@ -22,7 +22,7 @@ class DraftOrder {
      * To retrieve a draft order by its ID:
      *
      * ```ts
-     * sdk.admin.draftOrder.retrieve("draft_order_123")
+     * sdk.admin.draftOrder.retrieve("order_123")
      * .then(({ draft_order }) => {
      *   console.log(draft_order)
      * })
@@ -31,7 +31,7 @@ class DraftOrder {
      * To specify the fields and relations to retrieve:
      *
      * ```ts
-     * sdk.admin.draftOrder.retrieve("draft_order_123", {
+     * sdk.admin.draftOrder.retrieve("order_123", {
      *   fields: "id,*items"
      * })
      * .then(({ draft_order }) => {
@@ -120,7 +120,7 @@ class DraftOrder {
      *     },
      *   ],
      *   region_id: "region_123",
-     *   sales_channel_id: "sales_channel_123",
+     *   sales_channel_id: "sc_123",
      * })
      * .then(({ draft_order }) => {
      *   console.log(draft_order)
@@ -148,7 +148,7 @@ class DraftOrder {
      * To update a draft order:
      *
      * ```ts
-     * sdk.admin.draftOrder.update("draft_order_123", {
+     * sdk.admin.draftOrder.update("order_123", {
      *   email: "test@test.com",
      * })
      * .then(({ draft_order }) => {
@@ -164,6 +164,371 @@ class DraftOrder {
             headers,
         });
     }
+    /**
+     * This method converts a draft order to an order. It sends a request to the
+     * [Convert Draft Order to Order](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersidconvert-to-order) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param query - Configure the fields to retrieve in the order.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To convert a draft order to an order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.convertToOrder("order_123")
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    async convertToOrder(id, query, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/convert-to-order`, {
+            method: "POST",
+            query,
+            headers,
+        });
+    }
+    /**
+     * This method adds items to a draft order. It sends a request to the
+     * [Add Draft Order Items](https://docs.medusajs.com/api/admin#draft-orders_postordereditsiditems) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param body - The data to add the items to the draft order.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To add items to a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.addItems("order_123", {
+     *   items: [
+     *     {
+     *       variant_id: "variant_123",
+     *       quantity: 1,
+     *     },
+     *   ],
+     * })
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async addItems(id, body, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/items`, {
+            method: "POST",
+            body,
+            headers,
+        });
+    }
+    /**
+     * This method updates an item that is part of an action in a draft order. It sends a request to the
+     * [Update Draft Order Item](https://docs.medusajs.com/api/admin#draft-orders_postordereditsiditemsaction_id) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param actionId - The action ID.
+     * @param body - The data to update the item.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To update an item that is part of an action in a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.updateActionItem("order_123", "action_123", {
+     *   quantity: 2,
+     * })
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async updateActionItem(id, actionId, body, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/items/${actionId}`, {
+            method: "POST",
+            body,
+            headers,
+        });
+    }
+    /**
+     * This method removes an item that is part of an action in a draft order. It sends a request to the
+     * [Remove Draft Order Item](https://docs.medusajs.com/api/admin#draft-orders_deleteordereditsiditemsaction_id) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param actionId - The action ID.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To remove an item that is part of an action in a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.removeActionItem("order_123", "action_123")
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async removeActionItem(id, actionId, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/items/${actionId}`, {
+            method: "DELETE",
+            headers,
+        });
+    }
+    /**
+     * This method updates an item in a draft order. It sends a request to the
+     * [Update Draft Order Item](https://docs.medusajs.com/api/admin#draft-orders_postordereditsiditemsitem_id) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param itemId - The item ID.
+     * @param body - The data to update the item.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To update an item in a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.updateItem("order_123", "item_123", {
+     *   quantity: 2,
+     * })
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async updateItem(id, itemId, body, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/items/item/${itemId}`, {
+            method: "POST",
+            body,
+            headers,
+        });
+    }
+    /**
+     * This method adds promotions to a draft order. It sends a request to the
+     * [Add Draft Order Promotions](https://docs.medusajs.com/api/admin#draft-orders_postordereditsidpromotions) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param body - The data to add the promotions to the draft order.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To add promotions to a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.addPromotions("order_123", {
+     *   promo_codes: ["PROMO_CODE_1", "PROMO_CODE_2"],
+     * })
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async addPromotions(id, body, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/promotions`, {
+            method: "POST",
+            body,
+            headers,
+        });
+    }
+    /**
+     * This method removes promotions from a draft order. It sends a request to the
+     * [Remove Draft Order Promotions](https://docs.medusajs.com/api/admin#draft-orders_deleteordereditsidpromotions) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param body - The data to remove the promotions from the draft order.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To remove promotions from a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.removePromotions("order_123", {
+     *   promo_codes: ["PROMO_CODE_1", "PROMO_CODE_2"],
+     * })
+     * ```
+     */
+    async removePromotions(id, body, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/promotions`, {
+            method: "DELETE",
+            body,
+            headers,
+        });
+    }
+    /**
+     * This method adds a shipping method to a draft order. It sends a request to the
+     * [Add Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_postordereditsidshipping-methods) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param body - The data to add the shipping method to the draft order.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To add a shipping method to a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.addShippingMethod("order_123", {
+     *   shipping_option_id: "shipping_option_123",
+     * })
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async addShippingMethod(id, body, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/shipping-methods`, {
+            method: "POST",
+            body,
+            headers,
+        });
+    }
+    /**
+     * This method updates a shipping method in a draft order. It sends a request to the
+     * [Update Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_postordereditsidshipping-methodsaction_id) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param actionId - The action ID.
+     * @param body - The data to update the shipping method.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To update a shipping method in a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.updateShippingMethod("order_123", "action_123", {
+     *   shipping_option_id: "shipping_option_123",
+     * })
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async updateActionShippingMethod(id, actionId, body, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/shipping-methods/${actionId}`, {
+            method: "POST",
+            body,
+            headers,
+        });
+    }
+    /**
+     * This method removes a shipping method from a draft order. It sends a request to the
+     * [Remove Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_deleteordereditsidshipping-methodsaction_id) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param actionId - The action ID.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To remove a shipping method from a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.removeShippingMethod("order_123", "action_123")
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async removeActionShippingMethod(id, actionId, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/shipping-methods/${actionId}`, {
+            method: "DELETE",
+            headers,
+        });
+    }
+    async updateShippingMethod(id, methodId, body, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/shipping-methods/method/${methodId}`, {
+            method: "POST",
+            body,
+            headers,
+        });
+    }
+    /**
+     * This method begins an edit to a draft order. It sends a request to the
+     * [Begin Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_postordereditsid) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To begin an edit to a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.beginEdit("order_123")
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async beginEdit(id, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit`, {
+            method: "POST",
+            headers,
+        });
+    }
+    /**
+     * This method cancels an edit to a draft order. It sends a request to the
+     * [Cancel Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_deleteordereditsid) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To cancel an edit to a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.cancelEdit("order_123")
+     * .then(({ id, object, deleted }) => {
+     *   console.log(id, object, deleted)
+     * })
+     * ```
+     */
+    async cancelEdit(id, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit`, {
+            method: "DELETE",
+            headers,
+        });
+    }
+    /**
+     * This method requests an edit to a draft order. It sends a request to the
+     * [Request Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_postordereditsidrequest) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To request an edit to a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.requestEdit("order_123")
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async requestEdit(id, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/request`, {
+            method: "POST",
+            headers,
+        });
+    }
+    /**
+     * This method confirms an edit to a draft order. It sends a request to the
+     * [Confirm Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_postordereditsidconfirm) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To confirm an edit to a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.confirmEdit("order_123")
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     * ```
+     */
+    async confirmEdit(id, headers) {
+        return await this.client.fetch(`/admin/draft-orders/${id}/edit/confirm`, {
+            method: "POST",
+            headers,
+        });
+    }
 }
 exports.DraftOrder = DraftOrder;
 //# sourceMappingURL=draft-order.js.map

package/dist/admin/draft-order.js.map

@@ -1 +1 @@
-{"version":3,"file":"draft-order.js","sourceRoot":"","sources":["../../src/admin/draft-order.ts"],"names":[],"mappings":";;;AAKA,MAAa,UAAU;IAKrB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,WAAiD,EACjD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;YACE,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AAvMD,gCAuMC"}
+{"version":3,"file":"draft-order.js","sourceRoot":"","sources":["../../src/admin/draft-order.ts"],"names":[],"mappings":";;;AAKA,MAAa,UAAU;IAKrB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,WAAiD,EACjD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;YACE,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,mBAAmB,EAC5C;YACE,MAAM,EAAE,MAAM;YACd,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,IAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,aAAa,EACtC;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,gBAAgB,CACpB,EAAU,EACV,QAAgB,EAChB,IAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,eAAe,QAAQ,EAAE,EAClD;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,gBAAgB,CACpB,EAAU,EACV,QAAgB,EAChB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,eAAe,QAAQ,EAAE,EAClD;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,UAAU,CACd,EAAU,EACV,MAAc,EACd,IAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,oBAAoB,MAAM,EAAE,EACrD;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,IAA4C,EAC5C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,kBAAkB,EAC3C;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,gBAAgB,CACpB,EAAU,EACV,IAA+C,EAC/C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,kBAAkB,EAC3C;YACE,MAAM,EAAE,QAAQ;YAChB,IAAI;YACJ,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,iBAAiB,CACrB,EAAU,EACV,IAAgD,EAChD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,wBAAwB,EACjD;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,0BAA0B,CAC9B,EAAU,EACV,QAAgB,EAChB,IAAyD,EACzD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,0BAA0B,QAAQ,EAAE,EAC7D;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,0BAA0B,CAC9B,EAAU,EACV,QAAgB,EAChB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,0BAA0B,QAAQ,EAAE,EAC7D;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,EAAU,EACV,QAAgB,EAChB,IAAmD,EACnD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,iCAAiC,QAAQ,EAAE,EACpE;YACE,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,OAAO;SACR,CACF,CAAA;IACH,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,SAAS,CAAC,EAAU,EAAE,OAAuB;QACjD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,OAAO,EAChC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,UAAU,CAAC,EAAU,EAAE,OAAuB;QAClD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,uBAAuB,EAAE,OAAO,EAAE;YAClC,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,WAAW,CAAC,EAAU,EAAE,OAAuB;QACnD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,eAAe,EACxC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,WAAW,CAAC,EAAU,EAAE,OAAuB;QACnD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,eAAe,EACxC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AA9pBD,gCA8pBC"}

package/dist/admin/plugin.d.ts

@@ -2,8 +2,26 @@ import { HttpTypes } from "@medusajs/types";
 import { Client } from "../client";
 import { ClientHeaders } from "../types";
 export declare class Plugin {
+    /**
+     * @ignore
+     */
     private client;
+    /**
+     * @ignore
+     */
     constructor(client: Client);
+    /**
+     * This method retrieves the list of plugins installed in a Medusa application.
+     *
+     * @param headers - Headers to pass in the request.
+     * @returns The list of plugins.
+     *
+     * @example
+     * sdk.admin.plugin.list()
+     * .then(({ plugins }) => {
+     *   console.log(plugins)
+     * })
+     */
     list(headers?: ClientHeaders): Promise<HttpTypes.AdminPluginsListResponse>;
 }
 //# sourceMappingURL=plugin.d.ts.map

package/dist/admin/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/admin/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAQ;gBAEV,MAAM,EAAE,MAAM;IAIpB,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa;CASnC"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/admin/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa;CASnC"}

package/dist/admin/plugin.js

@@ -2,9 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Plugin = void 0;
 class Plugin {
+    /**
+     * @ignore
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves the list of plugins installed in a Medusa application.
+     *
+     * @param headers - Headers to pass in the request.
+     * @returns The list of plugins.
+     *
+     * @example
+     * sdk.admin.plugin.list()
+     * .then(({ plugins }) => {
+     *   console.log(plugins)
+     * })
+     */
     async list(headers) {
         return await this.client.fetch(`/admin/plugins`, {
             headers,

package/dist/admin/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/admin/plugin.ts"],"names":[],"mappings":";;;AAIA,MAAa,MAAM;IAGjB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;YACE,OAAO;YACP,KAAK,EAAE,EAAE;SACV,CACF,CAAA;IACH,CAAC;CACF;AAhBD,wBAgBC"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/admin/plugin.ts"],"names":[],"mappings":";;;AAIA,MAAa,MAAM;IAMjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;YACE,OAAO;YACP,KAAK,EAAE,EAAE;SACV,CACF,CAAA;IACH,CAAC;CACF;AAlCD,wBAkCC"}

package/dist/auth/index.d.ts

@@ -9,6 +9,12 @@ export declare class Auth {
      * This method is used to retrieve a registration JWT token for a user, customer, or custom actor type. It sends a request to the
      * [Retrieve Registration Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_provider_register).
      *
+     * Then, it stores the returned token and passes it in the header of subsequent requests. So, you can call the
+     * [store.customer.create](https://docs.medusajs.com/resources/references/js-sdk/store/customer#create) method,
+     * for example, after calling this method.
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.medusajs.com/resources/js-sdk/auth/overview) guide.
+     *
      * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
      * @param method - The authentication provider to use. For example, `emailpass` or `google`.
      * @param payload - The data to pass in the request's body for authentication. When using the `emailpass` provider,
@@ -18,15 +24,19 @@ export declare class Auth {
      * @tags auth
      *
      * @example
-     * sdk.auth.register(
+     * await sdk.auth.register(
      *   "customer",
      *   "emailpass",
      *   {
      *     email: "customer@gmail.com",
      *     password: "supersecret"
      *   }
-     * ).then((token) => {
-     *   console.log(token)
+     * )
+     *
+     * // all subsequent requests will use the token in the header
+     * const { customer } = await sdk.store.customer.create({
+     *   email: "customer@gmail.com",
+     *   password: "supersecret"
      * })
      */
     register: (actor: string, method: string, payload: HttpTypes.AdminSignUpWithEmailPassword) => Promise<string>;
@@ -34,11 +44,32 @@ export declare class Auth {
      * This method retrieves the JWT authenticated token for an admin user, customer, or custom
      * actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_provider).
      *
+     * ### Third-Party Authentication
+     *
+     * If the API route returns a `location` property, it means that the authentication requires additional steps,
+     * typically in a third-party service. The `location` property is returned so that you
+     * can redirect the user to the appropriate page.
+     *
+     * :::note
+     *
+     * For an example of implementing third-party authentication, refer to the
+     * [Third-Party Login in Storefront](https://docs.medusajs.com/resources/storefront-development/customers/third-party-login) guide.
+     *
+     * :::
+     *
+     * ### Session Authentication
+     *
      * If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
      * [Set Authentication Session API route](https://docs.medusajs.com/api/admin#auth_postsession).
      *
-     * Subsequent requests using the SDK will automatically have the necessary authentication headers / session
-     * set.
+     * Learn more in the [JS SDK Authentication](https://docs.medusajs.com/resources/js-sdk/auth/overview) guide.
+     *
+     * ### Automatic Authentication
+     *
+     * If the authentication was successful, subsequent requests using the SDK will automatically have the necessary authentication headers / session
+     * set, based on your JS SDK authentication configurations.
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.medusajs.com/resources/js-sdk/auth/overview) guide.
      *
      * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
      * @param method - The authentication provider to use. For example, `emailpass` or `google`.
@@ -49,16 +80,25 @@ export declare class Auth {
      * @tags auth
      *
      * @example
-     * sdk.auth.login(
+     * const result = await sdk.auth.login(
      *   "customer",
      *   "emailpass",
      *   {
      *     email: "customer@gmail.com",
      *     password: "supersecret"
      *   }
-     * ).then((token) => {
-     *   console.log(token)
-     * })
+     * )
+     *
+     * if (typeof result !== "string") {
+     *   alert("Authentication requires additional steps")
+     *   // replace with the redirect logic of your application
+     *   window.location.href = result.location
+     *   return
+     * }
+     *
+     * // customer is now authenticated
+     * // all subsequent requests will use the token in the header
+     * const { customer } = await sdk.store.customer.retrieve()
      */
     login: (actor: string, method: string, payload: HttpTypes.AdminSignInWithEmailPassword | Record<string, unknown>) => Promise<string | {
         location: string;
@@ -67,6 +107,12 @@ export declare class Auth {
      * This method is used to validate an Oauth callback from a third-party service, such as Google, for an admin user, customer, or custom actor types.
      * It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providercallback).
      *
+     * The method stores the returned token and passes it in the header of subsequent requests. So, you can call the
+     * [store.customer.create](https://docs.medusajs.com/resources/references/js-sdk/store/customer#create) or {@link refresh} methods,
+     * for example, after calling this method.
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.medusajs.com/resources/js-sdk/auth/overview) guide.
+     *
      * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
      * @param method - The authentication provider to use. For example, `google`.
      * @param query - The query parameters from the Oauth callback, which should be passed to the API route. This includes query parameters like
@@ -76,17 +122,20 @@ export declare class Auth {
      * @tags auth
      *
      * @example
-     * sdk.auth.callback(
+     * await sdk.auth.callback(
      *   "customer",
      *   "google",
      *   {
      *     code: "123",
      *     state: "456"
      *   }
-     * ).then((token) => {
-     *   console.log(token)
-     * })
+     * )
      *
+     * // all subsequent requests will use the token in the header
+     * const { customer } = await sdk.store.customer.create({
+     *   email: "customer@gmail.com",
+     *   password: "supersecret"
+     * })
      *
      * @privateRemarks
      * The callback expects all query parameters from the Oauth callback to be passed to
@@ -97,28 +146,43 @@ export declare class Auth {
      * This method refreshes a JWT authentication token, which is useful after validating the Oauth callback
      * with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/api/admin#auth_postadminauthtokenrefresh).
      *
+     * The method stores the returned token and passes it in the header of subsequent requests. So, you can call other
+     * methods that require authentication after calling this method.
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.medusajs.com/resources/js-sdk/auth/overview) guide.
+     *
+     * For an example of implementing third-party authentication, refer to the
+     * [Third-Party Login in Storefront](https://docs.medusajs.com/resources/storefront-development/customers/third-party-login) guide.
+     *
+     *
      * @returns The refreshed JWT authentication token.
      *
      * @tags auth
      *
      * @example
-     * sdk.auth.refresh()
-     * .then((token) => {
-     *   console.log(token)
-     * })
+     * const token = await sdk.auth.refresh()
+     *
+     * // all subsequent requests will use the token in the header
+     * const { customer } = await sdk.store.customer.retrieve()
      */
     refresh: () => Promise<string>;
     /**
-     * This method deletes the authentication session of the currently logged-in user to log them out.
-     * It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/api/admin#auth_deletesession).
+     * This method logs out the currently authenticated user based on your JS SDK authentication configurations.
+     *
+     * If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
+     * [Delete Authentication Session API route](https://docs.medusajs.com/api/admin#auth_deletesession).
+     *
+     * The method also clears any stored tokens or sessions, based on your JS SDK authentication configurations.
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.medusajs.com/resources/js-sdk/auth/overview) guide.
      *
      * @tags auth
      *
      * @example
-     * sdk.auth.logout()
-     * .then(() => {
-     *   // user is logged out
-     * })
+     * await sdk.auth.logout()
+     *
+     * // user is now logged out
+     * // you can't send any requests that require authentication
      */
     logout: () => Promise<void>;
     /**

package/dist/auth/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,qBAAa,IAAI;IACf,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAQ;gBAEV,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK1C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,UACC,MAAM,UACL,MAAM,WACL,SAAS,CAAC,4BAA4B,qBAahD;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,UACI,MAAM,UACL,MAAM,WACL,SAAS,CAAC,4BAA4B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;OAmB1E;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,UACC,MAAM,UACL,MAAM,UACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,qBAYhC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,wBAYN;IAED;;;;;;;;;;;OAWG;IACH,MAAM,sBAQL;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,aAAa,UACJ,MAAM,YACH,MAAM,QACV;QACJ;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAA;KACnB,mBAOF;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,cAAc,UACL,MAAM,YACH,MAAM,QACV,SAAS,CAAC,mBAAmB,SAC5B,MAAM,mBAOd;IAED;;OAEG;IACH,OAAO,CAAC,SAAS,CAUhB;CACF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,qBAAa,IAAI;IACf,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAQ;gBAEV,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,QAAQ,UACC,MAAM,UACL,MAAM,WACL,SAAS,CAAC,4BAA4B,qBAahD;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,KAAK,UACI,MAAM,UACL,MAAM,WACL,SAAS,CAAC,4BAA4B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;OAmB1E;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,QAAQ,UACC,MAAM,UACL,MAAM,UACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,qBAYhC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,OAAO,wBAYN;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,sBAQL;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,aAAa,UACJ,MAAM,YACH,MAAM,QACV;QACJ;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAA;KACnB,mBAOF;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,cAAc,UACL,MAAM,YACH,MAAM,QACV,SAAS,CAAC,mBAAmB,SAC5B,MAAM,mBAOd;IAED;;OAEG;IACH,OAAO,CAAC,SAAS,CAUhB;CACF"}