@etohq/core-flows 1.3.0 → 1.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Etohq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/api-key/steps/create-api-keys.d.ts

@@ -1,10 +1,27 @@
 import { CreateApiKeyDTO } from "@etohq/framework/types";
+/**
+ * The data to create API keys.
+ */
 export type CreateApiKeysStepInput = {
+    /**
+     * The API keys to create.
+     */
     api_keys: CreateApiKeyDTO[];
 };
 export declare const createApiKeysStepId = "create-api-keys";
 /**
  * This step creates one or more API keys.
+ *
+ * @example
+ * const data = createApiKeysStep({
+ *   api_keys: [
+ *     {
+ *       type: "publishable",
+ *       title: "Storefront",
+ *       created_by: "user_123"
+ *     }
+ *   ]
+ * })
  */
 export declare const createApiKeysStep: import("@etohq/framework/workflows-sdk").StepFunction<CreateApiKeysStepInput, import("@etohq/framework/types").ApiKeyDTO[]>;
 //# sourceMappingURL=create-api-keys.d.ts.map

package/dist/api-key/steps/create-api-keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/steps/create-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAEhB,MAAM,wBAAwB,CAAA;AAI/B,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,eAAe,EAAE,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,mBAAmB,oBAAoB,CAAA;AACpD;;GAEG;AACH,eAAO,MAAM,iBAAiB,6HAmB7B,CAAA"}
+{"version":3,"file":"create-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/steps/create-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAEhB,MAAM,wBAAwB,CAAA;AAI/B;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,QAAQ,EAAE,eAAe,EAAE,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,mBAAmB,oBAAoB,CAAA;AACpD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB,6HAmB7B,CAAA"}

package/dist/api-key/steps/create-api-keys.js

