@acmekit/js-sdk 2.13.1

package/dist/esm/admin/order.js

@@ -0,0 +1,603 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export class Order {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method retrieves an order by its ID. It sends a request to the
+     * [Get Order](https://docs.acmekit.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.acmekit.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/orders/${id}`, {
+                query,
+                headers,
+            });
+        });
+    }
+    /**
+     * This method updates an order. It sends a request to the
+     * [Update Order Email](https://docs.acmekit.com/api/admin#orders_postordersid)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param body - The update details.
+     * @param headers - Headers to pass in the request
+     * @returns The order's details.
+     *
+     * @example
+     * sdk.admin.order.update(
+     *   "order_123",
+     *   {
+     *     email: "new_email@example.com",
+     *     shipping_address: {
+     *       first_name: "John",
+     *       last_name: "Doe",
+     *       address_1: "123 Main St",
+     *     }
+     *   }
+     * )
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    update(id, body, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}`, {
+                method: "POST",
+                headers,
+                body,
+            });
+        });
+    }
+    /**
+     * 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.acmekit.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, query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield 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.acmekit.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.acmekit.com/api/store#select-fields-and-relations).
+     */
+    list(queryParams, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders`, {
+                query: queryParams,
+                headers,
+            });
+        });
+    }
+    /**
+     * This method archives an order. It sends a request to the
+     * [Archive Order](https://docs.acmekit.com/api/admin#orders_postordersidarchive)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param queryParams - 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.archive("order_123")
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    archive(id, queryParams, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/archive`, {
+                method: "POST",
+                query: queryParams,
+                headers,
+            });
+        });
+    }
+    /**
+     * This method cancels an order. It sends a request to the
+     * [Cancel Order](https://docs.acmekit.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, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/cancel`, {
+                method: "POST",
+                headers,
+            });
+        });
+    }
+    /**
+     * This method completes an order. It sends a request to the
+     * [Complete Order](https://docs.acmekit.com/api/admin#orders_postordersidcomplete)
+     * 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.complete("order_123")
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    complete(id, body, queryParams, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/complete`, {
+                method: "POST",
+                body,
+                query: queryParams,
+                headers,
+            });
+        });
+    }
+    /**
+     * This method requests an order transfer. It sends a request to the
+     * [Request Order Transfer](https://docs.acmekit.com/api/admin#orders_postordersidrequesttransfer)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param headers - Headers to pass in the request.
+     * @param body - The transfer's details - the id of the next owner.
+     * @returns The order's details.
+     *
+     * @example
+     * sdk.admin.order.requestTransfer("order_123", {
+     *   customer_id: "cus_123",
+     *   internal_note: "Internal note",
+     * })
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    requestTransfer(id, body, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/transfer`, {
+                method: "POST",
+                headers,
+                body,
+            });
+        });
+    }
+    /**
+     * This method cancels an order transfer request. It sends a request to the
+     * [Cancel Order Transfer Request](https://docs.acmekit.com/api/admin#orders_postordersidcanceltransferrequest)
+     * 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.cancelTransfer("order_123")
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    cancelTransfer(id, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/transfer/cancel`, {
+                method: "POST",
+                headers,
+            });
+        });
+    }
+    /**
+     * This method creates a fulfillment for an order. It sends a request to the
+     * [Create Fulfillment](https://docs.acmekit.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, body, query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/fulfillments`, {
+                method: "POST",
+                headers,
+                body,
+                query,
+            });
+        });
+    }
+    /**
+     * This method cancels an order's fulfillment. It sends a request to the
+     * [Cancel Fulfillment](https://docs.acmekit.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, fulfillmentId, body, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/fulfillments/${fulfillmentId}/cancel`, {
+                method: "POST",
+                headers,
+                body,
+            });
+        });
+    }
+    /**
+     * This method creates a shipment for an order's fulfillment. It sends a request to the
+     * [Create Shipment](https://docs.acmekit.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, fulfillmentId, body, query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/fulfillments/${fulfillmentId}/shipments`, {
+                method: "POST",
+                headers,
+                body,
+                query,
+            });
+        });
+    }
+    /**
+     * This method marks an order's fulfillment as delivered. It sends a request to the
+     * [Mark Delivered ](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idmarkasdelivered)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param fulfillmentId - The fulfillment'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
+     * sdk.admin.order.markAsDelivered(
+     *   "order_123",
+     *   "ful_123",
+     * )
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    markAsDelivered(id, fulfillmentId, query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/fulfillments/${fulfillmentId}/mark-as-delivered`, {
+                method: "POST",
+                headers,
+                query,
+            });
+        });
+    }
+    /**
+     * This method retrieves a list of shipping options for an order based on the order's shipping address.
+     *
+     * This method sends a request to the [List Shipping Options](https://docs.acmekit.com/api/admin#orders_getordersidshipping-options)
+     * API route.
+     *
+     * @param id - The order's ID.
+     * @param queryParams - Configure the fields to retrieve in each shipping option.
+     * @param headers - Headers to pass in the request
+     * @returns The list of shipping options.
+     *
+     * @example
+     * sdk.admin.order.listShippingOptions("order_123")
+     * .then(({ shipping_options }) => {
+     *   console.log(shipping_options)
+     * })
+     */
+    listShippingOptions(id, queryParams, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/shipping-options`, {
+                query: queryParams,
+                headers,
+            });
+        });
+    }
+    /**
+     * 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.acmekit.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, queryParams, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield 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.acmekit.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, queryParams, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${id}/line-items`, {
+                query: queryParams,
+                headers,
+            });
+        });
+    }
+    /**
+     * This method creates a credit line for an order. It sends a request to the
+     * [Create Credit Line](https://docs.acmekit.com/api/admin#orders_postordersidcredit-lines) API route.
+     *
+     * @param orderId - The order's ID.
+     * @param body - The credit line'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.createCreditLine(
+     *   "order_123",
+     *   {
+     *     amount: 100,
+     *     reference: "order",
+     *     reference_id: "order_123",
+     *   }
+     * )
+     * .then(({ order }) => {
+     *   console.log(order)
+     * })
+     */
+    createCreditLine(orderId, body, query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/${orderId}/credit-lines`, {
+                method: "POST",
+                headers,
+                body,
+                query,
+            });
+        });
+    }
+    /**
+     * This method updates an order change. It sends a request to the
+     * [Update Order Change](https://docs.acmekit.com/api/admin#order-changes_postorder-changesid)
+     * API route.
+     *
+     * @since 2.12.0
+     *
+     * @param id - The order change's ID.
+     * @param body - The update details.
+     * @param query - Configure the fields to retrieve in the order change.
+     * @param headers - Headers to pass in the request
+     * @returns The order change's details.
+     *
+     * @example
+     * sdk.admin.order.updateOrderChange(
+     *   "ordch_123",
+     *   {
+     *     carry_over_promotions: true
+     *   }
+     * )
+     * .then(({ order_change }) => {
+     *   console.log(order_change)
+     * })
+     */
+    updateOrderChange(id, body, query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/order-changes/${id}`, {
+                method: "POST",
+                headers,
+                body,
+                query,
+            });
+        });
+    }
+    /**
+     * This method starts an order export process to retrieve a CSV of exported orders. It sends
+     * a request to the [Export Orders](https://docs.acmekit.com/api/admin#orders_postordersexport) API route.
+     *
+     * You'll receive in the response the transaction ID of the workflow generating the CSV file.
+     * To check the status of the execution, send a `GET` request to
+     * `/admin/workflows-executions/export-orders/:transaction-id`.
+     *
+     * Once the execution finishes successfully, a notification is created for the export.
+     * You can retrieve the notifications using the `/admin/notification` API route to
+     * retrieve the file's download URL.
+     *
+     * @since 2.12.3
+     *
+     * @param query - Filters to specify which orders to export.
+     * @param headers - Headers to pass in the request.
+     * @returns The export's details.
+     *
+     * @example
+     * sdk.admin.order.export()
+     * .then(({ transaction_id }) => {
+     *   console.log(transaction_id)
+     * })
+     */
+    export(query, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/orders/export`, {
+                method: "POST",
+                headers,
+                query,
+            });
+        });
+    }
+}
+//# sourceMappingURL=order.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../../src/admin/order.ts"],"names":[],"mappings":";;;;;;;;;AAYA,MAAM,OAAO,KAAK;IAKhB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,MAAM,CACV,EAAU,EACV,IAAgC,EAChC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,eAAe,CACnB,EAAU,EACV,KAAmC,EACnC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,UAAU,EAC7B;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,eAAe,EACf;gBACE,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CACX,EAAU,EACV,WAA0B,EAC1B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,UAAU,EAC7B;gBACE,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,SAAS,EAC5B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CACZ,EAAU,EACV,IAA8B,EAC9B,WAA0B,EAC1B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,WAAW,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,eAAe,CACnB,EAAU,EACV,IAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,WAAW,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAAC,EAAU,EAAE,OAAuB;;YACtD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,kBAAkB,EACrC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CACrB,EAAU,EACV,IAA2C,EAC3C,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,eAAe,EAClC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,iBAAiB,CACrB,EAAU,EACV,aAAqB,EACrB,IAA2C,EAC3C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,SAAS,EAC1D;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,cAAc,CAClB,EAAU,EACV,aAAqB,EACrB,IAAwC,EACxC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,YAAY,EAC7D;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CACnB,EAAU,EACV,aAAqB,EACrB,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,oBAAoB,EACrE;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,mBAAmB,CACvB,EAAU,EACV,WAAoE,EACpE,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE3B,iBAAiB,EAAE,mBAAmB,EAAE;gBACzC,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,CACf,EAAU,EACV,WAA6D,EAC7D,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE,UAAU,EAAE;gBAC/B,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAU,EACV,WAA2D,EAC3D,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,aAAa,EAChC;gBACE,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,gBAAgB,CACpB,OAAe,EACf,IAAgD,EAChD,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,OAAO,eAAe,EACvC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CACrB,EAAU,EACV,IAAsC,EACtC,KAA0C,EAC1C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EAAE,EAAE,EAC5B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,KAAmC,EAAE,OAAuB;;YACvE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EACtB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

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

@@ -0,0 +1,72 @@
+import { HttpTypes, SelectParams } from "@acmekit/types";
+import { Client } from "../client";
+import { ClientHeaders } from "../types";
+export declare class PaymentCollection {
+    /**
+     * @ignore
+     */
+    private client;
+    /**
+     * @ignore
+     */
+    constructor(client: Client);
+    /**
+     * This method creates a payment collection. It sends a request to the
+     * [Create Payment Collection](https://docs.acmekit.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.acmekit.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.acmekit.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/esm/admin/payment-collection.d.ts.map

@@ -0,0 +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,gBAAgB,CAAA;AACxD,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"}