@epilot/sdk 2.4.4 → 2.6.0

package/dist/notes-K2IIFCX3.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/notes.json
+var notes_default = '# Notes API\n\n- **Base URL:** `https://notes.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/notes](https://docs.epilot.io/api/notes)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.notes.createNote(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/notes\'\n\nconst notesClient = getClient()\nauthorize(notesClient, () => \'<token>\')\nconst { data } = await notesClient.createNote(...)\n```\n\n## Operations\n\n**Notes**\n- [`createNote`](#createnote)\n- [`getNote`](#getnote)\n- [`patchNote`](#patchnote)\n- [`updateNote`](#updatenote)\n- [`deleteNote`](#deletenote)\n- [`searchNotesByContext`](#searchnotesbycontext)\n- [`getNoteContexts`](#getnotecontexts)\n\n**Pinning**\n- [`pinNote`](#pinnote)\n\n**Reactions**\n- [`addNoteReaction`](#addnotereaction)\n- [`removeNoteReaction`](#removenotereaction)\n- [`toggleNoteReactions`](#togglenotereactions)\n\n**Schemas**\n- [`NotePostRequestBody`](#notepostrequestbody)\n- [`ContextType`](#contexttype)\n- [`NoteEntity`](#noteentity)\n- [`Entity`](#entity)\n- [`CreatedByType`](#createdbytype)\n- [`NoteGetRequestResponse`](#notegetrequestresponse)\n- [`NotePatchRequestBody`](#notepatchrequestbody)\n- [`NonHydratedNoteEntity`](#nonhydratednoteentity)\n- [`NoteEntityParent`](#noteentityparent)\n- [`NotePutRequestBody`](#noteputrequestbody)\n- [`NoteSearchByContextRequestBody`](#notesearchbycontextrequestbody)\n- [`NotesSearchRequestResponse`](#notessearchrequestresponse)\n- [`NoteContexts`](#notecontexts)\n- [`WorkflowExecution`](#workflowexecution)\n- [`ReactionRequest`](#reactionrequest)\n- [`ToggleReactionsRequest`](#togglereactionsrequest)\n\n### `createNote`\n\nCreates a new Note entry\n\n`POST /v1/note`\n\n```ts\nconst { data } = await client.createNote(\n  null,\n  {\n    _tags: [\'string\'],\n    type: \'string\',\n    entity_id: \'string\',\n    parent_id: \'string\',\n    contexts: [\n      {\n        type: \'workflow_execution\',\n        id: \'string\'\n      }\n    ],\n    additional_contexts: [\n      {\n        type: \'workflow_execution\',\n        id: \'string\'\n      }\n    ],\n    content: \'string\',\n    attachments: [\'string\'],\n    read_by: [\'string\']\n  },\n)\n```\n\n---\n\n### `getNote`\n\nRetrieves a single Note entry based on it\'s Entity ID\n\n`GET /v1/note/{id}`\n\n```ts\nconst { data } = await client.getNote({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  hydrate: true,\n})\n```\n\n---\n\n### `patchNote`\n\nUpdates an existing Note entry\n\n`PATCH /v1/note/{id}`\n\n```ts\nconst { data } = await client.patchNote({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `updateNote`\n\nUpdates an existing Note entry\n\n`PUT /v1/note/{id}`\n\n```ts\nconst { data } = await client.updateNote(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    _id: \'string\',\n    _org: \'string\',\n    _schema: \'string\',\n    _created_at: \'1970-01-01T00:00:00.000Z\',\n    _updated_at: \'1970-01-01T00:00:00.000Z\',\n    _created_by: \'string\',\n    _tags: [\'string\'],\n    _acl: {},\n    _owners: [\n      {\n        org_id: \'string\',\n        user_id: \'string\'\n      }\n    ],\n    type: \'string\',\n    context_entities: {\n      $relation: [\n        {\n          entity_id: \'string\'\n        }\n      ]\n    },\n    parent: {\n      $relation: [\n        {\n          entity_id: \'string\'\n        }\n      ]\n    },\n    attachments: {\n      $relation: [\n        {\n          entity_id: \'string\'\n        }\n      ]\n    },\n    content: \'string\',\n    contexts: [\n      {\n        type: \'workflow_execution\',\n        id: \'string\'\n      }\n    ],\n    pinned_at: \'1970-01-01T00:00:00.000Z\',\n    edited_at: \'1970-01-01T00:00:00.000Z\',\n    created_by: [\n      {\n        type: \'user\',\n        user_id: \'string\',\n        display_name: \'string\',\n        org_id: \'string\',\n        email: \'string\',\n        phone: \'string\'\n      }\n    ],\n    read_by: [\'string\'],\n    reactions: {}\n  },\n)\n```\n\n---\n\n### `deleteNote`\n\nDeletes a single Note entry based on it\'s Entity ID\n\n`DELETE /v1/note/{id}`\n\n```ts\nconst { data } = await client.deleteNote({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `searchNotesByContext`\n\nSearch for a paginated list of Notes based on one or more contexts\n\n`POST /v1/notes:search`\n\n```ts\nconst { data } = await client.searchNotesByContext(\n  null,\n  {\n    contexts: [\n      {\n        type: \'workflow_execution\',\n        id: \'string\'\n      }\n    ],\n    include_related_schemas: [\'string\'],\n    from: 0,\n    size: 10\n  },\n)\n```\n\n---\n\n### `pinNote`\n\nPins a single Note entry based on it\'s Entity ID\n\n`POST /v1/note/{id}/pin`\n\n```ts\nconst { data } = await client.pinNote({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getNoteContexts`\n\nGets all the Entity and non-Entity records the Note is contextually attached to\n\n`GET /v1/note/{id}/context`\n\n```ts\nconst { data } = await client.getNoteContexts({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "type": "workflow_execution",\n    "context": {\n      "_id": "string",\n      "_org": "string",\n      "_schema": "string",\n      "_created_at": "1970-01-01T00:00:00.000Z",\n      "_updated_at": "1970-01-01T00:00:00.000Z",\n      "_created_by": "string",\n      "_tags": ["string"],\n      "_acl": {},\n      "_owners": [\n        {\n          "org_id": "string",\n          "user_id": "string"\n        }\n      ],\n      "type": "string"\n    }\n  }\n]\n```\n\n</details>\n\n---\n\n### `addNoteReaction`\n\nAdds an emoji reaction to a note\n\n`POST /v1/note/{id}/reaction`\n\n```ts\nconst { data } = await client.addNoteReaction(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    emoji: \'thumbs-up\'\n  },\n)\n```\n\n---\n\n### `removeNoteReaction`\n\nRemoves an emoji reaction from a note\n\n`DELETE /v1/note/{id}/reaction/{emoji_shortcode}`\n\n```ts\nconst { data } = await client.removeNoteReaction({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  emoji_shortcode: \'example\',\n})\n```\n\n---\n\n### `toggleNoteReactions`\n\nToggles multiple emoji reactions on a note. If a user has already reacted with an emoji, it removes the reaction. If a user hasn\'t reacted with an emoji, it adds the reaction.\n\n`POST /v1/note/{id}/reactions/toggle`\n\n```ts\nconst { data } = await client.toggleNoteReactions(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    emojis: [\'thumbs-up\', \'heart\']\n  },\n)\n```\n\n---\n\n## Schemas\n\n### `NotePostRequestBody`\n\n```ts\ntype NotePostRequestBody = {\n  _tags?: string[]\n  type?: string\n  entity_id?: string\n  parent_id?: string\n  contexts?: Array<{\n    type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n    id: string\n  }>\n  additional_contexts?: Array<{\n    type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n    id: string\n  }>\n  content?: string\n  attachments?: string[]\n  read_by?: string[]\n}\n```\n\n### `ContextType`\n\n```ts\ntype ContextType = "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n```\n\n### `NoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place.\n\n```ts\ntype NoteEntity = {\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}\n```\n\n### `Entity`\n\nBase Entity schema\n\n```ts\ntype Entity = {\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}\n```\n\n### `CreatedByType`\n\n```ts\ntype CreatedByType = "user" | "group"\n```\n\n### `NoteGetRequestResponse`\n\n```ts\ntype NoteGetRequestResponse = {\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}\n```\n\n### `NotePatchRequestBody`\n\n```ts\ntype NotePatchRequestBody = {\n  _tags?: string[]\n  type?: string\n  attachments?: {\n    $relation?: Array<{\n      entity_id: { ... }\n    }>\n  }\n  comments?: Array<{\n    _id: string\n    _org?: string\n    _schema?: string\n    _created_at?: string // date-time\n    _updated_at?: string // date-time\n    _created_by?: string | number\n    _tags?: string[]\n    _acl?: Record<string, string[]>\n    _owners?: Array<{\n      org_id: { ... }\n      user_id: { ... }\n    }>\n    type?: string\n  }>\n  content?: string\n  contexts?: Array<{\n    type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n    id: string\n  }>\n  pinned_at?: string // date-time\n  edited_at?: string // date-time\n  created_by?: Array<{\n    type: "user" | "group"\n    user_id?: string\n    display_name?: string\n    org_id?: string\n    email?: string\n    phone?: string\n  }>\n  read_by?: string[]\n  reactions?: Record<string, string[]>\n}\n```\n\n### `NonHydratedNoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are not hydrated in place.\n\n```ts\ntype NonHydratedNoteEntity = {\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}\n```\n\n### `NoteEntityParent`\n\nThe Note\'s parent Note\n\n```ts\ntype NoteEntityParent = {\n  $relation?: Array<{\n    entity_id: string\n  }>\n}\n```\n\n### `NotePutRequestBody`\n\n```ts\ntype NotePutRequestBody = {\n  _id?: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n  context_entities?: {\n    $relation: Array<{\n      entity_id: { ... }\n    }>\n  }\n  parent?: {\n    $relation?: Array<{\n      entity_id: { ... }\n    }>\n  }\n  attachments?: {\n    $relation?: Array<{\n      entity_id: { ... }\n    }>\n  }\n  content?: string\n  contexts?: Array<{\n    type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n    id: string\n  }>\n  pinned_at?: string // date-time\n  edited_at?: string // date-time\n  created_by?: Array<{\n    type: "user" | "group"\n    user_id?: string\n    display_name?: string\n    org_id?: string\n    email?: string\n    phone?: string\n  }>\n  read_by?: string[]\n  reactions?: Record<string, string[]>\n}\n```\n\n### `NoteSearchByContextRequestBody`\n\n```ts\ntype NoteSearchByContextRequestBody = {\n  contexts: Array<{\n    type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n    id: string\n  }>\n  include_related_schemas?: string[]\n  from?: number\n  size?: number\n}\n```\n\n### `NotesSearchRequestResponse`\n\n```ts\ntype NotesSearchRequestResponse = {\n  hits?: number\n  results: Array<{\n    _id: string\n    _org?: string\n    _schema?: string\n    _created_at?: string // date-time\n    _updated_at?: string // date-time\n    _created_by?: string | number\n    _tags?: string[]\n    _acl?: Record<string, string[]>\n    _owners?: Array<{\n      org_id: { ... }\n      user_id: { ... }\n    }>\n    type?: string\n  }>\n}\n```\n\n### `NoteContexts`\n\nList of resolved Entity and non-Entity contexts attached to a given Note.\n\n```ts\ntype NoteContexts = {\n  type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n  context: {\n    _id: string\n    _org?: string\n    _schema?: string\n    _created_at?: string // date-time\n    _updated_at?: string // date-time\n    _created_by?: string | number\n    _tags?: string[]\n    _acl?: Record<string, string[]>\n    _owners?: Array<{\n      org_id: { ... }\n      user_id: { ... }\n    }>\n    type?: string\n  } | {\n    id: string\n    definitionId: string\n    orgId: string\n    name: string\n  }\n}\n```\n\n### `WorkflowExecution`\n\nBase metadata for a Workflow Execution. This is a lightweight representation of a Workflow Execution, and does not contain all it\'s data\n\n```ts\ntype WorkflowExecution = {\n  id: string\n  definitionId: string\n  orgId: string\n  name: string\n}\n```\n\n### `ReactionRequest`\n\n```ts\ntype ReactionRequest = {\n  emoji: string\n}\n```\n\n### `ToggleReactionsRequest`\n\n```ts\ntype ToggleReactionsRequest = {\n  emojis: string[]\n}\n```\n';
+
+
+exports.default = notes_default;

