@epilot/sdk 2.1.7 → 2.1.9

package/dist/kanban-PMG5TXE5.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- [`GroupBy`](#groupby)\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      group_by: {\n        field: \'context_entity\'\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    "group_by": {\n      "field": "context_entity"\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    "group_by": {\n      "field": "context_entity"\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      group_by: {\n        field: \'context_entity\'\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    "group_by": {\n      "field": "context_entity"\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    "group_by": {\n      "field": "context_entity"\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    group_by: {\n      field: \'context_entity\'\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    group_by?: {\n      field: { ... }\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### `GroupBy`\n\nDefines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set.\n\n```ts\ntype GroupBy = {\n  field: "context_entity" | "phase"\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, grouping, 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  group_by?: {\n    field: "context_entity" | "phase"\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/{kanban.d-CtSt3uX2.d.ts → kanban.d-B99GucT_.d.cts}

@@ -43,6 +43,7 @@ declare namespace Components {
                 };
                 board_filter?: /* A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR). */ BoardFilter;
                 sorting?: /* Defines how query results should be sorted. Specify a field name and sort direction. */ Sorting;
+                group_by?: /* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set. */ GroupBy;
                 /**
                  * example:
                  * task 1
@@ -145,7 +146,7 @@ declare namespace Components {
          */
         export type 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";
         /**
-         * Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, and offset-based pagination.
+         * Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination.
          */
         export interface FlowsQueryRequest {
             /**
@@ -156,6 +157,10 @@ declare namespace Components {
              * Sort the results by a specific field and direction.
              */
             sorting?: /* Defines how query results should be sorted. Specify a field name and sort direction. */ Sorting;
+            /**
+             * Group tasks by a shared property within each swimlane. Grouped tasks are returned adjacently in the result set.
+             */
+            group_by?: /* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set. */ GroupBy;
             /**
              * Zero-based offset for pagination. Use with `size` to paginate through results.
              * example:
@@ -205,6 +210,15 @@ declare namespace Components {
              */
             total_pages?: number;
         }
+        /**
+         * Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set.
+         */
+        export interface GroupBy {
+            /**
+             * Property to group tasks by within each swimlane
+             */
+            field: "context_entity" | "phase";
+        }
         /**
          * Defines how query results should be sorted. Specify a field name and sort direction.
          */
@@ -283,7 +297,7 @@ declare namespace Paths {
         }
     }
     namespace ExecuteFlowsQuery {
-        export type RequestBody = /* Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, and offset-based pagination. */ Components.Schemas.FlowsQueryRequest;
+        export type RequestBody = /* Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination. */ Components.Schemas.FlowsQueryRequest;
         namespace Responses {
             export type $200 = /* Paginated result set returned from a Flows query. Each item in `results` is a workflow task record with dynamic fields depending on the dataset configuration. */ Components.Schemas.FlowsQueryResult;
             export type $400 = /* Standard error response */ Components.Schemas.Error;
@@ -738,8 +752,9 @@ type FilterItem = Components.Schemas.FilterItem;
 type FilterOperator = Components.Schemas.FilterOperator;
 type FlowsQueryRequest = Components.Schemas.FlowsQueryRequest;
 type FlowsQueryResult = Components.Schemas.FlowsQueryResult;
+type GroupBy = Components.Schemas.GroupBy;
 type Sorting = Components.Schemas.Sorting;
 type Swimlane = Components.Schemas.Swimlane;
 type ValueType = Components.Schemas.ValueType;
 
-export { type Board as B, type Client as C, type DynamicDateValue as D, type Error as E, type FilterGroup as F, type OperationMethods as O, Paths as P, type Sorting as S, type ValueType as V, Components as a, type PathsDictionary as b, type BoardFilter as c, type BoardSummary as d, type FilterItem as e, type FilterOperator as f, type FlowsQueryRequest as g, type FlowsQueryResult as h, type Swimlane as i };
+export { type Board as B, type Client as C, type DynamicDateValue as D, type Error as E, type FilterGroup as F, type GroupBy as G, type OperationMethods as O, Paths as P, type Sorting as S, type ValueType as V, Components as a, type PathsDictionary as b, type BoardFilter as c, type BoardSummary as d, type FilterItem as e, type FilterOperator as f, type FlowsQueryRequest as g, type FlowsQueryResult as h, type Swimlane as i };

package/dist/{kanban.d-CtSt3uX2.d.cts → kanban.d-B99GucT_.d.ts}

@@ -43,6 +43,7 @@ declare namespace Components {
                 };
                 board_filter?: /* A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR). */ BoardFilter;
                 sorting?: /* Defines how query results should be sorted. Specify a field name and sort direction. */ Sorting;
+                group_by?: /* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set. */ GroupBy;
                 /**
                  * example:
                  * task 1
@@ -145,7 +146,7 @@ declare namespace Components {
          */
         export type 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";
         /**
-         * Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, and offset-based pagination.
+         * Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination.
          */
         export interface FlowsQueryRequest {
             /**
@@ -156,6 +157,10 @@ declare namespace Components {
              * Sort the results by a specific field and direction.
              */
             sorting?: /* Defines how query results should be sorted. Specify a field name and sort direction. */ Sorting;
+            /**
+             * Group tasks by a shared property within each swimlane. Grouped tasks are returned adjacently in the result set.
+             */
+            group_by?: /* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set. */ GroupBy;
             /**
              * Zero-based offset for pagination. Use with `size` to paginate through results.
              * example:
@@ -205,6 +210,15 @@ declare namespace Components {
              */
             total_pages?: number;
         }
+        /**
+         * Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set.
+         */
+        export interface GroupBy {
+            /**
+             * Property to group tasks by within each swimlane
+             */
+            field: "context_entity" | "phase";
+        }
         /**
          * Defines how query results should be sorted. Specify a field name and sort direction.
          */
@@ -283,7 +297,7 @@ declare namespace Paths {
         }
     }
     namespace ExecuteFlowsQuery {
-        export type RequestBody = /* Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, and offset-based pagination. */ Components.Schemas.FlowsQueryRequest;
+        export type RequestBody = /* Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination. */ Components.Schemas.FlowsQueryRequest;
         namespace Responses {
             export type $200 = /* Paginated result set returned from a Flows query. Each item in `results` is a workflow task record with dynamic fields depending on the dataset configuration. */ Components.Schemas.FlowsQueryResult;
             export type $400 = /* Standard error response */ Components.Schemas.Error;
@@ -738,8 +752,9 @@ type FilterItem = Components.Schemas.FilterItem;
 type FilterOperator = Components.Schemas.FilterOperator;
 type FlowsQueryRequest = Components.Schemas.FlowsQueryRequest;
 type FlowsQueryResult = Components.Schemas.FlowsQueryResult;
+type GroupBy = Components.Schemas.GroupBy;
 type Sorting = Components.Schemas.Sorting;
 type Swimlane = Components.Schemas.Swimlane;
 type ValueType = Components.Schemas.ValueType;
 
-export { type Board as B, type Client as C, type DynamicDateValue as D, type Error as E, type FilterGroup as F, type OperationMethods as O, Paths as P, type Sorting as S, type ValueType as V, Components as a, type PathsDictionary as b, type BoardFilter as c, type BoardSummary as d, type FilterItem as e, type FilterOperator as f, type FlowsQueryRequest as g, type FlowsQueryResult as h, type Swimlane as i };
+export { type Board as B, type Client as C, type DynamicDateValue as D, type Error as E, type FilterGroup as F, type GroupBy as G, type OperationMethods as O, Paths as P, type Sorting as S, type ValueType as V, Components as a, type PathsDictionary as b, type BoardFilter as c, type BoardSummary as d, type FilterItem as e, type FilterOperator as f, type FlowsQueryRequest as g, type FlowsQueryResult as h, type Swimlane as i };

package/docs/customer-portal.md

@@ -39,6 +39,9 @@ const { data } = await customerPortalClient.upsertPortal(...)
 - [`getEmailTemplates`](#getemailtemplates)
 - [`upsertEmailTemplatesByPortalId`](#upsertemailtemplatesbyportalid)
 - [`getEmailTemplatesByPortalId`](#getemailtemplatesbyportalid)
+- [`getPortalWidgetsV3`](#getportalwidgetsv3)
+- [`upsertPortalWidgetV3`](#upsertportalwidgetv3)
+- [`savePortalFilesV3`](#saveportalfilesv3)
 - [`replaceECPTemplateVariables`](#replaceecptemplatevariables)
 - [`extraPermissionAttributes`](#extrapermissionattributes)
 - [`validateCaaRecords`](#validatecaarecords)
@@ -714,7 +717,10 @@ const { data } = await client.createUser(
 
 ### `createUserV3`
 
-Registers a portal user with portal id
+Registers a portal user.
+Supports two identification methods:
+1. Using portal_id
+2. Using domain
 
 `POST /v3/portal/public/user`
 
@@ -722,6 +728,7 @@ Registers a portal user with portal id
 const { data } = await client.createUserV3(
   {
     portal_id: 'example',
+    domain: 'example',
   },
   {
     email: 'testemail921@yopmail.com',
@@ -2939,6 +2946,201 @@ const { data } = await client.getEmailTemplatesByPortalId({
 
 ---
 
+### `getPortalWidgetsV3`
+
+Retrieves the widgets of a portal by portal_id.
+
+`GET /v3/portal/widgets`
+
+```ts
+const { data } = await client.getPortalWidgetsV3({
+  portal_id: 'example',
+  contract_id: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "widgets": [
+    {
+      "id": "string",
+      "type": "ACTION_WIDGET",
+      "listIndex": 0,
+      "headline": {
+        "en": "string",
+        "de": "string"
+      },
+      "subHeadline": {
+        "en": "string",
+        "de": "string"
+      },
+      "schema": "string"
+    },
+    {
+      "id": "string",
+      "type": "ACTION_WIDGET",
+      "listIndex": 0,
+      "headline": {
+        "en": "string",
+        "de": "string"
+      },
+      "subHeadline": {
+        "en": "string",
+        "de": "string"
+      },
+      "content": "string"
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
+### `upsertPortalWidgetV3`
+
+Upsert widget for a portal by portal_id.
+
+`POST /v3/portal/widgets`
+
+```ts
+const { data } = await client.upsertPortalWidgetV3(
+  {
+    portal_id: 'example',
+  },
+  {
+    widgets: [
+      {
+        id: 'string',
+        type: 'ACTION_WIDGET',
+        listIndex: 0,
+        headline: {
+          en: 'string',
+          de: 'string'
+        },
+        subHeadline: {
+          en: 'string',
+          de: 'string'
+        },
+        schema: 'string'
+      },
+      {
+        id: 'string',
+        type: 'ACTION_WIDGET',
+        listIndex: 0,
+        headline: {
+          en: 'string',
+          de: 'string'
+        },
+        subHeadline: {
+          en: 'string',
+          de: 'string'
+        },
+        content: 'string'
+      },
+      /* ... 8 more */
+    ]
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "widgets": [
+    {
+      "id": "string",
+      "type": "ACTION_WIDGET",
+      "listIndex": 0,
+      "headline": {
+        "en": "string",
+        "de": "string"
+      },
+      "subHeadline": {
+        "en": "string",
+        "de": "string"
+      },
+      "schema": "string"
+    },
+    {
+      "id": "string",
+      "type": "ACTION_WIDGET",
+      "listIndex": 0,
+      "headline": {
+        "en": "string",
+        "de": "string"
+      },
+      "subHeadline": {
+        "en": "string",
+        "de": "string"
+      },
+      "content": "string"
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
+### `savePortalFilesV3`
+
+Add files to portal by portal_id
+
+`POST /v3/portal/portal/files`
+
+```ts
+const { data } = await client.savePortalFilesV3(
+  {
+    portal_id: 'example',
+  },
+  {
+    origin: 'string',
+    files: [
+      {
+        filename: 12345,
+        file_type: 'orderRightTeaser',
+        _tags: 12345,
+        s3ref: {
+          bucket: 12345,
+          key: 12345
+        }
+      }
+    ]
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "createdFiles": [
+    {
+      "_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
+      "_title": "Example Entity",
+      "_org": "123",
+      "_tags": ["example", "mock"],
+      "_created_at": "2021-02-09T12:41:43.662Z",
+      "_updated_at": "2021-02-09T12:41:43.662Z",
+      "_schema": "file"
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
 ### `replaceECPTemplateVariables`
 
 Replaces the template variables of a portal
@@ -3398,6 +3600,9 @@ const { data } = await client.checkContactExists(
 ### `checkContactExistsV3`
 
 True if contact with given identifiers exists.
+Supports two identification methods:
+1. Using portal_id
+2. Using domain
 
 `POST /v3/portal/public/contact/exists`
 
@@ -3405,6 +3610,7 @@ True if contact with given identifiers exists.
 const { data } = await client.checkContactExistsV3(
   {
     portal_id: 'example',
+    domain: 'example',
   },
   {
     org_id: 728,
@@ -3713,7 +3919,10 @@ const { data } = await client.userExists({
 
 ### `userExistsV3`
 
-Checks whether a user exists in the portal
+Checks whether a user exists in the portal.
+Supports two identification methods:
+1. Using org_id + portal_id
+2. Using domain
 
 `GET /v3/portal/public/user/exists`
 
@@ -3722,6 +3931,7 @@ const { data } = await client.userExistsV3({
   email: 'example',
   org_id: 'example',
   portal_id: 'example',
+  domain: 'example',
 })
 ```
 
@@ -4483,7 +4693,8 @@ const { data } = await client.loginToPortalAsUser(
   {
     email: 'portal-customer@email.com',
     origin: 'string',
-    portal_id: 'string'
+    portal_id: 'string',
+    domain: 'string'
   },
 )
 ```
@@ -4530,7 +4741,10 @@ const { data } = await client.triggerEntityAccessEvent({
 
 ### `triggerEntityAccessEventV3`
 
-Trigger entity access event for a portal user
+Trigger entity access event for a portal user.
+Supports two identification methods:
+1. Using portal_id
+2. Using domain
 
 `POST /v3/portal/entity/{schema}/access`
 
@@ -4539,6 +4753,7 @@ const { data } = await client.triggerEntityAccessEventV3({
   schema: 'example',
   entity_id: 'example',
   portal_id: 'example',
+  domain: 'example',
 })
 ```
 
@@ -5078,6 +5293,7 @@ const { data } = await client.ssoLoginV3(
   {
     portal_id: 'example',
     org_id: 'example',
+    domain: 'example',
     contact_id: 'example',
   },
   {
@@ -5200,7 +5416,8 @@ const { data } = await client.getPortalPage({
   "is_entry_route": false,
   "is_deleted": false,
   "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
-  "last_modified_at": "2021-02-09T12:41:43.662Z"
+  "last_modified_at": "2021-02-09T12:41:43.662Z",
+  "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
 }
 ```
 
@@ -5280,7 +5497,8 @@ const { data } = await client.updatePortalPage(
   "is_entry_route": false,
   "is_deleted": false,
   "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
-  "last_modified_at": "2021-02-09T12:41:43.662Z"
+  "last_modified_at": "2021-02-09T12:41:43.662Z",
+  "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
 }
 ```
 
@@ -5350,7 +5568,8 @@ const { data } = await client.getPortalPages({
     "is_entry_route": false,
     "is_deleted": false,
     "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
-    "last_modified_at": "2021-02-09T12:41:43.662Z"
+    "last_modified_at": "2021-02-09T12:41:43.662Z",
+    "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
   }
 ]
 ```
@@ -5431,7 +5650,8 @@ const { data } = await client.createPortalPage(
   "is_entry_route": false,
   "is_deleted": false,
   "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
-  "last_modified_at": "2021-02-09T12:41:43.662Z"
+  "last_modified_at": "2021-02-09T12:41:43.662Z",
+  "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
 }
 ```
 
@@ -5485,7 +5705,8 @@ const { data } = await client.getPublicPages({
     "is_entry_route": false,
     "is_deleted": false,
     "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
-    "last_modified_at": "2021-02-09T12:41:43.662Z"
+    "last_modified_at": "2021-02-09T12:41:43.662Z",
+    "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
   }
 ]
 ```
@@ -5532,7 +5753,8 @@ const { data } = await client.interpolatePortalPages(
         is_entry_route: false,
         is_deleted: false,
         id: 'c495fef9-eeca-4019-a989-8390dcd9825b',
-        last_modified_at: '2021-02-09T12:41:43.662Z'
+        last_modified_at: '2021-02-09T12:41:43.662Z',
+        portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c'
       }
     ],
     context_entities: [
@@ -5578,7 +5800,8 @@ const { data } = await client.interpolatePortalPages(
     "is_entry_route": false,
     "is_deleted": false,
     "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
-    "last_modified_at": "2021-02-09T12:41:43.662Z"
+    "last_modified_at": "2021-02-09T12:41:43.662Z",
+    "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
   }
 ]
 ```
@@ -5629,7 +5852,8 @@ const { data } = await client.getDefaultPages()
     "is_entry_route": false,
     "is_deleted": false,
     "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
-    "last_modified_at": "2021-02-09T12:41:43.662Z"
+    "last_modified_at": "2021-02-09T12:41:43.662Z",
+    "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
   }
 ]
 ```
@@ -6442,7 +6666,8 @@ const { data } = await client.createPortalConfig(
       "is_entry_route": false,
       "is_deleted": false,
       "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
-      "last_modified_at": "2021-02-09T12:41:43.662Z"
+      "last_modified_at": "2021-02-09T12:41:43.662Z",
+      "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
     }
   ]
 }
@@ -6680,7 +6905,8 @@ const { data } = await client.getPortalConfigV3({
       "is_entry_route": false,
       "is_deleted": false,
       "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
-      "last_modified_at": "2021-02-09T12:41:43.662Z"
+      "last_modified_at": "2021-02-09T12:41:43.662Z",
+      "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
     }
   ]
 }
@@ -6914,7 +7140,8 @@ const { data } = await client.putPortalConfig(
         is_entry_route: false,
         is_deleted: false,
         id: 'c495fef9-eeca-4019-a989-8390dcd9825b',
-        last_modified_at: '2021-02-09T12:41:43.662Z'
+        last_modified_at: '2021-02-09T12:41:43.662Z',
+        portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c'
       }
     ]
   },
@@ -7137,7 +7364,8 @@ const { data } = await client.putPortalConfig(
       "is_entry_route": false,
       "is_deleted": false,
       "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
-      "last_modified_at": "2021-02-09T12:41:43.662Z"
+      "last_modified_at": "2021-02-09T12:41:43.662Z",
+      "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
     }
   ]
 }
@@ -10258,6 +10486,7 @@ type Page = {
   is_deleted?: boolean
   id?: string // uuid
   last_modified_at?: string // date-time
+  portal_id?: string
 }
 ```