@epilot/sdk 2.1.0-rc.1 → 2.1.0

package/dist/kanban-HI6LL5WY.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/kanban.json
+var kanban_default = '# Kanban API\n\n- **Base URL:** `https://kanban.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/kanban](https://docs.epilot.io/api/kanban)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.kanban.createKanbanBoard(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/kanban\'\n\nconst kanbanClient = getClient()\nauthorize(kanbanClient, () => \'<token>\')\nconst { data } = await kanbanClient.createKanbanBoard(...)\n```\n\n## Operations\n\n**Kanban**\n- [`createKanbanBoard`](#createkanbanboard)\n- [`getKanbanBoards`](#getkanbanboards)\n- [`getKanbanBoard`](#getkanbanboard)\n- [`updateKanbanBoard`](#updatekanbanboard)\n- [`patchKanbanBoard`](#patchkanbanboard)\n- [`deleteKanbanBoard`](#deletekanbanboard)\n- [`setDefaultKanbanBoard`](#setdefaultkanbanboard)\n- [`clearDefaultKanbanBoard`](#cleardefaultkanbanboard)\n\n**Query**\n- [`flowsAutocomplete`](#flowsautocomplete)\n- [`executeFlowsQuery`](#executeflowsquery)\n\n**Schemas**\n- [`Error`](#error)\n- [`BoardSummary`](#boardsummary)\n- [`Board`](#board)\n- [`Swimlane`](#swimlane)\n- [`Sorting`](#sorting)\n- [`BoardFilter`](#boardfilter)\n- [`FilterGroup`](#filtergroup)\n- [`FilterOperator`](#filteroperator)\n- [`DynamicDateValue`](#dynamicdatevalue)\n- [`ValueType`](#valuetype)\n- [`FlowsQueryRequest`](#flowsqueryrequest)\n- [`FlowsQueryResult`](#flowsqueryresult)\n- [`FilterItem`](#filteritem)\n\n### `createKanbanBoard`\n\nCreates a new Kanban board with the provided configuration.\n\n`POST /v1/kanban/board`\n\n```ts\nconst { data } = await client.createKanbanBoard(\n  null,\n  {\n    id: \'string\',\n    title: \'Board 1\',\n    description: \'Board description\',\n    created_at: \'1970-01-01T00:00:00.000Z\',\n    updated_at: \'1970-01-01T00:00:00.000Z\',\n    created_by: \'string\',\n    org_id: \'string\',\n    updated_by: \'string\',\n    shared_with: [\'string\'],\n    shared_with_org: true,\n    owners: [\'string\'],\n    config: {\n      dataset: \'workflow_tasks_overview\',\n      swimlanes: [\n        {\n          id: \'string\',\n          title: \'Swimlane 1\',\n          position: 1,\n          filter: {\n            items: [\n              {\n                key: \'assignee\',\n                operator: \'EQUALS\',\n                value: \'100020\',\n                data_type: \'string\'\n              }\n            ],\n            combination: \'OR\'\n          },\n          title_chip_variant: \'success\'\n        }\n      ],\n      card_config: {\n        fields: [\'assignee\']\n      },\n      board_filter: {\n        items: [\n          {\n            key: \'assignee\',\n            operator: \'EQUALS\',\n            value: \'100020\',\n            data_type: \'string\'\n          }\n        ],\n        combination: \'OR\'\n      },\n      sorting: {\n        field: \'created_at\',\n        direction: \'asc\'\n      },\n      search_query: \'task 1\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "title": "Board 1",\n  "description": "Board description",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "org_id": "string",\n  "updated_by": "string",\n  "shared_with": ["string"],\n  "shared_with_org": true,\n  "owners": ["string"],\n  "config": {\n    "dataset": "workflow_tasks_overview",\n    "swimlanes": [\n      {\n        "id": "string",\n        "title": "Swimlane 1",\n        "position": 1,\n        "filter": {\n          "items": [\n            {\n              "key": "assignee",\n              "operator": "EQUALS",\n              "value": "100020",\n              "data_type": "string"\n            }\n          ],\n          "combination": "OR"\n        },\n        "title_chip_variant": "success"\n      }\n    ],\n    "card_config": {\n      "fields": ["assignee"]\n    },\n    "board_filter": {\n      "items": [\n        {\n          "key": "assignee",\n          "operator": "EQUALS",\n          "value": "100020",\n          "data_type": "string"\n        }\n      ],\n      "combination": "OR"\n    },\n    "sorting": {\n      "field": "created_at",\n      "direction": "asc"\n    },\n    "search_query": "task 1"\n  }\n}\n```\n\n</details>\n\n---\n\n### `getKanbanBoards`\n\nReturns a list of all Kanban boards accessible to the authenticated user.\n\n`GET /v1/kanban/boards`\n\n```ts\nconst { data } = await client.getKanbanBoards({\n  filter: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "string",\n    "title": "Board 1",\n    "description": "Board description",\n    "created_at": "1970-01-01T00:00:00.000Z",\n    "updated_at": "1970-01-01T00:00:00.000Z",\n    "created_by": "string",\n    "org_id": "string",\n    "updated_by": "string",\n    "shared_with": ["string"],\n    "shared_with_org": true,\n    "owners": ["string"]\n  }\n]\n```\n\n</details>\n\n---\n\n### `getKanbanBoard`\n\nRetrieves a Kanban board by ID, including its full configuration (swimlanes, filters, sorting, card fields).\n\n`GET /v1/kanban/board/{boardId}`\n\n```ts\nconst { data } = await client.getKanbanBoard({\n  boardId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "title": "Board 1",\n  "description": "Board description",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "org_id": "string",\n  "updated_by": "string",\n  "shared_with": ["string"],\n  "shared_with_org": true,\n  "owners": ["string"],\n  "config": {\n    "dataset": "workflow_tasks_overview",\n    "swimlanes": [\n      {\n        "id": "string",\n        "title": "Swimlane 1",\n        "position": 1,\n        "filter": {\n          "items": [\n            {\n              "key": "assignee",\n              "operator": "EQUALS",\n              "value": "100020",\n              "data_type": "string"\n            }\n          ],\n          "combination": "OR"\n        },\n        "title_chip_variant": "success"\n      }\n    ],\n    "card_config": {\n      "fields": ["assignee"]\n    },\n    "board_filter": {\n      "items": [\n        {\n          "key": "assignee",\n          "operator": "EQUALS",\n          "value": "100020",\n          "data_type": "string"\n        }\n      ],\n      "combination": "OR"\n    },\n    "sorting": {\n      "field": "created_at",\n      "direction": "asc"\n    },\n    "search_query": "task 1"\n  }\n}\n```\n\n</details>\n\n---\n\n### `updateKanbanBoard`\n\nFully replaces the configuration of an existing Kanban board by ID.\n\n`PUT /v1/kanban/board/{boardId}`\n\n```ts\nconst { data } = await client.updateKanbanBoard(\n  {\n    boardId: \'example\',\n  },\n  {\n    id: \'string\',\n    title: \'Board 1\',\n    description: \'Board description\',\n    created_at: \'1970-01-01T00:00:00.000Z\',\n    updated_at: \'1970-01-01T00:00:00.000Z\',\n    created_by: \'string\',\n    org_id: \'string\',\n    updated_by: \'string\',\n    shared_with: [\'string\'],\n    shared_with_org: true,\n    owners: [\'string\'],\n    config: {\n      dataset: \'workflow_tasks_overview\',\n      swimlanes: [\n        {\n          id: \'string\',\n          title: \'Swimlane 1\',\n          position: 1,\n          filter: {\n            items: [\n              {\n                key: \'assignee\',\n                operator: \'EQUALS\',\n                value: \'100020\',\n                data_type: \'string\'\n              }\n            ],\n            combination: \'OR\'\n          },\n          title_chip_variant: \'success\'\n        }\n      ],\n      card_config: {\n        fields: [\'assignee\']\n      },\n      board_filter: {\n        items: [\n          {\n            key: \'assignee\',\n            operator: \'EQUALS\',\n            value: \'100020\',\n            data_type: \'string\'\n          }\n        ],\n        combination: \'OR\'\n      },\n      sorting: {\n        field: \'created_at\',\n        direction: \'asc\'\n      },\n      search_query: \'task 1\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "title": "Board 1",\n  "description": "Board description",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "org_id": "string",\n  "updated_by": "string",\n  "shared_with": ["string"],\n  "shared_with_org": true,\n  "owners": ["string"],\n  "config": {\n    "dataset": "workflow_tasks_overview",\n    "swimlanes": [\n      {\n        "id": "string",\n        "title": "Swimlane 1",\n        "position": 1,\n        "filter": {\n          "items": [\n            {\n              "key": "assignee",\n              "operator": "EQUALS",\n              "value": "100020",\n              "data_type": "string"\n            }\n          ],\n          "combination": "OR"\n        },\n        "title_chip_variant": "success"\n      }\n    ],\n    "card_config": {\n      "fields": ["assignee"]\n    },\n    "board_filter": {\n      "items": [\n        {\n          "key": "assignee",\n          "operator": "EQUALS",\n          "value": "100020",\n          "data_type": "string"\n        }\n      ],\n      "combination": "OR"\n    },\n    "sorting": {\n      "field": "created_at",\n      "direction": "asc"\n    },\n    "search_query": "task 1"\n  }\n}\n```\n\n</details>\n\n---\n\n### `patchKanbanBoard`\n\nPartially updates fields of an existing Kanban board by ID.\n\n`PATCH /v1/kanban/board/{boardId}`\n\n```ts\nconst { data } = await client.patchKanbanBoard(\n  {\n    boardId: \'example\',\n  },\n  {\n    title: \'Board 1\',\n    description: \'Board description\',\n    shared_with: [\'string\'],\n    shared_with_org: true,\n    owners: [\'string\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "title": "Board 1",\n  "description": "Board description",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "org_id": "string",\n  "updated_by": "string",\n  "shared_with": ["string"],\n  "shared_with_org": true,\n  "owners": ["string"],\n  "config": {\n    "dataset": "workflow_tasks_overview",\n    "swimlanes": [\n      {\n        "id": "string",\n        "title": "Swimlane 1",\n        "position": 1,\n        "filter": {\n          "items": [\n            {\n              "key": "assignee",\n              "operator": "EQUALS",\n              "value": "100020",\n              "data_type": "string"\n            }\n          ],\n          "combination": "OR"\n        },\n        "title_chip_variant": "success"\n      }\n    ],\n    "card_config": {\n      "fields": ["assignee"]\n    },\n    "board_filter": {\n      "items": [\n        {\n          "key": "assignee",\n          "operator": "EQUALS",\n          "value": "100020",\n          "data_type": "string"\n        }\n      ],\n      "combination": "OR"\n    },\n    "sorting": {\n      "field": "created_at",\n      "direction": "asc"\n    },\n    "search_query": "task 1"\n  }\n}\n```\n\n</details>\n\n---\n\n### `deleteKanbanBoard`\n\nPermanently deletes a Kanban board by ID. This action is irreversible.\n\n`DELETE /v1/kanban/board/{boardId}`\n\n```ts\nconst { data } = await client.deleteKanbanBoard({\n  boardId: \'example\',\n})\n```\n\n---\n\n### `setDefaultKanbanBoard`\n\nSets a Kanban board as the default board for the organization.\n\n`PUT /v1/kanban/org/default-board`\n\n```ts\nconst { data } = await client.setDefaultKanbanBoard({\n  boardId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "message": "string",\n  "default_board_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `clearDefaultKanbanBoard`\n\nRemoves the default board configuration for the organization.\n\n`DELETE /v1/kanban/org/default-board`\n\n```ts\nconst { data } = await client.clearDefaultKanbanBoard()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "message": "string",\n  "default_board_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `flowsAutocomplete`\n\nReturns autocomplete suggestions for a given attribute in the Flows dataset.\n\n`GET /v1/kanban/query/flows:autocomplete`\n\n```ts\nconst { data } = await client.flowsAutocomplete({\n  input: \'example\',\n  attribute: \'example\',\n  size: 1,\n  from: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": ["value"],\n  "hits": 42\n}\n```\n\n</details>\n\n---\n\n### `executeFlowsQuery`\n\nExecutes a query against the Flows dataset and returns paginated results for use in Kanban card rendering.\n\n`POST /v1/kanban/query/flows:execute`\n\n```ts\nconst { data } = await client.executeFlowsQuery(\n  null,\n  {\n    filters: {\n      items: [\n        {\n          key: \'assignee\',\n          operator: \'EQUALS\',\n          value: \'100020\',\n          data_type: \'string\'\n        }\n      ],\n      combination: \'OR\'\n    },\n    sorting: {\n      field: \'created_at\',\n      direction: \'asc\'\n    },\n    from: 0,\n    size: 10\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {}\n  ],\n  "hits": 42,\n  "page_number": 1,\n  "page_size": 10,\n  "total_pages": 5\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Error`\n\nStandard error response\n\n```ts\ntype Error = {\n  message?: string\n  status?: number\n}\n```\n\n### `BoardSummary`\n\nSummary representation of a Kanban board, returned in list responses. Does not include swimlane and filter configuration details.\n\n```ts\ntype BoardSummary = {\n  id?: string\n  title?: string\n  description?: string\n  created_at?: string // date-time\n  updated_at?: string // date-time\n  created_by?: string\n  org_id?: string\n  updated_by?: string\n  shared_with?: string[]\n  shared_with_org?: boolean\n  owners?: string[]\n}\n```\n\n### `Board`\n\nFull representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options.\n\n```ts\ntype Board = {\n  id?: string\n  title: string\n  description?: string\n  created_at?: string // date-time\n  updated_at?: string // date-time\n  created_by?: string\n  org_id?: string\n  updated_by?: string\n  shared_with?: string[]\n  shared_with_org?: boolean\n  owners?: string[]\n  config: {\n    dataset?: string\n    swimlanes?: Array<{\n      id?: { ... }\n      title?: { ... }\n      position?: { ... }\n      filter?: { ... }\n      title_chip_variant?: { ... }\n    }>\n    card_config?: {\n      fields?: { ... }\n    }\n    board_filter?: {\n      items: { ... }\n      combination: { ... }\n    }\n    sorting?: {\n      field: { ... }\n      direction?: { ... }\n    }\n    search_query?: string\n  }\n}\n```\n\n### `Swimlane`\n\nA vertical column in a Kanban board that groups workflow tasks or entities matching its filter criteria. Each swimlane has an independent filter and a display position.\n\n```ts\ntype Swimlane = {\n  id?: string\n  title?: string\n  position?: number\n  filter?: {\n    items: Array<{\n      key: { ... }\n      operator: { ... }\n      value?: { ... }\n      data_type?: { ... }\n    } | {\n      items: { ... }\n      combination: { ... }\n    }>\n    combination: "AND" | "OR"\n  }\n  title_chip_variant?: string\n}\n```\n\n### `Sorting`\n\nDefines how query results should be sorted. Specify a field name and sort direction.\n\n```ts\ntype Sorting = {\n  field: string\n  direction?: "asc" | "desc"\n}\n```\n\n### `BoardFilter`\n\nA filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR).\n\n```ts\ntype BoardFilter = {\n  items: Array<{\n    key: string\n    operator: "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL"\n    value?: string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean | string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean[]\n    data_type?: "string" | "number" | "boolean" | "date"\n  } | {\n    items: Array<{\n      key: { ... }\n      operator: { ... }\n      value?: { ... }\n      data_type?: { ... }\n    }>\n    combination: "AND" | "OR"\n  }>\n  combination: "AND" | "OR"\n}\n```\n\n### `FilterGroup`\n\n```ts\ntype FilterGroup = {\n  items: Array<{\n    key: string\n    operator: "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL"\n    value?: string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean | string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean[]\n    data_type?: "string" | "number" | "boolean" | "date"\n  }>\n  combination: "AND" | "OR"\n}\n```\n\n### `FilterOperator`\n\nThe comparison operator for filtering\n\n```ts\ntype FilterOperator = "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL"\n```\n\n### `DynamicDateValue`\n\nDynamic date keywords that resolve to actual dates at runtime\n\n```ts\ntype DynamicDateValue = "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER"\n```\n\n### `ValueType`\n\nThe value to compare against - can be a single value (string, number, boolean, or dynamic date) or an array of values\n\n```ts\ntype ValueType = string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean | string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean[]\n```\n\n### `FlowsQueryRequest`\n\nRequest payload for executing a query against the Flows dataset. Supports filter conditions, sorting, and offset-based pagination.\n\n```ts\ntype FlowsQueryRequest = {\n  filters?: {\n    items: Array<{\n      key: { ... }\n      operator: { ... }\n      value?: { ... }\n      data_type?: { ... }\n    } | {\n      items: { ... }\n      combination: { ... }\n    }>\n    combination: "AND" | "OR"\n  }\n  sorting?: {\n    field: string\n    direction?: "asc" | "desc"\n  }\n  from?: number\n  size?: number\n}\n```\n\n### `FlowsQueryResult`\n\nPaginated result set returned from a Flows query. Each item in `results` is a workflow task record with dynamic fields depending on the dataset configuration.\n\n```ts\ntype FlowsQueryResult = {\n  results?: Record<string, unknown>[]\n  hits?: number\n  page_number?: number\n  page_size?: number\n  total_pages?: number\n}\n```\n\n### `FilterItem`\n\n```ts\ntype FilterItem = {\n  key: string\n  operator: "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL"\n  value?: string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean | string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean[]\n  data_type?: "string" | "number" | "boolean" | "date"\n}\n```\n';
+export {
+  kanban_default as default
+};

