@epilot/sdk 2.0.0-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 +294 -0
- package/dist/access-token-MYDOBCIY.cjs +89 -0
- package/dist/access-token-Y5JR7PRG.js +89 -0
- package/dist/access-token.d-C2qnueDV.d.cts +553 -0
- package/dist/access-token.d-C2qnueDV.d.ts +553 -0
- package/dist/address-3RQRG3MK.js +84 -0
- package/dist/address-LQUTDOUA.cjs +84 -0
- package/dist/address-suggestions-PEKSA7B2.cjs +132 -0
- package/dist/address-suggestions-QNK5JWNH.js +132 -0
- package/dist/address-suggestions.d-CewXYNYH.d.cts +340 -0
- package/dist/address-suggestions.d-CewXYNYH.d.ts +340 -0
- package/dist/address.d-DP_aE2ex.d.cts +438 -0
- package/dist/address.d-DP_aE2ex.d.ts +438 -0
- package/dist/ai-agents-MO4PK2RJ.cjs +215 -0
- package/dist/ai-agents-OHP2F243.js +215 -0
- package/dist/ai-agents.d-vG-1utqk.d.cts +1340 -0
- package/dist/ai-agents.d-vG-1utqk.d.ts +1340 -0
- package/dist/apis/access-token.cjs +33 -0
- package/dist/apis/access-token.d.cts +18 -0
- package/dist/apis/access-token.d.ts +18 -0
- package/dist/apis/access-token.js +33 -0
- package/dist/apis/address-suggestions.cjs +33 -0
- package/dist/apis/address-suggestions.d.cts +18 -0
- package/dist/apis/address-suggestions.d.ts +18 -0
- package/dist/apis/address-suggestions.js +33 -0
- package/dist/apis/address.cjs +33 -0
- package/dist/apis/address.d.cts +18 -0
- package/dist/apis/address.d.ts +18 -0
- package/dist/apis/address.js +33 -0
- package/dist/apis/ai-agents.cjs +33 -0
- package/dist/apis/ai-agents.d.cts +18 -0
- package/dist/apis/ai-agents.d.ts +18 -0
- package/dist/apis/ai-agents.js +33 -0
- package/dist/apis/app.cjs +33 -0
- package/dist/apis/app.d.cts +18 -0
- package/dist/apis/app.d.ts +18 -0
- package/dist/apis/app.js +33 -0
- package/dist/apis/audit-logs.cjs +33 -0
- package/dist/apis/audit-logs.d.cts +18 -0
- package/dist/apis/audit-logs.d.ts +18 -0
- package/dist/apis/audit-logs.js +33 -0
- package/dist/apis/automation.cjs +33 -0
- package/dist/apis/automation.d.cts +18 -0
- package/dist/apis/automation.d.ts +18 -0
- package/dist/apis/automation.js +33 -0
- package/dist/apis/billing.cjs +33 -0
- package/dist/apis/billing.d.cts +18 -0
- package/dist/apis/billing.d.ts +18 -0
- package/dist/apis/billing.js +33 -0
- package/dist/apis/blueprint-manifest.cjs +33 -0
- package/dist/apis/blueprint-manifest.d.cts +18 -0
- package/dist/apis/blueprint-manifest.d.ts +18 -0
- package/dist/apis/blueprint-manifest.js +33 -0
- package/dist/apis/consent.cjs +33 -0
- package/dist/apis/consent.d.cts +18 -0
- package/dist/apis/consent.d.ts +18 -0
- package/dist/apis/consent.js +33 -0
- package/dist/apis/customer-portal.cjs +33 -0
- package/dist/apis/customer-portal.d.cts +18 -0
- package/dist/apis/customer-portal.d.ts +18 -0
- package/dist/apis/customer-portal.js +33 -0
- package/dist/apis/data-management.cjs +33 -0
- package/dist/apis/data-management.d.cts +18 -0
- package/dist/apis/data-management.d.ts +18 -0
- package/dist/apis/data-management.js +33 -0
- package/dist/apis/deduplication.cjs +33 -0
- package/dist/apis/deduplication.d.cts +18 -0
- package/dist/apis/deduplication.d.ts +18 -0
- package/dist/apis/deduplication.js +33 -0
- package/dist/apis/design.cjs +33 -0
- package/dist/apis/design.d.cts +18 -0
- package/dist/apis/design.d.ts +18 -0
- package/dist/apis/design.js +33 -0
- package/dist/apis/discussion.cjs +33 -0
- package/dist/apis/discussion.d.cts +18 -0
- package/dist/apis/discussion.d.ts +18 -0
- package/dist/apis/discussion.js +33 -0
- package/dist/apis/document.cjs +33 -0
- package/dist/apis/document.d.cts +18 -0
- package/dist/apis/document.d.ts +18 -0
- package/dist/apis/document.js +33 -0
- package/dist/apis/email-settings.cjs +33 -0
- package/dist/apis/email-settings.d.cts +18 -0
- package/dist/apis/email-settings.d.ts +18 -0
- package/dist/apis/email-settings.js +33 -0
- package/dist/apis/email-template.cjs +33 -0
- package/dist/apis/email-template.d.cts +18 -0
- package/dist/apis/email-template.d.ts +18 -0
- package/dist/apis/email-template.js +33 -0
- package/dist/apis/entity-mapping.cjs +33 -0
- package/dist/apis/entity-mapping.d.cts +18 -0
- package/dist/apis/entity-mapping.d.ts +18 -0
- package/dist/apis/entity-mapping.js +33 -0
- package/dist/apis/entity.cjs +33 -0
- package/dist/apis/entity.d.cts +18 -0
- package/dist/apis/entity.d.ts +18 -0
- package/dist/apis/entity.js +33 -0
- package/dist/apis/environments.cjs +33 -0
- package/dist/apis/environments.d.cts +18 -0
- package/dist/apis/environments.d.ts +18 -0
- package/dist/apis/environments.js +33 -0
- package/dist/apis/erp-integration.cjs +33 -0
- package/dist/apis/erp-integration.d.cts +18 -0
- package/dist/apis/erp-integration.d.ts +18 -0
- package/dist/apis/erp-integration.js +33 -0
- package/dist/apis/event-catalog.cjs +33 -0
- package/dist/apis/event-catalog.d.cts +18 -0
- package/dist/apis/event-catalog.d.ts +18 -0
- package/dist/apis/event-catalog.js +33 -0
- package/dist/apis/file.cjs +33 -0
- package/dist/apis/file.d.cts +18 -0
- package/dist/apis/file.d.ts +18 -0
- package/dist/apis/file.js +33 -0
- package/dist/apis/iban.cjs +33 -0
- package/dist/apis/iban.d.cts +18 -0
- package/dist/apis/iban.d.ts +18 -0
- package/dist/apis/iban.js +33 -0
- package/dist/apis/journey.cjs +33 -0
- package/dist/apis/journey.d.cts +18 -0
- package/dist/apis/journey.d.ts +18 -0
- package/dist/apis/journey.js +33 -0
- package/dist/apis/kanban.cjs +33 -0
- package/dist/apis/kanban.d.cts +18 -0
- package/dist/apis/kanban.d.ts +18 -0
- package/dist/apis/kanban.js +33 -0
- package/dist/apis/message.cjs +33 -0
- package/dist/apis/message.d.cts +18 -0
- package/dist/apis/message.d.ts +18 -0
- package/dist/apis/message.js +33 -0
- package/dist/apis/metering.cjs +33 -0
- package/dist/apis/metering.d.cts +18 -0
- package/dist/apis/metering.d.ts +18 -0
- package/dist/apis/metering.js +33 -0
- package/dist/apis/notes.cjs +33 -0
- package/dist/apis/notes.d.cts +18 -0
- package/dist/apis/notes.d.ts +18 -0
- package/dist/apis/notes.js +33 -0
- package/dist/apis/notification.cjs +33 -0
- package/dist/apis/notification.d.cts +18 -0
- package/dist/apis/notification.d.ts +18 -0
- package/dist/apis/notification.js +33 -0
- package/dist/apis/organization.cjs +33 -0
- package/dist/apis/organization.d.cts +18 -0
- package/dist/apis/organization.d.ts +18 -0
- package/dist/apis/organization.js +33 -0
- package/dist/apis/partner-directory.cjs +33 -0
- package/dist/apis/partner-directory.d.cts +18 -0
- package/dist/apis/partner-directory.d.ts +18 -0
- package/dist/apis/partner-directory.js +33 -0
- package/dist/apis/permissions.cjs +33 -0
- package/dist/apis/permissions.d.cts +18 -0
- package/dist/apis/permissions.d.ts +18 -0
- package/dist/apis/permissions.js +33 -0
- package/dist/apis/pricing-tier.cjs +33 -0
- package/dist/apis/pricing-tier.d.cts +18 -0
- package/dist/apis/pricing-tier.d.ts +18 -0
- package/dist/apis/pricing-tier.js +33 -0
- package/dist/apis/pricing.cjs +33 -0
- package/dist/apis/pricing.d.cts +18 -0
- package/dist/apis/pricing.d.ts +18 -0
- package/dist/apis/pricing.js +33 -0
- package/dist/apis/purpose.cjs +33 -0
- package/dist/apis/purpose.d.cts +18 -0
- package/dist/apis/purpose.d.ts +18 -0
- package/dist/apis/purpose.js +33 -0
- package/dist/apis/sandbox.cjs +33 -0
- package/dist/apis/sandbox.d.cts +18 -0
- package/dist/apis/sandbox.d.ts +18 -0
- package/dist/apis/sandbox.js +33 -0
- package/dist/apis/submission.cjs +33 -0
- package/dist/apis/submission.d.cts +18 -0
- package/dist/apis/submission.d.ts +18 -0
- package/dist/apis/submission.js +33 -0
- package/dist/apis/targeting.cjs +33 -0
- package/dist/apis/targeting.d.cts +18 -0
- package/dist/apis/targeting.d.ts +18 -0
- package/dist/apis/targeting.js +33 -0
- package/dist/apis/template-variables.cjs +33 -0
- package/dist/apis/template-variables.d.cts +18 -0
- package/dist/apis/template-variables.d.ts +18 -0
- package/dist/apis/template-variables.js +33 -0
- package/dist/apis/user.cjs +33 -0
- package/dist/apis/user.d.cts +18 -0
- package/dist/apis/user.d.ts +18 -0
- package/dist/apis/user.js +33 -0
- package/dist/apis/validation-rules.cjs +33 -0
- package/dist/apis/validation-rules.d.cts +18 -0
- package/dist/apis/validation-rules.d.ts +18 -0
- package/dist/apis/validation-rules.js +33 -0
- package/dist/apis/webhooks.cjs +33 -0
- package/dist/apis/webhooks.d.cts +18 -0
- package/dist/apis/webhooks.d.ts +18 -0
- package/dist/apis/webhooks.js +33 -0
- package/dist/apis/workflow-definition.cjs +33 -0
- package/dist/apis/workflow-definition.d.cts +18 -0
- package/dist/apis/workflow-definition.d.ts +18 -0
- package/dist/apis/workflow-definition.js +33 -0
- package/dist/apis/workflow.cjs +33 -0
- package/dist/apis/workflow.d.cts +18 -0
- package/dist/apis/workflow.d.ts +18 -0
- package/dist/apis/workflow.js +33 -0
- package/dist/app-UUTBO3WJ.js +573 -0
- package/dist/app-XJGY6SHO.cjs +573 -0
- package/dist/app.d-Uncn387s.d.cts +3370 -0
- package/dist/app.d-Uncn387s.d.ts +3370 -0
- package/dist/audit-logs-4IJYIOXF.js +55 -0
- package/dist/audit-logs-UWLCPBB4.cjs +55 -0
- package/dist/audit-logs.d-BxZqONu5.d.cts +288 -0
- package/dist/audit-logs.d-BxZqONu5.d.ts +288 -0
- package/dist/automation-4UQADTDO.cjs +282 -0
- package/dist/automation-PVXTQLZX.js +282 -0
- package/dist/automation.d-BteCzeFn.d.cts +4921 -0
- package/dist/automation.d-BteCzeFn.d.ts +4921 -0
- package/dist/billing-FI4V4UX5.cjs +175 -0
- package/dist/billing-OMWNJHGW.js +175 -0
- package/dist/billing.d-BH4__05Y.d.cts +994 -0
- package/dist/billing.d-BH4__05Y.d.ts +994 -0
- package/dist/bin/cli.js +135 -0
- package/dist/blueprint-manifest-CPQAL76N.cjs +504 -0
- package/dist/blueprint-manifest-FIMGDHSH.js +504 -0
- package/dist/blueprint-manifest.d-CU4v09fj.d.cts +3327 -0
- package/dist/blueprint-manifest.d-CU4v09fj.d.ts +3327 -0
- package/dist/chunk-3RG5ZIWI.js +10 -0
- package/dist/chunk-OBGZSXTJ.cjs +10 -0
- package/dist/chunk-UJTFRZMS.js +65 -0
- package/dist/chunk-YLLKMXS3.cjs +65 -0
- package/dist/consent-NHDCDJMK.js +84 -0
- package/dist/consent-R5GU3WCK.cjs +84 -0
- package/dist/consent.d-BETWwU_2.d.cts +266 -0
- package/dist/consent.d-BETWwU_2.d.ts +266 -0
- package/dist/customer-portal-6AV2W43T.cjs +2252 -0
- package/dist/customer-portal-EY57GJYV.js +2252 -0
- package/dist/customer-portal.d-Co_I6psR.d.cts +15255 -0
- package/dist/customer-portal.d-Co_I6psR.d.ts +15255 -0
- package/dist/data-management-ILQUYNTN.cjs +240 -0
- package/dist/data-management-QMXOLOEG.js +240 -0
- package/dist/data-management.d-CkR2E_Pm.d.cts +548 -0
- package/dist/data-management.d-CkR2E_Pm.d.ts +548 -0
- package/dist/deduplication-IVXANO7S.cjs +42 -0
- package/dist/deduplication-WN45DVK3.js +42 -0
- package/dist/deduplication.d-BlHnjhXk.d.cts +114 -0
- package/dist/deduplication.d-BlHnjhXk.d.ts +114 -0
- package/dist/design-ONRLY6XI.cjs +219 -0
- package/dist/design-UHMRO3PG.js +219 -0
- package/dist/design.d-JsNY_cGh.d.cts +834 -0
- package/dist/design.d-JsNY_cGh.d.ts +834 -0
- package/dist/discussion-4CZIG3ZM.cjs +134 -0
- package/dist/discussion-VWMWL2AF.js +134 -0
- package/dist/discussion.d-CxxaYKTf.d.cts +580 -0
- package/dist/discussion.d-CxxaYKTf.d.ts +580 -0
- package/dist/document-CN3JNXFF.js +78 -0
- package/dist/document-PCKNZA4K.cjs +78 -0
- package/dist/document.d-CZ_FGhEn.d.cts +649 -0
- package/dist/document.d-CZ_FGhEn.d.ts +649 -0
- package/dist/email-settings-ANURQMKZ.js +533 -0
- package/dist/email-settings-YE2XB2ZU.cjs +533 -0
- package/dist/email-settings.d-3eXYEyRr.d.cts +2278 -0
- package/dist/email-settings.d-3eXYEyRr.d.ts +2278 -0
- package/dist/email-template-4QI4YS4J.js +122 -0
- package/dist/email-template-BUJBC6HH.cjs +122 -0
- package/dist/email-template.d-C2L0dKqB.d.cts +1175 -0
- package/dist/email-template.d-C2L0dKqB.d.ts +1175 -0
- package/dist/entity-BCFE3UJT.cjs +1600 -0
- package/dist/entity-VEXNQC4Y.js +1600 -0
- package/dist/entity-mapping-PHRLSYP7.cjs +215 -0
- package/dist/entity-mapping-QK7MGNAW.js +215 -0
- package/dist/entity-mapping.d-B3Vyepok.d.cts +1093 -0
- package/dist/entity-mapping.d-B3Vyepok.d.ts +1093 -0
- package/dist/entity.d-DmER_7q5.d.cts +16018 -0
- package/dist/entity.d-DmER_7q5.d.ts +16018 -0
- package/dist/environments-266S44UM.cjs +71 -0
- package/dist/environments-AV7W6SLT.js +71 -0
- package/dist/environments.d-CpILpSNF.d.cts +254 -0
- package/dist/environments.d-CpILpSNF.d.ts +254 -0
- package/dist/erp-integration-5WNBCGWS.cjs +586 -0
- package/dist/erp-integration-EMI5WIWA.js +586 -0
- package/dist/erp-integration.d-DmxUZOUQ.d.cts +4120 -0
- package/dist/erp-integration.d-DmxUZOUQ.d.ts +4120 -0
- package/dist/event-catalog-DBWYKQ6J.cjs +130 -0
- package/dist/event-catalog-KKMXV5LB.js +130 -0
- package/dist/event-catalog.d-B2tq20gn.d.cts +1512 -0
- package/dist/event-catalog.d-B2tq20gn.d.ts +1512 -0
- package/dist/file-3ZLMS6TL.js +573 -0
- package/dist/file-Q66N5XMG.cjs +573 -0
- package/dist/file.d-Bi0EZkNu.d.cts +2993 -0
- package/dist/file.d-Bi0EZkNu.d.ts +2993 -0
- package/dist/iban-HSXVSIFW.cjs +43 -0
- package/dist/iban-Q27INTOC.js +43 -0
- package/dist/iban.d-DP7hl0Qt.d.cts +71 -0
- package/dist/iban.d-DP7hl0Qt.d.ts +71 -0
- package/dist/index.cjs +563 -0
- package/dist/index.d.cts +119 -0
- package/dist/index.d.ts +119 -0
- package/dist/index.js +563 -0
- package/dist/journey-DGKXVWZQ.js +270 -0
- package/dist/journey-T2Y72EBS.cjs +270 -0
- package/dist/journey.d-DxL16X6N.d.cts +1794 -0
- package/dist/journey.d-DxL16X6N.d.ts +1794 -0
- package/dist/kanban-A4B6RCJ2.cjs +164 -0
- package/dist/kanban-PP6WJVT2.js +164 -0
- package/dist/kanban.d-DDrBwr9h.d.cts +631 -0
- package/dist/kanban.d-DDrBwr9h.d.ts +631 -0
- package/dist/message-D6JY4GJH.cjs +673 -0
- package/dist/message-HFX2DDCV.js +673 -0
- package/dist/message.d-BeBH6vof.d.cts +3580 -0
- package/dist/message.d-BeBH6vof.d.ts +3580 -0
- package/dist/metering-63MJFCS2.cjs +399 -0
- package/dist/metering-F63PNFCZ.js +399 -0
- package/dist/metering.d-D5VR4tVa.d.cts +1842 -0
- package/dist/metering.d-D5VR4tVa.d.ts +1842 -0
- package/dist/notes-FTL5H4JE.cjs +219 -0
- package/dist/notes-GMWTQCMB.js +219 -0
- package/dist/notes.d-DZYeVo0I.d.cts +1047 -0
- package/dist/notes.d-DZYeVo0I.d.ts +1047 -0
- package/dist/notification-WXFSOORN.cjs +237 -0
- package/dist/notification-XHG3TIBW.js +237 -0
- package/dist/notification.d-BJwdFZnG.d.cts +1148 -0
- package/dist/notification.d-BJwdFZnG.d.ts +1148 -0
- package/dist/organization-CPXTUDJO.js +118 -0
- package/dist/organization-XIFV7MWP.cjs +118 -0
- package/dist/organization.d-DfUcuwKM.d.cts +629 -0
- package/dist/organization.d-DfUcuwKM.d.ts +629 -0
- package/dist/partner-directory-4WCHPJRO.js +282 -0
- package/dist/partner-directory-FKWPPO7F.cjs +282 -0
- package/dist/partner-directory.d-BRRDHFcz.d.cts +1511 -0
- package/dist/partner-directory.d-BRRDHFcz.d.ts +1511 -0
- package/dist/permissions-5E36GPG3.js +178 -0
- package/dist/permissions-PBTK5CCD.cjs +178 -0
- package/dist/permissions.d-CL7SwMFy.d.cts +1253 -0
- package/dist/permissions.d-CL7SwMFy.d.ts +1253 -0
- package/dist/pricing-FDWEBIQU.js +439 -0
- package/dist/pricing-FZQKL4DW.cjs +439 -0
- package/dist/pricing-tier-34O624R4.js +36 -0
- package/dist/pricing-tier-F4HE6WIM.cjs +36 -0
- package/dist/pricing-tier.d-VuH-NtlR.d.cts +82 -0
- package/dist/pricing-tier.d-VuH-NtlR.d.ts +82 -0
- package/dist/pricing.d-Dd1CaSX_.d.cts +12201 -0
- package/dist/pricing.d-Dd1CaSX_.d.ts +12201 -0
- package/dist/purpose-47HJIG2Q.cjs +180 -0
- package/dist/purpose-MX33NU5H.js +180 -0
- package/dist/purpose.d-D8YCSqt9.d.cts +373 -0
- package/dist/purpose.d-D8YCSqt9.d.ts +373 -0
- package/dist/sandbox-7QNLGFN2.cjs +100 -0
- package/dist/sandbox-TZCXHBJN.js +100 -0
- package/dist/sandbox.d-D1NgPMEc.d.cts +466 -0
- package/dist/sandbox.d-D1NgPMEc.d.ts +466 -0
- package/dist/submission-6LSPBI27.js +55 -0
- package/dist/submission-DBQNDJ4B.cjs +55 -0
- package/dist/submission.d-e9MPrbY1.d.cts +470 -0
- package/dist/submission.d-e9MPrbY1.d.ts +470 -0
- package/dist/targeting-HZRCLNIF.cjs +275 -0
- package/dist/targeting-MTQ6JBCY.js +275 -0
- package/dist/targeting.d-1GW3nh-y.d.cts +2058 -0
- package/dist/targeting.d-1GW3nh-y.d.ts +2058 -0
- package/dist/template-variables-S6IXK7SF.js +159 -0
- package/dist/template-variables-VPNIMC7L.cjs +159 -0
- package/dist/template-variables.d-CqqGe3sd.d.cts +1315 -0
- package/dist/template-variables.d-CqqGe3sd.d.ts +1315 -0
- package/dist/types-C5cGIwtq.d.cts +28 -0
- package/dist/types-C5cGIwtq.d.ts +28 -0
- package/dist/user-BHH4DAA5.cjs +488 -0
- package/dist/user-KBXFVRPI.js +488 -0
- package/dist/user.d-CWBgUia2.d.cts +2199 -0
- package/dist/user.d-CWBgUia2.d.ts +2199 -0
- package/dist/validation-rules-4V7KAWGW.cjs +120 -0
- package/dist/validation-rules-UGQY4ASY.js +120 -0
- package/dist/validation-rules.d-CMSvveua.d.cts +808 -0
- package/dist/validation-rules.d-CMSvveua.d.ts +808 -0
- package/dist/webhooks-JR475VD4.js +252 -0
- package/dist/webhooks-X64U3KCB.cjs +252 -0
- package/dist/webhooks.d-Bzl-u_Zs.d.cts +1201 -0
- package/dist/webhooks.d-Bzl-u_Zs.d.ts +1201 -0
- package/dist/workflow-7ANPQZDP.cjs +402 -0
- package/dist/workflow-DWSAHA5Q.js +402 -0
- package/dist/workflow-definition-2M3JBCUI.cjs +342 -0
- package/dist/workflow-definition-WLPGEU55.js +342 -0
- package/dist/workflow-definition.d-BKmIy2Qp.d.cts +2030 -0
- package/dist/workflow-definition.d-BKmIy2Qp.d.ts +2030 -0
- package/dist/workflow.d-DElz0XoQ.d.cts +3017 -0
- package/dist/workflow.d-DElz0XoQ.d.ts +3017 -0
- package/package.json +289 -0
|
@@ -0,0 +1,4120 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/* Auto-copied from erp-integration-client */
|
|
5
|
+
/* eslint-disable */
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
declare namespace Components {
|
|
10
|
+
namespace Responses {
|
|
11
|
+
export type BadRequest = Schemas.ErrorResponseBase;
|
|
12
|
+
export interface ERPUpdatesResponse {
|
|
13
|
+
results?: {
|
|
14
|
+
/**
|
|
15
|
+
* ID of the processed event
|
|
16
|
+
*/
|
|
17
|
+
event_id: string;
|
|
18
|
+
/**
|
|
19
|
+
* Processing status for the event (skipped indicates duplicate deduplication_id, ignored indicates unconfigured event)
|
|
20
|
+
*/
|
|
21
|
+
status: "success" | "error" | "skipped" | "ignored";
|
|
22
|
+
message?: string;
|
|
23
|
+
}[];
|
|
24
|
+
}
|
|
25
|
+
export type GetMonitoringStatsResponse = Schemas.MonitoringStats;
|
|
26
|
+
export interface GetMonitoringTimeSeriesResponse {
|
|
27
|
+
/**
|
|
28
|
+
* The time bucket interval used for aggregation
|
|
29
|
+
*/
|
|
30
|
+
interval: "5m" | "10m" | "30m" | "1h" | "3h" | "1d";
|
|
31
|
+
/**
|
|
32
|
+
* Start date of the time series
|
|
33
|
+
*/
|
|
34
|
+
from_date: string; // date-time
|
|
35
|
+
/**
|
|
36
|
+
* End date of the time series
|
|
37
|
+
*/
|
|
38
|
+
to_date: string; // date-time
|
|
39
|
+
/**
|
|
40
|
+
* List of time-series buckets with event counts
|
|
41
|
+
*/
|
|
42
|
+
buckets: Schemas.TimeSeriesBucket[];
|
|
43
|
+
}
|
|
44
|
+
export type InternalServerError = Schemas.ErrorResponseBase;
|
|
45
|
+
export type NotFound = Schemas.ErrorResponseBase;
|
|
46
|
+
export interface QueryAccessLogsResponse {
|
|
47
|
+
/**
|
|
48
|
+
* List of access log entries
|
|
49
|
+
*/
|
|
50
|
+
data?: Schemas.AccessLogEntry[];
|
|
51
|
+
/**
|
|
52
|
+
* Cursor to fetch the next page. Null if no more results.
|
|
53
|
+
*/
|
|
54
|
+
next_cursor?: {
|
|
55
|
+
timestamp?: string; // date-time
|
|
56
|
+
request_id?: string;
|
|
57
|
+
} | null;
|
|
58
|
+
/**
|
|
59
|
+
* Indicates if more results are available
|
|
60
|
+
*/
|
|
61
|
+
has_more?: boolean;
|
|
62
|
+
}
|
|
63
|
+
export interface QueryEventsResponse {
|
|
64
|
+
/**
|
|
65
|
+
* List of erp events
|
|
66
|
+
*/
|
|
67
|
+
data?: Schemas.ErpEvent[];
|
|
68
|
+
/**
|
|
69
|
+
* Cursor to fetch the next page. Null if no more results.
|
|
70
|
+
*/
|
|
71
|
+
next_cursor?: {
|
|
72
|
+
/**
|
|
73
|
+
* example:
|
|
74
|
+
* 2025-10-31T12:34:56Z
|
|
75
|
+
*/
|
|
76
|
+
event_time?: string; // date-time
|
|
77
|
+
/**
|
|
78
|
+
* example:
|
|
79
|
+
* evt_1234567890abcdef
|
|
80
|
+
*/
|
|
81
|
+
event_id?: string;
|
|
82
|
+
} | null;
|
|
83
|
+
/**
|
|
84
|
+
* Indicates if more results are available
|
|
85
|
+
* example:
|
|
86
|
+
* true
|
|
87
|
+
*/
|
|
88
|
+
has_more?: boolean;
|
|
89
|
+
}
|
|
90
|
+
export interface QueryInboundMonitoringEventsResponse {
|
|
91
|
+
/**
|
|
92
|
+
* List of inbound monitoring events
|
|
93
|
+
*/
|
|
94
|
+
data?: Schemas.InboundMonitoringEvent[];
|
|
95
|
+
/**
|
|
96
|
+
* Cursor to fetch the next page. Null if no more results.
|
|
97
|
+
*/
|
|
98
|
+
next_cursor?: {
|
|
99
|
+
completed_at?: string; // date-time
|
|
100
|
+
event_id?: string;
|
|
101
|
+
} | null;
|
|
102
|
+
/**
|
|
103
|
+
* Indicates if more results are available
|
|
104
|
+
*/
|
|
105
|
+
has_more?: boolean;
|
|
106
|
+
}
|
|
107
|
+
export interface QueryOutboundMonitoringEventsResponse {
|
|
108
|
+
/**
|
|
109
|
+
* List of outbound monitoring events
|
|
110
|
+
*/
|
|
111
|
+
data?: Schemas.OutboundMonitoringEvent[];
|
|
112
|
+
/**
|
|
113
|
+
* Cursor to fetch the next page. Null if no more results.
|
|
114
|
+
*/
|
|
115
|
+
next_cursor?: {
|
|
116
|
+
created_at?: string; // date-time
|
|
117
|
+
event_id?: string;
|
|
118
|
+
} | null;
|
|
119
|
+
/**
|
|
120
|
+
* Indicates if more results are available
|
|
121
|
+
*/
|
|
122
|
+
has_more?: boolean;
|
|
123
|
+
}
|
|
124
|
+
export interface ReplayEventsResponse {
|
|
125
|
+
/**
|
|
126
|
+
* List of event IDs for which replay was requested
|
|
127
|
+
*/
|
|
128
|
+
event_ids?: string[];
|
|
129
|
+
}
|
|
130
|
+
export type TriggerWebhookResponse = Schemas.TriggerWebhookResp;
|
|
131
|
+
export type Unauthorized = Schemas.ErrorResponseBase;
|
|
132
|
+
}
|
|
133
|
+
namespace Schemas {
|
|
134
|
+
export interface AccessLogEntry {
|
|
135
|
+
/**
|
|
136
|
+
* When the request was made
|
|
137
|
+
*/
|
|
138
|
+
timestamp?: string; // date-time
|
|
139
|
+
/**
|
|
140
|
+
* Environment (e.g., 'dev', 'prod')
|
|
141
|
+
*/
|
|
142
|
+
environment?: string;
|
|
143
|
+
/**
|
|
144
|
+
* Service name (e.g., 'entity', 'metering')
|
|
145
|
+
*/
|
|
146
|
+
service?: string;
|
|
147
|
+
/**
|
|
148
|
+
* Unique request identifier
|
|
149
|
+
*/
|
|
150
|
+
request_id?: string;
|
|
151
|
+
/**
|
|
152
|
+
* HTTP method
|
|
153
|
+
*/
|
|
154
|
+
method?: string;
|
|
155
|
+
/**
|
|
156
|
+
* Request path
|
|
157
|
+
*/
|
|
158
|
+
path?: string;
|
|
159
|
+
/**
|
|
160
|
+
* HTTP status code
|
|
161
|
+
*/
|
|
162
|
+
status?: number;
|
|
163
|
+
/**
|
|
164
|
+
* Response latency in milliseconds
|
|
165
|
+
*/
|
|
166
|
+
response_latency_ms?: number;
|
|
167
|
+
/**
|
|
168
|
+
* Response body length in bytes
|
|
169
|
+
*/
|
|
170
|
+
response_length?: number;
|
|
171
|
+
/**
|
|
172
|
+
* Access token identifier
|
|
173
|
+
*/
|
|
174
|
+
token_id?: string;
|
|
175
|
+
/**
|
|
176
|
+
* Organization ID
|
|
177
|
+
*/
|
|
178
|
+
org_id?: string;
|
|
179
|
+
/**
|
|
180
|
+
* Request origin header
|
|
181
|
+
*/
|
|
182
|
+
origin?: string;
|
|
183
|
+
/**
|
|
184
|
+
* Client IP address
|
|
185
|
+
*/
|
|
186
|
+
source_ip?: string;
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* Auto-refresh settings for keeping integration data fresh
|
|
190
|
+
*/
|
|
191
|
+
export interface AutoRefreshSettings {
|
|
192
|
+
/**
|
|
193
|
+
* Whether auto-refresh is enabled
|
|
194
|
+
*/
|
|
195
|
+
enabled?: boolean;
|
|
196
|
+
/**
|
|
197
|
+
* Maximum age (in minutes) of data before it is considered stale and eligible for refresh
|
|
198
|
+
*/
|
|
199
|
+
freshnessThresholdMinutes?: number;
|
|
200
|
+
}
|
|
201
|
+
export interface CreateFileProxyUseCaseRequest {
|
|
202
|
+
/**
|
|
203
|
+
* Use case name
|
|
204
|
+
*/
|
|
205
|
+
name: string;
|
|
206
|
+
/**
|
|
207
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
208
|
+
*
|
|
209
|
+
*/
|
|
210
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
211
|
+
/**
|
|
212
|
+
* Whether the use case is enabled
|
|
213
|
+
*/
|
|
214
|
+
enabled: boolean;
|
|
215
|
+
/**
|
|
216
|
+
* Use case type
|
|
217
|
+
*/
|
|
218
|
+
type: "file_proxy";
|
|
219
|
+
configuration?: /**
|
|
220
|
+
* Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
|
|
221
|
+
*
|
|
222
|
+
* The file proxy download URL always requires `orgId`, `integrationId`, and either `useCaseSlug` (recommended) or `useCaseId` (legacy UUID) as query parameters.
|
|
223
|
+
* The `orgId` is included in the signed URL to establish organization context without requiring authentication.
|
|
224
|
+
* Additional use-case-specific parameters are declared in the `params` array.
|
|
225
|
+
*
|
|
226
|
+
*/
|
|
227
|
+
FileProxyUseCaseConfiguration;
|
|
228
|
+
}
|
|
229
|
+
export interface CreateInboundUseCaseRequest {
|
|
230
|
+
/**
|
|
231
|
+
* Use case name
|
|
232
|
+
*/
|
|
233
|
+
name: string;
|
|
234
|
+
/**
|
|
235
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
236
|
+
*
|
|
237
|
+
*/
|
|
238
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
239
|
+
/**
|
|
240
|
+
* Whether the use case is enabled
|
|
241
|
+
*/
|
|
242
|
+
enabled: boolean;
|
|
243
|
+
/**
|
|
244
|
+
* Use case type
|
|
245
|
+
*/
|
|
246
|
+
type: "inbound";
|
|
247
|
+
configuration?: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
|
|
248
|
+
}
|
|
249
|
+
export interface CreateIntegrationRequest {
|
|
250
|
+
/**
|
|
251
|
+
* Integration name
|
|
252
|
+
*/
|
|
253
|
+
name: string;
|
|
254
|
+
/**
|
|
255
|
+
* Optional description of the integration
|
|
256
|
+
*/
|
|
257
|
+
description?: string;
|
|
258
|
+
/**
|
|
259
|
+
* List of access token IDs associated with this integration
|
|
260
|
+
*/
|
|
261
|
+
access_token_ids?: string[];
|
|
262
|
+
/**
|
|
263
|
+
* List of app IDs associated with this integration
|
|
264
|
+
*/
|
|
265
|
+
app_ids?: string[];
|
|
266
|
+
/**
|
|
267
|
+
* Configuration defining environment variables needed by this integration. Values are stored in the Environments API.
|
|
268
|
+
*/
|
|
269
|
+
environment_config?: EnvironmentFieldConfig[];
|
|
270
|
+
settings?: /* Settings for the integration */ IntegrationSettings;
|
|
271
|
+
}
|
|
272
|
+
export interface CreateOutboundUseCaseRequest {
|
|
273
|
+
/**
|
|
274
|
+
* Use case name
|
|
275
|
+
*/
|
|
276
|
+
name: string;
|
|
277
|
+
/**
|
|
278
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
279
|
+
*
|
|
280
|
+
*/
|
|
281
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
282
|
+
/**
|
|
283
|
+
* Whether the use case is enabled
|
|
284
|
+
*/
|
|
285
|
+
enabled: boolean;
|
|
286
|
+
/**
|
|
287
|
+
* Use case type
|
|
288
|
+
*/
|
|
289
|
+
type: "outbound";
|
|
290
|
+
configuration?: /* Configuration for outbound use cases. Defines the event that triggers the flow and the webhook mappings. */ OutboundIntegrationEventConfiguration;
|
|
291
|
+
}
|
|
292
|
+
export type CreateUseCaseRequest = CreateInboundUseCaseRequest | CreateOutboundUseCaseRequest | CreateFileProxyUseCaseRequest;
|
|
293
|
+
export interface CreateUseCaseRequestBase {
|
|
294
|
+
/**
|
|
295
|
+
* Use case name
|
|
296
|
+
*/
|
|
297
|
+
name: string;
|
|
298
|
+
/**
|
|
299
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
300
|
+
*
|
|
301
|
+
*/
|
|
302
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
303
|
+
/**
|
|
304
|
+
* Whether the use case is enabled
|
|
305
|
+
*/
|
|
306
|
+
enabled: boolean;
|
|
307
|
+
}
|
|
308
|
+
export interface DeleteIntegrationAppMappingRequest {
|
|
309
|
+
/**
|
|
310
|
+
* UUID of the integration app instance
|
|
311
|
+
*/
|
|
312
|
+
app_id: string; // uuid
|
|
313
|
+
/**
|
|
314
|
+
* UUID of the integration app component instance
|
|
315
|
+
*/
|
|
316
|
+
component_id: string; // uuid
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* Configuration for how the transformed event should be delivered
|
|
320
|
+
*/
|
|
321
|
+
export interface DeliveryConfig {
|
|
322
|
+
/**
|
|
323
|
+
* Delivery mechanism type (currently only webhook is supported)
|
|
324
|
+
*/
|
|
325
|
+
type: "webhook";
|
|
326
|
+
/**
|
|
327
|
+
* Reference to the webhook configuration in svc-webhooks
|
|
328
|
+
*/
|
|
329
|
+
webhook_id: string;
|
|
330
|
+
/**
|
|
331
|
+
* Cached webhook name for display purposes
|
|
332
|
+
*/
|
|
333
|
+
webhook_name?: string;
|
|
334
|
+
/**
|
|
335
|
+
* Cached webhook URL for display purposes
|
|
336
|
+
*/
|
|
337
|
+
webhook_url?: string;
|
|
338
|
+
}
|
|
339
|
+
export interface EmbeddedInboundUseCaseRequest {
|
|
340
|
+
/**
|
|
341
|
+
* Optional use case ID for update matching.
|
|
342
|
+
* - If provided and matches an existing use case, that use case is updated
|
|
343
|
+
* - If provided but no match, a new use case with this ID is created
|
|
344
|
+
* - If omitted, a new use case with auto-generated ID is created
|
|
345
|
+
*
|
|
346
|
+
*/
|
|
347
|
+
id?: string; // uuid
|
|
348
|
+
/**
|
|
349
|
+
* Use case name
|
|
350
|
+
*/
|
|
351
|
+
name: string;
|
|
352
|
+
/**
|
|
353
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation.
|
|
354
|
+
*
|
|
355
|
+
*/
|
|
356
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
357
|
+
/**
|
|
358
|
+
* Whether the use case is enabled
|
|
359
|
+
*/
|
|
360
|
+
enabled: boolean;
|
|
361
|
+
/**
|
|
362
|
+
* Optional description of this change (like a commit message)
|
|
363
|
+
*/
|
|
364
|
+
change_description?: string;
|
|
365
|
+
/**
|
|
366
|
+
* Use case type
|
|
367
|
+
*/
|
|
368
|
+
type: "inbound";
|
|
369
|
+
configuration?: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
|
|
370
|
+
}
|
|
371
|
+
export interface EmbeddedOutboundUseCaseRequest {
|
|
372
|
+
/**
|
|
373
|
+
* Optional use case ID for update matching.
|
|
374
|
+
* - If provided and matches an existing use case, that use case is updated
|
|
375
|
+
* - If provided but no match, a new use case with this ID is created
|
|
376
|
+
* - If omitted, a new use case with auto-generated ID is created
|
|
377
|
+
*
|
|
378
|
+
*/
|
|
379
|
+
id?: string; // uuid
|
|
380
|
+
/**
|
|
381
|
+
* Use case name
|
|
382
|
+
*/
|
|
383
|
+
name: string;
|
|
384
|
+
/**
|
|
385
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation.
|
|
386
|
+
*
|
|
387
|
+
*/
|
|
388
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
389
|
+
/**
|
|
390
|
+
* Whether the use case is enabled
|
|
391
|
+
*/
|
|
392
|
+
enabled: boolean;
|
|
393
|
+
/**
|
|
394
|
+
* Optional description of this change (like a commit message)
|
|
395
|
+
*/
|
|
396
|
+
change_description?: string;
|
|
397
|
+
/**
|
|
398
|
+
* Use case type
|
|
399
|
+
*/
|
|
400
|
+
type: "outbound";
|
|
401
|
+
configuration?: /* Configuration for outbound use cases. Defines the event that triggers the flow and the webhook mappings. */ OutboundIntegrationEventConfiguration;
|
|
402
|
+
}
|
|
403
|
+
export type EmbeddedUseCaseRequest = EmbeddedInboundUseCaseRequest | EmbeddedOutboundUseCaseRequest;
|
|
404
|
+
export interface EmbeddedUseCaseRequestBase {
|
|
405
|
+
/**
|
|
406
|
+
* Optional use case ID for update matching.
|
|
407
|
+
* - If provided and matches an existing use case, that use case is updated
|
|
408
|
+
* - If provided but no match, a new use case with this ID is created
|
|
409
|
+
* - If omitted, a new use case with auto-generated ID is created
|
|
410
|
+
*
|
|
411
|
+
*/
|
|
412
|
+
id?: string; // uuid
|
|
413
|
+
/**
|
|
414
|
+
* Use case name
|
|
415
|
+
*/
|
|
416
|
+
name: string;
|
|
417
|
+
/**
|
|
418
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation.
|
|
419
|
+
*
|
|
420
|
+
*/
|
|
421
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
422
|
+
/**
|
|
423
|
+
* Whether the use case is enabled
|
|
424
|
+
*/
|
|
425
|
+
enabled: boolean;
|
|
426
|
+
/**
|
|
427
|
+
* Optional description of this change (like a commit message)
|
|
428
|
+
*/
|
|
429
|
+
change_description?: string;
|
|
430
|
+
}
|
|
431
|
+
export interface EntityUpdate {
|
|
432
|
+
/**
|
|
433
|
+
* The entity type slug
|
|
434
|
+
*/
|
|
435
|
+
entity_slug: string;
|
|
436
|
+
/**
|
|
437
|
+
* Unique identifier mappings for this entity
|
|
438
|
+
*/
|
|
439
|
+
unique_identifiers: {
|
|
440
|
+
[name: string]: any;
|
|
441
|
+
};
|
|
442
|
+
/**
|
|
443
|
+
* Mapped attribute values
|
|
444
|
+
*/
|
|
445
|
+
attributes: {
|
|
446
|
+
[name: string]: any;
|
|
447
|
+
};
|
|
448
|
+
}
|
|
449
|
+
export interface EnvironmentFieldConfig {
|
|
450
|
+
/**
|
|
451
|
+
* Environment variable key, used to look up the value in the Environments API.
|
|
452
|
+
*/
|
|
453
|
+
key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
|
|
454
|
+
/**
|
|
455
|
+
* Display label for the field in the UI
|
|
456
|
+
*/
|
|
457
|
+
label: string;
|
|
458
|
+
/**
|
|
459
|
+
* Whether the value is a plain string or an encrypted secret
|
|
460
|
+
*/
|
|
461
|
+
type: "String" | "SecretString";
|
|
462
|
+
/**
|
|
463
|
+
* Help text shown below the field
|
|
464
|
+
*/
|
|
465
|
+
description?: string;
|
|
466
|
+
/**
|
|
467
|
+
* Whether this field must be filled before the integration can be used
|
|
468
|
+
*/
|
|
469
|
+
required?: boolean;
|
|
470
|
+
/**
|
|
471
|
+
* Sort order for display and drag-to-reorder
|
|
472
|
+
*/
|
|
473
|
+
order?: number;
|
|
474
|
+
}
|
|
475
|
+
export interface ErpEvent {
|
|
476
|
+
/**
|
|
477
|
+
* Type of event (create, update, delete)
|
|
478
|
+
*/
|
|
479
|
+
event_type: "CREATE" | "UPDATE" | "DELETE";
|
|
480
|
+
/**
|
|
481
|
+
* Type of the object being updated (business_partner, contract_account, etc.). Corresponds to "Event Name" from the integration UI.
|
|
482
|
+
*/
|
|
483
|
+
object_type: string;
|
|
484
|
+
/**
|
|
485
|
+
* Timestamp when the event occurred
|
|
486
|
+
*/
|
|
487
|
+
timestamp: string; // date-time
|
|
488
|
+
/**
|
|
489
|
+
* Format of the payload data
|
|
490
|
+
*/
|
|
491
|
+
format: "json" | "xml";
|
|
492
|
+
/**
|
|
493
|
+
* The object data payload - can be either a serialized string or a direct JSON object
|
|
494
|
+
*/
|
|
495
|
+
payload: /* The object data payload - can be either a serialized string or a direct JSON object */ string | {
|
|
496
|
+
[name: string]: any;
|
|
497
|
+
};
|
|
498
|
+
/**
|
|
499
|
+
* Optional unique identifier for idempotency - prevents duplicate processing of the same event within 24 hours in context of the same integration. Must contain only alphanumeric characters, hyphens, and underscores.
|
|
500
|
+
*
|
|
501
|
+
* example:
|
|
502
|
+
* evt-2025-05-01-12345-create-bp
|
|
503
|
+
*/
|
|
504
|
+
deduplication_id?: string; // ^[a-zA-Z0-9_-]+$
|
|
505
|
+
}
|
|
506
|
+
export type ErpEventV3 = {
|
|
507
|
+
/**
|
|
508
|
+
* Event name from integration mapping (e.g., business_partner, contract_account). Required when use_case_slug is not provided.
|
|
509
|
+
*
|
|
510
|
+
*/
|
|
511
|
+
event_name: string;
|
|
512
|
+
/**
|
|
513
|
+
* Timestamp when the event occurred
|
|
514
|
+
*/
|
|
515
|
+
timestamp: string; // date-time
|
|
516
|
+
/**
|
|
517
|
+
* Format of the payload data
|
|
518
|
+
*/
|
|
519
|
+
format: "json" | "xml";
|
|
520
|
+
/**
|
|
521
|
+
* The object data payload - can be either a serialized string or a direct JSON object
|
|
522
|
+
*/
|
|
523
|
+
payload: /* The object data payload - can be either a serialized string or a direct JSON object */ string | {
|
|
524
|
+
[name: string]: any;
|
|
525
|
+
};
|
|
526
|
+
/**
|
|
527
|
+
* Recommended. Use case slug for routing this event to the correct use case configuration. If provided, takes precedence over event_name for use case lookup. Preferred over event_name-based routing as slugs are portable across environments.
|
|
528
|
+
*
|
|
529
|
+
*/
|
|
530
|
+
use_case_slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
531
|
+
/**
|
|
532
|
+
* Optional unique identifier for idempotency - prevents duplicate processing of the same event within 24 hours in context of the same integration. Must contain only alphanumeric characters, hyphens, and underscores.
|
|
533
|
+
*
|
|
534
|
+
* example:
|
|
535
|
+
* evt-2025-05-01-12345-bp
|
|
536
|
+
*/
|
|
537
|
+
deduplication_id?: string; // ^[a-zA-Z0-9_-]+$
|
|
538
|
+
} | {
|
|
539
|
+
/**
|
|
540
|
+
* Event name from integration mapping (e.g., business_partner, contract_account). Required when use_case_slug is not provided.
|
|
541
|
+
*
|
|
542
|
+
*/
|
|
543
|
+
event_name?: string;
|
|
544
|
+
/**
|
|
545
|
+
* Timestamp when the event occurred
|
|
546
|
+
*/
|
|
547
|
+
timestamp: string; // date-time
|
|
548
|
+
/**
|
|
549
|
+
* Format of the payload data
|
|
550
|
+
*/
|
|
551
|
+
format: "json" | "xml";
|
|
552
|
+
/**
|
|
553
|
+
* The object data payload - can be either a serialized string or a direct JSON object
|
|
554
|
+
*/
|
|
555
|
+
payload: /* The object data payload - can be either a serialized string or a direct JSON object */ string | {
|
|
556
|
+
[name: string]: any;
|
|
557
|
+
};
|
|
558
|
+
/**
|
|
559
|
+
* Recommended. Use case slug for routing this event to the correct use case configuration. If provided, takes precedence over event_name for use case lookup. Preferred over event_name-based routing as slugs are portable across environments.
|
|
560
|
+
*
|
|
561
|
+
*/
|
|
562
|
+
use_case_slug: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
563
|
+
/**
|
|
564
|
+
* Optional unique identifier for idempotency - prevents duplicate processing of the same event within 24 hours in context of the same integration. Must contain only alphanumeric characters, hyphens, and underscores.
|
|
565
|
+
*
|
|
566
|
+
* example:
|
|
567
|
+
* evt-2025-05-01-12345-bp
|
|
568
|
+
*/
|
|
569
|
+
deduplication_id?: string; // ^[a-zA-Z0-9_-]+$
|
|
570
|
+
};
|
|
571
|
+
export interface ErpUpdatesEventsV2Request {
|
|
572
|
+
/**
|
|
573
|
+
* UUID that identifies the integration configuration to use
|
|
574
|
+
*/
|
|
575
|
+
integration_id: string; // uuid
|
|
576
|
+
/**
|
|
577
|
+
* Optional ID that identifies the specific request for debugging purposes
|
|
578
|
+
*/
|
|
579
|
+
correlation_id?: string;
|
|
580
|
+
/**
|
|
581
|
+
* List of ERP events to process
|
|
582
|
+
*/
|
|
583
|
+
events: ErpEvent[];
|
|
584
|
+
}
|
|
585
|
+
export interface ErpUpdatesEventsV3Request {
|
|
586
|
+
/**
|
|
587
|
+
* UUID that identifies the integration configuration to use
|
|
588
|
+
*/
|
|
589
|
+
integration_id: string; // uuid
|
|
590
|
+
/**
|
|
591
|
+
* Optional ID that identifies the specific request for debugging purposes
|
|
592
|
+
*/
|
|
593
|
+
correlation_id?: string;
|
|
594
|
+
/**
|
|
595
|
+
* List of ERP events to process
|
|
596
|
+
*/
|
|
597
|
+
events: ErpEventV3[];
|
|
598
|
+
}
|
|
599
|
+
export interface ErrorResponseBase {
|
|
600
|
+
/**
|
|
601
|
+
* Computer-readable error code
|
|
602
|
+
*/
|
|
603
|
+
code?: string;
|
|
604
|
+
/**
|
|
605
|
+
* Error message
|
|
606
|
+
*/
|
|
607
|
+
message?: string;
|
|
608
|
+
}
|
|
609
|
+
export interface FileProxyAuth {
|
|
610
|
+
/**
|
|
611
|
+
* Authentication type
|
|
612
|
+
*/
|
|
613
|
+
type: "oauth2_client_credentials" | "oauth2_password";
|
|
614
|
+
/**
|
|
615
|
+
* Handlebars template for the OAuth2 token endpoint URL
|
|
616
|
+
*/
|
|
617
|
+
token_url: string;
|
|
618
|
+
/**
|
|
619
|
+
* Handlebars template for the OAuth2 client ID
|
|
620
|
+
*/
|
|
621
|
+
client_id: string;
|
|
622
|
+
/**
|
|
623
|
+
* Handlebars template for the OAuth2 client secret
|
|
624
|
+
*/
|
|
625
|
+
client_secret: string;
|
|
626
|
+
/**
|
|
627
|
+
* Optional OAuth2 scope
|
|
628
|
+
*/
|
|
629
|
+
scope?: string;
|
|
630
|
+
/**
|
|
631
|
+
* Handlebars template for the OAuth2 audience parameter
|
|
632
|
+
*/
|
|
633
|
+
audience?: string;
|
|
634
|
+
/**
|
|
635
|
+
* Handlebars template for the OAuth2 resource parameter
|
|
636
|
+
*/
|
|
637
|
+
resource?: string;
|
|
638
|
+
/**
|
|
639
|
+
* Handlebars template for the OAuth2 resource owner username. Required when type is oauth2_password.
|
|
640
|
+
*/
|
|
641
|
+
username?: string;
|
|
642
|
+
/**
|
|
643
|
+
* Handlebars template for the OAuth2 resource owner password. Required when type is oauth2_password.
|
|
644
|
+
*/
|
|
645
|
+
password?: string;
|
|
646
|
+
/**
|
|
647
|
+
* Additional key-value pairs to include in the token request body. Values support Handlebars templates.
|
|
648
|
+
*/
|
|
649
|
+
body_params?: {
|
|
650
|
+
[name: string]: string;
|
|
651
|
+
};
|
|
652
|
+
/**
|
|
653
|
+
* Additional headers to include in the token request. Values support Handlebars templates.
|
|
654
|
+
*/
|
|
655
|
+
headers?: {
|
|
656
|
+
[name: string]: string;
|
|
657
|
+
};
|
|
658
|
+
/**
|
|
659
|
+
* Additional query parameters to append to the token URL. Values support Handlebars templates.
|
|
660
|
+
*/
|
|
661
|
+
query_params?: {
|
|
662
|
+
[name: string]: string;
|
|
663
|
+
};
|
|
664
|
+
}
|
|
665
|
+
export interface FileProxyParam {
|
|
666
|
+
/**
|
|
667
|
+
* Parameter name as it appears in the query string
|
|
668
|
+
*/
|
|
669
|
+
name: string;
|
|
670
|
+
/**
|
|
671
|
+
* Whether this parameter is required
|
|
672
|
+
*/
|
|
673
|
+
required: boolean;
|
|
674
|
+
/**
|
|
675
|
+
* Human-readable description of the parameter
|
|
676
|
+
*/
|
|
677
|
+
description?: string;
|
|
678
|
+
}
|
|
679
|
+
export interface FileProxyResponseConfig {
|
|
680
|
+
/**
|
|
681
|
+
* JSONata expression to extract file content from step results
|
|
682
|
+
*/
|
|
683
|
+
body: string;
|
|
684
|
+
/**
|
|
685
|
+
* Encoding of the extracted body
|
|
686
|
+
*/
|
|
687
|
+
encoding: "base64" | "binary";
|
|
688
|
+
/**
|
|
689
|
+
* JSONata expression to extract the filename
|
|
690
|
+
*/
|
|
691
|
+
filename?: string;
|
|
692
|
+
/**
|
|
693
|
+
* JSONata expression to extract the content type
|
|
694
|
+
*/
|
|
695
|
+
content_type?: string;
|
|
696
|
+
}
|
|
697
|
+
export interface FileProxyStep {
|
|
698
|
+
/**
|
|
699
|
+
* Handlebars template for the request URL
|
|
700
|
+
*/
|
|
701
|
+
url: string;
|
|
702
|
+
/**
|
|
703
|
+
* HTTP method
|
|
704
|
+
*/
|
|
705
|
+
method: "GET" | "POST";
|
|
706
|
+
/**
|
|
707
|
+
* Handlebars templates for request headers
|
|
708
|
+
*/
|
|
709
|
+
headers?: {
|
|
710
|
+
[name: string]: string;
|
|
711
|
+
};
|
|
712
|
+
/**
|
|
713
|
+
* Handlebars template for the request body (POST only)
|
|
714
|
+
*/
|
|
715
|
+
body?: string;
|
|
716
|
+
/**
|
|
717
|
+
* Expected response type
|
|
718
|
+
*/
|
|
719
|
+
response_type: "json" | "binary";
|
|
720
|
+
}
|
|
721
|
+
/**
|
|
722
|
+
* Auto-constructs a file proxy download URL. orgId and integrationId are injected from context. Exactly one of use_case_id or use_case_slug must be provided. Using use_case_slug is recommended as it is portable across environments.
|
|
723
|
+
*
|
|
724
|
+
*/
|
|
725
|
+
export type FileProxyUrlConfig = /**
|
|
726
|
+
* Auto-constructs a file proxy download URL. orgId and integrationId are injected from context. Exactly one of use_case_id or use_case_slug must be provided. Using use_case_slug is recommended as it is portable across environments.
|
|
727
|
+
*
|
|
728
|
+
*/
|
|
729
|
+
{
|
|
730
|
+
/**
|
|
731
|
+
* Recommended. Slug of the file_proxy use case. Maps to useCaseSlug query parameter. Portable across environments.
|
|
732
|
+
*
|
|
733
|
+
*/
|
|
734
|
+
use_case_slug: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
735
|
+
params?: /* Custom query parameters. Keys become URL param names, values resolved from payload. */ FileProxyUrlParams;
|
|
736
|
+
} | {
|
|
737
|
+
/**
|
|
738
|
+
* Legacy. UUID of the file_proxy use case. Maps to useCaseId query parameter. Prefer use_case_slug for portable configuration.
|
|
739
|
+
*
|
|
740
|
+
*/
|
|
741
|
+
use_case_id: string;
|
|
742
|
+
params?: /* Custom query parameters. Keys become URL param names, values resolved from payload. */ FileProxyUrlParams;
|
|
743
|
+
};
|
|
744
|
+
/**
|
|
745
|
+
* Parameter for file proxy URL. Exactly one of field, constant, or jsonataExpression must be set.
|
|
746
|
+
*/
|
|
747
|
+
export type FileProxyUrlParam = /* Parameter for file proxy URL. Exactly one of field, constant, or jsonataExpression must be set. */ {
|
|
748
|
+
/**
|
|
749
|
+
* Source field name or JSONPath expression (if starts with $)
|
|
750
|
+
*/
|
|
751
|
+
field: string;
|
|
752
|
+
} | {
|
|
753
|
+
/**
|
|
754
|
+
* Constant value (any type, stringified for URL)
|
|
755
|
+
*/
|
|
756
|
+
constant: any;
|
|
757
|
+
} | {
|
|
758
|
+
/**
|
|
759
|
+
* JSONata expression for transformation
|
|
760
|
+
*/
|
|
761
|
+
jsonataExpression: string;
|
|
762
|
+
};
|
|
763
|
+
/**
|
|
764
|
+
* Custom query parameters. Keys become URL param names, values resolved from payload.
|
|
765
|
+
*/
|
|
766
|
+
export interface FileProxyUrlParams {
|
|
767
|
+
[name: string]: /* Parameter for file proxy URL. Exactly one of field, constant, or jsonataExpression must be set. */ FileProxyUrlParam;
|
|
768
|
+
}
|
|
769
|
+
export interface FileProxyUseCase {
|
|
770
|
+
/**
|
|
771
|
+
* Unique identifier for the use case
|
|
772
|
+
*/
|
|
773
|
+
id: string; // uuid
|
|
774
|
+
/**
|
|
775
|
+
* Parent integration ID
|
|
776
|
+
*/
|
|
777
|
+
integrationId: string; // uuid
|
|
778
|
+
/**
|
|
779
|
+
* Use case name
|
|
780
|
+
*/
|
|
781
|
+
name: string;
|
|
782
|
+
/**
|
|
783
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
784
|
+
*
|
|
785
|
+
*/
|
|
786
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
787
|
+
/**
|
|
788
|
+
* Use case type
|
|
789
|
+
*/
|
|
790
|
+
type: "inbound" | "outbound" | "file_proxy" | "file_proxy";
|
|
791
|
+
enabled: boolean;
|
|
792
|
+
/**
|
|
793
|
+
* Description of the last change made to this use case
|
|
794
|
+
*/
|
|
795
|
+
change_description?: string;
|
|
796
|
+
/**
|
|
797
|
+
* ISO-8601 timestamp when the use case was created
|
|
798
|
+
*/
|
|
799
|
+
created_at: string; // date-time
|
|
800
|
+
/**
|
|
801
|
+
* ISO-8601 timestamp when the use case was last updated
|
|
802
|
+
*/
|
|
803
|
+
updated_at: string; // date-time
|
|
804
|
+
configuration?: /**
|
|
805
|
+
* Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
|
|
806
|
+
*
|
|
807
|
+
* The file proxy download URL always requires `orgId`, `integrationId`, and either `useCaseSlug` (recommended) or `useCaseId` (legacy UUID) as query parameters.
|
|
808
|
+
* The `orgId` is included in the signed URL to establish organization context without requiring authentication.
|
|
809
|
+
* Additional use-case-specific parameters are declared in the `params` array.
|
|
810
|
+
*
|
|
811
|
+
*/
|
|
812
|
+
FileProxyUseCaseConfiguration;
|
|
813
|
+
}
|
|
814
|
+
/**
|
|
815
|
+
* Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
|
|
816
|
+
*
|
|
817
|
+
* The file proxy download URL always requires `orgId`, `integrationId`, and either `useCaseSlug` (recommended) or `useCaseId` (legacy UUID) as query parameters.
|
|
818
|
+
* The `orgId` is included in the signed URL to establish organization context without requiring authentication.
|
|
819
|
+
* Additional use-case-specific parameters are declared in the `params` array.
|
|
820
|
+
*
|
|
821
|
+
*/
|
|
822
|
+
export interface FileProxyUseCaseConfiguration {
|
|
823
|
+
/**
|
|
824
|
+
* Whether requests require VPC routing for IP allowlisting. Read-only after creation — can only be modified directly in DynamoDB.
|
|
825
|
+
*/
|
|
826
|
+
requires_vpc?: boolean;
|
|
827
|
+
auth?: FileProxyAuth;
|
|
828
|
+
/**
|
|
829
|
+
* Additional use-case-specific parameters expected in the download URL query string (beyond the required orgId, integrationId, and useCaseSlug or useCaseId)
|
|
830
|
+
*/
|
|
831
|
+
params?: FileProxyParam[];
|
|
832
|
+
/**
|
|
833
|
+
* Ordered list of HTTP steps to execute to retrieve the file
|
|
834
|
+
*/
|
|
835
|
+
steps: [
|
|
836
|
+
FileProxyStep,
|
|
837
|
+
...FileProxyStep[]
|
|
838
|
+
];
|
|
839
|
+
response: FileProxyResponseConfig;
|
|
840
|
+
}
|
|
841
|
+
export interface FileProxyUseCaseHistoryEntry {
|
|
842
|
+
/**
|
|
843
|
+
* Unique identifier for this history entry
|
|
844
|
+
*/
|
|
845
|
+
id: string; // uuid
|
|
846
|
+
/**
|
|
847
|
+
* Reference to the parent use case
|
|
848
|
+
*/
|
|
849
|
+
useCaseId: string; // uuid
|
|
850
|
+
/**
|
|
851
|
+
* Parent integration ID
|
|
852
|
+
*/
|
|
853
|
+
integrationId: string; // uuid
|
|
854
|
+
/**
|
|
855
|
+
* Use case name at this point in history
|
|
856
|
+
*/
|
|
857
|
+
name: string;
|
|
858
|
+
/**
|
|
859
|
+
* Use case slug at this point in history
|
|
860
|
+
*/
|
|
861
|
+
slug?: string;
|
|
862
|
+
/**
|
|
863
|
+
* Whether the use case was enabled at this point in history
|
|
864
|
+
*/
|
|
865
|
+
enabled: boolean;
|
|
866
|
+
/**
|
|
867
|
+
* Description of the change that was made at this point in history
|
|
868
|
+
*/
|
|
869
|
+
change_description?: string;
|
|
870
|
+
/**
|
|
871
|
+
* ISO-8601 timestamp when the use case was originally created
|
|
872
|
+
*/
|
|
873
|
+
created_at: string; // date-time
|
|
874
|
+
/**
|
|
875
|
+
* ISO-8601 timestamp of this historical snapshot (before the update)
|
|
876
|
+
*/
|
|
877
|
+
updated_at: string; // date-time
|
|
878
|
+
/**
|
|
879
|
+
* ISO-8601 timestamp when this history entry was created
|
|
880
|
+
*/
|
|
881
|
+
history_created_at: string; // date-time
|
|
882
|
+
/**
|
|
883
|
+
* Use case type
|
|
884
|
+
*/
|
|
885
|
+
type: "file_proxy";
|
|
886
|
+
configuration?: /**
|
|
887
|
+
* Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
|
|
888
|
+
*
|
|
889
|
+
* The file proxy download URL always requires `orgId`, `integrationId`, and either `useCaseSlug` (recommended) or `useCaseId` (legacy UUID) as query parameters.
|
|
890
|
+
* The `orgId` is included in the signed URL to establish organization context without requiring authentication.
|
|
891
|
+
* Additional use-case-specific parameters are declared in the `params` array.
|
|
892
|
+
*
|
|
893
|
+
*/
|
|
894
|
+
FileProxyUseCaseConfiguration;
|
|
895
|
+
}
|
|
896
|
+
export interface GetMonitoringStatsRequest {
|
|
897
|
+
/**
|
|
898
|
+
* Start date for statistics period (inclusive)
|
|
899
|
+
* example:
|
|
900
|
+
* 2025-01-01T00:00:00Z
|
|
901
|
+
*/
|
|
902
|
+
from_date?: string; // date-time
|
|
903
|
+
/**
|
|
904
|
+
* End date for statistics period (inclusive)
|
|
905
|
+
* example:
|
|
906
|
+
* 2025-01-31T23:59:59Z
|
|
907
|
+
*/
|
|
908
|
+
to_date?: string; // date-time
|
|
909
|
+
/**
|
|
910
|
+
* Fields to group inbound statistics by
|
|
911
|
+
* example:
|
|
912
|
+
* [
|
|
913
|
+
* "use_case_id",
|
|
914
|
+
* "status"
|
|
915
|
+
* ]
|
|
916
|
+
*/
|
|
917
|
+
inbound_group_by?: ("use_case_id" | "sync_type" | "status" | "error_category" | "object_type" | "event_name" | "date")[];
|
|
918
|
+
/**
|
|
919
|
+
* Fields to group outbound statistics by
|
|
920
|
+
* example:
|
|
921
|
+
* [
|
|
922
|
+
* "event_name",
|
|
923
|
+
* "status"
|
|
924
|
+
* ]
|
|
925
|
+
*/
|
|
926
|
+
outbound_group_by?: ("event_name" | "status" | "webhook_config_id" | "date")[];
|
|
927
|
+
}
|
|
928
|
+
export interface GetMonitoringTimeSeriesRequest {
|
|
929
|
+
/**
|
|
930
|
+
* Start date for the time series (inclusive)
|
|
931
|
+
* example:
|
|
932
|
+
* 2025-01-01T00:00:00Z
|
|
933
|
+
*/
|
|
934
|
+
from_date: string; // date-time
|
|
935
|
+
/**
|
|
936
|
+
* End date for the time series (inclusive). Defaults to current time if not specified.
|
|
937
|
+
* example:
|
|
938
|
+
* 2025-01-31T23:59:59Z
|
|
939
|
+
*/
|
|
940
|
+
to_date?: string; // date-time
|
|
941
|
+
/**
|
|
942
|
+
* The time bucket interval for aggregation
|
|
943
|
+
* example:
|
|
944
|
+
* 1h
|
|
945
|
+
*/
|
|
946
|
+
interval: "5m" | "10m" | "30m" | "1h" | "3h" | "1d";
|
|
947
|
+
/**
|
|
948
|
+
* Filter by event direction. Defaults to both.
|
|
949
|
+
* example:
|
|
950
|
+
* both
|
|
951
|
+
*/
|
|
952
|
+
direction?: "inbound" | "outbound" | "both";
|
|
953
|
+
}
|
|
954
|
+
/**
|
|
955
|
+
* Configuration for inbound use cases (ERP to epilot)
|
|
956
|
+
*/
|
|
957
|
+
export interface InboundIntegrationEventConfiguration {
|
|
958
|
+
/**
|
|
959
|
+
* Array of entity configurations for this event
|
|
960
|
+
*/
|
|
961
|
+
entities?: IntegrationEntity[];
|
|
962
|
+
/**
|
|
963
|
+
* Array of meter reading configurations for this event
|
|
964
|
+
*/
|
|
965
|
+
meter_readings?: IntegrationMeterReading[];
|
|
966
|
+
}
|
|
967
|
+
export interface InboundMonitoringEvent {
|
|
968
|
+
/**
|
|
969
|
+
* Organization ID
|
|
970
|
+
*/
|
|
971
|
+
org_id: string;
|
|
972
|
+
/**
|
|
973
|
+
* Unique event identifier
|
|
974
|
+
*/
|
|
975
|
+
event_id: string;
|
|
976
|
+
/**
|
|
977
|
+
* Correlation ID for tracing related events
|
|
978
|
+
*/
|
|
979
|
+
correlation_id?: string | null;
|
|
980
|
+
/**
|
|
981
|
+
* Integration ID
|
|
982
|
+
*/
|
|
983
|
+
integration_id?: string | null;
|
|
984
|
+
/**
|
|
985
|
+
* Use case ID
|
|
986
|
+
*/
|
|
987
|
+
use_case_id?: string | null;
|
|
988
|
+
/**
|
|
989
|
+
* Type of event (optional for V3 events)
|
|
990
|
+
*/
|
|
991
|
+
event_type?: "CREATE" | "UPDATE" | "DELETE" | "TRIGGER";
|
|
992
|
+
/**
|
|
993
|
+
* Type of object being synced (e.g., 'contract', 'meter')
|
|
994
|
+
*/
|
|
995
|
+
object_type: string;
|
|
996
|
+
/**
|
|
997
|
+
* Type of sync operation
|
|
998
|
+
*/
|
|
999
|
+
sync_type: "entity" | "meter_reading" | "webhook" | "api_deprecation";
|
|
1000
|
+
/**
|
|
1001
|
+
* Processing status
|
|
1002
|
+
*/
|
|
1003
|
+
status: "success" | "error" | "skipped" | "warning";
|
|
1004
|
+
/**
|
|
1005
|
+
* Error code (when status=error)
|
|
1006
|
+
*/
|
|
1007
|
+
error_code?: string | null;
|
|
1008
|
+
/**
|
|
1009
|
+
* Error message (when status=error)
|
|
1010
|
+
*/
|
|
1011
|
+
error_message?: string | null;
|
|
1012
|
+
/**
|
|
1013
|
+
* Error category (when status=error)
|
|
1014
|
+
*/
|
|
1015
|
+
error_category?: "validation" | "configuration" | "downstream_api" | "timeout" | "system";
|
|
1016
|
+
/**
|
|
1017
|
+
* Processing duration in milliseconds
|
|
1018
|
+
*/
|
|
1019
|
+
processing_duration_ms?: number | null;
|
|
1020
|
+
/**
|
|
1021
|
+
* When the event was received
|
|
1022
|
+
*/
|
|
1023
|
+
received_at: string; // date-time
|
|
1024
|
+
/**
|
|
1025
|
+
* When processing completed
|
|
1026
|
+
*/
|
|
1027
|
+
completed_at: string; // date-time
|
|
1028
|
+
}
|
|
1029
|
+
export interface InboundUseCase {
|
|
1030
|
+
/**
|
|
1031
|
+
* Unique identifier for the use case
|
|
1032
|
+
*/
|
|
1033
|
+
id: string; // uuid
|
|
1034
|
+
/**
|
|
1035
|
+
* Parent integration ID
|
|
1036
|
+
*/
|
|
1037
|
+
integrationId: string; // uuid
|
|
1038
|
+
/**
|
|
1039
|
+
* Use case name
|
|
1040
|
+
*/
|
|
1041
|
+
name: string;
|
|
1042
|
+
/**
|
|
1043
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
1044
|
+
*
|
|
1045
|
+
*/
|
|
1046
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
1047
|
+
/**
|
|
1048
|
+
* Use case type
|
|
1049
|
+
*/
|
|
1050
|
+
type: "inbound" | "outbound" | "file_proxy" | "inbound";
|
|
1051
|
+
enabled: boolean;
|
|
1052
|
+
/**
|
|
1053
|
+
* Description of the last change made to this use case
|
|
1054
|
+
*/
|
|
1055
|
+
change_description?: string;
|
|
1056
|
+
/**
|
|
1057
|
+
* ISO-8601 timestamp when the use case was created
|
|
1058
|
+
*/
|
|
1059
|
+
created_at: string; // date-time
|
|
1060
|
+
/**
|
|
1061
|
+
* ISO-8601 timestamp when the use case was last updated
|
|
1062
|
+
*/
|
|
1063
|
+
updated_at: string; // date-time
|
|
1064
|
+
configuration?: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
|
|
1065
|
+
}
|
|
1066
|
+
export interface InboundUseCaseHistoryEntry {
|
|
1067
|
+
/**
|
|
1068
|
+
* Unique identifier for this history entry
|
|
1069
|
+
*/
|
|
1070
|
+
id: string; // uuid
|
|
1071
|
+
/**
|
|
1072
|
+
* Reference to the parent use case
|
|
1073
|
+
*/
|
|
1074
|
+
useCaseId: string; // uuid
|
|
1075
|
+
/**
|
|
1076
|
+
* Parent integration ID
|
|
1077
|
+
*/
|
|
1078
|
+
integrationId: string; // uuid
|
|
1079
|
+
/**
|
|
1080
|
+
* Use case name at this point in history
|
|
1081
|
+
*/
|
|
1082
|
+
name: string;
|
|
1083
|
+
/**
|
|
1084
|
+
* Use case slug at this point in history
|
|
1085
|
+
*/
|
|
1086
|
+
slug?: string;
|
|
1087
|
+
/**
|
|
1088
|
+
* Whether the use case was enabled at this point in history
|
|
1089
|
+
*/
|
|
1090
|
+
enabled: boolean;
|
|
1091
|
+
/**
|
|
1092
|
+
* Description of the change that was made at this point in history
|
|
1093
|
+
*/
|
|
1094
|
+
change_description?: string;
|
|
1095
|
+
/**
|
|
1096
|
+
* ISO-8601 timestamp when the use case was originally created
|
|
1097
|
+
*/
|
|
1098
|
+
created_at: string; // date-time
|
|
1099
|
+
/**
|
|
1100
|
+
* ISO-8601 timestamp of this historical snapshot (before the update)
|
|
1101
|
+
*/
|
|
1102
|
+
updated_at: string; // date-time
|
|
1103
|
+
/**
|
|
1104
|
+
* ISO-8601 timestamp when this history entry was created
|
|
1105
|
+
*/
|
|
1106
|
+
history_created_at: string; // date-time
|
|
1107
|
+
/**
|
|
1108
|
+
* Use case type
|
|
1109
|
+
*/
|
|
1110
|
+
type: "inbound";
|
|
1111
|
+
configuration?: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
|
|
1112
|
+
}
|
|
1113
|
+
export interface Integration {
|
|
1114
|
+
/**
|
|
1115
|
+
* Unique identifier for the integration
|
|
1116
|
+
*/
|
|
1117
|
+
id: string; // uuid
|
|
1118
|
+
/**
|
|
1119
|
+
* Organization ID
|
|
1120
|
+
*/
|
|
1121
|
+
orgId: string;
|
|
1122
|
+
/**
|
|
1123
|
+
* ISO-8601 timestamp when the integration was created
|
|
1124
|
+
*/
|
|
1125
|
+
created_at: string; // date-time
|
|
1126
|
+
/**
|
|
1127
|
+
* ISO-8601 timestamp when the integration was last updated
|
|
1128
|
+
*/
|
|
1129
|
+
updated_at: string; // date-time
|
|
1130
|
+
/**
|
|
1131
|
+
* Integration name
|
|
1132
|
+
*/
|
|
1133
|
+
name: string;
|
|
1134
|
+
/**
|
|
1135
|
+
* Optional description of the integration
|
|
1136
|
+
*/
|
|
1137
|
+
description?: string;
|
|
1138
|
+
/**
|
|
1139
|
+
* List of access token IDs associated with this integration
|
|
1140
|
+
*/
|
|
1141
|
+
access_token_ids?: string[];
|
|
1142
|
+
/**
|
|
1143
|
+
* List of app IDs associated with this integration
|
|
1144
|
+
*/
|
|
1145
|
+
app_ids?: string[];
|
|
1146
|
+
/**
|
|
1147
|
+
* Configuration defining environment variables needed by this integration. Values are stored in the Environments API.
|
|
1148
|
+
*/
|
|
1149
|
+
environment_config?: EnvironmentFieldConfig[];
|
|
1150
|
+
settings?: /* Settings for the integration */ IntegrationSettings;
|
|
1151
|
+
}
|
|
1152
|
+
export interface IntegrationAppMapping {
|
|
1153
|
+
/**
|
|
1154
|
+
* The integration ID this app/component is mapped to
|
|
1155
|
+
*/
|
|
1156
|
+
integration_id: string; // uuid
|
|
1157
|
+
}
|
|
1158
|
+
export interface IntegrationConfigurationV1 {
|
|
1159
|
+
/**
|
|
1160
|
+
* Mapping specification version
|
|
1161
|
+
*/
|
|
1162
|
+
version?: "1.0";
|
|
1163
|
+
mapping: {
|
|
1164
|
+
/**
|
|
1165
|
+
* [v1.0] Object type mappings
|
|
1166
|
+
*/
|
|
1167
|
+
objects: {
|
|
1168
|
+
[name: string]: IntegrationObjectV1;
|
|
1169
|
+
};
|
|
1170
|
+
};
|
|
1171
|
+
}
|
|
1172
|
+
export interface IntegrationConfigurationV2 {
|
|
1173
|
+
/**
|
|
1174
|
+
* Mapping specification version
|
|
1175
|
+
*/
|
|
1176
|
+
version: "2.0";
|
|
1177
|
+
mapping: {
|
|
1178
|
+
/**
|
|
1179
|
+
* [v2.0] Event type mappings
|
|
1180
|
+
*/
|
|
1181
|
+
events: {
|
|
1182
|
+
[name: string]: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
|
|
1183
|
+
};
|
|
1184
|
+
};
|
|
1185
|
+
}
|
|
1186
|
+
export interface IntegrationEditableFields {
|
|
1187
|
+
/**
|
|
1188
|
+
* Integration name
|
|
1189
|
+
*/
|
|
1190
|
+
name?: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* Optional description of the integration
|
|
1193
|
+
*/
|
|
1194
|
+
description?: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* List of access token IDs associated with this integration
|
|
1197
|
+
*/
|
|
1198
|
+
access_token_ids?: string[];
|
|
1199
|
+
/**
|
|
1200
|
+
* List of app IDs associated with this integration
|
|
1201
|
+
*/
|
|
1202
|
+
app_ids?: string[];
|
|
1203
|
+
/**
|
|
1204
|
+
* Configuration defining environment variables needed by this integration. Values are stored in the Environments API.
|
|
1205
|
+
*/
|
|
1206
|
+
environment_config?: EnvironmentFieldConfig[];
|
|
1207
|
+
settings?: /* Settings for the integration */ IntegrationSettings;
|
|
1208
|
+
}
|
|
1209
|
+
export interface IntegrationEntity {
|
|
1210
|
+
/**
|
|
1211
|
+
* Target entity schema (e.g., 'contact', 'contract')
|
|
1212
|
+
*/
|
|
1213
|
+
entity_schema: string;
|
|
1214
|
+
/**
|
|
1215
|
+
* Array of attribute names that uniquely identify this entity.
|
|
1216
|
+
* The _type hint for repeatable fields (e.g., email, phone) should be specified
|
|
1217
|
+
* on the corresponding field definition in the fields array.
|
|
1218
|
+
*
|
|
1219
|
+
*/
|
|
1220
|
+
unique_ids: string[];
|
|
1221
|
+
/**
|
|
1222
|
+
* Optional JSONata expression to pre-process the event data before field mapping
|
|
1223
|
+
*/
|
|
1224
|
+
jsonataExpression?: string;
|
|
1225
|
+
/**
|
|
1226
|
+
* Controls whether this entity mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean.
|
|
1227
|
+
*/
|
|
1228
|
+
enabled?: /* Controls whether this entity mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean. */ boolean | string;
|
|
1229
|
+
/**
|
|
1230
|
+
* Operation mode for entity mapping:
|
|
1231
|
+
* - 'upsert': Create or update the entity (default)
|
|
1232
|
+
* - 'delete': Soft delete the entity (marks as deleted)
|
|
1233
|
+
* - 'purge': Hard delete the entity (permanent removal)
|
|
1234
|
+
* - 'upsert-prune-scope-purge': Upsert entities from array, then purge entities in scope that weren't upserted
|
|
1235
|
+
* - 'upsert-prune-scope-delete': Upsert entities from array, then soft delete entities in scope that weren't upserted
|
|
1236
|
+
*
|
|
1237
|
+
*/
|
|
1238
|
+
mode?: "upsert" | "delete" | "purge" | "upsert-prune-scope-purge" | "upsert-prune-scope-delete";
|
|
1239
|
+
scope?: /**
|
|
1240
|
+
* Scope configuration for upsert-prune-scope modes.
|
|
1241
|
+
* Defines how to find entities that should be pruned if not in the upsert payload.
|
|
1242
|
+
* The scope is resolved against the original event payload (not individual array items).
|
|
1243
|
+
*
|
|
1244
|
+
*/
|
|
1245
|
+
PruneScopeConfig;
|
|
1246
|
+
/**
|
|
1247
|
+
* Field mapping definitions
|
|
1248
|
+
*/
|
|
1249
|
+
fields: IntegrationEntityField[];
|
|
1250
|
+
}
|
|
1251
|
+
export interface IntegrationEntityField {
|
|
1252
|
+
/**
|
|
1253
|
+
* Target attribute name
|
|
1254
|
+
*/
|
|
1255
|
+
attribute: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* Source field name or JSONPath expression (if starts with $)
|
|
1258
|
+
*/
|
|
1259
|
+
field?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* JSONata expression for transformation
|
|
1262
|
+
*/
|
|
1263
|
+
jsonataExpression?: string;
|
|
1264
|
+
/**
|
|
1265
|
+
* Constant value to assign (any type)
|
|
1266
|
+
*/
|
|
1267
|
+
constant?: any;
|
|
1268
|
+
_type?: /**
|
|
1269
|
+
* Type hint for repeatable fields that require special search handling.
|
|
1270
|
+
* These fields are stored as arrays of objects (e.g., email: [{ email: "value" }]).
|
|
1271
|
+
*
|
|
1272
|
+
*/
|
|
1273
|
+
RepeatableFieldType;
|
|
1274
|
+
/**
|
|
1275
|
+
* Controls whether this field mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean. Defaults to true if omitted.
|
|
1276
|
+
*/
|
|
1277
|
+
enabled?: /* Controls whether this field mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean. Defaults to true if omitted. */ boolean | string;
|
|
1278
|
+
relations?: RelationConfig;
|
|
1279
|
+
relation_refs?: /**
|
|
1280
|
+
* Configuration for relation references ($relation_ref).
|
|
1281
|
+
* Relation references link to a specific item within a repeatable attribute on a related entity.
|
|
1282
|
+
* Common use case: referencing a specific address within a contact's address list.
|
|
1283
|
+
*
|
|
1284
|
+
*/
|
|
1285
|
+
RelationRefsConfig;
|
|
1286
|
+
file_proxy_url?: /**
|
|
1287
|
+
* Auto-constructs a file proxy download URL. orgId and integrationId are injected from context. Exactly one of use_case_id or use_case_slug must be provided. Using use_case_slug is recommended as it is portable across environments.
|
|
1288
|
+
*
|
|
1289
|
+
*/
|
|
1290
|
+
FileProxyUrlConfig;
|
|
1291
|
+
}
|
|
1292
|
+
export interface IntegrationFieldV1 {
|
|
1293
|
+
/**
|
|
1294
|
+
* Target entity slug
|
|
1295
|
+
*/
|
|
1296
|
+
entity: string;
|
|
1297
|
+
/**
|
|
1298
|
+
* Target attribute name
|
|
1299
|
+
*/
|
|
1300
|
+
attribute: string;
|
|
1301
|
+
/**
|
|
1302
|
+
* Source field name (mutually exclusive with jsonataExpression)
|
|
1303
|
+
*/
|
|
1304
|
+
field?: string;
|
|
1305
|
+
/**
|
|
1306
|
+
* JSONata expression for transformation (mutually exclusive with field)
|
|
1307
|
+
*/
|
|
1308
|
+
jsonataExpression?: string;
|
|
1309
|
+
}
|
|
1310
|
+
export interface IntegrationMeterReading {
|
|
1311
|
+
/**
|
|
1312
|
+
* Optional JSONata expression to extract meter reading items from the event data.
|
|
1313
|
+
* If not provided, the entire payload is used as the reading data.
|
|
1314
|
+
* Useful when you need to extract an array of readings from a nested structure (e.g., "$.readings").
|
|
1315
|
+
*
|
|
1316
|
+
*/
|
|
1317
|
+
jsonataExpression?: string;
|
|
1318
|
+
/**
|
|
1319
|
+
* Strategy for matching incoming readings against existing readings.
|
|
1320
|
+
* - 'external_id': Match readings by external_id attribute (default behavior)
|
|
1321
|
+
* - 'strict-date': Match by meter_id + counter_id + direction + date (German timezone).
|
|
1322
|
+
* Useful when readings originate from ECP and are echoed back by the ERP with truncated timestamps.
|
|
1323
|
+
*
|
|
1324
|
+
*/
|
|
1325
|
+
reading_matching?: "external_id" | "strict-date";
|
|
1326
|
+
/**
|
|
1327
|
+
* Operation mode for meter reading mapping:
|
|
1328
|
+
* - 'upsert': Create or update meter readings (default)
|
|
1329
|
+
* - 'delete': Delete the meter reading
|
|
1330
|
+
* - 'upsert-prune-scope': Upsert readings from array, then delete all other readings for the same meter+counter that weren't upserted
|
|
1331
|
+
*
|
|
1332
|
+
*/
|
|
1333
|
+
mode?: "upsert" | "delete" | "upsert-prune-scope";
|
|
1334
|
+
scope?: /**
|
|
1335
|
+
* Scope configuration for meter reading upsert-prune-scope mode.
|
|
1336
|
+
* The scope is all readings for the same meter + counter.
|
|
1337
|
+
*
|
|
1338
|
+
*/
|
|
1339
|
+
MeterReadingPruneScopeConfig;
|
|
1340
|
+
meter: MeterUniqueIdsConfig;
|
|
1341
|
+
meter_counter?: MeterUniqueIdsConfig;
|
|
1342
|
+
/**
|
|
1343
|
+
* Field mapping definitions for meter reading attributes
|
|
1344
|
+
*/
|
|
1345
|
+
fields: IntegrationEntityField[];
|
|
1346
|
+
}
|
|
1347
|
+
export interface IntegrationObjectV1 {
|
|
1348
|
+
/**
|
|
1349
|
+
* Mapping of entity types to their unique identifier field mappings
|
|
1350
|
+
*/
|
|
1351
|
+
unique_ids: {
|
|
1352
|
+
[name: string]: string[] | {
|
|
1353
|
+
[name: string]: string;
|
|
1354
|
+
};
|
|
1355
|
+
};
|
|
1356
|
+
/**
|
|
1357
|
+
* Field mapping definitions
|
|
1358
|
+
*/
|
|
1359
|
+
fields: IntegrationFieldV1[];
|
|
1360
|
+
}
|
|
1361
|
+
/**
|
|
1362
|
+
* Settings for the integration
|
|
1363
|
+
*/
|
|
1364
|
+
export interface IntegrationSettings {
|
|
1365
|
+
autoRefresh?: /* Auto-refresh settings for keeping integration data fresh */ AutoRefreshSettings;
|
|
1366
|
+
}
|
|
1367
|
+
/**
|
|
1368
|
+
* Integration with embedded use cases for atomic CRUD operations
|
|
1369
|
+
*/
|
|
1370
|
+
export interface IntegrationWithUseCases {
|
|
1371
|
+
/**
|
|
1372
|
+
* Unique identifier for the integration
|
|
1373
|
+
*/
|
|
1374
|
+
id: string; // uuid
|
|
1375
|
+
/**
|
|
1376
|
+
* Organization ID
|
|
1377
|
+
*/
|
|
1378
|
+
orgId: string;
|
|
1379
|
+
/**
|
|
1380
|
+
* ISO-8601 timestamp when the integration was created
|
|
1381
|
+
*/
|
|
1382
|
+
created_at: string; // date-time
|
|
1383
|
+
/**
|
|
1384
|
+
* ISO-8601 timestamp when the integration was last updated
|
|
1385
|
+
*/
|
|
1386
|
+
updated_at: string; // date-time
|
|
1387
|
+
/**
|
|
1388
|
+
* Integration name
|
|
1389
|
+
*/
|
|
1390
|
+
name: string;
|
|
1391
|
+
/**
|
|
1392
|
+
* Optional description of the integration
|
|
1393
|
+
*/
|
|
1394
|
+
description?: string;
|
|
1395
|
+
/**
|
|
1396
|
+
* List of access token IDs associated with this integration
|
|
1397
|
+
*/
|
|
1398
|
+
access_token_ids?: string[];
|
|
1399
|
+
/**
|
|
1400
|
+
* List of app IDs associated with this integration
|
|
1401
|
+
*/
|
|
1402
|
+
app_ids?: string[];
|
|
1403
|
+
/**
|
|
1404
|
+
* Configuration defining environment variables needed by this integration. Values are stored in the Environments API.
|
|
1405
|
+
*/
|
|
1406
|
+
environment_config?: EnvironmentFieldConfig[];
|
|
1407
|
+
settings?: /* Settings for the integration */ IntegrationSettings;
|
|
1408
|
+
/**
|
|
1409
|
+
* All use cases belonging to this integration
|
|
1410
|
+
*/
|
|
1411
|
+
use_cases: UseCase[];
|
|
1412
|
+
}
|
|
1413
|
+
export interface MappingSimulationRequest {
|
|
1414
|
+
mapping_configuration: IntegrationConfigurationV1 | IntegrationConfigurationV2;
|
|
1415
|
+
/**
|
|
1416
|
+
* Type of the object/event being mapped.
|
|
1417
|
+
* For v1.0: must match a key in mapping_configuration.mapping.objects
|
|
1418
|
+
* For v2.0: must match a key in mapping_configuration.mapping.events
|
|
1419
|
+
*
|
|
1420
|
+
*/
|
|
1421
|
+
object_type: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* Format of the payload data
|
|
1424
|
+
*/
|
|
1425
|
+
format: "json" | "xml";
|
|
1426
|
+
/**
|
|
1427
|
+
* The object data payload - can be either a serialized string or a direct JSON object
|
|
1428
|
+
*/
|
|
1429
|
+
payload: /* The object data payload - can be either a serialized string or a direct JSON object */ string | {
|
|
1430
|
+
[name: string]: any;
|
|
1431
|
+
};
|
|
1432
|
+
}
|
|
1433
|
+
export interface MappingSimulationResponse {
|
|
1434
|
+
entity_updates: EntityUpdate[];
|
|
1435
|
+
meter_readings_updates?: MeterReadingUpdate[];
|
|
1436
|
+
/**
|
|
1437
|
+
* Validation warnings about the configuration (e.g., unique_ids referencing non-indexed fields)
|
|
1438
|
+
*/
|
|
1439
|
+
warnings?: MappingSimulationWarning[];
|
|
1440
|
+
}
|
|
1441
|
+
/**
|
|
1442
|
+
* Request for v2 mapping simulation. Uses the same configuration format stored in integration use case resources,
|
|
1443
|
+
* making it easier to test configurations before saving them.
|
|
1444
|
+
*
|
|
1445
|
+
*/
|
|
1446
|
+
export interface MappingSimulationV2Request {
|
|
1447
|
+
event_configuration: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
|
|
1448
|
+
/**
|
|
1449
|
+
* Format of the payload data
|
|
1450
|
+
*/
|
|
1451
|
+
format: "json" | "xml";
|
|
1452
|
+
/**
|
|
1453
|
+
* The event data payload - can be either a serialized string or a direct JSON object
|
|
1454
|
+
*/
|
|
1455
|
+
payload: /* The event data payload - can be either a serialized string or a direct JSON object */ string | {
|
|
1456
|
+
[name: string]: any;
|
|
1457
|
+
};
|
|
1458
|
+
}
|
|
1459
|
+
export interface MappingSimulationWarning {
|
|
1460
|
+
/**
|
|
1461
|
+
* The entity schema slug where the issue was found
|
|
1462
|
+
*/
|
|
1463
|
+
entity_schema: string;
|
|
1464
|
+
/**
|
|
1465
|
+
* The field name that caused the warning
|
|
1466
|
+
*/
|
|
1467
|
+
field: string;
|
|
1468
|
+
/**
|
|
1469
|
+
* Description of the validation issue
|
|
1470
|
+
*/
|
|
1471
|
+
message: string;
|
|
1472
|
+
}
|
|
1473
|
+
/**
|
|
1474
|
+
* Scope configuration for meter reading upsert-prune-scope mode.
|
|
1475
|
+
* The scope is all readings for the same meter + counter.
|
|
1476
|
+
*
|
|
1477
|
+
*/
|
|
1478
|
+
export interface MeterReadingPruneScopeConfig {
|
|
1479
|
+
/**
|
|
1480
|
+
* Optional source filter. When set, only readings with this source
|
|
1481
|
+
* are eligible for pruning (e.g., 'ERP' to only prune ERP-synced readings).
|
|
1482
|
+
*
|
|
1483
|
+
*/
|
|
1484
|
+
source?: string;
|
|
1485
|
+
}
|
|
1486
|
+
export interface MeterReadingUpdate {
|
|
1487
|
+
meter: {
|
|
1488
|
+
/**
|
|
1489
|
+
* Unique identifiers for the meter
|
|
1490
|
+
*/
|
|
1491
|
+
$entity_unique_ids: {
|
|
1492
|
+
[name: string]: any;
|
|
1493
|
+
};
|
|
1494
|
+
};
|
|
1495
|
+
meter_counter?: {
|
|
1496
|
+
/**
|
|
1497
|
+
* Unique identifiers for the meter counter
|
|
1498
|
+
*/
|
|
1499
|
+
$entity_unique_ids?: {
|
|
1500
|
+
[name: string]: any;
|
|
1501
|
+
};
|
|
1502
|
+
};
|
|
1503
|
+
/**
|
|
1504
|
+
* Meter reading attributes. Required: external_id, timestamp, source, value. `source` must be one of: ECP, ERP, 360, journey-submission. `reason` (optional) must be one of: regular, irregular, last, first, meter_change, contract_change, meter_adjustment (or empty/null).
|
|
1505
|
+
*/
|
|
1506
|
+
attributes: {
|
|
1507
|
+
[name: string]: any;
|
|
1508
|
+
};
|
|
1509
|
+
}
|
|
1510
|
+
export interface MeterUniqueIdsConfig {
|
|
1511
|
+
/**
|
|
1512
|
+
* Array of unique identifier field mappings
|
|
1513
|
+
*/
|
|
1514
|
+
unique_ids: [
|
|
1515
|
+
RelationUniqueIdField,
|
|
1516
|
+
...RelationUniqueIdField[]
|
|
1517
|
+
];
|
|
1518
|
+
}
|
|
1519
|
+
export interface MonitoringStats {
|
|
1520
|
+
/**
|
|
1521
|
+
* Statistics for inbound (ERP sync) events
|
|
1522
|
+
*/
|
|
1523
|
+
inbound: {
|
|
1524
|
+
/**
|
|
1525
|
+
* Total number of inbound events in the period
|
|
1526
|
+
*/
|
|
1527
|
+
total_events: number;
|
|
1528
|
+
/**
|
|
1529
|
+
* Total number of unique correlation IDs
|
|
1530
|
+
*/
|
|
1531
|
+
total_correlations?: number;
|
|
1532
|
+
/**
|
|
1533
|
+
* Number of successful events
|
|
1534
|
+
*/
|
|
1535
|
+
success_count: number;
|
|
1536
|
+
/**
|
|
1537
|
+
* Number of failed events
|
|
1538
|
+
*/
|
|
1539
|
+
error_count: number;
|
|
1540
|
+
/**
|
|
1541
|
+
* Number of skipped events
|
|
1542
|
+
*/
|
|
1543
|
+
skipped_count: number;
|
|
1544
|
+
/**
|
|
1545
|
+
* Number of warning events
|
|
1546
|
+
*/
|
|
1547
|
+
warning_count?: number;
|
|
1548
|
+
/**
|
|
1549
|
+
* Success rate as percentage (0-100)
|
|
1550
|
+
*/
|
|
1551
|
+
success_rate?: number; // float
|
|
1552
|
+
/**
|
|
1553
|
+
* Timestamp of the most recent error
|
|
1554
|
+
*/
|
|
1555
|
+
last_error_at?: string | null; // date-time
|
|
1556
|
+
/**
|
|
1557
|
+
* Statistics breakdown by requested inbound_group_by fields
|
|
1558
|
+
*/
|
|
1559
|
+
breakdown?: {
|
|
1560
|
+
[name: string]: any;
|
|
1561
|
+
}[];
|
|
1562
|
+
};
|
|
1563
|
+
/**
|
|
1564
|
+
* Statistics for outbound (webhook delivery) events
|
|
1565
|
+
*/
|
|
1566
|
+
outbound: {
|
|
1567
|
+
/**
|
|
1568
|
+
* Total number of outbound events in the period
|
|
1569
|
+
*/
|
|
1570
|
+
total_events: number;
|
|
1571
|
+
/**
|
|
1572
|
+
* Number of successful deliveries
|
|
1573
|
+
*/
|
|
1574
|
+
success_count: number;
|
|
1575
|
+
/**
|
|
1576
|
+
* Number of failed deliveries
|
|
1577
|
+
*/
|
|
1578
|
+
error_count: number;
|
|
1579
|
+
/**
|
|
1580
|
+
* Number of pending deliveries
|
|
1581
|
+
*/
|
|
1582
|
+
pending_count?: number;
|
|
1583
|
+
/**
|
|
1584
|
+
* Success rate as percentage (0-100)
|
|
1585
|
+
*/
|
|
1586
|
+
success_rate?: number; // float
|
|
1587
|
+
/**
|
|
1588
|
+
* Timestamp of the most recent error
|
|
1589
|
+
*/
|
|
1590
|
+
last_error_at?: string | null; // date-time
|
|
1591
|
+
/**
|
|
1592
|
+
* Statistics breakdown by requested outbound_group_by fields
|
|
1593
|
+
*/
|
|
1594
|
+
breakdown?: {
|
|
1595
|
+
[name: string]: any;
|
|
1596
|
+
}[];
|
|
1597
|
+
};
|
|
1598
|
+
}
|
|
1599
|
+
export interface OutboundConflict {
|
|
1600
|
+
/**
|
|
1601
|
+
* Type of conflict:
|
|
1602
|
+
* - 'event_disabled': Event catalog event is disabled while use case is enabled
|
|
1603
|
+
* - 'all_webhooks_disabled': All webhooks are disabled while use case is enabled
|
|
1604
|
+
* - 'event_enabled_while_disabled': Event is enabled while use case is disabled
|
|
1605
|
+
* - 'webhook_enabled_while_disabled': A webhook is enabled while use case is disabled
|
|
1606
|
+
*
|
|
1607
|
+
*/
|
|
1608
|
+
type: "event_disabled" | "all_webhooks_disabled" | "event_enabled_while_disabled" | "webhook_enabled_while_disabled";
|
|
1609
|
+
/**
|
|
1610
|
+
* Webhook ID (only present for webhook_enabled_while_disabled conflicts)
|
|
1611
|
+
*/
|
|
1612
|
+
webhookId?: string;
|
|
1613
|
+
/**
|
|
1614
|
+
* Human-readable description of the conflict
|
|
1615
|
+
*/
|
|
1616
|
+
message: string;
|
|
1617
|
+
}
|
|
1618
|
+
/**
|
|
1619
|
+
* Configuration for outbound use cases. Defines the event that triggers the flow and the webhook mappings.
|
|
1620
|
+
*/
|
|
1621
|
+
export interface OutboundIntegrationEventConfiguration {
|
|
1622
|
+
/**
|
|
1623
|
+
* The Event Catalog event name that triggers this outbound flow
|
|
1624
|
+
* example:
|
|
1625
|
+
* contract.created
|
|
1626
|
+
*/
|
|
1627
|
+
event_catalog_event: string;
|
|
1628
|
+
/**
|
|
1629
|
+
* List of mappings that transform and deliver the event
|
|
1630
|
+
*/
|
|
1631
|
+
mappings: [
|
|
1632
|
+
/* A mapping that transforms an event and delivers it to a webhook */ OutboundMapping,
|
|
1633
|
+
.../* A mapping that transforms an event and delivers it to a webhook */ OutboundMapping[]
|
|
1634
|
+
];
|
|
1635
|
+
}
|
|
1636
|
+
/**
|
|
1637
|
+
* A mapping that transforms an event and delivers it to a webhook
|
|
1638
|
+
*/
|
|
1639
|
+
export interface OutboundMapping {
|
|
1640
|
+
/**
|
|
1641
|
+
* Unique identifier for this mapping
|
|
1642
|
+
*/
|
|
1643
|
+
id: string; // uuid
|
|
1644
|
+
/**
|
|
1645
|
+
* Human-readable name for this mapping
|
|
1646
|
+
* example:
|
|
1647
|
+
* ERP Contract Sync
|
|
1648
|
+
*/
|
|
1649
|
+
name: string;
|
|
1650
|
+
/**
|
|
1651
|
+
* JSONata expression to transform the event payload
|
|
1652
|
+
* example:
|
|
1653
|
+
* { "id": entity._id, "customer": entity.customer_name }
|
|
1654
|
+
*/
|
|
1655
|
+
jsonata_expression: string;
|
|
1656
|
+
/**
|
|
1657
|
+
* Whether this mapping is active
|
|
1658
|
+
*/
|
|
1659
|
+
enabled: boolean;
|
|
1660
|
+
delivery: /* Configuration for how the transformed event should be delivered */ DeliveryConfig;
|
|
1661
|
+
/**
|
|
1662
|
+
* Timestamp when the mapping was created
|
|
1663
|
+
*/
|
|
1664
|
+
created_at?: string; // date-time
|
|
1665
|
+
/**
|
|
1666
|
+
* Timestamp when the mapping was last updated
|
|
1667
|
+
*/
|
|
1668
|
+
updated_at?: string; // date-time
|
|
1669
|
+
}
|
|
1670
|
+
export interface OutboundMonitoringEvent {
|
|
1671
|
+
/**
|
|
1672
|
+
* Organization ID
|
|
1673
|
+
*/
|
|
1674
|
+
org_id: string;
|
|
1675
|
+
/**
|
|
1676
|
+
* Unique event identifier
|
|
1677
|
+
*/
|
|
1678
|
+
event_id: string;
|
|
1679
|
+
/**
|
|
1680
|
+
* Event name (event_catalog_event)
|
|
1681
|
+
*/
|
|
1682
|
+
event_name: string;
|
|
1683
|
+
/**
|
|
1684
|
+
* Delivery status
|
|
1685
|
+
*/
|
|
1686
|
+
status: "succeeded" | "failed" | "pending";
|
|
1687
|
+
/**
|
|
1688
|
+
* Target URL
|
|
1689
|
+
*/
|
|
1690
|
+
url?: string;
|
|
1691
|
+
/**
|
|
1692
|
+
* HTTP method used (e.g., POST)
|
|
1693
|
+
*/
|
|
1694
|
+
http_method?: string;
|
|
1695
|
+
/**
|
|
1696
|
+
* HTTP response details (status_code, message, headers)
|
|
1697
|
+
*/
|
|
1698
|
+
http_response?: {
|
|
1699
|
+
[name: string]: any;
|
|
1700
|
+
};
|
|
1701
|
+
/**
|
|
1702
|
+
* Webhook configuration ID
|
|
1703
|
+
*/
|
|
1704
|
+
webhook_config_id?: string;
|
|
1705
|
+
/**
|
|
1706
|
+
* Additional metadata (webhook_id, organization details, correlation_id, etc.)
|
|
1707
|
+
*/
|
|
1708
|
+
metadata?: {
|
|
1709
|
+
[name: string]: any;
|
|
1710
|
+
};
|
|
1711
|
+
/**
|
|
1712
|
+
* Execution context (execution_arn, state_machine_arn, etc.)
|
|
1713
|
+
*/
|
|
1714
|
+
execution_context?: {
|
|
1715
|
+
[name: string]: any;
|
|
1716
|
+
};
|
|
1717
|
+
/**
|
|
1718
|
+
* Payload that was sent
|
|
1719
|
+
*/
|
|
1720
|
+
payload?: {
|
|
1721
|
+
[name: string]: any;
|
|
1722
|
+
};
|
|
1723
|
+
/**
|
|
1724
|
+
* When the event was created
|
|
1725
|
+
*/
|
|
1726
|
+
created_at: string; // date-time
|
|
1727
|
+
/**
|
|
1728
|
+
* When the event was last updated
|
|
1729
|
+
*/
|
|
1730
|
+
updated_at?: string; // date-time
|
|
1731
|
+
}
|
|
1732
|
+
export interface OutboundStatusResponse {
|
|
1733
|
+
useCases: OutboundUseCaseStatus[];
|
|
1734
|
+
}
|
|
1735
|
+
export interface OutboundUseCase {
|
|
1736
|
+
/**
|
|
1737
|
+
* Unique identifier for the use case
|
|
1738
|
+
*/
|
|
1739
|
+
id: string; // uuid
|
|
1740
|
+
/**
|
|
1741
|
+
* Parent integration ID
|
|
1742
|
+
*/
|
|
1743
|
+
integrationId: string; // uuid
|
|
1744
|
+
/**
|
|
1745
|
+
* Use case name
|
|
1746
|
+
*/
|
|
1747
|
+
name: string;
|
|
1748
|
+
/**
|
|
1749
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
1750
|
+
*
|
|
1751
|
+
*/
|
|
1752
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
1753
|
+
/**
|
|
1754
|
+
* Use case type
|
|
1755
|
+
*/
|
|
1756
|
+
type: "inbound" | "outbound" | "file_proxy" | "outbound";
|
|
1757
|
+
enabled: boolean;
|
|
1758
|
+
/**
|
|
1759
|
+
* Description of the last change made to this use case
|
|
1760
|
+
*/
|
|
1761
|
+
change_description?: string;
|
|
1762
|
+
/**
|
|
1763
|
+
* ISO-8601 timestamp when the use case was created
|
|
1764
|
+
*/
|
|
1765
|
+
created_at: string; // date-time
|
|
1766
|
+
/**
|
|
1767
|
+
* ISO-8601 timestamp when the use case was last updated
|
|
1768
|
+
*/
|
|
1769
|
+
updated_at: string; // date-time
|
|
1770
|
+
configuration?: /* Configuration for outbound use cases. Defines the event that triggers the flow and the webhook mappings. */ OutboundIntegrationEventConfiguration;
|
|
1771
|
+
}
|
|
1772
|
+
export interface OutboundUseCaseHistoryEntry {
|
|
1773
|
+
/**
|
|
1774
|
+
* Unique identifier for this history entry
|
|
1775
|
+
*/
|
|
1776
|
+
id: string; // uuid
|
|
1777
|
+
/**
|
|
1778
|
+
* Reference to the parent use case
|
|
1779
|
+
*/
|
|
1780
|
+
useCaseId: string; // uuid
|
|
1781
|
+
/**
|
|
1782
|
+
* Parent integration ID
|
|
1783
|
+
*/
|
|
1784
|
+
integrationId: string; // uuid
|
|
1785
|
+
/**
|
|
1786
|
+
* Use case name at this point in history
|
|
1787
|
+
*/
|
|
1788
|
+
name: string;
|
|
1789
|
+
/**
|
|
1790
|
+
* Use case slug at this point in history
|
|
1791
|
+
*/
|
|
1792
|
+
slug?: string;
|
|
1793
|
+
/**
|
|
1794
|
+
* Whether the use case was enabled at this point in history
|
|
1795
|
+
*/
|
|
1796
|
+
enabled: boolean;
|
|
1797
|
+
/**
|
|
1798
|
+
* Description of the change that was made at this point in history
|
|
1799
|
+
*/
|
|
1800
|
+
change_description?: string;
|
|
1801
|
+
/**
|
|
1802
|
+
* ISO-8601 timestamp when the use case was originally created
|
|
1803
|
+
*/
|
|
1804
|
+
created_at: string; // date-time
|
|
1805
|
+
/**
|
|
1806
|
+
* ISO-8601 timestamp of this historical snapshot (before the update)
|
|
1807
|
+
*/
|
|
1808
|
+
updated_at: string; // date-time
|
|
1809
|
+
/**
|
|
1810
|
+
* ISO-8601 timestamp when this history entry was created
|
|
1811
|
+
*/
|
|
1812
|
+
history_created_at: string; // date-time
|
|
1813
|
+
/**
|
|
1814
|
+
* Use case type
|
|
1815
|
+
*/
|
|
1816
|
+
type: "outbound";
|
|
1817
|
+
configuration?: /* Configuration for outbound use cases. Defines the event that triggers the flow and the webhook mappings. */ OutboundIntegrationEventConfiguration;
|
|
1818
|
+
}
|
|
1819
|
+
export interface OutboundUseCaseStatus {
|
|
1820
|
+
/**
|
|
1821
|
+
* Unique identifier for the use case
|
|
1822
|
+
*/
|
|
1823
|
+
useCaseId: string; // uuid
|
|
1824
|
+
/**
|
|
1825
|
+
* Human-readable name of the use case
|
|
1826
|
+
*/
|
|
1827
|
+
name: string;
|
|
1828
|
+
/**
|
|
1829
|
+
* Whether the use case is enabled
|
|
1830
|
+
*/
|
|
1831
|
+
useCaseEnabled: boolean;
|
|
1832
|
+
/**
|
|
1833
|
+
* The Event Catalog event name that triggers this outbound flow
|
|
1834
|
+
* example:
|
|
1835
|
+
* contract.created
|
|
1836
|
+
*/
|
|
1837
|
+
eventCatalogEvent?: string;
|
|
1838
|
+
/**
|
|
1839
|
+
* Whether the event is enabled in Event Catalog. Null if the API is unreachable.
|
|
1840
|
+
*/
|
|
1841
|
+
eventEnabled?: boolean | null;
|
|
1842
|
+
webhooks?: WebhookStatus[];
|
|
1843
|
+
/**
|
|
1844
|
+
* Overall status of the use case:
|
|
1845
|
+
* - 'ok': Use case is enabled and all dependencies are properly configured
|
|
1846
|
+
* - 'conflict': Use case has configuration issues (disabled events/webhooks while enabled)
|
|
1847
|
+
* - 'disabled': Use case is disabled
|
|
1848
|
+
*
|
|
1849
|
+
*/
|
|
1850
|
+
status: "ok" | "conflict" | "disabled";
|
|
1851
|
+
/**
|
|
1852
|
+
* List of detected conflicts, if any
|
|
1853
|
+
*/
|
|
1854
|
+
conflicts?: OutboundConflict[];
|
|
1855
|
+
}
|
|
1856
|
+
/**
|
|
1857
|
+
* Scope configuration for upsert-prune-scope modes.
|
|
1858
|
+
* Defines how to find entities that should be pruned if not in the upsert payload.
|
|
1859
|
+
* The scope is resolved against the original event payload (not individual array items).
|
|
1860
|
+
*
|
|
1861
|
+
*/
|
|
1862
|
+
export interface PruneScopeConfig {
|
|
1863
|
+
/**
|
|
1864
|
+
* Scope mode for finding entities to prune:
|
|
1865
|
+
* - 'relations': Find scope by looking at all entities related to a specific entity (both direct and reverse relations)
|
|
1866
|
+
* - 'query': Find scope entities directly via query parameters
|
|
1867
|
+
*
|
|
1868
|
+
*/
|
|
1869
|
+
scope_mode: "relations" | "query";
|
|
1870
|
+
/**
|
|
1871
|
+
* For 'relations' mode: The schema of the entity to find (e.g., 'billing_account').
|
|
1872
|
+
* Not used for 'query' mode.
|
|
1873
|
+
*
|
|
1874
|
+
*/
|
|
1875
|
+
schema?: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* For 'relations' mode: How to identify the scope entity from the payload.
|
|
1878
|
+
* Not used for 'query' mode.
|
|
1879
|
+
*
|
|
1880
|
+
*/
|
|
1881
|
+
unique_ids?: RelationUniqueIdField[];
|
|
1882
|
+
/**
|
|
1883
|
+
* For 'query' mode: Direct query parameters to find scope entities.
|
|
1884
|
+
* Not used for 'relations' or 'reverse-relations' modes.
|
|
1885
|
+
*
|
|
1886
|
+
*/
|
|
1887
|
+
query?: RelationUniqueIdField[];
|
|
1888
|
+
}
|
|
1889
|
+
export interface QueryAccessLogsRequest {
|
|
1890
|
+
/**
|
|
1891
|
+
* Filter by a specific access token ID (e.g., 'api_5ZugdRXasLfWBypHi93Fk').
|
|
1892
|
+
* Must be one of the access_token_ids linked to the integration.
|
|
1893
|
+
* If omitted, returns logs for all access tokens linked to the integration.
|
|
1894
|
+
*
|
|
1895
|
+
* example:
|
|
1896
|
+
* api_5ZugdRXasLfWBypHi93Fk
|
|
1897
|
+
*/
|
|
1898
|
+
token_id?: string;
|
|
1899
|
+
/**
|
|
1900
|
+
* Filter by service name (e.g., 'entity', 'metering', 'submission-api')
|
|
1901
|
+
* example:
|
|
1902
|
+
* entity
|
|
1903
|
+
*/
|
|
1904
|
+
service?: string;
|
|
1905
|
+
/**
|
|
1906
|
+
* Filter by HTTP method
|
|
1907
|
+
*/
|
|
1908
|
+
method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
|
|
1909
|
+
/**
|
|
1910
|
+
* Filter by request path (partial match)
|
|
1911
|
+
* example:
|
|
1912
|
+
* /v1/entity
|
|
1913
|
+
*/
|
|
1914
|
+
path?: string;
|
|
1915
|
+
/**
|
|
1916
|
+
* Filter by HTTP status code
|
|
1917
|
+
* example:
|
|
1918
|
+
* 200
|
|
1919
|
+
*/
|
|
1920
|
+
status?: number;
|
|
1921
|
+
/**
|
|
1922
|
+
* Filter logs from this date (inclusive)
|
|
1923
|
+
* example:
|
|
1924
|
+
* 2025-01-01T00:00:00Z
|
|
1925
|
+
*/
|
|
1926
|
+
from_date?: string; // date-time
|
|
1927
|
+
/**
|
|
1928
|
+
* Filter logs until this date (inclusive)
|
|
1929
|
+
* example:
|
|
1930
|
+
* 2025-01-31T23:59:59Z
|
|
1931
|
+
*/
|
|
1932
|
+
to_date?: string; // date-time
|
|
1933
|
+
/**
|
|
1934
|
+
* Maximum number of results to return
|
|
1935
|
+
* example:
|
|
1936
|
+
* 50
|
|
1937
|
+
*/
|
|
1938
|
+
limit?: number;
|
|
1939
|
+
/**
|
|
1940
|
+
* Cursor for pagination (infinite scroll)
|
|
1941
|
+
*/
|
|
1942
|
+
cursor?: {
|
|
1943
|
+
/**
|
|
1944
|
+
* Timestamp from the last log entry in the previous page
|
|
1945
|
+
*/
|
|
1946
|
+
timestamp?: string; // date-time
|
|
1947
|
+
/**
|
|
1948
|
+
* Request ID from the last log entry in the previous page
|
|
1949
|
+
*/
|
|
1950
|
+
request_id?: string;
|
|
1951
|
+
};
|
|
1952
|
+
}
|
|
1953
|
+
export interface QueryEventsRequest {
|
|
1954
|
+
/**
|
|
1955
|
+
* Filter by event ID
|
|
1956
|
+
*/
|
|
1957
|
+
event_id?: string;
|
|
1958
|
+
/**
|
|
1959
|
+
* Filter by event type
|
|
1960
|
+
*/
|
|
1961
|
+
event_type?: "CREATE" | "UPDATE" | "DELETE";
|
|
1962
|
+
/**
|
|
1963
|
+
* Filter by correlation ID
|
|
1964
|
+
*/
|
|
1965
|
+
correlation_id?: string;
|
|
1966
|
+
/**
|
|
1967
|
+
* Filter by object type
|
|
1968
|
+
*/
|
|
1969
|
+
object_type?: string;
|
|
1970
|
+
/**
|
|
1971
|
+
* Filter by event name (alias for object_type)
|
|
1972
|
+
*/
|
|
1973
|
+
event_name?: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* Maximum number of results to return
|
|
1976
|
+
* example:
|
|
1977
|
+
* 25
|
|
1978
|
+
*/
|
|
1979
|
+
limit?: number;
|
|
1980
|
+
/**
|
|
1981
|
+
* Cursor for pagination. Use the next_cursor from the previous response to get the next page.
|
|
1982
|
+
*/
|
|
1983
|
+
cursor?: {
|
|
1984
|
+
/**
|
|
1985
|
+
* Timestamp from the last event in the previous page
|
|
1986
|
+
* example:
|
|
1987
|
+
* 2025-10-31T12:34:56Z
|
|
1988
|
+
*/
|
|
1989
|
+
event_time?: string; // date-time
|
|
1990
|
+
/**
|
|
1991
|
+
* Event ID from the last event in the previous page
|
|
1992
|
+
* example:
|
|
1993
|
+
* evt_1234567890abcdef
|
|
1994
|
+
*/
|
|
1995
|
+
event_id?: string;
|
|
1996
|
+
};
|
|
1997
|
+
}
|
|
1998
|
+
export interface QueryInboundMonitoringEventsRequest {
|
|
1999
|
+
/**
|
|
2000
|
+
* Filter by use case ID
|
|
2001
|
+
*/
|
|
2002
|
+
use_case_id?: string; // uuid
|
|
2003
|
+
/**
|
|
2004
|
+
* Filter by event type
|
|
2005
|
+
*/
|
|
2006
|
+
event_type?: "CREATE" | "UPDATE" | "DELETE" | "TRIGGER";
|
|
2007
|
+
/**
|
|
2008
|
+
* Filter by sync type
|
|
2009
|
+
*/
|
|
2010
|
+
sync_type?: "entity" | "meter_reading" | "webhook" | "api_deprecation";
|
|
2011
|
+
/**
|
|
2012
|
+
* Filter by processing status
|
|
2013
|
+
*/
|
|
2014
|
+
status?: "success" | "error" | "skipped" | "warning";
|
|
2015
|
+
/**
|
|
2016
|
+
* Filter by error category (only applicable when status=error)
|
|
2017
|
+
*/
|
|
2018
|
+
error_category?: "validation" | "configuration" | "downstream_api" | "timeout" | "system";
|
|
2019
|
+
/**
|
|
2020
|
+
* Filter by correlation ID
|
|
2021
|
+
*/
|
|
2022
|
+
correlation_id?: string;
|
|
2023
|
+
/**
|
|
2024
|
+
* Filter by object type (e.g., 'contract', 'meter')
|
|
2025
|
+
*/
|
|
2026
|
+
object_type?: string;
|
|
2027
|
+
/**
|
|
2028
|
+
* Filter by event name (alias for object_type)
|
|
2029
|
+
*/
|
|
2030
|
+
event_name?: string;
|
|
2031
|
+
/**
|
|
2032
|
+
* Filter by event ID to find a specific event
|
|
2033
|
+
*/
|
|
2034
|
+
event_id?: string;
|
|
2035
|
+
/**
|
|
2036
|
+
* Filter events from this date (inclusive)
|
|
2037
|
+
* example:
|
|
2038
|
+
* 2025-01-01T00:00:00Z
|
|
2039
|
+
*/
|
|
2040
|
+
from_date?: string; // date-time
|
|
2041
|
+
/**
|
|
2042
|
+
* Filter events until this date (inclusive)
|
|
2043
|
+
* example:
|
|
2044
|
+
* 2025-01-31T23:59:59Z
|
|
2045
|
+
*/
|
|
2046
|
+
to_date?: string; // date-time
|
|
2047
|
+
/**
|
|
2048
|
+
* Maximum number of results to return
|
|
2049
|
+
* example:
|
|
2050
|
+
* 50
|
|
2051
|
+
*/
|
|
2052
|
+
limit?: number;
|
|
2053
|
+
/**
|
|
2054
|
+
* Cursor for pagination
|
|
2055
|
+
*/
|
|
2056
|
+
cursor?: {
|
|
2057
|
+
/**
|
|
2058
|
+
* Timestamp from the last event in the previous page
|
|
2059
|
+
*/
|
|
2060
|
+
completed_at?: string; // date-time
|
|
2061
|
+
/**
|
|
2062
|
+
* Event ID from the last event in the previous page
|
|
2063
|
+
*/
|
|
2064
|
+
event_id?: string;
|
|
2065
|
+
};
|
|
2066
|
+
}
|
|
2067
|
+
export interface QueryOutboundMonitoringEventsRequest {
|
|
2068
|
+
/**
|
|
2069
|
+
* Filter by event name (event_catalog_event). If not specified, returns events for all linked event names in the integration's outbound use cases.
|
|
2070
|
+
* example:
|
|
2071
|
+
* automation_flow_target
|
|
2072
|
+
*/
|
|
2073
|
+
event_name?: string;
|
|
2074
|
+
/**
|
|
2075
|
+
* Filter by delivery status
|
|
2076
|
+
*/
|
|
2077
|
+
status?: "succeeded" | "failed" | "pending";
|
|
2078
|
+
/**
|
|
2079
|
+
* Filter by webhook configuration ID
|
|
2080
|
+
*/
|
|
2081
|
+
webhook_config_id?: string;
|
|
2082
|
+
/**
|
|
2083
|
+
* Filter events from this date (inclusive)
|
|
2084
|
+
* example:
|
|
2085
|
+
* 2025-01-01T00:00:00Z
|
|
2086
|
+
*/
|
|
2087
|
+
from_date?: string; // date-time
|
|
2088
|
+
/**
|
|
2089
|
+
* Filter events until this date (inclusive)
|
|
2090
|
+
* example:
|
|
2091
|
+
* 2025-01-31T23:59:59Z
|
|
2092
|
+
*/
|
|
2093
|
+
to_date?: string; // date-time
|
|
2094
|
+
/**
|
|
2095
|
+
* Maximum number of results to return
|
|
2096
|
+
* example:
|
|
2097
|
+
* 50
|
|
2098
|
+
*/
|
|
2099
|
+
limit?: number;
|
|
2100
|
+
/**
|
|
2101
|
+
* Cursor for pagination
|
|
2102
|
+
*/
|
|
2103
|
+
cursor?: {
|
|
2104
|
+
/**
|
|
2105
|
+
* Timestamp from the last event in the previous page
|
|
2106
|
+
*/
|
|
2107
|
+
created_at?: string; // date-time
|
|
2108
|
+
/**
|
|
2109
|
+
* Event ID from the last event in the previous page
|
|
2110
|
+
*/
|
|
2111
|
+
event_id?: string;
|
|
2112
|
+
};
|
|
2113
|
+
}
|
|
2114
|
+
export interface RelationConfig {
|
|
2115
|
+
/**
|
|
2116
|
+
* Relation operation:
|
|
2117
|
+
* - '_set': Replace all existing relations with the specified items
|
|
2118
|
+
* - '_append': Add new unique items to existing relations (deduplicates by entity_id)
|
|
2119
|
+
* - '_append_all': Add all items to existing relations (no deduplication, allows duplicates)
|
|
2120
|
+
*
|
|
2121
|
+
*/
|
|
2122
|
+
operation: "_set" | "_append" | "_append_all";
|
|
2123
|
+
/**
|
|
2124
|
+
* Array of relation item configurations
|
|
2125
|
+
*/
|
|
2126
|
+
items?: RelationItemConfig[];
|
|
2127
|
+
/**
|
|
2128
|
+
* JSONata expression that returns relation items array (alternative to 'items')
|
|
2129
|
+
*/
|
|
2130
|
+
jsonataExpression?: string;
|
|
2131
|
+
}
|
|
2132
|
+
export interface RelationItemConfig {
|
|
2133
|
+
/**
|
|
2134
|
+
* Related entity schema
|
|
2135
|
+
*/
|
|
2136
|
+
entity_schema: string;
|
|
2137
|
+
/**
|
|
2138
|
+
* Optional tags for this relation
|
|
2139
|
+
*/
|
|
2140
|
+
_tags?: string[];
|
|
2141
|
+
/**
|
|
2142
|
+
* Unique identifier mappings for the related entity
|
|
2143
|
+
*/
|
|
2144
|
+
unique_ids: RelationUniqueIdField[];
|
|
2145
|
+
}
|
|
2146
|
+
/**
|
|
2147
|
+
* Configuration for a single relation reference item
|
|
2148
|
+
*/
|
|
2149
|
+
export interface RelationRefItemConfig {
|
|
2150
|
+
/**
|
|
2151
|
+
* Schema of the related entity (e.g., "contact")
|
|
2152
|
+
*/
|
|
2153
|
+
entity_schema: string;
|
|
2154
|
+
/**
|
|
2155
|
+
* Unique identifier mappings for the related entity
|
|
2156
|
+
*/
|
|
2157
|
+
unique_ids: RelationUniqueIdField[];
|
|
2158
|
+
/**
|
|
2159
|
+
* Attribute path on the related entity (e.g., "address")
|
|
2160
|
+
*/
|
|
2161
|
+
path: string;
|
|
2162
|
+
value: /* Configuration for the value to set on the related entity's attribute */ RelationRefValueConfig;
|
|
2163
|
+
}
|
|
2164
|
+
/**
|
|
2165
|
+
* Configuration for the value to set on the related entity's attribute
|
|
2166
|
+
*/
|
|
2167
|
+
export interface RelationRefValueConfig {
|
|
2168
|
+
/**
|
|
2169
|
+
* Target attribute name on the related entity
|
|
2170
|
+
*/
|
|
2171
|
+
attribute: string;
|
|
2172
|
+
/**
|
|
2173
|
+
* Operation for the attribute value:
|
|
2174
|
+
* - '_set': Replace the attribute value
|
|
2175
|
+
* - '_append': Add new unique items (deduplicates)
|
|
2176
|
+
* - '_append_all': Add all items (no deduplication)
|
|
2177
|
+
*
|
|
2178
|
+
*/
|
|
2179
|
+
operation?: "_set" | "_append" | "_append_all";
|
|
2180
|
+
/**
|
|
2181
|
+
* Source field name from the event data
|
|
2182
|
+
*/
|
|
2183
|
+
field?: string;
|
|
2184
|
+
/**
|
|
2185
|
+
* JSONata expression to compute the value
|
|
2186
|
+
*/
|
|
2187
|
+
jsonataExpression?: string;
|
|
2188
|
+
/**
|
|
2189
|
+
* Constant value (any type)
|
|
2190
|
+
*/
|
|
2191
|
+
constant?: any;
|
|
2192
|
+
}
|
|
2193
|
+
/**
|
|
2194
|
+
* Configuration for relation references ($relation_ref).
|
|
2195
|
+
* Relation references link to a specific item within a repeatable attribute on a related entity.
|
|
2196
|
+
* Common use case: referencing a specific address within a contact's address list.
|
|
2197
|
+
*
|
|
2198
|
+
*/
|
|
2199
|
+
export interface RelationRefsConfig {
|
|
2200
|
+
/**
|
|
2201
|
+
* Relation reference operation:
|
|
2202
|
+
* - '_set': Replace all existing relation_refs with the specified items
|
|
2203
|
+
* - '_append': Add new unique items to existing relation_refs (deduplicates by entity_id + _id)
|
|
2204
|
+
* - '_append_all': Add all items to existing relation_refs (no deduplication, allows duplicates)
|
|
2205
|
+
*
|
|
2206
|
+
*/
|
|
2207
|
+
operation: "_set" | "_append" | "_append_all";
|
|
2208
|
+
/**
|
|
2209
|
+
* Array of relation reference item configurations
|
|
2210
|
+
*/
|
|
2211
|
+
items?: /* Configuration for a single relation reference item */ RelationRefItemConfig[];
|
|
2212
|
+
/**
|
|
2213
|
+
* JSONata expression that returns relation_ref items array (alternative to 'items')
|
|
2214
|
+
*/
|
|
2215
|
+
jsonataExpression?: string;
|
|
2216
|
+
}
|
|
2217
|
+
export interface RelationUniqueIdField {
|
|
2218
|
+
/**
|
|
2219
|
+
* Target attribute name in the related entity
|
|
2220
|
+
*/
|
|
2221
|
+
attribute: string;
|
|
2222
|
+
_type?: /**
|
|
2223
|
+
* Type hint for repeatable fields that require special search handling.
|
|
2224
|
+
* These fields are stored as arrays of objects (e.g., email: [{ email: "value" }]).
|
|
2225
|
+
*
|
|
2226
|
+
*/
|
|
2227
|
+
RepeatableFieldType;
|
|
2228
|
+
/**
|
|
2229
|
+
* Source field name from the event data
|
|
2230
|
+
*/
|
|
2231
|
+
field?: string;
|
|
2232
|
+
/**
|
|
2233
|
+
* JSONata expression to compute the value
|
|
2234
|
+
*/
|
|
2235
|
+
jsonataExpression?: string;
|
|
2236
|
+
/**
|
|
2237
|
+
* Constant value (any type)
|
|
2238
|
+
*/
|
|
2239
|
+
constant?: any;
|
|
2240
|
+
}
|
|
2241
|
+
/**
|
|
2242
|
+
* Type hint for repeatable fields that require special search handling.
|
|
2243
|
+
* These fields are stored as arrays of objects (e.g., email: [{ email: "value" }]).
|
|
2244
|
+
*
|
|
2245
|
+
*/
|
|
2246
|
+
export type RepeatableFieldType = "email" | "phone";
|
|
2247
|
+
export interface ReplayEventsRequest {
|
|
2248
|
+
/**
|
|
2249
|
+
* List of event IDs to replay. Maximum 100 events per request.
|
|
2250
|
+
*/
|
|
2251
|
+
event_ids: [
|
|
2252
|
+
string,
|
|
2253
|
+
string?,
|
|
2254
|
+
string?,
|
|
2255
|
+
string?,
|
|
2256
|
+
string?,
|
|
2257
|
+
string?,
|
|
2258
|
+
string?,
|
|
2259
|
+
string?,
|
|
2260
|
+
string?,
|
|
2261
|
+
string?,
|
|
2262
|
+
string?,
|
|
2263
|
+
string?,
|
|
2264
|
+
string?,
|
|
2265
|
+
string?,
|
|
2266
|
+
string?,
|
|
2267
|
+
string?,
|
|
2268
|
+
string?,
|
|
2269
|
+
string?,
|
|
2270
|
+
string?,
|
|
2271
|
+
string?,
|
|
2272
|
+
string?,
|
|
2273
|
+
string?,
|
|
2274
|
+
string?,
|
|
2275
|
+
string?,
|
|
2276
|
+
string?,
|
|
2277
|
+
string?,
|
|
2278
|
+
string?,
|
|
2279
|
+
string?,
|
|
2280
|
+
string?,
|
|
2281
|
+
string?,
|
|
2282
|
+
string?,
|
|
2283
|
+
string?,
|
|
2284
|
+
string?,
|
|
2285
|
+
string?,
|
|
2286
|
+
string?,
|
|
2287
|
+
string?,
|
|
2288
|
+
string?,
|
|
2289
|
+
string?,
|
|
2290
|
+
string?,
|
|
2291
|
+
string?,
|
|
2292
|
+
string?,
|
|
2293
|
+
string?,
|
|
2294
|
+
string?,
|
|
2295
|
+
string?,
|
|
2296
|
+
string?,
|
|
2297
|
+
string?,
|
|
2298
|
+
string?,
|
|
2299
|
+
string?,
|
|
2300
|
+
string?,
|
|
2301
|
+
string?,
|
|
2302
|
+
string?,
|
|
2303
|
+
string?,
|
|
2304
|
+
string?,
|
|
2305
|
+
string?,
|
|
2306
|
+
string?,
|
|
2307
|
+
string?,
|
|
2308
|
+
string?,
|
|
2309
|
+
string?,
|
|
2310
|
+
string?,
|
|
2311
|
+
string?,
|
|
2312
|
+
string?,
|
|
2313
|
+
string?,
|
|
2314
|
+
string?,
|
|
2315
|
+
string?,
|
|
2316
|
+
string?,
|
|
2317
|
+
string?,
|
|
2318
|
+
string?,
|
|
2319
|
+
string?,
|
|
2320
|
+
string?,
|
|
2321
|
+
string?,
|
|
2322
|
+
string?,
|
|
2323
|
+
string?,
|
|
2324
|
+
string?,
|
|
2325
|
+
string?,
|
|
2326
|
+
string?,
|
|
2327
|
+
string?,
|
|
2328
|
+
string?,
|
|
2329
|
+
string?,
|
|
2330
|
+
string?,
|
|
2331
|
+
string?,
|
|
2332
|
+
string?,
|
|
2333
|
+
string?,
|
|
2334
|
+
string?,
|
|
2335
|
+
string?,
|
|
2336
|
+
string?,
|
|
2337
|
+
string?,
|
|
2338
|
+
string?,
|
|
2339
|
+
string?,
|
|
2340
|
+
string?,
|
|
2341
|
+
string?,
|
|
2342
|
+
string?,
|
|
2343
|
+
string?,
|
|
2344
|
+
string?,
|
|
2345
|
+
string?,
|
|
2346
|
+
string?,
|
|
2347
|
+
string?,
|
|
2348
|
+
string?,
|
|
2349
|
+
string?,
|
|
2350
|
+
string?,
|
|
2351
|
+
string?
|
|
2352
|
+
];
|
|
2353
|
+
}
|
|
2354
|
+
export interface SetIntegrationAppMappingRequest {
|
|
2355
|
+
/**
|
|
2356
|
+
* UUID of the integration app instance
|
|
2357
|
+
*/
|
|
2358
|
+
app_id: string; // uuid
|
|
2359
|
+
/**
|
|
2360
|
+
* UUID of the integration app component instance
|
|
2361
|
+
*/
|
|
2362
|
+
component_id: string; // uuid
|
|
2363
|
+
/**
|
|
2364
|
+
* If true, overwrites existing mapping. If false and mapping exists, returns 409 Conflict.
|
|
2365
|
+
*/
|
|
2366
|
+
overwrite?: boolean;
|
|
2367
|
+
}
|
|
2368
|
+
export interface TimeSeriesBucket {
|
|
2369
|
+
/**
|
|
2370
|
+
* The start timestamp of the bucket
|
|
2371
|
+
*/
|
|
2372
|
+
timestamp: string; // date-time
|
|
2373
|
+
/**
|
|
2374
|
+
* Inbound event counts for this bucket. Null when direction is outbound.
|
|
2375
|
+
*/
|
|
2376
|
+
inbound?: {
|
|
2377
|
+
success_count?: number;
|
|
2378
|
+
error_count?: number;
|
|
2379
|
+
warning_count?: number;
|
|
2380
|
+
skipped_count?: number;
|
|
2381
|
+
total_count?: number;
|
|
2382
|
+
} | null;
|
|
2383
|
+
/**
|
|
2384
|
+
* Outbound event counts for this bucket. Null when direction is inbound.
|
|
2385
|
+
*/
|
|
2386
|
+
outbound?: {
|
|
2387
|
+
success_count?: number;
|
|
2388
|
+
error_count?: number;
|
|
2389
|
+
pending_count?: number;
|
|
2390
|
+
total_count?: number;
|
|
2391
|
+
} | null;
|
|
2392
|
+
}
|
|
2393
|
+
export interface TriggerErpActionRequest {
|
|
2394
|
+
/**
|
|
2395
|
+
* Unique identifier of the current automation execution
|
|
2396
|
+
*/
|
|
2397
|
+
execution_id: string;
|
|
2398
|
+
/**
|
|
2399
|
+
* Identifier of the organization where the automation is executed
|
|
2400
|
+
*/
|
|
2401
|
+
org_id: string;
|
|
2402
|
+
/**
|
|
2403
|
+
* Identifier of the self-service webhook configuration
|
|
2404
|
+
*/
|
|
2405
|
+
webhook_id: string;
|
|
2406
|
+
/**
|
|
2407
|
+
* Identifier of the automation flow that triggered the action
|
|
2408
|
+
*/
|
|
2409
|
+
flow_id: string;
|
|
2410
|
+
/**
|
|
2411
|
+
* ISO-8601 timestamp when the webhook event was created
|
|
2412
|
+
*/
|
|
2413
|
+
created_at: string; // date-time
|
|
2414
|
+
/**
|
|
2415
|
+
* Identifier of the automation action being executed
|
|
2416
|
+
*/
|
|
2417
|
+
action_id: string;
|
|
2418
|
+
/**
|
|
2419
|
+
* Identifier of the specific automation flow action instance
|
|
2420
|
+
*/
|
|
2421
|
+
flow_action_id: string;
|
|
2422
|
+
/**
|
|
2423
|
+
* Human readable name of the automation flow
|
|
2424
|
+
*/
|
|
2425
|
+
flow_name: string;
|
|
2426
|
+
/**
|
|
2427
|
+
* Identifier of the entity activity related to this trigger
|
|
2428
|
+
*/
|
|
2429
|
+
activity_id: string;
|
|
2430
|
+
/**
|
|
2431
|
+
* Identifier of the entity referenced by the activity
|
|
2432
|
+
*/
|
|
2433
|
+
entity_id: string;
|
|
2434
|
+
}
|
|
2435
|
+
export interface TriggerWebhookResp {
|
|
2436
|
+
status_code?: string;
|
|
2437
|
+
message?: string;
|
|
2438
|
+
body?: {
|
|
2439
|
+
[key: string]: any;
|
|
2440
|
+
};
|
|
2441
|
+
code?: string;
|
|
2442
|
+
status?: "succeeded" | "failed";
|
|
2443
|
+
start_date?: string;
|
|
2444
|
+
end_date?: string;
|
|
2445
|
+
event_id?: string;
|
|
2446
|
+
}
|
|
2447
|
+
export interface UpdateFileProxyUseCaseRequest {
|
|
2448
|
+
/**
|
|
2449
|
+
* Use case name
|
|
2450
|
+
*/
|
|
2451
|
+
name?: string;
|
|
2452
|
+
/**
|
|
2453
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Can only be set once on use cases that don't have a slug yet. Immutable after being set.
|
|
2454
|
+
*
|
|
2455
|
+
*/
|
|
2456
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
2457
|
+
/**
|
|
2458
|
+
* Whether the use case is enabled
|
|
2459
|
+
*/
|
|
2460
|
+
enabled?: boolean;
|
|
2461
|
+
/**
|
|
2462
|
+
* Optional description of this change (like a commit message)
|
|
2463
|
+
*/
|
|
2464
|
+
change_description?: string;
|
|
2465
|
+
/**
|
|
2466
|
+
* Use case type
|
|
2467
|
+
*/
|
|
2468
|
+
type?: "file_proxy";
|
|
2469
|
+
configuration?: /**
|
|
2470
|
+
* Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
|
|
2471
|
+
*
|
|
2472
|
+
* The file proxy download URL always requires `orgId`, `integrationId`, and either `useCaseSlug` (recommended) or `useCaseId` (legacy UUID) as query parameters.
|
|
2473
|
+
* The `orgId` is included in the signed URL to establish organization context without requiring authentication.
|
|
2474
|
+
* Additional use-case-specific parameters are declared in the `params` array.
|
|
2475
|
+
*
|
|
2476
|
+
*/
|
|
2477
|
+
FileProxyUseCaseConfiguration;
|
|
2478
|
+
}
|
|
2479
|
+
export interface UpdateInboundUseCaseRequest {
|
|
2480
|
+
/**
|
|
2481
|
+
* Use case name
|
|
2482
|
+
*/
|
|
2483
|
+
name?: string;
|
|
2484
|
+
/**
|
|
2485
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Can only be set once on use cases that don't have a slug yet. Immutable after being set.
|
|
2486
|
+
*
|
|
2487
|
+
*/
|
|
2488
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
2489
|
+
/**
|
|
2490
|
+
* Whether the use case is enabled
|
|
2491
|
+
*/
|
|
2492
|
+
enabled?: boolean;
|
|
2493
|
+
/**
|
|
2494
|
+
* Optional description of this change (like a commit message)
|
|
2495
|
+
*/
|
|
2496
|
+
change_description?: string;
|
|
2497
|
+
/**
|
|
2498
|
+
* Use case type
|
|
2499
|
+
*/
|
|
2500
|
+
type?: "inbound";
|
|
2501
|
+
configuration?: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
|
|
2502
|
+
}
|
|
2503
|
+
export type UpdateIntegrationRequest = IntegrationEditableFields;
|
|
2504
|
+
export interface UpdateOutboundUseCaseRequest {
|
|
2505
|
+
/**
|
|
2506
|
+
* Use case name
|
|
2507
|
+
*/
|
|
2508
|
+
name?: string;
|
|
2509
|
+
/**
|
|
2510
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Can only be set once on use cases that don't have a slug yet. Immutable after being set.
|
|
2511
|
+
*
|
|
2512
|
+
*/
|
|
2513
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
2514
|
+
/**
|
|
2515
|
+
* Whether the use case is enabled
|
|
2516
|
+
*/
|
|
2517
|
+
enabled?: boolean;
|
|
2518
|
+
/**
|
|
2519
|
+
* Optional description of this change (like a commit message)
|
|
2520
|
+
*/
|
|
2521
|
+
change_description?: string;
|
|
2522
|
+
/**
|
|
2523
|
+
* Use case type
|
|
2524
|
+
*/
|
|
2525
|
+
type?: "outbound";
|
|
2526
|
+
configuration?: /* Configuration for outbound use cases. Defines the event that triggers the flow and the webhook mappings. */ OutboundIntegrationEventConfiguration;
|
|
2527
|
+
}
|
|
2528
|
+
export type UpdateUseCaseRequest = UpdateInboundUseCaseRequest | UpdateOutboundUseCaseRequest | UpdateFileProxyUseCaseRequest;
|
|
2529
|
+
export interface UpdateUseCaseRequestBase {
|
|
2530
|
+
/**
|
|
2531
|
+
* Use case name
|
|
2532
|
+
*/
|
|
2533
|
+
name?: string;
|
|
2534
|
+
/**
|
|
2535
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Can only be set once on use cases that don't have a slug yet. Immutable after being set.
|
|
2536
|
+
*
|
|
2537
|
+
*/
|
|
2538
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
2539
|
+
/**
|
|
2540
|
+
* Whether the use case is enabled
|
|
2541
|
+
*/
|
|
2542
|
+
enabled?: boolean;
|
|
2543
|
+
/**
|
|
2544
|
+
* Optional description of this change (like a commit message)
|
|
2545
|
+
*/
|
|
2546
|
+
change_description?: string;
|
|
2547
|
+
}
|
|
2548
|
+
/**
|
|
2549
|
+
* Request to create or update an integration with embedded use cases (upsert).
|
|
2550
|
+
* This is a declarative operation - the request represents the desired state.
|
|
2551
|
+
*
|
|
2552
|
+
*/
|
|
2553
|
+
export interface UpsertIntegrationWithUseCasesRequest {
|
|
2554
|
+
/**
|
|
2555
|
+
* Integration name
|
|
2556
|
+
*/
|
|
2557
|
+
name: string;
|
|
2558
|
+
/**
|
|
2559
|
+
* Optional description of the integration
|
|
2560
|
+
*/
|
|
2561
|
+
description?: string;
|
|
2562
|
+
/**
|
|
2563
|
+
* List of access token IDs associated with this integration
|
|
2564
|
+
*/
|
|
2565
|
+
access_token_ids?: string[];
|
|
2566
|
+
/**
|
|
2567
|
+
* List of app IDs associated with this integration
|
|
2568
|
+
*/
|
|
2569
|
+
app_ids?: string[];
|
|
2570
|
+
/**
|
|
2571
|
+
* Configuration defining environment variables needed by this integration. Values are stored in the Environments API.
|
|
2572
|
+
*/
|
|
2573
|
+
environment_config?: EnvironmentFieldConfig[];
|
|
2574
|
+
settings?: /* Settings for the integration */ IntegrationSettings;
|
|
2575
|
+
/**
|
|
2576
|
+
* Full list of use cases (declarative). This replaces ALL existing use cases.
|
|
2577
|
+
* - Use cases with an `id` field matching an existing use case will be updated
|
|
2578
|
+
* - Use cases without an `id` or with a non-matching `id` will be created
|
|
2579
|
+
* - Existing use cases not in this list will be deleted
|
|
2580
|
+
*
|
|
2581
|
+
*/
|
|
2582
|
+
use_cases?: EmbeddedUseCaseRequest[];
|
|
2583
|
+
}
|
|
2584
|
+
export type UseCase = InboundUseCase | OutboundUseCase | FileProxyUseCase;
|
|
2585
|
+
export interface UseCaseBase {
|
|
2586
|
+
/**
|
|
2587
|
+
* Unique identifier for the use case
|
|
2588
|
+
*/
|
|
2589
|
+
id: string; // uuid
|
|
2590
|
+
/**
|
|
2591
|
+
* Parent integration ID
|
|
2592
|
+
*/
|
|
2593
|
+
integrationId: string; // uuid
|
|
2594
|
+
/**
|
|
2595
|
+
* Use case name
|
|
2596
|
+
*/
|
|
2597
|
+
name: string;
|
|
2598
|
+
/**
|
|
2599
|
+
* URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
2600
|
+
*
|
|
2601
|
+
*/
|
|
2602
|
+
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
2603
|
+
/**
|
|
2604
|
+
* Use case type
|
|
2605
|
+
*/
|
|
2606
|
+
type: "inbound" | "outbound" | "file_proxy";
|
|
2607
|
+
enabled: boolean;
|
|
2608
|
+
/**
|
|
2609
|
+
* Description of the last change made to this use case
|
|
2610
|
+
*/
|
|
2611
|
+
change_description?: string;
|
|
2612
|
+
/**
|
|
2613
|
+
* ISO-8601 timestamp when the use case was created
|
|
2614
|
+
*/
|
|
2615
|
+
created_at: string; // date-time
|
|
2616
|
+
/**
|
|
2617
|
+
* ISO-8601 timestamp when the use case was last updated
|
|
2618
|
+
*/
|
|
2619
|
+
updated_at: string; // date-time
|
|
2620
|
+
}
|
|
2621
|
+
export type UseCaseHistoryEntry = InboundUseCaseHistoryEntry | OutboundUseCaseHistoryEntry | FileProxyUseCaseHistoryEntry;
|
|
2622
|
+
export interface UseCaseHistoryEntryBase {
|
|
2623
|
+
/**
|
|
2624
|
+
* Unique identifier for this history entry
|
|
2625
|
+
*/
|
|
2626
|
+
id: string; // uuid
|
|
2627
|
+
/**
|
|
2628
|
+
* Reference to the parent use case
|
|
2629
|
+
*/
|
|
2630
|
+
useCaseId: string; // uuid
|
|
2631
|
+
/**
|
|
2632
|
+
* Parent integration ID
|
|
2633
|
+
*/
|
|
2634
|
+
integrationId: string; // uuid
|
|
2635
|
+
/**
|
|
2636
|
+
* Use case name at this point in history
|
|
2637
|
+
*/
|
|
2638
|
+
name: string;
|
|
2639
|
+
/**
|
|
2640
|
+
* Use case slug at this point in history
|
|
2641
|
+
*/
|
|
2642
|
+
slug?: string;
|
|
2643
|
+
/**
|
|
2644
|
+
* Whether the use case was enabled at this point in history
|
|
2645
|
+
*/
|
|
2646
|
+
enabled: boolean;
|
|
2647
|
+
/**
|
|
2648
|
+
* Description of the change that was made at this point in history
|
|
2649
|
+
*/
|
|
2650
|
+
change_description?: string;
|
|
2651
|
+
/**
|
|
2652
|
+
* ISO-8601 timestamp when the use case was originally created
|
|
2653
|
+
*/
|
|
2654
|
+
created_at: string; // date-time
|
|
2655
|
+
/**
|
|
2656
|
+
* ISO-8601 timestamp of this historical snapshot (before the update)
|
|
2657
|
+
*/
|
|
2658
|
+
updated_at: string; // date-time
|
|
2659
|
+
/**
|
|
2660
|
+
* ISO-8601 timestamp when this history entry was created
|
|
2661
|
+
*/
|
|
2662
|
+
history_created_at: string; // date-time
|
|
2663
|
+
}
|
|
2664
|
+
export interface WebhookStatus {
|
|
2665
|
+
/**
|
|
2666
|
+
* Unique identifier for the webhook
|
|
2667
|
+
*/
|
|
2668
|
+
webhookId: string;
|
|
2669
|
+
/**
|
|
2670
|
+
* Human-readable name of the webhook
|
|
2671
|
+
*/
|
|
2672
|
+
webhookName?: string;
|
|
2673
|
+
/**
|
|
2674
|
+
* Whether the webhook is enabled. Null if the API is unreachable.
|
|
2675
|
+
*/
|
|
2676
|
+
enabled?: boolean | null;
|
|
2677
|
+
}
|
|
2678
|
+
}
|
|
2679
|
+
}
|
|
2680
|
+
declare namespace Paths {
|
|
2681
|
+
namespace AcknowledgeTracking {
|
|
2682
|
+
export interface RequestBody {
|
|
2683
|
+
/**
|
|
2684
|
+
* Unique identifier of the ERP tracking record to acknowledge
|
|
2685
|
+
*/
|
|
2686
|
+
ack_id: string;
|
|
2687
|
+
}
|
|
2688
|
+
namespace Responses {
|
|
2689
|
+
export interface $200 {
|
|
2690
|
+
message?: string;
|
|
2691
|
+
}
|
|
2692
|
+
export interface $400 {
|
|
2693
|
+
}
|
|
2694
|
+
export interface $401 {
|
|
2695
|
+
}
|
|
2696
|
+
export interface $404 {
|
|
2697
|
+
}
|
|
2698
|
+
export interface $500 {
|
|
2699
|
+
}
|
|
2700
|
+
}
|
|
2701
|
+
}
|
|
2702
|
+
namespace CreateIntegration {
|
|
2703
|
+
export type RequestBody = Components.Schemas.CreateIntegrationRequest;
|
|
2704
|
+
namespace Responses {
|
|
2705
|
+
export type $201 = Components.Schemas.Integration;
|
|
2706
|
+
export type $400 = Components.Responses.BadRequest;
|
|
2707
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2708
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2709
|
+
}
|
|
2710
|
+
}
|
|
2711
|
+
namespace CreateIntegrationV2 {
|
|
2712
|
+
export type RequestBody = /**
|
|
2713
|
+
* Request to create or update an integration with embedded use cases (upsert).
|
|
2714
|
+
* This is a declarative operation - the request represents the desired state.
|
|
2715
|
+
*
|
|
2716
|
+
*/
|
|
2717
|
+
Components.Schemas.UpsertIntegrationWithUseCasesRequest;
|
|
2718
|
+
namespace Responses {
|
|
2719
|
+
export type $201 = /* Integration with embedded use cases for atomic CRUD operations */ Components.Schemas.IntegrationWithUseCases;
|
|
2720
|
+
export type $400 = Components.Responses.BadRequest;
|
|
2721
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2722
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2723
|
+
}
|
|
2724
|
+
}
|
|
2725
|
+
namespace CreateUseCase {
|
|
2726
|
+
namespace Parameters {
|
|
2727
|
+
export type IntegrationId = string; // uuid
|
|
2728
|
+
}
|
|
2729
|
+
export interface PathParameters {
|
|
2730
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2731
|
+
}
|
|
2732
|
+
export type RequestBody = Components.Schemas.CreateUseCaseRequest;
|
|
2733
|
+
namespace Responses {
|
|
2734
|
+
export type $201 = Components.Schemas.UseCase;
|
|
2735
|
+
export type $400 = Components.Responses.BadRequest;
|
|
2736
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2737
|
+
export interface $404 {
|
|
2738
|
+
}
|
|
2739
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2740
|
+
}
|
|
2741
|
+
}
|
|
2742
|
+
namespace DeleteIntegration {
|
|
2743
|
+
namespace Parameters {
|
|
2744
|
+
export type IntegrationId = string; // uuid
|
|
2745
|
+
}
|
|
2746
|
+
export interface PathParameters {
|
|
2747
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2748
|
+
}
|
|
2749
|
+
namespace Responses {
|
|
2750
|
+
export interface $200 {
|
|
2751
|
+
message?: string;
|
|
2752
|
+
}
|
|
2753
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2754
|
+
export interface $404 {
|
|
2755
|
+
}
|
|
2756
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2757
|
+
}
|
|
2758
|
+
}
|
|
2759
|
+
namespace DeleteIntegrationAppMapping {
|
|
2760
|
+
namespace Parameters {
|
|
2761
|
+
export type IntegrationId = string; // uuid
|
|
2762
|
+
}
|
|
2763
|
+
export interface PathParameters {
|
|
2764
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2765
|
+
}
|
|
2766
|
+
export type RequestBody = Components.Schemas.DeleteIntegrationAppMappingRequest;
|
|
2767
|
+
namespace Responses {
|
|
2768
|
+
export interface $200 {
|
|
2769
|
+
message?: string;
|
|
2770
|
+
}
|
|
2771
|
+
export type $400 = Components.Responses.BadRequest;
|
|
2772
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2773
|
+
export interface $404 {
|
|
2774
|
+
}
|
|
2775
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2776
|
+
}
|
|
2777
|
+
}
|
|
2778
|
+
namespace DeleteIntegrationV2 {
|
|
2779
|
+
namespace Parameters {
|
|
2780
|
+
export type IntegrationId = string; // uuid
|
|
2781
|
+
}
|
|
2782
|
+
export interface PathParameters {
|
|
2783
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2784
|
+
}
|
|
2785
|
+
namespace Responses {
|
|
2786
|
+
export interface $200 {
|
|
2787
|
+
message?: string;
|
|
2788
|
+
}
|
|
2789
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2790
|
+
export interface $404 {
|
|
2791
|
+
}
|
|
2792
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2793
|
+
}
|
|
2794
|
+
}
|
|
2795
|
+
namespace DeleteUseCase {
|
|
2796
|
+
namespace Parameters {
|
|
2797
|
+
export type IntegrationId = string; // uuid
|
|
2798
|
+
export type UseCaseId = string; // uuid
|
|
2799
|
+
}
|
|
2800
|
+
export interface PathParameters {
|
|
2801
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2802
|
+
useCaseId: Parameters.UseCaseId /* uuid */;
|
|
2803
|
+
}
|
|
2804
|
+
namespace Responses {
|
|
2805
|
+
export interface $200 {
|
|
2806
|
+
message?: string;
|
|
2807
|
+
}
|
|
2808
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2809
|
+
export interface $404 {
|
|
2810
|
+
}
|
|
2811
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2812
|
+
}
|
|
2813
|
+
}
|
|
2814
|
+
namespace GetIntegration {
|
|
2815
|
+
namespace Parameters {
|
|
2816
|
+
export type IntegrationId = string; // uuid
|
|
2817
|
+
}
|
|
2818
|
+
export interface PathParameters {
|
|
2819
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2820
|
+
}
|
|
2821
|
+
namespace Responses {
|
|
2822
|
+
export type $200 = Components.Schemas.Integration;
|
|
2823
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2824
|
+
export interface $404 {
|
|
2825
|
+
}
|
|
2826
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2827
|
+
}
|
|
2828
|
+
}
|
|
2829
|
+
namespace GetIntegrationV2 {
|
|
2830
|
+
namespace Parameters {
|
|
2831
|
+
export type IntegrationId = string; // uuid
|
|
2832
|
+
}
|
|
2833
|
+
export interface PathParameters {
|
|
2834
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2835
|
+
}
|
|
2836
|
+
namespace Responses {
|
|
2837
|
+
export type $200 = /* Integration with embedded use cases for atomic CRUD operations */ Components.Schemas.IntegrationWithUseCases;
|
|
2838
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2839
|
+
export interface $404 {
|
|
2840
|
+
}
|
|
2841
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2842
|
+
}
|
|
2843
|
+
}
|
|
2844
|
+
namespace GetMonitoringStats {
|
|
2845
|
+
namespace Parameters {
|
|
2846
|
+
export type IntegrationId = string; // uuid
|
|
2847
|
+
}
|
|
2848
|
+
export interface PathParameters {
|
|
2849
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2850
|
+
}
|
|
2851
|
+
export type RequestBody = Components.Schemas.GetMonitoringStatsRequest;
|
|
2852
|
+
namespace Responses {
|
|
2853
|
+
export type $200 = Components.Responses.GetMonitoringStatsResponse;
|
|
2854
|
+
export type $400 = Components.Responses.BadRequest;
|
|
2855
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2856
|
+
export type $404 = Components.Responses.NotFound;
|
|
2857
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2858
|
+
}
|
|
2859
|
+
}
|
|
2860
|
+
namespace GetMonitoringTimeSeries {
|
|
2861
|
+
namespace Parameters {
|
|
2862
|
+
export type IntegrationId = string; // uuid
|
|
2863
|
+
}
|
|
2864
|
+
export interface PathParameters {
|
|
2865
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2866
|
+
}
|
|
2867
|
+
export type RequestBody = Components.Schemas.GetMonitoringTimeSeriesRequest;
|
|
2868
|
+
namespace Responses {
|
|
2869
|
+
export type $200 = Components.Responses.GetMonitoringTimeSeriesResponse;
|
|
2870
|
+
export type $400 = Components.Responses.BadRequest;
|
|
2871
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2872
|
+
export type $404 = Components.Responses.NotFound;
|
|
2873
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2874
|
+
}
|
|
2875
|
+
}
|
|
2876
|
+
namespace GetOutboundStatus {
|
|
2877
|
+
namespace Parameters {
|
|
2878
|
+
export type IntegrationId = string; // uuid
|
|
2879
|
+
}
|
|
2880
|
+
export interface PathParameters {
|
|
2881
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2882
|
+
}
|
|
2883
|
+
namespace Responses {
|
|
2884
|
+
export type $200 = Components.Schemas.OutboundStatusResponse;
|
|
2885
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2886
|
+
export type $404 = Components.Responses.NotFound;
|
|
2887
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2888
|
+
}
|
|
2889
|
+
}
|
|
2890
|
+
namespace GetUseCase {
|
|
2891
|
+
namespace Parameters {
|
|
2892
|
+
export type IntegrationId = string; // uuid
|
|
2893
|
+
export type UseCaseId = string; // uuid
|
|
2894
|
+
}
|
|
2895
|
+
export interface PathParameters {
|
|
2896
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2897
|
+
useCaseId: Parameters.UseCaseId /* uuid */;
|
|
2898
|
+
}
|
|
2899
|
+
namespace Responses {
|
|
2900
|
+
export type $200 = Components.Schemas.UseCase;
|
|
2901
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2902
|
+
export interface $404 {
|
|
2903
|
+
}
|
|
2904
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2905
|
+
}
|
|
2906
|
+
}
|
|
2907
|
+
namespace ListIntegrations {
|
|
2908
|
+
namespace Responses {
|
|
2909
|
+
export interface $200 {
|
|
2910
|
+
integrations: Components.Schemas.Integration[];
|
|
2911
|
+
}
|
|
2912
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2913
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2914
|
+
}
|
|
2915
|
+
}
|
|
2916
|
+
namespace ListIntegrationsV2 {
|
|
2917
|
+
namespace Responses {
|
|
2918
|
+
export interface $200 {
|
|
2919
|
+
integrations: /* Integration with embedded use cases for atomic CRUD operations */ Components.Schemas.IntegrationWithUseCases[];
|
|
2920
|
+
}
|
|
2921
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2922
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2923
|
+
}
|
|
2924
|
+
}
|
|
2925
|
+
namespace ListUseCaseHistory {
|
|
2926
|
+
namespace Parameters {
|
|
2927
|
+
export type Cursor = string;
|
|
2928
|
+
export type IntegrationId = string; // uuid
|
|
2929
|
+
export type UseCaseId = string; // uuid
|
|
2930
|
+
}
|
|
2931
|
+
export interface PathParameters {
|
|
2932
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2933
|
+
useCaseId: Parameters.UseCaseId /* uuid */;
|
|
2934
|
+
}
|
|
2935
|
+
export interface QueryParameters {
|
|
2936
|
+
cursor?: Parameters.Cursor;
|
|
2937
|
+
}
|
|
2938
|
+
namespace Responses {
|
|
2939
|
+
export interface $200 {
|
|
2940
|
+
/**
|
|
2941
|
+
* History entries in reverse chronological order (newest first)
|
|
2942
|
+
*/
|
|
2943
|
+
history: Components.Schemas.UseCaseHistoryEntry[];
|
|
2944
|
+
/**
|
|
2945
|
+
* Opaque cursor for fetching the next page. Absent if no more pages.
|
|
2946
|
+
*/
|
|
2947
|
+
next_cursor?: string;
|
|
2948
|
+
}
|
|
2949
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2950
|
+
export interface $404 {
|
|
2951
|
+
}
|
|
2952
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2953
|
+
}
|
|
2954
|
+
}
|
|
2955
|
+
namespace ListUseCases {
|
|
2956
|
+
namespace Parameters {
|
|
2957
|
+
export type IntegrationId = string; // uuid
|
|
2958
|
+
}
|
|
2959
|
+
export interface PathParameters {
|
|
2960
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
2961
|
+
}
|
|
2962
|
+
namespace Responses {
|
|
2963
|
+
export interface $200 {
|
|
2964
|
+
use_cases: Components.Schemas.UseCase[];
|
|
2965
|
+
}
|
|
2966
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2967
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
2968
|
+
}
|
|
2969
|
+
}
|
|
2970
|
+
namespace ProcessErpUpdatesEvents {
|
|
2971
|
+
export interface RequestBody {
|
|
2972
|
+
/**
|
|
2973
|
+
* UUID that identifies the specific integration app instance
|
|
2974
|
+
*/
|
|
2975
|
+
app_id: string; // uuid
|
|
2976
|
+
/**
|
|
2977
|
+
* UUID that identifies the specific integration app component instance
|
|
2978
|
+
*/
|
|
2979
|
+
component_id: string; // uuid
|
|
2980
|
+
/**
|
|
2981
|
+
* Metadata to be passed along with the events
|
|
2982
|
+
*/
|
|
2983
|
+
meta: {
|
|
2984
|
+
[name: string]: any;
|
|
2985
|
+
/**
|
|
2986
|
+
* ID that identifies the specific request for debugging purposes
|
|
2987
|
+
*/
|
|
2988
|
+
correlation_id?: string;
|
|
2989
|
+
};
|
|
2990
|
+
/**
|
|
2991
|
+
* List of ERP events to process
|
|
2992
|
+
*/
|
|
2993
|
+
events: Components.Schemas.ErpEvent[];
|
|
2994
|
+
}
|
|
2995
|
+
namespace Responses {
|
|
2996
|
+
export type $200 = Components.Responses.ERPUpdatesResponse;
|
|
2997
|
+
export type $400 = Components.Responses.BadRequest;
|
|
2998
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
2999
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3000
|
+
}
|
|
3001
|
+
}
|
|
3002
|
+
namespace ProcessErpUpdatesEventsV2 {
|
|
3003
|
+
export type RequestBody = Components.Schemas.ErpUpdatesEventsV2Request;
|
|
3004
|
+
namespace Responses {
|
|
3005
|
+
export type $200 = Components.Responses.ERPUpdatesResponse;
|
|
3006
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3007
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3008
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3009
|
+
}
|
|
3010
|
+
}
|
|
3011
|
+
namespace ProcessErpUpdatesEventsV3 {
|
|
3012
|
+
export type RequestBody = Components.Schemas.ErpUpdatesEventsV3Request;
|
|
3013
|
+
namespace Responses {
|
|
3014
|
+
export type $200 = Components.Responses.ERPUpdatesResponse;
|
|
3015
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3016
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3017
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3018
|
+
}
|
|
3019
|
+
}
|
|
3020
|
+
namespace QueryAccessLogs {
|
|
3021
|
+
namespace Parameters {
|
|
3022
|
+
export type IntegrationId = string; // uuid
|
|
3023
|
+
}
|
|
3024
|
+
export interface PathParameters {
|
|
3025
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
3026
|
+
}
|
|
3027
|
+
export type RequestBody = Components.Schemas.QueryAccessLogsRequest;
|
|
3028
|
+
namespace Responses {
|
|
3029
|
+
export type $200 = Components.Responses.QueryAccessLogsResponse;
|
|
3030
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3031
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3032
|
+
export type $404 = Components.Responses.NotFound;
|
|
3033
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3034
|
+
}
|
|
3035
|
+
}
|
|
3036
|
+
namespace QueryEvents {
|
|
3037
|
+
namespace Parameters {
|
|
3038
|
+
export type IntegrationId = string; // uuid
|
|
3039
|
+
}
|
|
3040
|
+
export interface PathParameters {
|
|
3041
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
3042
|
+
}
|
|
3043
|
+
export type RequestBody = Components.Schemas.QueryEventsRequest;
|
|
3044
|
+
namespace Responses {
|
|
3045
|
+
export type $200 = Components.Responses.QueryEventsResponse;
|
|
3046
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3047
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3048
|
+
export type $404 = Components.Responses.NotFound;
|
|
3049
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3050
|
+
}
|
|
3051
|
+
}
|
|
3052
|
+
namespace QueryInboundMonitoringEvents {
|
|
3053
|
+
namespace Parameters {
|
|
3054
|
+
export type IntegrationId = string; // uuid
|
|
3055
|
+
}
|
|
3056
|
+
export interface PathParameters {
|
|
3057
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
3058
|
+
}
|
|
3059
|
+
export type RequestBody = Components.Schemas.QueryInboundMonitoringEventsRequest;
|
|
3060
|
+
namespace Responses {
|
|
3061
|
+
export type $200 = Components.Responses.QueryInboundMonitoringEventsResponse;
|
|
3062
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3063
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3064
|
+
export type $404 = Components.Responses.NotFound;
|
|
3065
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3066
|
+
}
|
|
3067
|
+
}
|
|
3068
|
+
namespace QueryOutboundMonitoringEvents {
|
|
3069
|
+
namespace Parameters {
|
|
3070
|
+
export type IntegrationId = string; // uuid
|
|
3071
|
+
}
|
|
3072
|
+
export interface PathParameters {
|
|
3073
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
3074
|
+
}
|
|
3075
|
+
export type RequestBody = Components.Schemas.QueryOutboundMonitoringEventsRequest;
|
|
3076
|
+
namespace Responses {
|
|
3077
|
+
export type $200 = Components.Responses.QueryOutboundMonitoringEventsResponse;
|
|
3078
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3079
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3080
|
+
export type $404 = Components.Responses.NotFound;
|
|
3081
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3082
|
+
}
|
|
3083
|
+
}
|
|
3084
|
+
namespace ReplayEvents {
|
|
3085
|
+
namespace Parameters {
|
|
3086
|
+
export type IntegrationId = string; // uuid
|
|
3087
|
+
}
|
|
3088
|
+
export interface PathParameters {
|
|
3089
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
3090
|
+
}
|
|
3091
|
+
export type RequestBody = Components.Schemas.ReplayEventsRequest;
|
|
3092
|
+
namespace Responses {
|
|
3093
|
+
export type $200 = Components.Responses.ReplayEventsResponse;
|
|
3094
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3095
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3096
|
+
export type $404 = Components.Responses.NotFound;
|
|
3097
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3098
|
+
}
|
|
3099
|
+
}
|
|
3100
|
+
namespace SetIntegrationAppMapping {
|
|
3101
|
+
namespace Parameters {
|
|
3102
|
+
export type IntegrationId = string; // uuid
|
|
3103
|
+
}
|
|
3104
|
+
export interface PathParameters {
|
|
3105
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
3106
|
+
}
|
|
3107
|
+
export type RequestBody = Components.Schemas.SetIntegrationAppMappingRequest;
|
|
3108
|
+
namespace Responses {
|
|
3109
|
+
export type $200 = Components.Schemas.IntegrationAppMapping;
|
|
3110
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3111
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3112
|
+
export interface $404 {
|
|
3113
|
+
}
|
|
3114
|
+
export type $409 = Components.Schemas.ErrorResponseBase;
|
|
3115
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3116
|
+
}
|
|
3117
|
+
}
|
|
3118
|
+
namespace SimulateMapping {
|
|
3119
|
+
export type RequestBody = Components.Schemas.MappingSimulationRequest;
|
|
3120
|
+
namespace Responses {
|
|
3121
|
+
export type $200 = Components.Schemas.MappingSimulationResponse;
|
|
3122
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3123
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3124
|
+
export type $422 = Components.Schemas.ErrorResponseBase;
|
|
3125
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3126
|
+
}
|
|
3127
|
+
}
|
|
3128
|
+
namespace SimulateMappingV2 {
|
|
3129
|
+
export type RequestBody = /**
|
|
3130
|
+
* Request for v2 mapping simulation. Uses the same configuration format stored in integration use case resources,
|
|
3131
|
+
* making it easier to test configurations before saving them.
|
|
3132
|
+
*
|
|
3133
|
+
*/
|
|
3134
|
+
Components.Schemas.MappingSimulationV2Request;
|
|
3135
|
+
namespace Responses {
|
|
3136
|
+
export type $200 = Components.Schemas.MappingSimulationResponse;
|
|
3137
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3138
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3139
|
+
export type $422 = Components.Schemas.ErrorResponseBase;
|
|
3140
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3141
|
+
}
|
|
3142
|
+
}
|
|
3143
|
+
namespace TriggerErp {
|
|
3144
|
+
export type RequestBody = Components.Schemas.TriggerErpActionRequest;
|
|
3145
|
+
namespace Responses {
|
|
3146
|
+
export type $200 = Components.Responses.TriggerWebhookResponse;
|
|
3147
|
+
export interface $400 {
|
|
3148
|
+
}
|
|
3149
|
+
export interface $401 {
|
|
3150
|
+
}
|
|
3151
|
+
export interface $500 {
|
|
3152
|
+
}
|
|
3153
|
+
}
|
|
3154
|
+
}
|
|
3155
|
+
namespace UpdateIntegration {
|
|
3156
|
+
namespace Parameters {
|
|
3157
|
+
export type IntegrationId = string; // uuid
|
|
3158
|
+
}
|
|
3159
|
+
export interface PathParameters {
|
|
3160
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
3161
|
+
}
|
|
3162
|
+
export type RequestBody = Components.Schemas.UpdateIntegrationRequest;
|
|
3163
|
+
namespace Responses {
|
|
3164
|
+
export type $200 = Components.Schemas.Integration;
|
|
3165
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3166
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3167
|
+
export interface $404 {
|
|
3168
|
+
}
|
|
3169
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3170
|
+
}
|
|
3171
|
+
}
|
|
3172
|
+
namespace UpdateIntegrationV2 {
|
|
3173
|
+
namespace Parameters {
|
|
3174
|
+
export type IntegrationId = string; // uuid
|
|
3175
|
+
}
|
|
3176
|
+
export interface PathParameters {
|
|
3177
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
3178
|
+
}
|
|
3179
|
+
export type RequestBody = /**
|
|
3180
|
+
* Request to create or update an integration with embedded use cases (upsert).
|
|
3181
|
+
* This is a declarative operation - the request represents the desired state.
|
|
3182
|
+
*
|
|
3183
|
+
*/
|
|
3184
|
+
Components.Schemas.UpsertIntegrationWithUseCasesRequest;
|
|
3185
|
+
namespace Responses {
|
|
3186
|
+
export type $200 = /* Integration with embedded use cases for atomic CRUD operations */ Components.Schemas.IntegrationWithUseCases;
|
|
3187
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3188
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3189
|
+
export interface $404 {
|
|
3190
|
+
}
|
|
3191
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3192
|
+
}
|
|
3193
|
+
}
|
|
3194
|
+
namespace UpdateUseCase {
|
|
3195
|
+
namespace Parameters {
|
|
3196
|
+
export type IntegrationId = string; // uuid
|
|
3197
|
+
export type UseCaseId = string; // uuid
|
|
3198
|
+
}
|
|
3199
|
+
export interface PathParameters {
|
|
3200
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
3201
|
+
useCaseId: Parameters.UseCaseId /* uuid */;
|
|
3202
|
+
}
|
|
3203
|
+
export type RequestBody = Components.Schemas.UpdateUseCaseRequest;
|
|
3204
|
+
namespace Responses {
|
|
3205
|
+
export type $200 = Components.Schemas.UseCase;
|
|
3206
|
+
export type $400 = Components.Responses.BadRequest;
|
|
3207
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
3208
|
+
export interface $404 {
|
|
3209
|
+
}
|
|
3210
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
3211
|
+
}
|
|
3212
|
+
}
|
|
3213
|
+
}
|
|
3214
|
+
|
|
3215
|
+
|
|
3216
|
+
interface OperationMethods {
|
|
3217
|
+
/**
|
|
3218
|
+
* acknowledgeTracking - acknowledgeTracking
|
|
3219
|
+
*
|
|
3220
|
+
* Acknowledges an ERP tracking record by removing it from the tracking table, requires public authentication
|
|
3221
|
+
*/
|
|
3222
|
+
'acknowledgeTracking'(
|
|
3223
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3224
|
+
data?: Paths.AcknowledgeTracking.RequestBody,
|
|
3225
|
+
config?: AxiosRequestConfig
|
|
3226
|
+
): OperationResponse<Paths.AcknowledgeTracking.Responses.$200>
|
|
3227
|
+
/**
|
|
3228
|
+
* triggerErp - triggerErp
|
|
3229
|
+
*
|
|
3230
|
+
* Triggers the ERP integration process
|
|
3231
|
+
*/
|
|
3232
|
+
'triggerErp'(
|
|
3233
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3234
|
+
data?: Paths.TriggerErp.RequestBody,
|
|
3235
|
+
config?: AxiosRequestConfig
|
|
3236
|
+
): OperationResponse<Paths.TriggerErp.Responses.$200>
|
|
3237
|
+
/**
|
|
3238
|
+
* processErpUpdatesEvents - processErpUpdatesEvents
|
|
3239
|
+
*
|
|
3240
|
+
* Handles updates from ERP systems and tracks them appropriately
|
|
3241
|
+
*/
|
|
3242
|
+
'processErpUpdatesEvents'(
|
|
3243
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3244
|
+
data?: Paths.ProcessErpUpdatesEvents.RequestBody,
|
|
3245
|
+
config?: AxiosRequestConfig
|
|
3246
|
+
): OperationResponse<Paths.ProcessErpUpdatesEvents.Responses.$200>
|
|
3247
|
+
/**
|
|
3248
|
+
* processErpUpdatesEventsV2 - processErpUpdatesEventsV2
|
|
3249
|
+
*
|
|
3250
|
+
* Handles updates from ERP systems using integration_id directly.
|
|
3251
|
+
* This is the v2 version that simplifies the API by accepting integration_id
|
|
3252
|
+
* instead of app_id and component_id.
|
|
3253
|
+
*
|
|
3254
|
+
*/
|
|
3255
|
+
'processErpUpdatesEventsV2'(
|
|
3256
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3257
|
+
data?: Paths.ProcessErpUpdatesEventsV2.RequestBody,
|
|
3258
|
+
config?: AxiosRequestConfig
|
|
3259
|
+
): OperationResponse<Paths.ProcessErpUpdatesEventsV2.Responses.$200>
|
|
3260
|
+
/**
|
|
3261
|
+
* processErpUpdatesEventsV3 - processErpUpdatesEventsV3
|
|
3262
|
+
*
|
|
3263
|
+
* Handles updates from ERP systems using integration_id directly.
|
|
3264
|
+
* This is the v3 version that removes the unused event_type field and renames object_type to event_name
|
|
3265
|
+
* to align with the integration UI naming.
|
|
3266
|
+
*
|
|
3267
|
+
*/
|
|
3268
|
+
'processErpUpdatesEventsV3'(
|
|
3269
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3270
|
+
data?: Paths.ProcessErpUpdatesEventsV3.RequestBody,
|
|
3271
|
+
config?: AxiosRequestConfig
|
|
3272
|
+
): OperationResponse<Paths.ProcessErpUpdatesEventsV3.Responses.$200>
|
|
3273
|
+
/**
|
|
3274
|
+
* simulateMappingV2 - simulateMappingV2
|
|
3275
|
+
*
|
|
3276
|
+
* Test v2.0 mapping configuration by transforming a payload using the provided mapping rules without persisting data.
|
|
3277
|
+
*
|
|
3278
|
+
* This endpoint accepts the same configuration format that is stored in the integration use case resource,
|
|
3279
|
+
* making it easier to test configurations before saving them to a use case.
|
|
3280
|
+
*
|
|
3281
|
+
* See documentation at /docs/MAPPING_V2.md for detailed v2.0 format specification.
|
|
3282
|
+
*
|
|
3283
|
+
*/
|
|
3284
|
+
'simulateMappingV2'(
|
|
3285
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3286
|
+
data?: Paths.SimulateMappingV2.RequestBody,
|
|
3287
|
+
config?: AxiosRequestConfig
|
|
3288
|
+
): OperationResponse<Paths.SimulateMappingV2.Responses.$200>
|
|
3289
|
+
/**
|
|
3290
|
+
* simulateMapping - simulateMapping
|
|
3291
|
+
*
|
|
3292
|
+
* Test mapping configuration by transforming a payload using the provided mapping rules without persisting data.
|
|
3293
|
+
*
|
|
3294
|
+
* Supports both v1.0 (object-based) and v2.0 (event-based) mapping formats.
|
|
3295
|
+
* See documentation at /docs/MAPPING_V2.md for detailed v2.0 format specification.
|
|
3296
|
+
*
|
|
3297
|
+
*/
|
|
3298
|
+
'simulateMapping'(
|
|
3299
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3300
|
+
data?: Paths.SimulateMapping.RequestBody,
|
|
3301
|
+
config?: AxiosRequestConfig
|
|
3302
|
+
): OperationResponse<Paths.SimulateMapping.Responses.$200>
|
|
3303
|
+
/**
|
|
3304
|
+
* listIntegrations - listIntegrations
|
|
3305
|
+
*
|
|
3306
|
+
* Retrieve all integrations for the authenticated organization
|
|
3307
|
+
*/
|
|
3308
|
+
'listIntegrations'(
|
|
3309
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3310
|
+
data?: any,
|
|
3311
|
+
config?: AxiosRequestConfig
|
|
3312
|
+
): OperationResponse<Paths.ListIntegrations.Responses.$200>
|
|
3313
|
+
/**
|
|
3314
|
+
* createIntegration - createIntegration
|
|
3315
|
+
*
|
|
3316
|
+
* Create a new integration configuration
|
|
3317
|
+
*/
|
|
3318
|
+
'createIntegration'(
|
|
3319
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3320
|
+
data?: Paths.CreateIntegration.RequestBody,
|
|
3321
|
+
config?: AxiosRequestConfig
|
|
3322
|
+
): OperationResponse<Paths.CreateIntegration.Responses.$201>
|
|
3323
|
+
/**
|
|
3324
|
+
* getIntegration - getIntegration
|
|
3325
|
+
*
|
|
3326
|
+
* Retrieve a specific integration by its ID
|
|
3327
|
+
*/
|
|
3328
|
+
'getIntegration'(
|
|
3329
|
+
parameters?: Parameters<Paths.GetIntegration.PathParameters> | null,
|
|
3330
|
+
data?: any,
|
|
3331
|
+
config?: AxiosRequestConfig
|
|
3332
|
+
): OperationResponse<Paths.GetIntegration.Responses.$200>
|
|
3333
|
+
/**
|
|
3334
|
+
* updateIntegration - updateIntegration
|
|
3335
|
+
*
|
|
3336
|
+
* Update an existing integration configuration
|
|
3337
|
+
*/
|
|
3338
|
+
'updateIntegration'(
|
|
3339
|
+
parameters?: Parameters<Paths.UpdateIntegration.PathParameters> | null,
|
|
3340
|
+
data?: Paths.UpdateIntegration.RequestBody,
|
|
3341
|
+
config?: AxiosRequestConfig
|
|
3342
|
+
): OperationResponse<Paths.UpdateIntegration.Responses.$200>
|
|
3343
|
+
/**
|
|
3344
|
+
* deleteIntegration - deleteIntegration
|
|
3345
|
+
*
|
|
3346
|
+
* Delete an integration and all its use cases
|
|
3347
|
+
*/
|
|
3348
|
+
'deleteIntegration'(
|
|
3349
|
+
parameters?: Parameters<Paths.DeleteIntegration.PathParameters> | null,
|
|
3350
|
+
data?: any,
|
|
3351
|
+
config?: AxiosRequestConfig
|
|
3352
|
+
): OperationResponse<Paths.DeleteIntegration.Responses.$200>
|
|
3353
|
+
/**
|
|
3354
|
+
* queryEvents - queryEvents
|
|
3355
|
+
*
|
|
3356
|
+
* Query events for a specific integration
|
|
3357
|
+
*/
|
|
3358
|
+
'queryEvents'(
|
|
3359
|
+
parameters?: Parameters<Paths.QueryEvents.PathParameters> | null,
|
|
3360
|
+
data?: Paths.QueryEvents.RequestBody,
|
|
3361
|
+
config?: AxiosRequestConfig
|
|
3362
|
+
): OperationResponse<Paths.QueryEvents.Responses.$200>
|
|
3363
|
+
/**
|
|
3364
|
+
* replayEvents - replayEvents
|
|
3365
|
+
*
|
|
3366
|
+
* Replay one or more events for a specific integration. Events will be re-processed with their original payloads but with a new correlation ID for traceability.
|
|
3367
|
+
*/
|
|
3368
|
+
'replayEvents'(
|
|
3369
|
+
parameters?: Parameters<Paths.ReplayEvents.PathParameters> | null,
|
|
3370
|
+
data?: Paths.ReplayEvents.RequestBody,
|
|
3371
|
+
config?: AxiosRequestConfig
|
|
3372
|
+
): OperationResponse<Paths.ReplayEvents.Responses.$200>
|
|
3373
|
+
/**
|
|
3374
|
+
* listUseCases - listUseCases
|
|
3375
|
+
*
|
|
3376
|
+
* Retrieve all use cases for a specific integration
|
|
3377
|
+
*/
|
|
3378
|
+
'listUseCases'(
|
|
3379
|
+
parameters?: Parameters<Paths.ListUseCases.PathParameters> | null,
|
|
3380
|
+
data?: any,
|
|
3381
|
+
config?: AxiosRequestConfig
|
|
3382
|
+
): OperationResponse<Paths.ListUseCases.Responses.$200>
|
|
3383
|
+
/**
|
|
3384
|
+
* createUseCase - createUseCase
|
|
3385
|
+
*
|
|
3386
|
+
* Create a new use case for an integration
|
|
3387
|
+
*/
|
|
3388
|
+
'createUseCase'(
|
|
3389
|
+
parameters?: Parameters<Paths.CreateUseCase.PathParameters> | null,
|
|
3390
|
+
data?: Paths.CreateUseCase.RequestBody,
|
|
3391
|
+
config?: AxiosRequestConfig
|
|
3392
|
+
): OperationResponse<Paths.CreateUseCase.Responses.$201>
|
|
3393
|
+
/**
|
|
3394
|
+
* getUseCase - getUseCase
|
|
3395
|
+
*
|
|
3396
|
+
* Retrieve a specific use case by its ID
|
|
3397
|
+
*/
|
|
3398
|
+
'getUseCase'(
|
|
3399
|
+
parameters?: Parameters<Paths.GetUseCase.PathParameters> | null,
|
|
3400
|
+
data?: any,
|
|
3401
|
+
config?: AxiosRequestConfig
|
|
3402
|
+
): OperationResponse<Paths.GetUseCase.Responses.$200>
|
|
3403
|
+
/**
|
|
3404
|
+
* updateUseCase - updateUseCase
|
|
3405
|
+
*
|
|
3406
|
+
* Update an existing use case configuration
|
|
3407
|
+
*/
|
|
3408
|
+
'updateUseCase'(
|
|
3409
|
+
parameters?: Parameters<Paths.UpdateUseCase.PathParameters> | null,
|
|
3410
|
+
data?: Paths.UpdateUseCase.RequestBody,
|
|
3411
|
+
config?: AxiosRequestConfig
|
|
3412
|
+
): OperationResponse<Paths.UpdateUseCase.Responses.$200>
|
|
3413
|
+
/**
|
|
3414
|
+
* deleteUseCase - deleteUseCase
|
|
3415
|
+
*
|
|
3416
|
+
* Delete a use case from an integration
|
|
3417
|
+
*/
|
|
3418
|
+
'deleteUseCase'(
|
|
3419
|
+
parameters?: Parameters<Paths.DeleteUseCase.PathParameters> | null,
|
|
3420
|
+
data?: any,
|
|
3421
|
+
config?: AxiosRequestConfig
|
|
3422
|
+
): OperationResponse<Paths.DeleteUseCase.Responses.$200>
|
|
3423
|
+
/**
|
|
3424
|
+
* listUseCaseHistory - listUseCaseHistory
|
|
3425
|
+
*
|
|
3426
|
+
* Retrieve historical versions of a use case's configuration.
|
|
3427
|
+
* History entries are returned in reverse chronological order (newest first).
|
|
3428
|
+
* Use the 'cursor' parameter for pagination to fetch additional entries.
|
|
3429
|
+
*
|
|
3430
|
+
*/
|
|
3431
|
+
'listUseCaseHistory'(
|
|
3432
|
+
parameters?: Parameters<Paths.ListUseCaseHistory.QueryParameters & Paths.ListUseCaseHistory.PathParameters> | null,
|
|
3433
|
+
data?: any,
|
|
3434
|
+
config?: AxiosRequestConfig
|
|
3435
|
+
): OperationResponse<Paths.ListUseCaseHistory.Responses.$200>
|
|
3436
|
+
/**
|
|
3437
|
+
* listIntegrationsV2 - listIntegrationsV2
|
|
3438
|
+
*
|
|
3439
|
+
* Retrieve all integrations with embedded use cases for the authenticated organization
|
|
3440
|
+
*/
|
|
3441
|
+
'listIntegrationsV2'(
|
|
3442
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3443
|
+
data?: any,
|
|
3444
|
+
config?: AxiosRequestConfig
|
|
3445
|
+
): OperationResponse<Paths.ListIntegrationsV2.Responses.$200>
|
|
3446
|
+
/**
|
|
3447
|
+
* createIntegrationV2 - createIntegrationV2
|
|
3448
|
+
*
|
|
3449
|
+
* Create a new integration with embedded use cases.
|
|
3450
|
+
*
|
|
3451
|
+
*/
|
|
3452
|
+
'createIntegrationV2'(
|
|
3453
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3454
|
+
data?: Paths.CreateIntegrationV2.RequestBody,
|
|
3455
|
+
config?: AxiosRequestConfig
|
|
3456
|
+
): OperationResponse<Paths.CreateIntegrationV2.Responses.$201>
|
|
3457
|
+
/**
|
|
3458
|
+
* getIntegrationV2 - getIntegrationV2
|
|
3459
|
+
*
|
|
3460
|
+
* Retrieve a specific integration with all its embedded use cases
|
|
3461
|
+
*/
|
|
3462
|
+
'getIntegrationV2'(
|
|
3463
|
+
parameters?: Parameters<Paths.GetIntegrationV2.PathParameters> | null,
|
|
3464
|
+
data?: any,
|
|
3465
|
+
config?: AxiosRequestConfig
|
|
3466
|
+
): OperationResponse<Paths.GetIntegrationV2.Responses.$200>
|
|
3467
|
+
/**
|
|
3468
|
+
* updateIntegrationV2 - updateIntegrationV2
|
|
3469
|
+
*
|
|
3470
|
+
* Update an existing integration with embedded use cases.
|
|
3471
|
+
* The integration must already exist.
|
|
3472
|
+
* Use cases are updated declaratively:
|
|
3473
|
+
* - Use cases in the request with matching IDs are updated
|
|
3474
|
+
* - Use cases in the request without matching IDs are created
|
|
3475
|
+
* - Existing use cases not in the request are deleted
|
|
3476
|
+
*
|
|
3477
|
+
*/
|
|
3478
|
+
'updateIntegrationV2'(
|
|
3479
|
+
parameters?: Parameters<Paths.UpdateIntegrationV2.PathParameters> | null,
|
|
3480
|
+
data?: Paths.UpdateIntegrationV2.RequestBody,
|
|
3481
|
+
config?: AxiosRequestConfig
|
|
3482
|
+
): OperationResponse<Paths.UpdateIntegrationV2.Responses.$200>
|
|
3483
|
+
/**
|
|
3484
|
+
* deleteIntegrationV2 - deleteIntegrationV2
|
|
3485
|
+
*
|
|
3486
|
+
* Delete an integration and all its use cases
|
|
3487
|
+
*/
|
|
3488
|
+
'deleteIntegrationV2'(
|
|
3489
|
+
parameters?: Parameters<Paths.DeleteIntegrationV2.PathParameters> | null,
|
|
3490
|
+
data?: any,
|
|
3491
|
+
config?: AxiosRequestConfig
|
|
3492
|
+
): OperationResponse<Paths.DeleteIntegrationV2.Responses.$200>
|
|
3493
|
+
/**
|
|
3494
|
+
* setIntegrationAppMapping - setIntegrationAppMapping
|
|
3495
|
+
*
|
|
3496
|
+
* Creates or updates a mapping from an app/component to an integration.
|
|
3497
|
+
* This allows ERP updates sent via app_id and component_id to be associated
|
|
3498
|
+
* with a specific integration configuration.
|
|
3499
|
+
*
|
|
3500
|
+
*/
|
|
3501
|
+
'setIntegrationAppMapping'(
|
|
3502
|
+
parameters?: Parameters<Paths.SetIntegrationAppMapping.PathParameters> | null,
|
|
3503
|
+
data?: Paths.SetIntegrationAppMapping.RequestBody,
|
|
3504
|
+
config?: AxiosRequestConfig
|
|
3505
|
+
): OperationResponse<Paths.SetIntegrationAppMapping.Responses.$200>
|
|
3506
|
+
/**
|
|
3507
|
+
* deleteIntegrationAppMapping - deleteIntegrationAppMapping
|
|
3508
|
+
*
|
|
3509
|
+
* Removes a mapping from an app/component to an integration.
|
|
3510
|
+
*
|
|
3511
|
+
*/
|
|
3512
|
+
'deleteIntegrationAppMapping'(
|
|
3513
|
+
parameters?: Parameters<Paths.DeleteIntegrationAppMapping.PathParameters> | null,
|
|
3514
|
+
data?: Paths.DeleteIntegrationAppMapping.RequestBody,
|
|
3515
|
+
config?: AxiosRequestConfig
|
|
3516
|
+
): OperationResponse<Paths.DeleteIntegrationAppMapping.Responses.$200>
|
|
3517
|
+
/**
|
|
3518
|
+
* queryInboundMonitoringEvents - queryInboundMonitoringEvents
|
|
3519
|
+
*
|
|
3520
|
+
* Query inbound monitoring events for a specific integration.
|
|
3521
|
+
* Returns detailed information about inbound sync events from ERP systems,
|
|
3522
|
+
* including success rates, error breakdowns, and processing metrics.
|
|
3523
|
+
*
|
|
3524
|
+
*/
|
|
3525
|
+
'queryInboundMonitoringEvents'(
|
|
3526
|
+
parameters?: Parameters<Paths.QueryInboundMonitoringEvents.PathParameters> | null,
|
|
3527
|
+
data?: Paths.QueryInboundMonitoringEvents.RequestBody,
|
|
3528
|
+
config?: AxiosRequestConfig
|
|
3529
|
+
): OperationResponse<Paths.QueryInboundMonitoringEvents.Responses.$200>
|
|
3530
|
+
/**
|
|
3531
|
+
* getMonitoringStats - getMonitoringStats
|
|
3532
|
+
*
|
|
3533
|
+
* Get aggregated statistics for both inbound and outbound monitoring events for a specific integration.
|
|
3534
|
+
* Returns summary metrics for inbound (ERP sync) and outbound (webhook delivery) events,
|
|
3535
|
+
* including success/error counts and optional breakdowns.
|
|
3536
|
+
*
|
|
3537
|
+
*/
|
|
3538
|
+
'getMonitoringStats'(
|
|
3539
|
+
parameters?: Parameters<Paths.GetMonitoringStats.PathParameters> | null,
|
|
3540
|
+
data?: Paths.GetMonitoringStats.RequestBody,
|
|
3541
|
+
config?: AxiosRequestConfig
|
|
3542
|
+
): OperationResponse<Paths.GetMonitoringStats.Responses.$200>
|
|
3543
|
+
/**
|
|
3544
|
+
* getMonitoringTimeSeries - getMonitoringTimeSeries
|
|
3545
|
+
*
|
|
3546
|
+
* Get time-series aggregated event counts for monitoring charts.
|
|
3547
|
+
* Returns pre-bucketed counts at configurable intervals for both inbound and outbound events.
|
|
3548
|
+
* Maximum of 200 buckets per request. Returns 400 if the time range and interval would exceed this limit.
|
|
3549
|
+
*
|
|
3550
|
+
*/
|
|
3551
|
+
'getMonitoringTimeSeries'(
|
|
3552
|
+
parameters?: Parameters<Paths.GetMonitoringTimeSeries.PathParameters> | null,
|
|
3553
|
+
data?: Paths.GetMonitoringTimeSeries.RequestBody,
|
|
3554
|
+
config?: AxiosRequestConfig
|
|
3555
|
+
): OperationResponse<Paths.GetMonitoringTimeSeries.Responses.$200>
|
|
3556
|
+
/**
|
|
3557
|
+
* getOutboundStatus - getOutboundStatus
|
|
3558
|
+
*
|
|
3559
|
+
* Get the status of all outbound use cases for a specific integration.
|
|
3560
|
+
* Returns conflict information when events or webhooks are disabled but the use case is enabled.
|
|
3561
|
+
*
|
|
3562
|
+
*/
|
|
3563
|
+
'getOutboundStatus'(
|
|
3564
|
+
parameters?: Parameters<Paths.GetOutboundStatus.PathParameters> | null,
|
|
3565
|
+
data?: any,
|
|
3566
|
+
config?: AxiosRequestConfig
|
|
3567
|
+
): OperationResponse<Paths.GetOutboundStatus.Responses.$200>
|
|
3568
|
+
/**
|
|
3569
|
+
* queryAccessLogs - queryAccessLogs
|
|
3570
|
+
*
|
|
3571
|
+
* Query API access logs for a specific integration's organization.
|
|
3572
|
+
* Returns access token usage analytics filtered by user_id (access token).
|
|
3573
|
+
* Supports infinite scroll pagination with cursor-based navigation.
|
|
3574
|
+
*
|
|
3575
|
+
*/
|
|
3576
|
+
'queryAccessLogs'(
|
|
3577
|
+
parameters?: Parameters<Paths.QueryAccessLogs.PathParameters> | null,
|
|
3578
|
+
data?: Paths.QueryAccessLogs.RequestBody,
|
|
3579
|
+
config?: AxiosRequestConfig
|
|
3580
|
+
): OperationResponse<Paths.QueryAccessLogs.Responses.$200>
|
|
3581
|
+
/**
|
|
3582
|
+
* queryOutboundMonitoringEvents - queryOutboundMonitoringEvents
|
|
3583
|
+
*
|
|
3584
|
+
* Query outbound monitoring events for a specific integration.
|
|
3585
|
+
* Returns detailed information about outbound event deliveries,
|
|
3586
|
+
* filtered by event_name (event_catalog_event) linked to the integration's outbound use cases.
|
|
3587
|
+
*
|
|
3588
|
+
*/
|
|
3589
|
+
'queryOutboundMonitoringEvents'(
|
|
3590
|
+
parameters?: Parameters<Paths.QueryOutboundMonitoringEvents.PathParameters> | null,
|
|
3591
|
+
data?: Paths.QueryOutboundMonitoringEvents.RequestBody,
|
|
3592
|
+
config?: AxiosRequestConfig
|
|
3593
|
+
): OperationResponse<Paths.QueryOutboundMonitoringEvents.Responses.$200>
|
|
3594
|
+
}
|
|
3595
|
+
|
|
3596
|
+
interface PathsDictionary {
|
|
3597
|
+
['/v1/erp/tracking/acknowledgement']: {
|
|
3598
|
+
/**
|
|
3599
|
+
* acknowledgeTracking - acknowledgeTracking
|
|
3600
|
+
*
|
|
3601
|
+
* Acknowledges an ERP tracking record by removing it from the tracking table, requires public authentication
|
|
3602
|
+
*/
|
|
3603
|
+
'post'(
|
|
3604
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3605
|
+
data?: Paths.AcknowledgeTracking.RequestBody,
|
|
3606
|
+
config?: AxiosRequestConfig
|
|
3607
|
+
): OperationResponse<Paths.AcknowledgeTracking.Responses.$200>
|
|
3608
|
+
}
|
|
3609
|
+
['/v1/erp/trigger']: {
|
|
3610
|
+
/**
|
|
3611
|
+
* triggerErp - triggerErp
|
|
3612
|
+
*
|
|
3613
|
+
* Triggers the ERP integration process
|
|
3614
|
+
*/
|
|
3615
|
+
'post'(
|
|
3616
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3617
|
+
data?: Paths.TriggerErp.RequestBody,
|
|
3618
|
+
config?: AxiosRequestConfig
|
|
3619
|
+
): OperationResponse<Paths.TriggerErp.Responses.$200>
|
|
3620
|
+
}
|
|
3621
|
+
['/v1/erp/updates/events']: {
|
|
3622
|
+
/**
|
|
3623
|
+
* processErpUpdatesEvents - processErpUpdatesEvents
|
|
3624
|
+
*
|
|
3625
|
+
* Handles updates from ERP systems and tracks them appropriately
|
|
3626
|
+
*/
|
|
3627
|
+
'post'(
|
|
3628
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3629
|
+
data?: Paths.ProcessErpUpdatesEvents.RequestBody,
|
|
3630
|
+
config?: AxiosRequestConfig
|
|
3631
|
+
): OperationResponse<Paths.ProcessErpUpdatesEvents.Responses.$200>
|
|
3632
|
+
}
|
|
3633
|
+
['/v2/erp/updates/events']: {
|
|
3634
|
+
/**
|
|
3635
|
+
* processErpUpdatesEventsV2 - processErpUpdatesEventsV2
|
|
3636
|
+
*
|
|
3637
|
+
* Handles updates from ERP systems using integration_id directly.
|
|
3638
|
+
* This is the v2 version that simplifies the API by accepting integration_id
|
|
3639
|
+
* instead of app_id and component_id.
|
|
3640
|
+
*
|
|
3641
|
+
*/
|
|
3642
|
+
'post'(
|
|
3643
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3644
|
+
data?: Paths.ProcessErpUpdatesEventsV2.RequestBody,
|
|
3645
|
+
config?: AxiosRequestConfig
|
|
3646
|
+
): OperationResponse<Paths.ProcessErpUpdatesEventsV2.Responses.$200>
|
|
3647
|
+
}
|
|
3648
|
+
['/v3/erp/updates/events']: {
|
|
3649
|
+
/**
|
|
3650
|
+
* processErpUpdatesEventsV3 - processErpUpdatesEventsV3
|
|
3651
|
+
*
|
|
3652
|
+
* Handles updates from ERP systems using integration_id directly.
|
|
3653
|
+
* This is the v3 version that removes the unused event_type field and renames object_type to event_name
|
|
3654
|
+
* to align with the integration UI naming.
|
|
3655
|
+
*
|
|
3656
|
+
*/
|
|
3657
|
+
'post'(
|
|
3658
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3659
|
+
data?: Paths.ProcessErpUpdatesEventsV3.RequestBody,
|
|
3660
|
+
config?: AxiosRequestConfig
|
|
3661
|
+
): OperationResponse<Paths.ProcessErpUpdatesEventsV3.Responses.$200>
|
|
3662
|
+
}
|
|
3663
|
+
['/v2/erp/updates/mapping_simulation']: {
|
|
3664
|
+
/**
|
|
3665
|
+
* simulateMappingV2 - simulateMappingV2
|
|
3666
|
+
*
|
|
3667
|
+
* Test v2.0 mapping configuration by transforming a payload using the provided mapping rules without persisting data.
|
|
3668
|
+
*
|
|
3669
|
+
* This endpoint accepts the same configuration format that is stored in the integration use case resource,
|
|
3670
|
+
* making it easier to test configurations before saving them to a use case.
|
|
3671
|
+
*
|
|
3672
|
+
* See documentation at /docs/MAPPING_V2.md for detailed v2.0 format specification.
|
|
3673
|
+
*
|
|
3674
|
+
*/
|
|
3675
|
+
'post'(
|
|
3676
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3677
|
+
data?: Paths.SimulateMappingV2.RequestBody,
|
|
3678
|
+
config?: AxiosRequestConfig
|
|
3679
|
+
): OperationResponse<Paths.SimulateMappingV2.Responses.$200>
|
|
3680
|
+
}
|
|
3681
|
+
['/v1/erp/updates/mapping_simulation']: {
|
|
3682
|
+
/**
|
|
3683
|
+
* simulateMapping - simulateMapping
|
|
3684
|
+
*
|
|
3685
|
+
* Test mapping configuration by transforming a payload using the provided mapping rules without persisting data.
|
|
3686
|
+
*
|
|
3687
|
+
* Supports both v1.0 (object-based) and v2.0 (event-based) mapping formats.
|
|
3688
|
+
* See documentation at /docs/MAPPING_V2.md for detailed v2.0 format specification.
|
|
3689
|
+
*
|
|
3690
|
+
*/
|
|
3691
|
+
'post'(
|
|
3692
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3693
|
+
data?: Paths.SimulateMapping.RequestBody,
|
|
3694
|
+
config?: AxiosRequestConfig
|
|
3695
|
+
): OperationResponse<Paths.SimulateMapping.Responses.$200>
|
|
3696
|
+
}
|
|
3697
|
+
['/v1/integrations']: {
|
|
3698
|
+
/**
|
|
3699
|
+
* listIntegrations - listIntegrations
|
|
3700
|
+
*
|
|
3701
|
+
* Retrieve all integrations for the authenticated organization
|
|
3702
|
+
*/
|
|
3703
|
+
'get'(
|
|
3704
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3705
|
+
data?: any,
|
|
3706
|
+
config?: AxiosRequestConfig
|
|
3707
|
+
): OperationResponse<Paths.ListIntegrations.Responses.$200>
|
|
3708
|
+
/**
|
|
3709
|
+
* createIntegration - createIntegration
|
|
3710
|
+
*
|
|
3711
|
+
* Create a new integration configuration
|
|
3712
|
+
*/
|
|
3713
|
+
'post'(
|
|
3714
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3715
|
+
data?: Paths.CreateIntegration.RequestBody,
|
|
3716
|
+
config?: AxiosRequestConfig
|
|
3717
|
+
): OperationResponse<Paths.CreateIntegration.Responses.$201>
|
|
3718
|
+
}
|
|
3719
|
+
['/v1/integrations/{integrationId}']: {
|
|
3720
|
+
/**
|
|
3721
|
+
* getIntegration - getIntegration
|
|
3722
|
+
*
|
|
3723
|
+
* Retrieve a specific integration by its ID
|
|
3724
|
+
*/
|
|
3725
|
+
'get'(
|
|
3726
|
+
parameters?: Parameters<Paths.GetIntegration.PathParameters> | null,
|
|
3727
|
+
data?: any,
|
|
3728
|
+
config?: AxiosRequestConfig
|
|
3729
|
+
): OperationResponse<Paths.GetIntegration.Responses.$200>
|
|
3730
|
+
/**
|
|
3731
|
+
* updateIntegration - updateIntegration
|
|
3732
|
+
*
|
|
3733
|
+
* Update an existing integration configuration
|
|
3734
|
+
*/
|
|
3735
|
+
'put'(
|
|
3736
|
+
parameters?: Parameters<Paths.UpdateIntegration.PathParameters> | null,
|
|
3737
|
+
data?: Paths.UpdateIntegration.RequestBody,
|
|
3738
|
+
config?: AxiosRequestConfig
|
|
3739
|
+
): OperationResponse<Paths.UpdateIntegration.Responses.$200>
|
|
3740
|
+
/**
|
|
3741
|
+
* deleteIntegration - deleteIntegration
|
|
3742
|
+
*
|
|
3743
|
+
* Delete an integration and all its use cases
|
|
3744
|
+
*/
|
|
3745
|
+
'delete'(
|
|
3746
|
+
parameters?: Parameters<Paths.DeleteIntegration.PathParameters> | null,
|
|
3747
|
+
data?: any,
|
|
3748
|
+
config?: AxiosRequestConfig
|
|
3749
|
+
): OperationResponse<Paths.DeleteIntegration.Responses.$200>
|
|
3750
|
+
}
|
|
3751
|
+
['/v1/integrations/{integrationId}/events']: {
|
|
3752
|
+
/**
|
|
3753
|
+
* queryEvents - queryEvents
|
|
3754
|
+
*
|
|
3755
|
+
* Query events for a specific integration
|
|
3756
|
+
*/
|
|
3757
|
+
'post'(
|
|
3758
|
+
parameters?: Parameters<Paths.QueryEvents.PathParameters> | null,
|
|
3759
|
+
data?: Paths.QueryEvents.RequestBody,
|
|
3760
|
+
config?: AxiosRequestConfig
|
|
3761
|
+
): OperationResponse<Paths.QueryEvents.Responses.$200>
|
|
3762
|
+
}
|
|
3763
|
+
['/v1/integrations/{integrationId}/events/replay']: {
|
|
3764
|
+
/**
|
|
3765
|
+
* replayEvents - replayEvents
|
|
3766
|
+
*
|
|
3767
|
+
* Replay one or more events for a specific integration. Events will be re-processed with their original payloads but with a new correlation ID for traceability.
|
|
3768
|
+
*/
|
|
3769
|
+
'post'(
|
|
3770
|
+
parameters?: Parameters<Paths.ReplayEvents.PathParameters> | null,
|
|
3771
|
+
data?: Paths.ReplayEvents.RequestBody,
|
|
3772
|
+
config?: AxiosRequestConfig
|
|
3773
|
+
): OperationResponse<Paths.ReplayEvents.Responses.$200>
|
|
3774
|
+
}
|
|
3775
|
+
['/v1/integrations/{integrationId}/use-cases']: {
|
|
3776
|
+
/**
|
|
3777
|
+
* listUseCases - listUseCases
|
|
3778
|
+
*
|
|
3779
|
+
* Retrieve all use cases for a specific integration
|
|
3780
|
+
*/
|
|
3781
|
+
'get'(
|
|
3782
|
+
parameters?: Parameters<Paths.ListUseCases.PathParameters> | null,
|
|
3783
|
+
data?: any,
|
|
3784
|
+
config?: AxiosRequestConfig
|
|
3785
|
+
): OperationResponse<Paths.ListUseCases.Responses.$200>
|
|
3786
|
+
/**
|
|
3787
|
+
* createUseCase - createUseCase
|
|
3788
|
+
*
|
|
3789
|
+
* Create a new use case for an integration
|
|
3790
|
+
*/
|
|
3791
|
+
'post'(
|
|
3792
|
+
parameters?: Parameters<Paths.CreateUseCase.PathParameters> | null,
|
|
3793
|
+
data?: Paths.CreateUseCase.RequestBody,
|
|
3794
|
+
config?: AxiosRequestConfig
|
|
3795
|
+
): OperationResponse<Paths.CreateUseCase.Responses.$201>
|
|
3796
|
+
}
|
|
3797
|
+
['/v1/integrations/{integrationId}/use-cases/{useCaseId}']: {
|
|
3798
|
+
/**
|
|
3799
|
+
* getUseCase - getUseCase
|
|
3800
|
+
*
|
|
3801
|
+
* Retrieve a specific use case by its ID
|
|
3802
|
+
*/
|
|
3803
|
+
'get'(
|
|
3804
|
+
parameters?: Parameters<Paths.GetUseCase.PathParameters> | null,
|
|
3805
|
+
data?: any,
|
|
3806
|
+
config?: AxiosRequestConfig
|
|
3807
|
+
): OperationResponse<Paths.GetUseCase.Responses.$200>
|
|
3808
|
+
/**
|
|
3809
|
+
* updateUseCase - updateUseCase
|
|
3810
|
+
*
|
|
3811
|
+
* Update an existing use case configuration
|
|
3812
|
+
*/
|
|
3813
|
+
'put'(
|
|
3814
|
+
parameters?: Parameters<Paths.UpdateUseCase.PathParameters> | null,
|
|
3815
|
+
data?: Paths.UpdateUseCase.RequestBody,
|
|
3816
|
+
config?: AxiosRequestConfig
|
|
3817
|
+
): OperationResponse<Paths.UpdateUseCase.Responses.$200>
|
|
3818
|
+
/**
|
|
3819
|
+
* deleteUseCase - deleteUseCase
|
|
3820
|
+
*
|
|
3821
|
+
* Delete a use case from an integration
|
|
3822
|
+
*/
|
|
3823
|
+
'delete'(
|
|
3824
|
+
parameters?: Parameters<Paths.DeleteUseCase.PathParameters> | null,
|
|
3825
|
+
data?: any,
|
|
3826
|
+
config?: AxiosRequestConfig
|
|
3827
|
+
): OperationResponse<Paths.DeleteUseCase.Responses.$200>
|
|
3828
|
+
}
|
|
3829
|
+
['/v1/integrations/{integrationId}/use-cases/{useCaseId}/history']: {
|
|
3830
|
+
/**
|
|
3831
|
+
* listUseCaseHistory - listUseCaseHistory
|
|
3832
|
+
*
|
|
3833
|
+
* Retrieve historical versions of a use case's configuration.
|
|
3834
|
+
* History entries are returned in reverse chronological order (newest first).
|
|
3835
|
+
* Use the 'cursor' parameter for pagination to fetch additional entries.
|
|
3836
|
+
*
|
|
3837
|
+
*/
|
|
3838
|
+
'get'(
|
|
3839
|
+
parameters?: Parameters<Paths.ListUseCaseHistory.QueryParameters & Paths.ListUseCaseHistory.PathParameters> | null,
|
|
3840
|
+
data?: any,
|
|
3841
|
+
config?: AxiosRequestConfig
|
|
3842
|
+
): OperationResponse<Paths.ListUseCaseHistory.Responses.$200>
|
|
3843
|
+
}
|
|
3844
|
+
['/v2/integrations']: {
|
|
3845
|
+
/**
|
|
3846
|
+
* listIntegrationsV2 - listIntegrationsV2
|
|
3847
|
+
*
|
|
3848
|
+
* Retrieve all integrations with embedded use cases for the authenticated organization
|
|
3849
|
+
*/
|
|
3850
|
+
'get'(
|
|
3851
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3852
|
+
data?: any,
|
|
3853
|
+
config?: AxiosRequestConfig
|
|
3854
|
+
): OperationResponse<Paths.ListIntegrationsV2.Responses.$200>
|
|
3855
|
+
/**
|
|
3856
|
+
* createIntegrationV2 - createIntegrationV2
|
|
3857
|
+
*
|
|
3858
|
+
* Create a new integration with embedded use cases.
|
|
3859
|
+
*
|
|
3860
|
+
*/
|
|
3861
|
+
'post'(
|
|
3862
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3863
|
+
data?: Paths.CreateIntegrationV2.RequestBody,
|
|
3864
|
+
config?: AxiosRequestConfig
|
|
3865
|
+
): OperationResponse<Paths.CreateIntegrationV2.Responses.$201>
|
|
3866
|
+
}
|
|
3867
|
+
['/v2/integrations/{integrationId}']: {
|
|
3868
|
+
/**
|
|
3869
|
+
* getIntegrationV2 - getIntegrationV2
|
|
3870
|
+
*
|
|
3871
|
+
* Retrieve a specific integration with all its embedded use cases
|
|
3872
|
+
*/
|
|
3873
|
+
'get'(
|
|
3874
|
+
parameters?: Parameters<Paths.GetIntegrationV2.PathParameters> | null,
|
|
3875
|
+
data?: any,
|
|
3876
|
+
config?: AxiosRequestConfig
|
|
3877
|
+
): OperationResponse<Paths.GetIntegrationV2.Responses.$200>
|
|
3878
|
+
/**
|
|
3879
|
+
* updateIntegrationV2 - updateIntegrationV2
|
|
3880
|
+
*
|
|
3881
|
+
* Update an existing integration with embedded use cases.
|
|
3882
|
+
* The integration must already exist.
|
|
3883
|
+
* Use cases are updated declaratively:
|
|
3884
|
+
* - Use cases in the request with matching IDs are updated
|
|
3885
|
+
* - Use cases in the request without matching IDs are created
|
|
3886
|
+
* - Existing use cases not in the request are deleted
|
|
3887
|
+
*
|
|
3888
|
+
*/
|
|
3889
|
+
'put'(
|
|
3890
|
+
parameters?: Parameters<Paths.UpdateIntegrationV2.PathParameters> | null,
|
|
3891
|
+
data?: Paths.UpdateIntegrationV2.RequestBody,
|
|
3892
|
+
config?: AxiosRequestConfig
|
|
3893
|
+
): OperationResponse<Paths.UpdateIntegrationV2.Responses.$200>
|
|
3894
|
+
/**
|
|
3895
|
+
* deleteIntegrationV2 - deleteIntegrationV2
|
|
3896
|
+
*
|
|
3897
|
+
* Delete an integration and all its use cases
|
|
3898
|
+
*/
|
|
3899
|
+
'delete'(
|
|
3900
|
+
parameters?: Parameters<Paths.DeleteIntegrationV2.PathParameters> | null,
|
|
3901
|
+
data?: any,
|
|
3902
|
+
config?: AxiosRequestConfig
|
|
3903
|
+
): OperationResponse<Paths.DeleteIntegrationV2.Responses.$200>
|
|
3904
|
+
}
|
|
3905
|
+
['/v1/integrations/{integrationId}/app-mapping']: {
|
|
3906
|
+
/**
|
|
3907
|
+
* setIntegrationAppMapping - setIntegrationAppMapping
|
|
3908
|
+
*
|
|
3909
|
+
* Creates or updates a mapping from an app/component to an integration.
|
|
3910
|
+
* This allows ERP updates sent via app_id and component_id to be associated
|
|
3911
|
+
* with a specific integration configuration.
|
|
3912
|
+
*
|
|
3913
|
+
*/
|
|
3914
|
+
'put'(
|
|
3915
|
+
parameters?: Parameters<Paths.SetIntegrationAppMapping.PathParameters> | null,
|
|
3916
|
+
data?: Paths.SetIntegrationAppMapping.RequestBody,
|
|
3917
|
+
config?: AxiosRequestConfig
|
|
3918
|
+
): OperationResponse<Paths.SetIntegrationAppMapping.Responses.$200>
|
|
3919
|
+
/**
|
|
3920
|
+
* deleteIntegrationAppMapping - deleteIntegrationAppMapping
|
|
3921
|
+
*
|
|
3922
|
+
* Removes a mapping from an app/component to an integration.
|
|
3923
|
+
*
|
|
3924
|
+
*/
|
|
3925
|
+
'delete'(
|
|
3926
|
+
parameters?: Parameters<Paths.DeleteIntegrationAppMapping.PathParameters> | null,
|
|
3927
|
+
data?: Paths.DeleteIntegrationAppMapping.RequestBody,
|
|
3928
|
+
config?: AxiosRequestConfig
|
|
3929
|
+
): OperationResponse<Paths.DeleteIntegrationAppMapping.Responses.$200>
|
|
3930
|
+
}
|
|
3931
|
+
['/v1/integrations/{integrationId}/monitoring/inbound-events']: {
|
|
3932
|
+
/**
|
|
3933
|
+
* queryInboundMonitoringEvents - queryInboundMonitoringEvents
|
|
3934
|
+
*
|
|
3935
|
+
* Query inbound monitoring events for a specific integration.
|
|
3936
|
+
* Returns detailed information about inbound sync events from ERP systems,
|
|
3937
|
+
* including success rates, error breakdowns, and processing metrics.
|
|
3938
|
+
*
|
|
3939
|
+
*/
|
|
3940
|
+
'post'(
|
|
3941
|
+
parameters?: Parameters<Paths.QueryInboundMonitoringEvents.PathParameters> | null,
|
|
3942
|
+
data?: Paths.QueryInboundMonitoringEvents.RequestBody,
|
|
3943
|
+
config?: AxiosRequestConfig
|
|
3944
|
+
): OperationResponse<Paths.QueryInboundMonitoringEvents.Responses.$200>
|
|
3945
|
+
}
|
|
3946
|
+
['/v1/integrations/{integrationId}/monitoring/stats']: {
|
|
3947
|
+
/**
|
|
3948
|
+
* getMonitoringStats - getMonitoringStats
|
|
3949
|
+
*
|
|
3950
|
+
* Get aggregated statistics for both inbound and outbound monitoring events for a specific integration.
|
|
3951
|
+
* Returns summary metrics for inbound (ERP sync) and outbound (webhook delivery) events,
|
|
3952
|
+
* including success/error counts and optional breakdowns.
|
|
3953
|
+
*
|
|
3954
|
+
*/
|
|
3955
|
+
'post'(
|
|
3956
|
+
parameters?: Parameters<Paths.GetMonitoringStats.PathParameters> | null,
|
|
3957
|
+
data?: Paths.GetMonitoringStats.RequestBody,
|
|
3958
|
+
config?: AxiosRequestConfig
|
|
3959
|
+
): OperationResponse<Paths.GetMonitoringStats.Responses.$200>
|
|
3960
|
+
}
|
|
3961
|
+
['/v1/integrations/{integrationId}/monitoring/timeseries']: {
|
|
3962
|
+
/**
|
|
3963
|
+
* getMonitoringTimeSeries - getMonitoringTimeSeries
|
|
3964
|
+
*
|
|
3965
|
+
* Get time-series aggregated event counts for monitoring charts.
|
|
3966
|
+
* Returns pre-bucketed counts at configurable intervals for both inbound and outbound events.
|
|
3967
|
+
* Maximum of 200 buckets per request. Returns 400 if the time range and interval would exceed this limit.
|
|
3968
|
+
*
|
|
3969
|
+
*/
|
|
3970
|
+
'post'(
|
|
3971
|
+
parameters?: Parameters<Paths.GetMonitoringTimeSeries.PathParameters> | null,
|
|
3972
|
+
data?: Paths.GetMonitoringTimeSeries.RequestBody,
|
|
3973
|
+
config?: AxiosRequestConfig
|
|
3974
|
+
): OperationResponse<Paths.GetMonitoringTimeSeries.Responses.$200>
|
|
3975
|
+
}
|
|
3976
|
+
['/v1/integrations/{integrationId}/outbound-status']: {
|
|
3977
|
+
/**
|
|
3978
|
+
* getOutboundStatus - getOutboundStatus
|
|
3979
|
+
*
|
|
3980
|
+
* Get the status of all outbound use cases for a specific integration.
|
|
3981
|
+
* Returns conflict information when events or webhooks are disabled but the use case is enabled.
|
|
3982
|
+
*
|
|
3983
|
+
*/
|
|
3984
|
+
'get'(
|
|
3985
|
+
parameters?: Parameters<Paths.GetOutboundStatus.PathParameters> | null,
|
|
3986
|
+
data?: any,
|
|
3987
|
+
config?: AxiosRequestConfig
|
|
3988
|
+
): OperationResponse<Paths.GetOutboundStatus.Responses.$200>
|
|
3989
|
+
}
|
|
3990
|
+
['/v1/integrations/{integrationId}/monitoring/access-logs']: {
|
|
3991
|
+
/**
|
|
3992
|
+
* queryAccessLogs - queryAccessLogs
|
|
3993
|
+
*
|
|
3994
|
+
* Query API access logs for a specific integration's organization.
|
|
3995
|
+
* Returns access token usage analytics filtered by user_id (access token).
|
|
3996
|
+
* Supports infinite scroll pagination with cursor-based navigation.
|
|
3997
|
+
*
|
|
3998
|
+
*/
|
|
3999
|
+
'post'(
|
|
4000
|
+
parameters?: Parameters<Paths.QueryAccessLogs.PathParameters> | null,
|
|
4001
|
+
data?: Paths.QueryAccessLogs.RequestBody,
|
|
4002
|
+
config?: AxiosRequestConfig
|
|
4003
|
+
): OperationResponse<Paths.QueryAccessLogs.Responses.$200>
|
|
4004
|
+
}
|
|
4005
|
+
['/v1/integrations/{integrationId}/monitoring/outbound-events']: {
|
|
4006
|
+
/**
|
|
4007
|
+
* queryOutboundMonitoringEvents - queryOutboundMonitoringEvents
|
|
4008
|
+
*
|
|
4009
|
+
* Query outbound monitoring events for a specific integration.
|
|
4010
|
+
* Returns detailed information about outbound event deliveries,
|
|
4011
|
+
* filtered by event_name (event_catalog_event) linked to the integration's outbound use cases.
|
|
4012
|
+
*
|
|
4013
|
+
*/
|
|
4014
|
+
'post'(
|
|
4015
|
+
parameters?: Parameters<Paths.QueryOutboundMonitoringEvents.PathParameters> | null,
|
|
4016
|
+
data?: Paths.QueryOutboundMonitoringEvents.RequestBody,
|
|
4017
|
+
config?: AxiosRequestConfig
|
|
4018
|
+
): OperationResponse<Paths.QueryOutboundMonitoringEvents.Responses.$200>
|
|
4019
|
+
}
|
|
4020
|
+
}
|
|
4021
|
+
|
|
4022
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
4023
|
+
|
|
4024
|
+
|
|
4025
|
+
type AccessLogEntry = Components.Schemas.AccessLogEntry;
|
|
4026
|
+
type AutoRefreshSettings = Components.Schemas.AutoRefreshSettings;
|
|
4027
|
+
type CreateFileProxyUseCaseRequest = Components.Schemas.CreateFileProxyUseCaseRequest;
|
|
4028
|
+
type CreateInboundUseCaseRequest = Components.Schemas.CreateInboundUseCaseRequest;
|
|
4029
|
+
type CreateIntegrationRequest = Components.Schemas.CreateIntegrationRequest;
|
|
4030
|
+
type CreateOutboundUseCaseRequest = Components.Schemas.CreateOutboundUseCaseRequest;
|
|
4031
|
+
type CreateUseCaseRequest = Components.Schemas.CreateUseCaseRequest;
|
|
4032
|
+
type CreateUseCaseRequestBase = Components.Schemas.CreateUseCaseRequestBase;
|
|
4033
|
+
type DeleteIntegrationAppMappingRequest = Components.Schemas.DeleteIntegrationAppMappingRequest;
|
|
4034
|
+
type DeliveryConfig = Components.Schemas.DeliveryConfig;
|
|
4035
|
+
type EmbeddedInboundUseCaseRequest = Components.Schemas.EmbeddedInboundUseCaseRequest;
|
|
4036
|
+
type EmbeddedOutboundUseCaseRequest = Components.Schemas.EmbeddedOutboundUseCaseRequest;
|
|
4037
|
+
type EmbeddedUseCaseRequest = Components.Schemas.EmbeddedUseCaseRequest;
|
|
4038
|
+
type EmbeddedUseCaseRequestBase = Components.Schemas.EmbeddedUseCaseRequestBase;
|
|
4039
|
+
type EntityUpdate = Components.Schemas.EntityUpdate;
|
|
4040
|
+
type EnvironmentFieldConfig = Components.Schemas.EnvironmentFieldConfig;
|
|
4041
|
+
type ErpEvent = Components.Schemas.ErpEvent;
|
|
4042
|
+
type ErpEventV3 = Components.Schemas.ErpEventV3;
|
|
4043
|
+
type ErpUpdatesEventsV2Request = Components.Schemas.ErpUpdatesEventsV2Request;
|
|
4044
|
+
type ErpUpdatesEventsV3Request = Components.Schemas.ErpUpdatesEventsV3Request;
|
|
4045
|
+
type ErrorResponseBase = Components.Schemas.ErrorResponseBase;
|
|
4046
|
+
type FileProxyAuth = Components.Schemas.FileProxyAuth;
|
|
4047
|
+
type FileProxyParam = Components.Schemas.FileProxyParam;
|
|
4048
|
+
type FileProxyResponseConfig = Components.Schemas.FileProxyResponseConfig;
|
|
4049
|
+
type FileProxyStep = Components.Schemas.FileProxyStep;
|
|
4050
|
+
type FileProxyUrlConfig = Components.Schemas.FileProxyUrlConfig;
|
|
4051
|
+
type FileProxyUrlParam = Components.Schemas.FileProxyUrlParam;
|
|
4052
|
+
type FileProxyUrlParams = Components.Schemas.FileProxyUrlParams;
|
|
4053
|
+
type FileProxyUseCase = Components.Schemas.FileProxyUseCase;
|
|
4054
|
+
type FileProxyUseCaseConfiguration = Components.Schemas.FileProxyUseCaseConfiguration;
|
|
4055
|
+
type FileProxyUseCaseHistoryEntry = Components.Schemas.FileProxyUseCaseHistoryEntry;
|
|
4056
|
+
type GetMonitoringStatsRequest = Components.Schemas.GetMonitoringStatsRequest;
|
|
4057
|
+
type GetMonitoringTimeSeriesRequest = Components.Schemas.GetMonitoringTimeSeriesRequest;
|
|
4058
|
+
type InboundIntegrationEventConfiguration = Components.Schemas.InboundIntegrationEventConfiguration;
|
|
4059
|
+
type InboundMonitoringEvent = Components.Schemas.InboundMonitoringEvent;
|
|
4060
|
+
type InboundUseCase = Components.Schemas.InboundUseCase;
|
|
4061
|
+
type InboundUseCaseHistoryEntry = Components.Schemas.InboundUseCaseHistoryEntry;
|
|
4062
|
+
type Integration = Components.Schemas.Integration;
|
|
4063
|
+
type IntegrationAppMapping = Components.Schemas.IntegrationAppMapping;
|
|
4064
|
+
type IntegrationConfigurationV1 = Components.Schemas.IntegrationConfigurationV1;
|
|
4065
|
+
type IntegrationConfigurationV2 = Components.Schemas.IntegrationConfigurationV2;
|
|
4066
|
+
type IntegrationEditableFields = Components.Schemas.IntegrationEditableFields;
|
|
4067
|
+
type IntegrationEntity = Components.Schemas.IntegrationEntity;
|
|
4068
|
+
type IntegrationEntityField = Components.Schemas.IntegrationEntityField;
|
|
4069
|
+
type IntegrationFieldV1 = Components.Schemas.IntegrationFieldV1;
|
|
4070
|
+
type IntegrationMeterReading = Components.Schemas.IntegrationMeterReading;
|
|
4071
|
+
type IntegrationObjectV1 = Components.Schemas.IntegrationObjectV1;
|
|
4072
|
+
type IntegrationSettings = Components.Schemas.IntegrationSettings;
|
|
4073
|
+
type IntegrationWithUseCases = Components.Schemas.IntegrationWithUseCases;
|
|
4074
|
+
type MappingSimulationRequest = Components.Schemas.MappingSimulationRequest;
|
|
4075
|
+
type MappingSimulationResponse = Components.Schemas.MappingSimulationResponse;
|
|
4076
|
+
type MappingSimulationV2Request = Components.Schemas.MappingSimulationV2Request;
|
|
4077
|
+
type MappingSimulationWarning = Components.Schemas.MappingSimulationWarning;
|
|
4078
|
+
type MeterReadingPruneScopeConfig = Components.Schemas.MeterReadingPruneScopeConfig;
|
|
4079
|
+
type MeterReadingUpdate = Components.Schemas.MeterReadingUpdate;
|
|
4080
|
+
type MeterUniqueIdsConfig = Components.Schemas.MeterUniqueIdsConfig;
|
|
4081
|
+
type MonitoringStats = Components.Schemas.MonitoringStats;
|
|
4082
|
+
type OutboundConflict = Components.Schemas.OutboundConflict;
|
|
4083
|
+
type OutboundIntegrationEventConfiguration = Components.Schemas.OutboundIntegrationEventConfiguration;
|
|
4084
|
+
type OutboundMapping = Components.Schemas.OutboundMapping;
|
|
4085
|
+
type OutboundMonitoringEvent = Components.Schemas.OutboundMonitoringEvent;
|
|
4086
|
+
type OutboundStatusResponse = Components.Schemas.OutboundStatusResponse;
|
|
4087
|
+
type OutboundUseCase = Components.Schemas.OutboundUseCase;
|
|
4088
|
+
type OutboundUseCaseHistoryEntry = Components.Schemas.OutboundUseCaseHistoryEntry;
|
|
4089
|
+
type OutboundUseCaseStatus = Components.Schemas.OutboundUseCaseStatus;
|
|
4090
|
+
type PruneScopeConfig = Components.Schemas.PruneScopeConfig;
|
|
4091
|
+
type QueryAccessLogsRequest = Components.Schemas.QueryAccessLogsRequest;
|
|
4092
|
+
type QueryEventsRequest = Components.Schemas.QueryEventsRequest;
|
|
4093
|
+
type QueryInboundMonitoringEventsRequest = Components.Schemas.QueryInboundMonitoringEventsRequest;
|
|
4094
|
+
type QueryOutboundMonitoringEventsRequest = Components.Schemas.QueryOutboundMonitoringEventsRequest;
|
|
4095
|
+
type RelationConfig = Components.Schemas.RelationConfig;
|
|
4096
|
+
type RelationItemConfig = Components.Schemas.RelationItemConfig;
|
|
4097
|
+
type RelationRefItemConfig = Components.Schemas.RelationRefItemConfig;
|
|
4098
|
+
type RelationRefValueConfig = Components.Schemas.RelationRefValueConfig;
|
|
4099
|
+
type RelationRefsConfig = Components.Schemas.RelationRefsConfig;
|
|
4100
|
+
type RelationUniqueIdField = Components.Schemas.RelationUniqueIdField;
|
|
4101
|
+
type RepeatableFieldType = Components.Schemas.RepeatableFieldType;
|
|
4102
|
+
type ReplayEventsRequest = Components.Schemas.ReplayEventsRequest;
|
|
4103
|
+
type SetIntegrationAppMappingRequest = Components.Schemas.SetIntegrationAppMappingRequest;
|
|
4104
|
+
type TimeSeriesBucket = Components.Schemas.TimeSeriesBucket;
|
|
4105
|
+
type TriggerErpActionRequest = Components.Schemas.TriggerErpActionRequest;
|
|
4106
|
+
type TriggerWebhookResp = Components.Schemas.TriggerWebhookResp;
|
|
4107
|
+
type UpdateFileProxyUseCaseRequest = Components.Schemas.UpdateFileProxyUseCaseRequest;
|
|
4108
|
+
type UpdateInboundUseCaseRequest = Components.Schemas.UpdateInboundUseCaseRequest;
|
|
4109
|
+
type UpdateIntegrationRequest = Components.Schemas.UpdateIntegrationRequest;
|
|
4110
|
+
type UpdateOutboundUseCaseRequest = Components.Schemas.UpdateOutboundUseCaseRequest;
|
|
4111
|
+
type UpdateUseCaseRequest = Components.Schemas.UpdateUseCaseRequest;
|
|
4112
|
+
type UpdateUseCaseRequestBase = Components.Schemas.UpdateUseCaseRequestBase;
|
|
4113
|
+
type UpsertIntegrationWithUseCasesRequest = Components.Schemas.UpsertIntegrationWithUseCasesRequest;
|
|
4114
|
+
type UseCase = Components.Schemas.UseCase;
|
|
4115
|
+
type UseCaseBase = Components.Schemas.UseCaseBase;
|
|
4116
|
+
type UseCaseHistoryEntry = Components.Schemas.UseCaseHistoryEntry;
|
|
4117
|
+
type UseCaseHistoryEntryBase = Components.Schemas.UseCaseHistoryEntryBase;
|
|
4118
|
+
type WebhookStatus = Components.Schemas.WebhookStatus;
|
|
4119
|
+
|
|
4120
|
+
export type { MappingSimulationResponse as $, AccessLogEntry as A, FileProxyUseCaseHistoryEntry as B, Client as C, DeleteIntegrationAppMappingRequest as D, EmbeddedInboundUseCaseRequest as E, FileProxyAuth as F, GetMonitoringStatsRequest as G, GetMonitoringTimeSeriesRequest as H, InboundIntegrationEventConfiguration as I, InboundMonitoringEvent as J, InboundUseCase as K, InboundUseCaseHistoryEntry as L, Integration as M, IntegrationAppMapping as N, OperationMethods as O, PathsDictionary as P, IntegrationConfigurationV1 as Q, IntegrationConfigurationV2 as R, IntegrationEditableFields as S, IntegrationEntity as T, IntegrationEntityField as U, IntegrationFieldV1 as V, IntegrationMeterReading as W, IntegrationObjectV1 as X, IntegrationSettings as Y, IntegrationWithUseCases as Z, MappingSimulationRequest as _, AutoRefreshSettings as a, MappingSimulationV2Request as a0, MappingSimulationWarning as a1, MeterReadingPruneScopeConfig as a2, MeterReadingUpdate as a3, MeterUniqueIdsConfig as a4, MonitoringStats as a5, OutboundConflict as a6, OutboundIntegrationEventConfiguration as a7, OutboundMapping as a8, OutboundMonitoringEvent as a9, UpdateUseCaseRequestBase as aA, UpsertIntegrationWithUseCasesRequest as aB, UseCase as aC, UseCaseBase as aD, UseCaseHistoryEntry as aE, UseCaseHistoryEntryBase as aF, WebhookStatus as aG, OutboundStatusResponse as aa, OutboundUseCase as ab, OutboundUseCaseHistoryEntry as ac, OutboundUseCaseStatus as ad, PruneScopeConfig as ae, QueryAccessLogsRequest as af, QueryEventsRequest as ag, QueryInboundMonitoringEventsRequest as ah, QueryOutboundMonitoringEventsRequest as ai, RelationConfig as aj, RelationItemConfig as ak, RelationRefItemConfig as al, RelationRefValueConfig as am, RelationRefsConfig as an, RelationUniqueIdField as ao, RepeatableFieldType as ap, ReplayEventsRequest as aq, SetIntegrationAppMappingRequest as ar, TimeSeriesBucket as as, TriggerErpActionRequest as at, TriggerWebhookResp as au, UpdateFileProxyUseCaseRequest as av, UpdateInboundUseCaseRequest as aw, UpdateIntegrationRequest as ax, UpdateOutboundUseCaseRequest as ay, UpdateUseCaseRequest as az, CreateFileProxyUseCaseRequest as b, CreateInboundUseCaseRequest as c, CreateIntegrationRequest as d, CreateOutboundUseCaseRequest as e, CreateUseCaseRequest as f, CreateUseCaseRequestBase as g, DeliveryConfig as h, EmbeddedOutboundUseCaseRequest as i, EmbeddedUseCaseRequest as j, EmbeddedUseCaseRequestBase as k, EntityUpdate as l, EnvironmentFieldConfig as m, ErpEvent as n, ErpEventV3 as o, ErpUpdatesEventsV2Request as p, ErpUpdatesEventsV3Request as q, ErrorResponseBase as r, FileProxyParam as s, FileProxyResponseConfig as t, FileProxyStep as u, FileProxyUrlConfig as v, FileProxyUrlParam as w, FileProxyUrlParams as x, FileProxyUseCase as y, FileProxyUseCaseConfiguration as z };
|