@epilot/sdk 2.20.69 → 2.20.71

package/dist/identity-JDTGYAOV.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/identity.json
+var identity_default = '# Identity API\n\n- **Base URL:** `https://id.epilot.cloud`\n- **Full API Docs:** [https://docs.epilot.io/api/identity](https://docs.epilot.io/api/identity)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.identity.listClients(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/identity\'\n\nconst identityClient = getClient()\nauthorize(identityClient, () => \'<token>\')\nconst { data } = await identityClient.listClients(...)\n```\n\n## Operations\n\n**Operator Clients**\n- [`listClients`](#listclients)\n- [`createOidcClient`](#createoidcclient)\n- [`getOidcClient`](#getoidcclient)\n- [`updateClient`](#updateclient)\n- [`retireClient`](#retireclient)\n- [`activateClient`](#activateclient)\n- [`suspendClient`](#suspendclient)\n- [`rotateClientSecret`](#rotateclientsecret)\n\n**Operator Organizations**\n- [`listClientOrganizations`](#listclientorganizations)\n- [`enableClientOrganization`](#enableclientorganization)\n- [`getClientOrganization`](#getclientorganization)\n- [`updateClientOrganization`](#updateclientorganization)\n- [`revokeClientOrganization`](#revokeclientorganization)\n- [`suspendClientOrganization`](#suspendclientorganization)\n- [`activateClientOrganization`](#activateclientorganization)\n- [`getUserSubject`](#getusersubject)\n\n**Session**\n- [`createIdentitySession`](#createidentitysession)\n- [`deleteIdentitySession`](#deleteidentitysession)\n\n**Launch**\n- [`launchClient`](#launchclient)\n\n**Schemas**\n- [`Error`](#error)\n- [`PartnerClientId`](#partnerclientid)\n- [`OrgId`](#orgid)\n- [`UserId`](#userid)\n- [`Environment`](#environment)\n- [`PartnerClientStatus`](#partnerclientstatus)\n- [`Scope`](#scope)\n- [`HttpsUri`](#httpsuri)\n- [`PartnerClientCreate`](#partnerclientcreate)\n- [`PartnerClientUpdate`](#partnerclientupdate)\n- [`PartnerClient`](#partnerclient)\n- [`PartnerClientWithSecret`](#partnerclientwithsecret)\n- [`PartnerClientList`](#partnerclientlist)\n- [`StatusChangeRequest`](#statuschangerequest)\n- [`RotateSecretRequest`](#rotatesecretrequest)\n- [`AuthorizationPolicyInput`](#authorizationpolicyinput)\n- [`AuthorizationPolicy`](#authorizationpolicy)\n- [`OrgEnablementStatus`](#orgenablementstatus)\n- [`OrgEnablementCreate`](#orgenablementcreate)\n- [`OrgEnablementUpdate`](#orgenablementupdate)\n- [`OrgEnablement`](#orgenablement)\n- [`OrgEnablementList`](#orgenablementlist)\n- [`IdentitySession`](#identitysession)\n- [`UserSubject`](#usersubject)\n\n### `listClients`\n\nList registered partner clients. The client secret is never returned.\n\n`GET /v1/identity/operator/clients`\n\n```ts\nconst { data } = await client.listClients({\n  partner_key: \'example\',\n  status: \'example\',\n  size: 1,\n  cursor: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "client_id": "bf-prod-x7k2",\n      "partner_key": "string",\n      "display_name": "string",\n      "description": "string",\n      "environment": "dev",\n      "redirect_uris": ["https://partner.example.com/auth/callback"],\n      "sector_identifier_uri": "https://partner.example.com/auth/callback",\n      "initiate_login_uri": "https://partner.example.com/auth/callback",\n      "launch_target_prefixes": ["string"],\n      "token_endpoint_auth_method": "client_secret_basic",\n      "grant_types": ["authorization_code"],\n      "scopes_allowed": ["openid"],\n      "status": "draft",\n      "status_reason": "string",\n      "config_version": 1,\n      "secret_rotated_at": "1970-01-01T00:00:00.000Z",\n      "previous_secret_expires_at": "1970-01-01T00:00:00.000Z",\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "updated_at": "1970-01-01T00:00:00.000Z",\n      "created_by": "string",\n      "updated_by": "string"\n    }\n  ],\n  "next_cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `createOidcClient`\n\nCreate a partner client in `draft` status. The client secret is returned exactly once in this\nresponse and can never be read again; use `rotateClientSecret` to obtain a new one.\n\n`POST /v1/identity/operator/clients`\n\n```ts\nconst { data } = await client.createOidcClient(\n  null,\n  {\n    partner_key: \'babelforce\',\n    display_name: \'Babelforce\',\n    description: \'string\',\n    environment: \'dev\',\n    redirect_uris: [\'https://partner.example.com/auth/callback\'],\n    sector_identifier_uri: \'https://partner.example.com/auth/callback\',\n    initiate_login_uri: \'https://partner.example.com/auth/callback\',\n    launch_target_prefixes: [\'string\'],\n    scopes_allowed: [\'openid\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "partner_key": "string",\n  "display_name": "string",\n  "description": "string",\n  "environment": "dev",\n  "redirect_uris": ["https://partner.example.com/auth/callback"],\n  "sector_identifier_uri": "https://partner.example.com/auth/callback",\n  "initiate_login_uri": "https://partner.example.com/auth/callback",\n  "launch_target_prefixes": ["string"],\n  "token_endpoint_auth_method": "client_secret_basic",\n  "grant_types": ["authorization_code"],\n  "scopes_allowed": ["openid"],\n  "status": "draft",\n  "status_reason": "string",\n  "config_version": 1,\n  "secret_rotated_at": "1970-01-01T00:00:00.000Z",\n  "previous_secret_expires_at": "1970-01-01T00:00:00.000Z",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string",\n  "client_secret": "string"\n}\n```\n\n</details>\n\n---\n\n### `getOidcClient`\n\nRead a partner client. The client secret is never returned.\n\n`GET /v1/identity/operator/clients/{client_id}`\n\n```ts\nconst { data } = await client.getOidcClient({\n  client_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "partner_key": "string",\n  "display_name": "string",\n  "description": "string",\n  "environment": "dev",\n  "redirect_uris": ["https://partner.example.com/auth/callback"],\n  "sector_identifier_uri": "https://partner.example.com/auth/callback",\n  "initiate_login_uri": "https://partner.example.com/auth/callback",\n  "launch_target_prefixes": ["string"],\n  "token_endpoint_auth_method": "client_secret_basic",\n  "grant_types": ["authorization_code"],\n  "scopes_allowed": ["openid"],\n  "status": "draft",\n  "status_reason": "string",\n  "config_version": 1,\n  "secret_rotated_at": "1970-01-01T00:00:00.000Z",\n  "previous_secret_expires_at": "1970-01-01T00:00:00.000Z",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateClient`\n\nReplace the mutable configuration of a client. `config_version` must equal the current\nversion (compare-and-swap); a mismatch is rejected with `409`.\n\n`PUT /v1/identity/operator/clients/{client_id}`\n\n```ts\nconst { data } = await client.updateClient(\n  {\n    client_id: \'example\',\n  },\n  {\n    config_version: 1,\n    allow_sector_change: false,\n    display_name: \'string\',\n    description: \'string\',\n    redirect_uris: [\'https://partner.example.com/auth/callback\'],\n    sector_identifier_uri: \'https://partner.example.com/auth/callback\',\n    initiate_login_uri: \'https://partner.example.com/auth/callback\',\n    launch_target_prefixes: [\'string\'],\n    scopes_allowed: [\'openid\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "partner_key": "string",\n  "display_name": "string",\n  "description": "string",\n  "environment": "dev",\n  "redirect_uris": ["https://partner.example.com/auth/callback"],\n  "sector_identifier_uri": "https://partner.example.com/auth/callback",\n  "initiate_login_uri": "https://partner.example.com/auth/callback",\n  "launch_target_prefixes": ["string"],\n  "token_endpoint_auth_method": "client_secret_basic",\n  "grant_types": ["authorization_code"],\n  "scopes_allowed": ["openid"],\n  "status": "draft",\n  "status_reason": "string",\n  "config_version": 1,\n  "secret_rotated_at": "1970-01-01T00:00:00.000Z",\n  "previous_secret_expires_at": "1970-01-01T00:00:00.000Z",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `retireClient`\n\nRetire a client. The record is kept as a tombstone, the `client_id` is never reused, every\norganization enablement is revoked and all provider-side artefacts are revoked.\n\n`DELETE /v1/identity/operator/clients/{client_id}`\n\n```ts\nconst { data } = await client.retireClient({\n  client_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "partner_key": "string",\n  "display_name": "string",\n  "description": "string",\n  "environment": "dev",\n  "redirect_uris": ["https://partner.example.com/auth/callback"],\n  "sector_identifier_uri": "https://partner.example.com/auth/callback",\n  "initiate_login_uri": "https://partner.example.com/auth/callback",\n  "launch_target_prefixes": ["string"],\n  "token_endpoint_auth_method": "client_secret_basic",\n  "grant_types": ["authorization_code"],\n  "scopes_allowed": ["openid"],\n  "status": "draft",\n  "status_reason": "string",\n  "config_version": 1,\n  "secret_rotated_at": "1970-01-01T00:00:00.000Z",\n  "previous_secret_expires_at": "1970-01-01T00:00:00.000Z",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `activateClient`\n\nActivate a `draft` or `suspended` client. Validates that every redirect URI is an absolute\nHTTPS URL without fragment, that `scopes_allowed` contains `openid`, and that the\nauthentication method is `c\n\n`POST /v1/identity/operator/clients/{client_id}:activate`\n\n```ts\nconst { data } = await client.activateClient({\n  client_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "partner_key": "string",\n  "display_name": "string",\n  "description": "string",\n  "environment": "dev",\n  "redirect_uris": ["https://partner.example.com/auth/callback"],\n  "sector_identifier_uri": "https://partner.example.com/auth/callback",\n  "initiate_login_uri": "https://partner.example.com/auth/callback",\n  "launch_target_prefixes": ["string"],\n  "token_endpoint_auth_method": "client_secret_basic",\n  "grant_types": ["authorization_code"],\n  "scopes_allowed": ["openid"],\n  "status": "draft",\n  "status_reason": "string",\n  "config_version": 1,\n  "secret_rotated_at": "1970-01-01T00:00:00.000Z",\n  "previous_secret_expires_at": "1970-01-01T00:00:00.000Z",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `suspendClient`\n\nImmediately block the client for every organization. Provider-side artefacts (codes, tokens,\ngrants) are revoked; the audit trail is kept. Reversible with `activateClient`.\n\n`POST /v1/identity/operator/clients/{client_id}:suspend`\n\n```ts\nconst { data } = await client.suspendClient(\n  {\n    client_id: \'example\',\n  },\n  {\n    reason: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "partner_key": "string",\n  "display_name": "string",\n  "description": "string",\n  "environment": "dev",\n  "redirect_uris": ["https://partner.example.com/auth/callback"],\n  "sector_identifier_uri": "https://partner.example.com/auth/callback",\n  "initiate_login_uri": "https://partner.example.com/auth/callback",\n  "launch_target_prefixes": ["string"],\n  "token_endpoint_auth_method": "client_secret_basic",\n  "grant_types": ["authorization_code"],\n  "scopes_allowed": ["openid"],\n  "status": "draft",\n  "status_reason": "string",\n  "config_version": 1,\n  "secret_rotated_at": "1970-01-01T00:00:00.000Z",\n  "previous_secret_expires_at": "1970-01-01T00:00:00.000Z",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `rotateClientSecret`\n\nIssue a new client secret. The new secret is returned exactly once. The previous secret\nkeeps working until `previous_secret_expires_at` unless `compromise_mode` is set, in which\ncase it stops working\n\n`POST /v1/identity/operator/clients/{client_id}:rotateSecret`\n\n```ts\nconst { data } = await client.rotateClientSecret(\n  {\n    client_id: \'example\',\n  },\n  {\n    compromise_mode: false,\n    migration_window_seconds: 86400\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "partner_key": "string",\n  "display_name": "string",\n  "description": "string",\n  "environment": "dev",\n  "redirect_uris": ["https://partner.example.com/auth/callback"],\n  "sector_identifier_uri": "https://partner.example.com/auth/callback",\n  "initiate_login_uri": "https://partner.example.com/auth/callback",\n  "launch_target_prefixes": ["string"],\n  "token_endpoint_auth_method": "client_secret_basic",\n  "grant_types": ["authorization_code"],\n  "scopes_allowed": ["openid"],\n  "status": "draft",\n  "status_reason": "string",\n  "config_version": 1,\n  "secret_rotated_at": "1970-01-01T00:00:00.000Z",\n  "previous_secret_expires_at": "1970-01-01T00:00:00.000Z",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string",\n  "client_secret": "string"\n}\n```\n\n</details>\n\n---\n\n### `listClientOrganizations`\n\nList the organizations enabled on a client, including suspended and revoked ones.\n\n`GET /v1/identity/operator/clients/{client_id}/organizations`\n\n```ts\nconst { data } = await client.listClientOrganizations({\n  client_id: \'example\',\n  status: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "client_id": "bf-prod-x7k2",\n      "org_id": "739224",\n      "status": "active",\n      "status_reason": "string",\n      "authorization_policy": {\n        "mode": "preauthorized",\n        "population": "all_current_org_members",\n        "allowed_scopes": ["openid"],\n        "customer_approval_ref": "string",\n        "approved_at": "1970-01-01T00:00:00.000Z",\n        "version": 1,\n        "mandatory_claims": ["org_id"],\n        "recorded_by": "string",\n        "recorded_at": "1970-01-01T00:00:00.000Z"\n      },\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "updated_at": "1970-01-01T00:00:00.000Z",\n      "created_by": "string",\n      "updated_by": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `enableClientOrganization`\n\nEnable an epilot organization on a client, recording the customer\'s authorization policy\n(version 1). `allowed_scopes` must contain `openid` and be a subset of the client\'s\n`scopes_allowed`.\n\n`POST /v1/identity/operator/clients/{client_id}/organizations`\n\n```ts\nconst { data } = await client.enableClientOrganization(\n  {\n    client_id: \'example\',\n  },\n  {\n    org_id: \'739224\',\n    authorization_policy: {\n      mode: \'preauthorized\',\n      population: \'all_current_org_members\',\n      allowed_scopes: [\'openid\'],\n      customer_approval_ref: \'string\',\n      approved_at: \'1970-01-01T00:00:00.000Z\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "org_id": "739224",\n  "status": "active",\n  "status_reason": "string",\n  "authorization_policy": {\n    "mode": "preauthorized",\n    "population": "all_current_org_members",\n    "allowed_scopes": ["openid"],\n    "customer_approval_ref": "string",\n    "approved_at": "1970-01-01T00:00:00.000Z",\n    "version": 1,\n    "mandatory_claims": ["org_id"],\n    "recorded_by": "string",\n    "recorded_at": "1970-01-01T00:00:00.000Z"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getClientOrganization`\n\nRead one organization enablement.\n\n`GET /v1/identity/operator/clients/{client_id}/organizations/{org_id}`\n\n```ts\nconst { data } = await client.getClientOrganization({\n  client_id: \'example\',\n  org_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "org_id": "739224",\n  "status": "active",\n  "status_reason": "string",\n  "authorization_policy": {\n    "mode": "preauthorized",\n    "population": "all_current_org_members",\n    "allowed_scopes": ["openid"],\n    "customer_approval_ref": "string",\n    "approved_at": "1970-01-01T00:00:00.000Z",\n    "version": 1,\n    "mandatory_claims": ["org_id"],\n    "recorded_by": "string",\n    "recorded_at": "1970-01-01T00:00:00.000Z"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateClientOrganization`\n\nRecord a new version of the customer\'s authorization policy. `expected_policy_version` must\nequal the current version (compare-and-swap); a mismatch is rejected with `409`.\n\n`PUT /v1/identity/operator/clients/{client_id}/organizations/{org_id}`\n\n```ts\nconst { data } = await client.updateClientOrganization(\n  {\n    client_id: \'example\',\n    org_id: \'example\',\n  },\n  {\n    expected_policy_version: 1,\n    authorization_policy: {\n      mode: \'preauthorized\',\n      population: \'all_current_org_members\',\n      allowed_scopes: [\'openid\'],\n      customer_approval_ref: \'string\',\n      approved_at: \'1970-01-01T00:00:00.000Z\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "org_id": "739224",\n  "status": "active",\n  "status_reason": "string",\n  "authorization_policy": {\n    "mode": "preauthorized",\n    "population": "all_current_org_members",\n    "allowed_scopes": ["openid"],\n    "customer_approval_ref": "string",\n    "approved_at": "1970-01-01T00:00:00.000Z",\n    "version": 1,\n    "mandatory_claims": ["org_id"],\n    "recorded_by": "string",\n    "recorded_at": "1970-01-01T00:00:00.000Z"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `revokeClientOrganization`\n\nRevoke an organization\'s enablement. The record is kept as an audited tombstone; future\nauthorizations for this organization fail with `access_denied` and provider-side artefacts\nbound to it are revok\n\n`DELETE /v1/identity/operator/clients/{client_id}/organizations/{org_id}`\n\n```ts\nconst { data } = await client.revokeClientOrganization(\n  {\n    client_id: \'example\',\n    org_id: \'example\',\n  },\n  {\n    reason: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "org_id": "739224",\n  "status": "active",\n  "status_reason": "string",\n  "authorization_policy": {\n    "mode": "preauthorized",\n    "population": "all_current_org_members",\n    "allowed_scopes": ["openid"],\n    "customer_approval_ref": "string",\n    "approved_at": "1970-01-01T00:00:00.000Z",\n    "version": 1,\n    "mandatory_claims": ["org_id"],\n    "recorded_by": "string",\n    "recorded_at": "1970-01-01T00:00:00.000Z"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `suspendClientOrganization`\n\nTemporarily block one organization on this client. Reversible with `activateClientOrganization`.\n\n`POST /v1/identity/operator/clients/{client_id}/organizations/{org_id}:suspend`\n\n```ts\nconst { data } = await client.suspendClientOrganization(\n  {\n    client_id: \'example\',\n    org_id: \'example\',\n  },\n  {\n    reason: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "org_id": "739224",\n  "status": "active",\n  "status_reason": "string",\n  "authorization_policy": {\n    "mode": "preauthorized",\n    "population": "all_current_org_members",\n    "allowed_scopes": ["openid"],\n    "customer_approval_ref": "string",\n    "approved_at": "1970-01-01T00:00:00.000Z",\n    "version": 1,\n    "mandatory_claims": ["org_id"],\n    "recorded_by": "string",\n    "recorded_at": "1970-01-01T00:00:00.000Z"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `activateClientOrganization`\n\nResume a suspended organization on this client. Revoked enablements cannot be re-activated; enabling the organization again (`POST \u2026/organizations`) replaces the revoked entry and continues its policy\n\n`POST /v1/identity/operator/clients/{client_id}/organizations/{org_id}:activate`\n\n```ts\nconst { data } = await client.activateClientOrganization({\n  client_id: \'example\',\n  org_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "org_id": "739224",\n  "status": "active",\n  "status_reason": "string",\n  "authorization_policy": {\n    "mode": "preauthorized",\n    "population": "all_current_org_members",\n    "allowed_scopes": ["openid"],\n    "customer_approval_ref": "string",\n    "approved_at": "1970-01-01T00:00:00.000Z",\n    "version": 1,\n    "mandatory_claims": ["org_id"],\n    "recorded_by": "string",\n    "recorded_at": "1970-01-01T00:00:00.000Z"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getUserSubject`\n\nThe pairwise `sub` this client receives for one epilot user, so the partner can bind the person on its\nside **before** the first sign-in (for example a Babelforce agent provisioned through SCIM with\n`\n\n`GET /v1/identity/operator/clients/{client_id}/organizations/{org_id}/users/{user_id}:subject`\n\n```ts\nconst { data } = await client.getUserSubject({\n  client_id: \'example\',\n  org_id: \'example\',\n  user_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "client_id": "bf-prod-x7k2",\n  "org_id": "739224",\n  "user_id": "100321",\n  "sub": "v1.dGhpcy1pcy1hLWR1bW15LXN1YmplY3QtdmFsdWUtMDAx",\n  "key_version": "v1",\n  "sector": "portal.epilot.cloud"\n}\n```\n\n</details>\n\n---\n\n### `createIdentitySession`\n\nCalled by the epilot portal through the portal-host proxy after every persisted 360 session.\nValidates the 360 bearer token itself and mirrors it into the `identity_session` cookie\n(`HttpOnly; Secure;\n\n`GET /v1/identity/session`\n\n```ts\nconst { data } = await client.createIdentitySession()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "org_id": "739224",\n  "user_id": "string",\n  "expires_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteIdentitySession`\n\nClears the `identity_session` cookie. Called by the portal on logout.\n\n`DELETE /v1/identity/session`\n\n```ts\nconst { data } = await client.deleteIdentitySession()\n```\n\n---\n\n### `launchClient`\n\nOne validated place for partner start links (manager UI, hosted apps). Redirects the browser to the\nclient\'s registered `initiate_login_uri` with `iss` set to this issuer and, when given, the deep lin\n\n`GET /v1/identity/launch/{client_id}`\n\n```ts\nconst { data } = await client.launchClient({\n  client_id: \'example\',\n  target: \'example\',\n  extra: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `Error`\n\n```ts\ntype Error = {\n  status: number\n  error: string\n  details?: Record<string, unknown>[]\n}\n```\n\n### `PartnerClientId`\n\nOpaque client identifier, unique within the issuer, never reused\n\n```ts\ntype PartnerClientId = string\n```\n\n### `OrgId`\n\nepilot organization id, an opaque case-sensitive string\n\n```ts\ntype OrgId = string\n```\n\n### `UserId`\n\nepilot user id (`custom:ivy_user_id` in a 360 token). A user belongs to exactly one organization.\n\n```ts\ntype UserId = string\n```\n\n### `Environment`\n\nPartner-side environment this client belongs to\n\n```ts\ntype Environment = "dev" | "staging" | "production"\n```\n\n### `PartnerClientStatus`\n\n```ts\ntype PartnerClientStatus = "draft" | "active" | "suspended" | "retired"\n```\n\n### `Scope`\n\n```ts\ntype Scope = "openid" | "email" | "profile"\n```\n\n### `HttpsUri`\n\nAbsolute HTTPS URL without fragment\n\n```ts\ntype HttpsUri = string // uri\n```\n\n### `PartnerClientCreate`\n\n```ts\ntype PartnerClientCreate = {\n  partner_key: string\n  display_name: string\n  description?: string\n  environment: "dev" | "staging" | "production"\n  redirect_uris: string // uri[]\n  sector_identifier_uri?: string // uri\n  initiate_login_uri?: string // uri\n  launch_target_prefixes?: string[]\n  scopes_allowed?: "openid" | "email" | "profile"[]\n}\n```\n\n### `PartnerClientUpdate`\n\n```ts\ntype PartnerClientUpdate = {\n  config_version: number\n  allow_sector_change?: boolean\n  display_name: string\n  description?: string\n  redirect_uris: string // uri[]\n  sector_identifier_uri?: string // uri\n  initiate_login_uri?: string // uri\n  launch_target_prefixes?: string[]\n  scopes_allowed: "openid" | "email" | "profile"[]\n}\n```\n\n### `PartnerClient`\n\n```ts\ntype PartnerClient = {\n  client_id: string\n  partner_key: string\n  display_name: string\n  description?: string\n  environment: "dev" | "staging" | "production"\n  redirect_uris: string // uri[]\n  sector_identifier_uri?: string // uri\n  initiate_login_uri?: string // uri\n  launch_target_prefixes?: string[]\n  token_endpoint_auth_method: "client_secret_basic"\n  grant_types: "authorization_code"[]\n  scopes_allowed: "openid" | "email" | "profile"[]\n  status: "draft" | "active" | "suspended" | "retired"\n  status_reason?: string\n  config_version: number\n  secret_rotated_at?: string // date-time\n  previous_secret_expires_at?: string // date-time\n  created_at: string // date-time\n  updated_at: string // date-time\n  created_by?: string\n  updated_by?: string\n}\n```\n\n### `PartnerClientWithSecret`\n\n```ts\ntype PartnerClientWithSecret = {\n  client_id: string\n  partner_key: string\n  display_name: string\n  description?: string\n  environment: "dev" | "staging" | "production"\n  redirect_uris: string // uri[]\n  sector_identifier_uri?: string // uri\n  initiate_login_uri?: string // uri\n  launch_target_prefixes?: string[]\n  token_endpoint_auth_method: "client_secret_basic"\n  grant_types: "authorization_code"[]\n  scopes_allowed: "openid" | "email" | "profile"[]\n  status: "draft" | "active" | "suspended" | "retired"\n  status_reason?: string\n  config_version: number\n  secret_rotated_at?: string // date-time\n  previous_secret_expires_at?: string // date-time\n  created_at: string // date-time\n  updated_at: string // date-time\n  created_by?: string\n  updated_by?: string\n  client_secret: string\n}\n```\n\n### `PartnerClientList`\n\n```ts\ntype PartnerClientList = {\n  results: Array<{\n    client_id: string\n    partner_key: string\n    display_name: string\n    description?: string\n    environment: "dev" | "staging" | "production"\n    redirect_uris: string // uri[]\n    sector_identifier_uri?: string // uri\n    initiate_login_uri?: string // uri\n    launch_target_prefixes?: string[]\n    token_endpoint_auth_method: "client_secret_basic"\n    grant_types: "authorization_code"[]\n    scopes_allowed: "openid" | "email" | "profile"[]\n    status: "draft" | "active" | "suspended" | "retired"\n    status_reason?: string\n    config_version: number\n    secret_rotated_at?: string // date-time\n    previous_secret_expires_at?: string // date-time\n    created_at: string // date-time\n    updated_at: string // date-time\n    created_by?: string\n    updated_by?: string\n  }>\n  next_cursor?: string\n}\n```\n\n### `StatusChangeRequest`\n\n```ts\ntype StatusChangeRequest = {\n  reason?: string\n}\n```\n\n### `RotateSecretRequest`\n\n```ts\ntype RotateSecretRequest = {\n  compromise_mode?: boolean\n  migration_window_seconds?: number\n}\n```\n\n### `AuthorizationPolicyInput`\n\n```ts\ntype AuthorizationPolicyInput = {\n  mode?: "preauthorized"\n  population?: "all_current_org_members"\n  allowed_scopes: "openid" | "email" | "profile"[]\n  customer_approval_ref: string\n  approved_at: string // date-time\n}\n```\n\n### `AuthorizationPolicy`\n\n```ts\ntype AuthorizationPolicy = {\n  mode?: "preauthorized"\n  population?: "all_current_org_members"\n  allowed_scopes: "openid" | "email" | "profile"[]\n  customer_approval_ref: string\n  approved_at: string // date-time\n  version: number\n  mandatory_claims: "org_id"[]\n  recorded_by: string\n  recorded_at: string // date-time\n}\n```\n\n### `OrgEnablementStatus`\n\n```ts\ntype OrgEnablementStatus = "active" | "suspended" | "revoked"\n```\n\n### `OrgEnablementCreate`\n\n```ts\ntype OrgEnablementCreate = {\n  org_id: string\n  authorization_policy: {\n    mode?: "preauthorized"\n    population?: "all_current_org_members"\n    allowed_scopes: "openid" | "email" | "profile"[]\n    customer_approval_ref: string\n    approved_at: string // date-time\n  }\n}\n```\n\n### `OrgEnablementUpdate`\n\n```ts\ntype OrgEnablementUpdate = {\n  expected_policy_version: number\n  authorization_policy: {\n    mode?: "preauthorized"\n    population?: "all_current_org_members"\n    allowed_scopes: "openid" | "email" | "profile"[]\n    customer_approval_ref: string\n    approved_at: string // date-time\n  }\n}\n```\n\n### `OrgEnablement`\n\n```ts\ntype OrgEnablement = {\n  client_id: string\n  org_id: string\n  status: "active" | "suspended" | "revoked"\n  status_reason?: string\n  authorization_policy: {\n    mode?: "preauthorized"\n    population?: "all_current_org_members"\n    allowed_scopes: "openid" | "email" | "profile"[]\n    customer_approval_ref: string\n    approved_at: string // date-time\n    version: number\n    mandatory_claims: "org_id"[]\n    recorded_by: string\n    recorded_at: string // date-time\n  }\n  created_at: string // date-time\n  updated_at: string // date-time\n  created_by?: string\n  updated_by?: string\n}\n```\n\n### `OrgEnablementList`\n\n```ts\ntype OrgEnablementList = {\n  results: Array<{\n    client_id: string\n    org_id: string\n    status: "active" | "suspended" | "revoked"\n    status_reason?: string\n    authorization_policy: {\n      mode?: { ... }\n      population?: { ... }\n      allowed_scopes: { ... }\n      customer_approval_ref: { ... }\n      approved_at: { ... }\n      version: { ... }\n      mandatory_claims: { ... }\n      recorded_by: { ... }\n      recorded_at: { ... }\n    }\n    created_at: string // date-time\n    updated_at: string // date-time\n    created_by?: string\n    updated_by?: string\n  }>\n}\n```\n\n### `IdentitySession`\n\n```ts\ntype IdentitySession = {\n  org_id: string\n  user_id: string\n  expires_at: string // date-time\n}\n```\n\n### `UserSubject`\n\n```ts\ntype UserSubject = {\n  client_id: string\n  org_id: string\n  user_id: string\n  sub: string\n  key_version: string\n  sector: string\n}\n```\n';
+
+
+exports.default = identity_default;

