@etohq/core-flows 1.4.0 → 1.5.1-alpha.0

package/dist/payment-collection/workflows/cancel-payment-collection.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancelPaymentCollectionWorkflow = exports.cancelPaymentCollectionWorkflowId = void 0;
+const utils_1 = require("@etohq/framework/utils");
+const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
+const common_1 = require("../../common");
+const update_payment_collection_1 = require("../steps/update-payment-collection");
+const cancel_payment_1 = require("../steps/cancel-payment");
+const validatePaymentCollectionCancellationStep = (0, workflows_sdk_1.createStep)("validate-payment-collection-cancellation", async (input) => {
+    const { paymentCollection } = input;
+    if (paymentCollection.status === utils_1.PaymentCollectionStatus.COMPLETED) {
+        throw new utils_1.EtoError(utils_1.EtoError.Types.NOT_ALLOWED, "Cannot cancel a completed payment collection");
+    }
+    if (paymentCollection.status == utils_1.PaymentCollectionStatus.CANCELED) {
+        throw new utils_1.EtoError(utils_1.EtoError.Types.NOT_ALLOWED, "Payment collection is already canceled");
+    }
+});
+exports.cancelPaymentCollectionWorkflowId = "cancel-payment-collection";
+/**
+ * This workflow cancels a payment collection that is either not paid or authorized.
+ *
+ * Payment colelction that is completed or already canceled cannot be canceled.
+ *
+ * @example
+ * const data = cancelPaymentCollectionStep({
+ *   payment_collection_id: "paycol_123",
+ * })
+ */
+exports.cancelPaymentCollectionWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.cancelPaymentCollectionWorkflowId, (input) => {
+    const paymentCollectionQuery = (0, common_1.useQueryGraphStep)({
+        entity: "payment_collection",
+        fields: [
+            "id",
+            "status",
+            "payments.id",
+            "payments.captured_at",
+            "captured_amount",
+        ],
+        filters: { id: input.payment_collection_id },
+    }).config({ name: "get-payment-collection" });
+    const paymentCollection = (0, workflows_sdk_1.transform)({ paymentCollectionQuery }, ({ paymentCollectionQuery }) => paymentCollectionQuery.data[0]);
+    validatePaymentCollectionCancellationStep({
+        paymentCollection,
+    });
+    /**
+     * Only cancel authorized payments, not captured payments.
+     */
+    const authorizedPaymentIds = (0, workflows_sdk_1.transform)({ paymentCollection }, ({ paymentCollection }) => paymentCollection.payments
+        ?.filter((p) => !p.captured_at)
+        .map((p) => p.id) ?? []);
+    const status = (0, workflows_sdk_1.transform)({ paymentCollection }, ({ paymentCollection }) => paymentCollection.captured_amount > 0
+        ? utils_1.PaymentCollectionStatus.PARTIALLY_CAPTURED
+        : utils_1.PaymentCollectionStatus.CANCELED);
+    const updatedPaymentCollections = (0, update_payment_collection_1.updatePaymentCollectionStep)({
+        selector: { id: paymentCollection.id },
+        update: {
+            status: status,
+        },
+    });
+    (0, cancel_payment_1.cancelPaymentStep)({
+        ids: authorizedPaymentIds,
+    });
+    const resultPaymentCollection = (0, workflows_sdk_1.transform)({ updatedPaymentCollections }, ({ updatedPaymentCollections }) => updatedPaymentCollections[0]);
+    return new workflows_sdk_1.WorkflowResponse(resultPaymentCollection);
+});
+//# sourceMappingURL=cancel-payment-collection.js.map

package/dist/payment-collection/workflows/cancel-payment-collection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-payment-collection.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/cancel-payment-collection.ts"],"names":[],"mappings":";;;AACA,kDAA0E;AAC1E,kEAMuC;AACvC,yCAAgD;AAChD,kFAAgF;AAChF,4DAA2D;AAE3D,MAAM,yCAAyC,GAAG,IAAA,0BAAU,EAC1D,0CAA0C,EAC1C,KAAK,EAAE,KAAkD,EAAE,EAAE;IAC3D,MAAM,EAAE,iBAAiB,EAAE,GAAG,KAAK,CAAA;IAEnC,IAAI,iBAAiB,CAAC,MAAM,KAAK,+BAAuB,CAAC,SAAS,EAAE,CAAC;QACnE,MAAM,IAAI,gBAAQ,CAChB,gBAAQ,CAAC,KAAK,CAAC,WAAW,EAC1B,8CAA8C,CAC/C,CAAA;IACH,CAAC;IAED,IAAI,iBAAiB,CAAC,MAAM,IAAI,+BAAuB,CAAC,QAAQ,EAAE,CAAC;QACjE,MAAM,IAAI,gBAAQ,CAChB,gBAAQ,CAAC,KAAK,CAAC,WAAW,EAC1B,wCAAwC,CACzC,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA;AAYY,QAAA,iCAAiC,GAAG,2BAA2B,CAAA;AAC5E;;;;;;;;;GASG;AACU,QAAA,+BAA+B,GAAG,IAAA,8BAAc,EAC3D,yCAAiC,EACjC,CACE,KAAyD,EACjB,EAAE;IAC1C,MAAM,sBAAsB,GAAG,IAAA,0BAAiB,EAAC;QAC/C,MAAM,EAAE,oBAAoB;QAC5B,MAAM,EAAE;YACN,IAAI;YACJ,QAAQ;YACR,aAAa;YACb,sBAAsB;YACtB,iBAAiB;SAClB;QACD,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,qBAAqB,EAAE;KAC7C,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC,CAAA;IAE7C,MAAM,iBAAiB,GAAG,IAAA,yBAAS,EACjC,EAAE,sBAAsB,EAAE,EAC1B,CAAC,EAAE,sBAAsB,EAAE,EAAE,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,CAC/D,CAAA;IAED,yCAAyC,CAAC;QACxC,iBAAiB;KAClB,CAAC,CAAA;IAEF;;OAEG;IACH,MAAM,oBAAoB,GAAG,IAAA,yBAAS,EACpC,EAAE,iBAAiB,EAAE,EACrB,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE,CACxB,iBAAiB,CAAC,QAAQ;QACxB,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;SAC9B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAC5B,CAAA;IAED,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,EAAE,iBAAiB,EAAE,EAAE,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE,CACxE,iBAAiB,CAAC,eAAe,GAAG,CAAC;QACnC,CAAC,CAAC,+BAAuB,CAAC,kBAAkB;QAC5C,CAAC,CAAC,+BAAuB,CAAC,QAAQ,CACrC,CAAA;IAED,MAAM,yBAAyB,GAAG,IAAA,uDAA2B,EAAC;QAC5D,QAAQ,EAAE,EAAE,EAAE,EAAE,iBAAiB,CAAC,EAAE,EAAE;QACtC,MAAM,EAAE;YACN,MAAM,EAAE,MAAM;SACf;KACF,CAAC,CAAA;IAEF,IAAA,kCAAiB,EAAC;QAChB,GAAG,EAAE,oBAAoB;KAC1B,CAAC,CAAA;IAEF,MAAM,uBAAuB,GAAG,IAAA,yBAAS,EACvC,EAAE,yBAAyB,EAAE,EAC7B,CAAC,EAAE,yBAAyB,EAAE,EAAE,EAAE,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAChE,CAAA;IAED,OAAO,IAAI,gCAAgB,CAAC,uBAAuB,CAAC,CAAA;AACtD,CAAC,CACF,CAAA"}

