@medusajs/js-sdk 2.7.0 → 2.7.1-preview-20250413180145

package/dist/admin/claim.d.ts

@@ -452,7 +452,7 @@ export declare class Claim {
      * @returns The details of the claim, with a preview of the order when the claim is applied.
      *
      * @example
-     *    * sdk.admin.claim.addOutboundShipping(
+     * sdk.admin.claim.addOutboundShipping(
      *   "claim_123",
      *   {
      *     shipping_option_id: "so_123",

package/dist/admin/claim.js

@@ -553,7 +553,7 @@ class Claim {
      * @returns The details of the claim, with a preview of the order when the claim is applied.
      *
      * @example
-     *    * sdk.admin.claim.addOutboundShipping(
+     * sdk.admin.claim.addOutboundShipping(
      *   "claim_123",
      *   {
      *     shipping_option_id: "so_123",

package/dist/admin/draft-order.d.ts

@@ -100,9 +100,6 @@ export declare class DraftOrder {
      * @param headers - Headers to pass in the request.
      *
      * @example
-     * To create a draft order:
-     *
-     * ```ts
      * sdk.admin.draftOrder.create({
      *   email: "test@test.com",
      *   items: [
@@ -117,7 +114,6 @@ export declare class DraftOrder {
      * .then(({ draft_order }) => {
      *   console.log(draft_order)
      * })
-     * ```
      */
     create(body: HttpTypes.AdminCreateDraftOrder, query?: HttpTypes.AdminDraftOrderParams, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderResponse>;
     /**
@@ -130,16 +126,12 @@ export declare class DraftOrder {
      * @param headers - Headers to pass in the request.
      *
      * @example
-     * To update a draft order:
-     *
-     * ```ts
      * sdk.admin.draftOrder.update("order_123", {
      *   email: "test@test.com",
      * })
      * .then(({ draft_order }) => {
      *   console.log(draft_order)
      * })
-     * ```
      */
     update(id: string, body: HttpTypes.AdminUpdateDraftOrder, query?: HttpTypes.AdminDraftOrderParams, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderResponse>;
     /**
@@ -151,9 +143,6 @@ export declare class DraftOrder {
      * @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)
@@ -169,9 +158,6 @@ export declare class DraftOrder {
      * @param headers - Headers to pass in the request.
      *
      * @example
-     * To add items to a draft order:
-     *
-     * ```ts
      * sdk.admin.draftOrder.addItems("order_123", {
      *   items: [
      *     {
@@ -183,7 +169,6 @@ export declare class DraftOrder {
      * .then(({ draft_order_preview }) => {
      *   console.log(draft_order_preview)
      * })
-     * ```
      */
     addItems(id: string, body: HttpTypes.AdminAddDraftOrderItems, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
@@ -196,16 +181,12 @@ export declare class DraftOrder {
      * @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)
      * })
-     * ```
      */
     updateActionItem(id: string, actionId: string, body: HttpTypes.AdminUpdateDraftOrderItem, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
@@ -217,14 +198,10 @@ export declare class DraftOrder {
      * @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)
      * })
-     * ```
      */
     removeActionItem(id: string, actionId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
@@ -235,18 +212,15 @@ export declare class DraftOrder {
      * @param itemId - The item ID.
      * @param body - The data to update the item.
      * @param headers - Headers to pass in the request.
+     * @returns The draft order preview's details.
      *
      * @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)
      * })
-     * ```
      */
     updateItem(id: string, itemId: string, body: HttpTypes.AdminUpdateDraftOrderItem, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
@@ -258,16 +232,12 @@ export declare class DraftOrder {
      * @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)
      * })
-     * ```
      */
     addPromotions(id: string, body: HttpTypes.AdminAddDraftOrderPromotions, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
@@ -279,13 +249,9 @@ export declare class DraftOrder {
      * @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"],
      * })
-     * ```
      */
     removePromotions(id: string, body: HttpTypes.AdminRemoveDraftOrderPromotions, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
@@ -297,16 +263,12 @@ export declare class DraftOrder {
      * @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)
      * })
-     * ```
      */
     addShippingMethod(id: string, body: HttpTypes.AdminAddDraftOrderShippingMethod, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
@@ -319,16 +281,12 @@ export declare class DraftOrder {
      * @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)
      * })
-     * ```
      */
     updateActionShippingMethod(id: string, actionId: string, body: HttpTypes.AdminUpdateDraftOrderActionShippingMethod, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
@@ -340,16 +298,30 @@ export declare class DraftOrder {
      * @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)
      * })
-     * ```
      */
     removeActionShippingMethod(id: string, actionId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    /**
+     * 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 methodId - The shipping method's ID.
+     * @param body - The data to update the shipping method.
+     * @param headers - Headers to pass in the request.
+     * @returns The draft order preview's details.
+     *
+     * @example
+     * sdk.admin.draftOrder.updateShippingMethod("order_123", "sm_123", {
+     *  shipping_option_id: "so_123",
+     * })
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     */
     updateShippingMethod(id: string, methodId: string, body: HttpTypes.AdminUpdateDraftOrderShippingMethod, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
      * This method begins an edit to a draft order. It sends a request to the
@@ -359,14 +331,10 @@ export declare class DraftOrder {
      * @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)
      * })
-     * ```
      */
     beginEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
@@ -377,14 +345,10 @@ export declare class DraftOrder {
      * @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)
      * })
-     * ```
      */
     cancelEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.DeleteResponse<"draft-order-edit">>;
     /**
@@ -395,14 +359,10 @@ export declare class DraftOrder {
      * @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)
      * })
-     * ```
      */
     requestEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
     /**
@@ -413,14 +373,10 @@ export declare class DraftOrder {
      * @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)
      * })
-     * ```
      */
     confirmEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
 }

package/dist/admin/draft-order.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"draft-order.d.ts","sourceRoot":"","sources":["../../src/admin/draft-order.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,UAAU;IACrB;;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,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,4BAA4B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;OAgBG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gCAAgC,EAChD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,0BAA0B,CAC9B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,yCAAyC,EACzD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,0BAA0B,CAC9B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,aAAa;IAWnB,oBAAoB,CACxB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,mCAAmC,EACnD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;OAgBG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUnD;;;;;;;;;;;;;;;;OAgBG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IASpD;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUrD;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CAStD"}
+{"version":3,"file":"draft-order.d.ts","sourceRoot":"","sources":["../../src/admin/draft-order.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,UAAU;IACrB;;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,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;OAaG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;OAgBG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;OAaG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;OAiBG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,4BAA4B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;OAYG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;OAeG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gCAAgC,EAChD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;OAgBG;IACG,0BAA0B,CAC9B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,yCAAyC,EACzD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;OAaG;IACG,0BAA0B,CAC9B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;OAiBG;IACG,oBAAoB,CACxB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,mCAAmC,EACnD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;OAYG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUnD;;;;;;;;;;;;OAYG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IASpD;;;;;;;;;;;;OAYG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUrD;;;;;;;;;;;;OAYG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CAStD"}

package/dist/admin/draft-order.js

@@ -108,9 +108,6 @@ class DraftOrder {
      * @param headers - Headers to pass in the request.
      *
      * @example
-     * To create a draft order:
-     *
-     * ```ts
      * sdk.admin.draftOrder.create({
      *   email: "test@test.com",
      *   items: [
@@ -125,7 +122,6 @@ class DraftOrder {
      * .then(({ draft_order }) => {
      *   console.log(draft_order)
      * })
-     * ```
      */
     async create(body, query, headers) {
         return await this.client.fetch(`/admin/draft-orders`, {
@@ -145,16 +141,12 @@ class DraftOrder {
      * @param headers - Headers to pass in the request.
      *
      * @example
-     * To update a draft order:
-     *
-     * ```ts
      * sdk.admin.draftOrder.update("order_123", {
      *   email: "test@test.com",
      * })
      * .then(({ draft_order }) => {
      *   console.log(draft_order)
      * })
-     * ```
      */
     async update(id, body, query, headers) {
         return await this.client.fetch(`/admin/draft-orders/${id}`, {
@@ -173,9 +165,6 @@ class DraftOrder {
      * @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)
@@ -197,9 +186,6 @@ class DraftOrder {
      * @param headers - Headers to pass in the request.
      *
      * @example
-     * To add items to a draft order:
-     *
-     * ```ts
      * sdk.admin.draftOrder.addItems("order_123", {
      *   items: [
      *     {
@@ -211,7 +197,6 @@ class DraftOrder {
      * .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`, {
@@ -230,16 +215,12 @@ class DraftOrder {
      * @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}`, {
@@ -257,14 +238,10 @@ class DraftOrder {
      * @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}`, {
@@ -280,18 +257,15 @@ class DraftOrder {
      * @param itemId - The item ID.
      * @param body - The data to update the item.
      * @param headers - Headers to pass in the request.
+     * @returns The draft order preview's details.
      *
      * @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}`, {
@@ -309,16 +283,12 @@ class DraftOrder {
      * @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`, {
@@ -336,13 +306,9 @@ class DraftOrder {
      * @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`, {
@@ -360,16 +326,12 @@ class DraftOrder {
      * @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`, {
@@ -388,16 +350,12 @@ class DraftOrder {
      * @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}`, {
@@ -415,14 +373,10 @@ class DraftOrder {
      * @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}`, {
@@ -430,6 +384,24 @@ class DraftOrder {
             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 methodId - The shipping method's ID.
+     * @param body - The data to update the shipping method.
+     * @param headers - Headers to pass in the request.
+     * @returns The draft order preview's details.
+     *
+     * @example
+     * sdk.admin.draftOrder.updateShippingMethod("order_123", "sm_123", {
+     *  shipping_option_id: "so_123",
+     * })
+     * .then(({ draft_order_preview }) => {
+     *   console.log(draft_order_preview)
+     * })
+     */
     async updateShippingMethod(id, methodId, body, headers) {
         return await this.client.fetch(`/admin/draft-orders/${id}/edit/shipping-methods/method/${methodId}`, {
             method: "POST",
@@ -445,14 +417,10 @@ class DraftOrder {
      * @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`, {
@@ -468,14 +436,10 @@ class DraftOrder {
      * @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`, {
@@ -491,14 +455,10 @@ class DraftOrder {
      * @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`, {
@@ -514,14 +474,10 @@ class DraftOrder {
      * @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`, {

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;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"}
+{"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;;;;;;;;;;;;;;;;;;;;;;;OAuBG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;OAaG;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;;;;;;;;;;;;;;;;;;;;OAoBG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;OAaG;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;;;;;;;;;;;;;;;;;OAiBG;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;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;OAYG;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;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;OAaG;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;;;;;;;;;;;;;;;;;OAiBG;IACH,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;;;;;;;;;;;;OAYG;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;;;;;;;;;;;;OAYG;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;;;;;;;;;;;;OAYG;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;;;;;;;;;;;;OAYG;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;AAlnBD,gCAknBC"}

package/dist/admin/invite.d.ts

@@ -24,25 +24,20 @@ export declare class Invite {
      * @returns The user's details.
      *
      * @example
-     * const token = await sdk.auth.register("user", "emailpass", {
+     * await sdk.auth.register("user", "emailpass", {
      *   email: "user@gmail.com",
      *   password: "supersecret"
      * })
      *
-     * sdk.admin.invite.accept(
+     * // all subsequent requests will use the token in the header
+     * const { user } = await sdk.admin.invite.accept(
      *   {
      *     email: "user@gmail.com",
      *     first_name: "John",
      *     last_name: "Smith",
      *     invite_token: "12345..."
      *   },
-     *   {
-     *     Authorization: `Bearer ${token}`
-     *   }
      * )
-     * .then(({ user }) => {
-     *   console.log(user)
-     * })
      */
     accept(input: HttpTypes.AdminAcceptInvite & {
         /**

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

@@ -1 +1 @@
-{"version":3,"file":"invite.d.ts","sourceRoot":"","sources":["../../src/admin/invite.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,YAAY,EACb,MAAM,iBAAiB,CAAA;AACxB,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;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,MAAM,CACV,KAAK,EAAE,SAAS,CAAC,iBAAiB,GAAG;QACnC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;KACrB,EACD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAczB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa;IAS5D;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}
+{"version":3,"file":"invite.d.ts","sourceRoot":"","sources":["../../src/admin/invite.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,YAAY,EACb,MAAM,iBAAiB,CAAA;AACxB,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;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,MAAM,CACV,KAAK,EAAE,SAAS,CAAC,iBAAiB,GAAG;QACnC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;KACrB,EACD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAczB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa;IAS5D;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}

package/dist/admin/invite.js

@@ -22,25 +22,20 @@ class Invite {
      * @returns The user's details.
      *
      * @example
-     * const token = await sdk.auth.register("user", "emailpass", {
+     * await sdk.auth.register("user", "emailpass", {
      *   email: "user@gmail.com",
      *   password: "supersecret"
      * })
      *
-     * sdk.admin.invite.accept(
+     * // all subsequent requests will use the token in the header
+     * const { user } = await sdk.admin.invite.accept(
      *   {
      *     email: "user@gmail.com",
      *     first_name: "John",
      *     last_name: "Smith",
      *     invite_token: "12345..."
      *   },
-     *   {
-     *     Authorization: `Bearer ${token}`
-     *   }
      * )
-     * .then(({ user }) => {
-     *   console.log(user)
-     * })
      */
     async accept(input, query, headers) {
         const { invite_token, ...rest } = input;

package/dist/admin/invite.js.map

@@ -1 +1 @@
-{"version":3,"file":"invite.js","sourceRoot":"","sources":["../../src/admin/invite.ts"],"names":[],"mappings":";;;AAQA,MAAa,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,MAAM,CACV,KAKC,EACD,KAAoB,EACpB,OAAuB;QAEvB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAA;QACvC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,+BAA+B,KAAK,CAAC,YAAY,EAAE,EACnD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,IAAI;YACV,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CAAC,WAAwB,EAAE,OAAuB;QAC1D,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,gBAAgB,EAAE;YAClB,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,SAAS,EAC7B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AA1PD,wBA0PC"}
+{"version":3,"file":"invite.js","sourceRoot":"","sources":["../../src/admin/invite.ts"],"names":[],"mappings":";;;AAQA,MAAa,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,MAAM,CACV,KAKC,EACD,KAAoB,EACpB,OAAuB;QAEvB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAA;QACvC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,+BAA+B,KAAK,CAAC,YAAY,EAAE,EACnD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,IAAI;YACV,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CAAC,WAAwB,EAAE,OAAuB;QAC1D,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,gBAAgB,EAAE;YAClB,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,SAAS,EAC7B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AArPD,wBAqPC"}