package/dist/{identity-runtime-PFM5KQWA.js → identity-runtime-A4LSC77N.js}

@@ -1,5 +1,5 @@
 import {
   require_identity_runtime
-} from "./chunk-3IBAPVLY.js";
+} from "./chunk-DSYS22AC.js";
 import "./chunk-YPSWSI3M.js";
 export default require_identity_runtime();

package/dist/{identity-runtime-57DQPQWX.cjs → identity-runtime-GNE4EC7V.cjs}

@@ -1,5 +1,5 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkRPWTWCDCcjs = require('./chunk-RPWTWCDC.cjs');
+var _chunkTKRZK7V2cjs = require('./chunk-TKRZK7V2.cjs');
 require('./chunk-NJK5F5TF.cjs');
-exports. default = _chunkRPWTWCDCcjs.require_identity_runtime.call(void 0, );
+exports. default = _chunkTKRZK7V2cjs.require_identity_runtime.call(void 0, );

package/dist/index.cjs

@@ -15,7 +15,7 @@ var _chunk4QCVVDTAcjs = require('./chunk-4QCVVDTA.cjs');
 var _chunkX2LMHC5Rcjs = require('./chunk-X2LMHC5R.cjs');
 
 
-var _chunkHRSCAD3Wcjs = require('./chunk-HRSCAD3W.cjs');
+var _chunkJIUTCNTBcjs = require('./chunk-JIUTCNTB.cjs');
 
 
 var _chunkNGGI52NVcjs = require('./chunk-NGGI52NV.cjs');
