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

package/dist/auth/index.js

@@ -7,6 +7,12 @@ 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,
@@ -16,15 +22,19 @@ 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"
          * })
          */
         this.register = async (actor, method, payload) => {
@@ -39,11 +49,32 @@ 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`.
@@ -54,16 +85,25 @@ 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()
          */
         this.login = async (actor, method, payload) => {
             // There will either be token or location returned from the backend.
@@ -83,6 +123,12 @@ 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
@@ -92,17 +138,20 @@ 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
@@ -120,15 +169,24 @@ 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()
          */
         this.refresh = async () => {
             const { token } = await this.client.fetch("/auth/token/refresh", {
@@ -140,16 +198,22 @@ class Auth {
             return token;
         };
         /**
-         * 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
          */
         this.logout = async () => {
             if (this.config?.auth?.type === "session") {

package/dist/auth/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":";;;AAIA,MAAa,IAAI;IAIf,YAAY,MAAc,EAAE,MAAc;QAK1C;;;;;;;;;;;;;;;;;;;;;;;WAuBG;QACH,aAAQ,GAAG,KAAK,EACd,KAAa,EACb,MAAc,EACd,OAA+C,EAC/C,EAAE;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,SAAS,KAAK,IAAI,MAAM,WAAW,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,OAAO;aACd,CACF,CAAA;YAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YAE3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BG;QACH,UAAK,GAAG,KAAK,EACX,KAAa,EACb,MAAc,EACd,OAAyE,EACzE,EAAE;YACF,oEAAoE;YACpE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAGhD,SAAS,KAAK,IAAI,MAAM,EAAE,EAAE;gBAC7B,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,OAAO;aACd,CAAC,CAAA;YAEF,gFAAgF;YAChF,4EAA4E;YAC5E,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,EAAE,QAAQ,EAAE,CAAA;YACrB,CAAC;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,KAAe,CAAC,CAAA;YACrC,OAAO,KAAe,CAAA;QACxB,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4BG;QACH,aAAQ,GAAG,KAAK,EACd,KAAa,EACb,MAAc,EACd,KAA+B,EAC/B,EAAE;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,SAAS,KAAK,IAAI,MAAM,WAAW,EACnC;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK;aACN,CACF,CAAA;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA;QAED;;;;;;;;;;;;;WAaG;QACH,YAAO,GAAG,KAAK,IAAI,EAAE;YACnB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,qBAAqB,EACrB;gBACE,MAAM,EAAE,MAAM;aACf,CACF,CAAA;YAED,mHAAmH;YACnH,2IAA2I;YAC3I,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA;QAED;;;;;;;;;;;WAWG;QACH,WAAM,GAAG,KAAK,IAAI,EAAE;YAClB,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;oBACvC,MAAM,EAAE,QAAQ;iBACjB,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;QAC1B,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,kBAAa,GAAG,KAAK,EACnB,KAAa,EACb,QAAgB,EAChB,IAMC,EACD,EAAE;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI,QAAQ,iBAAiB,EAAE;gBACnE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,OAAO,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,uBAAuB;aAC3D,CAAC,CAAA;QACJ,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BG;QACH,mBAAc,GAAG,KAAK,EACpB,KAAa,EACb,QAAgB,EAChB,IAAmC,EACnC,KAAa,EACb,EAAE;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI,QAAQ,SAAS,EAAE;gBAC3D,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE;aAC9C,CAAC,CAAA;QACJ,CAAC,CAAA;QAED;;WAEG;QACK,cAAS,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;YAC1C,wIAAwI;YACxI,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;oBACvC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE;iBAC9C,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC,CAAA;QAxSC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CAuSF;AA9SD,oBA8SC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":";;;AAIA,MAAa,IAAI;IAIf,YAAY,MAAc,EAAE,MAAc;QAK1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiCG;QACH,aAAQ,GAAG,KAAK,EACd,KAAa,EACb,MAAc,EACd,OAA+C,EAC/C,EAAE;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,SAAS,KAAK,IAAI,MAAM,WAAW,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,OAAO;aACd,CACF,CAAA;YAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YAE3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2DG;QACH,UAAK,GAAG,KAAK,EACX,KAAa,EACb,MAAc,EACd,OAAyE,EACzE,EAAE;YACF,oEAAoE;YACpE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAGhD,SAAS,KAAK,IAAI,MAAM,EAAE,EAAE;gBAC7B,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,OAAO;aACd,CAAC,CAAA;YAEF,gFAAgF;YAChF,4EAA4E;YAC5E,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,EAAE,QAAQ,EAAE,CAAA;YACrB,CAAC;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,KAAe,CAAC,CAAA;YACrC,OAAO,KAAe,CAAA;QACxB,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqCG;QACH,aAAQ,GAAG,KAAK,EACd,KAAa,EACb,MAAc,EACd,KAA+B,EAC/B,EAAE;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,SAAS,KAAK,IAAI,MAAM,WAAW,EACnC;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK;aACN,CACF,CAAA;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;WAsBG;QACH,YAAO,GAAG,KAAK,IAAI,EAAE;YACnB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,qBAAqB,EACrB;gBACE,MAAM,EAAE,MAAM;aACf,CACF,CAAA;YAED,mHAAmH;YACnH,2IAA2I;YAC3I,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;WAiBG;QACH,WAAM,GAAG,KAAK,IAAI,EAAE;YAClB,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;oBACvC,MAAM,EAAE,QAAQ;iBACjB,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;QAC1B,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,kBAAa,GAAG,KAAK,EACnB,KAAa,EACb,QAAgB,EAChB,IAMC,EACD,EAAE;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI,QAAQ,iBAAiB,EAAE;gBACnE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,OAAO,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,uBAAuB;aAC3D,CAAC,CAAA;QACJ,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BG;QACH,mBAAc,GAAG,KAAK,EACpB,KAAa,EACb,QAAgB,EAChB,IAAmC,EACnC,KAAa,EACb,EAAE;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI,QAAQ,SAAS,EAAE;gBAC3D,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE;aAC9C,CAAC,CAAA;QACJ,CAAC,CAAA;QAED;;WAEG;QACK,cAAS,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;YAC1C,wIAAwI;YACxI,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;oBACvC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE;iBAC9C,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC,CAAA;QAxWC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CAuWF;AA9WD,oBA8WC"}

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

@@ -24,7 +24,7 @@ export declare 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)
      * })
@@ -33,7 +33,7 @@ export declare 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 }) => {
@@ -112,7 +112,7 @@ export declare class DraftOrder {
      *     },
      *   ],
      *   region_id: "region_123",
-     *   sales_channel_id: "sales_channel_123",
+     *   sales_channel_id: "sc_123",
      * })
      * .then(({ draft_order }) => {
      *   console.log(draft_order)
@@ -133,7 +133,7 @@ export declare 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 }) => {
@@ -142,5 +142,286 @@ export declare class DraftOrder {
      * ```
      */
     update(id: string, body: HttpTypes.AdminUpdateDraftOrder, query?: HttpTypes.AdminDraftOrderParams, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderResponse>;
+    /**
+     * 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)
+     * })
+     */
+    convertToOrder(id: string, query?: HttpTypes.AdminDraftOrderParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * 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)
+     * })
+     * ```
+     */
+    addItems(id: string, body: HttpTypes.AdminAddDraftOrderItems, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    /**
+     * 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)
+     * })
+     * ```
+     */
+    updateActionItem(id: string, actionId: string, body: HttpTypes.AdminUpdateDraftOrderItem, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    /**
+     * 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)
+     * })
+     * ```
+     */
+    removeActionItem(id: string, actionId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    /**
+     * 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)
+     * })
+     * ```
+     */
+    updateItem(id: string, itemId: string, body: HttpTypes.AdminUpdateDraftOrderItem, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    /**
+     * 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)
+     * })
+     * ```
+     */
+    addPromotions(id: string, body: HttpTypes.AdminAddDraftOrderPromotions, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    /**
+     * 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"],
+     * })
+     * ```
+     */
+    removePromotions(id: string, body: HttpTypes.AdminRemoveDraftOrderPromotions, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    /**
+     * 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)
+     * })
+     * ```
+     */
+    addShippingMethod(id: string, body: HttpTypes.AdminAddDraftOrderShippingMethod, 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 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)
+     * })
+     * ```
+     */
+    updateActionShippingMethod(id: string, actionId: string, body: HttpTypes.AdminUpdateDraftOrderActionShippingMethod, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    /**
+     * 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)
+     * })
+     * ```
+     */
+    removeActionShippingMethod(id: string, actionId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    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
+     * [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)
+     * })
+     * ```
+     */
+    beginEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    /**
+     * 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)
+     * })
+     * ```
+     */
+    cancelEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.DeleteResponse<"draft-order-edit">>;
+    /**
+     * 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)
+     * })
+     * ```
+     */
+    requestEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
+    /**
+     * 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)
+     * })
+     * ```
+     */
+    confirmEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
 }
 //# sourceMappingURL=draft-order.d.ts.map

package/dist/esm/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;CAY1B"}
+{"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"}