@epilot/sdk 2.11.7 → 2.12.0

package/dist/notification-PLIRHBNF.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/notification.json
+var notification_default = '# Notification API\n\n- **Base URL:** `https://notification.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/notification](https://docs.epilot.io/api/notification)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.notification.getNotificationsV2(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/notification\'\n\nconst notificationClient = getClient()\nauthorize(notificationClient, () => \'<token>\')\nconst { data } = await notificationClient.getNotificationsV2(...)\n```\n\n## Operations\n\n**Notification**\n- [`getNotificationsV2`](#getnotificationsv2)\n- [`createNotification`](#createnotification)\n- [`getNotifications`](#getnotifications)\n- [`getNotification`](#getnotification)\n- [`markAllAsRead`](#markallasread)\n- [`markAsRead`](#markasread)\n- [`getTotalUnread`](#gettotalunread)\n\n**Template**\n- [`listNotificationTemplates`](#listnotificationtemplates)\n- [`createNotificationTemplate`](#createnotificationtemplate)\n- [`getNotificationTemplate`](#getnotificationtemplate)\n- [`updateNotificationTemplate`](#updatenotificationtemplate)\n- [`patchNotificationTemplate`](#patchnotificationtemplate)\n- [`deleteNotificationTemplate`](#deletenotificationtemplate)\n- [`sendPreview`](#sendpreview)\n\n**Schemas**\n- [`Error`](#error)\n- [`EntityOperation`](#entityoperation)\n- [`NotificationItem`](#notificationitem)\n- [`Notification`](#notification)\n- [`NotificationBase`](#notificationbase)\n- [`EntityId`](#entityid)\n- [`Entity`](#entity)\n- [`Id`](#id)\n- [`NotificationId`](#notificationid)\n- [`NotificationCallerContext`](#notificationcallercontext)\n- [`EntitySlug`](#entityslug)\n- [`EntityOwner`](#entityowner)\n- [`EntityAcl`](#entityacl)\n- [`NotificationTemplate`](#notificationtemplate)\n- [`CreateNotificationTemplateInput`](#createnotificationtemplateinput)\n- [`UpdateNotificationTemplateInput`](#updatenotificationtemplateinput)\n- [`NotificationTemplateListResponse`](#notificationtemplatelistresponse)\n- [`SendPreviewInput`](#sendpreviewinput)\n- [`SendPreviewResponse`](#sendpreviewresponse)\n\n### `getNotificationsV2`\n\nGet notifications items. These items may eventually contain entities within their payload, which can be hydrated by the client if desired by calling the Entity API directly.\n\n`GET /v2/notification/notifications`\n\n```ts\nconst { data } = await client.getNotificationsV2({\n  cursor: \'example\',\n  after_id: 1,\n  limit: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "cursor": "eyJjcmVhd",\n  "total": 1,\n  "total_unread": 1,\n  "results": [\n    {\n      "id": 123456789,\n      "notification_id": 123456789,\n      "timestamp": "1970-01-01T00:00:00.000Z",\n      "read_state": false,\n      "type": "workflow",\n      "redirect_url": "https://epilot.cloud",\n      "organization_id": "206801",\n      "title": {\n        "en": "My custom notification",\n        "de": "Meine benutzerdefinierte Aktivit\xE4t"\n      },\n      "message": {\n        "en": "{{caller}} did something with {{contact.entity.id}} {{branch.name}}.",\n        "de": "{{caller}} habe etwas damit gemacht {{contact.entity.id}} {{branch.name}}."\n      },\n      "payload": {\n        "entity": {\n          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "schema": "contact"\n        }\n      },\n      "caller": {\n        "EpilotAuth": {\n          "token": {\n            "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",\n            "cognito:groups": ["Administrator"],\n            "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",\n            "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",\n            "custom:ivy_org_id": "739224",\n            "cognito:username": "n.ahmad@epilot.cloud",\n            "custom:ivy_user_id": "10006129",\n            "cognito:roles": ["arn:aws:iam::912468240823:role/base-administrator-role"],\n            "aud": "6e0jbdnger7nmoktaaflarue1l",\n            "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",\n            "token_use": "id",\n            "auth_time": 1614333023,\n            "exp": 1614336623,\n            "iat": 1614333023,\n            "email": "n.ahmad@epilot.cloud"\n          }\n        }\n      },\n      "operations": [\n        {\n          "entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "operation": "updateEntity",\n          "params": {\n            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "slug": "contact"\n          },\n          "payload": {\n            "_schema": "contact",\n            "_org": "123",\n            "status": "Inactive"\n          }\n        }\n      ],\n      "force_notify_users": {\n        "12345": {\n          "email": false,\n          "in_app": false\n        }\n      },\n      "allowed_channels": ["in_app"]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createNotification`\n\nCreate a message that can be displayed in the notification panel.\n\n`POST /v1/notification/notifications`\n\n```ts\nconst { data } = await client.createNotification(\n  null,\n  {\n    notification_id: 0,\n    timestamp: \'1970-01-01T00:00:00.000Z\',\n    type: \'workflow\',\n    redirect_url: \'https://epilot.cloud\',\n    organization_id: \'206801\',\n    title: {\n      en: \'My custom notification\',\n      de: \'Meine benutzerdefinierte Aktivit\xE4t\'\n    },\n    message: {\n      en: \'{{caller}} did something with {{contact.entity.id}} {{branch.name}}.\',\n      de: \'{{caller}} habe etwas damit gemacht {{contact.entity.id}} {{branch.name}}.\'\n    },\n    payload: {\n      entity: {\n        id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        schema: \'contact\'\n      }\n    },\n    caller: {\n      EpilotAuth: {\n        token: {\n          sub: \'476e9b48-42f4-4234-a2b0-4668b34626ce\',\n          \'cognito:groups\': [\'Administrator\'],\n          \'cognito:preferred_role\': \'arn:aws:iam::912468240823:role/base-administrator-role\',\n          iss: \'https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D\',\n          \'custom:ivy_org_id\': \'739224\',\n          \'cognito:username\': \'n.ahmad@epilot.cloud\',\n          \'custom:ivy_user_id\': \'10006129\',\n          \'cognito:roles\': [\'arn:aws:iam::912468240823:role/base-administrator-role\'],\n          aud: \'6e0jbdnger7nmoktaaflarue1l\',\n          event_id: \'cd5f5583-d90c-4db5-8e99-5f5dd29a4d75\',\n          token_use: \'id\',\n          auth_time: 1614333023,\n          exp: 1614336623,\n          iat: 1614333023,\n          email: \'n.ahmad@epilot.cloud\'\n        }\n      }\n    },\n    operations: [\n      {\n        entity: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        operation: \'updateEntity\',\n        params: {\n          id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n          slug: \'contact\'\n        },\n        payload: {\n          _schema: \'contact\',\n          _org: \'123\',\n          status: \'Inactive\'\n        }\n      }\n    ],\n    force_notify_users: {\n      \'12345\': {\n        email: false,\n        in_app: false\n      }\n    },\n    allowed_channels: [\'in_app\'],\n    read_state: false,\n    visibility_user_ids: [\'1\', \'2\', \'3\', \'4\', \'5\']\n  },\n)\n```\n\n---\n\n### `getNotifications`\n\nGet notifications\n\n`GET /v1/notification/notifications`\n\n```ts\nconst { data } = await client.getNotifications({\n  after_id: 1,\n  limit: 1,\n  no_hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "total": 1,\n  "total_unread": 1,\n  "results": [\n    {\n      "id": 123456789,\n      "notification_id": 123456789,\n      "timestamp": "1970-01-01T00:00:00.000Z",\n      "read_state": false,\n      "type": "workflow",\n      "redirect_url": "https://epilot.cloud",\n      "organization_id": "206801",\n      "title": {\n        "en": "My custom notification",\n        "de": "Meine benutzerdefinierte Aktivit\xE4t"\n      },\n      "message": {\n        "en": "{{caller}} did something with {{contact.entity.id}} {{branch.name}}.",\n        "de": "{{caller}} habe etwas damit gemacht {{contact.entity.id}} {{branch.name}}."\n      },\n      "payload": {\n        "entity": {\n          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "schema": "contact"\n        }\n      },\n      "caller": {\n        "EpilotAuth": {\n          "token": {\n            "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",\n            "cognito:groups": ["Administrator"],\n            "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",\n            "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",\n            "custom:ivy_org_id": "739224",\n            "cognito:username": "n.ahmad@epilot.cloud",\n            "custom:ivy_user_id": "10006129",\n            "cognito:roles": ["arn:aws:iam::912468240823:role/base-administrator-role"],\n            "aud": "6e0jbdnger7nmoktaaflarue1l",\n            "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",\n            "token_use": "id",\n            "auth_time": 1614333023,\n            "exp": 1614336623,\n            "iat": 1614333023,\n            "email": "n.ahmad@epilot.cloud"\n          }\n        }\n      },\n      "operations": [\n        {\n          "entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "operation": "updateEntity",\n          "params": {\n            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "slug": "contact"\n          },\n          "payload": {\n            "_schema": "contact",\n            "_org": "123",\n            "status": "Inactive"\n          }\n        }\n      ],\n      "force_notify_users": {\n        "12345": {\n          "email": false,\n          "in_app": false\n        }\n      },\n      "allowed_channels": ["in_app"]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getNotification`\n\nGet the details of a single notification.\n\n`GET /v1/notification/notifications/{id}`\n\n```ts\nconst { data } = await client.getNotification({\n  id: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": 123456789,\n  "notification_id": 123456789,\n  "timestamp": "1970-01-01T00:00:00.000Z",\n  "read_state": false,\n  "type": "workflow",\n  "redirect_url": "https://epilot.cloud",\n  "organization_id": "206801",\n  "title": {\n    "en": "My custom notification",\n    "de": "Meine benutzerdefinierte Aktivit\xE4t"\n  },\n  "message": {\n    "en": "{{caller}} did something with {{contact.entity.id}} {{branch.name}}.",\n    "de": "{{caller}} habe etwas damit gemacht {{contact.entity.id}} {{branch.name}}."\n  },\n  "payload": {\n    "entity": {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "schema": "contact"\n    }\n  },\n  "caller": {\n    "EpilotAuth": {\n      "token": {\n        "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",\n        "cognito:groups": ["Administrator"],\n        "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",\n        "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",\n        "custom:ivy_org_id": "739224",\n        "cognito:username": "n.ahmad@epilot.cloud",\n        "custom:ivy_user_id": "10006129",\n        "cognito:roles": ["arn:aws:iam::912468240823:role/base-administrator-role"],\n        "aud": "6e0jbdnger7nmoktaaflarue1l",\n        "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",\n        "token_use": "id",\n        "auth_time": 1614333023,\n        "exp": 1614336623,\n        "iat": 1614333023,\n        "email": "n.ahmad@epilot.cloud"\n      }\n    }\n  },\n  "operations": [\n    {\n      "entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "operation": "updateEntity",\n      "params": {\n        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n        "slug": "contact"\n      },\n      "payload": {\n        "_schema": "contact",\n        "_org": "123",\n        "status": "Inactive"\n      }\n    }\n  ],\n  "force_notify_users": {\n    "12345": {\n      "email": false,\n      "in_app": false\n    }\n  },\n  "allowed_channels": ["in_app"]\n}\n```\n\n</details>\n\n---\n\n### `markAllAsRead`\n\nMark all as read\n\n`PUT /v1/notification/notifications/mark`\n\n```ts\nconst { data } = await client.markAllAsRead()\n```\n\n---\n\n### `markAsRead`\n\nMark as read\n\n`PUT /v1/notification/notifications/{id}/mark`\n\n```ts\nconst { data } = await client.markAsRead({\n  id: 1,\n})\n```\n\n---\n\n### `getTotalUnread`\n\nGet total unread\n\n`GET /v1/notification/unreads`\n\n```ts\nconst { data } = await client.getTotalUnread()\n```\n\n---\n\n### `listNotificationTemplates`\n\nList notification templates with optional filtering and pagination\n\n`GET /v1/notification/templates`\n\n```ts\nconst { data } = await client.listNotificationTemplates({\n  q: \'example\',\n  from: 1,\n  size: 1,\n  sort: \'example\',\n  fields: \'example\',\n  hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_schema": "string",\n      "_title": "string",\n      "_org": "string",\n      "_tags": ["string"],\n      "_created_at": "1970-01-01T00:00:00.000Z",\n      "_updated_at": "1970-01-01T00:00:00.000Z",\n      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n      "_owners": [\n        {\n          "org_id": "string",\n          "user_id": "string"\n        }\n      ],\n      "_acl": {\n        "view": ["string"],\n        "edit": ["string"],\n        "delete": ["string"]\n      },\n      "name": "string",\n      "type": "string",\n      "notification_title": "string",\n      "message": "string",\n      "action_label": "string",\n      "action_url": "string",\n      "style": "string",\n      "system_template": true,\n      "created_by": "string",\n      "updated_by": "string"\n    }\n  ],\n  "hits": 0\n}\n```\n\n</details>\n\n---\n\n### `createNotificationTemplate`\n\nCreate a new notification template\n\n`POST /v1/notification/templates`\n\n```ts\nconst { data } = await client.createNotificationTemplate(\n  null,\n  {\n    name: \'string\',\n    type: \'string\',\n    notification_title: \'string\',\n    message: \'string\',\n    action_label: \'string\',\n    action_url: \'string\',\n    style: \'string\',\n    _title: \'string\',\n    _tags: [\'string\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_schema": "string",\n  "_title": "string",\n  "_org": "string",\n  "_tags": ["string"],\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "_owners": [\n    {\n      "org_id": "string",\n      "user_id": "string"\n    }\n  ],\n  "_acl": {\n    "view": ["string"],\n    "edit": ["string"],\n    "delete": ["string"]\n  },\n  "name": "string",\n  "type": "string",\n  "notification_title": "string",\n  "message": "string",\n  "action_label": "string",\n  "action_url": "string",\n  "style": "string",\n  "system_template": true,\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getNotificationTemplate`\n\nGet a single notification template by ID\n\n`GET /v1/notification/templates/{id}`\n\n```ts\nconst { data } = await client.getNotificationTemplate({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_schema": "string",\n  "_title": "string",\n  "_org": "string",\n  "_tags": ["string"],\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "_owners": [\n    {\n      "org_id": "string",\n      "user_id": "string"\n    }\n  ],\n  "_acl": {\n    "view": ["string"],\n    "edit": ["string"],\n    "delete": ["string"]\n  },\n  "name": "string",\n  "type": "string",\n  "notification_title": "string",\n  "message": "string",\n  "action_label": "string",\n  "action_url": "string",\n  "style": "string",\n  "system_template": true,\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateNotificationTemplate`\n\nUpdate a notification template (full replacement)\n\n`PUT /v1/notification/templates/{id}`\n\n```ts\nconst { data } = await client.updateNotificationTemplate(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    name: \'string\',\n    notification_title: \'string\',\n    message: \'string\',\n    action_label: \'string\',\n    action_url: \'string\',\n    style: \'string\',\n    _title: \'string\',\n    _tags: [\'string\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_schema": "string",\n  "_title": "string",\n  "_org": "string",\n  "_tags": ["string"],\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "_owners": [\n    {\n      "org_id": "string",\n      "user_id": "string"\n    }\n  ],\n  "_acl": {\n    "view": ["string"],\n    "edit": ["string"],\n    "delete": ["string"]\n  },\n  "name": "string",\n  "type": "string",\n  "notification_title": "string",\n  "message": "string",\n  "action_label": "string",\n  "action_url": "string",\n  "style": "string",\n  "system_template": true,\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `patchNotificationTemplate`\n\nPartially update a notification template\n\n`PATCH /v1/notification/templates/{id}`\n\n```ts\nconst { data } = await client.patchNotificationTemplate(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    name: \'string\',\n    notification_title: \'string\',\n    message: \'string\',\n    action_label: \'string\',\n    action_url: \'string\',\n    style: \'string\',\n    _title: \'string\',\n    _tags: [\'string\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_schema": "string",\n  "_title": "string",\n  "_org": "string",\n  "_tags": ["string"],\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "_owners": [\n    {\n      "org_id": "string",\n      "user_id": "string"\n    }\n  ],\n  "_acl": {\n    "view": ["string"],\n    "edit": ["string"],\n    "delete": ["string"]\n  },\n  "name": "string",\n  "type": "string",\n  "notification_title": "string",\n  "message": "string",\n  "action_label": "string",\n  "action_url": "string",\n  "style": "string",\n  "system_template": true,\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteNotificationTemplate`\n\nDelete a notification template permanently\n\n`DELETE /v1/notification/templates/{id}`\n\n```ts\nconst { data } = await client.deleteNotificationTemplate({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_schema": "string",\n  "_title": "string",\n  "_org": "string",\n  "_tags": ["string"],\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "_owners": [\n    {\n      "org_id": "string",\n      "user_id": "string"\n    }\n  ],\n  "_acl": {\n    "view": ["string"],\n    "edit": ["string"],\n    "delete": ["string"]\n  },\n  "name": "string",\n  "type": "string",\n  "notification_title": "string",\n  "message": "string",\n  "action_label": "string",\n  "action_url": "string",\n  "style": "string",\n  "system_template": true,\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `sendPreview`\n\nSend a preview notification (both email and in-app) to the requesting user.\nUsed to test notification templates before saving.\n\n`POST /v1/notification/templates/send-preview`\n\n```ts\nconst { data } = await client.sendPreview(\n  null,\n  {\n    template: {\n      name: \'string\',\n      notification_title: \'string\',\n      message: \'string\',\n      action_label: \'string\',\n      action_url: \'string\',\n      style: \'string\',\n      _title: \'string\',\n      _tags: [\'string\'],\n      _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n    },\n    context_ids: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "success": true,\n    "data": {}\n  }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Error`\n\n```ts\ntype Error = {\n  message: string\n  code?: string\n}\n```\n\n### `EntityOperation`\n\n```ts\ntype EntityOperation = {\n  entity: string // uuid\n  operation?: string\n  params?: {\n    id?: string // uuid\n    slug?: string\n  }\n  payload?: object\n}\n```\n\n### `NotificationItem`\n\n```ts\ntype NotificationItem = {\n  id?: number\n  notification_id?: number\n  timestamp?: string // date-time\n  read_state?: boolean\n  type: string\n  redirect_url?: string\n  organization_id?: string\n  title: {\n    en?: string\n    de?: string\n  }\n  message: {\n    en?: string\n    de?: string\n  }\n  payload?: Record<string, unknown>\n  caller?: {\n    EpilotAuth?: {\n      token?: { ... }\n    }\n  }\n  operations?: Array<{\n    entity: string // uuid\n    operation?: string\n    params?: {\n      id?: { ... }\n      slug?: { ... }\n    }\n    payload?: object\n  }>\n  force_notify_users?: Record<string, unknown>\n  allowed_channels?: "email" | "in_app"[]\n}\n```\n\n### `Notification`\n\n```ts\ntype Notification = {\n  notification_id?: number\n  timestamp?: string // date-time\n  type: string\n  redirect_url?: string\n  organization_id?: string\n  title: {\n    en?: string\n    de?: string\n  }\n  message: {\n    en?: string\n    de?: string\n  }\n  payload?: Record<string, unknown>\n  caller?: {\n    EpilotAuth?: {\n      token?: { ... }\n    }\n  }\n  operations?: Array<{\n    entity: string // uuid\n    operation?: string\n    params?: {\n      id?: { ... }\n      slug?: { ... }\n    }\n    payload?: object\n  }>\n  force_notify_users?: Record<string, unknown>\n  allowed_channels?: "email" | "in_app"[]\n  read_state?: boolean\n  visibility_user_ids?: string[]\n}\n```\n\n### `NotificationBase`\n\n```ts\ntype NotificationBase = {\n  notification_id?: number\n  timestamp?: string // date-time\n  type: string\n  redirect_url?: string\n  organization_id?: string\n  title: {\n    en?: string\n    de?: string\n  }\n  message: {\n    en?: string\n    de?: string\n  }\n  payload?: Record<string, unknown>\n  caller?: {\n    EpilotAuth?: {\n      token?: { ... }\n    }\n  }\n  operations?: Array<{\n    entity: string // uuid\n    operation?: string\n    params?: {\n      id?: { ... }\n      slug?: { ... }\n    }\n    payload?: object\n  }>\n  force_notify_users?: Record<string, unknown>\n  allowed_channels?: "email" | "in_app"[]\n}\n```\n\n### `EntityId`\n\n```ts\ntype EntityId = string // uuid\n```\n\n### `Entity`\n\n```ts\ntype Entity = Record<string, unknown>\n```\n\n### `Id`\n\n```ts\ntype Id = number\n```\n\n### `NotificationId`\n\n```ts\ntype NotificationId = number\n```\n\n### `NotificationCallerContext`\n\n```ts\ntype NotificationCallerContext = {\n  EpilotAuth?: {\n    token?: {\n      sub?: { ... }\n      email?: { ... }\n      cognito:username?: { ... }\n      custom:ivy_user_id?: { ... }\n    }\n  }\n}\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema\n\n```ts\ntype EntitySlug = string\n```\n\n### `EntityOwner`\n\n```ts\ntype EntityOwner = {\n  org_id: string\n  user_id: string\n}\n```\n\n### `EntityAcl`\n\nAccess control list\n\n```ts\ntype EntityAcl = {\n  view?: string[]\n  edit?: string[]\n  delete?: string[]\n}\n```\n\n### `NotificationTemplate`\n\n```ts\ntype NotificationTemplate = {\n  _id: string // uuid\n  _schema: string\n  _title: string\n  _org: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _manifest?: string // uuid[]\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  name?: string\n  type?: string\n  notification_title?: string\n  message?: string\n  action_label?: string\n  action_url?: string\n  style?: string\n  system_template?: boolean\n  created_by?: string\n  updated_by?: string\n}\n```\n\n### `CreateNotificationTemplateInput`\n\n```ts\ntype CreateNotificationTemplateInput = {\n  name: string\n  type: string\n  notification_title?: string\n  message?: string\n  action_label?: string\n  action_url?: string\n  style?: string\n  _title?: string\n  _tags?: string[]\n  _manifest?: string // uuid[]\n}\n```\n\n### `UpdateNotificationTemplateInput`\n\n```ts\ntype UpdateNotificationTemplateInput = {\n  name?: string\n  notification_title?: string\n  message?: string\n  action_label?: string\n  action_url?: string\n  style?: string\n  _title?: string\n  _tags?: string[]\n  _manifest?: string // uuid[]\n}\n```\n\n### `NotificationTemplateListResponse`\n\n```ts\ntype NotificationTemplateListResponse = {\n  results?: Array<{\n    _id: string // uuid\n    _schema: string\n    _title: string\n    _org: string\n    _tags?: string[]\n    _created_at: string // date-time\n    _updated_at: string // date-time\n    _manifest?: string // uuid[]\n    _owners?: Array<{\n      org_id: { ... }\n      user_id: { ... }\n    }>\n    _acl?: {\n      view?: { ... }\n      edit?: { ... }\n      delete?: { ... }\n    }\n    name?: string\n    type?: string\n    notification_title?: string\n    message?: string\n    action_label?: string\n    action_url?: string\n    style?: string\n    system_template?: boolean\n    created_by?: string\n    updated_by?: string\n  }>\n  hits?: number\n}\n```\n\n### `SendPreviewInput`\n\n```ts\ntype SendPreviewInput = {\n  template: {\n    name?: string\n    notification_title?: string\n    message?: string\n    action_label?: string\n    action_url?: string\n    style?: string\n    _title?: string\n    _tags?: string[]\n    _manifest?: string // uuid[]\n  }\n  context_ids?: Record<string, string>\n}\n```\n\n### `SendPreviewResponse`\n\nArray of results for each notification channel (email, in-app)\n\n```ts\ntype SendPreviewResponse = Array<{\n  success: boolean\n  data?: unknown\n}>\n```\n';
+export {
+  notification_default as default
+};

