@epilot/sdk 2.4.3 → 2.4.4-alpha.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/README.md +1 -0
- package/definitions/app-runtime.json +1 -1
- package/definitions/app.json +346 -10
- package/definitions/calendar-runtime.json +1 -0
- package/definitions/calendar.json +675 -0
- package/definitions/customer-portal.json +29 -0
- package/definitions/notes.json +175 -130
- package/definitions/pricing.json +5 -1
- package/dist/README-46VYEGGW.js +7 -0
- package/dist/README-IVBISSWB.cjs +7 -0
- package/dist/{_index-HE4B6FOA.js → _index-5FB6F5YY.js} +3 -0
- package/dist/{_index-55HAH24D.cjs → _index-DB2VV4PQ.cjs} +4 -1
- package/dist/apis/_registry.d.ts +8 -0
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.d.ts +9 -12
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.d.ts +9 -12
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.d.ts +9 -12
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.d.ts +9 -12
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.d.ts +9 -12
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.d.ts +9 -12
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.d.ts +9 -12
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.d.ts +9 -12
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.d.ts +9 -12
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +38 -0
- package/dist/apis/calendar.d.ts +15 -0
- package/dist/apis/calendar.js +38 -0
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.d.ts +9 -12
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.d.ts +9 -12
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.d.ts +9 -12
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.d.ts +9 -12
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.d.ts +9 -12
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.d.ts +9 -12
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.d.ts +9 -12
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.d.ts +9 -12
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.d.ts +9 -12
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.d.ts +9 -12
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.d.ts +9 -12
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.d.ts +9 -12
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.d.ts +9 -12
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.d.ts +9 -12
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.d.ts +9 -12
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.d.ts +9 -12
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.d.ts +9 -12
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.ts +9 -12
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.d.ts +9 -12
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.d.ts +9 -12
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.d.ts +9 -12
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.d.ts +9 -12
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.d.ts +9 -12
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.d.ts +9 -12
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.d.ts +9 -12
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.d.ts +9 -12
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.d.ts +9 -12
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.d.ts +9 -12
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.d.ts +9 -12
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.d.ts +9 -12
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.d.ts +9 -12
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.d.ts +9 -12
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.d.ts +9 -12
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.d.ts +9 -591
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.d.ts +9 -12
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.d.ts +9 -12
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.d.ts +9 -12
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.d.ts +9 -12
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.d.ts +9 -12
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.d.ts +9 -12
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.d.ts +9 -12
- package/dist/apis/workflow.js +1 -1
- package/dist/authorize.d.ts +3 -0
- package/dist/bin/cli.d.ts +1 -0
- package/dist/bin/cli.js +1 -1
- package/dist/calendar-2YDAYG7S.cjs +7 -0
- package/dist/calendar-ACFIHQ2N.js +7 -0
- package/dist/calendar-runtime-6CMMEQMG.js +5 -0
- package/dist/calendar-runtime-G4SN5PDY.cjs +5 -0
- package/dist/{chunk-AM5TSEMU.cjs → chunk-CD4OX2U6.cjs} +4 -2
- package/dist/chunk-CKLEBO4K.cjs +14 -0
- package/dist/chunk-JNH37UUH.js +14 -0
- package/dist/{chunk-M25MI6ZX.js → chunk-TSV242UN.js} +4 -2
- package/dist/client-factory.d.ts +9 -0
- package/dist/client-map.d.ts +102 -0
- package/dist/compact.d.ts +22 -0
- package/dist/help.d.ts +12 -0
- package/dist/index.cjs +25 -17
- package/dist/index.d.ts +12 -180
- package/dist/index.js +21 -13
- package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
- package/dist/large-response.d.ts +9 -0
- package/dist/openapi.d.ts +12 -0
- package/dist/overrides.d.ts +9 -0
- package/dist/proxy.d.ts +14 -0
- package/dist/registry.d.ts +19 -0
- package/dist/retry.d.ts +11 -0
- package/dist/sdk.d.ts +29 -0
- package/dist/types.d.ts +53 -0
- package/docs/calendar.md +441 -0
- package/package.json +10 -1
- package/dist/README-6MG272KM.cjs +0 -7
- package/dist/README-7N542PBL.js +0 -7
- package/dist/access-token.d-CnmUTOlq.d.cts +0 -552
- package/dist/access-token.d-CnmUTOlq.d.ts +0 -552
- package/dist/address-suggestions.d-_YwTOR-9.d.cts +0 -339
- package/dist/address-suggestions.d-_YwTOR-9.d.ts +0 -339
- package/dist/address.d-CwAPOVxa.d.cts +0 -437
- package/dist/address.d-CwAPOVxa.d.ts +0 -437
- package/dist/ai-agents.d-OkXfr2bz.d.cts +0 -1339
- package/dist/ai-agents.d-OkXfr2bz.d.ts +0 -1339
- package/dist/apis/access-token.d.cts +0 -18
- package/dist/apis/address-suggestions.d.cts +0 -18
- package/dist/apis/address.d.cts +0 -18
- package/dist/apis/ai-agents.d.cts +0 -18
- package/dist/apis/app.d.cts +0 -18
- package/dist/apis/audit-logs.d.cts +0 -18
- package/dist/apis/automation.d.cts +0 -18
- package/dist/apis/billing.d.cts +0 -18
- package/dist/apis/blueprint-manifest.d.cts +0 -18
- package/dist/apis/configuration-hub.d.cts +0 -18
- package/dist/apis/consent.d.cts +0 -18
- package/dist/apis/customer-portal.d.cts +0 -18
- package/dist/apis/dashboard.d.cts +0 -18
- package/dist/apis/data-governance.d.cts +0 -18
- package/dist/apis/deduplication.d.cts +0 -18
- package/dist/apis/design.d.cts +0 -18
- package/dist/apis/document.d.cts +0 -18
- package/dist/apis/email-settings.d.cts +0 -18
- package/dist/apis/email-template.d.cts +0 -18
- package/dist/apis/entity-mapping.d.cts +0 -18
- package/dist/apis/entity.d.cts +0 -18
- package/dist/apis/environments.d.cts +0 -18
- package/dist/apis/event-catalog.d.cts +0 -18
- package/dist/apis/file.d.cts +0 -18
- package/dist/apis/iban.d.cts +0 -18
- package/dist/apis/integration-toolkit.d.cts +0 -18
- package/dist/apis/journey.d.cts +0 -18
- package/dist/apis/kanban.d.cts +0 -18
- package/dist/apis/message.d.cts +0 -18
- package/dist/apis/metering.d.cts +0 -18
- package/dist/apis/notes.d.cts +0 -18
- package/dist/apis/notification.d.cts +0 -18
- package/dist/apis/organization.d.cts +0 -18
- package/dist/apis/partner-directory.d.cts +0 -18
- package/dist/apis/permissions.d.cts +0 -18
- package/dist/apis/pricing-tier.d.cts +0 -18
- package/dist/apis/pricing.d.cts +0 -18
- package/dist/apis/purpose.d.cts +0 -18
- package/dist/apis/query.d.cts +0 -18
- package/dist/apis/sandbox.d.cts +0 -18
- package/dist/apis/sharing.d.cts +0 -18
- package/dist/apis/submission.d.cts +0 -18
- package/dist/apis/target.d.cts +0 -597
- package/dist/apis/targeting.d.cts +0 -18
- package/dist/apis/template-variables.d.cts +0 -18
- package/dist/apis/user.d.cts +0 -18
- package/dist/apis/validation-rules.d.cts +0 -18
- package/dist/apis/webhooks.d.cts +0 -18
- package/dist/apis/workflow-definition.d.cts +0 -18
- package/dist/apis/workflow.d.cts +0 -18
- package/dist/app.d-u7Dq42kU.d.cts +0 -3391
- package/dist/app.d-u7Dq42kU.d.ts +0 -3391
- package/dist/audit-logs.d-BRToFqeX.d.cts +0 -287
- package/dist/audit-logs.d-BRToFqeX.d.ts +0 -287
- package/dist/automation.d-Du6-uiz5.d.cts +0 -5283
- package/dist/automation.d-Du6-uiz5.d.ts +0 -5283
- package/dist/billing.d-Bs8Ku9qE.d.cts +0 -993
- package/dist/billing.d-Bs8Ku9qE.d.ts +0 -993
- package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +0 -4343
- package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +0 -4343
- package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
- package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
- package/dist/consent.d-C2PROHhX.d.cts +0 -265
- package/dist/consent.d-C2PROHhX.d.ts +0 -265
- package/dist/customer-portal.d-DyZ2n2dW.d.cts +0 -16728
- package/dist/customer-portal.d-DyZ2n2dW.d.ts +0 -16728
- package/dist/dashboard.d-CsGcA74I.d.cts +0 -440
- package/dist/dashboard.d-CsGcA74I.d.ts +0 -440
- package/dist/data-governance.d-BbZ466j5.d.cts +0 -1178
- package/dist/data-governance.d-BbZ466j5.d.ts +0 -1178
- package/dist/deduplication.d-D5GYddVu.d.cts +0 -218
- package/dist/deduplication.d-D5GYddVu.d.ts +0 -218
- package/dist/design.d-BRre8iLg.d.cts +0 -2346
- package/dist/design.d-BRre8iLg.d.ts +0 -2346
- package/dist/document.d-DN37pjdx.d.cts +0 -648
- package/dist/document.d-DN37pjdx.d.ts +0 -648
- package/dist/email-settings.d-B7Q_xT25.d.cts +0 -2417
- package/dist/email-settings.d-B7Q_xT25.d.ts +0 -2417
- package/dist/email-template.d-gtQkdaXM.d.cts +0 -1188
- package/dist/email-template.d-gtQkdaXM.d.ts +0 -1188
- package/dist/entity-mapping.d-DKSW3sfy.d.cts +0 -1092
- package/dist/entity-mapping.d-DKSW3sfy.d.ts +0 -1092
- package/dist/entity.d-BHR9dEon.d.cts +0 -18479
- package/dist/entity.d-BHR9dEon.d.ts +0 -18479
- package/dist/environments.d-BvqvN-PD.d.cts +0 -382
- package/dist/environments.d-BvqvN-PD.d.ts +0 -382
- package/dist/event-catalog.d-ENw6HO-w.d.cts +0 -1511
- package/dist/event-catalog.d-ENw6HO-w.d.ts +0 -1511
- package/dist/file.d-DcTJxjp7.d.cts +0 -2992
- package/dist/file.d-DcTJxjp7.d.ts +0 -2992
- package/dist/iban.d-BwdiGbxi.d.cts +0 -70
- package/dist/iban.d-BwdiGbxi.d.ts +0 -70
- package/dist/index.d.cts +0 -180
- package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +0 -5796
- package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +0 -5796
- package/dist/journey.d-ClXO0xK8.d.cts +0 -1931
- package/dist/journey.d-ClXO0xK8.d.ts +0 -1931
- package/dist/kanban.d-BHnSRCYW.d.cts +0 -760
- package/dist/kanban.d-BHnSRCYW.d.ts +0 -760
- package/dist/message.d-B5UuSqgw.d.cts +0 -3811
- package/dist/message.d-B5UuSqgw.d.ts +0 -3811
- package/dist/metering.d-DvtPv7wk.d.cts +0 -1841
- package/dist/metering.d-DvtPv7wk.d.ts +0 -1841
- package/dist/notes.d-BC-scR42.d.cts +0 -1046
- package/dist/notes.d-BC-scR42.d.ts +0 -1046
- package/dist/notification.d-BfBL3lga.d.cts +0 -1147
- package/dist/notification.d-BfBL3lga.d.ts +0 -1147
- package/dist/organization.d-DqwnNxMg.d.cts +0 -1271
- package/dist/organization.d-DqwnNxMg.d.ts +0 -1271
- package/dist/partner-directory.d-BCIjHoGs.d.cts +0 -2337
- package/dist/partner-directory.d-BCIjHoGs.d.ts +0 -2337
- package/dist/permissions.d-l6AT8SYP.d.cts +0 -1279
- package/dist/permissions.d-l6AT8SYP.d.ts +0 -1279
- package/dist/pricing-tier.d-Cg0jl6n_.d.cts +0 -81
- package/dist/pricing-tier.d-Cg0jl6n_.d.ts +0 -81
- package/dist/pricing.d-BHpMU4KU.d.cts +0 -12255
- package/dist/pricing.d-BHpMU4KU.d.ts +0 -12255
- package/dist/purpose.d-CbIYfTua.d.cts +0 -372
- package/dist/purpose.d-CbIYfTua.d.ts +0 -372
- package/dist/query.d-Cmp78IhZ.d.cts +0 -2375
- package/dist/query.d-Cmp78IhZ.d.ts +0 -2375
- package/dist/sandbox.d-BdbOFzDu.d.cts +0 -465
- package/dist/sandbox.d-BdbOFzDu.d.ts +0 -465
- package/dist/sharing.d-sOXq-gtz.d.cts +0 -571
- package/dist/sharing.d-sOXq-gtz.d.ts +0 -571
- package/dist/submission.d-BamwfhXw.d.cts +0 -469
- package/dist/submission.d-BamwfhXw.d.ts +0 -469
- package/dist/targeting.d-BNmcVsNS.d.cts +0 -2057
- package/dist/targeting.d-BNmcVsNS.d.ts +0 -2057
- package/dist/template-variables.d-Ble9TSBa.d.cts +0 -1320
- package/dist/template-variables.d-Ble9TSBa.d.ts +0 -1320
- package/dist/types-ChU9Acbv.d.cts +0 -37
- package/dist/types-ChU9Acbv.d.ts +0 -37
- package/dist/user.d-D18fe97W.d.cts +0 -2270
- package/dist/user.d-D18fe97W.d.ts +0 -2270
- package/dist/validation-rules.d-Db5c5zTf.d.cts +0 -807
- package/dist/validation-rules.d-Db5c5zTf.d.ts +0 -807
- package/dist/webhooks.d-pLHIL_io.d.cts +0 -1256
- package/dist/webhooks.d-pLHIL_io.d.ts +0 -1256
- package/dist/workflow-definition.d-DOeb0KVV.d.cts +0 -1922
- package/dist/workflow-definition.d-DOeb0KVV.d.ts +0 -1922
- package/dist/workflow.d-CMSKt8oN.d.cts +0 -3151
- package/dist/workflow.d-CMSKt8oN.d.ts +0 -3151
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/sdk",
|
|
3
|
-
"version": "2.4.
|
|
3
|
+
"version": "2.4.4-alpha.0",
|
|
4
4
|
"description": "JavaScript/TypeScript SDK for epilot APIs",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -69,6 +69,12 @@
|
|
|
69
69
|
"require": "./dist/apis/blueprint-manifest.cjs"
|
|
70
70
|
},
|
|
71
71
|
"./blueprint-manifest/openapi.json": "./definitions/blueprint-manifest.json",
|
|
72
|
+
"./calendar": {
|
|
73
|
+
"types": "./dist/apis/calendar.d.ts",
|
|
74
|
+
"import": "./dist/apis/calendar.js",
|
|
75
|
+
"require": "./dist/apis/calendar.cjs"
|
|
76
|
+
},
|
|
77
|
+
"./calendar/openapi.json": "./definitions/calendar.json",
|
|
72
78
|
"./configuration-hub": {
|
|
73
79
|
"types": "./dist/apis/configuration-hub.d.ts",
|
|
74
80
|
"import": "./dist/apis/configuration-hub.js",
|
|
@@ -386,6 +392,9 @@
|
|
|
386
392
|
"blueprint-manifest": [
|
|
387
393
|
"./dist/apis/blueprint-manifest.d.ts"
|
|
388
394
|
],
|
|
395
|
+
"calendar": [
|
|
396
|
+
"./dist/apis/calendar.d.ts"
|
|
397
|
+
],
|
|
389
398
|
"configuration-hub": [
|
|
390
399
|
"./dist/apis/configuration-hub.d.ts"
|
|
391
400
|
],
|
package/dist/README-6MG272KM.cjs
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
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.configurationHub` | `@epilot/sdk/configuration-hub` | [docs](./docs/configuration-hub.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.query` | `@epilot/sdk/query` | [docs](./docs/query.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;
|
package/dist/README-7N542PBL.js
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
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.configurationHub` | `@epilot/sdk/configuration-hub` | [docs](./docs/configuration-hub.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.query` | `@epilot/sdk/query` | [docs](./docs/query.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
|
-
};
|
|
@@ -1,552 +0,0 @@
|
|
|
1
|
-
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
|
|
2
|
-
|
|
3
|
-
/* Auto-copied from access-token-client */
|
|
4
|
-
/* eslint-disable */
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
declare namespace Components {
|
|
9
|
-
namespace Schemas {
|
|
10
|
-
/**
|
|
11
|
-
* A JWT Access Token
|
|
12
|
-
* example:
|
|
13
|
-
* eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...
|
|
14
|
-
*/
|
|
15
|
-
export type AccessToken = string;
|
|
16
|
-
/**
|
|
17
|
-
* example:
|
|
18
|
-
* api_5ZugdRXasLfWBypHi93Fk
|
|
19
|
-
*/
|
|
20
|
-
export type AccessTokenId = string;
|
|
21
|
-
export interface AccessTokenItem {
|
|
22
|
-
id: /**
|
|
23
|
-
* example:
|
|
24
|
-
* api_5ZugdRXasLfWBypHi93Fk
|
|
25
|
-
*/
|
|
26
|
-
AccessTokenId;
|
|
27
|
-
created_at: string; // date-time
|
|
28
|
-
name: /**
|
|
29
|
-
* Human readable name for access token
|
|
30
|
-
* example:
|
|
31
|
-
* Postman Access Token
|
|
32
|
-
*/
|
|
33
|
-
AccessTokenName;
|
|
34
|
-
token_type?: /**
|
|
35
|
-
* Access token type
|
|
36
|
-
* example:
|
|
37
|
-
* api
|
|
38
|
-
*/
|
|
39
|
-
AccessTokenType;
|
|
40
|
-
journey_id?: /* Journey ID for access token type "journey" */ AccessTokenJourneyId;
|
|
41
|
-
portal_id?: /* Portal ID for access token type "portal" */ PortalId;
|
|
42
|
-
assignments?: /* List of role ids attached to an user */ Assignments;
|
|
43
|
-
/**
|
|
44
|
-
* Last date the token was used (YYYY-MM-DD format, 1 day accuracy)
|
|
45
|
-
* example:
|
|
46
|
-
* 2026-02-24
|
|
47
|
-
*/
|
|
48
|
-
last_used?: string; // date
|
|
49
|
-
}
|
|
50
|
-
/**
|
|
51
|
-
* Journey ID for access token type "journey"
|
|
52
|
-
*/
|
|
53
|
-
export type AccessTokenJourneyId = string;
|
|
54
|
-
/**
|
|
55
|
-
* Human readable name for access token
|
|
56
|
-
* example:
|
|
57
|
-
* Postman Access Token
|
|
58
|
-
*/
|
|
59
|
-
export type AccessTokenName = string;
|
|
60
|
-
export interface AccessTokenParameters {
|
|
61
|
-
name: /**
|
|
62
|
-
* Human readable name for access token
|
|
63
|
-
* example:
|
|
64
|
-
* Postman Access Token
|
|
65
|
-
*/
|
|
66
|
-
AccessTokenName;
|
|
67
|
-
token_type?: "api";
|
|
68
|
-
assignments?: /* List of role ids attached to an user */ Assignments;
|
|
69
|
-
expires_in?: ExpiresIn;
|
|
70
|
-
}
|
|
71
|
-
/**
|
|
72
|
-
* Access token type
|
|
73
|
-
* example:
|
|
74
|
-
* api
|
|
75
|
-
*/
|
|
76
|
-
export type AccessTokenType = "api" | "journey" | "portal" | "assume" | "app";
|
|
77
|
-
export interface AppTokenParameters {
|
|
78
|
-
name: /**
|
|
79
|
-
* Human readable name for access token
|
|
80
|
-
* example:
|
|
81
|
-
* Postman Access Token
|
|
82
|
-
*/
|
|
83
|
-
AccessTokenName;
|
|
84
|
-
token_type?: "app";
|
|
85
|
-
assignments?: /* List of role ids attached to an user */ Assignments;
|
|
86
|
-
expires_in?: ExpiresIn;
|
|
87
|
-
}
|
|
88
|
-
/**
|
|
89
|
-
* List of role ids attached to an user
|
|
90
|
-
*/
|
|
91
|
-
export type Assignments = /**
|
|
92
|
-
* Format: <organization_id>:<slug>
|
|
93
|
-
* example:
|
|
94
|
-
* 123:owner
|
|
95
|
-
*/
|
|
96
|
-
RoleId[];
|
|
97
|
-
export interface AssumeTokenParameters {
|
|
98
|
-
name: /**
|
|
99
|
-
* Human readable name for access token
|
|
100
|
-
* example:
|
|
101
|
-
* Postman Access Token
|
|
102
|
-
*/
|
|
103
|
-
AccessTokenName;
|
|
104
|
-
token_type?: "assume";
|
|
105
|
-
assignments?: /* List of role ids attached to an user */ Assignments;
|
|
106
|
-
}
|
|
107
|
-
export type ExpiresIn = number /* int32 */ | string /* ^[0-9]+ ?(ms|milliseconds?|s|seconds?|m|minutes?|h|hours?|d|days?|w|weeks?|y|years?)?$ */;
|
|
108
|
-
export interface JourneyTokenParameters {
|
|
109
|
-
name: /**
|
|
110
|
-
* Human readable name for access token
|
|
111
|
-
* example:
|
|
112
|
-
* Postman Access Token
|
|
113
|
-
*/
|
|
114
|
-
AccessTokenName;
|
|
115
|
-
token_type?: "journey";
|
|
116
|
-
journey_id: /* Journey ID for access token type "journey" */ AccessTokenJourneyId;
|
|
117
|
-
expires_in?: ExpiresIn;
|
|
118
|
-
}
|
|
119
|
-
/**
|
|
120
|
-
* Portal ID for access token type "portal"
|
|
121
|
-
*/
|
|
122
|
-
export type PortalId = string;
|
|
123
|
-
export interface PortalTokenParameters {
|
|
124
|
-
name: /**
|
|
125
|
-
* Human readable name for access token
|
|
126
|
-
* example:
|
|
127
|
-
* Postman Access Token
|
|
128
|
-
*/
|
|
129
|
-
AccessTokenName;
|
|
130
|
-
token_type?: "portal";
|
|
131
|
-
portal_id: /* Portal ID for access token type "portal" */ PortalId;
|
|
132
|
-
expires_in?: ExpiresIn;
|
|
133
|
-
}
|
|
134
|
-
/**
|
|
135
|
-
* Format: <organization_id>:<slug>
|
|
136
|
-
* example:
|
|
137
|
-
* 123:owner
|
|
138
|
-
*/
|
|
139
|
-
export type RoleId = string;
|
|
140
|
-
export type TokenParameters = AccessTokenParameters | JourneyTokenParameters | PortalTokenParameters | AssumeTokenParameters | AppTokenParameters;
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
declare namespace Paths {
|
|
144
|
-
namespace CreateAccessToken {
|
|
145
|
-
export type RequestBody = Components.Schemas.TokenParameters;
|
|
146
|
-
namespace Responses {
|
|
147
|
-
export interface $201 {
|
|
148
|
-
token?: /**
|
|
149
|
-
* A JWT Access Token
|
|
150
|
-
* example:
|
|
151
|
-
* eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...
|
|
152
|
-
*/
|
|
153
|
-
Components.Schemas.AccessToken;
|
|
154
|
-
id: /**
|
|
155
|
-
* example:
|
|
156
|
-
* api_5ZugdRXasLfWBypHi93Fk
|
|
157
|
-
*/
|
|
158
|
-
Components.Schemas.AccessTokenId;
|
|
159
|
-
created_at: string; // date-time
|
|
160
|
-
name: /**
|
|
161
|
-
* Human readable name for access token
|
|
162
|
-
* example:
|
|
163
|
-
* Postman Access Token
|
|
164
|
-
*/
|
|
165
|
-
Components.Schemas.AccessTokenName;
|
|
166
|
-
token_type?: /**
|
|
167
|
-
* Access token type
|
|
168
|
-
* example:
|
|
169
|
-
* api
|
|
170
|
-
*/
|
|
171
|
-
Components.Schemas.AccessTokenType;
|
|
172
|
-
journey_id?: /* Journey ID for access token type "journey" */ Components.Schemas.AccessTokenJourneyId;
|
|
173
|
-
portal_id?: /* Portal ID for access token type "portal" */ Components.Schemas.PortalId;
|
|
174
|
-
assignments?: /* List of role ids attached to an user */ Components.Schemas.Assignments;
|
|
175
|
-
/**
|
|
176
|
-
* Last date the token was used (YYYY-MM-DD format, 1 day accuracy)
|
|
177
|
-
* example:
|
|
178
|
-
* 2026-02-24
|
|
179
|
-
*/
|
|
180
|
-
last_used?: string; // date
|
|
181
|
-
}
|
|
182
|
-
export interface $400 {
|
|
183
|
-
status?: number;
|
|
184
|
-
error?: string;
|
|
185
|
-
}
|
|
186
|
-
export interface $500 {
|
|
187
|
-
status?: number;
|
|
188
|
-
error?: string;
|
|
189
|
-
}
|
|
190
|
-
}
|
|
191
|
-
}
|
|
192
|
-
namespace GetAccessTokenJwks {
|
|
193
|
-
namespace Responses {
|
|
194
|
-
export interface $200 {
|
|
195
|
-
keys?: {
|
|
196
|
-
/**
|
|
197
|
-
* example:
|
|
198
|
-
* RS256
|
|
199
|
-
*/
|
|
200
|
-
alg?: string;
|
|
201
|
-
/**
|
|
202
|
-
* example:
|
|
203
|
-
* AQAB
|
|
204
|
-
*/
|
|
205
|
-
e?: string;
|
|
206
|
-
/**
|
|
207
|
-
* example:
|
|
208
|
-
* tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=
|
|
209
|
-
*/
|
|
210
|
-
kid?: string;
|
|
211
|
-
/**
|
|
212
|
-
* example:
|
|
213
|
-
* RSA
|
|
214
|
-
*/
|
|
215
|
-
kty?: string;
|
|
216
|
-
/**
|
|
217
|
-
* example:
|
|
218
|
-
* h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ
|
|
219
|
-
*/
|
|
220
|
-
n?: string;
|
|
221
|
-
/**
|
|
222
|
-
* example:
|
|
223
|
-
* sig
|
|
224
|
-
*/
|
|
225
|
-
use?: string;
|
|
226
|
-
}[];
|
|
227
|
-
}
|
|
228
|
-
}
|
|
229
|
-
}
|
|
230
|
-
namespace GetAccessTokenOIDC {
|
|
231
|
-
namespace Responses {
|
|
232
|
-
export interface $200 {
|
|
233
|
-
/**
|
|
234
|
-
* example:
|
|
235
|
-
* https://access-token.sls.epilot.io/v1/access-tokens
|
|
236
|
-
*/
|
|
237
|
-
issuer?: string; // uri
|
|
238
|
-
/**
|
|
239
|
-
* example:
|
|
240
|
-
* https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json
|
|
241
|
-
*/
|
|
242
|
-
jwks_uri?: string; // uri
|
|
243
|
-
}
|
|
244
|
-
}
|
|
245
|
-
}
|
|
246
|
-
namespace GetPublicTokenJwks {
|
|
247
|
-
namespace Responses {
|
|
248
|
-
export interface $200 {
|
|
249
|
-
keys?: {
|
|
250
|
-
/**
|
|
251
|
-
* example:
|
|
252
|
-
* RS256
|
|
253
|
-
*/
|
|
254
|
-
alg?: string;
|
|
255
|
-
/**
|
|
256
|
-
* example:
|
|
257
|
-
* AQAB
|
|
258
|
-
*/
|
|
259
|
-
e?: string;
|
|
260
|
-
/**
|
|
261
|
-
* example:
|
|
262
|
-
* tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=
|
|
263
|
-
*/
|
|
264
|
-
kid?: string;
|
|
265
|
-
/**
|
|
266
|
-
* example:
|
|
267
|
-
* RSA
|
|
268
|
-
*/
|
|
269
|
-
kty?: string;
|
|
270
|
-
/**
|
|
271
|
-
* example:
|
|
272
|
-
* h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ
|
|
273
|
-
*/
|
|
274
|
-
n?: string;
|
|
275
|
-
/**
|
|
276
|
-
* example:
|
|
277
|
-
* sig
|
|
278
|
-
*/
|
|
279
|
-
use?: string;
|
|
280
|
-
}[];
|
|
281
|
-
}
|
|
282
|
-
}
|
|
283
|
-
}
|
|
284
|
-
namespace GetPublicTokenOIDC {
|
|
285
|
-
namespace Responses {
|
|
286
|
-
export interface $200 {
|
|
287
|
-
/**
|
|
288
|
-
* example:
|
|
289
|
-
* https://access-token.sls.epilot.io/v1/access-tokens
|
|
290
|
-
*/
|
|
291
|
-
issuer?: string; // uri
|
|
292
|
-
/**
|
|
293
|
-
* example:
|
|
294
|
-
* https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json
|
|
295
|
-
*/
|
|
296
|
-
jwks_uri?: string; // uri
|
|
297
|
-
}
|
|
298
|
-
}
|
|
299
|
-
}
|
|
300
|
-
namespace ListAccessTokens {
|
|
301
|
-
namespace Parameters {
|
|
302
|
-
export type TokenType = /**
|
|
303
|
-
* Access token type
|
|
304
|
-
* example:
|
|
305
|
-
* api
|
|
306
|
-
*/
|
|
307
|
-
Components.Schemas.AccessTokenType[];
|
|
308
|
-
}
|
|
309
|
-
export interface QueryParameters {
|
|
310
|
-
token_type?: Parameters.TokenType;
|
|
311
|
-
}
|
|
312
|
-
namespace Responses {
|
|
313
|
-
export type $200 = Components.Schemas.AccessTokenItem[];
|
|
314
|
-
}
|
|
315
|
-
}
|
|
316
|
-
namespace RevokeAccessToken {
|
|
317
|
-
namespace Parameters {
|
|
318
|
-
export type Id = /**
|
|
319
|
-
* example:
|
|
320
|
-
* api_5ZugdRXasLfWBypHi93Fk
|
|
321
|
-
*/
|
|
322
|
-
Components.Schemas.AccessTokenId;
|
|
323
|
-
}
|
|
324
|
-
export interface PathParameters {
|
|
325
|
-
id: Parameters.Id;
|
|
326
|
-
}
|
|
327
|
-
namespace Responses {
|
|
328
|
-
export type $200 = Components.Schemas.AccessTokenItem;
|
|
329
|
-
}
|
|
330
|
-
}
|
|
331
|
-
}
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
interface OperationMethods {
|
|
335
|
-
/**
|
|
336
|
-
* listAccessTokens - listAccessTokens
|
|
337
|
-
*
|
|
338
|
-
* Lists all Access Tokens for current user (by default excludes system generated tokens)
|
|
339
|
-
*/
|
|
340
|
-
'listAccessTokens'(
|
|
341
|
-
parameters?: Parameters<Paths.ListAccessTokens.QueryParameters> | null,
|
|
342
|
-
data?: any,
|
|
343
|
-
config?: AxiosRequestConfig
|
|
344
|
-
): OperationResponse<Paths.ListAccessTokens.Responses.$200>
|
|
345
|
-
/**
|
|
346
|
-
* createAccessToken - createAccessToken
|
|
347
|
-
*
|
|
348
|
-
* **Access Token type: `API`** (default if not specified):
|
|
349
|
-
*
|
|
350
|
-
* Generates a new Access Token to use for calling epilot APIs.
|
|
351
|
-
*
|
|
352
|
-
* Takes optionally a list of Roles assigned to the Access Token. Defaults to current user's assignments
|
|
353
|
-
*
|
|
354
|
-
* See [Permissions API docs](https://docs.epilot.io/api/permissions)
|
|
355
|
-
*
|
|
356
|
-
* **Access Token type: `JOURNEY`**:
|
|
357
|
-
*
|
|
358
|
-
* Generates a Public Access Token related to a journey.
|
|
359
|
-
* The journey id should be specfied.
|
|
360
|
-
*
|
|
361
|
-
*/
|
|
362
|
-
'createAccessToken'(
|
|
363
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
364
|
-
data?: Paths.CreateAccessToken.RequestBody,
|
|
365
|
-
config?: AxiosRequestConfig
|
|
366
|
-
): OperationResponse<Paths.CreateAccessToken.Responses.$201>
|
|
367
|
-
/**
|
|
368
|
-
* revokeAccessToken - revokeAccessToken
|
|
369
|
-
*
|
|
370
|
-
* Revokes an Access Token so it can't be used anymore.
|
|
371
|
-
*/
|
|
372
|
-
'revokeAccessToken'(
|
|
373
|
-
parameters?: Parameters<Paths.RevokeAccessToken.PathParameters> | null,
|
|
374
|
-
data?: any,
|
|
375
|
-
config?: AxiosRequestConfig
|
|
376
|
-
): OperationResponse<Paths.RevokeAccessToken.Responses.$200>
|
|
377
|
-
/**
|
|
378
|
-
* getAccessTokenJwks - getAccessTokenJwks
|
|
379
|
-
*
|
|
380
|
-
* Get jwks public key set to verify access tokens generated by this API
|
|
381
|
-
*/
|
|
382
|
-
'getAccessTokenJwks'(
|
|
383
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
384
|
-
data?: any,
|
|
385
|
-
config?: AxiosRequestConfig
|
|
386
|
-
): OperationResponse<Paths.GetAccessTokenJwks.Responses.$200>
|
|
387
|
-
/**
|
|
388
|
-
* getAccessTokenOIDC - getAccessTokenOIDC
|
|
389
|
-
*
|
|
390
|
-
* OpenID Connect configuration for Access Token API as identity provider
|
|
391
|
-
*
|
|
392
|
-
* Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to
|
|
393
|
-
* automate the process of verifying JWT tokens.
|
|
394
|
-
*
|
|
395
|
-
*/
|
|
396
|
-
'getAccessTokenOIDC'(
|
|
397
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
398
|
-
data?: any,
|
|
399
|
-
config?: AxiosRequestConfig
|
|
400
|
-
): OperationResponse<Paths.GetAccessTokenOIDC.Responses.$200>
|
|
401
|
-
/**
|
|
402
|
-
* getPublicTokenJwks - getPublicTokenJwks
|
|
403
|
-
*
|
|
404
|
-
* Get jwks public key set to verify public tokens generated by this API
|
|
405
|
-
*/
|
|
406
|
-
'getPublicTokenJwks'(
|
|
407
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
408
|
-
data?: any,
|
|
409
|
-
config?: AxiosRequestConfig
|
|
410
|
-
): OperationResponse<Paths.GetPublicTokenJwks.Responses.$200>
|
|
411
|
-
/**
|
|
412
|
-
* getPublicTokenOIDC - getPublicTokenOIDC
|
|
413
|
-
*
|
|
414
|
-
* OpenID Connect configuration for Access Token API a a public identity provider
|
|
415
|
-
*
|
|
416
|
-
* Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to
|
|
417
|
-
* automate the process of verifying JWT tokens.
|
|
418
|
-
*
|
|
419
|
-
*/
|
|
420
|
-
'getPublicTokenOIDC'(
|
|
421
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
422
|
-
data?: any,
|
|
423
|
-
config?: AxiosRequestConfig
|
|
424
|
-
): OperationResponse<Paths.GetPublicTokenOIDC.Responses.$200>
|
|
425
|
-
}
|
|
426
|
-
|
|
427
|
-
interface PathsDictionary {
|
|
428
|
-
['/v1/access-tokens']: {
|
|
429
|
-
/**
|
|
430
|
-
* createAccessToken - createAccessToken
|
|
431
|
-
*
|
|
432
|
-
* **Access Token type: `API`** (default if not specified):
|
|
433
|
-
*
|
|
434
|
-
* Generates a new Access Token to use for calling epilot APIs.
|
|
435
|
-
*
|
|
436
|
-
* Takes optionally a list of Roles assigned to the Access Token. Defaults to current user's assignments
|
|
437
|
-
*
|
|
438
|
-
* See [Permissions API docs](https://docs.epilot.io/api/permissions)
|
|
439
|
-
*
|
|
440
|
-
* **Access Token type: `JOURNEY`**:
|
|
441
|
-
*
|
|
442
|
-
* Generates a Public Access Token related to a journey.
|
|
443
|
-
* The journey id should be specfied.
|
|
444
|
-
*
|
|
445
|
-
*/
|
|
446
|
-
'post'(
|
|
447
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
448
|
-
data?: Paths.CreateAccessToken.RequestBody,
|
|
449
|
-
config?: AxiosRequestConfig
|
|
450
|
-
): OperationResponse<Paths.CreateAccessToken.Responses.$201>
|
|
451
|
-
/**
|
|
452
|
-
* listAccessTokens - listAccessTokens
|
|
453
|
-
*
|
|
454
|
-
* Lists all Access Tokens for current user (by default excludes system generated tokens)
|
|
455
|
-
*/
|
|
456
|
-
'get'(
|
|
457
|
-
parameters?: Parameters<Paths.ListAccessTokens.QueryParameters> | null,
|
|
458
|
-
data?: any,
|
|
459
|
-
config?: AxiosRequestConfig
|
|
460
|
-
): OperationResponse<Paths.ListAccessTokens.Responses.$200>
|
|
461
|
-
}
|
|
462
|
-
['/v1/access-tokens/{id}']: {
|
|
463
|
-
/**
|
|
464
|
-
* revokeAccessToken - revokeAccessToken
|
|
465
|
-
*
|
|
466
|
-
* Revokes an Access Token so it can't be used anymore.
|
|
467
|
-
*/
|
|
468
|
-
'delete'(
|
|
469
|
-
parameters?: Parameters<Paths.RevokeAccessToken.PathParameters> | null,
|
|
470
|
-
data?: any,
|
|
471
|
-
config?: AxiosRequestConfig
|
|
472
|
-
): OperationResponse<Paths.RevokeAccessToken.Responses.$200>
|
|
473
|
-
}
|
|
474
|
-
['/v1/access-tokens/.well-known/jwks.json']: {
|
|
475
|
-
/**
|
|
476
|
-
* getAccessTokenJwks - getAccessTokenJwks
|
|
477
|
-
*
|
|
478
|
-
* Get jwks public key set to verify access tokens generated by this API
|
|
479
|
-
*/
|
|
480
|
-
'get'(
|
|
481
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
482
|
-
data?: any,
|
|
483
|
-
config?: AxiosRequestConfig
|
|
484
|
-
): OperationResponse<Paths.GetAccessTokenJwks.Responses.$200>
|
|
485
|
-
}
|
|
486
|
-
['/v1/access-tokens/.well-known/openid-configuration']: {
|
|
487
|
-
/**
|
|
488
|
-
* getAccessTokenOIDC - getAccessTokenOIDC
|
|
489
|
-
*
|
|
490
|
-
* OpenID Connect configuration for Access Token API as identity provider
|
|
491
|
-
*
|
|
492
|
-
* Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to
|
|
493
|
-
* automate the process of verifying JWT tokens.
|
|
494
|
-
*
|
|
495
|
-
*/
|
|
496
|
-
'get'(
|
|
497
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
498
|
-
data?: any,
|
|
499
|
-
config?: AxiosRequestConfig
|
|
500
|
-
): OperationResponse<Paths.GetAccessTokenOIDC.Responses.$200>
|
|
501
|
-
}
|
|
502
|
-
['/v1/access-tokens/public/.well-known/jwks.json']: {
|
|
503
|
-
/**
|
|
504
|
-
* getPublicTokenJwks - getPublicTokenJwks
|
|
505
|
-
*
|
|
506
|
-
* Get jwks public key set to verify public tokens generated by this API
|
|
507
|
-
*/
|
|
508
|
-
'get'(
|
|
509
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
510
|
-
data?: any,
|
|
511
|
-
config?: AxiosRequestConfig
|
|
512
|
-
): OperationResponse<Paths.GetPublicTokenJwks.Responses.$200>
|
|
513
|
-
}
|
|
514
|
-
['/v1/access-tokens/public/.well-known/openid-configuration']: {
|
|
515
|
-
/**
|
|
516
|
-
* getPublicTokenOIDC - getPublicTokenOIDC
|
|
517
|
-
*
|
|
518
|
-
* OpenID Connect configuration for Access Token API a a public identity provider
|
|
519
|
-
*
|
|
520
|
-
* Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to
|
|
521
|
-
* automate the process of verifying JWT tokens.
|
|
522
|
-
*
|
|
523
|
-
*/
|
|
524
|
-
'get'(
|
|
525
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
526
|
-
data?: any,
|
|
527
|
-
config?: AxiosRequestConfig
|
|
528
|
-
): OperationResponse<Paths.GetPublicTokenOIDC.Responses.$200>
|
|
529
|
-
}
|
|
530
|
-
}
|
|
531
|
-
|
|
532
|
-
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
type AccessToken = Components.Schemas.AccessToken;
|
|
536
|
-
type AccessTokenId = Components.Schemas.AccessTokenId;
|
|
537
|
-
type AccessTokenItem = Components.Schemas.AccessTokenItem;
|
|
538
|
-
type AccessTokenJourneyId = Components.Schemas.AccessTokenJourneyId;
|
|
539
|
-
type AccessTokenName = Components.Schemas.AccessTokenName;
|
|
540
|
-
type AccessTokenParameters = Components.Schemas.AccessTokenParameters;
|
|
541
|
-
type AccessTokenType = Components.Schemas.AccessTokenType;
|
|
542
|
-
type AppTokenParameters = Components.Schemas.AppTokenParameters;
|
|
543
|
-
type Assignments = Components.Schemas.Assignments;
|
|
544
|
-
type AssumeTokenParameters = Components.Schemas.AssumeTokenParameters;
|
|
545
|
-
type ExpiresIn = Components.Schemas.ExpiresIn;
|
|
546
|
-
type JourneyTokenParameters = Components.Schemas.JourneyTokenParameters;
|
|
547
|
-
type PortalId = Components.Schemas.PortalId;
|
|
548
|
-
type PortalTokenParameters = Components.Schemas.PortalTokenParameters;
|
|
549
|
-
type RoleId = Components.Schemas.RoleId;
|
|
550
|
-
type TokenParameters = Components.Schemas.TokenParameters;
|
|
551
|
-
|
|
552
|
-
export { type AccessToken as A, type Client as C, type ExpiresIn as E, type JourneyTokenParameters as J, type OperationMethods as O, Paths as P, type RoleId as R, type TokenParameters as T, Components as a, type PathsDictionary as b, type AccessTokenId as c, type AccessTokenItem as d, type AccessTokenJourneyId as e, type AccessTokenName as f, type AccessTokenParameters as g, type AccessTokenType as h, type AppTokenParameters as i, type Assignments as j, type AssumeTokenParameters as k, type PortalId as l, type PortalTokenParameters as m };
|