@medusajs/js-sdk 2.0.1-snapshot-20241025090810 → 2.0.2-snapshot-20241104135243

package/dist/esm/admin/order-edit.js

@@ -14,6 +14,24 @@ export class OrderEdit {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates an order edit request. It sends a HTTP request to the
+     * [Create Order Edit](https://docs.medusajs.com/api/admin#order-edits_postorderedits)
+     * API route.
+     *
+     * @param body - The order edit's details.
+     * @param query - Configure the fields to retrieve in the order edit.
+     * @param headers - Headers to pass in the request.
+     * @returns The order edit's details.
+     *
+     * @example
+     * sdk.admin.orderEdit.initiateRequest({
+     *   order_id: "order_123"
+     * })
+     * .then(({ order_change }) => {
+     *   console.log(order_change)
+     * })
+     */
     initiateRequest(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/order-edits`, {
@@ -24,6 +42,22 @@ export class OrderEdit {
             });
         });
     }
+    /**
+     * This method changes an order edit to requested. It sends a request to the
+     * [Request Order Edit](https://docs.medusajs.com/api/admin#order-edits_postordereditsidrequest)
+     * API route.
+     *
+     * @param id - The order edit's ID.
+     * @param query - Configure the fields to retrieve in the order preview.
+     * @param headers - Headers to pass in the request.
+     * @returns The order preview's details.
+     *
+     * @example
+     * sdk.admin.orderEdit.request("ordch_123")
+     * .then(({ order_preview }) => {
+     *   console.log(order_preview)
+     * })
+     */
     request(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/order-edits/${id}/request`, {
@@ -33,6 +67,22 @@ export class OrderEdit {
             });
         });
     }
+    /**
+     * This method confirms an order edit and applies it on the order. It sends a request
+     * to the [Confirm Order Edit](https://docs.medusajs.com/api/admin#order-edits_postordereditsidconfirm)
+     * API route.
+     *
+     * @param id - The order edit's ID.
+     * @param query - Configure the fields to retrieve in the order preview.
+     * @param headers - Headers to pass in the request.
+     * @returns The order preview's details.
+     *
+     * @example
+     * sdk.admin.orderEdit.confirm("ordch_123")
+     * .then(({ order_preview }) => {
+     *   console.log(order_preview)
+     * })
+     */
     confirm(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/order-edits/${id}/confirm`, {
@@ -42,6 +92,22 @@ export class OrderEdit {
             });
         });
     }
+    /**
+     * This method cancels a requested order edit. It sends a request to the
+     * [Cancel Order Edit](https://docs.medusajs.com/api/admin#order-edits_deleteordereditsid)
+     * API route.
+     *
+     * @param id - The order edit's ID.
+     * @param query - Query parameters
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.orderEdit.cancelRequest("ordch_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     cancelRequest(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/order-edits/${id}`, {
@@ -51,6 +117,31 @@ export class OrderEdit {
             });
         });
     }
+    /**
+     * This method adds items to an order edit. These items will have the action `ITEM_ADD`.
+     *
+     * The method sends a request to the [Add Items](https://docs.medusajs.com/api/admin#order-edits_postordereditsiditems)
+     * API route.
+     *
+     * @param id - The order edit's ID.
+     * @param body - The items to add.
+     * @param query - Configure the fields to retrieve in the order preview.
+     * @param headers - Headers to pass in the request.
+     * @returns The order preview's details.
+     *
+     * @example
+     * sdk.admin.orderEdit.addItems("ordch_123", {
+     *   items: [
+     *     {
+     *       variant_id: "variant_123",
+     *       quantity: 1
+     *     }
+     *   ]
+     * })
+     * .then(({ order_preview }) => {
+     *   console.log(order_preview)
+     * })
+     */
     addItems(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/order-edits/${id}/items`, {
@@ -61,6 +152,30 @@ export class OrderEdit {
             });
         });
     }
+    /**
+     * This method updates the quantity and other details of an item in an order. It sends a request to the
+     * [Update Item Quantity](https://docs.medusajs.com/api/admin#order-edits_postordereditsiditemsitemitem_id)
+     * API route.
+     *
+     * @param id - The order edit's ID.
+     * @param itemId - The item's ID in the order.
+     * @param body - The data to edit in the item.
+     * @param query - Configure the fields to retrieve in the order preview.
+     * @param headers - Headers to pass in the request.
+     * @returns The order preview's details.
+     *
+     * @example
+     * sdk.admin.orderEdit.updateOriginalItem(
+     *   "ordch_123",
+     *   "orli_123",
+     *   {
+     *     quantity: 1
+     *   }
+     * )
+     * .then(({ order_preview }) => {
+     *   console.log(order_preview)
+     * })
+     */
     updateOriginalItem(id, itemId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/order-edits/${id}/items/item/${itemId}`, {
@@ -71,6 +186,35 @@ export class OrderEdit {
             });
         });
     }
