@epilot/sdk 2.4.4-alpha.0 → 2.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/app.json +137 -58
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +496 -24
- package/definitions/entity.json +185 -8
- package/definitions/webhooks-runtime.json +1 -1
- package/definitions/webhooks.json +134 -4
- package/dist/access-token.d-CnmUTOlq.d.cts +552 -0
- package/dist/access-token.d-CnmUTOlq.d.ts +552 -0
- package/dist/address-suggestions.d-_YwTOR-9.d.cts +339 -0
- package/dist/address-suggestions.d-_YwTOR-9.d.ts +339 -0
- package/dist/address.d-CwAPOVxa.d.cts +437 -0
- package/dist/address.d-CwAPOVxa.d.ts +437 -0
- package/dist/ai-agents.d-OkXfr2bz.d.cts +1339 -0
- package/dist/ai-agents.d-OkXfr2bz.d.ts +1339 -0
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.d.cts +18 -0
- package/dist/apis/access-token.d.ts +12 -9
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.d.cts +18 -0
- package/dist/apis/address-suggestions.d.ts +12 -9
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.d.cts +18 -0
- package/dist/apis/address.d.ts +12 -9
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.d.cts +18 -0
- package/dist/apis/ai-agents.d.ts +12 -9
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +8 -8
- package/dist/apis/app.d.cts +18 -0
- package/dist/apis/app.d.ts +12 -9
- package/dist/apis/app.js +2 -2
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.d.cts +18 -0
- package/dist/apis/audit-logs.d.ts +12 -9
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.d.cts +18 -0
- package/dist/apis/automation.d.ts +12 -9
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.d.cts +18 -0
- package/dist/apis/billing.d.ts +12 -9
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.d.cts +18 -0
- package/dist/apis/blueprint-manifest.d.ts +12 -9
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.d.cts +18 -0
- package/dist/apis/calendar.d.ts +12 -9
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.d.cts +18 -0
- package/dist/apis/configuration-hub.d.ts +12 -9
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.d.cts +18 -0
- package/dist/apis/consent.d.ts +12 -9
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +18 -0
- package/dist/apis/customer-portal.d.ts +12 -9
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.d.cts +18 -0
- package/dist/apis/dashboard.d.ts +12 -9
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.d.cts +18 -0
- package/dist/apis/data-governance.d.ts +12 -9
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.d.cts +18 -0
- package/dist/apis/deduplication.d.ts +12 -9
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.d.cts +18 -0
- package/dist/apis/design.d.ts +12 -9
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.d.cts +18 -0
- package/dist/apis/document.d.ts +12 -9
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.d.cts +18 -0
- package/dist/apis/email-settings.d.ts +12 -9
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.d.cts +18 -0
- package/dist/apis/email-template.d.ts +12 -9
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.d.cts +18 -0
- package/dist/apis/entity-mapping.d.ts +12 -9
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.d.cts +18 -0
- package/dist/apis/entity.d.ts +12 -9
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.d.cts +18 -0
- package/dist/apis/environments.d.ts +12 -9
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.d.cts +18 -0
- package/dist/apis/event-catalog.d.ts +12 -9
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.d.cts +18 -0
- package/dist/apis/file.d.ts +12 -9
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.d.cts +18 -0
- package/dist/apis/iban.d.ts +12 -9
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.d.cts +18 -0
- package/dist/apis/integration-toolkit.d.ts +12 -9
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.cts +18 -0
- package/dist/apis/journey.d.ts +12 -9
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.d.cts +18 -0
- package/dist/apis/kanban.d.ts +12 -9
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.d.cts +18 -0
- package/dist/apis/message.d.ts +12 -9
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.d.cts +18 -0
- package/dist/apis/metering.d.ts +12 -9
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.d.cts +18 -0
- package/dist/apis/notes.d.ts +12 -9
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.d.cts +18 -0
- package/dist/apis/notification.d.ts +12 -9
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.d.cts +18 -0
- package/dist/apis/organization.d.ts +12 -9
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.d.cts +18 -0
- package/dist/apis/partner-directory.d.ts +12 -9
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.d.cts +18 -0
- package/dist/apis/permissions.d.ts +12 -9
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.d.cts +18 -0
- package/dist/apis/pricing-tier.d.ts +12 -9
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.d.cts +18 -0
- package/dist/apis/pricing.d.ts +12 -9
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.d.cts +18 -0
- package/dist/apis/purpose.d.ts +12 -9
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.d.cts +18 -0
- package/dist/apis/query.d.ts +12 -9
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.d.cts +18 -0
- package/dist/apis/sandbox.d.ts +12 -9
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.d.cts +18 -0
- package/dist/apis/sharing.d.ts +12 -9
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.d.cts +18 -0
- package/dist/apis/submission.d.ts +12 -9
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.d.cts +597 -0
- package/dist/apis/target.d.ts +591 -9
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.d.cts +18 -0
- package/dist/apis/targeting.d.ts +12 -9
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.d.cts +18 -0
- package/dist/apis/template-variables.d.ts +12 -9
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.d.cts +18 -0
- package/dist/apis/user.d.ts +12 -9
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.d.cts +18 -0
- package/dist/apis/validation-rules.d.ts +12 -9
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +8 -8
- package/dist/apis/webhooks.d.cts +18 -0
- package/dist/apis/webhooks.d.ts +12 -9
- package/dist/apis/webhooks.js +2 -2
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.d.cts +18 -0
- package/dist/apis/workflow-definition.d.ts +12 -9
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.d.cts +18 -0
- package/dist/apis/workflow.d.ts +12 -9
- package/dist/apis/workflow.js +1 -1
- package/dist/app-34OBBTA4.js +7 -0
- package/dist/app-SSF545U7.cjs +7 -0
- package/dist/app-runtime-AFNM67YN.cjs +5 -0
- package/dist/{app-runtime-U7RGV7KT.js → app-runtime-DBUXZL6E.js} +1 -1
- package/dist/app.d--5n0FQQ4.d.cts +3757 -0
- package/dist/app.d--5n0FQQ4.d.ts +3757 -0
- package/dist/audit-logs.d-BRToFqeX.d.cts +287 -0
- package/dist/audit-logs.d-BRToFqeX.d.ts +287 -0
- package/dist/automation.d-Du6-uiz5.d.cts +5283 -0
- package/dist/automation.d-Du6-uiz5.d.ts +5283 -0
- package/dist/billing.d-Bs8Ku9qE.d.cts +993 -0
- package/dist/billing.d-Bs8Ku9qE.d.ts +993 -0
- package/dist/bin/cli.js +1 -1
- package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +4343 -0
- package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +4343 -0
- package/dist/calendar.d-BEjLDagH.d.cts +353 -0
- package/dist/calendar.d-BEjLDagH.d.ts +353 -0
- package/dist/chunk-5OBMZHRL.cjs +14 -0
- package/dist/{chunk-CD4OX2U6.cjs → chunk-C7GDYBXX.cjs} +9 -9
- package/dist/{chunk-L66IX6GX.cjs → chunk-KMVJYNLB.cjs} +1 -1
- package/dist/chunk-KYCVV2XE.cjs +14 -0
- package/dist/chunk-RGO3LTAM.js +14 -0
- package/dist/{chunk-TSV242UN.js → chunk-WRD2XFHY.js} +9 -9
- package/dist/{chunk-LLZYRINH.js → chunk-Z4H2FZ2K.js} +1 -1
- package/dist/chunk-Z6HGUGXK.js +14 -0
- package/dist/configuration-hub.d-Cqaq2F-W.d.cts +478 -0
- package/dist/configuration-hub.d-Cqaq2F-W.d.ts +478 -0
- package/dist/consent.d-C2PROHhX.d.cts +265 -0
- package/dist/consent.d-C2PROHhX.d.ts +265 -0
- package/dist/customer-portal-5I7ZGQDU.cjs +7 -0
- package/dist/customer-portal-YL2YMPZL.js +7 -0
- package/dist/{customer-portal-runtime-PSM55KGU.js → customer-portal-runtime-N4NWQ67M.js} +1 -1
- package/dist/{customer-portal-runtime-DULJLR7F.cjs → customer-portal-runtime-OEXTSMSE.cjs} +2 -2
- package/dist/customer-portal.d-ChSEioI5.d.cts +17113 -0
- package/dist/customer-portal.d-ChSEioI5.d.ts +17113 -0
- package/dist/dashboard.d-CsGcA74I.d.cts +440 -0
- package/dist/dashboard.d-CsGcA74I.d.ts +440 -0
- package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
- package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
- package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
- package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
- package/dist/design.d-BRre8iLg.d.cts +2346 -0
- package/dist/design.d-BRre8iLg.d.ts +2346 -0
- package/dist/document.d-DN37pjdx.d.cts +648 -0
- package/dist/document.d-DN37pjdx.d.ts +648 -0
- package/dist/email-settings.d-B7Q_xT25.d.cts +2417 -0
- package/dist/email-settings.d-B7Q_xT25.d.ts +2417 -0
- package/dist/email-template.d-gtQkdaXM.d.cts +1188 -0
- package/dist/email-template.d-gtQkdaXM.d.ts +1188 -0
- package/dist/entity-SS36LQO6.cjs +7 -0
- package/dist/entity-Z4YWKDVG.js +7 -0
- package/dist/entity-mapping.d-DKSW3sfy.d.cts +1092 -0
- package/dist/entity-mapping.d-DKSW3sfy.d.ts +1092 -0
- package/dist/entity.d-fospShiN.d.cts +18544 -0
- package/dist/entity.d-fospShiN.d.ts +18544 -0
- package/dist/environments.d-BvqvN-PD.d.cts +382 -0
- package/dist/environments.d-BvqvN-PD.d.ts +382 -0
- package/dist/event-catalog.d-ENw6HO-w.d.cts +1511 -0
- package/dist/event-catalog.d-ENw6HO-w.d.ts +1511 -0
- package/dist/file.d-DcTJxjp7.d.cts +2992 -0
- package/dist/file.d-DcTJxjp7.d.ts +2992 -0
- package/dist/iban.d-BwdiGbxi.d.cts +70 -0
- package/dist/iban.d-BwdiGbxi.d.ts +70 -0
- package/dist/index.cjs +14 -14
- package/dist/index.d.cts +182 -0
- package/dist/index.d.ts +182 -12
- package/dist/index.js +4 -4
- package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +5796 -0
- package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +5796 -0
- package/dist/journey.d-ClXO0xK8.d.cts +1931 -0
- package/dist/journey.d-ClXO0xK8.d.ts +1931 -0
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/dist/kanban.d-BHnSRCYW.d.cts +760 -0
- package/dist/kanban.d-BHnSRCYW.d.ts +760 -0
- package/dist/message.d-B5UuSqgw.d.cts +3811 -0
- package/dist/message.d-B5UuSqgw.d.ts +3811 -0
- package/dist/metering.d-DvtPv7wk.d.cts +1841 -0
- package/dist/metering.d-DvtPv7wk.d.ts +1841 -0
- package/dist/notes-K2IIFCX3.cjs +7 -0
- package/dist/notes-Q7JGS7O3.js +7 -0
- package/dist/notes.d-BcV_m5fe.d.cts +1068 -0
- package/dist/notes.d-BcV_m5fe.d.ts +1068 -0
- package/dist/notification.d-BfBL3lga.d.cts +1147 -0
- package/dist/notification.d-BfBL3lga.d.ts +1147 -0
- package/dist/organization.d-DqwnNxMg.d.cts +1271 -0
- package/dist/organization.d-DqwnNxMg.d.ts +1271 -0
- package/dist/partner-directory.d-BCIjHoGs.d.cts +2337 -0
- package/dist/partner-directory.d-BCIjHoGs.d.ts +2337 -0
- package/dist/permissions.d-l6AT8SYP.d.cts +1279 -0
- package/dist/permissions.d-l6AT8SYP.d.ts +1279 -0
- package/dist/{pricing-XAET4G7T.cjs → pricing-FODHQFCB.cjs} +1 -1
- package/dist/{pricing-G67CH3XH.js → pricing-XRIDVZFC.js} +1 -1
- package/dist/pricing-tier.d-Cg0jl6n_.d.cts +81 -0
- package/dist/pricing-tier.d-Cg0jl6n_.d.ts +81 -0
- package/dist/pricing.d-BHpMU4KU.d.cts +12255 -0
- package/dist/pricing.d-BHpMU4KU.d.ts +12255 -0
- package/dist/purpose.d-CbIYfTua.d.cts +372 -0
- package/dist/purpose.d-CbIYfTua.d.ts +372 -0
- package/dist/query.d-Cmp78IhZ.d.cts +2375 -0
- package/dist/query.d-Cmp78IhZ.d.ts +2375 -0
- package/dist/sandbox.d-BdbOFzDu.d.cts +465 -0
- package/dist/sandbox.d-BdbOFzDu.d.ts +465 -0
- package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
- package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
- package/dist/submission.d-BamwfhXw.d.cts +469 -0
- package/dist/submission.d-BamwfhXw.d.ts +469 -0
- package/dist/targeting.d-BNmcVsNS.d.cts +2057 -0
- package/dist/targeting.d-BNmcVsNS.d.ts +2057 -0
- package/dist/template-variables.d-Ble9TSBa.d.cts +1320 -0
- package/dist/template-variables.d-Ble9TSBa.d.ts +1320 -0
- package/dist/types-ChU9Acbv.d.cts +37 -0
- package/dist/types-ChU9Acbv.d.ts +37 -0
- package/dist/user.d-D18fe97W.d.cts +2270 -0
- package/dist/user.d-D18fe97W.d.ts +2270 -0
- package/dist/validation-rules.d-Db5c5zTf.d.cts +807 -0
- package/dist/validation-rules.d-Db5c5zTf.d.ts +807 -0
- package/dist/webhooks-NZ3TM3AY.cjs +7 -0
- package/dist/webhooks-XLBUXXCS.js +7 -0
- package/dist/{webhooks-runtime-EBM4M3SU.cjs → webhooks-runtime-QVAFNBDW.cjs} +2 -2
- package/dist/{webhooks-runtime-XCQYIGQK.js → webhooks-runtime-UYTPQQVG.js} +1 -1
- package/dist/webhooks.d-D79qib9f.d.cts +1366 -0
- package/dist/webhooks.d-D79qib9f.d.ts +1366 -0
- package/dist/workflow-definition.d-DOeb0KVV.d.cts +1922 -0
- package/dist/workflow-definition.d-DOeb0KVV.d.ts +1922 -0
- package/dist/workflow.d-CMSKt8oN.d.cts +3151 -0
- package/dist/workflow.d-CMSKt8oN.d.ts +3151 -0
- package/docs/app.md +244 -9
- package/docs/customer-portal.md +340 -113
- package/docs/entity.md +65 -0
- package/docs/notes.md +19 -12
- package/docs/pricing.md +3 -1
- package/docs/webhooks.md +49 -0
- package/package.json +1 -1
- package/dist/apis/_registry.d.ts +0 -8
- package/dist/app-5KSVSKDU.js +0 -7
- package/dist/app-PL3IOROO.cjs +0 -7
- package/dist/app-runtime-SSNHSBR7.cjs +0 -5
- package/dist/authorize.d.ts +0 -3
- package/dist/bin/cli.d.ts +0 -1
- package/dist/chunk-2MMSXUOL.cjs +0 -14
- package/dist/chunk-A7AAVJGM.js +0 -14
- package/dist/chunk-GVNT76UU.js +0 -14
- package/dist/chunk-HHMXS5NC.cjs +0 -14
- package/dist/client-factory.d.ts +0 -9
- package/dist/client-map.d.ts +0 -102
- package/dist/compact.d.ts +0 -22
- package/dist/customer-portal-5LMHNBMD.cjs +0 -7
- package/dist/customer-portal-RZACUF4N.js +0 -7
- package/dist/entity-H6ESUH3Y.js +0 -7
- package/dist/entity-ZVDKWQSF.cjs +0 -7
- package/dist/help.d.ts +0 -12
- package/dist/large-response.d.ts +0 -9
- package/dist/notes-3AO5GXIT.js +0 -7
- package/dist/notes-MPWOQC5J.cjs +0 -7
- package/dist/openapi.d.ts +0 -12
- package/dist/overrides.d.ts +0 -9
- package/dist/proxy.d.ts +0 -14
- package/dist/registry.d.ts +0 -19
- package/dist/retry.d.ts +0 -11
- package/dist/sdk.d.ts +0 -29
- package/dist/types.d.ts +0 -53
- package/dist/webhooks-H3RT33BF.cjs +0 -7
- package/dist/webhooks-RTOU3MS5.js +0 -7
|
@@ -0,0 +1,1366 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* Auto-copied from webhooks-client */
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
declare namespace Components {
|
|
7
|
+
namespace Schemas {
|
|
8
|
+
/**
|
|
9
|
+
* To be sent only if authType is API_KEY
|
|
10
|
+
*/
|
|
11
|
+
export interface ApiKeyConfig {
|
|
12
|
+
keyName: string;
|
|
13
|
+
/**
|
|
14
|
+
* On update: omit to preserve existing, pass null to explicitly clear, pass string to set new value.
|
|
15
|
+
*
|
|
16
|
+
*/
|
|
17
|
+
keyValue?: string | null;
|
|
18
|
+
/**
|
|
19
|
+
* When true, indicates the keyValue is an environment variable reference (e.g. {{ env.my_secret }})
|
|
20
|
+
*/
|
|
21
|
+
keyValueIsEnvVar?: boolean;
|
|
22
|
+
}
|
|
23
|
+
export interface Auth {
|
|
24
|
+
authType: AuthType;
|
|
25
|
+
basicAuthConfig?: /* To be sent only if authType is BASIC */ BasicAuthConfig;
|
|
26
|
+
oauthConfig?: /* To be sent only if authType is OAUTH_CLIENT_CREDENTIALS */ OAuthConfig;
|
|
27
|
+
apiKeyConfig?: /* To be sent only if authType is API_KEY */ ApiKeyConfig;
|
|
28
|
+
}
|
|
29
|
+
export type AuthType = "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE";
|
|
30
|
+
/**
|
|
31
|
+
* To be sent only if authType is BASIC
|
|
32
|
+
*/
|
|
33
|
+
export interface BasicAuthConfig {
|
|
34
|
+
username: string;
|
|
35
|
+
/**
|
|
36
|
+
* On update: omit to preserve existing, pass null to explicitly clear, pass string to set new value.
|
|
37
|
+
*
|
|
38
|
+
*/
|
|
39
|
+
password?: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* When true, indicates the password value is an environment variable reference (e.g. {{ env.my_secret }})
|
|
42
|
+
*/
|
|
43
|
+
passwordIsEnvVar?: boolean;
|
|
44
|
+
}
|
|
45
|
+
export interface BatchReplayRequest {
|
|
46
|
+
/**
|
|
47
|
+
* List of event IDs to replay
|
|
48
|
+
* example:
|
|
49
|
+
* [
|
|
50
|
+
* "2f1b7cf8-ff55-4359-966f-e56f39a52c94",
|
|
51
|
+
* "48c984bf-466b-470b-b743-d07cea168243"
|
|
52
|
+
* ]
|
|
53
|
+
*/
|
|
54
|
+
eventIds: [
|
|
55
|
+
string,
|
|
56
|
+
string?,
|
|
57
|
+
string?,
|
|
58
|
+
string?,
|
|
59
|
+
string?,
|
|
60
|
+
string?,
|
|
61
|
+
string?,
|
|
62
|
+
string?,
|
|
63
|
+
string?,
|
|
64
|
+
string?,
|
|
65
|
+
string?,
|
|
66
|
+
string?,
|
|
67
|
+
string?,
|
|
68
|
+
string?,
|
|
69
|
+
string?,
|
|
70
|
+
string?,
|
|
71
|
+
string?,
|
|
72
|
+
string?,
|
|
73
|
+
string?,
|
|
74
|
+
string?,
|
|
75
|
+
string?,
|
|
76
|
+
string?,
|
|
77
|
+
string?,
|
|
78
|
+
string?,
|
|
79
|
+
string?,
|
|
80
|
+
string?,
|
|
81
|
+
string?,
|
|
82
|
+
string?,
|
|
83
|
+
string?,
|
|
84
|
+
string?,
|
|
85
|
+
string?,
|
|
86
|
+
string?,
|
|
87
|
+
string?,
|
|
88
|
+
string?,
|
|
89
|
+
string?,
|
|
90
|
+
string?,
|
|
91
|
+
string?,
|
|
92
|
+
string?,
|
|
93
|
+
string?,
|
|
94
|
+
string?,
|
|
95
|
+
string?,
|
|
96
|
+
string?,
|
|
97
|
+
string?,
|
|
98
|
+
string?,
|
|
99
|
+
string?,
|
|
100
|
+
string?,
|
|
101
|
+
string?,
|
|
102
|
+
string?,
|
|
103
|
+
string?,
|
|
104
|
+
string?,
|
|
105
|
+
string?,
|
|
106
|
+
string?,
|
|
107
|
+
string?,
|
|
108
|
+
string?,
|
|
109
|
+
string?,
|
|
110
|
+
string?,
|
|
111
|
+
string?,
|
|
112
|
+
string?,
|
|
113
|
+
string?,
|
|
114
|
+
string?,
|
|
115
|
+
string?,
|
|
116
|
+
string?,
|
|
117
|
+
string?,
|
|
118
|
+
string?,
|
|
119
|
+
string?,
|
|
120
|
+
string?,
|
|
121
|
+
string?,
|
|
122
|
+
string?,
|
|
123
|
+
string?,
|
|
124
|
+
string?,
|
|
125
|
+
string?,
|
|
126
|
+
string?,
|
|
127
|
+
string?,
|
|
128
|
+
string?,
|
|
129
|
+
string?,
|
|
130
|
+
string?,
|
|
131
|
+
string?,
|
|
132
|
+
string?,
|
|
133
|
+
string?,
|
|
134
|
+
string?,
|
|
135
|
+
string?,
|
|
136
|
+
string?,
|
|
137
|
+
string?,
|
|
138
|
+
string?,
|
|
139
|
+
string?,
|
|
140
|
+
string?,
|
|
141
|
+
string?,
|
|
142
|
+
string?,
|
|
143
|
+
string?,
|
|
144
|
+
string?,
|
|
145
|
+
string?,
|
|
146
|
+
string?,
|
|
147
|
+
string?,
|
|
148
|
+
string?,
|
|
149
|
+
string?,
|
|
150
|
+
string?,
|
|
151
|
+
string?,
|
|
152
|
+
string?,
|
|
153
|
+
string?,
|
|
154
|
+
string?
|
|
155
|
+
];
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Object representing custom headers as key-value pairs.
|
|
159
|
+
*/
|
|
160
|
+
export interface CustomHeader {
|
|
161
|
+
[name: string]: string;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* Custom key/value pair of either type body, query or header
|
|
165
|
+
*/
|
|
166
|
+
export interface CustomOAuthParameter {
|
|
167
|
+
type: "body" | "query" | "header";
|
|
168
|
+
key: string;
|
|
169
|
+
value: string;
|
|
170
|
+
}
|
|
171
|
+
export interface ErrorResp {
|
|
172
|
+
message?: string;
|
|
173
|
+
}
|
|
174
|
+
export interface EventConfigEntry {
|
|
175
|
+
/**
|
|
176
|
+
* Name for identifying the event. Unique.
|
|
177
|
+
*/
|
|
178
|
+
eventName?: string;
|
|
179
|
+
/**
|
|
180
|
+
* Either a user friendly label, or the eventName itself.
|
|
181
|
+
*/
|
|
182
|
+
eventLabel?: string;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* example:
|
|
186
|
+
* [
|
|
187
|
+
* {
|
|
188
|
+
* "eventName": "customer_request_created",
|
|
189
|
+
* "eventLabel": "Customer Request Created"
|
|
190
|
+
* }
|
|
191
|
+
* ]
|
|
192
|
+
*/
|
|
193
|
+
export type EventConfigResp = EventConfigEntry[];
|
|
194
|
+
export interface EventListResponse {
|
|
195
|
+
/**
|
|
196
|
+
* List of webhook events
|
|
197
|
+
*/
|
|
198
|
+
data?: WebhookEvent[];
|
|
199
|
+
/**
|
|
200
|
+
* Cursor to fetch the next page. Null if no more results.
|
|
201
|
+
*/
|
|
202
|
+
next_cursor?: {
|
|
203
|
+
/**
|
|
204
|
+
* example:
|
|
205
|
+
* 2025-10-31T12:34:56Z
|
|
206
|
+
*/
|
|
207
|
+
created_at?: string; // date-time
|
|
208
|
+
/**
|
|
209
|
+
* example:
|
|
210
|
+
* evt_1234567890abcdef
|
|
211
|
+
*/
|
|
212
|
+
event_id?: string;
|
|
213
|
+
} | null;
|
|
214
|
+
/**
|
|
215
|
+
* Indicates if more results are available
|
|
216
|
+
* example:
|
|
217
|
+
* true
|
|
218
|
+
*/
|
|
219
|
+
has_more?: boolean;
|
|
220
|
+
}
|
|
221
|
+
export interface ExampleRequest {
|
|
222
|
+
/**
|
|
223
|
+
* ID of the automation, if applicable
|
|
224
|
+
* example:
|
|
225
|
+
* automation_123
|
|
226
|
+
*/
|
|
227
|
+
automation_id?: string;
|
|
228
|
+
}
|
|
229
|
+
export interface ExampleResponse {
|
|
230
|
+
[name: string]: any;
|
|
231
|
+
metadata?: /* Contains the metadata about the configured event */ Metadata;
|
|
232
|
+
/**
|
|
233
|
+
* Example payload for the webhook event
|
|
234
|
+
*/
|
|
235
|
+
entity?: {
|
|
236
|
+
[name: string]: any;
|
|
237
|
+
};
|
|
238
|
+
/**
|
|
239
|
+
* Example relations for the webhook event
|
|
240
|
+
*/
|
|
241
|
+
relations?: {
|
|
242
|
+
[name: string]: any;
|
|
243
|
+
}[];
|
|
244
|
+
}
|
|
245
|
+
/**
|
|
246
|
+
* Payload for triggering a webhook
|
|
247
|
+
*/
|
|
248
|
+
export interface ExecutionPayload {
|
|
249
|
+
[name: string]: any;
|
|
250
|
+
metadata: /* Contains the metadata about the configured event */ Metadata;
|
|
251
|
+
}
|
|
252
|
+
export interface Filter {
|
|
253
|
+
keyToFilter: string;
|
|
254
|
+
supportedValues: string[];
|
|
255
|
+
}
|
|
256
|
+
export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
|
|
257
|
+
/**
|
|
258
|
+
* Contains the metadata about the configured event
|
|
259
|
+
*/
|
|
260
|
+
export interface Metadata {
|
|
261
|
+
/**
|
|
262
|
+
* Action that triggered the event
|
|
263
|
+
* example:
|
|
264
|
+
* Manual triggered by user with id 123456
|
|
265
|
+
*/
|
|
266
|
+
action?: string;
|
|
267
|
+
/**
|
|
268
|
+
* Origin of the event
|
|
269
|
+
*/
|
|
270
|
+
origin?: string;
|
|
271
|
+
/**
|
|
272
|
+
* Time of event creation
|
|
273
|
+
*/
|
|
274
|
+
creation_timestamp?: string;
|
|
275
|
+
/**
|
|
276
|
+
* The ID of the webhook configuration
|
|
277
|
+
*/
|
|
278
|
+
webhook_id?: string;
|
|
279
|
+
/**
|
|
280
|
+
* The name of the webhook configuration
|
|
281
|
+
*/
|
|
282
|
+
webhook_name?: string;
|
|
283
|
+
/**
|
|
284
|
+
* The name of the automation that triggered the event
|
|
285
|
+
*/
|
|
286
|
+
automation_name?: string;
|
|
287
|
+
/**
|
|
288
|
+
* The ID of the given organization
|
|
289
|
+
*/
|
|
290
|
+
organization_id: string;
|
|
291
|
+
/**
|
|
292
|
+
* The ID of the user for manual triggered events
|
|
293
|
+
*/
|
|
294
|
+
user_id?: string;
|
|
295
|
+
/**
|
|
296
|
+
* ID used to track the event
|
|
297
|
+
*/
|
|
298
|
+
correlation_id?: string;
|
|
299
|
+
/**
|
|
300
|
+
* When triggered by an automation this is its execution id
|
|
301
|
+
*/
|
|
302
|
+
execution_id?: string;
|
|
303
|
+
/**
|
|
304
|
+
* When triggered by an automation this is the id of the action
|
|
305
|
+
*/
|
|
306
|
+
action_id?: string;
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* To be sent only if authType is OAUTH_CLIENT_CREDENTIALS
|
|
310
|
+
*/
|
|
311
|
+
export interface OAuthConfig {
|
|
312
|
+
clientId: string;
|
|
313
|
+
/**
|
|
314
|
+
* On update: omit to preserve existing, pass null to explicitly clear, pass string to set new value.
|
|
315
|
+
*
|
|
316
|
+
*/
|
|
317
|
+
clientSecret?: string | null;
|
|
318
|
+
/**
|
|
319
|
+
* When true, indicates the clientSecret value is an environment variable reference (e.g. {{ env.my_secret }})
|
|
320
|
+
*/
|
|
321
|
+
clientSecretIsEnvVar?: boolean;
|
|
322
|
+
/**
|
|
323
|
+
* Https Endpoint for authentication
|
|
324
|
+
*/
|
|
325
|
+
endpoint: string;
|
|
326
|
+
httpMethod: HttpMethod;
|
|
327
|
+
customParameterList?: /* Custom key/value pair of either type body, query or header */ CustomOAuthParameter[];
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
* Configuration for the webhook payload
|
|
331
|
+
*/
|
|
332
|
+
export interface PayloadConfiguration {
|
|
333
|
+
hydrate_entity?: boolean;
|
|
334
|
+
include_relations?: boolean;
|
|
335
|
+
include_activity?: boolean;
|
|
336
|
+
include_changed_attributes?: boolean;
|
|
337
|
+
/**
|
|
338
|
+
* When true, entity fields show proposed changeset values instead of current values
|
|
339
|
+
*/
|
|
340
|
+
apply_changesets?: boolean;
|
|
341
|
+
custom_headers?: /* Object representing custom headers as key-value pairs. */ CustomHeader;
|
|
342
|
+
}
|
|
343
|
+
export interface PublicKeyResponse {
|
|
344
|
+
/**
|
|
345
|
+
* PEM-encoded Ed25519 public key for verifying webhook signatures
|
|
346
|
+
* example:
|
|
347
|
+
* -----BEGIN PUBLIC KEY-----
|
|
348
|
+
* MCowBQYDK2VwAyEA...
|
|
349
|
+
* -----END PUBLIC KEY-----
|
|
350
|
+
*
|
|
351
|
+
*/
|
|
352
|
+
public_key: string;
|
|
353
|
+
/**
|
|
354
|
+
* The signing algorithm used
|
|
355
|
+
* example:
|
|
356
|
+
* ed25519
|
|
357
|
+
*/
|
|
358
|
+
algorithm: string;
|
|
359
|
+
/**
|
|
360
|
+
* The issuer of the signing key
|
|
361
|
+
* example:
|
|
362
|
+
* epilot
|
|
363
|
+
*/
|
|
364
|
+
issuer?: string;
|
|
365
|
+
}
|
|
366
|
+
export interface SearchOptions {
|
|
367
|
+
/**
|
|
368
|
+
* Maximum number of results to return
|
|
369
|
+
* example:
|
|
370
|
+
* 25
|
|
371
|
+
*/
|
|
372
|
+
limit?: number;
|
|
373
|
+
/**
|
|
374
|
+
* Cursor for pagination. Use the next_cursor from the previous response to get the next page.
|
|
375
|
+
*/
|
|
376
|
+
cursor?: {
|
|
377
|
+
/**
|
|
378
|
+
* Timestamp from the last event in the previous page
|
|
379
|
+
* example:
|
|
380
|
+
* 2025-10-31T12:34:56Z
|
|
381
|
+
*/
|
|
382
|
+
created_at?: string; // date-time
|
|
383
|
+
/**
|
|
384
|
+
* Event ID from the last event in the previous page
|
|
385
|
+
* example:
|
|
386
|
+
* evt_1234567890abcdef
|
|
387
|
+
*/
|
|
388
|
+
event_id?: string;
|
|
389
|
+
};
|
|
390
|
+
/**
|
|
391
|
+
* Filter events by timestamp range
|
|
392
|
+
*/
|
|
393
|
+
timestamp?: {
|
|
394
|
+
/**
|
|
395
|
+
* Start timestamp in ISO 8601 format
|
|
396
|
+
* example:
|
|
397
|
+
* 2025-10-01T00:00:00Z
|
|
398
|
+
*/
|
|
399
|
+
from?: string; // date-time
|
|
400
|
+
/**
|
|
401
|
+
* End timestamp in ISO 8601 format
|
|
402
|
+
* example:
|
|
403
|
+
* 2025-10-31T23:59:59Z
|
|
404
|
+
*/
|
|
405
|
+
to?: string; // date-time
|
|
406
|
+
};
|
|
407
|
+
/**
|
|
408
|
+
* Filter by specific event ID
|
|
409
|
+
* example:
|
|
410
|
+
* evt_1234567890abcdef
|
|
411
|
+
*/
|
|
412
|
+
event_id?: string;
|
|
413
|
+
/**
|
|
414
|
+
* Filter by event outcome
|
|
415
|
+
* example:
|
|
416
|
+
* succeeded
|
|
417
|
+
*/
|
|
418
|
+
status?: "succeeded" | "failed" | "skipped";
|
|
419
|
+
}
|
|
420
|
+
export interface TestOAuthResponse {
|
|
421
|
+
/**
|
|
422
|
+
* Whether the OAuth token exchange succeeded
|
|
423
|
+
* example:
|
|
424
|
+
* true
|
|
425
|
+
*/
|
|
426
|
+
success: boolean;
|
|
427
|
+
/**
|
|
428
|
+
* Token validity in seconds as reported by the OAuth provider
|
|
429
|
+
* example:
|
|
430
|
+
* 3600
|
|
431
|
+
*/
|
|
432
|
+
expires_in?: number;
|
|
433
|
+
/**
|
|
434
|
+
* Token type returned by the OAuth provider
|
|
435
|
+
* example:
|
|
436
|
+
* Bearer
|
|
437
|
+
*/
|
|
438
|
+
token_type?: string;
|
|
439
|
+
/**
|
|
440
|
+
* Human-readable result message
|
|
441
|
+
* example:
|
|
442
|
+
* OAuth token exchange successful
|
|
443
|
+
*/
|
|
444
|
+
message: string;
|
|
445
|
+
}
|
|
446
|
+
export interface TriggerWebhookResp {
|
|
447
|
+
status_code?: string;
|
|
448
|
+
message?: string;
|
|
449
|
+
body?: {
|
|
450
|
+
[key: string]: any;
|
|
451
|
+
};
|
|
452
|
+
code?: string;
|
|
453
|
+
status?: "succeeded" | "failed";
|
|
454
|
+
start_date?: string;
|
|
455
|
+
end_date?: string;
|
|
456
|
+
event_id: string;
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* A condition that must be met for the webhook to fire.
|
|
460
|
+
*/
|
|
461
|
+
export interface WebhookCondition {
|
|
462
|
+
/**
|
|
463
|
+
* Dot-notation path to the field in the event payload (e.g. "entity.status", "entity.line_items")
|
|
464
|
+
*/
|
|
465
|
+
field: string;
|
|
466
|
+
operation: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty";
|
|
467
|
+
/**
|
|
468
|
+
* Values to compare against (not required for is_empty/is_not_empty)
|
|
469
|
+
*/
|
|
470
|
+
values?: string[];
|
|
471
|
+
/**
|
|
472
|
+
* Type hint for the field (affects comparison logic)
|
|
473
|
+
*/
|
|
474
|
+
field_type?: "string" | "number" | "boolean" | "date" | "datetime";
|
|
475
|
+
/**
|
|
476
|
+
* Whether the target field is an array (repeatable)
|
|
477
|
+
*/
|
|
478
|
+
is_array_field?: boolean;
|
|
479
|
+
/**
|
|
480
|
+
* When true, evaluates conditions per-item in repeatable array fields
|
|
481
|
+
*/
|
|
482
|
+
repeatable_item_op?: boolean;
|
|
483
|
+
}
|
|
484
|
+
/**
|
|
485
|
+
* A group of conditions with a logical operator. Multiple conditions are AND-ed by default.
|
|
486
|
+
*/
|
|
487
|
+
export interface WebhookConditionGroup {
|
|
488
|
+
conditions?: [
|
|
489
|
+
/* A condition that must be met for the webhook to fire. */ WebhookCondition?,
|
|
490
|
+
/* A condition that must be met for the webhook to fire. */ WebhookCondition?,
|
|
491
|
+
/* A condition that must be met for the webhook to fire. */ WebhookCondition?,
|
|
492
|
+
/* A condition that must be met for the webhook to fire. */ WebhookCondition?,
|
|
493
|
+
/* A condition that must be met for the webhook to fire. */ WebhookCondition?,
|
|
494
|
+
/* A condition that must be met for the webhook to fire. */ WebhookCondition?,
|
|
495
|
+
/* A condition that must be met for the webhook to fire. */ WebhookCondition?,
|
|
496
|
+
/* A condition that must be met for the webhook to fire. */ WebhookCondition?,
|
|
497
|
+
/* A condition that must be met for the webhook to fire. */ WebhookCondition?,
|
|
498
|
+
/* A condition that must be met for the webhook to fire. */ WebhookCondition?
|
|
499
|
+
];
|
|
500
|
+
logical_operator?: "AND" | "OR";
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* example:
|
|
504
|
+
* {
|
|
505
|
+
* "eventName": "CustomerRequest_Created",
|
|
506
|
+
* "url": "https://my-partner-service.api.com",
|
|
507
|
+
* "httpMethod": "POST",
|
|
508
|
+
* "enabled": true,
|
|
509
|
+
* "auth": {
|
|
510
|
+
* "authType": "BASIC",
|
|
511
|
+
* "basicAuthConfig": {
|
|
512
|
+
* "username": "secretUsername",
|
|
513
|
+
* "password": "secret7825@!"
|
|
514
|
+
* }
|
|
515
|
+
* },
|
|
516
|
+
* "filter": {
|
|
517
|
+
* "keyToFilter": "customer_request.productId",
|
|
518
|
+
* "supportedValues": [
|
|
519
|
+
* "2324245",
|
|
520
|
+
* "5253642"
|
|
521
|
+
* ]
|
|
522
|
+
* }
|
|
523
|
+
* }
|
|
524
|
+
*/
|
|
525
|
+
export interface WebhookConfig {
|
|
526
|
+
id?: string;
|
|
527
|
+
name: string;
|
|
528
|
+
eventName: string;
|
|
529
|
+
url?: string;
|
|
530
|
+
/**
|
|
531
|
+
* Timestamp the webhook was first created. Immutable after creation.
|
|
532
|
+
* example:
|
|
533
|
+
* 2021-04-27T12:01:13.000Z
|
|
534
|
+
*/
|
|
535
|
+
creationTime?: string;
|
|
536
|
+
/**
|
|
537
|
+
* Timestamp of the most recent update to the webhook. Equals creationTime for never-edited webhooks. May be absent on legacy records written before this field was introduced.
|
|
538
|
+
* example:
|
|
539
|
+
* 2021-04-27T12:01:13.000Z
|
|
540
|
+
*/
|
|
541
|
+
updatedTime?: string;
|
|
542
|
+
httpMethod?: HttpMethod;
|
|
543
|
+
enabled?: boolean;
|
|
544
|
+
auth?: Auth;
|
|
545
|
+
filter?: Filter;
|
|
546
|
+
payloadConfiguration?: /* Configuration for the webhook payload */ PayloadConfiguration;
|
|
547
|
+
enableStaticIP?: boolean;
|
|
548
|
+
/**
|
|
549
|
+
* When true, indicates this webhook configuration is protected and should not be modified without explicit intent.
|
|
550
|
+
*/
|
|
551
|
+
protected?: boolean;
|
|
552
|
+
/**
|
|
553
|
+
* Routes webhook requests through a secure VPC proxy (ERP integration service). When set, takes precedence over enableStaticIP.
|
|
554
|
+
*/
|
|
555
|
+
secureProxy?: {
|
|
556
|
+
integration_id: string; // uuid
|
|
557
|
+
use_case_slug: string;
|
|
558
|
+
};
|
|
559
|
+
status?: "active" | "inactive" | "incomplete";
|
|
560
|
+
/**
|
|
561
|
+
* JSONata expression to transform the payload
|
|
562
|
+
*/
|
|
563
|
+
jsonataExpression?: string;
|
|
564
|
+
/**
|
|
565
|
+
* Controls how file data is delivered to the endpoint. Only relevant when the webhook is triggered by a file event. Absent for non-file-event webhooks.
|
|
566
|
+
*/
|
|
567
|
+
deliveryMode?: "json_base64" | "binary_multipart";
|
|
568
|
+
/**
|
|
569
|
+
* Configuration for binary_multipart delivery mode. Specifies the field names used in the multipart form data request.
|
|
570
|
+
*/
|
|
571
|
+
multipartConfig?: {
|
|
572
|
+
/**
|
|
573
|
+
* The name of the form field containing the file binary data.
|
|
574
|
+
*/
|
|
575
|
+
fileFieldName?: string;
|
|
576
|
+
/**
|
|
577
|
+
* The name of the form field containing the JSON metadata payload.
|
|
578
|
+
*/
|
|
579
|
+
metadataFieldName?: string;
|
|
580
|
+
};
|
|
581
|
+
filterConditions?: /* A group of conditions with a logical operator. Multiple conditions are AND-ed by default. */ WebhookConditionGroup;
|
|
582
|
+
/**
|
|
583
|
+
* Manifest ID used to create/update the webhook resource
|
|
584
|
+
*/
|
|
585
|
+
_manifest?: string /* uuid */[];
|
|
586
|
+
/**
|
|
587
|
+
* Per-webhook signing secret following the Standard Webhooks specification.
|
|
588
|
+
* Only returned once during webhook creation. Use this secret to verify
|
|
589
|
+
* webhook signatures using the `webhook-id`, `webhook-timestamp`, and
|
|
590
|
+
* `webhook-signature` headers.
|
|
591
|
+
*
|
|
592
|
+
* example:
|
|
593
|
+
* whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD
|
|
594
|
+
*/
|
|
595
|
+
signingSecret?: string;
|
|
596
|
+
}
|
|
597
|
+
export interface WebhookEvent {
|
|
598
|
+
event_id: string;
|
|
599
|
+
org_id: string;
|
|
600
|
+
webhook_config_id: string;
|
|
601
|
+
url?: string;
|
|
602
|
+
/**
|
|
603
|
+
* example:
|
|
604
|
+
* 2021-04-27T12:01:13.000Z
|
|
605
|
+
*/
|
|
606
|
+
created_at?: string;
|
|
607
|
+
event_name?: string;
|
|
608
|
+
http_response?: {
|
|
609
|
+
status_code?: number;
|
|
610
|
+
message?: string;
|
|
611
|
+
body?: {
|
|
612
|
+
[key: string]: any;
|
|
613
|
+
};
|
|
614
|
+
code?: string;
|
|
615
|
+
};
|
|
616
|
+
metadata?: /* Contains the metadata about the configured event */ Metadata;
|
|
617
|
+
status?: "succeeded" | "failed" | "in_progress" | "skipped";
|
|
618
|
+
http_method?: "GET" | "POST" | "PUT";
|
|
619
|
+
/**
|
|
620
|
+
* stringified payload of the webhook request
|
|
621
|
+
*/
|
|
622
|
+
payload?: string;
|
|
623
|
+
}
|
|
624
|
+
}
|
|
625
|
+
}
|
|
626
|
+
declare namespace Paths {
|
|
627
|
+
namespace BatchReplayEvents {
|
|
628
|
+
namespace Parameters {
|
|
629
|
+
export type ConfigId = string;
|
|
630
|
+
}
|
|
631
|
+
export interface PathParameters {
|
|
632
|
+
configId: Parameters.ConfigId;
|
|
633
|
+
}
|
|
634
|
+
export type RequestBody = Components.Schemas.BatchReplayRequest;
|
|
635
|
+
namespace Responses {
|
|
636
|
+
export interface $202 {
|
|
637
|
+
/**
|
|
638
|
+
* List of event ids that were enqueued for replay
|
|
639
|
+
*/
|
|
640
|
+
replayed_event_ids?: string[];
|
|
641
|
+
}
|
|
642
|
+
export type $400 = Components.Schemas.ErrorResp;
|
|
643
|
+
export type $404 = Components.Schemas.ErrorResp;
|
|
644
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
645
|
+
}
|
|
646
|
+
}
|
|
647
|
+
namespace CreateConfig {
|
|
648
|
+
export type RequestBody = /**
|
|
649
|
+
* example:
|
|
650
|
+
* {
|
|
651
|
+
* "eventName": "CustomerRequest_Created",
|
|
652
|
+
* "url": "https://my-partner-service.api.com",
|
|
653
|
+
* "httpMethod": "POST",
|
|
654
|
+
* "enabled": true,
|
|
655
|
+
* "auth": {
|
|
656
|
+
* "authType": "BASIC",
|
|
657
|
+
* "basicAuthConfig": {
|
|
658
|
+
* "username": "secretUsername",
|
|
659
|
+
* "password": "secret7825@!"
|
|
660
|
+
* }
|
|
661
|
+
* },
|
|
662
|
+
* "filter": {
|
|
663
|
+
* "keyToFilter": "customer_request.productId",
|
|
664
|
+
* "supportedValues": [
|
|
665
|
+
* "2324245",
|
|
666
|
+
* "5253642"
|
|
667
|
+
* ]
|
|
668
|
+
* }
|
|
669
|
+
* }
|
|
670
|
+
*/
|
|
671
|
+
Components.Schemas.WebhookConfig;
|
|
672
|
+
namespace Responses {
|
|
673
|
+
export type $201 = /**
|
|
674
|
+
* example:
|
|
675
|
+
* {
|
|
676
|
+
* "eventName": "CustomerRequest_Created",
|
|
677
|
+
* "url": "https://my-partner-service.api.com",
|
|
678
|
+
* "httpMethod": "POST",
|
|
679
|
+
* "enabled": true,
|
|
680
|
+
* "auth": {
|
|
681
|
+
* "authType": "BASIC",
|
|
682
|
+
* "basicAuthConfig": {
|
|
683
|
+
* "username": "secretUsername",
|
|
684
|
+
* "password": "secret7825@!"
|
|
685
|
+
* }
|
|
686
|
+
* },
|
|
687
|
+
* "filter": {
|
|
688
|
+
* "keyToFilter": "customer_request.productId",
|
|
689
|
+
* "supportedValues": [
|
|
690
|
+
* "2324245",
|
|
691
|
+
* "5253642"
|
|
692
|
+
* ]
|
|
693
|
+
* }
|
|
694
|
+
* }
|
|
695
|
+
*/
|
|
696
|
+
Components.Schemas.WebhookConfig;
|
|
697
|
+
export type $400 = Components.Schemas.ErrorResp;
|
|
698
|
+
export type $401 = Components.Schemas.ErrorResp;
|
|
699
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
700
|
+
}
|
|
701
|
+
}
|
|
702
|
+
namespace DeleteConfig {
|
|
703
|
+
namespace Parameters {
|
|
704
|
+
export type ConfigId = string;
|
|
705
|
+
}
|
|
706
|
+
export interface PathParameters {
|
|
707
|
+
configId: Parameters.ConfigId;
|
|
708
|
+
}
|
|
709
|
+
namespace Responses {
|
|
710
|
+
export interface $204 {
|
|
711
|
+
}
|
|
712
|
+
export type $401 = Components.Schemas.ErrorResp;
|
|
713
|
+
export interface $404 {
|
|
714
|
+
}
|
|
715
|
+
}
|
|
716
|
+
}
|
|
717
|
+
namespace GetConfig {
|
|
718
|
+
namespace Parameters {
|
|
719
|
+
export type ConfigId = string;
|
|
720
|
+
}
|
|
721
|
+
export interface PathParameters {
|
|
722
|
+
configId: Parameters.ConfigId;
|
|
723
|
+
}
|
|
724
|
+
namespace Responses {
|
|
725
|
+
export type $200 = /**
|
|
726
|
+
* example:
|
|
727
|
+
* {
|
|
728
|
+
* "eventName": "CustomerRequest_Created",
|
|
729
|
+
* "url": "https://my-partner-service.api.com",
|
|
730
|
+
* "httpMethod": "POST",
|
|
731
|
+
* "enabled": true,
|
|
732
|
+
* "auth": {
|
|
733
|
+
* "authType": "BASIC",
|
|
734
|
+
* "basicAuthConfig": {
|
|
735
|
+
* "username": "secretUsername",
|
|
736
|
+
* "password": "secret7825@!"
|
|
737
|
+
* }
|
|
738
|
+
* },
|
|
739
|
+
* "filter": {
|
|
740
|
+
* "keyToFilter": "customer_request.productId",
|
|
741
|
+
* "supportedValues": [
|
|
742
|
+
* "2324245",
|
|
743
|
+
* "5253642"
|
|
744
|
+
* ]
|
|
745
|
+
* }
|
|
746
|
+
* }
|
|
747
|
+
*/
|
|
748
|
+
Components.Schemas.WebhookConfig;
|
|
749
|
+
export type $404 = Components.Schemas.ErrorResp;
|
|
750
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
751
|
+
}
|
|
752
|
+
}
|
|
753
|
+
namespace GetConfigs {
|
|
754
|
+
namespace Parameters {
|
|
755
|
+
export type EventName = string;
|
|
756
|
+
}
|
|
757
|
+
export interface QueryParameters {
|
|
758
|
+
eventName?: Parameters.EventName;
|
|
759
|
+
}
|
|
760
|
+
namespace Responses {
|
|
761
|
+
export type $200 = /**
|
|
762
|
+
* example:
|
|
763
|
+
* {
|
|
764
|
+
* "eventName": "CustomerRequest_Created",
|
|
765
|
+
* "url": "https://my-partner-service.api.com",
|
|
766
|
+
* "httpMethod": "POST",
|
|
767
|
+
* "enabled": true,
|
|
768
|
+
* "auth": {
|
|
769
|
+
* "authType": "BASIC",
|
|
770
|
+
* "basicAuthConfig": {
|
|
771
|
+
* "username": "secretUsername",
|
|
772
|
+
* "password": "secret7825@!"
|
|
773
|
+
* }
|
|
774
|
+
* },
|
|
775
|
+
* "filter": {
|
|
776
|
+
* "keyToFilter": "customer_request.productId",
|
|
777
|
+
* "supportedValues": [
|
|
778
|
+
* "2324245",
|
|
779
|
+
* "5253642"
|
|
780
|
+
* ]
|
|
781
|
+
* }
|
|
782
|
+
* }
|
|
783
|
+
*/
|
|
784
|
+
Components.Schemas.WebhookConfig[];
|
|
785
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
786
|
+
}
|
|
787
|
+
}
|
|
788
|
+
namespace GetConfiguredEvents {
|
|
789
|
+
namespace Responses {
|
|
790
|
+
export type $200 = /**
|
|
791
|
+
* example:
|
|
792
|
+
* [
|
|
793
|
+
* {
|
|
794
|
+
* "eventName": "customer_request_created",
|
|
795
|
+
* "eventLabel": "Customer Request Created"
|
|
796
|
+
* }
|
|
797
|
+
* ]
|
|
798
|
+
*/
|
|
799
|
+
Components.Schemas.EventConfigResp;
|
|
800
|
+
}
|
|
801
|
+
}
|
|
802
|
+
namespace GetEventById {
|
|
803
|
+
namespace Parameters {
|
|
804
|
+
export type ConfigId = string;
|
|
805
|
+
export type EventId = string;
|
|
806
|
+
}
|
|
807
|
+
export interface PathParameters {
|
|
808
|
+
configId: Parameters.ConfigId;
|
|
809
|
+
eventId: Parameters.EventId;
|
|
810
|
+
}
|
|
811
|
+
namespace Responses {
|
|
812
|
+
export type $200 = Components.Schemas.WebhookEvent;
|
|
813
|
+
export type $404 = Components.Schemas.ErrorResp;
|
|
814
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
815
|
+
}
|
|
816
|
+
}
|
|
817
|
+
namespace GetPublicKey {
|
|
818
|
+
namespace Parameters {
|
|
819
|
+
export type OrgId = string;
|
|
820
|
+
}
|
|
821
|
+
export interface QueryParameters {
|
|
822
|
+
orgId: Parameters.OrgId;
|
|
823
|
+
}
|
|
824
|
+
namespace Responses {
|
|
825
|
+
export type $200 = Components.Schemas.PublicKeyResponse;
|
|
826
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
827
|
+
}
|
|
828
|
+
}
|
|
829
|
+
namespace GetWebhookEventsV2 {
|
|
830
|
+
namespace Parameters {
|
|
831
|
+
export type ConfigId = string;
|
|
832
|
+
}
|
|
833
|
+
export interface PathParameters {
|
|
834
|
+
configId: Parameters.ConfigId;
|
|
835
|
+
}
|
|
836
|
+
export type RequestBody = Components.Schemas.SearchOptions;
|
|
837
|
+
namespace Responses {
|
|
838
|
+
export type $200 = Components.Schemas.EventListResponse;
|
|
839
|
+
}
|
|
840
|
+
}
|
|
841
|
+
namespace GetWebhookExample {
|
|
842
|
+
namespace Parameters {
|
|
843
|
+
export type ConfigId = string;
|
|
844
|
+
}
|
|
845
|
+
export interface PathParameters {
|
|
846
|
+
configId: Parameters.ConfigId;
|
|
847
|
+
}
|
|
848
|
+
export type RequestBody = Components.Schemas.ExampleRequest;
|
|
849
|
+
namespace Responses {
|
|
850
|
+
export type $200 = Components.Schemas.ExampleResponse;
|
|
851
|
+
export type $400 = Components.Schemas.ErrorResp;
|
|
852
|
+
export type $404 = Components.Schemas.ErrorResp;
|
|
853
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
854
|
+
}
|
|
855
|
+
}
|
|
856
|
+
namespace GetWehookEvents {
|
|
857
|
+
namespace Parameters {
|
|
858
|
+
export type ConfigId = string;
|
|
859
|
+
export type Cursor = string;
|
|
860
|
+
export type Status = "succeeded" | "failed" | "in_progress";
|
|
861
|
+
}
|
|
862
|
+
export interface PathParameters {
|
|
863
|
+
configId: Parameters.ConfigId;
|
|
864
|
+
}
|
|
865
|
+
export interface QueryParameters {
|
|
866
|
+
status?: Parameters.Status;
|
|
867
|
+
cursor?: Parameters.Cursor;
|
|
868
|
+
}
|
|
869
|
+
namespace Responses {
|
|
870
|
+
export interface $200 {
|
|
871
|
+
data?: Components.Schemas.WebhookEvent[];
|
|
872
|
+
/**
|
|
873
|
+
* Cursor to be used for pagination
|
|
874
|
+
*/
|
|
875
|
+
cursor?: string;
|
|
876
|
+
}
|
|
877
|
+
export type $404 = Components.Schemas.ErrorResp;
|
|
878
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
879
|
+
}
|
|
880
|
+
}
|
|
881
|
+
namespace ReplayEvent {
|
|
882
|
+
namespace Parameters {
|
|
883
|
+
export type ConfigId = string;
|
|
884
|
+
export type EventId = string;
|
|
885
|
+
}
|
|
886
|
+
export interface PathParameters {
|
|
887
|
+
configId: Parameters.ConfigId;
|
|
888
|
+
eventId: Parameters.EventId;
|
|
889
|
+
}
|
|
890
|
+
namespace Responses {
|
|
891
|
+
export interface $204 {
|
|
892
|
+
}
|
|
893
|
+
export type $404 = Components.Schemas.ErrorResp;
|
|
894
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
895
|
+
}
|
|
896
|
+
}
|
|
897
|
+
namespace TestOAuth {
|
|
898
|
+
namespace Parameters {
|
|
899
|
+
export type ConfigId = string;
|
|
900
|
+
}
|
|
901
|
+
export interface PathParameters {
|
|
902
|
+
configId: Parameters.ConfigId;
|
|
903
|
+
}
|
|
904
|
+
namespace Responses {
|
|
905
|
+
export type $200 = Components.Schemas.TestOAuthResponse;
|
|
906
|
+
export type $400 = Components.Schemas.ErrorResp;
|
|
907
|
+
export type $404 = Components.Schemas.ErrorResp;
|
|
908
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
909
|
+
}
|
|
910
|
+
}
|
|
911
|
+
namespace TriggerWebhook {
|
|
912
|
+
namespace Parameters {
|
|
913
|
+
export type ConfigId = string;
|
|
914
|
+
export type Sync = boolean;
|
|
915
|
+
}
|
|
916
|
+
export interface PathParameters {
|
|
917
|
+
configId: Parameters.ConfigId;
|
|
918
|
+
}
|
|
919
|
+
export interface QueryParameters {
|
|
920
|
+
sync?: Parameters.Sync;
|
|
921
|
+
}
|
|
922
|
+
export type RequestBody = /* Payload for triggering a webhook */ Components.Schemas.ExecutionPayload;
|
|
923
|
+
namespace Responses {
|
|
924
|
+
export type $200 = Components.Schemas.TriggerWebhookResp;
|
|
925
|
+
export type $400 = Components.Schemas.ErrorResp;
|
|
926
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
927
|
+
}
|
|
928
|
+
}
|
|
929
|
+
namespace UpdateConfig {
|
|
930
|
+
namespace Parameters {
|
|
931
|
+
export type ConfigId = string;
|
|
932
|
+
}
|
|
933
|
+
export interface PathParameters {
|
|
934
|
+
configId: Parameters.ConfigId;
|
|
935
|
+
}
|
|
936
|
+
export type RequestBody = /**
|
|
937
|
+
* example:
|
|
938
|
+
* {
|
|
939
|
+
* "eventName": "CustomerRequest_Created",
|
|
940
|
+
* "url": "https://my-partner-service.api.com",
|
|
941
|
+
* "httpMethod": "POST",
|
|
942
|
+
* "enabled": true,
|
|
943
|
+
* "auth": {
|
|
944
|
+
* "authType": "BASIC",
|
|
945
|
+
* "basicAuthConfig": {
|
|
946
|
+
* "username": "secretUsername",
|
|
947
|
+
* "password": "secret7825@!"
|
|
948
|
+
* }
|
|
949
|
+
* },
|
|
950
|
+
* "filter": {
|
|
951
|
+
* "keyToFilter": "customer_request.productId",
|
|
952
|
+
* "supportedValues": [
|
|
953
|
+
* "2324245",
|
|
954
|
+
* "5253642"
|
|
955
|
+
* ]
|
|
956
|
+
* }
|
|
957
|
+
* }
|
|
958
|
+
*/
|
|
959
|
+
Components.Schemas.WebhookConfig;
|
|
960
|
+
namespace Responses {
|
|
961
|
+
export type $200 = /**
|
|
962
|
+
* example:
|
|
963
|
+
* {
|
|
964
|
+
* "eventName": "CustomerRequest_Created",
|
|
965
|
+
* "url": "https://my-partner-service.api.com",
|
|
966
|
+
* "httpMethod": "POST",
|
|
967
|
+
* "enabled": true,
|
|
968
|
+
* "auth": {
|
|
969
|
+
* "authType": "BASIC",
|
|
970
|
+
* "basicAuthConfig": {
|
|
971
|
+
* "username": "secretUsername",
|
|
972
|
+
* "password": "secret7825@!"
|
|
973
|
+
* }
|
|
974
|
+
* },
|
|
975
|
+
* "filter": {
|
|
976
|
+
* "keyToFilter": "customer_request.productId",
|
|
977
|
+
* "supportedValues": [
|
|
978
|
+
* "2324245",
|
|
979
|
+
* "5253642"
|
|
980
|
+
* ]
|
|
981
|
+
* }
|
|
982
|
+
* }
|
|
983
|
+
*/
|
|
984
|
+
Components.Schemas.WebhookConfig;
|
|
985
|
+
export type $400 = Components.Schemas.ErrorResp;
|
|
986
|
+
export type $401 = Components.Schemas.ErrorResp;
|
|
987
|
+
export type $500 = Components.Schemas.ErrorResp;
|
|
988
|
+
}
|
|
989
|
+
}
|
|
990
|
+
}
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
interface OperationMethods {
|
|
994
|
+
/**
|
|
995
|
+
* getPublicKey - getPublicKey
|
|
996
|
+
*
|
|
997
|
+
* Returns the platform-level Ed25519 public key used to verify
|
|
998
|
+
* asymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is required to ensure clients retrieve the correct key for their organization in case of key rotation.
|
|
999
|
+
*
|
|
1000
|
+
*/
|
|
1001
|
+
'getPublicKey'(
|
|
1002
|
+
parameters?: Parameters<Paths.GetPublicKey.QueryParameters> | null,
|
|
1003
|
+
data?: any,
|
|
1004
|
+
config?: AxiosRequestConfig
|
|
1005
|
+
): OperationResponse<Paths.GetPublicKey.Responses.$200>
|
|
1006
|
+
/**
|
|
1007
|
+
* getConfiguredEvents - getConfiguredEvents
|
|
1008
|
+
*
|
|
1009
|
+
* Retrieve events that can trigger webhooks
|
|
1010
|
+
*/
|
|
1011
|
+
'getConfiguredEvents'(
|
|
1012
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1013
|
+
data?: any,
|
|
1014
|
+
config?: AxiosRequestConfig
|
|
1015
|
+
): OperationResponse<Paths.GetConfiguredEvents.Responses.$200>
|
|
1016
|
+
/**
|
|
1017
|
+
* getConfigs - getConfigs
|
|
1018
|
+
*
|
|
1019
|
+
* Search Webhook Client Configs
|
|
1020
|
+
*/
|
|
1021
|
+
'getConfigs'(
|
|
1022
|
+
parameters?: Parameters<Paths.GetConfigs.QueryParameters> | null,
|
|
1023
|
+
data?: any,
|
|
1024
|
+
config?: AxiosRequestConfig
|
|
1025
|
+
): OperationResponse<Paths.GetConfigs.Responses.$200>
|
|
1026
|
+
/**
|
|
1027
|
+
* createConfig - createConfig
|
|
1028
|
+
*
|
|
1029
|
+
* Create Webhook Client Config
|
|
1030
|
+
*/
|
|
1031
|
+
'createConfig'(
|
|
1032
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1033
|
+
data?: Paths.CreateConfig.RequestBody,
|
|
1034
|
+
config?: AxiosRequestConfig
|
|
1035
|
+
): OperationResponse<Paths.CreateConfig.Responses.$201>
|
|
1036
|
+
/**
|
|
1037
|
+
* getConfig - getConfig
|
|
1038
|
+
*
|
|
1039
|
+
* Get webhook config by id
|
|
1040
|
+
*/
|
|
1041
|
+
'getConfig'(
|
|
1042
|
+
parameters?: Parameters<Paths.GetConfig.PathParameters> | null,
|
|
1043
|
+
data?: any,
|
|
1044
|
+
config?: AxiosRequestConfig
|
|
1045
|
+
): OperationResponse<Paths.GetConfig.Responses.$200>
|
|
1046
|
+
/**
|
|
1047
|
+
* updateConfig - updateConfig
|
|
1048
|
+
*
|
|
1049
|
+
* Update Webhook Client Config
|
|
1050
|
+
*/
|
|
1051
|
+
'updateConfig'(
|
|
1052
|
+
parameters?: Parameters<Paths.UpdateConfig.PathParameters> | null,
|
|
1053
|
+
data?: Paths.UpdateConfig.RequestBody,
|
|
1054
|
+
config?: AxiosRequestConfig
|
|
1055
|
+
): OperationResponse<Paths.UpdateConfig.Responses.$200>
|
|
1056
|
+
/**
|
|
1057
|
+
* deleteConfig - deleteConfig
|
|
1058
|
+
*
|
|
1059
|
+
* Delete Webhook Client Config
|
|
1060
|
+
*/
|
|
1061
|
+
'deleteConfig'(
|
|
1062
|
+
parameters?: Parameters<Paths.DeleteConfig.PathParameters> | null,
|
|
1063
|
+
data?: any,
|
|
1064
|
+
config?: AxiosRequestConfig
|
|
1065
|
+
): OperationResponse<Paths.DeleteConfig.Responses.$204>
|
|
1066
|
+
/**
|
|
1067
|
+
* testOAuth - Test OAuth connection
|
|
1068
|
+
*
|
|
1069
|
+
* Tests the OAuth client credentials configuration for a saved webhook by attempting
|
|
1070
|
+
* a token exchange against the configured OAuth endpoint. Returns success with token
|
|
1071
|
+
* metadata (e.g. expires_in, token_type) or an error describing why the exchange failed.
|
|
1072
|
+
* Does not send the actual webhook.
|
|
1073
|
+
*
|
|
1074
|
+
*/
|
|
1075
|
+
'testOAuth'(
|
|
1076
|
+
parameters?: Parameters<Paths.TestOAuth.PathParameters> | null,
|
|
1077
|
+
data?: any,
|
|
1078
|
+
config?: AxiosRequestConfig
|
|
1079
|
+
): OperationResponse<Paths.TestOAuth.Responses.$200>
|
|
1080
|
+
/**
|
|
1081
|
+
* triggerWebhook - triggers a webhook event either async or sync
|
|
1082
|
+
*
|
|
1083
|
+
* Trigger a webhook
|
|
1084
|
+
*/
|
|
1085
|
+
'triggerWebhook'(
|
|
1086
|
+
parameters?: Parameters<Paths.TriggerWebhook.QueryParameters & Paths.TriggerWebhook.PathParameters> | null,
|
|
1087
|
+
data?: Paths.TriggerWebhook.RequestBody,
|
|
1088
|
+
config?: AxiosRequestConfig
|
|
1089
|
+
): OperationResponse<Paths.TriggerWebhook.Responses.$200>
|
|
1090
|
+
/**
|
|
1091
|
+
* getWehookEvents - getWehookEvents
|
|
1092
|
+
*
|
|
1093
|
+
* This endpoint is deprecated and will be removed on 2025-12-31. Use /v2/webhooks/configs/{configId}/events instead.
|
|
1094
|
+
*/
|
|
1095
|
+
'getWehookEvents'(
|
|
1096
|
+
parameters?: Parameters<Paths.GetWehookEvents.QueryParameters & Paths.GetWehookEvents.PathParameters> | null,
|
|
1097
|
+
data?: any,
|
|
1098
|
+
config?: AxiosRequestConfig
|
|
1099
|
+
): OperationResponse<Paths.GetWehookEvents.Responses.$200>
|
|
1100
|
+
/**
|
|
1101
|
+
* batchReplayEvents - batchReplayEvents
|
|
1102
|
+
*
|
|
1103
|
+
* Replay a batch of webhook events
|
|
1104
|
+
*/
|
|
1105
|
+
'batchReplayEvents'(
|
|
1106
|
+
parameters?: Parameters<Paths.BatchReplayEvents.PathParameters> | null,
|
|
1107
|
+
data?: Paths.BatchReplayEvents.RequestBody,
|
|
1108
|
+
config?: AxiosRequestConfig
|
|
1109
|
+
): OperationResponse<Paths.BatchReplayEvents.Responses.$202>
|
|
1110
|
+
/**
|
|
1111
|
+
* getEventById - getEventById
|
|
1112
|
+
*
|
|
1113
|
+
* Get a webhook event by its id
|
|
1114
|
+
*/
|
|
1115
|
+
'getEventById'(
|
|
1116
|
+
parameters?: Parameters<Paths.GetEventById.PathParameters> | null,
|
|
1117
|
+
data?: any,
|
|
1118
|
+
config?: AxiosRequestConfig
|
|
1119
|
+
): OperationResponse<Paths.GetEventById.Responses.$200>
|
|
1120
|
+
/**
|
|
1121
|
+
* replayEvent - replayEvent
|
|
1122
|
+
*
|
|
1123
|
+
* Replay a webhook event
|
|
1124
|
+
*/
|
|
1125
|
+
'replayEvent'(
|
|
1126
|
+
parameters?: Parameters<Paths.ReplayEvent.PathParameters> | null,
|
|
1127
|
+
data?: any,
|
|
1128
|
+
config?: AxiosRequestConfig
|
|
1129
|
+
): OperationResponse<Paths.ReplayEvent.Responses.$204>
|
|
1130
|
+
/**
|
|
1131
|
+
* getWebhookExample - getWebhookExample
|
|
1132
|
+
*
|
|
1133
|
+
* Generate an example payload for a webhook configuration based on trigger type
|
|
1134
|
+
*/
|
|
1135
|
+
'getWebhookExample'(
|
|
1136
|
+
parameters?: Parameters<Paths.GetWebhookExample.PathParameters> | null,
|
|
1137
|
+
data?: Paths.GetWebhookExample.RequestBody,
|
|
1138
|
+
config?: AxiosRequestConfig
|
|
1139
|
+
): OperationResponse<Paths.GetWebhookExample.Responses.$200>
|
|
1140
|
+
/**
|
|
1141
|
+
* getWebhookEventsV2 - getWebhookEventsV2
|
|
1142
|
+
*
|
|
1143
|
+
* List webhook events and filter them by status, timestamp, etc.
|
|
1144
|
+
*/
|
|
1145
|
+
'getWebhookEventsV2'(
|
|
1146
|
+
parameters?: Parameters<Paths.GetWebhookEventsV2.PathParameters> | null,
|
|
1147
|
+
data?: Paths.GetWebhookEventsV2.RequestBody,
|
|
1148
|
+
config?: AxiosRequestConfig
|
|
1149
|
+
): OperationResponse<Paths.GetWebhookEventsV2.Responses.$200>
|
|
1150
|
+
}
|
|
1151
|
+
|
|
1152
|
+
interface PathsDictionary {
|
|
1153
|
+
['/v1/webhooks/.well-known/public-key']: {
|
|
1154
|
+
/**
|
|
1155
|
+
* getPublicKey - getPublicKey
|
|
1156
|
+
*
|
|
1157
|
+
* Returns the platform-level Ed25519 public key used to verify
|
|
1158
|
+
* asymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is required to ensure clients retrieve the correct key for their organization in case of key rotation.
|
|
1159
|
+
*
|
|
1160
|
+
*/
|
|
1161
|
+
'get'(
|
|
1162
|
+
parameters?: Parameters<Paths.GetPublicKey.QueryParameters> | null,
|
|
1163
|
+
data?: any,
|
|
1164
|
+
config?: AxiosRequestConfig
|
|
1165
|
+
): OperationResponse<Paths.GetPublicKey.Responses.$200>
|
|
1166
|
+
}
|
|
1167
|
+
['/v1/webhooks/configured-events']: {
|
|
1168
|
+
/**
|
|
1169
|
+
* getConfiguredEvents - getConfiguredEvents
|
|
1170
|
+
*
|
|
1171
|
+
* Retrieve events that can trigger webhooks
|
|
1172
|
+
*/
|
|
1173
|
+
'get'(
|
|
1174
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1175
|
+
data?: any,
|
|
1176
|
+
config?: AxiosRequestConfig
|
|
1177
|
+
): OperationResponse<Paths.GetConfiguredEvents.Responses.$200>
|
|
1178
|
+
}
|
|
1179
|
+
['/v1/webhooks/configs']: {
|
|
1180
|
+
/**
|
|
1181
|
+
* getConfigs - getConfigs
|
|
1182
|
+
*
|
|
1183
|
+
* Search Webhook Client Configs
|
|
1184
|
+
*/
|
|
1185
|
+
'get'(
|
|
1186
|
+
parameters?: Parameters<Paths.GetConfigs.QueryParameters> | null,
|
|
1187
|
+
data?: any,
|
|
1188
|
+
config?: AxiosRequestConfig
|
|
1189
|
+
): OperationResponse<Paths.GetConfigs.Responses.$200>
|
|
1190
|
+
/**
|
|
1191
|
+
* createConfig - createConfig
|
|
1192
|
+
*
|
|
1193
|
+
* Create Webhook Client Config
|
|
1194
|
+
*/
|
|
1195
|
+
'post'(
|
|
1196
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1197
|
+
data?: Paths.CreateConfig.RequestBody,
|
|
1198
|
+
config?: AxiosRequestConfig
|
|
1199
|
+
): OperationResponse<Paths.CreateConfig.Responses.$201>
|
|
1200
|
+
}
|
|
1201
|
+
['/v1/webhooks/configs/{configId}']: {
|
|
1202
|
+
/**
|
|
1203
|
+
* getConfig - getConfig
|
|
1204
|
+
*
|
|
1205
|
+
* Get webhook config by id
|
|
1206
|
+
*/
|
|
1207
|
+
'get'(
|
|
1208
|
+
parameters?: Parameters<Paths.GetConfig.PathParameters> | null,
|
|
1209
|
+
data?: any,
|
|
1210
|
+
config?: AxiosRequestConfig
|
|
1211
|
+
): OperationResponse<Paths.GetConfig.Responses.$200>
|
|
1212
|
+
/**
|
|
1213
|
+
* updateConfig - updateConfig
|
|
1214
|
+
*
|
|
1215
|
+
* Update Webhook Client Config
|
|
1216
|
+
*/
|
|
1217
|
+
'put'(
|
|
1218
|
+
parameters?: Parameters<Paths.UpdateConfig.PathParameters> | null,
|
|
1219
|
+
data?: Paths.UpdateConfig.RequestBody,
|
|
1220
|
+
config?: AxiosRequestConfig
|
|
1221
|
+
): OperationResponse<Paths.UpdateConfig.Responses.$200>
|
|
1222
|
+
/**
|
|
1223
|
+
* deleteConfig - deleteConfig
|
|
1224
|
+
*
|
|
1225
|
+
* Delete Webhook Client Config
|
|
1226
|
+
*/
|
|
1227
|
+
'delete'(
|
|
1228
|
+
parameters?: Parameters<Paths.DeleteConfig.PathParameters> | null,
|
|
1229
|
+
data?: any,
|
|
1230
|
+
config?: AxiosRequestConfig
|
|
1231
|
+
): OperationResponse<Paths.DeleteConfig.Responses.$204>
|
|
1232
|
+
}
|
|
1233
|
+
['/v1/webhooks/configs/{configId}/test-oauth']: {
|
|
1234
|
+
/**
|
|
1235
|
+
* testOAuth - Test OAuth connection
|
|
1236
|
+
*
|
|
1237
|
+
* Tests the OAuth client credentials configuration for a saved webhook by attempting
|
|
1238
|
+
* a token exchange against the configured OAuth endpoint. Returns success with token
|
|
1239
|
+
* metadata (e.g. expires_in, token_type) or an error describing why the exchange failed.
|
|
1240
|
+
* Does not send the actual webhook.
|
|
1241
|
+
*
|
|
1242
|
+
*/
|
|
1243
|
+
'post'(
|
|
1244
|
+
parameters?: Parameters<Paths.TestOAuth.PathParameters> | null,
|
|
1245
|
+
data?: any,
|
|
1246
|
+
config?: AxiosRequestConfig
|
|
1247
|
+
): OperationResponse<Paths.TestOAuth.Responses.$200>
|
|
1248
|
+
}
|
|
1249
|
+
['/v1/webhooks/configs/{configId}/trigger']: {
|
|
1250
|
+
/**
|
|
1251
|
+
* triggerWebhook - triggers a webhook event either async or sync
|
|
1252
|
+
*
|
|
1253
|
+
* Trigger a webhook
|
|
1254
|
+
*/
|
|
1255
|
+
'post'(
|
|
1256
|
+
parameters?: Parameters<Paths.TriggerWebhook.QueryParameters & Paths.TriggerWebhook.PathParameters> | null,
|
|
1257
|
+
data?: Paths.TriggerWebhook.RequestBody,
|
|
1258
|
+
config?: AxiosRequestConfig
|
|
1259
|
+
): OperationResponse<Paths.TriggerWebhook.Responses.$200>
|
|
1260
|
+
}
|
|
1261
|
+
['/v1/webhooks/configs/{configId}/events']: {
|
|
1262
|
+
/**
|
|
1263
|
+
* getWehookEvents - getWehookEvents
|
|
1264
|
+
*
|
|
1265
|
+
* This endpoint is deprecated and will be removed on 2025-12-31. Use /v2/webhooks/configs/{configId}/events instead.
|
|
1266
|
+
*/
|
|
1267
|
+
'get'(
|
|
1268
|
+
parameters?: Parameters<Paths.GetWehookEvents.QueryParameters & Paths.GetWehookEvents.PathParameters> | null,
|
|
1269
|
+
data?: any,
|
|
1270
|
+
config?: AxiosRequestConfig
|
|
1271
|
+
): OperationResponse<Paths.GetWehookEvents.Responses.$200>
|
|
1272
|
+
}
|
|
1273
|
+
['/v1/webhooks/configs/{configId}/events/replay-batch']: {
|
|
1274
|
+
/**
|
|
1275
|
+
* batchReplayEvents - batchReplayEvents
|
|
1276
|
+
*
|
|
1277
|
+
* Replay a batch of webhook events
|
|
1278
|
+
*/
|
|
1279
|
+
'post'(
|
|
1280
|
+
parameters?: Parameters<Paths.BatchReplayEvents.PathParameters> | null,
|
|
1281
|
+
data?: Paths.BatchReplayEvents.RequestBody,
|
|
1282
|
+
config?: AxiosRequestConfig
|
|
1283
|
+
): OperationResponse<Paths.BatchReplayEvents.Responses.$202>
|
|
1284
|
+
}
|
|
1285
|
+
['/v1/webhooks/configs/{configId}/events/{eventId}']: {
|
|
1286
|
+
/**
|
|
1287
|
+
* getEventById - getEventById
|
|
1288
|
+
*
|
|
1289
|
+
* Get a webhook event by its id
|
|
1290
|
+
*/
|
|
1291
|
+
'get'(
|
|
1292
|
+
parameters?: Parameters<Paths.GetEventById.PathParameters> | null,
|
|
1293
|
+
data?: any,
|
|
1294
|
+
config?: AxiosRequestConfig
|
|
1295
|
+
): OperationResponse<Paths.GetEventById.Responses.$200>
|
|
1296
|
+
}
|
|
1297
|
+
['/v1/webhooks/configs/{configId}/events/{eventId}/replay']: {
|
|
1298
|
+
/**
|
|
1299
|
+
* replayEvent - replayEvent
|
|
1300
|
+
*
|
|
1301
|
+
* Replay a webhook event
|
|
1302
|
+
*/
|
|
1303
|
+
'post'(
|
|
1304
|
+
parameters?: Parameters<Paths.ReplayEvent.PathParameters> | null,
|
|
1305
|
+
data?: any,
|
|
1306
|
+
config?: AxiosRequestConfig
|
|
1307
|
+
): OperationResponse<Paths.ReplayEvent.Responses.$204>
|
|
1308
|
+
}
|
|
1309
|
+
['/v1/webhooks/configs/{configId}/example']: {
|
|
1310
|
+
/**
|
|
1311
|
+
* getWebhookExample - getWebhookExample
|
|
1312
|
+
*
|
|
1313
|
+
* Generate an example payload for a webhook configuration based on trigger type
|
|
1314
|
+
*/
|
|
1315
|
+
'post'(
|
|
1316
|
+
parameters?: Parameters<Paths.GetWebhookExample.PathParameters> | null,
|
|
1317
|
+
data?: Paths.GetWebhookExample.RequestBody,
|
|
1318
|
+
config?: AxiosRequestConfig
|
|
1319
|
+
): OperationResponse<Paths.GetWebhookExample.Responses.$200>
|
|
1320
|
+
}
|
|
1321
|
+
['/v2/webhooks/configs/{configId}/events']: {
|
|
1322
|
+
/**
|
|
1323
|
+
* getWebhookEventsV2 - getWebhookEventsV2
|
|
1324
|
+
*
|
|
1325
|
+
* List webhook events and filter them by status, timestamp, etc.
|
|
1326
|
+
*/
|
|
1327
|
+
'post'(
|
|
1328
|
+
parameters?: Parameters<Paths.GetWebhookEventsV2.PathParameters> | null,
|
|
1329
|
+
data?: Paths.GetWebhookEventsV2.RequestBody,
|
|
1330
|
+
config?: AxiosRequestConfig
|
|
1331
|
+
): OperationResponse<Paths.GetWebhookEventsV2.Responses.$200>
|
|
1332
|
+
}
|
|
1333
|
+
}
|
|
1334
|
+
|
|
1335
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
type ApiKeyConfig = Components.Schemas.ApiKeyConfig;
|
|
1339
|
+
type Auth = Components.Schemas.Auth;
|
|
1340
|
+
type AuthType = Components.Schemas.AuthType;
|
|
1341
|
+
type BasicAuthConfig = Components.Schemas.BasicAuthConfig;
|
|
1342
|
+
type BatchReplayRequest = Components.Schemas.BatchReplayRequest;
|
|
1343
|
+
type CustomHeader = Components.Schemas.CustomHeader;
|
|
1344
|
+
type CustomOAuthParameter = Components.Schemas.CustomOAuthParameter;
|
|
1345
|
+
type ErrorResp = Components.Schemas.ErrorResp;
|
|
1346
|
+
type EventConfigEntry = Components.Schemas.EventConfigEntry;
|
|
1347
|
+
type EventConfigResp = Components.Schemas.EventConfigResp;
|
|
1348
|
+
type EventListResponse = Components.Schemas.EventListResponse;
|
|
1349
|
+
type ExampleRequest = Components.Schemas.ExampleRequest;
|
|
1350
|
+
type ExampleResponse = Components.Schemas.ExampleResponse;
|
|
1351
|
+
type ExecutionPayload = Components.Schemas.ExecutionPayload;
|
|
1352
|
+
type Filter = Components.Schemas.Filter;
|
|
1353
|
+
type HttpMethod = Components.Schemas.HttpMethod;
|
|
1354
|
+
type Metadata = Components.Schemas.Metadata;
|
|
1355
|
+
type OAuthConfig = Components.Schemas.OAuthConfig;
|
|
1356
|
+
type PayloadConfiguration = Components.Schemas.PayloadConfiguration;
|
|
1357
|
+
type PublicKeyResponse = Components.Schemas.PublicKeyResponse;
|
|
1358
|
+
type SearchOptions = Components.Schemas.SearchOptions;
|
|
1359
|
+
type TestOAuthResponse = Components.Schemas.TestOAuthResponse;
|
|
1360
|
+
type TriggerWebhookResp = Components.Schemas.TriggerWebhookResp;
|
|
1361
|
+
type WebhookCondition = Components.Schemas.WebhookCondition;
|
|
1362
|
+
type WebhookConditionGroup = Components.Schemas.WebhookConditionGroup;
|
|
1363
|
+
type WebhookConfig = Components.Schemas.WebhookConfig;
|
|
1364
|
+
type WebhookEvent = Components.Schemas.WebhookEvent;
|
|
1365
|
+
|
|
1366
|
+
export { type ApiKeyConfig as A, type BasicAuthConfig as B, type Client as C, type ErrorResp as E, type Filter as F, type HttpMethod as H, type Metadata as M, type OperationMethods as O, Paths as P, type SearchOptions as S, type TestOAuthResponse as T, type WebhookCondition as W, Components as a, type PathsDictionary as b, type Auth as c, type AuthType as d, type BatchReplayRequest as e, type CustomHeader as f, type CustomOAuthParameter as g, type EventConfigEntry as h, type EventConfigResp as i, type EventListResponse as j, type ExampleRequest as k, type ExampleResponse as l, type ExecutionPayload as m, type OAuthConfig as n, type PayloadConfiguration as o, type PublicKeyResponse as p, type TriggerWebhookResp as q, type WebhookConditionGroup as r, type WebhookConfig as s, type WebhookEvent as t };
|