@epilot/sdk 2.1.0-rc.1 → 2.1.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 +38 -0
- package/definitions/automation.json +2 -37
- package/definitions/blueprint-manifest-runtime.json +1 -1
- package/definitions/blueprint-manifest.json +115 -1
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +279 -42
- package/definitions/data-management.json +10 -0
- package/definitions/email-template.json +25 -3
- package/definitions/entity.json +205 -3
- package/definitions/erp-integration-runtime.json +1 -1
- package/definitions/erp-integration.json +472 -13
- package/definitions/journey.json +257 -12
- package/definitions/kanban.json +630 -78
- package/definitions/organization-runtime.json +1 -1
- package/definitions/organization.json +614 -51
- package/definitions/workflow.json +40 -0
- package/dist/README-VG67PX4R.js +7 -0
- package/dist/README-W4B35MRN.cjs +7 -0
- package/dist/_index-AMVZBT2K.cjs +99 -0
- package/dist/_index-S6LFD3ER.js +99 -0
- package/dist/access-token-6BJDZSFE.cjs +7 -0
- package/dist/access-token-GSQZLDXR.js +7 -0
- package/dist/address-HA4RMRNQ.cjs +7 -0
- package/dist/address-QVJUGMOG.js +7 -0
- package/dist/address-suggestions-74244BAJ.js +7 -0
- package/dist/address-suggestions-IUQMYF27.cjs +7 -0
- package/dist/ai-agents-IZWFEUSH.js +7 -0
- package/dist/ai-agents-PWHKNRCX.cjs +7 -0
- package/dist/apis/access-token.cjs +10 -8
- package/dist/apis/access-token.js +5 -3
- package/dist/apis/address-suggestions.cjs +10 -8
- package/dist/apis/address-suggestions.js +5 -3
- package/dist/apis/address.cjs +10 -8
- package/dist/apis/address.js +5 -3
- package/dist/apis/ai-agents.cjs +10 -8
- package/dist/apis/ai-agents.js +5 -3
- package/dist/apis/app.cjs +10 -8
- package/dist/apis/app.js +5 -3
- package/dist/apis/audit-logs.cjs +10 -8
- package/dist/apis/audit-logs.js +5 -3
- package/dist/apis/automation.cjs +10 -8
- package/dist/apis/automation.js +5 -3
- package/dist/apis/billing.cjs +10 -8
- package/dist/apis/billing.js +5 -3
- package/dist/apis/blueprint-manifest.cjs +10 -8
- package/dist/apis/blueprint-manifest.js +5 -3
- package/dist/apis/consent.cjs +10 -8
- package/dist/apis/consent.js +5 -3
- package/dist/apis/customer-portal.cjs +10 -8
- package/dist/apis/customer-portal.js +5 -3
- package/dist/apis/dashboard.cjs +10 -8
- package/dist/apis/dashboard.js +5 -3
- package/dist/apis/data-management.cjs +10 -8
- package/dist/apis/data-management.js +5 -3
- package/dist/apis/deduplication.cjs +10 -8
- package/dist/apis/deduplication.js +5 -3
- package/dist/apis/design.cjs +10 -8
- package/dist/apis/design.js +5 -3
- package/dist/apis/document.cjs +10 -8
- package/dist/apis/document.js +5 -3
- package/dist/apis/email-settings.cjs +10 -8
- package/dist/apis/email-settings.js +5 -3
- package/dist/apis/email-template.cjs +10 -8
- package/dist/apis/email-template.js +5 -3
- package/dist/apis/entity-mapping.cjs +10 -8
- package/dist/apis/entity-mapping.js +5 -3
- package/dist/apis/entity.cjs +10 -8
- package/dist/apis/entity.js +5 -3
- package/dist/apis/environments.cjs +10 -8
- package/dist/apis/environments.js +5 -3
- package/dist/apis/erp-integration.cjs +10 -8
- package/dist/apis/erp-integration.js +5 -3
- package/dist/apis/event-catalog.cjs +10 -8
- package/dist/apis/event-catalog.js +5 -3
- package/dist/apis/file.cjs +10 -8
- package/dist/apis/file.js +5 -3
- package/dist/apis/iban.cjs +10 -8
- package/dist/apis/iban.js +5 -3
- package/dist/apis/journey.cjs +10 -8
- package/dist/apis/journey.js +5 -3
- package/dist/apis/kanban.cjs +10 -8
- package/dist/apis/kanban.js +5 -3
- package/dist/apis/message.cjs +10 -8
- package/dist/apis/message.js +5 -3
- package/dist/apis/metering.cjs +10 -8
- package/dist/apis/metering.js +5 -3
- package/dist/apis/notes.cjs +10 -8
- package/dist/apis/notes.js +5 -3
- package/dist/apis/notification.cjs +10 -8
- package/dist/apis/notification.js +5 -3
- package/dist/apis/organization.cjs +10 -8
- package/dist/apis/organization.d.cts +2 -2
- package/dist/apis/organization.d.ts +2 -2
- package/dist/apis/organization.js +5 -3
- package/dist/apis/partner-directory.cjs +10 -8
- package/dist/apis/partner-directory.js +5 -3
- package/dist/apis/permissions.cjs +10 -8
- package/dist/apis/permissions.js +5 -3
- package/dist/apis/pricing-tier.cjs +10 -8
- package/dist/apis/pricing-tier.js +5 -3
- package/dist/apis/pricing.cjs +10 -8
- package/dist/apis/pricing.js +5 -3
- package/dist/apis/purpose.cjs +10 -8
- package/dist/apis/purpose.js +5 -3
- package/dist/apis/sandbox.cjs +10 -8
- package/dist/apis/sandbox.js +5 -3
- package/dist/apis/submission.cjs +10 -8
- package/dist/apis/submission.js +5 -3
- package/dist/apis/targeting.cjs +10 -8
- package/dist/apis/targeting.js +5 -3
- package/dist/apis/template-variables.cjs +10 -8
- package/dist/apis/template-variables.js +5 -3
- package/dist/apis/user.cjs +10 -8
- package/dist/apis/user.js +5 -3
- package/dist/apis/validation-rules.cjs +10 -8
- package/dist/apis/validation-rules.js +5 -3
- package/dist/apis/webhooks.cjs +10 -8
- package/dist/apis/webhooks.js +5 -3
- package/dist/apis/workflow-definition.cjs +10 -8
- package/dist/apis/workflow-definition.js +5 -3
- package/dist/apis/workflow.cjs +10 -8
- package/dist/apis/workflow.js +5 -3
- package/dist/app-IKHWU222.cjs +7 -0
- package/dist/app-VLM3SWKA.js +7 -0
- package/dist/audit-logs-5VXHOQ7S.js +7 -0
- package/dist/audit-logs-D2LFUA2R.cjs +7 -0
- package/dist/automation-3HGCK725.cjs +7 -0
- package/dist/automation-72VGEJCY.js +7 -0
- package/dist/billing-DUWDISHP.cjs +7 -0
- package/dist/billing-IPALEAG2.js +7 -0
- package/dist/blueprint-manifest-CXSCRQ5X.js +7 -0
- package/dist/blueprint-manifest-SHNZPK5O.cjs +7 -0
- package/dist/{chunk-6J7CIOKR.js → chunk-2HOJWFQ4.js} +1 -1
- package/dist/{chunk-BDIJHJOG.js → chunk-372VUPHN.js} +1 -1
- package/dist/{chunk-Q5TESEDZ.cjs → chunk-3HJEWWPS.cjs} +2 -2
- package/dist/{chunk-ID6BXIOZ.js → chunk-3N67SSL3.js} +1 -1
- package/dist/chunk-3XEP56SV.cjs +204 -0
- package/dist/{chunk-7KFKA3AH.cjs → chunk-3ZZ57K3S.cjs} +2 -2
- package/dist/{chunk-CVSQT5PV.cjs → chunk-4SWC43JO.cjs} +2 -2
- package/dist/{chunk-O3R6C3WW.js → chunk-4VFQTSJQ.js} +1 -1
- package/dist/{chunk-LXAJ722U.js → chunk-57QIBYDN.js} +1 -1
- package/dist/{chunk-SPZSDRM6.cjs → chunk-5SNJAD6F.cjs} +2 -2
- package/dist/{chunk-OI2M6FSB.js → chunk-73H6TVKN.js} +1 -1
- package/dist/{chunk-BB7WFIE2.cjs → chunk-A6JOROUC.cjs} +2 -2
- package/dist/{chunk-SHPXCOTN.cjs → chunk-AJKH25H2.cjs} +3 -3
- package/dist/{chunk-DBNEZWK2.cjs → chunk-ARWMTXJV.cjs} +2 -2
- package/dist/{chunk-7BPPP4M2.js → chunk-B3ZGAG7B.js} +1 -1
- package/dist/{chunk-5WN2YXNU.cjs → chunk-BH5ZXK4J.cjs} +2 -2
- package/dist/{chunk-JM6HKPSC.cjs → chunk-BWFXLUK5.cjs} +2 -2
- package/dist/{chunk-V56ZCL54.js → chunk-C6UTZEHH.js} +1 -1
- package/dist/{chunk-ZPCMZO2O.js → chunk-CPKBR34V.js} +1 -1
- package/dist/{chunk-UTQY2DSM.js → chunk-CWSHYFVZ.js} +1 -1
- package/dist/{chunk-5YVVQBA2.js → chunk-DJKSULPK.js} +1 -1
- package/dist/{chunk-XLOXC52O.js → chunk-DNJ54L2G.js} +1 -1
- package/dist/{chunk-YXPUCBVK.cjs → chunk-DY2D2IW5.cjs} +2 -2
- package/dist/{chunk-Z5LLUUFD.cjs → chunk-E26ZO7QM.cjs} +2 -2
- package/dist/{chunk-RNKZDJOY.js → chunk-EBCHCYUO.js} +1 -1
- package/dist/{chunk-4MO4WLKA.cjs → chunk-EPAIOB5U.cjs} +2 -2
- package/dist/{chunk-UX2IZQNM.cjs → chunk-EQZMT2HF.cjs} +2 -2
- package/dist/{chunk-U52A2DMK.cjs → chunk-F376L6PP.cjs} +2 -2
- package/dist/{chunk-TBBLLEB2.cjs → chunk-F472YLJG.cjs} +2 -2
- package/dist/{chunk-W3MM2BSK.cjs → chunk-FXOX3X7E.cjs} +2 -2
- package/dist/{chunk-E4IFBCNM.cjs → chunk-G2REP2VZ.cjs} +2 -2
- package/dist/{chunk-CFGXI3FX.js → chunk-GLO477NZ.js} +1 -1
- package/dist/{chunk-PBNPZ7UX.js → chunk-H4VSK4KF.js} +1 -1
- package/dist/{chunk-33TQRYMY.js → chunk-HPSGM6QP.js} +1 -1
- package/dist/{chunk-RQKN4WTW.cjs → chunk-HPYHWTTA.cjs} +2 -2
- package/dist/{chunk-5RXE7X63.js → chunk-IH4CMOML.js} +2 -2
- package/dist/{chunk-VD5TBK2T.cjs → chunk-IMT3IE5M.cjs} +2 -2
- package/dist/{chunk-DIP442PL.js → chunk-IP2WWEOU.js} +1 -1
- package/dist/{chunk-FCLW3FLF.js → chunk-IS2VB342.js} +1 -1
- package/dist/{chunk-UNHWLNE4.js → chunk-ITX53XAZ.js} +1 -1
- package/dist/{chunk-KU2XF4TS.cjs → chunk-JXBXDTFG.cjs} +2 -2
- package/dist/{chunk-Y4YQEDR3.js → chunk-K62XK7KU.js} +1 -1
- package/dist/chunk-KA3TGFJP.js +14 -0
- package/dist/{chunk-IXRDP4VP.js → chunk-KBOVBUBM.js} +1 -1
- package/dist/{chunk-MKZGM4A6.js → chunk-KPGC2D6E.js} +1 -1
- package/dist/{chunk-ZAPA4RPI.js → chunk-KSXTBGIV.js} +1 -1
- package/dist/{chunk-PLBIQ2Y7.cjs → chunk-LCIJ4TJ4.cjs} +2 -2
- package/dist/{chunk-TUAAE3UC.cjs → chunk-LQOLYXGQ.cjs} +2 -2
- package/dist/{chunk-6ADJEPMJ.js → chunk-LSIWCIQV.js} +1 -1
- package/dist/{chunk-CBRWUULQ.js → chunk-MHNSZ4HE.js} +1 -1
- package/dist/{chunk-WOOKHE7Y.cjs → chunk-MKX4CKAB.cjs} +2 -2
- package/dist/{chunk-N2P26AAD.js → chunk-MRTAFRO7.js} +1 -1
- package/dist/{chunk-YGULLD73.js → chunk-MRZ7LGKZ.js} +1 -1
- package/dist/{chunk-CLMZ2EXW.js → chunk-MSASBR2Y.js} +1 -1
- package/dist/{chunk-KEJRWMXR.cjs → chunk-NAWLLC3T.cjs} +2 -2
- package/dist/chunk-NJK5F5TF.cjs +21 -0
- package/dist/{chunk-HBPCJRZX.cjs → chunk-NLSZVGHK.cjs} +2 -2
- package/dist/{chunk-CK36RZXR.js → chunk-O4LRVGOY.js} +1 -1
- package/dist/chunk-OG2DMGU6.cjs +14 -0
- package/dist/{chunk-TIJGLQKO.js → chunk-OGQKJTXF.js} +1 -1
- package/dist/{chunk-UE4XPL43.js → chunk-PETLAONH.js} +1 -1
- package/dist/{chunk-MK4ZGXVE.cjs → chunk-PVSS2WPM.cjs} +2 -2
- package/dist/{chunk-ONN5COYQ.cjs → chunk-PXITFTJA.cjs} +2 -2
- package/dist/{chunk-ZAXYMQ2B.cjs → chunk-QDVPPRWI.cjs} +2 -2
- package/dist/{chunk-IPFHV2FV.cjs → chunk-QKERXNJJ.cjs} +2 -2
- package/dist/{chunk-ZDJ3J6Z6.cjs → chunk-QLML3IP5.cjs} +2 -2
- package/dist/{chunk-YFHQYQII.js → chunk-QVAJ5JP4.js} +1 -1
- package/dist/{chunk-S2QF6HG2.cjs → chunk-RD7E4OSJ.cjs} +2 -2
- package/dist/{chunk-XIB2G42L.cjs → chunk-RWSA3LXE.cjs} +2 -2
- package/dist/{chunk-R6WNZVTA.cjs → chunk-RXSS67VI.cjs} +2 -2
- package/dist/{chunk-UXVV3BSC.cjs → chunk-S3ZNESMC.cjs} +2 -2
- package/dist/{chunk-YNPRF4BX.js → chunk-S7NDMDRX.js} +1 -1
- package/dist/{chunk-HO7KACZZ.cjs → chunk-SK3VYIZ6.cjs} +2 -2
- package/dist/{chunk-CX3KG7D2.cjs → chunk-SMGHAG5C.cjs} +2 -2
- package/dist/{chunk-D5FJ26GG.js → chunk-T46LODOF.js} +1 -1
- package/dist/{chunk-Y4ZMNMYI.js → chunk-TIJWJVKZ.js} +1 -1
- package/dist/{chunk-EIILOQ6X.js → chunk-TLWCYLNA.js} +1 -1
- package/dist/{chunk-JX45ME2Z.js → chunk-TRJLYZHD.js} +1 -1
- package/dist/{chunk-RNBO3DEN.js → chunk-UKKJMCNH.js} +1 -1
- package/dist/chunk-ULBEEHG4.js +204 -0
- package/dist/{chunk-UDO4JYVU.cjs → chunk-VGTUK3QD.cjs} +2 -2
- package/dist/{chunk-4JPVFLVU.js → chunk-VQ7R36AC.js} +1 -1
- package/dist/{chunk-IPDIEZBN.cjs → chunk-VVQB5W7U.cjs} +2 -2
- package/dist/{chunk-HKZQ56AS.cjs → chunk-VVVATFGK.cjs} +2 -2
- package/dist/{chunk-URRL33D5.cjs → chunk-WMTYO5OX.cjs} +2 -2
- package/dist/{chunk-U4BMKRG6.js → chunk-WOSSSFXB.js} +1 -1
- package/dist/{chunk-OBQIS3KU.js → chunk-WOXXNKTE.js} +1 -1
- package/dist/{chunk-WAKSLH7V.cjs → chunk-XKI2OAYV.cjs} +2 -2
- package/dist/{chunk-5Y2KLUU6.cjs → chunk-XR4QF6KQ.cjs} +2 -2
- package/dist/{chunk-6BERHKDQ.cjs → chunk-XYHTQ523.cjs} +2 -2
- package/dist/{chunk-XD6XML3Z.cjs → chunk-XZYZLSUO.cjs} +2 -2
- package/dist/chunk-YPSWSI3M.js +21 -0
- package/dist/{chunk-4K3MX2J6.js → chunk-YYBIU5BQ.js} +1 -1
- package/dist/{chunk-HSGQSTVK.js → chunk-YZA5WZUS.js} +1 -1
- package/dist/{chunk-GGBSLAVO.cjs → chunk-Z4LUE424.cjs} +2 -2
- package/dist/{chunk-NSOHW3R6.js → chunk-ZV6XYUXS.js} +1 -1
- package/dist/consent-CS2ZBZX4.cjs +7 -0
- package/dist/consent-NNYHF2N4.js +7 -0
- package/dist/customer-portal-D3SLPAHZ.js +7 -0
- package/dist/customer-portal-UR3GN4VU.cjs +7 -0
- package/dist/dashboard-UHYR5RTY.cjs +7 -0
- package/dist/dashboard-UTPGXFW5.js +7 -0
- package/dist/data-management-QH2IJ5QV.js +7 -0
- package/dist/data-management-TEFRLGSU.cjs +7 -0
- package/dist/deduplication-ECVAZVVA.cjs +7 -0
- package/dist/deduplication-GYIST22B.js +7 -0
- package/dist/design-KUVXMFFK.cjs +7 -0
- package/dist/design-YKBXRW5C.js +7 -0
- package/dist/document-CY2A2OE7.js +7 -0
- package/dist/document-RYQ7MF6U.cjs +7 -0
- package/dist/email-settings-TQ5GGDYG.js +7 -0
- package/dist/email-settings-TQC34GST.cjs +7 -0
- package/dist/email-template-M2VVL4TI.cjs +7 -0
- package/dist/email-template-WYROV3UG.js +7 -0
- package/dist/entity-FA6PZX6S.js +7 -0
- package/dist/entity-IX5NSHPX.cjs +7 -0
- package/dist/entity-mapping-7J3IAGKQ.js +7 -0
- package/dist/entity-mapping-ZNMFCUKK.cjs +7 -0
- package/dist/environments-E3X6NYGX.js +7 -0
- package/dist/environments-P2JS4F5N.cjs +7 -0
- package/dist/erp-integration-EP2XFEH5.js +7 -0
- package/dist/erp-integration-NNV72VFI.cjs +7 -0
- package/dist/event-catalog-C45ISVMP.cjs +7 -0
- package/dist/event-catalog-D7VJ7WRS.js +7 -0
- package/dist/file-UOWBTDIU.cjs +7 -0
- package/dist/file-XSN3NAVZ.js +7 -0
- package/dist/iban-24GHLFDB.cjs +7 -0
- package/dist/iban-LDKYDVQV.js +7 -0
- package/dist/index.cjs +107 -100
- package/dist/index.d.cts +17 -2
- package/dist/index.d.ts +17 -2
- package/dist/index.js +58 -51
- package/dist/journey-7CKX67M7.js +7 -0
- package/dist/journey-EUZ6MVHG.cjs +7 -0
- package/dist/kanban-CHTH2ZSY.cjs +7 -0
- package/dist/kanban-HI6LL5WY.js +7 -0
- package/dist/message-3XZLJR6R.cjs +7 -0
- package/dist/message-ZNMCS5YH.js +7 -0
- package/dist/metering-DZNZPPY6.cjs +7 -0
- package/dist/metering-KOSCPPKB.js +7 -0
- package/dist/notes-3AO5GXIT.js +7 -0
- package/dist/notes-MPWOQC5J.cjs +7 -0
- package/dist/notification-PZOCUYD5.cjs +7 -0
- package/dist/notification-VWDZRSFZ.js +7 -0
- package/dist/organization-RARYYG2E.cjs +7 -0
- package/dist/organization-ZERPH2IH.js +7 -0
- package/dist/{organization.d-Bd2Hmk8v.d.cts → organization.d-DqwnNxMg.d.cts} +34 -7
- package/dist/{organization.d-Bd2Hmk8v.d.ts → organization.d-DqwnNxMg.d.ts} +34 -7
- package/dist/partner-directory-2XMPQWWX.js +7 -0
- package/dist/partner-directory-WHNTKQ5E.cjs +7 -0
- package/dist/permissions-4T3GFNB4.js +7 -0
- package/dist/permissions-FGBIJNN7.cjs +7 -0
- package/dist/pricing-4Z4TOETA.cjs +7 -0
- package/dist/pricing-C65DTZSX.js +7 -0
- package/dist/pricing-tier-NI35WOUP.cjs +7 -0
- package/dist/pricing-tier-VUOFK5Q7.js +7 -0
- package/dist/purpose-AKOEUHZ4.cjs +7 -0
- package/dist/purpose-RBRV3AQZ.js +7 -0
- package/dist/sandbox-2KN4X66E.cjs +7 -0
- package/dist/sandbox-L2SOOGGR.js +7 -0
- package/dist/submission-7BISSPO6.js +7 -0
- package/dist/submission-Q24BU4GS.cjs +7 -0
- package/dist/targeting-EYGYZD6M.cjs +7 -0
- package/dist/targeting-GEJTJN5Z.js +7 -0
- package/dist/template-variables-OAYS2E3G.cjs +1148 -0
- package/dist/template-variables-VKDJJZUT.js +1148 -0
- package/dist/user-EIEOI3OG.js +7 -0
- package/dist/user-NJJ7XVKB.cjs +7 -0
- package/dist/validation-rules-P6F5P73P.js +7 -0
- package/dist/validation-rules-VDU3CIZV.cjs +7 -0
- package/dist/webhooks-I7JWU34X.cjs +7 -0
- package/dist/webhooks-WPLEHVPX.js +7 -0
- package/dist/workflow-3LLURW3H.js +7 -0
- package/dist/workflow-RAGQDYXT.cjs +7 -0
- package/dist/workflow-definition-B6ELOZUR.cjs +7 -0
- package/dist/workflow-definition-D24CRCK2.js +7 -0
- package/docs/access-token.md +440 -0
- package/docs/address-suggestions.md +256 -0
- package/docs/address.md +284 -0
- package/docs/ai-agents.md +1891 -0
- package/docs/app.md +3388 -0
- package/docs/audit-logs.md +242 -0
- package/docs/automation.md +4044 -0
- package/docs/billing.md +783 -0
- package/docs/blueprint-manifest.md +3234 -0
- package/docs/consent.md +213 -0
- package/docs/customer-portal.md +11399 -0
- package/docs/dashboard.md +640 -0
- package/docs/data-management.md +883 -0
- package/docs/deduplication.md +135 -0
- package/docs/design.md +1273 -0
- package/docs/document.md +590 -0
- package/docs/email-settings.md +1544 -0
- package/docs/email-template.md +1197 -0
- package/docs/entity-mapping.md +2864 -0
- package/docs/entity.md +9595 -0
- package/docs/environments.md +259 -0
- package/docs/erp-integration.md +4572 -0
- package/docs/event-catalog.md +835 -0
- package/docs/file.md +1453 -0
- package/docs/iban.md +61 -0
- package/docs/journey.md +2268 -0
- package/docs/kanban.md +882 -0
- package/docs/message.md +2122 -0
- package/docs/metering.md +1431 -0
- package/docs/notes.md +670 -0
- package/docs/notification.md +1207 -0
- package/docs/organization.md +733 -0
- package/docs/partner-directory.md +1197 -0
- package/docs/permissions.md +1047 -0
- package/docs/pricing-tier.md +81 -0
- package/docs/pricing.md +5923 -0
- package/docs/purpose.md +283 -0
- package/docs/sandbox.md +389 -0
- package/docs/submission.md +195 -0
- package/docs/targeting.md +959 -0
- package/docs/template-variables.md +1141 -0
- package/docs/user.md +2555 -0
- package/docs/validation-rules.md +1597 -0
- package/docs/webhooks.md +996 -0
- package/docs/workflow-definition.md +3842 -0
- package/docs/workflow.md +4465 -0
- package/package.json +3 -2
- package/dist/chunk-GMBRXWMD.cjs +0 -14
- package/dist/chunk-L43U5IO3.js +0 -14
- package/dist/chunk-XE25WERA.js +0 -125
- package/dist/chunk-XEQMAKGA.cjs +0 -125
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/user.json
|
|
4
|
+
var user_default = '# User API\n\n- **Base URL:** `https://user.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/user](https://docs.epilot.io/api/user)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.user.signUpUser(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/user\'\n\nconst userClient = getClient()\nauthorize(userClient, () => \'<token>\')\nconst { data } = await userClient.signUpUser(...)\n```\n\n## Operations\n\n**User V2**\n- [`signUpUser`](#signupuser)\n- [`getMeV2`](#getmev2)\n- [`listUsersV2`](#listusersv2)\n- [`getUserV2`](#getuserv2)\n- [`updateUserV2`](#updateuserv2)\n- [`deleteUserV2`](#deleteuserv2)\n- [`inviteUser`](#inviteuser)\n- [`resendUserInvitation`](#resenduserinvitation)\n- [`getGroupsForUser`](#getgroupsforuser)\n- [`verifyEmailWithToken`](#verifyemailwithtoken)\n- [`checkInviteToken`](#checkinvitetoken)\n- [`activateUser`](#activateuser)\n- [`rejectInvite`](#rejectinvite)\n- [`getUserLoginParametersV2`](#getuserloginparametersv2)\n- [`beginPasskeyAuthentication`](#beginpasskeyauthentication)\n- [`beginDiscoverablePasskeyAuthentication`](#begindiscoverablepasskeyauthentication)\n- [`resolveDiscoverableCredential`](#resolvediscoverablecredential)\n- [`beginPasskeyRegistration`](#beginpasskeyregistration)\n- [`completePasskeyRegistration`](#completepasskeyregistration)\n- [`listPasskeys`](#listpasskeys)\n- [`deletePasskey`](#deletepasskey)\n- [`switchOrganization`](#switchorganization)\n\n**Group**\n- [`getGroups`](#getgroups)\n- [`createGroup`](#creategroup)\n- [`getGroup`](#getgroup)\n- [`updateGroup`](#updategroup)\n- [`deleteGroup`](#deletegroup)\n- [`advanceUserAssignment`](#advanceuserassignment)\n\n**Navigation**\n- [`createNavigation`](#createnavigation)\n- [`getNavigation`](#getnavigation)\n\n**User V1**\n- [`getMe`](#getme)\n- [`listUsers`](#listusers)\n- [`getUser`](#getuser)\n- [`getUserLoginParameters`](#getuserloginparameters)\n\n**Schemas**\n- [`NavigationId`](#navigationid)\n- [`Navigation`](#navigation)\n- [`NavigationCreateRequest`](#navigationcreaterequest)\n- [`NavigationConfiguration`](#navigationconfiguration)\n- [`NavigationItem`](#navigationitem)\n- [`NavigationKeyItem`](#navigationkeyitem)\n- [`NavigationGroupItem`](#navigationgroupitem)\n- [`InviteToken`](#invitetoken)\n- [`PartnerInvitationToken`](#partnerinvitationtoken)\n- [`VerificationToken`](#verificationtoken)\n- [`GroupId`](#groupid)\n- [`UserId`](#userid)\n- [`Query`](#query)\n- [`OrganizationId`](#organizationid)\n- [`Limit`](#limit)\n- [`Offset`](#offset)\n- [`Hydrate`](#hydrate)\n- [`Username`](#username)\n- [`UserInvitationPayload`](#userinvitationpayload)\n- [`UserActivationPayload`](#useractivationpayload)\n- [`UserVerificationPayload`](#userverificationpayload)\n- [`UserV2`](#userv2)\n- [`User`](#user)\n- [`LoginParameters`](#loginparameters)\n- [`CreateGroupReq`](#creategroupreq)\n- [`UpdateGroupReq`](#updategroupreq)\n- [`Group`](#group)\n- [`SignupUserPayload`](#signupuserpayload)\n- [`OrganizationDetail`](#organizationdetail)\n- [`CognitoDetails`](#cognitodetails)\n- [`UserDetail`](#userdetail)\n- [`Organization`](#organization)\n- [`DataPointsResponse`](#datapointsresponse)\n- [`DataPoint`](#datapoint)\n- [`Passkey`](#passkey)\n- [`PasskeyAuthenticationOptions`](#passkeyauthenticationoptions)\n- [`PasskeyRegistrationOptions`](#passkeyregistrationoptions)\n- [`PasskeyRegistrationResponse`](#passkeyregistrationresponse)\n\n### `signUpUser`\n\n`POST /v2/users/public/signup`\n\n```ts\nconst { data } = await client.signUpUser(\n {\n token: \'example\',\n },\n {\n organization_detail: {\n type: \'Vendor\',\n name: \'Epilot\',\n pricing_tier: \'professional\',\n email: \'string\',\n phone: \'string\',\n website: \'string\',\n is_privacy_policy_checked: false,\n is_terms_and_conditions_checked: false\n },\n user_detail: {\n full_name: \'Example user\',\n email: \'user@example.com\',\n password: \'AKjhdakjsdh@!34\'\n },\n language: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "user": {\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n },\n "organization": {\n "id": "string",\n "type": "Vendor",\n "name": "Epilot",\n "signature": "<p>Thanks</p>",\n "symbol": "EPI",\n "pricing_tier": "professional",\n "email": "someone@epilot.cloud",\n "phone": 49123123123,\n "website": "https://epilot.cloud",\n "address": {\n "country": "string",\n "city": "string",\n "postal_code": "string",\n "street": "string",\n "street_number": "string"\n },\n "logo_url": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png",\n "logo_thumbnail_url": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png",\n "is_unlicensed_org": false,\n "cognito_details": {\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_user_pool_arn": "arn:aws:cognito-idp:eu-central-1:123456789012:userpool/eu-central-sample"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getMeV2`\n\nGet currently logged in user\n\n`GET /v2/users/me`\n\n```ts\nconst { data } = await client.getMeV2()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listUsersV2`\n\nGet the list of organization users\n\n`GET /v2/users`\n\n```ts\nconst { data } = await client.listUsersV2({\n query: \'example\',\n limit: 1,\n offset: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getUserV2`\n\nGet user details by user id\n\n`GET /v2/users/{id}`\n\n```ts\nconst { data } = await client.getUserV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `updateUserV2`\n\nUpdate user details\n\n`PATCH /v2/users/{id}`\n\n```ts\nconst { data } = await client.updateUserV2(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n id: \'string\',\n organization_id: \'string\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n activated_at: \'1970-01-01T00:00:00.000Z\',\n display_name: \'Example User\',\n status: \'Active\',\n email: \'user@example.com\',\n draft_email: \'user@example.com\',\n department: \'Sales\',\n phone: 1234567890,\n secondary_phone: 1234567890,\n mfa_enabled: false,\n phone_verified: true,\n token: \'string\',\n signature: \'<p>Thanks</p>\',\n is_signature_enabled: true,\n preferred_language: \'de\',\n custom_start_page: \'/app/dashboard\',\n custom_navigation: \'5gbe4nkp6jsfq\',\n override_release_channel: \'canary\',\n feature_preferences: {\n feature_name: true\n },\n image_uri: {\n original: \'https://account-profile-images.epilot.cloud/1/avatar.png\',\n thumbnail_32: \'https://account-profile-images.epilot.cloud/1/avatar_32x32.png\'\n },\n favorites: {\n entity_views: {\n opportunity: \'891a5409850abf8b92bd2cb7bdd2844d32ce6bec\',\n order: \'628aee91-7c2f-4047-ab0d-433582a19c49\'\n },\n dashboard: \'751ff121-9ac2-4511-a2e6-851f11287380\'\n },\n email_notification_setting: {\n added_participant_opportunity: true,\n assigned_opportunity: true,\n assigned_task: true,\n comment_opportunity: true,\n deleted_task: true,\n escalated_task: true,\n message_receive_opportunity: true,\n message_send_opportunity: true,\n created_task: true,\n created_opportunity_manual: true,\n created_opportunity_auto: true,\n deleted_opportunity: true\n },\n properties: [\n {\n name: \'profileImageName\',\n value: \'avatar.png\'\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `deleteUserV2`\n\nDelete user by user id\n\n`DELETE /v2/users/{id}`\n\n```ts\nconst { data } = await client.deleteUserV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `inviteUser`\n\nCreates a new user in the caller\'s organization and sends an invite email to activate the user\n\n`POST /v2/users/invite`\n\n```ts\nconst { data } = await client.inviteUser(\n null,\n {\n email: \'test@example.com\',\n language: \'en\',\n roles: [\'123:owner\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `resendUserInvitation`\n\nResend user invitation email\n\n`POST /v2/users/invite:resendEmail`\n\n```ts\nconst { data } = await client.resendUserInvitation(\n null,\n {\n email: \'test@example.com\',\n language: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getGroupsForUser`\n\nGet groups of a user\n\n`GET /v2/users/{id}/groups`\n\n```ts\nconst { data } = await client.getGroupsForUser({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": [],\n "crt_index": 3\n },\n "users": [\n {}\n ]\n }\n]\n```\n\n</details>\n\n---\n\n### `getGroups`\n\nLists groups in organizations you have access to\n\n`GET /v1/groups`\n\n```ts\nconst { data } = await client.getGroups({\n query: \'example\',\n limit: 1,\n offset: 1,\n hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "groups": [\n {\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {},\n "users": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createGroup`\n\nCreate a new group\n\n`POST /v1/groups`\n\n```ts\nconst { data } = await client.createGroup(\n null,\n {\n name: \'Finance\',\n user_ids: [\'123\', \'456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getGroup`\n\nGet group by id\n\n`GET /v1/groups/{id}`\n\n```ts\nconst { data } = await client.getGroup({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `updateGroup`\n\nUpdate group by id\n\n`PATCH /v1/groups/{id}`\n\n```ts\nconst { data } = await client.updateGroup(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n name: \'Finance\',\n user_ids: [\'123\', \'456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `deleteGroup`\n\nDelete group by id\n\n`DELETE /v1/groups/{id}`\n\n```ts\nconst { data } = await client.deleteGroup({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `advanceUserAssignment`\n\nAdvance user assignment to next user in line\n\n`POST /v1/groups/{id}/user:next`\n\n```ts\nconst { data } = await client.advanceUserAssignment({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createNavigation`\n\nCreate a new navigation configuration. Navigations are immutable and globally accessible across organizations.\nEach creation generates a new id. To update a navigation, create a new one.\n\n`POST /v2/user/navigations`\n\n```ts\nconst { data } = await client.createNavigation(\n null,\n {\n name: \'Sales Team Navigation\',\n configuration: {\n customer_relations: [\n {\n key: \'dashboard\'\n },\n {\n key: \'contact\'\n }\n ],\n configurations: [\n {\n name: \'Product Catalog\',\n subItems: [\n {\n key: \'product\'\n },\n {\n key: \'price\'\n }\n ]\n },\n {\n key: \'journey\'\n }\n ]\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "5gbe4nkp6jsfq",\n "name": "Sales Team Navigation",\n "configuration": {\n "customer_relations": [\n {\n "key": "dashboard"\n },\n {\n "key": "contact"\n }\n ],\n "configurations": [\n {\n "name": "Product Catalog",\n "subItems": [\n {\n "key": "product"\n },\n {\n "key": "price"\n }\n ]\n },\n {\n "key": "journey"\n }\n ]\n }\n}\n```\n\n</details>\n\n---\n\n### `getNavigation`\n\nGet a navigation configuration by ID\n\n`GET /v2/user/navigations/{id}`\n\n```ts\nconst { data } = await client.getNavigation({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "5gbe4nkp6jsfq",\n "name": "Sales Team Navigation",\n "configuration": {\n "customer_relations": [\n {\n "key": "dashboard"\n },\n {\n "key": "contact"\n }\n ],\n "configurations": [\n {\n "name": "Product Catalog",\n "subItems": [\n {\n "key": "product"\n },\n {\n "key": "price"\n }\n ]\n },\n {\n "key": "journey"\n }\n ]\n }\n}\n```\n\n</details>\n\n---\n\n### `verifyEmailWithToken`\n\nUpdate new email using an verification token\n\n`POST /v2/users/public/verifyEmail`\n\n```ts\nconst { data } = await client.verifyEmailWithToken(\n {\n token: \'example\',\n },\n {\n password: \'AKjhdakjsdh@!34\'\n },\n)\n```\n\n---\n\n### `checkInviteToken`\n\nCheck an invite token\n\n`GET /v2/users/public/checkToken`\n\n```ts\nconst { data } = await client.checkInviteToken({\n token: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "invitation_org_id": "string",\n "invitation_org_name": "string",\n "invitation_org_logo_url": "string",\n "invitation_org_logo_thumbnail_url": "string",\n "invitee_user_id": "string",\n "invitee_primary_org_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `activateUser`\n\nActivate user using an invite token\n\n`POST /v2/users/public/activate`\n\n```ts\nconst { data } = await client.activateUser(\n {\n token: \'example\',\n },\n {\n display_name: \'Example User\',\n password: \'AKjhdakjsdh@!34\'\n },\n)\n```\n\n---\n\n### `rejectInvite`\n\nReject an invite\n\n`DELETE /v2/users/public/reject`\n\n```ts\nconst { data } = await client.rejectInvite({\n token: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true\n}\n```\n\n</details>\n\n---\n\n### `getUserLoginParametersV2`\n\nGet user organization login parameters by username\n\n`GET /v2/users/public/username/{username}:getLoginParameters`\n\n```ts\nconst { data } = await client.getUserLoginParametersV2({\n username: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "login_parameters": [\n {\n "organization_id": "123",\n "organization_name": "epilot GmbH",\n "organization_type": "Vendor",\n "organization_use": "Production",\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_oauth_domain": "epilot-org-123",\n "cognito_oauth_scopes": ["openid"],\n "oauth_response_type": "code",\n "passkey_enabled": true\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `beginPasskeyAuthentication`\n\nBegin passkey authentication flow. Returns WebAuthn options and a signed challenge token.\n\n`POST /v2/users/public/passkeys:authenticateBegin`\n\n```ts\nconst { data } = await client.beginPasskeyAuthentication(\n null,\n {\n email: \'user@example.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "options": {},\n "challenge_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `beginDiscoverablePasskeyAuthentication`\n\nBegin discoverable passkey authentication flow (no email required). Returns WebAuthn options with empty allowCredentials for the browser credential picker.\n\n`POST /v2/users/public/passkeys:authenticateBeginDiscoverable`\n\n```ts\nconst { data } = await client.beginDiscoverablePasskeyAuthentication()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "options": {},\n "challenge_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `resolveDiscoverableCredential`\n\nResolve user identity from a discoverable passkey assertion. Returns the user\'s email and login parameters.\n\n`POST /v2/users/public/passkeys:resolveCredential`\n\n```ts\nconst { data } = await client.resolveDiscoverableCredential(\n null,\n {\n challenge_token: \'string\',\n assertion_response: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "email": "user@example.com",\n "organization_id": "string",\n "user_id": "string",\n "login_parameters": [\n {\n "organization_id": "123",\n "organization_name": "epilot GmbH",\n "organization_type": "Vendor",\n "organization_use": "Production",\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_oauth_domain": "epilot-org-123",\n "cognito_oauth_scopes": ["openid"],\n "oauth_response_type": "code",\n "passkey_enabled": true\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `beginPasskeyRegistration`\n\nBegin passkey registration flow for the authenticated user.\n\n`POST /v2/users/me/passkeys:registerBegin`\n\n```ts\nconst { data } = await client.beginPasskeyRegistration(\n null,\n {\n friendly_name: \'My Laptop\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "options": {},\n "challenge_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `completePasskeyRegistration`\n\nComplete passkey registration by verifying the attestation response.\n\n`POST /v2/users/me/passkeys:registerComplete`\n\n```ts\nconst { data } = await client.completePasskeyRegistration(\n null,\n {\n challenge_token: \'string\',\n registration_response: {},\n friendly_name: \'My Laptop\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "credential_id": "string",\n "friendly_name": "My Laptop",\n "created_at": "1970-01-01T00:00:00.000Z",\n "transports": ["string"],\n "aaguid": "string"\n}\n```\n\n</details>\n\n---\n\n### `listPasskeys`\n\nList all passkeys registered for the authenticated user.\n\n`GET /v2/users/me/passkeys`\n\n```ts\nconst { data } = await client.listPasskeys()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "passkeys": [\n {\n "credential_id": "string",\n "friendly_name": "My Laptop",\n "created_at": "1970-01-01T00:00:00.000Z",\n "transports": ["string"],\n "aaguid": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `deletePasskey`\n\nDelete a passkey by credential ID.\n\n`DELETE /v2/users/me/passkeys/{credentialId}`\n\n```ts\nconst { data } = await client.deletePasskey({\n credentialId: \'example\',\n})\n```\n\n---\n\n### `switchOrganization`\n\nSwitch to another organization the user is part of\n\n`POST /v2/users/switchOrganization`\n\n```ts\nconst { data } = await client.switchOrganization(\n null,\n {\n org_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "login_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `getMe`\n\nGet currently logged in user\n\n`GET /v1/users/me`\n\n```ts\nconst { data } = await client.getMe()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listUsers`\n\nLists users in organizations you have access to\n\n`GET /v1/users`\n\n```ts\nconst { data } = await client.listUsers({\n org_ids: [\'...\'],\n query: \'example\',\n limit: 1,\n offset: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getUser`\n\nGet user by id\n\n`GET /v1/users/{id}`\n\n```ts\nconst { data } = await client.getUser({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getUserLoginParameters`\n\nGet user organization login parameters by username\n\n`GET /v1/users/username/{username}:getLoginParameters`\n\n```ts\nconst { data } = await client.getUserLoginParameters({\n username: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "login_parameters": [\n {\n "organization_id": "123",\n "organization_name": "epilot GmbH",\n "organization_type": "Vendor",\n "organization_use": "Production",\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_oauth_domain": "epilot-org-123",\n "cognito_oauth_scopes": ["openid"],\n "oauth_response_type": "code",\n "passkey_enabled": true\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `NavigationId`\n\nNavigation unique identifier - a hash of the normalized navigation payload (name + configuration). Identical navigations across orgs will have the same ID.\n\n```ts\ntype NavigationId = string\n```\n\n### `Navigation`\n\nA customized workplace navigation configuration. The ID is a content-hash, so identical configurations will have the same ID.\n\n```ts\ntype Navigation = {\n id: string\n name: string\n configuration: Record<string, Array<{\n key: string\n } | {\n name: string\n subItems: Array<{\n key: { ... }\n }>\n }>>\n}\n```\n\n### `NavigationCreateRequest`\n\nRequest payload to create a new navigation configuration\n\n```ts\ntype NavigationCreateRequest = {\n name: string\n configuration: Record<string, Array<{\n key: string\n } | {\n name: string\n subItems: Array<{\n key: { ... }\n }>\n }>>\n}\n```\n\n### `NavigationConfiguration`\n\nNavigation configuration organized by sections. Each section contains an array of navigation items.\n\n\n```ts\ntype NavigationConfiguration = Record<string, Array<{\n key: string\n} | {\n name: string\n subItems: Array<{\n key: string\n }>\n}>>\n```\n\n### `NavigationItem`\n\nA navigation item - either a simple key item or a group with sub-items\n\n```ts\ntype NavigationItem = {\n key: string\n} | {\n name: string\n subItems: Array<{\n key: string\n }>\n}\n```\n\n### `NavigationKeyItem`\n\nA simple navigation item with a key\n\n```ts\ntype NavigationKeyItem = {\n key: string\n}\n```\n\n### `NavigationGroupItem`\n\nA navigation group containing sub-items\n\n```ts\ntype NavigationGroupItem = {\n name: string\n subItems: Array<{\n key: string\n }>\n}\n```\n\n### `InviteToken`\n\nToken used to invite a user to epilot\n\n```ts\ntype InviteToken = string\n```\n\n### `PartnerInvitationToken`\n\nToken used to invite a partner user to epilot\n\n```ts\ntype PartnerInvitationToken = string\n```\n\n### `VerificationToken`\n\n```ts\ntype VerificationToken = string\n```\n\n### `GroupId`\n\nGroup unique identifier\n\n```ts\ntype GroupId = string\n```\n\n### `UserId`\n\nUser\'s unique identifier\n\n```ts\ntype UserId = string\n```\n\n### `Query`\n\n```ts\ntype Query = string\n```\n\n### `OrganizationId`\n\n```ts\ntype OrganizationId = string\n```\n\n### `Limit`\n\n```ts\ntype Limit = number\n```\n\n### `Offset`\n\n```ts\ntype Offset = number\n```\n\n### `Hydrate`\n\n```ts\ntype Hydrate = boolean\n```\n\n### `Username`\n\n```ts\ntype Username = string\n```\n\n### `UserInvitationPayload`\n\n```ts\ntype UserInvitationPayload = {\n email?: string\n language?: "en" | "de"\n roles?: string[]\n}\n```\n\n### `UserActivationPayload`\n\n```ts\ntype UserActivationPayload = {\n display_name?: string\n password?: string\n}\n```\n\n### `UserVerificationPayload`\n\n```ts\ntype UserVerificationPayload = {\n password?: string\n}\n```\n\n### `UserV2`\n\n```ts\ntype UserV2 = {\n id?: string\n organization_id?: string\n created_at?: string // date-time\n activated_at?: string // date-time\n display_name?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n email?: string // email\n draft_email?: string // email\n department?: string\n phone?: string\n secondary_phone?: string\n mfa_enabled?: boolean\n phone_verified?: boolean\n token?: string\n signature?: string\n is_signature_enabled?: boolean\n preferred_language?: string\n custom_start_page?: string\n custom_navigation?: string\n override_release_channel?: "canary" | "rc" | "stable" | null\n feature_preferences?: Record<string, unknown>\n image_uri?: {\n original?: string // uri\n thumbnail_32?: string // uri\n }\n favorites?: Record<string, unknown>\n email_notification_setting?: Record<string, unknown>\n properties?: Array<{\n name: string\n value: string\n }>\n}\n```\n\n### `User`\n\n```ts\ntype User = {\n id: string\n organization_id: string\n email: string // email\n display_name?: string\n name: string\n preferred_language: string\n signature?: string\n custom_navigation?: string\n roles: string[]\n image_uri?: {\n original?: string // uri\n thumbnail_32?: string // uri\n }\n properties: Array<{\n name: string\n value: string\n }>\n}\n```\n\n### `LoginParameters`\n\n```ts\ntype LoginParameters = {\n organization_id?: string\n organization_name?: string\n organization_type?: string\n organization_use?: string\n cognito_region?: string\n cognito_user_pool_id?: string\n cognito_user_pool_client_id?: string\n cognito_oauth_domain?: string\n cognito_oauth_scopes?: string[]\n oauth_response_type?: "code" | "token"\n passkey_enabled?: boolean\n}\n```\n\n### `CreateGroupReq`\n\n```ts\ntype CreateGroupReq = {\n name: string\n user_ids?: string[]\n}\n```\n\n### `UpdateGroupReq`\n\n```ts\ntype UpdateGroupReq = {\n name?: string\n user_ids?: string[]\n}\n```\n\n### `Group`\n\n```ts\ntype Group = {\n id: string\n org_id: string\n name: string\n created_at: string\n updated_at: string\n created_by?: string\n crt_assignee?: {\n id?: string\n organization_id?: string\n created_at?: string // date-time\n activated_at?: string // date-time\n display_name?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n email?: string // email\n draft_email?: string // email\n department?: string\n phone?: string\n secondary_phone?: string\n mfa_enabled?: boolean\n phone_verified?: boolean\n token?: string\n signature?: string\n is_signature_enabled?: boolean\n preferred_language?: string\n custom_start_page?: string\n custom_navigation?: string\n override_release_channel?: "canary" | "rc" | "stable" | null\n feature_preferences?: Record<string, unknown>\n image_uri?: {\n original?: { ... }\n thumbnail_32?: { ... }\n }\n favorites?: Record<string, unknown>\n email_notification_setting?: Record<string, unknown>\n properties?: Array<{\n name: { ... }\n value: { ... }\n }>\n crt_index?: number\n }\n users?: Array<{\n id?: string\n organization_id?: string\n created_at?: string // date-time\n activated_at?: string // date-time\n display_name?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n email?: string // email\n draft_email?: string // email\n department?: string\n phone?: string\n secondary_phone?: string\n mfa_enabled?: boolean\n phone_verified?: boolean\n token?: string\n signature?: string\n is_signature_enabled?: boolean\n preferred_language?: string\n custom_start_page?: string\n custom_navigation?: string\n override_release_channel?: "canary" | "rc" | "stable" | null\n feature_preferences?: Record<string, unknown>\n image_uri?: {\n original?: { ... }\n thumbnail_32?: { ... }\n }\n favorites?: Record<string, unknown>\n email_notification_setting?: Record<string, unknown>\n properties?: Array<{\n name: { ... }\n value: { ... }\n }>\n }>\n}\n```\n\n### `SignupUserPayload`\n\n```ts\ntype SignupUserPayload = {\n organization_detail?: {\n type: "Vendor" | "Partner"\n name: string\n pricing_tier: string\n email: string\n phone?: string\n website?: string\n is_privacy_policy_checked?: boolean\n is_terms_and_conditions_checked?: boolean\n }\n user_detail?: {\n full_name: string\n email: string // email\n password: string\n }\n language?: "en" | "de"\n}\n```\n\n### `OrganizationDetail`\n\n```ts\ntype OrganizationDetail = {\n type: "Vendor" | "Partner"\n name: string\n pricing_tier: string\n email: string\n phone?: string\n website?: string\n is_privacy_policy_checked?: boolean\n is_terms_and_conditions_checked?: boolean\n}\n```\n\n### `CognitoDetails`\n\n```ts\ntype CognitoDetails = {\n cognito_region?: string\n cognito_user_pool_id?: string\n cognito_user_pool_client_id?: string\n cognito_user_pool_arn?: string\n}\n```\n\n### `UserDetail`\n\n```ts\ntype UserDetail = {\n full_name: string\n email: string // email\n password: string\n}\n```\n\n### `Organization`\n\n```ts\ntype Organization = {\n id?: string\n type?: "Vendor" | "Partner"\n name?: string\n signature?: string\n symbol?: string\n pricing_tier?: string\n email?: string\n phone?: string\n website?: string\n address?: {\n country?: string\n city?: string\n postal_code?: string\n street?: string\n street_number?: string\n }\n logo_url?: string\n logo_thumbnail_url?: string\n is_unlicensed_org?: boolean\n cognito_details?: {\n cognito_region?: string\n cognito_user_pool_id?: string\n cognito_user_pool_client_id?: string\n cognito_user_pool_arn?: string\n }\n}\n```\n\n### `DataPointsResponse`\n\n```ts\ntype DataPointsResponse = Array<{\n id?: number\n actual_users?: number\n max_users_last_month?: number\n non_billable_users_last_month?: number\n}>\n```\n\n### `DataPoint`\n\n```ts\ntype DataPoint = {\n id?: number\n actual_users?: number\n max_users_last_month?: number\n non_billable_users_last_month?: number\n}\n```\n\n### `Passkey`\n\n```ts\ntype Passkey = {\n credential_id?: string\n friendly_name?: string\n created_at?: string // date-time\n transports?: string[]\n aaguid?: string\n}\n```\n\n### `PasskeyAuthenticationOptions`\n\n```ts\ntype PasskeyAuthenticationOptions = {\n options?: object\n challenge_token?: string\n}\n```\n\n### `PasskeyRegistrationOptions`\n\n```ts\ntype PasskeyRegistrationOptions = {\n options?: object\n challenge_token?: string\n}\n```\n\n### `PasskeyRegistrationResponse`\n\n```ts\ntype PasskeyRegistrationResponse = {\n challenge_token: string\n registration_response: object\n friendly_name?: string\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
user_default as default
|
|
7
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/user.json
|
|
4
|
+
var user_default = '# User API\n\n- **Base URL:** `https://user.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/user](https://docs.epilot.io/api/user)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.user.signUpUser(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/user\'\n\nconst userClient = getClient()\nauthorize(userClient, () => \'<token>\')\nconst { data } = await userClient.signUpUser(...)\n```\n\n## Operations\n\n**User V2**\n- [`signUpUser`](#signupuser)\n- [`getMeV2`](#getmev2)\n- [`listUsersV2`](#listusersv2)\n- [`getUserV2`](#getuserv2)\n- [`updateUserV2`](#updateuserv2)\n- [`deleteUserV2`](#deleteuserv2)\n- [`inviteUser`](#inviteuser)\n- [`resendUserInvitation`](#resenduserinvitation)\n- [`getGroupsForUser`](#getgroupsforuser)\n- [`verifyEmailWithToken`](#verifyemailwithtoken)\n- [`checkInviteToken`](#checkinvitetoken)\n- [`activateUser`](#activateuser)\n- [`rejectInvite`](#rejectinvite)\n- [`getUserLoginParametersV2`](#getuserloginparametersv2)\n- [`beginPasskeyAuthentication`](#beginpasskeyauthentication)\n- [`beginDiscoverablePasskeyAuthentication`](#begindiscoverablepasskeyauthentication)\n- [`resolveDiscoverableCredential`](#resolvediscoverablecredential)\n- [`beginPasskeyRegistration`](#beginpasskeyregistration)\n- [`completePasskeyRegistration`](#completepasskeyregistration)\n- [`listPasskeys`](#listpasskeys)\n- [`deletePasskey`](#deletepasskey)\n- [`switchOrganization`](#switchorganization)\n\n**Group**\n- [`getGroups`](#getgroups)\n- [`createGroup`](#creategroup)\n- [`getGroup`](#getgroup)\n- [`updateGroup`](#updategroup)\n- [`deleteGroup`](#deletegroup)\n- [`advanceUserAssignment`](#advanceuserassignment)\n\n**Navigation**\n- [`createNavigation`](#createnavigation)\n- [`getNavigation`](#getnavigation)\n\n**User V1**\n- [`getMe`](#getme)\n- [`listUsers`](#listusers)\n- [`getUser`](#getuser)\n- [`getUserLoginParameters`](#getuserloginparameters)\n\n**Schemas**\n- [`NavigationId`](#navigationid)\n- [`Navigation`](#navigation)\n- [`NavigationCreateRequest`](#navigationcreaterequest)\n- [`NavigationConfiguration`](#navigationconfiguration)\n- [`NavigationItem`](#navigationitem)\n- [`NavigationKeyItem`](#navigationkeyitem)\n- [`NavigationGroupItem`](#navigationgroupitem)\n- [`InviteToken`](#invitetoken)\n- [`PartnerInvitationToken`](#partnerinvitationtoken)\n- [`VerificationToken`](#verificationtoken)\n- [`GroupId`](#groupid)\n- [`UserId`](#userid)\n- [`Query`](#query)\n- [`OrganizationId`](#organizationid)\n- [`Limit`](#limit)\n- [`Offset`](#offset)\n- [`Hydrate`](#hydrate)\n- [`Username`](#username)\n- [`UserInvitationPayload`](#userinvitationpayload)\n- [`UserActivationPayload`](#useractivationpayload)\n- [`UserVerificationPayload`](#userverificationpayload)\n- [`UserV2`](#userv2)\n- [`User`](#user)\n- [`LoginParameters`](#loginparameters)\n- [`CreateGroupReq`](#creategroupreq)\n- [`UpdateGroupReq`](#updategroupreq)\n- [`Group`](#group)\n- [`SignupUserPayload`](#signupuserpayload)\n- [`OrganizationDetail`](#organizationdetail)\n- [`CognitoDetails`](#cognitodetails)\n- [`UserDetail`](#userdetail)\n- [`Organization`](#organization)\n- [`DataPointsResponse`](#datapointsresponse)\n- [`DataPoint`](#datapoint)\n- [`Passkey`](#passkey)\n- [`PasskeyAuthenticationOptions`](#passkeyauthenticationoptions)\n- [`PasskeyRegistrationOptions`](#passkeyregistrationoptions)\n- [`PasskeyRegistrationResponse`](#passkeyregistrationresponse)\n\n### `signUpUser`\n\n`POST /v2/users/public/signup`\n\n```ts\nconst { data } = await client.signUpUser(\n {\n token: \'example\',\n },\n {\n organization_detail: {\n type: \'Vendor\',\n name: \'Epilot\',\n pricing_tier: \'professional\',\n email: \'string\',\n phone: \'string\',\n website: \'string\',\n is_privacy_policy_checked: false,\n is_terms_and_conditions_checked: false\n },\n user_detail: {\n full_name: \'Example user\',\n email: \'user@example.com\',\n password: \'AKjhdakjsdh@!34\'\n },\n language: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "user": {\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n },\n "organization": {\n "id": "string",\n "type": "Vendor",\n "name": "Epilot",\n "signature": "<p>Thanks</p>",\n "symbol": "EPI",\n "pricing_tier": "professional",\n "email": "someone@epilot.cloud",\n "phone": 49123123123,\n "website": "https://epilot.cloud",\n "address": {\n "country": "string",\n "city": "string",\n "postal_code": "string",\n "street": "string",\n "street_number": "string"\n },\n "logo_url": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png",\n "logo_thumbnail_url": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png",\n "is_unlicensed_org": false,\n "cognito_details": {\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_user_pool_arn": "arn:aws:cognito-idp:eu-central-1:123456789012:userpool/eu-central-sample"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getMeV2`\n\nGet currently logged in user\n\n`GET /v2/users/me`\n\n```ts\nconst { data } = await client.getMeV2()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listUsersV2`\n\nGet the list of organization users\n\n`GET /v2/users`\n\n```ts\nconst { data } = await client.listUsersV2({\n query: \'example\',\n limit: 1,\n offset: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getUserV2`\n\nGet user details by user id\n\n`GET /v2/users/{id}`\n\n```ts\nconst { data } = await client.getUserV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `updateUserV2`\n\nUpdate user details\n\n`PATCH /v2/users/{id}`\n\n```ts\nconst { data } = await client.updateUserV2(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n id: \'string\',\n organization_id: \'string\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n activated_at: \'1970-01-01T00:00:00.000Z\',\n display_name: \'Example User\',\n status: \'Active\',\n email: \'user@example.com\',\n draft_email: \'user@example.com\',\n department: \'Sales\',\n phone: 1234567890,\n secondary_phone: 1234567890,\n mfa_enabled: false,\n phone_verified: true,\n token: \'string\',\n signature: \'<p>Thanks</p>\',\n is_signature_enabled: true,\n preferred_language: \'de\',\n custom_start_page: \'/app/dashboard\',\n custom_navigation: \'5gbe4nkp6jsfq\',\n override_release_channel: \'canary\',\n feature_preferences: {\n feature_name: true\n },\n image_uri: {\n original: \'https://account-profile-images.epilot.cloud/1/avatar.png\',\n thumbnail_32: \'https://account-profile-images.epilot.cloud/1/avatar_32x32.png\'\n },\n favorites: {\n entity_views: {\n opportunity: \'891a5409850abf8b92bd2cb7bdd2844d32ce6bec\',\n order: \'628aee91-7c2f-4047-ab0d-433582a19c49\'\n },\n dashboard: \'751ff121-9ac2-4511-a2e6-851f11287380\'\n },\n email_notification_setting: {\n added_participant_opportunity: true,\n assigned_opportunity: true,\n assigned_task: true,\n comment_opportunity: true,\n deleted_task: true,\n escalated_task: true,\n message_receive_opportunity: true,\n message_send_opportunity: true,\n created_task: true,\n created_opportunity_manual: true,\n created_opportunity_auto: true,\n deleted_opportunity: true\n },\n properties: [\n {\n name: \'profileImageName\',\n value: \'avatar.png\'\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `deleteUserV2`\n\nDelete user by user id\n\n`DELETE /v2/users/{id}`\n\n```ts\nconst { data } = await client.deleteUserV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `inviteUser`\n\nCreates a new user in the caller\'s organization and sends an invite email to activate the user\n\n`POST /v2/users/invite`\n\n```ts\nconst { data } = await client.inviteUser(\n null,\n {\n email: \'test@example.com\',\n language: \'en\',\n roles: [\'123:owner\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `resendUserInvitation`\n\nResend user invitation email\n\n`POST /v2/users/invite:resendEmail`\n\n```ts\nconst { data } = await client.resendUserInvitation(\n null,\n {\n email: \'test@example.com\',\n language: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getGroupsForUser`\n\nGet groups of a user\n\n`GET /v2/users/{id}/groups`\n\n```ts\nconst { data } = await client.getGroupsForUser({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": [],\n "crt_index": 3\n },\n "users": [\n {}\n ]\n }\n]\n```\n\n</details>\n\n---\n\n### `getGroups`\n\nLists groups in organizations you have access to\n\n`GET /v1/groups`\n\n```ts\nconst { data } = await client.getGroups({\n query: \'example\',\n limit: 1,\n offset: 1,\n hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "groups": [\n {\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {},\n "users": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createGroup`\n\nCreate a new group\n\n`POST /v1/groups`\n\n```ts\nconst { data } = await client.createGroup(\n null,\n {\n name: \'Finance\',\n user_ids: [\'123\', \'456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getGroup`\n\nGet group by id\n\n`GET /v1/groups/{id}`\n\n```ts\nconst { data } = await client.getGroup({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `updateGroup`\n\nUpdate group by id\n\n`PATCH /v1/groups/{id}`\n\n```ts\nconst { data } = await client.updateGroup(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n name: \'Finance\',\n user_ids: [\'123\', \'456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `deleteGroup`\n\nDelete group by id\n\n`DELETE /v1/groups/{id}`\n\n```ts\nconst { data } = await client.deleteGroup({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `advanceUserAssignment`\n\nAdvance user assignment to next user in line\n\n`POST /v1/groups/{id}/user:next`\n\n```ts\nconst { data } = await client.advanceUserAssignment({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createNavigation`\n\nCreate a new navigation configuration. Navigations are immutable and globally accessible across organizations.\nEach creation generates a new id. To update a navigation, create a new one.\n\n`POST /v2/user/navigations`\n\n```ts\nconst { data } = await client.createNavigation(\n null,\n {\n name: \'Sales Team Navigation\',\n configuration: {\n customer_relations: [\n {\n key: \'dashboard\'\n },\n {\n key: \'contact\'\n }\n ],\n configurations: [\n {\n name: \'Product Catalog\',\n subItems: [\n {\n key: \'product\'\n },\n {\n key: \'price\'\n }\n ]\n },\n {\n key: \'journey\'\n }\n ]\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "5gbe4nkp6jsfq",\n "name": "Sales Team Navigation",\n "configuration": {\n "customer_relations": [\n {\n "key": "dashboard"\n },\n {\n "key": "contact"\n }\n ],\n "configurations": [\n {\n "name": "Product Catalog",\n "subItems": [\n {\n "key": "product"\n },\n {\n "key": "price"\n }\n ]\n },\n {\n "key": "journey"\n }\n ]\n }\n}\n```\n\n</details>\n\n---\n\n### `getNavigation`\n\nGet a navigation configuration by ID\n\n`GET /v2/user/navigations/{id}`\n\n```ts\nconst { data } = await client.getNavigation({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "5gbe4nkp6jsfq",\n "name": "Sales Team Navigation",\n "configuration": {\n "customer_relations": [\n {\n "key": "dashboard"\n },\n {\n "key": "contact"\n }\n ],\n "configurations": [\n {\n "name": "Product Catalog",\n "subItems": [\n {\n "key": "product"\n },\n {\n "key": "price"\n }\n ]\n },\n {\n "key": "journey"\n }\n ]\n }\n}\n```\n\n</details>\n\n---\n\n### `verifyEmailWithToken`\n\nUpdate new email using an verification token\n\n`POST /v2/users/public/verifyEmail`\n\n```ts\nconst { data } = await client.verifyEmailWithToken(\n {\n token: \'example\',\n },\n {\n password: \'AKjhdakjsdh@!34\'\n },\n)\n```\n\n---\n\n### `checkInviteToken`\n\nCheck an invite token\n\n`GET /v2/users/public/checkToken`\n\n```ts\nconst { data } = await client.checkInviteToken({\n token: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "invitation_org_id": "string",\n "invitation_org_name": "string",\n "invitation_org_logo_url": "string",\n "invitation_org_logo_thumbnail_url": "string",\n "invitee_user_id": "string",\n "invitee_primary_org_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `activateUser`\n\nActivate user using an invite token\n\n`POST /v2/users/public/activate`\n\n```ts\nconst { data } = await client.activateUser(\n {\n token: \'example\',\n },\n {\n display_name: \'Example User\',\n password: \'AKjhdakjsdh@!34\'\n },\n)\n```\n\n---\n\n### `rejectInvite`\n\nReject an invite\n\n`DELETE /v2/users/public/reject`\n\n```ts\nconst { data } = await client.rejectInvite({\n token: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true\n}\n```\n\n</details>\n\n---\n\n### `getUserLoginParametersV2`\n\nGet user organization login parameters by username\n\n`GET /v2/users/public/username/{username}:getLoginParameters`\n\n```ts\nconst { data } = await client.getUserLoginParametersV2({\n username: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "login_parameters": [\n {\n "organization_id": "123",\n "organization_name": "epilot GmbH",\n "organization_type": "Vendor",\n "organization_use": "Production",\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_oauth_domain": "epilot-org-123",\n "cognito_oauth_scopes": ["openid"],\n "oauth_response_type": "code",\n "passkey_enabled": true\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `beginPasskeyAuthentication`\n\nBegin passkey authentication flow. Returns WebAuthn options and a signed challenge token.\n\n`POST /v2/users/public/passkeys:authenticateBegin`\n\n```ts\nconst { data } = await client.beginPasskeyAuthentication(\n null,\n {\n email: \'user@example.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "options": {},\n "challenge_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `beginDiscoverablePasskeyAuthentication`\n\nBegin discoverable passkey authentication flow (no email required). Returns WebAuthn options with empty allowCredentials for the browser credential picker.\n\n`POST /v2/users/public/passkeys:authenticateBeginDiscoverable`\n\n```ts\nconst { data } = await client.beginDiscoverablePasskeyAuthentication()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "options": {},\n "challenge_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `resolveDiscoverableCredential`\n\nResolve user identity from a discoverable passkey assertion. Returns the user\'s email and login parameters.\n\n`POST /v2/users/public/passkeys:resolveCredential`\n\n```ts\nconst { data } = await client.resolveDiscoverableCredential(\n null,\n {\n challenge_token: \'string\',\n assertion_response: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "email": "user@example.com",\n "organization_id": "string",\n "user_id": "string",\n "login_parameters": [\n {\n "organization_id": "123",\n "organization_name": "epilot GmbH",\n "organization_type": "Vendor",\n "organization_use": "Production",\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_oauth_domain": "epilot-org-123",\n "cognito_oauth_scopes": ["openid"],\n "oauth_response_type": "code",\n "passkey_enabled": true\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `beginPasskeyRegistration`\n\nBegin passkey registration flow for the authenticated user.\n\n`POST /v2/users/me/passkeys:registerBegin`\n\n```ts\nconst { data } = await client.beginPasskeyRegistration(\n null,\n {\n friendly_name: \'My Laptop\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "options": {},\n "challenge_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `completePasskeyRegistration`\n\nComplete passkey registration by verifying the attestation response.\n\n`POST /v2/users/me/passkeys:registerComplete`\n\n```ts\nconst { data } = await client.completePasskeyRegistration(\n null,\n {\n challenge_token: \'string\',\n registration_response: {},\n friendly_name: \'My Laptop\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "credential_id": "string",\n "friendly_name": "My Laptop",\n "created_at": "1970-01-01T00:00:00.000Z",\n "transports": ["string"],\n "aaguid": "string"\n}\n```\n\n</details>\n\n---\n\n### `listPasskeys`\n\nList all passkeys registered for the authenticated user.\n\n`GET /v2/users/me/passkeys`\n\n```ts\nconst { data } = await client.listPasskeys()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "passkeys": [\n {\n "credential_id": "string",\n "friendly_name": "My Laptop",\n "created_at": "1970-01-01T00:00:00.000Z",\n "transports": ["string"],\n "aaguid": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `deletePasskey`\n\nDelete a passkey by credential ID.\n\n`DELETE /v2/users/me/passkeys/{credentialId}`\n\n```ts\nconst { data } = await client.deletePasskey({\n credentialId: \'example\',\n})\n```\n\n---\n\n### `switchOrganization`\n\nSwitch to another organization the user is part of\n\n`POST /v2/users/switchOrganization`\n\n```ts\nconst { data } = await client.switchOrganization(\n null,\n {\n org_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "login_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `getMe`\n\nGet currently logged in user\n\n`GET /v1/users/me`\n\n```ts\nconst { data } = await client.getMe()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listUsers`\n\nLists users in organizations you have access to\n\n`GET /v1/users`\n\n```ts\nconst { data } = await client.listUsers({\n org_ids: [\'...\'],\n query: \'example\',\n limit: 1,\n offset: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getUser`\n\nGet user by id\n\n`GET /v1/users/{id}`\n\n```ts\nconst { data } = await client.getUser({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getUserLoginParameters`\n\nGet user organization login parameters by username\n\n`GET /v1/users/username/{username}:getLoginParameters`\n\n```ts\nconst { data } = await client.getUserLoginParameters({\n username: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "login_parameters": [\n {\n "organization_id": "123",\n "organization_name": "epilot GmbH",\n "organization_type": "Vendor",\n "organization_use": "Production",\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_oauth_domain": "epilot-org-123",\n "cognito_oauth_scopes": ["openid"],\n "oauth_response_type": "code",\n "passkey_enabled": true\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `NavigationId`\n\nNavigation unique identifier - a hash of the normalized navigation payload (name + configuration). Identical navigations across orgs will have the same ID.\n\n```ts\ntype NavigationId = string\n```\n\n### `Navigation`\n\nA customized workplace navigation configuration. The ID is a content-hash, so identical configurations will have the same ID.\n\n```ts\ntype Navigation = {\n id: string\n name: string\n configuration: Record<string, Array<{\n key: string\n } | {\n name: string\n subItems: Array<{\n key: { ... }\n }>\n }>>\n}\n```\n\n### `NavigationCreateRequest`\n\nRequest payload to create a new navigation configuration\n\n```ts\ntype NavigationCreateRequest = {\n name: string\n configuration: Record<string, Array<{\n key: string\n } | {\n name: string\n subItems: Array<{\n key: { ... }\n }>\n }>>\n}\n```\n\n### `NavigationConfiguration`\n\nNavigation configuration organized by sections. Each section contains an array of navigation items.\n\n\n```ts\ntype NavigationConfiguration = Record<string, Array<{\n key: string\n} | {\n name: string\n subItems: Array<{\n key: string\n }>\n}>>\n```\n\n### `NavigationItem`\n\nA navigation item - either a simple key item or a group with sub-items\n\n```ts\ntype NavigationItem = {\n key: string\n} | {\n name: string\n subItems: Array<{\n key: string\n }>\n}\n```\n\n### `NavigationKeyItem`\n\nA simple navigation item with a key\n\n```ts\ntype NavigationKeyItem = {\n key: string\n}\n```\n\n### `NavigationGroupItem`\n\nA navigation group containing sub-items\n\n```ts\ntype NavigationGroupItem = {\n name: string\n subItems: Array<{\n key: string\n }>\n}\n```\n\n### `InviteToken`\n\nToken used to invite a user to epilot\n\n```ts\ntype InviteToken = string\n```\n\n### `PartnerInvitationToken`\n\nToken used to invite a partner user to epilot\n\n```ts\ntype PartnerInvitationToken = string\n```\n\n### `VerificationToken`\n\n```ts\ntype VerificationToken = string\n```\n\n### `GroupId`\n\nGroup unique identifier\n\n```ts\ntype GroupId = string\n```\n\n### `UserId`\n\nUser\'s unique identifier\n\n```ts\ntype UserId = string\n```\n\n### `Query`\n\n```ts\ntype Query = string\n```\n\n### `OrganizationId`\n\n```ts\ntype OrganizationId = string\n```\n\n### `Limit`\n\n```ts\ntype Limit = number\n```\n\n### `Offset`\n\n```ts\ntype Offset = number\n```\n\n### `Hydrate`\n\n```ts\ntype Hydrate = boolean\n```\n\n### `Username`\n\n```ts\ntype Username = string\n```\n\n### `UserInvitationPayload`\n\n```ts\ntype UserInvitationPayload = {\n email?: string\n language?: "en" | "de"\n roles?: string[]\n}\n```\n\n### `UserActivationPayload`\n\n```ts\ntype UserActivationPayload = {\n display_name?: string\n password?: string\n}\n```\n\n### `UserVerificationPayload`\n\n```ts\ntype UserVerificationPayload = {\n password?: string\n}\n```\n\n### `UserV2`\n\n```ts\ntype UserV2 = {\n id?: string\n organization_id?: string\n created_at?: string // date-time\n activated_at?: string // date-time\n display_name?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n email?: string // email\n draft_email?: string // email\n department?: string\n phone?: string\n secondary_phone?: string\n mfa_enabled?: boolean\n phone_verified?: boolean\n token?: string\n signature?: string\n is_signature_enabled?: boolean\n preferred_language?: string\n custom_start_page?: string\n custom_navigation?: string\n override_release_channel?: "canary" | "rc" | "stable" | null\n feature_preferences?: Record<string, unknown>\n image_uri?: {\n original?: string // uri\n thumbnail_32?: string // uri\n }\n favorites?: Record<string, unknown>\n email_notification_setting?: Record<string, unknown>\n properties?: Array<{\n name: string\n value: string\n }>\n}\n```\n\n### `User`\n\n```ts\ntype User = {\n id: string\n organization_id: string\n email: string // email\n display_name?: string\n name: string\n preferred_language: string\n signature?: string\n custom_navigation?: string\n roles: string[]\n image_uri?: {\n original?: string // uri\n thumbnail_32?: string // uri\n }\n properties: Array<{\n name: string\n value: string\n }>\n}\n```\n\n### `LoginParameters`\n\n```ts\ntype LoginParameters = {\n organization_id?: string\n organization_name?: string\n organization_type?: string\n organization_use?: string\n cognito_region?: string\n cognito_user_pool_id?: string\n cognito_user_pool_client_id?: string\n cognito_oauth_domain?: string\n cognito_oauth_scopes?: string[]\n oauth_response_type?: "code" | "token"\n passkey_enabled?: boolean\n}\n```\n\n### `CreateGroupReq`\n\n```ts\ntype CreateGroupReq = {\n name: string\n user_ids?: string[]\n}\n```\n\n### `UpdateGroupReq`\n\n```ts\ntype UpdateGroupReq = {\n name?: string\n user_ids?: string[]\n}\n```\n\n### `Group`\n\n```ts\ntype Group = {\n id: string\n org_id: string\n name: string\n created_at: string\n updated_at: string\n created_by?: string\n crt_assignee?: {\n id?: string\n organization_id?: string\n created_at?: string // date-time\n activated_at?: string // date-time\n display_name?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n email?: string // email\n draft_email?: string // email\n department?: string\n phone?: string\n secondary_phone?: string\n mfa_enabled?: boolean\n phone_verified?: boolean\n token?: string\n signature?: string\n is_signature_enabled?: boolean\n preferred_language?: string\n custom_start_page?: string\n custom_navigation?: string\n override_release_channel?: "canary" | "rc" | "stable" | null\n feature_preferences?: Record<string, unknown>\n image_uri?: {\n original?: { ... }\n thumbnail_32?: { ... }\n }\n favorites?: Record<string, unknown>\n email_notification_setting?: Record<string, unknown>\n properties?: Array<{\n name: { ... }\n value: { ... }\n }>\n crt_index?: number\n }\n users?: Array<{\n id?: string\n organization_id?: string\n created_at?: string // date-time\n activated_at?: string // date-time\n display_name?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n email?: string // email\n draft_email?: string // email\n department?: string\n phone?: string\n secondary_phone?: string\n mfa_enabled?: boolean\n phone_verified?: boolean\n token?: string\n signature?: string\n is_signature_enabled?: boolean\n preferred_language?: string\n custom_start_page?: string\n custom_navigation?: string\n override_release_channel?: "canary" | "rc" | "stable" | null\n feature_preferences?: Record<string, unknown>\n image_uri?: {\n original?: { ... }\n thumbnail_32?: { ... }\n }\n favorites?: Record<string, unknown>\n email_notification_setting?: Record<string, unknown>\n properties?: Array<{\n name: { ... }\n value: { ... }\n }>\n }>\n}\n```\n\n### `SignupUserPayload`\n\n```ts\ntype SignupUserPayload = {\n organization_detail?: {\n type: "Vendor" | "Partner"\n name: string\n pricing_tier: string\n email: string\n phone?: string\n website?: string\n is_privacy_policy_checked?: boolean\n is_terms_and_conditions_checked?: boolean\n }\n user_detail?: {\n full_name: string\n email: string // email\n password: string\n }\n language?: "en" | "de"\n}\n```\n\n### `OrganizationDetail`\n\n```ts\ntype OrganizationDetail = {\n type: "Vendor" | "Partner"\n name: string\n pricing_tier: string\n email: string\n phone?: string\n website?: string\n is_privacy_policy_checked?: boolean\n is_terms_and_conditions_checked?: boolean\n}\n```\n\n### `CognitoDetails`\n\n```ts\ntype CognitoDetails = {\n cognito_region?: string\n cognito_user_pool_id?: string\n cognito_user_pool_client_id?: string\n cognito_user_pool_arn?: string\n}\n```\n\n### `UserDetail`\n\n```ts\ntype UserDetail = {\n full_name: string\n email: string // email\n password: string\n}\n```\n\n### `Organization`\n\n```ts\ntype Organization = {\n id?: string\n type?: "Vendor" | "Partner"\n name?: string\n signature?: string\n symbol?: string\n pricing_tier?: string\n email?: string\n phone?: string\n website?: string\n address?: {\n country?: string\n city?: string\n postal_code?: string\n street?: string\n street_number?: string\n }\n logo_url?: string\n logo_thumbnail_url?: string\n is_unlicensed_org?: boolean\n cognito_details?: {\n cognito_region?: string\n cognito_user_pool_id?: string\n cognito_user_pool_client_id?: string\n cognito_user_pool_arn?: string\n }\n}\n```\n\n### `DataPointsResponse`\n\n```ts\ntype DataPointsResponse = Array<{\n id?: number\n actual_users?: number\n max_users_last_month?: number\n non_billable_users_last_month?: number\n}>\n```\n\n### `DataPoint`\n\n```ts\ntype DataPoint = {\n id?: number\n actual_users?: number\n max_users_last_month?: number\n non_billable_users_last_month?: number\n}\n```\n\n### `Passkey`\n\n```ts\ntype Passkey = {\n credential_id?: string\n friendly_name?: string\n created_at?: string // date-time\n transports?: string[]\n aaguid?: string\n}\n```\n\n### `PasskeyAuthenticationOptions`\n\n```ts\ntype PasskeyAuthenticationOptions = {\n options?: object\n challenge_token?: string\n}\n```\n\n### `PasskeyRegistrationOptions`\n\n```ts\ntype PasskeyRegistrationOptions = {\n options?: object\n challenge_token?: string\n}\n```\n\n### `PasskeyRegistrationResponse`\n\n```ts\ntype PasskeyRegistrationResponse = {\n challenge_token: string\n registration_response: object\n friendly_name?: string\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = user_default;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/validation-rules.json
|
|
4
|
+
var validation_rules_default = '# Validation Rules API\n\n- **Base URL:** `https://validation-rules.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/validation-rules](https://docs.epilot.io/api/validation-rules)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.validationRules.getValidationRules(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/validation-rules\'\n\nconst validationRulesClient = getClient()\nauthorize(validationRulesClient, () => \'<token>\')\nconst { data } = await validationRulesClient.getValidationRules(...)\n```\n\n## Operations\n\n**Validation Rules**\n- [`getValidationRules`](#getvalidationrules)\n- [`createValidationRule`](#createvalidationrule)\n- [`getValidationRuleById`](#getvalidationrulebyid)\n- [`updateValidationRule`](#updatevalidationrule)\n- [`deleteValidationRule`](#deletevalidationrule)\n- [`addUsedByReference`](#addusedbyreference)\n- [`removeUsedByReference`](#removeusedbyreference)\n\n**Schemas**\n- [`GetValidationRulesResponse`](#getvalidationrulesresponse)\n- [`CreateValidationRuleRequest`](#createvalidationrulerequest)\n- [`UpdateValidationRuleRequest`](#updatevalidationrulerequest)\n- [`ValidationRuleBase`](#validationrulebase)\n- [`ValidationRule`](#validationrule)\n- [`UsedBy`](#usedby)\n- [`RegexRuleType`](#regexruletype)\n- [`PatternRuleType`](#patternruletype)\n- [`NumericRuleType`](#numericruletype)\n- [`RegexCondition`](#regexcondition)\n- [`RegexNestedCondition`](#regexnestedcondition)\n- [`RegexFactCondition`](#regexfactcondition)\n- [`PatternCondition`](#patterncondition)\n- [`PatternNestedCondition`](#patternnestedcondition)\n- [`PatternFactCondition`](#patternfactcondition)\n- [`NumericCondition`](#numericcondition)\n- [`NumericNestedCondition`](#numericnestedcondition)\n- [`NumericFactCondition`](#numericfactcondition)\n\n### `getValidationRules`\n\nGet all validation rules by organization Id\n\n`GET /v1/validation-rules`\n\n```ts\nconst { data } = await client.getValidationRules()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createValidationRule`\n\nCreate Validation Rule\n\n`POST /v1/validation-rules`\n\n```ts\nconst { data } = await client.createValidationRule(\n null,\n {\n title: \'string\',\n placeholder: \'string\',\n used_by: [\n {\n type: \'journey\',\n schema_slug: \'string\',\n source_id: \'string\'\n }\n ],\n rule: {\n type: \'regex\',\n conditions: {\n all: [\n {\n fact: \'inputValue\',\n operator: \'regexMatch\',\n value: \'string\',\n params: {\n errorMessage: \'string\'\n }\n },\n {\n all: [\n {\n fact: \'inputValue\',\n operator: \'regexMatch\',\n value: \'string\',\n params: {\n errorMessage: \'string\'\n }\n }\n ]\n }\n ]\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getValidationRuleById`\n\nGet validation rule by ID\n\n`GET /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.getValidationRuleById({\n ruleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateValidationRule`\n\nUpdate Validation Rule (partial update)\n\n`PATCH /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.updateValidationRule(\n {\n ruleId: \'example\',\n },\n {\n title: \'string\',\n placeholder: \'string\',\n used_by: [\n {\n type: \'journey\',\n schema_slug: \'string\',\n source_id: \'string\'\n }\n ],\n rule: {\n type: \'regex\',\n conditions: {\n all: [\n {\n fact: \'inputValue\',\n operator: \'regexMatch\',\n value: \'string\',\n params: {\n errorMessage: \'string\'\n }\n },\n {\n all: [\n {\n fact: \'inputValue\',\n operator: \'regexMatch\',\n value: \'string\',\n params: {\n errorMessage: \'string\'\n }\n }\n ]\n }\n ]\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteValidationRule`\n\nDelete Validation Rule\n\n`DELETE /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.deleteValidationRule({\n ruleId: \'example\',\n})\n```\n\n---\n\n### `addUsedByReference`\n\nAdd a reference to the usedBy array\n\n`POST /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.addUsedByReference(\n {\n ruleId: \'example\',\n },\n {\n type: \'journey\',\n schema_slug: \'string\',\n source_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `removeUsedByReference`\n\nRemove a reference from the usedBy array\n\n`DELETE /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.removeUsedByReference(\n {\n ruleId: \'example\',\n },\n {\n type: \'journey\',\n schema_slug: \'string\',\n source_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `GetValidationRulesResponse`\n\n```ts\ntype GetValidationRulesResponse = {\n results?: Array<{\n _schema_version: string\n _id: string\n _organization_id: string\n created_at: string\n updated_at: string\n created_by: string\n updated_by: string\n }>\n}\n```\n\n### `CreateValidationRuleRequest`\n\n```ts\ntype CreateValidationRuleRequest = object\n```\n\n### `UpdateValidationRuleRequest`\n\n```ts\ntype UpdateValidationRuleRequest = {\n title?: string\n placeholder?: string\n used_by?: Array<{\n type: "journey" | "entity"\n schema_slug?: string\n source_id?: string\n }>\n rule?: {\n type: "regex"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n } | {\n type: "pattern"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n } | {\n type: "numeric"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n }\n}\n```\n\n### `ValidationRuleBase`\n\n```ts\ntype ValidationRuleBase = {\n title?: string\n placeholder?: string\n used_by?: Array<{\n type: "journey" | "entity"\n schema_slug?: string\n source_id?: string\n }>\n rule?: {\n type: "regex"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n } | {\n type: "pattern"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n } | {\n type: "numeric"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n }\n}\n```\n\n### `ValidationRule`\n\nThe Validation rule definition.\n\n```ts\ntype ValidationRule = {\n _schema_version: string\n _id: string\n _organization_id: string\n created_at: string\n updated_at: string\n created_by: string\n updated_by: string\n}\n```\n\n### `UsedBy`\n\nDescribes where and how a validation rule is applied.\n\n```ts\ntype UsedBy = {\n type: "journey" | "entity"\n schema_slug?: string\n source_id?: string\n}\n```\n\n### `RegexRuleType`\n\nValidation rule that uses a regular expression to validate input.\n\n```ts\ntype RegexRuleType = {\n type: "regex"\n conditions: {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n }\n}\n```\n\n### `PatternRuleType`\n\nValidation rule that uses a sequence of patterns to validate input.\n\n```ts\ntype PatternRuleType = {\n type: "pattern"\n conditions: {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n }\n}\n```\n\n### `NumericRuleType`\n\nValidation rule for numeric values, supporting range and digit count constraints.\n\n```ts\ntype NumericRuleType = {\n type: "numeric"\n conditions: {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n }\n}\n```\n\n### `RegexCondition`\n\nCondition definition for a regex-based validation rule (2 levels deep)\n\n```ts\ntype RegexCondition = {\n all: Array<{\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n } | {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }\n }>\n} | {\n any: Array<{\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n } | {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }\n }>\n} | {\n not: {\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n } | {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }\n }\n}\n```\n\n### `RegexNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype RegexNestedCondition = {\n all: Array<{\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n }>\n} | {\n any: Array<{\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n }>\n} | {\n not: {\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n }\n}\n```\n\n### `RegexFactCondition`\n\nFact-based condition for regex validation\n\n```ts\ntype RegexFactCondition = {\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: string\n }\n}\n```\n\n### `PatternCondition`\n\nCondition definition for a pattern-based validation rule (2 levels deep)\n\n```ts\ntype PatternCondition = {\n all: Array<{\n fact: "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check" | "total-length"\n operator: "exactlyNDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "in" | "notIn" | "contains" | "doesNotContain"\n value: string[]\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "equal" | "notEqual"\n value: string\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n // ...\n}\n```\n\n### `PatternNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype PatternNestedCondition = {\n all: Array<{\n fact: "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check" | "total-length"\n operator: "exactlyNDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "in" | "notIn" | "contains" | "doesNotContain"\n value: string[]\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "equal" | "notEqual"\n value: string\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n }>\n} | {\n any: Array<{\n fact: "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check" | "total-length"\n operator: "exactlyNDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "in" | "notIn" | "contains" | "doesNotContain"\n value: string[]\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "equal" | "notEqual"\n value: string\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n }>\n} | {\n not: {\n fact: "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check" | "total-length"\n operator: "exactlyNDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "in" | "notIn" | "contains" | "doesNotContain"\n value: string[]\n params?: {\n // ...\n}\n```\n\n### `PatternFactCondition`\n\nFact-based condition for pattern validation\n\n```ts\ntype PatternFactCondition = {\n fact: "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: string\n start?: number\n end?: number\n }\n} | {\n fact: "static-check" | "total-length"\n operator: "exactlyNDigits"\n value: number\n params?: {\n errorMessage?: string\n start?: number\n end?: number\n }\n} | {\n fact: "static-check"\n operator: "in" | "notIn" | "contains" | "doesNotContain"\n value: string[]\n params?: {\n errorMessage?: string\n start?: number\n end?: number\n }\n} | {\n fact: "static-check"\n operator: "equal" | "notEqual"\n value: string\n params?: {\n errorMessage?: string\n start?: number\n end?: number\n }\n}\n```\n\n### `NumericCondition`\n\nCondition definition for a numeric-based validation rule (2 levels deep)\n\n```ts\ntype NumericCondition = {\n all: Array<{\n fact: "numeric-value" | "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "integer-digits-count"\n operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n allowLeadingZeroes?: { ... }\n }\n } | {\n fact: "decimal-digits-count"\n operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "has-leading-zeroes"\n operator: "equal" | "notAllowed"\n value: boolean\n params?: {\n errorMessage?: { ... }\n }\n } | {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }\n }>\n} | {\n any: Array<{\n fact: "numeric-value" | "total-length"\n // ...\n}\n```\n\n### `NumericNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype NumericNestedCondition = {\n all: Array<{\n fact: "numeric-value" | "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "integer-digits-count"\n operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n allowLeadingZeroes?: { ... }\n }\n } | {\n fact: "decimal-digits-count"\n operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "has-leading-zeroes"\n operator: "equal" | "notAllowed"\n value: boolean\n params?: {\n errorMessage?: { ... }\n }\n }>\n} | {\n any: Array<{\n fact: "numeric-value" | "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "integer-digits-count"\n operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n allowLeadingZeroes?: { ... }\n }\n } | {\n fact: "decimal-digits-count"\n operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "has-leading-zeroes"\n operator: "equal" | "notAllowed"\n value: boolean\n params?: {\n errorMessage?: { ... }\n }\n }>\n} | {\n not: {\n fact: "numeric-value" | "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "integer-digits-count"\n operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n allowLeadingZeroes?: { ... }\n }\n } | {\n fact: "decimal-digits-count"\n operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "has-leading-zeroes"\n operator: "equal" | "notAllowed"\n value: boolean\n params?: {\n errorMessage?: { ... }\n }\n }\n}\n```\n\n### `NumericFactCondition`\n\nFact-based condition for numeric validation\n\n```ts\ntype NumericFactCondition = {\n fact: "numeric-value" | "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: string\n }\n} | {\n fact: "integer-digits-count"\n operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n value: number\n params?: {\n errorMessage?: string\n allowLeadingZeroes?: boolean\n }\n} | {\n fact: "decimal-digits-count"\n operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n value: number\n params?: {\n errorMessage?: string\n }\n} | {\n fact: "has-leading-zeroes"\n operator: "equal" | "notAllowed"\n value: boolean\n params?: {\n errorMessage?: string\n }\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
validation_rules_default as default
|
|
7
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/validation-rules.json
|
|
4
|
+
var validation_rules_default = '# Validation Rules API\n\n- **Base URL:** `https://validation-rules.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/validation-rules](https://docs.epilot.io/api/validation-rules)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.validationRules.getValidationRules(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/validation-rules\'\n\nconst validationRulesClient = getClient()\nauthorize(validationRulesClient, () => \'<token>\')\nconst { data } = await validationRulesClient.getValidationRules(...)\n```\n\n## Operations\n\n**Validation Rules**\n- [`getValidationRules`](#getvalidationrules)\n- [`createValidationRule`](#createvalidationrule)\n- [`getValidationRuleById`](#getvalidationrulebyid)\n- [`updateValidationRule`](#updatevalidationrule)\n- [`deleteValidationRule`](#deletevalidationrule)\n- [`addUsedByReference`](#addusedbyreference)\n- [`removeUsedByReference`](#removeusedbyreference)\n\n**Schemas**\n- [`GetValidationRulesResponse`](#getvalidationrulesresponse)\n- [`CreateValidationRuleRequest`](#createvalidationrulerequest)\n- [`UpdateValidationRuleRequest`](#updatevalidationrulerequest)\n- [`ValidationRuleBase`](#validationrulebase)\n- [`ValidationRule`](#validationrule)\n- [`UsedBy`](#usedby)\n- [`RegexRuleType`](#regexruletype)\n- [`PatternRuleType`](#patternruletype)\n- [`NumericRuleType`](#numericruletype)\n- [`RegexCondition`](#regexcondition)\n- [`RegexNestedCondition`](#regexnestedcondition)\n- [`RegexFactCondition`](#regexfactcondition)\n- [`PatternCondition`](#patterncondition)\n- [`PatternNestedCondition`](#patternnestedcondition)\n- [`PatternFactCondition`](#patternfactcondition)\n- [`NumericCondition`](#numericcondition)\n- [`NumericNestedCondition`](#numericnestedcondition)\n- [`NumericFactCondition`](#numericfactcondition)\n\n### `getValidationRules`\n\nGet all validation rules by organization Id\n\n`GET /v1/validation-rules`\n\n```ts\nconst { data } = await client.getValidationRules()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createValidationRule`\n\nCreate Validation Rule\n\n`POST /v1/validation-rules`\n\n```ts\nconst { data } = await client.createValidationRule(\n null,\n {\n title: \'string\',\n placeholder: \'string\',\n used_by: [\n {\n type: \'journey\',\n schema_slug: \'string\',\n source_id: \'string\'\n }\n ],\n rule: {\n type: \'regex\',\n conditions: {\n all: [\n {\n fact: \'inputValue\',\n operator: \'regexMatch\',\n value: \'string\',\n params: {\n errorMessage: \'string\'\n }\n },\n {\n all: [\n {\n fact: \'inputValue\',\n operator: \'regexMatch\',\n value: \'string\',\n params: {\n errorMessage: \'string\'\n }\n }\n ]\n }\n ]\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getValidationRuleById`\n\nGet validation rule by ID\n\n`GET /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.getValidationRuleById({\n ruleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateValidationRule`\n\nUpdate Validation Rule (partial update)\n\n`PATCH /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.updateValidationRule(\n {\n ruleId: \'example\',\n },\n {\n title: \'string\',\n placeholder: \'string\',\n used_by: [\n {\n type: \'journey\',\n schema_slug: \'string\',\n source_id: \'string\'\n }\n ],\n rule: {\n type: \'regex\',\n conditions: {\n all: [\n {\n fact: \'inputValue\',\n operator: \'regexMatch\',\n value: \'string\',\n params: {\n errorMessage: \'string\'\n }\n },\n {\n all: [\n {\n fact: \'inputValue\',\n operator: \'regexMatch\',\n value: \'string\',\n params: {\n errorMessage: \'string\'\n }\n }\n ]\n }\n ]\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteValidationRule`\n\nDelete Validation Rule\n\n`DELETE /v1/validation-rules/{ruleId}`\n\n```ts\nconst { data } = await client.deleteValidationRule({\n ruleId: \'example\',\n})\n```\n\n---\n\n### `addUsedByReference`\n\nAdd a reference to the usedBy array\n\n`POST /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.addUsedByReference(\n {\n ruleId: \'example\',\n },\n {\n type: \'journey\',\n schema_slug: \'string\',\n source_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `removeUsedByReference`\n\nRemove a reference from the usedBy array\n\n`DELETE /v1/validation-rules/{ruleId}/used-by`\n\n```ts\nconst { data } = await client.removeUsedByReference(\n {\n ruleId: \'example\',\n },\n {\n type: \'journey\',\n schema_slug: \'string\',\n source_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "title": "string",\n "placeholder": "string",\n "used_by": [\n {\n "type": "journey",\n "schema_slug": "string",\n "source_id": "string"\n }\n ],\n "rule": {\n "type": "regex",\n "conditions": {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n },\n {\n "all": [\n {\n "fact": "inputValue",\n "operator": "regexMatch",\n "value": "string",\n "params": {\n "errorMessage": "string"\n }\n }\n ]\n }\n ]\n }\n },\n "_schema_version": "string",\n "_id": "string",\n "_organization_id": "string",\n "created_at": "string",\n "updated_at": "string",\n "created_by": "string",\n "updated_by": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `GetValidationRulesResponse`\n\n```ts\ntype GetValidationRulesResponse = {\n results?: Array<{\n _schema_version: string\n _id: string\n _organization_id: string\n created_at: string\n updated_at: string\n created_by: string\n updated_by: string\n }>\n}\n```\n\n### `CreateValidationRuleRequest`\n\n```ts\ntype CreateValidationRuleRequest = object\n```\n\n### `UpdateValidationRuleRequest`\n\n```ts\ntype UpdateValidationRuleRequest = {\n title?: string\n placeholder?: string\n used_by?: Array<{\n type: "journey" | "entity"\n schema_slug?: string\n source_id?: string\n }>\n rule?: {\n type: "regex"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n } | {\n type: "pattern"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n } | {\n type: "numeric"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n }\n}\n```\n\n### `ValidationRuleBase`\n\n```ts\ntype ValidationRuleBase = {\n title?: string\n placeholder?: string\n used_by?: Array<{\n type: "journey" | "entity"\n schema_slug?: string\n source_id?: string\n }>\n rule?: {\n type: "regex"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n } | {\n type: "pattern"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n } | {\n type: "numeric"\n conditions: {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n }\n}\n```\n\n### `ValidationRule`\n\nThe Validation rule definition.\n\n```ts\ntype ValidationRule = {\n _schema_version: string\n _id: string\n _organization_id: string\n created_at: string\n updated_at: string\n created_by: string\n updated_by: string\n}\n```\n\n### `UsedBy`\n\nDescribes where and how a validation rule is applied.\n\n```ts\ntype UsedBy = {\n type: "journey" | "entity"\n schema_slug?: string\n source_id?: string\n}\n```\n\n### `RegexRuleType`\n\nValidation rule that uses a regular expression to validate input.\n\n```ts\ntype RegexRuleType = {\n type: "regex"\n conditions: {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n }\n}\n```\n\n### `PatternRuleType`\n\nValidation rule that uses a sequence of patterns to validate input.\n\n```ts\ntype PatternRuleType = {\n type: "pattern"\n conditions: {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n }\n}\n```\n\n### `NumericRuleType`\n\nValidation rule for numeric values, supporting range and digit count constraints.\n\n```ts\ntype NumericRuleType = {\n type: "numeric"\n conditions: {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n all: { ... }\n } | {\n any: { ... }\n } | {\n not: { ... }\n }\n }\n}\n```\n\n### `RegexCondition`\n\nCondition definition for a regex-based validation rule (2 levels deep)\n\n```ts\ntype RegexCondition = {\n all: Array<{\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n } | {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }\n }>\n} | {\n any: Array<{\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n } | {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }\n }>\n} | {\n not: {\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n } | {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }\n }\n}\n```\n\n### `RegexNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype RegexNestedCondition = {\n all: Array<{\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n }>\n} | {\n any: Array<{\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n }>\n} | {\n not: {\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: { ... }\n }\n }\n}\n```\n\n### `RegexFactCondition`\n\nFact-based condition for regex validation\n\n```ts\ntype RegexFactCondition = {\n fact: "inputValue"\n operator: "regexMatch"\n value: string\n params?: {\n errorMessage?: string\n }\n}\n```\n\n### `PatternCondition`\n\nCondition definition for a pattern-based validation rule (2 levels deep)\n\n```ts\ntype PatternCondition = {\n all: Array<{\n fact: "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check" | "total-length"\n operator: "exactlyNDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "in" | "notIn" | "contains" | "doesNotContain"\n value: string[]\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "equal" | "notEqual"\n value: string\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n // ...\n}\n```\n\n### `PatternNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype PatternNestedCondition = {\n all: Array<{\n fact: "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check" | "total-length"\n operator: "exactlyNDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "in" | "notIn" | "contains" | "doesNotContain"\n value: string[]\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "equal" | "notEqual"\n value: string\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n }>\n} | {\n any: Array<{\n fact: "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check" | "total-length"\n operator: "exactlyNDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "in" | "notIn" | "contains" | "doesNotContain"\n value: string[]\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "equal" | "notEqual"\n value: string\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n }>\n} | {\n not: {\n fact: "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check" | "total-length"\n operator: "exactlyNDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n start?: { ... }\n end?: { ... }\n }\n } | {\n fact: "static-check"\n operator: "in" | "notIn" | "contains" | "doesNotContain"\n value: string[]\n params?: {\n // ...\n}\n```\n\n### `PatternFactCondition`\n\nFact-based condition for pattern validation\n\n```ts\ntype PatternFactCondition = {\n fact: "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: string\n start?: number\n end?: number\n }\n} | {\n fact: "static-check" | "total-length"\n operator: "exactlyNDigits"\n value: number\n params?: {\n errorMessage?: string\n start?: number\n end?: number\n }\n} | {\n fact: "static-check"\n operator: "in" | "notIn" | "contains" | "doesNotContain"\n value: string[]\n params?: {\n errorMessage?: string\n start?: number\n end?: number\n }\n} | {\n fact: "static-check"\n operator: "equal" | "notEqual"\n value: string\n params?: {\n errorMessage?: string\n start?: number\n end?: number\n }\n}\n```\n\n### `NumericCondition`\n\nCondition definition for a numeric-based validation rule (2 levels deep)\n\n```ts\ntype NumericCondition = {\n all: Array<{\n fact: "numeric-value" | "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "integer-digits-count"\n operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n allowLeadingZeroes?: { ... }\n }\n } | {\n fact: "decimal-digits-count"\n operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "has-leading-zeroes"\n operator: "equal" | "notAllowed"\n value: boolean\n params?: {\n errorMessage?: { ... }\n }\n } | {\n all: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n any: Array<{\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }>\n } | {\n not: {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n } | {\n fact: { ... }\n operator: { ... }\n value: { ... }\n params?: { ... }\n }\n }>\n} | {\n any: Array<{\n fact: "numeric-value" | "total-length"\n // ...\n}\n```\n\n### `NumericNestedCondition`\n\nNested condition with logical operators (level 2 only)\n\n```ts\ntype NumericNestedCondition = {\n all: Array<{\n fact: "numeric-value" | "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "integer-digits-count"\n operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n allowLeadingZeroes?: { ... }\n }\n } | {\n fact: "decimal-digits-count"\n operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "has-leading-zeroes"\n operator: "equal" | "notAllowed"\n value: boolean\n params?: {\n errorMessage?: { ... }\n }\n }>\n} | {\n any: Array<{\n fact: "numeric-value" | "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "integer-digits-count"\n operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n allowLeadingZeroes?: { ... }\n }\n } | {\n fact: "decimal-digits-count"\n operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "has-leading-zeroes"\n operator: "equal" | "notAllowed"\n value: boolean\n params?: {\n errorMessage?: { ... }\n }\n }>\n} | {\n not: {\n fact: "numeric-value" | "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "integer-digits-count"\n operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n allowLeadingZeroes?: { ... }\n }\n } | {\n fact: "decimal-digits-count"\n operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n value: number\n params?: {\n errorMessage?: { ... }\n }\n } | {\n fact: "has-leading-zeroes"\n operator: "equal" | "notAllowed"\n value: boolean\n params?: {\n errorMessage?: { ... }\n }\n }\n}\n```\n\n### `NumericFactCondition`\n\nFact-based condition for numeric validation\n\n```ts\ntype NumericFactCondition = {\n fact: "numeric-value" | "total-length"\n operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive"\n value: number\n params?: {\n errorMessage?: string\n }\n} | {\n fact: "integer-digits-count"\n operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits"\n value: number\n params?: {\n errorMessage?: string\n allowLeadingZeroes?: boolean\n }\n} | {\n fact: "decimal-digits-count"\n operator: "equal" | "minDecimalDigits" | "maxDecimalDigits"\n value: number\n params?: {\n errorMessage?: string\n }\n} | {\n fact: "has-leading-zeroes"\n operator: "equal" | "notAllowed"\n value: boolean\n params?: {\n errorMessage?: string\n }\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = validation_rules_default;
|