@@ -6,6 +6,17 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 exports.createApiKeysStepId = "create-api-keys";
 /**
  * This step creates one or more API keys.
+ *
+ * @example
+ * const data = createApiKeysStep({
+ *   api_keys: [
+ *     {
+ *       type: "publishable",
+ *       title: "Storefront",
+ *       created_by: "user_123"
+ *     }
+ *   ]
+ * })
  */
 exports.createApiKeysStep = (0, workflows_sdk_1.createStep)(exports.createApiKeysStepId, async (data, { container }) => {
     const service = container.resolve(utils_1.Modules.API_KEY);

package/dist/api-key/steps/create-api-keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/steps/create-api-keys.ts"],"names":[],"mappings":";;;AAIA,kDAAgD;AAChD,kEAAyE;AAM5D,QAAA,mBAAmB,GAAG,iBAAiB,CAAA;AACpD;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,2BAAmB,EACnB,KAAK,EAAE,IAA4B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACpD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IACxE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC1D,OAAO,IAAI,4BAAY,CACrB,OAAO,EACP,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CACnC,CAAA;AACH,CAAC,EACD,KAAK,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAClC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IAExE,MAAM,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;AACzC,CAAC,CACF,CAAA"}
+{"version":3,"file":"create-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/steps/create-api-keys.ts"],"names":[],"mappings":";;;AAIA,kDAAgD;AAChD,kEAAyE;AAY5D,QAAA,mBAAmB,GAAG,iBAAiB,CAAA;AACpD;;;;;;;;;;;;;GAaG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,2BAAmB,EACnB,KAAK,EAAE,IAA4B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACpD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IACxE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC1D,OAAO,IAAI,4BAAY,CACrB,OAAO,EACP,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CACnC,CAAA;AACH,CAAC,EACD,KAAK,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAClC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IAExE,MAAM,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;AACzC,CAAC,CACF,CAAA"}

package/dist/api-key/steps/delete-api-keys.d.ts

@@ -1,6 +1,10 @@
+/**
+ * The IDs of the API keys to delete.
+ */
+export type DeleteApiKeysStepInput = string[];
 export declare const deleteApiKeysStepId = "delete-api-keys";
 /**
  * This step deletes one or more API keys.
  */
-export declare const deleteApiKeysStep: import("@etohq/framework/workflows-sdk").StepFunction<string[], undefined>;
+export declare const deleteApiKeysStep: import("@etohq/framework/workflows-sdk").StepFunction<DeleteApiKeysStepInput, undefined>;
 //# sourceMappingURL=delete-api-keys.d.ts.map

package/dist/api-key/steps/delete-api-keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/steps/delete-api-keys.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,mBAAmB,oBAAoB,CAAA;AACpD;;GAEG;AACH,eAAO,MAAM,iBAAiB,4EAS7B,CAAA"}
+{"version":3,"file":"delete-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/steps/delete-api-keys.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,EAAE,CAAA;AAE7C,eAAO,MAAM,mBAAmB,oBAAoB,CAAA;AACpD;;GAEG;AACH,eAAO,MAAM,iBAAiB,0FAS7B,CAAA"}

package/dist/api-key/steps/delete-api-keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/steps/delete-api-keys.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAE5D,QAAA,mBAAmB,GAAG,iBAAiB,CAAA;AACpD;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,EAAE,IAAI,EAAE,2BAAmB,EAAE,cAAc,EAAE,IAAI,EAAE,EACnD,KAAK,EAAE,GAAa,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrC,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IAExE,MAAM,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;IAChC,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;AACjC,CAAC,EACD,KAAK,IAAI,EAAE,GAAE,CAAC,CACf,CAAA"}
+{"version":3,"file":"delete-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/steps/delete-api-keys.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAO5D,QAAA,mBAAmB,GAAG,iBAAiB,CAAA;AACpD;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,EAAE,IAAI,EAAE,2BAAmB,EAAE,cAAc,EAAE,IAAI,EAAE,EACnD,KAAK,EAAE,GAA2B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACnD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IAExE,MAAM,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;IAChC,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;AACjC,CAAC,EACD,KAAK,IAAI,EAAE,GAAE,CAAC,CACf,CAAA"}

package/dist/api-key/steps/revoke-api-keys.d.ts

@@ -1,11 +1,30 @@
 import { FilterableApiKeyProps, RevokeApiKeyDTO } from "@etohq/framework/types";
+/**
+ * The data to revoke API keys.
+ */
 export type RevokeApiKeysStepInput = {
+    /**
+     * The filters to select the API keys to revoke.
+     */
     selector: FilterableApiKeyProps;
+    /**
+     * The data to revoke the API keys.
+     */
     revoke: RevokeApiKeyDTO;
 };
 export declare const revokeApiKeysStepId = "revoke-api-keys";
 /**
  * This step revokes one or more API keys.
+ *
+ * @example
+ * const data = revokeApiKeysStep({
+ *   selector: {
+ *     id: "apk_123"
+ *   },
+ *   revoke: {
+ *     revoked_by: "user_123"
+ *   }
+ * })
  */
 export declare const revokeApiKeysStep: import("@etohq/framework/workflows-sdk").StepFunction<RevokeApiKeysStepInput, import("@etohq/framework/types").ApiKeyDTO[]>;
 //# sourceMappingURL=revoke-api-keys.d.ts.map

package/dist/api-key/steps/revoke-api-keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"revoke-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/steps/revoke-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EAErB,eAAe,EAChB,MAAM,wBAAwB,CAAA;AAI/B,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,qBAAqB,CAAA;IAC/B,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,mBAAmB,oBAAoB,CAAA;AACpD;;GAEG;AACH,eAAO,MAAM,iBAAiB,6HAS7B,CAAA"}
+{"version":3,"file":"revoke-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/steps/revoke-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EAErB,eAAe,EAChB,MAAM,wBAAwB,CAAA;AAI/B;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,QAAQ,EAAE,qBAAqB,CAAA;IAC/B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,mBAAmB,oBAAoB,CAAA;AACpD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB,6HAS7B,CAAA"}

package/dist/api-key/steps/revoke-api-keys.js

