@acmekit/core-flows 2.13.1

package/dist/order/workflows/index.js

@@ -0,0 +1,111 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./add-line-items"), exports);
+__exportStar(require("./archive-orders"), exports);
+__exportStar(require("./cancel-order"), exports);
+__exportStar(require("./cancel-order-change"), exports);
+__exportStar(require("./cancel-order-fulfillment"), exports);
+__exportStar(require("./claim/begin-order-claim"), exports);
+__exportStar(require("./claim/cancel-begin-order-claim"), exports);
+__exportStar(require("./claim/cancel-claim"), exports);
+__exportStar(require("./claim/claim-add-new-item"), exports);
+__exportStar(require("./claim/claim-item"), exports);
+__exportStar(require("./claim/claim-request-item-return"), exports);
+__exportStar(require("./claim/confirm-claim-request"), exports);
+__exportStar(require("./claim/create-claim-shipping-method"), exports);
+__exportStar(require("./claim/remove-claim-add-item-action"), exports);
+__exportStar(require("./claim/remove-claim-item-action"), exports);
+__exportStar(require("./claim/remove-claim-shipping-method"), exports);
+__exportStar(require("./claim/update-claim-add-item"), exports);
+__exportStar(require("./claim/update-claim-item"), exports);
+__exportStar(require("./claim/update-claim-shipping-method"), exports);
+__exportStar(require("./complete-orders"), exports);
+__exportStar(require("./compute-adjustments-for-preview"), exports);
+__exportStar(require("./create-fulfillment"), exports);
+__exportStar(require("./create-or-update-order-payment-collection"), exports);
+__exportStar(require("./create-order"), exports);
+__exportStar(require("./create-order-change"), exports);
+__exportStar(require("./create-order-change-actions"), exports);
+__exportStar(require("./create-order-credit-lines"), exports);
+__exportStar(require("./create-order-payment-collection"), exports);
+__exportStar(require("./create-shipment"), exports);
+__exportStar(require("./decline-order-change"), exports);
+__exportStar(require("./delete-order-change"), exports);
+__exportStar(require("./delete-order-change-actions"), exports);
+__exportStar(require("./delete-order-payment-collection"), exports);
+__exportStar(require("./exchange/begin-order-exchange"), exports);
+__exportStar(require("./exchange/cancel-begin-order-exchange"), exports);
+__exportStar(require("./exchange/cancel-exchange"), exports);
+__exportStar(require("./exchange/confirm-exchange-request"), exports);
+__exportStar(require("./exchange/create-exchange-shipping-method"), exports);
+__exportStar(require("./exchange/exchange-add-new-item"), exports);
+__exportStar(require("./exchange/exchange-request-item-return"), exports);
+__exportStar(require("./exchange/remove-exchange-item-action"), exports);
+__exportStar(require("./exchange/remove-exchange-shipping-method"), exports);
+__exportStar(require("./exchange/update-exchange-add-item"), exports);
+__exportStar(require("./exchange/update-exchange-shipping-method"), exports);
+__exportStar(require("./export-orders"), exports);
+__exportStar(require("./fetch-shipping-option"), exports);
+__exportStar(require("./get-order-detail"), exports);
+__exportStar(require("./get-orders-list"), exports);
+__exportStar(require("./list-shipping-options-for-order"), exports);
+__exportStar(require("./mark-order-fulfillment-as-delivered"), exports);
+__exportStar(require("./mark-payment-collection-as-paid"), exports);
+__exportStar(require("./maybe-refresh-shipping-methods"), exports);
+__exportStar(require("./on-carry-promotions-flag-set"), exports);
+__exportStar(require("./order-edit/begin-order-edit"), exports);
+__exportStar(require("./order-edit/cancel-begin-order-edit"), exports);
+__exportStar(require("./order-edit/confirm-order-edit-request"), exports);
+__exportStar(require("./order-edit/create-order-edit-shipping-method"), exports);
+__exportStar(require("./order-edit/order-edit-add-new-item"), exports);
+__exportStar(require("./order-edit/order-edit-update-item-quantity"), exports);
+__exportStar(require("./order-edit/remove-order-edit-item-action"), exports);
+__exportStar(require("./order-edit/remove-order-edit-shipping-method"), exports);
+__exportStar(require("./order-edit/request-order-edit"), exports);
+__exportStar(require("./order-edit/update-order-edit-add-item"), exports);
+__exportStar(require("./order-edit/update-order-edit-item-quantity"), exports);
+__exportStar(require("./order-edit/update-order-edit-shipping-method"), exports);
+__exportStar(require("./return/begin-receive-return"), exports);
+__exportStar(require("./return/begin-return"), exports);
+__exportStar(require("./return/cancel-receive-return"), exports);
+__exportStar(require("./return/cancel-request-return"), exports);
+__exportStar(require("./return/cancel-return"), exports);
+__exportStar(require("./return/confirm-receive-return-request"), exports);
+__exportStar(require("./return/confirm-return-request"), exports);
+__exportStar(require("./return/create-complete-return"), exports);
+__exportStar(require("./return/create-return-shipping-method"), exports);
+__exportStar(require("./return/dismiss-item-return-request"), exports);
+__exportStar(require("./return/receive-complete-return"), exports);
+__exportStar(require("./return/receive-item-return-request"), exports);
+__exportStar(require("./return/remove-item-receive-return-action"), exports);
+__exportStar(require("./return/remove-item-return-action"), exports);
+__exportStar(require("./return/remove-return-shipping-method"), exports);
+__exportStar(require("./return/request-item-return"), exports);
+__exportStar(require("./return/update-receive-item-return-request"), exports);
+__exportStar(require("./return/update-request-item-return"), exports);
+__exportStar(require("./return/update-return"), exports);
+__exportStar(require("./return/update-return-shipping-method"), exports);
+__exportStar(require("./transfer/accept-order-transfer"), exports);
+__exportStar(require("./transfer/cancel-order-transfer"), exports);
+__exportStar(require("./transfer/decline-order-transfer"), exports);
+__exportStar(require("./transfer/request-order-transfer"), exports);
+__exportStar(require("./update-order"), exports);
+__exportStar(require("./update-order-change"), exports);
+__exportStar(require("./update-order-change-actions"), exports);
+__exportStar(require("./update-order-changes"), exports);
+__exportStar(require("./update-tax-lines"), exports);
+//# sourceMappingURL=index.js.map