@@ -87,7 +87,7 @@ var _chunk424JLS5Gcjs = require('./chunk-424JLS5G.cjs');
 var _chunkYO4M3BZLcjs = require('./chunk-YO4M3BZL.cjs');
 
 
-var _chunkRPWTWCDCcjs = require('./chunk-RPWTWCDC.cjs');
+var _chunkTKRZK7V2cjs = require('./chunk-TKRZK7V2.cjs');
 
 
 var _chunkQDPZZUG3cjs = require('./chunk-QDPZZUG3.cjs');
@@ -170,7 +170,7 @@ var _chunkWOUASZJWcjs = require('./chunk-WOUASZJW.cjs');
 
 
 
-var _chunkPAMXQWNLcjs = require('./chunk-PAMXQWNL.cjs');
+var _chunkM6RNRDA3cjs = require('./chunk-M6RNRDA3.cjs');
 
 
 var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -244,7 +244,7 @@ var resolveClient = (params) => {
   }
   if (!entry.instance) {
     const definition = entry.loader();
-    entry.instance = _chunkPAMXQWNLcjs.createApiClient.call(void 0, {
+    entry.instance = _chunkM6RNRDA3cjs.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) => _chunkPAMXQWNLcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+var expandDef = (mod) => _chunkM6RNRDA3cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
@@ -422,7 +422,7 @@ var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
     name: "identity",
-    loader: () => expandDef(_chunkRPWTWCDCcjs.require_identity_runtime.call(void 0, ))
+    loader: () => expandDef(_chunkTKRZK7V2cjs.require_identity_runtime.call(void 0, ))
   });
   registerApi({
     registry,
@@ -537,7 +537,7 @@ var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
     name: "validationRules",
-    loader: () => expandDef(_chunkHRSCAD3Wcjs.require_validation_rules_runtime.call(void 0, ))
+    loader: () => expandDef(_chunkJIUTCNTBcjs.require_validation_rules_runtime.call(void 0, ))
   });
   registerApi({
     registry,
@@ -640,9 +640,9 @@ var createSDK = () => {
       const available = [...registry.keys()].join(", ");
       throw new Error(`Unknown API: "${name}". Available: ${available}`);
     }
-    return _chunkPAMXQWNLcjs.createApiHandle.call(void 0, {
+    return _chunkM6RNRDA3cjs.createApiHandle.call(void 0, {
       resolveClient: () => resolveClient({ registry, name, state }),
-      createClient: () => _chunkPAMXQWNLcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
+      createClient: () => _chunkM6RNRDA3cjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
       apiName: name
     });
   };
@@ -690,9 +690,9 @@ var createSDK = () => {
           return interceptorUse;
         }
         case "help":
-          return (apiName) => _chunkPAMXQWNLcjs.help.call(void 0, apiName);
+          return (apiName) => _chunkM6RNRDA3cjs.help.call(void 0, apiName);
         case "openapi":
-          return (apiName) => _chunkPAMXQWNLcjs.openapi.call(void 0, apiName);
+          return (apiName) => _chunkM6RNRDA3cjs.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 = _chunkPAMXQWNLcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkPAMXQWNLcjs.help; exports.openapi = _chunkPAMXQWNLcjs.openapi;
+exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkM6RNRDA3cjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkM6RNRDA3cjs.help; exports.openapi = _chunkM6RNRDA3cjs.openapi;

package/dist/index.d.cts

@@ -54,7 +54,7 @@ import { C as Client$L } from './submission.d-BamwfhXw.cjs';
 import { C as Client$M } from './targeting.d-BYVSahmV.cjs';
 import { C as Client$N } from './template-variables.d-Ble9TSBa.cjs';
 import { C as Client$O } from './user.d-rqYtwsCz.cjs';
-import { C as Client$P } from './validation-rules.d-ChX2VKqg.cjs';
+import { C as Client$P } from './validation-rules.d-C1OtLama.cjs';
 import { C as Client$Q } from './webhooks.d-DqOEzFsp.cjs';
 import { C as Client$R } from './workflow.d-5cyNJgVQ.cjs';
 import { C as Client$S } from './workflow-definition.d-CweGhhBU.cjs';

package/dist/index.d.ts

@@ -54,7 +54,7 @@ import { C as Client$L } from './submission.d-BamwfhXw.js';
 import { C as Client$M } from './targeting.d-BYVSahmV.js';
 import { C as Client$N } from './template-variables.d-Ble9TSBa.js';
 import { C as Client$O } from './user.d-rqYtwsCz.js';
-import { C as Client$P } from './validation-rules.d-ChX2VKqg.js';
+import { C as Client$P } from './validation-rules.d-C1OtLama.js';
 import { C as Client$Q } from './webhooks.d-DqOEzFsp.js';
 import { C as Client$R } from './workflow.d-5cyNJgVQ.js';
 import { C as Client$S } from './workflow-definition.d-CweGhhBU.js';

package/dist/index.js

@@ -15,7 +15,7 @@ import {
 } from "./chunk-N254AABZ.js";
 import {
   require_validation_rules_runtime
-} from "./chunk-PPX45U34.js";
+} from "./chunk-7IKQIVUS.js";
 import {
   require_webhooks_runtime
 } from "./chunk-OV4MYZR5.js";
@@ -87,7 +87,7 @@ import {
 } from "./chunk-5MFHAXBT.js";
 import {
   require_identity_runtime
-} from "./chunk-3IBAPVLY.js";
+} from "./chunk-DSYS22AC.js";
 import {
   require_integration_toolkit_runtime
 } from "./chunk-I6IC54PD.js";
@@ -170,7 +170,7 @@ import {
   expand,
   help,
   openapi
-} from "./chunk-BVDXJ4QV.js";
+} from "./chunk-N2IV6QYZ.js";
 import {
   __require
 } from "./chunk-YPSWSI3M.js";

