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

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

@@ -0,0 +1,427 @@
+import { HttpTypes } from "@medusajs/types";
+import { Client } from "../client";
+import { ClientHeaders } from "../types";
+export declare class DraftOrder {
+    /**
+     * @ignore
+     */
+    private client;
+    /**
+     * @ignore
+     */
+    constructor(client: Client);
+    /**
+     * This method retrieves a draft order by its ID. It sends a request to the
+     * [Get Draft Order](https://docs.medusajs.com/api/admin#draft-orders_getdraftordersid)
+     * API route.
+     *
+     * @param id - The draft order's ID.
+     * @param query - Configure the fields to retrieve in the draft order.
+     * @param headers - Headers to pass in the request
+     * @returns The draft order's details.
+     *
+     * @example
+     * To retrieve a draft order by its ID:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.retrieve("draft_order_123")
+     * .then(({ draft_order }) => {
+     *   console.log(draft_order)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.retrieve("draft_order_123", {
+     *   fields: "id,*items"
+     * })
+     * .then(({ draft_order }) => {
+     *   console.log(draft_order)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
+    retrieve(id: string, query?: HttpTypes.AdminDraftOrderParams, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderResponse>;
+    /**
+     * This method retrieves a paginated list of draft orders. It sends a request to the
+     * [List Draft Orders](https://docs.medusajs.com/api/admin#draft-orders_getdraftorders) API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of draft orders.
+     *
+     * @example
+     * To retrieve the list of draft orders:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.list()
+     * .then(({ draft_orders, count, limit, offset }) => {
+     *   console.log(draft_orders)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ draft_orders, count, limit, offset }) => {
+     *   console.log(draft_orders)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.list({
+     *   fields: "id,*items"
+     * })
+     * .then(({ draft_orders, count, limit, offset }) => {
+     *   console.log(draft_orders)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
+    list(queryParams?: HttpTypes.AdminDraftOrderListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderListResponse>;
+    /**
+     * This method creates a draft order. It sends a request to the
+     * [Create Draft Order](https://docs.medusajs.com/api/admin#draft-orders_postdraftorders) API route.
+     *
+     * @param body - The data to create the draft order.
+     * @param query - Configure the fields to retrieve in the draft order.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To create a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.create({
+     *   email: "test@test.com",
+     *   items: [
+     *     {
+     *       variant_id: "variant_123",
+     *       quantity: 1,
+     *     },
+     *   ],
+     *   region_id: "region_123",
+     *   sales_channel_id: "sales_channel_123",
+     * })
+     * .then(({ draft_order }) => {
+     *   console.log(draft_order)
+     * })
+     * ```
+     */
+    create(body: HttpTypes.AdminCreateDraftOrder, query?: HttpTypes.AdminDraftOrderParams, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderResponse>;
+    /**
+     * This method updates a draft order. It sends a request to the
+     * [Update Draft Order](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersid) API route.
+     *
+     * @param id - The draft order's ID.
+     * @param body - The data to update the draft order.
+     * @param query - Configure the fields to retrieve in the draft order.
+     * @param headers - Headers to pass in the request.
+     *
+     * @example
+     * To update a draft order:
+     *
+     * ```ts
+     * sdk.admin.draftOrder.update("draft_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>;
+    /**
+     * 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("draft_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/admin/draft-order.d.ts.map

@@ -0,0 +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"}