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

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

package/dist/admin/order.js

@@ -8,30 +8,163 @@ class Order {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * 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).
+     */
     async retrieve(id, query, headers) {
         return await this.client.fetch(`/admin/orders/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async retrievePreview(id, query, headers) {
         return await this.client.fetch(`/admin/orders/${id}/preview`, {
             query,
             headers,
         });
     }
+    /**
+     * 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).
+     */
     async list(queryParams, headers) {
         return await this.client.fetch(`/admin/orders`, {
             query: queryParams,
             headers,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async cancel(id, headers) {
         return await this.client.fetch(`/admin/orders/${id}/cancel`, {
             method: "POST",
             headers,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async createFulfillment(id, body, query, headers) {
         return await this.client.fetch(`/admin/orders/${id}/fulfillments`, {
             method: "POST",
@@ -40,6 +173,29 @@ class Order {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async cancelFulfillment(id, fulfillmentId, body, headers) {
         return await this.client.fetch(`/admin/orders/${id}/fulfillments/${fulfillmentId}/cancel`, {
             method: "POST",
@@ -47,6 +203,35 @@ class Order {
             body,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async createShipment(id, fulfillmentId, body, query, headers) {
         return await this.client.fetch(`/admin/orders/${id}/fulfillments/${fulfillmentId}/shipments`, {
             method: "POST",
@@ -55,6 +240,28 @@ class Order {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async markAsDelivered(id, fulfillmentId, body, query, headers) {
         return await this.client.fetch(`/admin/orders/${id}/fulfillments/${fulfillmentId}/mark-as-delivered`, {
             method: "POST",
@@ -63,12 +270,45 @@ class Order {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async listChanges(id, queryParams, headers) {
         return await this.client.fetch(`/admin/orders/${id}/changes`, {
             query: queryParams,
             headers,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async listLineItems(id, queryParams, headers) {
         return await this.client.fetch(`/admin/orders/${id}/line-items`, {
             query: queryParams,

package/dist/admin/order.js.map

@@ -1 +1 @@
-{"version":3,"file":"order.js","sourceRoot":"","sources":["../../src/admin/order.ts"],"names":[],"mappings":";;;AAWA,MAAa,KAAK;IAKhB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,KAAmC,EACnC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,UAAU,EAC7B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,WAAsD,EACtD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,eAAe,EAAE;YACjB,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,SAAS,EAC5B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,EAAU,EACV,IAA2C,EAC3C,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,eAAe,EAClC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,EAAU,EACV,aAAqB,EACrB,IAA2C,EAC3C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,SAAS,EAC1D;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,aAAqB,EACrB,IAAwC,EACxC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,YAAY,EAC7D;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,aAAqB,EACrB,IAAoD,EACpD,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,oBAAoB,EACrE;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CACf,EAAU,EACV,WAA6D,EAC7D,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE,UAAU,EAAE;YAC/B,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,WAA2D,EAC3D,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE,aAAa,EAAE;YAClC,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF;AAxJD,sBAwJC"}
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../src/admin/order.ts"],"names":[],"mappings":";;;AAWA,MAAa,KAAK;IAKhB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,KAAmC,EACnC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,UAAU,EAC7B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,WAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,eAAe,EAAE;YACjB,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,SAAS,EAC5B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,iBAAiB,CACrB,EAAU,EACV,IAA2C,EAC3C,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,eAAe,EAClC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,iBAAiB,CACrB,EAAU,EACV,aAAqB,EACrB,IAA2C,EAC3C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,SAAS,EAC1D;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,aAAqB,EACrB,IAAwC,EACxC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,YAAY,EAC7D;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,aAAqB,EACrB,IAAoD,EACpD,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,oBAAoB,EACrE;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,WAAW,CACf,EAAU,EACV,WAA6D,EAC7D,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE,UAAU,EAAE;YAC/B,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,WAA2D,EAC3D,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE,aAAa,EAAE;YAClC,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF;AAxYD,sBAwYC"}

package/dist/admin/payment-collection.d.ts

@@ -10,8 +10,63 @@ export declare class PaymentCollection {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a payment collection. It sends a request to the
+     * [Create Payment Collection](https://docs.medusajs.com/api/admin#payment-collections_postpaymentcollections)
+     * API route.
+     *
+     * @param body - The details of the payment collection to create.
+     * @param query - Configure the fields to retrieve in the payment collection.
+     * @param headers - Headers to pass in the request
+     * @returns The payment collection's details.
+     *
+     * @example
+     * sdk.admin.paymentCollection.create({
+     *   order_id: "order_123"
+     * })
+     * .then(({ payment_collection }) => {
+     *   console.log(payment_collection)
+     * })
+     */
     create(body: HttpTypes.AdminCreatePaymentCollection, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentCollectionResponse>;
+    /**
+     * This method deletes a payment collection. It sends a request to the
+     * [Delete Payment Collection](https://docs.medusajs.com/api/admin#payment-collections_deletepaymentcollectionsid)
+     * API route.
+     *
+     * @param id - The payment collection's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.paymentCollection.delete("paycol_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDeletePaymentCollectionResponse>;
+    /**
+     * This method marks a payment collection as paid. It sends a request to the
+     * [Mark as Paid](https://docs.medusajs.com/api/admin#payment-collections_postpaymentcollectionsidmarkaspaid)
+     * API route.
+     *
+     * The API route creates and authorizes a payment session, then capture its payment,
+     * using the manual payment provider.
+     *
+     * @param id - The payment collection to mark as paid.
+     * @param body - The details to mark the payment collection as paid.
+     * @param query - Configure the fields to retrieve in the payment collection.
+     * @param headers - Headers to pass in the request.
+     * @returns The payment collection's details.
+     *
+     * @example
+     * sdk.admin.paymentCollection.markAsPaid("paycol_123", {
+     *   order_id: "order_123"
+     * })
+     * .then(({ payment_collection }) => {
+     *   console.log(payment_collection)
+     * })
+     */
     markAsPaid(id: string, body: HttpTypes.AdminMarkPaymentCollectionAsPaid, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentCollectionResponse>;
 }
 //# sourceMappingURL=payment-collection.d.ts.map

package/dist/admin/payment-collection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payment-collection.d.ts","sourceRoot":"","sources":["../../src/admin/payment-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,4BAA4B,EAC5C,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,UAAU,CACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gCAAgC,EAChD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}
+{"version":3,"file":"payment-collection.d.ts","sourceRoot":"","sources":["../../src/admin/payment-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,4BAA4B,EAC5C,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gCAAgC,EAChD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}