package/dist/notes-Q7JGS7O3.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/notes.json
+var notes_default = '# Notes API\n\n- **Base URL:** `https://notes.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/notes](https://docs.epilot.io/api/notes)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.notes.createNote(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/notes\'\n\nconst notesClient = getClient()\nauthorize(notesClient, () => \'<token>\')\nconst { data } = await notesClient.createNote(...)\n```\n\n## Operations\n\n**Notes**\n- [`createNote`](#createnote)\n- [`getNote`](#getnote)\n- [`patchNote`](#patchnote)\n- [`updateNote`](#updatenote)\n- [`deleteNote`](#deletenote)\n- [`searchNotesByContext`](#searchnotesbycontext)\n- [`getNoteContexts`](#getnotecontexts)\n\n**Pinning**\n- [`pinNote`](#pinnote)\n\n**Reactions**\n- [`addNoteReaction`](#addnotereaction)\n- [`removeNoteReaction`](#removenotereaction)\n- [`toggleNoteReactions`](#togglenotereactions)\n\n**Schemas**\n- [`NotePostRequestBody`](#notepostrequestbody)\n- [`ContextType`](#contexttype)\n- [`NoteEntity`](#noteentity)\n- [`Entity`](#entity)\n- [`CreatedByType`](#createdbytype)\n- [`NoteGetRequestResponse`](#notegetrequestresponse)\n- [`NotePatchRequestBody`](#notepatchrequestbody)\n- [`NonHydratedNoteEntity`](#nonhydratednoteentity)\n- [`NoteEntityParent`](#noteentityparent)\n- [`NotePutRequestBody`](#noteputrequestbody)\n- [`NoteSearchByContextRequestBody`](#notesearchbycontextrequestbody)\n- [`NotesSearchRequestResponse`](#notessearchrequestresponse)\n- [`NoteContexts`](#notecontexts)\n- [`WorkflowExecution`](#workflowexecution)\n- [`ReactionRequest`](#reactionrequest)\n- [`ToggleReactionsRequest`](#togglereactionsrequest)\n\n### `createNote`\n\nCreates a new Note entry\n\n`POST /v1/note`\n\n```ts\nconst { data } = await client.createNote(\n  null,\n  {\n    _tags: [\'string\'],\n    type: \'string\',\n    entity_id: \'string\',\n    parent_id: \'string\',\n    contexts: [\n      {\n        type: \'workflow_execution\',\n        id: \'string\'\n      }\n    ],\n    additional_contexts: [\n      {\n        type: \'workflow_execution\',\n        id: \'string\'\n      }\n    ],\n    content: \'string\',\n    attachments: [\'string\'],\n    read_by: [\'string\']\n  },\n)\n```\n\n---\n\n### `getNote`\n\nRetrieves a single Note entry based on it\'s Entity ID\n\n`GET /v1/note/{id}`\n\n```ts\nconst { data } = await client.getNote({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  hydrate: true,\n})\n```\n\n---\n\n### `patchNote`\n\nUpdates an existing Note entry\n\n`PATCH /v1/note/{id}`\n\n```ts\nconst { data } = await client.patchNote({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `updateNote`\n\nUpdates an existing Note entry\n\n`PUT /v1/note/{id}`\n\n```ts\nconst { data } = await client.updateNote(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    _id: \'string\',\n    _org: \'string\',\n    _schema: \'string\',\n    _created_at: \'1970-01-01T00:00:00.000Z\',\n    _updated_at: \'1970-01-01T00:00:00.000Z\',\n    _created_by: \'string\',\n    _tags: [\'string\'],\n    _acl: {},\n    _owners: [\n      {\n        org_id: \'string\',\n        user_id: \'string\'\n      }\n    ],\n    type: \'string\',\n    context_entities: {\n      $relation: [\n        {\n          entity_id: \'string\'\n        }\n      ]\n    },\n    parent: {\n      $relation: [\n        {\n          entity_id: \'string\'\n        }\n      ]\n    },\n    attachments: {\n      $relation: [\n        {\n          entity_id: \'string\'\n        }\n      ]\n    },\n    content: \'string\',\n    contexts: [\n      {\n        type: \'workflow_execution\',\n        id: \'string\'\n      }\n    ],\n    pinned_at: \'1970-01-01T00:00:00.000Z\',\n    edited_at: \'1970-01-01T00:00:00.000Z\',\n    created_by: [\n      {\n        type: \'user\',\n        user_id: \'string\',\n        display_name: \'string\',\n        org_id: \'string\',\n        email: \'string\',\n        phone: \'string\'\n      }\n    ],\n    read_by: [\'string\'],\n    reactions: {}\n  },\n)\n```\n\n---\n\n### `deleteNote`\n\nDeletes a single Note entry based on it\'s Entity ID\n\n`DELETE /v1/note/{id}`\n\n```ts\nconst { data } = await client.deleteNote({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `searchNotesByContext`\n\nSearch for a paginated list of Notes based on one or more contexts\n\n`POST /v1/notes:search`\n\n```ts\nconst { data } = await client.searchNotesByContext(\n  null,\n  {\n    contexts: [\n      {\n        type: \'workflow_execution\',\n        id: \'string\'\n      }\n    ],\n    include_related_schemas: [\'string\'],\n    from: 0,\n    size: 10\n  },\n)\n```\n\n---\n\n### `pinNote`\n\nPins a single Note entry based on it\'s Entity ID\n\n`POST /v1/note/{id}/pin`\n\n```ts\nconst { data } = await client.pinNote({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getNoteContexts`\n\nGets all the Entity and non-Entity records the Note is contextually attached to\n\n`GET /v1/note/{id}/context`\n\n```ts\nconst { data } = await client.getNoteContexts({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "type": "workflow_execution",\n    "context": {\n      "_id": "string",\n      "_org": "string",\n      "_schema": "string",\n      "_created_at": "1970-01-01T00:00:00.000Z",\n      "_updated_at": "1970-01-01T00:00:00.000Z",\n      "_created_by": "string",\n      "_tags": ["string"],\n      "_acl": {},\n      "_owners": [\n        {\n          "org_id": "string",\n          "user_id": "string"\n        }\n      ],\n      "type": "string"\n    }\n  }\n]\n```\n\n</details>\n\n---\n\n### `addNoteReaction`\n\nAdds an emoji reaction to a note\n\n`POST /v1/note/{id}/reaction`\n\n```ts\nconst { data } = await client.addNoteReaction(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    emoji: \'thumbs-up\'\n  },\n)\n```\n\n---\n\n### `removeNoteReaction`\n\nRemoves an emoji reaction from a note\n\n`DELETE /v1/note/{id}/reaction/{emoji_shortcode}`\n\n```ts\nconst { data } = await client.removeNoteReaction({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  emoji_shortcode: \'example\',\n})\n```\n\n---\n\n### `toggleNoteReactions`\n\nToggles multiple emoji reactions on a note. If a user has already reacted with an emoji, it removes the reaction. If a user hasn\'t reacted with an emoji, it adds the reaction.\n\n`POST /v1/note/{id}/reactions/toggle`\n\n```ts\nconst { data } = await client.toggleNoteReactions(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    emojis: [\'thumbs-up\', \'heart\']\n  },\n)\n```\n\n---\n\n## Schemas\n\n### `NotePostRequestBody`\n\n```ts\ntype NotePostRequestBody = {\n  _tags?: string[]\n  type?: string\n  entity_id?: string\n  parent_id?: string\n  contexts?: Array<{\n    type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n    id: string\n  }>\n  additional_contexts?: Array<{\n    type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n    id: string\n  }>\n  content?: string\n  attachments?: string[]\n  read_by?: string[]\n}\n```\n\n### `ContextType`\n\n```ts\ntype ContextType = "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n```\n\n### `NoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place.\n\n```ts\ntype NoteEntity = {\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}\n```\n\n### `Entity`\n\nBase Entity schema\n\n```ts\ntype Entity = {\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}\n```\n\n### `CreatedByType`\n\n```ts\ntype CreatedByType = "user" | "group"\n```\n\n### `NoteGetRequestResponse`\n\n```ts\ntype NoteGetRequestResponse = {\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}\n```\n\n### `NotePatchRequestBody`\n\n```ts\ntype NotePatchRequestBody = {\n  _tags?: string[]\n  type?: string\n  attachments?: {\n    $relation?: Array<{\n      entity_id: { ... }\n    }>\n  }\n  comments?: Array<{\n    _id: string\n    _org?: string\n    _schema?: string\n    _created_at?: string // date-time\n    _updated_at?: string // date-time\n    _created_by?: string | number\n    _tags?: string[]\n    _acl?: Record<string, string[]>\n    _owners?: Array<{\n      org_id: { ... }\n      user_id: { ... }\n    }>\n    type?: string\n  }>\n  content?: string\n  contexts?: Array<{\n    type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n    id: string\n  }>\n  pinned_at?: string // date-time\n  edited_at?: string // date-time\n  created_by?: Array<{\n    type: "user" | "group"\n    user_id?: string\n    display_name?: string\n    org_id?: string\n    email?: string\n    phone?: string\n  }>\n  read_by?: string[]\n  reactions?: Record<string, string[]>\n}\n```\n\n### `NonHydratedNoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are not hydrated in place.\n\n```ts\ntype NonHydratedNoteEntity = {\n  _id: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n}\n```\n\n### `NoteEntityParent`\n\nThe Note\'s parent Note\n\n```ts\ntype NoteEntityParent = {\n  $relation?: Array<{\n    entity_id: string\n  }>\n}\n```\n\n### `NotePutRequestBody`\n\n```ts\ntype NotePutRequestBody = {\n  _id?: string\n  _org?: string\n  _schema?: string\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _created_by?: string | number\n  _tags?: string[]\n  _acl?: Record<string, string[]>\n  _owners?: Array<{\n    org_id: string\n    user_id: string\n  }>\n  type?: string\n  context_entities?: {\n    $relation: Array<{\n      entity_id: { ... }\n    }>\n  }\n  parent?: {\n    $relation?: Array<{\n      entity_id: { ... }\n    }>\n  }\n  attachments?: {\n    $relation?: Array<{\n      entity_id: { ... }\n    }>\n  }\n  content?: string\n  contexts?: Array<{\n    type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n    id: string\n  }>\n  pinned_at?: string // date-time\n  edited_at?: string // date-time\n  created_by?: Array<{\n    type: "user" | "group"\n    user_id?: string\n    display_name?: string\n    org_id?: string\n    email?: string\n    phone?: string\n  }>\n  read_by?: string[]\n  reactions?: Record<string, string[]>\n}\n```\n\n### `NoteSearchByContextRequestBody`\n\n```ts\ntype NoteSearchByContextRequestBody = {\n  contexts: Array<{\n    type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n    id: string\n  }>\n  include_related_schemas?: string[]\n  from?: number\n  size?: number\n}\n```\n\n### `NotesSearchRequestResponse`\n\n```ts\ntype NotesSearchRequestResponse = {\n  hits?: number\n  results: Array<{\n    _id: string\n    _org?: string\n    _schema?: string\n    _created_at?: string // date-time\n    _updated_at?: string // date-time\n    _created_by?: string | number\n    _tags?: string[]\n    _acl?: Record<string, string[]>\n    _owners?: Array<{\n      org_id: { ... }\n      user_id: { ... }\n    }>\n    type?: string\n  }>\n}\n```\n\n### `NoteContexts`\n\nList of resolved Entity and non-Entity contexts attached to a given Note.\n\n```ts\ntype NoteContexts = {\n  type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n  context: {\n    _id: string\n    _org?: string\n    _schema?: string\n    _created_at?: string // date-time\n    _updated_at?: string // date-time\n    _created_by?: string | number\n    _tags?: string[]\n    _acl?: Record<string, string[]>\n    _owners?: Array<{\n      org_id: { ... }\n      user_id: { ... }\n    }>\n    type?: string\n  } | {\n    id: string\n    definitionId: string\n    orgId: string\n    name: string\n  }\n}\n```\n\n### `WorkflowExecution`\n\nBase metadata for a Workflow Execution. This is a lightweight representation of a Workflow Execution, and does not contain all it\'s data\n\n```ts\ntype WorkflowExecution = {\n  id: string\n  definitionId: string\n  orgId: string\n  name: string\n}\n```\n\n### `ReactionRequest`\n\n```ts\ntype ReactionRequest = {\n  emoji: string\n}\n```\n\n### `ToggleReactionsRequest`\n\n```ts\ntype ToggleReactionsRequest = {\n  emojis: string[]\n}\n```\n';
+export {
+  notes_default as default
+};

