@epilot/sdk 2.20.59 → 2.20.60

package/definitions/app.json

@@ -67,6 +67,7 @@
         "summary": "getPublicFacingComponent",
         "description": "Retrieve public facing components for an installed app",
         "operationId": "getPublicFacingComponent",
+        "x-epilot-permissions": [],
         "tags": [
           "App Installation"
         ],
@@ -97,6 +98,11 @@
         "summary": "listConfigurations",
         "description": "List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.",
         "operationId": "listConfigurations",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:read"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -159,6 +165,11 @@
         "summary": "createConfiguration",
         "description": "Create a new private app configuration. To make it public a verification process needs to be triggered",
         "operationId": "createConfiguration",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -192,6 +203,11 @@
         "summary": "listPublicConfigurations",
         "description": "List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.",
         "operationId": "listPublicConfigurations",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:read"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -267,6 +283,11 @@
         "summary": "getPublicConfiguration",
         "description": "Retrieve the public configuration of an app to install in your tenant",
         "operationId": "getPublicConfiguration",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:read"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -313,6 +334,11 @@
         "summary": "getConfiguration",
         "description": "Retrieve a specific app configuration",
         "operationId": "getConfiguration",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:read"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -346,6 +372,11 @@
         "summary": "patchMetadata",
         "description": "Patch non-versioned configuration metadata of a given app configuration.",
         "operationId": "patchMetadata",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -365,6 +396,11 @@
         "summary": "Delete app configuration",
         "description": "Delete an app configuration and all its versions and components.",
         "operationId": "deleteConfiguration",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -383,6 +419,11 @@
         "summary": "queryEvents",
         "description": "Query analytics events for a specific app with flexible filtering",
         "operationId": "queryEvents",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:read"
+          }
+        ],
         "tags": [
           "App Analytics"
         ],
@@ -432,6 +473,11 @@
         "summary": "createBundleUploadUrl",
         "description": "Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path",
         "operationId": "createBundleUploadUrl",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -495,6 +541,11 @@
       "post": {
         "summary": "createZipUploadUrl",
         "operationId": "createZipUploadUrl",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "description": "Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path\n",
         "tags": [
           "App Configuration"
@@ -595,6 +646,11 @@
         "summary": "createLogoUploadUrl",
         "description": "Generate a presigned URL for uploading app logo to /<app-id>/logo.png path",
         "operationId": "createLogoUploadUrl",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -638,6 +694,11 @@
         "summary": "deleteLogo",
         "description": "Delete the app logo from /<app-id>/logo.png path",
         "operationId": "deleteLogo",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -656,6 +717,11 @@
         "summary": "listVersions",
         "description": "Retrieve a list of versions for an app configuration",
         "operationId": "listVersions",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:read"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -732,6 +798,11 @@
         "summary": "getVersion",
         "description": "Retrieve a specific version of an app configuration",
         "operationId": "getVersion",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:read"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -775,6 +846,11 @@
         "summary": "deleteVersion",
         "description": "Delete a specific version of an app configuration",
         "operationId": "deleteVersion",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -817,6 +893,11 @@
         "summary": "patchVersion",
         "description": "Patch an existing app version",
         "operationId": "patchVersion",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -861,6 +942,11 @@
         "summary": "getReview",
         "description": "Retrieve the review status of a specific app version",
         "operationId": "getReview",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:read"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -909,6 +995,11 @@
         "summary": "createReview",
         "description": "Submit an app version for review to make it public",
         "operationId": "createReview",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -965,6 +1056,11 @@
         "summary": "createComponent",
         "description": "Patch an existing app version to create/add a component",
         "operationId": "createComponent",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -1021,6 +1117,11 @@
         "summary": "patchComponent",
         "description": "Patch an existing app version to update its components",
         "operationId": "patchComponent",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -1072,6 +1173,11 @@
         "summary": "deleteComponent",
         "description": "Delete a specific component from an app version",
         "operationId": "deleteComponent",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -1119,6 +1225,11 @@
         "summary": "cloneVersion",
         "description": "Clone an existing app version to create a new version",
         "operationId": "cloneVersion",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Configuration"
         ],
@@ -1194,6 +1305,11 @@
         "summary": "listInstallations",
         "description": "Retrieve a list of installed apps for the organization.",
         "operationId": "listInstallations",
+        "x-epilot-permissions": [
+          {
+            "action": "app:view"
+          }
+        ],
         "tags": [
           "App Installation"
         ],
@@ -1275,6 +1391,11 @@
         "summary": "getInstallation",
         "description": "Retrieve details of an installed app by its ID.",
         "operationId": "getInstallation",
+        "x-epilot-permissions": [
+          {
+            "action": "app:view"
+          }
+        ],
         "tags": [
           "App Installation"
         ],
@@ -1308,6 +1429,11 @@
         "summary": "install",
         "description": "Upsert app installation by its ID.",
         "operationId": "install",
+        "x-epilot-permissions": [
+          {
+            "action": "app:install"
+          }
+        ],
         "tags": [
           "App Installation"
         ],
@@ -1344,6 +1470,11 @@
         "summary": "patchInstallation",
         "description": "Patch an installed app by its ID.",
         "operationId": "patchInstallation",
+        "x-epilot-permissions": [
+          {
+            "action": "app:install"
+          }
+        ],
         "tags": [
           "App Installation"
         ],
@@ -1364,8 +1495,11 @@
           "204": {
             "description": "App installation patched successfully."
           },
+          "400": {
+            "description": "The requested `version` is not available to the requesting organization (`code: VERSION_NOT_VISIBLE`; `details.latest_visible_version` names the newest version it can install). Pass `version: latest` to take that version instead."
+          },
           "404": {
-            "description": "App not found."
+            "description": "App installation not found."
           }
         }
       },
