@epilot/sdk 2.0.0-beta.4 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (290) hide show
  1. package/LICENSE +21 -0
  2. package/dist/{access-token.d-BuXO-21p.d.cts → access-token.d-CnmUTOlq.d.cts} +1 -1
  3. package/dist/{access-token.d-BuXO-21p.d.ts → access-token.d-CnmUTOlq.d.ts} +1 -1
  4. package/dist/{address-suggestions.d-Cay0qOfA.d.cts → address-suggestions.d-_YwTOR-9.d.cts} +1 -1
  5. package/dist/{address-suggestions.d-Cay0qOfA.d.ts → address-suggestions.d-_YwTOR-9.d.ts} +1 -1
  6. package/dist/{address.d-D-oZY0rk.d.cts → address.d-CwAPOVxa.d.cts} +1 -1
  7. package/dist/{address.d-D-oZY0rk.d.ts → address.d-CwAPOVxa.d.ts} +1 -1
  8. package/dist/{ai-agents.d-B4_CZTCP.d.cts → ai-agents.d-OkXfr2bz.d.cts} +1 -1
  9. package/dist/{ai-agents.d-B4_CZTCP.d.ts → ai-agents.d-OkXfr2bz.d.ts} +1 -1
  10. package/dist/apis/access-token.d.cts +3 -3
  11. package/dist/apis/access-token.d.ts +3 -3
  12. package/dist/apis/address-suggestions.d.cts +3 -3
  13. package/dist/apis/address-suggestions.d.ts +3 -3
  14. package/dist/apis/address.d.cts +3 -3
  15. package/dist/apis/address.d.ts +3 -3
  16. package/dist/apis/ai-agents.d.cts +3 -3
  17. package/dist/apis/ai-agents.d.ts +3 -3
  18. package/dist/apis/app.d.cts +3 -3
  19. package/dist/apis/app.d.ts +3 -3
  20. package/dist/apis/audit-logs.d.cts +3 -3
  21. package/dist/apis/audit-logs.d.ts +3 -3
  22. package/dist/apis/automation.d.cts +3 -3
  23. package/dist/apis/automation.d.ts +3 -3
  24. package/dist/apis/billing.d.cts +3 -3
  25. package/dist/apis/billing.d.ts +3 -3
  26. package/dist/apis/blueprint-manifest.d.cts +3 -3
  27. package/dist/apis/blueprint-manifest.d.ts +3 -3
  28. package/dist/apis/consent.d.cts +3 -3
  29. package/dist/apis/consent.d.ts +3 -3
  30. package/dist/apis/customer-portal.cjs +1 -1
  31. package/dist/apis/customer-portal.d.cts +3 -3
  32. package/dist/apis/customer-portal.d.ts +3 -3
  33. package/dist/apis/customer-portal.js +1 -1
  34. package/dist/apis/dashboard.d.cts +3 -3
  35. package/dist/apis/dashboard.d.ts +3 -3
  36. package/dist/apis/data-management.d.cts +3 -3
  37. package/dist/apis/data-management.d.ts +3 -3
  38. package/dist/apis/deduplication.d.cts +3 -3
  39. package/dist/apis/deduplication.d.ts +3 -3
  40. package/dist/apis/design.d.cts +3 -3
  41. package/dist/apis/design.d.ts +3 -3
  42. package/dist/apis/document.d.cts +3 -3
  43. package/dist/apis/document.d.ts +3 -3
  44. package/dist/apis/email-settings.d.cts +3 -3
  45. package/dist/apis/email-settings.d.ts +3 -3
  46. package/dist/apis/email-template.d.cts +3 -3
  47. package/dist/apis/email-template.d.ts +3 -3
  48. package/dist/apis/entity-mapping.d.cts +3 -3
  49. package/dist/apis/entity-mapping.d.ts +3 -3
  50. package/dist/apis/entity.d.cts +3 -3
  51. package/dist/apis/entity.d.ts +3 -3
  52. package/dist/apis/environments.d.cts +3 -3
  53. package/dist/apis/environments.d.ts +3 -3
  54. package/dist/apis/erp-integration.cjs +1 -1
  55. package/dist/apis/erp-integration.d.cts +3 -3
  56. package/dist/apis/erp-integration.d.ts +3 -3
  57. package/dist/apis/erp-integration.js +1 -1
  58. package/dist/apis/event-catalog.d.cts +3 -3
  59. package/dist/apis/event-catalog.d.ts +3 -3
  60. package/dist/apis/file.d.cts +3 -3
  61. package/dist/apis/file.d.ts +3 -3
  62. package/dist/apis/iban.d.cts +3 -3
  63. package/dist/apis/iban.d.ts +3 -3
  64. package/dist/apis/journey.d.cts +3 -3
  65. package/dist/apis/journey.d.ts +3 -3
  66. package/dist/apis/kanban.d.cts +3 -3
  67. package/dist/apis/kanban.d.ts +3 -3
  68. package/dist/apis/message.d.cts +3 -3
  69. package/dist/apis/message.d.ts +3 -3
  70. package/dist/apis/metering.d.cts +3 -3
  71. package/dist/apis/metering.d.ts +3 -3
  72. package/dist/apis/notes.d.cts +3 -3
  73. package/dist/apis/notes.d.ts +3 -3
  74. package/dist/apis/notification.d.cts +3 -3
  75. package/dist/apis/notification.d.ts +3 -3
  76. package/dist/apis/organization.cjs +1 -1
  77. package/dist/apis/organization.d.cts +3 -3
  78. package/dist/apis/organization.d.ts +3 -3
  79. package/dist/apis/organization.js +1 -1
  80. package/dist/apis/partner-directory.d.cts +3 -3
  81. package/dist/apis/partner-directory.d.ts +3 -3
  82. package/dist/apis/permissions.d.cts +3 -3
  83. package/dist/apis/permissions.d.ts +3 -3
  84. package/dist/apis/pricing-tier.d.cts +3 -3
  85. package/dist/apis/pricing-tier.d.ts +3 -3
  86. package/dist/apis/pricing.d.cts +3 -3
  87. package/dist/apis/pricing.d.ts +3 -3
  88. package/dist/apis/purpose.d.cts +3 -3
  89. package/dist/apis/purpose.d.ts +3 -3
  90. package/dist/apis/sandbox.d.cts +3 -3
  91. package/dist/apis/sandbox.d.ts +3 -3
  92. package/dist/apis/submission.d.cts +3 -3
  93. package/dist/apis/submission.d.ts +3 -3
  94. package/dist/apis/targeting.d.cts +3 -3
  95. package/dist/apis/targeting.d.ts +3 -3
  96. package/dist/apis/template-variables.d.cts +3 -3
  97. package/dist/apis/template-variables.d.ts +3 -3
  98. package/dist/apis/user.d.cts +3 -3
  99. package/dist/apis/user.d.ts +3 -3
  100. package/dist/apis/validation-rules.d.cts +3 -3
  101. package/dist/apis/validation-rules.d.ts +3 -3
  102. package/dist/apis/webhooks.d.cts +3 -3
  103. package/dist/apis/webhooks.d.ts +3 -3
  104. package/dist/apis/workflow-definition.d.cts +3 -3
  105. package/dist/apis/workflow-definition.d.ts +3 -3
  106. package/dist/apis/workflow.d.cts +3 -3
  107. package/dist/apis/workflow.d.ts +3 -3
  108. package/dist/{app.d-BKyfin-q.d.cts → app.d-Dr03n4J4.d.cts} +1 -1
  109. package/dist/{app.d-BKyfin-q.d.ts → app.d-Dr03n4J4.d.ts} +1 -1
  110. package/dist/{audit-logs.d-19BKb-ur.d.cts → audit-logs.d-BRToFqeX.d.cts} +1 -1
  111. package/dist/{audit-logs.d-19BKb-ur.d.ts → audit-logs.d-BRToFqeX.d.ts} +1 -1
  112. package/dist/{automation.d-DKl2VtnW.d.ts → automation.d-KOiZ6ru5.d.cts} +2 -24
  113. package/dist/{automation.d-DKl2VtnW.d.cts → automation.d-KOiZ6ru5.d.ts} +2 -24
  114. package/dist/{billing.d-58fUMBqj.d.cts → billing.d-Bs8Ku9qE.d.cts} +1 -1
  115. package/dist/{billing.d-58fUMBqj.d.ts → billing.d-Bs8Ku9qE.d.ts} +1 -1
  116. package/dist/{blueprint-manifest.d-Bu1GyXFW.d.cts → blueprint-manifest.d-CEWRdF3i.d.cts} +1 -1
  117. package/dist/{blueprint-manifest.d-Bu1GyXFW.d.ts → blueprint-manifest.d-CEWRdF3i.d.ts} +1 -1
  118. package/dist/{consent.d-CQ88IEj0.d.cts → consent.d-C2PROHhX.d.cts} +1 -1
  119. package/dist/{consent.d-CQ88IEj0.d.ts → consent.d-C2PROHhX.d.ts} +1 -1
  120. package/dist/{customer-portal.d-EyndRWh6.d.ts → customer-portal.d-Bh9NF8cY.d.cts} +598 -99
  121. package/dist/{customer-portal.d-EyndRWh6.d.cts → customer-portal.d-Bh9NF8cY.d.ts} +598 -99
  122. package/dist/{dashboard.d-AE3RQ6zo.d.cts → dashboard.d-CsGcA74I.d.cts} +1 -1
  123. package/dist/{dashboard.d-AE3RQ6zo.d.ts → dashboard.d-CsGcA74I.d.ts} +1 -1
  124. package/dist/{data-management.d-CNExsqJQ.d.cts → data-management.d-pnuiRU2h.d.cts} +1 -1
  125. package/dist/{data-management.d-CNExsqJQ.d.ts → data-management.d-pnuiRU2h.d.ts} +1 -1
  126. package/dist/{deduplication.d-DCeJzdbM.d.ts → deduplication.d-w_2aJD5f.d.cts} +1 -1
  127. package/dist/{deduplication.d-DCeJzdbM.d.cts → deduplication.d-w_2aJD5f.d.ts} +1 -1
  128. package/dist/{design.d-CkwgJ78Z.d.cts → design.d-eA-irKEX.d.cts} +1 -1
  129. package/dist/{design.d-CkwgJ78Z.d.ts → design.d-eA-irKEX.d.ts} +1 -1
  130. package/dist/{document.d-Y8i32qNV.d.cts → document.d-DN37pjdx.d.cts} +1 -1
  131. package/dist/{document.d-Y8i32qNV.d.ts → document.d-DN37pjdx.d.ts} +1 -1
  132. package/dist/{email-settings.d-CPAsRFWN.d.cts → email-settings.d-BXxYjVDr.d.cts} +1 -1
  133. package/dist/{email-settings.d-CPAsRFWN.d.ts → email-settings.d-BXxYjVDr.d.ts} +1 -1
  134. package/dist/{email-template.d-CQqiCN0N.d.cts → email-template.d-BeqkDHtk.d.cts} +1 -1
  135. package/dist/{email-template.d-CQqiCN0N.d.ts → email-template.d-BeqkDHtk.d.ts} +1 -1
  136. package/dist/{entity-mapping.d-DiqXqJWb.d.cts → entity-mapping.d-DKSW3sfy.d.cts} +1 -1
  137. package/dist/{entity-mapping.d-DiqXqJWb.d.ts → entity-mapping.d-DKSW3sfy.d.ts} +1 -1
  138. package/dist/{entity.d-BtT4mdq4.d.ts → entity.d-CrtZaZr8.d.cts} +1 -1
  139. package/dist/{entity.d-BtT4mdq4.d.cts → entity.d-CrtZaZr8.d.ts} +1 -1
  140. package/dist/{environments.d-C1xIs8N2.d.cts → environments.d-H3LK_KuH.d.cts} +1 -1
  141. package/dist/{environments.d-C1xIs8N2.d.ts → environments.d-H3LK_KuH.d.ts} +1 -1
  142. package/dist/{erp-integration.d-CNLzgl4L.d.cts → erp-integration.d-DOhxy4P5.d.cts} +409 -15
  143. package/dist/{erp-integration.d-CNLzgl4L.d.ts → erp-integration.d-DOhxy4P5.d.ts} +409 -15
  144. package/dist/{event-catalog.d-DW1dOyVh.d.cts → event-catalog.d-ENw6HO-w.d.cts} +1 -1
  145. package/dist/{event-catalog.d-DW1dOyVh.d.ts → event-catalog.d-ENw6HO-w.d.ts} +1 -1
  146. package/dist/{file.d-Bpdt2ORN.d.cts → file.d-DcTJxjp7.d.cts} +1 -1
  147. package/dist/{file.d-Bpdt2ORN.d.ts → file.d-DcTJxjp7.d.ts} +1 -1
  148. package/dist/{iban.d-3_7FEsbx.d.ts → iban.d-BwdiGbxi.d.cts} +1 -1
  149. package/dist/{iban.d-3_7FEsbx.d.cts → iban.d-BwdiGbxi.d.ts} +1 -1
  150. package/dist/index.d.cts +46 -46
  151. package/dist/index.d.ts +46 -46
  152. package/dist/{journey.d-C2lgynUF.d.cts → journey.d-C4N4t1Rh.d.cts} +122 -4
  153. package/dist/{journey.d-C2lgynUF.d.ts → journey.d-C4N4t1Rh.d.ts} +122 -4
  154. package/dist/kanban.d-CtSt3uX2.d.cts +745 -0
  155. package/dist/kanban.d-CtSt3uX2.d.ts +745 -0
  156. package/dist/{message.d-TAVDRlDJ.d.cts → message.d-YEv1kmQd.d.cts} +1 -1
  157. package/dist/{message.d-TAVDRlDJ.d.ts → message.d-YEv1kmQd.d.ts} +1 -1
  158. package/dist/{metering.d-qyYaAU-O.d.cts → metering.d-DvtPv7wk.d.cts} +1 -1
  159. package/dist/{metering.d-qyYaAU-O.d.ts → metering.d-DvtPv7wk.d.ts} +1 -1
  160. package/dist/{notes.d-CDyIbegf.d.cts → notes.d-BC-scR42.d.cts} +1 -1
  161. package/dist/{notes.d-CDyIbegf.d.ts → notes.d-BC-scR42.d.ts} +1 -1
  162. package/dist/{notification.d-B7ccbaPr.d.cts → notification.d-BfBL3lga.d.cts} +1 -1
  163. package/dist/{notification.d-B7ccbaPr.d.ts → notification.d-BfBL3lga.d.ts} +1 -1
  164. package/dist/organization.d-Bd2Hmk8v.d.cts +1244 -0
  165. package/dist/organization.d-Bd2Hmk8v.d.ts +1244 -0
  166. package/dist/{partner-directory.d-CzKV3WfP.d.cts → partner-directory.d-CRNkDF8q.d.cts} +1 -1
  167. package/dist/{partner-directory.d-CzKV3WfP.d.ts → partner-directory.d-CRNkDF8q.d.ts} +1 -1
  168. package/dist/{permissions.d-lVoPAfl3.d.cts → permissions.d-BHB1FFS5.d.cts} +1 -1
  169. package/dist/{permissions.d-lVoPAfl3.d.ts → permissions.d-BHB1FFS5.d.ts} +1 -1
  170. package/dist/{pricing-tier.d-BW2cZt1w.d.cts → pricing-tier.d-Cg0jl6n_.d.cts} +1 -1
  171. package/dist/{pricing-tier.d-BW2cZt1w.d.ts → pricing-tier.d-Cg0jl6n_.d.ts} +1 -1
  172. package/dist/{pricing.d-Ehb2JuKY.d.cts → pricing.d-Cv39plGm.d.cts} +1 -1
  173. package/dist/{pricing.d-Ehb2JuKY.d.ts → pricing.d-Cv39plGm.d.ts} +1 -1
  174. package/dist/{purpose.d-BVxst611.d.cts → purpose.d-CbIYfTua.d.cts} +1 -1
  175. package/dist/{purpose.d-BVxst611.d.ts → purpose.d-CbIYfTua.d.ts} +1 -1
  176. package/dist/{sandbox.d-tRO2movo.d.cts → sandbox.d-BdbOFzDu.d.cts} +1 -1
  177. package/dist/{sandbox.d-tRO2movo.d.ts → sandbox.d-BdbOFzDu.d.ts} +1 -1
  178. package/dist/{submission.d-CSll5Km9.d.cts → submission.d-BamwfhXw.d.cts} +1 -1
  179. package/dist/{submission.d-CSll5Km9.d.ts → submission.d-BamwfhXw.d.ts} +1 -1
  180. package/dist/{targeting.d-CDxIsOWy.d.cts → targeting.d-BNmcVsNS.d.cts} +1 -1
  181. package/dist/{targeting.d-CDxIsOWy.d.ts → targeting.d-BNmcVsNS.d.ts} +1 -1
  182. package/dist/{template-variables.d-PwA27Ocv.d.cts → template-variables.d-Ch3H3zYf.d.cts} +1 -1
  183. package/dist/{template-variables.d-PwA27Ocv.d.ts → template-variables.d-Ch3H3zYf.d.ts} +1 -1
  184. package/dist/{user.d-DJBp6aX5.d.cts → user.d-CXqM751M.d.cts} +1 -1
  185. package/dist/{user.d-DJBp6aX5.d.ts → user.d-CXqM751M.d.ts} +1 -1
  186. package/dist/{validation-rules.d-CScjNdxD.d.cts → validation-rules.d-Db5c5zTf.d.cts} +1 -1
  187. package/dist/{validation-rules.d-CScjNdxD.d.ts → validation-rules.d-Db5c5zTf.d.ts} +1 -1
  188. package/dist/{webhooks.d-C_MQSJEB.d.cts → webhooks.d-CUNJrltY.d.cts} +1 -1
  189. package/dist/{webhooks.d-C_MQSJEB.d.ts → webhooks.d-CUNJrltY.d.ts} +1 -1
  190. package/dist/{workflow-definition.d-CFXrp2Hg.d.cts → workflow-definition.d-CE3kk9gl.d.cts} +1 -1
  191. package/dist/{workflow-definition.d-CFXrp2Hg.d.ts → workflow-definition.d-CE3kk9gl.d.ts} +1 -1
  192. package/dist/{workflow.d-BIWtgMyP.d.cts → workflow.d-DvhTpEtU.d.cts} +46 -4
  193. package/dist/{workflow.d-BIWtgMyP.d.ts → workflow.d-DvhTpEtU.d.ts} +46 -4
  194. package/package.json +152 -11
  195. package/definitions/access-token-runtime.json +0 -1
  196. package/definitions/access-token.json +0 -663
  197. package/definitions/address-runtime.json +0 -1
  198. package/definitions/address-suggestions-runtime.json +0 -1
  199. package/definitions/address-suggestions.json +0 -582
  200. package/definitions/address.json +0 -578
  201. package/definitions/ai-agents-runtime.json +0 -1
  202. package/definitions/ai-agents.json +0 -1711
  203. package/definitions/app-runtime.json +0 -1
  204. package/definitions/app.json +0 -4443
  205. package/definitions/audit-logs-runtime.json +0 -1
  206. package/definitions/audit-logs.json +0 -305
  207. package/definitions/automation-runtime.json +0 -1
  208. package/definitions/automation.json +0 -4850
  209. package/definitions/billing-runtime.json +0 -1
  210. package/definitions/billing.json +0 -837
  211. package/definitions/blueprint-manifest-runtime.json +0 -1
  212. package/definitions/blueprint-manifest.json +0 -3376
  213. package/definitions/consent-runtime.json +0 -1
  214. package/definitions/consent.json +0 -344
  215. package/definitions/customer-portal-runtime.json +0 -1
  216. package/definitions/customer-portal.json +0 -15000
  217. package/definitions/dashboard-runtime.json +0 -1
  218. package/definitions/dashboard.json +0 -484
  219. package/definitions/data-management-runtime.json +0 -1
  220. package/definitions/data-management.json +0 -962
  221. package/definitions/deduplication-runtime.json +0 -1
  222. package/definitions/deduplication.json +0 -183
  223. package/definitions/design-runtime.json +0 -1
  224. package/definitions/design.json +0 -1423
  225. package/definitions/document-runtime.json +0 -1
  226. package/definitions/document.json +0 -758
  227. package/definitions/email-settings-runtime.json +0 -1
  228. package/definitions/email-settings.json +0 -2627
  229. package/definitions/email-template-runtime.json +0 -1
  230. package/definitions/email-template.json +0 -1419
  231. package/definitions/entity-mapping-runtime.json +0 -1
  232. package/definitions/entity-mapping.json +0 -1642
  233. package/definitions/entity-runtime.json +0 -1
  234. package/definitions/entity.json +0 -10074
  235. package/definitions/environments-runtime.json +0 -1
  236. package/definitions/environments.json +0 -363
  237. package/definitions/erp-integration-runtime.json +0 -1
  238. package/definitions/erp-integration.json +0 -5845
  239. package/definitions/event-catalog-runtime.json +0 -1
  240. package/definitions/event-catalog.json +0 -1051
  241. package/definitions/file-runtime.json +0 -1
  242. package/definitions/file.json +0 -2842
  243. package/definitions/iban-runtime.json +0 -1
  244. package/definitions/iban.json +0 -132
  245. package/definitions/journey-runtime.json +0 -1
  246. package/definitions/journey.json +0 -2341
  247. package/definitions/kanban-runtime.json +0 -1
  248. package/definitions/kanban.json +0 -929
  249. package/definitions/message-runtime.json +0 -1
  250. package/definitions/message.json +0 -2660
  251. package/definitions/metering-runtime.json +0 -1
  252. package/definitions/metering.json +0 -2321
  253. package/definitions/notes-runtime.json +0 -1
  254. package/definitions/notes.json +0 -1531
  255. package/definitions/notification-runtime.json +0 -1
  256. package/definitions/notification.json +0 -1425
  257. package/definitions/organization-runtime.json +0 -1
  258. package/definitions/organization.json +0 -629
  259. package/definitions/partner-directory-runtime.json +0 -1
  260. package/definitions/partner-directory.json +0 -1718
  261. package/definitions/permissions-runtime.json +0 -1
  262. package/definitions/permissions.json +0 -1480
  263. package/definitions/pricing-runtime.json +0 -1
  264. package/definitions/pricing-tier-runtime.json +0 -1
  265. package/definitions/pricing-tier.json +0 -105
  266. package/definitions/pricing.json +0 -9884
  267. package/definitions/purpose-runtime.json +0 -1
  268. package/definitions/purpose.json +0 -524
  269. package/definitions/sandbox-runtime.json +0 -1
  270. package/definitions/sandbox.json +0 -453
  271. package/definitions/submission-runtime.json +0 -1
  272. package/definitions/submission.json +0 -313
  273. package/definitions/targeting-runtime.json +0 -1
  274. package/definitions/targeting.json +0 -1474
  275. package/definitions/template-variables-runtime.json +0 -1
  276. package/definitions/template-variables.json +0 -1408
  277. package/definitions/user-runtime.json +0 -1
  278. package/definitions/user.json +0 -2408
  279. package/definitions/validation-rules-runtime.json +0 -1
  280. package/definitions/validation-rules.json +0 -1491
  281. package/definitions/webhooks-runtime.json +0 -1
  282. package/definitions/webhooks.json +0 -1525
  283. package/definitions/workflow-definition-runtime.json +0 -1
  284. package/definitions/workflow-definition.json +0 -3417
  285. package/definitions/workflow-runtime.json +0 -1
  286. package/definitions/workflow.json +0 -4106
  287. package/dist/kanban.d-DYVjUQ_S.d.cts +0 -630
  288. package/dist/kanban.d-DYVjUQ_S.d.ts +0 -630
  289. package/dist/organization.d-BxZWnh8L.d.cts +0 -628
  290. package/dist/organization.d-BxZWnh8L.d.ts +0 -628
