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

package/dist/admin/notification.d.ts

@@ -10,7 +10,87 @@ export declare class Notification {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a notification's details. It sends a request to the
+     * [Get Notification](https://docs.medusajs.com/api/admin#notifications_getnotificationsid)
+     * API route.
+     *
+     * @param id - The notification's ID.
+     * @param query - Configure the fields to retrieve in the notification.
+     * @param headers - Headers to pass in the request
+     * @returns The notification's details.
+     *
+     * @example
+     * To retrieve a notification by its ID:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123")
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123", {
+     *   fields: "id,to"
+     * })
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * 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.AdminNotificationParams, headers?: ClientHeaders): Promise<HttpTypes.AdminNotificationResponse>;
+    /**
+     * This method retrieves a paginated list of notifications. It sends a request to the
+     * [List Notifications](https://docs.medusajs.com/api/admin#notifications_getnotifications)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of notifications.
+     *
+     * @example
+     * To retrieve the list of notifications:
+     *
+     * ```ts
+     * sdk.admin.notification.list()
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * 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.notification.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each notification:
+     *
+     * ```ts
+     * sdk.admin.notification.list({
+     *   fields: "id,to"
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminNotificationListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminNotificationListResponse>;
 }
 //# sourceMappingURL=notification.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../src/admin/notification.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYnB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../src/admin/notification.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,YAAY;IACvB;;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,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/admin/notification.js

@@ -8,6 +8,39 @@ class Notification {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a notification's details. It sends a request to the
+     * [Get Notification](https://docs.medusajs.com/api/admin#notifications_getnotificationsid)
+     * API route.
+     *
+     * @param id - The notification's ID.
+     * @param query - Configure the fields to retrieve in the notification.
+     * @param headers - Headers to pass in the request
+     * @returns The notification's details.
+     *
+     * @example
+     * To retrieve a notification by its ID:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123")
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123", {
+     *   fields: "id,to"
+     * })
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     async retrieve(id, query, headers) {
         return await this.client.fetch(`/admin/notifications/${id}`, {
             method: "GET",
@@ -15,6 +48,53 @@ class Notification {
             query,
         });
     }
+    /**
+     * This method retrieves a paginated list of notifications. It sends a request to the
+     * [List Notifications](https://docs.medusajs.com/api/admin#notifications_getnotifications)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of notifications.
+     *
+     * @example
+     * To retrieve the list of notifications:
+     *
+     * ```ts
+     * sdk.admin.notification.list()
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * 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.notification.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each notification:
+     *
+     * ```ts
+     * sdk.admin.notification.list({
+     *   fields: "id,to"
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     async list(query, headers) {
         return await this.client.fetch(`/admin/notifications`, {
             method: "GET",

package/dist/admin/notification.js.map

@@ -1 +1 @@
-{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../src/admin/notification.ts"],"names":[],"mappings":";;;AAIA,MAAa,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EAAE,EAAE,EAC5B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EACtB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAxCD,oCAwCC"}
+{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../src/admin/notification.ts"],"names":[],"mappings":";;;AAIA,MAAa,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EAAE,EAAE,EAC5B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EACtB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAxHD,oCAwHC"}

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

@@ -10,13 +10,178 @@ export declare class OrderEdit {
      * @ignore
      */
     constructor(client: Client);
-    initiateRequest(body: HttpTypes.AdminInitiateOrderEditRequest, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
+    /**
+     * 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: HttpTypes.AdminInitiateOrderEditRequest, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditResponse>;
+    /**
+     * 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: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
+    /**
+     * 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: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
+    /**
+     * 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: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditDeleteResponse>;
+    /**
+     * 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: string, body: HttpTypes.AdminAddOrderEditItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
+    /**
+     * 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: string, itemId: string, body: HttpTypes.AdminUpdateOrderEditItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
+    /**
+     * 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: string, actionId: string, body: HttpTypes.AdminUpdateOrderEditItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
+    /**
+     * 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: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
 }
 //# sourceMappingURL=order-edit.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"order-edit.d.ts","sourceRoot":"","sources":["../../src/admin/order-edit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,eAAe,CACnB,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,OAAO,CACX,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,OAAO,CACX,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"order-edit.d.ts","sourceRoot":"","sources":["../../src/admin/order-edit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,eAAe,CACnB,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/admin/order-edit.js

@@ -8,6 +8,24 @@ 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)
+     * })
+     */
     async initiateRequest(body, query, headers) {
         return await this.client.fetch(`/admin/order-edits`, {
             method: "POST",
@@ -16,6 +34,22 @@ class OrderEdit {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async request(id, query, headers) {
         return await this.client.fetch(`/admin/order-edits/${id}/request`, {
             method: "POST",
@@ -23,6 +57,22 @@ class OrderEdit {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async confirm(id, query, headers) {
         return await this.client.fetch(`/admin/order-edits/${id}/confirm`, {
             method: "POST",
@@ -30,6 +80,22 @@ class OrderEdit {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async cancelRequest(id, query, headers) {
         return await this.client.fetch(`/admin/order-edits/${id}`, {
             method: "DELETE",
@@ -37,6 +103,31 @@ class OrderEdit {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async addItems(id, body, query, headers) {
         return await this.client.fetch(`/admin/order-edits/${id}/items`, {
             method: "POST",
@@ -45,6 +136,30 @@ class OrderEdit {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async updateOriginalItem(id, itemId, body, query, headers) {
         return await this.client.fetch(`/admin/order-edits/${id}/items/item/${itemId}`, {
             method: "POST",
@@ -53,6 +168,35 @@ class OrderEdit {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async updateAddedItem(id, actionId, body, query, headers) {
         return await this.client.fetch(`/admin/order-edits/${id}/items/${actionId}`, {
             method: "POST",
@@ -61,6 +205,27 @@ class OrderEdit {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async removeAddedItem(id, actionId, query, headers) {
         return await this.client.fetch(`/admin/order-edits/${id}/items/${actionId}`, {
             method: "DELETE",

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

@@ -1 +1 @@
-{"version":3,"file":"order-edit.js","sourceRoot":"","sources":["../../src/admin/order-edit.ts"],"names":[],"mappings":";;;AAIA,MAAa,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CACX,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,EAClC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CACX,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,EAClC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,QAAQ,EAChC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,MAAc,EACd,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,eAAe,MAAM,EAAE,EAC/C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,QAAgB,EAChB,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,QAAQ,EAAE,EAC5C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,QAAQ,EAAE,EAC5C;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AA7ID,8BA6IC"}
+{"version":3,"file":"order-edit.js","sourceRoot":"","sources":["../../src/admin/order-edit.ts"],"names":[],"mappings":";;;AAIA,MAAa,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,eAAe,CACnB,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,OAAO,CACX,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,EAClC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,OAAO,CACX,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,EAClC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,QAAQ,EAChC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,MAAc,EACd,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,eAAe,MAAM,EAAE,EAC/C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,QAAgB,EAChB,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,QAAQ,EAAE,EAC5C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,QAAQ,EAAE,EAC5C;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAlTD,8BAkTC"}