@@ -1373,6 +1507,11 @@
         "summary": "uninstall",
         "description": "Uninstall an app by its ID.",
         "operationId": "uninstall",
+        "x-epilot-permissions": [
+          {
+            "action": "app:uninstall"
+          }
+        ],
         "tags": [
           "App Installation"
         ],
@@ -1401,6 +1540,11 @@
         "summary": "promoteVersion",
         "description": "Update an installed app to a new version",
         "operationId": "promoteVersion",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "tags": [
           "App Installation"
         ],
@@ -1447,6 +1591,7 @@
         "summary": "resolveOptions",
         "description": "Resolve the effective app-level options of an installation, including decrypted sensitive values (secrets). This endpoint accepts epilot internal-auth tokens exclusively (internal service calls, e.g. automation-workers or the customer portal API) — no user token, API key, or app token can call it, regardless of roles. Every call is audit-logged with the caller identity.",
         "operationId": "resolveOptions",
+        "x-epilot-permissions": [],
         "tags": [
           "App Installation"
         ],
@@ -1510,6 +1655,11 @@
       "post": {
         "summary": "ingestEvent",
         "operationId": "ingestEvent",
+        "x-epilot-permissions": [
+          {
+            "action": "app:config:write"
+          }
+        ],
         "description": "Internal endpoint for services to submit app events for analytic purposes",
         "tags": [
           "App Analytics"
@@ -1586,6 +1736,7 @@
       "get": {
         "summary": "publicProxyGet",
         "operationId": "publicProxyGet",
+        "x-epilot-permissions": [],
         "description": "Forward a GET request to a registered proxy target from a public-facing component (e.g. journey blocks)",
         "tags": [
           "App Proxy"
@@ -1613,6 +1764,7 @@
       "post": {
         "summary": "publicProxyPost",
         "operationId": "publicProxyPost",
+        "x-epilot-permissions": [],
         "description": "Forward a POST request to a registered proxy target from a public-facing component (e.g. journey blocks)",
         "tags": [
           "App Proxy"
@@ -1649,6 +1801,7 @@
       "put": {
         "summary": "publicProxyPut",
         "operationId": "publicProxyPut",
+        "x-epilot-permissions": [],
         "description": "Forward a PUT request to a registered proxy target from a public-facing component",
         "tags": [
           "App Proxy"
@@ -1685,6 +1838,7 @@
       "patch": {
         "summary": "publicProxyPatch",
         "operationId": "publicProxyPatch",
+        "x-epilot-permissions": [],
         "description": "Forward a PATCH request to a registered proxy target from a public-facing component",
         "tags": [
           "App Proxy"
@@ -1721,6 +1875,7 @@
       "delete": {
         "summary": "publicProxyDelete",
         "operationId": "publicProxyDelete",
+        "x-epilot-permissions": [],
         "description": "Forward a DELETE request to a registered proxy target from a public-facing component",
         "tags": [
           "App Proxy"
@@ -5154,7 +5309,7 @@
       },
       "ExternalValuesHook": {
         "type": "object",
-        "description": "One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Input`, `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse`.\n",
+        "description": "One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.contract }}`).\n\n`Context` is the name → value map the consumer supplies, one entry per context requirement it bound. Declare what a hook reads from `Context` in `contexts` so consumers can require it.\n",
         "required": [
           "id",
           "name",
@@ -5233,7 +5388,7 @@
               },
               "body": {
                 "type": "object",
-                "description": "JSON body to send. Values support variable interpolation. When omitted, `{ Input, Context, Consumer }` is sent as-is.",
+                "description": "JSON body to send. Values support variable interpolation. When omitted, `{ Context, Consumer }` is sent as-is.",
                 "additionalProperties": true
               }
             }
@@ -5262,6 +5417,13 @@
             "default": "skip",
             "description": "Behaviour when the external system is unavailable (timeout, network or upstream error). `skip`: consumers ignore conditions depending on this hook. `block`: consumers treat the dependent action as not allowed."
           },
+          "contexts": {
+            "type": "array",
+            "description": "The requirements the hook reads from `Context` (at most 10). An `entity` requirement means the consumer supplies the bound entities of that schema under `Context.<schema>` (e.g. `{{ Context.contract[0].external_id }}` needs `{ type: entity, schema: contract }`). More requirement types will be added later; consumers must ignore types they do not know.",
+            "items": {
+              "$ref": "#/components/schemas/ContextRequirement"
+            }
+          },
           "cache": {
             "type": "object",
             "description": "Response caching. Off when omitted.",
@@ -5277,7 +5439,7 @@
               },
               "key": {
                 "type": "string",
-                "description": "Liquid template for the cache key. Defaults to a hash of org, app, hook, `Input` and `Context`."
+                "description": "Liquid template for the cache key. Defaults to a hash of org, app, hook and `Context`."
               }
             }
           },
@@ -5286,6 +5448,42 @@
           }
         }
       },
+      "ContextRequirement": {
+        "description": "A requirement a hook reads from `Context`, discriminated by `type`. More types will be added later; consumers must ignore types they do not know.",
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/EntityContextRequirement"
+          }
+        ],
+        "discriminator": {
+          "propertyName": "type",
+          "mapping": {
+            "entity": "#/components/schemas/EntityContextRequirement"
+          }
+        }
+      },
+      "EntityContextRequirement": {
+        "type": "object",
+        "description": "The consumer supplies the bound entities of `schema` under `Context.<schema>`.",
+        "required": [
+          "type",
+          "schema"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "entity"
+            ]
+          },
+          "schema": {
+            "type": "string",
+            "pattern": "^[a-z0-9_-]{1,100}$",
+            "description": "Entity schema slug, e.g. `contract`.",
+            "example": "contract"
+          }
+        }
+      },
       "ExternalValuesResult": {
         "type": "object",
         "description": "A single typed value extracted from the hook response. Exactly one of `template`, `path` or `jsonata` must be set.\n",
@@ -5325,7 +5523,7 @@
           },
           "jsonata": {
             "type": "string",
-            "description": "JSONata expression over `{ Response, Input, Context, Options, Env }`.",
+            "description": "JSONata expression over `{ Response, Context, Options, Env }`.",
             "example": "$sum(Response.items.amount)"
           }
         }

