@epilot/sdk 2.4.4-alpha.0 → 2.5.0
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.
- package/definitions/app.json +137 -58
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +496 -24
- package/definitions/entity.json +185 -8
- package/definitions/webhooks-runtime.json +1 -1
- package/definitions/webhooks.json +134 -4
- package/dist/access-token.d-CnmUTOlq.d.cts +552 -0
- package/dist/access-token.d-CnmUTOlq.d.ts +552 -0
- package/dist/address-suggestions.d-_YwTOR-9.d.cts +339 -0
- package/dist/address-suggestions.d-_YwTOR-9.d.ts +339 -0
- package/dist/address.d-CwAPOVxa.d.cts +437 -0
- package/dist/address.d-CwAPOVxa.d.ts +437 -0
- package/dist/ai-agents.d-OkXfr2bz.d.cts +1339 -0
- package/dist/ai-agents.d-OkXfr2bz.d.ts +1339 -0
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.d.cts +18 -0
- package/dist/apis/access-token.d.ts +12 -9
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.d.cts +18 -0
- package/dist/apis/address-suggestions.d.ts +12 -9
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.d.cts +18 -0
- package/dist/apis/address.d.ts +12 -9
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.d.cts +18 -0
- package/dist/apis/ai-agents.d.ts +12 -9
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +8 -8
- package/dist/apis/app.d.cts +18 -0
- package/dist/apis/app.d.ts +12 -9
- package/dist/apis/app.js +2 -2
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.d.cts +18 -0
- package/dist/apis/audit-logs.d.ts +12 -9
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.d.cts +18 -0
- package/dist/apis/automation.d.ts +12 -9
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.d.cts +18 -0
- package/dist/apis/billing.d.ts +12 -9
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.d.cts +18 -0
- package/dist/apis/blueprint-manifest.d.ts +12 -9
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.d.cts +18 -0
- package/dist/apis/calendar.d.ts +12 -9
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.d.cts +18 -0
- package/dist/apis/configuration-hub.d.ts +12 -9
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.d.cts +18 -0
- package/dist/apis/consent.d.ts +12 -9
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +18 -0
- package/dist/apis/customer-portal.d.ts +12 -9
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.d.cts +18 -0
- package/dist/apis/dashboard.d.ts +12 -9
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.d.cts +18 -0
- package/dist/apis/data-governance.d.ts +12 -9
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.d.cts +18 -0
- package/dist/apis/deduplication.d.ts +12 -9
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.d.cts +18 -0
- package/dist/apis/design.d.ts +12 -9
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.d.cts +18 -0
- package/dist/apis/document.d.ts +12 -9
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.d.cts +18 -0
- package/dist/apis/email-settings.d.ts +12 -9
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.d.cts +18 -0
- package/dist/apis/email-template.d.ts +12 -9
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.d.cts +18 -0
- package/dist/apis/entity-mapping.d.ts +12 -9
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.d.cts +18 -0
- package/dist/apis/entity.d.ts +12 -9
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.d.cts +18 -0
- package/dist/apis/environments.d.ts +12 -9
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.d.cts +18 -0
- package/dist/apis/event-catalog.d.ts +12 -9
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.d.cts +18 -0
- package/dist/apis/file.d.ts +12 -9
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.d.cts +18 -0
- package/dist/apis/iban.d.ts +12 -9
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.d.cts +18 -0
- package/dist/apis/integration-toolkit.d.ts +12 -9
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.cts +18 -0
- package/dist/apis/journey.d.ts +12 -9
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.d.cts +18 -0
- package/dist/apis/kanban.d.ts +12 -9
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.d.cts +18 -0
- package/dist/apis/message.d.ts +12 -9
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.d.cts +18 -0
- package/dist/apis/metering.d.ts +12 -9
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.d.cts +18 -0
- package/dist/apis/notes.d.ts +12 -9
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.d.cts +18 -0
- package/dist/apis/notification.d.ts +12 -9
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.d.cts +18 -0
- package/dist/apis/organization.d.ts +12 -9
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.d.cts +18 -0
- package/dist/apis/partner-directory.d.ts +12 -9
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.d.cts +18 -0
- package/dist/apis/permissions.d.ts +12 -9
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.d.cts +18 -0
- package/dist/apis/pricing-tier.d.ts +12 -9
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.d.cts +18 -0
- package/dist/apis/pricing.d.ts +12 -9
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.d.cts +18 -0
- package/dist/apis/purpose.d.ts +12 -9
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.d.cts +18 -0
- package/dist/apis/query.d.ts +12 -9
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.d.cts +18 -0
- package/dist/apis/sandbox.d.ts +12 -9
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.d.cts +18 -0
- package/dist/apis/sharing.d.ts +12 -9
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.d.cts +18 -0
- package/dist/apis/submission.d.ts +12 -9
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.d.cts +597 -0
- package/dist/apis/target.d.ts +591 -9
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.d.cts +18 -0
- package/dist/apis/targeting.d.ts +12 -9
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.d.cts +18 -0
- package/dist/apis/template-variables.d.ts +12 -9
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.d.cts +18 -0
- package/dist/apis/user.d.ts +12 -9
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.d.cts +18 -0
- package/dist/apis/validation-rules.d.ts +12 -9
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +8 -8
- package/dist/apis/webhooks.d.cts +18 -0
- package/dist/apis/webhooks.d.ts +12 -9
- package/dist/apis/webhooks.js +2 -2
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.d.cts +18 -0
- package/dist/apis/workflow-definition.d.ts +12 -9
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.d.cts +18 -0
- package/dist/apis/workflow.d.ts +12 -9
- package/dist/apis/workflow.js +1 -1
- package/dist/app-34OBBTA4.js +7 -0
- package/dist/app-SSF545U7.cjs +7 -0
- package/dist/app-runtime-AFNM67YN.cjs +5 -0
- package/dist/{app-runtime-U7RGV7KT.js → app-runtime-DBUXZL6E.js} +1 -1
- package/dist/app.d--5n0FQQ4.d.cts +3757 -0
- package/dist/app.d--5n0FQQ4.d.ts +3757 -0
- package/dist/audit-logs.d-BRToFqeX.d.cts +287 -0
- package/dist/audit-logs.d-BRToFqeX.d.ts +287 -0
- package/dist/automation.d-Du6-uiz5.d.cts +5283 -0
- package/dist/automation.d-Du6-uiz5.d.ts +5283 -0
- package/dist/billing.d-Bs8Ku9qE.d.cts +993 -0
- package/dist/billing.d-Bs8Ku9qE.d.ts +993 -0
- package/dist/bin/cli.js +1 -1
- package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +4343 -0
- package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +4343 -0
- package/dist/calendar.d-BEjLDagH.d.cts +353 -0
- package/dist/calendar.d-BEjLDagH.d.ts +353 -0
- package/dist/chunk-5OBMZHRL.cjs +14 -0
- package/dist/{chunk-CD4OX2U6.cjs → chunk-C7GDYBXX.cjs} +9 -9
- package/dist/{chunk-L66IX6GX.cjs → chunk-KMVJYNLB.cjs} +1 -1
- package/dist/chunk-KYCVV2XE.cjs +14 -0
- package/dist/chunk-RGO3LTAM.js +14 -0
- package/dist/{chunk-TSV242UN.js → chunk-WRD2XFHY.js} +9 -9
- package/dist/{chunk-LLZYRINH.js → chunk-Z4H2FZ2K.js} +1 -1
- package/dist/chunk-Z6HGUGXK.js +14 -0
- package/dist/configuration-hub.d-Cqaq2F-W.d.cts +478 -0
- package/dist/configuration-hub.d-Cqaq2F-W.d.ts +478 -0
- package/dist/consent.d-C2PROHhX.d.cts +265 -0
- package/dist/consent.d-C2PROHhX.d.ts +265 -0
- package/dist/customer-portal-5I7ZGQDU.cjs +7 -0
- package/dist/customer-portal-YL2YMPZL.js +7 -0
- package/dist/{customer-portal-runtime-PSM55KGU.js → customer-portal-runtime-N4NWQ67M.js} +1 -1
- package/dist/{customer-portal-runtime-DULJLR7F.cjs → customer-portal-runtime-OEXTSMSE.cjs} +2 -2
- package/dist/customer-portal.d-ChSEioI5.d.cts +17113 -0
- package/dist/customer-portal.d-ChSEioI5.d.ts +17113 -0
- package/dist/dashboard.d-CsGcA74I.d.cts +440 -0
- package/dist/dashboard.d-CsGcA74I.d.ts +440 -0
- package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
- package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
- package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
- package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
- package/dist/design.d-BRre8iLg.d.cts +2346 -0
- package/dist/design.d-BRre8iLg.d.ts +2346 -0
- package/dist/document.d-DN37pjdx.d.cts +648 -0
- package/dist/document.d-DN37pjdx.d.ts +648 -0
- package/dist/email-settings.d-B7Q_xT25.d.cts +2417 -0
- package/dist/email-settings.d-B7Q_xT25.d.ts +2417 -0
- package/dist/email-template.d-gtQkdaXM.d.cts +1188 -0
- package/dist/email-template.d-gtQkdaXM.d.ts +1188 -0
- package/dist/entity-SS36LQO6.cjs +7 -0
- package/dist/entity-Z4YWKDVG.js +7 -0
- package/dist/entity-mapping.d-DKSW3sfy.d.cts +1092 -0
- package/dist/entity-mapping.d-DKSW3sfy.d.ts +1092 -0
- package/dist/entity.d-fospShiN.d.cts +18544 -0
- package/dist/entity.d-fospShiN.d.ts +18544 -0
- package/dist/environments.d-BvqvN-PD.d.cts +382 -0
- package/dist/environments.d-BvqvN-PD.d.ts +382 -0
- package/dist/event-catalog.d-ENw6HO-w.d.cts +1511 -0
- package/dist/event-catalog.d-ENw6HO-w.d.ts +1511 -0
- package/dist/file.d-DcTJxjp7.d.cts +2992 -0
- package/dist/file.d-DcTJxjp7.d.ts +2992 -0
- package/dist/iban.d-BwdiGbxi.d.cts +70 -0
- package/dist/iban.d-BwdiGbxi.d.ts +70 -0
- package/dist/index.cjs +14 -14
- package/dist/index.d.cts +182 -0
- package/dist/index.d.ts +182 -12
- package/dist/index.js +4 -4
- package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +5796 -0
- package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +5796 -0
- package/dist/journey.d-ClXO0xK8.d.cts +1931 -0
- package/dist/journey.d-ClXO0xK8.d.ts +1931 -0
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/dist/kanban.d-BHnSRCYW.d.cts +760 -0
- package/dist/kanban.d-BHnSRCYW.d.ts +760 -0
- package/dist/message.d-B5UuSqgw.d.cts +3811 -0
- package/dist/message.d-B5UuSqgw.d.ts +3811 -0
- package/dist/metering.d-DvtPv7wk.d.cts +1841 -0
- package/dist/metering.d-DvtPv7wk.d.ts +1841 -0
- package/dist/notes-K2IIFCX3.cjs +7 -0
- package/dist/notes-Q7JGS7O3.js +7 -0
- package/dist/notes.d-BcV_m5fe.d.cts +1068 -0
- package/dist/notes.d-BcV_m5fe.d.ts +1068 -0
- package/dist/notification.d-BfBL3lga.d.cts +1147 -0
- package/dist/notification.d-BfBL3lga.d.ts +1147 -0
- package/dist/organization.d-DqwnNxMg.d.cts +1271 -0
- package/dist/organization.d-DqwnNxMg.d.ts +1271 -0
- package/dist/partner-directory.d-BCIjHoGs.d.cts +2337 -0
- package/dist/partner-directory.d-BCIjHoGs.d.ts +2337 -0
- package/dist/permissions.d-l6AT8SYP.d.cts +1279 -0
- package/dist/permissions.d-l6AT8SYP.d.ts +1279 -0
- package/dist/{pricing-XAET4G7T.cjs → pricing-FODHQFCB.cjs} +1 -1
- package/dist/{pricing-G67CH3XH.js → pricing-XRIDVZFC.js} +1 -1
- package/dist/pricing-tier.d-Cg0jl6n_.d.cts +81 -0
- package/dist/pricing-tier.d-Cg0jl6n_.d.ts +81 -0
- package/dist/pricing.d-BHpMU4KU.d.cts +12255 -0
- package/dist/pricing.d-BHpMU4KU.d.ts +12255 -0
- package/dist/purpose.d-CbIYfTua.d.cts +372 -0
- package/dist/purpose.d-CbIYfTua.d.ts +372 -0
- package/dist/query.d-Cmp78IhZ.d.cts +2375 -0
- package/dist/query.d-Cmp78IhZ.d.ts +2375 -0
- package/dist/sandbox.d-BdbOFzDu.d.cts +465 -0
- package/dist/sandbox.d-BdbOFzDu.d.ts +465 -0
- package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
- package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
- package/dist/submission.d-BamwfhXw.d.cts +469 -0
- package/dist/submission.d-BamwfhXw.d.ts +469 -0
- package/dist/targeting.d-BNmcVsNS.d.cts +2057 -0
- package/dist/targeting.d-BNmcVsNS.d.ts +2057 -0
- package/dist/template-variables.d-Ble9TSBa.d.cts +1320 -0
- package/dist/template-variables.d-Ble9TSBa.d.ts +1320 -0
- package/dist/types-ChU9Acbv.d.cts +37 -0
- package/dist/types-ChU9Acbv.d.ts +37 -0
- package/dist/user.d-D18fe97W.d.cts +2270 -0
- package/dist/user.d-D18fe97W.d.ts +2270 -0
- package/dist/validation-rules.d-Db5c5zTf.d.cts +807 -0
- package/dist/validation-rules.d-Db5c5zTf.d.ts +807 -0
- package/dist/webhooks-NZ3TM3AY.cjs +7 -0
- package/dist/webhooks-XLBUXXCS.js +7 -0
- package/dist/{webhooks-runtime-EBM4M3SU.cjs → webhooks-runtime-QVAFNBDW.cjs} +2 -2
- package/dist/{webhooks-runtime-XCQYIGQK.js → webhooks-runtime-UYTPQQVG.js} +1 -1
- package/dist/webhooks.d-D79qib9f.d.cts +1366 -0
- package/dist/webhooks.d-D79qib9f.d.ts +1366 -0
- package/dist/workflow-definition.d-DOeb0KVV.d.cts +1922 -0
- package/dist/workflow-definition.d-DOeb0KVV.d.ts +1922 -0
- package/dist/workflow.d-CMSKt8oN.d.cts +3151 -0
- package/dist/workflow.d-CMSKt8oN.d.ts +3151 -0
- package/docs/app.md +244 -9
- package/docs/customer-portal.md +340 -113
- package/docs/entity.md +65 -0
- package/docs/notes.md +19 -12
- package/docs/pricing.md +3 -1
- package/docs/webhooks.md +49 -0
- package/package.json +1 -1
- package/dist/apis/_registry.d.ts +0 -8
- package/dist/app-5KSVSKDU.js +0 -7
- package/dist/app-PL3IOROO.cjs +0 -7
- package/dist/app-runtime-SSNHSBR7.cjs +0 -5
- package/dist/authorize.d.ts +0 -3
- package/dist/bin/cli.d.ts +0 -1
- package/dist/chunk-2MMSXUOL.cjs +0 -14
- package/dist/chunk-A7AAVJGM.js +0 -14
- package/dist/chunk-GVNT76UU.js +0 -14
- package/dist/chunk-HHMXS5NC.cjs +0 -14
- package/dist/client-factory.d.ts +0 -9
- package/dist/client-map.d.ts +0 -102
- package/dist/compact.d.ts +0 -22
- package/dist/customer-portal-5LMHNBMD.cjs +0 -7
- package/dist/customer-portal-RZACUF4N.js +0 -7
- package/dist/entity-H6ESUH3Y.js +0 -7
- package/dist/entity-ZVDKWQSF.cjs +0 -7
- package/dist/help.d.ts +0 -12
- package/dist/large-response.d.ts +0 -9
- package/dist/notes-3AO5GXIT.js +0 -7
- package/dist/notes-MPWOQC5J.cjs +0 -7
- package/dist/openapi.d.ts +0 -12
- package/dist/overrides.d.ts +0 -9
- package/dist/proxy.d.ts +0 -14
- package/dist/registry.d.ts +0 -19
- package/dist/retry.d.ts +0 -11
- package/dist/sdk.d.ts +0 -29
- package/dist/types.d.ts +0 -53
- package/dist/webhooks-H3RT33BF.cjs +0 -7
- package/dist/webhooks-RTOU3MS5.js +0 -7
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/notes.json
|
|
4
|
+
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';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = notes_default;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/notes.json
|
|
4
|
+
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';
|
|
5
|
+
export {
|
|
6
|
+
notes_default as default
|
|
7
|
+
};
|