package/dist/message-3XZLJR6R.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/message.json
+var message_default = '# Message API\n\n- **Base URL:** `https://message.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/message](https://docs.epilot.io/api/message)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.message.sendMessage(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/message\'\n\nconst messageClient = getClient()\nauthorize(messageClient, () => \'<token>\')\nconst { data } = await messageClient.sendMessage(...)\n```\n\n## Operations\n\n**Messages**\n- [`sendMessage`](#sendmessage)\n- [`updateMessage`](#updatemessage)\n- [`getMessage`](#getmessage)\n- [`deleteMessage`](#deletemessage)\n- [`getMessageEml`](#getmessageeml)\n- [`searchMessages`](#searchmessages)\n- [`trashMessage`](#trashmessage)\n- [`untrashMessage`](#untrashmessage)\n- [`markReadMessage`](#markreadmessage)\n- [`markReadMessageV2`](#markreadmessagev2)\n- [`markUnreadMessage`](#markunreadmessage)\n- [`getUnread`](#getunread)\n- [`markUnreadMessageV2`](#markunreadmessagev2)\n- [`getMessageV2`](#getmessagev2)\n\n**Threads**\n- [`searchThreads`](#searchthreads)\n- [`searchThreadsV2`](#searchthreadsv2)\n- [`searchIds`](#searchids)\n- [`updateThread`](#updatethread)\n- [`deleteThread`](#deletethread)\n- [`moveThread`](#movethread)\n- [`markThreadAsDone`](#markthreadasdone)\n- [`markThreadAsOpen`](#markthreadasopen)\n- [`getThreadTimeline`](#getthreadtimeline)\n- [`trashThread`](#trashthread)\n- [`untrashThread`](#untrashthread)\n- [`threadBulkActionsRead`](#threadbulkactionsread)\n- [`threadBulkActionsUnread`](#threadbulkactionsunread)\n- [`threadBulkActionsFavorite`](#threadbulkactionsfavorite)\n- [`threadBulkActionsUnfavorite`](#threadbulkactionsunfavorite)\n- [`threadBulkActionsTrash`](#threadbulkactionstrash)\n- [`threadBulkActionsUntrash`](#threadbulkactionsuntrash)\n- [`threadBulkActionsDelete`](#threadbulkactionsdelete)\n- [`threadBulkActionsDone`](#threadbulkactionsdone)\n- [`threadBulkActionsOpen`](#threadbulkactionsopen)\n- [`markReadThread`](#markreadthread)\n- [`markReadThreadV2`](#markreadthreadv2)\n- [`markUnreadThread`](#markunreadthread)\n- [`markUnreadThreadV2`](#markunreadthreadv2)\n- [`assignThread`](#assignthread)\n- [`unassignThread`](#unassignthread)\n- [`assignUsers`](#assignusers)\n- [`assignUsersV2`](#assignusersv2)\n- [`pinThread`](#pinthread)\n- [`unpinThread`](#unpinthread)\n\n**Drafts**\n- [`createDraft`](#createdraft)\n- [`sendDraft`](#senddraft)\n\n**Schemas**\n- [`ErrorResponse`](#errorresponse)\n- [`MoveThreadPayload`](#movethreadpayload)\n- [`BaseEntity`](#baseentity)\n- [`Thread`](#thread)\n- [`Message`](#message)\n- [`MessageV2`](#messagev2)\n- [`Address`](#address)\n- [`AttachmentsRelation`](#attachmentsrelation)\n- [`File`](#file)\n- [`MessageRequestParams`](#messagerequestparams)\n- [`SearchParamsV2`](#searchparamsv2)\n- [`SearchParams`](#searchparams)\n- [`SearchIDParams`](#searchidparams)\n- [`ReadMessagePayload`](#readmessagepayload)\n- [`ReadingScope`](#readingscope)\n- [`ThreadTimeline`](#threadtimeline)\n- [`ThreadDoneEvent`](#threaddoneevent)\n- [`ThreadOpenEvent`](#threadopenevent)\n- [`TimelineEventData`](#timelineeventdata)\n- [`TimelineEvent`](#timelineevent)\n- [`BulkActionsPayloadWithScopes`](#bulkactionspayloadwithscopes)\n- [`BulkActionsPayload`](#bulkactionspayload)\n- [`FieldsParam`](#fieldsparam)\n\n### `sendMessage`\n\nSend an email message\n\n`POST /v1/message/messages`\n\n```ts\nconst { data } = await client.sendMessage(\n  {\n    do_not_create_entities: true,\n  },\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `updateMessage`\n\nUpdate message metadata\n\n`PUT /v1/message/messages`\n\n```ts\nconst { data } = await client.updateMessage()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `getMessage`\n\nGet an email message by id\n\n`GET /v1/message/messages/{id}`\n\n```ts\nconst { data } = await client.getMessage({\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  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `deleteMessage`\n\nImmediately and permanently delete a message. This operation cannot be undone.\n\n`DELETE /v1/message/messages/{id}`\n\n```ts\nconst { data } = await client.deleteMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getMessageEml`\n\nDownload a message as an EML file.\nReturns a 302 redirect to a pre-signed S3 URL where the EML file can be downloaded.\n\n`GET /v1/message/messages/{id}/eml`\n\n```ts\nconst { data } = await client.getMessageEml({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `searchMessages`\n\nSearch Messages\n\n`POST /v1/message/messages:search`\n\n```ts\nconst { data } = await client.searchMessages(\n  null,\n  {\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\',\n    fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\'],\n    from: 0,\n    size: 10,\n    hydrate: false,\n    include_scores: false,\n    sort: \'string\',\n    highlight: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["pricing", "INBOX"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n      "sender": "206801",\n      "subject": "Request for solar panel price",\n      "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n      "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n      "from": {\n        "name": "epilot",\n        "address": "messaging@epilot.cloud",\n        "email_type": "INTERNAL",\n        "send_status": "SEND",\n        "send_error": {}\n      },\n      "reply_to": {\n        "name": "epilot",\n        "address": "messaging@epilot.cloud",\n        "email_type": "INTERNAL",\n        "send_status": "SEND",\n        "send_error": {}\n      },\n      "to": [\n        {\n          "name": "epilot",\n          "address": "messaging@epilot.cloud",\n          "email_type": "INTERNAL",\n          "send_status": "SEND",\n          "send_error": {}\n        }\n      ],\n      "cc": [\n        {\n          "name": "epilot",\n          "address": "messaging@epilot.cloud",\n          "email_type": "INTERNAL",\n          "send_status": "SEND",\n          "send_error": {}\n        }\n      ],\n      "bcc": [\n        {\n          "name": "epilot",\n          "address": "messaging@epilot.cloud",\n          "email_type": "INTERNAL",\n          "send_status": "SEND",\n          "send_error": {}\n        }\n      ],\n      "file": {\n        "$relation": [\n          {\n            "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n            "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n            "is_message_attachment": true,\n            "may_be_signature_attachment": true,\n            "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n            "inline": false,\n            "send_as_link": false\n          }\n        ]\n      },\n      "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n      "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n      "user_read_message": ["206801", "200109"],\n      "org_read_message": ["789372", "210291"],\n      "send_status": ["SEND"],\n      "type": "SENT",\n      "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `trashMessage`\n\nMove a message to the trash\n\n`POST /v1/message/messages/{id}/trash`\n\n```ts\nconst { data } = await client.trashMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `untrashMessage`\n\nRestore a trashed message\n\n`POST /v1/message/messages/{id}/untrash`\n\n```ts\nconst { data } = await client.untrashMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markReadMessage`\n\nMark message as read\n\n`POST /v1/message/messages/{id}/read`\n\n```ts\nconst { data } = await client.markReadMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markReadMessageV2`\n\nMark message as read within a scope\n\n`POST /v2/message/messages/{id}/read`\n\n```ts\nconst { data } = await client.markReadMessageV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `markUnreadMessage`\n\nMark message as unread\n\n`POST /v1/message/messages/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getUnread`\n\nGet all unread messages by actor\n\n`GET /v1/message/messages/unread/{actor}`\n\n```ts\nconst { data } = await client.getUnread({\n  actor: \'example\',\n  email_filter: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "count": 14,\n  "unread": 0,\n  "drafts": 12,\n  "unassigned": 1\n}\n```\n\n</details>\n\n---\n\n### `markUnreadMessageV2`\n\nMark message as unread within a scope\n\n`POST /v2/message/messages/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadMessageV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `searchThreads`\n\nSearch for threads of email messages.\n\n`POST /v1/message/threads:search`\n\n```ts\nconst { data } = await client.searchThreads(\n  null,\n  {\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\',\n    from: 0,\n    size: 10,\n    hydrate: false\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["pricing", "INBOX"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "topic": "CUSTOMER_MESSAGE",\n      "assigned_to": ["206801", "200109"],\n      "org_read_message": ["789372", "210291"],\n      "done": false,\n      "latest_message": {},\n      "latest_trash_message": {},\n      "latest_message_at": "2024-02-10T09:14:31.990Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `searchThreadsV2`\n\nSearch for threads of email messages.\n\n`POST /v2/message/threads:search`\n\n```ts\nconst { data } = await client.searchThreadsV2(\n  null,\n  {\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\',\n    fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\'],\n    from: 0,\n    size: 10,\n    hydrate: false,\n    include_scores: false,\n    sort: \'string\',\n    highlight: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["pricing", "INBOX"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "topic": "CUSTOMER_MESSAGE",\n      "assigned_to": ["206801", "200109"],\n      "org_read_message": ["789372", "210291"],\n      "done": false,\n      "latest_message": {},\n      "latest_trash_message": {},\n      "latest_message_at": "2024-02-10T09:14:31.990Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `searchIds`\n\nSearch threads and return all id\'s\n\n`POST /v1/message/threads:searchIds`\n\n```ts\nconst { data } = await client.searchIds(\n  null,\n  {\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `updateThread`\n\nModify thread metadata\n\n`PUT /v1/message/threads`\n\n```ts\nconst { data } = await client.updateThread()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "topic": "CUSTOMER_MESSAGE",\n  "assigned_to": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "done": false,\n  "latest_message": {\n    "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n    "sender": "206801",\n    "subject": "Request for solar panel price",\n    "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n    "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n    "from": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "reply_to": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "to": [\n      {}\n    ],\n    "cc": [\n      {}\n    ],\n    "bcc": [\n      {}\n    ],\n    "file": {\n      "$relation": []\n    },\n    "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "user_read_message": ["206801", "200109"],\n    "org_read_message": ["789372", "210291"],\n    "send_status": ["SEND"],\n    "type": "SENT",\n    "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n  },\n  "latest_trash_message": {\n    "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n    "sender": "206801",\n    "subject": "Request for solar panel price",\n    "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n    "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n    "from": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "reply_to": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "to": [\n      {}\n    ],\n    "cc": [\n      {}\n    ],\n    "bcc": [\n      {}\n    ],\n    "file": {\n      "$relation": []\n    },\n    "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "user_read_message": ["206801", "200109"],\n    "org_read_message": ["789372", "210291"],\n    "send_status": ["SEND"],\n    "type": "SENT",\n    "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n  },\n  "latest_message_at": "2024-02-10T09:14:31.990Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteThread`\n\nImmediately and permanently delete a thread. This operation cannot be undone.\n\n`DELETE /v1/message/threads/{id}`\n\n```ts\nconst { data } = await client.deleteThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `moveThread`\n\nMove thread to a different Inbox\n\n`POST /v1/message/threads/{id}:move`\n\n```ts\nconst { data } = await client.moveThread(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\'\n  },\n)\n```\n\n---\n\n### `markThreadAsDone`\n\nMark thread as done\n\n`POST /v1/message/threads/{id}:markAsDone`\n\n```ts\nconst { data } = await client.markThreadAsDone({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markThreadAsOpen`\n\nMark thread as open\n\n`POST /v1/message/threads/{id}:markAsOpen`\n\n```ts\nconst { data } = await client.markThreadAsOpen({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getThreadTimeline`\n\nGet thread timeline\n\n`GET /v1/message/threads/{id}/timeline`\n\n```ts\nconst { data } = await client.getThreadTimeline({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "events": [\n    {\n      "data": {\n        "type": "THREAD_DONE",\n        "user_id": "123",\n        "organization_id": "456"\n      },\n      "timestamp": "2024-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `trashThread`\n\nMove a thread to trash\n\n`POST /v1/message/threads/{id}/trash`\n\n```ts\nconst { data } = await client.trashThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `untrashThread`\n\nRestore a trashed thread\n\n`POST /v1/message/threads/{id}/untrash`\n\n```ts\nconst { data } = await client.untrashThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `threadBulkActionsRead`\n\nPerform a bulk action of marking an array of thread ids as read\n\n`POST /v1/message/threads/bulk:read`\n\n```ts\nconst { data } = await client.threadBulkActionsRead(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\'],\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsUnread`\n\nPerform a bulk action of marking an array of thread ids as unread\n\n`POST /v1/message/threads/bulk:unread`\n\n```ts\nconst { data } = await client.threadBulkActionsUnread(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\'],\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsFavorite`\n\nPerform a bulk action of marking an array of thread ids favorite\n\n`POST /v1/message/threads/bulk:favorite`\n\n```ts\nconst { data } = await client.threadBulkActionsFavorite(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsUnfavorite`\n\nPerform a bulk action of marking an array of thread ids unfavorited\n\n`POST /v1/message/threads/bulk:unfavorite`\n\n```ts\nconst { data } = await client.threadBulkActionsUnfavorite(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsTrash`\n\nPerform a bulk action of trashing an array of threads\n\n`POST /v1/message/threads/bulk:trash`\n\n```ts\nconst { data } = await client.threadBulkActionsTrash(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsUntrash`\n\nPerform a bulk action of untrashing an array of threads\n\n`POST /v1/message/threads/bulk:untrash`\n\n```ts\nconst { data } = await client.threadBulkActionsUntrash(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsDelete`\n\nPerforms a bulk permanent delete for all threads\n\n`POST /v1/message/threads/bulk:delete`\n\n```ts\nconst { data } = await client.threadBulkActionsDelete(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsDone`\n\nPerform a bulk action of marking an array of threads as done\n\n`POST /v1/message/threads/bulk:done`\n\n```ts\nconst { data } = await client.threadBulkActionsDone(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsOpen`\n\nPerform a bulk action of marking an array of threads as open\n\n`POST /v1/message/threads/bulk:open`\n\n```ts\nconst { data } = await client.threadBulkActionsOpen(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `markReadThread`\n\nMark thread as read\n\n`POST /v1/message/threads/{id}/read`\n\n```ts\nconst { data } = await client.markReadThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markReadThreadV2`\n\nMark thread as read within a scope\n\n`POST /v2/message/threads/{id}/read`\n\n```ts\nconst { data } = await client.markReadThreadV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `markUnreadThread`\n\nMark thread as unread\n\n`POST /v1/message/threads/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markUnreadThreadV2`\n\nMark thread as unread within a scope\n\n`POST /v2/message/threads/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadThreadV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `assignThread`\n\nAssign thread to entities\n\n`POST /v1/message/threads/{id}/assign`\n\n```ts\nconst { data } = await client.assignThread(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  [\n    {\n      slug: \'contact\',\n      entity_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n      org_id: \'206801\',\n      is_main_entity: true\n    }\n  ],\n)\n```\n\n---\n\n### `unassignThread`\n\nUnassign thread from entities\n\n`POST /v1/message/threads/{id}/unassign`\n\n```ts\nconst { data } = await client.unassignThread(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  [\n    {\n      slug: \'contact\',\n      entity_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\'\n    }\n  ],\n)\n```\n\n---\n\n### `assignUsers`\n\nAssign users to thread for receiving notifications.\nThe operation replaces all existing assigned users in thread.\n\n`POST /v1/message/threads/{id}/assign:users`\n\n```ts\nconst { data } = await client.assignUsers(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    assigned_to: [\'206801\']\n  },\n)\n```\n\n---\n\n### `assignUsersV2`\n\nAssign users to thread.\n\n`POST /v2/message/threads/{id}/assign:users`\n\n```ts\nconst { data } = await client.assignUsersV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    add: [\'206801\'],\n    remove: [\'206801\']\n  },\n)\n```\n\n---\n\n### `pinThread`\n\nPin a single thread\n\n`POST /v1/message/threads/{id}:pin`\n\n```ts\nconst { data } = await client.pinThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `unpinThread`\n\nUnpin a single thread\n\n`DELETE /v1/message/threads/{id}:pin`\n\n```ts\nconst { data } = await client.unpinThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `createDraft`\n\nCreate a new draft\n\n`POST /v1/message/drafts`\n\n```ts\nconst { data } = await client.createDraft(\n  null,\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `sendDraft`\n\nSend the existing draft to the recipients\n\n`POST /v1/message/drafts:send`\n\n```ts\nconst { data } = await client.sendDraft()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `getMessageV2`\n\n- Fetches message by ID\n- If the message html is omitted on the entity, then it keeps the content on the message as a signed url\n  {\n    ...\n    _id: "4d74976d-fb64-47fd-85e2-65eea140f5eb",\n    _schem\n\n`GET /v2/message/messages/{id}`\n\n```ts\nconst { data } = await client.getMessageV2({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "html_omitted": false,\n  "html_download_url": "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html",\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ErrorResponse`\n\n```ts\ntype ErrorResponse = {\n  error?: string\n}\n```\n\n### `MoveThreadPayload`\n\n```ts\ntype MoveThreadPayload = {\n  inbox_id: string\n}\n```\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n}\n```\n\n### `Thread`\n\nThread properties depend on API caller as it\'s not pre-defined. We do recommend having at least `topic` property for categorizing.\n\n```ts\ntype Thread = {\n  topic: string\n  assigned_to?: string[]\n  org_read_message?: string[]\n  done?: boolean\n  latest_message?: {\n    message_id?: string\n    sender?: string\n    subject: string\n    html?: string\n    text?: string\n    from: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    reply_to?: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    to?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    cc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    bcc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    file?: {\n      $relation?: { ... }\n    }\n    references?: string\n    in_reply_to?: string\n    user_read_message?: string[]\n    org_read_message?: string[]\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"[]\n    type?: "SENT" | "RECEIVED"\n    template_id?: string\n  }\n  latest_trash_message?: {\n    message_id?: string\n    sender?: string\n    subject: string\n    html?: string\n    text?: string\n    from: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    reply_to?: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    to?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    cc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    bcc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    file?: {\n      $relation?: { ... }\n  // ...\n}\n```\n\n### `Message`\n\n```ts\ntype Message = {\n  message_id?: string\n  sender?: string\n  subject: string\n  html?: string\n  text?: string\n  from: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  reply_to?: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  to?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  cc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  bcc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  file?: {\n    $relation?: Array<{\n      entity_id: { ... }\n      filename?: { ... }\n      is_message_attachment?: { ... }\n      may_be_signature_attachment?: { ... }\n      cid?: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n    }>\n  }\n  references?: string\n  in_reply_to?: string\n  user_read_message?: string[]\n  org_read_message?: string[]\n  send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"[]\n  type?: "SENT" | "RECEIVED"\n  template_id?: string\n}\n```\n\n### `MessageV2`\n\n```ts\ntype MessageV2 = {\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  message_id?: string\n  sender?: string\n  subject: string\n  html?: string\n  text?: string\n  from: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  reply_to?: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  to?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  cc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  bcc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  file?: {\n    $relation?: Array<{\n      entity_id: { ... }\n      filename?: { ... }\n      is_message_attachment?: { ... }\n      may_be_signature_attachment?: { ... }\n      cid?: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n    }>\n  }\n  references?: string\n  in_reply_to?: string\n  user_read_message?: string[]\n  org_read_message?: string[]\n  send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"[]\n  type?: "SENT" | "RECEIVED"\n  template_id?: string\n}\n```\n\n### `Address`\n\n```ts\ntype Address = {\n  name?: string\n  address: string\n  email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n  send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n  send_error?: object\n}\n```\n\n### `AttachmentsRelation`\n\nMessage attachments\n\n```ts\ntype AttachmentsRelation = {\n  $relation?: Array<{\n    entity_id: string\n    filename?: string\n    is_message_attachment?: boolean\n    may_be_signature_attachment?: boolean\n    cid?: string\n    inline?: boolean\n    send_as_link?: boolean\n  }>\n}\n```\n\n### `File`\n\n```ts\ntype File = {\n  entity_id: string\n  filename?: string\n  is_message_attachment?: boolean\n  may_be_signature_attachment?: boolean\n  cid?: string\n  inline?: boolean\n  send_as_link?: boolean\n}\n```\n\n### `MessageRequestParams`\n\n```ts\ntype MessageRequestParams = {\n  complete_thread?: boolean\n  thread?: {\n    topic: string\n    assigned_to?: string[]\n  }\n  parent_id?: string\n  subject: string\n  html?: string\n  text?: string\n  from: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  reply_to?: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  to?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  cc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  bcc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  file?: {\n    $relation?: Array<{\n      entity_id: { ... }\n      filename?: { ... }\n      is_message_attachment?: { ... }\n      may_be_signature_attachment?: { ... }\n      cid?: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n    }>\n  }\n  template_id?: string\n}\n```\n\n### `SearchParamsV2`\n\n```ts\ntype SearchParamsV2 = {\n  inbox_id?: string | string[]\n  q: string\n  fields?: string[]\n  from?: number\n  size?: number\n  hydrate?: boolean\n  include_scores?: boolean\n  sort?: string\n  highlight?: unknown\n}\n```\n\n### `SearchParams`\n\n```ts\ntype SearchParams = {\n  q: string\n  from?: number\n  size?: number\n  hydrate?: boolean\n}\n```\n\n### `SearchIDParams`\n\n```ts\ntype SearchIDParams = {\n  q?: string\n}\n```\n\n### `ReadMessagePayload`\n\n```ts\ntype ReadMessagePayload = {\n  scopes: "organization" | "user"[]\n}\n```\n\n### `ReadingScope`\n\nWho is marking an item as read or unread.\n\n```ts\ntype ReadingScope = "organization" | "user"\n```\n\n### `ThreadTimeline`\n\n```ts\ntype ThreadTimeline = {\n  events: Array<{\n    data: {\n      type: { ... }\n      user_id: { ... }\n      organization_id: { ... }\n    } | {\n      type: { ... }\n      user_id: { ... }\n      organization_id: { ... }\n    }\n    timestamp: string\n  }>\n}\n```\n\n### `ThreadDoneEvent`\n\n```ts\ntype ThreadDoneEvent = {\n  type: "THREAD_DONE"\n  user_id: string\n  organization_id: string\n}\n```\n\n### `ThreadOpenEvent`\n\n```ts\ntype ThreadOpenEvent = {\n  type: "THREAD_OPEN"\n  user_id: string\n  organization_id: string\n}\n```\n\n### `TimelineEventData`\n\n```ts\ntype TimelineEventData = {\n  type: "THREAD_DONE"\n  user_id: string\n  organization_id: string\n} | {\n  type: "THREAD_OPEN"\n  user_id: string\n  organization_id: string\n}\n```\n\n### `TimelineEvent`\n\n```ts\ntype TimelineEvent = {\n  data: {\n    type: "THREAD_DONE"\n    user_id: string\n    organization_id: string\n  } | {\n    type: "THREAD_OPEN"\n    user_id: string\n    organization_id: string\n  }\n  timestamp: string\n}\n```\n\n### `BulkActionsPayloadWithScopes`\n\n```ts\ntype BulkActionsPayloadWithScopes = {\n  ids: string[]\n  scopes?: "organization" | "user"[]\n}\n```\n\n### `BulkActionsPayload`\n\n```ts\ntype BulkActionsPayload = {\n  ids: string[]\n}\n```\n\n### `FieldsParam`\n\nList of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n\nGlobbing and globstart (**) is supported for nested fields.\n\n\n```ts\ntype FieldsParam = string[]\n```\n';
+
+
+exports.default = message_default;