package/dist/order/workflows/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/order/workflows/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAgC;AAChC,mDAAgC;AAChC,iDAA8B;AAC9B,wDAAqC;AACrC,6DAA0C;AAC1C,4DAAyC;AACzC,mEAAgD;AAChD,uDAAoC;AACpC,6DAA0C;AAC1C,qDAAkC;AAClC,oEAAiD;AACjD,gEAA6C;AAC7C,uEAAoD;AACpD,uEAAoD;AACpD,mEAAgD;AAChD,uEAAoD;AACpD,gEAA6C;AAC7C,4DAAyC;AACzC,uEAAoD;AACpD,oDAAiC;AACjC,oEAAiD;AACjD,uDAAoC;AACpC,8EAA2D;AAC3D,iDAA8B;AAC9B,wDAAqC;AACrC,gEAA6C;AAC7C,8DAA2C;AAC3C,oEAAiD;AACjD,oDAAiC;AACjC,yDAAsC;AACtC,wDAAqC;AACrC,gEAA6C;AAC7C,oEAAiD;AACjD,kEAA+C;AAC/C,yEAAsD;AACtD,6DAA0C;AAC1C,sEAAmD;AACnD,6EAA0D;AAC1D,mEAAgD;AAChD,0EAAuD;AACvD,yEAAsD;AACtD,6EAA0D;AAC1D,sEAAmD;AACnD,6EAA0D;AAC1D,kDAA+B;AAC/B,0DAAuC;AACvC,qDAAkC;AAClC,oDAAiC;AACjC,oEAAiD;AACjD,wEAAqD;AACrD,oEAAiD;AACjD,mEAAgD;AAChD,iEAA8C;AAC9C,gEAA6C;AAC7C,uEAAoD;AACpD,0EAAuD;AACvD,iFAA8D;AAC9D,uEAAoD;AACpD,+EAA4D;AAC5D,6EAA0D;AAC1D,iFAA8D;AAC9D,kEAA+C;AAC/C,0EAAuD;AACvD,+EAA4D;AAC5D,iFAA8D;AAC9D,gEAA6C;AAC7C,wDAAqC;AACrC,iEAA8C;AAC9C,iEAA8C;AAC9C,yDAAsC;AACtC,0EAAuD;AACvD,kEAA+C;AAC/C,kEAA+C;AAC/C,yEAAsD;AACtD,uEAAoD;AACpD,mEAAgD;AAChD,uEAAoD;AACpD,6EAA0D;AAC1D,qEAAkD;AAClD,yEAAsD;AACtD,+DAA4C;AAC5C,8EAA2D;AAC3D,sEAAmD;AACnD,yDAAsC;AACtC,yEAAsD;AACtD,mEAAgD;AAChD,mEAAgD;AAChD,oEAAiD;AACjD,oEAAiD;AACjD,iDAA8B;AAC9B,wDAAqC;AACrC,gEAA6C;AAC7C,yDAAsC;AACtC,qDAAkC"}

package/dist/order/workflows/list-shipping-options-for-order.d.ts

@@ -0,0 +1,26 @@
+import type { ListShippingOptionsForOrderWorkflowInput } from "@acmekit/framework/types";
+export declare const listShippingOptionsForOrderWorkflowId = "list-shipping-options-for-order";
+/**
+ * This workflow lists the shipping options of an order. It's executed by the
+ * [List Shipping Options Store API Route](https://docs.acmekit.com/api/store#orders_getidshippingoptions).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around to retrieve the shipping options of an order
+ * in your custom flows.
+ *
+ * @since 2.10.0
+ *
+ * @example
+ * const { result } = await listShippingOptionsForOrderWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * List a order's shipping options.
+ *
+ */
+export declare const listShippingOptionsForOrderWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<ListShippingOptionsForOrderWorkflowInput, any[], []>;
+//# sourceMappingURL=list-shipping-options-for-order.d.ts.map