package/dist/{notes.d-BC-scR42.d.cts → notes.d-BcV_m5fe.d.cts}

@@ -1,8 +1,6 @@
 import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
 
 /* Auto-copied from notes-client */
-/* eslint-disable */
-
 
 
 declare namespace Components {
@@ -129,6 +127,10 @@ declare namespace Components {
              * The timestamp of when this Note was pinned
              */
             pinned_at?: string; // date-time
+            /**
+             * The timestamp of when this Note was last updated
+             */
+            edited_at?: string; // date-time
             created_by?: {
                 type: "user" | "group";
                 user_id?: string;
@@ -136,7 +138,7 @@ declare namespace Components {
                 org_id?: string;
                 email?: string;
                 phone?: string;
-            };
+            }[];
             /**
              * List of user IDs who have read this note
              */
@@ -228,7 +230,7 @@ declare namespace Components {
                 org_id?: string;
                 email?: string;
                 phone?: string;
-            };
+            }[];
             /**
              * List of user IDs who have read this note
              */
@@ -321,7 +323,7 @@ declare namespace Components {
                 org_id?: string;
                 email?: string;
                 phone?: string;
-            };
+            }[];
             /**
              * List of user IDs who have read this note
              */
@@ -363,6 +365,10 @@ declare namespace Components {
              * The timestamp of when this Note was pinned
              */
             pinned_at?: string; // date-time
+            /**
+             * The timestamp of when this Note was last updated
+             */
+            edited_at?: string; // date-time
             created_by?: {
                 type: "user" | "group";
                 user_id?: string;
@@ -370,7 +376,7 @@ declare namespace Components {
                 org_id?: string;
                 email?: string;
                 phone?: string;
-            };
+            }[];
             /**
              * List of user IDs who have read this note
              */
@@ -495,6 +501,10 @@ declare namespace Components {
              * The timestamp of when this Note was pinned
              */
             pinned_at?: string; // date-time
+            /**
+             * The timestamp of when this Note was last updated
+             */
+            edited_at?: string; // date-time
             created_by?: {
                 type: "user" | "group";
                 user_id?: string;
@@ -502,7 +512,7 @@ declare namespace Components {
                 org_id?: string;
                 email?: string;
                 phone?: string;
-            };
+            }[];
             /**
              * List of user IDs who have read this note
              */
@@ -515,10 +525,20 @@ declare namespace Components {
             };
         }
         export interface NoteSearchByContextRequestBody {
-            contexts: {
-                type: ContextType;
-                id: string;
-            }[];
+            contexts: [
+                {
+                    type: ContextType;
+                    id: string;
+                },
+                ...{
+                    type: ContextType;
+                    id: string;
+                }[]
+            ];
+            /**
+             * When set, the API resolves related entities of these schemas for the primary entity context and includes their notes in the results.
+             */
+            include_related_schemas?: string[];
             /**
              * The index of the first Note to return in this query
              */
@@ -758,6 +778,7 @@ declare namespace Paths {
     }
 }
 
+
 interface OperationMethods {
   /**
    * createNote - createNote
@@ -1026,6 +1047,7 @@ interface PathsDictionary {
 
 type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
+
 type ContextType = Components.Schemas.ContextType;
 type CreatedByType = Components.Schemas.CreatedByType;
 type Entity = Components.Schemas.Entity;

package/dist/{notes.d-BC-scR42.d.ts → notes.d-BcV_m5fe.d.ts}

@@ -1,8 +1,6 @@
 import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
 
 /* Auto-copied from notes-client */
-/* eslint-disable */
-
 
 
 declare namespace Components {
@@ -129,6 +127,10 @@ declare namespace Components {
              * The timestamp of when this Note was pinned
              */
             pinned_at?: string; // date-time
+            /**
+             * The timestamp of when this Note was last updated
+             */
+            edited_at?: string; // date-time
             created_by?: {
                 type: "user" | "group";
                 user_id?: string;
@@ -136,7 +138,7 @@ declare namespace Components {
                 org_id?: string;
                 email?: string;
                 phone?: string;
-            };
+            }[];
             /**
              * List of user IDs who have read this note
              */
@@ -228,7 +230,7 @@ declare namespace Components {
                 org_id?: string;
                 email?: string;
                 phone?: string;
-            };
+            }[];
             /**
              * List of user IDs who have read this note
              */
@@ -321,7 +323,7 @@ declare namespace Components {
                 org_id?: string;
                 email?: string;
                 phone?: string;
-            };
+            }[];
             /**
              * List of user IDs who have read this note
              */
@@ -363,6 +365,10 @@ declare namespace Components {
              * The timestamp of when this Note was pinned
              */
             pinned_at?: string; // date-time
+            /**
+             * The timestamp of when this Note was last updated
+             */
+            edited_at?: string; // date-time
             created_by?: {
                 type: "user" | "group";
                 user_id?: string;
@@ -370,7 +376,7 @@ declare namespace Components {
                 org_id?: string;
                 email?: string;
                 phone?: string;
-            };
+            }[];
             /**
              * List of user IDs who have read this note
              */
@@ -495,6 +501,10 @@ declare namespace Components {
              * The timestamp of when this Note was pinned
              */
             pinned_at?: string; // date-time
+            /**
+             * The timestamp of when this Note was last updated
+             */
+            edited_at?: string; // date-time
             created_by?: {
                 type: "user" | "group";
                 user_id?: string;
@@ -502,7 +512,7 @@ declare namespace Components {
                 org_id?: string;
                 email?: string;
                 phone?: string;
-            };
+            }[];
             /**
              * List of user IDs who have read this note
              */
@@ -515,10 +525,20 @@ declare namespace Components {
             };
         }
         export interface NoteSearchByContextRequestBody {
-            contexts: {
-                type: ContextType;
-                id: string;
-            }[];
+            contexts: [
+                {
+                    type: ContextType;
+                    id: string;
+                },
+                ...{
+                    type: ContextType;
+                    id: string;
+                }[]
+            ];
+            /**
+             * When set, the API resolves related entities of these schemas for the primary entity context and includes their notes in the results.
+             */
+            include_related_schemas?: string[];
             /**
              * The index of the first Note to return in this query
              */
@@ -758,6 +778,7 @@ declare namespace Paths {
     }
 }
 
+
 interface OperationMethods {
   /**
    * createNote - createNote
@@ -1026,6 +1047,7 @@ interface PathsDictionary {
 
 type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
+
 type ContextType = Components.Schemas.ContextType;
 type CreatedByType = Components.Schemas.CreatedByType;
 type Entity = Components.Schemas.Entity;