@@ -6,6 +6,16 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 exports.revokeApiKeysStepId = "revoke-api-keys";
 /**
  * This step revokes one or more API keys.
+ *
+ * @example
+ * const data = revokeApiKeysStep({
+ *   selector: {
+ *     id: "apk_123"
+ *   },
+ *   revoke: {
+ *     revoked_by: "user_123"
+ *   }
+ * })
  */
 exports.revokeApiKeysStep = (0, workflows_sdk_1.createStep)({ name: exports.revokeApiKeysStepId, noCompensation: true }, async (data, { container }) => {
     const service = container.resolve(utils_1.Modules.API_KEY);

package/dist/api-key/steps/revoke-api-keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"revoke-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/steps/revoke-api-keys.ts"],"names":[],"mappings":";;;AAKA,kDAAgD;AAChD,kEAAyE;AAO5D,QAAA,mBAAmB,GAAG,iBAAiB,CAAA;AACpD;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,EAAE,IAAI,EAAE,2BAAmB,EAAE,cAAc,EAAE,IAAI,EAAE,EACnD,KAAK,EAAE,IAA4B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACpD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IAExE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IAChE,OAAO,IAAI,4BAAY,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC,EACD,KAAK,IAAI,EAAE,GAAE,CAAC,CACf,CAAA"}
+{"version":3,"file":"revoke-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/steps/revoke-api-keys.ts"],"names":[],"mappings":";;;AAKA,kDAAgD;AAChD,kEAAyE;AAgB5D,QAAA,mBAAmB,GAAG,iBAAiB,CAAA;AACpD;;;;;;;;;;;;GAYG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,EAAE,IAAI,EAAE,2BAAmB,EAAE,cAAc,EAAE,IAAI,EAAE,EACnD,KAAK,EAAE,IAA4B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACpD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IAExE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IAChE,OAAO,IAAI,4BAAY,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC,EACD,KAAK,IAAI,EAAE,GAAE,CAAC,CACf,CAAA"}

package/dist/api-key/steps/update-api-keys.d.ts

@@ -1,11 +1,30 @@
 import { FilterableApiKeyProps, UpdateApiKeyDTO } from "@etohq/framework/types";
+/**
+ * The data to update API keys.
+ */
 export type UpdateApiKeysStepInput = {
+    /**
+     * The filters to select the API keys to update.
+     */
     selector: FilterableApiKeyProps;
+    /**
+     * The data to update the API keys.
+     */
     update: UpdateApiKeyDTO;
 };
 export declare const updateApiKeysStepId = "update-api-keys";
 /**
  * This step updates one or more API keys.
+ *
+ * @example
+ * const data = updateApiKeysStep({
+ *   selector: {
+ *     id: "apk_123"
+ *   },
+ *   update: {
+ *     title: "Storefront"
+ *   }
+ * })
  */
 export declare const updateApiKeysStep: import("@etohq/framework/workflows-sdk").StepFunction<UpdateApiKeysStepInput, import("@etohq/framework/types").ApiKeyDTO[]>;
 //# sourceMappingURL=update-api-keys.d.ts.map

package/dist/api-key/steps/update-api-keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"update-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/steps/update-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EAErB,eAAe,EAChB,MAAM,wBAAwB,CAAA;AAO/B,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,qBAAqB,CAAA;IAC/B,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,mBAAmB,oBAAoB,CAAA;AACpD;;GAEG;AACH,eAAO,MAAM,iBAAiB,6HA+B7B,CAAA"}
+{"version":3,"file":"update-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/steps/update-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EAErB,eAAe,EAChB,MAAM,wBAAwB,CAAA;AAO/B;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,QAAQ,EAAE,qBAAqB,CAAA;IAC/B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,mBAAmB,oBAAoB,CAAA;AACpD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB,6HA+B7B,CAAA"}

package/dist/api-key/steps/update-api-keys.js