package/dist/payment-collection/workflows/create-payment-session.d.ts

@@ -1,13 +1,52 @@
-import { PaymentProviderContext, PaymentSessionDTO } from "@etohq/types";
+import { PaymentSessionDTO } from "@etohq/framework/types";
+/**
+ * The data to create payment sessions.
+ */
 export interface CreatePaymentSessionsWorkflowInput {
+    /**
+     * The ID of the payment collection to create payment sessions for.
+     */
     payment_collection_id: string;
+    /**
+     * The ID of the payment provider that the payment sessions are associated with.
+     * This provider is used to later process the payment sessions and their payments.
+     */
     provider_id: string;
+    /**
+     * The ID of the customer that the payment session should be associated with.
+     */
+    customer_id?: string;
+    /**
+     * Custom data relevant for the payment provider to process the payment session.
+     * Learn more in [this documentation](https://docs.etohq.com/resources/commerce-modules/payment/payment-session#data-property).
+     */
     data?: Record<string, unknown>;
-    context?: PaymentProviderContext;
+    /**
+     * Additional context that's useful for the payment provider to process the payment session.
+     * Currently all of the context is calculated within the workflow.
+     */
+    context?: Record<string, unknown>;
 }
 export declare const createPaymentSessionsWorkflowId = "create-payment-sessions";
 /**
- * This workflow creates payment sessions.
+ * This workflow creates payment sessions. It's used by the
+ * [Initialize Payment Session Store API Route](https://docs.etohq.com/api/store#payment-collections_postpaymentcollectionsidpaymentsessions).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to create payment sessions in your custom flows.
+ *
+ * @example
+ * const { result } = await createPaymentSessionsWorkflow(container)
+ * .run({
+ *   input: {
+ *     payment_collection_id: "paycol_123",
+ *     provider_id: "pp_system"
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create payment sessions.
  */
 export declare const createPaymentSessionsWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<CreatePaymentSessionsWorkflowInput, PaymentSessionDTO, []>;
 //# sourceMappingURL=create-payment-session.d.ts.map

package/dist/payment-collection/workflows/create-payment-session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-payment-session.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/create-payment-session.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,cAAc,CAAA;AAYrB,MAAM,WAAW,kCAAkC;IACjD,qBAAqB,EAAE,MAAM,CAAA;IAC7B,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,OAAO,CAAC,EAAE,sBAAsB,CAAA;CACjC;AAED,eAAO,MAAM,+BAA+B,4BAA4B,CAAA;AACxE;;GAEG;AACH,eAAO,MAAM,6BAA6B,oHAiDzC,CAAA"}
+{"version":3,"file":"create-payment-session.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/create-payment-session.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,iBAAiB,EAClB,MAAM,wBAAwB,CAAA;AAiB/B;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAA;IAC7B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE9B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC;AAED,eAAO,MAAM,+BAA+B,4BAA4B,CAAA;AACxE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,6BAA6B,oHAmIzC,CAAA"}

package/dist/payment-collection/workflows/create-payment-session.js

