@epilot/sdk 2.20.81 → 2.20.83

package/docs/targeting.md

@@ -66,6 +66,8 @@ const { data } = await targetingClient.changeCampaignStatus(...)
 - [`JobStatus`](#jobstatus)
 - [`Campaign`](#campaign)
 - [`Target`](#target)
+- [`TargetEntityFilters`](#targetentityfilters)
+- [`TargetSortItem`](#targetsortitem)
 - [`MatchCampaignParams`](#matchcampaignparams)
 - [`NextBestAction`](#nextbestaction)
 - [`DiscoverCampaignsParams`](#discovercampaignsparams)
@@ -305,6 +307,27 @@ const { data } = await client.setupCampaign(
       email: {
         automation_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84',
         template_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84'
+      },
+      entity_ui: {
+        category: 'string',
+        icon: {
+          name: 'string',
+          color: 'string'
+        },
+        title: 'string',
+        body: 'string',
+        priority: 'medium',
+        is_dismissable: true,
+        cta: {
+          type: 'journey',
+          target: 'string',
+          context_params: [
+            {
+              key: 'string',
+              value: 'string'
+            }
+          ]
+        }
       }
     }
   },
@@ -537,7 +560,17 @@ const { data } = await client.matchTargets(
         "name": "string",
         "description": "string",
         "entity_schema": "string",
-        "entity_filters": {}
+        "entity_filters": {
+          "filter": {},
+          "search": "string",
+          "sort": [
+            {
+              "key": "billing_address.postal_code",
+              "order": "asc"
+            }
+          ],
+          "limit": 1
+        }
       }
     }
   ]
@@ -552,6 +585,7 @@ const { data } = await client.matchTargets(
 
 Transform target filters into Lucene queries for the provided target IDs.
 Returns the transformed query string for each target along with any errors encountered.
+If the target defines a sort order or 
 
 `POST /v1/target/queries`
 
@@ -573,7 +607,9 @@ const { data } = await client.getTargetQueries(
     {
       "target_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",
       "query": "string",
-      "error": "string"
+      "error": "string",
+      "sort": ["billing_date:desc", "_title.keyword:asc", "_id:desc"],
+      "limit": 1
     }
   ]
 }
@@ -1218,7 +1254,42 @@ type Target = {
   name?: string
   description?: string
   entity_schema?: string
-  entity_filters?: Record<string, unknown>
+  entity_filters?: {
+    filter?: Record<string, unknown>
+    search?: string
+    sort?: Array<{
+      key: { ... }
+      order: { ... }
+    }>
+    limit?: number
+  }
+}
+```
+
+### `TargetEntityFilters`
+
+Search state of the target. `filter` and `search` use the same shape as the search state of entity views.
+Besides the filters, it optionally defines the order and maximum number of results.
+
+
+```ts
+type TargetEntityFilters = {
+  filter?: Record<string, unknown>
+  search?: string
+  sort?: Array<{
+    key: string
+    order: "asc" | "desc"
+  }>
+  limit?: number
+}
+```
+
+### `TargetSortItem`
+
+```ts
+type TargetSortItem = {
+  key: string
+  order: "asc" | "desc"
 }
 ```
 
@@ -1327,6 +1398,8 @@ type TargetQueryResult = {
   target_id: string // uuid
   query: string
   error?: string
+  sort?: string[]
+  limit?: number
 }
 ```
 
@@ -1541,6 +1614,15 @@ type SetupCampaignRequest = {
       automation_id?: { ... }
       template_id?: { ... }
     }
+    entity_ui?: {
+      category?: { ... }
+      icon?: { ... }
+      title: { ... }
+      body?: { ... }
+      priority?: { ... }
+      is_dismissable?: { ... }
+      cta: { ... }
+    }
   }
 }
 ```
@@ -1576,6 +1658,15 @@ type SetupTariffChangeCampaignRequest = {
       automation_id?: { ... }
       template_id?: { ... }
     }
+    entity_ui?: {
+      category?: { ... }
+      icon?: { ... }
+      title: { ... }
+      body?: { ... }
+      priority?: { ... }
+      is_dismissable?: { ... }
+      cta: { ... }
+    }
   }
 }
 ```

package/package.json

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

package/dist/phone-integration-5EHY236F.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/phone-integration.json
-var phone_integration_default = '# Phone Integration API\n\n- **Base URL:** `https://phone-integration-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/phone-integration](https://docs.epilot.io/api/phone-integration)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.phoneIntegration.batchSearchCustomers(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/phone-integration\'\n\nconst phoneIntegrationClient = getClient()\nauthorize(phoneIntegrationClient, () => \'<token>\')\nconst { data } = await phoneIntegrationClient.batchSearchCustomers(...)\n```\n\n## Operations\n\n**phone-integration**\n- [`batchSearchCustomers`](#batchsearchcustomers)\n\n**manager**\n- [`getManagerStatus`](#getmanagerstatus)\n- [`listPhoneAgents`](#listphoneagents)\n- [`assignPhoneAgent`](#assignphoneagent)\n- [`removePhoneAgent`](#removephoneagent)\n\n**operator**\n- [`getProviderSetup`](#getprovidersetup)\n- [`setupProvider`](#setupprovider)\n\n**Schemas**\n- [`ManagerStatus`](#managerstatus)\n- [`PhoneAgent`](#phoneagent)\n- [`AssignPhoneAgentRequest`](#assignphoneagentrequest)\n- [`ProviderSetup`](#providersetup)\n- [`ProviderSetupRequest`](#providersetuprequest)\n- [`CustomerBatchSearchResult`](#customerbatchsearchresult)\n- [`CustomerSearchResult`](#customersearchresult)\n- [`CustomerIdentifier`](#customeridentifier)\n- [`CustomerSummary`](#customersummary)\n- [`ErrorResponse`](#errorresponse)\n\n### `batchSearchCustomers`\n\nResolves up to 50 identifiers to epilot customers (Contacts) in one\nrequest \u2014 for example every number in an agent\'s call history.\n\n`GET /v1/customer:batchSearch`\n\n```ts\nconst { data } = await client.batchSearchCustomers({\n  id: [\'...\'],\n  customer_number: [\'...\'],\n  external_id: [\'...\'],\n  phone_number: [\'...\'],\n  email: [\'...\'],\n  x-trace-id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "identifier": {\n        "type": "id",\n        "value": "+4917012345678"\n      },\n      "status": "found",\n      "customer": {\n        "id": "dba8e5f9-8b3f-4608-b887-cd0798fce624",\n        "name": "Max Mustermann",\n        "customer_number": "4711"\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getManagerStatus`\n\nWhether the caller\'s organization is ready for phone agents: the telephony provider tenant\nexists and is configured. The control center shows a "not set up" state when `ready` is false.\nRequires `phon\n\n`GET /v1/manager/status`\n\n```ts\nconst { data } = await client.getManagerStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "ready": true,\n  "reasons": ["provider_tenant_missing"]\n}\n```\n\n</details>\n\n---\n\n### `listPhoneAgents`\n\nOrganization members who hold the phone (`phone:use`), each joined with the provider user behind\nthem. Requires `phone:manage`.\n\n`GET /v1/manager/agents`\n\n```ts\nconst { data } = await client.listPhoneAgents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "user_id": "string",\n      "email": "string",\n      "display_name": "string",\n      "status": "active",\n      "provider_user_id": "string",\n      "provider_roles": ["string"],\n      "assigned_at": "1970-01-01T00:00:00.000Z",\n      "assigned_by": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `assignPhoneAgent`\n\nGives an organization member the phone. In order: the member is verified with user-api, their\npairwise subject for the provider is read from identity-api, the provider user is created (or\nfound) bound\n\n`POST /v1/manager/agents`\n\n```ts\nconst { data } = await client.assignPhoneAgent(\n  null,\n  {\n    user_id: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "user_id": "string",\n  "email": "string",\n  "display_name": "string",\n  "status": "active",\n  "provider_user_id": "string",\n  "provider_roles": ["string"],\n  "assigned_at": "1970-01-01T00:00:00.000Z",\n  "assigned_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `removePhoneAgent`\n\nTakes the phone away from a member: the `phone_agent` role is removed first, then the provider\nuser is deactivated (never deleted: call history keeps referring to it). Requires `phone:manage`.\n\n`DELETE /v1/manager/agents/{user_id}`\n\n```ts\nconst { data } = await client.removePhoneAgent({\n  user_id: \'example\',\n})\n```\n\n---\n\n### `getProviderSetup`\n\nWhat has been set up at the telephony provider for this organization.\n\n`GET /v1/operator/organizations/{org_id}/provider`\n\n```ts\nconst { data } = await client.getProviderSetup({\n  org_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "org_id": "string",\n  "ready": true,\n  "tenant": {\n    "id": "string",\n    "name": "string",\n    "org_key": "string",\n    "created_at": "1970-01-01T00:00:00.000Z"\n  },\n  "scim": {\n    "configured": true,\n    "roles_enabled": true\n  },\n  "sso": {\n    "configured": true,\n    "identity_client_id": "string",\n    "configured_at": "1970-01-01T00:00:00.000Z"\n  },\n  "last_setup_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `setupProvider`\n\nPrepares the telephony provider for an organization, idempotently and in order: the provider\ntenant (Babelforce sub-account keyed by the organization id), its SCIM configuration with role\nmanagement o\n\n`POST /v1/operator/organizations/{org_id}/provider:setup`\n\n```ts\nconst { data } = await client.setupProvider(\n  {\n    org_id: \'example\',\n  },\n  {\n    account_name: \'string\',\n    identity_client_id: \'string\',\n    identity_client_secret: \'stringstring\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "org_id": "string",\n  "ready": true,\n  "tenant": {\n    "id": "string",\n    "name": "string",\n    "org_key": "string",\n    "created_at": "1970-01-01T00:00:00.000Z"\n  },\n  "scim": {\n    "configured": true,\n    "roles_enabled": true\n  },\n  "sso": {\n    "configured": true,\n    "identity_client_id": "string",\n    "configured_at": "1970-01-01T00:00:00.000Z"\n  },\n  "last_setup_by": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ManagerStatus`\n\n```ts\ntype ManagerStatus = {\n  provider: "babelforce"\n  ready: boolean\n  reasons: "provider_tenant_missing" | "sso_not_configured" | "scim_not_configured" | "identity_enablement_missing"[]\n}\n```\n\n### `PhoneAgent`\n\n```ts\ntype PhoneAgent = {\n  user_id: string\n  email: string\n  display_name?: string\n  status: "active" | "pending" | "disabled" | "missing_provider" | "missing_role"\n  provider_user_id?: string\n  provider_roles?: string[]\n  assigned_at?: string // date-time\n  assigned_by?: string\n}\n```\n\n### `AssignPhoneAgentRequest`\n\n```ts\ntype AssignPhoneAgentRequest = {\n  user_id: string\n}\n```\n\n### `ProviderSetup`\n\n```ts\ntype ProviderSetup = {\n  provider: "babelforce"\n  org_id: string\n  ready: boolean\n  tenant: {\n    id: string\n    name: string\n    org_key: string\n    created_at?: string // date-time\n  }\n  scim: {\n    configured: boolean\n    roles_enabled: boolean\n  }\n  sso: {\n    configured: boolean\n    identity_client_id?: string\n    configured_at?: string // date-time\n  }\n  last_setup_by?: string\n}\n```\n\n### `ProviderSetupRequest`\n\n```ts\ntype ProviderSetupRequest = {\n  account_name?: string\n  identity_client_id: string\n  identity_client_secret: string\n}\n```\n\n### `CustomerBatchSearchResult`\n\n```ts\ntype CustomerBatchSearchResult = {\n  results: Array<{\n    identifier: {\n      type: { ... }\n      value: { ... }\n    }\n    status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n    customer?: {\n      id: { ... }\n      name: { ... }\n      customer_number?: { ... }\n    }\n  }>\n}\n```\n\n### `CustomerSearchResult`\n\n```ts\ntype CustomerSearchResult = {\n  identifier: {\n    type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n    value: string\n  }\n  status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n  customer?: {\n    id: string\n    name: string\n    customer_number?: string\n  }\n}\n```\n\n### `CustomerIdentifier`\n\n```ts\ntype CustomerIdentifier = {\n  type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n  value: string\n}\n```\n\n### `CustomerSummary`\n\nPresent when `status` is `found`\n\n```ts\ntype CustomerSummary = {\n  id: string\n  name: string\n  customer_number?: string\n}\n```\n\n### `ErrorResponse`\n\n```ts\ntype ErrorResponse = {\n  status: number\n  error: string\n  code?: string\n}\n```\n';
-export {
-  phone_integration_default as default
-};

package/dist/phone-integration-C567S75X.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/phone-integration.json
-var phone_integration_default = '# Phone Integration API\n\n- **Base URL:** `https://phone-integration-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/phone-integration](https://docs.epilot.io/api/phone-integration)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.phoneIntegration.batchSearchCustomers(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/phone-integration\'\n\nconst phoneIntegrationClient = getClient()\nauthorize(phoneIntegrationClient, () => \'<token>\')\nconst { data } = await phoneIntegrationClient.batchSearchCustomers(...)\n```\n\n## Operations\n\n**phone-integration**\n- [`batchSearchCustomers`](#batchsearchcustomers)\n\n**manager**\n- [`getManagerStatus`](#getmanagerstatus)\n- [`listPhoneAgents`](#listphoneagents)\n- [`assignPhoneAgent`](#assignphoneagent)\n- [`removePhoneAgent`](#removephoneagent)\n\n**operator**\n- [`getProviderSetup`](#getprovidersetup)\n- [`setupProvider`](#setupprovider)\n\n**Schemas**\n- [`ManagerStatus`](#managerstatus)\n- [`PhoneAgent`](#phoneagent)\n- [`AssignPhoneAgentRequest`](#assignphoneagentrequest)\n- [`ProviderSetup`](#providersetup)\n- [`ProviderSetupRequest`](#providersetuprequest)\n- [`CustomerBatchSearchResult`](#customerbatchsearchresult)\n- [`CustomerSearchResult`](#customersearchresult)\n- [`CustomerIdentifier`](#customeridentifier)\n- [`CustomerSummary`](#customersummary)\n- [`ErrorResponse`](#errorresponse)\n\n### `batchSearchCustomers`\n\nResolves up to 50 identifiers to epilot customers (Contacts) in one\nrequest \u2014 for example every number in an agent\'s call history.\n\n`GET /v1/customer:batchSearch`\n\n```ts\nconst { data } = await client.batchSearchCustomers({\n  id: [\'...\'],\n  customer_number: [\'...\'],\n  external_id: [\'...\'],\n  phone_number: [\'...\'],\n  email: [\'...\'],\n  x-trace-id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "identifier": {\n        "type": "id",\n        "value": "+4917012345678"\n      },\n      "status": "found",\n      "customer": {\n        "id": "dba8e5f9-8b3f-4608-b887-cd0798fce624",\n        "name": "Max Mustermann",\n        "customer_number": "4711"\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getManagerStatus`\n\nWhether the caller\'s organization is ready for phone agents: the telephony provider tenant\nexists and is configured. The control center shows a "not set up" state when `ready` is false.\nRequires `phon\n\n`GET /v1/manager/status`\n\n```ts\nconst { data } = await client.getManagerStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "ready": true,\n  "reasons": ["provider_tenant_missing"]\n}\n```\n\n</details>\n\n---\n\n### `listPhoneAgents`\n\nOrganization members who hold the phone (`phone:use`), each joined with the provider user behind\nthem. Requires `phone:manage`.\n\n`GET /v1/manager/agents`\n\n```ts\nconst { data } = await client.listPhoneAgents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "user_id": "string",\n      "email": "string",\n      "display_name": "string",\n      "status": "active",\n      "provider_user_id": "string",\n      "provider_roles": ["string"],\n      "assigned_at": "1970-01-01T00:00:00.000Z",\n      "assigned_by": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `assignPhoneAgent`\n\nGives an organization member the phone. In order: the member is verified with user-api, their\npairwise subject for the provider is read from identity-api, the provider user is created (or\nfound) bound\n\n`POST /v1/manager/agents`\n\n```ts\nconst { data } = await client.assignPhoneAgent(\n  null,\n  {\n    user_id: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "user_id": "string",\n  "email": "string",\n  "display_name": "string",\n  "status": "active",\n  "provider_user_id": "string",\n  "provider_roles": ["string"],\n  "assigned_at": "1970-01-01T00:00:00.000Z",\n  "assigned_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `removePhoneAgent`\n\nTakes the phone away from a member: the `phone_agent` role is removed first, then the provider\nuser is deactivated (never deleted: call history keeps referring to it). Requires `phone:manage`.\n\n`DELETE /v1/manager/agents/{user_id}`\n\n```ts\nconst { data } = await client.removePhoneAgent({\n  user_id: \'example\',\n})\n```\n\n---\n\n### `getProviderSetup`\n\nWhat has been set up at the telephony provider for this organization.\n\n`GET /v1/operator/organizations/{org_id}/provider`\n\n```ts\nconst { data } = await client.getProviderSetup({\n  org_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "org_id": "string",\n  "ready": true,\n  "tenant": {\n    "id": "string",\n    "name": "string",\n    "org_key": "string",\n    "created_at": "1970-01-01T00:00:00.000Z"\n  },\n  "scim": {\n    "configured": true,\n    "roles_enabled": true\n  },\n  "sso": {\n    "configured": true,\n    "identity_client_id": "string",\n    "configured_at": "1970-01-01T00:00:00.000Z"\n  },\n  "last_setup_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `setupProvider`\n\nPrepares the telephony provider for an organization, idempotently and in order: the provider\ntenant (Babelforce sub-account keyed by the organization id), its SCIM configuration with role\nmanagement o\n\n`POST /v1/operator/organizations/{org_id}/provider:setup`\n\n```ts\nconst { data } = await client.setupProvider(\n  {\n    org_id: \'example\',\n  },\n  {\n    account_name: \'string\',\n    identity_client_id: \'string\',\n    identity_client_secret: \'stringstring\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "org_id": "string",\n  "ready": true,\n  "tenant": {\n    "id": "string",\n    "name": "string",\n    "org_key": "string",\n    "created_at": "1970-01-01T00:00:00.000Z"\n  },\n  "scim": {\n    "configured": true,\n    "roles_enabled": true\n  },\n  "sso": {\n    "configured": true,\n    "identity_client_id": "string",\n    "configured_at": "1970-01-01T00:00:00.000Z"\n  },\n  "last_setup_by": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ManagerStatus`\n\n```ts\ntype ManagerStatus = {\n  provider: "babelforce"\n  ready: boolean\n  reasons: "provider_tenant_missing" | "sso_not_configured" | "scim_not_configured" | "identity_enablement_missing"[]\n}\n```\n\n### `PhoneAgent`\n\n```ts\ntype PhoneAgent = {\n  user_id: string\n  email: string\n  display_name?: string\n  status: "active" | "pending" | "disabled" | "missing_provider" | "missing_role"\n  provider_user_id?: string\n  provider_roles?: string[]\n  assigned_at?: string // date-time\n  assigned_by?: string\n}\n```\n\n### `AssignPhoneAgentRequest`\n\n```ts\ntype AssignPhoneAgentRequest = {\n  user_id: string\n}\n```\n\n### `ProviderSetup`\n\n```ts\ntype ProviderSetup = {\n  provider: "babelforce"\n  org_id: string\n  ready: boolean\n  tenant: {\n    id: string\n    name: string\n    org_key: string\n    created_at?: string // date-time\n  }\n  scim: {\n    configured: boolean\n    roles_enabled: boolean\n  }\n  sso: {\n    configured: boolean\n    identity_client_id?: string\n    configured_at?: string // date-time\n  }\n  last_setup_by?: string\n}\n```\n\n### `ProviderSetupRequest`\n\n```ts\ntype ProviderSetupRequest = {\n  account_name?: string\n  identity_client_id: string\n  identity_client_secret: string\n}\n```\n\n### `CustomerBatchSearchResult`\n\n```ts\ntype CustomerBatchSearchResult = {\n  results: Array<{\n    identifier: {\n      type: { ... }\n      value: { ... }\n    }\n    status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n    customer?: {\n      id: { ... }\n      name: { ... }\n      customer_number?: { ... }\n    }\n  }>\n}\n```\n\n### `CustomerSearchResult`\n\n```ts\ntype CustomerSearchResult = {\n  identifier: {\n    type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n    value: string\n  }\n  status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n  customer?: {\n    id: string\n    name: string\n    customer_number?: string\n  }\n}\n```\n\n### `CustomerIdentifier`\n\n```ts\ntype CustomerIdentifier = {\n  type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n  value: string\n}\n```\n\n### `CustomerSummary`\n\nPresent when `status` is `found`\n\n```ts\ntype CustomerSummary = {\n  id: string\n  name: string\n  customer_number?: string\n}\n```\n\n### `ErrorResponse`\n\n```ts\ntype ErrorResponse = {\n  status: number\n  error: string\n  code?: string\n}\n```\n';
-
-
-exports.default = phone_integration_default;

package/dist/targeting-2JCGF4IR.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/targeting.json
-var targeting_default = '# Targeting API\n\n- **Base URL:** `https://targeting.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/targeting](https://docs.epilot.io/api/targeting)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.targeting.changeCampaignStatus(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/targeting\'\n\nconst targetingClient = getClient()\nauthorize(targetingClient, () => \'<token>\')\nconst { data } = await targetingClient.changeCampaignStatus(...)\n```\n\n## Operations\n\n**Campaign**\n- [`changeCampaignStatus`](#changecampaignstatus)\n- [`getCampaignJobStatus`](#getcampaignjobstatus)\n- [`getCampaignPortals`](#getcampaignportals)\n- [`setupCampaign`](#setupcampaign)\n- [`matchCampaigns`](#matchcampaigns)\n- [`discoverCampaigns`](#discovercampaigns)\n\n**Campaign Delivery**\n- [`retriggerCampaignAutomations`](#retriggercampaignautomations)\n\n**Target**\n- [`matchTargets`](#matchtargets)\n- [`getTargetQueries`](#gettargetqueries)\n\n**Campaign Recipient**\n- [`createRecipient`](#createrecipient)\n- [`updateRecipient`](#updaterecipient)\n- [`updateRecipientPortalStatus`](#updaterecipientportalstatus)\n- [`updateRecipientEntityUiStatus`](#updaterecipiententityuistatus)\n- [`restoreRecipientEntityUiStatus`](#restorerecipiententityuistatus)\n- [`getRecipients`](#getrecipients)\n- [`getEmailStats`](#getemailstats)\n\n**Schemas**\n- [`BaseError`](#baseerror)\n- [`ServerError`](#servererror)\n- [`ClientError`](#clienterror)\n- [`BaseUUID`](#baseuuid)\n- [`BaseNanoID`](#basenanoid)\n- [`BaseTags`](#basetags)\n- [`BaseRelation`](#baserelation)\n- [`BaseSystemId`](#basesystemid)\n- [`BaseEntityOwner`](#baseentityowner)\n- [`BaseEntityAcl`](#baseentityacl)\n- [`BaseSystemFields`](#basesystemfields)\n- [`BaseSystemFieldsRequired`](#basesystemfieldsrequired)\n- [`CampaignStatus`](#campaignstatus)\n- [`ExecutionSummaryItem`](#executionsummaryitem)\n- [`JobStatus`](#jobstatus)\n- [`Campaign`](#campaign)\n- [`Target`](#target)\n- [`MatchCampaignParams`](#matchcampaignparams)\n- [`NextBestAction`](#nextbestaction)\n- [`DiscoverCampaignsParams`](#discovercampaignsparams)\n- [`DiscoverResult`](#discoverresult)\n- [`MatchTargetParams`](#matchtargetparams)\n- [`GetTargetQueriesParams`](#gettargetqueriesparams)\n- [`TargetQueryResult`](#targetqueryresult)\n- [`AutomationStatus`](#automationstatus)\n- [`PortalStatus`](#portalstatus)\n- [`EntityUiStatus`](#entityuistatus)\n- [`EmailStatus`](#emailstatus)\n- [`EmailBounceType`](#emailbouncetype)\n- [`Recipient`](#recipient)\n- [`BaseRecipientPayload`](#baserecipientpayload)\n- [`AutomationRecipientPayload`](#automationrecipientpayload)\n- [`PortalRecipientPayload`](#portalrecipientpayload)\n- [`CreateRecipientPayload`](#createrecipientpayload)\n- [`UpdateRecipientPayload`](#updaterecipientpayload)\n- [`RetriggerAutomationsRequest`](#retriggerautomationsrequest)\n- [`RetriggerAutomationsResult`](#retriggerautomationsresult)\n- [`UpdatePortalStatusRequest`](#updateportalstatusrequest)\n- [`UpdateEntityUiStatusRequest`](#updateentityuistatusrequest)\n- [`SetupCampaignRequest`](#setupcampaignrequest)\n- [`SetupTariffChangeCampaignRequest`](#setuptariffchangecampaignrequest)\n- [`SetupTariffChangeCampaignResponse`](#setuptariffchangecampaignresponse)\n\n### `changeCampaignStatus`\n\nChange the status of a campaign to a desired status.\n\n`POST /v1/campaign/{campaign_id}/status`\n\n```ts\nconst { data } = await client.changeCampaignStatus({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "campaign": {\n    "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n    "_org": "string",\n    "_owners": [\n      {\n        "org_id": "123",\n        "user_id": "123"\n      }\n    ],\n    "_schema": "string",\n    "_title": "string",\n    "_tags": ["string"],\n    "_created_at": "1970-01-01T00:00:00.000Z",\n    "_updated_at": "1970-01-01T00:00:00.000Z",\n    "_acl": {\n      "view": ["org:456"],\n      "edit": ["org:456"],\n      "delete": ["org:456"]\n    },\n    "name": "string",\n    "goal": "string",\n    "status": "draft",\n    "start_date": "1970-01-01",\n    "end_date": "1970-01-01",\n    "flow_id": "string",\n    "job_id": "string",\n    "target": {\n      "$relation": [\n        {\n          "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n          "_tags": ["string"]\n        }\n      ]\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `getCampaignJobStatus`\n\nGet the status of a campaign\'s automation job\n\n`GET /v1/campaign/{campaign_id}/job`\n\n```ts\nconst { data } = await client.getCampaignJobStatus({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "queued",\n  "execution_summary": [\n    {\n      "execution_id": "string",\n      "execution_status": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getCampaignPortals`\n\nGet the list of portals and its widgets where the campaign is used.\n\n`GET /v1/campaign/{campaign_id}/portals`\n\n```ts\nconst { data } = await client.getCampaignPortals({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "portal": {\n      "origin": "string",\n      "domain": "string",\n      "name": "string"\n    },\n    "widgets": [\n      {\n        "id": "string",\n        "headline": {\n          "en": "string",\n          "de": "string"\n        }\n      }\n    ]\n  }\n]\n```\n\n</details>\n\n---\n\n### `retriggerCampaignAutomations`\n\nRetrigger automation executions for specific campaign recipients that have failed.\n\n`POST /v1/campaign/{campaign_id}/automations:retrigger`\n\n```ts\nconst { data } = await client.retriggerCampaignAutomations(\n  {\n    campaign_id: \'example\',\n  },\n  {\n    recipient_ids: [\'3fa85f64-5717-4562-b3fc-2c963f66afa6\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "message": "string",\n  "results": [\n    {\n      "recipient_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "result": "success",\n      "execution_id": "string",\n      "error": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `setupCampaign`\n\nCreates a `campaign` entity together with its related entities and configurations in a single call.\nUsed by the campaign wizard UI, but not restricted to it.\n\n`POST /v1/campaign:setup`\n\n```ts\nconst { data } = await client.setupCampaign(\n  null,\n  {\n    type: \'tariff_change\',\n    product_recommendation: {\n      name: \'string\',\n      source_product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n      source_price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n      offers: [\n        {\n          target_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n          items: [\n            {\n              product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n              price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n              highlight_config: {}\n            }\n          ]\n        }\n      ]\n    },\n    campaign: {\n      name: \'string\',\n      goal: \'string\',\n      target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n    },\n    journey: {\n      journey_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n    },\n    channels: {\n      portal_widget: {\n        portal_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        block_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n      },\n      email: {\n        automation_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        template_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n      }\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "type": "tariff_change",\n  "product_recommendation_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "journey_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "portal_widget_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84"\n}\n```\n\n</details>\n\n---\n\n### `matchCampaigns`\n\nMatch campaigns based on target entities.\n\n`POST /v1/campaign:match`\n\n```ts\nconst { data } = await client.matchCampaigns(\n  null,\n  {\n    entity_refs: [\n      {\n        entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        entity_schema: \'string\'\n      }\n    ],\n    campaign_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "campaign": {\n        "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n        "_org": "string",\n        "_owners": [\n          {\n            "org_id": "123",\n            "user_id": "123"\n          }\n        ],\n        "_schema": "string",\n        "_title": "string",\n        "_tags": ["string"],\n        "_created_at": "1970-01-01T00:00:00.000Z",\n        "_updated_at": "1970-01-01T00:00:00.000Z",\n        "_acl": {\n          "view": ["org:456"],\n          "edit": ["org:456"],\n          "delete": ["org:456"]\n        },\n        "name": "string",\n        "goal": "string",\n        "status": "draft",\n        "start_date": "1970-01-01",\n        "end_date": "1970-01-01",\n        "flow_id": "string",\n        "job_id": "string",\n        "target": {\n          "$relation": [\n            {\n              "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n              "_tags": ["string"]\n            }\n          ]\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `discoverCampaigns`\n\nGiven an entity, returns the Next Best Actions it should see on the Entity-UI channel.\n\n`POST /v1/campaign:discover`\n\n```ts\nconst { data } = await client.discoverCampaigns(\n  null,\n  {\n    entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n    entity_schema: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "nba": {\n        "category": "string",\n        "icon": {\n          "name": "string",\n          "color": "string"\n        },\n        "title": "string",\n        "body": "string",\n        "priority": "medium",\n        "is_dismissable": true,\n        "cta": {\n          "type": "journey",\n          "target": "string",\n          "context_params": [\n            {\n              "key": "string",\n              "value": "string"\n            }\n          ]\n        }\n      },\n      "status": "seen",\n      "status_updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "dismissed": [\n    {\n      "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "nba": {\n        "category": "string",\n        "icon": {\n          "name": "string",\n          "color": "string"\n        },\n        "title": "string",\n        "body": "string",\n        "priority": "medium",\n        "is_dismissable": true,\n        "cta": {\n          "type": "journey",\n          "target": "string",\n          "context_params": [\n            {\n              "key": "string",\n              "value": "string"\n            }\n          ]\n        }\n      },\n      "status": "seen",\n      "status_updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `matchTargets`\n\nFind targets from the provided list that include the provide entities.\n\n`POST /v1/target:match`\n\n```ts\nconst { data } = await client.matchTargets(\n  null,\n  {\n    entity_refs: [\n      {\n        entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        entity_schema: \'string\'\n      }\n    ],\n    target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "target": {\n        "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n        "_org": "string",\n        "_owners": [\n          {\n            "org_id": "123",\n            "user_id": "123"\n          }\n        ],\n        "_schema": "string",\n        "_title": "string",\n        "_tags": ["string"],\n        "_created_at": "1970-01-01T00:00:00.000Z",\n        "_updated_at": "1970-01-01T00:00:00.000Z",\n        "_acl": {\n          "view": ["org:456"],\n          "edit": ["org:456"],\n          "delete": ["org:456"]\n        },\n        "name": "string",\n        "description": "string",\n        "entity_schema": "string",\n        "entity_filters": {}\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getTargetQueries`\n\nTransform target filters into Lucene queries for the provided target IDs.\nReturns the transformed query string for each target along with any errors encountered.\n\n`POST /v1/target/queries`\n\n```ts\nconst { data } = await client.getTargetQueries(\n  null,\n  {\n    target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "target_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "query": "string",\n      "error": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createRecipient`\n\nCreates a new recipient associated with a campaign.\n\n`POST /v1/campaign/{campaign_id}/recipient`\n\n```ts\nconst { data } = await client.createRecipient(\n  {\n    campaign_id: \'example\',\n  },\n  {\n    entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n    entity_schema: \'string\',\n    automation_status: \'pending\',\n    automation_execution_id: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "entity_ui_status": "seen",\n  "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "entity_ui_status_before_dismiss": "seen",\n  "message_entity_id": "string",\n  "email_status": "sent",\n  "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "email_bounce_type": "permanent",\n  "email_bounce_subtype": "string",\n  "email_complaint_type": "string",\n  "email_bounce_reason": "string",\n  "email_send_error": {},\n  "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n  "email_open_count": 0,\n  "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_click_count": 0,\n  "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n  "email_clicked_links": [\n    {\n      "url": "string",\n      "clicked_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipient`\n\nUpdates a recipient\'s attributes.\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}`\n\n```ts\nconst { data } = await client.updateRecipient(\n  {\n    campaign_id: \'example\',\n    recipient_id: \'example\',\n  },\n  {\n    automation_status: \'pending\',\n    automation_execution_id: \'string\',\n    portal_status: \'sent\',\n    portal_state: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "entity_ui_status": "seen",\n  "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "entity_ui_status_before_dismiss": "seen",\n  "message_entity_id": "string",\n  "email_status": "sent",\n  "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "email_bounce_type": "permanent",\n  "email_bounce_subtype": "string",\n  "email_complaint_type": "string",\n  "email_bounce_reason": "string",\n  "email_send_error": {},\n  "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n  "email_open_count": 0,\n  "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_click_count": 0,\n  "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n  "email_clicked_links": [\n    {\n      "url": "string",\n      "clicked_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipientPortalStatus`\n\nUpdates the portal status for a specific campaign recipient.\nThe portal_status_updated_at timestamp is automatically set when the status changes.\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status`\n\n```ts\nconst { data } = await client.updateRecipientPortalStatus(\n  {\n    campaign_id: \'example\',\n    recipient_id: \'example\',\n  },\n  {\n    status: \'sent\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "entity_ui_status": "seen",\n  "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "entity_ui_status_before_dismiss": "seen",\n  "message_entity_id": "string",\n  "email_status": "sent",\n  "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "email_bounce_type": "permanent",\n  "email_bounce_subtype": "string",\n  "email_complaint_type": "string",\n  "email_bounce_reason": "string",\n  "email_send_error": {},\n  "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n  "email_open_count": 0,\n  "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_click_count": 0,\n  "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n  "email_clicked_links": [\n    {\n      "url": "string",\n      "clicked_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipientEntityUiStatus`\n\nRecords a Next Best Action interaction for a recipient on the Entity-UI channel.\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:status`\n\n```ts\nconst { data } = await client.updateRecipientEntityUiStatus(\n  {\n    campaign_id: \'example\',\n    recipient_id: \'example\',\n  },\n  {\n    status: \'seen\',\n    entity_schema: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "entity_ui_status": "seen",\n  "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "entity_ui_status_before_dismiss": "seen",\n  "message_entity_id": "string",\n  "email_status": "sent",\n  "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "email_bounce_type": "permanent",\n  "email_bounce_subtype": "string",\n  "email_complaint_type": "string",\n  "email_bounce_reason": "string",\n  "email_send_error": {},\n  "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n  "email_open_count": 0,\n  "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_click_count": 0,\n  "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n  "email_clicked_links": [\n    {\n      "url": "string",\n      "clicked_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `restoreRecipientEntityUiStatus`\n\nUndo a dismissal on the Entity-UI (Next Best Action) channel\n\n`POST /v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:restore`\n\n```ts\nconst { data } = await client.restoreRecipientEntityUiStatus({\n  campaign_id: \'example\',\n  recipient_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "entity_ui_status": "seen",\n  "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "entity_ui_status_before_dismiss": "seen",\n  "message_entity_id": "string",\n  "email_status": "sent",\n  "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "email_bounce_type": "permanent",\n  "email_bounce_subtype": "string",\n  "email_complaint_type": "string",\n  "email_bounce_reason": "string",\n  "email_send_error": {},\n  "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n  "email_open_count": 0,\n  "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_click_count": 0,\n  "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n  "email_clicked_links": [\n    {\n      "url": "string",\n      "clicked_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getRecipients`\n\nGet a paginated list of recipients for a campaign.\n\n`GET /v1/campaign/{campaign_id}/recipients`\n\n```ts\nconst { data } = await client.getRecipients({\n  campaign_id: \'example\',\n  limit: 1,\n  next: \'example\',\n  q: \'example\',\n  automation_status: [\'...\'],\n  portal_status: \'example\',\n  email_status: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "entity_schema": "string",\n      "title": "string",\n      "automation_status": "pending",\n      "automation_execution_id": "string",\n      "portal_status": "sent",\n      "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n      "portal_state": {},\n      "entity_ui_status": "seen",\n      "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n      "entity_ui_status_before_dismiss": "seen",\n      "message_entity_id": "string",\n      "email_status": "sent",\n      "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n      "email_bounce_type": "permanent",\n      "email_bounce_subtype": "string",\n      "email_complaint_type": "string",\n      "email_bounce_reason": "string",\n      "email_send_error": {},\n      "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n      "email_open_count": 0,\n      "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n      "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n      "email_click_count": 0,\n      "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n      "email_clicked_links": [\n        {\n          "url": "string",\n          "clicked_at": "1970-01-01T00:00:00.000Z"\n        }\n      ],\n      "updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "next": "string",\n  "total": 0\n}\n```\n\n</details>\n\n---\n\n### `getEmailStats`\n\nAggregate email delivery counts for a campaign, for the KPI summary on the campaign UI.\nCounts cover the email (automation) channel only; `total_emailed` is the number of\nrecipients with a recorded em\n\n`GET /v1/campaign/{campaign_id}/email-stats`\n\n```ts\nconst { data } = await client.getEmailStats({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "total_emailed": 0,\n  "sent": 0,\n  "delivered": 0,\n  "bounced": 0,\n  "bounced_hard": 0,\n  "bounced_soft": 0,\n  "complained": 0,\n  "failed": 0,\n  "unsubscribed": 0,\n  "opened": 0,\n  "clicked": 0,\n  "total_opens": 0,\n  "total_clicks": 0\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `BaseError`\n\n```ts\ntype BaseError = {\n  status: number\n  message: string\n}\n```\n\n### `ServerError`\n\n```ts\ntype ServerError = {\n  status: number\n  message: string\n}\n```\n\n### `ClientError`\n\nDescribes the structure of a client error response, which can be one of several types:\n1. `MessageError`: Contains a \'message\' field for general descriptive errors.\n2. `CodeError`: Contains a \'code\' field for specific, machine-readable error codes.\n3. `StatusedError`: Contains \'error\' and \'status\' f\n\n```ts\ntype ClientError = {\n  message: string\n} | {\n  code: "CAMPAIGN_NOT_FOUND" | "CAMPAIGN_HAS_NO_TARGET" | "CAMPAIGN_HAS_NO_DELIVERY_METHOD" | "INVALID_NEXT_BEST_ACTION" | "CAMPAIGN_HAS_JOB_IN_PROGRESS" | "CAMPAIGN_HAS_UNEXPECTED_STATUS" | "JOB_TOKEN_MISSING" | "TARGET_WITHOUT_FILTERS"\n} | {\n  error: string\n  status: number\n}\n```\n\n### `BaseUUID`\n\n```ts\ntype BaseUUID = string // uuid\n```\n\n### `BaseNanoID`\n\n```ts\ntype BaseNanoID = string\n```\n\n### `BaseTags`\n\n```ts\ntype BaseTags = string[]\n```\n\n### `BaseRelation`\n\n```ts\ntype BaseRelation = {\n  $relation?: Array<{\n    entity_id?: string // uuid\n    _tags?: string[]\n  }>\n}\n```\n\n### `BaseSystemId`\n\n```ts\ntype BaseSystemId = {\n  _id: string // uuid\n}\n```\n\n### `BaseEntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype BaseEntityOwner = {\n  org_id: string\n  user_id?: string\n}\n```\n\n### `BaseEntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype BaseEntityAcl = {\n  view?: string[]\n  edit?: string[]\n  delete?: string[]\n}\n```\n\n### `BaseSystemFields`\n\n```ts\ntype BaseSystemFields = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n}\n```\n\n### `BaseSystemFieldsRequired`\n\n```ts\ntype BaseSystemFieldsRequired = object\n```\n\n### `CampaignStatus`\n\n```ts\ntype CampaignStatus = "draft" | "activating" | "active" | "inactive"\n```\n\n### `ExecutionSummaryItem`\n\n```ts\ntype ExecutionSummaryItem = {\n  execution_id?: string\n  execution_status?: string\n}\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = {\n  status?: "queued" | "processing" | "finished" | "failed" | "cancelled" | "send_report"\n  execution_summary?: Array<{\n    execution_id?: string\n    execution_status?: string\n  }>\n}\n```\n\n### `Campaign`\n\n```ts\ntype Campaign = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  name?: string\n  goal?: string\n  status?: "draft" | "activating" | "active" | "inactive"\n  start_date?: string // date\n  end_date?: string // date\n  flow_id?: string\n  job_id?: string\n  target?: {\n    $relation?: Array<{\n      entity_id?: { ... }\n      _tags?: { ... }\n    }>\n  }\n}\n```\n\n### `Target`\n\n```ts\ntype Target = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  name?: string\n  description?: string\n  entity_schema?: string\n  entity_filters?: Record<string, unknown>\n}\n```\n\n### `MatchCampaignParams`\n\n```ts\ntype MatchCampaignParams = {\n  entity_refs: Array<{\n    entity_id: string // uuid\n    entity_schema: string\n  }>\n  campaign_ids: string // uuid[]\n}\n```\n\n### `NextBestAction`\n\nA Next Best Action configured on a campaign\'s Entity-UI channel.\nThis is the canonical NBA contract shared by discovery (this API), authoring, and rendering.\nNBA content is single-language in v1; text fields may contain `{{placeholders}}` resolved at render time.\n\n\n```ts\ntype NextBestAction = {\n  category?: string\n  icon?: {\n    name: string\n    color?: string\n  }\n  title: string\n  body?: string\n  priority?: "low" | "medium" | "high"\n  is_dismissable?: boolean\n  cta: {\n    type: "journey" | "workflow" | "flow"\n    target: string\n    context_params?: Array<{\n      key: { ... }\n      value: { ... }\n    }>\n  }\n}\n```\n\n### `DiscoverCampaignsParams`\n\n```ts\ntype DiscoverCampaignsParams = {\n  entity_id: string // uuid\n  entity_schema: string\n}\n```\n\n### `DiscoverResult`\n\nOne discovered Next Best Action, plus this entity\'s interaction state for it.\n\n```ts\ntype DiscoverResult = {\n  campaign_id: string // uuid\n  nba: {\n    category?: string\n    icon?: {\n      name: { ... }\n      color?: { ... }\n    }\n    title: string\n    body?: string\n    priority?: "low" | "medium" | "high"\n    is_dismissable?: boolean\n    cta: {\n      type: { ... }\n      target: { ... }\n      context_params?: { ... }\n    }\n  }\n  status?: "seen" | "dismissed" | "clicked"\n  status_updated_at?: string // date-time\n}\n```\n\n### `MatchTargetParams`\n\n```ts\ntype MatchTargetParams = {\n  entity_refs: Array<{\n    entity_id: string // uuid\n    entity_schema: string\n  }>\n  target_ids: string // uuid[]\n}\n```\n\n### `GetTargetQueriesParams`\n\n```ts\ntype GetTargetQueriesParams = {\n  target_ids: string // uuid[]\n}\n```\n\n### `TargetQueryResult`\n\n```ts\ntype TargetQueryResult = {\n  target_id: string // uuid\n  query: string\n  error?: string\n}\n```\n\n### `AutomationStatus`\n\n```ts\ntype AutomationStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled"\n```\n\n### `PortalStatus`\n\n```ts\ntype PortalStatus = "sent" | "seen" | "dismissed" | "clicked"\n```\n\n### `EntityUiStatus`\n\nLifecycle status of a Next Best Action on the Entity-UI channel. Unlike the portal\nchannel there is no `sent` state: an NBA recipient is born at `seen`, the moment the\naction is first rendered to an agent.\n\n\n```ts\ntype EntityUiStatus = "seen" | "dismissed" | "clicked"\n```\n\n### `EmailStatus`\n\nDelivery status of the email a campaign\'s automation sends to a recipient. Set to `sent`\nonce the automation hands the email off, then updated asynchronously as SES notifications\narrive (`bounced` / `complained`; an SES Reject maps to `bounced`). `failed` is a send-time\nfailure (the automation execu\n\n```ts\ntype EmailStatus = "sent" | "delivered" | "bounced" | "complained" | "failed"\n```\n\n### `EmailBounceType`\n\nSES bounce classification: `permanent` (hard) or `transient` (soft).\n\n```ts\ntype EmailBounceType = "permanent" | "transient"\n```\n\n### `Recipient`\n\n```ts\ntype Recipient = {\n  entity_id?: string // uuid\n  entity_schema?: string\n  title?: string\n  automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id?: string\n  portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n  portal_status_updated_at?: string // date-time\n  portal_state?: Record<string, unknown>\n  entity_ui_status?: "seen" | "dismissed" | "clicked"\n  entity_ui_status_updated_at?: string // date-time\n  entity_ui_status_before_dismiss?: "seen" | "dismissed" | "clicked"\n  message_entity_id?: string\n  email_status?: "sent" | "delivered" | "bounced" | "complained" | "failed"\n  email_status_updated_at?: string // date-time\n  email_bounce_type?: "permanent" | "transient"\n  email_bounce_subtype?: string\n  email_complaint_type?: string\n  email_bounce_reason?: string\n  email_send_error?: Record<string, unknown>\n  email_unsubscribed_at?: string // date-time\n  email_open_count?: number\n  email_first_opened_at?: string // date-time\n  email_last_opened_at?: string // date-time\n  email_click_count?: number\n  email_first_clicked_at?: string // date-time\n  email_clicked_links?: Array<{\n    url: string\n    clicked_at: string // date-time\n  }>\n  updated_at?: string // date-time\n}\n```\n\n### `BaseRecipientPayload`\n\n```ts\ntype BaseRecipientPayload = {\n  entity_id: string // uuid\n  entity_schema: string\n}\n```\n\n### `AutomationRecipientPayload`\n\n```ts\ntype AutomationRecipientPayload = {\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n}\n```\n\n### `PortalRecipientPayload`\n\n```ts\ntype PortalRecipientPayload = {\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `CreateRecipientPayload`\n\n```ts\ntype CreateRecipientPayload = {\n  entity_id: string // uuid\n  entity_schema: string\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n} | {\n  entity_id: string // uuid\n  entity_schema: string\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n} | {\n  entity_id: string // uuid\n  entity_schema: string\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `UpdateRecipientPayload`\n\n```ts\ntype UpdateRecipientPayload = {\n  automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id?: string\n  portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `RetriggerAutomationsRequest`\n\n```ts\ntype RetriggerAutomationsRequest = {\n  recipient_ids: string // uuid[]\n}\n```\n\n### `RetriggerAutomationsResult`\n\n```ts\ntype RetriggerAutomationsResult = {\n  recipient_id: string // uuid\n  result: "success" | "failure" | "not_found" | "invalid_status"\n  execution_id?: string\n  error?: string\n}\n```\n\n### `UpdatePortalStatusRequest`\n\n```ts\ntype UpdatePortalStatusRequest = {\n  status: "sent" | "seen" | "dismissed" | "clicked"\n}\n```\n\n### `UpdateEntityUiStatusRequest`\n\n```ts\ntype UpdateEntityUiStatusRequest = {\n  status: "seen" | "dismissed" | "clicked"\n  entity_schema?: string\n}\n```\n\n### `SetupCampaignRequest`\n\nDiscriminated by `type`. Each campaign variant has its own request shape;\nnew variants are added by introducing a new schema and extending the `oneOf` list.\n\n\n```ts\ntype SetupCampaignRequest = {\n  type: "tariff_change"\n  product_recommendation: {\n    name?: string\n    source_product_id?: string // uuid\n    source_price_id?: string // uuid\n    offers?: Array<{\n      target_id?: { ... }\n      items: { ... }\n    }>\n  }\n  campaign: {\n    name: string\n    goal?: string\n    target_ids: string // uuid[]\n  }\n  journey?: {\n    journey_id: string // uuid\n  }\n  channels?: {\n    portal_widget?: {\n      portal_id: { ... }\n      block_id: { ... }\n    }\n    email?: {\n      automation_id?: { ... }\n      template_id?: { ... }\n    }\n  }\n}\n```\n\n### `SetupTariffChangeCampaignRequest`\n\n```ts\ntype SetupTariffChangeCampaignRequest = {\n  type: "tariff_change"\n  product_recommendation: {\n    name?: string\n    source_product_id?: string // uuid\n    source_price_id?: string // uuid\n    offers?: Array<{\n      target_id?: { ... }\n      items: { ... }\n    }>\n  }\n  campaign: {\n    name: string\n    goal?: string\n    target_ids: string // uuid[]\n  }\n  journey?: {\n    journey_id: string // uuid\n  }\n  channels?: {\n    portal_widget?: {\n      portal_id: { ... }\n      block_id: { ... }\n    }\n    email?: {\n      automation_id?: { ... }\n      template_id?: { ... }\n    }\n  }\n}\n```\n\n### `SetupTariffChangeCampaignResponse`\n\n```ts\ntype SetupTariffChangeCampaignResponse = {\n  type: "tariff_change"\n  product_recommendation_id: string // uuid\n  campaign_id: string // uuid\n  journey_id?: string // uuid\n  portal_widget_id?: string // uuid\n}\n```\n';
-
-
-exports.default = targeting_default;

package/dist/targeting-2NHAG7B5.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/targeting.json
-var targeting_default = '# Targeting API\n\n- **Base URL:** `https://targeting.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/targeting](https://docs.epilot.io/api/targeting)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.targeting.changeCampaignStatus(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/targeting\'\n\nconst targetingClient = getClient()\nauthorize(targetingClient, () => \'<token>\')\nconst { data } = await targetingClient.changeCampaignStatus(...)\n```\n\n## Operations\n\n**Campaign**\n- [`changeCampaignStatus`](#changecampaignstatus)\n- [`getCampaignJobStatus`](#getcampaignjobstatus)\n- [`getCampaignPortals`](#getcampaignportals)\n- [`setupCampaign`](#setupcampaign)\n- [`matchCampaigns`](#matchcampaigns)\n- [`discoverCampaigns`](#discovercampaigns)\n\n**Campaign Delivery**\n- [`retriggerCampaignAutomations`](#retriggercampaignautomations)\n\n**Target**\n- [`matchTargets`](#matchtargets)\n- [`getTargetQueries`](#gettargetqueries)\n\n**Campaign Recipient**\n- [`createRecipient`](#createrecipient)\n- [`updateRecipient`](#updaterecipient)\n- [`updateRecipientPortalStatus`](#updaterecipientportalstatus)\n- [`updateRecipientEntityUiStatus`](#updaterecipiententityuistatus)\n- [`restoreRecipientEntityUiStatus`](#restorerecipiententityuistatus)\n- [`getRecipients`](#getrecipients)\n- [`getEmailStats`](#getemailstats)\n\n**Schemas**\n- [`BaseError`](#baseerror)\n- [`ServerError`](#servererror)\n- [`ClientError`](#clienterror)\n- [`BaseUUID`](#baseuuid)\n- [`BaseNanoID`](#basenanoid)\n- [`BaseTags`](#basetags)\n- [`BaseRelation`](#baserelation)\n- [`BaseSystemId`](#basesystemid)\n- [`BaseEntityOwner`](#baseentityowner)\n- [`BaseEntityAcl`](#baseentityacl)\n- [`BaseSystemFields`](#basesystemfields)\n- [`BaseSystemFieldsRequired`](#basesystemfieldsrequired)\n- [`CampaignStatus`](#campaignstatus)\n- [`ExecutionSummaryItem`](#executionsummaryitem)\n- [`JobStatus`](#jobstatus)\n- [`Campaign`](#campaign)\n- [`Target`](#target)\n- [`MatchCampaignParams`](#matchcampaignparams)\n- [`NextBestAction`](#nextbestaction)\n- [`DiscoverCampaignsParams`](#discovercampaignsparams)\n- [`DiscoverResult`](#discoverresult)\n- [`MatchTargetParams`](#matchtargetparams)\n- [`GetTargetQueriesParams`](#gettargetqueriesparams)\n- [`TargetQueryResult`](#targetqueryresult)\n- [`AutomationStatus`](#automationstatus)\n- [`PortalStatus`](#portalstatus)\n- [`EntityUiStatus`](#entityuistatus)\n- [`EmailStatus`](#emailstatus)\n- [`EmailBounceType`](#emailbouncetype)\n- [`Recipient`](#recipient)\n- [`BaseRecipientPayload`](#baserecipientpayload)\n- [`AutomationRecipientPayload`](#automationrecipientpayload)\n- [`PortalRecipientPayload`](#portalrecipientpayload)\n- [`CreateRecipientPayload`](#createrecipientpayload)\n- [`UpdateRecipientPayload`](#updaterecipientpayload)\n- [`RetriggerAutomationsRequest`](#retriggerautomationsrequest)\n- [`RetriggerAutomationsResult`](#retriggerautomationsresult)\n- [`UpdatePortalStatusRequest`](#updateportalstatusrequest)\n- [`UpdateEntityUiStatusRequest`](#updateentityuistatusrequest)\n- [`SetupCampaignRequest`](#setupcampaignrequest)\n- [`SetupTariffChangeCampaignRequest`](#setuptariffchangecampaignrequest)\n- [`SetupTariffChangeCampaignResponse`](#setuptariffchangecampaignresponse)\n\n### `changeCampaignStatus`\n\nChange the status of a campaign to a desired status.\n\n`POST /v1/campaign/{campaign_id}/status`\n\n```ts\nconst { data } = await client.changeCampaignStatus({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "campaign": {\n    "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n    "_org": "string",\n    "_owners": [\n      {\n        "org_id": "123",\n        "user_id": "123"\n      }\n    ],\n    "_schema": "string",\n    "_title": "string",\n    "_tags": ["string"],\n    "_created_at": "1970-01-01T00:00:00.000Z",\n    "_updated_at": "1970-01-01T00:00:00.000Z",\n    "_acl": {\n      "view": ["org:456"],\n      "edit": ["org:456"],\n      "delete": ["org:456"]\n    },\n    "name": "string",\n    "goal": "string",\n    "status": "draft",\n    "start_date": "1970-01-01",\n    "end_date": "1970-01-01",\n    "flow_id": "string",\n    "job_id": "string",\n    "target": {\n      "$relation": [\n        {\n          "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n          "_tags": ["string"]\n        }\n      ]\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `getCampaignJobStatus`\n\nGet the status of a campaign\'s automation job\n\n`GET /v1/campaign/{campaign_id}/job`\n\n```ts\nconst { data } = await client.getCampaignJobStatus({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "queued",\n  "execution_summary": [\n    {\n      "execution_id": "string",\n      "execution_status": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getCampaignPortals`\n\nGet the list of portals and its widgets where the campaign is used.\n\n`GET /v1/campaign/{campaign_id}/portals`\n\n```ts\nconst { data } = await client.getCampaignPortals({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "portal": {\n      "origin": "string",\n      "domain": "string",\n      "name": "string"\n    },\n    "widgets": [\n      {\n        "id": "string",\n        "headline": {\n          "en": "string",\n          "de": "string"\n        }\n      }\n    ]\n  }\n]\n```\n\n</details>\n\n---\n\n### `retriggerCampaignAutomations`\n\nRetrigger automation executions for specific campaign recipients that have failed.\n\n`POST /v1/campaign/{campaign_id}/automations:retrigger`\n\n```ts\nconst { data } = await client.retriggerCampaignAutomations(\n  {\n    campaign_id: \'example\',\n  },\n  {\n    recipient_ids: [\'3fa85f64-5717-4562-b3fc-2c963f66afa6\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "message": "string",\n  "results": [\n    {\n      "recipient_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "result": "success",\n      "execution_id": "string",\n      "error": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `setupCampaign`\n\nCreates a `campaign` entity together with its related entities and configurations in a single call.\nUsed by the campaign wizard UI, but not restricted to it.\n\n`POST /v1/campaign:setup`\n\n```ts\nconst { data } = await client.setupCampaign(\n  null,\n  {\n    type: \'tariff_change\',\n    product_recommendation: {\n      name: \'string\',\n      source_product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n      source_price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n      offers: [\n        {\n          target_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n          items: [\n            {\n              product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n              price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n              highlight_config: {}\n            }\n          ]\n        }\n      ]\n    },\n    campaign: {\n      name: \'string\',\n      goal: \'string\',\n      target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n    },\n    journey: {\n      journey_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n    },\n    channels: {\n      portal_widget: {\n        portal_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        block_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n      },\n      email: {\n        automation_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        template_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n      }\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "type": "tariff_change",\n  "product_recommendation_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "journey_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "portal_widget_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84"\n}\n```\n\n</details>\n\n---\n\n### `matchCampaigns`\n\nMatch campaigns based on target entities.\n\n`POST /v1/campaign:match`\n\n```ts\nconst { data } = await client.matchCampaigns(\n  null,\n  {\n    entity_refs: [\n      {\n        entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        entity_schema: \'string\'\n      }\n    ],\n    campaign_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "campaign": {\n        "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n        "_org": "string",\n        "_owners": [\n          {\n            "org_id": "123",\n            "user_id": "123"\n          }\n        ],\n        "_schema": "string",\n        "_title": "string",\n        "_tags": ["string"],\n        "_created_at": "1970-01-01T00:00:00.000Z",\n        "_updated_at": "1970-01-01T00:00:00.000Z",\n        "_acl": {\n          "view": ["org:456"],\n          "edit": ["org:456"],\n          "delete": ["org:456"]\n        },\n        "name": "string",\n        "goal": "string",\n        "status": "draft",\n        "start_date": "1970-01-01",\n        "end_date": "1970-01-01",\n        "flow_id": "string",\n        "job_id": "string",\n        "target": {\n          "$relation": [\n            {\n              "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n              "_tags": ["string"]\n            }\n          ]\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `discoverCampaigns`\n\nGiven an entity, returns the Next Best Actions it should see on the Entity-UI channel.\n\n`POST /v1/campaign:discover`\n\n```ts\nconst { data } = await client.discoverCampaigns(\n  null,\n  {\n    entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n    entity_schema: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "nba": {\n        "category": "string",\n        "icon": {\n          "name": "string",\n          "color": "string"\n        },\n        "title": "string",\n        "body": "string",\n        "priority": "medium",\n        "is_dismissable": true,\n        "cta": {\n          "type": "journey",\n          "target": "string",\n          "context_params": [\n            {\n              "key": "string",\n              "value": "string"\n            }\n          ]\n        }\n      },\n      "status": "seen",\n      "status_updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "dismissed": [\n    {\n      "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "nba": {\n        "category": "string",\n        "icon": {\n          "name": "string",\n          "color": "string"\n        },\n        "title": "string",\n        "body": "string",\n        "priority": "medium",\n        "is_dismissable": true,\n        "cta": {\n          "type": "journey",\n          "target": "string",\n          "context_params": [\n            {\n              "key": "string",\n              "value": "string"\n            }\n          ]\n        }\n      },\n      "status": "seen",\n      "status_updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `matchTargets`\n\nFind targets from the provided list that include the provide entities.\n\n`POST /v1/target:match`\n\n```ts\nconst { data } = await client.matchTargets(\n  null,\n  {\n    entity_refs: [\n      {\n        entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        entity_schema: \'string\'\n      }\n    ],\n    target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "target": {\n        "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n        "_org": "string",\n        "_owners": [\n          {\n            "org_id": "123",\n            "user_id": "123"\n          }\n        ],\n        "_schema": "string",\n        "_title": "string",\n        "_tags": ["string"],\n        "_created_at": "1970-01-01T00:00:00.000Z",\n        "_updated_at": "1970-01-01T00:00:00.000Z",\n        "_acl": {\n          "view": ["org:456"],\n          "edit": ["org:456"],\n          "delete": ["org:456"]\n        },\n        "name": "string",\n        "description": "string",\n        "entity_schema": "string",\n        "entity_filters": {}\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getTargetQueries`\n\nTransform target filters into Lucene queries for the provided target IDs.\nReturns the transformed query string for each target along with any errors encountered.\n\n`POST /v1/target/queries`\n\n```ts\nconst { data } = await client.getTargetQueries(\n  null,\n  {\n    target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "target_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "query": "string",\n      "error": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createRecipient`\n\nCreates a new recipient associated with a campaign.\n\n`POST /v1/campaign/{campaign_id}/recipient`\n\n```ts\nconst { data } = await client.createRecipient(\n  {\n    campaign_id: \'example\',\n  },\n  {\n    entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n    entity_schema: \'string\',\n    automation_status: \'pending\',\n    automation_execution_id: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "entity_ui_status": "seen",\n  "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "entity_ui_status_before_dismiss": "seen",\n  "message_entity_id": "string",\n  "email_status": "sent",\n  "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "email_bounce_type": "permanent",\n  "email_bounce_subtype": "string",\n  "email_complaint_type": "string",\n  "email_bounce_reason": "string",\n  "email_send_error": {},\n  "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n  "email_open_count": 0,\n  "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_click_count": 0,\n  "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n  "email_clicked_links": [\n    {\n      "url": "string",\n      "clicked_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipient`\n\nUpdates a recipient\'s attributes.\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}`\n\n```ts\nconst { data } = await client.updateRecipient(\n  {\n    campaign_id: \'example\',\n    recipient_id: \'example\',\n  },\n  {\n    automation_status: \'pending\',\n    automation_execution_id: \'string\',\n    portal_status: \'sent\',\n    portal_state: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "entity_ui_status": "seen",\n  "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "entity_ui_status_before_dismiss": "seen",\n  "message_entity_id": "string",\n  "email_status": "sent",\n  "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "email_bounce_type": "permanent",\n  "email_bounce_subtype": "string",\n  "email_complaint_type": "string",\n  "email_bounce_reason": "string",\n  "email_send_error": {},\n  "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n  "email_open_count": 0,\n  "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_click_count": 0,\n  "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n  "email_clicked_links": [\n    {\n      "url": "string",\n      "clicked_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipientPortalStatus`\n\nUpdates the portal status for a specific campaign recipient.\nThe portal_status_updated_at timestamp is automatically set when the status changes.\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status`\n\n```ts\nconst { data } = await client.updateRecipientPortalStatus(\n  {\n    campaign_id: \'example\',\n    recipient_id: \'example\',\n  },\n  {\n    status: \'sent\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "entity_ui_status": "seen",\n  "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "entity_ui_status_before_dismiss": "seen",\n  "message_entity_id": "string",\n  "email_status": "sent",\n  "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "email_bounce_type": "permanent",\n  "email_bounce_subtype": "string",\n  "email_complaint_type": "string",\n  "email_bounce_reason": "string",\n  "email_send_error": {},\n  "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n  "email_open_count": 0,\n  "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_click_count": 0,\n  "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n  "email_clicked_links": [\n    {\n      "url": "string",\n      "clicked_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipientEntityUiStatus`\n\nRecords a Next Best Action interaction for a recipient on the Entity-UI channel.\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:status`\n\n```ts\nconst { data } = await client.updateRecipientEntityUiStatus(\n  {\n    campaign_id: \'example\',\n    recipient_id: \'example\',\n  },\n  {\n    status: \'seen\',\n    entity_schema: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "entity_ui_status": "seen",\n  "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "entity_ui_status_before_dismiss": "seen",\n  "message_entity_id": "string",\n  "email_status": "sent",\n  "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "email_bounce_type": "permanent",\n  "email_bounce_subtype": "string",\n  "email_complaint_type": "string",\n  "email_bounce_reason": "string",\n  "email_send_error": {},\n  "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n  "email_open_count": 0,\n  "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_click_count": 0,\n  "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n  "email_clicked_links": [\n    {\n      "url": "string",\n      "clicked_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `restoreRecipientEntityUiStatus`\n\nUndo a dismissal on the Entity-UI (Next Best Action) channel\n\n`POST /v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:restore`\n\n```ts\nconst { data } = await client.restoreRecipientEntityUiStatus({\n  campaign_id: \'example\',\n  recipient_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "entity_ui_status": "seen",\n  "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "entity_ui_status_before_dismiss": "seen",\n  "message_entity_id": "string",\n  "email_status": "sent",\n  "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "email_bounce_type": "permanent",\n  "email_bounce_subtype": "string",\n  "email_complaint_type": "string",\n  "email_bounce_reason": "string",\n  "email_send_error": {},\n  "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n  "email_open_count": 0,\n  "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n  "email_click_count": 0,\n  "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n  "email_clicked_links": [\n    {\n      "url": "string",\n      "clicked_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getRecipients`\n\nGet a paginated list of recipients for a campaign.\n\n`GET /v1/campaign/{campaign_id}/recipients`\n\n```ts\nconst { data } = await client.getRecipients({\n  campaign_id: \'example\',\n  limit: 1,\n  next: \'example\',\n  q: \'example\',\n  automation_status: [\'...\'],\n  portal_status: \'example\',\n  email_status: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "entity_schema": "string",\n      "title": "string",\n      "automation_status": "pending",\n      "automation_execution_id": "string",\n      "portal_status": "sent",\n      "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n      "portal_state": {},\n      "entity_ui_status": "seen",\n      "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n      "entity_ui_status_before_dismiss": "seen",\n      "message_entity_id": "string",\n      "email_status": "sent",\n      "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n      "email_bounce_type": "permanent",\n      "email_bounce_subtype": "string",\n      "email_complaint_type": "string",\n      "email_bounce_reason": "string",\n      "email_send_error": {},\n      "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n      "email_open_count": 0,\n      "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n      "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n      "email_click_count": 0,\n      "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n      "email_clicked_links": [\n        {\n          "url": "string",\n          "clicked_at": "1970-01-01T00:00:00.000Z"\n        }\n      ],\n      "updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "next": "string",\n  "total": 0\n}\n```\n\n</details>\n\n---\n\n### `getEmailStats`\n\nAggregate email delivery counts for a campaign, for the KPI summary on the campaign UI.\nCounts cover the email (automation) channel only; `total_emailed` is the number of\nrecipients with a recorded em\n\n`GET /v1/campaign/{campaign_id}/email-stats`\n\n```ts\nconst { data } = await client.getEmailStats({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "total_emailed": 0,\n  "sent": 0,\n  "delivered": 0,\n  "bounced": 0,\n  "bounced_hard": 0,\n  "bounced_soft": 0,\n  "complained": 0,\n  "failed": 0,\n  "unsubscribed": 0,\n  "opened": 0,\n  "clicked": 0,\n  "total_opens": 0,\n  "total_clicks": 0\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `BaseError`\n\n```ts\ntype BaseError = {\n  status: number\n  message: string\n}\n```\n\n### `ServerError`\n\n```ts\ntype ServerError = {\n  status: number\n  message: string\n}\n```\n\n### `ClientError`\n\nDescribes the structure of a client error response, which can be one of several types:\n1. `MessageError`: Contains a \'message\' field for general descriptive errors.\n2. `CodeError`: Contains a \'code\' field for specific, machine-readable error codes.\n3. `StatusedError`: Contains \'error\' and \'status\' f\n\n```ts\ntype ClientError = {\n  message: string\n} | {\n  code: "CAMPAIGN_NOT_FOUND" | "CAMPAIGN_HAS_NO_TARGET" | "CAMPAIGN_HAS_NO_DELIVERY_METHOD" | "INVALID_NEXT_BEST_ACTION" | "CAMPAIGN_HAS_JOB_IN_PROGRESS" | "CAMPAIGN_HAS_UNEXPECTED_STATUS" | "JOB_TOKEN_MISSING" | "TARGET_WITHOUT_FILTERS"\n} | {\n  error: string\n  status: number\n}\n```\n\n### `BaseUUID`\n\n```ts\ntype BaseUUID = string // uuid\n```\n\n### `BaseNanoID`\n\n```ts\ntype BaseNanoID = string\n```\n\n### `BaseTags`\n\n```ts\ntype BaseTags = string[]\n```\n\n### `BaseRelation`\n\n```ts\ntype BaseRelation = {\n  $relation?: Array<{\n    entity_id?: string // uuid\n    _tags?: string[]\n  }>\n}\n```\n\n### `BaseSystemId`\n\n```ts\ntype BaseSystemId = {\n  _id: string // uuid\n}\n```\n\n### `BaseEntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype BaseEntityOwner = {\n  org_id: string\n  user_id?: string\n}\n```\n\n### `BaseEntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype BaseEntityAcl = {\n  view?: string[]\n  edit?: string[]\n  delete?: string[]\n}\n```\n\n### `BaseSystemFields`\n\n```ts\ntype BaseSystemFields = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n}\n```\n\n### `BaseSystemFieldsRequired`\n\n```ts\ntype BaseSystemFieldsRequired = object\n```\n\n### `CampaignStatus`\n\n```ts\ntype CampaignStatus = "draft" | "activating" | "active" | "inactive"\n```\n\n### `ExecutionSummaryItem`\n\n```ts\ntype ExecutionSummaryItem = {\n  execution_id?: string\n  execution_status?: string\n}\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = {\n  status?: "queued" | "processing" | "finished" | "failed" | "cancelled" | "send_report"\n  execution_summary?: Array<{\n    execution_id?: string\n    execution_status?: string\n  }>\n}\n```\n\n### `Campaign`\n\n```ts\ntype Campaign = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  name?: string\n  goal?: string\n  status?: "draft" | "activating" | "active" | "inactive"\n  start_date?: string // date\n  end_date?: string // date\n  flow_id?: string\n  job_id?: string\n  target?: {\n    $relation?: Array<{\n      entity_id?: { ... }\n      _tags?: { ... }\n    }>\n  }\n}\n```\n\n### `Target`\n\n```ts\ntype Target = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  name?: string\n  description?: string\n  entity_schema?: string\n  entity_filters?: Record<string, unknown>\n}\n```\n\n### `MatchCampaignParams`\n\n```ts\ntype MatchCampaignParams = {\n  entity_refs: Array<{\n    entity_id: string // uuid\n    entity_schema: string\n  }>\n  campaign_ids: string // uuid[]\n}\n```\n\n### `NextBestAction`\n\nA Next Best Action configured on a campaign\'s Entity-UI channel.\nThis is the canonical NBA contract shared by discovery (this API), authoring, and rendering.\nNBA content is single-language in v1; text fields may contain `{{placeholders}}` resolved at render time.\n\n\n```ts\ntype NextBestAction = {\n  category?: string\n  icon?: {\n    name: string\n    color?: string\n  }\n  title: string\n  body?: string\n  priority?: "low" | "medium" | "high"\n  is_dismissable?: boolean\n  cta: {\n    type: "journey" | "workflow" | "flow"\n    target: string\n    context_params?: Array<{\n      key: { ... }\n      value: { ... }\n    }>\n  }\n}\n```\n\n### `DiscoverCampaignsParams`\n\n```ts\ntype DiscoverCampaignsParams = {\n  entity_id: string // uuid\n  entity_schema: string\n}\n```\n\n### `DiscoverResult`\n\nOne discovered Next Best Action, plus this entity\'s interaction state for it.\n\n```ts\ntype DiscoverResult = {\n  campaign_id: string // uuid\n  nba: {\n    category?: string\n    icon?: {\n      name: { ... }\n      color?: { ... }\n    }\n    title: string\n    body?: string\n    priority?: "low" | "medium" | "high"\n    is_dismissable?: boolean\n    cta: {\n      type: { ... }\n      target: { ... }\n      context_params?: { ... }\n    }\n  }\n  status?: "seen" | "dismissed" | "clicked"\n  status_updated_at?: string // date-time\n}\n```\n\n### `MatchTargetParams`\n\n```ts\ntype MatchTargetParams = {\n  entity_refs: Array<{\n    entity_id: string // uuid\n    entity_schema: string\n  }>\n  target_ids: string // uuid[]\n}\n```\n\n### `GetTargetQueriesParams`\n\n```ts\ntype GetTargetQueriesParams = {\n  target_ids: string // uuid[]\n}\n```\n\n### `TargetQueryResult`\n\n```ts\ntype TargetQueryResult = {\n  target_id: string // uuid\n  query: string\n  error?: string\n}\n```\n\n### `AutomationStatus`\n\n```ts\ntype AutomationStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled"\n```\n\n### `PortalStatus`\n\n```ts\ntype PortalStatus = "sent" | "seen" | "dismissed" | "clicked"\n```\n\n### `EntityUiStatus`\n\nLifecycle status of a Next Best Action on the Entity-UI channel. Unlike the portal\nchannel there is no `sent` state: an NBA recipient is born at `seen`, the moment the\naction is first rendered to an agent.\n\n\n```ts\ntype EntityUiStatus = "seen" | "dismissed" | "clicked"\n```\n\n### `EmailStatus`\n\nDelivery status of the email a campaign\'s automation sends to a recipient. Set to `sent`\nonce the automation hands the email off, then updated asynchronously as SES notifications\narrive (`bounced` / `complained`; an SES Reject maps to `bounced`). `failed` is a send-time\nfailure (the automation execu\n\n```ts\ntype EmailStatus = "sent" | "delivered" | "bounced" | "complained" | "failed"\n```\n\n### `EmailBounceType`\n\nSES bounce classification: `permanent` (hard) or `transient` (soft).\n\n```ts\ntype EmailBounceType = "permanent" | "transient"\n```\n\n### `Recipient`\n\n```ts\ntype Recipient = {\n  entity_id?: string // uuid\n  entity_schema?: string\n  title?: string\n  automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id?: string\n  portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n  portal_status_updated_at?: string // date-time\n  portal_state?: Record<string, unknown>\n  entity_ui_status?: "seen" | "dismissed" | "clicked"\n  entity_ui_status_updated_at?: string // date-time\n  entity_ui_status_before_dismiss?: "seen" | "dismissed" | "clicked"\n  message_entity_id?: string\n  email_status?: "sent" | "delivered" | "bounced" | "complained" | "failed"\n  email_status_updated_at?: string // date-time\n  email_bounce_type?: "permanent" | "transient"\n  email_bounce_subtype?: string\n  email_complaint_type?: string\n  email_bounce_reason?: string\n  email_send_error?: Record<string, unknown>\n  email_unsubscribed_at?: string // date-time\n  email_open_count?: number\n  email_first_opened_at?: string // date-time\n  email_last_opened_at?: string // date-time\n  email_click_count?: number\n  email_first_clicked_at?: string // date-time\n  email_clicked_links?: Array<{\n    url: string\n    clicked_at: string // date-time\n  }>\n  updated_at?: string // date-time\n}\n```\n\n### `BaseRecipientPayload`\n\n```ts\ntype BaseRecipientPayload = {\n  entity_id: string // uuid\n  entity_schema: string\n}\n```\n\n### `AutomationRecipientPayload`\n\n```ts\ntype AutomationRecipientPayload = {\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n}\n```\n\n### `PortalRecipientPayload`\n\n```ts\ntype PortalRecipientPayload = {\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `CreateRecipientPayload`\n\n```ts\ntype CreateRecipientPayload = {\n  entity_id: string // uuid\n  entity_schema: string\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n} | {\n  entity_id: string // uuid\n  entity_schema: string\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n} | {\n  entity_id: string // uuid\n  entity_schema: string\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `UpdateRecipientPayload`\n\n```ts\ntype UpdateRecipientPayload = {\n  automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id?: string\n  portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `RetriggerAutomationsRequest`\n\n```ts\ntype RetriggerAutomationsRequest = {\n  recipient_ids: string // uuid[]\n}\n```\n\n### `RetriggerAutomationsResult`\n\n```ts\ntype RetriggerAutomationsResult = {\n  recipient_id: string // uuid\n  result: "success" | "failure" | "not_found" | "invalid_status"\n  execution_id?: string\n  error?: string\n}\n```\n\n### `UpdatePortalStatusRequest`\n\n```ts\ntype UpdatePortalStatusRequest = {\n  status: "sent" | "seen" | "dismissed" | "clicked"\n}\n```\n\n### `UpdateEntityUiStatusRequest`\n\n```ts\ntype UpdateEntityUiStatusRequest = {\n  status: "seen" | "dismissed" | "clicked"\n  entity_schema?: string\n}\n```\n\n### `SetupCampaignRequest`\n\nDiscriminated by `type`. Each campaign variant has its own request shape;\nnew variants are added by introducing a new schema and extending the `oneOf` list.\n\n\n```ts\ntype SetupCampaignRequest = {\n  type: "tariff_change"\n  product_recommendation: {\n    name?: string\n    source_product_id?: string // uuid\n    source_price_id?: string // uuid\n    offers?: Array<{\n      target_id?: { ... }\n      items: { ... }\n    }>\n  }\n  campaign: {\n    name: string\n    goal?: string\n    target_ids: string // uuid[]\n  }\n  journey?: {\n    journey_id: string // uuid\n  }\n  channels?: {\n    portal_widget?: {\n      portal_id: { ... }\n      block_id: { ... }\n    }\n    email?: {\n      automation_id?: { ... }\n      template_id?: { ... }\n    }\n  }\n}\n```\n\n### `SetupTariffChangeCampaignRequest`\n\n```ts\ntype SetupTariffChangeCampaignRequest = {\n  type: "tariff_change"\n  product_recommendation: {\n    name?: string\n    source_product_id?: string // uuid\n    source_price_id?: string // uuid\n    offers?: Array<{\n      target_id?: { ... }\n      items: { ... }\n    }>\n  }\n  campaign: {\n    name: string\n    goal?: string\n    target_ids: string // uuid[]\n  }\n  journey?: {\n    journey_id: string // uuid\n  }\n  channels?: {\n    portal_widget?: {\n      portal_id: { ... }\n      block_id: { ... }\n    }\n    email?: {\n      automation_id?: { ... }\n      template_id?: { ... }\n    }\n  }\n}\n```\n\n### `SetupTariffChangeCampaignResponse`\n\n```ts\ntype SetupTariffChangeCampaignResponse = {\n  type: "tariff_change"\n  product_recommendation_id: string // uuid\n  campaign_id: string // uuid\n  journey_id?: string // uuid\n  portal_widget_id?: string // uuid\n}\n```\n';
-export {
-  targeting_default as default
-};