@@ -6,6 +6,16 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 exports.updateApiKeysStepId = "update-api-keys";
 /**
  * This step updates one or more API keys.
+ *
+ * @example
+ * const data = updateApiKeysStep({
+ *   selector: {
+ *     id: "apk_123"
+ *   },
+ *   update: {
+ *     title: "Storefront"
+ *   }
+ * })
  */
 exports.updateApiKeysStep = (0, workflows_sdk_1.createStep)(exports.updateApiKeysStepId, async (data, { container }) => {
     const service = container.resolve(utils_1.Modules.API_KEY);

package/dist/api-key/steps/update-api-keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"update-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/steps/update-api-keys.ts"],"names":[],"mappings":";;;AAKA,kDAG+B;AAC/B,kEAAyE;AAO5D,QAAA,mBAAmB,GAAG,iBAAiB,CAAA;AACpD;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,2BAAmB,EACnB,KAAK,EAAE,IAA4B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACpD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IAExE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAA,6CAAqC,EAAC;QACnE,IAAI,CAAC,MAAM;KACZ,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE;QACxD,MAAM,EAAE,OAAO;QACf,SAAS;KACV,CAAC,CAAA;IAEF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IACvE,OAAO,IAAI,4BAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;AAC5C,CAAC,EACD,KAAK,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAChC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;QACtB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IAExE,MAAM,OAAO,CAAC,aAAa,CACzB,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACnB,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,KAAK,EAAE,CAAC,CAAC,KAAK;KACf,CAAC,CAAC,CACJ,CAAA;AACH,CAAC,CACF,CAAA"}
+{"version":3,"file":"update-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/steps/update-api-keys.ts"],"names":[],"mappings":";;;AAKA,kDAG+B;AAC/B,kEAAyE;AAgB5D,QAAA,mBAAmB,GAAG,iBAAiB,CAAA;AACpD;;;;;;;;;;;;GAYG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,2BAAmB,EACnB,KAAK,EAAE,IAA4B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACpD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IAExE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAA,6CAAqC,EAAC;QACnE,IAAI,CAAC,MAAM;KACZ,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE;QACxD,MAAM,EAAE,OAAO;QACf,SAAS;KACV,CAAC,CAAA;IAEF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IACvE,OAAO,IAAI,4BAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;AAC5C,CAAC,EACD,KAAK,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAChC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;QACtB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAuB,eAAO,CAAC,OAAO,CAAC,CAAA;IAExE,MAAM,OAAO,CAAC,aAAa,CACzB,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACnB,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,KAAK,EAAE,CAAC,CAAC,KAAK;KACf,CAAC,CAAC,CACJ,CAAA;AACH,CAAC,CACF,CAAA"}

package/dist/api-key/workflows/create-api-keys.d.ts

@@ -1,10 +1,49 @@
 import { ApiKeyDTO, CreateApiKeyDTO } from "@etohq/framework/types";
+import { WorkflowData } from "@etohq/framework/workflows-sdk";
+/**
+ * The data to create API keys.
+ */
 export type CreateApiKeysWorkflowInput = {
+    /**
+     * The API keys to create.
+     */
     api_keys: CreateApiKeyDTO[];
 };
+/**
+ * The created API keys.
+ */
+export type CreateApiKeysWorkflowOutput = ApiKeyDTO[];
 export declare const createApiKeysWorkflowId = "create-api-keys";
 /**
- * This workflow creates one or more API keys.
+ * This workflow creates one or more API keys, which can be secret or publishable. It's used by the
+ * [Create API Key Admin API Route](https://docs.etohq.com/api/admin#api-keys_postapikeys).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * create API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await createApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     api_keys: [
+ *       {
+ *         type: "publishable",
+ *         title: "Storefront",
+ *         created_by: "user_123"
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create secret or publishable API keys.
  */
-export declare const createApiKeysWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<CreateApiKeysWorkflowInput, ApiKeyDTO[], []>;
+export declare const createApiKeysWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<CreateApiKeysWorkflowInput, ApiKeyDTO[], [import("@etohq/framework/workflows-sdk").Hook<"apiKeysCreated", {
+    apiKeys: (ApiKeyDTO | WorkflowData<ApiKeyDTO>)[] & ApiKeyDTO[] & import("@etohq/framework/workflows-sdk").WorkflowDataProperties<ApiKeyDTO[]> & {
+        config(config: {
+            name?: string;
+        } & Omit<import("@etohq/orchestration").TransactionStepsDefinition, "next" | "uuid" | "action">): WorkflowData<ApiKeyDTO[]>;
+    } & import("@etohq/framework/workflows-sdk").StepFunctionReturnConfig<ApiKeyDTO[]>;
+}, unknown>]>;
 //# sourceMappingURL=create-api-keys.d.ts.map