package/dist/message-ZNMCS5YH.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/message.json
+var message_default = '# Message API\n\n- **Base URL:** `https://message.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/message](https://docs.epilot.io/api/message)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.message.sendMessage(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/message\'\n\nconst messageClient = getClient()\nauthorize(messageClient, () => \'<token>\')\nconst { data } = await messageClient.sendMessage(...)\n```\n\n## Operations\n\n**Messages**\n- [`sendMessage`](#sendmessage)\n- [`updateMessage`](#updatemessage)\n- [`getMessage`](#getmessage)\n- [`deleteMessage`](#deletemessage)\n- [`getMessageEml`](#getmessageeml)\n- [`searchMessages`](#searchmessages)\n- [`trashMessage`](#trashmessage)\n- [`untrashMessage`](#untrashmessage)\n- [`markReadMessage`](#markreadmessage)\n- [`markReadMessageV2`](#markreadmessagev2)\n- [`markUnreadMessage`](#markunreadmessage)\n- [`getUnread`](#getunread)\n- [`markUnreadMessageV2`](#markunreadmessagev2)\n- [`getMessageV2`](#getmessagev2)\n\n**Threads**\n- [`searchThreads`](#searchthreads)\n- [`searchThreadsV2`](#searchthreadsv2)\n- [`searchIds`](#searchids)\n- [`updateThread`](#updatethread)\n- [`deleteThread`](#deletethread)\n- [`moveThread`](#movethread)\n- [`markThreadAsDone`](#markthreadasdone)\n- [`markThreadAsOpen`](#markthreadasopen)\n- [`getThreadTimeline`](#getthreadtimeline)\n- [`trashThread`](#trashthread)\n- [`untrashThread`](#untrashthread)\n- [`threadBulkActionsRead`](#threadbulkactionsread)\n- [`threadBulkActionsUnread`](#threadbulkactionsunread)\n- [`threadBulkActionsFavorite`](#threadbulkactionsfavorite)\n- [`threadBulkActionsUnfavorite`](#threadbulkactionsunfavorite)\n- [`threadBulkActionsTrash`](#threadbulkactionstrash)\n- [`threadBulkActionsUntrash`](#threadbulkactionsuntrash)\n- [`threadBulkActionsDelete`](#threadbulkactionsdelete)\n- [`threadBulkActionsDone`](#threadbulkactionsdone)\n- [`threadBulkActionsOpen`](#threadbulkactionsopen)\n- [`markReadThread`](#markreadthread)\n- [`markReadThreadV2`](#markreadthreadv2)\n- [`markUnreadThread`](#markunreadthread)\n- [`markUnreadThreadV2`](#markunreadthreadv2)\n- [`assignThread`](#assignthread)\n- [`unassignThread`](#unassignthread)\n- [`assignUsers`](#assignusers)\n- [`assignUsersV2`](#assignusersv2)\n- [`pinThread`](#pinthread)\n- [`unpinThread`](#unpinthread)\n\n**Drafts**\n- [`createDraft`](#createdraft)\n- [`sendDraft`](#senddraft)\n\n**Schemas**\n- [`ErrorResponse`](#errorresponse)\n- [`MoveThreadPayload`](#movethreadpayload)\n- [`BaseEntity`](#baseentity)\n- [`Thread`](#thread)\n- [`Message`](#message)\n- [`MessageV2`](#messagev2)\n- [`Address`](#address)\n- [`AttachmentsRelation`](#attachmentsrelation)\n- [`File`](#file)\n- [`MessageRequestParams`](#messagerequestparams)\n- [`SearchParamsV2`](#searchparamsv2)\n- [`SearchParams`](#searchparams)\n- [`SearchIDParams`](#searchidparams)\n- [`ReadMessagePayload`](#readmessagepayload)\n- [`ReadingScope`](#readingscope)\n- [`ThreadTimeline`](#threadtimeline)\n- [`ThreadDoneEvent`](#threaddoneevent)\n- [`ThreadOpenEvent`](#threadopenevent)\n- [`TimelineEventData`](#timelineeventdata)\n- [`TimelineEvent`](#timelineevent)\n- [`BulkActionsPayloadWithScopes`](#bulkactionspayloadwithscopes)\n- [`BulkActionsPayload`](#bulkactionspayload)\n- [`FieldsParam`](#fieldsparam)\n\n### `sendMessage`\n\nSend an email message\n\n`POST /v1/message/messages`\n\n```ts\nconst { data } = await client.sendMessage(\n  {\n    do_not_create_entities: true,\n  },\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `updateMessage`\n\nUpdate message metadata\n\n`PUT /v1/message/messages`\n\n```ts\nconst { data } = await client.updateMessage()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `getMessage`\n\nGet an email message by id\n\n`GET /v1/message/messages/{id}`\n\n```ts\nconst { data } = await client.getMessage({\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  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `deleteMessage`\n\nImmediately and permanently delete a message. This operation cannot be undone.\n\n`DELETE /v1/message/messages/{id}`\n\n```ts\nconst { data } = await client.deleteMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getMessageEml`\n\nDownload a message as an EML file.\nReturns a 302 redirect to a pre-signed S3 URL where the EML file can be downloaded.\n\n`GET /v1/message/messages/{id}/eml`\n\n```ts\nconst { data } = await client.getMessageEml({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `searchMessages`\n\nSearch Messages\n\n`POST /v1/message/messages:search`\n\n```ts\nconst { data } = await client.searchMessages(\n  null,\n  {\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\',\n    fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\'],\n    from: 0,\n    size: 10,\n    hydrate: false,\n    include_scores: false,\n    sort: \'string\',\n    highlight: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["pricing", "INBOX"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n      "sender": "206801",\n      "subject": "Request for solar panel price",\n      "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n      "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n      "from": {\n        "name": "epilot",\n        "address": "messaging@epilot.cloud",\n        "email_type": "INTERNAL",\n        "send_status": "SEND",\n        "send_error": {}\n      },\n      "reply_to": {\n        "name": "epilot",\n        "address": "messaging@epilot.cloud",\n        "email_type": "INTERNAL",\n        "send_status": "SEND",\n        "send_error": {}\n      },\n      "to": [\n        {\n          "name": "epilot",\n          "address": "messaging@epilot.cloud",\n          "email_type": "INTERNAL",\n          "send_status": "SEND",\n          "send_error": {}\n        }\n      ],\n      "cc": [\n        {\n          "name": "epilot",\n          "address": "messaging@epilot.cloud",\n          "email_type": "INTERNAL",\n          "send_status": "SEND",\n          "send_error": {}\n        }\n      ],\n      "bcc": [\n        {\n          "name": "epilot",\n          "address": "messaging@epilot.cloud",\n          "email_type": "INTERNAL",\n          "send_status": "SEND",\n          "send_error": {}\n        }\n      ],\n      "file": {\n        "$relation": [\n          {\n            "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n            "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n            "is_message_attachment": true,\n            "may_be_signature_attachment": true,\n            "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n            "inline": false,\n            "send_as_link": false\n          }\n        ]\n      },\n      "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n      "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n      "user_read_message": ["206801", "200109"],\n      "org_read_message": ["789372", "210291"],\n      "send_status": ["SEND"],\n      "type": "SENT",\n      "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `trashMessage`\n\nMove a message to the trash\n\n`POST /v1/message/messages/{id}/trash`\n\n```ts\nconst { data } = await client.trashMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `untrashMessage`\n\nRestore a trashed message\n\n`POST /v1/message/messages/{id}/untrash`\n\n```ts\nconst { data } = await client.untrashMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markReadMessage`\n\nMark message as read\n\n`POST /v1/message/messages/{id}/read`\n\n```ts\nconst { data } = await client.markReadMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markReadMessageV2`\n\nMark message as read within a scope\n\n`POST /v2/message/messages/{id}/read`\n\n```ts\nconst { data } = await client.markReadMessageV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `markUnreadMessage`\n\nMark message as unread\n\n`POST /v1/message/messages/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadMessage({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getUnread`\n\nGet all unread messages by actor\n\n`GET /v1/message/messages/unread/{actor}`\n\n```ts\nconst { data } = await client.getUnread({\n  actor: \'example\',\n  email_filter: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "count": 14,\n  "unread": 0,\n  "drafts": 12,\n  "unassigned": 1\n}\n```\n\n</details>\n\n---\n\n### `markUnreadMessageV2`\n\nMark message as unread within a scope\n\n`POST /v2/message/messages/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadMessageV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `searchThreads`\n\nSearch for threads of email messages.\n\n`POST /v1/message/threads:search`\n\n```ts\nconst { data } = await client.searchThreads(\n  null,\n  {\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\',\n    from: 0,\n    size: 10,\n    hydrate: false\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["pricing", "INBOX"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "topic": "CUSTOMER_MESSAGE",\n      "assigned_to": ["206801", "200109"],\n      "org_read_message": ["789372", "210291"],\n      "done": false,\n      "latest_message": {},\n      "latest_trash_message": {},\n      "latest_message_at": "2024-02-10T09:14:31.990Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `searchThreadsV2`\n\nSearch for threads of email messages.\n\n`POST /v2/message/threads:search`\n\n```ts\nconst { data } = await client.searchThreadsV2(\n  null,\n  {\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\',\n    fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\'],\n    from: 0,\n    size: 10,\n    hydrate: false,\n    include_scores: false,\n    sort: \'string\',\n    highlight: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["pricing", "INBOX"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "topic": "CUSTOMER_MESSAGE",\n      "assigned_to": ["206801", "200109"],\n      "org_read_message": ["789372", "210291"],\n      "done": false,\n      "latest_message": {},\n      "latest_trash_message": {},\n      "latest_message_at": "2024-02-10T09:14:31.990Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `searchIds`\n\nSearch threads and return all id\'s\n\n`POST /v1/message/threads:searchIds`\n\n```ts\nconst { data } = await client.searchIds(\n  null,\n  {\n    q: \'subject:"Request for solar panel price" AND _tags:INBOX\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 14,\n  "results": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `updateThread`\n\nModify thread metadata\n\n`PUT /v1/message/threads`\n\n```ts\nconst { data } = await client.updateThread()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "topic": "CUSTOMER_MESSAGE",\n  "assigned_to": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "done": false,\n  "latest_message": {\n    "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n    "sender": "206801",\n    "subject": "Request for solar panel price",\n    "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n    "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n    "from": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "reply_to": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "to": [\n      {}\n    ],\n    "cc": [\n      {}\n    ],\n    "bcc": [\n      {}\n    ],\n    "file": {\n      "$relation": []\n    },\n    "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "user_read_message": ["206801", "200109"],\n    "org_read_message": ["789372", "210291"],\n    "send_status": ["SEND"],\n    "type": "SENT",\n    "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n  },\n  "latest_trash_message": {\n    "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n    "sender": "206801",\n    "subject": "Request for solar panel price",\n    "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n    "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n    "from": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "reply_to": {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    },\n    "to": [\n      {}\n    ],\n    "cc": [\n      {}\n    ],\n    "bcc": [\n      {}\n    ],\n    "file": {\n      "$relation": []\n    },\n    "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n    "user_read_message": ["206801", "200109"],\n    "org_read_message": ["789372", "210291"],\n    "send_status": ["SEND"],\n    "type": "SENT",\n    "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n  },\n  "latest_message_at": "2024-02-10T09:14:31.990Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteThread`\n\nImmediately and permanently delete a thread. This operation cannot be undone.\n\n`DELETE /v1/message/threads/{id}`\n\n```ts\nconst { data } = await client.deleteThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `moveThread`\n\nMove thread to a different Inbox\n\n`POST /v1/message/threads/{id}:move`\n\n```ts\nconst { data } = await client.moveThread(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    inbox_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\'\n  },\n)\n```\n\n---\n\n### `markThreadAsDone`\n\nMark thread as done\n\n`POST /v1/message/threads/{id}:markAsDone`\n\n```ts\nconst { data } = await client.markThreadAsDone({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markThreadAsOpen`\n\nMark thread as open\n\n`POST /v1/message/threads/{id}:markAsOpen`\n\n```ts\nconst { data } = await client.markThreadAsOpen({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getThreadTimeline`\n\nGet thread timeline\n\n`GET /v1/message/threads/{id}/timeline`\n\n```ts\nconst { data } = await client.getThreadTimeline({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "events": [\n    {\n      "data": {\n        "type": "THREAD_DONE",\n        "user_id": "123",\n        "organization_id": "456"\n      },\n      "timestamp": "2024-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `trashThread`\n\nMove a thread to trash\n\n`POST /v1/message/threads/{id}/trash`\n\n```ts\nconst { data } = await client.trashThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `untrashThread`\n\nRestore a trashed thread\n\n`POST /v1/message/threads/{id}/untrash`\n\n```ts\nconst { data } = await client.untrashThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `threadBulkActionsRead`\n\nPerform a bulk action of marking an array of thread ids as read\n\n`POST /v1/message/threads/bulk:read`\n\n```ts\nconst { data } = await client.threadBulkActionsRead(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\'],\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsUnread`\n\nPerform a bulk action of marking an array of thread ids as unread\n\n`POST /v1/message/threads/bulk:unread`\n\n```ts\nconst { data } = await client.threadBulkActionsUnread(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\'],\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsFavorite`\n\nPerform a bulk action of marking an array of thread ids favorite\n\n`POST /v1/message/threads/bulk:favorite`\n\n```ts\nconst { data } = await client.threadBulkActionsFavorite(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsUnfavorite`\n\nPerform a bulk action of marking an array of thread ids unfavorited\n\n`POST /v1/message/threads/bulk:unfavorite`\n\n```ts\nconst { data } = await client.threadBulkActionsUnfavorite(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsTrash`\n\nPerform a bulk action of trashing an array of threads\n\n`POST /v1/message/threads/bulk:trash`\n\n```ts\nconst { data } = await client.threadBulkActionsTrash(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsUntrash`\n\nPerform a bulk action of untrashing an array of threads\n\n`POST /v1/message/threads/bulk:untrash`\n\n```ts\nconst { data } = await client.threadBulkActionsUntrash(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsDelete`\n\nPerforms a bulk permanent delete for all threads\n\n`POST /v1/message/threads/bulk:delete`\n\n```ts\nconst { data } = await client.threadBulkActionsDelete(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsDone`\n\nPerform a bulk action of marking an array of threads as done\n\n`POST /v1/message/threads/bulk:done`\n\n```ts\nconst { data } = await client.threadBulkActionsDone(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `threadBulkActionsOpen`\n\nPerform a bulk action of marking an array of threads as open\n\n`POST /v1/message/threads/bulk:open`\n\n```ts\nconst { data } = await client.threadBulkActionsOpen(\n  null,\n  {\n    ids: [\'6b299eda-4018-4554-8965-c4b5598e6531\']\n  },\n)\n```\n\n---\n\n### `markReadThread`\n\nMark thread as read\n\n`POST /v1/message/threads/{id}/read`\n\n```ts\nconst { data } = await client.markReadThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markReadThreadV2`\n\nMark thread as read within a scope\n\n`POST /v2/message/threads/{id}/read`\n\n```ts\nconst { data } = await client.markReadThreadV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `markUnreadThread`\n\nMark thread as unread\n\n`POST /v1/message/threads/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `markUnreadThreadV2`\n\nMark thread as unread within a scope\n\n`POST /v2/message/threads/{id}/unread`\n\n```ts\nconst { data } = await client.markUnreadThreadV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    scopes: [\'organization\', \'user\']\n  },\n)\n```\n\n---\n\n### `assignThread`\n\nAssign thread to entities\n\n`POST /v1/message/threads/{id}/assign`\n\n```ts\nconst { data } = await client.assignThread(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  [\n    {\n      slug: \'contact\',\n      entity_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\',\n      org_id: \'206801\',\n      is_main_entity: true\n    }\n  ],\n)\n```\n\n---\n\n### `unassignThread`\n\nUnassign thread from entities\n\n`POST /v1/message/threads/{id}/unassign`\n\n```ts\nconst { data } = await client.unassignThread(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  [\n    {\n      slug: \'contact\',\n      entity_id: \'3f34ce73-089c-4d45-a5ee-c161234e41c3\'\n    }\n  ],\n)\n```\n\n---\n\n### `assignUsers`\n\nAssign users to thread for receiving notifications.\nThe operation replaces all existing assigned users in thread.\n\n`POST /v1/message/threads/{id}/assign:users`\n\n```ts\nconst { data } = await client.assignUsers(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    assigned_to: [\'206801\']\n  },\n)\n```\n\n---\n\n### `assignUsersV2`\n\nAssign users to thread.\n\n`POST /v2/message/threads/{id}/assign:users`\n\n```ts\nconst { data } = await client.assignUsersV2(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    add: [\'206801\'],\n    remove: [\'206801\']\n  },\n)\n```\n\n---\n\n### `pinThread`\n\nPin a single thread\n\n`POST /v1/message/threads/{id}:pin`\n\n```ts\nconst { data } = await client.pinThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `unpinThread`\n\nUnpin a single thread\n\n`DELETE /v1/message/threads/{id}:pin`\n\n```ts\nconst { data } = await client.unpinThread({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `createDraft`\n\nCreate a new draft\n\n`POST /v1/message/drafts`\n\n```ts\nconst { data } = await client.createDraft(\n  null,\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `sendDraft`\n\nSend the existing draft to the recipients\n\n`POST /v1/message/drafts:send`\n\n```ts\nconst { data } = await client.sendDraft()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n### `getMessageV2`\n\n- Fetches message by ID\n- If the message html is omitted on the entity, then it keeps the content on the message as a signed url\n  {\n    ...\n    _id: "4d74976d-fb64-47fd-85e2-65eea140f5eb",\n    _schem\n\n`GET /v2/message/messages/{id}`\n\n```ts\nconst { data } = await client.getMessageV2({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "html_omitted": false,\n  "html_download_url": "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html",\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["pricing", "INBOX"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "message_id": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>",\n  "sender": "206801",\n  "subject": "Request for solar panel price",\n  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",\n  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",\n  "from": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "reply_to": {\n    "name": "epilot",\n    "address": "messaging@epilot.cloud",\n    "email_type": "INTERNAL",\n    "send_status": "SEND",\n    "send_error": {}\n  },\n  "to": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "cc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "bcc": [\n    {\n      "name": "epilot",\n      "address": "messaging@epilot.cloud",\n      "email_type": "INTERNAL",\n      "send_status": "SEND",\n      "send_error": {}\n    }\n  ],\n  "file": {\n    "$relation": [\n      {\n        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "is_message_attachment": true,\n        "may_be_signature_attachment": true,\n        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",\n        "inline": false,\n        "send_as_link": false\n      }\n    ]\n  },\n  "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "in_reply_to": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",\n  "user_read_message": ["206801", "200109"],\n  "org_read_message": ["789372", "210291"],\n  "send_status": ["SEND"],\n  "type": "SENT",\n  "template_id": "3f34ce73-089c-4d45-a5ee-c161234e41c3"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ErrorResponse`\n\n```ts\ntype ErrorResponse = {\n  error?: string\n}\n```\n\n### `MoveThreadPayload`\n\n```ts\ntype MoveThreadPayload = {\n  inbox_id: string\n}\n```\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n}\n```\n\n### `Thread`\n\nThread properties depend on API caller as it\'s not pre-defined. We do recommend having at least `topic` property for categorizing.\n\n```ts\ntype Thread = {\n  topic: string\n  assigned_to?: string[]\n  org_read_message?: string[]\n  done?: boolean\n  latest_message?: {\n    message_id?: string\n    sender?: string\n    subject: string\n    html?: string\n    text?: string\n    from: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    reply_to?: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    to?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    cc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    bcc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    file?: {\n      $relation?: { ... }\n    }\n    references?: string\n    in_reply_to?: string\n    user_read_message?: string[]\n    org_read_message?: string[]\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"[]\n    type?: "SENT" | "RECEIVED"\n    template_id?: string\n  }\n  latest_trash_message?: {\n    message_id?: string\n    sender?: string\n    subject: string\n    html?: string\n    text?: string\n    from: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    reply_to?: {\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }\n    to?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    cc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    bcc?: Array<{\n      name?: { ... }\n      address: { ... }\n      email_type?: { ... }\n      send_status?: { ... }\n      send_error?: { ... }\n    }>\n    file?: {\n      $relation?: { ... }\n  // ...\n}\n```\n\n### `Message`\n\n```ts\ntype Message = {\n  message_id?: string\n  sender?: string\n  subject: string\n  html?: string\n  text?: string\n  from: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  reply_to?: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  to?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  cc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  bcc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  file?: {\n    $relation?: Array<{\n      entity_id: { ... }\n      filename?: { ... }\n      is_message_attachment?: { ... }\n      may_be_signature_attachment?: { ... }\n      cid?: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n    }>\n  }\n  references?: string\n  in_reply_to?: string\n  user_read_message?: string[]\n  org_read_message?: string[]\n  send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"[]\n  type?: "SENT" | "RECEIVED"\n  template_id?: string\n}\n```\n\n### `MessageV2`\n\n```ts\ntype MessageV2 = {\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  message_id?: string\n  sender?: string\n  subject: string\n  html?: string\n  text?: string\n  from: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  reply_to?: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  to?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  cc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  bcc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  file?: {\n    $relation?: Array<{\n      entity_id: { ... }\n      filename?: { ... }\n      is_message_attachment?: { ... }\n      may_be_signature_attachment?: { ... }\n      cid?: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n    }>\n  }\n  references?: string\n  in_reply_to?: string\n  user_read_message?: string[]\n  org_read_message?: string[]\n  send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"[]\n  type?: "SENT" | "RECEIVED"\n  template_id?: string\n}\n```\n\n### `Address`\n\n```ts\ntype Address = {\n  name?: string\n  address: string\n  email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n  send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n  send_error?: object\n}\n```\n\n### `AttachmentsRelation`\n\nMessage attachments\n\n```ts\ntype AttachmentsRelation = {\n  $relation?: Array<{\n    entity_id: string\n    filename?: string\n    is_message_attachment?: boolean\n    may_be_signature_attachment?: boolean\n    cid?: string\n    inline?: boolean\n    send_as_link?: boolean\n  }>\n}\n```\n\n### `File`\n\n```ts\ntype File = {\n  entity_id: string\n  filename?: string\n  is_message_attachment?: boolean\n  may_be_signature_attachment?: boolean\n  cid?: string\n  inline?: boolean\n  send_as_link?: boolean\n}\n```\n\n### `MessageRequestParams`\n\n```ts\ntype MessageRequestParams = {\n  complete_thread?: boolean\n  thread?: {\n    topic: string\n    assigned_to?: string[]\n  }\n  parent_id?: string\n  subject: string\n  html?: string\n  text?: string\n  from: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  reply_to?: {\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }\n  to?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  cc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  bcc?: Array<{\n    name?: string\n    address: string\n    email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"\n    send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"\n    send_error?: object\n  }>\n  file?: {\n    $relation?: Array<{\n      entity_id: { ... }\n      filename?: { ... }\n      is_message_attachment?: { ... }\n      may_be_signature_attachment?: { ... }\n      cid?: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n    }>\n  }\n  template_id?: string\n}\n```\n\n### `SearchParamsV2`\n\n```ts\ntype SearchParamsV2 = {\n  inbox_id?: string | string[]\n  q: string\n  fields?: string[]\n  from?: number\n  size?: number\n  hydrate?: boolean\n  include_scores?: boolean\n  sort?: string\n  highlight?: unknown\n}\n```\n\n### `SearchParams`\n\n```ts\ntype SearchParams = {\n  q: string\n  from?: number\n  size?: number\n  hydrate?: boolean\n}\n```\n\n### `SearchIDParams`\n\n```ts\ntype SearchIDParams = {\n  q?: string\n}\n```\n\n### `ReadMessagePayload`\n\n```ts\ntype ReadMessagePayload = {\n  scopes: "organization" | "user"[]\n}\n```\n\n### `ReadingScope`\n\nWho is marking an item as read or unread.\n\n```ts\ntype ReadingScope = "organization" | "user"\n```\n\n### `ThreadTimeline`\n\n```ts\ntype ThreadTimeline = {\n  events: Array<{\n    data: {\n      type: { ... }\n      user_id: { ... }\n      organization_id: { ... }\n    } | {\n      type: { ... }\n      user_id: { ... }\n      organization_id: { ... }\n    }\n    timestamp: string\n  }>\n}\n```\n\n### `ThreadDoneEvent`\n\n```ts\ntype ThreadDoneEvent = {\n  type: "THREAD_DONE"\n  user_id: string\n  organization_id: string\n}\n```\n\n### `ThreadOpenEvent`\n\n```ts\ntype ThreadOpenEvent = {\n  type: "THREAD_OPEN"\n  user_id: string\n  organization_id: string\n}\n```\n\n### `TimelineEventData`\n\n```ts\ntype TimelineEventData = {\n  type: "THREAD_DONE"\n  user_id: string\n  organization_id: string\n} | {\n  type: "THREAD_OPEN"\n  user_id: string\n  organization_id: string\n}\n```\n\n### `TimelineEvent`\n\n```ts\ntype TimelineEvent = {\n  data: {\n    type: "THREAD_DONE"\n    user_id: string\n    organization_id: string\n  } | {\n    type: "THREAD_OPEN"\n    user_id: string\n    organization_id: string\n  }\n  timestamp: string\n}\n```\n\n### `BulkActionsPayloadWithScopes`\n\n```ts\ntype BulkActionsPayloadWithScopes = {\n  ids: string[]\n  scopes?: "organization" | "user"[]\n}\n```\n\n### `BulkActionsPayload`\n\n```ts\ntype BulkActionsPayload = {\n  ids: string[]\n}\n```\n\n### `FieldsParam`\n\nList of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n\nGlobbing and globstart (**) is supported for nested fields.\n\n\n```ts\ntype FieldsParam = string[]\n```\n';
+export {
+  message_default as default
+};

