@epilot/sdk 2.20.59 → 2.20.61

package/dist/{external-values.d-DjP9C_-r.d.ts → external-values.d-23q55J5P.d.ts}

@@ -13,6 +13,38 @@ declare namespace Components {
         HookId?: Parameters.HookId /* ^[a-zA-Z0-9_-]{1,100}$ */;
     }
     namespace Schemas {
+        /**
+         * Something a hook needs the consumer to supply in `context`, discriminated by `type`.
+         * Today only `entity`; more types will follow. Consumers ignore types they do not know.
+         *
+         */
+        export type ContextRequirement = /**
+         * Something a hook needs the consumer to supply in `context`, discriminated by `type`.
+         * Today only `entity`; more types will follow. Consumers ignore types they do not know.
+         *
+         */
+        /**
+         * The consumer supplies the bound entities of `schema` under `Context.<schema>`, e.g. a hook
+         * interpolating `{{ Context.contract[0].external_id }}` declares
+         * `{ type: entity, schema: contract }`.
+         *
+         */
+        EntityContextRequirement;
+        /**
+         * The consumer supplies the bound entities of `schema` under `Context.<schema>`, e.g. a hook
+         * interpolating `{{ Context.contract[0].external_id }}` declares
+         * `{ type: entity, schema: contract }`.
+         *
+         */
+        export interface EntityContextRequirement {
+            type: "entity";
+            /**
+             * Entity schema slug, e.g. `contract`.
+             * example:
+             * contract
+             */
+            schema: string;
+        }
         export interface ExternalValueError {
             /**
              * Set for per-result errors; absent for hook-level failures
@@ -48,6 +80,19 @@ declare namespace Components {
             name: TranslatedString;
             description?: TranslatedString;
             results: ExternalValueResultSummary[];
+            /**
+             * What the hook needs the consumer to supply in `context`, as declared in the hook
+             * config. Omitted when the hook declares none. A rule builder must require these
+             * contexts on any rule that uses the hook, so the caller passes them in `context`.
+             * More requirement types will follow; consumers ignore types they do not know.
+             *
+             */
+            contexts?: /**
+             * Something a hook needs the consumer to supply in `context`, discriminated by `type`.
+             * Today only `entity`; more types will follow. Consumers ignore types they do not know.
+             *
+             */
+            ContextRequirement[];
         }
         export interface ExternalValueResultSummary {
             id: string;
@@ -59,11 +104,13 @@ declare namespace Components {
          * 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",
@@ -75,11 +122,12 @@ declare namespace Components {
             /**
              * Everything the consumer supplies for interpolation, as one name → value map.
              * Exposed to the hook's Liquid templates as `Context` / `context`, e.g.
-             * `{{ context.input }}`, `{{ context.contract.installment_amount }}`.
+             * `{{ context.contract[0].external_id }}`.
              *
-             * The names are up to the consumer; this API does not interpret them. By
-             * convention the journey runtime passes the validated value of a validation
-             * rule as `input` and every configured context binding under its own name.
+             * One entry per context requirement the consumer bound (see
+             * `ExternalValueHookSummary.contexts`): for an `entity` requirement, the bound
+             * entities of that schema under its schema slug. This API gives no name special
+             * treatment.
              *
              */
             context: {
@@ -165,11 +213,13 @@ declare namespace Paths {
          * 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",
@@ -217,11 +267,13 @@ declare namespace Paths {
          * 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",
@@ -378,6 +430,8 @@ interface PathsDictionary {
 type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 
+type ContextRequirement = Components.Schemas.ContextRequirement;
+type EntityContextRequirement = Components.Schemas.EntityContextRequirement;
 type ExternalValueError = Components.Schemas.ExternalValueError;
 type ExternalValueErrorCode = Components.Schemas.ExternalValueErrorCode;
 type ExternalValueHookList = Components.Schemas.ExternalValueHookList;
@@ -388,4 +442,4 @@ type ResolveExternalValueRequest = Components.Schemas.ResolveExternalValueReques
 type ResolveExternalValueResponse = Components.Schemas.ResolveExternalValueResponse;
 type TranslatedString = Components.Schemas.TranslatedString;
 
-export { type Client as C, type ExternalValueError as E, type OperationMethods as O, Paths as P, type ResolveExternalValueRequest as R, type TranslatedString as T, Components as a, type PathsDictionary as b, type ExternalValueErrorCode as c, type ExternalValueHookList as d, type ExternalValueHookSummary as e, type ExternalValueResultSummary as f, type ExternalValueType as g, type ResolveExternalValueResponse as h };
+export { type Client as C, type EntityContextRequirement as E, type OperationMethods as O, Paths as P, type ResolveExternalValueRequest as R, type TranslatedString as T, Components as a, type PathsDictionary as b, type ContextRequirement as c, type ExternalValueError as d, type ExternalValueErrorCode as e, type ExternalValueHookList as f, type ExternalValueHookSummary as g, type ExternalValueResultSummary as h, type ExternalValueType as i, type ResolveExternalValueResponse as j };

package/dist/index.cjs

@@ -170,7 +170,7 @@ var _chunkWOUASZJWcjs = require('./chunk-WOUASZJW.cjs');
 
 
 
-var _chunkFPQK7U3Pcjs = require('./chunk-FPQK7U3P.cjs');
+var _chunk6LYUL3EYcjs = require('./chunk-6LYUL3EY.cjs');
 
 
 var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -244,7 +244,7 @@ var resolveClient = (params) => {
   }
   if (!entry.instance) {
     const definition = entry.loader();
-    entry.instance = _chunkFPQK7U3Pcjs.createApiClient.call(void 0, {
+    entry.instance = _chunk6LYUL3EYcjs.createApiClient.call(void 0, {
       definition,
       token: state.token,
       headers: state.globalHeaders,
@@ -277,7 +277,7 @@ var resetAllClients = (registry) => {
 };
 
 // src/apis/_registry.ts
-var expandDef = (mod) => _chunkFPQK7U3Pcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+var expandDef = (mod) => _chunk6LYUL3EYcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
@@ -640,9 +640,9 @@ var createSDK = () => {
       const available = [...registry.keys()].join(", ");
       throw new Error(`Unknown API: "${name}". Available: ${available}`);
     }
-    return _chunkFPQK7U3Pcjs.createApiHandle.call(void 0, {
+    return _chunk6LYUL3EYcjs.createApiHandle.call(void 0, {
       resolveClient: () => resolveClient({ registry, name, state }),
-      createClient: () => _chunkFPQK7U3Pcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
+      createClient: () => _chunk6LYUL3EYcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
       apiName: name
     });
   };
@@ -690,9 +690,9 @@ var createSDK = () => {
           return interceptorUse;
         }
         case "help":
-          return (apiName) => _chunkFPQK7U3Pcjs.help.call(void 0, apiName);
+          return (apiName) => _chunk6LYUL3EYcjs.help.call(void 0, apiName);
         case "openapi":
-          return (apiName) => _chunkFPQK7U3Pcjs.openapi.call(void 0, apiName);
+          return (apiName) => _chunk6LYUL3EYcjs.openapi.call(void 0, apiName);
         case "then":
         case "catch":
         case "finally":
@@ -722,4 +722,4 @@ var epilot = createSDK();
 
 
 
-exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkFPQK7U3Pcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkFPQK7U3Pcjs.help; exports.openapi = _chunkFPQK7U3Pcjs.openapi;
+exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunk6LYUL3EYcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunk6LYUL3EYcjs.help; exports.openapi = _chunk6LYUL3EYcjs.openapi;

package/dist/index.d.cts

@@ -7,7 +7,7 @@ import { C as Client } from './access-token.d-Yy-yrft_.cjs';
 import { C as Client$1 } from './address.d-CwAPOVxa.cjs';
 import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.cjs';
 import { C as Client$3 } from './ai-agents.d-B3TkP4mo.cjs';
-import { C as Client$4 } from './app.d-CqXqNLxq.cjs';
+import { C as Client$4 } from './app.d-DbOr4uIC.cjs';
 import { C as Client$5 } from './audit-logs.d-BRToFqeX.cjs';
 import { C as Client$6 } from './automation.d-B8g3nYp-.cjs';
 import { C as Client$7 } from './billing.d-DA3sViEF.cjs';
@@ -22,13 +22,13 @@ import { C as Client$f } from './data-governance.d-BbZ466j5.cjs';
 import { C as Client$g } from './deduplication.d-Cueh8bDD.cjs';
 import { C as Client$h } from './design.d-CYHbiaq_.cjs';
 import { C as Client$i } from './document.d-B0zC-R8x.cjs';
-import { C as Client$j } from './email-settings.d-DViLYaOl.cjs';
+import { C as Client$j } from './email-settings.d-DX_nzlZk.cjs';
 import { C as Client$k } from './email-template.d-gtQkdaXM.cjs';
 import { C as Client$l } from './entity.d-BwsBk0Po.cjs';
 import { C as Client$m } from './entity-mapping.d-8MtWa2_L.cjs';
 import { C as Client$n } from './environments.d-qL1urwAq.cjs';
 import { C as Client$o } from './event-catalog.d-BrAxYS9D.cjs';
-import { C as Client$p } from './external-values.d-DjP9C_-r.cjs';
+import { C as Client$p } from './external-values.d-23q55J5P.cjs';
 import { C as Client$q } from './file.d-DELNV63w.cjs';
 import { C as Client$r } from './iban.d-BwdiGbxi.cjs';
 import { C as Client$s } from './identity.d-BBL0NI_O.cjs';

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import { C as Client } from './access-token.d-Yy-yrft_.js';
 import { C as Client$1 } from './address.d-CwAPOVxa.js';
 import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.js';
 import { C as Client$3 } from './ai-agents.d-B3TkP4mo.js';
-import { C as Client$4 } from './app.d-CqXqNLxq.js';
+import { C as Client$4 } from './app.d-DbOr4uIC.js';
 import { C as Client$5 } from './audit-logs.d-BRToFqeX.js';
 import { C as Client$6 } from './automation.d-B8g3nYp-.js';
 import { C as Client$7 } from './billing.d-DA3sViEF.js';
@@ -22,13 +22,13 @@ import { C as Client$f } from './data-governance.d-BbZ466j5.js';
 import { C as Client$g } from './deduplication.d-Cueh8bDD.js';
 import { C as Client$h } from './design.d-CYHbiaq_.js';
 import { C as Client$i } from './document.d-B0zC-R8x.js';
-import { C as Client$j } from './email-settings.d-DViLYaOl.js';
+import { C as Client$j } from './email-settings.d-DX_nzlZk.js';
 import { C as Client$k } from './email-template.d-gtQkdaXM.js';
 import { C as Client$l } from './entity.d-BwsBk0Po.js';
 import { C as Client$m } from './entity-mapping.d-8MtWa2_L.js';
 import { C as Client$n } from './environments.d-qL1urwAq.js';
 import { C as Client$o } from './event-catalog.d-BrAxYS9D.js';
-import { C as Client$p } from './external-values.d-DjP9C_-r.js';
+import { C as Client$p } from './external-values.d-23q55J5P.js';
 import { C as Client$q } from './file.d-DELNV63w.js';
 import { C as Client$r } from './iban.d-BwdiGbxi.js';
 import { C as Client$s } from './identity.d-BBL0NI_O.js';

package/dist/index.js

@@ -170,7 +170,7 @@ import {
   expand,
   help,
   openapi
-} from "./chunk-WPDKRU5K.js";
+} from "./chunk-OEDN6Y5U.js";
 import {
   __require
 } from "./chunk-YPSWSI3M.js";

package/docs/app.md

@@ -136,6 +136,8 @@ const { data } = await appClient.getPublicFacingComponent(...)
 - [`ApiProxyConfig`](#apiproxyconfig)
 - [`ExternalValuesConfig`](#externalvaluesconfig)
 - [`ExternalValuesHook`](#externalvalueshook)
+- [`ContextRequirement`](#contextrequirement)
+- [`EntityContextRequirement`](#entitycontextrequirement)
 - [`ExternalValuesResult`](#externalvaluesresult)
 - [`Grants`](#grants)
 - [`BlueprintRef`](#blueprintref)
@@ -2268,6 +2270,7 @@ type ExternalValuesComponent = {
       result: { ... }
       timeout_ms?: { ... }
       on_unavailable?: { ... }
+      contexts?: { ... }
       cache?: { ... }
       secure_proxy?: { ... }
     }>
@@ -3793,6 +3796,10 @@ type ExternalValuesConfig = {
     }>
     timeout_ms?: number
     on_unavailable?: "skip" | "block"
+    contexts?: Array<{
+      type: { ... }
+      schema: { ... }
+    }>
     cache?: {
       ttl_seconds: { ... }
       key?: { ... }
@@ -3807,8 +3814,9 @@ type ExternalValuesConfig = {
 
 ### `ExternalValuesHook`
 
-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`.
+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 }}`).
 
+`Context` is the name → v
 
 ```ts
 type ExternalValuesHook = {
@@ -3855,6 +3863,10 @@ type ExternalValuesHook = {
   }>
   timeout_ms?: number
   on_unavailable?: "skip" | "block"
+  contexts?: Array<{
+    type: "entity"
+    schema: string
+  }>
   cache?: {
     ttl_seconds: number
     key?: string
@@ -3866,6 +3878,28 @@ type ExternalValuesHook = {
 }
 ```
 
+### `ContextRequirement`
+
+A requirement a hook reads from `Context`, discriminated by `type`. More types will be added later; consumers must ignore types they do not know.
+
+```ts
+type ContextRequirement = {
+  type: "entity"
+  schema: string
+}
+```
+
+### `EntityContextRequirement`
+
+The consumer supplies the bound entities of `schema` under `Context.`<schema>``.
+
+```ts
+type EntityContextRequirement = {
+  type: "entity"
+  schema: string
+}
+```
+
 ### `ExternalValuesResult`
 
 A single typed value extracted from the hook response. Exactly one of `template`, `path` or `jsonata` must be set.

package/docs/email-settings.md

@@ -1801,7 +1801,7 @@ type ConnectOutlookRequest = {
 type MailboxSyncStatus = {
   execution_id: string
   status: "RUNNING" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "FAILED" | "CANCELLED"
-  timeframe: "5m" | "1w" | "2w" | "1m"
+  timeframe: "5m" | "1w" | "2w" | "1m" | "3m" | "6m" | "1y"
   started_at: string // date-time
   completed_at?: string // date-time
   inbox?: {
@@ -1834,7 +1834,7 @@ type MailboxSyncFolderStatuses = "PENDING" | "RUNNING" | "COMPLETED" | "FAILED"
 ### `MailboxSyncTimeframePeriods`
 
 ```ts
-type MailboxSyncTimeframePeriods = "5m" | "1w" | "2w" | "1m"
+type MailboxSyncTimeframePeriods = "5m" | "1w" | "2w" | "1m" | "3m" | "6m" | "1y"
 ```
 
 ### `InboxBucketResponse`

package/docs/external-values.md

@@ -38,6 +38,8 @@ const { data } = await externalValuesClient.listExternalValues(...)
 - [`ResolveExternalValueResponse`](#resolveexternalvalueresponse)
 - [`ExternalValueResultSummary`](#externalvalueresultsummary)
 - [`ExternalValueHookSummary`](#externalvaluehooksummary)
+- [`ContextRequirement`](#contextrequirement)
+- [`EntityContextRequirement`](#entitycontextrequirement)
 - [`ExternalValueHookList`](#externalvaluehooklist)
 
 ### `listExternalValues`
@@ -78,6 +80,12 @@ const { data } = await client.listExternalValues()
             "en": "string"
           }
         }
+      ],
+      "contexts": [
+        {
+          "type": "entity",
+          "schema": "contract"
+        }
       ]
     }
   ]
@@ -103,11 +111,13 @@ const { data } = await client.resolveExternalValue(
   },
   {
     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',
@@ -157,11 +167,13 @@ const { data } = await client.resolvePortalExternalValue(
   },
   {
     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',
@@ -301,6 +313,37 @@ type ExternalValueHookSummary = {
       en?: { ... }
     }
   }>
+  contexts?: Array<{
+    type: "entity"
+    schema: string
+  }>
+}
+```
+
+### `ContextRequirement`
+
+Something a hook needs the consumer to supply in `context`, discriminated by `type`.
+Today only `entity`; more types will follow. Consumers ignore types they do not know.
+
+
+```ts
+type ContextRequirement = {
+  type: "entity"
+  schema: string
+}
+```
+
+### `EntityContextRequirement`
+
+The consumer supplies the bound entities of `schema` under `Context.`<schema>``, e.g. a hook
+interpolating `{{ Context.contract[0].external_id }}` declares
+`{ type: entity, schema: contract }`.
+
+
+```ts
+type EntityContextRequirement = {
+  type: "entity"
+  schema: string
 }
 ```
 
@@ -325,6 +368,10 @@ type ExternalValueHookList = {
       type: { ... }
       name: { ... }
     }>
+    contexts?: Array<{
+      type: { ... }
+      schema: { ... }
+    }>
   }>
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.59",
+  "version": "2.20.61",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",