package/dist/api-key/workflows/create-api-keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/create-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAQnE,MAAM,MAAM,0BAA0B,GAAG;IAAE,QAAQ,EAAE,eAAe,EAAE,CAAA;CAAE,CAAA;AAExE,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;GAEG;AACH,eAAO,MAAM,qBAAqB,sGAOjC,CAAA"}
+{"version":3,"file":"create-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/create-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AACnE,OAAO,EACL,YAAY,EAIb,MAAM,gCAAgC,CAAA;AAGvC;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,QAAQ,EAAE,eAAe,EAAE,CAAA;CAC5B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,SAAS,EAAE,CAAA;AAErD,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,qBAAqB;;;gBAcu4B,CAAC;;;aADz6B,CAAA"}

package/dist/api-key/workflows/create-api-keys.js

@@ -5,9 +5,37 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const steps_1 = require("../steps");
 exports.createApiKeysWorkflowId = "create-api-keys";
 /**
- * This workflow creates one or more API keys.
+ * This workflow creates one or more API keys, which can be secret or publishable. It's used by the
+ * [Create API Key Admin API Route](https://docs.etohq.com/api/admin#api-keys_postapikeys).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * create API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await createApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     api_keys: [
+ *       {
+ *         type: "publishable",
+ *         title: "Storefront",
+ *         created_by: "user_123"
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create secret or publishable API keys.
  */
 exports.createApiKeysWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createApiKeysWorkflowId, (input) => {
-    return new workflows_sdk_1.WorkflowResponse((0, steps_1.createApiKeysStep)(input));
+    const apiKeys = (0, steps_1.createApiKeysStep)(input);
+    const apiKeysCreated = (0, workflows_sdk_1.createHook)("apiKeysCreated", {
+        apiKeys,
+    });
+    return new workflows_sdk_1.WorkflowResponse(apiKeys, {
+        hooks: [apiKeysCreated],
+    });
 });
 //# sourceMappingURL=create-api-keys.js.map

package/dist/api-key/workflows/create-api-keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/create-api-keys.ts"],"names":[],"mappings":";;;AACA,kEAIuC;AACvC,oCAA4C;AAI/B,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;GAEG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CACE,KAA+C,EAChB,EAAE;IACjC,OAAO,IAAI,gCAAgB,CAAC,IAAA,yBAAiB,EAAC,KAAK,CAAC,CAAC,CAAA;AACvD,CAAC,CACF,CAAA"}
+{"version":3,"file":"create-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/create-api-keys.ts"],"names":[],"mappings":";;;AACA,kEAKuC;AACvC,oCAA4C;AAiB/B,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CAAC,KAA+C,EAAE,EAAE;IAClD,MAAM,OAAO,GAAG,IAAA,yBAAiB,EAAC,KAAK,CAAC,CAAA;IAExC,MAAM,cAAc,GAAG,IAAA,0BAAU,EAAC,gBAAgB,EAAE;QAClD,OAAO;KACR,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,OAAO,EAAE;QACnC,KAAK,EAAE,CAAC,cAAc,CAAC;KACxB,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

package/dist/api-key/workflows/delete-api-keys.d.ts

@@ -1,9 +1,31 @@
+/**
+ * The data to delete API keys.
+ */
 export type DeleteApiKeysWorkflowInput = {
+    /**
+     * The IDs of the API keys to delete.
+     */
     ids: string[];
 };
 export declare const deleteApiKeysWorkflowId = "delete-api-keys";
 /**
- * This workflow deletes one or more API keys.
+ * This workflow deletes one or more secret or publishable API keys. It's used by the
+ * [Delete API Key Admin API Route](https://docs.etohq.com/api/admin#api-keys_deleteapikeysid).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * delete API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await deleteApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     ids: ["apk_123"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Delete secret or publishable API keys.
  */
 export declare const deleteApiKeysWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<DeleteApiKeysWorkflowInput, unknown, any[]>;
 //# sourceMappingURL=delete-api-keys.d.ts.map

package/dist/api-key/workflows/delete-api-keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/delete-api-keys.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,0BAA0B,GAAG;IAAE,GAAG,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAE1D,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;GAEG;AACH,eAAO,MAAM,qBAAqB,qGAUjC,CAAA"}
+{"version":3,"file":"delete-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/delete-api-keys.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,GAAG,EAAE,MAAM,EAAE,CAAA;CACd,CAAA;AAED,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,qBAAqB,qGAUjC,CAAA"}