package/dist/notification-R2XBHFEW.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/notification.json
+var notification_default = '# Notification API\n\n- **Base URL:** `https://notification.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/notification](https://docs.epilot.io/api/notification)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.notification.getNotificationsV2(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/notification\'\n\nconst notificationClient = getClient()\nauthorize(notificationClient, () => \'<token>\')\nconst { data } = await notificationClient.getNotificationsV2(...)\n```\n\n## Operations\n\n**Notification**\n- [`getNotificationsV2`](#getnotificationsv2)\n- [`createNotification`](#createnotification)\n- [`getNotifications`](#getnotifications)\n- [`getNotification`](#getnotification)\n- [`markAllAsRead`](#markallasread)\n- [`markAsRead`](#markasread)\n- [`getTotalUnread`](#gettotalunread)\n\n**Template**\n- [`listNotificationTemplates`](#listnotificationtemplates)\n- [`createNotificationTemplate`](#createnotificationtemplate)\n- [`getNotificationTemplate`](#getnotificationtemplate)\n- [`updateNotificationTemplate`](#updatenotificationtemplate)\n- [`patchNotificationTemplate`](#patchnotificationtemplate)\n- [`deleteNotificationTemplate`](#deletenotificationtemplate)\n- [`sendPreview`](#sendpreview)\n\n**Schemas**\n- [`Error`](#error)\n- [`EntityOperation`](#entityoperation)\n- [`NotificationItem`](#notificationitem)\n- [`Notification`](#notification)\n- [`NotificationBase`](#notificationbase)\n- [`EntityId`](#entityid)\n- [`Entity`](#entity)\n- [`Id`](#id)\n- [`NotificationId`](#notificationid)\n- [`NotificationCallerContext`](#notificationcallercontext)\n- [`EntitySlug`](#entityslug)\n- [`EntityOwner`](#entityowner)\n- [`EntityAcl`](#entityacl)\n- [`NotificationTemplate`](#notificationtemplate)\n- [`CreateNotificationTemplateInput`](#createnotificationtemplateinput)\n- [`UpdateNotificationTemplateInput`](#updatenotificationtemplateinput)\n- [`NotificationTemplateListResponse`](#notificationtemplatelistresponse)\n- [`SendPreviewInput`](#sendpreviewinput)\n- [`SendPreviewResponse`](#sendpreviewresponse)\n\n### `getNotificationsV2`\n\nGet notifications items. These items may eventually contain entities within their payload, which can be hydrated by the client if desired by calling the Entity API directly.\n\n`GET /v2/notification/notifications`\n\n```ts\nconst { data } = await client.getNotificationsV2({\n  cursor: \'example\',\n  after_id: 1,\n  limit: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "cursor": "eyJjcmVhd",\n  "total": 1,\n  "total_unread": 1,\n  "results": [\n    {\n      "id": 123456789,\n      "notification_id": 123456789,\n      "timestamp": "1970-01-01T00:00:00.000Z",\n      "read_state": false,\n      "type": "workflow",\n      "redirect_url": "https://epilot.cloud",\n      "organization_id": "206801",\n      "title": {\n        "en": "My custom notification",\n        "de": "Meine benutzerdefinierte Aktivit\xE4t"\n      },\n      "message": {\n        "en": "{{caller}} did something with {{contact.entity.id}} {{branch.name}}.",\n        "de": "{{caller}} habe etwas damit gemacht {{contact.entity.id}} {{branch.name}}."\n      },\n      "payload": {\n        "entity": {\n          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "schema": "contact"\n        }\n      },\n      "caller": {\n        "EpilotAuth": {\n          "token": {\n            "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",\n            "cognito:groups": ["Administrator"],\n            "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",\n            "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",\n            "custom:ivy_org_id": "739224",\n            "cognito:username": "n.ahmad@epilot.cloud",\n            "custom:ivy_user_id": "10006129",\n            "cognito:roles": ["arn:aws:iam::912468240823:role/base-administrator-role"],\n            "aud": "6e0jbdnger7nmoktaaflarue1l",\n            "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",\n            "token_use": "id",\n            "auth_time": 1614333023,\n            "exp": 1614336623,\n            "iat": 1614333023,\n            "email": "n.ahmad@epilot.cloud"\n          }\n        }\n      },\n      "operations": [\n        {\n          "entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "operation": "updateEntity",\n          "params": {\n            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "slug": "contact"\n          },\n          "payload": {\n            "_schema": "contact",\n            "_org": "123",\n            "status": "Inactive"\n          }\n        }\n      ],\n      "force_notify_users": {\n        "12345": {\n          "email": false,\n          "in_app": false\n        }\n      },\n      "allowed_channels": ["in_app"]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createNotification`\n\nCreate a message that can be displayed in the notification panel.\n\n`POST /v1/notification/notifications`\n\n```ts\nconst { data } = await client.createNotification(\n  null,\n  {\n    notification_id: 0,\n    timestamp: \'1970-01-01T00:00:00.000Z\',\n    type: \'workflow\',\n    redirect_url: \'https://epilot.cloud\',\n    organization_id: \'206801\',\n    title: {\n      en: \'My custom notification\',\n      de: \'Meine benutzerdefinierte Aktivit\xE4t\'\n    },\n    message: {\n      en: \'{{caller}} did something with {{contact.entity.id}} {{branch.name}}.\',\n      de: \'{{caller}} habe etwas damit gemacht {{contact.entity.id}} {{branch.name}}.\'\n    },\n    payload: {\n      entity: {\n        id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        schema: \'contact\'\n      }\n    },\n    caller: {\n      EpilotAuth: {\n        token: {\n          sub: \'476e9b48-42f4-4234-a2b0-4668b34626ce\',\n          \'cognito:groups\': [\'Administrator\'],\n          \'cognito:preferred_role\': \'arn:aws:iam::912468240823:role/base-administrator-role\',\n          iss: \'https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D\',\n          \'custom:ivy_org_id\': \'739224\',\n          \'cognito:username\': \'n.ahmad@epilot.cloud\',\n          \'custom:ivy_user_id\': \'10006129\',\n          \'cognito:roles\': [\'arn:aws:iam::912468240823:role/base-administrator-role\'],\n          aud: \'6e0jbdnger7nmoktaaflarue1l\',\n          event_id: \'cd5f5583-d90c-4db5-8e99-5f5dd29a4d75\',\n          token_use: \'id\',\n          auth_time: 1614333023,\n          exp: 1614336623,\n          iat: 1614333023,\n          email: \'n.ahmad@epilot.cloud\'\n        }\n      }\n    },\n    operations: [\n      {\n        entity: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        operation: \'updateEntity\',\n        params: {\n          id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n          slug: \'contact\'\n        },\n        payload: {\n          _schema: \'contact\',\n          _org: \'123\',\n          status: \'Inactive\'\n        }\n      }\n    ],\n    force_notify_users: {\n      \'12345\': {\n        email: false,\n        in_app: false\n      }\n    },\n    allowed_channels: [\'in_app\'],\n    read_state: false,\n    visibility_user_ids: [\'1\', \'2\', \'3\', \'4\', \'5\']\n  },\n)\n```\n\n---\n\n### `getNotifications`\n\nGet notifications\n\n`GET /v1/notification/notifications`\n\n```ts\nconst { data } = await client.getNotifications({\n  after_id: 1,\n  limit: 1,\n  no_hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "total": 1,\n  "total_unread": 1,\n  "results": [\n    {\n      "id": 123456789,\n      "notification_id": 123456789,\n      "timestamp": "1970-01-01T00:00:00.000Z",\n      "read_state": false,\n      "type": "workflow",\n      "redirect_url": "https://epilot.cloud",\n      "organization_id": "206801",\n      "title": {\n        "en": "My custom notification",\n        "de": "Meine benutzerdefinierte Aktivit\xE4t"\n      },\n      "message": {\n        "en": "{{caller}} did something with {{contact.entity.id}} {{branch.name}}.",\n        "de": "{{caller}} habe etwas damit gemacht {{contact.entity.id}} {{branch.name}}."\n      },\n      "payload": {\n        "entity": {\n          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "schema": "contact"\n        }\n      },\n      "caller": {\n        "EpilotAuth": {\n          "token": {\n            "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",\n            "cognito:groups": ["Administrator"],\n            "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",\n            "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",\n            "custom:ivy_org_id": "739224",\n            "cognito:username": "n.ahmad@epilot.cloud",\n            "custom:ivy_user_id": "10006129",\n            "cognito:roles": ["arn:aws:iam::912468240823:role/base-administrator-role"],\n            "aud": "6e0jbdnger7nmoktaaflarue1l",\n            "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",\n            "token_use": "id",\n            "auth_time": 1614333023,\n            "exp": 1614336623,\n            "iat": 1614333023,\n            "email": "n.ahmad@epilot.cloud"\n          }\n        }\n      },\n      "operations": [\n        {\n          "entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "operation": "updateEntity",\n          "params": {\n            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "slug": "contact"\n          },\n          "payload": {\n            "_schema": "contact",\n            "_org": "123",\n            "status": "Inactive"\n          }\n        }\n      ],\n      "force_notify_users": {\n        "12345": {\n          "email": false,\n          "in_app": false\n        }\n      },\n      "allowed_channels": ["in_app"]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getNotification`\n\nGet the details of a single notification.\n\n`GET /v1/notification/notifications/{id}`\n\n```ts\nconst { data } = await client.getNotification({\n  id: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": 123456789,\n  "notification_id": 123456789,\n  "timestamp": "1970-01-01T00:00:00.000Z",\n  "read_state": false,\n  "type": "workflow",\n  "redirect_url": "https://epilot.cloud",\n  "organization_id": "206801",\n  "title": {\n    "en": "My custom notification",\n    "de": "Meine benutzerdefinierte Aktivit\xE4t"\n  },\n  "message": {\n    "en": "{{caller}} did something with {{contact.entity.id}} {{branch.name}}.",\n    "de": "{{caller}} habe etwas damit gemacht {{contact.entity.id}} {{branch.name}}."\n  },\n  "payload": {\n    "entity": {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "schema": "contact"\n    }\n  },\n  "caller": {\n    "EpilotAuth": {\n      "token": {\n        "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",\n        "cognito:groups": ["Administrator"],\n        "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",\n        "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",\n        "custom:ivy_org_id": "739224",\n        "cognito:username": "n.ahmad@epilot.cloud",\n        "custom:ivy_user_id": "10006129",\n        "cognito:roles": ["arn:aws:iam::912468240823:role/base-administrator-role"],\n        "aud": "6e0jbdnger7nmoktaaflarue1l",\n        "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",\n        "token_use": "id",\n        "auth_time": 1614333023,\n        "exp": 1614336623,\n        "iat": 1614333023,\n        "email": "n.ahmad@epilot.cloud"\n      }\n    }\n  },\n  "operations": [\n    {\n      "entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "operation": "updateEntity",\n      "params": {\n        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n        "slug": "contact"\n      },\n      "payload": {\n        "_schema": "contact",\n        "_org": "123",\n        "status": "Inactive"\n      }\n    }\n  ],\n  "force_notify_users": {\n    "12345": {\n      "email": false,\n      "in_app": false\n    }\n  },\n  "allowed_channels": ["in_app"]\n}\n```\n\n</details>\n\n---\n\n### `markAllAsRead`\n\nMark all as read\n\n`PUT /v1/notification/notifications/mark`\n\n```ts\nconst { data } = await client.markAllAsRead()\n```\n\n---\n\n### `markAsRead`\n\nMark as read\n\n`PUT /v1/notification/notifications/{id}/mark`\n\n```ts\nconst { data } = await client.markAsRead({\n  id: 1,\n})\n```\n\n---\n\n### `getTotalUnread`\n\nGet total unread\n\n`GET /v1/notification/unreads`\n\n```ts\nconst { data } = await client.getTotalUnread()\n```\n\n---\n\n### `listNotificationTemplates`\n\nList notification templates with optional filtering and pagination\n\n`GET /v1/notification/templates`\n\n```ts\nconst { data } = await client.listNotificationTemplates({\n  q: \'example\',\n  from: 1,\n  size: 1,\n  sort: \'example\',\n  fields: \'example\',\n  hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_schema": "string",\n      "_title": "string",\n      "_org": "string",\n      "_tags": ["string"],\n      "_created_at": "1970-01-01T00:00:00.000Z",\n      "_updated_at": "1970-01-01T00:00:00.000Z",\n      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n      "_owners": [\n        {\n          "org_id": "string",\n          "user_id": "string"\n        }\n      ],\n      "_acl": {\n        "view": ["string"],\n        "edit": ["string"],\n        "delete": ["string"]\n      },\n      "name": "string",\n      "type": "string",\n      "notification_title": "string",\n      "message": "string",\n      "action_label": "string",\n      "action_url": "string",\n      "style": "string",\n      "system_template": true,\n      "created_by": "string",\n      "updated_by": "string"\n    }\n  ],\n  "hits": 0\n}\n```\n\n</details>\n\n---\n\n### `createNotificationTemplate`\n\nCreate a new notification template\n\n`POST /v1/notification/templates`\n\n```ts\nconst { data } = await client.createNotificationTemplate(\n  null,\n  {\n    name: \'string\',\n    type: \'string\',\n    notification_title: \'string\',\n    message: \'string\',\n    action_label: \'string\',\n    action_url: \'string\',\n    style: \'string\',\n    _title: \'string\',\n    _tags: [\'string\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_schema": "string",\n  "_title": "string",\n  "_org": "string",\n  "_tags": ["string"],\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "_owners": [\n    {\n      "org_id": "string",\n      "user_id": "string"\n    }\n  ],\n  "_acl": {\n    "view": ["string"],\n    "edit": ["string"],\n    "delete": ["string"]\n  },\n  "name": "string",\n  "type": "string",\n  "notification_title": "string",\n  "message": "string",\n  "action_label": "string",\n  "action_url": "string",\n  "style": "string",\n  "system_template": true,\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getNotificationTemplate`\n\nGet a single notification template by ID\n\n`GET /v1/notification/templates/{id}`\n\n```ts\nconst { data } = await client.getNotificationTemplate({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_schema": "string",\n  "_title": "string",\n  "_org": "string",\n  "_tags": ["string"],\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "_owners": [\n    {\n      "org_id": "string",\n      "user_id": "string"\n    }\n  ],\n  "_acl": {\n    "view": ["string"],\n    "edit": ["string"],\n    "delete": ["string"]\n  },\n  "name": "string",\n  "type": "string",\n  "notification_title": "string",\n  "message": "string",\n  "action_label": "string",\n  "action_url": "string",\n  "style": "string",\n  "system_template": true,\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateNotificationTemplate`\n\nUpdate a notification template (full replacement)\n\n`PUT /v1/notification/templates/{id}`\n\n```ts\nconst { data } = await client.updateNotificationTemplate(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    name: \'string\',\n    notification_title: \'string\',\n    message: \'string\',\n    action_label: \'string\',\n    action_url: \'string\',\n    style: \'string\',\n    _title: \'string\',\n    _tags: [\'string\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_schema": "string",\n  "_title": "string",\n  "_org": "string",\n  "_tags": ["string"],\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "_owners": [\n    {\n      "org_id": "string",\n      "user_id": "string"\n    }\n  ],\n  "_acl": {\n    "view": ["string"],\n    "edit": ["string"],\n    "delete": ["string"]\n  },\n  "name": "string",\n  "type": "string",\n  "notification_title": "string",\n  "message": "string",\n  "action_label": "string",\n  "action_url": "string",\n  "style": "string",\n  "system_template": true,\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `patchNotificationTemplate`\n\nPartially update a notification template\n\n`PATCH /v1/notification/templates/{id}`\n\n```ts\nconst { data } = await client.patchNotificationTemplate(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    name: \'string\',\n    notification_title: \'string\',\n    message: \'string\',\n    action_label: \'string\',\n    action_url: \'string\',\n    style: \'string\',\n    _title: \'string\',\n    _tags: [\'string\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_schema": "string",\n  "_title": "string",\n  "_org": "string",\n  "_tags": ["string"],\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "_owners": [\n    {\n      "org_id": "string",\n      "user_id": "string"\n    }\n  ],\n  "_acl": {\n    "view": ["string"],\n    "edit": ["string"],\n    "delete": ["string"]\n  },\n  "name": "string",\n  "type": "string",\n  "notification_title": "string",\n  "message": "string",\n  "action_label": "string",\n  "action_url": "string",\n  "style": "string",\n  "system_template": true,\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteNotificationTemplate`\n\nDelete a notification template permanently\n\n`DELETE /v1/notification/templates/{id}`\n\n```ts\nconst { data } = await client.deleteNotificationTemplate({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_schema": "string",\n  "_title": "string",\n  "_org": "string",\n  "_tags": ["string"],\n  "_created_at": "1970-01-01T00:00:00.000Z",\n  "_updated_at": "1970-01-01T00:00:00.000Z",\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "_owners": [\n    {\n      "org_id": "string",\n      "user_id": "string"\n    }\n  ],\n  "_acl": {\n    "view": ["string"],\n    "edit": ["string"],\n    "delete": ["string"]\n  },\n  "name": "string",\n  "type": "string",\n  "notification_title": "string",\n  "message": "string",\n  "action_label": "string",\n  "action_url": "string",\n  "style": "string",\n  "system_template": true,\n  "created_by": "string",\n  "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `sendPreview`\n\nSend a preview notification (both email and in-app) to the requesting user.\nUsed to test notification templates before saving.\n\n`POST /v1/notification/templates/send-preview`\n\n```ts\nconst { data } = await client.sendPreview(\n  null,\n  {\n    template: {\n      name: \'string\',\n      notification_title: \'string\',\n      message: \'string\',\n      action_label: \'string\',\n      action_url: \'string\',\n      style: \'string\',\n      _title: \'string\',\n      _tags: [\'string\'],\n      _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n    },\n    context_ids: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "success": true,\n    "data": {}\n  }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Error`\n\n```ts\ntype Error = {\n  message: string\n  code?: string\n}\n```\n\n### `EntityOperation`\n\n```ts\ntype EntityOperation = {\n  entity: string // uuid\n  operation?: string\n  params?: {\n    id?: string // uuid\n    slug?: string\n  }\n  payload?: object\n}\n```\n\n### `NotificationItem`\n\n```ts\ntype NotificationItem = {\n  id?: number\n  notification_id?: number\n  timestamp?: string // date-time\n  read_state?: boolean\n  type: string\n  redirect_url?: string\n  organization_id?: string\n  title: {\n    en?: string\n    de?: string\n  }\n  message: {\n    en?: string\n    de?: string\n  }\n  payload?: Record<string, unknown>\n  caller?: {\n    EpilotAuth?: {\n      token?: { ... }\n    }\n  }\n  operations?: Array<{\n    entity: string // uuid\n    operation?: string\n    params?: {\n      id?: { ... }\n      slug?: { ... }\n    }\n    payload?: object\n  }>\n  force_notify_users?: Record<string, unknown>\n  allowed_channels?: "email" | "in_app"[]\n}\n```\n\n### `Notification`\n\n```ts\ntype Notification = {\n  notification_id?: number\n  timestamp?: string // date-time\n  type: string\n  redirect_url?: string\n  organization_id?: string\n  title: {\n    en?: string\n    de?: string\n  }\n  message: {\n    en?: string\n    de?: string\n  }\n  payload?: Record<string, unknown>\n  caller?: {\n    EpilotAuth?: {\n      token?: { ... }\n    }\n  }\n  operations?: Array<{\n    entity: string // uuid\n    operation?: string\n    params?: {\n      id?: { ... }\n      slug?: { ... }\n    }\n    payload?: object\n  }>\n  force_notify_users?: Record<string, unknown>\n  allowed_channels?: "email" | "in_app"[]\n  read_state?: boolean\n  visibility_user_ids?: string[]\n}\n```\n\n### `NotificationBase`\n\n```ts\ntype NotificationBase = {\n  notification_id?: number\n  timestamp?: string // date-time\n  type: string\n  redirect_url?: string\n  organization_id?: string\n  title: {\n    en?: string\n    de?: string\n  }\n  message: {\n    en?: string\n    de?: string\n  }\n  payload?: Record<string, unknown>\n  caller?: {\n    EpilotAuth?: {\n      token?: { ... }\n    }\n  }\n  operations?: Array<{\n    entity: string // uuid\n    operation?: string\n    params?: {\n      id?: { ... }\n      slug?: { ... }\n    }\n    payload?: object\n  }>\n  force_notify_users?: Record<string, unknown>\n  allowed_channels?: "email" | "in_app"[]\n}\n```\n\n### `EntityId`\n\n```ts\ntype EntityId = string // uuid\n```\n\n### `Entity`\n\n```ts\ntype Entity = Record<string, unknown>\n```\n\n### `Id`\n\n```ts\ntype Id = number\n```\n\n### `NotificationId`\n\n```ts\ntype NotificationId = number\n```\n\n### `NotificationCallerContext`\n\n```ts\ntype NotificationCallerContext = {\n  EpilotAuth?: {\n    token?: {\n      sub?: { ... }\n      email?: { ... }\n      cognito:username?: { ... }\n      custom:ivy_user_id?: { ... }\n    }\n  }\n}\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema\n\n```ts\ntype EntitySlug = string\n```\n\n### `EntityOwner`\n\n```ts\ntype EntityOwner = {\n  org_id: string\n  user_id: string\n}\n```\n\n### `EntityAcl`\n\nAccess control list\n\n```ts\ntype EntityAcl = {\n  view?: string[]\n  edit?: string[]\n  delete?: string[]\n}\n```\n\n### `NotificationTemplate`\n\n```ts\ntype NotificationTemplate = {\n  _id: string // uuid\n  _schema: string\n  _title: string\n  _org: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _manifest?: string // uuid[]\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  name?: string\n  type?: string\n  notification_title?: string\n  message?: string\n  action_label?: string\n  action_url?: string\n  style?: string\n  system_template?: boolean\n  created_by?: string\n  updated_by?: string\n}\n```\n\n### `CreateNotificationTemplateInput`\n\n```ts\ntype CreateNotificationTemplateInput = {\n  name: string\n  type: string\n  notification_title?: string\n  message?: string\n  action_label?: string\n  action_url?: string\n  style?: string\n  _title?: string\n  _tags?: string[]\n  _manifest?: string // uuid[]\n}\n```\n\n### `UpdateNotificationTemplateInput`\n\n```ts\ntype UpdateNotificationTemplateInput = {\n  name?: string\n  notification_title?: string\n  message?: string\n  action_label?: string\n  action_url?: string\n  style?: string\n  _title?: string\n  _tags?: string[]\n  _manifest?: string // uuid[]\n}\n```\n\n### `NotificationTemplateListResponse`\n\n```ts\ntype NotificationTemplateListResponse = {\n  results?: Array<{\n    _id: string // uuid\n    _schema: string\n    _title: string\n    _org: string\n    _tags?: string[]\n    _created_at: string // date-time\n    _updated_at: string // date-time\n    _manifest?: string // uuid[]\n    _owners?: Array<{\n      org_id: { ... }\n      user_id: { ... }\n    }>\n    _acl?: {\n      view?: { ... }\n      edit?: { ... }\n      delete?: { ... }\n    }\n    name?: string\n    type?: string\n    notification_title?: string\n    message?: string\n    action_label?: string\n    action_url?: string\n    style?: string\n    system_template?: boolean\n    created_by?: string\n    updated_by?: string\n  }>\n  hits?: number\n}\n```\n\n### `SendPreviewInput`\n\n```ts\ntype SendPreviewInput = {\n  template: {\n    name?: string\n    notification_title?: string\n    message?: string\n    action_label?: string\n    action_url?: string\n    style?: string\n    _title?: string\n    _tags?: string[]\n    _manifest?: string // uuid[]\n  }\n  context_ids?: Record<string, string>\n}\n```\n\n### `SendPreviewResponse`\n\nArray of results for each notification channel (email, in-app)\n\n```ts\ntype SendPreviewResponse = Array<{\n  success: boolean\n  data?: unknown\n}>\n```\n';
+
+
+exports.default = notification_default;