@@ -1,13 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createPaymentSessionsWorkflow = exports.createPaymentSessionsWorkflowId = void 0;
+const utils_1 = require("@etohq/framework/utils");
 const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const common_1 = require("../../common");
 const steps_1 = require("../steps");
 const delete_payment_sessions_1 = require("./delete-payment-sessions");
 exports.createPaymentSessionsWorkflowId = "create-payment-sessions";
 /**
- * This workflow creates payment sessions.
+ * This workflow creates payment sessions. It's used by the
+ * [Initialize Payment Session Store API Route](https://docs.etohq.com/api/store#payment-collections_postpaymentcollectionsidpaymentsessions).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to create payment sessions in your custom flows.
+ *
+ * @example
+ * const { result } = await createPaymentSessionsWorkflow(container)
+ * .run({
+ *   input: {
+ *     payment_collection_id: "paycol_123",
+ *     provider_id: "pp_system"
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create payment sessions.
  */
 exports.createPaymentSessionsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createPaymentSessionsWorkflowId, (input) => {
     const paymentCollection = (0, common_1.useRemoteQueryStep)({
@@ -15,13 +33,73 @@ exports.createPaymentSessionsWorkflow = (0, workflows_sdk_1.createWorkflow)(expo
         fields: ["id", "amount", "currency_code", "payment_sessions.*"],
         variables: { id: input.payment_collection_id },
         list: false,
+    }).config({ name: "get-payment-collection" });
+    const { paymentCustomer, accountHolder, existingAccountHolder } = (0, workflows_sdk_1.when)("customer-id-exists", { input }, (data) => {
+        return !!data.input.customer_id;
+    }).then(() => {
+        const customer = (0, common_1.useRemoteQueryStep)({
+            entry_point: "customer",
+            fields: [
+                "id",
+                "email",
+                "company_name",
+                "first_name",
+                "last_name",
+                "phone",
+                "addresses.*",
+                "account_holders.*",
+                "metadata",
+            ],
+            variables: { id: input.customer_id },
+            list: false,
+        }).config({ name: "get-customer" });
+        const paymentCustomer = (0, workflows_sdk_1.transform)({ customer }, (data) => {
+            return {
+                ...data.customer,
+                billing_address: data.customer.addresses?.find((a) => a.is_default_billing) ??
+                    data.customer.addresses?.[0],
+            };
+        });
+        const existingAccountHolder = (0, workflows_sdk_1.transform)({ customer, input }, (data) => {
+            return data.customer.account_holders.find((ac) => ac.provider_id === data.input.provider_id);
+        });
+        const accountHolderInput = (0, workflows_sdk_1.transform)({ existingAccountHolder, input, paymentCustomer }, (data) => {
+            return {
+                provider_id: data.input.provider_id,
+                context: {
+                    // The module is idempotent, so if there already is a linked account holder, the module will simply return it back.
+                    account_holder: data.existingAccountHolder,
+                    customer: data.paymentCustomer,
+                },
+            };
+        });
+        const accountHolder = (0, steps_1.createPaymentAccountHolderStep)(accountHolderInput);
+        return { paymentCustomer, accountHolder, existingAccountHolder };
     });
-    const paymentSessionInput = (0, workflows_sdk_1.transform)({ paymentCollection, input }, (data) => {
+    (0, workflows_sdk_1.when)("account-holder-created", { paymentCustomer, accountHolder, input, existingAccountHolder }, ({ existingAccountHolder, accountHolder }) => {
+        return !(0, utils_1.isPresent)(existingAccountHolder) && (0, utils_1.isPresent)(accountHolder);
+    }).then(() => {
+        (0, common_1.createRemoteLinkStep)([
+            {
+                [utils_1.Modules.CUSTOMER]: {
+                    customer_id: paymentCustomer.id,
+                },
+                [utils_1.Modules.PAYMENT]: {
+                    account_holder_id: accountHolder.id,
+                },
+            },
+        ]);
+    });
+    const paymentSessionInput = (0, workflows_sdk_1.transform)({ paymentCollection, paymentCustomer, accountHolder, input }, (data) => {
         return {
             payment_collection_id: data.input.payment_collection_id,
             provider_id: data.input.provider_id,
             data: data.input.data,
-            context: data.input.context,
+            context: {
+                ...data.input.context,
+                customer: data.paymentCustomer,
+                account_holder: data.accountHolder,
+            },
             amount: data.paymentCollection.amount,
             currency_code: data.paymentCollection.currency_code,
         };

package/dist/payment-collection/workflows/create-payment-session.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-payment-session.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/create-payment-session.ts"],"names":[],"mappings":";;;AAIA,kEAMuC;AACvC,yCAAiD;AACjD,oCAAmD;AACnD,uEAAyE;AAS5D,QAAA,+BAA+B,GAAG,yBAAyB,CAAA;AACxE;;GAEG;AACU,QAAA,6BAA6B,GAAG,IAAA,8BAAc,EACzD,uCAA+B,EAC/B,CACE,KAAuD,EAClB,EAAE;IACvC,MAAM,iBAAiB,GAAG,IAAA,2BAAkB,EAAC;QAC3C,WAAW,EAAE,oBAAoB;QACjC,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,oBAAoB,CAAC;QAC/D,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,qBAAqB,EAAE;QAC9C,IAAI,EAAE,KAAK;KACZ,CAAC,CAAA;IAEF,MAAM,mBAAmB,GAAG,IAAA,yBAAS,EACnC,EAAE,iBAAiB,EAAE,KAAK,EAAE,EAC5B,CAAC,IAAI,EAAE,EAAE;QACP,OAAO;YACL,qBAAqB,EAAE,IAAI,CAAC,KAAK,CAAC,qBAAqB;YACvD,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW;YACnC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;YACrB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;YAC3B,MAAM,EAAE,IAAI,CAAC,iBAAiB,CAAC,MAAM;YACrC,aAAa,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa;SACpD,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,yBAAyB,GAAG,IAAA,yBAAS,EACzC,EAAE,iBAAiB,EAAE,EACrB,CAAC,IAAI,EAAE,EAAE;QACP,OAAO;YACL,GAAG,EACD,IAAI,CAAC,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE;SACrE,CAAA;IACH,CAAC,CACF,CAAA;IAED,6EAA6E;IAC7E,6EAA6E;IAC7E,8EAA8E;IAC9E,+BAA+B;IAC/B,MAAM,CAAC,OAAO,CAAC,GAAG,IAAA,2BAAW,EAC3B,IAAA,gCAAwB,EAAC,mBAAmB,CAAC,EAC7C,uDAA6B,CAAC,SAAS,CAAC;QACtC,KAAK,EAAE,yBAAyB;KACjC,CAAC,CACH,CAAA;IAED,OAAO,IAAI,gCAAgB,CAAC,OAAO,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}
+{"version":3,"file":"create-payment-session.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/create-payment-session.ts"],"names":[],"mappings":";;;AAKA,kDAA2D;AAC3D,kEAOuC;AACvC,yCAAuE;AACvE,oCAGiB;AACjB,uEAAyE;AAgC5D,QAAA,+BAA+B,GAAG,yBAAyB,CAAA;AACxE;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,6BAA6B,GAAG,IAAA,8BAAc,EACzD,uCAA+B,EAC/B,CACE,KAAuD,EAClB,EAAE;IACvC,MAAM,iBAAiB,GAAG,IAAA,2BAAkB,EAAC;QAC3C,WAAW,EAAE,oBAAoB;QACjC,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,oBAAoB,CAAC;QAC/D,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,qBAAqB,EAAE;QAC9C,IAAI,EAAE,KAAK;KACZ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC,CAAA;IAE7C,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,qBAAqB,EAAE,GAAG,IAAA,oBAAI,EACpE,oBAAoB,EACpB,EAAE,KAAK,EAAE,EACT,CAAC,IAAI,EAAE,EAAE;QACP,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAA;IACjC,CAAC,CACF,CAAC,IAAI,CAAC,GAAG,EAAE;QACV,MAAM,QAAQ,GACZ,IAAA,2BAAkB,EAAC;YACjB,WAAW,EAAE,UAAU;YACvB,MAAM,EAAE;gBACN,IAAI;gBACJ,OAAO;gBACP,cAAc;gBACd,YAAY;gBACZ,WAAW;gBACX,OAAO;gBACP,aAAa;gBACb,mBAAmB;gBACnB,UAAU;aACX;YACD,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE;YACpC,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAA;QAErC,MAAM,eAAe,GAAG,IAAA,yBAAS,EAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;YACvD,OAAO;gBACL,GAAG,IAAI,CAAC,QAAQ;gBAChB,eAAe,EACb,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC;oBAC1D,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;aAC/B,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,MAAM,qBAAqB,GAAG,IAAA,yBAAS,EAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;YACpE,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CACvC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,KAAK,IAAI,CAAC,KAAK,CAAC,WAAW,CAClD,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,MAAM,kBAAkB,GAAG,IAAA,yBAAS,EAClC,EAAE,qBAAqB,EAAE,KAAK,EAAE,eAAe,EAAE,EACjD,CAAC,IAAI,EAAE,EAAE;YACP,OAAO;gBACL,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW;gBACnC,OAAO,EAAE;oBACP,mHAAmH;oBACnH,cAAc,EAAE,IAAI,CAAC,qBAAqB;oBAC1C,QAAQ,EAAE,IAAI,CAAC,eAAe;iBAC/B;aACF,CAAA;QACH,CAAC,CACF,CAAA;QAED,MAAM,aAAa,GAAG,IAAA,sCAA8B,EAAC,kBAAkB,CAAC,CAAA;QAExE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,qBAAqB,EAAE,CAAA;IAClE,CAAC,CAAC,CAAA;IAEF,IAAA,oBAAI,EACF,wBAAwB,EACxB,EAAE,eAAe,EAAE,aAAa,EAAE,KAAK,EAAE,qBAAqB,EAAE,EAChE,CAAC,EAAE,qBAAqB,EAAE,aAAa,EAAE,EAAE,EAAE;QAC3C,OAAO,CAAC,IAAA,iBAAS,EAAC,qBAAqB,CAAC,IAAI,IAAA,iBAAS,EAAC,aAAa,CAAC,CAAA;IACtE,CAAC,CACF,CAAC,IAAI,CAAC,GAAG,EAAE;QACV,IAAA,6BAAoB,EAAC;YACnB;gBACE,CAAC,eAAO,CAAC,QAAQ,CAAC,EAAE;oBAClB,WAAW,EAAE,eAAe,CAAC,EAAE;iBAChC;gBACD,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE;oBACjB,iBAAiB,EAAE,aAAa,CAAC,EAAE;iBACpC;aACF;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,MAAM,mBAAmB,GAAG,IAAA,yBAAS,EACnC,EAAE,iBAAiB,EAAE,eAAe,EAAE,aAAa,EAAE,KAAK,EAAE,EAC5D,CAAC,IAAI,EAAE,EAAE;QACP,OAAO;YACL,qBAAqB,EAAE,IAAI,CAAC,KAAK,CAAC,qBAAqB;YACvD,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW;YACnC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;YACrB,OAAO,EAAE;gBACP,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO;gBACrB,QAAQ,EAAE,IAAI,CAAC,eAAe;gBAC9B,cAAc,EAAE,IAAI,CAAC,aAAa;aACnC;YACD,MAAM,EAAE,IAAI,CAAC,iBAAiB,CAAC,MAAM;YACrC,aAAa,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa;SACpD,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,yBAAyB,GAAG,IAAA,yBAAS,EACzC,EAAE,iBAAiB,EAAE,EACrB,CAAC,IAAI,EAAE,EAAE;QACP,OAAO;YACL,GAAG,EACD,IAAI,CAAC,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE;SACrE,CAAA;IACH,CAAC,CACF,CAAA;IAED,6EAA6E;IAC7E,6EAA6E;IAC7E,8EAA8E;IAC9E,+BAA+B;IAC/B,MAAM,CAAC,OAAO,CAAC,GAAG,IAAA,2BAAW,EAC3B,IAAA,gCAAwB,EAAC,mBAAmB,CAAC,EAC7C,uDAA6B,CAAC,SAAS,CAAC;QACtC,KAAK,EAAE,yBAAyB;KACjC,CAAC,CACH,CAAA;IAED,OAAO,IAAI,gCAAgB,CAAC,OAAO,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}

package/dist/payment-collection/workflows/create-refund-reasons.d.ts

@@ -1,9 +1,36 @@
-import { CreateRefundReasonDTO, RefundReasonDTO } from "@etohq/types";
-export declare const createRefundReasonsWorkflowId = "create-refund-reasons-workflow";
+import { CreateRefundReasonDTO, RefundReasonDTO } from "@etohq/framework/types";
 /**
- * This workflow creates one or more refund reasons.
+ * The data to create refund reasons.
  */
-export declare const createRefundReasonsWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<{
+export type CreateRefundReasonsWorkflowInput = {
+    /**
+     * The refund reasons to create.
+     */
     data: CreateRefundReasonDTO[];
-}, RefundReasonDTO[], []>;
+};
+export declare const createRefundReasonsWorkflowId = "create-refund-reasons-workflow";
+/**
+ * This workflow creates one or more refund reasons. It's used by the
+ * [Create Refund Reason Admin API Route](https://docs.etohq.com/api/admin#refund-reasons_postrefundreasons).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to create refund reasons in your custom flows.
+ *
+ * @example
+ * const { result } = await createRefundReasonsWorkflow(container)
+ * .run({
+ *   input: {
+ *     data: [
+ *       {
+ *         label: "damaged",
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create refund reasons.
+ */
+export declare const createRefundReasonsWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<CreateRefundReasonsWorkflowInput, RefundReasonDTO[], []>;
 //# sourceMappingURL=create-refund-reasons.d.ts.map

package/dist/payment-collection/workflows/create-refund-reasons.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-refund-reasons.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/create-refund-reasons.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,eAAe,EAChB,MAAM,cAAc,CAAA;AAQrB,eAAO,MAAM,6BAA6B,mCAAmC,CAAA;AAC7E;;GAEG;AACH,eAAO,MAAM,2BAA2B;UAGR,qBAAqB,EAAE;yBAItD,CAAA"}
+{"version":3,"file":"create-refund-reasons.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/create-refund-reasons.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,eAAe,EAChB,MAAM,wBAAwB,CAAA;AAQ/B;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,IAAI,EAAE,qBAAqB,EAAE,CAAA;CAC9B,CAAA;AAED,eAAO,MAAM,6BAA6B,mCAAmC,CAAA;AAC7E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,2BAA2B,kHAOvC,CAAA"}

package/dist/payment-collection/workflows/create-refund-reasons.js

@@ -5,7 +5,27 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const create_refund_reasons_1 = require("../steps/create-refund-reasons");
 exports.createRefundReasonsWorkflowId = "create-refund-reasons-workflow";
 /**
- * This workflow creates one or more refund reasons.
+ * This workflow creates one or more refund reasons. It's used by the
+ * [Create Refund Reason Admin API Route](https://docs.etohq.com/api/admin#refund-reasons_postrefundreasons).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to create refund reasons in your custom flows.
+ *
+ * @example
+ * const { result } = await createRefundReasonsWorkflow(container)
+ * .run({
+ *   input: {
+ *     data: [
+ *       {
+ *         label: "damaged",
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create refund reasons.
  */
 exports.createRefundReasonsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createRefundReasonsWorkflowId, (input) => {
     return new workflows_sdk_1.WorkflowResponse((0, create_refund_reasons_1.createRefundReasonStep)(input.data));

package/dist/payment-collection/workflows/create-refund-reasons.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-refund-reasons.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/create-refund-reasons.ts"],"names":[],"mappings":";;;AAIA,kEAIuC;AACvC,0EAAuE;AAE1D,QAAA,6BAA6B,GAAG,gCAAgC,CAAA;AAC7E;;GAEG;AACU,QAAA,2BAA2B,GAAG,IAAA,8BAAc,EACvD,qCAA6B,EAC7B,CACE,KAAsD,EACjB,EAAE;IACvC,OAAO,IAAI,gCAAgB,CAAC,IAAA,8CAAsB,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC,CACF,CAAA"}
+{"version":3,"file":"create-refund-reasons.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/create-refund-reasons.ts"],"names":[],"mappings":";;;AAIA,kEAIuC;AACvC,0EAAuE;AAY1D,QAAA,6BAA6B,GAAG,gCAAgC,CAAA;AAC7E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,2BAA2B,GAAG,IAAA,8BAAc,EACvD,qCAA6B,EAC7B,CACE,KAAqD,EAChB,EAAE;IACvC,OAAO,IAAI,gCAAgB,CAAC,IAAA,8CAAsB,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC,CACF,CAAA"}

package/dist/payment-collection/workflows/delete-payment-sessions.d.ts

@@ -1,9 +1,31 @@
+/**
+ * The data to delete payment sessions.
+ */
 export interface DeletePaymentSessionsWorkflowInput {
+    /**
+     * The IDs of the payment sessions to delete.
+     */
     ids: string[];
 }
 export declare const deletePaymentSessionsWorkflowId = "delete-payment-sessions";
 /**
- * This workflow deletes one or more payment sessions.
+ * This workflow deletes one or more payment sessions. It's used by other workflows, like
+ * {@link refreshPaymentCollectionForCartWorkflow} to delete payment sessions when the cart's total changes.
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to delete payment sessions in your custom flows.
+ *
+ * @example
+ * const { result } = await deletePaymentSessionsWorkflow(container)
+ * .run({
+ *   input: {
+ *     ids: ["payses_123"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Delete payment sessions.
  */
 export declare const deletePaymentSessionsWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<DeletePaymentSessionsWorkflowInput, string[], []>;
 //# sourceMappingURL=delete-payment-sessions.d.ts.map

package/dist/payment-collection/workflows/delete-payment-sessions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-payment-sessions.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/delete-payment-sessions.ts"],"names":[],"mappings":"AAUA,MAAM,WAAW,kCAAkC;IACjD,GAAG,EAAE,MAAM,EAAE,CAAA;CACd;AAED,eAAO,MAAM,+BAA+B,4BAA4B,CAAA;AACxE;;GAEG;AACH,eAAO,MAAM,6BAA6B,2GAYzC,CAAA"}
+{"version":3,"file":"delete-payment-sessions.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/delete-payment-sessions.ts"],"names":[],"mappings":"AAUA;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,GAAG,EAAE,MAAM,EAAE,CAAA;CACd;AAED,eAAO,MAAM,+BAA+B,4BAA4B,CAAA;AACxE;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,6BAA6B,2GAYzC,CAAA"}

package/dist/payment-collection/workflows/delete-payment-sessions.js

@@ -5,7 +5,23 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const steps_1 = require("../steps");
 exports.deletePaymentSessionsWorkflowId = "delete-payment-sessions";
 /**
- * This workflow deletes one or more payment sessions.
+ * This workflow deletes one or more payment sessions. It's used by other workflows, like
+ * {@link refreshPaymentCollectionForCartWorkflow} to delete payment sessions when the cart's total changes.
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to delete payment sessions in your custom flows.
+ *
+ * @example
+ * const { result } = await deletePaymentSessionsWorkflow(container)
+ * .run({
+ *   input: {
+ *     ids: ["payses_123"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Delete payment sessions.
  */
 exports.deletePaymentSessionsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.deletePaymentSessionsWorkflowId, (input) => {
     const idsDeleted = (0, steps_1.deletePaymentSessionsStep)({ ids: input.ids });

package/dist/payment-collection/workflows/delete-payment-sessions.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-payment-sessions.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/delete-payment-sessions.ts"],"names":[],"mappings":";;;AAAA,kEAIuC;AACvC,oCAGiB;AAMJ,QAAA,+BAA+B,GAAG,yBAAyB,CAAA;AACxE;;GAEG;AACU,QAAA,6BAA6B,GAAG,IAAA,8BAAc,EACzD,uCAA+B,EAC/B,CAAC,KAAuD,EAAE,EAAE;IAC1D,MAAM,UAAU,GAAG,IAAA,iCAAyB,EAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAA;IAEhE,IAAA,0CAAkC,EAAC;QACjC,WAAW,EAAE,KAAK,CAAC,GAAG;QACtB,UAAU;KACX,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,UAAU,CAAC,CAAA;AACzC,CAAC,CACF,CAAA"}
+{"version":3,"file":"delete-payment-sessions.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/delete-payment-sessions.ts"],"names":[],"mappings":";;;AAAA,kEAIuC;AACvC,oCAGiB;AAYJ,QAAA,+BAA+B,GAAG,yBAAyB,CAAA;AACxE;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,6BAA6B,GAAG,IAAA,8BAAc,EACzD,uCAA+B,EAC/B,CAAC,KAAuD,EAAE,EAAE;IAC1D,MAAM,UAAU,GAAG,IAAA,iCAAyB,EAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAA;IAEhE,IAAA,0CAAkC,EAAC;QACjC,WAAW,EAAE,KAAK,CAAC,GAAG;QACtB,UAAU;KACX,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,UAAU,CAAC,CAAA;AACzC,CAAC,CACF,CAAA"}

package/dist/payment-collection/workflows/delete-refund-reasons.d.ts

@@ -1,8 +1,31 @@
-export declare const deleteRefundReasonsWorkflowId = "delete-refund-reasons-workflow";
 /**
- * This workflow deletes one or more refund reasons.
+ * The data to delete refund reasons.
  */
-export declare const deleteRefundReasonsWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<{
+export type DeleteRefundReasonsWorkflowInput = {
+    /**
+     * The refund reasons to delete.
+     */
     ids: string[];
-}, void, []>;
+};
+export declare const deleteRefundReasonsWorkflowId = "delete-refund-reasons-workflow";
+/**
+ * This workflow deletes one or more refund reasons. It's used by the
+ * [Delete Refund Reason Admin API Route](https://docs.etohq.com/api/admin#refund-reasons_deleterefundreasonsid).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to delete refund reasons in your custom flows.
+ *
+ * @example
+ * const { result } = await deleteRefundReasonsWorkflow(container)
+ * .run({
+ *   input: {
+ *     ids: ["refres_123"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Delete refund reasons.
+ */
+export declare const deleteRefundReasonsWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<DeleteRefundReasonsWorkflowInput, void, []>;
 //# sourceMappingURL=delete-refund-reasons.d.ts.map

package/dist/payment-collection/workflows/delete-refund-reasons.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-refund-reasons.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/delete-refund-reasons.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,6BAA6B,mCAAmC,CAAA;AAC7E;;GAEG;AACH,eAAO,MAAM,2BAA2B;SAEV,MAAM,EAAE;YAGrC,CAAA"}
+{"version":3,"file":"delete-refund-reasons.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/delete-refund-reasons.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,GAAG,EAAE,MAAM,EAAE,CAAA;CACd,CAAA;AAED,eAAO,MAAM,6BAA6B,mCAAmC,CAAA;AAC7E;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,2BAA2B,qGAKvC,CAAA"}

package/dist/payment-collection/workflows/delete-refund-reasons.js

@@ -5,7 +5,23 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const steps_1 = require("../steps");
 exports.deleteRefundReasonsWorkflowId = "delete-refund-reasons-workflow";
 /**
- * This workflow deletes one or more refund reasons.
+ * This workflow deletes one or more refund reasons. It's used by the
+ * [Delete Refund Reason Admin API Route](https://docs.etohq.com/api/admin#refund-reasons_deleterefundreasonsid).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to delete refund reasons in your custom flows.
+ *
+ * @example
+ * const { result } = await deleteRefundReasonsWorkflow(container)
+ * .run({
+ *   input: {
+ *     ids: ["refres_123"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Delete refund reasons.
  */
 exports.deleteRefundReasonsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.deleteRefundReasonsWorkflowId, (input) => {
     return new workflows_sdk_1.WorkflowResponse((0, steps_1.deleteRefundReasonsStep)(input.ids));

package/dist/payment-collection/workflows/delete-refund-reasons.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-refund-reasons.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/delete-refund-reasons.ts"],"names":[],"mappings":";;;AAAA,kEAIuC;AACvC,oCAAkD;AAErC,QAAA,6BAA6B,GAAG,gCAAgC,CAAA;AAC7E;;GAEG;AACU,QAAA,2BAA2B,GAAG,IAAA,8BAAc,EACvD,qCAA6B,EAC7B,CAAC,KAAsC,EAA0B,EAAE;IACjE,OAAO,IAAI,gCAAgB,CAAC,IAAA,+BAAuB,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;AACjE,CAAC,CACF,CAAA"}
+{"version":3,"file":"delete-refund-reasons.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/delete-refund-reasons.ts"],"names":[],"mappings":";;;AAAA,kEAIuC;AACvC,oCAAkD;AAYrC,QAAA,6BAA6B,GAAG,gCAAgC,CAAA;AAC7E;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,2BAA2B,GAAG,IAAA,8BAAc,EACvD,qCAA6B,EAC7B,CAAC,KAAqD,EAA0B,EAAE;IAChF,OAAO,IAAI,gCAAgB,CAAC,IAAA,+BAAuB,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;AACjE,CAAC,CACF,CAAA"}

package/dist/payment-collection/workflows/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./create-payment-session";
 export * from "./create-refund-reasons";
 export * from "./delete-payment-sessions";
+export * from "./delete-refund-reasons";
 export * from "./update-refund-reasons";
 //# sourceMappingURL=index.d.ts.map

package/dist/payment-collection/workflows/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA"}

package/dist/payment-collection/workflows/index.js

@@ -17,5 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./create-payment-session"), exports);
 __exportStar(require("./create-refund-reasons"), exports);
 __exportStar(require("./delete-payment-sessions"), exports);
+__exportStar(require("./delete-refund-reasons"), exports);
 __exportStar(require("./update-refund-reasons"), exports);
 //# sourceMappingURL=index.js.map

package/dist/payment-collection/workflows/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAwC;AACxC,0DAAuC;AACvC,4DAAyC;AACzC,0DAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAwC;AACxC,0DAAuC;AACvC,4DAAyC;AACzC,0DAAuC;AACvC,0DAAuC"}

package/dist/payment-collection/workflows/update-refund-reasons.d.ts

@@ -1,7 +1,34 @@
-import { RefundReasonDTO, UpdateRefundReasonDTO } from "@etohq/types";
+import { RefundReasonDTO, UpdateRefundReasonDTO } from "@etohq/framework/types";
+/**
+ * The refund reasons to update.
+ */
+export type UpdateRefundReasonsWorkflowInput = UpdateRefundReasonDTO[];
+/**
+ * The updated refund reasons.
+ */
+export type UpdateRefundReasonsWorkflowOutput = RefundReasonDTO[];
 export declare const updateRefundReasonsWorkflowId = "update-refund-reasons";
 /**
- * This workflow updates one or more refund reasons.
+ * This workflow updates one or more refund reasons. It's used by the
+ * [Update Refund Reason Admin API Route](https://docs.etohq.com/api/admin#refund-reasons_postrefundreasonsid).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to update refund reasons in your custom flows.
+ *
+ * @example
+ * const { result } = await updateRefundReasonsWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       id: "refres_123",
+ *       label: "Damaged",
+ *     }
+ *   ]
+ * })
+ *
+ * @summary
+ *
+ * Update refund reasons.
  */
-export declare const updateRefundReasonsWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<UpdateRefundReasonDTO[], RefundReasonDTO[], []>;
+export declare const updateRefundReasonsWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<UpdateRefundReasonsWorkflowInput, UpdateRefundReasonsWorkflowOutput, []>;
 //# sourceMappingURL=update-refund-reasons.d.ts.map

package/dist/payment-collection/workflows/update-refund-reasons.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"update-refund-reasons.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/update-refund-reasons.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,qBAAqB,EACtB,MAAM,cAAc,CAAA;AAQrB,eAAO,MAAM,6BAA6B,0BAA0B,CAAA;AACpE;;GAEG;AACH,eAAO,MAAM,2BAA2B,yGAOvC,CAAA"}
+{"version":3,"file":"update-refund-reasons.d.ts","sourceRoot":"","sources":["../../../src/payment-collection/workflows/update-refund-reasons.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,qBAAqB,EACtB,MAAM,wBAAwB,CAAA;AAQ/B;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG,qBAAqB,EAAE,CAAA;AAEtE;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,eAAe,EAAE,CAAA;AAEjE,eAAO,MAAM,6BAA6B,0BAA0B,CAAA;AACpE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,2BAA2B,kIAOvC,CAAA"}

package/dist/payment-collection/workflows/update-refund-reasons.js

@@ -5,7 +5,26 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const steps_1 = require("../steps");
 exports.updateRefundReasonsWorkflowId = "update-refund-reasons";
 /**
- * This workflow updates one or more refund reasons.
+ * This workflow updates one or more refund reasons. It's used by the
+ * [Update Refund Reason Admin API Route](https://docs.etohq.com/api/admin#refund-reasons_postrefundreasonsid).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to update refund reasons in your custom flows.
+ *
+ * @example
+ * const { result } = await updateRefundReasonsWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       id: "refres_123",
+ *       label: "Damaged",
+ *     }
+ *   ]
+ * })
+ *
+ * @summary
+ *
+ * Update refund reasons.
  */
 exports.updateRefundReasonsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.updateRefundReasonsWorkflowId, (input) => {
     return new workflows_sdk_1.WorkflowResponse((0, steps_1.updateRefundReasonsStep)(input));

package/dist/payment-collection/workflows/update-refund-reasons.js.map

@@ -1 +1 @@
-{"version":3,"file":"update-refund-reasons.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/update-refund-reasons.ts"],"names":[],"mappings":";;;AAIA,kEAIuC;AACvC,oCAAkD;AAErC,QAAA,6BAA6B,GAAG,uBAAuB,CAAA;AACpE;;GAEG;AACU,QAAA,2BAA2B,GAAG,IAAA,8BAAc,EACvD,qCAA6B,EAC7B,CACE,KAA4C,EACP,EAAE;IACvC,OAAO,IAAI,gCAAgB,CAAC,IAAA,+BAAuB,EAAC,KAAK,CAAC,CAAC,CAAA;AAC7D,CAAC,CACF,CAAA"}
+{"version":3,"file":"update-refund-reasons.js","sourceRoot":"","sources":["../../../src/payment-collection/workflows/update-refund-reasons.ts"],"names":[],"mappings":";;;AAIA,kEAIuC;AACvC,oCAAkD;AAYrC,QAAA,6BAA6B,GAAG,uBAAuB,CAAA;AACpE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACU,QAAA,2BAA2B,GAAG,IAAA,8BAAc,EACvD,qCAA6B,EAC7B,CACE,KAAqD,EACA,EAAE;IACvD,OAAO,IAAI,gCAAgB,CAAC,IAAA,+BAAuB,EAAC,KAAK,CAAC,CAAC,CAAA;AAC7D,CAAC,CACF,CAAA"}

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/index.ts","../src/api-key/index.ts","../src/api-key/steps/create-api-keys.ts","../src/api-key/steps/delete-api-keys.ts","../src/api-key/steps/index.ts","../src/api-key/steps/revoke-api-keys.ts","../src/api-key/steps/update-api-keys.ts","../src/api-key/workflows/create-api-keys.ts","../src/api-key/workflows/delete-api-keys.ts","../src/api-key/workflows/index.ts","../src/api-key/workflows/revoke-api-keys.ts","../src/api-key/workflows/update-api-keys.ts","../src/auth/index.ts","../src/auth/steps/index.ts","../src/auth/steps/set-auth-app-metadata.ts","../src/auth/workflows/generate-reset-password-token.ts","../src/auth/workflows/index.ts","../src/common/index.ts","../src/common/steps/create-entities.ts","../src/common/steps/create-remote-links.ts","../src/common/steps/delete-entities.ts","../src/common/steps/dismiss-remote-links.ts","../src/common/steps/emit-event.ts","../src/common/steps/release-event.ts","../src/common/steps/remove-remote-links.ts","../src/common/steps/update-remote-links.ts","../src/common/steps/use-query-graph.ts","../src/common/steps/use-remote-query.ts","../src/common/steps/validate-presence-of.ts","../src/common/workflows/batch-links.ts","../src/common/workflows/create-links.ts","../src/common/workflows/dismiss-links.ts","../src/common/workflows/update-links.ts","../src/file/index.ts","../src/file/steps/delete-files.ts","../src/file/steps/index.ts","../src/file/steps/upload-files.ts","../src/file/workflows/delete-files.ts","../src/file/workflows/index.ts","../src/file/workflows/upload-files.ts","../src/notification/index.ts","../src/notification/steps/index.ts","../src/notification/steps/notify-on-failure.ts","../src/notification/steps/send-notifications.ts","../src/payment/index.ts","../src/payment/steps/authorize-payment-session.ts","../src/payment/steps/cancel-payment.ts","../src/payment/steps/capture-payment.ts","../src/payment/steps/index.ts","../src/payment/steps/refund-payment.ts","../src/payment/steps/refund-payments.ts","../src/payment-collection/index.ts","../src/payment-collection/steps/create-payment-session.ts","../src/payment-collection/steps/create-refund-reasons.ts","../src/payment-collection/steps/delete-payment-sessions.ts","../src/payment-collection/steps/delete-refund-reasons.ts","../src/payment-collection/steps/index.ts","../src/payment-collection/steps/update-payment-collection.ts","../src/payment-collection/steps/update-refund-reasons.ts","../src/payment-collection/steps/validate-deleted-payment-sessions.ts","../src/payment-collection/workflows/create-payment-session.ts","../src/payment-collection/workflows/create-refund-reasons.ts","../src/payment-collection/workflows/delete-payment-sessions.ts","../src/payment-collection/workflows/delete-refund-reasons.ts","../src/payment-collection/workflows/index.ts","../src/payment-collection/workflows/update-refund-reasons.ts","../src/user/index.ts","../src/user/steps/create-users.ts","../src/user/steps/delete-users.ts","../src/user/steps/index.ts","../src/user/steps/update-users.ts","../src/user/workflows/create-user-account.ts","../src/user/workflows/create-users.ts","../src/user/workflows/delete-users.ts","../src/user/workflows/index.ts","../src/user/workflows/remove-user-account.ts","../src/user/workflows/update-users.ts"],"version":"5.8.3"}
+{"root":["../src/index.ts","../src/api-key/index.ts","../src/api-key/steps/create-api-keys.ts","../src/api-key/steps/delete-api-keys.ts","../src/api-key/steps/index.ts","../src/api-key/steps/revoke-api-keys.ts","../src/api-key/steps/update-api-keys.ts","../src/api-key/workflows/create-api-keys.ts","../src/api-key/workflows/delete-api-keys.ts","../src/api-key/workflows/index.ts","../src/api-key/workflows/revoke-api-keys.ts","../src/api-key/workflows/update-api-keys.ts","../src/auth/index.ts","../src/auth/steps/index.ts","../src/auth/steps/set-auth-app-metadata.ts","../src/auth/workflows/generate-reset-password-token.ts","../src/auth/workflows/index.ts","../src/common/index.ts","../src/common/steps/create-entities.ts","../src/common/steps/create-remote-links.ts","../src/common/steps/delete-entities.ts","../src/common/steps/dismiss-remote-links.ts","../src/common/steps/emit-event.ts","../src/common/steps/release-event.ts","../src/common/steps/remove-remote-links.ts","../src/common/steps/update-remote-links.ts","../src/common/steps/use-query-graph.ts","../src/common/steps/use-remote-query.ts","../src/common/steps/validate-presence-of.ts","../src/common/workflows/batch-links.ts","../src/common/workflows/create-links.ts","../src/common/workflows/dismiss-links.ts","../src/common/workflows/update-links.ts","../src/file/index.ts","../src/file/steps/delete-files.ts","../src/file/steps/index.ts","../src/file/steps/upload-files.ts","../src/file/workflows/delete-files.ts","../src/file/workflows/index.ts","../src/file/workflows/upload-files.ts","../src/invite/index.ts","../src/invite/steps/create-invites.ts","../src/invite/steps/delete-invites.ts","../src/invite/steps/index.ts","../src/invite/steps/refresh-invite-tokens.ts","../src/invite/steps/validate-token.ts","../src/invite/workflows/accept-invite.ts","../src/invite/workflows/create-invites.ts","../src/invite/workflows/delete-invites.ts","../src/invite/workflows/index.ts","../src/invite/workflows/refresh-invite-tokens.ts","../src/locking/acquire-lock.ts","../src/locking/index.ts","../src/locking/release-lock.ts","../src/notification/index.ts","../src/notification/steps/index.ts","../src/notification/steps/notify-on-failure.ts","../src/notification/steps/send-notifications.ts","../src/payment/index.ts","../src/payment/steps/authorize-payment-session.ts","../src/payment/steps/cancel-payment.ts","../src/payment/steps/capture-payment.ts","../src/payment/steps/index.ts","../src/payment/steps/refund-payment.ts","../src/payment/steps/refund-payments.ts","../src/payment-collection/index.ts","../src/payment-collection/steps/cancel-payment.ts","../src/payment-collection/steps/create-payment-account-holder.ts","../src/payment-collection/steps/create-payment-session.ts","../src/payment-collection/steps/create-refund-reasons.ts","../src/payment-collection/steps/delete-payment-sessions.ts","../src/payment-collection/steps/delete-refund-reasons.ts","../src/payment-collection/steps/index.ts","../src/payment-collection/steps/update-payment-collection.ts","../src/payment-collection/steps/update-refund-reasons.ts","../src/payment-collection/steps/validate-deleted-payment-sessions.ts","../src/payment-collection/workflows/cancel-payment-collection.ts","../src/payment-collection/workflows/create-payment-session.ts","../src/payment-collection/workflows/create-refund-reasons.ts","../src/payment-collection/workflows/delete-payment-sessions.ts","../src/payment-collection/workflows/delete-refund-reasons.ts","../src/payment-collection/workflows/index.ts","../src/payment-collection/workflows/update-refund-reasons.ts","../src/user/index.ts","../src/user/steps/create-users.ts","../src/user/steps/delete-users.ts","../src/user/steps/index.ts","../src/user/steps/update-users.ts","../src/user/workflows/create-user-account.ts","../src/user/workflows/create-users.ts","../src/user/workflows/delete-users.ts","../src/user/workflows/index.ts","../src/user/workflows/remove-user-account.ts","../src/user/workflows/update-users.ts"],"version":"5.8.3"}