package/dist/validation-rules-D4OW6VYI.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/validation-rules.json
+var validation_rules_default = '# Validation Rules API\n\n- **Base URL:** `https://validation-rules.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/validation-rules](https://docs.epilot.io/api/validation-rules)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.validationRules.getValidationRules(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/validation-rules\'\n\nconst validationRulesClient = getClient()\nauthorize(validationRulesClient, () => \'<token>\')\nconst { data } = await validationRulesClient.getValidationRules(...)\n```\n\n## Operations\n\n**Validation Rules**\n- [`getValidationRules`](#getvalidationrules)\n- [`createValidationRule`](#createvalidationrule)\n- [`getValidationRuleById`](#getvalidationrulebyid)\n- [`updateValidationRule`](#updatevalidationrule)\n- [`deleteValidationRule`](#deletevalidationrule)\n- [`addUsedByReference`](#addusedbyreference)\n- [`removeUsedByReference`](#removeusedbyreference)\n\n**Schemas**\n- [`GetValidationRulesResponse`](#getvalidationrulesresponse)\n- [`CreateValidationRuleRequest`](#createvalidationrulerequest)\n- [`UpdateValidationRuleRequest`](#updatevalidationrulerequest)\n- [`ValidationRuleBase`](#validationrulebase)\n- [`ValidationRule`](#validationrule)\n- [`UsedBy`](#usedby)\n- [`RegexRuleType`](#regexruletype)\n- [`PatternRuleType`](#patternruletype)\n- [`NumericRuleType`](#numericruletype)\n- [`RegexCondition`](#regexcondition)\n- [`RegexNestedCondition`](#regexnestedcondition)\n- [`RegexFactCondition`](#regexfactcondition)\n- [`PatternCondition`](#patterncondition)\n- [`PatternNestedCondition`](#patternnestedcondition)\n- [`PatternFactCondition`](#patternfactcondition)\n- [`NumericCondition`](#numericcondition)\n- [`NumericNestedCondition`](#numericnestedcondition)\n- [`NumericFactCondition`](#numericfactcondition)\n- [`ComparisonRuleType`](#comparisonruletype)\n- [`Condition`](#condition)\n- [`Operator`](#operator)\n- [`ConditionValue`](#conditionvalue)\n- [`ScalarValue`](#scalarvalue)\n- [`ValueReference`](#valuereference)\n- [`EnvironmentValue`](#environmentvalue)\n- [`ExternalValue`](#externalvalue)\n- [`ParameterValue`](#parametervalue)\n- [`StaticValue`](#staticvalue)\n- [`ContextValue`](#contextvalue)\n- [`ValueAdjustment`](#valueadjustment)\n- [`RelativeDateValue`](#relativedatevalue)\n- [`RangeValue`](#rangevalue)\n- [`NoValue`](#novalue)\n- [`DocumentRuleType`](#documentruletype)\n- [`DocumentCheck`](#documentcheck)\n- [`DocumentCondition`](#documentcondition)\n- [`DocumentOperator`](#documentoperator)\n- [`DocumentConditionValue`](#documentconditionvalue)\n- [`FileTypesValue`](#filetypesvalue)\n- [`CriteriaValue`](#criteriavalue)\n- [`AppliesWhen`](#applieswhen)\n- [`ContextRequirement`](#contextrequirement)\n\n### `getValidationRules`\n\nReturns all validation rules belonging to the authenticated user\'s organization.\n\n`GET /v1/validation-rules`\n\n```ts\nconst { data } = await client.getValidationRules()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "title": "string",\n      "placeholder": "string",\n      "used_by": [\n        {\n          "type": "journey",\n          "source_id": "journey-xyz789"\n        }\n      ],\n      "rule": {\n        "type": "regex",\n        "conditions": {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            },\n            {\n              "all": [\n                {\n                  "fact": "inputValue",\n                  "operator": "regexMatch",\n                  "value": "string",\n                  "params": {\n                    "errorMessage": "string"\n                  }\n                }\n              ]\n            }\n          ]\n        }\n      },\n      "contexts": [\n        {\n          "schema": "contract"\n        }\n      ],\n      "_schema_version": "string",\n      "_id": "string",\n      "_organization_id": "string",\n      "created_at": "string",\n      "updated_at": "string",\n      "created_by": "string",\n      "updated_by": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createValidationRule`\n\nCreates a new validation rule for the authenticated organization.\n\n`POST /v1/validation-rules`\n\n```ts\nconst { data } = await client.createValidationRule(\n  null,\n  {\n    title: \'string\',\n    placeholder: \'string\',\n    used_by: [\n      {\n        type: \'journey\',\n        source_id: \'journey-xyz789\'\n      }\n    ],\n    rule: {\n      type: \'regex\',\n      conditions: {\n        all: [\n          {\n            fact: \'inputValue\',\n            operator: \'regexMatch\',\n            value: \'string\',\n            params: {\n              errorMessage: \'string\'\n            }\n          },\n          {\n            all: [\n              {\n                fact: \'inputValue\',\n                operator: \'regexMatch\',\n                value: \'string\',\n                params: {\n                  errorMessage: \'string\'\n                }\n              }\n            ]\n          }\n        ]\n      }\n    },\n    contexts: [\n      {\n        schema: \'contract\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getValidationRuleById`\n\nRetrieves a specific validation rule by its unique ID.\n\n`GET /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.getValidationRuleById({\n  ruleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateValidationRule`\n\nPartially updates an existing validation rule by ID. Only the fields provided in the request body are updated.\n\n`PATCH /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.updateValidationRule(\n  {\n    ruleId: \'example\',\n  },\n  {\n    title: \'string\',\n    placeholder: \'string\',\n    used_by: [\n      {\n        type: \'journey\',\n        source_id: \'journey-xyz789\'\n      }\n    ],\n    rule: {\n      type: \'regex\',\n      conditions: {\n        all: [\n          {\n            fact: \'inputValue\',\n            operator: \'regexMatch\',\n            value: \'string\',\n            params: {\n              errorMessage: \'string\'\n            }\n          },\n          {\n            all: [\n              {\n                fact: \'inputValue\',\n                operator: \'regexMatch\',\n                value: \'string\',\n                params: {\n                  errorMessage: \'string\'\n                }\n              }\n            ]\n          }\n        ]\n      }\n    },\n    contexts: [\n      {\n        schema: \'contract\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteValidationRule`\n\nPermanently deletes a validation rule by ID. Any journeys or entity attributes referencing this rule should be updated before deletion.\n\n`DELETE /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.deleteValidationRule({\n  ruleId: \'example\',\n})\n```\n\n---\n\n### `addUsedByReference`\n\nAdds a single `used_by` reference to an existing validation rule.\n\n`POST /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.addUsedByReference(\n  {\n    ruleId: \'example\',\n  },\n  {\n    type: \'journey\',\n    source_id: \'journey-xyz789\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `removeUsedByReference`\n\nRemoves a specific `used_by` reference from an existing validation rule.\n\n`DELETE /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.removeUsedByReference(\n  {\n    ruleId: \'example\',\n  },\n  {\n    type: \'journey\',\n    source_id: \'journey-xyz789\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `GetValidationRulesResponse`\n\nResponse envelope for listing all validation rules within an organization.\n\n```ts\ntype GetValidationRulesResponse = {\n  results?: Array<{\n    _schema_version: string\n    _id: string\n    _organization_id: string\n    created_at: string\n    updated_at: string\n    created_by: string\n    updated_by: string\n  }>\n}\n```\n\n### `CreateValidationRuleRequest`\n\n```ts\ntype CreateValidationRuleRequest = object\n```\n\n### `UpdateValidationRuleRequest`\n\n```ts\ntype UpdateValidationRuleRequest = {\n  title?: string\n  placeholder?: string\n  used_by?: Array<{\n    type: "journey" | "entity"\n    schema_slug?: string\n    source_id?: string\n  }>\n  rule?: {\n    type: "regex"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "pattern"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "numeric"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    input_type: "number" | "date" | "text"\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      applies_when?: { ... }\n      allow_failure?: { ... }\n    }>\n  } | {\n    input_type: "document"\n    check: {\n      level: { ... }\n    }\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      allow_failure?: { ... }\n    }>\n  }\n  contexts?: Array<{\n    schema: string\n  }>\n}\n```\n\n### `ValidationRuleBase`\n\n```ts\ntype ValidationRuleBase = {\n  title?: string\n  placeholder?: string\n  used_by?: Array<{\n    type: "journey" | "entity"\n    schema_slug?: string\n    source_id?: string\n  }>\n  rule?: {\n    type: "regex"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "pattern"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "numeric"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    input_type: "number" | "date" | "text"\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      applies_when?: { ... }\n      allow_failure?: { ... }\n    }>\n  } | {\n    input_type: "document"\n    check: {\n      level: { ... }\n    }\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      allow_failure?: { ... }\n    }>\n  }\n  contexts?: Array<{\n    schema: string\n  }>\n}\n```\n\n### `ValidationRule`\n\nThe Validation rule definition.\n\n```ts\ntype ValidationRule = {\n  _schema_version: string\n  _id: string\n  _organization_id: string\n  created_at: string\n  updated_at: string\n  created_by: string\n  updated_by: string\n}\n```\n\n### `UsedBy`\n\nDescribes where and how a validation rule is applied. Used to track associations between rules and the journeys or entity schemas that reference them.\n\n```ts\ntype UsedBy = {\n  type: "journey" | "entity"\n  schema_slug?: string\n  source_id?: string\n}\n```\n\n### `RegexRuleType`\n\nValidation rule that uses a regular expression to validate input.\n\n```ts\ntype RegexRuleType = {\n  type: "regex"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `PatternRuleType`\n\nValidation rule that uses a sequence of patterns to validate input.\n\n```ts\ntype PatternRuleType = {\n  type: "pattern"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `NumericRuleType`\n\nValidation rule for numeric values, supporting range and digit count constraints.\n\n```ts\ntype NumericRuleType = {\n  type: "numeric"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `RegexCondition`\n\nCondition definition for a regex-based validation rule (2 levels deep)\n\n```ts\ntype RegexCondition = {\n  all: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }\n}\n```\n\n### `RegexNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype RegexNestedCondition = {\n  all: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }\n}\n```\n\n### `RegexFactCondition`\n\nFact-based condition for regex validation\n\n```ts\ntype RegexFactCondition = {\n  fact: "inputValue"\n  operator: "regexMatch"\n  value: string\n  params?: {\n    errorMessage?: string\n  }\n}\n```\n\n### `PatternCondition`\n\nCondition definition for a pattern-based validation rule (2 levels deep)\n\n```ts\ntype PatternCondition = {\n  all: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n  // ...\n}\n```\n\n### `PatternNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype PatternNestedCondition = {\n  all: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n  // ...\n}\n```\n\n### `PatternFactCondition`\n\nFact-based condition for pattern validation\n\n```ts\ntype PatternFactCondition = {\n  fact: "total-length"\n  operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n  value: number\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check" | "total-length"\n  operator: "exactlyNDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check"\n  operator: "in" | "notIn" | "contains" | "doesNotContain"\n  value: string[]\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check"\n  operator: "equal" | "notEqual"\n  value: string\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n}\n```\n\n### `NumericCondition`\n\nCondition definition for a numeric-based validation rule (2 levels deep)\n\n```ts\ntype NumericCondition = {\n  all: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "numeric-value" | "total-length"\n  // ...\n}\n```\n\n### `NumericNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype NumericNestedCondition = {\n  all: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }\n}\n```\n\n### `NumericFactCondition`\n\nFact-based condition for numeric validation\n\n```ts\ntype NumericFactCondition = {\n  fact: "numeric-value" | "total-length"\n  operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n  value: number\n  params?: {\n    errorMessage?: string\n  }\n} | {\n  fact: "integer-digits-count"\n  operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n    allowLeadingZeroes?: boolean\n  }\n} | {\n  fact: "decimal-digits-count"\n  operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n  }\n} | {\n  fact: "has-leading-zeroes"\n  operator: "equal" | "notAllowed"\n  value: boolean\n  params?: {\n    errorMessage?: string\n  }\n}\n```\n\n### `ComparisonRuleType`\n\nDeclarative validation rule (schema version v2). Supports predefined comparison operators\nover number, date and text inputs, with static, dynamic (context path), relative-date and\nexternal (app-provided) comparison values.\n\n\n```ts\ntype ComparisonRuleType = {\n  input_type: "number" | "date" | "text"\n  conditions: Array<{\n    id: string\n    operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n    value: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      min: { ... }\n      max: { ... }\n    } | {\n      source: { ... }\n    }\n    error_message: string\n    applies_when?: {\n      path: { ... }\n      operator: { ... }\n      value?: { ... }\n    }\n    allow_failure?: boolean\n  }>\n}\n```\n\n### `Condition`\n\nA single comparison the input value must satisfy.\n\n```ts\ntype Condition = {\n  id: string\n  operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n  value: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    unit: "days" | "months" | "years"\n    anchor?: "today" | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "range"\n    min: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    } | {\n  // ...\n}\n```\n\n### `Operator`\n\nPredefined comparison operator. Compatibility (enforced at write time):\n- number: equal, notEqual, greaterThan, greaterThanInclusive, lessThan, lessThanInclusive, between, regexMatch,\n  maxDigits, maxDecimals\n- date: dateBefore, dateOnOrBefore, dateAfter, dateOnOrAfter, dateBetween, notInFuture, not\n\n```ts\ntype Operator = "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n```\n\n### `ConditionValue`\n\nThe comparison value of a condition - a scalar, a range of scalars, or nothing (unary operators).\n\n```ts\ntype ConditionValue = {\n  source: "static"\n  data: number | string | boolean\n} | {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "relative_date"\n  offset: number | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  unit: "days" | "months" | "years"\n  anchor?: "today" | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n  // ...\n}\n```\n\n### `ScalarValue`\n\nA single comparison value - static, resolved from context, a relative date, an organisation environment variable, an external value, or a parameter the consuming surface supplies.\n\n```ts\ntype ScalarValue = {\n  source: "static"\n  data: number | string | boolean\n} | {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "relative_date"\n  offset: number | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  unit: "days" | "months" | "years"\n  anchor?: "today" | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n  // ...\n}\n```\n\n### `ValueReference`\n\nA value resolved at evaluation time instead of written into the rule, identified by\n`source`. Each field that accepts a reference lists the sources it allows; a rule using\nany other source is rejected when it is saved.\n\n\n```ts\ntype ValueReference = {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "environment"\n  key: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "external"\n  app_id: string\n  hook_id: string\n  result_id: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "parameter"\n  name: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n  // ...\n}\n```\n\n### `EnvironmentValue`\n\nA comparison value resolved at evaluation time from an organisation environment variable\n(environments-api). The rule stores the key, never the value, so one change to the variable\nreaches every rule that references it and a blueprint install never overwrites the\norganisation\'s own value.\n\nOnly brow\n\n```ts\ntype EnvironmentValue = {\n  source: "environment"\n  key: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n}\n```\n\n### `ExternalValue`\n\nA comparison value produced at evaluation time by an External Values hook of an installed\napp (component type `EXTERNAL_VALUES`). The rule stores the reference only; the value is\nresolved server-side by the external-values-api, which executes the hook\'s HTTP call with\nthe app\'s credentials and retur\n\n```ts\ntype ExternalValue = {\n  source: "external"\n  app_id: string\n  hook_id: string\n  result_id: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n}\n```\n\n### `ParameterValue`\n\nA comparison value supplied by the surface that evaluates the rule, identified by a name\nthe rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface\nbinds the name to a source of its own - a journey binds it to the value of another block -\nand resolves it at evaluation\n\n```ts\ntype ParameterValue = {\n  source: "parameter"\n  name: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n}\n```\n\n### `StaticValue`\n\nA fixed comparison value.\n\n```ts\ntype StaticValue = {\n  source: "static"\n  data: number | string | boolean\n}\n```\n\n### `ContextValue`\n\nA dynamic comparison value resolved from runtime context, e.g. `contract.installment_amount`\nor `previous_reading.value`. The first path segment must match the `name` of a declared\ncontext requirement.\n\n\n```ts\ntype ContextValue = {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n}\n```\n\n### `ValueAdjustment`\n\nAdjusts a context-resolved numeric value before comparison, e.g. "context value plus 10 percent".\nUsed to express tolerance bands such as "at most 10% above the current instalment amount".\n\n\n```ts\ntype ValueAdjustment = {\n  type: "percent" | "absolute"\n  value: number | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  direction: "increase" | "decrease"\n  rounding?: "up" | "down"\n}\n```\n\n### `RelativeDateValue`\n\nA date relative to the evaluation moment, e.g. "today minus 30 days". Only valid for date rules.\n\n```ts\ntype RelativeDateValue = {\n  source: "relative_date"\n  offset: number | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  unit: "days" | "months" | "years"\n  anchor?: "today" | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n}\n```\n\n### `RangeValue`\n\nA lower and upper bound for range operators (between, dateBetween, lengthBetween). Bounds are inclusive.\n\n```ts\ntype RangeValue = {\n  source: "range"\n  min: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    unit: "days" | "months" | "years"\n    anchor?: "today" | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  max: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number | {\n  // ...\n}\n```\n\n### `NoValue`\n\nNo comparison value - used by unary operators such as notInFuture / notInPast.\n\n```ts\ntype NoValue = {\n  source: "none"\n}\n```\n\n### `DocumentRuleType`\n\nDeclarative validation rule (schema version v2) for uploaded files. The rule declares how deep\nthe check goes (`check.level`) and the conditions the file must satisfy. Property conditions\n(file type, size, page count, image resolution, blank and password-protected detection) are\ndeterministic and av\n\n```ts\ntype DocumentRuleType = {\n  input_type: "document"\n  check: {\n    level: "basic" | "standard" | "advanced"\n  }\n  conditions: Array<{\n    id: string\n    operator: "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"\n    value: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      min: { ... }\n      max: { ... }\n    } | {\n      source: { ... }\n    } | {\n      source: { ... }\n      types: { ... }\n    } | {\n      source: { ... }\n      text: { ... }\n    }\n    error_message: string\n    allow_failure?: boolean\n  }>\n}\n```\n\n### `DocumentCheck`\n\nHow deep the document check goes. Levels are cumulative.\n\n```ts\ntype DocumentCheck = {\n  level: "basic" | "standard" | "advanced"\n}\n```\n\n### `DocumentCondition`\n\nA single check the uploaded file must satisfy.\n\n```ts\ntype DocumentCondition = {\n  id: string\n  operator: "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"\n  value: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "range"\n    min: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    max: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n  } | {\n    source: "none"\n  } | {\n    source: "file_types"\n    types: "image" | "pdf" | "document" | "spreadsheet"[]\n  } | {\n    source: "criteria"\n    text: string\n  }\n  error_message: string\n  allow_failure?: boolean\n}\n```\n\n### `DocumentOperator`\n\nPredefined document check. Value compatibility (enforced at write time):\n- fileTypeIn: `file_types` value listing the accepted file categories.\n- sizeBelow: static integer, maximum file size in bytes.\n- pageCountBetween: `range` of static non-negative integers (inclusive).\n- resolutionAtLeast / reso\n\n```ts\ntype DocumentOperator = "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"\n```\n\n### `DocumentConditionValue`\n\nThe value of a document condition - a static scalar, a range, nothing, accepted file categories, or a free-text criterion.\n\n```ts\ntype DocumentConditionValue = {\n  source: "static"\n  data: number | string | boolean\n} | {\n  source: "range"\n  min: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    unit: "days" | "months" | "years"\n    anchor?: "today" | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  max: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  // ...\n}\n```\n\n### `FileTypesValue`\n\nAccepted file categories; each category expands to a mime list at check time.\n\n```ts\ntype FileTypesValue = {\n  source: "file_types"\n  types: "image" | "pdf" | "document" | "spreadsheet"[]\n}\n```\n\n### `CriteriaValue`\n\nA free-text requirement judged against the document\'s extracted content, e.g. "The photo shows\nan electricity meter with the meter number and the current reading fully legible." One requirement\nper condition keeps results specific and lets each requirement be graded separately.\n\n\n```ts\ntype CriteriaValue = {\n  source: "criteria"\n  text: string\n}\n```\n\n### `AppliesWhen`\n\nOptional precondition on a condition: the condition only takes part in the\nvalidation when this comparison over context holds. Examples: apply the\ndual-tariff reference only when `contract.htnt` is not empty, or run a\nplausibility check only when a context value reaches a threshold.\n\n\n```ts\ntype AppliesWhen = {\n  path: string\n  operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty"\n  value?: number | string | boolean | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n}\n```\n\n### `ContextRequirement`\n\nAn entity context source the rule needs at evaluation time, referenced by `context`\nvalue paths via the schema slug as their first segment (e.g. `contract.installment_amount`).\nHow the source is resolved (which entity instance) is decided by the consuming surface,\nnot by the rule. Meter reading comp\n\n```ts\ntype ContextRequirement = {\n  schema: string\n}\n```\n';
+export {
+  validation_rules_default as default
+};