package/dist/api-key/workflows/delete-api-keys.js

@@ -7,7 +7,23 @@ const steps_1 = require("../steps");
 const utils_1 = require("@etohq/framework/utils");
 exports.deleteApiKeysWorkflowId = "delete-api-keys";
 /**
- * This workflow deletes one or more API keys.
+ * This workflow deletes one or more secret or publishable API keys. It's used by the
+ * [Delete API Key Admin API Route](https://docs.etohq.com/api/admin#api-keys_deleteapikeysid).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * delete API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await deleteApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     ids: ["apk_123"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Delete secret or publishable API keys.
  */
 exports.deleteApiKeysWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.deleteApiKeysWorkflowId, (input) => {
     (0, steps_1.deleteApiKeysStep)(input.ids);

package/dist/api-key/workflows/delete-api-keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/delete-api-keys.ts"],"names":[],"mappings":";;;AAAA,kEAA6E;AAC7E,gFAA6E;AAC7E,oCAA4C;AAC5C,kDAAgD;AAInC,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;GAEG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CAAC,KAA+C,EAAsB,EAAE;IACtE,IAAA,yBAAiB,EAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAE5B,0DAA0D;IAC1D,IAAA,0CAAoB,EAAC;QACnB,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE,EAAE,kBAAkB,EAAE,KAAK,CAAC,GAAG,EAAE;KACrD,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}
+{"version":3,"file":"delete-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/delete-api-keys.ts"],"names":[],"mappings":";;;AAAA,kEAA6E;AAC7E,gFAA6E;AAC7E,oCAA4C;AAC5C,kDAAgD;AAYnC,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CAAC,KAA+C,EAAsB,EAAE;IACtE,IAAA,yBAAiB,EAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAE5B,0DAA0D;IAC1D,IAAA,0CAAoB,EAAC;QACnB,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE,EAAE,kBAAkB,EAAE,KAAK,CAAC,GAAG,EAAE;KACrD,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

package/dist/api-key/workflows/link-sales-channels-to-publishable-key.d.ts

@@ -0,0 +1,32 @@
+import { LinkWorkflowInput } from "@etohq/framework/types";
+/**
+ * The data to manage the sales channels of a publishable API key.
+ *
+ * @property id - The ID of the publishable API key.
+ * @property add - The sales channel IDs to add to the publishable API key.
+ * @property remove - The sales channel IDs to remove from the publishable API key.
+ */
+export type LinkSalesChannelsToApiKeyWorkflowInput = LinkWorkflowInput;
+export declare const linkSalesChannelsToApiKeyWorkflowId = "link-sales-channels-to-api-key";
+/**
+ * This workflow manages the sales channels of a publishable API key. It's used by the
+ * [Manage Sales Channels API Route](https://docs.etohq.com/api/admin#api-keys_postapikeysidsaleschannels).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * manage the sales channels of a publishable API key within your custom flows.
+ *
+ * @example
+ * const { result } = await linkSalesChannelsToApiKeyWorkflow(container)
+ * .run({
+ *   input: {
+ *     id: "apk_132",
+ *     add: ["sc_123"],
+ *     remove: ["sc_321"]
+ *   }
+ * })
+ *
+ * @summary
+ * Manage the sales channels of a publishable API key.
+ */
+export declare const linkSalesChannelsToApiKeyWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<LinkWorkflowInput, unknown, any[]>;
+//# sourceMappingURL=link-sales-channels-to-publishable-key.d.ts.map

package/dist/api-key/workflows/link-sales-channels-to-publishable-key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"link-sales-channels-to-publishable-key.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/link-sales-channels-to-publishable-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAO1D;;;;;;GAMG;AACH,MAAM,MAAM,sCAAsC,GAAG,iBAAiB,CAAA;AAEtE,eAAO,MAAM,mCAAmC,mCACd,CAAA;AAClC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,iCAAiC,4FAS7C,CAAA"}

