@epilot/sdk 2.20.75 → 2.20.77

package/dist/app-7VPZV72D.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/app.json
+var app_default = '# App API\n\n- **Base URL:** `https://app.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/app](https://docs.epilot.io/api/app)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.app.getPublicFacingComponent(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/app\'\n\nconst appClient = getClient()\nauthorize(appClient, () => \'<token>\')\nconst { data } = await appClient.getPublicFacingComponent(...)\n```\n\n## Operations\n\n**App Installation**\n- [`getPublicFacingComponent`](#getpublicfacingcomponent)\n- [`listInstallations`](#listinstallations)\n- [`getInstallation`](#getinstallation)\n- [`install`](#install)\n- [`patchInstallation`](#patchinstallation)\n- [`uninstall`](#uninstall)\n- [`promoteVersion`](#promoteversion)\n- [`resolveOptions`](#resolveoptions)\n\n**App Configuration**\n- [`listConfigurations`](#listconfigurations)\n- [`createConfiguration`](#createconfiguration)\n- [`listPublicConfigurations`](#listpublicconfigurations)\n- [`getPublicConfiguration`](#getpublicconfiguration)\n- [`getConfiguration`](#getconfiguration)\n- [`patchMetadata`](#patchmetadata)\n- [`deleteConfiguration`](#deleteconfiguration)\n- [`createBundleUploadUrl`](#createbundleuploadurl)\n- [`createZipUploadUrl`](#createzipuploadurl)\n- [`createLogoUploadUrl`](#createlogouploadurl)\n- [`deleteLogo`](#deletelogo)\n- [`listVersions`](#listversions)\n- [`getVersion`](#getversion)\n- [`deleteVersion`](#deleteversion)\n- [`patchVersion`](#patchversion)\n- [`getReview`](#getreview)\n- [`createReview`](#createreview)\n- [`createComponent`](#createcomponent)\n- [`patchComponent`](#patchcomponent)\n- [`deleteComponent`](#deletecomponent)\n- [`cloneVersion`](#cloneversion)\n\n**App Analytics**\n- [`queryEvents`](#queryevents)\n- [`ingestEvent`](#ingestevent)\n\n**App Proxy**\n- [`publicProxyGet`](#publicproxyget)\n- [`publicProxyPost`](#publicproxypost)\n- [`publicProxyPut`](#publicproxyput)\n- [`publicProxyPatch`](#publicproxypatch)\n- [`publicProxyDelete`](#publicproxydelete)\n\n**Schemas**\n- [`Role`](#role)\n- [`Options`](#options)\n- [`ObjectField`](#objectfield)\n- [`Option`](#option)\n- [`OptionsRef`](#optionsref)\n- [`S3Reference`](#s3reference)\n- [`ComponentType`](#componenttype)\n- [`FunctionDefinition`](#functiondefinition)\n- [`Author`](#author)\n- [`NotificationConfig`](#notificationconfig)\n- [`NotificationEvent`](#notificationevent)\n- [`BaseComponentCommon`](#basecomponentcommon)\n- [`BaseComponent`](#basecomponent)\n- [`ApiProxyComponent`](#apiproxycomponent)\n- [`ExternalValuesComponent`](#externalvaluescomponent)\n- [`CustomCapabilityComponent`](#customcapabilitycomponent)\n- [`CustomPageComponent`](#custompagecomponent)\n- [`CustomPageConfig`](#custompageconfig)\n- [`JourneyBlockComponent`](#journeyblockcomponent)\n- [`PortalBlockComponent`](#portalblockcomponent)\n- [`ErpInformToolkitComponent`](#erpinformtoolkitcomponent)\n- [`CustomFlowActionComponent`](#customflowactioncomponent)\n- [`BaseCustomActionConfig`](#basecustomactionconfig)\n- [`ExternalIntegrationCustomActionConfig`](#externalintegrationcustomactionconfig)\n- [`FunctionRefCustomActionConfig`](#functionrefcustomactionconfig)\n- [`CustomFlowConfig`](#customflowconfig)\n- [`ExternalProductCatalogComponent`](#externalproductcatalogcomponent)\n- [`ExternalProductCatalogConfig`](#externalproductcatalogconfig)\n- [`ExternalProductCatalogHookProducts`](#externalproductcataloghookproducts)\n- [`ExternalProductCatalogHookProductRecommendations`](#externalproductcataloghookproductrecommendations)\n- [`PortalExtensionComponent`](#portalextensioncomponent)\n- [`PortalExtensionConfig`](#portalextensionconfig)\n- [`PortalExtensionHookRegistrationIdentifiersCheck`](#portalextensionhookregistrationidentifierscheck)\n- [`PortalExtensionHookContractIdentification`](#portalextensionhookcontractidentification)\n- [`PortalExtensionHookMeterReadingPlausibilityCheck`](#portalextensionhookmeterreadingplausibilitycheck)\n- [`PortalExtensionHookPriceDataRetrieval`](#portalextensionhookpricedataretrieval)\n- [`PortalExtensionHookConsumptionDataRetrieval`](#portalextensionhookconsumptiondataretrieval)\n- [`PortalExtensionHookDataExport`](#portalextensionhookdataexport)\n- [`PortalExtensionHookVisualizationMetadata`](#portalextensionhookvisualizationmetadata)\n- [`PortalExtensionHookCostDataRetrieval`](#portalextensionhookcostdataretrieval)\n- [`PortalExtensionHookChangeEmail`](#portalextensionhookchangeemail)\n- [`PortalExtensionHookChangePassword`](#portalextensionhookchangepassword)\n- [`PortalExtensionHookDeleteAccount`](#portalextensionhookdeleteaccount)\n- [`PortalExtensionSeamlessLink`](#portalextensionseamlesslink)\n- [`PortalExtensionAuthBlock`](#portalextensionauthblock)\n- [`PortalExtensionSecureProxy`](#portalextensionsecureproxy)\n- [`ExternalProductCatalogAuthBlock`](#externalproductcatalogauthblock)\n- [`OverrideDevMode`](#overridedevmode)\n- [`JourneyBlockConfig`](#journeyblockconfig)\n- [`PortalBlockConfig`](#portalblockconfig)\n- [`AppBridgeSurfaceConfig`](#appbridgesurfaceconfig)\n- [`PortalBlockSurfaceConfig`](#portalblocksurfaceconfig)\n- [`JourneyBlockComponentArgs`](#journeyblockcomponentargs)\n- [`TextArg`](#textarg)\n- [`BooleanArg`](#booleanarg)\n- [`BlockReferenceArg`](#blockreferencearg)\n- [`EnumArg`](#enumarg)\n- [`BillingFrequency`](#billingfrequency)\n- [`Pricing`](#pricing)\n- [`Audit`](#audit)\n- [`Review`](#review)\n- [`InternalReview`](#internalreview)\n- [`ConfigurationMetadata`](#configurationmetadata)\n- [`ConfigurationVersion`](#configurationversion)\n- [`ApiProxyConfig`](#apiproxyconfig)\n- [`ExternalValuesConfig`](#externalvaluesconfig)\n- [`ExternalValuesHook`](#externalvalueshook)\n- [`ContextRequirement`](#contextrequirement)\n- [`EntityContextRequirement`](#entitycontextrequirement)\n- [`ValueContextRequirement`](#valuecontextrequirement)\n- [`ExternalValuesResult`](#externalvaluesresult)\n- [`Grants`](#grants)\n- [`BlueprintRef`](#blueprintref)\n- [`Installation`](#installation)\n- [`PublicConfiguration`](#publicconfiguration)\n- [`Configuration`](#configuration)\n- [`TranslatedString`](#translatedstring)\n- [`CallerIdentity`](#calleridentity)\n- [`BatchEventRequest`](#batcheventrequest)\n- [`Actor`](#actor)\n- [`AppEventData`](#appeventdata)\n- [`EventsQuery`](#eventsquery)\n- [`EventsQueryResponse`](#eventsqueryresponse)\n- [`RawEvents`](#rawevents)\n- [`AggregatedEvents`](#aggregatedevents)\n\n### `getPublicFacingComponent`\n\nRetrieve public facing components for an installed app\n\n`GET /v1/public/app/{appId}/components/{componentId}`\n\n```ts\nconst { data } = await client.getPublicFacingComponent({\n  appId: \'example\',\n  componentId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "component": {\n    "component_type": "CUSTOM_JOURNEY_BLOCK",\n    "configuration": {\n      "override_dev_mode": {\n        "override_url": "http://localhost:3000"\n      },\n      "component_url": "https://cdn.apps.com/123/v1.0.0/bundle.js",\n      "component_tag": "string",\n      "component_args": [\n        {\n          "type": "text"\n        }\n      ],\n      "component_size": 0,\n      "component_mapping": {}\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `listConfigurations`\n\nList all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.\n\n`GET /v1/app-configurations`\n\n```ts\nconst { data } = await client.listConfigurations({\n  page: 1,\n  pageSize: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "configurations": [\n    {\n      "app_id": "string",\n      "name": "string",\n      "author": {\n        "name": "string",\n        "company": "string",\n        "email": "string"\n      },\n      "dev_mode": true,\n      "versions": ["string"],\n      "public_versions": ["string"],\n      "support_email": "string",\n      "latest_version": "string",\n      "category": "string",\n      "icon_url": "string",\n      "documentation_url": "string",\n      "description": {\n        "en": "string",\n        "de": "string"\n      },\n      "notifications": {\n        "email": "developer@example.com",\n        "events": ["app.installed"]\n      },\n      "owner_org_id": "string",\n      "internal": false,\n      "pricing": {\n        "pricing_type": "FREE",\n        "billing_frequency": "MONTHLY"\n      },\n      "configuration_audit": {\n        "created_at": "string",\n        "created_by": "string",\n        "updated_at": "string",\n        "updated_by": "string"\n      }\n    }\n  ],\n  "pagination": {\n    "total": 0,\n    "page": 0,\n    "pageSize": 0\n  }\n}\n```\n\n</details>\n\n---\n\n### `createConfiguration`\n\nCreate a new private app configuration. To make it public a verification process needs to be triggered\n\n`POST /v1/app-configurations`\n\n```ts\nconst { data } = await client.createConfiguration(\n  null,\n  {\n    name: \'string\',\n    description: {\n      en: \'string\',\n      de: \'string\'\n    },\n    category: \'string\',\n    logo_url_key: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "app_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `listPublicConfigurations`\n\nList all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.\n\n`GET /v1/app-configurations/public`\n\n```ts\nconst { data } = await client.listPublicConfigurations({\n  page: 1,\n  pageSize: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "configurations": [\n    {\n      "app_id": "string",\n      "name": "string",\n      "author": {\n        "name": "string",\n        "company": "string",\n        "email": "string"\n      },\n      "dev_mode": true,\n      "versions": ["string"],\n      "public_versions": ["string"],\n      "support_email": "string",\n      "latest_version": "string",\n      "category": "string",\n      "icon_url": "string",\n      "documentation_url": "string",\n      "description": {\n        "en": "string",\n        "de": "string"\n      },\n      "notifications": {\n        "email": "developer@example.com",\n        "events": ["app.installed"]\n      },\n      "owner_org_id": "string",\n      "internal": false,\n      "pricing": {\n        "pricing_type": "FREE",\n        "billing_frequency": "MONTHLY"\n      },\n      "configuration_audit": {\n        "created_at": "string",\n        "created_by": "string",\n        "updated_at": "string",\n        "updated_by": "string"\n      }\n    }\n  ],\n  "pagination": {\n    "total": 0,\n    "page": 0,\n    "pageSize": 0\n  }\n}\n```\n\n</details>\n\n---\n\n### `getPublicConfiguration`\n\nRetrieve the public configuration of an app to install in your tenant\n\n`GET /v1/app-configurations/public/{appId}`\n\n```ts\nconst { data } = await client.getPublicConfiguration({\n  appId: \'example\',\n  version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "app_id": "string",\n  "support_email": "string",\n  "owner_org_id": "string",\n  "name": "string",\n  "author": {\n    "name": "string",\n    "company": "string",\n    "email": "string"\n  },\n  "dev_mode": true,\n  "category": "string",\n  "icon_url": "string",\n  "documentation_url": "string",\n  "description": {\n    "en": "string",\n    "de": "string"\n  },\n  "pricing": {\n    "pricing_type": "FREE",\n    "billing_frequency": "MONTHLY"\n  },\n  "components": [\n    {\n      "component_type": "CUSTOM_JOURNEY_BLOCK",\n      "configuration": {}\n    }\n  ],\n  "functions": [\n    {\n      "name": "string",\n      "type": "workflow",\n      "label": {},\n      "description": {},\n      "code": "string",\n      "schedule": "rate(30 minutes)",\n      "schedule_timezone": "Europe/Berlin",\n      "schedule_overlap": "skip",\n      "secrets": ["string"]\n    }\n  ],\n  "options": [\n    {\n      "key": "string",\n      "label": "string",\n      "required": true,\n      "description": "string",\n      "repeatable": true,\n      "fields": [],\n      "value": {},\n      "type": "text",\n      "sensitive": true,\n      "configured": true,\n      "lifted": true,\n      "value_updated_at": "string"\n    }\n  ],\n  "is_beta": true,\n  "deprecated_at": "string",\n  "version": "string",\n  "role": {\n    "id": "string",\n    "grants": [\n      {}\n    ]\n  },\n  "blueprint_ref": {\n    "manifest_id": "string",\n    "job_id": "string",\n    "source_blueprint_file": "string"\n  },\n  "latest_version": "string",\n  "public": true,\n  "versions": [\n    {\n      "app_id": "string",\n      "owner_org_id": "string",\n      "components": [],\n      "functions": [],\n      "options": [],\n      "visibility": "private",\n      "public": false,\n      "pending": false,\n      "version": "string",\n      "is_beta": true,\n      "deprecated_at": "string",\n      "changelog": "string",\n      "review_status": "approved",\n      "role": {},\n      "blueprint_ref": {},\n      "version_audit": {}\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getConfiguration`\n\nRetrieve a specific app configuration\n\n`GET /v1/app-configurations/{appId}`\n\n```ts\nconst { data } = await client.getConfiguration({\n  appId: \'example\',\n  version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "app_id": "string",\n  "name": "string",\n  "author": {\n    "name": "string",\n    "company": "string",\n    "email": "string"\n  },\n  "dev_mode": true,\n  "versions": ["string"],\n  "public_versions": ["string"],\n  "support_email": "string",\n  "latest_version": "string",\n  "category": "string",\n  "icon_url": "string",\n  "documentation_url": "string",\n  "description": {\n    "en": "string",\n    "de": "string"\n  },\n  "notifications": {\n    "email": "developer@example.com",\n    "events": ["app.installed"]\n  },\n  "owner_org_id": "string",\n  "internal": false,\n  "pricing": {\n    "pricing_type": "FREE",\n    "billing_frequency": "MONTHLY"\n  },\n  "configuration_audit": {\n    "created_at": "string",\n    "created_by": "string",\n    "updated_at": "string",\n    "updated_by": "string"\n  },\n  "components": [\n    {\n      "component_type": "CUSTOM_JOURNEY_BLOCK",\n      "configuration": {}\n    }\n  ],\n  "functions": [\n    {\n      "name": "string",\n      "type": "workflow",\n      "label": {},\n      "description": {},\n      "code": "string",\n      "schedule": "rate(30 minutes)",\n      "schedule_timezone": "Europe/Berlin",\n      "schedule_overlap": "skip",\n      "secrets": ["string"]\n    }\n  ],\n  "options": [\n    {\n      "key": "string",\n      "label": "string",\n      "required": true,\n      "description": "string",\n      "repeatable": true,\n      "fields": [],\n      "value": {},\n      "type": "text",\n      "sensitive": true,\n      "configured": true,\n      "lifted": true,\n      "value_updated_at": "string"\n    }\n  ],\n  "visibility": "private",\n  "public": false,\n  "pending": false,\n  "version": "string",\n  "is_beta": true,\n  "deprecated_at": "string",\n  "changelog": "string",\n  "review_status": "approved",\n  "role": {\n    "id": "string",\n    "grants": [\n      {}\n    ]\n  },\n  "blueprint_ref": {\n    "manifest_id": "string",\n    "job_id": "string",\n    "source_blueprint_file": "string"\n  },\n  "version_audit": {\n    "created_at": "string",\n    "created_by": "string",\n    "updated_at": "string",\n    "updated_by": "string",\n    "versioned_at": "string",\n    "versioned_by": "string"\n  }\n}\n```\n\n</details>\n\n---\n\n### `patchMetadata`\n\nPatch non-versioned configuration metadata of a given app configuration.\n\n`PATCH /v1/app-configurations/{appId}`\n\n```ts\nconst { data } = await client.patchMetadata(\n  {\n    appId: \'example\',\n  },\n  {\n    name: \'string\',\n    description: {\n      en: \'string\',\n      de: \'string\'\n    },\n    category: \'string\',\n    documentation_url: \'string\',\n    notifications: {\n      email: \'developer@example.com\',\n      events: [\'app.installed\']\n    },\n    pricing: {\n      pricing_type: \'FREE\',\n      billing_frequency: \'MONTHLY\'\n    },\n    logo_url_key: \'string\',\n    support_email: \'string\',\n    dev_mode: true\n  },\n)\n```\n\n---\n\n### `deleteConfiguration`\n\nDelete app configuration\n\n`DELETE /v1/app-configurations/{appId}`\n\n```ts\nconst { data } = await client.deleteConfiguration({\n  appId: \'example\',\n})\n```\n\n---\n\n### `queryEvents`\n\nQuery analytics events for a specific app with flexible filtering\n\n`POST /v1/app-configurations/{appId}/events`\n\n```ts\nconst { data } = await client.queryEvents(\n  {\n    appId: \'example\',\n  },\n  {\n    time_range: {\n      start: \'1970-01-01T00:00:00.000Z\',\n      end: \'1970-01-01T00:00:00.000Z\',\n      preset: \'1h\'\n    },\n    filters: {\n      source: [\'CUSTOM_JOURNEY_BLOCK\'],\n      component_id: [\'string\'],\n      event_type: [\'ERROR\'],\n      correlation_id: \'string\',\n      search: \'string\'\n    },\n    aggregation: {\n      group_by: [\'source\'],\n      metrics: [\'count\']\n    },\n    pagination: {\n      page: 1,\n      page_size: 100,\n      before: \'1970-01-01T00:00:00.000Z\'\n    },\n    sort: {\n      field: \'timestamp\',\n      order: \'desc\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "query": {\n    "time_range": {\n      "start": "1970-01-01T00:00:00.000Z",\n      "end": "1970-01-01T00:00:00.000Z",\n      "preset": "1h"\n    },\n    "filters": {\n      "source": ["CUSTOM_JOURNEY_BLOCK"],\n      "component_id": ["string"],\n      "event_type": ["ERROR"],\n      "correlation_id": "string",\n      "search": "string"\n    },\n    "aggregation": {\n      "group_by": ["source"],\n      "metrics": ["count"]\n    },\n    "pagination": {\n      "page": 1,\n      "page_size": 100,\n      "before": "1970-01-01T00:00:00.000Z"\n    },\n    "sort": {\n      "field": "timestamp",\n      "order": "desc"\n    }\n  },\n  "results": {\n    "type": "raw",\n    "events": [\n      {\n        "app_id": "string",\n        "version": "string",\n        "event_id": "string",\n        "component_id": "string",\n        "timestamp": "string",\n        "correlation_id": "string",\n        "event_type": "ERROR",\n        "source": "CUSTOM_JOURNEY_BLOCK",\n        "actor": {\n          "org_id": "string",\n          "user_id": "string",\n          "type": "user"\n        },\n        "details": {}\n      }\n    ]\n  },\n  "pagination": {\n    "page": 0,\n    "page_size": 0,\n    "total_items": 0,\n    "has_next": true\n  }\n}\n```\n\n</details>\n\n---\n\n### `createBundleUploadUrl`\n\nGenerate a presigned URL for uploading app bundle to /``<app-id>``/bundle.js path\n\n`POST /v1/app-configurations/{appId}/bundle`\n\n```ts\nconst { data } = await client.createBundleUploadUrl(\n  {\n    appId: \'example\',\n  },\n  {\n    version: \'string\',\n    component_id: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "component_id": "string",\n  "component_url": "string",\n  "upload_url": "string",\n  "s3ref": {\n    "bucket": "my-bucket",\n    "key": "manifest.json"\n  },\n  "expires_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createZipUploadUrl`\n\nGenerate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /``<app-id>``/ path\n\n`POST /v1/app-configurations/{appId}/zip`\n\n```ts\nconst { data } = await client.createZipUploadUrl(\n  {\n    appId: \'example\',\n  },\n  {\n    version: \'1.0.0\',\n    component_id: \'string\',\n    filename: \'dist.zip\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "component_id": "string",\n  "upload_url": "string",\n  "artifact_url": "string",\n  "s3ref": {\n    "bucket": "my-bucket",\n    "key": "manifest.json"\n  },\n  "expires_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createLogoUploadUrl`\n\nGenerate a presigned URL for uploading app logo to /``<app-id>``/logo.png path\n\n`POST /v1/app-configurations/{appId}/logo`\n\n```ts\nconst { data } = await client.createLogoUploadUrl(\n  {\n    appId: \'example\',\n  },\n  {\n    filename: \'company-logo.png\',\n    mime_type: \'image/png\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "upload_url": "string",\n  "s3ref": {\n    "bucket": "my-bucket",\n    "key": "manifest.json"\n  },\n  "expires_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteLogo`\n\nDelete the app logo from /``<app-id>``/logo.png path\n\n`DELETE /v1/app-configurations/{appId}/logo`\n\n```ts\nconst { data } = await client.deleteLogo({\n  appId: \'example\',\n})\n```\n\n---\n\n### `listVersions`\n\nRetrieve a list of versions for an app configuration\n\n`GET /v1/app-configurations/{appId}/versions`\n\n```ts\nconst { data } = await client.listVersions({\n  appId: \'example\',\n  page: 1,\n  pageSize: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "versions": [\n    {\n      "app_id": "string",\n      "owner_org_id": "string",\n      "components": [],\n      "functions": [],\n      "options": [],\n      "visibility": "private",\n      "public": false,\n      "pending": false,\n      "version": "string",\n      "is_beta": true,\n      "deprecated_at": "string",\n      "changelog": "string",\n      "review_status": "approved",\n      "role": {},\n      "blueprint_ref": {},\n      "version_audit": {}\n    }\n  ],\n  "pagination": {\n    "total": 0,\n    "page": 0,\n    "pageSize": 0\n  }\n}\n```\n\n</details>\n\n---\n\n### `getVersion`\n\nRetrieve a specific version of an app configuration\n\n`GET /v1/app-configurations/{appId}/versions/{version}`\n\n```ts\nconst { data } = await client.getVersion({\n  appId: \'example\',\n  version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "app_id": "string",\n  "name": "string",\n  "author": {\n    "name": "string",\n    "company": "string",\n    "email": "string"\n  },\n  "dev_mode": true,\n  "versions": ["string"],\n  "public_versions": ["string"],\n  "support_email": "string",\n  "latest_version": "string",\n  "category": "string",\n  "icon_url": "string",\n  "documentation_url": "string",\n  "description": {\n    "en": "string",\n    "de": "string"\n  },\n  "notifications": {\n    "email": "developer@example.com",\n    "events": ["app.installed"]\n  },\n  "owner_org_id": "string",\n  "internal": false,\n  "pricing": {\n    "pricing_type": "FREE",\n    "billing_frequency": "MONTHLY"\n  },\n  "configuration_audit": {\n    "created_at": "string",\n    "created_by": "string",\n    "updated_at": "string",\n    "updated_by": "string"\n  },\n  "components": [\n    {\n      "component_type": "CUSTOM_JOURNEY_BLOCK",\n      "configuration": {}\n    }\n  ],\n  "functions": [\n    {\n      "name": "string",\n      "type": "workflow",\n      "label": {},\n      "description": {},\n      "code": "string",\n      "schedule": "rate(30 minutes)",\n      "schedule_timezone": "Europe/Berlin",\n      "schedule_overlap": "skip",\n      "secrets": ["string"]\n    }\n  ],\n  "options": [\n    {\n      "key": "string",\n      "label": "string",\n      "required": true,\n      "description": "string",\n      "repeatable": true,\n      "fields": [],\n      "value": {},\n      "type": "text",\n      "sensitive": true,\n      "configured": true,\n      "lifted": true,\n      "value_updated_at": "string"\n    }\n  ],\n  "visibility": "private",\n  "public": false,\n  "pending": false,\n  "version": "string",\n  "is_beta": true,\n  "deprecated_at": "string",\n  "changelog": "string",\n  "review_status": "approved",\n  "role": {\n    "id": "string",\n    "grants": [\n      {}\n    ]\n  },\n  "blueprint_ref": {\n    "manifest_id": "string",\n    "job_id": "string",\n    "source_blueprint_file": "string"\n  },\n  "version_audit": {\n    "created_at": "string",\n    "created_by": "string",\n    "updated_at": "string",\n    "updated_by": "string",\n    "versioned_at": "string",\n    "versioned_by": "string"\n  }\n}\n```\n\n</details>\n\n---\n\n### `deleteVersion`\n\nDelete a specific version of an app configuration\n\n`DELETE /v1/app-configurations/{appId}/versions/{version}`\n\n```ts\nconst { data } = await client.deleteVersion({\n  appId: \'example\',\n  version: \'example\',\n})\n```\n\n---\n\n### `patchVersion`\n\nPatch an existing app version\n\n`PATCH /v1/app-configurations/{appId}/versions/{version}`\n\n```ts\nconst { data } = await client.patchVersion(\n  {\n    appId: \'example\',\n    version: \'example\',\n  },\n  {\n    manifest_id: \'string\',\n    role_id: \'string\',\n    grants: [\n      {\n        action: \'string\',\n        resource: \'string\'\n      }\n    ],\n    functions: [\n      {\n        name: \'string\',\n        type: \'workflow\',\n        label: {\n          en: \'string\',\n          de: \'string\'\n        },\n        description: {\n          en: \'string\',\n          de: \'string\'\n        },\n        code: \'string\',\n        schedule: \'rate(30 minutes)\',\n        schedule_timezone: \'Europe/Berlin\',\n        schedule_overlap: \'skip\',\n        secrets: [\'string\']\n      }\n    ],\n    options: [\n      {\n        key: \'string\',\n        label: \'string\',\n        required: true,\n        description: \'string\',\n        repeatable: true,\n        fields: [\n          {\n            key: \'string\',\n            label: \'string\',\n            description: \'string\',\n            required: true,\n            type: \'text\'\n          }\n        ],\n        value: {},\n        type: \'text\',\n        sensitive: true,\n        configured: true,\n        lifted: true,\n        value_updated_at: \'string\'\n      }\n    ],\n    changelog: \'string\'\n  },\n)\n```\n\n---\n\n### `getReview`\n\nRetrieve the review status of a specific app version\n\n`GET /v1/app-configurations/{appId}/versions/{version}/review`\n\n```ts\nconst { data } = await client.getReview({\n  appId: \'example\',\n  version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "review": {\n    "version": "string",\n    "review_status": "approved",\n    "requested_at": "string",\n    "requested_by": "string",\n    "technical_contact": "string",\n    "marketing_contact": "string",\n    "demo_url": "string"\n  }\n}\n```\n\n</details>\n\n---\n\n### `createReview`\n\nSubmit an app version for review to make it public\n\n`POST /v1/app-configurations/{appId}/versions/{version}/review`\n\n```ts\nconst { data } = await client.createReview(\n  {\n    appId: \'example\',\n    version: \'example\',\n  },\n  {\n    technical_contact: \'string\',\n    marketing_contact: \'string\',\n    demo_url: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "review": {\n    "version": "string",\n    "review_status": "approved",\n    "requested_at": "string",\n    "requested_by": "string",\n    "technical_contact": "string",\n    "marketing_contact": "string",\n    "demo_url": "string"\n  }\n}\n```\n\n</details>\n\n---\n\n### `createComponent`\n\nPatch an existing app version to create/add a component\n\n`POST /v1/app-configurations/{appId}/versions/{version}/components`\n\n```ts\nconst { data } = await client.createComponent(\n  {\n    appId: \'example\',\n    version: \'example\',\n  },\n  {\n    component_type: \'CUSTOM_JOURNEY_BLOCK\',\n    configuration: {\n      override_dev_mode: {\n        override_url: \'http://localhost:3000\'\n      },\n      component_url: \'https://cdn.apps.com/123/v1.0.0/bundle.js\',\n      component_tag: \'string\',\n      component_args: [\n        {\n          type: \'text\'\n        }\n      ],\n      component_size: 0,\n      component_mapping: {}\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "component": {\n    "component_type": "CUSTOM_JOURNEY_BLOCK",\n    "configuration": {\n      "override_dev_mode": {\n        "override_url": "http://localhost:3000"\n      },\n      "component_url": "https://cdn.apps.com/123/v1.0.0/bundle.js",\n      "component_tag": "string",\n      "component_args": [\n        {\n          "type": "text"\n        }\n      ],\n      "component_size": 0,\n      "component_mapping": {}\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `patchComponent`\n\nPatch an existing app version to update its components\n\n`PATCH /v1/app-configurations/{appId}/versions/{version}/components/{componentId}`\n\n```ts\nconst { data } = await client.patchComponent(\n  {\n    appId: \'example\',\n    version: \'example\',\n    componentId: \'example\',\n  },\n  {\n    component_type: \'CUSTOM_JOURNEY_BLOCK\',\n    configuration: {\n      override_dev_mode: {\n        override_url: \'http://localhost:3000\'\n      },\n      component_url: \'https://cdn.apps.com/123/v1.0.0/bundle.js\',\n      component_tag: \'string\',\n      component_args: [\n        {\n          type: \'text\'\n        }\n      ],\n      component_size: 0,\n      component_mapping: {}\n    }\n  },\n)\n```\n\n---\n\n### `deleteComponent`\n\nDelete a specific component from an app version\n\n`DELETE /v1/app-configurations/{appId}/versions/{version}/components/{componentId}`\n\n```ts\nconst { data } = await client.deleteComponent({\n  appId: \'example\',\n  version: \'example\',\n  componentId: \'example\',\n})\n```\n\n---\n\n### `cloneVersion`\n\nClone an existing app version to create a new version\n\n`POST /v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}`\n\n```ts\nconst { data } = await client.cloneVersion(\n  {\n    appId: \'example\',\n    sourceVersion: \'example\',\n    targetVersion: \'example\',\n  },\n  {\n    changelog: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "app_id": "string",\n  "version": "string",\n  "status": "pending"\n}\n```\n\n</details>\n\n---\n\n### `listInstallations`\n\nRetrieve a list of installed apps for the organization.\n\n`GET /v1/app`\n\n```ts\nconst { data } = await client.listInstallations({\n  componentType: \'example\',\n  enabled: true,\n  page: 1,\n  pageSize: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "apps": [\n    {\n      "app_id": "string",\n      "installer_org_id": "string",\n      "owner_org_id": "string",\n      "enabled": true,\n      "name": "string",\n      "icon_url": "string",\n      "option_values": [],\n      "components": [],\n      "functions": [],\n      "options": [],\n      "installed_version": "string",\n      "role": "string",\n      "blueprint_ref": {},\n      "installation_audit": {},\n      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n    }\n  ],\n  "pagination": {\n    "total": 0,\n    "page": 0,\n    "pageSize": 0\n  }\n}\n```\n\n</details>\n\n---\n\n### `getInstallation`\n\nRetrieve details of an installed app by its ID.\n\n`GET /v1/app/{appId}`\n\n```ts\nconst { data } = await client.getInstallation({\n  appId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "app_id": "string",\n  "installer_org_id": "string",\n  "owner_org_id": "string",\n  "enabled": true,\n  "name": "string",\n  "icon_url": "string",\n  "option_values": [\n    {\n      "component_id": "string",\n      "options": [\n        {\n          "key": "string",\n          "value": {}\n        }\n      ]\n    }\n  ],\n  "components": [\n    {\n      "component_type": "CUSTOM_JOURNEY_BLOCK",\n      "configuration": {\n        "override_dev_mode": {\n          "override_url": "http://localhost:3000"\n        },\n        "component_url": "https://cdn.apps.com/123/v1.0.0/bundle.js",\n        "component_tag": "string",\n        "component_args": [\n          {\n            "type": "text"\n          }\n        ],\n        "component_size": 0,\n        "component_mapping": {}\n      }\n    }\n  ],\n  "functions": [\n    {\n      "name": "string",\n      "type": "workflow",\n      "label": {\n        "en": "string",\n        "de": "string"\n      },\n      "description": {\n        "en": "string",\n        "de": "string"\n      },\n      "code": "string",\n      "schedule": "rate(30 minutes)",\n      "schedule_timezone": "Europe/Berlin",\n      "schedule_overlap": "skip",\n      "secrets": ["string"]\n    }\n  ],\n  "options": [\n    {\n      "key": "string",\n      "label": "string",\n      "required": true,\n      "description": "string",\n      "repeatable": true,\n      "fields": [\n        {\n          "key": "string",\n          "label": "string",\n          "description": "string",\n          "required": true,\n          "type": "text"\n        }\n      ],\n      "value": {},\n      "type": "text",\n      "sensitive": true,\n      "configured": true,\n      "lifted": true,\n      "value_updated_at": "string"\n    }\n  ],\n  "installed_version": "string",\n  "role": "string",\n  "blueprint_ref": {\n    "manifest_id": "string",\n    "job_id": "string",\n    "source_blueprint_file": "string"\n  },\n  "installation_audit": {\n    "created_at": "string",\n    "created_by": "string",\n    "updated_at": "string",\n    "updated_by": "string"\n  },\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `install`\n\nUpsert app installation by its ID.\n\n`POST /v1/app/{appId}`\n\n```ts\nconst { data } = await client.install(\n  {\n    appId: \'example\',\n  },\n  {\n    version: \'string\',\n    option_values: [\n      {\n        component_id: \'string\',\n        options: [\n          {\n            key: \'string\',\n            value: {}\n          }\n        ]\n      }\n    ],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "app_id": "string",\n  "installer_org_id": "string",\n  "owner_org_id": "string",\n  "enabled": true,\n  "name": "string",\n  "icon_url": "string",\n  "option_values": [\n    {\n      "component_id": "string",\n      "options": [\n        {\n          "key": "string",\n          "value": {}\n        }\n      ]\n    }\n  ],\n  "components": [\n    {\n      "component_type": "CUSTOM_JOURNEY_BLOCK",\n      "configuration": {\n        "override_dev_mode": {\n          "override_url": "http://localhost:3000"\n        },\n        "component_url": "https://cdn.apps.com/123/v1.0.0/bundle.js",\n        "component_tag": "string",\n        "component_args": [\n          {\n            "type": "text"\n          }\n        ],\n        "component_size": 0,\n        "component_mapping": {}\n      }\n    }\n  ],\n  "functions": [\n    {\n      "name": "string",\n      "type": "workflow",\n      "label": {\n        "en": "string",\n        "de": "string"\n      },\n      "description": {\n        "en": "string",\n        "de": "string"\n      },\n      "code": "string",\n      "schedule": "rate(30 minutes)",\n      "schedule_timezone": "Europe/Berlin",\n      "schedule_overlap": "skip",\n      "secrets": ["string"]\n    }\n  ],\n  "options": [\n    {\n      "key": "string",\n      "label": "string",\n      "required": true,\n      "description": "string",\n      "repeatable": true,\n      "fields": [\n        {\n          "key": "string",\n          "label": "string",\n          "description": "string",\n          "required": true,\n          "type": "text"\n        }\n      ],\n      "value": {},\n      "type": "text",\n      "sensitive": true,\n      "configured": true,\n      "lifted": true,\n      "value_updated_at": "string"\n    }\n  ],\n  "installed_version": "string",\n  "role": "string",\n  "blueprint_ref": {\n    "manifest_id": "string",\n    "job_id": "string",\n    "source_blueprint_file": "string"\n  },\n  "installation_audit": {\n    "created_at": "string",\n    "created_by": "string",\n    "updated_at": "string",\n    "updated_by": "string"\n  },\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `patchInstallation`\n\nPatch an installed app by its ID.\n\n`PATCH /v1/app/{appId}`\n\n```ts\nconst { data } = await client.patchInstallation(\n  {\n    appId: \'example\',\n  },\n  {\n    version: \'string\',\n    option_values: [\n      {\n        component_id: \'string\',\n        options: [\n          {\n            key: \'string\',\n            value: {}\n          }\n        ]\n      }\n    ],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n  },\n)\n```\n\n---\n\n### `uninstall`\n\nUninstall an app by its ID.\n\n`DELETE /v1/app/{appId}`\n\n```ts\nconst { data } = await client.uninstall({\n  appId: \'example\',\n})\n```\n\n---\n\n### `promoteVersion`\n\nUpdate an installed app to a new version\n\n`POST /v1/app/{appId}/promote-to/{version}`\n\n```ts\nconst { data } = await client.promoteVersion({\n  appId: \'example\',\n  version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "app_id": "string",\n  "installer_org_id": "string",\n  "owner_org_id": "string",\n  "enabled": true,\n  "name": "string",\n  "icon_url": "string",\n  "option_values": [\n    {\n      "component_id": "string",\n      "options": [\n        {\n          "key": "string",\n          "value": {}\n        }\n      ]\n    }\n  ],\n  "components": [\n    {\n      "component_type": "CUSTOM_JOURNEY_BLOCK",\n      "configuration": {\n        "override_dev_mode": {\n          "override_url": "http://localhost:3000"\n        },\n        "component_url": "https://cdn.apps.com/123/v1.0.0/bundle.js",\n        "component_tag": "string",\n        "component_args": [\n          {\n            "type": "text"\n          }\n        ],\n        "component_size": 0,\n        "component_mapping": {}\n      }\n    }\n  ],\n  "functions": [\n    {\n      "name": "string",\n      "type": "workflow",\n      "label": {\n        "en": "string",\n        "de": "string"\n      },\n      "description": {\n        "en": "string",\n        "de": "string"\n      },\n      "code": "string",\n      "schedule": "rate(30 minutes)",\n      "schedule_timezone": "Europe/Berlin",\n      "schedule_overlap": "skip",\n      "secrets": ["string"]\n    }\n  ],\n  "options": [\n    {\n      "key": "string",\n      "label": "string",\n      "required": true,\n      "description": "string",\n      "repeatable": true,\n      "fields": [\n        {\n          "key": "string",\n          "label": "string",\n          "description": "string",\n          "required": true,\n          "type": "text"\n        }\n      ],\n      "value": {},\n      "type": "text",\n      "sensitive": true,\n      "configured": true,\n      "lifted": true,\n      "value_updated_at": "string"\n    }\n  ],\n  "installed_version": "string",\n  "role": "string",\n  "blueprint_ref": {\n    "manifest_id": "string",\n    "job_id": "string",\n    "source_blueprint_file": "string"\n  },\n  "installation_audit": {\n    "created_at": "string",\n    "created_by": "string",\n    "updated_at": "string",\n    "updated_by": "string"\n  },\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `resolveOptions`\n\nResolve the effective app-level options of an installation, including decrypted sensitive values (secrets). This endpoint accepts epilot internal-auth tokens exclusively (internal service calls, e.g. \n\n`POST /v1/app/{appId}/options/resolve`\n\n```ts\nconst { data } = await client.resolveOptions(\n  {\n    appId: \'example\',\n  },\n  {\n    keys: [\'string\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "options": [\n    {\n      "key": "string",\n      "label": "string",\n      "required": true,\n      "description": "string",\n      "repeatable": true,\n      "fields": [\n        {\n          "key": "string",\n          "label": "string",\n          "description": "string",\n          "required": true,\n          "type": "text"\n        }\n      ],\n      "value": {},\n      "type": "text",\n      "sensitive": true,\n      "configured": true,\n      "lifted": true,\n      "value_updated_at": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `ingestEvent`\n\nInternal endpoint for services to submit app events for analytic purposes\n\n`POST /v1/app-events`\n\n```ts\nconst { data } = await client.ingestEvent(\n  null,\n  {\n    app_id: \'string\',\n    version: \'string\',\n    event_id: \'string\',\n    component_id: \'string\',\n    timestamp: \'string\',\n    correlation_id: \'string\',\n    event_type: \'ERROR\',\n    source: \'CUSTOM_JOURNEY_BLOCK\',\n    actor: {\n      org_id: \'string\',\n      user_id: \'string\',\n      type: \'user\'\n    },\n    details: {}\n  },\n)\n```\n\n---\n\n### `publicProxyGet`\n\nForward a GET request to a registered proxy target from a public-facing component (e.g. journey blocks)\n\n`GET /v1/public/app/{appId}/proxy/{proxyName}/{path}`\n\n```ts\nconst { data } = await client.publicProxyGet({\n  appId: \'example\',\n  proxyName: \'example\',\n  path: \'example\',\n  query: \'example\',\n})\n```\n\n---\n\n### `publicProxyPost`\n\nForward a POST request to a registered proxy target from a public-facing component (e.g. journey blocks)\n\n`POST /v1/public/app/{appId}/proxy/{proxyName}/{path}`\n\n```ts\nconst { data } = await client.publicProxyPost(\n  {\n    appId: \'example\',\n    proxyName: \'example\',\n    path: \'example\',\n    query: \'example\',\n  },\n  {},\n)\n```\n\n---\n\n### `publicProxyPut`\n\nForward a PUT request to a registered proxy target from a public-facing component\n\n`PUT /v1/public/app/{appId}/proxy/{proxyName}/{path}`\n\n```ts\nconst { data } = await client.publicProxyPut(\n  {\n    appId: \'example\',\n    proxyName: \'example\',\n    path: \'example\',\n    query: \'example\',\n  },\n  {},\n)\n```\n\n---\n\n### `publicProxyPatch`\n\nForward a PATCH request to a registered proxy target from a public-facing component\n\n`PATCH /v1/public/app/{appId}/proxy/{proxyName}/{path}`\n\n```ts\nconst { data } = await client.publicProxyPatch(\n  {\n    appId: \'example\',\n    proxyName: \'example\',\n    path: \'example\',\n    query: \'example\',\n  },\n  {},\n)\n```\n\n---\n\n### `publicProxyDelete`\n\nForward a DELETE request to a registered proxy target from a public-facing component\n\n`DELETE /v1/public/app/{appId}/proxy/{proxyName}/{path}`\n\n```ts\nconst { data } = await client.publicProxyDelete({\n  appId: \'example\',\n  proxyName: \'example\',\n  path: \'example\',\n  query: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `Role`\n\n```ts\ntype Role = {\n  id?: string\n  grants?: Array<{\n    action: string\n    resource?: string\n  }>\n}\n```\n\n### `Options`\n\nAn option declaration \u2014 a setting the installing org fills in. Declared at app level.\n\n```ts\ntype Options = {\n  key: string\n  label?: string\n  required?: boolean\n  description?: string\n  repeatable?: boolean\n  fields?: Array<{\n    key: string\n    label?: string\n    description?: string\n    required?: boolean\n    type: "text" | "number" | "boolean" | "secret"\n  }>\n  value?: unknown\n  type: "text" | "number" | "boolean" | "secret" | "object"\n  sensitive?: boolean\n  configured?: boolean\n  lifted?: boolean\n  value_updated_at?: string\n}\n```\n\n### `ObjectField`\n\nOne declared field inside a `type: object` option. Fields are primitives \u2014 object nesting\nis not supported.\n\n\n```ts\ntype ObjectField = {\n  key: string\n  label?: string\n  description?: string\n  required?: boolean\n  type: "text" | "number" | "boolean" | "secret"\n}\n```\n\n### `Option`\n\n```ts\ntype Option = {\n  key: string\n  value: unknown\n}\n```\n\n### `OptionsRef`\n\n```ts\ntype OptionsRef = {\n  component_id: string\n  options: Array<{\n    key: string\n    value: unknown\n  }>\n}\n```\n\n### `S3Reference`\n\n```ts\ntype S3Reference = {\n  bucket: string\n  key: string\n}\n```\n\n### `ComponentType`\n\nType of app component\n\n```ts\ntype ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE" | "API_PROXY" | "EXTERNAL_VALUES" | "APP_FUNCTION"\n```\n\n### `FunctionDefinition`\n\nA named server-side function belonging to the app. Runs in the epilot code-execution sandbox with an installation-scoped app token. Functions with a schedule are executed automatically once per installation.\n\n\n```ts\ntype FunctionDefinition = {\n  name: string\n  type: "workflow" | "scheduled"\n  label?: {\n    en?: string\n    de: string\n  }\n  description?: {\n    en?: string\n    de: string\n  }\n  code: string\n  schedule?: string\n  schedule_timezone?: string\n  schedule_overlap?: "skip"\n  secrets?: string[]\n}\n```\n\n### `Author`\n\n```ts\ntype Author = {\n  name?: string\n  company: string\n  email?: string\n}\n```\n\n### `NotificationConfig`\n\n```ts\ntype NotificationConfig = {\n  email?: string // email\n  events?: "app.installed" | "app.uninstalled"[]\n}\n```\n\n### `NotificationEvent`\n\n```ts\ntype NotificationEvent = "app.installed" | "app.uninstalled"\n```\n\n### `BaseComponentCommon`\n\n```ts\ntype BaseComponentCommon = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  description?: {\n    en?: string\n    de: string\n  }\n  options?: Array<{\n    key: string\n    label?: string\n    required?: boolean\n    description?: string\n    repeatable?: boolean\n    fields?: Array<{\n      key: { ... }\n      label?: { ... }\n      description?: { ... }\n      required?: { ... }\n      type: { ... }\n    }>\n    value?: unknown\n    type: "text" | "number" | "boolean" | "secret" | "object"\n    sensitive?: boolean\n    configured?: boolean\n    lifted?: boolean\n    value_updated_at?: string\n  }>\n  uses_options?: string[]\n  surfaces?: object\n}\n```\n\n### `BaseComponent`\n\n```ts\ntype BaseComponent = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  description?: {\n    en?: string\n    de: string\n  }\n  options?: Array<{\n    key: string\n    label?: string\n    required?: boolean\n    description?: string\n    repeatable?: boolean\n    fields?: Array<{\n      key: { ... }\n      label?: { ... }\n      description?: { ... }\n      required?: { ... }\n      type: { ... }\n    }>\n    value?: unknown\n    type: "text" | "number" | "boolean" | "secret" | "object"\n    sensitive?: boolean\n    configured?: boolean\n    lifted?: boolean\n    value_updated_at?: string\n  }>\n  uses_options?: string[]\n  surfaces?: object\n}\n```\n\n### `ApiProxyComponent`\n\n```ts\ntype ApiProxyComponent = {\n  component_type: "API_PROXY"\n  configuration: {\n    name: string\n    target: string\n    auth_type: "header" | "bearer" | "basic" | "oauth2" | "none"\n    auth_header?: string\n    token_url?: string // uri\n    headers?: Record<string, string>\n  }\n}\n```\n\n### `ExternalValuesComponent`\n\nExposes typed values resolved from an external system at runtime (e.g. a meter reading prediction). Consumers such as validation rules reference a hook and one of its results by id. Resolution is performed by the external-values-api on behalf of authenticated epilot 360 users and portal end customer\n\n```ts\ntype ExternalValuesComponent = {\n  component_type: "EXTERNAL_VALUES"\n  configuration: {\n    hooks: Array<{\n      id: { ... }\n      name: { ... }\n      description?: { ... }\n      auth_type?: { ... }\n      auth_header?: { ... }\n      auth_secret?: { ... }\n      auth?: { ... }\n      call: { ... }\n      result: { ... }\n      timeout_ms?: { ... }\n      on_unavailable?: { ... }\n      contexts?: { ... }\n      cache?: { ... }\n      secure_proxy?: { ... }\n    }>\n  }\n}\n```\n\n### `CustomCapabilityComponent`\n\n```ts\ntype CustomCapabilityComponent = {\n  component_type: "CUSTOM_CAPABILITY"\n  configuration: {\n    type?: "tab" | "group" | "widget"\n    allowed_schemas?: string[]\n  }\n  surfaces?: {\n    capability_config?: {\n      app_url?: { ... }\n      zip_url?: { ... }\n      override_url?: { ... }\n    }\n  }\n}\n```\n\n### `CustomPageComponent`\n\n```ts\ntype CustomPageComponent = {\n  component_type: "CUSTOM_PAGE"\n  configuration: {\n    slug: string\n    nav_label?: string\n    nav_icon?: string\n    nav_description?: string\n  }\n  surfaces?: {\n    page?: {\n      app_url?: { ... }\n      zip_url?: { ... }\n      override_url?: { ... }\n    }\n  }\n}\n```\n\n### `CustomPageConfig`\n\n```ts\ntype CustomPageConfig = {\n  slug: string\n  nav_label?: string\n  nav_icon?: string\n  nav_description?: string\n}\n```\n\n### `JourneyBlockComponent`\n\n```ts\ntype JourneyBlockComponent = {\n  component_type: "CUSTOM_JOURNEY_BLOCK"\n  configuration: {\n    override_dev_mode?: {\n      override_url?: { ... }\n    }\n    component_url: string\n    component_tag: string\n    component_args?: Array<{\n      key: { ... }\n      type: { ... }\n      required?: { ... }\n      description?: { ... }\n      label: { ... }\n    }>\n    component_size?: number\n    component_mapping?: Record<string, "string" | "boolean" | "date" | "datetime" | "link" | "number">\n  }\n}\n```\n\n### `PortalBlockComponent`\n\n```ts\ntype PortalBlockComponent = {\n  component_type: "CUSTOM_PORTAL_BLOCK"\n  configuration: object\n  surfaces?: {\n    portal_block?: {\n      app_url?: { ... }\n      zip_url?: { ... }\n      override_url?: { ... }\n      supported_surfaces?: { ... }\n    }\n  }\n}\n```\n\n### `ErpInformToolkitComponent`\n\n```ts\ntype ErpInformToolkitComponent = {\n  component_type: "ERP_INFORM_TOOLKIT"\n  configuration: {\n    type: "inbound" | "outbound"\n  }\n}\n```\n\n### `CustomFlowActionComponent`\n\n```ts\ntype CustomFlowActionComponent = {\n  component_type: "CUSTOM_FLOW_ACTION"\n  configuration: {\n    name?: string\n    description?: string\n    wait_for_callback?: boolean\n    type: "external_integration"\n    external_integration_settings?: {\n      url?: { ... }\n      headers?: { ... }\n    }\n  } | {\n    name?: string\n    description?: string\n    wait_for_callback?: boolean\n    type: "function"\n    function_name: string\n  }\n  surfaces?: {\n    flow_action_config?: {\n      app_url?: { ... }\n      zip_url?: { ... }\n      override_url?: { ... }\n    }\n  }\n}\n```\n\n### `BaseCustomActionConfig`\n\n```ts\ntype BaseCustomActionConfig = {\n  name?: string\n  description?: string\n  wait_for_callback?: boolean\n}\n```\n\n### `ExternalIntegrationCustomActionConfig`\n\n```ts\ntype ExternalIntegrationCustomActionConfig = {\n  name?: string\n  description?: string\n  wait_for_callback?: boolean\n  type: "external_integration"\n  external_integration_settings?: {\n    url?: string\n    headers?: Record<string, unknown>\n  }\n}\n```\n\n### `FunctionRefCustomActionConfig`\n\n```ts\ntype FunctionRefCustomActionConfig = {\n  name?: string\n  description?: string\n  wait_for_callback?: boolean\n  type: "function"\n  function_name: string\n}\n```\n\n### `CustomFlowConfig`\n\nConfiguration of a flow action component. `external_integration` calls an external HTTP endpoint; `function` runs a workflow-type app function in the epilot sandbox.\n\n\n```ts\ntype CustomFlowConfig = {\n  name?: string\n  description?: string\n  wait_for_callback?: boolean\n  type: "external_integration"\n  external_integration_settings?: {\n    url?: string\n    headers?: Record<string, unknown>\n  }\n} | {\n  name?: string\n  description?: string\n  wait_for_callback?: boolean\n  type: "function"\n  function_name: string\n}\n```\n\n### `ExternalProductCatalogComponent`\n\n```ts\ntype ExternalProductCatalogComponent = {\n  component_type: "EXTERNAL_PRODUCT_CATALOG"\n  configuration: {\n    hooks?: Array<{\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      auth?: { ... }\n      call: { ... }\n    } | {\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      auth?: { ... }\n      call: { ... }\n    }>\n  }\n}\n```\n\n### `ExternalProductCatalogConfig`\n\n```ts\ntype ExternalProductCatalogConfig = {\n  hooks?: Array<{\n    id: string\n    name?: {\n      en?: { ... }\n      de: { ... }\n    }\n    type: "products"\n    auth?: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers?: { ... }\n      body?: { ... }\n    }\n    call: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers?: { ... }\n      body?: { ... }\n    }\n  } | {\n    id: string\n    name?: {\n      en?: { ... }\n      de: { ... }\n    }\n    type: "product-recommendations"\n    auth?: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers?: { ... }\n      body?: { ... }\n    }\n    call: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers?: { ... }\n      body?: { ... }\n    }\n  }>\n}\n```\n\n### `ExternalProductCatalogHookProducts`\n\nHook for getting products from an external catalog. This hook makes a call to retrieve product data from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.\n\n\n```ts\ntype ExternalProductCatalogHookProducts = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "products"\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n  }\n}\n```\n\n### `ExternalProductCatalogHookProductRecommendations`\n\nHook for getting product recommendations from an external catalog. This hook makes a call to retrieve product recommendations from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.\n\n\n```ts\ntype ExternalProductCatalogHookProductRecommendations = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "product-recommendations"\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n  }\n}\n```\n\n### `PortalExtensionComponent`\n\n```ts\ntype PortalExtensionComponent = {\n  component_type: "PORTAL_EXTENSION"\n  configuration: {\n    hooks?: Array<{\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      auth?: { ... }\n      call: { ... }\n      resolved?: { ... }\n      use_static_ips?: { ... }\n      secure_proxy?: { ... }\n    } | {\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      auth?: { ... }\n      call: { ... }\n      resolved?: { ... }\n      assignment_mode?: { ... }\n      contact_relation_attribute?: { ... }\n      explanation?: { ... }\n      use_static_ips?: { ... }\n      secure_proxy?: { ... }\n    } | {\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      intervals?: { ... }\n      auth?: { ... }\n      call: { ... }\n      resolved?: { ... }\n      use_static_ips?: { ... }\n      secure_proxy?: { ... }\n    } | {\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      intervals?: { ... }\n      auth?: { ... }\n      call: { ... }\n      resolved?: { ... }\n      use_static_ips?: { ... }\n      secure_proxy?: { ... }\n    } | {\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      block_types?: { ... }\n      auth?: { ... }\n      call: { ... }\n      resolved?: { ... }\n      use_static_ips?: { ... }\n      secure_proxy?: { ... }\n    } | {\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      intervals?: { ... }\n      auth?: { ... }\n      call: { ... }\n      resolved?: { ... }\n      use_static_ips?: { ... }\n      secure_proxy?: { ... }\n    } | {\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      plausibility_mode?: { ... }\n      auth?: { ... }\n      call: { ... }\n      resolved: { ... }\n      use_static_ips?: { ... }\n      secure_proxy?: { ... }\n    } | {\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      auth?: { ... }\n      call: { ... }\n      resolved?: { ... }\n      use_static_ips?: { ... }\n      secure_proxy?: { ... }\n    } | {\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      change_mode?: { ... }\n      require_password_confirmation?: { ... }\n      explanation?: { ... }\n      auth?: { ... }\n      call: { ... }\n      resolved?: { ... }\n      secure_proxy?: { ... }\n    } | {\n      id: { ... }\n      name?: { ... }\n      type: { ... }\n      require_new_password?: { ... }\n      explanation?: { ... }\n  // ...\n}\n```\n\n### `PortalExtensionConfig`\n\n```ts\ntype PortalExtensionConfig = {\n  hooks?: Array<{\n    id: string\n    name?: {\n      en?: { ... }\n      de: { ... }\n    }\n    type: "registrationIdentifiersCheck"\n    auth?: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers?: { ... }\n      body?: { ... }\n      cache?: { ... }\n    }\n    call: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers: { ... }\n      body?: { ... }\n      result: { ... }\n      result_correlation_id?: { ... }\n    }\n    resolved?: {\n      result?: { ... }\n      result_correlation_id?: { ... }\n      error_message_path?: { ... }\n    }\n    use_static_ips?: boolean\n    secure_proxy?: {\n      integration_id: { ... }\n      use_case_slug: { ... }\n    }\n  } | {\n    id: string\n    name?: {\n      en?: { ... }\n      de: { ... }\n    }\n    type: "contractIdentification"\n    auth?: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers?: { ... }\n      body?: { ... }\n      cache?: { ... }\n    }\n    call: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers: { ... }\n      body?: { ... }\n      result?: { ... }\n      result_correlation_id?: { ... }\n    }\n    resolved?: {\n      result?: { ... }\n      result_correlation_id?: { ... }\n      error_message_path?: { ... }\n    }\n    assignment_mode?: "contracts" | "contact_to_contracts" | "contact_to_portal_user"\n    contact_relation_attribute?: string\n    explanation?: {\n      en: { ... }\n    }\n    use_static_ips?: boolean\n    secure_proxy?: {\n      integration_id: { ... }\n      use_case_slug: { ... }\n    }\n  } | {\n    id: string\n    name?: {\n      en?: { ... }\n      de: { ... }\n    }\n    type: "priceDataRetrieval"\n    intervals?: "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y" | "custom"[]\n    auth?: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers?: { ... }\n      body?: { ... }\n      cache?: { ... }\n    }\n    call: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers?: { ... }\n      body?: { ... }\n    }\n    resolved?: {\n      data_path?: { ... }\n      dataPath?: { ... }\n  // ...\n}\n```\n\n### `PortalExtensionHookRegistrationIdentifiersCheck`\n\nHook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:\n  - 200 with contact id if exactly one contact is found\n  - 404 if no contact is found or more th\n\n```ts\ntype PortalExtensionHookRegistrationIdentifiersCheck = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "registrationIdentifiersCheck"\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers: Record<string, string>\n    body?: object\n    result: string\n    result_correlation_id?: string\n  }\n  resolved?: {\n    result?: string\n    result_correlation_id?: string\n    error_message_path?: string\n  }\n  use_static_ips?: boolean\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionHookContractIdentification`\n\nHook that replaces the built-in Contract identification for self-assignment. This hook involves an HTTP request whenever a user is trying to self-assign Contract(s).\nThe expected response http status code to the call is:\n  - 200 if found\n  - 404 if not found\n\nThe following assignment modes are suppo\n\n```ts\ntype PortalExtensionHookContractIdentification = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "contractIdentification"\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers: Record<string, string>\n    body?: object\n    result?: string\n    result_correlation_id?: string\n  }\n  resolved?: {\n    result?: string\n    result_correlation_id?: string\n    error_message_path?: string\n  }\n  assignment_mode?: "contracts" | "contact_to_contracts" | "contact_to_portal_user"\n  contact_relation_attribute?: string\n  explanation?: {\n    en: string\n  }\n  use_static_ips?: boolean\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionHookMeterReadingPlausibilityCheck`\n\nHook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:\n  - 200:\n    If meter reading is plausible, the response should contain:\n      - valid: true\n    If meter re\n\n```ts\ntype PortalExtensionHookMeterReadingPlausibilityCheck = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "meterReadingPlausibilityCheck"\n  plausibility_mode?: "check" | "range"\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    url: string\n    body: Record<string, unknown>\n    headers: Record<string, string>\n  }\n  resolved: {\n    data_path?: string\n    dataPath?: string\n    counter_identifiers?: Record<string, string>\n    valid?: string\n    upper_limit?: string\n    lower_limit?: string\n    error_message_path?: string\n  }\n  use_static_ips?: boolean\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionHookPriceDataRetrieval`\n\nHook that will allow using the specified source as data for price visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:\n  - 200 with the time series data\n\n\n```ts\ntype PortalExtensionHookPriceDataRetrieval = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "priceDataRetrieval"\n  intervals?: "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y" | "custom"[]\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n  }\n  resolved?: {\n    data_path?: string\n    dataPath?: string\n    error_message_path?: string\n  }\n  use_static_ips?: boolean\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionHookConsumptionDataRetrieval`\n\nHook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:\n  - 200 with the time series data\n\n\n```ts\ntype PortalExtensionHookConsumptionDataRetrieval = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "consumptionDataRetrieval"\n  intervals?: "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y" | "custom"[]\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n  }\n  resolved?: {\n    data_path?: string\n    dataPath?: string\n    error_message_path?: string\n  }\n  use_static_ips?: boolean\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionHookDataExport`\n\nGeneric data export hook. When configured on blocks that support it, the portal delegates the export action (e.g. CSV/Excel/PDF download) to the configured external source instead of generating the file itself. Can be used by any block that supports export \u2014 consumption charts, dynamic tariff charts\n\n```ts\ntype PortalExtensionHookDataExport = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "dataExport"\n  block_types?: string[]\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n  }\n  resolved?: {\n    error_message_path?: string\n  }\n  use_static_ips?: boolean\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionHookVisualizationMetadata`\n\nHook that returns runtime metadata describing how a visualization (consumption / price / cost chart) should be rendered for a given portal context (meter, contract, etc). It is invoked by the portal before fetching data, with the same context the data hook would receive, so that the discovery shape \n\n```ts\ntype PortalExtensionHookVisualizationMetadata = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "visualizationMetadata"\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n  }\n  resolved?: {\n    data_path?: string\n    dataPath?: string\n    error_message_path?: string\n  }\n  use_static_ips?: boolean\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionHookCostDataRetrieval`\n\nHook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:\n  - 200 with the time series data\n\n\n```ts\ntype PortalExtensionHookCostDataRetrieval = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "costDataRetrieval"\n  intervals?: "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y" | "custom"[]\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n  }\n  resolved?: {\n    data_path?: string\n    dataPath?: string\n    error_message_path?: string\n  }\n  use_static_ips?: boolean\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionHookChangeEmail`\n\nHook that replaces the built-in change email functionality for portal users. When configured, the portal does not run its own change email flow. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change.\nThe `change_mode` controls what the portal d\n\n```ts\ntype PortalExtensionHookChangeEmail = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "changeEmail"\n  change_mode?: "synchronous" | "asynchronous"\n  require_password_confirmation?: boolean\n  explanation?: {\n    en: string\n  }\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers: Record<string, string>\n    body?: object\n  }\n  resolved?: {\n    error_message_path?: string\n  }\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionHookChangePassword`\n\nHook that replaces the built-in change password functionality for portal users. When configured, the portal does not change the user\'s password itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the password change (most likely by sending the user in\n\n```ts\ntype PortalExtensionHookChangePassword = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "changePassword"\n  require_new_password?: boolean\n  explanation?: {\n    en: string\n  }\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers: Record<string, string>\n    body?: object\n  }\n  resolved?: {\n    error_message_path?: string\n  }\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionHookDeleteAccount`\n\nHook that replaces the built-in delete account functionality for portal users. When configured, the portal does not delete the user itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the deletion.\nThe `deletion_mode` controls what the portal does aft\n\n```ts\ntype PortalExtensionHookDeleteAccount = {\n  id: string\n  name?: {\n    en?: string\n    de: string\n  }\n  type: "deleteAccount"\n  deletion_mode?: "synchronous" | "asynchronous"\n  delete_contact?: "none" | "soft" | "hard"\n  explanation?: {\n    en: string\n  }\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers: Record<string, string>\n    body?: object\n  }\n  resolved?: {\n    error_message_path?: string\n  }\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `PortalExtensionSeamlessLink`\n\n```ts\ntype PortalExtensionSeamlessLink = {\n  id: string\n  name: {\n    en?: string\n    de: string\n  }\n  description?: {\n    en?: string\n    de: string\n  }\n  type: "seamless"\n  condition?: string\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  redirect: {\n    url?: string\n    params?: Record<string, string>\n  }\n}\n```\n\n### `PortalExtensionAuthBlock`\n\n```ts\ntype PortalExtensionAuthBlock = {\n  method?: string\n  url: string\n  params?: Record<string, string>\n  headers?: Record<string, string>\n  body?: Record<string, unknown>\n  cache?: {\n    key: string\n    ttl: string\n  }\n}\n```\n\n### `PortalExtensionSecureProxy`\n\nIf set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips.\n\n```ts\ntype PortalExtensionSecureProxy = {\n  integration_id: string // uuid\n  use_case_slug: string\n}\n```\n\n### `ExternalProductCatalogAuthBlock`\n\n```ts\ntype ExternalProductCatalogAuthBlock = {\n  method?: string\n  url: string\n  params?: Record<string, string>\n  headers?: Record<string, string>\n  body?: Record<string, unknown>\n}\n```\n\n### `OverrideDevMode`\n\nOverride URL when app is in dev mode\n\n```ts\ntype OverrideDevMode = {\n  override_url?: string\n}\n```\n\n### `JourneyBlockConfig`\n\n```ts\ntype JourneyBlockConfig = {\n  override_dev_mode?: {\n    override_url?: string\n  }\n  component_url: string\n  component_tag: string\n  component_args?: Array<{\n    key: string\n    type: "text" | "boolean" | "enum" | "block_reference"\n    required?: boolean\n    description?: {\n      en?: { ... }\n      de: { ... }\n    }\n    label: {\n      en?: { ... }\n      de: { ... }\n    }\n  }>\n  component_size?: number\n  component_mapping?: Record<string, "string" | "boolean" | "date" | "datetime" | "link" | "number">\n}\n```\n\n### `PortalBlockConfig`\n\n```ts\ntype PortalBlockConfig = object\n```\n\n### `AppBridgeSurfaceConfig`\n\n```ts\ntype AppBridgeSurfaceConfig = {\n  app_url?: string\n  zip_url?: string\n  override_url?: string\n}\n```\n\n### `PortalBlockSurfaceConfig`\n\n```ts\ntype PortalBlockSurfaceConfig = {\n  app_url?: string\n  zip_url?: string\n  override_url?: string\n  supported_surfaces?: "main" | "footer_inline" | "footer_left_absolute" | "footer_right_absolute"[]\n}\n```\n\n### `JourneyBlockComponentArgs`\n\n```ts\ntype JourneyBlockComponentArgs = {\n  key: string\n  type: "text" | "boolean" | "enum" | "block_reference"\n  required?: boolean\n  description?: {\n    en?: string\n    de: string\n  }\n  label: {\n    en?: string\n    de: string\n  }\n}\n```\n\n### `TextArg`\n\n```ts\ntype TextArg = {\n  type?: "text"\n}\n```\n\n### `BooleanArg`\n\n```ts\ntype BooleanArg = {\n  type?: "boolean"\n}\n```\n\n### `BlockReferenceArg`\n\nReferences another journey block by its ID. The configuring user picks\na block from the journey via a dropdown in the journey-builder; the\nchosen block\'s ID is stored as the arg value (a string). The bundle can\nthen call `subscribe(blockId, cb)` / `getValue(blockId)` against that ID.\n\n\n```ts\ntype BlockReferenceArg = {\n  type?: "block_reference"\n  allowed_types?: string[]\n}\n```\n\n### `EnumArg`\n\n```ts\ntype EnumArg = {\n  type?: "enum"\n  isMulti?: boolean\n  options: Array<{\n    id: string\n    label: {\n      en?: { ... }\n      de: { ... }\n    }\n  }>\n}\n```\n\n### `BillingFrequency`\n\nHow often the subscription is billed\n\n```ts\ntype BillingFrequency = "MONTHLY" | "QUARTERLY" | "YEARLY" | "CUSTOM"\n```\n\n### `Pricing`\n\n```ts\ntype Pricing = {\n  pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN"\n  billing_frequency?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "CUSTOM"\n}\n```\n\n### `Audit`\n\n```ts\ntype Audit = {\n  created_at?: string\n  created_by?: string\n  updated_at?: string\n  updated_by?: string\n}\n```\n\n### `Review`\n\n```ts\ntype Review = {\n  version?: string\n  review_status?: "approved" | "rejected" | "pending"\n  requested_at?: string\n  requested_by?: string\n  technical_contact?: string\n  marketing_contact?: string\n  demo_url?: string\n}\n```\n\n### `InternalReview`\n\nReview entry including app ownership info, used by internal admin endpoints\n\n```ts\ntype InternalReview = {\n  version?: string\n  review_status?: "approved" | "rejected" | "pending"\n  requested_at?: string\n  requested_by?: string\n  technical_contact?: string\n  marketing_contact?: string\n  demo_url?: string\n  app_id?: string\n  org_id?: string\n  reviewed_by?: string\n  reviewed_at?: string\n}\n```\n\n### `ConfigurationMetadata`\n\nBasic metadata about your app configuration which does not get versioned\n\n```ts\ntype ConfigurationMetadata = {\n  app_id: string\n  name: string\n  author?: {\n    name?: string\n    company: string\n    email?: string\n  }\n  dev_mode?: boolean\n  versions: string[]\n  public_versions?: string[]\n  support_email?: string\n  latest_version: string\n  category?: string\n  icon_url?: string\n  documentation_url?: string\n  description: {\n    en?: string\n    de: string\n  }\n  notifications?: {\n    email?: string // email\n    events?: "app.installed" | "app.uninstalled"[]\n  }\n  owner_org_id: string\n  internal?: boolean\n  pricing?: {\n    pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN"\n    billing_frequency?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "CUSTOM"\n  }\n  configuration_audit?: {\n    created_at?: string\n    created_by?: string\n    updated_at?: string\n    updated_by?: string\n  }\n}\n```\n\n### `ConfigurationVersion`\n\nConfiguration data about your app which is versionable\n\n```ts\ntype ConfigurationVersion = {\n  app_id: string\n  owner_org_id: string\n  components: Array<{\n    id: string\n    name?: {\n      en?: { ... }\n      de: { ... }\n    }\n    description?: {\n      en?: { ... }\n      de: { ... }\n    }\n    options?: Array<{\n      key: { ... }\n      label?: { ... }\n      required?: { ... }\n      description?: { ... }\n      repeatable?: { ... }\n      fields?: { ... }\n      value?: { ... }\n      type: { ... }\n      sensitive?: { ... }\n      configured?: { ... }\n      lifted?: { ... }\n      value_updated_at?: { ... }\n    }>\n    uses_options?: string[]\n    surfaces?: object\n  }>\n  functions?: Array<{\n    name: string\n    type: "workflow" | "scheduled"\n    label?: {\n      en?: { ... }\n      de: { ... }\n    }\n    description?: {\n      en?: { ... }\n      de: { ... }\n    }\n    code: string\n    schedule?: string\n    schedule_timezone?: string\n    schedule_overlap?: "skip"\n    secrets?: string[]\n  }>\n  options?: Array<{\n    key: string\n    label?: string\n    required?: boolean\n    description?: string\n    repeatable?: boolean\n    fields?: Array<{\n      key: { ... }\n      label?: { ... }\n      description?: { ... }\n      required?: { ... }\n      type: { ... }\n    }>\n    value?: unknown\n    type: "text" | "number" | "boolean" | "secret" | "object"\n    sensitive?: boolean\n    configured?: boolean\n    lifted?: boolean\n    value_updated_at?: string\n  }>\n  visibility?: "public" | "private"\n  public?: boolean\n  pending?: boolean\n  version: string\n  is_beta?: boolean\n  deprecated_at?: string\n  changelog?: string\n  review_status?: "approved" | "rejected" | "pending"\n  role?: {\n    id?: string\n    grants?: Array<{\n      action: { ... }\n      resource?: { ... }\n    }>\n  }\n  blueprint_ref?: {\n    manifest_id?: string\n    job_id?: string\n    source_blueprint_file?: string\n  }\n  version_audit: {\n    created_at?: string\n    created_by?: string\n    updated_at?: string\n    updated_by?: string\n    versioned_at?: string\n    versioned_by?: string\n  }\n}\n```\n\n### `ApiProxyConfig`\n\nConfiguration for an API proxy component\n\n```ts\ntype ApiProxyConfig = {\n  name: string\n  target: string\n  auth_type: "header" | "bearer" | "basic" | "oauth2" | "none"\n  auth_header?: string\n  token_url?: string // uri\n  headers?: Record<string, string>\n}\n```\n\n### `ExternalValuesConfig`\n\nConfiguration for an EXTERNAL_VALUES component\n\n```ts\ntype ExternalValuesConfig = {\n  hooks: Array<{\n    id: string\n    name: {\n      en?: { ... }\n      de: { ... }\n    }\n    description?: {\n      en?: { ... }\n      de: { ... }\n    }\n    auth_type?: "none" | "header" | "bearer" | "hmac"\n    auth_header?: string\n    auth_secret?: string\n    auth?: {\n      method?: { ... }\n      url: { ... }\n      params?: { ... }\n      headers?: { ... }\n      body?: { ... }\n      cache?: { ... }\n    }\n    call: {\n      method?: { ... }\n      url: { ... }\n      headers?: { ... }\n      params?: { ... }\n      body?: { ... }\n    }\n    result: Array<{\n      id: { ... }\n      type: { ... }\n      name: { ... }\n      template?: { ... }\n      path?: { ... }\n      jsonata?: { ... }\n    }>\n    timeout_ms?: number\n    on_unavailable?: "skip" | "block"\n    contexts?: Array<{\n      type: { ... }\n      schema: { ... }\n    } | {\n      type: { ... }\n      name: { ... }\n      value_type: { ... }\n    }>\n    cache?: {\n      ttl_seconds: { ... }\n      key?: { ... }\n    }\n    secure_proxy?: {\n      integration_id: { ... }\n      use_case_slug: { ... }\n    }\n  }>\n}\n```\n\n### `ExternalValuesHook`\n\nOne external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and \u2014 for `result` templates \u2014 `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.contract }}`).\n\n`Context` is the name \u2192 v\n\n```ts\ntype ExternalValuesHook = {\n  id: string\n  name: {\n    en?: string\n    de: string\n  }\n  description?: {\n    en?: string\n    de: string\n  }\n  auth_type?: "none" | "header" | "bearer" | "hmac"\n  auth_header?: string\n  auth_secret?: string\n  auth?: {\n    method?: string\n    url: string\n    params?: Record<string, string>\n    headers?: Record<string, string>\n    body?: Record<string, unknown>\n    cache?: {\n      key: { ... }\n      ttl: { ... }\n    }\n  }\n  call: {\n    method?: "GET" | "POST" | "PUT" | "PATCH"\n    url: string\n    headers?: Record<string, string>\n    params?: Record<string, string>\n    body?: Record<string, unknown>\n  }\n  result: Array<{\n    id: string\n    type: "number" | "text" | "date" | "boolean"\n    name: {\n      en?: { ... }\n      de: { ... }\n    }\n    template?: string\n    path?: string\n    jsonata?: string\n  }>\n  timeout_ms?: number\n  on_unavailable?: "skip" | "block"\n  contexts?: Array<{\n    type: "entity"\n    schema: string\n  } | {\n    type: "value"\n    name: string\n    value_type: "number" | "text" | "date" | "boolean"\n  }>\n  cache?: {\n    ttl_seconds: number\n    key?: string\n  }\n  secure_proxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n}\n```\n\n### `ContextRequirement`\n\nA requirement a hook reads from `Context`, discriminated by `type`. More types will be added later; consumers must ignore types they do not know.\n\n```ts\ntype ContextRequirement = {\n  type: "entity"\n  schema: string\n} | {\n  type: "value"\n  name: string\n  value_type: "number" | "text" | "date" | "boolean"\n}\n```\n\n### `EntityContextRequirement`\n\nThe consumer supplies the bound entities of `schema` under `Context.`<schema>``.\n\n```ts\ntype EntityContextRequirement = {\n  type: "entity"\n  schema: string\n}\n```\n\n### `ValueContextRequirement`\n\nThe consumer supplies one scalar value under `Context.`<name>``, e.g. a date the customer entered in a journey block. A value input is optional: the consumer sends it when it has a value and omits it otherwise, so the hook\'s templates must cope with its absence, e.g. `{{ Context.reading_date | default\n\n```ts\ntype ValueContextRequirement = {\n  type: "value"\n  name: string\n  value_type: "number" | "text" | "date" | "boolean"\n}\n```\n\n### `ExternalValuesResult`\n\nA single typed value extracted from the hook response. Exactly one of `template`, `path` or `jsonata` must be set.\n\n\n```ts\ntype ExternalValuesResult = {\n  id: string\n  type: "number" | "text" | "date" | "boolean"\n  name: {\n    en?: string\n    de: string\n  }\n  template?: string\n  path?: string\n  jsonata?: string\n}\n```\n\n### `Grants`\n\nRequired grants for the app in order to call APIs for the installing tenant\n\n```ts\ntype Grants = Array<{\n  action: string\n  resource?: string\n}>\n```\n\n### `BlueprintRef`\n\n```ts\ntype BlueprintRef = {\n  manifest_id?: string\n  job_id?: string\n  source_blueprint_file?: string\n}\n```\n\n### `Installation`\n\nInformation about the installed app. Has configuration data of the installed version\n\n```ts\ntype Installation = {\n  app_id: string\n  installer_org_id: string\n  owner_org_id?: string\n  enabled: boolean\n  name: string\n  icon_url?: string\n  option_values?: Array<{\n    component_id: string\n    options: Array<{\n      key: { ... }\n      value: { ... }\n    }>\n  }>\n  components: Array<{\n    id: string\n    name?: {\n      en?: { ... }\n      de: { ... }\n    }\n    description?: {\n      en?: { ... }\n      de: { ... }\n    }\n    options?: Array<{\n      key: { ... }\n      label?: { ... }\n      required?: { ... }\n      description?: { ... }\n      repeatable?: { ... }\n      fields?: { ... }\n      value?: { ... }\n      type: { ... }\n      sensitive?: { ... }\n      configured?: { ... }\n      lifted?: { ... }\n      value_updated_at?: { ... }\n    }>\n    uses_options?: string[]\n    surfaces?: object\n  }>\n  functions?: Array<{\n    name: string\n    type: "workflow" | "scheduled"\n    label?: {\n      en?: { ... }\n      de: { ... }\n    }\n    description?: {\n      en?: { ... }\n      de: { ... }\n    }\n    code: string\n    schedule?: string\n    schedule_timezone?: string\n    schedule_overlap?: "skip"\n    secrets?: string[]\n  }>\n  options?: Array<{\n    key: string\n    label?: string\n    required?: boolean\n    description?: string\n    repeatable?: boolean\n    fields?: Array<{\n      key: { ... }\n      label?: { ... }\n      description?: { ... }\n      required?: { ... }\n      type: { ... }\n    }>\n    value?: unknown\n    type: "text" | "number" | "boolean" | "secret" | "object"\n    sensitive?: boolean\n    configured?: boolean\n    lifted?: boolean\n    value_updated_at?: string\n  }>\n  installed_version: string\n  role?: string\n  blueprint_ref?: {\n    manifest_id?: string\n    job_id?: string\n    source_blueprint_file?: string\n  }\n  installation_audit?: {\n    created_at?: string\n    created_by?: string\n    updated_at?: string\n    updated_by?: string\n  }\n  _manifest?: string // uuid[]\n}\n```\n\n### `PublicConfiguration`\n\nPublic configuration of the published app\n\n```ts\ntype PublicConfiguration = {\n  app_id: string\n  support_email?: string\n  owner_org_id: string\n  name: string\n  author?: {\n    name?: string\n    company: string\n    email?: string\n  }\n  dev_mode?: boolean\n  category?: string\n  icon_url?: string\n  documentation_url?: string\n  description?: {\n    en?: string\n    de: string\n  }\n  pricing?: {\n    pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN"\n    billing_frequency?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "CUSTOM"\n  }\n  components: Array<{\n    id: string\n    name?: {\n      en?: { ... }\n      de: { ... }\n    }\n    description?: {\n      en?: { ... }\n      de: { ... }\n    }\n    options?: Array<{\n      key: { ... }\n      label?: { ... }\n      required?: { ... }\n      description?: { ... }\n      repeatable?: { ... }\n      fields?: { ... }\n      value?: { ... }\n      type: { ... }\n      sensitive?: { ... }\n      configured?: { ... }\n      lifted?: { ... }\n      value_updated_at?: { ... }\n    }>\n    uses_options?: string[]\n    surfaces?: object\n  }>\n  functions?: Array<{\n    name: string\n    type: "workflow" | "scheduled"\n    label?: {\n      en?: { ... }\n      de: { ... }\n    }\n    description?: {\n      en?: { ... }\n      de: { ... }\n    }\n    code: string\n    schedule?: string\n    schedule_timezone?: string\n    schedule_overlap?: "skip"\n    secrets?: string[]\n  }>\n  options?: Array<{\n    key: string\n    label?: string\n    required?: boolean\n    description?: string\n    repeatable?: boolean\n    fields?: Array<{\n      key: { ... }\n      label?: { ... }\n      description?: { ... }\n      required?: { ... }\n      type: { ... }\n    }>\n    value?: unknown\n    type: "text" | "number" | "boolean" | "secret" | "object"\n    sensitive?: boolean\n    configured?: boolean\n    lifted?: boolean\n    value_updated_at?: string\n  }>\n  is_beta?: boolean\n  deprecated_at?: string\n  version: string\n  role?: {\n    id?: string\n    grants?: Array<{\n      action: { ... }\n      resource?: { ... }\n    }>\n  }\n  blueprint_ref?: {\n    manifest_id?: string\n    job_id?: string\n    source_blueprint_file?: string\n  // ...\n}\n```\n\n### `Configuration`\n\nConfiguration of the published app\n\n```ts\ntype Configuration = {\n  app_id: string\n  name: string\n  author?: {\n    name?: string\n    company: string\n    email?: string\n  }\n  dev_mode?: boolean\n  versions: string[]\n  public_versions?: string[]\n  support_email?: string\n  latest_version: string\n  category?: string\n  icon_url?: string\n  documentation_url?: string\n  description: {\n    en?: string\n    de: string\n  }\n  notifications?: {\n    email?: string // email\n    events?: "app.installed" | "app.uninstalled"[]\n  }\n  owner_org_id: string\n  internal?: boolean\n  pricing?: {\n    pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN"\n    billing_frequency?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "CUSTOM"\n  }\n  configuration_audit?: {\n    created_at?: string\n    created_by?: string\n    updated_at?: string\n    updated_by?: string\n  }\n  components: Array<{\n    id: string\n    name?: {\n      en?: { ... }\n      de: { ... }\n    }\n    description?: {\n      en?: { ... }\n      de: { ... }\n    }\n    options?: Array<{\n      key: { ... }\n      label?: { ... }\n      required?: { ... }\n      description?: { ... }\n      repeatable?: { ... }\n      fields?: { ... }\n      value?: { ... }\n      type: { ... }\n      sensitive?: { ... }\n      configured?: { ... }\n      lifted?: { ... }\n      value_updated_at?: { ... }\n    }>\n    uses_options?: string[]\n    surfaces?: object\n  }>\n  functions?: Array<{\n    name: string\n    type: "workflow" | "scheduled"\n    label?: {\n      en?: { ... }\n      de: { ... }\n    }\n    description?: {\n      en?: { ... }\n      de: { ... }\n    }\n    code: string\n    schedule?: string\n    schedule_timezone?: string\n    schedule_overlap?: "skip"\n    secrets?: string[]\n  }>\n  options?: Array<{\n    key: string\n    label?: string\n    required?: boolean\n    description?: string\n    repeatable?: boolean\n    fields?: Array<{\n      key: { ... }\n      label?: { ... }\n      description?: { ... }\n      required?: { ... }\n      type: { ... }\n    }>\n    value?: unknown\n    type: "text" | "number" | "boolean" | "secret" | "object"\n    sensitive?: boolean\n    configured?: boolean\n    lifted?: boolean\n    value_updated_at?: string\n  }>\n  // ...\n}\n```\n\n### `TranslatedString`\n\n```ts\ntype TranslatedString = {\n  en?: string\n  de: string\n}\n```\n\n### `CallerIdentity`\n\n```ts\ntype CallerIdentity = {\n  name?: unknown\n  org_id: string\n  user_id?: string\n  token_id?: string\n}\n```\n\n### `BatchEventRequest`\n\n```ts\ntype BatchEventRequest = {\n  events: Array<{\n    app_id: string\n    version: string\n    event_id?: string\n    component_id: string\n    timestamp?: string\n    correlation_id?: string\n    event_type: "ERROR" | "WARNING" | "INFO"\n    source: "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE" | "API_PROXY" | "EXTERNAL_VALUES" | "APP_FUNCTION"\n    actor: {\n      org_id?: { ... }\n      user_id?: { ... }\n      type: { ... }\n    }\n    details?: Record<string, unknown>\n  }>\n}\n```\n\n### `Actor`\n\n```ts\ntype Actor = {\n  org_id?: string\n  user_id?: string\n  type: "user" | "system"\n}\n```\n\n### `AppEventData`\n\n```ts\ntype AppEventData = {\n  app_id: string\n  version: string\n  event_id?: string\n  component_id: string\n  timestamp?: string\n  correlation_id?: string\n  event_type: "ERROR" | "WARNING" | "INFO"\n  source: "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE" | "API_PROXY" | "EXTERNAL_VALUES" | "APP_FUNCTION"\n  actor: {\n    org_id?: string\n    user_id?: string\n    type: "user" | "system"\n  }\n  details?: Record<string, unknown>\n}\n```\n\n### `EventsQuery`\n\n```ts\ntype EventsQuery = {\n  time_range?: {\n    start?: string // date-time\n    end?: string // date-time\n    preset?: "1h" | "6h" | "24h" | "7d" | "30d"\n  }\n  filters?: {\n    source?: "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE" | "API_PROXY" | "EXTERNAL_VALUES" | "APP_FUNCTION"[]\n    component_id?: string[]\n    event_type?: "ERROR" | "WARNING" | "INFO"[]\n    correlation_id?: string\n    search?: string\n  }\n  aggregation?: {\n    group_by?: "source" | "component_id" | "event_type" | "hour" | "day"[]\n    metrics?: "count" | "error_rate" | "unique_users"[]\n  }\n  pagination?: {\n    page?: number\n    page_size?: number\n    before?: string // date-time\n  }\n  sort?: {\n    field?: "timestamp" | "event_type" | "component_id"\n    order?: "asc" | "desc"\n  }\n}\n```\n\n### `EventsQueryResponse`\n\n```ts\ntype EventsQueryResponse = {\n  query?: {\n    time_range?: {\n      start?: { ... }\n      end?: { ... }\n      preset?: { ... }\n    }\n    filters?: {\n      source?: { ... }\n      component_id?: { ... }\n      event_type?: { ... }\n      correlation_id?: { ... }\n      search?: { ... }\n    }\n    aggregation?: {\n      group_by?: { ... }\n      metrics?: { ... }\n    }\n    pagination?: {\n      page?: { ... }\n      page_size?: { ... }\n      before?: { ... }\n    }\n    sort?: {\n      field?: { ... }\n      order?: { ... }\n    }\n  }\n  results?: {\n    type?: "raw"\n    events?: Array<{\n      app_id: { ... }\n      version: { ... }\n      event_id?: { ... }\n      component_id: { ... }\n      timestamp?: { ... }\n      correlation_id?: { ... }\n      event_type: { ... }\n      source: { ... }\n      actor: { ... }\n      details?: { ... }\n    }>\n  } | {\n    type?: "aggregated"\n    groups?: Array<{\n      dimensions?: { ... }\n      metrics?: { ... }\n    }>\n  }\n  pagination?: {\n    page?: number\n    page_size?: number\n    total_items?: number\n    has_next?: boolean\n  }\n}\n```\n\n### `RawEvents`\n\n```ts\ntype RawEvents = {\n  type?: "raw"\n  events?: Array<{\n    app_id: string\n    version: string\n    event_id?: string\n    component_id: string\n    timestamp?: string\n    correlation_id?: string\n    event_type: "ERROR" | "WARNING" | "INFO"\n    source: "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE" | "API_PROXY" | "EXTERNAL_VALUES" | "APP_FUNCTION"\n    actor: {\n      org_id?: { ... }\n      user_id?: { ... }\n      type: { ... }\n    }\n    details?: Record<string, unknown>\n  }>\n}\n```\n\n### `AggregatedEvents`\n\n```ts\ntype AggregatedEvents = {\n  type?: "aggregated"\n  groups?: Array<{\n    dimensions?: Record<string, unknown>\n    metrics?: {\n      count?: { ... }\n      error_rate?: { ... }\n    }\n  }>\n}\n```\n';
+
+
+exports.default = app_default;

