@epilot/sdk 2.2.7 → 2.3.1
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/README.md +3 -2
- package/definitions/automation-runtime.json +1 -1
- package/definitions/automation.json +209 -0
- package/definitions/blueprint-manifest-runtime.json +1 -1
- package/definitions/blueprint-manifest.json +1279 -150
- package/definitions/data-governance-runtime.json +1 -0
- package/definitions/data-governance.json +1126 -0
- package/definitions/deduplication-runtime.json +1 -1
- package/definitions/deduplication.json +135 -4
- package/definitions/design-runtime.json +1 -1
- package/definitions/design.json +103 -57
- package/definitions/email-settings-runtime.json +1 -1
- package/definitions/email-settings.json +29 -0
- package/definitions/entity.json +44 -2
- package/definitions/{erp-integration-runtime.json → integration-toolkit-runtime.json} +1 -1
- package/definitions/{erp-integration.json → integration-toolkit.json} +76 -5
- package/definitions/journey.json +9 -0
- package/definitions/message-runtime.json +1 -1
- package/definitions/message.json +202 -0
- package/definitions/sharing-runtime.json +1 -0
- package/definitions/sharing.json +956 -0
- package/definitions/template-variables.json +12 -4
- package/definitions/user.json +52 -0
- package/definitions/workflow-definition.json +15 -1
- package/definitions/workflow-runtime.json +1 -1
- package/definitions/workflow.json +102 -0
- package/dist/README-KX4XC2HB.js +7 -0
- package/dist/README-PTYV6PQI.cjs +7 -0
- package/dist/{_index-NWNYWBIF.js → _index-CLT2KTVS.js} +9 -6
- package/dist/{_index-ONGE545F.cjs → _index-O7JDGRSE.cjs} +8 -5
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +8 -8
- package/dist/apis/automation.d.cts +2 -2
- package/dist/apis/automation.d.ts +2 -2
- package/dist/apis/automation.js +2 -2
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +8 -8
- package/dist/apis/blueprint-manifest.d.cts +2 -2
- package/dist/apis/blueprint-manifest.d.ts +2 -2
- package/dist/apis/blueprint-manifest.js +2 -2
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +38 -0
- package/dist/apis/{data-management.d.cts → data-governance.d.cts} +5 -5
- package/dist/apis/{data-management.d.ts → data-governance.d.ts} +5 -5
- package/dist/apis/{data-management.js → data-governance.js} +10 -10
- package/dist/apis/deduplication.cjs +8 -8
- package/dist/apis/deduplication.d.cts +2 -2
- package/dist/apis/deduplication.d.ts +2 -2
- package/dist/apis/deduplication.js +2 -2
- package/dist/apis/design.cjs +8 -8
- package/dist/apis/design.d.cts +2 -2
- package/dist/apis/design.d.ts +2 -2
- package/dist/apis/design.js +2 -2
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +8 -8
- package/dist/apis/email-settings.d.cts +2 -2
- package/dist/apis/email-settings.d.ts +2 -2
- package/dist/apis/email-settings.js +2 -2
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.d.cts +2 -2
- package/dist/apis/entity.d.ts +2 -2
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/erp-integration.cjs +6 -6
- package/dist/apis/erp-integration.d.cts +5755 -3
- package/dist/apis/erp-integration.d.ts +5755 -3
- package/dist/apis/erp-integration.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +38 -0
- package/dist/apis/integration-toolkit.d.cts +18 -0
- package/dist/apis/integration-toolkit.d.ts +18 -0
- package/dist/apis/integration-toolkit.js +38 -0
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +8 -8
- package/dist/apis/message.d.cts +2 -2
- package/dist/apis/message.d.ts +2 -2
- package/dist/apis/message.js +2 -2
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +38 -0
- package/dist/apis/sharing.d.cts +18 -0
- package/dist/apis/sharing.d.ts +18 -0
- package/dist/apis/sharing.js +38 -0
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.d.cts +2 -2
- package/dist/apis/template-variables.d.ts +2 -2
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.d.cts +2 -2
- package/dist/apis/user.d.ts +2 -2
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.d.cts +2 -2
- package/dist/apis/workflow-definition.d.ts +2 -2
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +8 -8
- package/dist/apis/workflow.d.cts +2 -2
- package/dist/apis/workflow.d.ts +2 -2
- package/dist/apis/workflow.js +2 -2
- package/dist/automation-GFNNLSIN.js +7 -0
- package/dist/automation-IOCVCTKR.cjs +7 -0
- package/dist/{automation-runtime-YBGGE5PL.cjs → automation-runtime-DO5QSGJJ.cjs} +2 -2
- package/dist/{automation-runtime-L5UKEFLA.js → automation-runtime-VP4M7Z4R.js} +1 -1
- package/dist/{automation.d-D7BzN7Gq.d.cts → automation.d-CzhG2m4L.d.cts} +353 -3
- package/dist/{automation.d-D7BzN7Gq.d.ts → automation.d-CzhG2m4L.d.ts} +353 -3
- package/dist/blueprint-manifest-ELK4SGN7.js +7 -0
- package/dist/blueprint-manifest-VBOWPK52.cjs +7 -0
- package/dist/{blueprint-manifest-runtime-2RTW5C52.js → blueprint-manifest-runtime-E2FN43TB.js} +1 -1
- package/dist/{blueprint-manifest-runtime-AF3FIDVX.cjs → blueprint-manifest-runtime-G4UK5VEX.cjs} +2 -2
- package/dist/{blueprint-manifest.d-DECw6HdM.d.cts → blueprint-manifest.d-BGrGU787.d.cts} +712 -22
- package/dist/{blueprint-manifest.d-DECw6HdM.d.ts → blueprint-manifest.d-BGrGU787.d.ts} +712 -22
- package/dist/chunk-5APJZUIH.cjs +14 -0
- package/dist/chunk-5ED7FB3Q.js +14 -0
- package/dist/{chunk-UNCVJH6J.cjs → chunk-77JS7NDM.cjs} +1 -1
- package/dist/{chunk-6UAS2VVG.js → chunk-DLYPVF4U.js} +1 -1
- package/dist/chunk-DVM27A7E.cjs +14 -0
- package/dist/{chunk-3NLMZLCD.js → chunk-EFWPEVXI.js} +1 -1
- package/dist/chunk-EIIIKDOJ.cjs +14 -0
- package/dist/{chunk-HAZ3WP7V.cjs → chunk-IAHSYVYB.cjs} +1 -1
- package/dist/chunk-JTFWOEZF.cjs +14 -0
- package/dist/{chunk-A67W5WAP.cjs → chunk-KEI3GHDY.cjs} +1 -1
- package/dist/chunk-KIWRGUKM.js +14 -0
- package/dist/{chunk-PSQMDY3B.js → chunk-KQKBSWGI.js} +1 -1
- package/dist/chunk-NPDSA7T2.js +14 -0
- package/dist/{chunk-ZI33AJQ5.cjs → chunk-QNZPOA54.cjs} +1 -1
- package/dist/{chunk-BN6EJPDC.js → chunk-QSEIJWJW.js} +31 -26
- package/dist/{chunk-VUVWHQMP.cjs → chunk-TKTSGA7G.cjs} +31 -26
- package/dist/chunk-TZQFJ5GX.cjs +14 -0
- package/dist/chunk-U4PUHKZC.js +14 -0
- package/dist/chunk-VPDA5SAH.js +14 -0
- package/dist/chunk-WT26LFC2.js +14 -0
- package/dist/{chunk-3YSEO476.js → chunk-X2SC4GW5.js} +1 -1
- package/dist/chunk-ZL6KDJFT.cjs +14 -0
- package/dist/data-governance-2U5UU4GM.cjs +7 -0
- package/dist/data-governance-36Y33JVG.js +7 -0
- package/dist/{data-management-W5JQGGGH.js → data-governance-PLS5TJ7Z.js} +3 -3
- package/dist/{data-management-XFSRLFYA.cjs → data-governance-ZJ2K4ZWX.cjs} +3 -3
- package/dist/data-governance-runtime-LITKCNSG.js +5 -0
- package/dist/{data-management-runtime-J5IS7T47.cjs → data-governance-runtime-TDGFG67G.cjs} +2 -2
- package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
- package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
- package/dist/deduplication-G2ZY4NMX.js +7 -0
- package/dist/deduplication-PKKTZAEA.cjs +7 -0
- package/dist/{deduplication-runtime-BBHG7MJW.cjs → deduplication-runtime-5QS6I4S7.cjs} +2 -2
- package/dist/{deduplication-runtime-DLGBF4RN.js → deduplication-runtime-VL4R2VIG.js} +1 -1
- package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
- package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
- package/dist/design-NISDHPFD.cjs +7 -0
- package/dist/design-WL4AZIGX.js +7 -0
- package/dist/design-runtime-OXEXKZVG.cjs +5 -0
- package/dist/{design-runtime-3SKJA7QH.js → design-runtime-QMJM4FAF.js} +1 -1
- package/dist/{design.d-eA-irKEX.d.ts → design.d-DTo29S0F.d.cts} +142 -15
- package/dist/{design.d-eA-irKEX.d.cts → design.d-DTo29S0F.d.ts} +142 -15
- package/dist/email-settings-CKFJU4WZ.js +7 -0
- package/dist/email-settings-NQJJKS2P.cjs +7 -0
- package/dist/{email-settings-runtime-Q2HVKJDS.js → email-settings-runtime-EGIJ2AVQ.js} +1 -1
- package/dist/{email-settings-runtime-3NJIAWWI.cjs → email-settings-runtime-WGVLI7N6.cjs} +2 -2
- package/dist/{email-settings.d-DUvmLZMN.d.ts → email-settings.d-B7Q_xT25.d.cts} +29 -2
- package/dist/{email-settings.d-DUvmLZMN.d.cts → email-settings.d-B7Q_xT25.d.ts} +29 -2
- package/dist/entity-CK76MXVN.js +7 -0
- package/dist/entity-TFMH5VTZ.cjs +7 -0
- package/dist/{entity.d-__Tx1Y0J.d.cts → entity.d-ByufVI16.d.cts} +40 -1
- package/dist/{entity.d-__Tx1Y0J.d.ts → entity.d-ByufVI16.d.ts} +40 -1
- package/dist/erp-integration-PAVHSUDM.cjs +7 -0
- package/dist/erp-integration-SBQJ6HEG.js +7 -0
- package/dist/index.cjs +67 -40
- package/dist/index.d.cts +36 -34
- package/dist/index.d.ts +36 -34
- package/dist/index.js +54 -27
- package/dist/integration-toolkit-FRPFOYT2.js +7 -0
- package/dist/integration-toolkit-VNMDI55O.cjs +7 -0
- package/dist/integration-toolkit-runtime-5KG3LGXF.cjs +5 -0
- package/dist/integration-toolkit-runtime-LYHFVIRW.js +5 -0
- package/dist/{erp-integration.d-B4XPU_j-.d.cts → integration-toolkit.d-Ry-KC9ow.d.cts} +69 -3
- package/dist/{erp-integration.d-B4XPU_j-.d.ts → integration-toolkit.d-Ry-KC9ow.d.ts} +69 -3
- package/dist/journey-KDR5EU3W.js +7 -0
- package/dist/journey-REBN4TGQ.cjs +7 -0
- package/dist/{journey.d-BguKXj73.d.cts → journey.d-ClXO0xK8.d.cts} +8 -0
- package/dist/{journey.d-BguKXj73.d.ts → journey.d-ClXO0xK8.d.ts} +8 -0
- package/dist/message-HCA2KSH6.js +7 -0
- package/dist/message-J2SFQJNB.cjs +7 -0
- package/dist/{message-runtime-ITR7MPKT.cjs → message-runtime-CGFCT6FU.cjs} +2 -2
- package/dist/{message-runtime-YMKW2N3R.js → message-runtime-XDCFFLYK.js} +1 -1
- package/dist/{message.d-YEv1kmQd.d.cts → message.d-D3QUkBjg.d.cts} +230 -4
- package/dist/{message.d-YEv1kmQd.d.ts → message.d-D3QUkBjg.d.ts} +230 -4
- package/dist/sharing-KEWK5LNG.js +976 -0
- package/dist/sharing-MNDABPL7.js +7 -0
- package/dist/sharing-MR7ANOST.cjs +7 -0
- package/dist/sharing-WG4L7LH2.cjs +976 -0
- package/dist/sharing-runtime-OZGIZWL3.js +5 -0
- package/dist/sharing-runtime-VOFLBIFW.cjs +5 -0
- package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
- package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
- package/dist/{template-variables-VKDJJZUT.js → template-variables-6CLOG67C.js} +13 -0
- package/dist/{template-variables-OAYS2E3G.cjs → template-variables-I72B5WS6.cjs} +13 -0
- package/dist/{template-variables.d-Ch3H3zYf.d.cts → template-variables.d-Ble9TSBa.d.cts} +8 -2
- package/dist/{template-variables.d-Ch3H3zYf.d.ts → template-variables.d-Ble9TSBa.d.ts} +8 -2
- package/dist/user-7ZN2XO7G.cjs +7 -0
- package/dist/user-ZK7BK6VY.js +7 -0
- package/dist/{user.d-CXqM751M.d.cts → user.d-D18fe97W.d.cts} +75 -3
- package/dist/{user.d-CXqM751M.d.ts → user.d-D18fe97W.d.ts} +75 -3
- package/dist/workflow-CQOBZ25C.cjs +7 -0
- package/dist/workflow-G7VFCXY7.js +7 -0
- package/dist/workflow-definition-CVBYKAUY.cjs +7 -0
- package/dist/workflow-definition-GNAKDNG7.js +7 -0
- package/dist/{workflow-definition.d-CtmE-ymB.d.cts → workflow-definition.d-ByCJK9_x.d.cts} +16 -0
- package/dist/{workflow-definition.d-CtmE-ymB.d.ts → workflow-definition.d-ByCJK9_x.d.ts} +16 -0
- package/dist/{workflow-runtime-RLZO2OQB.js → workflow-runtime-DNTQDYPQ.js} +1 -1
- package/dist/{workflow-runtime-WCJ7NRTH.cjs → workflow-runtime-VKFESVFX.cjs} +2 -2
- package/dist/{workflow.d-DvhTpEtU.d.cts → workflow.d-pD8ISOg-.d.cts} +73 -1
- package/dist/{workflow.d-DvhTpEtU.d.ts → workflow.d-pD8ISOg-.d.ts} +73 -1
- package/docs/automation.md +141 -15
- package/docs/blueprint-manifest.md +854 -55
- package/docs/{data-management.md → data-governance.md} +113 -28
- package/docs/deduplication.md +122 -0
- package/docs/design.md +140 -82
- package/docs/email-settings.md +22 -0
- package/docs/entity.md +17 -0
- package/docs/erp-integration.md +21 -6
- package/docs/integration-toolkit.md +6048 -0
- package/docs/journey.md +6 -0
- package/docs/message.md +110 -1
- package/docs/sharing.md +1181 -0
- package/docs/template-variables.md +13 -0
- package/docs/user.md +62 -8
- package/docs/workflow-definition.md +28 -14
- package/docs/workflow.md +231 -30
- package/package.json +29 -17
- package/definitions/data-management-runtime.json +0 -1
- package/definitions/data-management.json +0 -978
- package/dist/README-6OOYWQYJ.cjs +0 -7
- package/dist/README-JUWX7KNV.js +0 -7
- package/dist/apis/data-management.cjs +0 -38
- package/dist/automation-3HGCK725.cjs +0 -7
- package/dist/automation-72VGEJCY.js +0 -7
- package/dist/blueprint-manifest-CXSCRQ5X.js +0 -7
- package/dist/blueprint-manifest-SHNZPK5O.cjs +0 -7
- package/dist/chunk-4BCQGZJB.cjs +0 -14
- package/dist/chunk-4G6LO3JY.cjs +0 -14
- package/dist/chunk-6GC363VV.js +0 -14
- package/dist/chunk-75ZWZM3L.js +0 -14
- package/dist/chunk-D32L2HMX.cjs +0 -14
- package/dist/chunk-O4JDWMYD.js +0 -14
- package/dist/chunk-RXMOHUBP.cjs +0 -14
- package/dist/chunk-ZKQ573B7.js +0 -14
- package/dist/data-management-3N3A3XBM.js +0 -7
- package/dist/data-management-YXFLQWLV.cjs +0 -7
- package/dist/data-management-runtime-DN7FGK7G.js +0 -5
- package/dist/data-management.d-BXS5jbJY.d.cts +0 -547
- package/dist/data-management.d-BXS5jbJY.d.ts +0 -547
- package/dist/deduplication-ECVAZVVA.cjs +0 -7
- package/dist/deduplication-GYIST22B.js +0 -7
- package/dist/deduplication.d-w_2aJD5f.d.cts +0 -113
- package/dist/deduplication.d-w_2aJD5f.d.ts +0 -113
- package/dist/design-KUVXMFFK.cjs +0 -7
- package/dist/design-YKBXRW5C.js +0 -7
- package/dist/design-runtime-Y3VGTQLP.cjs +0 -5
- package/dist/email-settings-EJ3DCPPN.js +0 -7
- package/dist/email-settings-TALOPLBC.cjs +0 -7
- package/dist/entity-M5F22DSS.cjs +0 -7
- package/dist/entity-RT4YRZDG.js +0 -7
- package/dist/erp-integration-76K5HOGL.js +0 -7
- package/dist/erp-integration-A33WOGPF.cjs +0 -7
- package/dist/journey-HKN7QXCZ.cjs +0 -7
- package/dist/journey-UBZCOJNW.js +0 -7
- package/dist/message-3XZLJR6R.cjs +0 -7
- package/dist/message-ZNMCS5YH.js +0 -7
- package/dist/user-EIEOI3OG.js +0 -7
- package/dist/user-NJJ7XVKB.cjs +0 -7
- package/dist/workflow-3LLURW3H.js +0 -7
- package/dist/workflow-RAGQDYXT.cjs +0 -7
- package/dist/workflow-definition-MBOMPMCG.js +0 -7
- package/dist/workflow-definition-SPAHD3HS.cjs +0 -7
|
@@ -3,12 +3,9 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Template Variables API",
|
|
5
5
|
"description": "This API provides dynamic template processing and variable management, seamless Handlebars template compilation, custom variable operations, and context-aware content generation across email, document templates and snippets.\n",
|
|
6
|
-
"version": "1.
|
|
6
|
+
"version": "1.1.0"
|
|
7
7
|
},
|
|
8
8
|
"servers": [
|
|
9
|
-
{
|
|
10
|
-
"url": "https://template-variables-api.sls.epilot.io"
|
|
11
|
-
},
|
|
12
9
|
{
|
|
13
10
|
"url": "https://template-variables-api.sls.epilot.io"
|
|
14
11
|
},
|
|
@@ -644,6 +641,10 @@
|
|
|
644
641
|
"type": "string"
|
|
645
642
|
}
|
|
646
643
|
},
|
|
644
|
+
"template_id": {
|
|
645
|
+
"type": "string",
|
|
646
|
+
"description": "The Id of email template"
|
|
647
|
+
},
|
|
647
648
|
"variables_version": {
|
|
648
649
|
"type": "string",
|
|
649
650
|
"description": "The version of the variables syntax supported. Default is 1.0",
|
|
@@ -1081,6 +1082,13 @@
|
|
|
1081
1082
|
"type": "string"
|
|
1082
1083
|
}
|
|
1083
1084
|
},
|
|
1085
|
+
"_manifest": {
|
|
1086
|
+
"type": "array",
|
|
1087
|
+
"description": "The manifest IDs associated with this custom variable",
|
|
1088
|
+
"items": {
|
|
1089
|
+
"type": "string"
|
|
1090
|
+
}
|
|
1091
|
+
},
|
|
1084
1092
|
"helper_params": {
|
|
1085
1093
|
"type": "array",
|
|
1086
1094
|
"description": "The helper function parameter's names",
|
package/definitions/user.json
CHANGED
|
@@ -1984,6 +1984,49 @@
|
|
|
1984
1984
|
}
|
|
1985
1985
|
}
|
|
1986
1986
|
},
|
|
1987
|
+
"GroupImageUri": {
|
|
1988
|
+
"description": "Group's profile image or gradient colors. Supports uploaded image URLs and generated gradient avatars.",
|
|
1989
|
+
"type": "object",
|
|
1990
|
+
"additionalProperties": true,
|
|
1991
|
+
"nullable": true,
|
|
1992
|
+
"properties": {
|
|
1993
|
+
"original": {
|
|
1994
|
+
"type": "string",
|
|
1995
|
+
"format": "uri",
|
|
1996
|
+
"example": "https://account-profile-images.epilot.cloud/org/group-avatar.png"
|
|
1997
|
+
},
|
|
1998
|
+
"thumbnail_32": {
|
|
1999
|
+
"type": "string",
|
|
2000
|
+
"format": "uri",
|
|
2001
|
+
"example": "https://account-profile-images.epilot.cloud/org/group-avatar_32x32.png"
|
|
2002
|
+
},
|
|
2003
|
+
"thumbnail_64": {
|
|
2004
|
+
"type": "string",
|
|
2005
|
+
"format": "uri",
|
|
2006
|
+
"example": "https://account-profile-images.epilot.cloud/org/group-avatar_64x64.png"
|
|
2007
|
+
},
|
|
2008
|
+
"gradient_colors": {
|
|
2009
|
+
"type": "array",
|
|
2010
|
+
"description": "Two hex color strings [base_color, accent_color] for mesh gradient avatar.",
|
|
2011
|
+
"items": {
|
|
2012
|
+
"type": "string",
|
|
2013
|
+
"pattern": "^#[0-9a-fA-F]{6}$"
|
|
2014
|
+
},
|
|
2015
|
+
"minItems": 2,
|
|
2016
|
+
"maxItems": 2,
|
|
2017
|
+
"example": [
|
|
2018
|
+
"#0588f0",
|
|
2019
|
+
"#3358d4"
|
|
2020
|
+
]
|
|
2021
|
+
}
|
|
2022
|
+
},
|
|
2023
|
+
"example": {
|
|
2024
|
+
"gradient_colors": [
|
|
2025
|
+
"#0588f0",
|
|
2026
|
+
"#3358d4"
|
|
2027
|
+
]
|
|
2028
|
+
}
|
|
2029
|
+
},
|
|
1987
2030
|
"CreateGroupReq": {
|
|
1988
2031
|
"type": "object",
|
|
1989
2032
|
"properties": {
|
|
@@ -2002,6 +2045,9 @@
|
|
|
2002
2045
|
"123",
|
|
2003
2046
|
"456"
|
|
2004
2047
|
]
|
|
2048
|
+
},
|
|
2049
|
+
"image_uri": {
|
|
2050
|
+
"$ref": "#/components/schemas/GroupImageUri"
|
|
2005
2051
|
}
|
|
2006
2052
|
},
|
|
2007
2053
|
"required": [
|
|
@@ -2026,6 +2072,9 @@
|
|
|
2026
2072
|
"123",
|
|
2027
2073
|
"456"
|
|
2028
2074
|
]
|
|
2075
|
+
},
|
|
2076
|
+
"image_uri": {
|
|
2077
|
+
"$ref": "#/components/schemas/GroupImageUri"
|
|
2029
2078
|
}
|
|
2030
2079
|
}
|
|
2031
2080
|
},
|
|
@@ -2080,6 +2129,9 @@
|
|
|
2080
2129
|
"items": {
|
|
2081
2130
|
"$ref": "#/components/schemas/UserV2"
|
|
2082
2131
|
}
|
|
2132
|
+
},
|
|
2133
|
+
"image_uri": {
|
|
2134
|
+
"$ref": "#/components/schemas/GroupImageUri"
|
|
2083
2135
|
}
|
|
2084
2136
|
},
|
|
2085
2137
|
"required": [
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Workflows Definitions",
|
|
5
|
-
"version": "1.
|
|
5
|
+
"version": "1.1.0",
|
|
6
6
|
"description": "Service for Workflow Definitions for different processes inside of an Organization\n"
|
|
7
7
|
},
|
|
8
8
|
"servers": [
|
|
@@ -1698,6 +1698,13 @@
|
|
|
1698
1698
|
"singleClosingReasonSelection": {
|
|
1699
1699
|
"type": "boolean",
|
|
1700
1700
|
"description": "Whether only a single closing reason can be selected"
|
|
1701
|
+
},
|
|
1702
|
+
"_manifest": {
|
|
1703
|
+
"type": "array",
|
|
1704
|
+
"description": "The manifest IDs associated with this workflow",
|
|
1705
|
+
"items": {
|
|
1706
|
+
"type": "string"
|
|
1707
|
+
}
|
|
1701
1708
|
}
|
|
1702
1709
|
}
|
|
1703
1710
|
},
|
|
@@ -2736,6 +2743,13 @@
|
|
|
2736
2743
|
"singleClosingReasonSelection": {
|
|
2737
2744
|
"type": "boolean",
|
|
2738
2745
|
"description": "Whether only a single closing reason can be selected"
|
|
2746
|
+
},
|
|
2747
|
+
"_manifest": {
|
|
2748
|
+
"type": "array",
|
|
2749
|
+
"description": "The manifest IDs associated with this workflow",
|
|
2750
|
+
"items": {
|
|
2751
|
+
"type": "string"
|
|
2752
|
+
}
|
|
2739
2753
|
}
|
|
2740
2754
|
},
|
|
2741
2755
|
"required": [
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"s":"https://workflows-execution.sls.epilot.io","o":[["getExecutions","get","/v1/workflows/executions",[["context","q"],["schema","q"]]],["createExecution","post","/v1/workflows/executions",null,1],["getExecution","get","/v1/workflows/executions/{executionId}",[["executionId","p",true]]],["updateExecution","patch","/v1/workflows/executions/{executionId}",[["executionId","p",true]],1],["deleteExecution","delete","/v1/workflows/executions/{executionId}",[["executionId","p",true]]],["createStep","post","/v1/workflows/executions/{executionId}/steps",[["executionId","p",true]],1],["updateStep","patch","/v1/workflows/executions/{executionId}/steps/{stepId}",[["executionId","p",true],["stepId","p",true]],1],["deleteStep","delete","/v1/workflows/executions/{executionId}/steps/{stepId}",[["executionId","p",true],["stepId","p",true]]],["searchExecutions","post","/v1/workflows/executions/search",null,1],["searchSteps","post","/v1/workflows/executions/steps/search",null,1],["getClosingReasonExecution","get","/v1/workflows/executions/{executionId}/closing-reasons",[["executionId","p",true]]],["startFlowExecution","post","/v2/flows/executions",null,1],["getFlowExecution","get","/v2/flows/executions/{execution_id}",[["ExecutionIdParam"]]],["patchFlowExecution","patch","/v2/flows/executions/{execution_id}",[["ExecutionIdParam"]],1],["deleteFlowExecution","delete","/v2/flows/executions/{execution_id}",[["ExecutionIdParam"],["SoftDeleteParam"]]],["searchFlowExecutions","post","/v2/flows/executions:search",null,1],["patchTask","patch","/v2/flows/executions/{execution_id}/tasks/{task_id}",[["ExecutionIdParam"],["TaskIdParam"]],1],["runTaskAutomation","post","/v2/flows/executions/{execution_id}/tasks/{task_id}/automation:run",[["ExecutionIdParam"],["TaskIdParam"]]],["executeTask","post","/v2/flows/executions/{execution_id}/tasks/{task_id}/execute",[["ExecutionIdParam"],["TaskIdParam"]]],["patchPhase","patch","/v2/flows/executions/{execution_id}/phases/{phase_id}",[["ExecutionIdParam"],["PhaseIdParam"]],1],["addTask","post","/v2/flows/executions/{execution_id}/tasks",[["ExecutionIdParam"]],1],["cancelTaskSchedule","delete","/v2/flows/executions/{execution_id}/tasks/{task_id}/schedule",[["ExecutionIdParam"],["TaskIdParam"]]],["cancelSchedule","post","/v2/flows/executions/{execution_id}/schedules/{schedule_id}",[["ExecutionIdParam"],["ScheduleIdParam"]]]],"v":"3.0.0","cp":{"ExecutionIdParam":["execution_id","p",true],"TaskIdParam":["task_id","p",true],"PhaseIdParam":["phase_id","p",true],"ScheduleIdParam":["schedule_id","p",true],"SoftDeleteParam":["soft","q"]}}
|
|
1
|
+
{"s":"https://workflows-execution.sls.epilot.io","o":[["getExecutions","get","/v1/workflows/executions",[["context","q"],["schema","q"]]],["createExecution","post","/v1/workflows/executions",null,1],["getExecution","get","/v1/workflows/executions/{executionId}",[["executionId","p",true]]],["updateExecution","patch","/v1/workflows/executions/{executionId}",[["executionId","p",true]],1],["deleteExecution","delete","/v1/workflows/executions/{executionId}",[["executionId","p",true]]],["createStep","post","/v1/workflows/executions/{executionId}/steps",[["executionId","p",true]],1],["updateStep","patch","/v1/workflows/executions/{executionId}/steps/{stepId}",[["executionId","p",true],["stepId","p",true]],1],["deleteStep","delete","/v1/workflows/executions/{executionId}/steps/{stepId}",[["executionId","p",true],["stepId","p",true]]],["searchExecutions","post","/v1/workflows/executions/search",null,1],["searchSteps","post","/v1/workflows/executions/steps/search",null,1],["getClosingReasonExecution","get","/v1/workflows/executions/{executionId}/closing-reasons",[["executionId","p",true]]],["startFlowExecution","post","/v2/flows/executions",null,1],["getFlowExecution","get","/v2/flows/executions/{execution_id}",[["ExecutionIdParam"]]],["patchFlowExecution","patch","/v2/flows/executions/{execution_id}",[["ExecutionIdParam"]],1],["deleteFlowExecution","delete","/v2/flows/executions/{execution_id}",[["ExecutionIdParam"],["SoftDeleteParam"]]],["searchFlowExecutions","post","/v2/flows/executions:search",null,1],["patchTask","patch","/v2/flows/executions/{execution_id}/tasks/{task_id}",[["ExecutionIdParam"],["TaskIdParam"]],1],["runTaskAutomation","post","/v2/flows/executions/{execution_id}/tasks/{task_id}/automation:run",[["ExecutionIdParam"],["TaskIdParam"]]],["executeTask","post","/v2/flows/executions/{execution_id}/tasks/{task_id}/execute",[["ExecutionIdParam"],["TaskIdParam"]]],["patchPhase","patch","/v2/flows/executions/{execution_id}/phases/{phase_id}",[["ExecutionIdParam"],["PhaseIdParam"]],1],["addTask","post","/v2/flows/executions/{execution_id}/tasks",[["ExecutionIdParam"]],1],["cancelTaskSchedule","delete","/v2/flows/executions/{execution_id}/tasks/{task_id}/schedule",[["ExecutionIdParam"],["TaskIdParam"]]],["runTaskScheduleNow","post","/v2/flows/executions/{execution_id}/tasks/{task_id}/schedule/run-now",[["ExecutionIdParam"],["TaskIdParam"]]],["cancelSchedule","post","/v2/flows/executions/{execution_id}/schedules/{schedule_id}",[["ExecutionIdParam"],["ScheduleIdParam"]]]],"v":"3.0.0","cp":{"ExecutionIdParam":["execution_id","p",true],"TaskIdParam":["task_id","p",true],"PhaseIdParam":["phase_id","p",true],"ScheduleIdParam":["schedule_id","p",true],"SoftDeleteParam":["soft","q"]}}
|
|
@@ -1317,6 +1317,76 @@
|
|
|
1317
1317
|
}
|
|
1318
1318
|
}
|
|
1319
1319
|
},
|
|
1320
|
+
"/v2/flows/executions/{execution_id}/tasks/{task_id}/schedule/run-now": {
|
|
1321
|
+
"post": {
|
|
1322
|
+
"operationId": "runTaskScheduleNow",
|
|
1323
|
+
"summary": "runTaskScheduleNow",
|
|
1324
|
+
"description": "Cancels the pending schedule for a task and immediately triggers its automation execution.",
|
|
1325
|
+
"tags": [
|
|
1326
|
+
"Flows V2"
|
|
1327
|
+
],
|
|
1328
|
+
"parameters": [
|
|
1329
|
+
{
|
|
1330
|
+
"$ref": "#/components/parameters/ExecutionIdParam"
|
|
1331
|
+
},
|
|
1332
|
+
{
|
|
1333
|
+
"$ref": "#/components/parameters/TaskIdParam"
|
|
1334
|
+
}
|
|
1335
|
+
],
|
|
1336
|
+
"responses": {
|
|
1337
|
+
"200": {
|
|
1338
|
+
"description": "Success - task automation has been triggered",
|
|
1339
|
+
"content": {
|
|
1340
|
+
"application/json": {
|
|
1341
|
+
"schema": {
|
|
1342
|
+
"$ref": "#/components/schemas/Task"
|
|
1343
|
+
}
|
|
1344
|
+
}
|
|
1345
|
+
}
|
|
1346
|
+
},
|
|
1347
|
+
"400": {
|
|
1348
|
+
"description": "Validation Errors",
|
|
1349
|
+
"content": {
|
|
1350
|
+
"application/json": {
|
|
1351
|
+
"schema": {
|
|
1352
|
+
"$ref": "#/components/schemas/ErrorResp"
|
|
1353
|
+
}
|
|
1354
|
+
}
|
|
1355
|
+
}
|
|
1356
|
+
},
|
|
1357
|
+
"401": {
|
|
1358
|
+
"description": "Authentication Errors",
|
|
1359
|
+
"content": {
|
|
1360
|
+
"application/json": {
|
|
1361
|
+
"schema": {
|
|
1362
|
+
"$ref": "#/components/schemas/ErrorResp"
|
|
1363
|
+
}
|
|
1364
|
+
}
|
|
1365
|
+
}
|
|
1366
|
+
},
|
|
1367
|
+
"404": {
|
|
1368
|
+
"description": "Not Found",
|
|
1369
|
+
"content": {
|
|
1370
|
+
"application/json": {
|
|
1371
|
+
"schema": {
|
|
1372
|
+
"$ref": "#/components/schemas/ErrorResp"
|
|
1373
|
+
}
|
|
1374
|
+
}
|
|
1375
|
+
}
|
|
1376
|
+
},
|
|
1377
|
+
"500": {
|
|
1378
|
+
"description": "Other errors",
|
|
1379
|
+
"content": {
|
|
1380
|
+
"application/json": {
|
|
1381
|
+
"schema": {
|
|
1382
|
+
"$ref": "#/components/schemas/ErrorResp"
|
|
1383
|
+
}
|
|
1384
|
+
}
|
|
1385
|
+
}
|
|
1386
|
+
}
|
|
1387
|
+
}
|
|
1388
|
+
}
|
|
1389
|
+
},
|
|
1320
1390
|
"/v2/flows/executions/{execution_id}/schedules/{schedule_id}": {
|
|
1321
1391
|
"post": {
|
|
1322
1392
|
"operationId": "cancelSchedule",
|
|
@@ -1978,6 +2048,10 @@
|
|
|
1978
2048
|
"installer": {
|
|
1979
2049
|
"$ref": "#/components/schemas/ECPDetails"
|
|
1980
2050
|
},
|
|
2051
|
+
"partner": {
|
|
2052
|
+
"$ref": "#/components/schemas/PartnerDetails",
|
|
2053
|
+
"description": "Partner-specific task details shown to partner org users viewing shared resources"
|
|
2054
|
+
},
|
|
1981
2055
|
"enabled": {
|
|
1982
2056
|
"type": "boolean"
|
|
1983
2057
|
},
|
|
@@ -2209,6 +2283,21 @@
|
|
|
2209
2283
|
}
|
|
2210
2284
|
}
|
|
2211
2285
|
},
|
|
2286
|
+
"PartnerDetails": {
|
|
2287
|
+
"type": "object",
|
|
2288
|
+
"description": "Details regarding partner for the workflow step",
|
|
2289
|
+
"properties": {
|
|
2290
|
+
"enabled": {
|
|
2291
|
+
"type": "boolean"
|
|
2292
|
+
},
|
|
2293
|
+
"label": {
|
|
2294
|
+
"type": "string"
|
|
2295
|
+
},
|
|
2296
|
+
"description": {
|
|
2297
|
+
"type": "string"
|
|
2298
|
+
}
|
|
2299
|
+
}
|
|
2300
|
+
},
|
|
2212
2301
|
"StepDescription": {
|
|
2213
2302
|
"type": "object",
|
|
2214
2303
|
"description": "Longer information regarding Task",
|
|
@@ -3405,6 +3494,11 @@
|
|
|
3405
3494
|
"$ref": "#/components/schemas/Condition"
|
|
3406
3495
|
}
|
|
3407
3496
|
},
|
|
3497
|
+
"allow_parallel_execution": {
|
|
3498
|
+
"type": "boolean",
|
|
3499
|
+
"description": "When true, all branches with met conditions execute in parallel. When false, only the first branch with a met condition is executed. Defaults to true for backwards compatibility.",
|
|
3500
|
+
"default": true
|
|
3501
|
+
},
|
|
3408
3502
|
"schedule": {
|
|
3409
3503
|
"anyOf": [
|
|
3410
3504
|
{
|
|
@@ -3550,6 +3644,10 @@
|
|
|
3550
3644
|
"installer": {
|
|
3551
3645
|
"$ref": "#/components/schemas/ECPDetails"
|
|
3552
3646
|
},
|
|
3647
|
+
"partner": {
|
|
3648
|
+
"$ref": "#/components/schemas/PartnerDetails",
|
|
3649
|
+
"description": "Partner-specific task details shown to partner org users viewing shared resources"
|
|
3650
|
+
},
|
|
3553
3651
|
"taxonomies": {
|
|
3554
3652
|
"type": "array",
|
|
3555
3653
|
"items": {
|
|
@@ -4050,6 +4148,10 @@
|
|
|
4050
4148
|
"installer": {
|
|
4051
4149
|
"$ref": "#/components/schemas/ECPDetails"
|
|
4052
4150
|
},
|
|
4151
|
+
"partner": {
|
|
4152
|
+
"$ref": "#/components/schemas/PartnerDetails",
|
|
4153
|
+
"description": "Partner-specific task details shown to partner org users viewing shared resources"
|
|
4154
|
+
},
|
|
4053
4155
|
"next_condition_id": {
|
|
4054
4156
|
"type": "string",
|
|
4055
4157
|
"description": "Condition to evaluate as true for a decision task with a manual trigger mode"
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/README.json
|
|
4
|
+
var README_default = "<h1 align=\"center\"><img alt=\"epilot\" src=\"https://raw.githubusercontent.com/epilot-dev/sdk-js/main/logo.png\" width=\"200\"><br>@epilot/sdk</h1>\n\n<p align=\"center\">\n <a href=\"https://github.com/epilot-dev/sdk-js/actions?query=workflow%3ACI\"><img src=\"https://github.com/epilot-dev/sdk-js/workflows/CI/badge.svg\" alt=\"CI\"></a>\n <a href=\"https://www.npmjs.com/package/@epilot/sdk\"><img src=\"https://img.shields.io/npm/v/@epilot/sdk.svg\" alt=\"npm version\"></a>\n <a href=\"https://github.com/epilot-dev/sdk-js/blob/main/\"><img src=\"http://img.shields.io/:license-mit-blue.svg\" alt=\"License\"></a>\n</p>\n\n<p align=\"center\">JavaScript/TypeScript SDK for epilot APIs. Full types, tree-shakeable imports, and lazy-loaded OpenAPI specs.</p>\n\n## Install\n\n```bash\nnpm i @epilot/sdk axios openapi-client-axios\n```\n\n## Quick Start\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\nepilot.authorize(() => '<my-bearer-token>')\n\nconst { data: entity } = await epilot.entity.createEntity(\n { slug: 'contact' },\n { first_name: 'John', last_name: 'Doe' },\n)\n\nconst { data: file } = await epilot.file.getFile({ id: 'file-123' })\n\nconst { data: executions } = await epilot.workflow.getExecutions()\n```\n\nAPI clients are built on [openapi-client-axios](https://openapistack.co/docs/openapi-client-axios/intro/), which generates fully typed operation methods on top of regular [axios](https://axios-http.com/docs/intro) instances. All standard axios features (interceptors, defaults, config) work as expected. Each operation is forwarded to a lazy singleton \u2014 the spec is loaded and the client initialized on first use, then cached.\n\nFull API documentation: [https://docs.epilot.io/api](https://docs.epilot.io/api)\n\n## API Reference\n\n<!-- api-reference-table -->\n| API | Import | Docs |\n| --- | ------ | ---- |\n| `epilot.accessToken` | `@epilot/sdk/access-token` | [docs](./docs/access-token.md) |\n| `epilot.address` | `@epilot/sdk/address` | [docs](./docs/address.md) |\n| `epilot.addressSuggestions` | `@epilot/sdk/address-suggestions` | [docs](./docs/address-suggestions.md) |\n| `epilot.aiAgents` | `@epilot/sdk/ai-agents` | [docs](./docs/ai-agents.md) |\n| `epilot.app` | `@epilot/sdk/app` | [docs](./docs/app.md) |\n| `epilot.auditLogs` | `@epilot/sdk/audit-logs` | [docs](./docs/audit-logs.md) |\n| `epilot.automation` | `@epilot/sdk/automation` | [docs](./docs/automation.md) |\n| `epilot.billing` | `@epilot/sdk/billing` | [docs](./docs/billing.md) |\n| `epilot.blueprintManifest` | `@epilot/sdk/blueprint-manifest` | [docs](./docs/blueprint-manifest.md) |\n| `epilot.consent` | `@epilot/sdk/consent` | [docs](./docs/consent.md) |\n| `epilot.customerPortal` | `@epilot/sdk/customer-portal` | [docs](./docs/customer-portal.md) |\n| `epilot.dashboard` | `@epilot/sdk/dashboard` | [docs](./docs/dashboard.md) |\n| `epilot.dataGovernance` | `@epilot/sdk/data-governance` | [docs](./docs/data-governance.md) |\n| `epilot.deduplication` | `@epilot/sdk/deduplication` | [docs](./docs/deduplication.md) |\n| `epilot.design` | `@epilot/sdk/design` | [docs](./docs/design.md) |\n| `epilot.document` | `@epilot/sdk/document` | [docs](./docs/document.md) |\n| `epilot.emailSettings` | `@epilot/sdk/email-settings` | [docs](./docs/email-settings.md) |\n| `epilot.emailTemplate` | `@epilot/sdk/email-template` | [docs](./docs/email-template.md) |\n| `epilot.entity` | `@epilot/sdk/entity` | [docs](./docs/entity.md) |\n| `epilot.entityMapping` | `@epilot/sdk/entity-mapping` | [docs](./docs/entity-mapping.md) |\n| `epilot.environments` | `@epilot/sdk/environments` | [docs](./docs/environments.md) |\n| `epilot.eventCatalog` | `@epilot/sdk/event-catalog` | [docs](./docs/event-catalog.md) |\n| `epilot.file` | `@epilot/sdk/file` | [docs](./docs/file.md) |\n| `epilot.iban` | `@epilot/sdk/iban` | [docs](./docs/iban.md) |\n| `epilot.integrationToolkit` | `@epilot/sdk/integration-toolkit` | [docs](./docs/integration-toolkit.md) |\n| `epilot.journey` | `@epilot/sdk/journey` | [docs](./docs/journey.md) |\n| `epilot.kanban` | `@epilot/sdk/kanban` | [docs](./docs/kanban.md) |\n| `epilot.message` | `@epilot/sdk/message` | [docs](./docs/message.md) |\n| `epilot.metering` | `@epilot/sdk/metering` | [docs](./docs/metering.md) |\n| `epilot.notes` | `@epilot/sdk/notes` | [docs](./docs/notes.md) |\n| `epilot.notification` | `@epilot/sdk/notification` | [docs](./docs/notification.md) |\n| `epilot.organization` | `@epilot/sdk/organization` | [docs](./docs/organization.md) |\n| `epilot.partnerDirectory` | `@epilot/sdk/partner-directory` | [docs](./docs/partner-directory.md) |\n| `epilot.permissions` | `@epilot/sdk/permissions` | [docs](./docs/permissions.md) |\n| `epilot.pricing` | `@epilot/sdk/pricing` | [docs](./docs/pricing.md) |\n| `epilot.pricingTier` | `@epilot/sdk/pricing-tier` | [docs](./docs/pricing-tier.md) |\n| `epilot.purpose` | `@epilot/sdk/purpose` | [docs](./docs/purpose.md) |\n| `epilot.sandbox` | `@epilot/sdk/sandbox` | [docs](./docs/sandbox.md) |\n| `epilot.sharing` | `@epilot/sdk/sharing` | [docs](./docs/sharing.md) |\n| `epilot.submission` | `@epilot/sdk/submission` | [docs](./docs/submission.md) |\n| `epilot.targeting` | `@epilot/sdk/targeting` | [docs](./docs/targeting.md) |\n| `epilot.templateVariables` | `@epilot/sdk/template-variables` | [docs](./docs/template-variables.md) |\n| `epilot.user` | `@epilot/sdk/user` | [docs](./docs/user.md) |\n| `epilot.validationRules` | `@epilot/sdk/validation-rules` | [docs](./docs/validation-rules.md) |\n| `epilot.webhooks` | `@epilot/sdk/webhooks` | [docs](./docs/webhooks.md) |\n| `epilot.workflow` | `@epilot/sdk/workflow` | [docs](./docs/workflow.md) |\n| `epilot.workflowDefinition` | `@epilot/sdk/workflow-definition` | [docs](./docs/workflow-definition.md) |\n<!-- /api-reference-table -->\n\n## OpenAPI Spec\n\nRetrieve the full OpenAPI specification for any API at runtime. The spec is lazy-loaded on first call and cached.\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\n// Via API handle\nconst entitySpec = await epilot.entity.openapi()\nconsole.log(entitySpec.info.title) // \"Entity API\"\nconsole.log(entitySpec.paths) // all paths with full schemas\n\n// Via top-level method\nconst spec = await epilot.openapi('entity')\n```\n\nFor tree-shakeable imports:\n\n```ts\nimport { openapi } from '@epilot/sdk/entity'\n\nconst spec = await openapi()\n```\n\n## Explicit Client Access\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\nepilot.authorize(() => '<my-token>')\n\n// Get the cached singleton client\nconst entityClient = epilot.entity.getClient()\nconst { data } = await entityClient.getEntity({ slug: 'contact', id: '123' })\n\n// Create a fresh (non-singleton) client instance\nconst freshClient = epilot.entity.createClient()\nauthorize(freshClient, () => '<my-token>')\n```\n\n## Tree-Shakeable Imports\n\nImport only what you need. Other APIs never touch your bundle.\n\n```ts\nimport { getClient, authorize } from '@epilot/sdk/entity'\n\nconst entityClient = getClient()\nauthorize(entityClient, () => '<my-token>')\n\nconst { data } = await entityClient.getEntity({ slug: 'contact', id: '123' })\n\n// Or use the handle for direct operation forwarding\nimport { entity } from '@epilot/sdk/entity'\nconst { data } = await entity.getEntity({ slug: 'contact', id: '123' })\n```\n\n## Types\n\nEach API subpath re-exports all schema types generated from the OpenAPI spec. Import them directly:\n\n```ts\nimport type { Entity, EntitySchema, RelationAttribute } from '@epilot/sdk/entity'\nimport type { FileItem } from '@epilot/sdk/file'\nimport type { AutomationFlow } from '@epilot/sdk/automation'\n```\n\nThe `Client`, `OperationMethods`, and `PathsDictionary` types are also available for typing client instances:\n\n```ts\nimport type { Client } from '@epilot/sdk/entity'\n\nconst entityClient: Client = epilot.entity.getClient()\n```\n\n## Headers\n\n### Global Headers\n\nSet default headers applied to all clients. Useful for `x-epilot-org-id`, `x-epilot-user-id`, etc.\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\nepilot.authorize(() => '<my-token>')\nepilot.headers({\n 'x-epilot-org-id': 'org-123',\n 'x-epilot-user-id': 'user-456',\n})\n\nconst { data } = await epilot.entity.searchEntities(...)\n```\n\n### Standard Axios Headers\n\nUse standard axios `defaults.headers.common` on individual clients:\n\n```ts\nconst entityClient = epilot.entity.getClient()\nentityClient.defaults.headers.common['x-epilot-org-id'] = 'org-123'\n```\n\n## Auth Patterns\n\n`authorize()` accepts a string or a function. The function form is preferred \u2014 it is called on every request, so tokens stay fresh.\n\n```ts\nimport { authorize } from '@epilot/sdk'\nimport { getClient } from '@epilot/sdk/entity'\n\n// Per-client \u2014 function predicate (recommended)\nconst entityClient = getClient()\nauthorize(entityClient, () => '<my-token>')\n\n// Per-client \u2014 async function (e.g. OAuth / session)\nauthorize(entityClient, async () => {\n return await getTokenFromSession()\n})\n\n// Per-client \u2014 static string (sets default header once)\nauthorize(entityClient, 'my-static-api-token')\n```\n\n```ts\n// Global \u2014 applies to all clients resolved from the SDK\nimport { epilot } from '@epilot/sdk'\n\nepilot.authorize(() => '<my-token>')\nepilot.authorize(async () => await getTokenFromSession())\nepilot.authorize('my-static-api-token')\n```\n\n## Fresh Client Instance\n\n```ts\nimport { createClient, authorize } from '@epilot/sdk/entity'\n\nconst entityClient = createClient()\nauthorize(entityClient, () => '<my-token>')\nentityClient.defaults.headers.common['x-epilot-org-id'] = 'org-123'\n```\n\n## Multiple SDK Instances\n\n```ts\nimport { createSDK } from '@epilot/sdk'\n\nconst sdk1 = createSDK()\nsdk1.authorize(() => '<token-for-org-1>')\nsdk1.headers({ 'x-epilot-org-id': 'org-1' })\n\nconst sdk2 = createSDK()\nsdk2.authorize(() => '<token-for-org-2>')\nsdk2.headers({ 'x-epilot-org-id': 'org-2' })\n```\n\n\n## Interceptors\n\nUse axios interceptors for custom request/response processing. Since clients are axios instances, you can use `client.interceptors` directly:\n\n```ts\nentityClient.interceptors.response.use((response) => {\n console.debug(`${response.config.method?.toUpperCase()} ${response.config.url}`, {\n status: response.status,\n data: response.data,\n })\n return response\n})\n```\n\nOr register global interceptors applied to all clients:\n\n```ts\nepilot.interceptors.request((config) => {\n config.headers['x-correlation-id'] = generateTraceId()\n return config\n})\n```\n\n## Auto-Retry (429 Too Many Requests)\n\nThe SDK automatically retries requests that receive a `429 Too Many Requests` response. It respects the `Retry-After` header (in seconds) to determine how long to wait before retrying.\n\nEnabled by default with up to 3 retries.\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\n// Customize retry behavior\nepilot.retry({ maxRetries: 5, defaultDelayMs: 2000 })\n\n// Disable retries\nepilot.retry({ maxRetries: 0 })\n```\n\n| Option | Default | Description |\n| --- | --- | --- |\n| `maxRetries` | `3` | Maximum number of retries. Set to `0` to disable. |\n| `defaultDelayMs` | `1000` | Fallback delay in ms when `Retry-After` header is missing. |\n\nFor individually imported clients (tree-shakeable imports), apply the interceptor manually:\n\n```ts\nimport { getClient, authorize } from '@epilot/sdk/entity'\nimport { applyRetryInterceptor } from '@epilot/sdk'\n\nconst entityClient = getClient()\nauthorize(entityClient, () => '<my-token>')\napplyRetryInterceptor({ client: entityClient, config: { maxRetries: 3 } })\n```\n\n## Large Response Handling (413 Payload Too Large)\n\nepilot APIs use a [large response middleware](https://github.com/epilot-dev/aws-lambda-utility-middlewares) to work around the AWS Lambda 6MB response limit. When a response exceeds ~5.1MB, the API uploads the payload to S3 and returns a presigned URL instead.\n\nThe SDK handles this transparently \u2014 it sends the opt-in `Accept` header and automatically fetches the full payload from S3 when a large response URL is returned. Enabled by default.\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\n// Disable large response handling\nepilot.largeResponse({ enabled: false })\n```\n\nFor individually imported clients (tree-shakeable imports), apply the interceptor manually:\n\n```ts\nimport { getClient, authorize } from '@epilot/sdk/entity'\nimport { applyLargeResponseInterceptor } from '@epilot/sdk'\n\nconst entityClient = getClient()\nauthorize(entityClient, () => '<my-token>')\napplyLargeResponseInterceptor({ client: entityClient, config: { enabled: true } })\n```\n\n## Overrides & Custom APIs\n\nOverride built-in API specs or register custom APIs via `.epilot/sdk-overrides.json`. This is useful for testing new versions of an API spec or getting the latest types without waiting for an SDK release.\n\n```json\n{\n \"entity\": \"./specs/entity-openapi.json\",\n \"myNewApi\": \"./specs/my-new-api-openapi.json\"\n}\n```\n\n```ts\n// Built-in API with overridden spec\nconst { data } = await epilot.entity.getEntity({ slug: 'contact', id: '123' })\n```\n\n### Override Commands\n\n```bash\n# Apply all overrides from .epilot/sdk-overrides.json\nnpx epilot-sdk override\n\n# Override a single API\nnpx epilot-sdk override entity ./my-local-entity-spec.yaml\n\n# Regenerate types after spec changes\nnpx epilot-sdk typegen\n```\n\n<details>\n<summary>Migration from <code>@epilot/*-client</code></summary>\n\nDrop-in replacement \u2014 just change the import path:\n\n```ts\n// Before\nimport { getClient, createClient, authorize } from '@epilot/entity-client'\nimport type { Client, Entity } from '@epilot/entity-client'\n\n// After\nimport { getClient, createClient, authorize } from '@epilot/sdk/entity'\nimport type { Client, Entity } from '@epilot/sdk/entity'\n```\n\n</details>\n\n<details>\n<summary>Client Lifecycle</summary>\n\nWhen you call `authorize()`, `headers()`, `retry()`, `largeResponse()`, or `interceptors`, the SDK invalidates all cached client instances. The next operation call creates a fresh client with the updated configuration.\n\n**Operation methods are always up to date** \u2014 calls like `epilot.entity.getEntity(...)` re-resolve the client on every invocation, so they always use the latest config.\n\n**Direct `getClient()` references can go stale** \u2014 if you hold a reference and then change config, your reference still points to the old client:\n\n```ts\nconst entityClient = epilot.entity.getClient()\n\nepilot.authorize('new-token') // invalidates all cached clients\n\n// entityClient still has the old token\n// epilot.entity.getEntity(...) will use a new client with the new token\n```\n\nIf you need a long-lived reference that survives config changes, call `getClient()` again after changing config, or use operation methods directly.\n\n</details>\n";
|
|
5
|
+
export {
|
|
6
|
+
README_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/README.json
|
|
4
|
+
var README_default = "<h1 align=\"center\"><img alt=\"epilot\" src=\"https://raw.githubusercontent.com/epilot-dev/sdk-js/main/logo.png\" width=\"200\"><br>@epilot/sdk</h1>\n\n<p align=\"center\">\n <a href=\"https://github.com/epilot-dev/sdk-js/actions?query=workflow%3ACI\"><img src=\"https://github.com/epilot-dev/sdk-js/workflows/CI/badge.svg\" alt=\"CI\"></a>\n <a href=\"https://www.npmjs.com/package/@epilot/sdk\"><img src=\"https://img.shields.io/npm/v/@epilot/sdk.svg\" alt=\"npm version\"></a>\n <a href=\"https://github.com/epilot-dev/sdk-js/blob/main/\"><img src=\"http://img.shields.io/:license-mit-blue.svg\" alt=\"License\"></a>\n</p>\n\n<p align=\"center\">JavaScript/TypeScript SDK for epilot APIs. Full types, tree-shakeable imports, and lazy-loaded OpenAPI specs.</p>\n\n## Install\n\n```bash\nnpm i @epilot/sdk axios openapi-client-axios\n```\n\n## Quick Start\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\nepilot.authorize(() => '<my-bearer-token>')\n\nconst { data: entity } = await epilot.entity.createEntity(\n { slug: 'contact' },\n { first_name: 'John', last_name: 'Doe' },\n)\n\nconst { data: file } = await epilot.file.getFile({ id: 'file-123' })\n\nconst { data: executions } = await epilot.workflow.getExecutions()\n```\n\nAPI clients are built on [openapi-client-axios](https://openapistack.co/docs/openapi-client-axios/intro/), which generates fully typed operation methods on top of regular [axios](https://axios-http.com/docs/intro) instances. All standard axios features (interceptors, defaults, config) work as expected. Each operation is forwarded to a lazy singleton \u2014 the spec is loaded and the client initialized on first use, then cached.\n\nFull API documentation: [https://docs.epilot.io/api](https://docs.epilot.io/api)\n\n## API Reference\n\n<!-- api-reference-table -->\n| API | Import | Docs |\n| --- | ------ | ---- |\n| `epilot.accessToken` | `@epilot/sdk/access-token` | [docs](./docs/access-token.md) |\n| `epilot.address` | `@epilot/sdk/address` | [docs](./docs/address.md) |\n| `epilot.addressSuggestions` | `@epilot/sdk/address-suggestions` | [docs](./docs/address-suggestions.md) |\n| `epilot.aiAgents` | `@epilot/sdk/ai-agents` | [docs](./docs/ai-agents.md) |\n| `epilot.app` | `@epilot/sdk/app` | [docs](./docs/app.md) |\n| `epilot.auditLogs` | `@epilot/sdk/audit-logs` | [docs](./docs/audit-logs.md) |\n| `epilot.automation` | `@epilot/sdk/automation` | [docs](./docs/automation.md) |\n| `epilot.billing` | `@epilot/sdk/billing` | [docs](./docs/billing.md) |\n| `epilot.blueprintManifest` | `@epilot/sdk/blueprint-manifest` | [docs](./docs/blueprint-manifest.md) |\n| `epilot.consent` | `@epilot/sdk/consent` | [docs](./docs/consent.md) |\n| `epilot.customerPortal` | `@epilot/sdk/customer-portal` | [docs](./docs/customer-portal.md) |\n| `epilot.dashboard` | `@epilot/sdk/dashboard` | [docs](./docs/dashboard.md) |\n| `epilot.dataGovernance` | `@epilot/sdk/data-governance` | [docs](./docs/data-governance.md) |\n| `epilot.deduplication` | `@epilot/sdk/deduplication` | [docs](./docs/deduplication.md) |\n| `epilot.design` | `@epilot/sdk/design` | [docs](./docs/design.md) |\n| `epilot.document` | `@epilot/sdk/document` | [docs](./docs/document.md) |\n| `epilot.emailSettings` | `@epilot/sdk/email-settings` | [docs](./docs/email-settings.md) |\n| `epilot.emailTemplate` | `@epilot/sdk/email-template` | [docs](./docs/email-template.md) |\n| `epilot.entity` | `@epilot/sdk/entity` | [docs](./docs/entity.md) |\n| `epilot.entityMapping` | `@epilot/sdk/entity-mapping` | [docs](./docs/entity-mapping.md) |\n| `epilot.environments` | `@epilot/sdk/environments` | [docs](./docs/environments.md) |\n| `epilot.eventCatalog` | `@epilot/sdk/event-catalog` | [docs](./docs/event-catalog.md) |\n| `epilot.file` | `@epilot/sdk/file` | [docs](./docs/file.md) |\n| `epilot.iban` | `@epilot/sdk/iban` | [docs](./docs/iban.md) |\n| `epilot.integrationToolkit` | `@epilot/sdk/integration-toolkit` | [docs](./docs/integration-toolkit.md) |\n| `epilot.journey` | `@epilot/sdk/journey` | [docs](./docs/journey.md) |\n| `epilot.kanban` | `@epilot/sdk/kanban` | [docs](./docs/kanban.md) |\n| `epilot.message` | `@epilot/sdk/message` | [docs](./docs/message.md) |\n| `epilot.metering` | `@epilot/sdk/metering` | [docs](./docs/metering.md) |\n| `epilot.notes` | `@epilot/sdk/notes` | [docs](./docs/notes.md) |\n| `epilot.notification` | `@epilot/sdk/notification` | [docs](./docs/notification.md) |\n| `epilot.organization` | `@epilot/sdk/organization` | [docs](./docs/organization.md) |\n| `epilot.partnerDirectory` | `@epilot/sdk/partner-directory` | [docs](./docs/partner-directory.md) |\n| `epilot.permissions` | `@epilot/sdk/permissions` | [docs](./docs/permissions.md) |\n| `epilot.pricing` | `@epilot/sdk/pricing` | [docs](./docs/pricing.md) |\n| `epilot.pricingTier` | `@epilot/sdk/pricing-tier` | [docs](./docs/pricing-tier.md) |\n| `epilot.purpose` | `@epilot/sdk/purpose` | [docs](./docs/purpose.md) |\n| `epilot.sandbox` | `@epilot/sdk/sandbox` | [docs](./docs/sandbox.md) |\n| `epilot.sharing` | `@epilot/sdk/sharing` | [docs](./docs/sharing.md) |\n| `epilot.submission` | `@epilot/sdk/submission` | [docs](./docs/submission.md) |\n| `epilot.targeting` | `@epilot/sdk/targeting` | [docs](./docs/targeting.md) |\n| `epilot.templateVariables` | `@epilot/sdk/template-variables` | [docs](./docs/template-variables.md) |\n| `epilot.user` | `@epilot/sdk/user` | [docs](./docs/user.md) |\n| `epilot.validationRules` | `@epilot/sdk/validation-rules` | [docs](./docs/validation-rules.md) |\n| `epilot.webhooks` | `@epilot/sdk/webhooks` | [docs](./docs/webhooks.md) |\n| `epilot.workflow` | `@epilot/sdk/workflow` | [docs](./docs/workflow.md) |\n| `epilot.workflowDefinition` | `@epilot/sdk/workflow-definition` | [docs](./docs/workflow-definition.md) |\n<!-- /api-reference-table -->\n\n## OpenAPI Spec\n\nRetrieve the full OpenAPI specification for any API at runtime. The spec is lazy-loaded on first call and cached.\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\n// Via API handle\nconst entitySpec = await epilot.entity.openapi()\nconsole.log(entitySpec.info.title) // \"Entity API\"\nconsole.log(entitySpec.paths) // all paths with full schemas\n\n// Via top-level method\nconst spec = await epilot.openapi('entity')\n```\n\nFor tree-shakeable imports:\n\n```ts\nimport { openapi } from '@epilot/sdk/entity'\n\nconst spec = await openapi()\n```\n\n## Explicit Client Access\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\nepilot.authorize(() => '<my-token>')\n\n// Get the cached singleton client\nconst entityClient = epilot.entity.getClient()\nconst { data } = await entityClient.getEntity({ slug: 'contact', id: '123' })\n\n// Create a fresh (non-singleton) client instance\nconst freshClient = epilot.entity.createClient()\nauthorize(freshClient, () => '<my-token>')\n```\n\n## Tree-Shakeable Imports\n\nImport only what you need. Other APIs never touch your bundle.\n\n```ts\nimport { getClient, authorize } from '@epilot/sdk/entity'\n\nconst entityClient = getClient()\nauthorize(entityClient, () => '<my-token>')\n\nconst { data } = await entityClient.getEntity({ slug: 'contact', id: '123' })\n\n// Or use the handle for direct operation forwarding\nimport { entity } from '@epilot/sdk/entity'\nconst { data } = await entity.getEntity({ slug: 'contact', id: '123' })\n```\n\n## Types\n\nEach API subpath re-exports all schema types generated from the OpenAPI spec. Import them directly:\n\n```ts\nimport type { Entity, EntitySchema, RelationAttribute } from '@epilot/sdk/entity'\nimport type { FileItem } from '@epilot/sdk/file'\nimport type { AutomationFlow } from '@epilot/sdk/automation'\n```\n\nThe `Client`, `OperationMethods`, and `PathsDictionary` types are also available for typing client instances:\n\n```ts\nimport type { Client } from '@epilot/sdk/entity'\n\nconst entityClient: Client = epilot.entity.getClient()\n```\n\n## Headers\n\n### Global Headers\n\nSet default headers applied to all clients. Useful for `x-epilot-org-id`, `x-epilot-user-id`, etc.\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\nepilot.authorize(() => '<my-token>')\nepilot.headers({\n 'x-epilot-org-id': 'org-123',\n 'x-epilot-user-id': 'user-456',\n})\n\nconst { data } = await epilot.entity.searchEntities(...)\n```\n\n### Standard Axios Headers\n\nUse standard axios `defaults.headers.common` on individual clients:\n\n```ts\nconst entityClient = epilot.entity.getClient()\nentityClient.defaults.headers.common['x-epilot-org-id'] = 'org-123'\n```\n\n## Auth Patterns\n\n`authorize()` accepts a string or a function. The function form is preferred \u2014 it is called on every request, so tokens stay fresh.\n\n```ts\nimport { authorize } from '@epilot/sdk'\nimport { getClient } from '@epilot/sdk/entity'\n\n// Per-client \u2014 function predicate (recommended)\nconst entityClient = getClient()\nauthorize(entityClient, () => '<my-token>')\n\n// Per-client \u2014 async function (e.g. OAuth / session)\nauthorize(entityClient, async () => {\n return await getTokenFromSession()\n})\n\n// Per-client \u2014 static string (sets default header once)\nauthorize(entityClient, 'my-static-api-token')\n```\n\n```ts\n// Global \u2014 applies to all clients resolved from the SDK\nimport { epilot } from '@epilot/sdk'\n\nepilot.authorize(() => '<my-token>')\nepilot.authorize(async () => await getTokenFromSession())\nepilot.authorize('my-static-api-token')\n```\n\n## Fresh Client Instance\n\n```ts\nimport { createClient, authorize } from '@epilot/sdk/entity'\n\nconst entityClient = createClient()\nauthorize(entityClient, () => '<my-token>')\nentityClient.defaults.headers.common['x-epilot-org-id'] = 'org-123'\n```\n\n## Multiple SDK Instances\n\n```ts\nimport { createSDK } from '@epilot/sdk'\n\nconst sdk1 = createSDK()\nsdk1.authorize(() => '<token-for-org-1>')\nsdk1.headers({ 'x-epilot-org-id': 'org-1' })\n\nconst sdk2 = createSDK()\nsdk2.authorize(() => '<token-for-org-2>')\nsdk2.headers({ 'x-epilot-org-id': 'org-2' })\n```\n\n\n## Interceptors\n\nUse axios interceptors for custom request/response processing. Since clients are axios instances, you can use `client.interceptors` directly:\n\n```ts\nentityClient.interceptors.response.use((response) => {\n console.debug(`${response.config.method?.toUpperCase()} ${response.config.url}`, {\n status: response.status,\n data: response.data,\n })\n return response\n})\n```\n\nOr register global interceptors applied to all clients:\n\n```ts\nepilot.interceptors.request((config) => {\n config.headers['x-correlation-id'] = generateTraceId()\n return config\n})\n```\n\n## Auto-Retry (429 Too Many Requests)\n\nThe SDK automatically retries requests that receive a `429 Too Many Requests` response. It respects the `Retry-After` header (in seconds) to determine how long to wait before retrying.\n\nEnabled by default with up to 3 retries.\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\n// Customize retry behavior\nepilot.retry({ maxRetries: 5, defaultDelayMs: 2000 })\n\n// Disable retries\nepilot.retry({ maxRetries: 0 })\n```\n\n| Option | Default | Description |\n| --- | --- | --- |\n| `maxRetries` | `3` | Maximum number of retries. Set to `0` to disable. |\n| `defaultDelayMs` | `1000` | Fallback delay in ms when `Retry-After` header is missing. |\n\nFor individually imported clients (tree-shakeable imports), apply the interceptor manually:\n\n```ts\nimport { getClient, authorize } from '@epilot/sdk/entity'\nimport { applyRetryInterceptor } from '@epilot/sdk'\n\nconst entityClient = getClient()\nauthorize(entityClient, () => '<my-token>')\napplyRetryInterceptor({ client: entityClient, config: { maxRetries: 3 } })\n```\n\n## Large Response Handling (413 Payload Too Large)\n\nepilot APIs use a [large response middleware](https://github.com/epilot-dev/aws-lambda-utility-middlewares) to work around the AWS Lambda 6MB response limit. When a response exceeds ~5.1MB, the API uploads the payload to S3 and returns a presigned URL instead.\n\nThe SDK handles this transparently \u2014 it sends the opt-in `Accept` header and automatically fetches the full payload from S3 when a large response URL is returned. Enabled by default.\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\n// Disable large response handling\nepilot.largeResponse({ enabled: false })\n```\n\nFor individually imported clients (tree-shakeable imports), apply the interceptor manually:\n\n```ts\nimport { getClient, authorize } from '@epilot/sdk/entity'\nimport { applyLargeResponseInterceptor } from '@epilot/sdk'\n\nconst entityClient = getClient()\nauthorize(entityClient, () => '<my-token>')\napplyLargeResponseInterceptor({ client: entityClient, config: { enabled: true } })\n```\n\n## Overrides & Custom APIs\n\nOverride built-in API specs or register custom APIs via `.epilot/sdk-overrides.json`. This is useful for testing new versions of an API spec or getting the latest types without waiting for an SDK release.\n\n```json\n{\n \"entity\": \"./specs/entity-openapi.json\",\n \"myNewApi\": \"./specs/my-new-api-openapi.json\"\n}\n```\n\n```ts\n// Built-in API with overridden spec\nconst { data } = await epilot.entity.getEntity({ slug: 'contact', id: '123' })\n```\n\n### Override Commands\n\n```bash\n# Apply all overrides from .epilot/sdk-overrides.json\nnpx epilot-sdk override\n\n# Override a single API\nnpx epilot-sdk override entity ./my-local-entity-spec.yaml\n\n# Regenerate types after spec changes\nnpx epilot-sdk typegen\n```\n\n<details>\n<summary>Migration from <code>@epilot/*-client</code></summary>\n\nDrop-in replacement \u2014 just change the import path:\n\n```ts\n// Before\nimport { getClient, createClient, authorize } from '@epilot/entity-client'\nimport type { Client, Entity } from '@epilot/entity-client'\n\n// After\nimport { getClient, createClient, authorize } from '@epilot/sdk/entity'\nimport type { Client, Entity } from '@epilot/sdk/entity'\n```\n\n</details>\n\n<details>\n<summary>Client Lifecycle</summary>\n\nWhen you call `authorize()`, `headers()`, `retry()`, `largeResponse()`, or `interceptors`, the SDK invalidates all cached client instances. The next operation call creates a fresh client with the updated configuration.\n\n**Operation methods are always up to date** \u2014 calls like `epilot.entity.getEntity(...)` re-resolve the client on every invocation, so they always use the latest config.\n\n**Direct `getClient()` references can go stale** \u2014 if you hold a reference and then change config, your reference still points to the old client:\n\n```ts\nconst entityClient = epilot.entity.getClient()\n\nepilot.authorize('new-token') // invalidates all cached clients\n\n// entityClient still has the old token\n// epilot.entity.getEntity(...) will use a new client with the new token\n```\n\nIf you need a long-lived reference that survives config changes, call `getClient()` again after changing config, or use operation methods directly.\n\n</details>\n";
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = README_default;
|
|
@@ -13,7 +13,7 @@ var blueprintManifest = "blueprint-manifest";
|
|
|
13
13
|
var consent = "consent";
|
|
14
14
|
var customerPortal = "customer-portal";
|
|
15
15
|
var dashboard = "dashboard";
|
|
16
|
-
var
|
|
16
|
+
var dataGovernance = "data-governance";
|
|
17
17
|
var deduplication = "deduplication";
|
|
18
18
|
var design = "design";
|
|
19
19
|
var document = "document";
|
|
@@ -22,10 +22,10 @@ var emailTemplate = "email-template";
|
|
|
22
22
|
var entity = "entity";
|
|
23
23
|
var entityMapping = "entity-mapping";
|
|
24
24
|
var environments = "environments";
|
|
25
|
-
var erpIntegration = "erp-integration";
|
|
26
25
|
var eventCatalog = "event-catalog";
|
|
27
26
|
var file = "file";
|
|
28
27
|
var iban = "iban";
|
|
28
|
+
var integrationToolkit = "integration-toolkit";
|
|
29
29
|
var journey = "journey";
|
|
30
30
|
var kanban = "kanban";
|
|
31
31
|
var message = "message";
|
|
@@ -39,6 +39,7 @@ var pricing = "pricing";
|
|
|
39
39
|
var pricingTier = "pricing-tier";
|
|
40
40
|
var purpose = "purpose";
|
|
41
41
|
var sandbox = "sandbox";
|
|
42
|
+
var sharing = "sharing";
|
|
42
43
|
var submission = "submission";
|
|
43
44
|
var targeting = "targeting";
|
|
44
45
|
var templateVariables = "template-variables";
|
|
@@ -60,7 +61,7 @@ var index_default = {
|
|
|
60
61
|
consent,
|
|
61
62
|
customerPortal,
|
|
62
63
|
dashboard,
|
|
63
|
-
|
|
64
|
+
dataGovernance,
|
|
64
65
|
deduplication,
|
|
65
66
|
design,
|
|
66
67
|
document,
|
|
@@ -69,10 +70,10 @@ var index_default = {
|
|
|
69
70
|
entity,
|
|
70
71
|
entityMapping,
|
|
71
72
|
environments,
|
|
72
|
-
erpIntegration,
|
|
73
73
|
eventCatalog,
|
|
74
74
|
file,
|
|
75
75
|
iban,
|
|
76
|
+
integrationToolkit,
|
|
76
77
|
journey,
|
|
77
78
|
kanban,
|
|
78
79
|
message,
|
|
@@ -86,6 +87,7 @@ var index_default = {
|
|
|
86
87
|
pricingTier,
|
|
87
88
|
purpose,
|
|
88
89
|
sandbox,
|
|
90
|
+
sharing,
|
|
89
91
|
submission,
|
|
90
92
|
targeting,
|
|
91
93
|
templateVariables,
|
|
@@ -108,7 +110,7 @@ export {
|
|
|
108
110
|
consent,
|
|
109
111
|
customerPortal,
|
|
110
112
|
dashboard,
|
|
111
|
-
|
|
113
|
+
dataGovernance,
|
|
112
114
|
deduplication,
|
|
113
115
|
index_default as default,
|
|
114
116
|
design,
|
|
@@ -118,10 +120,10 @@ export {
|
|
|
118
120
|
entity,
|
|
119
121
|
entityMapping,
|
|
120
122
|
environments,
|
|
121
|
-
erpIntegration,
|
|
122
123
|
eventCatalog,
|
|
123
124
|
file,
|
|
124
125
|
iban,
|
|
126
|
+
integrationToolkit,
|
|
125
127
|
journey,
|
|
126
128
|
kanban,
|
|
127
129
|
message,
|
|
@@ -135,6 +137,7 @@ export {
|
|
|
135
137
|
pricingTier,
|
|
136
138
|
purpose,
|
|
137
139
|
sandbox,
|
|
140
|
+
sharing,
|
|
138
141
|
submission,
|
|
139
142
|
targeting,
|
|
140
143
|
templateVariables,
|
|
@@ -13,7 +13,7 @@ var blueprintManifest = "blueprint-manifest";
|
|
|
13
13
|
var consent = "consent";
|
|
14
14
|
var customerPortal = "customer-portal";
|
|
15
15
|
var dashboard = "dashboard";
|
|
16
|
-
var
|
|
16
|
+
var dataGovernance = "data-governance";
|
|
17
17
|
var deduplication = "deduplication";
|
|
18
18
|
var design = "design";
|
|
19
19
|
var document = "document";
|
|
@@ -22,10 +22,10 @@ var emailTemplate = "email-template";
|
|
|
22
22
|
var entity = "entity";
|
|
23
23
|
var entityMapping = "entity-mapping";
|
|
24
24
|
var environments = "environments";
|
|
25
|
-
var erpIntegration = "erp-integration";
|
|
26
25
|
var eventCatalog = "event-catalog";
|
|
27
26
|
var file = "file";
|
|
28
27
|
var iban = "iban";
|
|
28
|
+
var integrationToolkit = "integration-toolkit";
|
|
29
29
|
var journey = "journey";
|
|
30
30
|
var kanban = "kanban";
|
|
31
31
|
var message = "message";
|
|
@@ -39,6 +39,7 @@ var pricing = "pricing";
|
|
|
39
39
|
var pricingTier = "pricing-tier";
|
|
40
40
|
var purpose = "purpose";
|
|
41
41
|
var sandbox = "sandbox";
|
|
42
|
+
var sharing = "sharing";
|
|
42
43
|
var submission = "submission";
|
|
43
44
|
var targeting = "targeting";
|
|
44
45
|
var templateVariables = "template-variables";
|
|
@@ -60,7 +61,7 @@ var index_default = {
|
|
|
60
61
|
consent,
|
|
61
62
|
customerPortal,
|
|
62
63
|
dashboard,
|
|
63
|
-
|
|
64
|
+
dataGovernance,
|
|
64
65
|
deduplication,
|
|
65
66
|
design,
|
|
66
67
|
document,
|
|
@@ -69,10 +70,10 @@ var index_default = {
|
|
|
69
70
|
entity,
|
|
70
71
|
entityMapping,
|
|
71
72
|
environments,
|
|
72
|
-
erpIntegration,
|
|
73
73
|
eventCatalog,
|
|
74
74
|
file,
|
|
75
75
|
iban,
|
|
76
|
+
integrationToolkit,
|
|
76
77
|
journey,
|
|
77
78
|
kanban,
|
|
78
79
|
message,
|
|
@@ -86,6 +87,7 @@ var index_default = {
|
|
|
86
87
|
pricingTier,
|
|
87
88
|
purpose,
|
|
88
89
|
sandbox,
|
|
90
|
+
sharing,
|
|
89
91
|
submission,
|
|
90
92
|
targeting,
|
|
91
93
|
templateVariables,
|
|
@@ -143,4 +145,5 @@ var index_default = {
|
|
|
143
145
|
|
|
144
146
|
|
|
145
147
|
|
|
146
|
-
|
|
148
|
+
|
|
149
|
+
exports.accessToken = accessToken; exports.address = address; exports.addressSuggestions = addressSuggestions; exports.aiAgents = aiAgents; exports.app = app; exports.auditLogs = auditLogs; exports.automation = automation; exports.billing = billing; exports.blueprintManifest = blueprintManifest; exports.consent = consent; exports.customerPortal = customerPortal; exports.dashboard = dashboard; exports.dataGovernance = dataGovernance; exports.deduplication = deduplication; exports.default = index_default; exports.design = design; exports.document = document; exports.emailSettings = emailSettings; exports.emailTemplate = emailTemplate; exports.entity = entity; exports.entityMapping = entityMapping; exports.environments = environments; exports.eventCatalog = eventCatalog; exports.file = file; exports.iban = iban; exports.integrationToolkit = integrationToolkit; exports.journey = journey; exports.kanban = kanban; exports.message = message; exports.metering = metering; exports.notes = notes; exports.notification = notification; exports.organization = organization; exports.partnerDirectory = partnerDirectory; exports.permissions = permissions; exports.pricing = pricing; exports.pricingTier = pricingTier; exports.purpose = purpose; exports.sandbox = sandbox; exports.sharing = sharing; exports.submission = submission; exports.targeting = targeting; exports.templateVariables = templateVariables; exports.user = user; exports.validationRules = validationRules; exports.webhooks = webhooks; exports.workflow = workflow; exports.workflowDefinition = workflowDefinition;
|
|
@@ -6,25 +6,25 @@ var _chunkOXJOO2YFcjs = require('../chunk-OXJOO2YF.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunkTKTSGA7Gcjs = require('../chunk-TKTSGA7G.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/access-token.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkOXJOO2YFcjs.require_access_token_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunkTKTSGA7Gcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunkTKTSGA7Gcjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunkTKTSGA7Gcjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunkTKTSGA7Gcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
|
|
28
28
|
apiName: "accessToken"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var accessToken = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.accessToken = accessToken; exports.authorize =
|
|
38
|
+
exports.accessToken = accessToken; exports.authorize = _chunkTKTSGA7Gcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|
|
@@ -6,25 +6,25 @@ var _chunkLKRBFBFNcjs = require('../chunk-LKRBFBFN.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunkTKTSGA7Gcjs = require('../chunk-TKTSGA7G.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/address-suggestions.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkLKRBFBFNcjs.require_address_suggestions_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunkTKTSGA7Gcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunkTKTSGA7Gcjs.createApiClient.call(void 0, { definition: def, apiName: "addressSuggestions" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunkTKTSGA7Gcjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunkTKTSGA7Gcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "addressSuggestions" }),
|
|
28
28
|
apiName: "addressSuggestions"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var addressSuggestions = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.addressSuggestions = addressSuggestions; exports.authorize =
|
|
38
|
+
exports.addressSuggestions = addressSuggestions; exports.authorize = _chunkTKTSGA7Gcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|