package/dist/order/workflows/list-shipping-options-for-order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list-shipping-options-for-order.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/list-shipping-options-for-order.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,wCAAwC,EAAE,MAAM,0BAA0B,CAAA;AAIxF,eAAO,MAAM,qCAAqC,oCACf,CAAA;AACnC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,mCAAmC,gHAkK/C,CAAA"}

package/dist/order/workflows/list-shipping-options-for-order.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listShippingOptionsForOrderWorkflow = exports.listShippingOptionsForOrderWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+exports.listShippingOptionsForOrderWorkflowId = "list-shipping-options-for-order";
+/**
+ * This workflow lists the shipping options of an order. It's executed by the
+ * [List Shipping Options Store API Route](https://docs.acmekit.com/api/store#orders_getidshippingoptions).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around to retrieve the shipping options of an order
+ * in your custom flows.
+ *
+ * @since 2.10.0
+ *
+ * @example
+ * const { result } = await listShippingOptionsForOrderWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * List a order's shipping options.
+ *
+ */
+exports.listShippingOptionsForOrderWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.listShippingOptionsForOrderWorkflowId, (input) => {
+    const orderQuery = (0, common_1.useQueryGraphStep)({
+        entity: "order",
+        filters: { id: input.order_id },
+        fields: [
+            "id",
+            "sales_channel_id",
+            "region_id",
+            "shipping_address.city",
+            "shipping_address.country_code",
+            "shipping_address.province",
+            "shipping_address.postal_code",
+            "items.*",
+            "items.variant.manage_inventory",
+            "items.variant.inventory_items.inventory_item_id",
+            "items.variant.inventory_items.inventory.requires_shipping",
+            "items.variant.inventory_items.inventory.location_levels.*",
+        ],
+        options: { throwIfKeyNotFound: true },
+    }).config({ name: "get-order" });
+    const order = (0, workflows_sdk_1.transform)({ orderQuery }, ({ orderQuery }) => orderQuery.data[0]);
+    (0, common_1.validatePresenceOfStep)({
+        entity: order,
+        fields: ["sales_channel_id", "region_id"],
+    });
+    const scFulfillmentSetQuery = (0, common_1.useQueryGraphStep)({
+        entity: "sales_channels",
+        filters: { id: order.sales_channel_id },
+        fields: [
+            "id",
+            "stock_locations.fulfillment_sets.id",
+            "stock_locations.id",
+            "stock_locations.name",
+            "stock_locations.address.*",
+        ],
+        options: {
+            cache: {
+                enable: true,
+            },
+        },
+    }).config({ name: "sales_channels-fulfillment-query" });
+    const scFulfillmentSets = (0, workflows_sdk_1.transform)({ scFulfillmentSetQuery }, ({ scFulfillmentSetQuery }) => scFulfillmentSetQuery.data[0]);
+    const { fulfillmentSetIds } = (0, workflows_sdk_1.transform)({ scFulfillmentSets }, ({ scFulfillmentSets }) => {
+        const fulfillmentSetIds = new Set();
+        scFulfillmentSets.stock_locations.forEach((stockLocation) => {
+            stockLocation.fulfillment_sets.forEach((fulfillmentSet) => {
+                fulfillmentSetIds.add(fulfillmentSet.id);
+            });
+        });
+        return {
+            fulfillmentSetIds: Array.from(fulfillmentSetIds),
+        };
+    });
+    const queryVariables = (0, workflows_sdk_1.transform)({ fulfillmentSetIds, order }, ({ fulfillmentSetIds, order }) => {
+        return {
+            filters: {
+                fulfillment_set_id: fulfillmentSetIds,
+                address: {
+                    country_code: order.shipping_address?.country_code,
+                    province_code: order.shipping_address?.province,
+                    city: order.shipping_address?.city,
+                    postal_expression: order.shipping_address?.postal_code,
+                },
+            },
+        };
+    });
+    const { data: shippingOptions } = (0, common_1.useQueryGraphStep)({
+        entity: "shipping_option",
+        filters: queryVariables.filters,
+        fields: [
+            "id",
+            "name",
+            "price_type",
+            "service_zone_id",
+            "shipping_profile_id",
+            "provider_id",
+            "data",
+            "service_zone.fulfillment_set_id",
+            "service_zone.fulfillment_set.type",
+            "service_zone.fulfillment_set.location.id",
+            "service_zone.fulfillment_set.location.name",
+            "service_zone.fulfillment_set.location.address.*",
+            "type.id",
+            "type.label",
+            "type.description",
+            "type.code",
+            "provider.id",
+            "provider.is_enabled",
+            "rules.attribute",
+            "rules.value",
+            "rules.operator",
+        ],
+    }).config({ name: "shipping-options-query" });
+    const shippingOptionsWithInventory = (0, workflows_sdk_1.transform)({ shippingOptions, order }, ({ shippingOptions, order }) => shippingOptions.map((shippingOption) => {
+        const locationId = shippingOption.service_zone.fulfillment_set.location.id;
+        const itemsAtLocationWithoutAvailableQuantity = order.items.filter((item) => {
+            if (!item.variant?.manage_inventory) {
+                return false;
+            }
+            return item.variant.inventory_items.some((inventoryItem) => {
+                if (!inventoryItem.inventory.requires_shipping) {
+                    return false;
+                }
+                const level = inventoryItem.inventory.location_levels.find((locationLevel) => {
+                    return locationLevel.location_id === locationId;
+                });
+                return !level ? true : level.available_quantity < item.quantity;
+            });
+        });
+        return {
+            ...shippingOption,
+            insufficient_inventory: itemsAtLocationWithoutAvailableQuantity.length > 0,
+        };
+    }));
+    return new workflows_sdk_1.WorkflowResponse(shippingOptionsWithInventory);
+});
+//# sourceMappingURL=list-shipping-options-for-order.js.map