package/dist/api-key/workflows/link-sales-channels-to-publishable-key.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.linkSalesChannelsToApiKeyWorkflow = exports.linkSalesChannelsToApiKeyWorkflowId = void 0;
+const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
+const steps_1 = require("../steps");
+exports.linkSalesChannelsToApiKeyWorkflowId = "link-sales-channels-to-api-key";
+/**
+ * This workflow manages the sales channels of a publishable API key. It's used by the
+ * [Manage Sales Channels API Route](https://docs.etohq.com/api/admin#api-keys_postapikeysidsaleschannels).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * manage the sales channels of a publishable API key within your custom flows.
+ *
+ * @example
+ * const { result } = await linkSalesChannelsToApiKeyWorkflow(container)
+ * .run({
+ *   input: {
+ *     id: "apk_132",
+ *     add: ["sc_123"],
+ *     remove: ["sc_321"]
+ *   }
+ * })
+ *
+ * @summary
+ * Manage the sales channels of a publishable API key.
+ */
+exports.linkSalesChannelsToApiKeyWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.linkSalesChannelsToApiKeyWorkflowId, (input) => {
+    (0, steps_1.validateSalesChannelsExistStep)({
+        sales_channel_ids: input.add ?? [],
+    });
+    (0, steps_1.linkSalesChannelsToApiKeyStep)(input);
+});
+//# sourceMappingURL=link-sales-channels-to-publishable-key.js.map

package/dist/api-key/workflows/link-sales-channels-to-publishable-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link-sales-channels-to-publishable-key.js","sourceRoot":"","sources":["../../../src/api-key/workflows/link-sales-channels-to-publishable-key.ts"],"names":[],"mappings":";;;AACA,kEAA6E;AAC7E,oCAGiB;AAWJ,QAAA,mCAAmC,GAC9C,gCAAgC,CAAA;AAClC;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,iCAAiC,GAAG,IAAA,8BAAc,EAC7D,2CAAmC,EACnC,CAAC,KAA2D,EAAE,EAAE;IAC9D,IAAA,sCAA8B,EAAC;QAC7B,iBAAiB,EAAE,KAAK,CAAC,GAAG,IAAI,EAAE;KACnC,CAAC,CAAA;IAEF,IAAA,qCAA6B,EAAC,KAAK,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}

package/dist/api-key/workflows/revoke-api-keys.d.ts

@@ -1,11 +1,47 @@
 import { ApiKeyDTO, FilterableApiKeyProps, RevokeApiKeyDTO } from "@etohq/framework/types";
+/**
+ * The data to revoke API keys.
+ */
 export type RevokeApiKeysWorkflowInput = {
+    /**
+     * The filters to select the API keys to revoke.
+     */
     selector: FilterableApiKeyProps;
+    /**
+     * The data to revoke the API keys.
+     */
     revoke: RevokeApiKeyDTO;
 };
+/**
+ * The revoked API keys.
+ */
+export type RevokeApiKeysWorkflowOutput = ApiKeyDTO[];
 export declare const revokeApiKeysWorkflowId = "revoke-api-keys";
 /**
- * This workflow revokes one or more API keys.
+ * This workflow revokes one or more API keys. If the API key is a secret,
+ * it can't be used for authentication anymore. If it's publishable, it can't be used by client applications.
+ *
+ * This workflow is used by the [Revoke API Key API Route](https://docs.etohq.com/api/admin#api-keys_postapikeysidrevoke).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * revoke API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await revokeApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     selector: {
+ *       id: "apk_123"
+ *     },
+ *     revoke: {
+ *       revoked_by: "user_123"
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Revoke secret or publishable API keys.
  */
-export declare const revokeApiKeysWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<RevokeApiKeysWorkflowInput, ApiKeyDTO[], []>;
+export declare const revokeApiKeysWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<RevokeApiKeysWorkflowInput, RevokeApiKeysWorkflowOutput, []>;
 //# sourceMappingURL=revoke-api-keys.d.ts.map

package/dist/api-key/workflows/revoke-api-keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"revoke-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/revoke-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,eAAe,EAChB,MAAM,wBAAwB,CAAA;AAQ/B,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,EAAE,qBAAqB,CAAA;IAC/B,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;GAEG;AACH,eAAO,MAAM,qBAAqB,sGAOjC,CAAA"}
+{"version":3,"file":"revoke-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/revoke-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,eAAe,EAChB,MAAM,wBAAwB,CAAA;AAQ/B;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,QAAQ,EAAE,qBAAqB,CAAA;IAC/B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,SAAS,EAAE,CAAA;AAErD,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,qBAAqB,sHAOjC,CAAA"}