package/definitions/external-values.json

@@ -241,7 +241,7 @@
         "properties": {
           "context": {
             "type": "object",
-            "description": "Everything the consumer supplies for interpolation, as one name → value map.\nExposed to the hook's Liquid templates as `Context` / `context`, e.g.\n`{{ context.input }}`, `{{ context.contract.installment_amount }}`.\n\nThe names are up to the consumer; this API does not interpret them. By\nconvention the journey runtime passes the validated value of a validation\nrule as `input` and every configured context binding under its own name.\n",
+            "description": "Everything the consumer supplies for interpolation, as one name → value map.\nExposed to the hook's Liquid templates as `Context` / `context`, e.g.\n`{{ context.contract[0].external_id }}`.\n\nOne entry per context requirement the consumer bound (see\n`ExternalValueHookSummary.contexts`): for an `entity` requirement, the bound\nentities of that schema under its schema slug. This API gives no name special\ntreatment.\n",
             "additionalProperties": true
           },
           "consumer": {
@@ -264,11 +264,13 @@
         },
         "example": {
           "context": {
-            "input": "123,45",
-            "contract": {
-              "_id": "8a7e3f5e-9c0c-4c74-8d4a-1a1a1a1a1a1a",
-              "installment_amount": 110
-            }
+            "contract": [
+              {
+                "_id": "8a7e3f5e-9c0c-4c74-8d4a-1a1a1a1a1a1a",
+                "external_id": "C-1001",
+                "installment_amount": 110
+              }
+            ]
           },
           "consumer": {
             "type": "validation_rule",
@@ -423,6 +425,48 @@
             "items": {
               "$ref": "#/components/schemas/ExternalValueResultSummary"
             }
+          },
+          "contexts": {
+            "type": "array",
+            "description": "What the hook needs the consumer to supply in `context`, as declared in the hook\nconfig. Omitted when the hook declares none. A rule builder must require these\ncontexts on any rule that uses the hook, so the caller passes them in `context`.\nMore requirement types will follow; consumers ignore types they do not know.\n",
+            "items": {
+              "$ref": "#/components/schemas/ContextRequirement"
+            }
+          }
+        }
+      },
+      "ContextRequirement": {
+        "description": "Something a hook needs the consumer to supply in `context`, discriminated by `type`.\nToday only `entity`; more types will follow. Consumers ignore types they do not know.\n",
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/EntityContextRequirement"
+          }
+        ],
+        "discriminator": {
+          "propertyName": "type",
+          "mapping": {
+            "entity": "#/components/schemas/EntityContextRequirement"
+          }
+        }
+      },
+      "EntityContextRequirement": {
+        "type": "object",
+        "description": "The consumer supplies the bound entities of `schema` under `Context.<schema>`, e.g. a hook\ninterpolating `{{ Context.contract[0].external_id }}` declares\n`{ type: entity, schema: contract }`.\n",
+        "required": [
+          "type",
+          "schema"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "entity"
+            ]
+          },
+          "schema": {
+            "type": "string",
+            "description": "Entity schema slug, e.g. `contract`.",
+            "example": "contract"
           }
         }
       },

