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

package/dist/admin/product-collection.js

@@ -8,6 +8,24 @@ class ProductCollection {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a product collection. It sends a request to the
+     * [Create Collection](https://docs.medusajs.com/api/admin#collections_postcollections)
+     * API route.
+     *
+     * @param body - The details of the product collection to create.
+     * @param query - Configure the fields to retrieve in the product collection.
+     * @param headers - Headers to pass in the request
+     * @returns The product collection's details.
+     *
+     * @example
+     * sdk.admin.productCollection.create({
+     *   title: "Summer Collection"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     async create(body, query, headers) {
         return this.client.fetch(`/admin/collections`, {
             method: "POST",
@@ -16,6 +34,25 @@ class ProductCollection {
             query,
         });
     }
+    /**
+     * This method updates a collection. It sends a request to the
+     * [Update Collection](https://docs.medusajs.com/api/admin#collections_postcollectionsid)
+     * API route.
+     *
+     * @param id - The ID of the collection.
+     * @param body - The data to update in the collection.
+     * @param query - Configure the fields to retrieve in the product collection.
+     * @param headers - Headers to pass in the request
+     * @returns The product collection's details.
+     *
+     * @example
+     * sdk.admin.productCollection.update("pcol_123", {
+     *   title: "Summer Collection"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     async update(id, body, query, headers) {
         return this.client.fetch(`/admin/collections/${id}`, {
             method: "POST",
@@ -24,24 +61,136 @@ class ProductCollection {
             query,
         });
     }
+    /**
+     * This method retrieves a paginated list of collections. It sends a request to the
+     * [List Collections](https://docs.medusajs.com/api/admin#collections_getcollections) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of collections.
+     *
+     * @example
+     * To retrieve the list of collections:
+     *
+     * ```ts
+     * sdk.admin.productCollection.list()
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * 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.productCollection.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each collection:
+     *
+     * ```ts
+     * sdk.admin.productCollection.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     async list(queryParams, headers) {
         return this.client.fetch(`/admin/collections`, {
             headers,
             query: queryParams,
         });
     }
+    /**
+     * This method retrieves a collection by its ID. It sends a request to the
+     * [Get Collection](https://docs.medusajs.com/api/admin#collections_getcollectionsid) API route.
+     *
+     * @param id - The collection's ID.
+     * @param query - Configure the fields to retrieve in the collection.
+     * @param headers - Headers to pass in the request
+     * @returns The collection's details.
+     *
+     * @example
+     * To retrieve a collection by its ID:
+     *
+     * ```ts
+     * sdk.admin.productCollection.retrieve("pcol_123")
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.productCollection.retrieve("pcol_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     * ```
+     *
+     * 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 this.client.fetch(`/admin/collections/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * This method deletes a product collection. It sends a request to the
+     * [Delete Collection](https://docs.medusajs.com/api/admin#collections_deletecollectionsid)
+     * API route.
+     *
+     * @param id - The collection's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.productCollection.delete("pcol_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return this.client.fetch(`/admin/collections/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method manages the products of a collection to add or remove them. It sends a request
+     * to the [Manage Products](https://docs.medusajs.com/api/admin#collections_postcollectionsidproducts)
+     * API route.
+     *
+     * @param id - The collection's ID.
+     * @param body - The products to add or remove.
+     * @param headers - Headers to pass in the request
+     * @returns The product category's details.
+     *
+     * @example
+     * sdk.admin.productCollection.updateProducts("pcol_123", {
+     *   add: ["prod_123"],
+     *   remove: ["prod_321"]
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     async updateProducts(id, body, headers) {
         return this.client.fetch(`/admin/collections/${id}/products`, {
             method: "POST",

package/dist/admin/product-collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../src/admin/product-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IACD,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,WAAiD,EACjD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AA/FD,8CA+FC"}
+{"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../src/admin/product-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,WAAiD,EACjD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AArPD,8CAqPC"}

package/dist/esm/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/esm/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/esm/admin/notification.js

@@ -14,6 +14,39 @@ export 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).
+     */
     retrieve(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/notifications/${id}`, {
@@ -23,6 +56,53 @@ export class Notification {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/notifications`, {

package/dist/esm/admin/notification.js.map

@@ -1 +1 @@
-{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../../src/admin/notification.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EAAE,EAAE,EAC5B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EACtB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../../src/admin/notification.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EAAE,EAAE,EAC5B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EACtB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/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/esm/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"}