@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,3370 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/* Auto-copied from app-client */
|
|
5
|
+
/* eslint-disable */
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
declare namespace Components {
|
|
10
|
+
namespace RequestBodies {
|
|
11
|
+
export interface CreateBundlePresignedRequest {
|
|
12
|
+
/**
|
|
13
|
+
* Version of the app
|
|
14
|
+
*/
|
|
15
|
+
version: string;
|
|
16
|
+
/**
|
|
17
|
+
* ID of the journey block component
|
|
18
|
+
*/
|
|
19
|
+
component_id?: string;
|
|
20
|
+
}
|
|
21
|
+
export interface CreateConfigRequest {
|
|
22
|
+
/**
|
|
23
|
+
* Name of the app
|
|
24
|
+
*/
|
|
25
|
+
name: string;
|
|
26
|
+
description: Schemas.TranslatedString;
|
|
27
|
+
category?: string;
|
|
28
|
+
/**
|
|
29
|
+
* S3 key of the logo file
|
|
30
|
+
*/
|
|
31
|
+
logo_url_key?: string;
|
|
32
|
+
}
|
|
33
|
+
export interface CreateLogoPresignedRequest {
|
|
34
|
+
/**
|
|
35
|
+
* Original filename of the logo
|
|
36
|
+
* example:
|
|
37
|
+
* company-logo.png
|
|
38
|
+
*/
|
|
39
|
+
filename: string;
|
|
40
|
+
/**
|
|
41
|
+
* MIME type of the logo file
|
|
42
|
+
* example:
|
|
43
|
+
* image/png
|
|
44
|
+
*/
|
|
45
|
+
mime_type: "image/png" | "image/jpeg" | "image/jpg";
|
|
46
|
+
}
|
|
47
|
+
export interface CreateReviewRequest {
|
|
48
|
+
/**
|
|
49
|
+
* Email of the technical contact
|
|
50
|
+
*/
|
|
51
|
+
technical_contact: string;
|
|
52
|
+
/**
|
|
53
|
+
* Email of the marketing contact
|
|
54
|
+
*/
|
|
55
|
+
marketing_contact: string;
|
|
56
|
+
/**
|
|
57
|
+
* URL to a demo of the app
|
|
58
|
+
*/
|
|
59
|
+
demo_url?: string;
|
|
60
|
+
}
|
|
61
|
+
export interface InstallRequest {
|
|
62
|
+
/**
|
|
63
|
+
* Version of the app to update to
|
|
64
|
+
*/
|
|
65
|
+
version?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Configuration values for the app components
|
|
68
|
+
*/
|
|
69
|
+
option_values?: Schemas.OptionsRef[];
|
|
70
|
+
/**
|
|
71
|
+
* Manifest ID used to create/update the entity
|
|
72
|
+
*/
|
|
73
|
+
_manifest?: string /* uuid */[];
|
|
74
|
+
}
|
|
75
|
+
export interface PatchConfigMetadataRequest {
|
|
76
|
+
/**
|
|
77
|
+
* Name of the app
|
|
78
|
+
*/
|
|
79
|
+
name?: string;
|
|
80
|
+
description?: Schemas.TranslatedString;
|
|
81
|
+
category?: string;
|
|
82
|
+
documentation_url?: string;
|
|
83
|
+
notifications?: Schemas.NotificationConfig;
|
|
84
|
+
pricing?: Schemas.Pricing;
|
|
85
|
+
/**
|
|
86
|
+
* S3 key of the logo file
|
|
87
|
+
*/
|
|
88
|
+
logo_url_key?: string;
|
|
89
|
+
/**
|
|
90
|
+
* Email address for support requests
|
|
91
|
+
*/
|
|
92
|
+
support_email?: string;
|
|
93
|
+
/**
|
|
94
|
+
* Flag to indicate if the app is in dev mode. If true, the app takes the override properties of components into account.
|
|
95
|
+
*/
|
|
96
|
+
dev_mode?: boolean;
|
|
97
|
+
}
|
|
98
|
+
export interface PatchVersionRequest {
|
|
99
|
+
/**
|
|
100
|
+
* ID of the manifest to use for this version
|
|
101
|
+
*/
|
|
102
|
+
manifest_id?: string;
|
|
103
|
+
/**
|
|
104
|
+
* Name of the role
|
|
105
|
+
*/
|
|
106
|
+
role_id?: string | null;
|
|
107
|
+
grants?: /* Required grants for the app in order to call APIs for the installing tenant */ Schemas.Grants;
|
|
108
|
+
}
|
|
109
|
+
export type UpsertComponentRequest = Schemas.BaseComponent;
|
|
110
|
+
}
|
|
111
|
+
namespace Schemas {
|
|
112
|
+
export interface Actor {
|
|
113
|
+
/**
|
|
114
|
+
* Organization ID of the actor
|
|
115
|
+
*/
|
|
116
|
+
org_id?: string;
|
|
117
|
+
/**
|
|
118
|
+
* User ID of the actor
|
|
119
|
+
*/
|
|
120
|
+
user_id?: string;
|
|
121
|
+
/**
|
|
122
|
+
* Type of the actor (e.g., user, system)
|
|
123
|
+
*/
|
|
124
|
+
type: "user" | "system";
|
|
125
|
+
}
|
|
126
|
+
export interface AggregatedEvents {
|
|
127
|
+
type?: "aggregated";
|
|
128
|
+
groups?: {
|
|
129
|
+
/**
|
|
130
|
+
* The grouped dimensions e.g., "source": "CUSTOM_JOURNEY_BLOCK", "event_type": "ERROR"
|
|
131
|
+
*/
|
|
132
|
+
dimensions?: {
|
|
133
|
+
[name: string]: any;
|
|
134
|
+
};
|
|
135
|
+
metrics?: {
|
|
136
|
+
count?: number;
|
|
137
|
+
error_rate?: number;
|
|
138
|
+
};
|
|
139
|
+
}[];
|
|
140
|
+
}
|
|
141
|
+
export interface AppBridgeSurfaceConfig {
|
|
142
|
+
/**
|
|
143
|
+
* URL of the uploaded App Bridge App. This is the entrypoint for the app
|
|
144
|
+
*/
|
|
145
|
+
app_url?: string;
|
|
146
|
+
/**
|
|
147
|
+
* URL of the uploaded zip file containing the app
|
|
148
|
+
*/
|
|
149
|
+
zip_url?: string;
|
|
150
|
+
/**
|
|
151
|
+
* URL of the app in dev mode
|
|
152
|
+
*/
|
|
153
|
+
override_url?: string;
|
|
154
|
+
}
|
|
155
|
+
export interface AppEventData {
|
|
156
|
+
/**
|
|
157
|
+
* ID of the app configuration
|
|
158
|
+
*/
|
|
159
|
+
app_id: string;
|
|
160
|
+
/**
|
|
161
|
+
* Version of the app configuration
|
|
162
|
+
*/
|
|
163
|
+
version: string;
|
|
164
|
+
event_id?: string;
|
|
165
|
+
component_id: string;
|
|
166
|
+
timestamp?: string;
|
|
167
|
+
correlation_id?: string;
|
|
168
|
+
event_type: "ERROR" | "WARNING" | "INFO";
|
|
169
|
+
source: /* Type of app component */ ComponentType;
|
|
170
|
+
actor: Actor;
|
|
171
|
+
/**
|
|
172
|
+
* Details about the event
|
|
173
|
+
*/
|
|
174
|
+
details?: {
|
|
175
|
+
[name: string]: any;
|
|
176
|
+
};
|
|
177
|
+
}
|
|
178
|
+
export interface Audit {
|
|
179
|
+
/**
|
|
180
|
+
* Timestamp of the creation
|
|
181
|
+
*/
|
|
182
|
+
created_at?: string;
|
|
183
|
+
/**
|
|
184
|
+
* User ID of the creator
|
|
185
|
+
*/
|
|
186
|
+
created_by?: string;
|
|
187
|
+
/**
|
|
188
|
+
* Timestamp of the last update
|
|
189
|
+
*/
|
|
190
|
+
updated_at?: string;
|
|
191
|
+
/**
|
|
192
|
+
* User ID of the last updater
|
|
193
|
+
*/
|
|
194
|
+
updated_by?: string;
|
|
195
|
+
}
|
|
196
|
+
export interface Author {
|
|
197
|
+
/**
|
|
198
|
+
* Name of the author
|
|
199
|
+
*/
|
|
200
|
+
name?: string;
|
|
201
|
+
/**
|
|
202
|
+
* Company of the author
|
|
203
|
+
*/
|
|
204
|
+
company: string;
|
|
205
|
+
/**
|
|
206
|
+
* Email of the author
|
|
207
|
+
*/
|
|
208
|
+
email?: string;
|
|
209
|
+
}
|
|
210
|
+
export type BaseComponent = {
|
|
211
|
+
/**
|
|
212
|
+
* Unique identifier for the component
|
|
213
|
+
*/
|
|
214
|
+
id: string;
|
|
215
|
+
/**
|
|
216
|
+
* Name of the component
|
|
217
|
+
*/
|
|
218
|
+
name?: {
|
|
219
|
+
/**
|
|
220
|
+
* English translation
|
|
221
|
+
*/
|
|
222
|
+
en?: string | null;
|
|
223
|
+
/**
|
|
224
|
+
* German translation
|
|
225
|
+
*/
|
|
226
|
+
de: string;
|
|
227
|
+
};
|
|
228
|
+
/**
|
|
229
|
+
* Description of the component
|
|
230
|
+
*/
|
|
231
|
+
description?: {
|
|
232
|
+
/**
|
|
233
|
+
* English translation
|
|
234
|
+
*/
|
|
235
|
+
en?: string | null;
|
|
236
|
+
/**
|
|
237
|
+
* German translation
|
|
238
|
+
*/
|
|
239
|
+
de: string;
|
|
240
|
+
};
|
|
241
|
+
/**
|
|
242
|
+
* List of options for the app component
|
|
243
|
+
*/
|
|
244
|
+
options?: /* Options for the component configuration */ Options[];
|
|
245
|
+
surfaces?: {
|
|
246
|
+
[key: string]: any;
|
|
247
|
+
};
|
|
248
|
+
} & (JourneyBlockComponent | PortalBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent | CustomCapabilityComponent | ExternalProductCatalogComponent | CustomPageComponent);
|
|
249
|
+
export interface BaseComponentCommon {
|
|
250
|
+
/**
|
|
251
|
+
* Unique identifier for the component
|
|
252
|
+
*/
|
|
253
|
+
id: string;
|
|
254
|
+
/**
|
|
255
|
+
* Name of the component
|
|
256
|
+
*/
|
|
257
|
+
name?: {
|
|
258
|
+
/**
|
|
259
|
+
* English translation
|
|
260
|
+
*/
|
|
261
|
+
en?: string | null;
|
|
262
|
+
/**
|
|
263
|
+
* German translation
|
|
264
|
+
*/
|
|
265
|
+
de: string;
|
|
266
|
+
};
|
|
267
|
+
/**
|
|
268
|
+
* Description of the component
|
|
269
|
+
*/
|
|
270
|
+
description?: {
|
|
271
|
+
/**
|
|
272
|
+
* English translation
|
|
273
|
+
*/
|
|
274
|
+
en?: string | null;
|
|
275
|
+
/**
|
|
276
|
+
* German translation
|
|
277
|
+
*/
|
|
278
|
+
de: string;
|
|
279
|
+
};
|
|
280
|
+
/**
|
|
281
|
+
* List of options for the app component
|
|
282
|
+
*/
|
|
283
|
+
options?: /* Options for the component configuration */ Options[];
|
|
284
|
+
surfaces?: {
|
|
285
|
+
[key: string]: any;
|
|
286
|
+
};
|
|
287
|
+
}
|
|
288
|
+
export interface BaseCustomActionConfig {
|
|
289
|
+
/**
|
|
290
|
+
* Name of the custom action
|
|
291
|
+
*/
|
|
292
|
+
name?: string;
|
|
293
|
+
/**
|
|
294
|
+
* Description of the custom action
|
|
295
|
+
*/
|
|
296
|
+
description?: string;
|
|
297
|
+
/**
|
|
298
|
+
* Wait for callback_url to be called before completing the action
|
|
299
|
+
*/
|
|
300
|
+
wait_for_callback?: boolean;
|
|
301
|
+
}
|
|
302
|
+
export interface BatchEventRequest {
|
|
303
|
+
events: [
|
|
304
|
+
AppEventData?,
|
|
305
|
+
AppEventData?,
|
|
306
|
+
AppEventData?,
|
|
307
|
+
AppEventData?,
|
|
308
|
+
AppEventData?,
|
|
309
|
+
AppEventData?,
|
|
310
|
+
AppEventData?,
|
|
311
|
+
AppEventData?,
|
|
312
|
+
AppEventData?,
|
|
313
|
+
AppEventData?,
|
|
314
|
+
AppEventData?,
|
|
315
|
+
AppEventData?,
|
|
316
|
+
AppEventData?,
|
|
317
|
+
AppEventData?,
|
|
318
|
+
AppEventData?,
|
|
319
|
+
AppEventData?,
|
|
320
|
+
AppEventData?,
|
|
321
|
+
AppEventData?,
|
|
322
|
+
AppEventData?,
|
|
323
|
+
AppEventData?,
|
|
324
|
+
AppEventData?,
|
|
325
|
+
AppEventData?,
|
|
326
|
+
AppEventData?,
|
|
327
|
+
AppEventData?,
|
|
328
|
+
AppEventData?,
|
|
329
|
+
AppEventData?,
|
|
330
|
+
AppEventData?,
|
|
331
|
+
AppEventData?,
|
|
332
|
+
AppEventData?,
|
|
333
|
+
AppEventData?,
|
|
334
|
+
AppEventData?,
|
|
335
|
+
AppEventData?,
|
|
336
|
+
AppEventData?,
|
|
337
|
+
AppEventData?,
|
|
338
|
+
AppEventData?,
|
|
339
|
+
AppEventData?,
|
|
340
|
+
AppEventData?,
|
|
341
|
+
AppEventData?,
|
|
342
|
+
AppEventData?,
|
|
343
|
+
AppEventData?,
|
|
344
|
+
AppEventData?,
|
|
345
|
+
AppEventData?,
|
|
346
|
+
AppEventData?,
|
|
347
|
+
AppEventData?,
|
|
348
|
+
AppEventData?,
|
|
349
|
+
AppEventData?,
|
|
350
|
+
AppEventData?,
|
|
351
|
+
AppEventData?,
|
|
352
|
+
AppEventData?,
|
|
353
|
+
AppEventData?,
|
|
354
|
+
AppEventData?,
|
|
355
|
+
AppEventData?,
|
|
356
|
+
AppEventData?,
|
|
357
|
+
AppEventData?,
|
|
358
|
+
AppEventData?,
|
|
359
|
+
AppEventData?,
|
|
360
|
+
AppEventData?,
|
|
361
|
+
AppEventData?,
|
|
362
|
+
AppEventData?,
|
|
363
|
+
AppEventData?,
|
|
364
|
+
AppEventData?,
|
|
365
|
+
AppEventData?,
|
|
366
|
+
AppEventData?,
|
|
367
|
+
AppEventData?,
|
|
368
|
+
AppEventData?,
|
|
369
|
+
AppEventData?,
|
|
370
|
+
AppEventData?,
|
|
371
|
+
AppEventData?,
|
|
372
|
+
AppEventData?,
|
|
373
|
+
AppEventData?,
|
|
374
|
+
AppEventData?,
|
|
375
|
+
AppEventData?,
|
|
376
|
+
AppEventData?,
|
|
377
|
+
AppEventData?,
|
|
378
|
+
AppEventData?,
|
|
379
|
+
AppEventData?,
|
|
380
|
+
AppEventData?,
|
|
381
|
+
AppEventData?,
|
|
382
|
+
AppEventData?,
|
|
383
|
+
AppEventData?,
|
|
384
|
+
AppEventData?,
|
|
385
|
+
AppEventData?,
|
|
386
|
+
AppEventData?,
|
|
387
|
+
AppEventData?,
|
|
388
|
+
AppEventData?,
|
|
389
|
+
AppEventData?,
|
|
390
|
+
AppEventData?,
|
|
391
|
+
AppEventData?,
|
|
392
|
+
AppEventData?,
|
|
393
|
+
AppEventData?,
|
|
394
|
+
AppEventData?,
|
|
395
|
+
AppEventData?,
|
|
396
|
+
AppEventData?,
|
|
397
|
+
AppEventData?,
|
|
398
|
+
AppEventData?,
|
|
399
|
+
AppEventData?,
|
|
400
|
+
AppEventData?,
|
|
401
|
+
AppEventData?,
|
|
402
|
+
AppEventData?,
|
|
403
|
+
AppEventData?
|
|
404
|
+
];
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
* How often the subscription is billed
|
|
408
|
+
*/
|
|
409
|
+
export type BillingFrequency = "MONTHLY" | "QUARTERLY" | "YEARLY" | "CUSTOM";
|
|
410
|
+
export interface BlueprintRef {
|
|
411
|
+
/**
|
|
412
|
+
* ID of the blueprint
|
|
413
|
+
*/
|
|
414
|
+
manifest_id?: string;
|
|
415
|
+
/**
|
|
416
|
+
* ID of the job that created the blueprint
|
|
417
|
+
*/
|
|
418
|
+
job_id?: string;
|
|
419
|
+
}
|
|
420
|
+
export interface BooleanArg {
|
|
421
|
+
type?: "boolean";
|
|
422
|
+
}
|
|
423
|
+
export interface CallerIdentity {
|
|
424
|
+
/**
|
|
425
|
+
* a human readable name of the caller (e.g. user name, token name or email address)
|
|
426
|
+
* example:
|
|
427
|
+
* manifest@epilot.cloud
|
|
428
|
+
*/
|
|
429
|
+
name?: any;
|
|
430
|
+
/**
|
|
431
|
+
* epilot organization id
|
|
432
|
+
* example:
|
|
433
|
+
* 911690
|
|
434
|
+
*/
|
|
435
|
+
org_id: string;
|
|
436
|
+
/**
|
|
437
|
+
* epilot user id, when called by a user
|
|
438
|
+
* example:
|
|
439
|
+
* 11001045
|
|
440
|
+
*/
|
|
441
|
+
user_id?: string;
|
|
442
|
+
/**
|
|
443
|
+
* token id, when called by API token
|
|
444
|
+
* example:
|
|
445
|
+
* api_5ZugdRXasLfWBypHi93Fk
|
|
446
|
+
*/
|
|
447
|
+
token_id?: string;
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* Type of app component
|
|
451
|
+
*/
|
|
452
|
+
export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE";
|
|
453
|
+
/**
|
|
454
|
+
* Configuration of the published app
|
|
455
|
+
*/
|
|
456
|
+
export interface Configuration {
|
|
457
|
+
app_id: string;
|
|
458
|
+
/**
|
|
459
|
+
* Name of the app
|
|
460
|
+
*/
|
|
461
|
+
name: string;
|
|
462
|
+
author?: Author;
|
|
463
|
+
/**
|
|
464
|
+
* Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account.
|
|
465
|
+
*/
|
|
466
|
+
dev_mode?: boolean;
|
|
467
|
+
/**
|
|
468
|
+
* List of available versions of the app
|
|
469
|
+
*/
|
|
470
|
+
versions: string[];
|
|
471
|
+
/**
|
|
472
|
+
* List of available public versions of the app
|
|
473
|
+
*/
|
|
474
|
+
public_versions?: string[];
|
|
475
|
+
/**
|
|
476
|
+
* Email address for support requests
|
|
477
|
+
*/
|
|
478
|
+
support_email?: string;
|
|
479
|
+
/**
|
|
480
|
+
* Latest version of the app
|
|
481
|
+
*/
|
|
482
|
+
latest_version: string;
|
|
483
|
+
/**
|
|
484
|
+
* Category of the app.
|
|
485
|
+
*/
|
|
486
|
+
category?: string;
|
|
487
|
+
/**
|
|
488
|
+
* URL of the app icon.
|
|
489
|
+
*/
|
|
490
|
+
icon_url?: string;
|
|
491
|
+
/**
|
|
492
|
+
* URL of the app documentation.
|
|
493
|
+
*/
|
|
494
|
+
documentation_url?: string;
|
|
495
|
+
/**
|
|
496
|
+
* Markdown description of the app.
|
|
497
|
+
*/
|
|
498
|
+
description: {
|
|
499
|
+
/**
|
|
500
|
+
* English translation
|
|
501
|
+
*/
|
|
502
|
+
en?: string | null;
|
|
503
|
+
/**
|
|
504
|
+
* German translation
|
|
505
|
+
*/
|
|
506
|
+
de: string;
|
|
507
|
+
};
|
|
508
|
+
/**
|
|
509
|
+
* Configuration for developer notifications
|
|
510
|
+
*/
|
|
511
|
+
notifications?: {
|
|
512
|
+
/**
|
|
513
|
+
* Email address to receive notifications
|
|
514
|
+
* example:
|
|
515
|
+
* developer@example.com
|
|
516
|
+
*/
|
|
517
|
+
email?: string; // email
|
|
518
|
+
/**
|
|
519
|
+
* List of events to subscribe to
|
|
520
|
+
*/
|
|
521
|
+
events?: NotificationEvent[];
|
|
522
|
+
};
|
|
523
|
+
/**
|
|
524
|
+
* Organization ID of the app owner
|
|
525
|
+
*/
|
|
526
|
+
owner_org_id: string;
|
|
527
|
+
/**
|
|
528
|
+
* Flag to indicate if the app is built by epilot.
|
|
529
|
+
*/
|
|
530
|
+
internal?: boolean;
|
|
531
|
+
/**
|
|
532
|
+
* Pricing information for the app
|
|
533
|
+
*/
|
|
534
|
+
pricing?: {
|
|
535
|
+
pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
|
|
536
|
+
billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
|
|
537
|
+
};
|
|
538
|
+
/**
|
|
539
|
+
* Audit information for the app
|
|
540
|
+
*/
|
|
541
|
+
configuration_audit?: {
|
|
542
|
+
/**
|
|
543
|
+
* Timestamp of the creation
|
|
544
|
+
*/
|
|
545
|
+
created_at?: string;
|
|
546
|
+
/**
|
|
547
|
+
* User ID of the creator
|
|
548
|
+
*/
|
|
549
|
+
created_by?: string;
|
|
550
|
+
/**
|
|
551
|
+
* Timestamp of the last update
|
|
552
|
+
*/
|
|
553
|
+
updated_at?: string;
|
|
554
|
+
/**
|
|
555
|
+
* User ID of the last updater
|
|
556
|
+
*/
|
|
557
|
+
updated_by?: string;
|
|
558
|
+
};
|
|
559
|
+
components: BaseComponent[];
|
|
560
|
+
/**
|
|
561
|
+
* Visibility of the app version
|
|
562
|
+
*/
|
|
563
|
+
visibility?: "public" | "private";
|
|
564
|
+
/**
|
|
565
|
+
* Flag to indicate if the app is public.
|
|
566
|
+
*/
|
|
567
|
+
public?: boolean;
|
|
568
|
+
/**
|
|
569
|
+
* Flag to indicate if the app is pending for verification
|
|
570
|
+
*/
|
|
571
|
+
pending?: boolean;
|
|
572
|
+
/**
|
|
573
|
+
* Version of the app that is installed
|
|
574
|
+
*/
|
|
575
|
+
version: string;
|
|
576
|
+
/**
|
|
577
|
+
* Flag to indicate if the app is in beta.
|
|
578
|
+
*/
|
|
579
|
+
is_beta?: boolean;
|
|
580
|
+
/**
|
|
581
|
+
* Timestamp when the app version is deprecated
|
|
582
|
+
*/
|
|
583
|
+
deprecated_at?: string;
|
|
584
|
+
/**
|
|
585
|
+
* Changelog for the app version
|
|
586
|
+
*/
|
|
587
|
+
changelog?: string;
|
|
588
|
+
/**
|
|
589
|
+
* Status of the review process
|
|
590
|
+
*/
|
|
591
|
+
review_status?: "approved" | "rejected" | "pending";
|
|
592
|
+
role?: Role;
|
|
593
|
+
blueprint_ref?: BlueprintRef;
|
|
594
|
+
version_audit: {
|
|
595
|
+
/**
|
|
596
|
+
* Timestamp of the creation
|
|
597
|
+
*/
|
|
598
|
+
created_at?: string;
|
|
599
|
+
/**
|
|
600
|
+
* User ID of the creator
|
|
601
|
+
*/
|
|
602
|
+
created_by?: string;
|
|
603
|
+
/**
|
|
604
|
+
* Timestamp of the last update
|
|
605
|
+
*/
|
|
606
|
+
updated_at?: string;
|
|
607
|
+
/**
|
|
608
|
+
* User ID of the last updater
|
|
609
|
+
*/
|
|
610
|
+
updated_by?: string;
|
|
611
|
+
/**
|
|
612
|
+
* Timestamp of the last version update
|
|
613
|
+
*/
|
|
614
|
+
versioned_at?: string;
|
|
615
|
+
/**
|
|
616
|
+
* User ID of the user who last updated the app
|
|
617
|
+
*/
|
|
618
|
+
versioned_by?: string;
|
|
619
|
+
};
|
|
620
|
+
}
|
|
621
|
+
/**
|
|
622
|
+
* Basic metadata about your app configuration which does not get versioned
|
|
623
|
+
*/
|
|
624
|
+
export interface ConfigurationMetadata {
|
|
625
|
+
app_id: string;
|
|
626
|
+
/**
|
|
627
|
+
* Name of the app
|
|
628
|
+
*/
|
|
629
|
+
name: string;
|
|
630
|
+
author?: Author;
|
|
631
|
+
/**
|
|
632
|
+
* Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account.
|
|
633
|
+
*/
|
|
634
|
+
dev_mode?: boolean;
|
|
635
|
+
/**
|
|
636
|
+
* List of available versions of the app
|
|
637
|
+
*/
|
|
638
|
+
versions: string[];
|
|
639
|
+
/**
|
|
640
|
+
* List of available public versions of the app
|
|
641
|
+
*/
|
|
642
|
+
public_versions?: string[];
|
|
643
|
+
/**
|
|
644
|
+
* Email address for support requests
|
|
645
|
+
*/
|
|
646
|
+
support_email?: string;
|
|
647
|
+
/**
|
|
648
|
+
* Latest version of the app
|
|
649
|
+
*/
|
|
650
|
+
latest_version: string;
|
|
651
|
+
/**
|
|
652
|
+
* Category of the app.
|
|
653
|
+
*/
|
|
654
|
+
category?: string;
|
|
655
|
+
/**
|
|
656
|
+
* URL of the app icon.
|
|
657
|
+
*/
|
|
658
|
+
icon_url?: string;
|
|
659
|
+
/**
|
|
660
|
+
* URL of the app documentation.
|
|
661
|
+
*/
|
|
662
|
+
documentation_url?: string;
|
|
663
|
+
/**
|
|
664
|
+
* Markdown description of the app.
|
|
665
|
+
*/
|
|
666
|
+
description: {
|
|
667
|
+
/**
|
|
668
|
+
* English translation
|
|
669
|
+
*/
|
|
670
|
+
en?: string | null;
|
|
671
|
+
/**
|
|
672
|
+
* German translation
|
|
673
|
+
*/
|
|
674
|
+
de: string;
|
|
675
|
+
};
|
|
676
|
+
/**
|
|
677
|
+
* Configuration for developer notifications
|
|
678
|
+
*/
|
|
679
|
+
notifications?: {
|
|
680
|
+
/**
|
|
681
|
+
* Email address to receive notifications
|
|
682
|
+
* example:
|
|
683
|
+
* developer@example.com
|
|
684
|
+
*/
|
|
685
|
+
email?: string; // email
|
|
686
|
+
/**
|
|
687
|
+
* List of events to subscribe to
|
|
688
|
+
*/
|
|
689
|
+
events?: NotificationEvent[];
|
|
690
|
+
};
|
|
691
|
+
/**
|
|
692
|
+
* Organization ID of the app owner, required for private apps or sandbox accounts
|
|
693
|
+
*/
|
|
694
|
+
owner_org_id: string;
|
|
695
|
+
/**
|
|
696
|
+
* Flag to indicate if the app is built by epilot.
|
|
697
|
+
*/
|
|
698
|
+
internal?: boolean;
|
|
699
|
+
/**
|
|
700
|
+
* Pricing information for the app
|
|
701
|
+
*/
|
|
702
|
+
pricing?: {
|
|
703
|
+
pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
|
|
704
|
+
billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
|
|
705
|
+
};
|
|
706
|
+
/**
|
|
707
|
+
* Audit information for the app
|
|
708
|
+
*/
|
|
709
|
+
configuration_audit?: {
|
|
710
|
+
/**
|
|
711
|
+
* Timestamp of the creation
|
|
712
|
+
*/
|
|
713
|
+
created_at?: string;
|
|
714
|
+
/**
|
|
715
|
+
* User ID of the creator
|
|
716
|
+
*/
|
|
717
|
+
created_by?: string;
|
|
718
|
+
/**
|
|
719
|
+
* Timestamp of the last update
|
|
720
|
+
*/
|
|
721
|
+
updated_at?: string;
|
|
722
|
+
/**
|
|
723
|
+
* User ID of the last updater
|
|
724
|
+
*/
|
|
725
|
+
updated_by?: string;
|
|
726
|
+
};
|
|
727
|
+
}
|
|
728
|
+
/**
|
|
729
|
+
* Configuration data about your app which is versionable
|
|
730
|
+
*/
|
|
731
|
+
export interface ConfigurationVersion {
|
|
732
|
+
app_id: string;
|
|
733
|
+
/**
|
|
734
|
+
* Organization ID of the app owner
|
|
735
|
+
*/
|
|
736
|
+
owner_org_id: string;
|
|
737
|
+
components: BaseComponent[];
|
|
738
|
+
/**
|
|
739
|
+
* Visibility of the app version
|
|
740
|
+
*/
|
|
741
|
+
visibility?: "public" | "private";
|
|
742
|
+
/**
|
|
743
|
+
* Flag to indicate if the app is public.
|
|
744
|
+
*/
|
|
745
|
+
public?: boolean;
|
|
746
|
+
/**
|
|
747
|
+
* Flag to indicate if the app is pending for verification
|
|
748
|
+
*/
|
|
749
|
+
pending?: boolean;
|
|
750
|
+
/**
|
|
751
|
+
* Version of the app that is installed
|
|
752
|
+
*/
|
|
753
|
+
version: string;
|
|
754
|
+
/**
|
|
755
|
+
* Flag to indicate if the app is in beta.
|
|
756
|
+
*/
|
|
757
|
+
is_beta?: boolean;
|
|
758
|
+
/**
|
|
759
|
+
* Timestamp when the app version is deprecated
|
|
760
|
+
*/
|
|
761
|
+
deprecated_at?: string;
|
|
762
|
+
/**
|
|
763
|
+
* Changelog for the app version
|
|
764
|
+
*/
|
|
765
|
+
changelog?: string;
|
|
766
|
+
/**
|
|
767
|
+
* Status of the review process
|
|
768
|
+
*/
|
|
769
|
+
review_status?: "approved" | "rejected" | "pending";
|
|
770
|
+
role?: Role;
|
|
771
|
+
blueprint_ref?: BlueprintRef;
|
|
772
|
+
version_audit: {
|
|
773
|
+
/**
|
|
774
|
+
* Timestamp of the creation
|
|
775
|
+
*/
|
|
776
|
+
created_at?: string;
|
|
777
|
+
/**
|
|
778
|
+
* User ID of the creator
|
|
779
|
+
*/
|
|
780
|
+
created_by?: string;
|
|
781
|
+
/**
|
|
782
|
+
* Timestamp of the last update
|
|
783
|
+
*/
|
|
784
|
+
updated_at?: string;
|
|
785
|
+
/**
|
|
786
|
+
* User ID of the last updater
|
|
787
|
+
*/
|
|
788
|
+
updated_by?: string;
|
|
789
|
+
/**
|
|
790
|
+
* Timestamp of the last version update
|
|
791
|
+
*/
|
|
792
|
+
versioned_at?: string;
|
|
793
|
+
/**
|
|
794
|
+
* User ID of the user who last updated the app
|
|
795
|
+
*/
|
|
796
|
+
versioned_by?: string;
|
|
797
|
+
};
|
|
798
|
+
}
|
|
799
|
+
export interface CustomCapabilityComponent {
|
|
800
|
+
component_type: "CUSTOM_CAPABILITY";
|
|
801
|
+
configuration: {
|
|
802
|
+
/**
|
|
803
|
+
* Define what type of capability this is
|
|
804
|
+
*/
|
|
805
|
+
type?: "tab" | "group";
|
|
806
|
+
/**
|
|
807
|
+
* Which schemas are supported by the capability. If empty, all schemas are supported.
|
|
808
|
+
*/
|
|
809
|
+
allowed_schemas?: string[];
|
|
810
|
+
};
|
|
811
|
+
surfaces?: {
|
|
812
|
+
capability_config?: AppBridgeSurfaceConfig;
|
|
813
|
+
};
|
|
814
|
+
}
|
|
815
|
+
export interface CustomFlowActionComponent {
|
|
816
|
+
component_type: "CUSTOM_FLOW_ACTION";
|
|
817
|
+
configuration: CustomFlowConfig;
|
|
818
|
+
surfaces?: {
|
|
819
|
+
flow_action_config?: AppBridgeSurfaceConfig;
|
|
820
|
+
};
|
|
821
|
+
}
|
|
822
|
+
export type CustomFlowConfig = ExternalIntegrationCustomActionConfig | SandboxCustomActionConfig;
|
|
823
|
+
export interface CustomPageComponent {
|
|
824
|
+
component_type: "CUSTOM_PAGE";
|
|
825
|
+
configuration: CustomPageConfig;
|
|
826
|
+
surfaces?: {
|
|
827
|
+
page?: AppBridgeSurfaceConfig;
|
|
828
|
+
};
|
|
829
|
+
}
|
|
830
|
+
export interface CustomPageConfig {
|
|
831
|
+
/**
|
|
832
|
+
* URL slug for the page route. Must be unique per organization.
|
|
833
|
+
* example:
|
|
834
|
+
* zapier
|
|
835
|
+
*/
|
|
836
|
+
slug: string; // ^[a-z0-9][a-z0-9-]*[a-z0-9]$
|
|
837
|
+
/**
|
|
838
|
+
* Display label in the navigation sidebar.
|
|
839
|
+
* example:
|
|
840
|
+
* Zapier
|
|
841
|
+
*/
|
|
842
|
+
nav_label?: string;
|
|
843
|
+
/**
|
|
844
|
+
* Icon identifier for the navigation item.
|
|
845
|
+
* example:
|
|
846
|
+
* zap
|
|
847
|
+
*/
|
|
848
|
+
nav_icon?: string;
|
|
849
|
+
/**
|
|
850
|
+
* Optional tooltip or description for the navigation item.
|
|
851
|
+
*/
|
|
852
|
+
nav_description?: string;
|
|
853
|
+
}
|
|
854
|
+
export interface EnumArg {
|
|
855
|
+
type?: "enum";
|
|
856
|
+
/**
|
|
857
|
+
* If true, allows selection of multiple values
|
|
858
|
+
*/
|
|
859
|
+
isMulti?: boolean;
|
|
860
|
+
/**
|
|
861
|
+
* List of options for enum type
|
|
862
|
+
*/
|
|
863
|
+
options: [
|
|
864
|
+
{
|
|
865
|
+
/**
|
|
866
|
+
* Unique identifier for the option
|
|
867
|
+
*/
|
|
868
|
+
id: string;
|
|
869
|
+
/**
|
|
870
|
+
* Display label for the option
|
|
871
|
+
*/
|
|
872
|
+
label: {
|
|
873
|
+
/**
|
|
874
|
+
* English translation
|
|
875
|
+
*/
|
|
876
|
+
en?: string | null;
|
|
877
|
+
/**
|
|
878
|
+
* German translation
|
|
879
|
+
*/
|
|
880
|
+
de: string;
|
|
881
|
+
};
|
|
882
|
+
},
|
|
883
|
+
...{
|
|
884
|
+
/**
|
|
885
|
+
* Unique identifier for the option
|
|
886
|
+
*/
|
|
887
|
+
id: string;
|
|
888
|
+
/**
|
|
889
|
+
* Display label for the option
|
|
890
|
+
*/
|
|
891
|
+
label: {
|
|
892
|
+
/**
|
|
893
|
+
* English translation
|
|
894
|
+
*/
|
|
895
|
+
en?: string | null;
|
|
896
|
+
/**
|
|
897
|
+
* German translation
|
|
898
|
+
*/
|
|
899
|
+
de: string;
|
|
900
|
+
};
|
|
901
|
+
}[]
|
|
902
|
+
];
|
|
903
|
+
}
|
|
904
|
+
export interface ErpInformToolkitComponent {
|
|
905
|
+
component_type: "ERP_INFORM_TOOLKIT";
|
|
906
|
+
configuration: {
|
|
907
|
+
type: "inbound" | "outbound";
|
|
908
|
+
};
|
|
909
|
+
}
|
|
910
|
+
export interface EventsQuery {
|
|
911
|
+
/**
|
|
912
|
+
* Either use preset OR start+end
|
|
913
|
+
*/
|
|
914
|
+
time_range?: {
|
|
915
|
+
/**
|
|
916
|
+
* Start time (ISO 8601)
|
|
917
|
+
*/
|
|
918
|
+
start?: string; // date-time
|
|
919
|
+
/**
|
|
920
|
+
* End time (ISO 8601)
|
|
921
|
+
*/
|
|
922
|
+
end?: string; // date-time
|
|
923
|
+
/**
|
|
924
|
+
* Predefined time range (alternative to start/end)
|
|
925
|
+
*/
|
|
926
|
+
preset?: "1h" | "6h" | "24h" | "7d" | "30d";
|
|
927
|
+
};
|
|
928
|
+
filters?: {
|
|
929
|
+
/**
|
|
930
|
+
* Filter by component types
|
|
931
|
+
*/
|
|
932
|
+
source?: /* Type of app component */ ComponentType[];
|
|
933
|
+
/**
|
|
934
|
+
* Filter by specific component IDs
|
|
935
|
+
*/
|
|
936
|
+
component_id?: string[];
|
|
937
|
+
/**
|
|
938
|
+
* Filter by event types
|
|
939
|
+
*/
|
|
940
|
+
event_type?: ("ERROR" | "WARNING" | "INFO")[];
|
|
941
|
+
/**
|
|
942
|
+
* Filter by correlation ID for tracing
|
|
943
|
+
*/
|
|
944
|
+
correlation_id?: string;
|
|
945
|
+
};
|
|
946
|
+
aggregation?: {
|
|
947
|
+
/**
|
|
948
|
+
* Group results by specified fields
|
|
949
|
+
*/
|
|
950
|
+
group_by?: ("source" | "component_id" | "event_type" | "hour" | "day")[];
|
|
951
|
+
/**
|
|
952
|
+
* Metrics to calculate
|
|
953
|
+
*/
|
|
954
|
+
metrics?: ("count" | "error_rate" | "unique_users")[];
|
|
955
|
+
};
|
|
956
|
+
pagination?: {
|
|
957
|
+
page?: number;
|
|
958
|
+
page_size?: number;
|
|
959
|
+
};
|
|
960
|
+
sort?: {
|
|
961
|
+
field?: "timestamp" | "event_type" | "component_id";
|
|
962
|
+
order?: "asc" | "desc";
|
|
963
|
+
};
|
|
964
|
+
}
|
|
965
|
+
export interface EventsQueryResponse {
|
|
966
|
+
query?: EventsQuery;
|
|
967
|
+
results?: RawEvents | AggregatedEvents;
|
|
968
|
+
pagination?: {
|
|
969
|
+
page?: number;
|
|
970
|
+
page_size?: number;
|
|
971
|
+
total_items?: number;
|
|
972
|
+
has_next?: boolean;
|
|
973
|
+
};
|
|
974
|
+
}
|
|
975
|
+
export interface ExternalIntegrationCustomActionConfig {
|
|
976
|
+
/**
|
|
977
|
+
* Name of the custom action
|
|
978
|
+
*/
|
|
979
|
+
name?: string;
|
|
980
|
+
/**
|
|
981
|
+
* Description of the custom action
|
|
982
|
+
*/
|
|
983
|
+
description?: string;
|
|
984
|
+
/**
|
|
985
|
+
* Wait for callback_url to be called before completing the action
|
|
986
|
+
*/
|
|
987
|
+
wait_for_callback?: boolean;
|
|
988
|
+
type: "external_integration";
|
|
989
|
+
external_integration_settings?: {
|
|
990
|
+
/**
|
|
991
|
+
* URL to call
|
|
992
|
+
*/
|
|
993
|
+
url?: string;
|
|
994
|
+
headers?: {
|
|
995
|
+
[name: string]: any;
|
|
996
|
+
};
|
|
997
|
+
};
|
|
998
|
+
}
|
|
999
|
+
export interface ExternalProductCatalogAuthBlock {
|
|
1000
|
+
/**
|
|
1001
|
+
* HTTP method to use for authentication
|
|
1002
|
+
*/
|
|
1003
|
+
method?: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* URL to use for authentication. Supports variable interpolation.
|
|
1006
|
+
*/
|
|
1007
|
+
url: string;
|
|
1008
|
+
/**
|
|
1009
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1010
|
+
*/
|
|
1011
|
+
params?: {
|
|
1012
|
+
[name: string]: string;
|
|
1013
|
+
};
|
|
1014
|
+
/**
|
|
1015
|
+
* Headers to use for authentication. Supports variable interpolation.
|
|
1016
|
+
*/
|
|
1017
|
+
headers?: {
|
|
1018
|
+
[name: string]: string;
|
|
1019
|
+
};
|
|
1020
|
+
/**
|
|
1021
|
+
* JSON body to use for authentication. Supports variable interpolation. Content format is determined by Content-Type header.
|
|
1022
|
+
*/
|
|
1023
|
+
body?: {
|
|
1024
|
+
[name: string]: any;
|
|
1025
|
+
};
|
|
1026
|
+
}
|
|
1027
|
+
export interface ExternalProductCatalogComponent {
|
|
1028
|
+
component_type: "EXTERNAL_PRODUCT_CATALOG";
|
|
1029
|
+
configuration: ExternalProductCatalogConfig;
|
|
1030
|
+
}
|
|
1031
|
+
export interface ExternalProductCatalogConfig {
|
|
1032
|
+
hooks?: (/**
|
|
1033
|
+
* Hook for getting products from an external catalog. This hook makes a call to retrieve product data from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
|
|
1034
|
+
*
|
|
1035
|
+
*/
|
|
1036
|
+
ExternalProductCatalogHookProducts | /**
|
|
1037
|
+
* Hook for getting product recommendations from an external catalog. This hook makes a call to retrieve product recommendations from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
|
|
1038
|
+
*
|
|
1039
|
+
*/
|
|
1040
|
+
ExternalProductCatalogHookProductRecommendations)[];
|
|
1041
|
+
}
|
|
1042
|
+
/**
|
|
1043
|
+
* Hook for getting product recommendations from an external catalog. This hook makes a call to retrieve product recommendations from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
|
|
1044
|
+
*
|
|
1045
|
+
*/
|
|
1046
|
+
export interface ExternalProductCatalogHookProductRecommendations {
|
|
1047
|
+
/**
|
|
1048
|
+
* Identifier of the hook. Should not change between updates.
|
|
1049
|
+
*/
|
|
1050
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1051
|
+
name?: TranslatedString;
|
|
1052
|
+
type: "product-recommendations";
|
|
1053
|
+
auth?: ExternalProductCatalogAuthBlock;
|
|
1054
|
+
call: {
|
|
1055
|
+
/**
|
|
1056
|
+
* HTTP method to use for the call
|
|
1057
|
+
*/
|
|
1058
|
+
method?: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* URL to call. Supports variable interpolation.
|
|
1061
|
+
*/
|
|
1062
|
+
url: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1065
|
+
*/
|
|
1066
|
+
params?: {
|
|
1067
|
+
[name: string]: string;
|
|
1068
|
+
};
|
|
1069
|
+
/**
|
|
1070
|
+
* Headers to use. Supports variable interpolation.
|
|
1071
|
+
*/
|
|
1072
|
+
headers?: {
|
|
1073
|
+
[name: string]: string;
|
|
1074
|
+
};
|
|
1075
|
+
/**
|
|
1076
|
+
* JSON body to use for the call. Supports variable interpolation. If empty / not provided, the default request context will be used based on the consumer (e.g. Journey).
|
|
1077
|
+
*/
|
|
1078
|
+
body?: {
|
|
1079
|
+
[name: string]: any;
|
|
1080
|
+
};
|
|
1081
|
+
};
|
|
1082
|
+
}
|
|
1083
|
+
/**
|
|
1084
|
+
* Hook for getting products from an external catalog. This hook makes a call to retrieve product data from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
|
|
1085
|
+
*
|
|
1086
|
+
*/
|
|
1087
|
+
export interface ExternalProductCatalogHookProducts {
|
|
1088
|
+
/**
|
|
1089
|
+
* Identifier of the hook. Should not change between updates.
|
|
1090
|
+
*/
|
|
1091
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1092
|
+
name?: TranslatedString;
|
|
1093
|
+
type: "products";
|
|
1094
|
+
auth?: ExternalProductCatalogAuthBlock;
|
|
1095
|
+
call: {
|
|
1096
|
+
/**
|
|
1097
|
+
* HTTP method to use for the call
|
|
1098
|
+
*/
|
|
1099
|
+
method?: string;
|
|
1100
|
+
/**
|
|
1101
|
+
* URL to call. Supports variable interpolation.
|
|
1102
|
+
*/
|
|
1103
|
+
url: string;
|
|
1104
|
+
/**
|
|
1105
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1106
|
+
*/
|
|
1107
|
+
params?: {
|
|
1108
|
+
[name: string]: string;
|
|
1109
|
+
};
|
|
1110
|
+
/**
|
|
1111
|
+
* Headers to use. Supports variable interpolation.
|
|
1112
|
+
*/
|
|
1113
|
+
headers?: {
|
|
1114
|
+
[name: string]: string;
|
|
1115
|
+
};
|
|
1116
|
+
/**
|
|
1117
|
+
* JSON body to use for the call. Supports variable interpolation. If empty / not provided, the default request context will be used based on the consumer (e.g. Journey).
|
|
1118
|
+
*/
|
|
1119
|
+
body?: {
|
|
1120
|
+
[name: string]: any;
|
|
1121
|
+
};
|
|
1122
|
+
};
|
|
1123
|
+
}
|
|
1124
|
+
/**
|
|
1125
|
+
* Required grants for the app in order to call APIs for the installing tenant
|
|
1126
|
+
*/
|
|
1127
|
+
export type Grants = {
|
|
1128
|
+
/**
|
|
1129
|
+
* The action the app can perform
|
|
1130
|
+
*/
|
|
1131
|
+
action: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* The resource the app can access
|
|
1134
|
+
*/
|
|
1135
|
+
resource?: string;
|
|
1136
|
+
}[];
|
|
1137
|
+
/**
|
|
1138
|
+
* Information about the installed app. Has configuration data of the installed version
|
|
1139
|
+
*/
|
|
1140
|
+
export interface Installation {
|
|
1141
|
+
/**
|
|
1142
|
+
* ID of the app configuration
|
|
1143
|
+
*/
|
|
1144
|
+
app_id: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* Unique identifier for the organization the app is installed in
|
|
1147
|
+
*/
|
|
1148
|
+
installer_org_id: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* Organization ID of the app creator
|
|
1151
|
+
*/
|
|
1152
|
+
owner_org_id?: string;
|
|
1153
|
+
/**
|
|
1154
|
+
* Flag to indicate if the app is enabled. Enabled is set to true when required option values are set.
|
|
1155
|
+
*/
|
|
1156
|
+
enabled: boolean;
|
|
1157
|
+
/**
|
|
1158
|
+
* Name of the app
|
|
1159
|
+
*/
|
|
1160
|
+
name: string;
|
|
1161
|
+
/**
|
|
1162
|
+
* Configuration values for the app components
|
|
1163
|
+
*/
|
|
1164
|
+
option_values?: OptionsRef[];
|
|
1165
|
+
/**
|
|
1166
|
+
* List of component configurations for the installed version
|
|
1167
|
+
*/
|
|
1168
|
+
components: BaseComponent[];
|
|
1169
|
+
/**
|
|
1170
|
+
* Version of the app that is installed
|
|
1171
|
+
*/
|
|
1172
|
+
installed_version: string;
|
|
1173
|
+
/**
|
|
1174
|
+
* The name of the role the app can use to access APIs
|
|
1175
|
+
*/
|
|
1176
|
+
role?: string;
|
|
1177
|
+
blueprint_ref?: BlueprintRef;
|
|
1178
|
+
/**
|
|
1179
|
+
* Audit information for the app
|
|
1180
|
+
*/
|
|
1181
|
+
installation_audit?: {
|
|
1182
|
+
/**
|
|
1183
|
+
* Timestamp of the creation
|
|
1184
|
+
*/
|
|
1185
|
+
created_at?: string;
|
|
1186
|
+
/**
|
|
1187
|
+
* User ID of the creator
|
|
1188
|
+
*/
|
|
1189
|
+
created_by?: string;
|
|
1190
|
+
/**
|
|
1191
|
+
* Timestamp of the last update
|
|
1192
|
+
*/
|
|
1193
|
+
updated_at?: string;
|
|
1194
|
+
/**
|
|
1195
|
+
* User ID of the last updater
|
|
1196
|
+
*/
|
|
1197
|
+
updated_by?: string;
|
|
1198
|
+
};
|
|
1199
|
+
/**
|
|
1200
|
+
* Manifest ID used to create/update the entity
|
|
1201
|
+
*/
|
|
1202
|
+
_manifest?: string /* uuid */[];
|
|
1203
|
+
}
|
|
1204
|
+
export interface JourneyBlockComponent {
|
|
1205
|
+
component_type: "CUSTOM_JOURNEY_BLOCK";
|
|
1206
|
+
configuration: JourneyBlockConfig;
|
|
1207
|
+
}
|
|
1208
|
+
export type JourneyBlockComponentArgs = {
|
|
1209
|
+
/**
|
|
1210
|
+
* Unique identifier for this component arg
|
|
1211
|
+
*/
|
|
1212
|
+
key: string;
|
|
1213
|
+
type: "text" | "boolean" | "enum";
|
|
1214
|
+
/**
|
|
1215
|
+
* Flag to indicate if this option is required
|
|
1216
|
+
*/
|
|
1217
|
+
required?: boolean;
|
|
1218
|
+
/**
|
|
1219
|
+
* Description of what this component arg does
|
|
1220
|
+
*/
|
|
1221
|
+
description?: {
|
|
1222
|
+
/**
|
|
1223
|
+
* English translation
|
|
1224
|
+
*/
|
|
1225
|
+
en?: string | null;
|
|
1226
|
+
/**
|
|
1227
|
+
* German translation
|
|
1228
|
+
*/
|
|
1229
|
+
de: string;
|
|
1230
|
+
};
|
|
1231
|
+
/**
|
|
1232
|
+
* Human-readable label for the component arg
|
|
1233
|
+
*/
|
|
1234
|
+
label: {
|
|
1235
|
+
/**
|
|
1236
|
+
* English translation
|
|
1237
|
+
*/
|
|
1238
|
+
en?: string | null;
|
|
1239
|
+
/**
|
|
1240
|
+
* German translation
|
|
1241
|
+
*/
|
|
1242
|
+
de: string;
|
|
1243
|
+
};
|
|
1244
|
+
} & (TextArg | BooleanArg | EnumArg);
|
|
1245
|
+
export interface JourneyBlockConfig {
|
|
1246
|
+
override_dev_mode?: /* Override URL when app is in dev mode */ OverrideDevMode;
|
|
1247
|
+
/**
|
|
1248
|
+
* URL of the web component object
|
|
1249
|
+
* example:
|
|
1250
|
+
* https://cdn.apps.com/123/v1.0.0/bundle.js
|
|
1251
|
+
*/
|
|
1252
|
+
component_url: string;
|
|
1253
|
+
/**
|
|
1254
|
+
* Custom element tag for the component
|
|
1255
|
+
*/
|
|
1256
|
+
component_tag: string;
|
|
1257
|
+
/**
|
|
1258
|
+
* Arguments to pass to the component
|
|
1259
|
+
*/
|
|
1260
|
+
component_args?: JourneyBlockComponentArgs[];
|
|
1261
|
+
/**
|
|
1262
|
+
* Size of the bundle in bytes
|
|
1263
|
+
*/
|
|
1264
|
+
component_size?: number;
|
|
1265
|
+
/**
|
|
1266
|
+
* Define data which is mapped to entity mapping ui blocks
|
|
1267
|
+
*/
|
|
1268
|
+
component_mapping?: {
|
|
1269
|
+
[name: string]: "string" | "boolean" | "date" | "datetime" | "link" | "number";
|
|
1270
|
+
};
|
|
1271
|
+
}
|
|
1272
|
+
export interface NotificationConfig {
|
|
1273
|
+
/**
|
|
1274
|
+
* Email address to receive notifications
|
|
1275
|
+
* example:
|
|
1276
|
+
* developer@example.com
|
|
1277
|
+
*/
|
|
1278
|
+
email?: string; // email
|
|
1279
|
+
/**
|
|
1280
|
+
* List of events to subscribe to
|
|
1281
|
+
*/
|
|
1282
|
+
events?: NotificationEvent[];
|
|
1283
|
+
}
|
|
1284
|
+
export type NotificationEvent = "app.installed" | "app.uninstalled";
|
|
1285
|
+
export interface Option {
|
|
1286
|
+
/**
|
|
1287
|
+
* Key matching a config_option from the component
|
|
1288
|
+
*/
|
|
1289
|
+
key: string;
|
|
1290
|
+
/**
|
|
1291
|
+
* The configured value for this option
|
|
1292
|
+
*/
|
|
1293
|
+
value: string | boolean | number;
|
|
1294
|
+
}
|
|
1295
|
+
/**
|
|
1296
|
+
* Options for the component configuration
|
|
1297
|
+
*/
|
|
1298
|
+
export interface Options {
|
|
1299
|
+
/**
|
|
1300
|
+
* Unique identifier for this configuration option
|
|
1301
|
+
*/
|
|
1302
|
+
key: string;
|
|
1303
|
+
/**
|
|
1304
|
+
* Human-readable label for the configuration option
|
|
1305
|
+
*/
|
|
1306
|
+
label?: string;
|
|
1307
|
+
/**
|
|
1308
|
+
* Flag to indicate if this option is required
|
|
1309
|
+
*/
|
|
1310
|
+
required?: boolean;
|
|
1311
|
+
/**
|
|
1312
|
+
* Detailed description of what this configuration option does
|
|
1313
|
+
*/
|
|
1314
|
+
description?: string;
|
|
1315
|
+
/**
|
|
1316
|
+
* The configured value for this option. Is only present when the component is installed.
|
|
1317
|
+
*/
|
|
1318
|
+
value?: string | boolean | number;
|
|
1319
|
+
type: "text" | "number" | "boolean" | "secret";
|
|
1320
|
+
}
|
|
1321
|
+
export interface OptionsRef {
|
|
1322
|
+
/**
|
|
1323
|
+
* ID of the component these values are for
|
|
1324
|
+
*/
|
|
1325
|
+
component_id: string;
|
|
1326
|
+
options: Option[];
|
|
1327
|
+
}
|
|
1328
|
+
/**
|
|
1329
|
+
* Override URL when app is in dev mode
|
|
1330
|
+
*/
|
|
1331
|
+
export interface OverrideDevMode {
|
|
1332
|
+
/**
|
|
1333
|
+
* URL of the web component object in dev mode
|
|
1334
|
+
* example:
|
|
1335
|
+
* http://localhost:3000
|
|
1336
|
+
*/
|
|
1337
|
+
override_url?: string;
|
|
1338
|
+
}
|
|
1339
|
+
export interface PortalBlockComponent {
|
|
1340
|
+
component_type: "CUSTOM_PORTAL_BLOCK";
|
|
1341
|
+
configuration: PortalBlockConfig;
|
|
1342
|
+
surfaces?: {
|
|
1343
|
+
portal_block?: PortalBlockSurfaceConfig;
|
|
1344
|
+
};
|
|
1345
|
+
}
|
|
1346
|
+
export interface PortalBlockConfig {
|
|
1347
|
+
}
|
|
1348
|
+
export interface PortalBlockSurfaceConfig {
|
|
1349
|
+
/**
|
|
1350
|
+
* URL of the uploaded App Bridge App. This is the entrypoint for the app
|
|
1351
|
+
*/
|
|
1352
|
+
app_url?: string;
|
|
1353
|
+
/**
|
|
1354
|
+
* URL of the uploaded zip file containing the app
|
|
1355
|
+
*/
|
|
1356
|
+
zip_url?: string;
|
|
1357
|
+
/**
|
|
1358
|
+
* URL of the app in dev mode
|
|
1359
|
+
*/
|
|
1360
|
+
override_url?: string;
|
|
1361
|
+
/**
|
|
1362
|
+
* Define which section of the portal this block can be placed in
|
|
1363
|
+
*/
|
|
1364
|
+
section?: "main" | "footer";
|
|
1365
|
+
}
|
|
1366
|
+
export interface PortalExtensionAuthBlock {
|
|
1367
|
+
/**
|
|
1368
|
+
* HTTP method to use for authentication
|
|
1369
|
+
*/
|
|
1370
|
+
method?: string;
|
|
1371
|
+
/**
|
|
1372
|
+
* URL to use for authentication. Supports variable interpolation.
|
|
1373
|
+
*/
|
|
1374
|
+
url: string;
|
|
1375
|
+
/**
|
|
1376
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1377
|
+
*/
|
|
1378
|
+
params?: {
|
|
1379
|
+
[name: string]: string;
|
|
1380
|
+
};
|
|
1381
|
+
/**
|
|
1382
|
+
* Headers to use for authentication. Supports variable interpolation.
|
|
1383
|
+
*/
|
|
1384
|
+
headers?: {
|
|
1385
|
+
[name: string]: string;
|
|
1386
|
+
};
|
|
1387
|
+
/**
|
|
1388
|
+
* JSON body to use for authentication. Supports variable interpolation. Content format is determined by Content-Type header.
|
|
1389
|
+
*/
|
|
1390
|
+
body?: {
|
|
1391
|
+
[name: string]: any;
|
|
1392
|
+
};
|
|
1393
|
+
cache?: {
|
|
1394
|
+
/**
|
|
1395
|
+
* Key to use to identify the auth response. Supports interpolation.
|
|
1396
|
+
* example:
|
|
1397
|
+
* {{Options.api_key}}
|
|
1398
|
+
*/
|
|
1399
|
+
key: string;
|
|
1400
|
+
/**
|
|
1401
|
+
* Time to live in seconds for the cache. Supports interpolation.
|
|
1402
|
+
* example:
|
|
1403
|
+
* {{AuthResponse.data.expires_in}}
|
|
1404
|
+
*/
|
|
1405
|
+
ttl: string;
|
|
1406
|
+
};
|
|
1407
|
+
}
|
|
1408
|
+
export interface PortalExtensionComponent {
|
|
1409
|
+
component_type: "PORTAL_EXTENSION";
|
|
1410
|
+
configuration: PortalExtensionConfig;
|
|
1411
|
+
}
|
|
1412
|
+
export interface PortalExtensionConfig {
|
|
1413
|
+
hooks?: (/**
|
|
1414
|
+
* Hook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
|
|
1415
|
+
* - 200 with contact id if exactly one contact is found
|
|
1416
|
+
* - 404 if no contact is found or more than contact is found
|
|
1417
|
+
*
|
|
1418
|
+
*/
|
|
1419
|
+
PortalExtensionHookRegistrationIdentifiersCheck | /**
|
|
1420
|
+
* Hook that replaces the built-in Contract identification for self-assignment. This hook involves an HTTP request whenever a user is trying to self-assign Contract(s).
|
|
1421
|
+
* The expected response http status code to the call is:
|
|
1422
|
+
* - 200 if found
|
|
1423
|
+
* - 404 if not found
|
|
1424
|
+
*
|
|
1425
|
+
* The following assignment modes are supported:
|
|
1426
|
+
* - `contracts`: We expect the response to contain Contract ids (customizable using `result` property).
|
|
1427
|
+
* - `contact_to_contracts`: We expect the response to contain a Contact id (customizable using `result` property) and we will assign the Contact as a Customer to the Contracts and (optionally) update the Contact attribute specified by `contact_relation_attribute` to add the matched Contact.
|
|
1428
|
+
* - `contact_to_portal_user`: We expect the response to contain a Contact id (customizable using `result` property) and we will assign the Contact to the Portal User. Portal User will be able to see all data including Contracts transitively.
|
|
1429
|
+
*
|
|
1430
|
+
* Defaults to `contact_to_contracts` for backwards compatibility. We recommend using `contact_to_portal_user` as it does not influence the data model of business entities.
|
|
1431
|
+
*
|
|
1432
|
+
*/
|
|
1433
|
+
PortalExtensionHookContractIdentification | /**
|
|
1434
|
+
* Hook that will allow using the specified source as data for price visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
|
|
1435
|
+
* - 200 with the time series data
|
|
1436
|
+
*
|
|
1437
|
+
*/
|
|
1438
|
+
PortalExtensionHookPriceDataRetrieval | /**
|
|
1439
|
+
* Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
|
|
1440
|
+
* - 200 with the time series data
|
|
1441
|
+
*
|
|
1442
|
+
*/
|
|
1443
|
+
PortalExtensionHookConsumptionDataRetrieval | /**
|
|
1444
|
+
* Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
|
|
1445
|
+
* - 200 with the time series data
|
|
1446
|
+
*
|
|
1447
|
+
*/
|
|
1448
|
+
PortalExtensionHookCostDataRetrieval | /**
|
|
1449
|
+
* Hook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:
|
|
1450
|
+
* - 200:
|
|
1451
|
+
* If meter reading is plausible, the response should contain:
|
|
1452
|
+
* - valid: true
|
|
1453
|
+
* If meter reading is not plausible, the response should contain:
|
|
1454
|
+
* - valid: false
|
|
1455
|
+
*
|
|
1456
|
+
*/
|
|
1457
|
+
PortalExtensionHookMeterReadingPlausibilityCheck)[];
|
|
1458
|
+
links?: {
|
|
1459
|
+
/**
|
|
1460
|
+
* Identifier of the link. Should not change between updates.
|
|
1461
|
+
*/
|
|
1462
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1463
|
+
name: TranslatedString;
|
|
1464
|
+
description?: TranslatedString;
|
|
1465
|
+
type: "seamless";
|
|
1466
|
+
/**
|
|
1467
|
+
* Controls whether the link should be shown. Supports variable interpolation.
|
|
1468
|
+
* example:
|
|
1469
|
+
* {{Contact.customer_number | is_not_empty}}
|
|
1470
|
+
*/
|
|
1471
|
+
condition?: string;
|
|
1472
|
+
auth?: PortalExtensionAuthBlock;
|
|
1473
|
+
redirect: {
|
|
1474
|
+
/**
|
|
1475
|
+
* URL to redirect to. Supports variable interpolation.
|
|
1476
|
+
*/
|
|
1477
|
+
url?: string;
|
|
1478
|
+
/**
|
|
1479
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1480
|
+
*/
|
|
1481
|
+
params?: {
|
|
1482
|
+
[name: string]: string;
|
|
1483
|
+
};
|
|
1484
|
+
};
|
|
1485
|
+
}[];
|
|
1486
|
+
}
|
|
1487
|
+
/**
|
|
1488
|
+
* Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
|
|
1489
|
+
* - 200 with the time series data
|
|
1490
|
+
*
|
|
1491
|
+
*/
|
|
1492
|
+
export interface PortalExtensionHookConsumptionDataRetrieval {
|
|
1493
|
+
/**
|
|
1494
|
+
* Identifier of the hook. Should not change between updates.
|
|
1495
|
+
*/
|
|
1496
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1497
|
+
name?: TranslatedString;
|
|
1498
|
+
type: "consumptionDataRetrieval";
|
|
1499
|
+
/**
|
|
1500
|
+
* Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
|
|
1501
|
+
*/
|
|
1502
|
+
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
|
|
1503
|
+
auth?: PortalExtensionAuthBlock;
|
|
1504
|
+
call: {
|
|
1505
|
+
/**
|
|
1506
|
+
* HTTP method to use for the call
|
|
1507
|
+
*/
|
|
1508
|
+
method?: string;
|
|
1509
|
+
/**
|
|
1510
|
+
* URL to call. Supports variable interpolation.
|
|
1511
|
+
*/
|
|
1512
|
+
url: string;
|
|
1513
|
+
/**
|
|
1514
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1515
|
+
*/
|
|
1516
|
+
params?: {
|
|
1517
|
+
[name: string]: string;
|
|
1518
|
+
};
|
|
1519
|
+
/**
|
|
1520
|
+
* Headers to use. Supports variable interpolation.
|
|
1521
|
+
*/
|
|
1522
|
+
headers?: {
|
|
1523
|
+
[name: string]: string;
|
|
1524
|
+
};
|
|
1525
|
+
/**
|
|
1526
|
+
* Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.
|
|
1527
|
+
*/
|
|
1528
|
+
body?: {
|
|
1529
|
+
[name: string]: any;
|
|
1530
|
+
};
|
|
1531
|
+
};
|
|
1532
|
+
resolved?: {
|
|
1533
|
+
/**
|
|
1534
|
+
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
1535
|
+
*/
|
|
1536
|
+
dataPath?: string;
|
|
1537
|
+
};
|
|
1538
|
+
/**
|
|
1539
|
+
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
1540
|
+
*/
|
|
1541
|
+
use_static_ips?: boolean;
|
|
1542
|
+
}
|
|
1543
|
+
/**
|
|
1544
|
+
* Hook that replaces the built-in Contract identification for self-assignment. This hook involves an HTTP request whenever a user is trying to self-assign Contract(s).
|
|
1545
|
+
* The expected response http status code to the call is:
|
|
1546
|
+
* - 200 if found
|
|
1547
|
+
* - 404 if not found
|
|
1548
|
+
*
|
|
1549
|
+
* The following assignment modes are supported:
|
|
1550
|
+
* - `contracts`: We expect the response to contain Contract ids (customizable using `result` property).
|
|
1551
|
+
* - `contact_to_contracts`: We expect the response to contain a Contact id (customizable using `result` property) and we will assign the Contact as a Customer to the Contracts and (optionally) update the Contact attribute specified by `contact_relation_attribute` to add the matched Contact.
|
|
1552
|
+
* - `contact_to_portal_user`: We expect the response to contain a Contact id (customizable using `result` property) and we will assign the Contact to the Portal User. Portal User will be able to see all data including Contracts transitively.
|
|
1553
|
+
*
|
|
1554
|
+
* Defaults to `contact_to_contracts` for backwards compatibility. We recommend using `contact_to_portal_user` as it does not influence the data model of business entities.
|
|
1555
|
+
*
|
|
1556
|
+
*/
|
|
1557
|
+
export interface PortalExtensionHookContractIdentification {
|
|
1558
|
+
/**
|
|
1559
|
+
* Identifier of the hook. Should not change between updates.
|
|
1560
|
+
*/
|
|
1561
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1562
|
+
name?: TranslatedString;
|
|
1563
|
+
type: "contractIdentification";
|
|
1564
|
+
auth?: PortalExtensionAuthBlock;
|
|
1565
|
+
call: {
|
|
1566
|
+
/**
|
|
1567
|
+
* HTTP method to use for the call
|
|
1568
|
+
*/
|
|
1569
|
+
method?: string;
|
|
1570
|
+
/**
|
|
1571
|
+
* URL to call. Supports variable interpolation.
|
|
1572
|
+
*/
|
|
1573
|
+
url: string;
|
|
1574
|
+
/**
|
|
1575
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1576
|
+
*/
|
|
1577
|
+
params?: {
|
|
1578
|
+
[name: string]: string;
|
|
1579
|
+
};
|
|
1580
|
+
/**
|
|
1581
|
+
* Headers to use. Supports variable interpolation.
|
|
1582
|
+
*/
|
|
1583
|
+
headers: {
|
|
1584
|
+
[name: string]: string;
|
|
1585
|
+
};
|
|
1586
|
+
/**
|
|
1587
|
+
* Optional JSON body to use for the call. Defaults to object with all configured identifiers grouped by entity, e.g. `{"contract": {"contract_name": "Name"}}`. Supports variable interpolation.
|
|
1588
|
+
*/
|
|
1589
|
+
body?: {
|
|
1590
|
+
[key: string]: any;
|
|
1591
|
+
};
|
|
1592
|
+
/**
|
|
1593
|
+
* Contract or Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation.
|
|
1594
|
+
*/
|
|
1595
|
+
result?: string;
|
|
1596
|
+
};
|
|
1597
|
+
/**
|
|
1598
|
+
* Mode of contract assignment. See hook description for mode details.
|
|
1599
|
+
*/
|
|
1600
|
+
assignment_mode?: "contracts" | "contact_to_contracts" | "contact_to_portal_user";
|
|
1601
|
+
/**
|
|
1602
|
+
* Name of the Contact attribute to update with the matched Contact ID when using `contact_to_contracts` mode. Must be a Contact relation attribute supporting multiple entities.
|
|
1603
|
+
* example:
|
|
1604
|
+
* represents_contact
|
|
1605
|
+
*/
|
|
1606
|
+
contact_relation_attribute?: string;
|
|
1607
|
+
/**
|
|
1608
|
+
* Explanation of the hook.
|
|
1609
|
+
*/
|
|
1610
|
+
explanation?: {
|
|
1611
|
+
[name: string]: string;
|
|
1612
|
+
/**
|
|
1613
|
+
* Explanation of the functionality shown to the end user.
|
|
1614
|
+
* example:
|
|
1615
|
+
* This process will give you access to the matching Contracts.
|
|
1616
|
+
*/
|
|
1617
|
+
en: string;
|
|
1618
|
+
};
|
|
1619
|
+
/**
|
|
1620
|
+
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
1621
|
+
*/
|
|
1622
|
+
use_static_ips?: boolean;
|
|
1623
|
+
}
|
|
1624
|
+
/**
|
|
1625
|
+
* Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
|
|
1626
|
+
* - 200 with the time series data
|
|
1627
|
+
*
|
|
1628
|
+
*/
|
|
1629
|
+
export interface PortalExtensionHookCostDataRetrieval {
|
|
1630
|
+
/**
|
|
1631
|
+
* Identifier of the hook. Should not change between updates.
|
|
1632
|
+
*/
|
|
1633
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1634
|
+
name?: TranslatedString;
|
|
1635
|
+
type: "costDataRetrieval";
|
|
1636
|
+
/**
|
|
1637
|
+
* Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
|
|
1638
|
+
*/
|
|
1639
|
+
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
|
|
1640
|
+
auth?: PortalExtensionAuthBlock;
|
|
1641
|
+
call: {
|
|
1642
|
+
/**
|
|
1643
|
+
* HTTP method to use for the call
|
|
1644
|
+
*/
|
|
1645
|
+
method?: string;
|
|
1646
|
+
/**
|
|
1647
|
+
* URL to call. Supports variable interpolation.
|
|
1648
|
+
*/
|
|
1649
|
+
url: string;
|
|
1650
|
+
/**
|
|
1651
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1652
|
+
*/
|
|
1653
|
+
params?: {
|
|
1654
|
+
[name: string]: string;
|
|
1655
|
+
};
|
|
1656
|
+
/**
|
|
1657
|
+
* Headers to use. Supports variable interpolation.
|
|
1658
|
+
*/
|
|
1659
|
+
headers?: {
|
|
1660
|
+
[name: string]: string;
|
|
1661
|
+
};
|
|
1662
|
+
/**
|
|
1663
|
+
* Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.
|
|
1664
|
+
*/
|
|
1665
|
+
body?: {
|
|
1666
|
+
[name: string]: any;
|
|
1667
|
+
};
|
|
1668
|
+
};
|
|
1669
|
+
resolved?: {
|
|
1670
|
+
/**
|
|
1671
|
+
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
1672
|
+
*/
|
|
1673
|
+
dataPath?: string;
|
|
1674
|
+
};
|
|
1675
|
+
/**
|
|
1676
|
+
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
1677
|
+
*/
|
|
1678
|
+
use_static_ips?: boolean;
|
|
1679
|
+
}
|
|
1680
|
+
/**
|
|
1681
|
+
* Hook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:
|
|
1682
|
+
* - 200:
|
|
1683
|
+
* If meter reading is plausible, the response should contain:
|
|
1684
|
+
* - valid: true
|
|
1685
|
+
* If meter reading is not plausible, the response should contain:
|
|
1686
|
+
* - valid: false
|
|
1687
|
+
*
|
|
1688
|
+
*/
|
|
1689
|
+
export interface PortalExtensionHookMeterReadingPlausibilityCheck {
|
|
1690
|
+
/**
|
|
1691
|
+
* Identifier of the hook. Should not change between updates.
|
|
1692
|
+
*/
|
|
1693
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1694
|
+
name?: TranslatedString;
|
|
1695
|
+
type: "meterReadingPlausibilityCheck";
|
|
1696
|
+
/**
|
|
1697
|
+
* Mode for plausibility check:
|
|
1698
|
+
* - "check": Validates meter reading and returns valid: boolean (used during submission)
|
|
1699
|
+
* - "range": Returns min/max allowed values for each counter for validation before submission
|
|
1700
|
+
*
|
|
1701
|
+
*/
|
|
1702
|
+
plausibility_mode?: "check" | "range";
|
|
1703
|
+
auth?: PortalExtensionAuthBlock;
|
|
1704
|
+
call: {
|
|
1705
|
+
/**
|
|
1706
|
+
* URL to call. Supports variable interpolation.
|
|
1707
|
+
*/
|
|
1708
|
+
url: string;
|
|
1709
|
+
/**
|
|
1710
|
+
* JSON body to use for the call. Supports variable interpolation.
|
|
1711
|
+
*/
|
|
1712
|
+
body: {
|
|
1713
|
+
[name: string]: any;
|
|
1714
|
+
};
|
|
1715
|
+
/**
|
|
1716
|
+
* Headers to use. Supports variable interpolation.
|
|
1717
|
+
*/
|
|
1718
|
+
headers: {
|
|
1719
|
+
[name: string]: string;
|
|
1720
|
+
};
|
|
1721
|
+
};
|
|
1722
|
+
/**
|
|
1723
|
+
* Response to the call
|
|
1724
|
+
*/
|
|
1725
|
+
resolved: {
|
|
1726
|
+
/**
|
|
1727
|
+
* Optional path to an array in the response. If specified and the path points to an array,
|
|
1728
|
+
* the hook will map over each item using 'Item' variable for interpolation.
|
|
1729
|
+
* Relevant only if plausibility_mode is "range".
|
|
1730
|
+
*
|
|
1731
|
+
* example:
|
|
1732
|
+
* data.results
|
|
1733
|
+
*/
|
|
1734
|
+
dataPath?: string;
|
|
1735
|
+
/**
|
|
1736
|
+
* Counter identifier(s) used to match against the meter's counters.
|
|
1737
|
+
* Can be a string (counter ID) or an object with counter properties.
|
|
1738
|
+
* The backend resolves this to meter_counter_id in the final response.
|
|
1739
|
+
* Relevant only if plausibility_mode is "range".
|
|
1740
|
+
*
|
|
1741
|
+
* example:
|
|
1742
|
+
* {
|
|
1743
|
+
* "obis_code": "{{Item.obis}}"
|
|
1744
|
+
* }
|
|
1745
|
+
*/
|
|
1746
|
+
counter_identifiers?: {
|
|
1747
|
+
[name: string]: string;
|
|
1748
|
+
};
|
|
1749
|
+
/**
|
|
1750
|
+
* Indicate whether the meter reading is plausible. Relevant only if plausibility_mode is "check".
|
|
1751
|
+
* example:
|
|
1752
|
+
* {{CallResponse.data.valid}}
|
|
1753
|
+
*/
|
|
1754
|
+
valid?: string;
|
|
1755
|
+
/**
|
|
1756
|
+
* Upper allowed limit of the meter reading
|
|
1757
|
+
* example:
|
|
1758
|
+
* {{CallResponse.data.upper_limit}}
|
|
1759
|
+
*/
|
|
1760
|
+
upper_limit?: string;
|
|
1761
|
+
/**
|
|
1762
|
+
* Lower allowed limit of the meter reading
|
|
1763
|
+
* example:
|
|
1764
|
+
* {{CallResponse.data.lower_limit}}
|
|
1765
|
+
*/
|
|
1766
|
+
lower_limit?: string;
|
|
1767
|
+
};
|
|
1768
|
+
/**
|
|
1769
|
+
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
1770
|
+
*/
|
|
1771
|
+
use_static_ips?: boolean;
|
|
1772
|
+
}
|
|
1773
|
+
/**
|
|
1774
|
+
* Hook that will allow using the specified source as data for price visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
|
|
1775
|
+
* - 200 with the time series data
|
|
1776
|
+
*
|
|
1777
|
+
*/
|
|
1778
|
+
export interface PortalExtensionHookPriceDataRetrieval {
|
|
1779
|
+
/**
|
|
1780
|
+
* Identifier of the hook. Should not change between updates.
|
|
1781
|
+
*/
|
|
1782
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1783
|
+
name?: TranslatedString;
|
|
1784
|
+
type: "priceDataRetrieval";
|
|
1785
|
+
/**
|
|
1786
|
+
* Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
|
|
1787
|
+
*/
|
|
1788
|
+
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
|
|
1789
|
+
auth?: PortalExtensionAuthBlock;
|
|
1790
|
+
call: {
|
|
1791
|
+
/**
|
|
1792
|
+
* HTTP method to use for the call
|
|
1793
|
+
*/
|
|
1794
|
+
method?: string;
|
|
1795
|
+
/**
|
|
1796
|
+
* URL to call. Supports variable interpolation.
|
|
1797
|
+
*/
|
|
1798
|
+
url: string;
|
|
1799
|
+
/**
|
|
1800
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1801
|
+
*/
|
|
1802
|
+
params?: {
|
|
1803
|
+
[name: string]: string;
|
|
1804
|
+
};
|
|
1805
|
+
/**
|
|
1806
|
+
* Headers to use. Supports variable interpolation.
|
|
1807
|
+
*/
|
|
1808
|
+
headers?: {
|
|
1809
|
+
[name: string]: string;
|
|
1810
|
+
};
|
|
1811
|
+
/**
|
|
1812
|
+
* Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.
|
|
1813
|
+
*/
|
|
1814
|
+
body?: {
|
|
1815
|
+
[name: string]: any;
|
|
1816
|
+
};
|
|
1817
|
+
};
|
|
1818
|
+
resolved?: {
|
|
1819
|
+
/**
|
|
1820
|
+
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
1821
|
+
*/
|
|
1822
|
+
dataPath?: string;
|
|
1823
|
+
};
|
|
1824
|
+
/**
|
|
1825
|
+
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
1826
|
+
*/
|
|
1827
|
+
use_static_ips?: boolean;
|
|
1828
|
+
}
|
|
1829
|
+
/**
|
|
1830
|
+
* Hook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
|
|
1831
|
+
* - 200 with contact id if exactly one contact is found
|
|
1832
|
+
* - 404 if no contact is found or more than contact is found
|
|
1833
|
+
*
|
|
1834
|
+
*/
|
|
1835
|
+
export interface PortalExtensionHookRegistrationIdentifiersCheck {
|
|
1836
|
+
/**
|
|
1837
|
+
* Identifier of the hook. Should not change between updates.
|
|
1838
|
+
*/
|
|
1839
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1840
|
+
name?: TranslatedString;
|
|
1841
|
+
type: "registrationIdentifiersCheck";
|
|
1842
|
+
auth?: PortalExtensionAuthBlock;
|
|
1843
|
+
call: {
|
|
1844
|
+
/**
|
|
1845
|
+
* HTTP method to use for the call
|
|
1846
|
+
*/
|
|
1847
|
+
method?: string;
|
|
1848
|
+
/**
|
|
1849
|
+
* URL to call. Supports variable interpolation.
|
|
1850
|
+
*/
|
|
1851
|
+
url: string;
|
|
1852
|
+
/**
|
|
1853
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1854
|
+
*/
|
|
1855
|
+
params?: {
|
|
1856
|
+
[name: string]: string;
|
|
1857
|
+
};
|
|
1858
|
+
/**
|
|
1859
|
+
* Headers to use. Supports variable interpolation.
|
|
1860
|
+
*/
|
|
1861
|
+
headers: {
|
|
1862
|
+
[name: string]: string;
|
|
1863
|
+
};
|
|
1864
|
+
/**
|
|
1865
|
+
* Optional JSON body to use for the call. Defaults to object with all configured identifiers grouped by entity, e.g. `{"contract": {"contract_name": "Name"}}`. Supports variable interpolation.
|
|
1866
|
+
*/
|
|
1867
|
+
body?: {
|
|
1868
|
+
[key: string]: any;
|
|
1869
|
+
};
|
|
1870
|
+
/**
|
|
1871
|
+
* Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation.
|
|
1872
|
+
*/
|
|
1873
|
+
result: string;
|
|
1874
|
+
};
|
|
1875
|
+
/**
|
|
1876
|
+
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
1877
|
+
*/
|
|
1878
|
+
use_static_ips?: boolean;
|
|
1879
|
+
}
|
|
1880
|
+
export interface PortalExtensionSeamlessLink {
|
|
1881
|
+
/**
|
|
1882
|
+
* Identifier of the link. Should not change between updates.
|
|
1883
|
+
*/
|
|
1884
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1885
|
+
name: TranslatedString;
|
|
1886
|
+
description?: TranslatedString;
|
|
1887
|
+
type: "seamless";
|
|
1888
|
+
/**
|
|
1889
|
+
* Controls whether the link should be shown. Supports variable interpolation.
|
|
1890
|
+
* example:
|
|
1891
|
+
* {{Contact.customer_number | is_not_empty}}
|
|
1892
|
+
*/
|
|
1893
|
+
condition?: string;
|
|
1894
|
+
auth?: PortalExtensionAuthBlock;
|
|
1895
|
+
redirect: {
|
|
1896
|
+
/**
|
|
1897
|
+
* URL to redirect to. Supports variable interpolation.
|
|
1898
|
+
*/
|
|
1899
|
+
url?: string;
|
|
1900
|
+
/**
|
|
1901
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1902
|
+
*/
|
|
1903
|
+
params?: {
|
|
1904
|
+
[name: string]: string;
|
|
1905
|
+
};
|
|
1906
|
+
};
|
|
1907
|
+
}
|
|
1908
|
+
export interface Pricing {
|
|
1909
|
+
pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
|
|
1910
|
+
billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
|
|
1911
|
+
}
|
|
1912
|
+
/**
|
|
1913
|
+
* Public configuration of the published app
|
|
1914
|
+
*/
|
|
1915
|
+
export interface PublicConfiguration {
|
|
1916
|
+
/**
|
|
1917
|
+
* ID of the app configuration
|
|
1918
|
+
*/
|
|
1919
|
+
app_id: string;
|
|
1920
|
+
/**
|
|
1921
|
+
* Email address for support requests
|
|
1922
|
+
*/
|
|
1923
|
+
support_email?: string;
|
|
1924
|
+
/**
|
|
1925
|
+
* Organization ID of the app owner
|
|
1926
|
+
*/
|
|
1927
|
+
owner_org_id: string;
|
|
1928
|
+
/**
|
|
1929
|
+
* Name of the app
|
|
1930
|
+
*/
|
|
1931
|
+
name: string;
|
|
1932
|
+
author?: Author;
|
|
1933
|
+
/**
|
|
1934
|
+
* Flag to indicate if the app is in dev mode.
|
|
1935
|
+
*/
|
|
1936
|
+
dev_mode?: boolean;
|
|
1937
|
+
/**
|
|
1938
|
+
* Category of the app.
|
|
1939
|
+
*/
|
|
1940
|
+
category?: string;
|
|
1941
|
+
/**
|
|
1942
|
+
* URL of the app icon.
|
|
1943
|
+
*/
|
|
1944
|
+
icon_url?: string;
|
|
1945
|
+
/**
|
|
1946
|
+
* URL of the app documentation.
|
|
1947
|
+
*/
|
|
1948
|
+
documentation_url?: string;
|
|
1949
|
+
/**
|
|
1950
|
+
* Markdown description of the app.
|
|
1951
|
+
*/
|
|
1952
|
+
description?: {
|
|
1953
|
+
/**
|
|
1954
|
+
* English translation
|
|
1955
|
+
*/
|
|
1956
|
+
en?: string | null;
|
|
1957
|
+
/**
|
|
1958
|
+
* German translation
|
|
1959
|
+
*/
|
|
1960
|
+
de: string;
|
|
1961
|
+
};
|
|
1962
|
+
/**
|
|
1963
|
+
* Pricing information for the app
|
|
1964
|
+
*/
|
|
1965
|
+
pricing?: {
|
|
1966
|
+
pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
|
|
1967
|
+
billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
|
|
1968
|
+
};
|
|
1969
|
+
components: BaseComponent[];
|
|
1970
|
+
/**
|
|
1971
|
+
* Flag to indicate if the app is in beta.
|
|
1972
|
+
*/
|
|
1973
|
+
is_beta?: boolean;
|
|
1974
|
+
/**
|
|
1975
|
+
* Timestamp when the app version is deprecated
|
|
1976
|
+
*/
|
|
1977
|
+
deprecated_at?: string;
|
|
1978
|
+
/**
|
|
1979
|
+
* Version of the app that is installed
|
|
1980
|
+
*/
|
|
1981
|
+
version: string;
|
|
1982
|
+
role?: Role;
|
|
1983
|
+
blueprint_ref?: BlueprintRef;
|
|
1984
|
+
/**
|
|
1985
|
+
* Latest version of the app
|
|
1986
|
+
*/
|
|
1987
|
+
latest_version?: string;
|
|
1988
|
+
/**
|
|
1989
|
+
* Flag to indicate if the app is public.
|
|
1990
|
+
*/
|
|
1991
|
+
public?: boolean;
|
|
1992
|
+
/**
|
|
1993
|
+
* List of available versions of the app
|
|
1994
|
+
*/
|
|
1995
|
+
versions?: /* Configuration data about your app which is versionable */ ConfigurationVersion[];
|
|
1996
|
+
}
|
|
1997
|
+
export interface RawEvents {
|
|
1998
|
+
type?: "raw";
|
|
1999
|
+
events?: AppEventData[];
|
|
2000
|
+
}
|
|
2001
|
+
export interface Review {
|
|
2002
|
+
/**
|
|
2003
|
+
* Version of the app that is under review
|
|
2004
|
+
*/
|
|
2005
|
+
version?: string;
|
|
2006
|
+
/**
|
|
2007
|
+
* Status of the review
|
|
2008
|
+
*/
|
|
2009
|
+
review_status?: "approved" | "rejected" | "pending";
|
|
2010
|
+
/**
|
|
2011
|
+
* Timestamp of the review
|
|
2012
|
+
*/
|
|
2013
|
+
requested_at?: string;
|
|
2014
|
+
/**
|
|
2015
|
+
* User ID of the reviewer
|
|
2016
|
+
*/
|
|
2017
|
+
requested_by?: string;
|
|
2018
|
+
/**
|
|
2019
|
+
* Email of the technical contact
|
|
2020
|
+
*/
|
|
2021
|
+
technical_contact?: string;
|
|
2022
|
+
/**
|
|
2023
|
+
* Email of the marketing contact
|
|
2024
|
+
*/
|
|
2025
|
+
marketing_contact?: string;
|
|
2026
|
+
/**
|
|
2027
|
+
* URL of the demo
|
|
2028
|
+
*/
|
|
2029
|
+
demo_url?: string;
|
|
2030
|
+
}
|
|
2031
|
+
export interface Role {
|
|
2032
|
+
/**
|
|
2033
|
+
* Name of the role
|
|
2034
|
+
*/
|
|
2035
|
+
id?: string;
|
|
2036
|
+
grants?: /* Required grants for the app in order to call APIs for the installing tenant */ Grants;
|
|
2037
|
+
}
|
|
2038
|
+
export interface S3Reference {
|
|
2039
|
+
/**
|
|
2040
|
+
* The name of the S3 bucket where the JSON file for import is stored.
|
|
2041
|
+
* example:
|
|
2042
|
+
* my-bucket
|
|
2043
|
+
*/
|
|
2044
|
+
bucket: string;
|
|
2045
|
+
/**
|
|
2046
|
+
* The key or path to the JSON file within the S3 bucket.
|
|
2047
|
+
* example:
|
|
2048
|
+
* manifest.json
|
|
2049
|
+
*/
|
|
2050
|
+
key: string;
|
|
2051
|
+
}
|
|
2052
|
+
export interface SandboxCustomActionConfig {
|
|
2053
|
+
/**
|
|
2054
|
+
* Name of the custom action
|
|
2055
|
+
*/
|
|
2056
|
+
name?: string;
|
|
2057
|
+
/**
|
|
2058
|
+
* Description of the custom action
|
|
2059
|
+
*/
|
|
2060
|
+
description?: string;
|
|
2061
|
+
/**
|
|
2062
|
+
* Wait for callback_url to be called before completing the action
|
|
2063
|
+
*/
|
|
2064
|
+
wait_for_callback?: boolean;
|
|
2065
|
+
type: "sandbox";
|
|
2066
|
+
sandbox_settings?: {
|
|
2067
|
+
/**
|
|
2068
|
+
* JavaScript code to execute for the sandbox action. Maximum size: 300KB (hard limit). Code is stored as raw JavaScript and will be syntax-validated on save. Security restrictions: eval() and Function() constructor are not allowed.
|
|
2069
|
+
*
|
|
2070
|
+
*/
|
|
2071
|
+
code?: string;
|
|
2072
|
+
};
|
|
2073
|
+
}
|
|
2074
|
+
export interface TextArg {
|
|
2075
|
+
type?: "text";
|
|
2076
|
+
}
|
|
2077
|
+
export interface TranslatedString {
|
|
2078
|
+
/**
|
|
2079
|
+
* English translation
|
|
2080
|
+
*/
|
|
2081
|
+
en?: string | null;
|
|
2082
|
+
/**
|
|
2083
|
+
* German translation
|
|
2084
|
+
*/
|
|
2085
|
+
de: string;
|
|
2086
|
+
}
|
|
2087
|
+
}
|
|
2088
|
+
}
|
|
2089
|
+
declare namespace Paths {
|
|
2090
|
+
namespace CloneVersion {
|
|
2091
|
+
namespace Parameters {
|
|
2092
|
+
export type AppId = string;
|
|
2093
|
+
export type SourceVersion = string;
|
|
2094
|
+
export type TargetVersion = string;
|
|
2095
|
+
}
|
|
2096
|
+
export interface PathParameters {
|
|
2097
|
+
appId: Parameters.AppId;
|
|
2098
|
+
sourceVersion: Parameters.SourceVersion;
|
|
2099
|
+
targetVersion: Parameters.TargetVersion;
|
|
2100
|
+
}
|
|
2101
|
+
namespace Responses {
|
|
2102
|
+
export interface $201 {
|
|
2103
|
+
app_id?: string;
|
|
2104
|
+
version?: string;
|
|
2105
|
+
status?: "pending" | "published";
|
|
2106
|
+
}
|
|
2107
|
+
export interface $400 {
|
|
2108
|
+
}
|
|
2109
|
+
export interface $404 {
|
|
2110
|
+
}
|
|
2111
|
+
}
|
|
2112
|
+
}
|
|
2113
|
+
namespace CreateBundleUploadUrl {
|
|
2114
|
+
namespace Parameters {
|
|
2115
|
+
export type AppId = string;
|
|
2116
|
+
}
|
|
2117
|
+
export interface PathParameters {
|
|
2118
|
+
appId: Parameters.AppId;
|
|
2119
|
+
}
|
|
2120
|
+
export type RequestBody = Components.RequestBodies.CreateBundlePresignedRequest;
|
|
2121
|
+
namespace Responses {
|
|
2122
|
+
export interface $200 {
|
|
2123
|
+
/**
|
|
2124
|
+
* ID of the journye block component
|
|
2125
|
+
*/
|
|
2126
|
+
component_id?: string;
|
|
2127
|
+
/**
|
|
2128
|
+
* URL of the web component object
|
|
2129
|
+
*/
|
|
2130
|
+
component_url?: string;
|
|
2131
|
+
/**
|
|
2132
|
+
* Presigned S3 URL for uploading the bundle
|
|
2133
|
+
*/
|
|
2134
|
+
upload_url: string;
|
|
2135
|
+
s3ref?: Components.Schemas.S3Reference;
|
|
2136
|
+
/**
|
|
2137
|
+
* Timestamp when the upload URL expires
|
|
2138
|
+
*/
|
|
2139
|
+
expires_at?: string; // date-time
|
|
2140
|
+
}
|
|
2141
|
+
export interface $404 {
|
|
2142
|
+
}
|
|
2143
|
+
}
|
|
2144
|
+
}
|
|
2145
|
+
namespace CreateComponent {
|
|
2146
|
+
namespace Parameters {
|
|
2147
|
+
export type AppId = string;
|
|
2148
|
+
export type Version = string;
|
|
2149
|
+
}
|
|
2150
|
+
export interface PathParameters {
|
|
2151
|
+
appId: Parameters.AppId;
|
|
2152
|
+
version: Parameters.Version;
|
|
2153
|
+
}
|
|
2154
|
+
export type RequestBody = Components.RequestBodies.UpsertComponentRequest;
|
|
2155
|
+
namespace Responses {
|
|
2156
|
+
export interface $200 {
|
|
2157
|
+
component?: Components.Schemas.BaseComponent;
|
|
2158
|
+
}
|
|
2159
|
+
export interface $400 {
|
|
2160
|
+
}
|
|
2161
|
+
export interface $404 {
|
|
2162
|
+
}
|
|
2163
|
+
}
|
|
2164
|
+
}
|
|
2165
|
+
namespace CreateConfiguration {
|
|
2166
|
+
export type RequestBody = Components.RequestBodies.CreateConfigRequest;
|
|
2167
|
+
namespace Responses {
|
|
2168
|
+
export interface $201 {
|
|
2169
|
+
app_id: string;
|
|
2170
|
+
}
|
|
2171
|
+
}
|
|
2172
|
+
}
|
|
2173
|
+
namespace CreateLogoUploadUrl {
|
|
2174
|
+
export type RequestBody = Components.RequestBodies.CreateLogoPresignedRequest;
|
|
2175
|
+
namespace Responses {
|
|
2176
|
+
export interface $200 {
|
|
2177
|
+
/**
|
|
2178
|
+
* Presigned S3 URL for uploading the logo
|
|
2179
|
+
*/
|
|
2180
|
+
upload_url: string;
|
|
2181
|
+
s3ref?: Components.Schemas.S3Reference;
|
|
2182
|
+
/**
|
|
2183
|
+
* Timestamp when the upload URL expires
|
|
2184
|
+
*/
|
|
2185
|
+
expires_at?: string; // date-time
|
|
2186
|
+
}
|
|
2187
|
+
export interface $404 {
|
|
2188
|
+
}
|
|
2189
|
+
}
|
|
2190
|
+
}
|
|
2191
|
+
namespace CreateReview {
|
|
2192
|
+
namespace Parameters {
|
|
2193
|
+
export type AppId = string;
|
|
2194
|
+
export type Version = string;
|
|
2195
|
+
}
|
|
2196
|
+
export interface PathParameters {
|
|
2197
|
+
appId: Parameters.AppId;
|
|
2198
|
+
version: Parameters.Version;
|
|
2199
|
+
}
|
|
2200
|
+
export type RequestBody = Components.RequestBodies.CreateReviewRequest;
|
|
2201
|
+
namespace Responses {
|
|
2202
|
+
export interface $200 {
|
|
2203
|
+
review?: Components.Schemas.Review;
|
|
2204
|
+
}
|
|
2205
|
+
export interface $400 {
|
|
2206
|
+
}
|
|
2207
|
+
export interface $404 {
|
|
2208
|
+
}
|
|
2209
|
+
}
|
|
2210
|
+
}
|
|
2211
|
+
namespace CreateZipUploadUrl {
|
|
2212
|
+
namespace Parameters {
|
|
2213
|
+
export type AppId = string;
|
|
2214
|
+
}
|
|
2215
|
+
export interface PathParameters {
|
|
2216
|
+
appId: Parameters.AppId;
|
|
2217
|
+
}
|
|
2218
|
+
export interface RequestBody {
|
|
2219
|
+
/**
|
|
2220
|
+
* Version of the app configuration
|
|
2221
|
+
* example:
|
|
2222
|
+
* 1.0.0
|
|
2223
|
+
*/
|
|
2224
|
+
version?: string;
|
|
2225
|
+
/**
|
|
2226
|
+
* ID of the journey block component
|
|
2227
|
+
*/
|
|
2228
|
+
component_id?: string;
|
|
2229
|
+
/**
|
|
2230
|
+
* example:
|
|
2231
|
+
* dist.zip
|
|
2232
|
+
*/
|
|
2233
|
+
filename?: string;
|
|
2234
|
+
}
|
|
2235
|
+
namespace Responses {
|
|
2236
|
+
export interface $200 {
|
|
2237
|
+
/**
|
|
2238
|
+
* ID of the journye block component
|
|
2239
|
+
*/
|
|
2240
|
+
component_id?: string;
|
|
2241
|
+
/**
|
|
2242
|
+
* Presigned S3 URL for uploading the bundle
|
|
2243
|
+
*/
|
|
2244
|
+
upload_url: string;
|
|
2245
|
+
/**
|
|
2246
|
+
* Public CDN URL for the unpacked artifacts
|
|
2247
|
+
*/
|
|
2248
|
+
artifact_url: string;
|
|
2249
|
+
s3ref?: Components.Schemas.S3Reference;
|
|
2250
|
+
/**
|
|
2251
|
+
* Timestamp when the upload URL expires
|
|
2252
|
+
*/
|
|
2253
|
+
expires_at?: string; // date-time
|
|
2254
|
+
}
|
|
2255
|
+
export interface $404 {
|
|
2256
|
+
}
|
|
2257
|
+
}
|
|
2258
|
+
}
|
|
2259
|
+
namespace DeleteComponent {
|
|
2260
|
+
namespace Parameters {
|
|
2261
|
+
export type AppId = string;
|
|
2262
|
+
export type ComponentId = string;
|
|
2263
|
+
export type Version = string;
|
|
2264
|
+
}
|
|
2265
|
+
export interface PathParameters {
|
|
2266
|
+
appId: Parameters.AppId;
|
|
2267
|
+
version: Parameters.Version;
|
|
2268
|
+
componentId: Parameters.ComponentId;
|
|
2269
|
+
}
|
|
2270
|
+
namespace Responses {
|
|
2271
|
+
export interface $204 {
|
|
2272
|
+
}
|
|
2273
|
+
export interface $404 {
|
|
2274
|
+
}
|
|
2275
|
+
}
|
|
2276
|
+
}
|
|
2277
|
+
namespace DeleteConfiguration {
|
|
2278
|
+
namespace Responses {
|
|
2279
|
+
export interface $204 {
|
|
2280
|
+
}
|
|
2281
|
+
export interface $404 {
|
|
2282
|
+
}
|
|
2283
|
+
}
|
|
2284
|
+
}
|
|
2285
|
+
namespace DeleteLogo {
|
|
2286
|
+
namespace Responses {
|
|
2287
|
+
export interface $204 {
|
|
2288
|
+
}
|
|
2289
|
+
export interface $404 {
|
|
2290
|
+
}
|
|
2291
|
+
}
|
|
2292
|
+
}
|
|
2293
|
+
namespace DeleteVersion {
|
|
2294
|
+
namespace Parameters {
|
|
2295
|
+
export type AppId = string;
|
|
2296
|
+
export type Version = string;
|
|
2297
|
+
}
|
|
2298
|
+
export interface PathParameters {
|
|
2299
|
+
appId: Parameters.AppId;
|
|
2300
|
+
version: Parameters.Version;
|
|
2301
|
+
}
|
|
2302
|
+
namespace Responses {
|
|
2303
|
+
export interface $204 {
|
|
2304
|
+
}
|
|
2305
|
+
export interface $400 {
|
|
2306
|
+
}
|
|
2307
|
+
export interface $404 {
|
|
2308
|
+
}
|
|
2309
|
+
export interface $409 {
|
|
2310
|
+
}
|
|
2311
|
+
}
|
|
2312
|
+
}
|
|
2313
|
+
namespace GetConfiguration {
|
|
2314
|
+
namespace Parameters {
|
|
2315
|
+
export type Version = string;
|
|
2316
|
+
}
|
|
2317
|
+
export interface QueryParameters {
|
|
2318
|
+
version?: Parameters.Version;
|
|
2319
|
+
}
|
|
2320
|
+
namespace Responses {
|
|
2321
|
+
export type $200 = /* Configuration of the published app */ Components.Schemas.Configuration;
|
|
2322
|
+
export interface $404 {
|
|
2323
|
+
}
|
|
2324
|
+
}
|
|
2325
|
+
}
|
|
2326
|
+
namespace GetInstallation {
|
|
2327
|
+
namespace Parameters {
|
|
2328
|
+
export type AppId = string;
|
|
2329
|
+
}
|
|
2330
|
+
export interface PathParameters {
|
|
2331
|
+
appId: Parameters.AppId;
|
|
2332
|
+
}
|
|
2333
|
+
namespace Responses {
|
|
2334
|
+
export type $200 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
|
|
2335
|
+
export interface $404 {
|
|
2336
|
+
}
|
|
2337
|
+
}
|
|
2338
|
+
}
|
|
2339
|
+
namespace GetPublicConfiguration {
|
|
2340
|
+
namespace Parameters {
|
|
2341
|
+
export type Version = string;
|
|
2342
|
+
}
|
|
2343
|
+
export interface QueryParameters {
|
|
2344
|
+
version?: Parameters.Version;
|
|
2345
|
+
}
|
|
2346
|
+
namespace Responses {
|
|
2347
|
+
export type $200 = /* Public configuration of the published app */ Components.Schemas.PublicConfiguration;
|
|
2348
|
+
export interface $404 {
|
|
2349
|
+
}
|
|
2350
|
+
}
|
|
2351
|
+
}
|
|
2352
|
+
namespace GetPublicFacingComponent {
|
|
2353
|
+
namespace Responses {
|
|
2354
|
+
export interface $200 {
|
|
2355
|
+
component?: Components.Schemas.BaseComponent;
|
|
2356
|
+
}
|
|
2357
|
+
export interface $404 {
|
|
2358
|
+
}
|
|
2359
|
+
}
|
|
2360
|
+
}
|
|
2361
|
+
namespace GetReview {
|
|
2362
|
+
namespace Parameters {
|
|
2363
|
+
export type AppId = string;
|
|
2364
|
+
export type Version = string;
|
|
2365
|
+
}
|
|
2366
|
+
export interface PathParameters {
|
|
2367
|
+
appId: Parameters.AppId;
|
|
2368
|
+
version: Parameters.Version;
|
|
2369
|
+
}
|
|
2370
|
+
namespace Responses {
|
|
2371
|
+
export interface $200 {
|
|
2372
|
+
review?: Components.Schemas.Review;
|
|
2373
|
+
}
|
|
2374
|
+
export interface $404 {
|
|
2375
|
+
}
|
|
2376
|
+
}
|
|
2377
|
+
}
|
|
2378
|
+
namespace GetVersion {
|
|
2379
|
+
namespace Parameters {
|
|
2380
|
+
export type AppId = string;
|
|
2381
|
+
export type Version = string;
|
|
2382
|
+
}
|
|
2383
|
+
export interface PathParameters {
|
|
2384
|
+
appId: Parameters.AppId;
|
|
2385
|
+
version: Parameters.Version;
|
|
2386
|
+
}
|
|
2387
|
+
namespace Responses {
|
|
2388
|
+
export type $200 = /* Configuration of the published app */ Components.Schemas.Configuration;
|
|
2389
|
+
export interface $404 {
|
|
2390
|
+
}
|
|
2391
|
+
}
|
|
2392
|
+
}
|
|
2393
|
+
namespace IngestEvent {
|
|
2394
|
+
export type RequestBody = Components.Schemas.AppEventData | Components.Schemas.BatchEventRequest;
|
|
2395
|
+
namespace Responses {
|
|
2396
|
+
export interface $202 {
|
|
2397
|
+
}
|
|
2398
|
+
export interface $400 {
|
|
2399
|
+
}
|
|
2400
|
+
}
|
|
2401
|
+
}
|
|
2402
|
+
namespace Install {
|
|
2403
|
+
namespace Parameters {
|
|
2404
|
+
export type AppId = string;
|
|
2405
|
+
}
|
|
2406
|
+
export interface PathParameters {
|
|
2407
|
+
appId: Parameters.AppId;
|
|
2408
|
+
}
|
|
2409
|
+
export type RequestBody = Components.RequestBodies.InstallRequest;
|
|
2410
|
+
namespace Responses {
|
|
2411
|
+
export type $201 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
|
|
2412
|
+
export interface $404 {
|
|
2413
|
+
}
|
|
2414
|
+
}
|
|
2415
|
+
}
|
|
2416
|
+
namespace ListConfigurations {
|
|
2417
|
+
namespace Parameters {
|
|
2418
|
+
export type Page = number;
|
|
2419
|
+
export type PageSize = number;
|
|
2420
|
+
}
|
|
2421
|
+
export interface QueryParameters {
|
|
2422
|
+
page?: Parameters.Page;
|
|
2423
|
+
pageSize?: Parameters.PageSize;
|
|
2424
|
+
}
|
|
2425
|
+
namespace Responses {
|
|
2426
|
+
export interface $200 {
|
|
2427
|
+
configurations?: /* Basic metadata about your app configuration which does not get versioned */ Components.Schemas.ConfigurationMetadata[];
|
|
2428
|
+
pagination?: {
|
|
2429
|
+
total?: number;
|
|
2430
|
+
page?: number;
|
|
2431
|
+
pageSize?: number;
|
|
2432
|
+
};
|
|
2433
|
+
}
|
|
2434
|
+
}
|
|
2435
|
+
}
|
|
2436
|
+
namespace ListInstallations {
|
|
2437
|
+
namespace Parameters {
|
|
2438
|
+
export type ComponentType = /* Type of app component */ Components.Schemas.ComponentType;
|
|
2439
|
+
export type Enabled = boolean;
|
|
2440
|
+
export type Page = number;
|
|
2441
|
+
export type PageSize = number;
|
|
2442
|
+
}
|
|
2443
|
+
export interface QueryParameters {
|
|
2444
|
+
componentType?: Parameters.ComponentType;
|
|
2445
|
+
enabled?: Parameters.Enabled;
|
|
2446
|
+
page?: Parameters.Page;
|
|
2447
|
+
pageSize?: Parameters.PageSize;
|
|
2448
|
+
}
|
|
2449
|
+
namespace Responses {
|
|
2450
|
+
export interface $200 {
|
|
2451
|
+
apps?: /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation[];
|
|
2452
|
+
pagination?: {
|
|
2453
|
+
total?: number;
|
|
2454
|
+
page?: number;
|
|
2455
|
+
pageSize?: number;
|
|
2456
|
+
};
|
|
2457
|
+
}
|
|
2458
|
+
}
|
|
2459
|
+
}
|
|
2460
|
+
namespace ListPublicConfigurations {
|
|
2461
|
+
namespace Parameters {
|
|
2462
|
+
export type Page = number;
|
|
2463
|
+
export type PageSize = number;
|
|
2464
|
+
}
|
|
2465
|
+
export interface QueryParameters {
|
|
2466
|
+
page?: Parameters.Page;
|
|
2467
|
+
pageSize?: Parameters.PageSize;
|
|
2468
|
+
}
|
|
2469
|
+
namespace Responses {
|
|
2470
|
+
export interface $200 {
|
|
2471
|
+
configurations?: /* Basic metadata about your app configuration which does not get versioned */ Components.Schemas.ConfigurationMetadata[];
|
|
2472
|
+
pagination?: {
|
|
2473
|
+
total?: number;
|
|
2474
|
+
page?: number;
|
|
2475
|
+
pageSize?: number;
|
|
2476
|
+
};
|
|
2477
|
+
}
|
|
2478
|
+
}
|
|
2479
|
+
}
|
|
2480
|
+
namespace ListVersions {
|
|
2481
|
+
namespace Parameters {
|
|
2482
|
+
export type AppId = string;
|
|
2483
|
+
export type Page = number;
|
|
2484
|
+
export type PageSize = number;
|
|
2485
|
+
}
|
|
2486
|
+
export interface PathParameters {
|
|
2487
|
+
appId: Parameters.AppId;
|
|
2488
|
+
}
|
|
2489
|
+
export interface QueryParameters {
|
|
2490
|
+
page?: Parameters.Page;
|
|
2491
|
+
pageSize?: Parameters.PageSize;
|
|
2492
|
+
}
|
|
2493
|
+
namespace Responses {
|
|
2494
|
+
export interface $200 {
|
|
2495
|
+
versions?: /* Configuration data about your app which is versionable */ Components.Schemas.ConfigurationVersion[];
|
|
2496
|
+
pagination?: {
|
|
2497
|
+
total?: number;
|
|
2498
|
+
page?: number;
|
|
2499
|
+
pageSize?: number;
|
|
2500
|
+
};
|
|
2501
|
+
}
|
|
2502
|
+
export interface $400 {
|
|
2503
|
+
}
|
|
2504
|
+
}
|
|
2505
|
+
}
|
|
2506
|
+
namespace PatchComponent {
|
|
2507
|
+
namespace Parameters {
|
|
2508
|
+
export type AppId = string;
|
|
2509
|
+
export type ComponentId = string;
|
|
2510
|
+
export type Version = string;
|
|
2511
|
+
}
|
|
2512
|
+
export interface PathParameters {
|
|
2513
|
+
appId: Parameters.AppId;
|
|
2514
|
+
version: Parameters.Version;
|
|
2515
|
+
componentId: Parameters.ComponentId;
|
|
2516
|
+
}
|
|
2517
|
+
export type RequestBody = Components.RequestBodies.UpsertComponentRequest;
|
|
2518
|
+
namespace Responses {
|
|
2519
|
+
export interface $204 {
|
|
2520
|
+
}
|
|
2521
|
+
export interface $400 {
|
|
2522
|
+
}
|
|
2523
|
+
export interface $404 {
|
|
2524
|
+
}
|
|
2525
|
+
}
|
|
2526
|
+
}
|
|
2527
|
+
namespace PatchInstallation {
|
|
2528
|
+
namespace Parameters {
|
|
2529
|
+
export type AppId = string;
|
|
2530
|
+
}
|
|
2531
|
+
export interface PathParameters {
|
|
2532
|
+
appId: Parameters.AppId;
|
|
2533
|
+
}
|
|
2534
|
+
export type RequestBody = Components.RequestBodies.InstallRequest;
|
|
2535
|
+
namespace Responses {
|
|
2536
|
+
export interface $204 {
|
|
2537
|
+
}
|
|
2538
|
+
export interface $404 {
|
|
2539
|
+
}
|
|
2540
|
+
}
|
|
2541
|
+
}
|
|
2542
|
+
namespace PatchMetadata {
|
|
2543
|
+
export type RequestBody = Components.RequestBodies.PatchConfigMetadataRequest;
|
|
2544
|
+
namespace Responses {
|
|
2545
|
+
export interface $204 {
|
|
2546
|
+
}
|
|
2547
|
+
export interface $404 {
|
|
2548
|
+
}
|
|
2549
|
+
}
|
|
2550
|
+
}
|
|
2551
|
+
namespace PatchVersion {
|
|
2552
|
+
namespace Parameters {
|
|
2553
|
+
export type AppId = string;
|
|
2554
|
+
export type Version = string;
|
|
2555
|
+
}
|
|
2556
|
+
export interface PathParameters {
|
|
2557
|
+
appId: Parameters.AppId;
|
|
2558
|
+
version: Parameters.Version;
|
|
2559
|
+
}
|
|
2560
|
+
export type RequestBody = Components.RequestBodies.PatchVersionRequest;
|
|
2561
|
+
namespace Responses {
|
|
2562
|
+
export interface $204 {
|
|
2563
|
+
}
|
|
2564
|
+
export interface $400 {
|
|
2565
|
+
}
|
|
2566
|
+
export interface $404 {
|
|
2567
|
+
}
|
|
2568
|
+
}
|
|
2569
|
+
}
|
|
2570
|
+
namespace PromoteVersion {
|
|
2571
|
+
namespace Parameters {
|
|
2572
|
+
export type AppId = string;
|
|
2573
|
+
export type Version = string;
|
|
2574
|
+
}
|
|
2575
|
+
export interface PathParameters {
|
|
2576
|
+
appId: Parameters.AppId;
|
|
2577
|
+
version: Parameters.Version;
|
|
2578
|
+
}
|
|
2579
|
+
namespace Responses {
|
|
2580
|
+
export type $200 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
|
|
2581
|
+
export interface $400 {
|
|
2582
|
+
}
|
|
2583
|
+
export interface $404 {
|
|
2584
|
+
}
|
|
2585
|
+
}
|
|
2586
|
+
}
|
|
2587
|
+
namespace QueryEvents {
|
|
2588
|
+
namespace Parameters {
|
|
2589
|
+
export type AppId = string;
|
|
2590
|
+
}
|
|
2591
|
+
export interface PathParameters {
|
|
2592
|
+
appId: Parameters.AppId;
|
|
2593
|
+
}
|
|
2594
|
+
export type RequestBody = Components.Schemas.EventsQuery;
|
|
2595
|
+
namespace Responses {
|
|
2596
|
+
export type $200 = Components.Schemas.EventsQueryResponse;
|
|
2597
|
+
export interface $400 {
|
|
2598
|
+
}
|
|
2599
|
+
export interface $404 {
|
|
2600
|
+
}
|
|
2601
|
+
}
|
|
2602
|
+
}
|
|
2603
|
+
namespace Uninstall {
|
|
2604
|
+
namespace Parameters {
|
|
2605
|
+
export type AppId = string;
|
|
2606
|
+
}
|
|
2607
|
+
export interface PathParameters {
|
|
2608
|
+
appId: Parameters.AppId;
|
|
2609
|
+
}
|
|
2610
|
+
namespace Responses {
|
|
2611
|
+
export interface $204 {
|
|
2612
|
+
}
|
|
2613
|
+
export interface $404 {
|
|
2614
|
+
}
|
|
2615
|
+
}
|
|
2616
|
+
}
|
|
2617
|
+
namespace V1AppConfigurations$AppId {
|
|
2618
|
+
namespace Parameters {
|
|
2619
|
+
export type AppId = string;
|
|
2620
|
+
}
|
|
2621
|
+
export interface PathParameters {
|
|
2622
|
+
appId: Parameters.AppId;
|
|
2623
|
+
}
|
|
2624
|
+
}
|
|
2625
|
+
namespace V1AppConfigurations$AppIdLogo {
|
|
2626
|
+
namespace Parameters {
|
|
2627
|
+
export type AppId = string;
|
|
2628
|
+
}
|
|
2629
|
+
export interface PathParameters {
|
|
2630
|
+
appId: Parameters.AppId;
|
|
2631
|
+
}
|
|
2632
|
+
}
|
|
2633
|
+
namespace V1AppConfigurationsPublic$AppId {
|
|
2634
|
+
namespace Parameters {
|
|
2635
|
+
export type AppId = string;
|
|
2636
|
+
}
|
|
2637
|
+
export interface PathParameters {
|
|
2638
|
+
appId: Parameters.AppId;
|
|
2639
|
+
}
|
|
2640
|
+
}
|
|
2641
|
+
namespace V1PublicApp$AppIdComponents$ComponentId {
|
|
2642
|
+
namespace Parameters {
|
|
2643
|
+
export type AppId = string;
|
|
2644
|
+
export type ComponentId = string;
|
|
2645
|
+
}
|
|
2646
|
+
export interface PathParameters {
|
|
2647
|
+
appId: Parameters.AppId;
|
|
2648
|
+
componentId: Parameters.ComponentId;
|
|
2649
|
+
}
|
|
2650
|
+
}
|
|
2651
|
+
}
|
|
2652
|
+
|
|
2653
|
+
|
|
2654
|
+
interface OperationMethods {
|
|
2655
|
+
/**
|
|
2656
|
+
* getPublicFacingComponent - getPublicFacingComponent
|
|
2657
|
+
*
|
|
2658
|
+
* Retrieve public facing components for an installed app
|
|
2659
|
+
*/
|
|
2660
|
+
'getPublicFacingComponent'(
|
|
2661
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdComponents$ComponentId.PathParameters> | null,
|
|
2662
|
+
data?: any,
|
|
2663
|
+
config?: AxiosRequestConfig
|
|
2664
|
+
): OperationResponse<Paths.GetPublicFacingComponent.Responses.$200>
|
|
2665
|
+
/**
|
|
2666
|
+
* listConfigurations - listConfigurations
|
|
2667
|
+
*
|
|
2668
|
+
* List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.
|
|
2669
|
+
*/
|
|
2670
|
+
'listConfigurations'(
|
|
2671
|
+
parameters?: Parameters<Paths.ListConfigurations.QueryParameters> | null,
|
|
2672
|
+
data?: any,
|
|
2673
|
+
config?: AxiosRequestConfig
|
|
2674
|
+
): OperationResponse<Paths.ListConfigurations.Responses.$200>
|
|
2675
|
+
/**
|
|
2676
|
+
* createConfiguration - createConfiguration
|
|
2677
|
+
*
|
|
2678
|
+
* Create a new private app configuration. To make it public a verification process needs to be triggered
|
|
2679
|
+
*/
|
|
2680
|
+
'createConfiguration'(
|
|
2681
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2682
|
+
data?: Paths.CreateConfiguration.RequestBody,
|
|
2683
|
+
config?: AxiosRequestConfig
|
|
2684
|
+
): OperationResponse<Paths.CreateConfiguration.Responses.$201>
|
|
2685
|
+
/**
|
|
2686
|
+
* listPublicConfigurations - listPublicConfigurations
|
|
2687
|
+
*
|
|
2688
|
+
* List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.
|
|
2689
|
+
*/
|
|
2690
|
+
'listPublicConfigurations'(
|
|
2691
|
+
parameters?: Parameters<Paths.ListPublicConfigurations.QueryParameters> | null,
|
|
2692
|
+
data?: any,
|
|
2693
|
+
config?: AxiosRequestConfig
|
|
2694
|
+
): OperationResponse<Paths.ListPublicConfigurations.Responses.$200>
|
|
2695
|
+
/**
|
|
2696
|
+
* getPublicConfiguration - getPublicConfiguration
|
|
2697
|
+
*
|
|
2698
|
+
* Retrieve the public configuration of an app to install in your tenant
|
|
2699
|
+
*/
|
|
2700
|
+
'getPublicConfiguration'(
|
|
2701
|
+
parameters?: Parameters<Paths.GetPublicConfiguration.QueryParameters & Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
|
|
2702
|
+
data?: any,
|
|
2703
|
+
config?: AxiosRequestConfig
|
|
2704
|
+
): OperationResponse<Paths.GetPublicConfiguration.Responses.$200>
|
|
2705
|
+
/**
|
|
2706
|
+
* getConfiguration - getConfiguration
|
|
2707
|
+
*
|
|
2708
|
+
* Retrieve a specific app configuration
|
|
2709
|
+
*/
|
|
2710
|
+
'getConfiguration'(
|
|
2711
|
+
parameters?: Parameters<Paths.GetConfiguration.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
|
|
2712
|
+
data?: any,
|
|
2713
|
+
config?: AxiosRequestConfig
|
|
2714
|
+
): OperationResponse<Paths.GetConfiguration.Responses.$200>
|
|
2715
|
+
/**
|
|
2716
|
+
* patchMetadata - patchMetadata
|
|
2717
|
+
*
|
|
2718
|
+
* Patch non-versioned configuration metadata of a given app configuration.
|
|
2719
|
+
*/
|
|
2720
|
+
'patchMetadata'(
|
|
2721
|
+
parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
|
|
2722
|
+
data?: Paths.PatchMetadata.RequestBody,
|
|
2723
|
+
config?: AxiosRequestConfig
|
|
2724
|
+
): OperationResponse<Paths.PatchMetadata.Responses.$204>
|
|
2725
|
+
/**
|
|
2726
|
+
* deleteConfiguration - Delete app configuration
|
|
2727
|
+
*
|
|
2728
|
+
* Delete an app configuration and all its versions and components.
|
|
2729
|
+
*/
|
|
2730
|
+
'deleteConfiguration'(
|
|
2731
|
+
parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
|
|
2732
|
+
data?: any,
|
|
2733
|
+
config?: AxiosRequestConfig
|
|
2734
|
+
): OperationResponse<Paths.DeleteConfiguration.Responses.$204>
|
|
2735
|
+
/**
|
|
2736
|
+
* queryEvents - queryEvents
|
|
2737
|
+
*
|
|
2738
|
+
* Query analytics events for a specific app with flexible filtering
|
|
2739
|
+
*/
|
|
2740
|
+
'queryEvents'(
|
|
2741
|
+
parameters?: Parameters<Paths.QueryEvents.PathParameters> | null,
|
|
2742
|
+
data?: Paths.QueryEvents.RequestBody,
|
|
2743
|
+
config?: AxiosRequestConfig
|
|
2744
|
+
): OperationResponse<Paths.QueryEvents.Responses.$200>
|
|
2745
|
+
/**
|
|
2746
|
+
* createBundleUploadUrl - createBundleUploadUrl
|
|
2747
|
+
*
|
|
2748
|
+
* Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path
|
|
2749
|
+
*/
|
|
2750
|
+
'createBundleUploadUrl'(
|
|
2751
|
+
parameters?: Parameters<Paths.CreateBundleUploadUrl.PathParameters> | null,
|
|
2752
|
+
data?: Paths.CreateBundleUploadUrl.RequestBody,
|
|
2753
|
+
config?: AxiosRequestConfig
|
|
2754
|
+
): OperationResponse<Paths.CreateBundleUploadUrl.Responses.$200>
|
|
2755
|
+
/**
|
|
2756
|
+
* createZipUploadUrl - createZipUploadUrl
|
|
2757
|
+
*
|
|
2758
|
+
* Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path
|
|
2759
|
+
*
|
|
2760
|
+
*/
|
|
2761
|
+
'createZipUploadUrl'(
|
|
2762
|
+
parameters?: Parameters<Paths.CreateZipUploadUrl.PathParameters> | null,
|
|
2763
|
+
data?: Paths.CreateZipUploadUrl.RequestBody,
|
|
2764
|
+
config?: AxiosRequestConfig
|
|
2765
|
+
): OperationResponse<Paths.CreateZipUploadUrl.Responses.$200>
|
|
2766
|
+
/**
|
|
2767
|
+
* createLogoUploadUrl - createLogoUploadUrl
|
|
2768
|
+
*
|
|
2769
|
+
* Generate a presigned URL for uploading app logo to /<app-id>/logo.png path
|
|
2770
|
+
*/
|
|
2771
|
+
'createLogoUploadUrl'(
|
|
2772
|
+
parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
|
|
2773
|
+
data?: Paths.CreateLogoUploadUrl.RequestBody,
|
|
2774
|
+
config?: AxiosRequestConfig
|
|
2775
|
+
): OperationResponse<Paths.CreateLogoUploadUrl.Responses.$200>
|
|
2776
|
+
/**
|
|
2777
|
+
* deleteLogo - deleteLogo
|
|
2778
|
+
*
|
|
2779
|
+
* Delete the app logo from /<app-id>/logo.png path
|
|
2780
|
+
*/
|
|
2781
|
+
'deleteLogo'(
|
|
2782
|
+
parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
|
|
2783
|
+
data?: any,
|
|
2784
|
+
config?: AxiosRequestConfig
|
|
2785
|
+
): OperationResponse<Paths.DeleteLogo.Responses.$204>
|
|
2786
|
+
/**
|
|
2787
|
+
* listVersions - listVersions
|
|
2788
|
+
*
|
|
2789
|
+
* Retrieve a list of versions for an app configuration
|
|
2790
|
+
*/
|
|
2791
|
+
'listVersions'(
|
|
2792
|
+
parameters?: Parameters<Paths.ListVersions.QueryParameters & Paths.ListVersions.PathParameters> | null,
|
|
2793
|
+
data?: any,
|
|
2794
|
+
config?: AxiosRequestConfig
|
|
2795
|
+
): OperationResponse<Paths.ListVersions.Responses.$200>
|
|
2796
|
+
/**
|
|
2797
|
+
* getVersion - getVersion
|
|
2798
|
+
*
|
|
2799
|
+
* Retrieve a specific version of an app configuration
|
|
2800
|
+
*/
|
|
2801
|
+
'getVersion'(
|
|
2802
|
+
parameters?: Parameters<Paths.GetVersion.PathParameters> | null,
|
|
2803
|
+
data?: any,
|
|
2804
|
+
config?: AxiosRequestConfig
|
|
2805
|
+
): OperationResponse<Paths.GetVersion.Responses.$200>
|
|
2806
|
+
/**
|
|
2807
|
+
* patchVersion - patchVersion
|
|
2808
|
+
*
|
|
2809
|
+
* Patch an existing app version
|
|
2810
|
+
*/
|
|
2811
|
+
'patchVersion'(
|
|
2812
|
+
parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
|
|
2813
|
+
data?: Paths.PatchVersion.RequestBody,
|
|
2814
|
+
config?: AxiosRequestConfig
|
|
2815
|
+
): OperationResponse<Paths.PatchVersion.Responses.$204>
|
|
2816
|
+
/**
|
|
2817
|
+
* deleteVersion - deleteVersion
|
|
2818
|
+
*
|
|
2819
|
+
* Delete a specific version of an app configuration
|
|
2820
|
+
*/
|
|
2821
|
+
'deleteVersion'(
|
|
2822
|
+
parameters?: Parameters<Paths.DeleteVersion.PathParameters> | null,
|
|
2823
|
+
data?: any,
|
|
2824
|
+
config?: AxiosRequestConfig
|
|
2825
|
+
): OperationResponse<Paths.DeleteVersion.Responses.$204>
|
|
2826
|
+
/**
|
|
2827
|
+
* getReview - getReview
|
|
2828
|
+
*
|
|
2829
|
+
* Retrieve the review status of a specific app version
|
|
2830
|
+
*/
|
|
2831
|
+
'getReview'(
|
|
2832
|
+
parameters?: Parameters<Paths.GetReview.PathParameters> | null,
|
|
2833
|
+
data?: any,
|
|
2834
|
+
config?: AxiosRequestConfig
|
|
2835
|
+
): OperationResponse<Paths.GetReview.Responses.$200>
|
|
2836
|
+
/**
|
|
2837
|
+
* createReview - createReview
|
|
2838
|
+
*
|
|
2839
|
+
* Submit an app version for review to make it public
|
|
2840
|
+
*/
|
|
2841
|
+
'createReview'(
|
|
2842
|
+
parameters?: Parameters<Paths.CreateReview.PathParameters> | null,
|
|
2843
|
+
data?: Paths.CreateReview.RequestBody,
|
|
2844
|
+
config?: AxiosRequestConfig
|
|
2845
|
+
): OperationResponse<Paths.CreateReview.Responses.$200>
|
|
2846
|
+
/**
|
|
2847
|
+
* createComponent - createComponent
|
|
2848
|
+
*
|
|
2849
|
+
* Patch an existing app version to create/add a component
|
|
2850
|
+
*/
|
|
2851
|
+
'createComponent'(
|
|
2852
|
+
parameters?: Parameters<Paths.CreateComponent.PathParameters> | null,
|
|
2853
|
+
data?: Paths.CreateComponent.RequestBody,
|
|
2854
|
+
config?: AxiosRequestConfig
|
|
2855
|
+
): OperationResponse<Paths.CreateComponent.Responses.$200>
|
|
2856
|
+
/**
|
|
2857
|
+
* patchComponent - patchComponent
|
|
2858
|
+
*
|
|
2859
|
+
* Patch an existing app version to update its components
|
|
2860
|
+
*/
|
|
2861
|
+
'patchComponent'(
|
|
2862
|
+
parameters?: Parameters<Paths.PatchComponent.PathParameters> | null,
|
|
2863
|
+
data?: Paths.PatchComponent.RequestBody,
|
|
2864
|
+
config?: AxiosRequestConfig
|
|
2865
|
+
): OperationResponse<Paths.PatchComponent.Responses.$204>
|
|
2866
|
+
/**
|
|
2867
|
+
* deleteComponent - deleteComponent
|
|
2868
|
+
*
|
|
2869
|
+
* Delete a specific component from an app version
|
|
2870
|
+
*/
|
|
2871
|
+
'deleteComponent'(
|
|
2872
|
+
parameters?: Parameters<Paths.DeleteComponent.PathParameters> | null,
|
|
2873
|
+
data?: any,
|
|
2874
|
+
config?: AxiosRequestConfig
|
|
2875
|
+
): OperationResponse<Paths.DeleteComponent.Responses.$204>
|
|
2876
|
+
/**
|
|
2877
|
+
* cloneVersion - cloneVersion
|
|
2878
|
+
*
|
|
2879
|
+
* Clone an existing app version to create a new version
|
|
2880
|
+
*/
|
|
2881
|
+
'cloneVersion'(
|
|
2882
|
+
parameters?: Parameters<Paths.CloneVersion.PathParameters> | null,
|
|
2883
|
+
data?: any,
|
|
2884
|
+
config?: AxiosRequestConfig
|
|
2885
|
+
): OperationResponse<Paths.CloneVersion.Responses.$201>
|
|
2886
|
+
/**
|
|
2887
|
+
* listInstallations - listInstallations
|
|
2888
|
+
*
|
|
2889
|
+
* Retrieve a list of installed apps for the organization.
|
|
2890
|
+
*/
|
|
2891
|
+
'listInstallations'(
|
|
2892
|
+
parameters?: Parameters<Paths.ListInstallations.QueryParameters> | null,
|
|
2893
|
+
data?: any,
|
|
2894
|
+
config?: AxiosRequestConfig
|
|
2895
|
+
): OperationResponse<Paths.ListInstallations.Responses.$200>
|
|
2896
|
+
/**
|
|
2897
|
+
* getInstallation - getInstallation
|
|
2898
|
+
*
|
|
2899
|
+
* Retrieve details of an installed app by its ID.
|
|
2900
|
+
*/
|
|
2901
|
+
'getInstallation'(
|
|
2902
|
+
parameters?: Parameters<Paths.GetInstallation.PathParameters> | null,
|
|
2903
|
+
data?: any,
|
|
2904
|
+
config?: AxiosRequestConfig
|
|
2905
|
+
): OperationResponse<Paths.GetInstallation.Responses.$200>
|
|
2906
|
+
/**
|
|
2907
|
+
* install - install
|
|
2908
|
+
*
|
|
2909
|
+
* Upsert app installation by its ID.
|
|
2910
|
+
*/
|
|
2911
|
+
'install'(
|
|
2912
|
+
parameters?: Parameters<Paths.Install.PathParameters> | null,
|
|
2913
|
+
data?: Paths.Install.RequestBody,
|
|
2914
|
+
config?: AxiosRequestConfig
|
|
2915
|
+
): OperationResponse<Paths.Install.Responses.$201>
|
|
2916
|
+
/**
|
|
2917
|
+
* patchInstallation - patchInstallation
|
|
2918
|
+
*
|
|
2919
|
+
* Patch an installed app by its ID.
|
|
2920
|
+
*/
|
|
2921
|
+
'patchInstallation'(
|
|
2922
|
+
parameters?: Parameters<Paths.PatchInstallation.PathParameters> | null,
|
|
2923
|
+
data?: Paths.PatchInstallation.RequestBody,
|
|
2924
|
+
config?: AxiosRequestConfig
|
|
2925
|
+
): OperationResponse<Paths.PatchInstallation.Responses.$204>
|
|
2926
|
+
/**
|
|
2927
|
+
* uninstall - uninstall
|
|
2928
|
+
*
|
|
2929
|
+
* Uninstall an app by its ID.
|
|
2930
|
+
*/
|
|
2931
|
+
'uninstall'(
|
|
2932
|
+
parameters?: Parameters<Paths.Uninstall.PathParameters> | null,
|
|
2933
|
+
data?: any,
|
|
2934
|
+
config?: AxiosRequestConfig
|
|
2935
|
+
): OperationResponse<Paths.Uninstall.Responses.$204>
|
|
2936
|
+
/**
|
|
2937
|
+
* promoteVersion - promoteVersion
|
|
2938
|
+
*
|
|
2939
|
+
* Update an installed app to a new version
|
|
2940
|
+
*/
|
|
2941
|
+
'promoteVersion'(
|
|
2942
|
+
parameters?: Parameters<Paths.PromoteVersion.PathParameters> | null,
|
|
2943
|
+
data?: any,
|
|
2944
|
+
config?: AxiosRequestConfig
|
|
2945
|
+
): OperationResponse<Paths.PromoteVersion.Responses.$200>
|
|
2946
|
+
/**
|
|
2947
|
+
* ingestEvent - ingestEvent
|
|
2948
|
+
*
|
|
2949
|
+
* Internal endpoint for services to submit app events for analytic purposes
|
|
2950
|
+
*/
|
|
2951
|
+
'ingestEvent'(
|
|
2952
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2953
|
+
data?: Paths.IngestEvent.RequestBody,
|
|
2954
|
+
config?: AxiosRequestConfig
|
|
2955
|
+
): OperationResponse<Paths.IngestEvent.Responses.$202>
|
|
2956
|
+
}
|
|
2957
|
+
|
|
2958
|
+
interface PathsDictionary {
|
|
2959
|
+
['/v1/public/app/{appId}/components/{componentId}']: {
|
|
2960
|
+
/**
|
|
2961
|
+
* getPublicFacingComponent - getPublicFacingComponent
|
|
2962
|
+
*
|
|
2963
|
+
* Retrieve public facing components for an installed app
|
|
2964
|
+
*/
|
|
2965
|
+
'get'(
|
|
2966
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdComponents$ComponentId.PathParameters> | null,
|
|
2967
|
+
data?: any,
|
|
2968
|
+
config?: AxiosRequestConfig
|
|
2969
|
+
): OperationResponse<Paths.GetPublicFacingComponent.Responses.$200>
|
|
2970
|
+
}
|
|
2971
|
+
['/v1/app-configurations']: {
|
|
2972
|
+
/**
|
|
2973
|
+
* listConfigurations - listConfigurations
|
|
2974
|
+
*
|
|
2975
|
+
* List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.
|
|
2976
|
+
*/
|
|
2977
|
+
'get'(
|
|
2978
|
+
parameters?: Parameters<Paths.ListConfigurations.QueryParameters> | null,
|
|
2979
|
+
data?: any,
|
|
2980
|
+
config?: AxiosRequestConfig
|
|
2981
|
+
): OperationResponse<Paths.ListConfigurations.Responses.$200>
|
|
2982
|
+
/**
|
|
2983
|
+
* createConfiguration - createConfiguration
|
|
2984
|
+
*
|
|
2985
|
+
* Create a new private app configuration. To make it public a verification process needs to be triggered
|
|
2986
|
+
*/
|
|
2987
|
+
'post'(
|
|
2988
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2989
|
+
data?: Paths.CreateConfiguration.RequestBody,
|
|
2990
|
+
config?: AxiosRequestConfig
|
|
2991
|
+
): OperationResponse<Paths.CreateConfiguration.Responses.$201>
|
|
2992
|
+
}
|
|
2993
|
+
['/v1/app-configurations/public']: {
|
|
2994
|
+
/**
|
|
2995
|
+
* listPublicConfigurations - listPublicConfigurations
|
|
2996
|
+
*
|
|
2997
|
+
* List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.
|
|
2998
|
+
*/
|
|
2999
|
+
'get'(
|
|
3000
|
+
parameters?: Parameters<Paths.ListPublicConfigurations.QueryParameters> | null,
|
|
3001
|
+
data?: any,
|
|
3002
|
+
config?: AxiosRequestConfig
|
|
3003
|
+
): OperationResponse<Paths.ListPublicConfigurations.Responses.$200>
|
|
3004
|
+
}
|
|
3005
|
+
['/v1/app-configurations/public/{appId}']: {
|
|
3006
|
+
/**
|
|
3007
|
+
* getPublicConfiguration - getPublicConfiguration
|
|
3008
|
+
*
|
|
3009
|
+
* Retrieve the public configuration of an app to install in your tenant
|
|
3010
|
+
*/
|
|
3011
|
+
'get'(
|
|
3012
|
+
parameters?: Parameters<Paths.GetPublicConfiguration.QueryParameters & Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
|
|
3013
|
+
data?: any,
|
|
3014
|
+
config?: AxiosRequestConfig
|
|
3015
|
+
): OperationResponse<Paths.GetPublicConfiguration.Responses.$200>
|
|
3016
|
+
}
|
|
3017
|
+
['/v1/app-configurations/{appId}']: {
|
|
3018
|
+
/**
|
|
3019
|
+
* getConfiguration - getConfiguration
|
|
3020
|
+
*
|
|
3021
|
+
* Retrieve a specific app configuration
|
|
3022
|
+
*/
|
|
3023
|
+
'get'(
|
|
3024
|
+
parameters?: Parameters<Paths.GetConfiguration.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
|
|
3025
|
+
data?: any,
|
|
3026
|
+
config?: AxiosRequestConfig
|
|
3027
|
+
): OperationResponse<Paths.GetConfiguration.Responses.$200>
|
|
3028
|
+
/**
|
|
3029
|
+
* patchMetadata - patchMetadata
|
|
3030
|
+
*
|
|
3031
|
+
* Patch non-versioned configuration metadata of a given app configuration.
|
|
3032
|
+
*/
|
|
3033
|
+
'patch'(
|
|
3034
|
+
parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
|
|
3035
|
+
data?: Paths.PatchMetadata.RequestBody,
|
|
3036
|
+
config?: AxiosRequestConfig
|
|
3037
|
+
): OperationResponse<Paths.PatchMetadata.Responses.$204>
|
|
3038
|
+
/**
|
|
3039
|
+
* deleteConfiguration - Delete app configuration
|
|
3040
|
+
*
|
|
3041
|
+
* Delete an app configuration and all its versions and components.
|
|
3042
|
+
*/
|
|
3043
|
+
'delete'(
|
|
3044
|
+
parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
|
|
3045
|
+
data?: any,
|
|
3046
|
+
config?: AxiosRequestConfig
|
|
3047
|
+
): OperationResponse<Paths.DeleteConfiguration.Responses.$204>
|
|
3048
|
+
}
|
|
3049
|
+
['/v1/app-configurations/{appId}/events']: {
|
|
3050
|
+
/**
|
|
3051
|
+
* queryEvents - queryEvents
|
|
3052
|
+
*
|
|
3053
|
+
* Query analytics events for a specific app with flexible filtering
|
|
3054
|
+
*/
|
|
3055
|
+
'post'(
|
|
3056
|
+
parameters?: Parameters<Paths.QueryEvents.PathParameters> | null,
|
|
3057
|
+
data?: Paths.QueryEvents.RequestBody,
|
|
3058
|
+
config?: AxiosRequestConfig
|
|
3059
|
+
): OperationResponse<Paths.QueryEvents.Responses.$200>
|
|
3060
|
+
}
|
|
3061
|
+
['/v1/app-configurations/{appId}/bundle']: {
|
|
3062
|
+
/**
|
|
3063
|
+
* createBundleUploadUrl - createBundleUploadUrl
|
|
3064
|
+
*
|
|
3065
|
+
* Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path
|
|
3066
|
+
*/
|
|
3067
|
+
'post'(
|
|
3068
|
+
parameters?: Parameters<Paths.CreateBundleUploadUrl.PathParameters> | null,
|
|
3069
|
+
data?: Paths.CreateBundleUploadUrl.RequestBody,
|
|
3070
|
+
config?: AxiosRequestConfig
|
|
3071
|
+
): OperationResponse<Paths.CreateBundleUploadUrl.Responses.$200>
|
|
3072
|
+
}
|
|
3073
|
+
['/v1/app-configurations/{appId}/zip']: {
|
|
3074
|
+
/**
|
|
3075
|
+
* createZipUploadUrl - createZipUploadUrl
|
|
3076
|
+
*
|
|
3077
|
+
* Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path
|
|
3078
|
+
*
|
|
3079
|
+
*/
|
|
3080
|
+
'post'(
|
|
3081
|
+
parameters?: Parameters<Paths.CreateZipUploadUrl.PathParameters> | null,
|
|
3082
|
+
data?: Paths.CreateZipUploadUrl.RequestBody,
|
|
3083
|
+
config?: AxiosRequestConfig
|
|
3084
|
+
): OperationResponse<Paths.CreateZipUploadUrl.Responses.$200>
|
|
3085
|
+
}
|
|
3086
|
+
['/v1/app-configurations/{appId}/logo']: {
|
|
3087
|
+
/**
|
|
3088
|
+
* createLogoUploadUrl - createLogoUploadUrl
|
|
3089
|
+
*
|
|
3090
|
+
* Generate a presigned URL for uploading app logo to /<app-id>/logo.png path
|
|
3091
|
+
*/
|
|
3092
|
+
'post'(
|
|
3093
|
+
parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
|
|
3094
|
+
data?: Paths.CreateLogoUploadUrl.RequestBody,
|
|
3095
|
+
config?: AxiosRequestConfig
|
|
3096
|
+
): OperationResponse<Paths.CreateLogoUploadUrl.Responses.$200>
|
|
3097
|
+
/**
|
|
3098
|
+
* deleteLogo - deleteLogo
|
|
3099
|
+
*
|
|
3100
|
+
* Delete the app logo from /<app-id>/logo.png path
|
|
3101
|
+
*/
|
|
3102
|
+
'delete'(
|
|
3103
|
+
parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
|
|
3104
|
+
data?: any,
|
|
3105
|
+
config?: AxiosRequestConfig
|
|
3106
|
+
): OperationResponse<Paths.DeleteLogo.Responses.$204>
|
|
3107
|
+
}
|
|
3108
|
+
['/v1/app-configurations/{appId}/versions']: {
|
|
3109
|
+
/**
|
|
3110
|
+
* listVersions - listVersions
|
|
3111
|
+
*
|
|
3112
|
+
* Retrieve a list of versions for an app configuration
|
|
3113
|
+
*/
|
|
3114
|
+
'get'(
|
|
3115
|
+
parameters?: Parameters<Paths.ListVersions.QueryParameters & Paths.ListVersions.PathParameters> | null,
|
|
3116
|
+
data?: any,
|
|
3117
|
+
config?: AxiosRequestConfig
|
|
3118
|
+
): OperationResponse<Paths.ListVersions.Responses.$200>
|
|
3119
|
+
}
|
|
3120
|
+
['/v1/app-configurations/{appId}/versions/{version}']: {
|
|
3121
|
+
/**
|
|
3122
|
+
* getVersion - getVersion
|
|
3123
|
+
*
|
|
3124
|
+
* Retrieve a specific version of an app configuration
|
|
3125
|
+
*/
|
|
3126
|
+
'get'(
|
|
3127
|
+
parameters?: Parameters<Paths.GetVersion.PathParameters> | null,
|
|
3128
|
+
data?: any,
|
|
3129
|
+
config?: AxiosRequestConfig
|
|
3130
|
+
): OperationResponse<Paths.GetVersion.Responses.$200>
|
|
3131
|
+
/**
|
|
3132
|
+
* deleteVersion - deleteVersion
|
|
3133
|
+
*
|
|
3134
|
+
* Delete a specific version of an app configuration
|
|
3135
|
+
*/
|
|
3136
|
+
'delete'(
|
|
3137
|
+
parameters?: Parameters<Paths.DeleteVersion.PathParameters> | null,
|
|
3138
|
+
data?: any,
|
|
3139
|
+
config?: AxiosRequestConfig
|
|
3140
|
+
): OperationResponse<Paths.DeleteVersion.Responses.$204>
|
|
3141
|
+
/**
|
|
3142
|
+
* patchVersion - patchVersion
|
|
3143
|
+
*
|
|
3144
|
+
* Patch an existing app version
|
|
3145
|
+
*/
|
|
3146
|
+
'patch'(
|
|
3147
|
+
parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
|
|
3148
|
+
data?: Paths.PatchVersion.RequestBody,
|
|
3149
|
+
config?: AxiosRequestConfig
|
|
3150
|
+
): OperationResponse<Paths.PatchVersion.Responses.$204>
|
|
3151
|
+
}
|
|
3152
|
+
['/v1/app-configurations/{appId}/versions/{version}/review']: {
|
|
3153
|
+
/**
|
|
3154
|
+
* getReview - getReview
|
|
3155
|
+
*
|
|
3156
|
+
* Retrieve the review status of a specific app version
|
|
3157
|
+
*/
|
|
3158
|
+
'get'(
|
|
3159
|
+
parameters?: Parameters<Paths.GetReview.PathParameters> | null,
|
|
3160
|
+
data?: any,
|
|
3161
|
+
config?: AxiosRequestConfig
|
|
3162
|
+
): OperationResponse<Paths.GetReview.Responses.$200>
|
|
3163
|
+
/**
|
|
3164
|
+
* createReview - createReview
|
|
3165
|
+
*
|
|
3166
|
+
* Submit an app version for review to make it public
|
|
3167
|
+
*/
|
|
3168
|
+
'post'(
|
|
3169
|
+
parameters?: Parameters<Paths.CreateReview.PathParameters> | null,
|
|
3170
|
+
data?: Paths.CreateReview.RequestBody,
|
|
3171
|
+
config?: AxiosRequestConfig
|
|
3172
|
+
): OperationResponse<Paths.CreateReview.Responses.$200>
|
|
3173
|
+
}
|
|
3174
|
+
['/v1/app-configurations/{appId}/versions/{version}/components']: {
|
|
3175
|
+
/**
|
|
3176
|
+
* createComponent - createComponent
|
|
3177
|
+
*
|
|
3178
|
+
* Patch an existing app version to create/add a component
|
|
3179
|
+
*/
|
|
3180
|
+
'post'(
|
|
3181
|
+
parameters?: Parameters<Paths.CreateComponent.PathParameters> | null,
|
|
3182
|
+
data?: Paths.CreateComponent.RequestBody,
|
|
3183
|
+
config?: AxiosRequestConfig
|
|
3184
|
+
): OperationResponse<Paths.CreateComponent.Responses.$200>
|
|
3185
|
+
}
|
|
3186
|
+
['/v1/app-configurations/{appId}/versions/{version}/components/{componentId}']: {
|
|
3187
|
+
/**
|
|
3188
|
+
* patchComponent - patchComponent
|
|
3189
|
+
*
|
|
3190
|
+
* Patch an existing app version to update its components
|
|
3191
|
+
*/
|
|
3192
|
+
'patch'(
|
|
3193
|
+
parameters?: Parameters<Paths.PatchComponent.PathParameters> | null,
|
|
3194
|
+
data?: Paths.PatchComponent.RequestBody,
|
|
3195
|
+
config?: AxiosRequestConfig
|
|
3196
|
+
): OperationResponse<Paths.PatchComponent.Responses.$204>
|
|
3197
|
+
/**
|
|
3198
|
+
* deleteComponent - deleteComponent
|
|
3199
|
+
*
|
|
3200
|
+
* Delete a specific component from an app version
|
|
3201
|
+
*/
|
|
3202
|
+
'delete'(
|
|
3203
|
+
parameters?: Parameters<Paths.DeleteComponent.PathParameters> | null,
|
|
3204
|
+
data?: any,
|
|
3205
|
+
config?: AxiosRequestConfig
|
|
3206
|
+
): OperationResponse<Paths.DeleteComponent.Responses.$204>
|
|
3207
|
+
}
|
|
3208
|
+
['/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}']: {
|
|
3209
|
+
/**
|
|
3210
|
+
* cloneVersion - cloneVersion
|
|
3211
|
+
*
|
|
3212
|
+
* Clone an existing app version to create a new version
|
|
3213
|
+
*/
|
|
3214
|
+
'post'(
|
|
3215
|
+
parameters?: Parameters<Paths.CloneVersion.PathParameters> | null,
|
|
3216
|
+
data?: any,
|
|
3217
|
+
config?: AxiosRequestConfig
|
|
3218
|
+
): OperationResponse<Paths.CloneVersion.Responses.$201>
|
|
3219
|
+
}
|
|
3220
|
+
['/v1/app']: {
|
|
3221
|
+
/**
|
|
3222
|
+
* listInstallations - listInstallations
|
|
3223
|
+
*
|
|
3224
|
+
* Retrieve a list of installed apps for the organization.
|
|
3225
|
+
*/
|
|
3226
|
+
'get'(
|
|
3227
|
+
parameters?: Parameters<Paths.ListInstallations.QueryParameters> | null,
|
|
3228
|
+
data?: any,
|
|
3229
|
+
config?: AxiosRequestConfig
|
|
3230
|
+
): OperationResponse<Paths.ListInstallations.Responses.$200>
|
|
3231
|
+
}
|
|
3232
|
+
['/v1/app/{appId}']: {
|
|
3233
|
+
/**
|
|
3234
|
+
* getInstallation - getInstallation
|
|
3235
|
+
*
|
|
3236
|
+
* Retrieve details of an installed app by its ID.
|
|
3237
|
+
*/
|
|
3238
|
+
'get'(
|
|
3239
|
+
parameters?: Parameters<Paths.GetInstallation.PathParameters> | null,
|
|
3240
|
+
data?: any,
|
|
3241
|
+
config?: AxiosRequestConfig
|
|
3242
|
+
): OperationResponse<Paths.GetInstallation.Responses.$200>
|
|
3243
|
+
/**
|
|
3244
|
+
* install - install
|
|
3245
|
+
*
|
|
3246
|
+
* Upsert app installation by its ID.
|
|
3247
|
+
*/
|
|
3248
|
+
'post'(
|
|
3249
|
+
parameters?: Parameters<Paths.Install.PathParameters> | null,
|
|
3250
|
+
data?: Paths.Install.RequestBody,
|
|
3251
|
+
config?: AxiosRequestConfig
|
|
3252
|
+
): OperationResponse<Paths.Install.Responses.$201>
|
|
3253
|
+
/**
|
|
3254
|
+
* patchInstallation - patchInstallation
|
|
3255
|
+
*
|
|
3256
|
+
* Patch an installed app by its ID.
|
|
3257
|
+
*/
|
|
3258
|
+
'patch'(
|
|
3259
|
+
parameters?: Parameters<Paths.PatchInstallation.PathParameters> | null,
|
|
3260
|
+
data?: Paths.PatchInstallation.RequestBody,
|
|
3261
|
+
config?: AxiosRequestConfig
|
|
3262
|
+
): OperationResponse<Paths.PatchInstallation.Responses.$204>
|
|
3263
|
+
/**
|
|
3264
|
+
* uninstall - uninstall
|
|
3265
|
+
*
|
|
3266
|
+
* Uninstall an app by its ID.
|
|
3267
|
+
*/
|
|
3268
|
+
'delete'(
|
|
3269
|
+
parameters?: Parameters<Paths.Uninstall.PathParameters> | null,
|
|
3270
|
+
data?: any,
|
|
3271
|
+
config?: AxiosRequestConfig
|
|
3272
|
+
): OperationResponse<Paths.Uninstall.Responses.$204>
|
|
3273
|
+
}
|
|
3274
|
+
['/v1/app/{appId}/promote-to/{version}']: {
|
|
3275
|
+
/**
|
|
3276
|
+
* promoteVersion - promoteVersion
|
|
3277
|
+
*
|
|
3278
|
+
* Update an installed app to a new version
|
|
3279
|
+
*/
|
|
3280
|
+
'post'(
|
|
3281
|
+
parameters?: Parameters<Paths.PromoteVersion.PathParameters> | null,
|
|
3282
|
+
data?: any,
|
|
3283
|
+
config?: AxiosRequestConfig
|
|
3284
|
+
): OperationResponse<Paths.PromoteVersion.Responses.$200>
|
|
3285
|
+
}
|
|
3286
|
+
['/v1/app-events']: {
|
|
3287
|
+
/**
|
|
3288
|
+
* ingestEvent - ingestEvent
|
|
3289
|
+
*
|
|
3290
|
+
* Internal endpoint for services to submit app events for analytic purposes
|
|
3291
|
+
*/
|
|
3292
|
+
'post'(
|
|
3293
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3294
|
+
data?: Paths.IngestEvent.RequestBody,
|
|
3295
|
+
config?: AxiosRequestConfig
|
|
3296
|
+
): OperationResponse<Paths.IngestEvent.Responses.$202>
|
|
3297
|
+
}
|
|
3298
|
+
}
|
|
3299
|
+
|
|
3300
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
3301
|
+
|
|
3302
|
+
|
|
3303
|
+
type Actor = Components.Schemas.Actor;
|
|
3304
|
+
type AggregatedEvents = Components.Schemas.AggregatedEvents;
|
|
3305
|
+
type AppBridgeSurfaceConfig = Components.Schemas.AppBridgeSurfaceConfig;
|
|
3306
|
+
type AppEventData = Components.Schemas.AppEventData;
|
|
3307
|
+
type Audit = Components.Schemas.Audit;
|
|
3308
|
+
type Author = Components.Schemas.Author;
|
|
3309
|
+
type BaseComponent = Components.Schemas.BaseComponent;
|
|
3310
|
+
type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
|
|
3311
|
+
type BaseCustomActionConfig = Components.Schemas.BaseCustomActionConfig;
|
|
3312
|
+
type BatchEventRequest = Components.Schemas.BatchEventRequest;
|
|
3313
|
+
type BillingFrequency = Components.Schemas.BillingFrequency;
|
|
3314
|
+
type BlueprintRef = Components.Schemas.BlueprintRef;
|
|
3315
|
+
type BooleanArg = Components.Schemas.BooleanArg;
|
|
3316
|
+
type CallerIdentity = Components.Schemas.CallerIdentity;
|
|
3317
|
+
type ComponentType = Components.Schemas.ComponentType;
|
|
3318
|
+
type Configuration = Components.Schemas.Configuration;
|
|
3319
|
+
type ConfigurationMetadata = Components.Schemas.ConfigurationMetadata;
|
|
3320
|
+
type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
|
|
3321
|
+
type CustomCapabilityComponent = Components.Schemas.CustomCapabilityComponent;
|
|
3322
|
+
type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
|
|
3323
|
+
type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
|
|
3324
|
+
type CustomPageComponent = Components.Schemas.CustomPageComponent;
|
|
3325
|
+
type CustomPageConfig = Components.Schemas.CustomPageConfig;
|
|
3326
|
+
type EnumArg = Components.Schemas.EnumArg;
|
|
3327
|
+
type ErpInformToolkitComponent = Components.Schemas.ErpInformToolkitComponent;
|
|
3328
|
+
type EventsQuery = Components.Schemas.EventsQuery;
|
|
3329
|
+
type EventsQueryResponse = Components.Schemas.EventsQueryResponse;
|
|
3330
|
+
type ExternalIntegrationCustomActionConfig = Components.Schemas.ExternalIntegrationCustomActionConfig;
|
|
3331
|
+
type ExternalProductCatalogAuthBlock = Components.Schemas.ExternalProductCatalogAuthBlock;
|
|
3332
|
+
type ExternalProductCatalogComponent = Components.Schemas.ExternalProductCatalogComponent;
|
|
3333
|
+
type ExternalProductCatalogConfig = Components.Schemas.ExternalProductCatalogConfig;
|
|
3334
|
+
type ExternalProductCatalogHookProductRecommendations = Components.Schemas.ExternalProductCatalogHookProductRecommendations;
|
|
3335
|
+
type ExternalProductCatalogHookProducts = Components.Schemas.ExternalProductCatalogHookProducts;
|
|
3336
|
+
type Grants = Components.Schemas.Grants;
|
|
3337
|
+
type Installation = Components.Schemas.Installation;
|
|
3338
|
+
type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
|
|
3339
|
+
type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
|
|
3340
|
+
type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;
|
|
3341
|
+
type NotificationConfig = Components.Schemas.NotificationConfig;
|
|
3342
|
+
type NotificationEvent = Components.Schemas.NotificationEvent;
|
|
3343
|
+
type Option = Components.Schemas.Option;
|
|
3344
|
+
type Options = Components.Schemas.Options;
|
|
3345
|
+
type OptionsRef = Components.Schemas.OptionsRef;
|
|
3346
|
+
type OverrideDevMode = Components.Schemas.OverrideDevMode;
|
|
3347
|
+
type PortalBlockComponent = Components.Schemas.PortalBlockComponent;
|
|
3348
|
+
type PortalBlockConfig = Components.Schemas.PortalBlockConfig;
|
|
3349
|
+
type PortalBlockSurfaceConfig = Components.Schemas.PortalBlockSurfaceConfig;
|
|
3350
|
+
type PortalExtensionAuthBlock = Components.Schemas.PortalExtensionAuthBlock;
|
|
3351
|
+
type PortalExtensionComponent = Components.Schemas.PortalExtensionComponent;
|
|
3352
|
+
type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
|
|
3353
|
+
type PortalExtensionHookConsumptionDataRetrieval = Components.Schemas.PortalExtensionHookConsumptionDataRetrieval;
|
|
3354
|
+
type PortalExtensionHookContractIdentification = Components.Schemas.PortalExtensionHookContractIdentification;
|
|
3355
|
+
type PortalExtensionHookCostDataRetrieval = Components.Schemas.PortalExtensionHookCostDataRetrieval;
|
|
3356
|
+
type PortalExtensionHookMeterReadingPlausibilityCheck = Components.Schemas.PortalExtensionHookMeterReadingPlausibilityCheck;
|
|
3357
|
+
type PortalExtensionHookPriceDataRetrieval = Components.Schemas.PortalExtensionHookPriceDataRetrieval;
|
|
3358
|
+
type PortalExtensionHookRegistrationIdentifiersCheck = Components.Schemas.PortalExtensionHookRegistrationIdentifiersCheck;
|
|
3359
|
+
type PortalExtensionSeamlessLink = Components.Schemas.PortalExtensionSeamlessLink;
|
|
3360
|
+
type Pricing = Components.Schemas.Pricing;
|
|
3361
|
+
type PublicConfiguration = Components.Schemas.PublicConfiguration;
|
|
3362
|
+
type RawEvents = Components.Schemas.RawEvents;
|
|
3363
|
+
type Review = Components.Schemas.Review;
|
|
3364
|
+
type Role = Components.Schemas.Role;
|
|
3365
|
+
type S3Reference = Components.Schemas.S3Reference;
|
|
3366
|
+
type SandboxCustomActionConfig = Components.Schemas.SandboxCustomActionConfig;
|
|
3367
|
+
type TextArg = Components.Schemas.TextArg;
|
|
3368
|
+
type TranslatedString = Components.Schemas.TranslatedString;
|
|
3369
|
+
|
|
3370
|
+
export type { PortalExtensionHookConsumptionDataRetrieval as $, Actor as A, BaseComponent as B, Client as C, ExternalProductCatalogComponent as D, EnumArg as E, ExternalProductCatalogConfig as F, ExternalProductCatalogHookProductRecommendations as G, ExternalProductCatalogHookProducts as H, Grants as I, Installation as J, JourneyBlockComponent as K, JourneyBlockComponentArgs as L, JourneyBlockConfig as M, NotificationConfig as N, OperationMethods as O, PathsDictionary as P, NotificationEvent as Q, Option as R, Options as S, OptionsRef as T, OverrideDevMode as U, PortalBlockComponent as V, PortalBlockConfig as W, PortalBlockSurfaceConfig as X, PortalExtensionAuthBlock as Y, PortalExtensionComponent as Z, PortalExtensionConfig as _, AggregatedEvents as a, PortalExtensionHookContractIdentification as a0, PortalExtensionHookCostDataRetrieval as a1, PortalExtensionHookMeterReadingPlausibilityCheck as a2, PortalExtensionHookPriceDataRetrieval as a3, PortalExtensionHookRegistrationIdentifiersCheck as a4, PortalExtensionSeamlessLink as a5, Pricing as a6, PublicConfiguration as a7, RawEvents as a8, Review as a9, Role as aa, S3Reference as ab, SandboxCustomActionConfig as ac, TextArg as ad, TranslatedString as ae, AppBridgeSurfaceConfig as b, AppEventData as c, Audit as d, Author as e, BaseComponentCommon as f, BaseCustomActionConfig as g, BatchEventRequest as h, BillingFrequency as i, BlueprintRef as j, BooleanArg as k, CallerIdentity as l, ComponentType as m, Configuration as n, ConfigurationMetadata as o, ConfigurationVersion as p, CustomCapabilityComponent as q, CustomFlowActionComponent as r, CustomFlowConfig as s, CustomPageComponent as t, CustomPageConfig as u, ErpInformToolkitComponent as v, EventsQuery as w, EventsQueryResponse as x, ExternalIntegrationCustomActionConfig as y, ExternalProductCatalogAuthBlock as z };
|