package/dist/api-key/workflows/revoke-api-keys.js

@@ -5,7 +5,30 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const steps_1 = require("../steps");
 exports.revokeApiKeysWorkflowId = "revoke-api-keys";
 /**
- * This workflow revokes one or more API keys.
+ * This workflow revokes one or more API keys. If the API key is a secret,
+ * it can't be used for authentication anymore. If it's publishable, it can't be used by client applications.
+ *
+ * This workflow is used by the [Revoke API Key API Route](https://docs.etohq.com/api/admin#api-keys_postapikeysidrevoke).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * revoke API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await revokeApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     selector: {
+ *       id: "apk_123"
+ *     },
+ *     revoke: {
+ *       revoked_by: "user_123"
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Revoke secret or publishable API keys.
  */
 exports.revokeApiKeysWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.revokeApiKeysWorkflowId, (input) => {
     return new workflows_sdk_1.WorkflowResponse((0, steps_1.revokeApiKeysStep)(input));

package/dist/api-key/workflows/revoke-api-keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"revoke-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/revoke-api-keys.ts"],"names":[],"mappings":";;;AAKA,kEAIuC;AACvC,oCAA4C;AAO/B,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;GAEG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CACE,KAA+C,EAChB,EAAE;IACjC,OAAO,IAAI,gCAAgB,CAAC,IAAA,yBAAiB,EAAC,KAAK,CAAC,CAAC,CAAA;AACvD,CAAC,CACF,CAAA"}
+{"version":3,"file":"revoke-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/revoke-api-keys.ts"],"names":[],"mappings":";;;AAKA,kEAIuC;AACvC,oCAA4C;AAqB/B,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CACE,KAA+C,EACA,EAAE;IACjD,OAAO,IAAI,gCAAgB,CAAC,IAAA,yBAAiB,EAAC,KAAK,CAAC,CAAC,CAAA;AACvD,CAAC,CACF,CAAA"}

package/dist/api-key/workflows/update-api-keys.d.ts

@@ -1,11 +1,45 @@
 import { ApiKeyDTO, FilterableApiKeyProps, UpdateApiKeyDTO } from "@etohq/framework/types";
+/**
+ * The data to update API keys.
+ */
 export type UpdateApiKeysWorkflowInput = {
+    /**
+     * The filters to select the API keys to update.
+     */
     selector: FilterableApiKeyProps;
+    /**
+     * The data to update the API keys.
+     */
     update: UpdateApiKeyDTO;
 };
+/**
+ * The updated API keys.
+ */
+export type UpdateApiKeysWorkflowOutput = ApiKeyDTO[];
 export declare const updateApiKeysWorkflowId = "update-api-keys";
 /**
- * This workflow creates one or more API keys.
+ * This workflow updates one or more secret or publishable API keys. It's used by the
+ * [Update API Key Admin API Route](https://docs.etohq.com/api/admin#api-keys_postapikeysid).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * update API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await updateApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     selector: {
+ *       id: "apk_123"
+ *     },
+ *     update: {
+ *       title: "Storefront"
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Update secret or publishable API keys.
  */
-export declare const updateApiKeysWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<UpdateApiKeysWorkflowInput, ApiKeyDTO[], []>;
+export declare const updateApiKeysWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<UpdateApiKeysWorkflowInput, UpdateApiKeysWorkflowOutput, []>;
 //# sourceMappingURL=update-api-keys.d.ts.map

package/dist/api-key/workflows/update-api-keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"update-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/update-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,eAAe,EAChB,MAAM,wBAAwB,CAAA;AAQ/B,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,EAAE,qBAAqB,CAAA;IAC/B,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;GAEG;AACH,eAAO,MAAM,qBAAqB,sGAOjC,CAAA"}
+{"version":3,"file":"update-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/update-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,eAAe,EAChB,MAAM,wBAAwB,CAAA;AAQ/B;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,QAAQ,EAAE,qBAAqB,CAAA;IAC/B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,SAAS,EAAE,CAAA;AAErD,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,qBAAqB,sHAOjC,CAAA"}