package/dist/{app.d-CZELwNO3.d.cts → app.d-cnyQ-loP.d.cts}

@@ -919,6 +919,10 @@ declare namespace Components {
                 versioned_by?: string;
             };
         }
+        /**
+         * A requirement a hook reads from `Context`, discriminated by `type`. More types will be added later; consumers must ignore types they do not know.
+         */
+        export type ContextRequirement = /* A requirement a hook reads from `Context`, discriminated by `type`. More types will be added later; consumers must ignore types they do not know. */ /* The consumer supplies the bound entities of `schema` under `Context.<schema>`. */ EntityContextRequirement | /* The consumer supplies one scalar value under `Context.<name>`, e.g. a date the customer entered in a journey block. A value input is optional: the consumer sends it when it has a value and omits it otherwise, so the hook's templates must cope with its absence, e.g. `{{ Context.reading_date | default: "now" | date: "%Y-%m-%d" }}`. `date` values are ISO 8601 strings (`YYYY-MM-DD` or a date-time). */ ValueContextRequirement;
         export interface CustomCapabilityComponent {
             component_type: "CUSTOM_CAPABILITY";
             configuration: {
@@ -986,6 +990,18 @@ declare namespace Components {
              */
             nav_description?: string;
         }
+        /**
+         * The consumer supplies the bound entities of `schema` under `Context.<schema>`.
+         */
+        export interface EntityContextRequirement {
+            type: "entity";
+            /**
+             * Entity schema slug, e.g. `contract`.
+             * example:
+             * contract
+             */
+            schema: string; // ^[a-z0-9_-]{1,100}$
+        }
         export interface EnumArg {
             type?: "enum";
             /**
@@ -1281,17 +1297,17 @@ declare namespace Components {
              * Hooks exposed by this component. Hook ids must be unique within the component.
              */
             hooks: /**
-             * One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.input }}`).
+             * One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.contract }}`).
              *
-             * `Context` is the single name → value map the consumer supplies. The names in it are up to the consumer — by convention the journey runtime passes the validated value of a validation rule as `context.input` and every configured context binding under its own configured name.
+             * `Context` is the name → value map the consumer supplies, one entry per context requirement it bound: `Context.<schema>` for an `entity` requirement, `Context.<name>` for a `value` requirement. Declare what a hook reads from `Context` in `contexts` so consumers can require it.
              *
              */
             ExternalValuesHook[];
         }
         /**
-         * One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.input }}`).
+         * One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.contract }}`).
          *
-         * `Context` is the single name → value map the consumer supplies. The names in it are up to the consumer — by convention the journey runtime passes the validated value of a validation rule as `context.input` and every configured context binding under its own configured name.
+         * `Context` is the name → value map the consumer supplies, one entry per context requirement it bound: `Context.<schema>` for an `entity` requirement, `Context.<name>` for a `value` requirement. Declare what a hook reads from `Context` in `contexts` so consumers can require it.
          *
          */
         export interface ExternalValuesHook {
@@ -1378,6 +1394,10 @@ declare namespace Components {
              * Behaviour when the external system is unavailable (timeout, network or upstream error). `skip`: consumers ignore conditions depending on this hook. `block`: consumers treat the dependent action as not allowed.
              */
             on_unavailable?: "skip" | "block";
+            /**
+             * The requirements the hook reads from `Context` (at most 10). An `entity` requirement means the consumer supplies the bound entities of that schema under `Context.<schema>` (e.g. `{{ Context.contract[0].external_id }}` needs `{ type: entity, schema: contract }`). A `value` requirement means the consumer supplies one scalar value under `Context.<name>` (e.g. `{{ Context.reading_date }}` needs `{ type: value, name: reading_date, value_type: date }`); value inputs are optional at runtime, so templates must cope with their absence. Entity schemas are unique, value names are unique, and a value name must not equal an entity schema of the same hook (both land in `Context`). More requirement types will be added later; consumers must ignore types they do not know.
+             */
+            contexts?: /* A requirement a hook reads from `Context`, discriminated by `type`. More types will be added later; consumers must ignore types they do not know. */ ContextRequirement[];
             /**
              * Response caching. Off when omitted.
              */
@@ -3237,6 +3257,24 @@ declare namespace Components {
              */
             de: string;
         }
+        /**
+         * The consumer supplies one scalar value under `Context.<name>`, e.g. a date the customer entered in a journey block. A value input is optional: the consumer sends it when it has a value and omits it otherwise, so the hook's templates must cope with its absence, e.g. `{{ Context.reading_date | default: "now" | date: "%Y-%m-%d" }}`. `date` values are ISO 8601 strings (`YYYY-MM-DD` or a date-time).
+         */
+        export interface ValueContextRequirement {
+            type: "value";
+            /**
+             * Key under which the value is sent (`Context.<name>`). Same pattern as validation rule parameter names. Unique among the hook's `value` requirements and must not equal the `schema` of an `entity` requirement of the same hook.
+             * example:
+             * reading_date
+             */
+            name: string; // ^[a-z][a-z0-9_]{0,63}$
+            /**
+             * Type of the value: `number` and `boolean` are sent as JSON numbers and booleans, `text` as a string, `date` as an ISO 8601 string (`YYYY-MM-DD` or a date-time).
+             * example:
+             * date
+             */
+            value_type: "number" | "text" | "date" | "boolean";
+        }
     }
 }
 declare namespace Paths {
@@ -4708,11 +4746,13 @@ type ComponentType = Components.Schemas.ComponentType;
 type Configuration = Components.Schemas.Configuration;
 type ConfigurationMetadata = Components.Schemas.ConfigurationMetadata;
 type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
+type ContextRequirement = Components.Schemas.ContextRequirement;
 type CustomCapabilityComponent = Components.Schemas.CustomCapabilityComponent;
 type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
 type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
 type CustomPageComponent = Components.Schemas.CustomPageComponent;
 type CustomPageConfig = Components.Schemas.CustomPageConfig;
+type EntityContextRequirement = Components.Schemas.EntityContextRequirement;
 type EnumArg = Components.Schemas.EnumArg;
 type ErpInformToolkitComponent = Components.Schemas.ErpInformToolkitComponent;
 type EventsQuery = Components.Schemas.EventsQuery;
@@ -4769,5 +4809,6 @@ type Role = Components.Schemas.Role;
 type S3Reference = Components.Schemas.S3Reference;
 type TextArg = Components.Schemas.TextArg;
 type TranslatedString = Components.Schemas.TranslatedString;
+type ValueContextRequirement = Components.Schemas.ValueContextRequirement;
 
-export { type NotificationConfig as $, type Actor as A, type BaseComponent as B, type Client as C, type ErpInformToolkitComponent as D, type EnumArg as E, type EventsQuery as F, type EventsQueryResponse as G, type ExternalIntegrationCustomActionConfig as H, type ExternalProductCatalogAuthBlock as I, type ExternalProductCatalogComponent as J, type ExternalProductCatalogConfig as K, type ExternalProductCatalogHookProductRecommendations as L, type ExternalProductCatalogHookProducts as M, type ExternalValuesComponent as N, type OperationMethods as O, Paths as P, type ExternalValuesConfig as Q, type ExternalValuesHook as R, type ExternalValuesResult as S, type FunctionDefinition as T, type FunctionRefCustomActionConfig as U, type Grants as V, type Installation as W, type InternalReview as X, type JourneyBlockComponent as Y, type JourneyBlockComponentArgs as Z, type JourneyBlockConfig as _, Components as a, type NotificationEvent as a0, type ObjectField as a1, type Option as a2, type Options as a3, type OptionsRef as a4, type OverrideDevMode as a5, type PortalBlockComponent as a6, type PortalBlockConfig as a7, type PortalBlockSurfaceConfig as a8, type PortalExtensionAuthBlock as a9, type PortalExtensionComponent as aa, type PortalExtensionConfig as ab, type PortalExtensionHookChangeEmail as ac, type PortalExtensionHookChangePassword as ad, type PortalExtensionHookConsumptionDataRetrieval as ae, type PortalExtensionHookContractIdentification as af, type PortalExtensionHookCostDataRetrieval as ag, type PortalExtensionHookDataExport as ah, type PortalExtensionHookDeleteAccount as ai, type PortalExtensionHookMeterReadingPlausibilityCheck as aj, type PortalExtensionHookPriceDataRetrieval as ak, type PortalExtensionHookRegistrationIdentifiersCheck as al, type PortalExtensionHookVisualizationMetadata as am, type PortalExtensionSeamlessLink as an, type PortalExtensionSecureProxy as ao, type Pricing as ap, type PublicConfiguration as aq, type RawEvents as ar, type Review as as, type Role as at, type S3Reference as au, type TextArg as av, type TranslatedString as aw, type PathsDictionary as b, type AggregatedEvents as c, type ApiProxyComponent as d, type ApiProxyConfig as e, type AppBridgeSurfaceConfig as f, type AppEventData as g, type Audit as h, type Author as i, type BaseComponentCommon as j, type BaseCustomActionConfig as k, type BatchEventRequest as l, type BillingFrequency as m, type BlockReferenceArg as n, type BlueprintRef as o, type BooleanArg as p, type CallerIdentity as q, type ComponentType as r, type Configuration as s, type ConfigurationMetadata as t, type ConfigurationVersion as u, type CustomCapabilityComponent as v, type CustomFlowActionComponent as w, type CustomFlowConfig as x, type CustomPageComponent as y, type CustomPageConfig as z };
+export { type JourneyBlockComponentArgs as $, type Actor as A, type BaseComponent as B, type Client as C, type CustomPageConfig as D, type EntityContextRequirement as E, type EnumArg as F, type ErpInformToolkitComponent as G, type EventsQuery as H, type EventsQueryResponse as I, type ExternalIntegrationCustomActionConfig as J, type ExternalProductCatalogAuthBlock as K, type ExternalProductCatalogComponent as L, type ExternalProductCatalogConfig as M, type ExternalProductCatalogHookProductRecommendations as N, type OperationMethods as O, Paths as P, type ExternalProductCatalogHookProducts as Q, type ExternalValuesComponent as R, type ExternalValuesConfig as S, type ExternalValuesHook as T, type ExternalValuesResult as U, type FunctionDefinition as V, type FunctionRefCustomActionConfig as W, type Grants as X, type Installation as Y, type InternalReview as Z, type JourneyBlockComponent as _, Components as a, type JourneyBlockConfig as a0, type NotificationConfig as a1, type NotificationEvent as a2, type ObjectField as a3, type Option as a4, type Options as a5, type OptionsRef as a6, type OverrideDevMode as a7, type PortalBlockComponent as a8, type PortalBlockConfig as a9, type PortalBlockSurfaceConfig as aa, type PortalExtensionAuthBlock as ab, type PortalExtensionComponent as ac, type PortalExtensionConfig as ad, type PortalExtensionHookChangeEmail as ae, type PortalExtensionHookChangePassword as af, type PortalExtensionHookConsumptionDataRetrieval as ag, type PortalExtensionHookContractIdentification as ah, type PortalExtensionHookCostDataRetrieval as ai, type PortalExtensionHookDataExport as aj, type PortalExtensionHookDeleteAccount as ak, type PortalExtensionHookMeterReadingPlausibilityCheck as al, type PortalExtensionHookPriceDataRetrieval as am, type PortalExtensionHookRegistrationIdentifiersCheck as an, type PortalExtensionHookVisualizationMetadata as ao, type PortalExtensionSeamlessLink as ap, type PortalExtensionSecureProxy as aq, type Pricing as ar, type PublicConfiguration as as, type RawEvents as at, type Review as au, type Role as av, type S3Reference as aw, type TextArg as ax, type TranslatedString as ay, type ValueContextRequirement as az, type PathsDictionary as b, type AggregatedEvents as c, type ApiProxyComponent as d, type ApiProxyConfig as e, type AppBridgeSurfaceConfig as f, type AppEventData as g, type Audit as h, type Author as i, type BaseComponentCommon as j, type BaseCustomActionConfig as k, type BatchEventRequest as l, type BillingFrequency as m, type BlockReferenceArg as n, type BlueprintRef as o, type BooleanArg as p, type CallerIdentity as q, type ComponentType as r, type Configuration as s, type ConfigurationMetadata as t, type ConfigurationVersion as u, type ContextRequirement as v, type CustomCapabilityComponent as w, type CustomFlowActionComponent as x, type CustomFlowConfig as y, type CustomPageComponent as z };

package/dist/{app.d-CZELwNO3.d.ts → app.d-cnyQ-loP.d.ts}

@@ -919,6 +919,10 @@ declare namespace Components {
                 versioned_by?: string;
             };
         }
+        /**
+         * A requirement a hook reads from `Context`, discriminated by `type`. More types will be added later; consumers must ignore types they do not know.
+         */
+        export type ContextRequirement = /* A requirement a hook reads from `Context`, discriminated by `type`. More types will be added later; consumers must ignore types they do not know. */ /* The consumer supplies the bound entities of `schema` under `Context.<schema>`. */ EntityContextRequirement | /* The consumer supplies one scalar value under `Context.<name>`, e.g. a date the customer entered in a journey block. A value input is optional: the consumer sends it when it has a value and omits it otherwise, so the hook's templates must cope with its absence, e.g. `{{ Context.reading_date | default: "now" | date: "%Y-%m-%d" }}`. `date` values are ISO 8601 strings (`YYYY-MM-DD` or a date-time). */ ValueContextRequirement;
         export interface CustomCapabilityComponent {
             component_type: "CUSTOM_CAPABILITY";
             configuration: {
@@ -986,6 +990,18 @@ declare namespace Components {
              */
             nav_description?: string;
         }
+        /**
+         * The consumer supplies the bound entities of `schema` under `Context.<schema>`.
+         */
+        export interface EntityContextRequirement {
+            type: "entity";
+            /**
+             * Entity schema slug, e.g. `contract`.
+             * example:
+             * contract
+             */
+            schema: string; // ^[a-z0-9_-]{1,100}$
+        }
         export interface EnumArg {
             type?: "enum";
             /**
@@ -1281,17 +1297,17 @@ declare namespace Components {
              * Hooks exposed by this component. Hook ids must be unique within the component.
              */
             hooks: /**
-             * One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.input }}`).
+             * One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.contract }}`).
              *
-             * `Context` is the single name → value map the consumer supplies. The names in it are up to the consumer — by convention the journey runtime passes the validated value of a validation rule as `context.input` and every configured context binding under its own configured name.
+             * `Context` is the name → value map the consumer supplies, one entry per context requirement it bound: `Context.<schema>` for an `entity` requirement, `Context.<name>` for a `value` requirement. Declare what a hook reads from `Context` in `contexts` so consumers can require it.
              *
              */
             ExternalValuesHook[];
         }
         /**
-         * One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.input }}`).
+         * One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.contract }}`).
          *
-         * `Context` is the single name → value map the consumer supplies. The names in it are up to the consumer — by convention the journey runtime passes the validated value of a validation rule as `context.input` and every configured context binding under its own configured name.
+         * `Context` is the name → value map the consumer supplies, one entry per context requirement it bound: `Context.<schema>` for an `entity` requirement, `Context.<name>` for a `value` requirement. Declare what a hook reads from `Context` in `contexts` so consumers can require it.
          *
          */
         export interface ExternalValuesHook {
@@ -1378,6 +1394,10 @@ declare namespace Components {
              * Behaviour when the external system is unavailable (timeout, network or upstream error). `skip`: consumers ignore conditions depending on this hook. `block`: consumers treat the dependent action as not allowed.
              */
             on_unavailable?: "skip" | "block";
+            /**
+             * The requirements the hook reads from `Context` (at most 10). An `entity` requirement means the consumer supplies the bound entities of that schema under `Context.<schema>` (e.g. `{{ Context.contract[0].external_id }}` needs `{ type: entity, schema: contract }`). A `value` requirement means the consumer supplies one scalar value under `Context.<name>` (e.g. `{{ Context.reading_date }}` needs `{ type: value, name: reading_date, value_type: date }`); value inputs are optional at runtime, so templates must cope with their absence. Entity schemas are unique, value names are unique, and a value name must not equal an entity schema of the same hook (both land in `Context`). More requirement types will be added later; consumers must ignore types they do not know.
+             */
+            contexts?: /* A requirement a hook reads from `Context`, discriminated by `type`. More types will be added later; consumers must ignore types they do not know. */ ContextRequirement[];
             /**
              * Response caching. Off when omitted.
              */
@@ -3237,6 +3257,24 @@ declare namespace Components {
              */
             de: string;
         }
+        /**
+         * The consumer supplies one scalar value under `Context.<name>`, e.g. a date the customer entered in a journey block. A value input is optional: the consumer sends it when it has a value and omits it otherwise, so the hook's templates must cope with its absence, e.g. `{{ Context.reading_date | default: "now" | date: "%Y-%m-%d" }}`. `date` values are ISO 8601 strings (`YYYY-MM-DD` or a date-time).
+         */
+        export interface ValueContextRequirement {
+            type: "value";
+            /**
+             * Key under which the value is sent (`Context.<name>`). Same pattern as validation rule parameter names. Unique among the hook's `value` requirements and must not equal the `schema` of an `entity` requirement of the same hook.
+             * example:
+             * reading_date
+             */
+            name: string; // ^[a-z][a-z0-9_]{0,63}$
+            /**
+             * Type of the value: `number` and `boolean` are sent as JSON numbers and booleans, `text` as a string, `date` as an ISO 8601 string (`YYYY-MM-DD` or a date-time).
+             * example:
+             * date
+             */
+            value_type: "number" | "text" | "date" | "boolean";
+        }
     }
 }
 declare namespace Paths {
@@ -4708,11 +4746,13 @@ type ComponentType = Components.Schemas.ComponentType;
 type Configuration = Components.Schemas.Configuration;
 type ConfigurationMetadata = Components.Schemas.ConfigurationMetadata;
 type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
+type ContextRequirement = Components.Schemas.ContextRequirement;
 type CustomCapabilityComponent = Components.Schemas.CustomCapabilityComponent;
 type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
 type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
 type CustomPageComponent = Components.Schemas.CustomPageComponent;
 type CustomPageConfig = Components.Schemas.CustomPageConfig;
+type EntityContextRequirement = Components.Schemas.EntityContextRequirement;
 type EnumArg = Components.Schemas.EnumArg;
 type ErpInformToolkitComponent = Components.Schemas.ErpInformToolkitComponent;
 type EventsQuery = Components.Schemas.EventsQuery;
@@ -4769,5 +4809,6 @@ type Role = Components.Schemas.Role;
 type S3Reference = Components.Schemas.S3Reference;
 type TextArg = Components.Schemas.TextArg;
 type TranslatedString = Components.Schemas.TranslatedString;
+type ValueContextRequirement = Components.Schemas.ValueContextRequirement;
 
-export { type NotificationConfig as $, type Actor as A, type BaseComponent as B, type Client as C, type ErpInformToolkitComponent as D, type EnumArg as E, type EventsQuery as F, type EventsQueryResponse as G, type ExternalIntegrationCustomActionConfig as H, type ExternalProductCatalogAuthBlock as I, type ExternalProductCatalogComponent as J, type ExternalProductCatalogConfig as K, type ExternalProductCatalogHookProductRecommendations as L, type ExternalProductCatalogHookProducts as M, type ExternalValuesComponent as N, type OperationMethods as O, Paths as P, type ExternalValuesConfig as Q, type ExternalValuesHook as R, type ExternalValuesResult as S, type FunctionDefinition as T, type FunctionRefCustomActionConfig as U, type Grants as V, type Installation as W, type InternalReview as X, type JourneyBlockComponent as Y, type JourneyBlockComponentArgs as Z, type JourneyBlockConfig as _, Components as a, type NotificationEvent as a0, type ObjectField as a1, type Option as a2, type Options as a3, type OptionsRef as a4, type OverrideDevMode as a5, type PortalBlockComponent as a6, type PortalBlockConfig as a7, type PortalBlockSurfaceConfig as a8, type PortalExtensionAuthBlock as a9, type PortalExtensionComponent as aa, type PortalExtensionConfig as ab, type PortalExtensionHookChangeEmail as ac, type PortalExtensionHookChangePassword as ad, type PortalExtensionHookConsumptionDataRetrieval as ae, type PortalExtensionHookContractIdentification as af, type PortalExtensionHookCostDataRetrieval as ag, type PortalExtensionHookDataExport as ah, type PortalExtensionHookDeleteAccount as ai, type PortalExtensionHookMeterReadingPlausibilityCheck as aj, type PortalExtensionHookPriceDataRetrieval as ak, type PortalExtensionHookRegistrationIdentifiersCheck as al, type PortalExtensionHookVisualizationMetadata as am, type PortalExtensionSeamlessLink as an, type PortalExtensionSecureProxy as ao, type Pricing as ap, type PublicConfiguration as aq, type RawEvents as ar, type Review as as, type Role as at, type S3Reference as au, type TextArg as av, type TranslatedString as aw, type PathsDictionary as b, type AggregatedEvents as c, type ApiProxyComponent as d, type ApiProxyConfig as e, type AppBridgeSurfaceConfig as f, type AppEventData as g, type Audit as h, type Author as i, type BaseComponentCommon as j, type BaseCustomActionConfig as k, type BatchEventRequest as l, type BillingFrequency as m, type BlockReferenceArg as n, type BlueprintRef as o, type BooleanArg as p, type CallerIdentity as q, type ComponentType as r, type Configuration as s, type ConfigurationMetadata as t, type ConfigurationVersion as u, type CustomCapabilityComponent as v, type CustomFlowActionComponent as w, type CustomFlowConfig as x, type CustomPageComponent as y, type CustomPageConfig as z };
+export { type JourneyBlockComponentArgs as $, type Actor as A, type BaseComponent as B, type Client as C, type CustomPageConfig as D, type EntityContextRequirement as E, type EnumArg as F, type ErpInformToolkitComponent as G, type EventsQuery as H, type EventsQueryResponse as I, type ExternalIntegrationCustomActionConfig as J, type ExternalProductCatalogAuthBlock as K, type ExternalProductCatalogComponent as L, type ExternalProductCatalogConfig as M, type ExternalProductCatalogHookProductRecommendations as N, type OperationMethods as O, Paths as P, type ExternalProductCatalogHookProducts as Q, type ExternalValuesComponent as R, type ExternalValuesConfig as S, type ExternalValuesHook as T, type ExternalValuesResult as U, type FunctionDefinition as V, type FunctionRefCustomActionConfig as W, type Grants as X, type Installation as Y, type InternalReview as Z, type JourneyBlockComponent as _, Components as a, type JourneyBlockConfig as a0, type NotificationConfig as a1, type NotificationEvent as a2, type ObjectField as a3, type Option as a4, type Options as a5, type OptionsRef as a6, type OverrideDevMode as a7, type PortalBlockComponent as a8, type PortalBlockConfig as a9, type PortalBlockSurfaceConfig as aa, type PortalExtensionAuthBlock as ab, type PortalExtensionComponent as ac, type PortalExtensionConfig as ad, type PortalExtensionHookChangeEmail as ae, type PortalExtensionHookChangePassword as af, type PortalExtensionHookConsumptionDataRetrieval as ag, type PortalExtensionHookContractIdentification as ah, type PortalExtensionHookCostDataRetrieval as ai, type PortalExtensionHookDataExport as aj, type PortalExtensionHookDeleteAccount as ak, type PortalExtensionHookMeterReadingPlausibilityCheck as al, type PortalExtensionHookPriceDataRetrieval as am, type PortalExtensionHookRegistrationIdentifiersCheck as an, type PortalExtensionHookVisualizationMetadata as ao, type PortalExtensionSeamlessLink as ap, type PortalExtensionSecureProxy as aq, type Pricing as ar, type PublicConfiguration as as, type RawEvents as at, type Review as au, type Role as av, type S3Reference as aw, type TextArg as ax, type TranslatedString as ay, type ValueContextRequirement as az, type PathsDictionary as b, type AggregatedEvents as c, type ApiProxyComponent as d, type ApiProxyConfig as e, type AppBridgeSurfaceConfig as f, type AppEventData as g, type Audit as h, type Author as i, type BaseComponentCommon as j, type BaseCustomActionConfig as k, type BatchEventRequest as l, type BillingFrequency as m, type BlockReferenceArg as n, type BlueprintRef as o, type BooleanArg as p, type CallerIdentity as q, type ComponentType as r, type Configuration as s, type ConfigurationMetadata as t, type ConfigurationVersion as u, type ContextRequirement as v, type CustomCapabilityComponent as w, type CustomFlowActionComponent as x, type CustomFlowConfig as y, type CustomPageComponent as z };

package/dist/{chunk-6B5HXASK.js → chunk-C6T52ZOY.js}

@@ -33,7 +33,7 @@ var globImport_docs = __glob({
   "./docs/address-suggestions.json": () => import("./address-suggestions-74244BAJ.js"),
   "./docs/address.json": () => import("./address-QVJUGMOG.js"),
   "./docs/ai-agents.json": () => import("./ai-agents-5EG5UUP7.js"),
-  "./docs/app.json": () => import("./app-CKQAJ7EE.js"),
+  "./docs/app.json": () => import("./app-3WUZHA43.js"),
   "./docs/audit-logs.json": () => import("./audit-logs-5VXHOQ7S.js"),
   "./docs/automation.json": () => import("./automation-UPTNUOYO.js"),
   "./docs/billing.json": () => import("./billing-UJ6I7FPG.js"),
@@ -52,10 +52,10 @@ var globImport_docs = __glob({
   "./docs/email-template.json": () => import("./email-template-WYROV3UG.js"),
   "./docs/entity-mapping.json": () => import("./entity-mapping-CBRH3VBZ.js"),
   "./docs/entity.json": () => import("./entity-T26ZCCI6.js"),
-  "./docs/environments.json": () => import("./environments-OYCH6VUD.js"),
+  "./docs/environments.json": () => import("./environments-MKY6TF4Z.js"),
   "./docs/erp-integration.json": () => import("./erp-integration-SBQJ6HEG.js"),
   "./docs/event-catalog.json": () => import("./event-catalog-R4ZGZQVY.js"),
-  "./docs/external-values.json": () => import("./external-values-7BS76RVR.js"),
+  "./docs/external-values.json": () => import("./external-values-66ANK66M.js"),
   "./docs/file.json": () => import("./file-N3SGGI6E.js"),
   "./docs/iban.json": () => import("./iban-LDKYDVQV.js"),
   "./docs/identity.json": () => import("./identity-OT3MIWHV.js"),

package/dist/{chunk-JGPHZYSD.cjs → chunk-RZJMF6WE.cjs}

@@ -33,7 +33,7 @@ var globImport_docs = _chunkNJK5F5TFcjs.__glob.call(void 0, {
   "./docs/address-suggestions.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./address-suggestions-IUQMYF27.cjs"))),
   "./docs/address.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./address-HA4RMRNQ.cjs"))),
   "./docs/ai-agents.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./ai-agents-HDLQXHEO.cjs"))),
-  "./docs/app.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./app-ERJHXY64.cjs"))),
+  "./docs/app.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./app-7VPZV72D.cjs"))),
   "./docs/audit-logs.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./audit-logs-D2LFUA2R.cjs"))),
   "./docs/automation.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./automation-G2CKAQNB.cjs"))),
   "./docs/billing.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./billing-CKCFSK6K.cjs"))),
@@ -52,10 +52,10 @@ var globImport_docs = _chunkNJK5F5TFcjs.__glob.call(void 0, {
   "./docs/email-template.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./email-template-M2VVL4TI.cjs"))),
   "./docs/entity-mapping.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./entity-mapping-WE3QMZWA.cjs"))),
   "./docs/entity.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./entity-GZC53ATN.cjs"))),
-  "./docs/environments.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./environments-S3O6ASTY.cjs"))),
+  "./docs/environments.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./environments-QII3AKWU.cjs"))),
   "./docs/erp-integration.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./erp-integration-PAVHSUDM.cjs"))),
   "./docs/event-catalog.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./event-catalog-YYCD2DBK.cjs"))),
-  "./docs/external-values.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./external-values-R2XB2ALG.cjs"))),
+  "./docs/external-values.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./external-values-WET4FHGU.cjs"))),
   "./docs/file.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./file-2KT6MMMG.cjs"))),
   "./docs/iban.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./iban-24GHLFDB.cjs"))),
   "./docs/identity.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./identity-XCFH3MIW.cjs"))),