package/dist/validation-rules-QYVRILMT.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/validation-rules.json
+var validation_rules_default = '# Validation Rules API\n\n- **Base URL:** `https://validation-rules.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/validation-rules](https://docs.epilot.io/api/validation-rules)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.validationRules.getValidationRules(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/validation-rules\'\n\nconst validationRulesClient = getClient()\nauthorize(validationRulesClient, () => \'<token>\')\nconst { data } = await validationRulesClient.getValidationRules(...)\n```\n\n## Operations\n\n**Validation Rules**\n- [`getValidationRules`](#getvalidationrules)\n- [`createValidationRule`](#createvalidationrule)\n- [`getValidationRuleById`](#getvalidationrulebyid)\n- [`updateValidationRule`](#updatevalidationrule)\n- [`deleteValidationRule`](#deletevalidationrule)\n- [`addUsedByReference`](#addusedbyreference)\n- [`removeUsedByReference`](#removeusedbyreference)\n\n**Schemas**\n- [`GetValidationRulesResponse`](#getvalidationrulesresponse)\n- [`CreateValidationRuleRequest`](#createvalidationrulerequest)\n- [`UpdateValidationRuleRequest`](#updatevalidationrulerequest)\n- [`ValidationRuleBase`](#validationrulebase)\n- [`ValidationRule`](#validationrule)\n- [`UsedBy`](#usedby)\n- [`RegexRuleType`](#regexruletype)\n- [`PatternRuleType`](#patternruletype)\n- [`NumericRuleType`](#numericruletype)\n- [`RegexCondition`](#regexcondition)\n- [`RegexNestedCondition`](#regexnestedcondition)\n- [`RegexFactCondition`](#regexfactcondition)\n- [`PatternCondition`](#patterncondition)\n- [`PatternNestedCondition`](#patternnestedcondition)\n- [`PatternFactCondition`](#patternfactcondition)\n- [`NumericCondition`](#numericcondition)\n- [`NumericNestedCondition`](#numericnestedcondition)\n- [`NumericFactCondition`](#numericfactcondition)\n- [`ComparisonRuleType`](#comparisonruletype)\n- [`Condition`](#condition)\n- [`Operator`](#operator)\n- [`ConditionValue`](#conditionvalue)\n- [`ScalarValue`](#scalarvalue)\n- [`ValueReference`](#valuereference)\n- [`EnvironmentValue`](#environmentvalue)\n- [`ExternalValue`](#externalvalue)\n- [`ParameterValue`](#parametervalue)\n- [`StaticValue`](#staticvalue)\n- [`ContextValue`](#contextvalue)\n- [`ValueAdjustment`](#valueadjustment)\n- [`RelativeDateValue`](#relativedatevalue)\n- [`RangeValue`](#rangevalue)\n- [`NoValue`](#novalue)\n- [`DocumentRuleType`](#documentruletype)\n- [`DocumentCheck`](#documentcheck)\n- [`DocumentCondition`](#documentcondition)\n- [`DocumentOperator`](#documentoperator)\n- [`DocumentConditionValue`](#documentconditionvalue)\n- [`FileTypesValue`](#filetypesvalue)\n- [`CriteriaValue`](#criteriavalue)\n- [`AppliesWhen`](#applieswhen)\n- [`ContextRequirement`](#contextrequirement)\n\n### `getValidationRules`\n\nReturns all validation rules belonging to the authenticated user\'s organization.\n\n`GET /v1/validation-rules`\n\n```ts\nconst { data } = await client.getValidationRules()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "title": "string",\n      "placeholder": "string",\n      "used_by": [\n        {\n          "type": "journey",\n          "source_id": "journey-xyz789"\n        }\n      ],\n      "rule": {\n        "type": "regex",\n        "conditions": {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            },\n            {\n              "all": [\n                {\n                  "fact": "inputValue",\n                  "operator": "regexMatch",\n                  "value": "string",\n                  "params": {\n                    "errorMessage": "string"\n                  }\n                }\n              ]\n            }\n          ]\n        }\n      },\n      "contexts": [\n        {\n          "schema": "contract"\n        }\n      ],\n      "_schema_version": "string",\n      "_id": "string",\n      "_organization_id": "string",\n      "created_at": "string",\n      "updated_at": "string",\n      "created_by": "string",\n      "updated_by": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createValidationRule`\n\nCreates a new validation rule for the authenticated organization.\n\n`POST /v1/validation-rules`\n\n```ts\nconst { data } = await client.createValidationRule(\n  null,\n  {\n    title: \'string\',\n    placeholder: \'string\',\n    used_by: [\n      {\n        type: \'journey\',\n        source_id: \'journey-xyz789\'\n      }\n    ],\n    rule: {\n      type: \'regex\',\n      conditions: {\n        all: [\n          {\n            fact: \'inputValue\',\n            operator: \'regexMatch\',\n            value: \'string\',\n            params: {\n              errorMessage: \'string\'\n            }\n          },\n          {\n            all: [\n              {\n                fact: \'inputValue\',\n                operator: \'regexMatch\',\n                value: \'string\',\n                params: {\n                  errorMessage: \'string\'\n                }\n              }\n            ]\n          }\n        ]\n      }\n    },\n    contexts: [\n      {\n        schema: \'contract\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getValidationRuleById`\n\nRetrieves a specific validation rule by its unique ID.\n\n`GET /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.getValidationRuleById({\n  ruleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateValidationRule`\n\nPartially updates an existing validation rule by ID. Only the fields provided in the request body are updated.\n\n`PATCH /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.updateValidationRule(\n  {\n    ruleId: \'example\',\n  },\n  {\n    title: \'string\',\n    placeholder: \'string\',\n    used_by: [\n      {\n        type: \'journey\',\n        source_id: \'journey-xyz789\'\n      }\n    ],\n    rule: {\n      type: \'regex\',\n      conditions: {\n        all: [\n          {\n            fact: \'inputValue\',\n            operator: \'regexMatch\',\n            value: \'string\',\n            params: {\n              errorMessage: \'string\'\n            }\n          },\n          {\n            all: [\n              {\n                fact: \'inputValue\',\n                operator: \'regexMatch\',\n                value: \'string\',\n                params: {\n                  errorMessage: \'string\'\n                }\n              }\n            ]\n          }\n        ]\n      }\n    },\n    contexts: [\n      {\n        schema: \'contract\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteValidationRule`\n\nPermanently deletes a validation rule by ID. Any journeys or entity attributes referencing this rule should be updated before deletion.\n\n`DELETE /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.deleteValidationRule({\n  ruleId: \'example\',\n})\n```\n\n---\n\n### `addUsedByReference`\n\nAdds a single `used_by` reference to an existing validation rule.\n\n`POST /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.addUsedByReference(\n  {\n    ruleId: \'example\',\n  },\n  {\n    type: \'journey\',\n    source_id: \'journey-xyz789\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `removeUsedByReference`\n\nRemoves a specific `used_by` reference from an existing validation rule.\n\n`DELETE /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.removeUsedByReference(\n  {\n    ruleId: \'example\',\n  },\n  {\n    type: \'journey\',\n    source_id: \'journey-xyz789\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "title": "string",\n  "placeholder": "string",\n  "used_by": [\n    {\n      "type": "journey",\n      "source_id": "journey-xyz789"\n    }\n  ],\n  "rule": {\n    "type": "regex",\n    "conditions": {\n      "all": [\n        {\n          "fact": "inputValue",\n          "operator": "regexMatch",\n          "value": "string",\n          "params": {\n            "errorMessage": "string"\n          }\n        },\n        {\n          "all": [\n            {\n              "fact": "inputValue",\n              "operator": "regexMatch",\n              "value": "string",\n              "params": {\n                "errorMessage": "string"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  },\n  "contexts": [\n    {\n      "schema": "contract"\n    }\n  ],\n  "_schema_version": "string",\n  "_id": "string",\n  "_organization_id": "string",\n  "created_at": "string",\n  "updated_at": "string",\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `GetValidationRulesResponse`\n\nResponse envelope for listing all validation rules within an organization.\n\n```ts\ntype GetValidationRulesResponse = {\n  results?: Array<{\n    _schema_version: string\n    _id: string\n    _organization_id: string\n    created_at: string\n    updated_at: string\n    created_by: string\n    updated_by: string\n  }>\n}\n```\n\n### `CreateValidationRuleRequest`\n\n```ts\ntype CreateValidationRuleRequest = object\n```\n\n### `UpdateValidationRuleRequest`\n\n```ts\ntype UpdateValidationRuleRequest = {\n  title?: string\n  placeholder?: string\n  used_by?: Array<{\n    type: "journey" | "entity"\n    schema_slug?: string\n    source_id?: string\n  }>\n  rule?: {\n    type: "regex"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "pattern"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "numeric"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    input_type: "number" | "date" | "text"\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      applies_when?: { ... }\n      allow_failure?: { ... }\n    }>\n  } | {\n    input_type: "document"\n    check: {\n      level: { ... }\n    }\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      allow_failure?: { ... }\n    }>\n  }\n  contexts?: Array<{\n    schema: string\n  }>\n}\n```\n\n### `ValidationRuleBase`\n\n```ts\ntype ValidationRuleBase = {\n  title?: string\n  placeholder?: string\n  used_by?: Array<{\n    type: "journey" | "entity"\n    schema_slug?: string\n    source_id?: string\n  }>\n  rule?: {\n    type: "regex"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "pattern"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    type: "numeric"\n    conditions: {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  } | {\n    input_type: "number" | "date" | "text"\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      applies_when?: { ... }\n      allow_failure?: { ... }\n    }>\n  } | {\n    input_type: "document"\n    check: {\n      level: { ... }\n    }\n    conditions: Array<{\n      id: { ... }\n      operator: { ... }\n      value: { ... }\n      error_message: { ... }\n      allow_failure?: { ... }\n    }>\n  }\n  contexts?: Array<{\n    schema: string\n  }>\n}\n```\n\n### `ValidationRule`\n\nThe Validation rule definition.\n\n```ts\ntype ValidationRule = {\n  _schema_version: string\n  _id: string\n  _organization_id: string\n  created_at: string\n  updated_at: string\n  created_by: string\n  updated_by: string\n}\n```\n\n### `UsedBy`\n\nDescribes where and how a validation rule is applied. Used to track associations between rules and the journeys or entity schemas that reference them.\n\n```ts\ntype UsedBy = {\n  type: "journey" | "entity"\n  schema_slug?: string\n  source_id?: string\n}\n```\n\n### `RegexRuleType`\n\nValidation rule that uses a regular expression to validate input.\n\n```ts\ntype RegexRuleType = {\n  type: "regex"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `PatternRuleType`\n\nValidation rule that uses a sequence of patterns to validate input.\n\n```ts\ntype PatternRuleType = {\n  type: "pattern"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `NumericRuleType`\n\nValidation rule for numeric values, supporting range and digit count constraints.\n\n```ts\ntype NumericRuleType = {\n  type: "numeric"\n  conditions: {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      all: { ... }\n    } | {\n      any: { ... }\n    } | {\n      not: { ... }\n    }\n  }\n}\n```\n\n### `RegexCondition`\n\nCondition definition for a regex-based validation rule (2 levels deep)\n\n```ts\ntype RegexCondition = {\n  all: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }\n}\n```\n\n### `RegexNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype RegexNestedCondition = {\n  all: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "inputValue"\n    operator: "regexMatch"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n    }\n  }\n}\n```\n\n### `RegexFactCondition`\n\nFact-based condition for regex validation\n\n```ts\ntype RegexFactCondition = {\n  fact: "inputValue"\n  operator: "regexMatch"\n  value: string\n  params?: {\n    errorMessage?: string\n  }\n}\n```\n\n### `PatternCondition`\n\nCondition definition for a pattern-based validation rule (2 levels deep)\n\n```ts\ntype PatternCondition = {\n  all: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n  // ...\n}\n```\n\n### `PatternNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype PatternNestedCondition = {\n  all: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "equal" | "notEqual"\n    value: string\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check" | "total-length"\n    operator: "exactlyNDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      start?: { ... }\n      end?: { ... }\n    }\n  } | {\n    fact: "static-check"\n    operator: "in" | "notIn" | "contains" | "doesNotContain"\n    value: string[]\n    params?: {\n  // ...\n}\n```\n\n### `PatternFactCondition`\n\nFact-based condition for pattern validation\n\n```ts\ntype PatternFactCondition = {\n  fact: "total-length"\n  operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n  value: number\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check" | "total-length"\n  operator: "exactlyNDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check"\n  operator: "in" | "notIn" | "contains" | "doesNotContain"\n  value: string[]\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n} | {\n  fact: "static-check"\n  operator: "equal" | "notEqual"\n  value: string\n  params?: {\n    errorMessage?: string\n    start?: number\n    end?: number\n  }\n}\n```\n\n### `NumericCondition`\n\nCondition definition for a numeric-based validation rule (2 levels deep)\n\n```ts\ntype NumericCondition = {\n  all: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    all: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    any: Array<{\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }>\n  } | {\n    not: {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    } | {\n      fact: { ... }\n      operator: { ... }\n      value: { ... }\n      params?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "numeric-value" | "total-length"\n  // ...\n}\n```\n\n### `NumericNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype NumericNestedCondition = {\n  all: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  any: Array<{\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }>\n} | {\n  not: {\n    fact: "numeric-value" | "total-length"\n    operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "integer-digits-count"\n    operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n      allowLeadingZeroes?: { ... }\n    }\n  } | {\n    fact: "decimal-digits-count"\n    operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n    value: number\n    params?: {\n      errorMessage?: { ... }\n    }\n  } | {\n    fact: "has-leading-zeroes"\n    operator: "equal" | "notAllowed"\n    value: boolean\n    params?: {\n      errorMessage?: { ... }\n    }\n  }\n}\n```\n\n### `NumericFactCondition`\n\nFact-based condition for numeric validation\n\n```ts\ntype NumericFactCondition = {\n  fact: "numeric-value" | "total-length"\n  operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n  value: number\n  params?: {\n    errorMessage?: string\n  }\n} | {\n  fact: "integer-digits-count"\n  operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n    allowLeadingZeroes?: boolean\n  }\n} | {\n  fact: "decimal-digits-count"\n  operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n  value: number\n  params?: {\n    errorMessage?: string\n  }\n} | {\n  fact: "has-leading-zeroes"\n  operator: "equal" | "notAllowed"\n  value: boolean\n  params?: {\n    errorMessage?: string\n  }\n}\n```\n\n### `ComparisonRuleType`\n\nDeclarative validation rule (schema version v2). Supports predefined comparison operators\nover number, date and text inputs, with static, dynamic (context path), relative-date and\nexternal (app-provided) comparison values.\n\n\n```ts\ntype ComparisonRuleType = {\n  input_type: "number" | "date" | "text"\n  conditions: Array<{\n    id: string\n    operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n    value: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      min: { ... }\n      max: { ... }\n    } | {\n      source: { ... }\n    }\n    error_message: string\n    applies_when?: {\n      path: { ... }\n      operator: { ... }\n      value?: { ... }\n    }\n    allow_failure?: boolean\n  }>\n}\n```\n\n### `Condition`\n\nA single comparison the input value must satisfy.\n\n```ts\ntype Condition = {\n  id: string\n  operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n  value: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    unit: "days" | "months" | "years"\n    anchor?: "today" | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "range"\n    min: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    } | {\n  // ...\n}\n```\n\n### `Operator`\n\nPredefined comparison operator. Compatibility (enforced at write time):\n- number: equal, notEqual, greaterThan, greaterThanInclusive, lessThan, lessThanInclusive, between, regexMatch,\n  maxDigits, maxDecimals\n- date: dateBefore, dateOnOrBefore, dateAfter, dateOnOrAfter, dateBetween, notInFuture, not\n\n```ts\ntype Operator = "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals"\n```\n\n### `ConditionValue`\n\nThe comparison value of a condition - a scalar, a range of scalars, or nothing (unary operators).\n\n```ts\ntype ConditionValue = {\n  source: "static"\n  data: number | string | boolean\n} | {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "relative_date"\n  offset: number | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  unit: "days" | "months" | "years"\n  anchor?: "today" | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n  // ...\n}\n```\n\n### `ScalarValue`\n\nA single comparison value - static, resolved from context, a relative date, an organisation environment variable, an external value, or a parameter the consuming surface supplies.\n\n```ts\ntype ScalarValue = {\n  source: "static"\n  data: number | string | boolean\n} | {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "relative_date"\n  offset: number | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  unit: "days" | "months" | "years"\n  anchor?: "today" | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n  // ...\n}\n```\n\n### `ValueReference`\n\nA value resolved at evaluation time instead of written into the rule, identified by\n`source`. Each field that accepts a reference lists the sources it allows; a rule using\nany other source is rejected when it is saved.\n\n\n```ts\ntype ValueReference = {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "environment"\n  key: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "external"\n  app_id: string\n  hook_id: string\n  result_id: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n} | {\n  source: "parameter"\n  name: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n  // ...\n}\n```\n\n### `EnvironmentValue`\n\nA comparison value resolved at evaluation time from an organisation environment variable\n(environments-api). The rule stores the key, never the value, so one change to the variable\nreaches every rule that references it and a blueprint install never overwrites the\norganisation\'s own value.\n\nOnly brow\n\n```ts\ntype EnvironmentValue = {\n  source: "environment"\n  key: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n}\n```\n\n### `ExternalValue`\n\nA comparison value produced at evaluation time by an External Values hook of an installed\napp (component type `EXTERNAL_VALUES`). The rule stores the reference only; the value is\nresolved server-side by the external-values-api, which executes the hook\'s HTTP call with\nthe app\'s credentials and retur\n\n```ts\ntype ExternalValue = {\n  source: "external"\n  app_id: string\n  hook_id: string\n  result_id: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n}\n```\n\n### `ParameterValue`\n\nA comparison value supplied by the surface that evaluates the rule, identified by a name\nthe rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface\nbinds the name to a source of its own - a journey binds it to the value of another block -\nand resolves it at evaluation\n\n```ts\ntype ParameterValue = {\n  source: "parameter"\n  name: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n}\n```\n\n### `StaticValue`\n\nA fixed comparison value.\n\n```ts\ntype StaticValue = {\n  source: "static"\n  data: number | string | boolean\n}\n```\n\n### `ContextValue`\n\nA dynamic comparison value resolved from runtime context, e.g. `contract.installment_amount`\nor `previous_reading.value`. The first path segment must match the `name` of a declared\ncontext requirement.\n\n\n```ts\ntype ContextValue = {\n  source: "context"\n  path: string\n  adjust?: {\n    type: "percent" | "absolute"\n    value: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    direction: "increase" | "decrease"\n    rounding?: "up" | "down"\n  }\n}\n```\n\n### `ValueAdjustment`\n\nAdjusts a context-resolved numeric value before comparison, e.g. "context value plus 10 percent".\nUsed to express tolerance bands such as "at most 10% above the current instalment amount".\n\n\n```ts\ntype ValueAdjustment = {\n  type: "percent" | "absolute"\n  value: number | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  direction: "increase" | "decrease"\n  rounding?: "up" | "down"\n}\n```\n\n### `RelativeDateValue`\n\nA date relative to the evaluation moment, e.g. "today minus 30 days". Only valid for date rules.\n\n```ts\ntype RelativeDateValue = {\n  source: "relative_date"\n  offset: number | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  unit: "days" | "months" | "years"\n  anchor?: "today" | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n}\n```\n\n### `RangeValue`\n\nA lower and upper bound for range operators (between, dateBetween, lengthBetween). Bounds are inclusive.\n\n```ts\ntype RangeValue = {\n  source: "range"\n  min: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    unit: "days" | "months" | "years"\n    anchor?: "today" | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  max: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number | {\n  // ...\n}\n```\n\n### `NoValue`\n\nNo comparison value - used by unary operators such as notInFuture / notInPast.\n\n```ts\ntype NoValue = {\n  source: "none"\n}\n```\n\n### `DocumentRuleType`\n\nDeclarative validation rule (schema version v2) for uploaded files. The rule declares how deep\nthe check goes (`check.level`) and the conditions the file must satisfy. Property conditions\n(file type, size, page count, image resolution, blank and password-protected detection) are\ndeterministic and av\n\n```ts\ntype DocumentRuleType = {\n  input_type: "document"\n  check: {\n    level: "basic" | "standard" | "advanced"\n  }\n  conditions: Array<{\n    id: string\n    operator: "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"\n    value: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      min: { ... }\n      max: { ... }\n    } | {\n      source: { ... }\n    } | {\n      source: { ... }\n      types: { ... }\n    } | {\n      source: { ... }\n      text: { ... }\n    }\n    error_message: string\n    allow_failure?: boolean\n  }>\n}\n```\n\n### `DocumentCheck`\n\nHow deep the document check goes. Levels are cumulative.\n\n```ts\ntype DocumentCheck = {\n  level: "basic" | "standard" | "advanced"\n}\n```\n\n### `DocumentCondition`\n\nA single check the uploaded file must satisfy.\n\n```ts\ntype DocumentCondition = {\n  id: string\n  operator: "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"\n  value: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "range"\n    min: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    max: {\n      source: { ... }\n      data: { ... }\n    } | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      offset: { ... }\n      unit: { ... }\n      anchor?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n  } | {\n    source: "none"\n  } | {\n    source: "file_types"\n    types: "image" | "pdf" | "document" | "spreadsheet"[]\n  } | {\n    source: "criteria"\n    text: string\n  }\n  error_message: string\n  allow_failure?: boolean\n}\n```\n\n### `DocumentOperator`\n\nPredefined document check. Value compatibility (enforced at write time):\n- fileTypeIn: `file_types` value listing the accepted file categories.\n- sizeBelow: static integer, maximum file size in bytes.\n- pageCountBetween: `range` of static non-negative integers (inclusive).\n- resolutionAtLeast / reso\n\n```ts\ntype DocumentOperator = "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"\n```\n\n### `DocumentConditionValue`\n\nThe value of a document condition - a static scalar, a range, nothing, accepted file categories, or a free-text criterion.\n\n```ts\ntype DocumentConditionValue = {\n  source: "static"\n  data: number | string | boolean\n} | {\n  source: "range"\n  min: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "relative_date"\n    offset: number | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n    unit: "days" | "months" | "years"\n    anchor?: "today" | {\n      source: { ... }\n      path: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      key: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      app_id: { ... }\n      hook_id: { ... }\n      result_id: { ... }\n      adjust?: { ... }\n    } | {\n      source: { ... }\n      name: { ... }\n      adjust?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n  max: {\n    source: "static"\n    data: number | string | boolean\n  } | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  // ...\n}\n```\n\n### `FileTypesValue`\n\nAccepted file categories; each category expands to a mime list at check time.\n\n```ts\ntype FileTypesValue = {\n  source: "file_types"\n  types: "image" | "pdf" | "document" | "spreadsheet"[]\n}\n```\n\n### `CriteriaValue`\n\nA free-text requirement judged against the document\'s extracted content, e.g. "The photo shows\nan electricity meter with the meter number and the current reading fully legible." One requirement\nper condition keeps results specific and lets each requirement be graded separately.\n\n\n```ts\ntype CriteriaValue = {\n  source: "criteria"\n  text: string\n}\n```\n\n### `AppliesWhen`\n\nOptional precondition on a condition: the condition only takes part in the\nvalidation when this comparison over context holds. Examples: apply the\ndual-tariff reference only when `contract.htnt` is not empty, or run a\nplausibility check only when a context value reaches a threshold.\n\n\n```ts\ntype AppliesWhen = {\n  path: string\n  operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty"\n  value?: number | string | boolean | {\n    source: "context"\n    path: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "environment"\n    key: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "external"\n    app_id: string\n    hook_id: string\n    result_id: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  } | {\n    source: "parameter"\n    name: string\n    adjust?: {\n      type: { ... }\n      value: { ... }\n      direction: { ... }\n      rounding?: { ... }\n    }\n  }\n}\n```\n\n### `ContextRequirement`\n\nAn entity context source the rule needs at evaluation time, referenced by `context`\nvalue paths via the schema slug as their first segment (e.g. `contract.installment_amount`).\nHow the source is resolved (which entity instance) is decided by the consuming surface,\nnot by the rule. Meter reading comp\n\n```ts\ntype ContextRequirement = {\n  schema: string\n}\n```\n';
+
+
+exports.default = validation_rules_default;