package/dist/metering-DZNZPPY6.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/metering.json
+var metering_default = '# Metering API\n\n- **Base URL:** `https://metering.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/metering](https://docs.epilot.io/api/metering)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.metering.getCustomerMeters(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/metering\'\n\nconst meteringClient = getClient()\nauthorize(meteringClient, () => \'<token>\')\nconst { data } = await meteringClient.getCustomerMeters(...)\n```\n\n## Operations\n\n**ECP**\n- [`getCustomerMeters`](#getcustomermeters)\n- [`getMetersByContractId`](#getmetersbycontractid)\n- [`updateMeter`](#updatemeter)\n- [`getMeter`](#getmeter)\n- [`getMeterCounters`](#getmetercounters)\n- [`getCounterDetails`](#getcounterdetails)\n- [`createPortalMeterReadings`](#createportalmeterreadings)\n\n**ECP Admin**\n- [`createMeterReading`](#createmeterreading)\n- [`createMeterReadings`](#createmeterreadings)\n- [`batchWriteMeterReadings`](#batchwritemeterreadings)\n- [`createMeterReadingFromSubmission`](#createmeterreadingfromsubmission)\n- [`getAllowedReadingForMeter`](#getallowedreadingformeter)\n- [`createReadingWithMeter`](#createreadingwithmeter)\n- [`getReadingsByInterval`](#getreadingsbyinterval)\n- [`updateMeterReading`](#updatemeterreading)\n- [`deleteMeterReading`](#deletemeterreading)\n\n**Schemas**\n- [`ErrorResp`](#errorresp)\n- [`EntityId`](#entityid)\n- [`EntitySlug`](#entityslug)\n- [`BaseEntity`](#baseentity)\n- [`Entity`](#entity)\n- [`EntityItem`](#entityitem)\n- [`Id`](#id)\n- [`EntityRelation`](#entityrelation)\n- [`Meter`](#meter)\n- [`Direction`](#direction)\n- [`TariffType`](#tarifftype)\n- [`Reason`](#reason)\n- [`ReasonString`](#reasonstring)\n- [`ReadBy`](#readby)\n- [`ReadingStatus`](#readingstatus)\n- [`Reading`](#reading)\n- [`MeterReading`](#meterreading)\n- [`PortalMeterReading`](#portalmeterreading)\n- [`UpdateMeterReading`](#updatemeterreading)\n- [`MeterCounter`](#metercounter)\n- [`CounterReadingOnSubmission`](#counterreadingonsubmission)\n- [`SubmissionMeterReading`](#submissionmeterreading)\n- [`Unit`](#unit)\n- [`Source`](#source)\n- [`ActionLabel`](#actionlabel)\n- [`Rule`](#rule)\n- [`JourneyActions`](#journeyactions)\n- [`ReadingWithMeter`](#readingwithmeter)\n- [`ActivityId`](#activityid)\n\n### `getCustomerMeters`\n\nGet Customer Meters\n\n`GET /v1/metering/meter`\n\n```ts\nconst { data } = await client.getCustomerMeters()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "Example Entity",\n      "_org": "123",\n      "_tags": ["example", "mock"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-09T12:41:43.662Z",\n      "_schema": "meter",\n      "ma_lo_id": "A09-123",\n      "status": "active",\n      "meter_type": "three-phase-meter",\n      "tariff_type": "Peak load tariff",\n      "meter_number": "J-1093-1AK",\n      "sector": "power",\n      "location": [\n        {\n          "country": "Germany",\n          "city": "Koln",\n          "postal_code": 81475,\n          "street": "Melateng\xFCrtel",\n          "street_number": 71,\n          "additional_info": "5. Etage",\n          "_tags": ["billing", "delivery"]\n        }\n      ],\n      "used_for": "Domestic Usage",\n      "manufacturer": "Energy One",\n      "calibration_date": "2022-10-10T00:00:00.000Z",\n      "contract": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      },\n      "customer": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      },\n      "journey_actions": {\n        "journey_id": "string",\n        "action_label": {\n          "en": "string",\n          "de": "string"\n        },\n        "slug": "string",\n        "rules": [\n          {\n            "entity": "string",\n            "attribute": "string",\n            "attribute_value": "string"\n          }\n        ]\n      },\n      "last_reading": "2022-10-10T00:00:00.000Z",\n      "current_consumption": 100.5\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getMetersByContractId`\n\nRetrieves all meters related to a contract.\n\n`GET /v1/metering/contract/meters/{contract_id}`\n\n```ts\nconst { data } = await client.getMetersByContractId({\n  contract_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "Example Entity",\n      "_org": "123",\n      "_tags": ["example", "mock"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-09T12:41:43.662Z",\n      "_schema": "meter",\n      "ma_lo_id": "A09-123",\n      "status": "active",\n      "meter_type": "three-phase-meter",\n      "tariff_type": "Peak load tariff",\n      "meter_number": "J-1093-1AK",\n      "sector": "power",\n      "location": [\n        {\n          "country": "Germany",\n          "city": "Koln",\n          "postal_code": 81475,\n          "street": "Melateng\xFCrtel",\n          "street_number": 71,\n          "additional_info": "5. Etage",\n          "_tags": ["billing", "delivery"]\n        }\n      ],\n      "used_for": "Domestic Usage",\n      "manufacturer": "Energy One",\n      "calibration_date": "2022-10-10T00:00:00.000Z",\n      "contract": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      },\n      "customer": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `updateMeter`\n\nUpdate Meter\n\n`PATCH /v1/metering/meter/{id}`\n\n```ts\nconst { data } = await client.updateMeter(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "_title": "Example Entity",\n    "_org": "123",\n    "_tags": ["example", "mock"],\n    "_created_at": "2021-02-09T12:41:43.662Z",\n    "_updated_at": "2021-02-09T12:41:43.662Z",\n    "_schema": "meter",\n    "ma_lo_id": "A09-123",\n    "status": "active",\n    "meter_type": "three-phase-meter",\n    "tariff_type": "Peak load tariff",\n    "meter_number": "J-1093-1AK",\n    "sector": "power",\n    "location": [\n      {\n        "country": "Germany",\n        "city": "Koln",\n        "postal_code": 81475,\n        "street": "Melateng\xFCrtel",\n        "street_number": 71,\n        "additional_info": "5. Etage",\n        "_tags": ["billing", "delivery"]\n      }\n    ],\n    "used_for": "Domestic Usage",\n    "manufacturer": "Energy One",\n    "calibration_date": "2022-10-10T00:00:00.000Z",\n    "contract": {\n      "$relation": [\n        {\n          "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "_slug": "contact"\n        }\n      ]\n    },\n    "customer": {\n      "$relation": [\n        {\n          "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "_slug": "contact"\n        }\n      ]\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `getMeter`\n\nGet Meter\n\n`GET /v1/metering/meter/{id}`\n\n```ts\nconst { data } = await client.getMeter({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "entity": {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "Example Entity",\n      "_org": "123",\n      "_tags": ["example", "mock"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-09T12:41:43.662Z",\n      "_schema": "meter",\n      "ma_lo_id": "A09-123",\n      "status": "active",\n      "meter_type": "three-phase-meter",\n      "tariff_type": "Peak load tariff",\n      "meter_number": "J-1093-1AK",\n      "sector": "power",\n      "location": [\n        {\n          "country": "Germany",\n          "city": "Koln",\n          "postal_code": 81475,\n          "street": "Melateng\xFCrtel",\n          "street_number": 71,\n          "additional_info": "5. Etage",\n          "_tags": ["billing", "delivery"]\n        }\n      ],\n      "used_for": "Domestic Usage",\n      "manufacturer": "Energy One",\n      "calibration_date": "2022-10-10T00:00:00.000Z",\n      "contract": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      },\n      "customer": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      }\n    },\n    "journey_actions": {\n      "journey_id": "string",\n      "action_label": {\n        "en": "string",\n        "de": "string"\n      },\n      "slug": "string",\n      "rules": [\n        {\n          "entity": "string",\n          "attribute": "string",\n          "attribute_value": "string"\n        }\n      ]\n    },\n    "relations": [\n      {\n        "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n        "_title": "Example Entity",\n        "_org": "123",\n        "_tags": ["example", "mock"],\n        "_created_at": "2021-02-09T12:41:43.662Z",\n        "_updated_at": "2021-02-09T12:41:43.662Z"\n      }\n    ]\n  }\n}\n```\n\n</details>\n\n---\n\n### `getMeterCounters`\n\nGet Meter Counters\n\n`GET /v1/metering/counter`\n\n```ts\nconst { data } = await client.getMeterCounters({\n  meter_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "Example Entity",\n      "_org": "123",\n      "_tags": ["example", "mock"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-09T12:41:43.662Z",\n      "_schema": "meter_counter",\n      "obis_number": "A-34",\n      "direction": "feed-in",\n      "transformer_ratio": 70,\n      "unit": "string",\n      "forecast_reading_value": 270,\n      "forecast_as_of": "2022-12-10T00:00:00.000Z",\n      "current_consumption": 240,\n      "last_reading": "2022-10-10T00:00:00.000Z",\n      "conversion_factor": 3,\n      "tariff_type": "ht"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getCounterDetails`\n\nGet Counter Details\n\n`GET /v1/metering/counter/{counter_id}`\n\n```ts\nconst { data } = await client.getCounterDetails({\n  counter_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "_title": "Example Entity",\n    "_org": "123",\n    "_tags": ["example", "mock"],\n    "_created_at": "2021-02-09T12:41:43.662Z",\n    "_updated_at": "2021-02-09T12:41:43.662Z",\n    "_schema": "meter_counter",\n    "obis_number": "A-34",\n    "direction": "feed-in",\n    "transformer_ratio": 70,\n    "unit": "string",\n    "forecast_reading_value": 270,\n    "forecast_as_of": "2022-12-10T00:00:00.000Z",\n    "current_consumption": 240,\n    "last_reading": "2022-10-10T00:00:00.000Z",\n    "conversion_factor": 3,\n    "tariff_type": "ht"\n  }\n}\n```\n\n</details>\n\n---\n\n### `createMeterReading`\n\nCreate Meter Reading\n\n`POST /v1/metering/reading`\n\n```ts\nconst { data } = await client.createMeterReading(\n  null,\n  {\n    value: 240,\n    read_by: \'John Doe\',\n    reason: \'\',\n    meter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    counter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    direction: \'feed-in\',\n    timestamp: \'2022-10-10T00:00:00.000Z\',\n    source: \'ECP\',\n    status: \'valid\',\n    external_id: \'string\',\n    remark: \'Customer reported unusual consumption\',\n    metadata: {\n      registration_id: \'1234567890\',\n      business_unit: \'ABC\'\n    },\n    note: \'string\',\n    unit: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "value": 240,\n    "read_by": "John Doe",\n    "reason": "",\n    "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "direction": "feed-in",\n    "timestamp": "2022-10-10T00:00:00.000Z",\n    "source": "ECP",\n    "status": "valid",\n    "external_id": "string",\n    "remark": "Customer reported unusual consumption",\n    "metadata": {\n      "registration_id": "1234567890",\n      "business_unit": "ABC"\n    },\n    "note": "string",\n    "unit": "string"\n  }\n}\n```\n\n</details>\n\n---\n\n### `createMeterReadings`\n\nCreate Meter Readings\n\n`POST /v1/metering/readings`\n\n```ts\nconst { data } = await client.createMeterReadings(\n  {\n    async: true,\n    activity_id: \'example\',\n    skip_validation: true,\n  },\n  {\n    readings: [\n      {\n        value: 240,\n        read_by: \'John Doe\',\n        reason: \'\',\n        meter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        counter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        direction: \'feed-in\',\n        timestamp: \'2022-10-10T00:00:00.000Z\',\n        source: \'ECP\',\n        status: \'valid\',\n        external_id: \'string\',\n        remark: \'Customer reported unusual consumption\',\n        metadata: {\n          registration_id: \'1234567890\',\n          business_unit: \'ABC\'\n        },\n        note: \'string\',\n        unit: \'string\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "value": 240,\n      "read_by": "John Doe",\n      "reason": "",\n      "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "direction": "feed-in",\n      "timestamp": "2022-10-10T00:00:00.000Z",\n      "source": "ECP",\n      "status": "valid",\n      "external_id": "string",\n      "remark": "Customer reported unusual consumption",\n      "metadata": {\n        "registration_id": "1234567890",\n        "business_unit": "ABC"\n      },\n      "note": "string",\n      "unit": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createPortalMeterReadings`\n\nInserts multiple meter readings at once for a given meter. Limited to 2 readings per request.\n\n`POST /v1/metering/readings/{meter_id}`\n\n```ts\nconst { data } = await client.createPortalMeterReadings(\n  {\n    meter_id: \'example\',\n  },\n  {\n    readings: [\n      {\n        value: 240,\n        read_by: \'John Doe\',\n        reason: \'\',\n        meter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        counter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        direction: \'feed-in\',\n        timestamp: \'2022-10-10T00:00:00.000Z\',\n        source: \'ECP\',\n        status: \'valid\',\n        external_id: \'string\',\n        remark: \'Customer reported unusual consumption\',\n        metadata: {\n          registration_id: \'1234567890\',\n          business_unit: \'ABC\'\n        },\n        note: \'string\',\n        unit: \'string\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "value": 240,\n      "read_by": "John Doe",\n      "reason": "",\n      "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "direction": "feed-in",\n      "timestamp": "2022-10-10T00:00:00.000Z",\n      "source": "ECP",\n      "status": "valid",\n      "external_id": "string",\n      "remark": "Customer reported unusual consumption",\n      "metadata": {\n        "registration_id": "1234567890",\n        "business_unit": "ABC"\n      },\n      "note": "string",\n      "unit": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `batchWriteMeterReadings`\n\nBatch Write Readings\n\n`POST /v2/metering/readings`\n\n```ts\nconst { data } = await client.batchWriteMeterReadings(\n  {\n    async: true,\n    skip_validation: true,\n    activity_id: \'example\',\n  },\n  {\n    identifiers: [\'string\'],\n    readings: [\n      {\n        value: 240,\n        read_by: \'John Doe\',\n        reason: \'\',\n        meter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        counter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        direction: \'feed-in\',\n        timestamp: \'2022-10-10T00:00:00.000Z\',\n        source: \'ECP\',\n        status: \'valid\',\n        external_id: \'string\',\n        remark: \'Customer reported unusual consumption\',\n        metadata: {\n          registration_id: \'1234567890\',\n          business_unit: \'ABC\'\n        },\n        note: \'string\',\n        unit: \'string\',\n        operation: \'create\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "value": 240,\n      "read_by": "John Doe",\n      "reason": "",\n      "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "direction": "feed-in",\n      "timestamp": "2022-10-10T00:00:00.000Z",\n      "source": "ECP",\n      "status": "valid",\n      "external_id": "string",\n      "remark": "Customer reported unusual consumption",\n      "metadata": {\n        "registration_id": "1234567890",\n        "business_unit": "ABC"\n      },\n      "note": "string",\n      "unit": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createMeterReadingFromSubmission`\n\nCreate Meter Reading from Submission\n\n`POST /v1/metering/reading/submission`\n\n```ts\nconst { data } = await client.createMeterReadingFromSubmission(\n  null,\n  {\n    org_id: \'123\',\n    entity: {\n      _org: \'123\',\n      meterReadings: [\n        {\n          meterId: \'string\',\n          readings: [\n            {\n              counterId: \'string\',\n              direction: \'feed-in\',\n              unit: \'string\',\n              value: 240\n            }\n          ],\n          readingValue: 240,\n          readingDate: \'2022-10-10T10:10:00.000Z\',\n          readBy: \'John Doe\',\n          reason: \'\',\n          maloId: \'A09-123\',\n          obisNumber: \'A-34\',\n          readingUnit: \'string\',\n          meterType: \'one_tariff\',\n          feedInValue: 240,\n          feedOutValue: 240,\n          htValue: 240,\n          ntValue: 240\n        }\n      ]\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "message": "Successfully Processed"\n}\n```\n\n</details>\n\n---\n\n### `getAllowedReadingForMeter`\n\nGet allowed reading for the given meter\n\n`GET /v1/metering/allowed/reading/{meter_id}`\n\n```ts\nconst { data } = await client.getAllowedReadingForMeter({\n  meter_id: \'example\',\n  timestamp: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "counter_id": "string",\n      "min_value": 0,\n      "max_value": 0\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createReadingWithMeter`\n\nCreate Reading with Meter\n\n`POST /v1/metering/reading/with-meter`\n\n```ts\nconst { data } = await client.createReadingWithMeter(\n  null,\n  {\n    ma_lo_id: \'A09-123\',\n    meter_id: \'string\',\n    obis_number: \'A-34\',\n    unit: \'string\',\n    direction: \'feed-in\',\n    tariff_type: \'ht\',\n    value: 240,\n    read_by: \'John Doe\',\n    reason: \'\',\n    timestamp: \'2022-10-10T10:10:00.000Z\',\n    source: \'ECP\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "value": 240,\n    "read_by": "John Doe",\n    "reason": "",\n    "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "direction": "feed-in",\n    "timestamp": "2022-10-10T00:00:00.000Z",\n    "source": "ECP",\n    "status": "valid",\n    "external_id": "string",\n    "remark": "Customer reported unusual consumption",\n    "metadata": {\n      "registration_id": "1234567890",\n      "business_unit": "ABC"\n    },\n    "note": "string",\n    "unit": "string"\n  }\n}\n```\n\n</details>\n\n---\n\n### `getReadingsByInterval`\n\nGet Readings by Interval\n\n`GET /v1/metering/reading/{meter_id}/{counter_id}`\n\n```ts\nconst { data } = await client.getReadingsByInterval({\n  meter_id: \'example\',\n  counter_id: \'example\',\n  start_date: \'example\',\n  end_date: \'example\',\n  direction: \'example\',\n  size: 1,\n  from: 1,\n  type: \'example\',\n  sort: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "value": 240,\n      "read_by": "John Doe",\n      "reason": "",\n      "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "direction": "feed-in",\n      "timestamp": "2022-10-10T00:00:00.000Z",\n      "source": "ECP",\n      "status": "valid",\n      "external_id": "string",\n      "remark": "Customer reported unusual consumption",\n      "metadata": {\n        "registration_id": "1234567890",\n        "business_unit": "ABC"\n      },\n      "note": "string",\n      "unit": "string"\n    }\n  ],\n  "hits": 120,\n  "firstRecordCreatedAt": "2022-10-01T20:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateMeterReading`\n\nUpdate Meter Reading\n\n`PUT /v1/metering/reading/{meter_id}/{counter_id}`\n\n```ts\nconst { data } = await client.updateMeterReading(\n  {\n    meter_id: \'example\',\n    counter_id: \'example\',\n    timestamp: \'example\',\n  },\n  {\n    value: 240,\n    read_by: \'John Doe\',\n    reason: \'string\',\n    meter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    counter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    direction: \'feed-in\',\n    timestamp: \'2022-10-10T00:00:00.000Z\',\n    source: \'ECP\',\n    status: \'valid\',\n    external_id: \'string\',\n    remark: \'Customer reported unusual consumption\',\n    metadata: {\n      registration_id: \'1234567890\',\n      business_unit: \'ABC\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "value": 240,\n    "read_by": "John Doe",\n    "reason": "",\n    "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "direction": "feed-in",\n    "timestamp": "2022-10-10T00:00:00.000Z",\n    "source": "ECP",\n    "status": "valid",\n    "external_id": "string",\n    "remark": "Customer reported unusual consumption",\n    "metadata": {\n      "registration_id": "1234567890",\n      "business_unit": "ABC"\n    },\n    "note": "string",\n    "unit": "string"\n  }\n}\n```\n\n</details>\n\n---\n\n### `deleteMeterReading`\n\nDelete Meter Reading\n\n`DELETE /v1/metering/reading/{meter_id}/{counter_id}`\n\n```ts\nconst { data } = await client.deleteMeterReading({\n  meter_id: \'example\',\n  counter_id: \'example\',\n  timestamp: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "meterId": "string",\n    "counterId": "string",\n    "timestamp": "2022-10-01T20:00:00.000Z"\n  }\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n  message?: string\n}\n```\n\n### `EntityId`\n\n```ts\ntype EntityId = string // uuid\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema\n\n```ts\ntype EntitySlug = string\n```\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n  _id: string // uuid\n  _title: string\n  _org: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n}\n```\n\n### `Entity`\n\n```ts\ntype Entity = Record<string, unknown>\n```\n\n### `EntityItem`\n\n```ts\ntype EntityItem = {\n  _id: string // uuid\n  _title: string\n  _org: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n}\n```\n\n### `Id`\n\n```ts\ntype Id = string\n```\n\n### `EntityRelation`\n\n```ts\ntype EntityRelation = {\n  entity_id?: string // uuid\n  _slug?: "contact" | "contract"\n}\n```\n\n### `Meter`\n\n```ts\ntype Meter = {\n  _id: string // uuid\n  _title: string\n  _org: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _schema: "meter"\n  ma_lo_id?: string\n  status?: "active" | "decommissioned"\n  meter_type?: "three-phase-meter" | "bellow-gas-meter" | "rotary-piston-meter" | "smart-meter" | "performance-meter" | "maximum-meter" | "turbine-gas-meter" | "ultrasonic-gas-meter" | "alternating-current-meter" | "modern-metering-system" | "intelligent-measuring-system" | "electronic-meter"\n  tariff_type?: string\n  meter_number?: string\n  sector?: "power" | "water" | "gas" | "district_heating" | "waste_water"\n  location?: object\n  used_for?: string\n  manufacturer?: string\n  calibration_date?: string\n  contract?: {\n    $relation?: Array<{\n      entity_id?: { ... }\n      _slug?: { ... }\n    }>\n  }\n  customer?: {\n    $relation?: Array<{\n      entity_id?: { ... }\n      _slug?: { ... }\n    }>\n  }\n}\n```\n\n### `Direction`\n\n```ts\ntype Direction = "feed-in" | "feed-out"\n```\n\n### `TariffType`\n\n```ts\ntype TariffType = "ht" | "nt"\n```\n\n### `Reason`\n\nThe reason for recording the reading\nIf no reason is specified or left empty, the Epilot UI will show \'Regular\' as the default display text\n\n\n```ts\ntype Reason = "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n```\n\n### `ReasonString`\n\nThis field is deprecated. Please use the Reason enum instead.\n\n\n```ts\ntype ReasonString = string\n```\n\n### `ReadBy`\n\nThe person who recorded the reading\n\n```ts\ntype ReadBy = string\n```\n\n### `ReadingStatus`\n\n```ts\ntype ReadingStatus = "valid" | "in-validation" | "implausible" | null | ""\n```\n\n### `Reading`\n\n```ts\ntype Reading = {\n  value: number\n  read_by?: string\n  reason?: "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n  meter_id?: string // uuid\n  counter_id?: string // uuid\n  direction?: "feed-in" | "feed-out"\n  timestamp?: string // date-time\n  source: "ECP" | "ERP" | "360" | "journey-submission"\n  status?: "valid" | "in-validation" | "implausible" | null | ""\n  external_id?: string\n  remark?: string\n  metadata?: Record<string, string>\n  note?: string\n  unit?: string\n}\n```\n\n### `MeterReading`\n\n```ts\ntype MeterReading = {\n  value: number\n  read_by?: string\n  reason?: "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n  meter_id: string // uuid\n  counter_id?: string // uuid\n  direction?: "feed-in" | "feed-out"\n  timestamp?: string // date-time\n  source: "ECP" | "ERP" | "360" | "journey-submission"\n  status?: "valid" | "in-validation" | "implausible" | null | ""\n  external_id?: string\n  remark?: string\n  metadata?: Record<string, string>\n  note?: string\n  unit?: string\n}\n```\n\n### `PortalMeterReading`\n\n```ts\ntype PortalMeterReading = {\n  value: number\n  read_by?: string\n  reason?: "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n  meter_id?: string // uuid\n  counter_id: string // uuid\n  direction?: "feed-in" | "feed-out"\n  timestamp?: string // date-time\n  source: "ECP" | "ERP" | "360" | "journey-submission"\n  status?: "valid" | "in-validation" | "implausible" | null | ""\n  external_id?: string\n  remark?: string\n  metadata?: Record<string, string>\n  note?: string\n  unit?: string\n}\n```\n\n### `UpdateMeterReading`\n\n```ts\ntype UpdateMeterReading = {\n  value: number\n  read_by?: string\n  reason?: string\n  meter_id: string // uuid\n  counter_id?: string // uuid\n  direction?: "feed-in" | "feed-out"\n  timestamp?: string // date-time\n  source: "ECP" | "ERP" | "360" | "journey-submission"\n  status?: "valid" | "in-validation" | "implausible" | null | ""\n  external_id?: string\n  remark?: string\n  metadata?: Record<string, string>\n}\n```\n\n### `MeterCounter`\n\n```ts\ntype MeterCounter = {\n  _id: string // uuid\n  _title: string\n  _org: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _schema: "meter_counter"\n  obis_number?: string\n  direction?: "feed-in" | "feed-out"\n  transformer_ratio?: number\n  unit?: string\n  forecast_reading_value?: string\n  forecast_as_of?: string\n  current_consumption?: number\n  last_reading?: string\n  conversion_factor?: number\n  tariff_type?: "ht" | "nt"\n}\n```\n\n### `CounterReadingOnSubmission`\n\n```ts\ntype CounterReadingOnSubmission = {\n  counterId: string\n  direction: "feed-in" | "feed-out"\n  unit?: string\n  value: number\n}\n```\n\n### `SubmissionMeterReading`\n\n```ts\ntype SubmissionMeterReading = {\n  meterId: string\n  readings?: Array<{\n    counterId: string\n    direction: "feed-in" | "feed-out"\n    unit?: string\n    value: number\n  }>\n  readingValue?: number\n  readingDate?: string\n  readBy?: string\n  reason?: "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n  maloId?: string\n  obisNumber?: string\n  readingUnit?: string\n  meterType?: "one_tariff" | "two_tariff" | "bi_directional"\n  feedInValue?: number\n  feedOutValue?: number\n  htValue?: number\n  ntValue?: number\n}\n```\n\n### `Unit`\n\n```ts\ntype Unit = string\n```\n\n### `Source`\n\n```ts\ntype Source = "ECP" | "ERP" | "360" | "journey-submission"\n```\n\n### `ActionLabel`\n\n```ts\ntype ActionLabel = {\n  en?: string\n  de?: string\n}\n```\n\n### `Rule`\n\n```ts\ntype Rule = {\n  entity?: string\n  attribute?: string\n  attribute_value?: string\n}\n```\n\n### `JourneyActions`\n\n```ts\ntype JourneyActions = {\n  journey_id?: string\n  action_label?: {\n    en?: string\n    de?: string\n  }\n  slug?: string\n  rules?: Array<{\n    entity?: string\n    attribute?: string\n    attribute_value?: string\n  }>\n}\n```\n\n### `ReadingWithMeter`\n\n```ts\ntype ReadingWithMeter = {\n  ma_lo_id?: string\n  meter_id?: string\n  obis_number?: string\n  unit?: string\n  direction?: "feed-in" | "feed-out"\n  tariff_type?: "ht" | "nt"\n  value?: number\n  read_by?: string\n  reason?: "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n  timestamp?: string\n  source?: "ECP" | "ERP" | "360" | "journey-submission"\n}\n```\n\n### `ActivityId`\n\nSee https://github.com/ulid/spec\n\n```ts\ntype ActivityId = string // ulid\n```\n';
+
+
+exports.default = metering_default;