package/dist/order/workflows/list-shipping-options-for-order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list-shipping-options-for-order.js","sourceRoot":"","sources":["../../../src/order/workflows/list-shipping-options-for-order.ts"],"names":[],"mappings":";;;AAAA,oEAKyC;AAGzC,yCAAwE;AAE3D,QAAA,qCAAqC,GAChD,iCAAiC,CAAA;AACnC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACU,QAAA,mCAAmC,GAAG,IAAA,8BAAc,EAC/D,6CAAqC,EACrC,CAAC,KAA6D,EAAE,EAAE;IAChE,MAAM,UAAU,GAAG,IAAA,0BAAiB,EAAC;QACnC,MAAM,EAAE,OAAO;QACf,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE;QAC/B,MAAM,EAAE;YACN,IAAI;YAEJ,kBAAkB;YAClB,WAAW;YACX,uBAAuB;YACvB,+BAA+B;YAC/B,2BAA2B;YAC3B,8BAA8B;YAE9B,SAAS;YACT,gCAAgC;YAChC,iDAAiD;YACjD,2DAA2D;YAC3D,2DAA2D;SAC5D;QACD,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE;KACtC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;IAEhC,MAAM,KAAK,GAAG,IAAA,yBAAS,EACrB,EAAE,UAAU,EAAE,EACd,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CACvC,CAAA;IAED,IAAA,+BAAsB,EAAC;QACrB,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,CAAC,kBAAkB,EAAE,WAAW,CAAC;KAC1C,CAAC,CAAA;IAEF,MAAM,qBAAqB,GAAG,IAAA,0BAAiB,EAAC;QAC9C,MAAM,EAAE,gBAAgB;QACxB,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,gBAAgB,EAAE;QACvC,MAAM,EAAE;YACN,IAAI;YACJ,qCAAqC;YACrC,oBAAoB;YACpB,sBAAsB;YACtB,2BAA2B;SAC5B;QACD,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,IAAI;aACb;SACF;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,kCAAkC,EAAE,CAAC,CAAA;IAEvD,MAAM,iBAAiB,GAAG,IAAA,yBAAS,EACjC,EAAE,qBAAqB,EAAE,EACzB,CAAC,EAAE,qBAAqB,EAAE,EAAE,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAC7D,CAAA;IAED,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAA,yBAAS,EACrC,EAAE,iBAAiB,EAAE,EACrB,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE;QACxB,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAU,CAAA;QAE3C,iBAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YAC1D,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;gBACxD,iBAAiB,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;YAC1C,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,OAAO;YACL,iBAAiB,EAAE,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACjD,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,cAAc,GAAG,IAAA,yBAAS,EAC9B,EAAE,iBAAiB,EAAE,KAAK,EAAE,EAC5B,CAAC,EAAE,iBAAiB,EAAE,KAAK,EAAE,EAAE,EAAE;QAC/B,OAAO;YACL,OAAO,EAAE;gBACP,kBAAkB,EAAE,iBAAiB;gBAErC,OAAO,EAAE;oBACP,YAAY,EAAE,KAAK,CAAC,gBAAgB,EAAE,YAAY;oBAClD,aAAa,EAAE,KAAK,CAAC,gBAAgB,EAAE,QAAQ;oBAC/C,IAAI,EAAE,KAAK,CAAC,gBAAgB,EAAE,IAAI;oBAClC,iBAAiB,EAAE,KAAK,CAAC,gBAAgB,EAAE,WAAW;iBACvD;aACF;SACF,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,IAAA,0BAAiB,EAAC;QAClD,MAAM,EAAE,iBAAiB;QACzB,OAAO,EAAE,cAAc,CAAC,OAAO;QAC/B,MAAM,EAAE;YACN,IAAI;YACJ,MAAM;YACN,YAAY;YACZ,iBAAiB;YACjB,qBAAqB;YACrB,aAAa;YACb,MAAM;YACN,iCAAiC;YACjC,mCAAmC;YACnC,0CAA0C;YAC1C,4CAA4C;YAC5C,iDAAiD;YAEjD,SAAS;YACT,YAAY;YACZ,kBAAkB;YAClB,WAAW;YAEX,aAAa;YACb,qBAAqB;YAErB,iBAAiB;YACjB,aAAa;YACb,gBAAgB;SACjB;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC,CAAA;IAE7C,MAAM,4BAA4B,GAAG,IAAA,yBAAS,EAC5C,EAAE,eAAe,EAAE,KAAK,EAAE,EAC1B,CAAC,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,EAAE,CAC7B,eAAe,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;QACrC,MAAM,UAAU,GACd,cAAc,CAAC,YAAY,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAA;QAEzD,MAAM,uCAAuC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAChE,CAAC,IAAI,EAAE,EAAE;YACP,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,gBAAgB,EAAE,CAAC;gBACpC,OAAO,KAAK,CAAA;YACd,CAAC;YAED,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;gBACzD,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC;oBAC/C,OAAO,KAAK,CAAA;gBACd,CAAC;gBAED,MAAM,KAAK,GAAG,aAAa,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CACxD,CAAC,aAAa,EAAE,EAAE;oBAChB,OAAO,aAAa,CAAC,WAAW,KAAK,UAAU,CAAA;gBACjD,CAAC,CACF,CAAA;gBAED,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAAA;YACjE,CAAC,CAAC,CAAA;QACJ,CAAC,CACF,CAAA;QAED,OAAO;YACL,GAAG,cAAc;YACjB,sBAAsB,EACpB,uCAAuC,CAAC,MAAM,GAAG,CAAC;SACrD,CAAA;IACH,CAAC,CAAC,CACL,CAAA;IAED,OAAO,IAAI,gCAAgB,CAAC,4BAA4B,CAAC,CAAA;AAC3D,CAAC,CACF,CAAA"}