+    /**
+     * This method updates an added item in the order edit by the ID of the item's `ITEM_ADD` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * It sends a request
+     * to the [Update Item](https://docs.medusajs.com/api/admin#order-edits_postordereditsiditemsaction_id)
+     * API route.
+     *
+     * @param id - The order edit's ID.
+     * @param actionId - The id of the new item's `ITEM_ADD` action.
+     * @param body - The data to update.
+     * @param query - Configure the fields to retrieve in the order preview.
+     * @param headers - Headers to pass in the request.
+     * @returns The order preview's details.
+     *
+     * @example
+     * sdk.admin.orderEdit.updateAddedItem(
+     *   "ordch_123",
+     *   "orli_123",
+     *   {
+     *     quantity: 1
+     *   }
+     * )
+     * .then(({ order_preview }) => {
+     *   console.log(order_preview)
+     * })
+     */
     updateAddedItem(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/order-edits/${id}/items/${actionId}`, {
@@ -81,6 +225,27 @@ export class OrderEdit {
             });
         });
     }
+    /**
+     * This method removes an added item in the order edit by the ID of the item's `ITEM_ADD` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The order edit's ID.
+     * @param actionId - The id of the new item's `ITEM_ADD` action.
+     * @param query - Configure the fields to retrieve in the order preview.
+     * @param headers - Headers to pass in the request.
+     * @returns The order preview's details.
+     *
+     * @example
+     * sdk.admin.orderEdit.removeAddedItem(
+     *   "ordch_123",
+     *   "orli_123",
+     * )
+     * .then(({ order_preview }) => {
+     *   console.log(order_preview)
+     * })
+     */
     removeAddedItem(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/order-edits/${id}/items/${actionId}`, {

package/dist/esm/admin/order-edit.js.map

@@ -1 +1 @@
-{"version":3,"file":"order-edit.js","sourceRoot":"","sources":["../../../src/admin/order-edit.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,eAAe,CACnB,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EACpB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,OAAO,CACX,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,EAClC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,OAAO,CACX,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,EAClC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,QAAQ,EAChC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,kBAAkB,CACtB,EAAU,EACV,MAAc,EACd,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,eAAe,MAAM,EAAE,EAC/C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,eAAe,CACnB,EAAU,EACV,QAAgB,EAChB,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,QAAQ,EAAE,EAC5C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,eAAe,CACnB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,QAAQ,EAAE,EAC5C;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"order-edit.js","sourceRoot":"","sources":["../../../src/admin/order-edit.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,eAAe,CACnB,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EACpB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CACX,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,EAClC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CACX,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,EAClC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,QAAQ,CACZ,EAAU,EACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,QAAQ,EAChC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,kBAAkB,CACtB,EAAU,EACV,MAAc,EACd,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,eAAe,MAAM,EAAE,EAC/C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,eAAe,CACnB,EAAU,EACV,QAAgB,EAChB,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,QAAQ,EAAE,EAC5C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,eAAe,CACnB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,QAAQ,EAAE,EAC5C;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

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

@@ -10,29 +10,255 @@ export declare class Order {
      * @ignore
      */
     constructor(client: Client);
-    retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        order: HttpTypes.AdminOrder;
-    }>;
+    /**
+     * This method retrieves an order by its ID. It sends a request to the
+     * [Get Order](https://docs.medusajs.com/api/admin#orders_getordersid)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param query - Configure the fields to retrieve in the order.
+     * @param headers - Headers to pass in the request
+     * @returns The order's details.
+     *
+     * @example
+     * To retrieve an order by its ID:
+     *
+     * ```ts
+     * sdk.admin.order.retrieve("order_123")
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.order.retrieve("order_123", {
+     *   fields: "id,*items"
+     * })
+     * .then(({ order }) => {
+     *   console.log(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?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * This method retrieves the preview of an order based on its last associated change. It sends a request to the
+     * [Get Order Preview](https://docs.medusajs.com/api/admin#orders_getordersidpreview) API route.
+     *
+     * @param id - The order's ID.
+     * @param query - Query parameters.
+     * @param headers - Headers to pass in the request
+     * @returns The order preview's details.
+     *
+     * @example
+     * sdk.admin.order.retrievePreview("order_123")
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
     retrievePreview(id: string, query?: HttpTypes.AdminOrderFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderPreviewResponse>;
-    list(queryParams?: FindParams & HttpTypes.AdminOrderFilters, headers?: ClientHeaders): Promise<HttpTypes.PaginatedResponse<{
-        orders: HttpTypes.AdminOrder[];
-    }>>;
-    cancel(id: string, headers?: ClientHeaders): Promise<{
-        order: HttpTypes.AdminOrder;
-    }>;
-    createFulfillment(id: string, body: HttpTypes.AdminCreateOrderFulfillment, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        order: HttpTypes.AdminOrder;
-    }>;
-    cancelFulfillment(id: string, fulfillmentId: string, body: HttpTypes.AdminCancelOrderFulfillment, headers?: ClientHeaders): Promise<{
-        order: HttpTypes.AdminOrder;
-    }>;
-    createShipment(id: string, fulfillmentId: string, body: HttpTypes.AdminCreateOrderShipment, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        order: HttpTypes.AdminOrder;
-    }>;
-    markAsDelivered(id: string, fulfillmentId: string, body: HttpTypes.AdminMarkOrderFulfillmentAsDelivered, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        order: HttpTypes.AdminOrder;
-    }>;
+    /**
+     * This method retrieves a paginated list of orders. It sends a request to the
+     * [List Orders](https://docs.medusajs.com/api/admin#orders_getorders) API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of orders.
+     *
+     * @example
+     * To retrieve the list of orders:
+     *
+     * ```ts
+     * sdk.admin.order.list()
+     * .then(({ orders, count, limit, offset }) => {
+     *   console.log(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.order.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ orders, count, limit, offset }) => {
+     *   console.log(orders)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each order:
+     *
+     * ```ts
+     * sdk.admin.order.list({
+     *   fields: "id,*items"
+     * })
+     * .then(({ orders, count, limit, offset }) => {
+     *   console.log(orders)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
+    list(queryParams?: HttpTypes.AdminOrderFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderListResponse>;
+    /**
+     * This method cancels an order. It sends a request to the
+     * [Cancel Order](https://docs.medusajs.com/api/admin#orders_postordersidcancel)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The order's details.
+     *
+     * @example
+     * sdk.admin.order.cancel("order_123")
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    cancel(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * This method creates a fulfillment for an order. It sends a request to the
+     * [Create Fulfillment](https://docs.medusajs.com/api/admin#orders_postordersidfulfillments)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param body - The fulfillment's details.
+     * @param query - Configure the fields to retrieve in the order.
+     * @param headers - Headers to pass in the request
+     * @returns The order's details.
+     *
+     * @example
+     * sdk.admin.order.createFulfillment("order_123", {
+     *   items: [
+     *     {
+     *       id: "orli_123",
+     *       quantity: 1
+     *     }
+     *   ]
+     * })
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    createFulfillment(id: string, body: HttpTypes.AdminCreateOrderFulfillment, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * This method cancels an order's fulfillment. It sends a request to the
+     * [Cancel Fulfillment](https://docs.medusajs.com/api/admin#orders_postordersidfulfillmentsfulfillment_idcancel)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param fulfillmentId - The ID of the fulfillment to cancel.
+     * @param body - The cancelation's details.
+     * @param headers - Headers to pass in the request
+     * @returns The order's details.
+     *
+     * @example
+     * sdk.admin.order.cancelFulfillment(
+     *   "order_123",
+     *   "ful_123",
+     *   {
+     *     no_notification: false
+     *   }
+     * )
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    cancelFulfillment(id: string, fulfillmentId: string, body: HttpTypes.AdminCancelOrderFulfillment, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * This method creates a shipment for an order's fulfillment. It sends a request to the
+     * [Create Shipment](https://docs.medusajs.com/api/admin#orders_postordersidfulfillmentsfulfillment_idshipments)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param fulfillmentId - The ID of the fulfillment.
+     * @param body - The shipment's details.
+     * @param query - Configure the fields to retrieve in the order.
+     * @param headers - Headers to pass in the request
+     * @returns The order's details.
+     *
+     * @example
+     * sdk.admin.order.createShipment(
+     *   "order_123",
+     *   "ful_123",
+     *   {
+     *     items: [
+     *       {
+     *         id: "fulit_123",
+     *         quantity: 1
+     *       }
+     *     ]
+     *   }
+     * )
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    createShipment(id: string, fulfillmentId: string, body: HttpTypes.AdminCreateOrderShipment, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * This method marks an order's fulfillment as delivered. It sends a request to the
+     * [Mark Delivered ](https://docs.medusajs.com/api/admin#orders_postordersidfulfillmentsfulfillment_idmarkasdelivered)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param fulfillmentId - The fulfillment's ID.
+     * @param body - The delivery details.
+     * @param query - Configure the fields to retrieve in the order.
+     * @param headers - Headers to pass in the request
+     * @returns The order's details.
+     *
+     * @example
+     * sdk.admin.order.markAsDelivered(
+     *   "order_123",
+     *   "ful_123",
+     *   {}
+     * )
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    markAsDelivered(id: string, fulfillmentId: string, body: HttpTypes.AdminMarkOrderFulfillmentAsDelivered, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * This method retrieves a list of changes made on an order, including returns, exchanges, etc...
+     *
+     * This method sends a request to the [List Changes](https://docs.medusajs.com/api/admin#orders_getordersidchanges)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param queryParams - Configure the fields to retrieve in each order change.
+     * @param headers - Headers to pass in the request
+     * @returns The list of order changes.
+     *
+     * @example
+     * sdk.admin.order.listChanges("order_123")
+     * .then(({ order_changes }) => {
+     *   console.log(order_changes)
+     * })
+     */
     listChanges(id: string, queryParams?: FindParams & HttpTypes.AdminOrderChangesFilters, headers?: ClientHeaders): Promise<HttpTypes.PaginatedResponse<HttpTypes.AdminOrderChangesResponse>>;
-    listLineItems(id: string, queryParams?: FindParams & HttpTypes.AdminOrderItemsFilters, headers?: ClientHeaders): Promise<HttpTypes.PaginatedResponse<HttpTypes.AdminOrderLineItemsListResponse>>;
+    /**
+     * This method retrieves the order's line items. It sends a request to the
+     * [List Line Items](https://docs.medusajs.com/api/admin#orders_getordersidlineitems)
+     * API routes.
+     *
+     * @param id - The order's ID.
+     * @param queryParams - Configure the fields to retrieve in each line item.
+     * @param headers - Headers to pass in the request
+     * @returns The list of line items.
+     *
+     * @example
+     * sdk.admin.order.listLineItems("order_123")
+     * .then(({ order_items }) => {
+     *   console.log(order_items)
+     * })
+     */
+    listLineItems(id: string, queryParams?: FindParams & HttpTypes.AdminOrderItemsFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderLineItemsListResponse>;
 }
 //# sourceMappingURL=order.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"order.d.ts","sourceRoot":"","sources":["../../../src/admin/order.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EAET,YAAY,EACb,MAAM,iBAAiB,CAAA;AAGxB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,KAAK;IAChB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;eAC9B,SAAS,CAAC,UAAU;;IASxD,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,iBAAiB,EACnC,OAAO,CAAC,EAAE,aAAa;IAWnB,IAAI,CACR,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,iBAAiB,EACtD,OAAO,CAAC,EAAE,aAAa;gBAGO,SAAS,CAAC,UAAU,EAAE;;IAOhD,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;eACN,SAAS,CAAC,UAAU;;IASxD,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,2BAA2B,EAC3C,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;eAEiB,SAAS,CAAC,UAAU;;IAWxD,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,SAAS,CAAC,2BAA2B,EAC3C,OAAO,CAAC,EAAE,aAAa;eAEiB,SAAS,CAAC,UAAU;;IAUxD,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;eAEiB,SAAS,CAAC,UAAU;;IAWxD,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,SAAS,CAAC,oCAAoC,EACpD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;eAEiB,SAAS,CAAC,UAAU;;IAWxD,WAAW,CACf,EAAE,EAAE,MAAM,EACV,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,wBAAwB,EAC7D,OAAO,CAAC,EAAE,aAAa;IAUnB,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,sBAAsB,EAC3D,OAAO,CAAC,EAAE,aAAa;CAS1B"}
+{"version":3,"file":"order.d.ts","sourceRoot":"","sources":["../../../src/admin/order.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EAET,YAAY,EACb,MAAM,iBAAiB,CAAA;AAGxB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,KAAK;IAChB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;OAcG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,iBAAiB,EACnC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,iBAAiB,EACzC,OAAO,CAAC,EAAE,aAAa;IAUzB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,2BAA2B,EAC3C,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,SAAS,CAAC,2BAA2B,EAC3C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,SAAS,CAAC,oCAAoC,EACpD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,EACV,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,wBAAwB,EAC7D,OAAO,CAAC,EAAE,aAAa;IAUzB;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,sBAAsB,EAC3D,OAAO,CAAC,EAAE,aAAa;CAS1B"}