package/dist/apis/access-token.cjs

@@ -6,7 +6,7 @@ var _chunkZMBA3WV4cjs = require('../chunk-ZMBA3WV4.cjs');
 
 
 
-var _chunkFPQK7U3Pcjs = require('../chunk-FPQK7U3P.cjs');
+var _chunkRBSTI4X4cjs = require('../chunk-RBSTI4X4.cjs');
 require('../chunk-NJK5F5TF.cjs');
 
 // src/apis/access-token.ts
@@ -14,7 +14,7 @@ var _definition = null;
 var loadDefinition = () => {
   if (!_definition) {
     const mod = _chunkZMBA3WV4cjs.require_access_token_runtime.call(void 0, );
-    _definition = _chunkFPQK7U3Pcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+    _definition = _chunkRBSTI4X4cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
   }
   return _definition;
 };
@@ -22,13 +22,13 @@ var _instance = null;
 var resolve = () => {
   if (!_instance) {
     const def = loadDefinition();
-    _instance = _chunkFPQK7U3Pcjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
+    _instance = _chunkRBSTI4X4cjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
   }
   return _instance;
 };
-var _handle = _chunkFPQK7U3Pcjs.createApiHandle.call(void 0, {
+var _handle = _chunkRBSTI4X4cjs.createApiHandle.call(void 0, {
   resolveClient: resolve,
-  createClient: () => _chunkFPQK7U3Pcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
+  createClient: () => _chunkRBSTI4X4cjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
   apiName: "accessToken"
 });
 var getClient = _handle.getClient;
@@ -39,4 +39,4 @@ var accessToken = _handle;
 
 
 
-exports.accessToken = accessToken; exports.authorize = _chunkFPQK7U3Pcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
+exports.accessToken = accessToken; exports.authorize = _chunkRBSTI4X4cjs.authorize; exports.createClient = createClient; exports.getClient = getClient;

package/dist/apis/access-token.js

@@ -6,7 +6,7 @@ import {
   createApiClient,
   createApiHandle,
   expand
-} from "../chunk-WPDKRU5K.js";
+} from "../chunk-4MDOL6ZZ.js";
 import "../chunk-YPSWSI3M.js";
 
 // src/apis/access-token.ts

package/dist/apis/address-suggestions.cjs

@@ -6,7 +6,7 @@ var _chunkLKRBFBFNcjs = require('../chunk-LKRBFBFN.cjs');
 
 
 
-var _chunkFPQK7U3Pcjs = require('../chunk-FPQK7U3P.cjs');
+var _chunkRBSTI4X4cjs = require('../chunk-RBSTI4X4.cjs');
 require('../chunk-NJK5F5TF.cjs');
 
 // src/apis/address-suggestions.ts
@@ -14,7 +14,7 @@ var _definition = null;
 var loadDefinition = () => {
   if (!_definition) {
     const mod = _chunkLKRBFBFNcjs.require_address_suggestions_runtime.call(void 0, );
-    _definition = _chunkFPQK7U3Pcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+    _definition = _chunkRBSTI4X4cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
   }
   return _definition;
 };
@@ -22,13 +22,13 @@ var _instance = null;
 var resolve = () => {
   if (!_instance) {
     const def = loadDefinition();
-    _instance = _chunkFPQK7U3Pcjs.createApiClient.call(void 0, { definition: def, apiName: "addressSuggestions" });
+    _instance = _chunkRBSTI4X4cjs.createApiClient.call(void 0, { definition: def, apiName: "addressSuggestions" });
   }
   return _instance;
 };
-var _handle = _chunkFPQK7U3Pcjs.createApiHandle.call(void 0, {
+var _handle = _chunkRBSTI4X4cjs.createApiHandle.call(void 0, {
   resolveClient: resolve,
-  createClient: () => _chunkFPQK7U3Pcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "addressSuggestions" }),
+  createClient: () => _chunkRBSTI4X4cjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "addressSuggestions" }),
   apiName: "addressSuggestions"
 });
 var getClient = _handle.getClient;
@@ -39,4 +39,4 @@ var addressSuggestions = _handle;
 
 
 
-exports.addressSuggestions = addressSuggestions; exports.authorize = _chunkFPQK7U3Pcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
+exports.addressSuggestions = addressSuggestions; exports.authorize = _chunkRBSTI4X4cjs.authorize; exports.createClient = createClient; exports.getClient = getClient;

package/dist/apis/address-suggestions.js

@@ -6,7 +6,7 @@ import {
   createApiClient,
   createApiHandle,
   expand
-} from "../chunk-WPDKRU5K.js";
+} from "../chunk-4MDOL6ZZ.js";
 import "../chunk-YPSWSI3M.js";
 
 // src/apis/address-suggestions.ts