package/dist/order/workflows/mark-order-fulfillment-as-delivered.d.ts

@@ -0,0 +1,92 @@
+import { FulfillmentDTO, OrderDTO } from "@acmekit/framework/types";
+/**
+ * The data to validate the order fulfillment deliverability.
+ */
+export type OrderFulfillmentDeliverabilityValidationStepInput = {
+    /**
+     * The order to validate the fulfillment deliverability for.
+     */
+    order: OrderDTO & {
+        /**
+         * The fulfillments in the order.
+         */
+        fulfillments: FulfillmentDTO[];
+    };
+    /**
+     * The fulfillment to validate the deliverability for.
+     */
+    fulfillment: FulfillmentDTO;
+};
+export declare const orderFulfillmentDeliverablilityValidationStepId = "order-fulfillment-deliverability-validation";
+/**
+ * This step validates that the order fulfillment can be delivered. If the order is cancelled,
+ * the items to mark as delivered don't exist in the order, or the fulfillment doesn't exist in the order,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order and fulfillment's details using [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+ * or [useQueryGraphStep](https://docs.acmekit.com/resources/references/acmekit-workflows/steps/useQueryGraphStep).
+ *
+ * :::
+ *
+ * @example
+ * const data = orderFulfillmentDeliverablilityValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     fulfillments: [
+ *       {
+ *         id: "ful_123",
+ *         // other fulfillment details...
+ *       }
+ *     ]
+ *     // other order details...
+ *   },
+ *   fulfillment: {
+ *     id: "ful_123",
+ *     // other fulfillment details...
+ *   }
+ * })
+ */
+export declare const orderFulfillmentDeliverablilityValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<{
+    order: OrderDTO & {
+        fulfillments: FulfillmentDTO[];
+    };
+    fulfillment: FulfillmentDTO;
+}, unknown>;
+/**
+ * The details to mark a fulfillment in an order as delivered.
+ */
+export type MarkOrderFulfillmentAsDeliveredWorkflowInput = {
+    /**
+     * The ID of the order to mark the fulfillment as delivered in.
+     */
+    orderId: string;
+    /**
+     * The ID of the fulfillment to mark as delivered.
+     */
+    fulfillmentId: string;
+};
+export declare const markOrderFulfillmentAsDeliveredWorkflowId = "mark-order-fulfillment-as-delivered-workflow";
+/**
+ * This workflow marks a fulfillment in an order as delivered. It's used by the
+ * [Mark Fulfillment as Delivered Admin API Route](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idmarkasdelivered).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
+ * marking a fulfillment as delivered.
+ *
+ * @example
+ * const { result } = await markOrderFulfillmentAsDeliveredWorkflow(container)
+ * .run({
+ *   input: {
+ *     orderId: "order_123",
+ *     fulfillmentId: "ful_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Mark a fulfillment in an order as delivered.
+ */
+export declare const markOrderFulfillmentAsDeliveredWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<MarkOrderFulfillmentAsDeliveredWorkflowInput, undefined, []>;
+//# sourceMappingURL=mark-order-fulfillment-as-delivered.d.ts.map

package/dist/order/workflows/mark-order-fulfillment-as-delivered.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mark-order-fulfillment-as-delivered.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/mark-order-fulfillment-as-delivered.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EAEd,QAAQ,EAIT,MAAM,0BAA0B,CAAA;AAkCjC;;GAEG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG;QAChB;;WAEG;QACH,YAAY,EAAE,cAAc,EAAE,CAAA;KAC/B,CAAA;IACD;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,+CAA+C,gDACb,CAAA;AAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,6CAA6C;WAM/C,QAAQ,GAAG;QAAE,YAAY,EAAE,cAAc,EAAE,CAAA;KAAE;iBACvC,cAAc;WAuB9B,CAAA;AA4DD;;GAEG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,eAAO,MAAM,yCAAyC,iDACN,CAAA;AAChD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,uCAAuC,wHAiEnD,CAAA"}

