@acmekit/js-sdk 2.13.1

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

@@ -0,0 +1,452 @@
+import { AdminOrderChangesResponse, CreateOrderCreditLineDTO, FindParams, HttpTypes, SelectParams } from "@acmekit/types";
+import { Client } from "../client";
+import { ClientHeaders } from "../types";
+export declare class Order {
+    /**
+     * @ignore
+     */
+    private client;
+    /**
+     * @ignore
+     */
+    constructor(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: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * 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: string, body: HttpTypes.AdminUpdateOrder, 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.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: string, query?: HttpTypes.AdminOrderFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderPreviewResponse>;
+    /**
+     * 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?: HttpTypes.AdminOrderFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderListResponse>;
+    /**
+     * 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: string, queryParams?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * 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: string, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * 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: string, body: HttpTypes.AdditionalData, queryParams?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * 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: string, body: HttpTypes.AdminRequestOrderTransfer, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * 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: string, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * 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: 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.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: 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.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: 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.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: string, fulfillmentId: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * 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: string, queryParams?: FindParams & HttpTypes.AdminGetOrderShippingOptionList, headers?: ClientHeaders): Promise<{
+        shipping_options: HttpTypes.AdminShippingOption[];
+    }>;
+    /**
+     * 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: string, queryParams?: FindParams & HttpTypes.AdminOrderChangesFilters, headers?: ClientHeaders): Promise<HttpTypes.PaginatedResponse<AdminOrderChangesResponse>>;
+    /**
+     * 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: string, queryParams?: FindParams & HttpTypes.AdminOrderItemsFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderLineItemsListResponse>;
+    /**
+     * 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: string, body: Omit<CreateOrderCreditLineDTO, "order_id">, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
+    /**
+     * 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: string, body: HttpTypes.AdminUpdateOrderChange, query?: HttpTypes.AdminOrderChangesFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderChangeResponse>;
+    /**
+     * 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?: HttpTypes.AdminOrderFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminExportOrderResponse>;
+}
+//# sourceMappingURL=order.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"order.d.ts","sourceRoot":"","sources":["../../../src/admin/order.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,wBAAwB,EACxB,UAAU,EACV,SAAS,EAET,YAAY,EACb,MAAM,gBAAgB,CAAA;AAEvB,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;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gBAAgB,EAChC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;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;IAWzB;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,WAAW,CAAC,EAAE,YAAY,EAC1B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,WAAW,CAAC,EAAE,YAAY,EAC1B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxD;;;;;;;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;OAgBG;IACG,mBAAmB,CACvB,EAAE,EAAE,MAAM,EACV,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,+BAA+B,EACpE,OAAO,CAAC,EAAE,aAAa;0BAGH,SAAS,CAAC,mBAAmB,EAAE;;IAOrD;;;;;;;;;;;;;;;;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;IAWzB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,gBAAgB,CACpB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,EAChD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,wBAAwB,EAC1C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,EAAE,aAAa;CAU1E"}