package/dist/{notification.d-BfBL3lga.d.ts → notification.d-r89Jec85.d.cts}

@@ -1,8 +1,6 @@
 import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
 
 /* Auto-copied from notification-client */
-/* eslint-disable */
-
 
 
 declare namespace Components {
@@ -208,6 +206,14 @@ declare namespace Components {
             force_notify_users?: {
                 [name: string]: any;
             };
+            /**
+             * Optional delivery-channel ceiling. When present, delivery is restricted to the intersection of this set and each recipient's own notification preferences — it can only NARROW delivery, never force a channel on. Absent means no restriction (recipient preferences and per-type defaults apply as before). An empty array suppresses all channels.
+             * example:
+             * [
+             *   "in_app"
+             * ]
+             */
+            allowed_channels?: ("email" | "in_app")[];
             /**
              * example:
              * false
@@ -301,6 +307,14 @@ declare namespace Components {
             force_notify_users?: {
                 [name: string]: any;
             };
+            /**
+             * Optional delivery-channel ceiling. When present, delivery is restricted to the intersection of this set and each recipient's own notification preferences — it can only NARROW delivery, never force a channel on. Absent means no restriction (recipient preferences and per-type defaults apply as before). An empty array suppresses all channels.
+             * example:
+             * [
+             *   "in_app"
+             * ]
+             */
+            allowed_channels?: ("email" | "in_app")[];
         }
         export interface NotificationCallerContext {
             [name: string]: any;
@@ -447,6 +461,14 @@ declare namespace Components {
             force_notify_users?: {
                 [name: string]: any;
             };
+            /**
+             * Optional delivery-channel ceiling. When present, delivery is restricted to the intersection of this set and each recipient's own notification preferences — it can only NARROW delivery, never force a channel on. Absent means no restriction (recipient preferences and per-type defaults apply as before). An empty array suppresses all channels.
+             * example:
+             * [
+             *   "in_app"
+             * ]
+             */
+            allowed_channels?: ("email" | "in_app")[];
         }
         export interface NotificationTemplate {
             /**

package/dist/{notification.d-BfBL3lga.d.cts → notification.d-r89Jec85.d.ts}

@@ -1,8 +1,6 @@
 import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
 
 /* Auto-copied from notification-client */
-/* eslint-disable */
-
 
 
 declare namespace Components {
@@ -208,6 +206,14 @@ declare namespace Components {
             force_notify_users?: {
                 [name: string]: any;
             };
+            /**
+             * Optional delivery-channel ceiling. When present, delivery is restricted to the intersection of this set and each recipient's own notification preferences — it can only NARROW delivery, never force a channel on. Absent means no restriction (recipient preferences and per-type defaults apply as before). An empty array suppresses all channels.
+             * example:
+             * [
+             *   "in_app"
+             * ]
+             */
+            allowed_channels?: ("email" | "in_app")[];
             /**
              * example:
              * false
@@ -301,6 +307,14 @@ declare namespace Components {
             force_notify_users?: {
                 [name: string]: any;
             };
+            /**
+             * Optional delivery-channel ceiling. When present, delivery is restricted to the intersection of this set and each recipient's own notification preferences — it can only NARROW delivery, never force a channel on. Absent means no restriction (recipient preferences and per-type defaults apply as before). An empty array suppresses all channels.
+             * example:
+             * [
+             *   "in_app"
+             * ]
+             */
+            allowed_channels?: ("email" | "in_app")[];
         }
         export interface NotificationCallerContext {
             [name: string]: any;
@@ -447,6 +461,14 @@ declare namespace Components {
             force_notify_users?: {
                 [name: string]: any;
             };
+            /**
+             * Optional delivery-channel ceiling. When present, delivery is restricted to the intersection of this set and each recipient's own notification preferences — it can only NARROW delivery, never force a channel on. Absent means no restriction (recipient preferences and per-type defaults apply as before). An empty array suppresses all channels.
+             * example:
+             * [
+             *   "in_app"
+             * ]
+             */
+            allowed_channels?: ("email" | "in_app")[];
         }
         export interface NotificationTemplate {
             /**

package/docs/integration-toolkit.md

@@ -2669,6 +2669,7 @@ const { data } = await client.getMonitoringStatsV2(
     from_date: '2025-01-01T00:00:00Z',
     to_date: '2025-01-31T23:59:59Z',
     use_case_type: 'inbound',
+    use_case_types: ['inbound'],
     group_by: 'use_case_id',
     source: 'monitoring'
   },
@@ -3572,7 +3573,7 @@ type IntegrationSettings = {
     monitoredUseCases?: string[]
     monitoredCodes?: string[]
     rules: Array<{
-      id: { ... }
+      id?: { ... }
       name?: { ... }
       type: { ... }
       enabled: { ... }
@@ -3583,7 +3584,6 @@ type IntegrationSettings = {
       fallbackThreshold?: { ... }
       window?: { ... }
       minSampleSize?: { ... }
-      consecutive?: { ... }
       quietPeriod?: { ... }
     }>
     digest: {
@@ -3629,9 +3629,9 @@ type IntegrationNotificationConfig = {
   monitoredUseCases?: string[]
   monitoredCodes?: string[]
   rules: Array<{
-    id: string
+    id?: string
     name?: string
-    type: "critical_error" | "error_threshold" | "warning_threshold" | "success_rate_drop" | "recovery" | "silence" | "consecutive_failures" | "first_error" | "new_error_code" | "auth_expiry" | "ack_timeout" | "validation_surge"
+    type: "critical_error" | "error_threshold" | "warning_threshold" | "success_rate_drop" | "recovery" | "silence"
     enabled: boolean
     channels?: {
       email: { ... }
@@ -3643,7 +3643,6 @@ type IntegrationNotificationConfig = {
     fallbackThreshold?: number
     window?: string
     minSampleSize?: number
-    consecutive?: number
     quietPeriod?: string
   }>
   digest: {
@@ -3686,13 +3685,13 @@ type NotificationChannelSet = {
 
 ### `NotificationRule`
 
-A single notification rule. Only the params relevant to a given type are set. The id is a server-minted ULID, preserved across edits.
+A single notification rule. Only the params relevant to a given type are set. The id is optional on write: the server mints a ULID when omitted and preserves a supplied id verbatim (a stable id keeps a rule's AlertState across config saves).
 
 ```ts
 type NotificationRule = {
-  id: string
+  id?: string
   name?: string
-  type: "critical_error" | "error_threshold" | "warning_threshold" | "success_rate_drop" | "recovery" | "silence" | "consecutive_failures" | "first_error" | "new_error_code" | "auth_expiry" | "ack_timeout" | "validation_surge"
+  type: "critical_error" | "error_threshold" | "warning_threshold" | "success_rate_drop" | "recovery" | "silence"
   enabled: boolean
   channels?: {
     email: boolean
@@ -3704,7 +3703,6 @@ type NotificationRule = {
   fallbackThreshold?: number
   window?: string
   minSampleSize?: number
-  consecutive?: number
   quietPeriod?: string
 }
 ```
@@ -3805,6 +3803,7 @@ type IntegrationWithUseCases = {
       allowed_origins?: { ... }
       steps: { ... }
       response: { ... }
+      prevent_indirect_serving?: { ... }
     }
   } | {
     id: string // uuid
@@ -3944,11 +3943,11 @@ type UpsertIntegrationWithUseCasesRequest = {
       allowed_origins?: { ... }
       steps: { ... }
       response: { ... }
+      prevent_indirect_serving?: { ... }
     }
   } | {
     id?: string // uuid
     name: string
-    slug?: string
   // ...
 }
 ```
@@ -4554,6 +4553,7 @@ type EmbeddedUseCaseRequest = {
       filename?: { ... }
       content_type?: { ... }
     }
+    prevent_indirect_serving?: boolean
   }
 } | {
   id?: string // uuid
@@ -4563,7 +4563,6 @@ type EmbeddedUseCaseRequest = {
   change_description?: string
   type: "managed_call"
   configuration?: {
-    operation: {
   // ...
 }
 ```
@@ -4685,6 +4684,7 @@ type EmbeddedFileProxyUseCaseRequest = {
       filename?: { ... }
       content_type?: { ... }
     }
+    prevent_indirect_serving?: boolean
   }
 }
 ```
@@ -4861,6 +4861,7 @@ type FileProxyUseCase = {
       filename?: { ... }
       content_type?: { ... }
     }
+    prevent_indirect_serving?: boolean
   }
 }
 ```
@@ -5020,7 +5021,7 @@ type UseCase = {
       filename?: { ... }
       content_type?: { ... }
     }
-  }
+    prevent_indirect_serving?: boolean
   // ...
 }
 ```
@@ -5112,6 +5113,7 @@ type CreateUseCaseRequest = {
       filename?: { ... }
       content_type?: { ... }
     }
+    prevent_indirect_serving?: boolean
   }
 } | {
   name: string
@@ -5127,7 +5129,6 @@ type CreateUseCaseRequest = {
     }
     request_mapping?: string
     response_mapping?: string
-    inbound_use_case_slug?: string
   // ...
 }
 ```
@@ -5241,6 +5242,7 @@ type CreateFileProxyUseCaseRequest = {
       filename?: { ... }
       content_type?: { ... }
     }
+    prevent_indirect_serving?: boolean
   }
 }
 ```
@@ -5373,6 +5375,7 @@ type UpdateUseCaseRequest = {
       filename?: { ... }
       content_type?: { ... }
     }
+    prevent_indirect_serving?: boolean
   }
 } | {
   name?: string
@@ -5385,7 +5388,6 @@ type UpdateUseCaseRequest = {
       method: { ... }
       path: { ... }
       headers?: { ... }
-      query_params?: { ... }
   // ...
 }
 ```
@@ -5503,6 +5505,7 @@ type UpdateFileProxyUseCaseRequest = {
       filename?: { ... }
       content_type?: { ... }
     }
+    prevent_indirect_serving?: boolean
   }
 }
 ```
@@ -5799,6 +5802,7 @@ type FileProxyUseCaseHistoryEntry = {
       filename?: { ... }
       content_type?: { ... }
     }
+    prevent_indirect_serving?: boolean
   }
 }
 ```
@@ -6319,6 +6323,7 @@ type FileProxyUseCaseConfiguration = {
     filename?: string
     content_type?: string
   }
+  prevent_indirect_serving?: boolean
 }
 ```
 
@@ -7268,6 +7273,7 @@ type GetMonitoringStatsV2Request = {
   from_date?: string // date-time
   to_date?: string // date-time
   use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy"
+  use_case_types?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy"[]
   group_by?: "use_case_id" | "use_case_type" | "level" | "code" | "date"
   source?: "monitoring" | "incoming"
 }

package/docs/notification.md

@@ -149,7 +149,8 @@ const { data } = await client.getNotificationsV2({
           "email": false,
           "in_app": false
         }
-      }
+      },
+      "allowed_channels": ["in_app"]
     }
   ]
 }
@@ -230,6 +231,7 @@ const { data } = await client.createNotification(
         in_app: false
       }
     },
+    allowed_channels: ['in_app'],
     read_state: false,
     visibility_user_ids: ['1', '2', '3', '4', '5']
   },
@@ -323,7 +325,8 @@ const { data } = await client.getNotifications({
           "email": false,
           "in_app": false
         }
-      }
+      },
+      "allowed_channels": ["in_app"]
     }
   ]
 }
@@ -412,7 +415,8 @@ const { data } = await client.getNotification({
       "email": false,
       "in_app": false
     }
-  }
+  },
+  "allowed_channels": ["in_app"]
 }
 ```
 
@@ -927,6 +931,7 @@ type NotificationItem = {
     payload?: object
   }>
   force_notify_users?: Record<string, unknown>
+  allowed_channels?: "email" | "in_app"[]
 }
 ```
 
@@ -963,6 +968,7 @@ type Notification = {
     payload?: object
   }>
   force_notify_users?: Record<string, unknown>
+  allowed_channels?: "email" | "in_app"[]
   read_state?: boolean
   visibility_user_ids?: string[]
 }
@@ -1001,6 +1007,7 @@ type NotificationBase = {
     payload?: object
   }>
   force_notify_users?: Record<string, unknown>
+  allowed_channels?: "email" | "in_app"[]
 }
 ```
 

package/package.json

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