package/dist/metering-KOSCPPKB.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/metering.json
+var metering_default = '# Metering API\n\n- **Base URL:** `https://metering.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/metering](https://docs.epilot.io/api/metering)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.metering.getCustomerMeters(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/metering\'\n\nconst meteringClient = getClient()\nauthorize(meteringClient, () => \'<token>\')\nconst { data } = await meteringClient.getCustomerMeters(...)\n```\n\n## Operations\n\n**ECP**\n- [`getCustomerMeters`](#getcustomermeters)\n- [`getMetersByContractId`](#getmetersbycontractid)\n- [`updateMeter`](#updatemeter)\n- [`getMeter`](#getmeter)\n- [`getMeterCounters`](#getmetercounters)\n- [`getCounterDetails`](#getcounterdetails)\n- [`createPortalMeterReadings`](#createportalmeterreadings)\n\n**ECP Admin**\n- [`createMeterReading`](#createmeterreading)\n- [`createMeterReadings`](#createmeterreadings)\n- [`batchWriteMeterReadings`](#batchwritemeterreadings)\n- [`createMeterReadingFromSubmission`](#createmeterreadingfromsubmission)\n- [`getAllowedReadingForMeter`](#getallowedreadingformeter)\n- [`createReadingWithMeter`](#createreadingwithmeter)\n- [`getReadingsByInterval`](#getreadingsbyinterval)\n- [`updateMeterReading`](#updatemeterreading)\n- [`deleteMeterReading`](#deletemeterreading)\n\n**Schemas**\n- [`ErrorResp`](#errorresp)\n- [`EntityId`](#entityid)\n- [`EntitySlug`](#entityslug)\n- [`BaseEntity`](#baseentity)\n- [`Entity`](#entity)\n- [`EntityItem`](#entityitem)\n- [`Id`](#id)\n- [`EntityRelation`](#entityrelation)\n- [`Meter`](#meter)\n- [`Direction`](#direction)\n- [`TariffType`](#tarifftype)\n- [`Reason`](#reason)\n- [`ReasonString`](#reasonstring)\n- [`ReadBy`](#readby)\n- [`ReadingStatus`](#readingstatus)\n- [`Reading`](#reading)\n- [`MeterReading`](#meterreading)\n- [`PortalMeterReading`](#portalmeterreading)\n- [`UpdateMeterReading`](#updatemeterreading)\n- [`MeterCounter`](#metercounter)\n- [`CounterReadingOnSubmission`](#counterreadingonsubmission)\n- [`SubmissionMeterReading`](#submissionmeterreading)\n- [`Unit`](#unit)\n- [`Source`](#source)\n- [`ActionLabel`](#actionlabel)\n- [`Rule`](#rule)\n- [`JourneyActions`](#journeyactions)\n- [`ReadingWithMeter`](#readingwithmeter)\n- [`ActivityId`](#activityid)\n\n### `getCustomerMeters`\n\nGet Customer Meters\n\n`GET /v1/metering/meter`\n\n```ts\nconst { data } = await client.getCustomerMeters()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "Example Entity",\n      "_org": "123",\n      "_tags": ["example", "mock"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-09T12:41:43.662Z",\n      "_schema": "meter",\n      "ma_lo_id": "A09-123",\n      "status": "active",\n      "meter_type": "three-phase-meter",\n      "tariff_type": "Peak load tariff",\n      "meter_number": "J-1093-1AK",\n      "sector": "power",\n      "location": [\n        {\n          "country": "Germany",\n          "city": "Koln",\n          "postal_code": 81475,\n          "street": "Melateng\xFCrtel",\n          "street_number": 71,\n          "additional_info": "5. Etage",\n          "_tags": ["billing", "delivery"]\n        }\n      ],\n      "used_for": "Domestic Usage",\n      "manufacturer": "Energy One",\n      "calibration_date": "2022-10-10T00:00:00.000Z",\n      "contract": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      },\n      "customer": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      },\n      "journey_actions": {\n        "journey_id": "string",\n        "action_label": {\n          "en": "string",\n          "de": "string"\n        },\n        "slug": "string",\n        "rules": [\n          {\n            "entity": "string",\n            "attribute": "string",\n            "attribute_value": "string"\n          }\n        ]\n      },\n      "last_reading": "2022-10-10T00:00:00.000Z",\n      "current_consumption": 100.5\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getMetersByContractId`\n\nRetrieves all meters related to a contract.\n\n`GET /v1/metering/contract/meters/{contract_id}`\n\n```ts\nconst { data } = await client.getMetersByContractId({\n  contract_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "Example Entity",\n      "_org": "123",\n      "_tags": ["example", "mock"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-09T12:41:43.662Z",\n      "_schema": "meter",\n      "ma_lo_id": "A09-123",\n      "status": "active",\n      "meter_type": "three-phase-meter",\n      "tariff_type": "Peak load tariff",\n      "meter_number": "J-1093-1AK",\n      "sector": "power",\n      "location": [\n        {\n          "country": "Germany",\n          "city": "Koln",\n          "postal_code": 81475,\n          "street": "Melateng\xFCrtel",\n          "street_number": 71,\n          "additional_info": "5. Etage",\n          "_tags": ["billing", "delivery"]\n        }\n      ],\n      "used_for": "Domestic Usage",\n      "manufacturer": "Energy One",\n      "calibration_date": "2022-10-10T00:00:00.000Z",\n      "contract": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      },\n      "customer": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `updateMeter`\n\nUpdate Meter\n\n`PATCH /v1/metering/meter/{id}`\n\n```ts\nconst { data } = await client.updateMeter(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "_title": "Example Entity",\n    "_org": "123",\n    "_tags": ["example", "mock"],\n    "_created_at": "2021-02-09T12:41:43.662Z",\n    "_updated_at": "2021-02-09T12:41:43.662Z",\n    "_schema": "meter",\n    "ma_lo_id": "A09-123",\n    "status": "active",\n    "meter_type": "three-phase-meter",\n    "tariff_type": "Peak load tariff",\n    "meter_number": "J-1093-1AK",\n    "sector": "power",\n    "location": [\n      {\n        "country": "Germany",\n        "city": "Koln",\n        "postal_code": 81475,\n        "street": "Melateng\xFCrtel",\n        "street_number": 71,\n        "additional_info": "5. Etage",\n        "_tags": ["billing", "delivery"]\n      }\n    ],\n    "used_for": "Domestic Usage",\n    "manufacturer": "Energy One",\n    "calibration_date": "2022-10-10T00:00:00.000Z",\n    "contract": {\n      "$relation": [\n        {\n          "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "_slug": "contact"\n        }\n      ]\n    },\n    "customer": {\n      "$relation": [\n        {\n          "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n          "_slug": "contact"\n        }\n      ]\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `getMeter`\n\nGet Meter\n\n`GET /v1/metering/meter/{id}`\n\n```ts\nconst { data } = await client.getMeter({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "entity": {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "Example Entity",\n      "_org": "123",\n      "_tags": ["example", "mock"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-09T12:41:43.662Z",\n      "_schema": "meter",\n      "ma_lo_id": "A09-123",\n      "status": "active",\n      "meter_type": "three-phase-meter",\n      "tariff_type": "Peak load tariff",\n      "meter_number": "J-1093-1AK",\n      "sector": "power",\n      "location": [\n        {\n          "country": "Germany",\n          "city": "Koln",\n          "postal_code": 81475,\n          "street": "Melateng\xFCrtel",\n          "street_number": 71,\n          "additional_info": "5. Etage",\n          "_tags": ["billing", "delivery"]\n        }\n      ],\n      "used_for": "Domestic Usage",\n      "manufacturer": "Energy One",\n      "calibration_date": "2022-10-10T00:00:00.000Z",\n      "contract": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      },\n      "customer": {\n        "$relation": [\n          {\n            "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n            "_slug": "contact"\n          }\n        ]\n      }\n    },\n    "journey_actions": {\n      "journey_id": "string",\n      "action_label": {\n        "en": "string",\n        "de": "string"\n      },\n      "slug": "string",\n      "rules": [\n        {\n          "entity": "string",\n          "attribute": "string",\n          "attribute_value": "string"\n        }\n      ]\n    },\n    "relations": [\n      {\n        "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n        "_title": "Example Entity",\n        "_org": "123",\n        "_tags": ["example", "mock"],\n        "_created_at": "2021-02-09T12:41:43.662Z",\n        "_updated_at": "2021-02-09T12:41:43.662Z"\n      }\n    ]\n  }\n}\n```\n\n</details>\n\n---\n\n### `getMeterCounters`\n\nGet Meter Counters\n\n`GET /v1/metering/counter`\n\n```ts\nconst { data } = await client.getMeterCounters({\n  meter_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "Example Entity",\n      "_org": "123",\n      "_tags": ["example", "mock"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-09T12:41:43.662Z",\n      "_schema": "meter_counter",\n      "obis_number": "A-34",\n      "direction": "feed-in",\n      "transformer_ratio": 70,\n      "unit": "string",\n      "forecast_reading_value": 270,\n      "forecast_as_of": "2022-12-10T00:00:00.000Z",\n      "current_consumption": 240,\n      "last_reading": "2022-10-10T00:00:00.000Z",\n      "conversion_factor": 3,\n      "tariff_type": "ht"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getCounterDetails`\n\nGet Counter Details\n\n`GET /v1/metering/counter/{counter_id}`\n\n```ts\nconst { data } = await client.getCounterDetails({\n  counter_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "_title": "Example Entity",\n    "_org": "123",\n    "_tags": ["example", "mock"],\n    "_created_at": "2021-02-09T12:41:43.662Z",\n    "_updated_at": "2021-02-09T12:41:43.662Z",\n    "_schema": "meter_counter",\n    "obis_number": "A-34",\n    "direction": "feed-in",\n    "transformer_ratio": 70,\n    "unit": "string",\n    "forecast_reading_value": 270,\n    "forecast_as_of": "2022-12-10T00:00:00.000Z",\n    "current_consumption": 240,\n    "last_reading": "2022-10-10T00:00:00.000Z",\n    "conversion_factor": 3,\n    "tariff_type": "ht"\n  }\n}\n```\n\n</details>\n\n---\n\n### `createMeterReading`\n\nCreate Meter Reading\n\n`POST /v1/metering/reading`\n\n```ts\nconst { data } = await client.createMeterReading(\n  null,\n  {\n    value: 240,\n    read_by: \'John Doe\',\n    reason: \'\',\n    meter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    counter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    direction: \'feed-in\',\n    timestamp: \'2022-10-10T00:00:00.000Z\',\n    source: \'ECP\',\n    status: \'valid\',\n    external_id: \'string\',\n    remark: \'Customer reported unusual consumption\',\n    metadata: {\n      registration_id: \'1234567890\',\n      business_unit: \'ABC\'\n    },\n    note: \'string\',\n    unit: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "value": 240,\n    "read_by": "John Doe",\n    "reason": "",\n    "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "direction": "feed-in",\n    "timestamp": "2022-10-10T00:00:00.000Z",\n    "source": "ECP",\n    "status": "valid",\n    "external_id": "string",\n    "remark": "Customer reported unusual consumption",\n    "metadata": {\n      "registration_id": "1234567890",\n      "business_unit": "ABC"\n    },\n    "note": "string",\n    "unit": "string"\n  }\n}\n```\n\n</details>\n\n---\n\n### `createMeterReadings`\n\nCreate Meter Readings\n\n`POST /v1/metering/readings`\n\n```ts\nconst { data } = await client.createMeterReadings(\n  {\n    async: true,\n    activity_id: \'example\',\n    skip_validation: true,\n  },\n  {\n    readings: [\n      {\n        value: 240,\n        read_by: \'John Doe\',\n        reason: \'\',\n        meter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        counter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        direction: \'feed-in\',\n        timestamp: \'2022-10-10T00:00:00.000Z\',\n        source: \'ECP\',\n        status: \'valid\',\n        external_id: \'string\',\n        remark: \'Customer reported unusual consumption\',\n        metadata: {\n          registration_id: \'1234567890\',\n          business_unit: \'ABC\'\n        },\n        note: \'string\',\n        unit: \'string\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "value": 240,\n      "read_by": "John Doe",\n      "reason": "",\n      "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "direction": "feed-in",\n      "timestamp": "2022-10-10T00:00:00.000Z",\n      "source": "ECP",\n      "status": "valid",\n      "external_id": "string",\n      "remark": "Customer reported unusual consumption",\n      "metadata": {\n        "registration_id": "1234567890",\n        "business_unit": "ABC"\n      },\n      "note": "string",\n      "unit": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createPortalMeterReadings`\n\nInserts multiple meter readings at once for a given meter. Limited to 2 readings per request.\n\n`POST /v1/metering/readings/{meter_id}`\n\n```ts\nconst { data } = await client.createPortalMeterReadings(\n  {\n    meter_id: \'example\',\n  },\n  {\n    readings: [\n      {\n        value: 240,\n        read_by: \'John Doe\',\n        reason: \'\',\n        meter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        counter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        direction: \'feed-in\',\n        timestamp: \'2022-10-10T00:00:00.000Z\',\n        source: \'ECP\',\n        status: \'valid\',\n        external_id: \'string\',\n        remark: \'Customer reported unusual consumption\',\n        metadata: {\n          registration_id: \'1234567890\',\n          business_unit: \'ABC\'\n        },\n        note: \'string\',\n        unit: \'string\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "value": 240,\n      "read_by": "John Doe",\n      "reason": "",\n      "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "direction": "feed-in",\n      "timestamp": "2022-10-10T00:00:00.000Z",\n      "source": "ECP",\n      "status": "valid",\n      "external_id": "string",\n      "remark": "Customer reported unusual consumption",\n      "metadata": {\n        "registration_id": "1234567890",\n        "business_unit": "ABC"\n      },\n      "note": "string",\n      "unit": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `batchWriteMeterReadings`\n\nBatch Write Readings\n\n`POST /v2/metering/readings`\n\n```ts\nconst { data } = await client.batchWriteMeterReadings(\n  {\n    async: true,\n    skip_validation: true,\n    activity_id: \'example\',\n  },\n  {\n    identifiers: [\'string\'],\n    readings: [\n      {\n        value: 240,\n        read_by: \'John Doe\',\n        reason: \'\',\n        meter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        counter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        direction: \'feed-in\',\n        timestamp: \'2022-10-10T00:00:00.000Z\',\n        source: \'ECP\',\n        status: \'valid\',\n        external_id: \'string\',\n        remark: \'Customer reported unusual consumption\',\n        metadata: {\n          registration_id: \'1234567890\',\n          business_unit: \'ABC\'\n        },\n        note: \'string\',\n        unit: \'string\',\n        operation: \'create\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "value": 240,\n      "read_by": "John Doe",\n      "reason": "",\n      "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "direction": "feed-in",\n      "timestamp": "2022-10-10T00:00:00.000Z",\n      "source": "ECP",\n      "status": "valid",\n      "external_id": "string",\n      "remark": "Customer reported unusual consumption",\n      "metadata": {\n        "registration_id": "1234567890",\n        "business_unit": "ABC"\n      },\n      "note": "string",\n      "unit": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createMeterReadingFromSubmission`\n\nCreate Meter Reading from Submission\n\n`POST /v1/metering/reading/submission`\n\n```ts\nconst { data } = await client.createMeterReadingFromSubmission(\n  null,\n  {\n    org_id: \'123\',\n    entity: {\n      _org: \'123\',\n      meterReadings: [\n        {\n          meterId: \'string\',\n          readings: [\n            {\n              counterId: \'string\',\n              direction: \'feed-in\',\n              unit: \'string\',\n              value: 240\n            }\n          ],\n          readingValue: 240,\n          readingDate: \'2022-10-10T10:10:00.000Z\',\n          readBy: \'John Doe\',\n          reason: \'\',\n          maloId: \'A09-123\',\n          obisNumber: \'A-34\',\n          readingUnit: \'string\',\n          meterType: \'one_tariff\',\n          feedInValue: 240,\n          feedOutValue: 240,\n          htValue: 240,\n          ntValue: 240\n        }\n      ]\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "message": "Successfully Processed"\n}\n```\n\n</details>\n\n---\n\n### `getAllowedReadingForMeter`\n\nGet allowed reading for the given meter\n\n`GET /v1/metering/allowed/reading/{meter_id}`\n\n```ts\nconst { data } = await client.getAllowedReadingForMeter({\n  meter_id: \'example\',\n  timestamp: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "counter_id": "string",\n      "min_value": 0,\n      "max_value": 0\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createReadingWithMeter`\n\nCreate Reading with Meter\n\n`POST /v1/metering/reading/with-meter`\n\n```ts\nconst { data } = await client.createReadingWithMeter(\n  null,\n  {\n    ma_lo_id: \'A09-123\',\n    meter_id: \'string\',\n    obis_number: \'A-34\',\n    unit: \'string\',\n    direction: \'feed-in\',\n    tariff_type: \'ht\',\n    value: 240,\n    read_by: \'John Doe\',\n    reason: \'\',\n    timestamp: \'2022-10-10T10:10:00.000Z\',\n    source: \'ECP\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "value": 240,\n    "read_by": "John Doe",\n    "reason": "",\n    "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "direction": "feed-in",\n    "timestamp": "2022-10-10T00:00:00.000Z",\n    "source": "ECP",\n    "status": "valid",\n    "external_id": "string",\n    "remark": "Customer reported unusual consumption",\n    "metadata": {\n      "registration_id": "1234567890",\n      "business_unit": "ABC"\n    },\n    "note": "string",\n    "unit": "string"\n  }\n}\n```\n\n</details>\n\n---\n\n### `getReadingsByInterval`\n\nGet Readings by Interval\n\n`GET /v1/metering/reading/{meter_id}/{counter_id}`\n\n```ts\nconst { data } = await client.getReadingsByInterval({\n  meter_id: \'example\',\n  counter_id: \'example\',\n  start_date: \'example\',\n  end_date: \'example\',\n  direction: \'example\',\n  size: 1,\n  from: 1,\n  type: \'example\',\n  sort: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "value": 240,\n      "read_by": "John Doe",\n      "reason": "",\n      "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "direction": "feed-in",\n      "timestamp": "2022-10-10T00:00:00.000Z",\n      "source": "ECP",\n      "status": "valid",\n      "external_id": "string",\n      "remark": "Customer reported unusual consumption",\n      "metadata": {\n        "registration_id": "1234567890",\n        "business_unit": "ABC"\n      },\n      "note": "string",\n      "unit": "string"\n    }\n  ],\n  "hits": 120,\n  "firstRecordCreatedAt": "2022-10-01T20:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateMeterReading`\n\nUpdate Meter Reading\n\n`PUT /v1/metering/reading/{meter_id}/{counter_id}`\n\n```ts\nconst { data } = await client.updateMeterReading(\n  {\n    meter_id: \'example\',\n    counter_id: \'example\',\n    timestamp: \'example\',\n  },\n  {\n    value: 240,\n    read_by: \'John Doe\',\n    reason: \'string\',\n    meter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    counter_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    direction: \'feed-in\',\n    timestamp: \'2022-10-10T00:00:00.000Z\',\n    source: \'ECP\',\n    status: \'valid\',\n    external_id: \'string\',\n    remark: \'Customer reported unusual consumption\',\n    metadata: {\n      registration_id: \'1234567890\',\n      business_unit: \'ABC\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "value": 240,\n    "read_by": "John Doe",\n    "reason": "",\n    "meter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "counter_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "direction": "feed-in",\n    "timestamp": "2022-10-10T00:00:00.000Z",\n    "source": "ECP",\n    "status": "valid",\n    "external_id": "string",\n    "remark": "Customer reported unusual consumption",\n    "metadata": {\n      "registration_id": "1234567890",\n      "business_unit": "ABC"\n    },\n    "note": "string",\n    "unit": "string"\n  }\n}\n```\n\n</details>\n\n---\n\n### `deleteMeterReading`\n\nDelete Meter Reading\n\n`DELETE /v1/metering/reading/{meter_id}/{counter_id}`\n\n```ts\nconst { data } = await client.deleteMeterReading({\n  meter_id: \'example\',\n  counter_id: \'example\',\n  timestamp: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": {\n    "meterId": "string",\n    "counterId": "string",\n    "timestamp": "2022-10-01T20:00:00.000Z"\n  }\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n  message?: string\n}\n```\n\n### `EntityId`\n\n```ts\ntype EntityId = string // uuid\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema\n\n```ts\ntype EntitySlug = string\n```\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n  _id: string // uuid\n  _title: string\n  _org: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n}\n```\n\n### `Entity`\n\n```ts\ntype Entity = Record<string, unknown>\n```\n\n### `EntityItem`\n\n```ts\ntype EntityItem = {\n  _id: string // uuid\n  _title: string\n  _org: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n}\n```\n\n### `Id`\n\n```ts\ntype Id = string\n```\n\n### `EntityRelation`\n\n```ts\ntype EntityRelation = {\n  entity_id?: string // uuid\n  _slug?: "contact" | "contract"\n}\n```\n\n### `Meter`\n\n```ts\ntype Meter = {\n  _id: string // uuid\n  _title: string\n  _org: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _schema: "meter"\n  ma_lo_id?: string\n  status?: "active" | "decommissioned"\n  meter_type?: "three-phase-meter" | "bellow-gas-meter" | "rotary-piston-meter" | "smart-meter" | "performance-meter" | "maximum-meter" | "turbine-gas-meter" | "ultrasonic-gas-meter" | "alternating-current-meter" | "modern-metering-system" | "intelligent-measuring-system" | "electronic-meter"\n  tariff_type?: string\n  meter_number?: string\n  sector?: "power" | "water" | "gas" | "district_heating" | "waste_water"\n  location?: object\n  used_for?: string\n  manufacturer?: string\n  calibration_date?: string\n  contract?: {\n    $relation?: Array<{\n      entity_id?: { ... }\n      _slug?: { ... }\n    }>\n  }\n  customer?: {\n    $relation?: Array<{\n      entity_id?: { ... }\n      _slug?: { ... }\n    }>\n  }\n}\n```\n\n### `Direction`\n\n```ts\ntype Direction = "feed-in" | "feed-out"\n```\n\n### `TariffType`\n\n```ts\ntype TariffType = "ht" | "nt"\n```\n\n### `Reason`\n\nThe reason for recording the reading\nIf no reason is specified or left empty, the Epilot UI will show \'Regular\' as the default display text\n\n\n```ts\ntype Reason = "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n```\n\n### `ReasonString`\n\nThis field is deprecated. Please use the Reason enum instead.\n\n\n```ts\ntype ReasonString = string\n```\n\n### `ReadBy`\n\nThe person who recorded the reading\n\n```ts\ntype ReadBy = string\n```\n\n### `ReadingStatus`\n\n```ts\ntype ReadingStatus = "valid" | "in-validation" | "implausible" | null | ""\n```\n\n### `Reading`\n\n```ts\ntype Reading = {\n  value: number\n  read_by?: string\n  reason?: "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n  meter_id?: string // uuid\n  counter_id?: string // uuid\n  direction?: "feed-in" | "feed-out"\n  timestamp?: string // date-time\n  source: "ECP" | "ERP" | "360" | "journey-submission"\n  status?: "valid" | "in-validation" | "implausible" | null | ""\n  external_id?: string\n  remark?: string\n  metadata?: Record<string, string>\n  note?: string\n  unit?: string\n}\n```\n\n### `MeterReading`\n\n```ts\ntype MeterReading = {\n  value: number\n  read_by?: string\n  reason?: "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n  meter_id: string // uuid\n  counter_id?: string // uuid\n  direction?: "feed-in" | "feed-out"\n  timestamp?: string // date-time\n  source: "ECP" | "ERP" | "360" | "journey-submission"\n  status?: "valid" | "in-validation" | "implausible" | null | ""\n  external_id?: string\n  remark?: string\n  metadata?: Record<string, string>\n  note?: string\n  unit?: string\n}\n```\n\n### `PortalMeterReading`\n\n```ts\ntype PortalMeterReading = {\n  value: number\n  read_by?: string\n  reason?: "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n  meter_id?: string // uuid\n  counter_id: string // uuid\n  direction?: "feed-in" | "feed-out"\n  timestamp?: string // date-time\n  source: "ECP" | "ERP" | "360" | "journey-submission"\n  status?: "valid" | "in-validation" | "implausible" | null | ""\n  external_id?: string\n  remark?: string\n  metadata?: Record<string, string>\n  note?: string\n  unit?: string\n}\n```\n\n### `UpdateMeterReading`\n\n```ts\ntype UpdateMeterReading = {\n  value: number\n  read_by?: string\n  reason?: string\n  meter_id: string // uuid\n  counter_id?: string // uuid\n  direction?: "feed-in" | "feed-out"\n  timestamp?: string // date-time\n  source: "ECP" | "ERP" | "360" | "journey-submission"\n  status?: "valid" | "in-validation" | "implausible" | null | ""\n  external_id?: string\n  remark?: string\n  metadata?: Record<string, string>\n}\n```\n\n### `MeterCounter`\n\n```ts\ntype MeterCounter = {\n  _id: string // uuid\n  _title: string\n  _org: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _schema: "meter_counter"\n  obis_number?: string\n  direction?: "feed-in" | "feed-out"\n  transformer_ratio?: number\n  unit?: string\n  forecast_reading_value?: string\n  forecast_as_of?: string\n  current_consumption?: number\n  last_reading?: string\n  conversion_factor?: number\n  tariff_type?: "ht" | "nt"\n}\n```\n\n### `CounterReadingOnSubmission`\n\n```ts\ntype CounterReadingOnSubmission = {\n  counterId: string\n  direction: "feed-in" | "feed-out"\n  unit?: string\n  value: number\n}\n```\n\n### `SubmissionMeterReading`\n\n```ts\ntype SubmissionMeterReading = {\n  meterId: string\n  readings?: Array<{\n    counterId: string\n    direction: "feed-in" | "feed-out"\n    unit?: string\n    value: number\n  }>\n  readingValue?: number\n  readingDate?: string\n  readBy?: string\n  reason?: "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n  maloId?: string\n  obisNumber?: string\n  readingUnit?: string\n  meterType?: "one_tariff" | "two_tariff" | "bi_directional"\n  feedInValue?: number\n  feedOutValue?: number\n  htValue?: number\n  ntValue?: number\n}\n```\n\n### `Unit`\n\n```ts\ntype Unit = string\n```\n\n### `Source`\n\n```ts\ntype Source = "ECP" | "ERP" | "360" | "journey-submission"\n```\n\n### `ActionLabel`\n\n```ts\ntype ActionLabel = {\n  en?: string\n  de?: string\n}\n```\n\n### `Rule`\n\n```ts\ntype Rule = {\n  entity?: string\n  attribute?: string\n  attribute_value?: string\n}\n```\n\n### `JourneyActions`\n\n```ts\ntype JourneyActions = {\n  journey_id?: string\n  action_label?: {\n    en?: string\n    de?: string\n  }\n  slug?: string\n  rules?: Array<{\n    entity?: string\n    attribute?: string\n    attribute_value?: string\n  }>\n}\n```\n\n### `ReadingWithMeter`\n\n```ts\ntype ReadingWithMeter = {\n  ma_lo_id?: string\n  meter_id?: string\n  obis_number?: string\n  unit?: string\n  direction?: "feed-in" | "feed-out"\n  tariff_type?: "ht" | "nt"\n  value?: number\n  read_by?: string\n  reason?: "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment"\n  timestamp?: string\n  source?: "ECP" | "ERP" | "360" | "journey-submission"\n}\n```\n\n### `ActivityId`\n\nSee https://github.com/ulid/spec\n\n```ts\ntype ActivityId = string // ulid\n```\n';
+export {
+  metering_default as default
+};