@@ -1,1531 +0,0 @@
1
- {
2
- "openapi": "3.0.2",
3
- "info": {
4
- "version": "2.3.0",
5
- "title": "Notes API",
6
- "description": "Facade API Backend for Epilot Notes feature"
7
- },
8
- "servers": [
9
- {
10
- "url": "https://notes.sls.epilot.io"
11
- }
12
- ],
13
- "tags": [
14
- {
15
- "name": "Notes"
16
- },
17
- {
18
- "name": "Pinning"
19
- }
20
- ],
21
- "security": [
22
- {
23
- "EpilotAuth": []
24
- }
25
- ],
26
- "paths": {
27
- "/v1/note": {
28
- "post": {
29
- "operationId": "createNote",
30
- "summary": "createNote",
31
- "description": "Creates a new Note entry",
32
- "tags": [
33
- "Notes"
34
- ],
35
- "requestBody": {
36
- "content": {
37
- "application/json": {
38
- "schema": {
39
- "$ref": "#/components/schemas/NotePostRequestBody"
40
- }
41
- }
42
- }
43
- },
44
- "responses": {
45
- "200": {
46
- "description": "Successful response with Note content",
47
- "content": {
48
- "application/json": {
49
- "schema": {
50
- "$ref": "#/components/schemas/NoteEntity"
51
- }
52
- }
53
- }
54
- }
55
- }
56
- }
57
- },
58
- "/v1/note/{id}": {
59
- "get": {
60
- "operationId": "getNote",
61
- "summary": "getNote",
62
- "description": "Retrieves a single Note entry based on it's Entity ID",
63
- "tags": [
64
- "Notes"
65
- ],
66
- "parameters": [
67
- {
68
- "in": "path",
69
- "name": "id",
70
- "description": "The Entity ID of the Note entry to retrieve",
71
- "schema": {
72
- "type": "string",
73
- "description": "The Entity ID of the Note entry to retrieve"
74
- },
75
- "required": true
76
- },
77
- {
78
- "in": "query",
79
- "name": "hydrate",
80
- "description": "Whether to hydrate the Note's relation attributes",
81
- "schema": {
82
- "type": "boolean",
83
- "description": "Whether to hydrate the Note's relation attributes"
84
- }
85
- }
86
- ],
87
- "responses": {
88
- "200": {
89
- "description": "Successful response with Note content",
90
- "content": {
91
- "application/json": {
92
- "schema": {
93
- "$ref": "#/components/schemas/NoteGetRequestResponse"
94
- }
95
- }
96
- }
97
- }
98
- }
99
- },
100
- "patch": {
101
- "operationId": "patchNote",
102
- "summary": "patchNote",
103
- "description": "Updates an existing Note entry",
104
- "tags": [
105
- "Notes"
106
- ],
107
- "parameters": [
108
- {
109
- "in": "path",
110
- "name": "id",
111
- "description": "The Entity ID of the Note entry to update",
112
- "schema": {
113
- "type": "string",
114
- "description": "The Entity ID of the Note entry to update"
115
- },
116
- "required": true
117
- }
118
- ],
119
- "requestBody": {
120
- "content": {
121
- "application/json": {
122
- "schema": {
123
- "$ref": "#/components/schemas/NotePatchRequestBody"
124
- }
125
- }
126
- }
127
- },
128
- "responses": {
129
- "200": {
130
- "description": "Successful response with Note content",
131
- "content": {
132
- "application/json": {
133
- "schema": {
134
- "$ref": "#/components/schemas/NoteEntity"
135
- }
136
- }
137
- }
138
- }
139
- }
140
- },
141
- "put": {
142
- "operationId": "updateNote",
143
- "summary": "updateNote",
144
- "description": "Updates an existing Note entry",
145
- "tags": [
146
- "Notes"
147
- ],
148
- "parameters": [
149
- {
150
- "in": "path",
151
- "name": "id",
152
- "description": "The Entity ID of the Note entry to update",
153
- "schema": {
154
- "type": "string",
155
- "description": "The Entity ID of the Note entry to update"
156
- },
157
- "required": true
158
- }
159
- ],
160
- "requestBody": {
161
- "content": {
162
- "application/json": {
163
- "schema": {
164
- "$ref": "#/components/schemas/NotePutRequestBody"
165
- }
166
- }
167
- }
168
- },
169
- "responses": {
170
- "200": {
171
- "description": "Successful response with Note content",
172
- "content": {
173
- "application/json": {
174
- "schema": {
175
- "$ref": "#/components/schemas/NoteEntity"
176
- }
177
- }
178
- }
179
- }
180
- }
181
- },
182
- "delete": {
183
- "operationId": "deleteNote",
184
- "summary": "deleteNote",
185
- "description": "Deletes a single Note entry based on it's Entity ID",
186
- "tags": [
187
- "Notes"
188
- ],
189
- "parameters": [
190
- {
191
- "in": "path",
192
- "name": "id",
193
- "description": "The Entity ID of the Note entry to delete",
194
- "schema": {
195
- "type": "string",
196
- "description": "The Entity ID of the Note entry to delete"
197
- },
198
- "required": true
199
- }
200
- ],
201
- "responses": {
202
- "200": {
203
- "description": "Successful response with the deleted Note entity"
204
- }
205
- }
206
- }
207
- },
208
- "/v1/notes:search": {
209
- "post": {
210
- "operationId": "searchNotesByContext",
211
- "summary": "searchNotesByContext",
212
- "description": "Search for a paginated list of Notes based on one or more contexts",
213
- "tags": [
214
- "Notes"
215
- ],
216
- "requestBody": {
217
- "content": {
218
- "application/json": {
219
- "schema": {
220
- "$ref": "#/components/schemas/NoteSearchByContextRequestBody"
221
- }
222
- }
223
- }
224
- },
225
- "responses": {
226
- "200": {
227
- "description": "Successful response with Note content",
228
- "content": {
229
- "application/json": {
230
- "schema": {
231
- "$ref": "#/components/schemas/NotesSearchRequestResponse"
232
- }
233
- }
234
- }
235
- }
236
- }
237
- }
238
- },
239
- "/v1/notes/{entity_id}": {
240
- "get": {
241
- "operationId": "getNotesByContext",
242
- "summary": "getNotesByContext",
243
- "deprecated": true,
244
- "description": "Given a `context_type`, returns a list of Notes that belong to that context within the specified `id`. \nThis endpoint is deprecated but will be kept for backwards compatibility. Please use the `searchNotesByContext` endpoint instead.",
245
- "tags": [
246
- "Notes"
247
- ],
248
- "parameters": [
249
- {
250
- "in": "path",
251
- "name": "entity_id",
252
- "description": "The ID of the Contextual Entity from where to retrieve Notes",
253
- "schema": {
254
- "type": "string",
255
- "description": "The ID of the Contextual Entity from where to retrieve Notes"
256
- },
257
- "required": true
258
- },
259
- {
260
- "in": "query",
261
- "name": "contexts",
262
- "schema": {
263
- "type": "array",
264
- "items": {
265
- "type": "object",
266
- "properties": {
267
- "type": {
268
- "$ref": "#/components/schemas/ContextType"
269
- },
270
- "id": {
271
- "type": "string"
272
- }
273
- },
274
- "required": [
275
- "type",
276
- "id"
277
- ]
278
- }
279
- }
280
- },
281
- {
282
- "in": "query",
283
- "name": "from",
284
- "description": "The index of the first Note to return in this query",
285
- "schema": {
286
- "type": "number",
287
- "default": 0,
288
- "description": "The index of the first Note to return in this query"
289
- }
290
- },
291
- {
292
- "in": "query",
293
- "name": "size",
294
- "description": "The number of Note entries to return in this query",
295
- "schema": {
296
- "type": "number",
297
- "default": 10,
298
- "description": "The number of Note entries to return in this query"
299
- }
300
- }
301
- ],
302
- "responses": {
303
- "200": {
304
- "description": "Successful response with Note content",
305
- "content": {
306
- "application/json": {
307
- "schema": {
308
- "$ref": "#/components/schemas/NotesSearchRequestResponse"
309
- }
310
- }
311
- }
312
- }
313
- }
314
- }
315
- },
316
- "/v1/note/{id}/pin": {
317
- "post": {
318
- "operationId": "pinNote",
319
- "summary": "pinNote",
320
- "description": "Pins a single Note entry based on it's Entity ID",
321
- "tags": [
322
- "Pinning"
323
- ],
324
- "parameters": [
325
- {
326
- "in": "path",
327
- "name": "id",
328
- "description": "The Entity ID of the Note entry to pin",
329
- "schema": {
330
- "type": "string",
331
- "description": "The Entity ID of the Note entry to pin"
332
- },
333
- "required": true
334
- }
335
- ],
336
- "responses": {
337
- "200": {
338
- "description": "Successful response with the pinned Note entity"
339
- }
340
- }
341
- }
342
- },
343
- "/v1/note/{id}/context": {
344
- "get": {
345
- "operationId": "getNoteContexts",
346
- "summary": "getNoteContexts",
347
- "description": "Gets all the Entity and non-Entity records the Note is contextually attached to",
348
- "tags": [
349
- "Notes"
350
- ],
351
- "parameters": [
352
- {
353
- "in": "path",
354
- "name": "id",
355
- "description": "The Entity ID of the Note entry to get contexts for",
356
- "schema": {
357
- "type": "string",
358
- "description": "The Entity ID of the Note entry to get contexts for"
359
- },
360
- "required": true
361
- }
362
- ],
363
- "responses": {
364
- "200": {
365
- "description": "Successful response with the contexts for the Note Entity",
366
- "content": {
367
- "application/json": {
368
- "schema": {
369
- "type": "array",
370
- "items": {
371
- "$ref": "#/components/schemas/NoteContexts"
372
- }
373
- }
374
- }
375
- }
376
- }
377
- }
378
- }
379
- },
380
- "/v1/note/{id}/reaction": {
381
- "post": {
382
- "operationId": "addNoteReaction",
383
- "summary": "addNoteReaction",
384
- "description": "Adds an emoji reaction to a note",
385
- "tags": [
386
- "Reactions"
387
- ],
388
- "parameters": [
389
- {
390
- "in": "path",
391
- "name": "id",
392
- "description": "The Entity ID of the Note entry to add reaction to",
393
- "schema": {
394
- "type": "string",
395
- "description": "The Entity ID of the Note entry to add reaction to"
396
- },
397
- "required": true
398
- }
399
- ],
400
- "requestBody": {
401
- "content": {
402
- "application/json": {
403
- "schema": {
404
- "$ref": "#/components/schemas/ReactionRequest"
405
- }
406
- }
407
- }
408
- },
409
- "responses": {
410
- "200": {
411
- "description": "Successful response with the updated note reactions",
412
- "content": {
413
- "application/json": {
414
- "schema": {
415
- "$ref": "#/components/schemas/NoteEntity"
416
- }
417
- }
418
- }
419
- }
420
- }
421
- }
422
- },
423
- "/v1/note/{id}/reaction/{emoji_shortcode}": {
424
- "delete": {
425
- "operationId": "removeNoteReaction",
426
- "summary": "removeNoteReaction",
427
- "description": "Removes an emoji reaction from a note",
428
- "tags": [
429
- "Reactions"
430
- ],
431
- "parameters": [
432
- {
433
- "in": "path",
434
- "name": "id",
435
- "description": "The Entity ID of the Note entry to remove reaction from",
436
- "schema": {
437
- "type": "string",
438
- "description": "The Entity ID of the Note entry to remove reaction from"
439
- },
440
- "required": true
441
- },
442
- {
443
- "in": "path",
444
- "name": "emoji_shortcode",
445
- "description": "The emoji to remove from the note",
446
- "schema": {
447
- "type": "string",
448
- "description": "The emoji to remove from the note"
449
- },
450
- "required": true
451
- }
452
- ],
453
- "responses": {
454
- "200": {
455
- "description": "Successful response with the updated note reactions",
456
- "content": {
457
- "application/json": {
458
- "schema": {
459
- "$ref": "#/components/schemas/NoteEntity"
460
- }
461
- }
462
- }
463
- }
464
- }
465
- }
466
- },
467
- "/v1/note/{id}/reactions/toggle": {
468
- "post": {
469
- "operationId": "toggleNoteReactions",
470
- "summary": "toggleNoteReactions",
471
- "description": "Toggles 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.",
472
- "tags": [
473
- "Reactions"
474
- ],
475
- "parameters": [
476
- {
477
- "in": "path",
478
- "name": "id",
479
- "description": "The Entity ID of the Note entry to toggle reactions on",
480
- "schema": {
481
- "type": "string",
482
- "description": "The Entity ID of the Note entry to toggle reactions on"
483
- },
484
- "required": true
485
- }
486
- ],
487
- "requestBody": {
488
- "content": {
489
- "application/json": {
490
- "schema": {
491
- "$ref": "#/components/schemas/ToggleReactionsRequest"
492
- }
493
- }
494
- }
495
- },
496
- "responses": {
497
- "200": {
498
- "description": "Successful response with the updated note reactions",
499
- "content": {
500
- "application/json": {
501
- "schema": {
502
- "$ref": "#/components/schemas/NoteEntity"
503
- }
504
- }
505
- }
506
- }
507
- }
508
- }
509
- }
510
- },
511
- "components": {
512
- "securitySchemes": {
513
- "EpilotAuth": {
514
- "type": "http",
515
- "scheme": "bearer",
516
- "description": "Authorization header with epilot OAuth2 bearer token",
517
- "bearerFormat": "JWT"
518
- }
519
- },
520
- "schemas": {
521
- "NotePostRequestBody": {
522
- "type": "object",
523
- "properties": {
524
- "_tags": {
525
- "type": "array",
526
- "items": {
527
- "type": "string"
528
- },
529
- "description": "Tags associated with this Note"
530
- },
531
- "type": {
532
- "type": "string",
533
- "description": "Entity ID of the Note entry"
534
- },
535
- "entity_id": {
536
- "type": "string",
537
- "description": "The Entity ID of the Entity this Note will be related to. This option has been deprecated since 2.1.0. Please use `contexts` instead.",
538
- "deprecated": true
539
- },
540
- "parent_id": {
541
- "type": "string",
542
- "description": "The Entity ID of the Note's parent Note. If supplied, the Note will be a comment to the parent Note. Be aware that Notes can only have comments one level deep"
543
- },
544
- "contexts": {
545
- "type": "array",
546
- "items": {
547
- "type": "object",
548
- "properties": {
549
- "type": {
550
- "$ref": "#/components/schemas/ContextType"
551
- },
552
- "id": {
553
- "type": "string"
554
- }
555
- },
556
- "required": [
557
- "type",
558
- "id"
559
- ]
560
- },
561
- "description": "The contexts to which this Note will be related to"
562
- },
563
- "additional_contexts": {
564
- "type": "array",
565
- "items": {
566
- "type": "object",
567
- "properties": {
568
- "type": {
569
- "$ref": "#/components/schemas/ContextType"
570
- },
571
- "id": {
572
- "type": "string"
573
- }
574
- },
575
- "required": [
576
- "type",
577
- "id"
578
- ]
579
- },
580
- "description": "Any additional non-entity contexts to which this Note will be related to. This option has been deprecated since 2.1.0. Please use `contexts` instead.",
581
- "deprecated": true
582
- },
583
- "content": {
584
- "type": "string",
585
- "description": "The content of the Note"
586
- },
587
- "attachments": {
588
- "type": "array",
589
- "items": {
590
- "type": "string"
591
- },
592
- "description": "List of File Entity IDs attached to the Note"
593
- },
594
- "read_by": {
595
- "type": "array",
596
- "items": {
597
- "type": "string"
598
- },
599
- "description": "List of user IDs who have read this note"
600
- }
601
- }
602
- },
603
- "ContextType": {
604
- "type": "string",
605
- "enum": [
606
- "workflow_execution",
607
- "workflow_task",
608
- "workflow_configuration",
609
- "journey_configuration",
610
- "entity"
611
- ]
612
- },
613
- "NoteEntity": {
614
- "allOf": [
615
- {
616
- "$ref": "#/components/schemas/Entity"
617
- }
618
- ],
619
- "type": "object",
620
- "properties": {
621
- "context_entities": {
622
- "type": "array",
623
- "items": {
624
- "$ref": "#/components/schemas/Entity"
625
- }
626
- },
627
- "parent": {
628
- "type": "array",
629
- "items": {
630
- "$ref": "#/components/schemas/NoteEntity"
631
- }
632
- },
633
- "attachments": {
634
- "type": "array",
635
- "items": {
636
- "$ref": "#/components/schemas/Entity"
637
- }
638
- },
639
- "comments": {
640
- "type": "array",
641
- "items": {
642
- "$ref": "#/components/schemas/NoteEntity"
643
- }
644
- },
645
- "content": {
646
- "type": "string",
647
- "description": "The content of the Note"
648
- },
649
- "contexts": {
650
- "type": "array",
651
- "items": {
652
- "type": "object",
653
- "properties": {
654
- "type": {
655
- "$ref": "#/components/schemas/ContextType"
656
- },
657
- "id": {
658
- "type": "string"
659
- }
660
- },
661
- "required": [
662
- "type",
663
- "id"
664
- ]
665
- }
666
- },
667
- "pinned_at": {
668
- "type": "string",
669
- "description": "The timestamp of when this Note was pinned",
670
- "format": "date-time"
671
- },
672
- "edited_at": {
673
- "type": "string",
674
- "description": "The timestamp of when this Note was last updated",
675
- "format": "date-time"
676
- },
677
- "created_by": {
678
- "type": "object",
679
- "properties": {
680
- "type": {
681
- "$ref": "#/components/schemas/CreatedByType"
682
- },
683
- "user_id": {
684
- "type": "string"
685
- },
686
- "display_name": {
687
- "type": "string"
688
- },
689
- "org_id": {
690
- "type": "string"
691
- },
692
- "email": {
693
- "type": "string"
694
- },
695
- "phone": {
696
- "type": "string"
697
- }
698
- },
699
- "required": [
700
- "type"
701
- ]
702
- },
703
- "read_by": {
704
- "type": "array",
705
- "items": {
706
- "type": "string"
707
- },
708
- "description": "List of user IDs who have read this note"
709
- },
710
- "reactions": {
711
- "type": "object",
712
- "additionalProperties": {
713
- "type": "array",
714
- "items": {
715
- "type": "string"
716
- }
717
- },
718
- "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
719
- }
720
- },
721
- "description": "A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place."
722
- },
723
- "Entity": {
724
- "type": "object",
725
- "properties": {
726
- "_id": {
727
- "type": "string",
728
- "description": "Entity ID of the Note entry"
729
- },
730
- "_org": {
731
- "type": "string",
732
- "description": "ID of the Organization that owns this Note"
733
- },
734
- "_schema": {
735
- "type": "string",
736
- "description": "The Entity schema of this Note"
737
- },
738
- "_created_at": {
739
- "type": "string",
740
- "description": "The timestamp of when this Note was created",
741
- "format": "date-time"
742
- },
743
- "_updated_at": {
744
- "type": "string",
745
- "description": "The timestamp of when this Note was last updated",
746
- "format": "date-time"
747
- },
748
- "_created_by": {
749
- "anyOf": [
750
- {
751
- "type": "string"
752
- },
753
- {
754
- "type": "number"
755
- }
756
- ],
757
- "description": "The Entity ID of the User that created this Note"
758
- },
759
- "_tags": {
760
- "type": "array",
761
- "items": {
762
- "type": "string"
763
- },
764
- "description": "Tags associated with this Note"
765
- },
766
- "_acl": {
767
- "type": "object",
768
- "additionalProperties": {
769
- "type": "array",
770
- "items": {
771
- "type": "string"
772
- }
773
- },
774
- "description": "Access Control List for this Note entry"
775
- },
776
- "_owners": {
777
- "type": "array",
778
- "items": {
779
- "type": "object",
780
- "properties": {
781
- "org_id": {
782
- "type": "string"
783
- },
784
- "user_id": {
785
- "type": "string"
786
- }
787
- },
788
- "required": [
789
- "org_id",
790
- "user_id"
791
- ]
792
- }
793
- },
794
- "type": {
795
- "type": "string",
796
- "description": "Entity ID of the Note entry"
797
- }
798
- },
799
- "required": [
800
- "_id"
801
- ],
802
- "description": "Base Entity schema"
803
- },
804
- "CreatedByType": {
805
- "type": "string",
806
- "enum": [
807
- "user",
808
- "group"
809
- ]
810
- },
811
- "NoteGetRequestResponse": {
812
- "allOf": [
813
- {
814
- "$ref": "#/components/schemas/Entity"
815
- }
816
- ],
817
- "type": "object",
818
- "properties": {
819
- "context_entities": {
820
- "type": "array",
821
- "items": {
822
- "$ref": "#/components/schemas/Entity"
823
- }
824
- },
825
- "parent": {
826
- "type": "array",
827
- "items": {
828
- "$ref": "#/components/schemas/NoteEntity"
829
- }
830
- },
831
- "attachments": {
832
- "type": "array",
833
- "items": {
834
- "$ref": "#/components/schemas/Entity"
835
- }
836
- },
837
- "comments": {
838
- "type": "array",
839
- "items": {
840
- "$ref": "#/components/schemas/NoteEntity"
841
- }
842
- },
843
- "content": {
844
- "type": "string",
845
- "description": "The content of the Note"
846
- },
847
- "contexts": {
848
- "type": "array",
849
- "items": {
850
- "type": "object",
851
- "properties": {
852
- "type": {
853
- "$ref": "#/components/schemas/ContextType"
854
- },
855
- "id": {
856
- "type": "string"
857
- }
858
- },
859
- "required": [
860
- "type",
861
- "id"
862
- ]
863
- }
864
- },
865
- "pinned_at": {
866
- "type": "string",
867
- "description": "The timestamp of when this Note was pinned",
868
- "format": "date-time"
869
- },
870
- "edited_at": {
871
- "type": "string",
872
- "description": "The timestamp of when this Note was last updated",
873
- "format": "date-time"
874
- },
875
- "created_by": {
876
- "type": "object",
877
- "properties": {
878
- "type": {
879
- "$ref": "#/components/schemas/CreatedByType"
880
- },
881
- "user_id": {
882
- "type": "string"
883
- },
884
- "display_name": {
885
- "type": "string"
886
- },
887
- "org_id": {
888
- "type": "string"
889
- },
890
- "email": {
891
- "type": "string"
892
- },
893
- "phone": {
894
- "type": "string"
895
- }
896
- },
897
- "required": [
898
- "type"
899
- ]
900
- },
901
- "read_by": {
902
- "type": "array",
903
- "items": {
904
- "type": "string"
905
- },
906
- "description": "List of user IDs who have read this note"
907
- },
908
- "reactions": {
909
- "type": "object",
910
- "additionalProperties": {
911
- "type": "array",
912
- "items": {
913
- "type": "string"
914
- }
915
- },
916
- "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
917
- }
918
- }
919
- },
920
- "NotePatchRequestBody": {
921
- "type": "object",
922
- "properties": {
923
- "_tags": {
924
- "type": "array",
925
- "items": {
926
- "type": "string"
927
- },
928
- "description": "Tags associated with this Note"
929
- },
930
- "type": {
931
- "type": "string",
932
- "description": "Entity ID of the Note entry"
933
- },
934
- "attachments": {
935
- "type": "object",
936
- "properties": {
937
- "$relation": {
938
- "type": "array",
939
- "items": {
940
- "type": "object",
941
- "properties": {
942
- "entity_id": {
943
- "type": "string"
944
- }
945
- },
946
- "required": [
947
- "entity_id"
948
- ]
949
- }
950
- }
951
- },
952
- "description": "The Note's parent Note"
953
- },
954
- "comments": {
955
- "type": "array",
956
- "items": {
957
- "$ref": "#/components/schemas/NonHydratedNoteEntity"
958
- }
959
- },
960
- "content": {
961
- "type": "string",
962
- "description": "The content of the Note"
963
- },
964
- "contexts": {
965
- "type": "array",
966
- "items": {
967
- "type": "object",
968
- "properties": {
969
- "type": {
970
- "$ref": "#/components/schemas/ContextType"
971
- },
972
- "id": {
973
- "type": "string"
974
- }
975
- },
976
- "required": [
977
- "type",
978
- "id"
979
- ]
980
- }
981
- },
982
- "pinned_at": {
983
- "type": "string",
984
- "description": "The timestamp of when this Note was pinned",
985
- "format": "date-time"
986
- },
987
- "created_by": {
988
- "type": "object",
989
- "properties": {
990
- "type": {
991
- "type": "string",
992
- "enum": [
993
- "user",
994
- "group"
995
- ]
996
- },
997
- "user_id": {
998
- "type": "string"
999
- },
1000
- "display_name": {
1001
- "type": "string"
1002
- },
1003
- "org_id": {
1004
- "type": "string"
1005
- },
1006
- "email": {
1007
- "type": "string"
1008
- },
1009
- "phone": {
1010
- "type": "string"
1011
- }
1012
- },
1013
- "required": [
1014
- "type"
1015
- ]
1016
- },
1017
- "read_by": {
1018
- "type": "array",
1019
- "items": {
1020
- "type": "string"
1021
- },
1022
- "description": "List of user IDs who have read this note"
1023
- },
1024
- "reactions": {
1025
- "type": "object",
1026
- "additionalProperties": {
1027
- "type": "array",
1028
- "items": {
1029
- "type": "string"
1030
- }
1031
- },
1032
- "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
1033
- }
1034
- }
1035
- },
1036
- "NonHydratedNoteEntity": {
1037
- "allOf": [
1038
- {
1039
- "$ref": "#/components/schemas/Entity"
1040
- }
1041
- ],
1042
- "type": "object",
1043
- "properties": {
1044
- "context_entities": {
1045
- "type": "object",
1046
- "properties": {
1047
- "$relation": {
1048
- "type": "array",
1049
- "items": {
1050
- "type": "object",
1051
- "properties": {
1052
- "entity_id": {
1053
- "type": "string"
1054
- }
1055
- },
1056
- "required": [
1057
- "entity_id"
1058
- ]
1059
- }
1060
- }
1061
- },
1062
- "required": [
1063
- "$relation"
1064
- ]
1065
- },
1066
- "parent": {
1067
- "$ref": "#/components/schemas/NoteEntityParent"
1068
- },
1069
- "attachments": {
1070
- "type": "object",
1071
- "properties": {
1072
- "$relation": {
1073
- "type": "array",
1074
- "items": {
1075
- "type": "object",
1076
- "properties": {
1077
- "entity_id": {
1078
- "type": "string"
1079
- }
1080
- },
1081
- "required": [
1082
- "entity_id"
1083
- ]
1084
- }
1085
- }
1086
- },
1087
- "description": "The Note's parent Note"
1088
- },
1089
- "comments": {
1090
- "type": "array",
1091
- "items": {
1092
- "$ref": "#/components/schemas/NonHydratedNoteEntity"
1093
- }
1094
- },
1095
- "content": {
1096
- "type": "string",
1097
- "description": "The content of the Note"
1098
- },
1099
- "contexts": {
1100
- "type": "array",
1101
- "items": {
1102
- "type": "object",
1103
- "properties": {
1104
- "type": {
1105
- "$ref": "#/components/schemas/ContextType"
1106
- },
1107
- "id": {
1108
- "type": "string"
1109
- }
1110
- },
1111
- "required": [
1112
- "type",
1113
- "id"
1114
- ]
1115
- }
1116
- },
1117
- "pinned_at": {
1118
- "type": "string",
1119
- "description": "The timestamp of when this Note was pinned",
1120
- "format": "date-time"
1121
- },
1122
- "created_by": {
1123
- "type": "object",
1124
- "properties": {
1125
- "type": {
1126
- "type": "string",
1127
- "enum": [
1128
- "user",
1129
- "group"
1130
- ]
1131
- },
1132
- "user_id": {
1133
- "type": "string"
1134
- },
1135
- "display_name": {
1136
- "type": "string"
1137
- },
1138
- "org_id": {
1139
- "type": "string"
1140
- },
1141
- "email": {
1142
- "type": "string"
1143
- },
1144
- "phone": {
1145
- "type": "string"
1146
- }
1147
- },
1148
- "required": [
1149
- "type"
1150
- ]
1151
- },
1152
- "read_by": {
1153
- "type": "array",
1154
- "items": {
1155
- "type": "string"
1156
- },
1157
- "description": "List of user IDs who have read this note"
1158
- },
1159
- "reactions": {
1160
- "type": "object",
1161
- "additionalProperties": {
1162
- "type": "array",
1163
- "items": {
1164
- "type": "string"
1165
- }
1166
- },
1167
- "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
1168
- }
1169
- },
1170
- "required": [
1171
- "context_entities"
1172
- ],
1173
- "description": "A note Entity object cotaining Entity metadata and content. Relational attributes are not hydrated in place."
1174
- },
1175
- "NoteEntityParent": {
1176
- "type": "object",
1177
- "properties": {
1178
- "$relation": {
1179
- "type": "array",
1180
- "items": {
1181
- "type": "object",
1182
- "properties": {
1183
- "entity_id": {
1184
- "type": "string"
1185
- }
1186
- },
1187
- "required": [
1188
- "entity_id"
1189
- ]
1190
- }
1191
- }
1192
- },
1193
- "description": "The Note's parent Note"
1194
- },
1195
- "NotePutRequestBody": {
1196
- "type": "object",
1197
- "properties": {
1198
- "_id": {
1199
- "type": "string",
1200
- "description": "Entity ID of the Note entry"
1201
- },
1202
- "_org": {
1203
- "type": "string",
1204
- "description": "ID of the Organization that owns this Note"
1205
- },
1206
- "_schema": {
1207
- "type": "string",
1208
- "description": "The Entity schema of this Note"
1209
- },
1210
- "_created_at": {
1211
- "type": "string",
1212
- "description": "The timestamp of when this Note was created",
1213
- "format": "date-time"
1214
- },
1215
- "_updated_at": {
1216
- "type": "string",
1217
- "description": "The timestamp of when this Note was last updated",
1218
- "format": "date-time"
1219
- },
1220
- "_created_by": {
1221
- "anyOf": [
1222
- {
1223
- "type": "string"
1224
- },
1225
- {
1226
- "type": "number"
1227
- }
1228
- ],
1229
- "description": "The Entity ID of the User that created this Note"
1230
- },
1231
- "_tags": {
1232
- "type": "array",
1233
- "items": {
1234
- "type": "string"
1235
- },
1236
- "description": "Tags associated with this Note"
1237
- },
1238
- "_acl": {
1239
- "type": "object",
1240
- "additionalProperties": {
1241
- "type": "array",
1242
- "items": {
1243
- "type": "string"
1244
- }
1245
- },
1246
- "description": "Access Control List for this Note entry"
1247
- },
1248
- "_owners": {
1249
- "type": "array",
1250
- "items": {
1251
- "type": "object",
1252
- "properties": {
1253
- "org_id": {
1254
- "type": "string"
1255
- },
1256
- "user_id": {
1257
- "type": "string"
1258
- }
1259
- },
1260
- "required": [
1261
- "org_id",
1262
- "user_id"
1263
- ]
1264
- }
1265
- },
1266
- "type": {
1267
- "type": "string",
1268
- "description": "Entity ID of the Note entry"
1269
- },
1270
- "context_entities": {
1271
- "type": "object",
1272
- "properties": {
1273
- "$relation": {
1274
- "type": "array",
1275
- "items": {
1276
- "type": "object",
1277
- "properties": {
1278
- "entity_id": {
1279
- "type": "string"
1280
- }
1281
- },
1282
- "required": [
1283
- "entity_id"
1284
- ]
1285
- }
1286
- }
1287
- },
1288
- "required": [
1289
- "$relation"
1290
- ]
1291
- },
1292
- "parent": {
1293
- "$ref": "#/components/schemas/NoteEntityParent"
1294
- },
1295
- "attachments": {
1296
- "type": "object",
1297
- "properties": {
1298
- "$relation": {
1299
- "type": "array",
1300
- "items": {
1301
- "type": "object",
1302
- "properties": {
1303
- "entity_id": {
1304
- "type": "string"
1305
- }
1306
- },
1307
- "required": [
1308
- "entity_id"
1309
- ]
1310
- }
1311
- }
1312
- },
1313
- "description": "The Note's parent Note"
1314
- },
1315
- "content": {
1316
- "type": "string",
1317
- "description": "The content of the Note"
1318
- },
1319
- "contexts": {
1320
- "type": "array",
1321
- "items": {
1322
- "type": "object",
1323
- "properties": {
1324
- "type": {
1325
- "$ref": "#/components/schemas/ContextType"
1326
- },
1327
- "id": {
1328
- "type": "string"
1329
- }
1330
- },
1331
- "required": [
1332
- "type",
1333
- "id"
1334
- ]
1335
- }
1336
- },
1337
- "pinned_at": {
1338
- "type": "string",
1339
- "description": "The timestamp of when this Note was pinned",
1340
- "format": "date-time"
1341
- },
1342
- "created_by": {
1343
- "type": "object",
1344
- "properties": {
1345
- "type": {
1346
- "type": "string",
1347
- "enum": [
1348
- "user",
1349
- "group"
1350
- ]
1351
- },
1352
- "user_id": {
1353
- "type": "string"
1354
- },
1355
- "display_name": {
1356
- "type": "string"
1357
- },
1358
- "org_id": {
1359
- "type": "string"
1360
- },
1361
- "email": {
1362
- "type": "string"
1363
- },
1364
- "phone": {
1365
- "type": "string"
1366
- }
1367
- },
1368
- "required": [
1369
- "type"
1370
- ]
1371
- },
1372
- "read_by": {
1373
- "type": "array",
1374
- "items": {
1375
- "type": "string"
1376
- },
1377
- "description": "List of user IDs who have read this note"
1378
- },
1379
- "reactions": {
1380
- "type": "object",
1381
- "additionalProperties": {
1382
- "type": "array",
1383
- "items": {
1384
- "type": "string"
1385
- }
1386
- },
1387
- "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
1388
- }
1389
- }
1390
- },
1391
- "NoteSearchByContextRequestBody": {
1392
- "type": "object",
1393
- "properties": {
1394
- "contexts": {
1395
- "type": "array",
1396
- "items": {
1397
- "type": "object",
1398
- "properties": {
1399
- "type": {
1400
- "$ref": "#/components/schemas/ContextType"
1401
- },
1402
- "id": {
1403
- "type": "string"
1404
- }
1405
- },
1406
- "required": [
1407
- "type",
1408
- "id"
1409
- ]
1410
- }
1411
- },
1412
- "from": {
1413
- "type": "number",
1414
- "default": 0,
1415
- "description": "The index of the first Note to return in this query"
1416
- },
1417
- "size": {
1418
- "type": "number",
1419
- "default": 10,
1420
- "description": "The number of Note entries to return in this query"
1421
- }
1422
- },
1423
- "required": [
1424
- "contexts"
1425
- ]
1426
- },
1427
- "NotesSearchRequestResponse": {
1428
- "type": "object",
1429
- "properties": {
1430
- "hits": {
1431
- "type": "number",
1432
- "description": "The number of Note entries returned in this query"
1433
- },
1434
- "results": {
1435
- "type": "array",
1436
- "items": {
1437
- "$ref": "#/components/schemas/NoteEntity"
1438
- },
1439
- "description": "The Note entries returned in this query"
1440
- }
1441
- },
1442
- "required": [
1443
- "results"
1444
- ]
1445
- },
1446
- "NoteContexts": {
1447
- "type": "object",
1448
- "properties": {
1449
- "type": {
1450
- "$ref": "#/components/schemas/ContextType"
1451
- },
1452
- "context": {
1453
- "anyOf": [
1454
- {
1455
- "$ref": "#/components/schemas/Entity"
1456
- },
1457
- {
1458
- "$ref": "#/components/schemas/WorkflowExecution"
1459
- }
1460
- ]
1461
- }
1462
- },
1463
- "required": [
1464
- "type",
1465
- "context"
1466
- ],
1467
- "description": "List of resolved Entity and non-Entity contexts attached to a given Note."
1468
- },
1469
- "WorkflowExecution": {
1470
- "type": "object",
1471
- "properties": {
1472
- "id": {
1473
- "type": "string"
1474
- },
1475
- "definitionId": {
1476
- "type": "string"
1477
- },
1478
- "orgId": {
1479
- "type": "string"
1480
- },
1481
- "name": {
1482
- "type": "string"
1483
- }
1484
- },
1485
- "required": [
1486
- "id",
1487
- "definitionId",
1488
- "orgId",
1489
- "name"
1490
- ],
1491
- "description": "Base metadata for a Workflow Execution. This is a lightweight representation of a Workflow Execution, and does not contain all it's data"
1492
- },
1493
- "ReactionRequest": {
1494
- "type": "object",
1495
- "properties": {
1496
- "emoji": {
1497
- "type": "string",
1498
- "minLength": 1,
1499
- "maxLength": 50,
1500
- "description": "The emoji identifier (e.g., 'thumbs-up', 'heart', 'thinking-face')",
1501
- "example": "thumbs-up"
1502
- }
1503
- },
1504
- "required": [
1505
- "emoji"
1506
- ]
1507
- },
1508
- "ToggleReactionsRequest": {
1509
- "type": "object",
1510
- "properties": {
1511
- "emojis": {
1512
- "type": "array",
1513
- "items": {
1514
- "type": "string",
1515
- "minLength": 1,
1516
- "maxLength": 50
1517
- },
1518
- "description": "Array of emoji identifiers to toggle (e.g., ['thumbs-up', 'heart', 'thinking-face'])",
1519
- "example": [
1520
- "thumbs-up",
1521
- "heart"
1522
- ]
1523
- }
1524
- },
1525
- "required": [
1526
- "emojis"
1527
- ]
1528
- }
1529
- }
1530
- }
1531
- }