package/dist/order/workflows/mark-order-fulfillment-as-delivered.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.markOrderFulfillmentAsDeliveredWorkflow = exports.markOrderFulfillmentAsDeliveredWorkflowId = exports.orderFulfillmentDeliverablilityValidationStep = exports.orderFulfillmentDeliverablilityValidationStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+const fulfillment_1 = require("../../fulfillment");
+const register_delivery_1 = require("../steps/register-delivery");
+const order_validation_1 = require("../utils/order-validation");
+const locking_1 = require("../../locking");
+exports.orderFulfillmentDeliverablilityValidationStepId = "order-fulfillment-deliverability-validation";
+/**
+ * This step validates that the order fulfillment can be delivered. If the order is cancelled,
+ * the items to mark as delivered don't exist in the order, or the fulfillment doesn't exist in the order,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order and fulfillment's details using [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+ * or [useQueryGraphStep](https://docs.acmekit.com/resources/references/acmekit-workflows/steps/useQueryGraphStep).
+ *
+ * :::
+ *
+ * @example
+ * const data = orderFulfillmentDeliverablilityValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     fulfillments: [
+ *       {
+ *         id: "ful_123",
+ *         // other fulfillment details...
+ *       }
+ *     ]
+ *     // other order details...
+ *   },
+ *   fulfillment: {
+ *     id: "ful_123",
+ *     // other fulfillment details...
+ *   }
+ * })
+ */
+exports.orderFulfillmentDeliverablilityValidationStep = (0, workflows_sdk_1.createStep)(exports.orderFulfillmentDeliverablilityValidationStepId, async ({ fulfillment, order, }) => {
+    (0, order_validation_1.throwIfOrderIsCancelled)({ order });
+    const orderFulfillment = order.fulfillments?.find((f) => f.id === fulfillment.id);
+    if (!orderFulfillment) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Fulfillment with id ${fulfillment.id} not found in the order`);
+    }
+    (0, order_validation_1.throwIfItemsDoesNotExistsInOrder)({
+        order,
+        inputItems: order.items.map((i) => ({
+            id: i.id,
+            quantity: i.quantity,
+        })),
+    });
+});
+function prepareRegisterDeliveryData({ fulfillment, order, }) {
+    const orderFulfillment = order.fulfillments.find((f) => f.id === fulfillment.id);
+    const lineItemIds = new Array(...new Set(orderFulfillment.items.map((i) => i.line_item_id)));
+    return {
+        order_id: order.id,
+        reference: utils_1.Modules.FULFILLMENT,
+        reference_id: orderFulfillment.id,
+        items: lineItemIds.map((lineItemId) => {
+            // find order item
+            const orderItem = order.items.find((i) => i.id === lineItemId);
+            // find inventory items
+            const iitems = orderItem.variant?.inventory_items;
+            // find fulfillment item
+            const fitem = orderFulfillment.items.find((i) => i.line_item_id === lineItemId);
+            let quantity = fitem.quantity;
+            // NOTE: if the order item has an inventory kit or `required_qunatity` > 1, fulfillment items wont't match 1:1 with order items.
+            // - for each inventory item in the kit, a fulfillment item will be created i.e. one line item could have multiple fulfillment items
+            // - the quantity of the fulfillment item will be the quantity of the order item multiplied by the required quantity of the inventory item
+            //
+            //   We need to take this into account when marking the fulfillment as delivered to compute quantity of line items being delivered based on fulfillment items and qunatities.
+            //   NOTE: for now we only need to find one inventory item of a line item to compute this since when a fulfillment is created all inventory items are fulfilled together.
+            //   If we allow to cancel partial fulfillments for an order item, we need to change this.
+            //
+            if (iitems?.length) {
+                const iitem = iitems.find((i) => i.inventory.id === fitem.inventory_item_id);
+                if (iitem)
+                    quantity = utils_1.MathBN.div(quantity, iitem.required_quantity);
+            }
+            return {
+                id: lineItemId,
+                quantity,
+            };
+        }),
+    };
+}
+exports.markOrderFulfillmentAsDeliveredWorkflowId = "mark-order-fulfillment-as-delivered-workflow";
+/**
+ * This workflow marks a fulfillment in an order as delivered. It's used by the
+ * [Mark Fulfillment as Delivered Admin API Route](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idmarkasdelivered).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
+ * marking a fulfillment as delivered.
+ *
+ * @example
+ * const { result } = await markOrderFulfillmentAsDeliveredWorkflow(container)
+ * .run({
+ *   input: {
+ *     orderId: "order_123",
+ *     fulfillmentId: "ful_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Mark a fulfillment in an order as delivered.
+ */
+exports.markOrderFulfillmentAsDeliveredWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.markOrderFulfillmentAsDeliveredWorkflowId, (input) => {
+    const { fulfillmentId, orderId } = input;
+    const { data: fulfillment } = (0, common_1.useQueryGraphStep)({
+        entity: "fulfillment",
+        filters: { id: fulfillmentId },
+        fields: ["id"],
+        options: { throwIfKeyNotFound: true, isList: false },
+    }).config({ name: "get-fulfillment" });
+    const { data: order } = (0, common_1.useQueryGraphStep)({
+        entity: "order",
+        filters: { id: orderId },
+        fields: [
+            "id",
+            "summary",
+            "total",
+            "currency_code",
+            "region_id",
+            "fulfillments.id",
+            "fulfillments.items.id",
+            "fulfillments.items.quantity",
+            "fulfillments.items.line_item_id",
+            "fulfillments.items.inventory_item_id",
+            "items.id",
+            "items.quantity",
+            "items.variant.manage_inventory",
+            "items.variant.inventory_items.inventory.id",
+            "items.variant.inventory_items.required_quantity",
+        ],
+        options: { throwIfKeyNotFound: true, isList: false },
+    }).config({ name: "order-query" });
+    (0, exports.orderFulfillmentDeliverablilityValidationStep)({ order, fulfillment });
+    const deliveryData = (0, workflows_sdk_1.transform)({ order, fulfillment }, prepareRegisterDeliveryData);
+    (0, locking_1.acquireLockStep)({
+        key: orderId,
+        timeout: 2,
+        ttl: 10,
+    });
+    const deliveredFulfillment = fulfillment_1.markFulfillmentAsDeliveredWorkflow.runAsStep({
+        input: { id: fulfillment.id },
+    });
+    (0, locking_1.releaseLockStep)({
+        key: orderId,
+    });
+    (0, register_delivery_1.registerOrderDeliveryStep)(deliveryData);
+    (0, common_1.emitEventStep)({
+        eventName: utils_1.FulfillmentWorkflowEvents.DELIVERY_CREATED,
+        data: { id: deliveredFulfillment.id },
+    });
+    return new workflows_sdk_1.WorkflowResponse(void 0);
+});
+//# sourceMappingURL=mark-order-fulfillment-as-delivered.js.map

package/dist/order/workflows/mark-order-fulfillment-as-delivered.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mark-order-fulfillment-as-delivered.js","sourceRoot":"","sources":["../../../src/order/workflows/mark-order-fulfillment-as-delivered.ts"],"names":[],"mappings":";;;AASA,oDAKiC;AACjC,oEAMyC;AACzC,yCAA+D;AAC/D,mDAAsE;AACtE,kEAAsE;AACtE,gEAGkC;AAClC,2CAAgE;AAgCnD,QAAA,+CAA+C,GAC1D,6CAA6C,CAAA;AAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACU,QAAA,6CAA6C,GAAG,IAAA,0BAAU,EACrE,uDAA+C,EAC/C,KAAK,EAAE,EACL,WAAW,EACX,KAAK,GAIN,EAAE,EAAE;IACH,IAAA,0CAAuB,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IAElC,MAAM,gBAAgB,GAAG,KAAK,CAAC,YAAY,EAAE,IAAI,CAC/C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,WAAW,CAAC,EAAE,CAC/B,CAAA;IAED,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,uBAAuB,WAAW,CAAC,EAAE,yBAAyB,CAC/D,CAAA;IACH,CAAC;IAED,IAAA,mDAAgC,EAAC;QAC/B,KAAK;QACL,UAAU,EAAE,KAAK,CAAC,KAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnC,EAAE,EAAE,CAAC,CAAC,EAAE;YACR,QAAQ,EAAE,CAAC,CAAC,QAAQ;SACrB,CAAC,CAAC;KACJ,CAAC,CAAA;AACJ,CAAC,CACF,CAAA;AAED,SAAS,2BAA2B,CAAC,EACnC,WAAW,EACX,KAAK,GAIN;IACC,MAAM,gBAAgB,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAC9C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,WAAW,CAAC,EAAE,CAC9B,CAAA;IAEF,MAAM,WAAW,GAAG,IAAI,KAAK,CAC3B,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAC9D,CAAA;IAED,OAAO;QACL,QAAQ,EAAE,KAAK,CAAC,EAAE;QAClB,SAAS,EAAE,eAAO,CAAC,WAAW;QAC9B,YAAY,EAAE,gBAAgB,CAAC,EAAE;QACjC,KAAK,EAAE,WAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;YACrC,kBAAkB;YAClB,MAAM,SAAS,GAAG,KAAK,CAAC,KAAM,CAAC,IAAI,CACjC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,UAAU,CACA,CAAA;YAC5B,uBAAuB;YACvB,MAAM,MAAM,GAAG,SAAU,CAAC,OAAO,EAAE,eAAe,CAAA;YAClD,wBAAwB;YACxB,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,UAAU,CACpC,CAAA;YAEF,IAAI,QAAQ,GAAmB,KAAK,CAAC,QAAQ,CAAA;YAE7C,gIAAgI;YAChI,oIAAoI;YACpI,0IAA0I;YAC1I,EAAE;YACF,6KAA6K;YAC7K,yKAAyK;YACzK,0FAA0F;YAC1F,EAAE;YAEF,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;gBACnB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CACvB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,KAAK,KAAK,CAAC,iBAAiB,CAClD,CAAA;gBACD,IAAG,KAAK;oBACN,QAAQ,GAAG,cAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;YAC5D,CAAC;YAED,OAAO;gBACL,EAAE,EAAE,UAAoB;gBACxB,QAAQ;aACT,CAAA;QACH,CAAC,CAAC;KACH,CAAA;AACH,CAAC;AAgBY,QAAA,yCAAyC,GACpD,8CAA8C,CAAA;AAChD;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,uCAAuC,GAAG,IAAA,8BAAc,EACnE,iDAAyC,EACzC,CAAC,KAAiE,EAAE,EAAE;IACpE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;IAExC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAA,0BAAiB,EAAC;QAC9C,MAAM,EAAE,aAAa;QACrB,OAAO,EAAE,EAAE,EAAE,EAAE,aAAa,EAAE;QAC9B,MAAM,EAAE,CAAC,IAAI,CAAC;QACd,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;KACrD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAA;IAEtC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAA,0BAAiB,EAAC;QACxC,MAAM,EAAE,OAAO;QACf,OAAO,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE;QACxB,MAAM,EAAE;YACN,IAAI;YACJ,SAAS;YACT,OAAO;YACP,eAAe;YACf,WAAW;YACX,iBAAiB;YACjB,uBAAuB;YACvB,6BAA6B;YAC7B,iCAAiC;YACjC,sCAAsC;YACtC,UAAU;YACV,gBAAgB;YAChB,gCAAgC;YAChC,4CAA4C;YAC5C,iDAAiD;SAClD;QACD,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;KACrD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;IAElC,IAAA,qDAA6C,EAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAA;IAErE,MAAM,YAAY,GAAG,IAAA,yBAAS,EAC5B,EAAE,KAAK,EAAE,WAAW,EAAE,EACtB,2BAA2B,CAC5B,CAAA;IAED,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,OAAO;QACZ,OAAO,EAAE,CAAC;QACV,GAAG,EAAE,EAAE;KACR,CAAC,CAAA;IAEF,MAAM,oBAAoB,GAAG,gDAAkC,CAAC,SAAS,CAAC;QACxE,KAAK,EAAE,EAAE,EAAE,EAAE,WAAW,CAAC,EAAE,EAAE;KAC9B,CAAC,CAAA;IAEF,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,OAAO;KACb,CAAC,CAAA;IAEF,IAAA,6CAAyB,EAAC,YAAY,CAAC,CAAA;IAEvC,IAAA,sBAAa,EAAC;QACZ,SAAS,EAAE,iCAAyB,CAAC,gBAAgB;QACrD,IAAI,EAAE,EAAE,EAAE,EAAE,oBAAoB,CAAC,EAAE,EAAE;KACtC,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;AACrC,CAAC,CACF,CAAA"}

package/dist/order/workflows/mark-payment-collection-as-paid.d.ts

@@ -0,0 +1,70 @@
+import type { PaymentCollectionDTO } from "@acmekit/framework/types";
+/**
+ * The details of the payment collection to validate.
+ */
+export type ThrowUnlessPaymentCollectionNotePaidInput = {
+    /**
+     * The payment collection to validate.
+     */
+    paymentCollection: PaymentCollectionDTO;
+};
+/**
+ * This step validates that the payment collection is not paid. If not valid,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve a payment collection's details using [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+ * or [useQueryGraphStep](https://docs.acmekit.com/resources/references/acmekit-workflows/steps/useQueryGraphStep).
+ *
+ * :::
+ *
+ * @example
+ * const data = throwUnlessPaymentCollectionNotPaid({
+ *   paymentCollection: {
+ *     id: "paycol_123",
+ *     // other payment details...
+ *   }
+ * })
+ */
+export declare const throwUnlessPaymentCollectionNotPaid: import("@acmekit/framework/workflows-sdk").StepFunction<ThrowUnlessPaymentCollectionNotePaidInput, unknown>;
+/**
+ * The data to mark a payment collection as paid.
+ */
+export type MarkPaymentCollectionAsPaidInput = {
+    /**
+     * The ID of the payment collection to mark as paid.
+     */
+    payment_collection_id: string;
+    /**
+     * The ID of the order that the payment collection belongs to.
+     */
+    order_id: string;
+    /**
+     * The ID of the user marking the payment collection as completed.
+     */
+    captured_by?: string;
+};
+export declare const markPaymentCollectionAsPaidId = "mark-payment-collection-as-paid";
+/**
+ * This workflow marks a payment collection for an order as paid. It's used by the
+ * [Mark Payment Collection as Paid Admin API Route](https://docs.acmekit.com/api/admin#payment-collections_postpaymentcollectionsidmarkaspaid).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
+ * marking a payment collection for an order as paid.
+ *
+ * @example
+ * const { result } = await markPaymentCollectionAsPaid(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     payment_collection_id: "paycol_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Mark a payment collection for an order as paid.
+ */
+export declare const markPaymentCollectionAsPaid: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<MarkPaymentCollectionAsPaidInput, import("@acmekit/framework/types").PaymentDTO | null, []>;
+//# sourceMappingURL=mark-payment-collection-as-paid.d.ts.map

package/dist/order/workflows/mark-payment-collection-as-paid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mark-payment-collection-as-paid.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/mark-payment-collection-as-paid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAepE;;GAEG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD;;OAEG;IACH,iBAAiB,EAAE,oBAAoB,CAAA;CACxC,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,mCAAmC,6GAU/C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAA;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAGD,eAAO,MAAM,6BAA6B,oCAAoC,CAAA;AAC9E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,2BAA2B,uJAmCvC,CAAA"}