@epilot/sdk 2.12.0 → 2.12.2

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.
Files changed (141) hide show
  1. package/definitions/customer-portal-runtime.json +1 -1
  2. package/definitions/customer-portal.json +164 -16
  3. package/definitions/event-catalog.json +63 -1
  4. package/dist/apis/access-token.cjs +6 -6
  5. package/dist/apis/access-token.js +1 -1
  6. package/dist/apis/address-suggestions.cjs +6 -6
  7. package/dist/apis/address-suggestions.js +1 -1
  8. package/dist/apis/address.cjs +6 -6
  9. package/dist/apis/address.js +1 -1
  10. package/dist/apis/ai-agents.cjs +6 -6
  11. package/dist/apis/ai-agents.js +1 -1
  12. package/dist/apis/app.cjs +6 -6
  13. package/dist/apis/app.js +1 -1
  14. package/dist/apis/audit-logs.cjs +6 -6
  15. package/dist/apis/audit-logs.js +1 -1
  16. package/dist/apis/automation.cjs +6 -6
  17. package/dist/apis/automation.js +1 -1
  18. package/dist/apis/billing.cjs +6 -6
  19. package/dist/apis/billing.js +1 -1
  20. package/dist/apis/blueprint-manifest.cjs +6 -6
  21. package/dist/apis/blueprint-manifest.js +1 -1
  22. package/dist/apis/calendar.cjs +6 -6
  23. package/dist/apis/calendar.js +1 -1
  24. package/dist/apis/configuration-hub.cjs +6 -6
  25. package/dist/apis/configuration-hub.js +1 -1
  26. package/dist/apis/consent.cjs +6 -6
  27. package/dist/apis/consent.js +1 -1
  28. package/dist/apis/customer-portal.cjs +8 -8
  29. package/dist/apis/customer-portal.d.cts +2 -2
  30. package/dist/apis/customer-portal.d.ts +2 -2
  31. package/dist/apis/customer-portal.js +2 -2
  32. package/dist/apis/dashboard.cjs +6 -6
  33. package/dist/apis/dashboard.js +1 -1
  34. package/dist/apis/data-governance.cjs +6 -6
  35. package/dist/apis/data-governance.js +1 -1
  36. package/dist/apis/deduplication.cjs +6 -6
  37. package/dist/apis/deduplication.js +1 -1
  38. package/dist/apis/design.cjs +6 -6
  39. package/dist/apis/design.js +1 -1
  40. package/dist/apis/document.cjs +6 -6
  41. package/dist/apis/document.js +1 -1
  42. package/dist/apis/email-settings.cjs +6 -6
  43. package/dist/apis/email-settings.js +1 -1
  44. package/dist/apis/email-template.cjs +6 -6
  45. package/dist/apis/email-template.js +1 -1
  46. package/dist/apis/entity-mapping.cjs +6 -6
  47. package/dist/apis/entity-mapping.js +1 -1
  48. package/dist/apis/entity.cjs +6 -6
  49. package/dist/apis/entity.js +1 -1
  50. package/dist/apis/environments.cjs +6 -6
  51. package/dist/apis/environments.js +1 -1
  52. package/dist/apis/event-catalog.cjs +6 -6
  53. package/dist/apis/event-catalog.d.cts +2 -2
  54. package/dist/apis/event-catalog.d.ts +2 -2
  55. package/dist/apis/event-catalog.js +1 -1
  56. package/dist/apis/file.cjs +6 -6
  57. package/dist/apis/file.js +1 -1
  58. package/dist/apis/iban.cjs +6 -6
  59. package/dist/apis/iban.js +1 -1
  60. package/dist/apis/integration-toolkit.cjs +6 -6
  61. package/dist/apis/integration-toolkit.js +1 -1
  62. package/dist/apis/journey.cjs +6 -6
  63. package/dist/apis/journey.js +1 -1
  64. package/dist/apis/kanban.cjs +6 -6
  65. package/dist/apis/kanban.js +1 -1
  66. package/dist/apis/message.cjs +6 -6
  67. package/dist/apis/message.js +1 -1
  68. package/dist/apis/metering.cjs +6 -6
  69. package/dist/apis/metering.js +1 -1
  70. package/dist/apis/notes.cjs +6 -6
  71. package/dist/apis/notes.js +1 -1
  72. package/dist/apis/notification.cjs +6 -6
  73. package/dist/apis/notification.js +1 -1
  74. package/dist/apis/organization.cjs +6 -6
  75. package/dist/apis/organization.js +1 -1
  76. package/dist/apis/partner-directory.cjs +6 -6
  77. package/dist/apis/partner-directory.js +1 -1
  78. package/dist/apis/permissions.cjs +6 -6
  79. package/dist/apis/permissions.js +1 -1
  80. package/dist/apis/pricing-tier.cjs +6 -6
  81. package/dist/apis/pricing-tier.js +1 -1
  82. package/dist/apis/pricing.cjs +6 -6
  83. package/dist/apis/pricing.js +1 -1
  84. package/dist/apis/purpose.cjs +6 -6
  85. package/dist/apis/purpose.js +1 -1
  86. package/dist/apis/query.cjs +6 -6
  87. package/dist/apis/query.js +1 -1
  88. package/dist/apis/sandbox.cjs +6 -6
  89. package/dist/apis/sandbox.js +1 -1
  90. package/dist/apis/sharing.cjs +6 -6
  91. package/dist/apis/sharing.js +1 -1
  92. package/dist/apis/snapshot.cjs +6 -6
  93. package/dist/apis/snapshot.js +1 -1
  94. package/dist/apis/submission.cjs +6 -6
  95. package/dist/apis/submission.js +1 -1
  96. package/dist/apis/target.cjs +6 -6
  97. package/dist/apis/target.js +1 -1
  98. package/dist/apis/targeting.cjs +6 -6
  99. package/dist/apis/targeting.js +1 -1
  100. package/dist/apis/template-variables.cjs +6 -6
  101. package/dist/apis/template-variables.js +1 -1
  102. package/dist/apis/user.cjs +6 -6
  103. package/dist/apis/user.js +1 -1
  104. package/dist/apis/validation-rules.cjs +6 -6
  105. package/dist/apis/validation-rules.js +1 -1
  106. package/dist/apis/webhooks.cjs +6 -6
  107. package/dist/apis/webhooks.js +1 -1
  108. package/dist/apis/workflow-definition.cjs +6 -6
  109. package/dist/apis/workflow-definition.js +1 -1
  110. package/dist/apis/workflow.cjs +6 -6
  111. package/dist/apis/workflow.js +1 -1
  112. package/dist/{chunk-XGCTJYBW.cjs → chunk-64QQ2WEY.cjs} +3 -3
  113. package/dist/chunk-6HJ2Y7DZ.js +14 -0
  114. package/dist/chunk-BFMY2X2J.cjs +14 -0
  115. package/dist/{chunk-FOGUF2AK.js → chunk-ZALT2KZ3.js} +3 -3
  116. package/dist/customer-portal-6I3G44I4.cjs +7 -0
  117. package/dist/customer-portal-PTVGKDUH.js +7 -0
  118. package/dist/{customer-portal-runtime-VRGCSOVU.cjs → customer-portal-runtime-4ACQGDNY.cjs} +2 -2
  119. package/dist/{customer-portal-runtime-NRIQG6IO.js → customer-portal-runtime-E4RI7NYM.js} +1 -1
  120. package/dist/{customer-portal.d-fWVl8_mE.d.cts → customer-portal.d-Bpc-wk9K.d.cts} +140 -12
  121. package/dist/{customer-portal.d-fWVl8_mE.d.ts → customer-portal.d-Bpc-wk9K.d.ts} +140 -12
  122. package/dist/event-catalog-6ZSSF5JU.cjs +7 -0
  123. package/dist/event-catalog-RS4LJMY2.js +7 -0
  124. package/dist/{event-catalog.d-CXbUn8T1.d.cts → event-catalog.d-QIhhewVH.d.cts} +153 -3
  125. package/dist/{event-catalog.d-CXbUn8T1.d.ts → event-catalog.d-QIhhewVH.d.ts} +153 -3
  126. package/dist/index.cjs +10 -10
  127. package/dist/index.d.cts +2 -2
  128. package/dist/index.d.ts +2 -2
  129. package/dist/index.js +2 -2
  130. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  131. package/docs/customer-portal.md +86 -21
  132. package/docs/event-catalog.md +90 -5
  133. package/package.json +11 -12
  134. package/definitions/focus-pocus-runtime.json +0 -1
  135. package/definitions/focus-pocus.json +0 -757
  136. package/dist/chunk-4H2KIKGL.cjs +0 -14
  137. package/dist/chunk-COASF7ZR.js +0 -14
  138. package/dist/customer-portal-F45XWLIO.cjs +0 -7
  139. package/dist/customer-portal-MYNJZ4OW.js +0 -7
  140. package/dist/event-catalog-3YOQ46ZW.js +0 -7
  141. package/dist/event-catalog-HLWUT7RM.cjs +0 -7
@@ -1 +1 @@
1
- {"s":"https://customer-portal-api.sls.epilot.io","o":[["upsertPortal","post","/v2/portal/portal",[["origin","q",true],["portal_id","q"]],1],["createUser","post","/v2/portal/public/user",[["origin","q",true]],1],["createUserV3","post","/v3/portal/public/user",[["portal_id","q"],["domain","q"]],1],["validateToken","post","/v2/portal/token/validate"],["revokeToken","post","/v2/portal/token/revoke",null,1],["getPortalConfigByDomain","get","/v2/portal/public/config",[["domain","q",true]]],["getPortalConfig","get","/v2/portal/config",[["origin","q"]]],["deletePortal","delete","/v2/portal/config",[["origin","q",true]]],["createExport","post","/v1/portal/exports",[["language","q"]]],["getExport","get","/v1/portal/exports/{jobId}",[["jobId","p",true]]],["getPortalExtensions","get","/v2/portal/extensions",[["origin","q"]]],["getPublicPortalExtensionDetails","get","/v2/portal/public/extensions",[["org_id","q",true],["origin","q",true]]],["getPortalExtensionsV3","get","/v3/portal/extensions",[["portal_id","q",true]]],["getPublicPortalExtensionDetailsV3","get","/v3/portal/public/extensions",[["org_id","q"],["portal_id","q"],["domain","q"]]],["getConsumption","get","/v2/portal/consumption",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["prepareVisualizationExport","post","/v2/portal/visualization:export",null,1],["getVisualizationMetadata","get","/v2/portal/visualization/metadata",[["app_id","q",true],["extensionId","q",true],["context_entities","q"]]],["getCosts","get","/v2/portal/costs",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getPrices","get","/v2/portal/prices",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getExternalLinks","get","/v2/portal/external-links",[["origin","q"],["contactId","q"]]],["getResolvedExternalLink","get","/v2/portal/resolve:external-link/{id}",[["id","p",true],["origin","q"],["contactId","q"]]],["getExternalLinksV3","get","/v3/portal/external-links",[["portal_id","q"],["contactId","q"]]],["getResolvedExternalLinkV3","get","/v3/portal/resolve:external-link/{id}",[["id","p",true],["portal_id","q"],["contactId","q"]]],["getResolvedSeamlessLink","get","/v2/portal/resolve:seamless-link",[["app_id","q"],["extension_id","q",true],["link_id","q",true],["context_entities","q"]]],["getPublicPortalConfig","get","/v2/portal/public/portal/config",[["org_id","q",true],["origin","q",true]]],["getOrgPortalConfig","get","/v2/portal/org/portal/config",[["origin","q",true]]],["getPublicPortalConfigV3","get","/v3/portal/public/portal/config",[["org_id","q",true],["portal_id","q",true]]],["getOrgPortalConfigV3","get","/v3/portal/org/portal/config",[["portal_id","q",true]]],["getAllPortalConfigs","get","/v2/portal/configs"],["upsertEmailTemplates","post","/v2/portal/email-templates",[["origin","q",true]],1],["getEmailTemplates","get","/v2/portal/email-templates",[["origin","q",true]]],["migrateEmailTemplateReferences","post","/v3/portal/email-templates:migrate-references",null,1],["listEmailTemplateReferences","post","/v3/portal/email-templates:list-references",null,1],["upsertEmailTemplatesByPortalId","post","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]],1],["getEmailTemplatesByPortalId","get","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]]],["getPublicPortalWidgets","get","/v2/portal/public-widgets",[["org_id","q",true],["origin","q",true]]],["getPublicPortalWidgetsV3","get","/v3/portal/public/widgets",[["org_id","q"],["portal_id","q"],["domain","q"]]],["upsertPortalWidget","post","/v2/portal/widgets",[["origin","q",true]],1],["getPortalWidgets","get","/v2/portal/widgets",[["origin","q"],["contract_id","q"]]],["getPortalWidgetsV3","get","/v3/portal/widgets",[["portal_id","q",true],["contract_id","q"]]],["upsertPortalWidgetV3","post","/v3/portal/widgets",[["portal_id","q",true]],1],["savePortalFilesV3","post","/v3/portal/portal/files",[["portal_id","q",true]],1],["replaceECPTemplateVariables","post","/v2/portal/replace-ecp-template-variables",null,1],["getOrganizationSettings","get","/v2/portal/org/settings"],["getSchemas","get","/v2/portal/schemas"],["getSchemasByDomain","get","/v2/portal/public/schemas",[["domain","q",true]]],["getPublicSchemasV3","get","/v3/portal/public/schemas",[["org_id","q"],["portal_id","q"],["domain","q"]]],["getOrganizationSettingsByDomain","get","/v2/portal/public/org/settings",[["domain","q",true]]],["extraPermissionAttributes","get","/v2/portal/extra-permission-attributes"],["validateCaaRecords","post","/v2/portal/validate/caa-records",[["origin","q",true]]],["validateCaaRecordsV3","post","/v3/portal/validate/caa-records",[["portal_id","q",true]]],["getContact","get","/v2/portal/contact"],["updateContact","patch","/v2/portal/contact",null,1],["getECPContact","get","/v2/portal/ecp/contact",[["id","q",true]]],["checkContactExists","post","/v2/portal/public/contact/exists",[["origin","q",true]],1],["checkContactExistsV3","post","/v3/portal/public/contact/exists",[["portal_id","q"],["domain","q"]],1],["checkAccountExists","post","/v3/portal/public/account/exists",[["portal_id","q"],["domain","q"]],1],["getValidSecondaryAttributes","get","/v2/portal/contact/valid/secondary/attributes"],["getPortalUser","get","/v2/portal/user"],["updatePortalUser","patch","/v2/portal/user",null,1],["deletePortalUser","delete","/v2/portal/user"],["updatePortalUserEmail","put","/v2/portal/user/update/email",null,1],["changePortalUserPassword","put","/v2/portal/user/change/password",null,1],["resendConfirmationEmail","post","/v2/portal/user/resend/confirmation-email/{id}",[["id","p",true]]],["fetchPortalUsersByRelatedEntity","get","/v2/portal/users/by-related-entity",[["entity_id","q",true],["slug","q",true]]],["confirmUser","get","/v2/portal/user/confirm",[["confirmation_link_token","q",true],["use_redirect","q"]]],["confirmUserWithUserId","get","/v2/portal/user/confirm/{id}",[["origin","q",true],["id","p",true],["org_id","q",true]]],["userExists","get","/v2/portal/public/user/exists",[["email","q",true],["org_id","q",true],["origin","q"]]],["userExistsV3","get","/v3/portal/public/user/exists",[["email","q",true],["org_id","q"],["portal_id","q"],["domain","q"]]],["getRecipientsToNotifyOnAutomation","post","/v2/portal/recipients-to-notify",null,1],["configureDistribution","get","/v2/portal/configure-distribution",[["origin","q",true]]],["configureDistributionV3","get","/v3/portal/configure-distribution",[["portal_id","q",true]]],["getAllOrders","get","/v2/portal/order",[["from","q"],["size","q"]]],["postOrderAcceptance","post","/v2/portal/order/{id}/acceptance",[["id","p",true]],1],["getOrder","get","/v2/portal/order/{id}",[["id","p",true]]],["updateOrder","patch","/v2/portal/order/{id}",[["id","p",true]],1],["getAllOpportunities","get","/v2/portal/opportunity",[["from","q"],["size","q"]]],["getSearchableAttributesForOpportunities","get","/v2/portal/opportunities/searchable-attributes",[["from","q"],["size","q"]]],["getSearchResultsForOpportunities","post","/v2/portal/opportunities/search",[["from","q"],["size","q"]],1],["getOpportunity","get","/v2/portal/opportunities/{id}",[["id","p",true]]],["updateOpportunity","patch","/v2/portal/opportunities/{id}",[["id","p",true]],1],["getAllRequests","get","/v2/portal/request",[["from","q"],["size","q"]]],["getAllContracts","get","/v2/portal/contract",[["from","q"],["size","q"]]],["getContract","get","/v2/portal/contract/{id}",[["id","p",true]]],["updateContract","patch","/v2/portal/contract/{id}",[["id","p",true]],1],["addContractByIdentifiers","post","/v2/portal/contract/by-identifiers",null,1],["getEntityIdentifiers","get","/v2/portal/entity/identifiers/{slug}",[["slug","p",true]]],["getEntityActivityFeed","get","/v2/portal/entity/{slug}/{id}/activity",[["slug","p",true],["id","p",true],["after","q"],["before","q"],["from","q"],["size","q"],["type","q"],["include_relations","q"]]],["validateCadenceEntityEditRules","get","/v2/portal/{slug}/{id}:validateRule",[["slug","p",true],["id","p",true],["attribute","q"]]],["searchPaymentRelationsInEntities","get","/v2/portal/entities-by-payment/{id}",[["id","p",true]]],["createCustomEntityActivity","put","/v2/portal/entity/activity",[["entities","q",false,"form"]],1],["saveEntityFile","post","/v2/portal/entity/file",null,1],["deleteEntityFile","delete","/v2/portal/entity/file",null,1],["savePortalFiles","post","/v2/portal/portal/files",null,1],["getRegistrationIdentifiers","get","/v2/portal/registration/identifiers"],["getAllFiles","get","/v2/portal/user/files",[["from","q",true],["size","q",true],["entity_ids","q"],["file_types","q"]]],["getFileById","get","/v2/portal/user/file/{id}",[["id","p",true]]],["trackFileDownloaded","post","/v2/portal/user/file/{id}/downloaded",[["id","p",true]]],["getFilesCountByEntity","get","/v2/portal/user/files/count-by-entity"],["getBillingEvents","get","/v2/portal/billing/events",[["from","q"],["size","q"],["entity_id","q"],["event_type","q"],["paid","q"],["date_after","q"],["date_before","q"],["sort","q"]]],["getCustomerBalance","get","/v2/portal/billing/customers/balance"],["getBillingAccount","get","/v2/portal/billing/accounts/{id}"],["loginToPortalAsUser","post","/v2/portal/admin:login-as-user",null,1],["triggerEntityAccessEvent","post","/v2/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["origin","q",true]]],["triggerEntityAccessEventV3","post","/v3/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["portal_id","q"],["domain","q"]]],["getPortalUserEntity","post","/v2/portal/entity:get",null,1],["searchPortalUserEntities","post","/v2/portal/entity:search",null,1],["createPortalUserEntity","post","/v2/portal/entity/{slug}",[["slug","p",true]],1],["patchPortalUserEntity","patch","/v2/portal/entity/{slug}/{id}",[["slug","p",true],["id","p",true]],1],["canTriggerPortalFlow","post","/v2/portal/can-trigger-portal-flow",[["origin","q"],["portal_id","q",true]],1],["getAutomationContext","get","/v2/portal/automation-context",[["activity_id","q",true],["type","q",true]]],["updateWorkflowStepAsDone","put","/v2/portal/workflow/{workflow_id}/{step_id}:markDone",[["workflow_id","p",true],["step_id","p",true]]],["getEntityWorkflows","get","/v2/portal/entity/{slug}/{id}/workflows",[["slug","p",true],["id","p",true]]],["uploadMeterReadingPhoto","post","/v2/portal/metering/reading/photo",null,1],["createMeterReading","post","/v2/portal/metering/reading",[["override_plausibility","q"]],1],["getAllowedMeterReadingRange","get","/v2/portal/metering/reading/allowed-range/{meter_id}",[["meter_id","p",true],["origin","q"],["timestamp","q"],["context_entities","q"]]],["getMeterReadings","post","/v2/portal/metering/readings",null,1],["getSSOProvider","get","/v2/portal/public/sso/providers/{provider_slug}",[["provider_slug","p",true],["org_id","q"],["origin","q"],["portal_id","q"],["domain","q"]]],["ssoLogin","post","/v2/portal/public/sso/login",[["origin","q",true],["org_id","q",true],["contact_id","q"]],1],["ssoLoginV3","post","/v3/portal/public/sso/login",[["portal_id","q"],["org_id","q"],["domain","q"],["contact_id","q"]],1],["ssoRedirect","post","/v2/portal/public/sso/redirect",[["web_uri","q",true]],1],["ssoCallback","post","/v2/portal/public/sso/callback",[["domain","q"]],1],["getPortalPage","get","/v2/portal/pages/{id}"],["updatePortalPage","put","/v2/portal/pages/{id}",null,1],["deletePortalPage","delete","/v2/portal/pages/{id}"],["getPortalPages","get","/v2/portal/pages",[["fields","q"],["filter","q"],["contract_id","q"],["context_entities","q"]]],["createPortalPage","post","/v2/portal/pages",null,1],["getPublicPages","get","/v2/portal/public/pages",[["domain","q",true],["fields","q"],["filter","q"]]],["interpolatePortalPages","post","/v2/portal/pages/interpolate",null,1],["getTriggeredJourney","get","/v2/portal/config/triggered-journeys/{trigger_name}",[["context_entities","q"]]],["getDefaultPages","get","/v2/portal/pages/default"],["createPortalPageBlock","post","/v2/portal/pages/{id}/blocks",null,1],["getPortalPageBlocks","get","/v2/portal/pages/{id}/blocks"],["getPortalPageBlock","get","/v2/portal/pages/{id}/blocks/{block_id}"],["updatePortalPageBlock","put","/v2/portal/pages/{id}/blocks/{block_id}",null,1],["deletePortalPageBlock","delete","/v2/portal/pages/{id}/blocks/{block_id}"],["getUserEntryPoint","get","/v2/portal/public/user/entry-point",[["email","q",true],["domain","q",true]]],["updateCampaignPortalBlockStatus","put","/v2/portal/campaign/{campaign_id}/entity:status",[["campaign_id","p",true]],1],["updateNotificationsStatus","put","/v2/portal/notifications/entity:status",null,1],["deRegisterMLoginUser","delete","/v2/portal/public/m-login/deregister/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]]],["notifyMLoginInterestChange","post","/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]],1],["createPortalConfig","post","/v3/portal/config",null,1],["getPortalConfigV3","get","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["putPortalConfig","put","/v3/portal/config/{portal_id}",[["portal_id","p",true],["page_upsert_mode","q"]],1],["deletePortalConfig","delete","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["listAllPortalConfigs","get","/v3/portal/configs"],["swapPortalConfig","post","/v3/portal/config/swap",null,1],["clonePortalConfig","post","/v3/portal/config/clone",null,1],["invitePartner","post","/v3/portal/partner/invite",null,1],["listBusinessPartners","get","/v3/portal/partner/list"],["resendPartnerInvitation","post","/v3/portal/partner/{partner_id}/resend-invitation",[["partner_id","p",true]]],["revokePartner","delete","/v3/portal/partner/{partner_id}/revoke",[["partner_id","p",true]]],["disablePartner","post","/v3/portal/partner/{partner_id}/disable",[["partner_id","p",true]]],["enablePartner","post","/v3/portal/partner/{partner_id}/enable",[["partner_id","p",true]]],["verifyDns","post","/v3/portal/verify-dns",[["portal_id","q",true]]],["portalProxyExecute","post","/v2/portal/proxy/execute",null,1],["getMobileConfig","get","/v1/portal/mobile-config",[["portal_id","q",true],["raw","q"]]],["putMobileConfig","put","/v1/portal/mobile-config",[["portal_id","q",true]],1]],"v":"3.0.3","pp":{"/v2/portal/billing/accounts/{id}":[["id","p",true]],"/v2/portal/pages/{id}":[["id","p",true]],"/v2/portal/pages":[["domain","q",true]],"/v2/portal/config/triggered-journeys/{trigger_name}":[["trigger_name","p",true]],"/v2/portal/pages/{id}/blocks":[["id","p",true]],"/v2/portal/pages/{id}/blocks/{block_id}":[["id","p",true],["block_id","p",true]]}}
1
+ {"s":"https://customer-portal-api.sls.epilot.io","o":[["upsertPortal","post","/v2/portal/portal",[["origin","q",true],["portal_id","q"]],1],["createUser","post","/v2/portal/public/user",[["origin","q",true]],1],["createUserV3","post","/v3/portal/public/user",[["portal_id","q"],["domain","q"]],1],["validateToken","post","/v2/portal/token/validate"],["revokeToken","post","/v2/portal/token/revoke",null,1],["getPortalConfigByDomain","get","/v2/portal/public/config",[["domain","q",true]]],["getPortalConfig","get","/v2/portal/config",[["origin","q"]]],["deletePortal","delete","/v2/portal/config",[["origin","q",true]]],["createExport","post","/v1/portal/exports",null,1],["getExport","get","/v1/portal/exports/{jobId}",[["jobId","p",true]]],["getPortalExtensions","get","/v2/portal/extensions",[["origin","q"]]],["getPublicPortalExtensionDetails","get","/v2/portal/public/extensions",[["org_id","q",true],["origin","q",true]]],["getPortalExtensionsV3","get","/v3/portal/extensions",[["portal_id","q",true]]],["getPublicPortalExtensionDetailsV3","get","/v3/portal/public/extensions",[["org_id","q"],["portal_id","q"],["domain","q"]]],["getConsumption","get","/v2/portal/consumption",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["prepareVisualizationExport","post","/v2/portal/visualization:export",null,1],["getVisualizationMetadata","get","/v2/portal/visualization/metadata",[["app_id","q",true],["extensionId","q",true],["context_entities","q"]]],["getCosts","get","/v2/portal/costs",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getPrices","get","/v2/portal/prices",[["app_id","q"],["extensionId","q",true],["hookId","q"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getExternalLinks","get","/v2/portal/external-links",[["origin","q"],["contactId","q"]]],["getResolvedExternalLink","get","/v2/portal/resolve:external-link/{id}",[["id","p",true],["origin","q"],["contactId","q"]]],["getExternalLinksV3","get","/v3/portal/external-links",[["portal_id","q"],["contactId","q"]]],["getResolvedExternalLinkV3","get","/v3/portal/resolve:external-link/{id}",[["id","p",true],["portal_id","q"],["contactId","q"]]],["getResolvedSeamlessLink","get","/v2/portal/resolve:seamless-link",[["app_id","q"],["extension_id","q",true],["link_id","q",true],["context_entities","q"]]],["getPublicPortalConfig","get","/v2/portal/public/portal/config",[["org_id","q",true],["origin","q",true]]],["getOrgPortalConfig","get","/v2/portal/org/portal/config",[["origin","q",true]]],["getPublicPortalConfigV3","get","/v3/portal/public/portal/config",[["org_id","q",true],["portal_id","q",true]]],["getOrgPortalConfigV3","get","/v3/portal/org/portal/config",[["portal_id","q",true]]],["getAllPortalConfigs","get","/v2/portal/configs"],["upsertEmailTemplates","post","/v2/portal/email-templates",[["origin","q",true]],1],["getEmailTemplates","get","/v2/portal/email-templates",[["origin","q",true]]],["migrateEmailTemplateReferences","post","/v3/portal/email-templates:migrate-references",null,1],["listEmailTemplateReferences","post","/v3/portal/email-templates:list-references",null,1],["upsertEmailTemplatesByPortalId","post","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]],1],["getEmailTemplatesByPortalId","get","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]]],["getPublicPortalWidgets","get","/v2/portal/public-widgets",[["org_id","q",true],["origin","q",true]]],["getPublicPortalWidgetsV3","get","/v3/portal/public/widgets",[["org_id","q"],["portal_id","q"],["domain","q"]]],["upsertPortalWidget","post","/v2/portal/widgets",[["origin","q",true]],1],["getPortalWidgets","get","/v2/portal/widgets",[["origin","q"],["contract_id","q"]]],["getPortalWidgetsV3","get","/v3/portal/widgets",[["portal_id","q",true],["contract_id","q"]]],["upsertPortalWidgetV3","post","/v3/portal/widgets",[["portal_id","q",true]],1],["savePortalFilesV3","post","/v3/portal/portal/files",[["portal_id","q",true]],1],["replaceECPTemplateVariables","post","/v2/portal/replace-ecp-template-variables",null,1],["getOrganizationSettings","get","/v2/portal/org/settings"],["getSchemas","get","/v2/portal/schemas"],["getSchemasByDomain","get","/v2/portal/public/schemas",[["domain","q",true]]],["getPublicSchemasV3","get","/v3/portal/public/schemas",[["org_id","q"],["portal_id","q"],["domain","q"]]],["getOrganizationSettingsByDomain","get","/v2/portal/public/org/settings",[["domain","q",true]]],["extraPermissionAttributes","get","/v2/portal/extra-permission-attributes"],["validateCaaRecords","post","/v2/portal/validate/caa-records",[["origin","q",true]]],["validateCaaRecordsV3","post","/v3/portal/validate/caa-records",[["portal_id","q",true]]],["getContact","get","/v2/portal/contact"],["updateContact","patch","/v2/portal/contact",null,1],["getECPContact","get","/v2/portal/ecp/contact",[["id","q",true]]],["checkContactExists","post","/v2/portal/public/contact/exists",[["origin","q",true]],1],["checkContactExistsV3","post","/v3/portal/public/contact/exists",[["portal_id","q"],["domain","q"]],1],["checkAccountExists","post","/v3/portal/public/account/exists",[["portal_id","q"],["domain","q"]],1],["getValidSecondaryAttributes","get","/v2/portal/contact/valid/secondary/attributes"],["getPortalUser","get","/v2/portal/user"],["updatePortalUser","patch","/v2/portal/user",null,1],["deletePortalUser","delete","/v2/portal/user"],["updatePortalUserEmail","put","/v2/portal/user/update/email",null,1],["changePortalUserPassword","put","/v2/portal/user/change/password",null,1],["resendConfirmationEmail","post","/v2/portal/user/resend/confirmation-email/{id}",[["id","p",true]]],["fetchPortalUsersByRelatedEntity","get","/v2/portal/users/by-related-entity",[["entity_id","q",true],["slug","q",true]]],["confirmUser","get","/v2/portal/user/confirm",[["confirmation_link_token","q",true],["use_redirect","q"]]],["confirmUserWithUserId","get","/v2/portal/user/confirm/{id}",[["origin","q",true],["id","p",true],["org_id","q",true]]],["userExists","get","/v2/portal/public/user/exists",[["email","q",true],["org_id","q",true],["origin","q"]]],["userExistsV3","get","/v3/portal/public/user/exists",[["email","q",true],["org_id","q"],["portal_id","q"],["domain","q"]]],["getRecipientsToNotifyOnAutomation","post","/v2/portal/recipients-to-notify",null,1],["configureDistribution","get","/v2/portal/configure-distribution",[["origin","q",true]]],["configureDistributionV3","get","/v3/portal/configure-distribution",[["portal_id","q",true]]],["getAllOrders","get","/v2/portal/order",[["from","q"],["size","q"]]],["postOrderAcceptance","post","/v2/portal/order/{id}/acceptance",[["id","p",true]],1],["getOrder","get","/v2/portal/order/{id}",[["id","p",true]]],["updateOrder","patch","/v2/portal/order/{id}",[["id","p",true]],1],["getAllOpportunities","get","/v2/portal/opportunity",[["from","q"],["size","q"]]],["getSearchableAttributesForOpportunities","get","/v2/portal/opportunities/searchable-attributes",[["from","q"],["size","q"]]],["getSearchResultsForOpportunities","post","/v2/portal/opportunities/search",[["from","q"],["size","q"]],1],["getOpportunity","get","/v2/portal/opportunities/{id}",[["id","p",true]]],["updateOpportunity","patch","/v2/portal/opportunities/{id}",[["id","p",true]],1],["getAllRequests","get","/v2/portal/request",[["from","q"],["size","q"]]],["getAllContracts","get","/v2/portal/contract",[["from","q"],["size","q"]]],["getContract","get","/v2/portal/contract/{id}",[["id","p",true]]],["updateContract","patch","/v2/portal/contract/{id}",[["id","p",true]],1],["addContractByIdentifiers","post","/v2/portal/contract/by-identifiers",null,1],["getEntityIdentifiers","get","/v2/portal/entity/identifiers/{slug}",[["slug","p",true]]],["getEntityActivityFeed","get","/v2/portal/entity/{slug}/{id}/activity",[["slug","p",true],["id","p",true],["after","q"],["before","q"],["from","q"],["size","q"],["type","q"],["include_relations","q"]]],["validateCadenceEntityEditRules","get","/v2/portal/{slug}/{id}:validateRule",[["slug","p",true],["id","p",true],["attribute","q"]]],["searchPaymentRelationsInEntities","get","/v2/portal/entities-by-payment/{id}",[["id","p",true]]],["createCustomEntityActivity","put","/v2/portal/entity/activity",[["entities","q",false,"form"]],1],["saveEntityFile","post","/v2/portal/entity/file",null,1],["deleteEntityFile","delete","/v2/portal/entity/file",null,1],["savePortalFiles","post","/v2/portal/portal/files",null,1],["getRegistrationIdentifiers","get","/v2/portal/registration/identifiers"],["getAllFiles","get","/v2/portal/user/files",[["from","q",true],["size","q",true],["entity_ids","q"],["file_types","q"]]],["getFileById","get","/v2/portal/user/file/{id}",[["id","p",true]]],["trackFileDownloaded","post","/v2/portal/user/file/{id}/downloaded",[["id","p",true]]],["getFilesCountByEntity","get","/v2/portal/user/files/count-by-entity"],["getBillingEvents","get","/v2/portal/billing/events",[["from","q"],["size","q"],["entity_id","q"],["event_type","q"],["paid","q"],["date_after","q"],["date_before","q"],["sort","q"]]],["getCustomerBalance","get","/v2/portal/billing/customers/balance"],["getBillingAccount","get","/v2/portal/billing/accounts/{id}"],["loginToPortalAsUser","post","/v2/portal/admin:login-as-user",null,1],["triggerEntityAccessEvent","post","/v2/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["origin","q",true]]],["triggerEntityAccessEventV3","post","/v3/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["portal_id","q"],["domain","q"]]],["getPortalUserEntity","post","/v2/portal/entity:get",null,1],["searchPortalUserEntities","post","/v2/portal/entity:search",null,1],["createPortalUserEntity","post","/v2/portal/entity/{slug}",[["slug","p",true]],1],["patchPortalUserEntity","patch","/v2/portal/entity/{slug}/{id}",[["slug","p",true],["id","p",true]],1],["canTriggerPortalFlow","post","/v2/portal/can-trigger-portal-flow",[["origin","q"],["portal_id","q",true]],1],["getAutomationContext","get","/v2/portal/automation-context",[["activity_id","q",true],["type","q",true]]],["updateWorkflowStepAsDone","put","/v2/portal/workflow/{workflow_id}/{step_id}:markDone",[["workflow_id","p",true],["step_id","p",true]]],["getEntityWorkflows","get","/v2/portal/entity/{slug}/{id}/workflows",[["slug","p",true],["id","p",true]]],["uploadMeterReadingPhoto","post","/v2/portal/metering/reading/photo",null,1],["createMeterReading","post","/v2/portal/metering/reading",[["override_plausibility","q"]],1],["getAllowedMeterReadingRange","get","/v2/portal/metering/reading/allowed-range/{meter_id}",[["meter_id","p",true],["origin","q"],["timestamp","q"],["context_entities","q"]]],["getMeterReadings","post","/v2/portal/metering/readings",null,1],["getSSOProvider","get","/v2/portal/public/sso/providers/{provider_slug}",[["provider_slug","p",true],["org_id","q"],["origin","q"],["portal_id","q"],["domain","q"]]],["ssoLogin","post","/v2/portal/public/sso/login",[["origin","q",true],["org_id","q",true],["contact_id","q"]],1],["ssoLoginV3","post","/v3/portal/public/sso/login",[["portal_id","q"],["org_id","q"],["domain","q"],["contact_id","q"]],1],["ssoRedirect","post","/v2/portal/public/sso/redirect",[["web_uri","q",true]],1],["ssoCallback","post","/v2/portal/public/sso/callback",[["domain","q"]],1],["getPortalPage","get","/v2/portal/pages/{id}"],["updatePortalPage","put","/v2/portal/pages/{id}",null,1],["deletePortalPage","delete","/v2/portal/pages/{id}"],["getPortalPages","get","/v2/portal/pages",[["fields","q"],["filter","q"],["contract_id","q"],["context_entities","q"]]],["createPortalPage","post","/v2/portal/pages",null,1],["getPublicPages","get","/v2/portal/public/pages",[["domain","q",true],["fields","q"],["filter","q"]]],["interpolatePortalPages","post","/v2/portal/pages/interpolate",null,1],["getTriggeredJourney","get","/v2/portal/config/triggered-journeys/{trigger_name}",[["context_entities","q"]]],["getDefaultPages","get","/v2/portal/pages/default"],["createPortalPageBlock","post","/v2/portal/pages/{id}/blocks",null,1],["getPortalPageBlocks","get","/v2/portal/pages/{id}/blocks"],["getPortalPageBlock","get","/v2/portal/pages/{id}/blocks/{block_id}"],["updatePortalPageBlock","put","/v2/portal/pages/{id}/blocks/{block_id}",null,1],["deletePortalPageBlock","delete","/v2/portal/pages/{id}/blocks/{block_id}"],["getUserEntryPoint","get","/v2/portal/public/user/entry-point",[["email","q",true],["domain","q",true]]],["updateCampaignPortalBlockStatus","put","/v2/portal/campaign/{campaign_id}/entity:status",[["campaign_id","p",true]],1],["updateNotificationsStatus","put","/v2/portal/notifications/entity:status",null,1],["deRegisterMLoginUser","delete","/v2/portal/public/m-login/deregister/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]]],["notifyMLoginInterestChange","post","/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]],1],["createPortalConfig","post","/v3/portal/config",null,1],["getPortalConfigV3","get","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["putPortalConfig","put","/v3/portal/config/{portal_id}",[["portal_id","p",true],["page_upsert_mode","q"]],1],["deletePortalConfig","delete","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["listAllPortalConfigs","get","/v3/portal/configs"],["swapPortalConfig","post","/v3/portal/config/swap",null,1],["clonePortalConfig","post","/v3/portal/config/clone",null,1],["invitePartner","post","/v3/portal/partner/invite",null,1],["listBusinessPartners","get","/v3/portal/partner/list"],["resendPartnerInvitation","post","/v3/portal/partner/{partner_id}/resend-invitation",[["partner_id","p",true]]],["revokePartner","delete","/v3/portal/partner/{partner_id}/revoke",[["partner_id","p",true]]],["disablePartner","post","/v3/portal/partner/{partner_id}/disable",[["partner_id","p",true]]],["enablePartner","post","/v3/portal/partner/{partner_id}/enable",[["partner_id","p",true]]],["verifyDns","post","/v3/portal/verify-dns",[["portal_id","q",true]]],["portalProxyExecute","post","/v2/portal/proxy/execute",null,1],["getMobileConfig","get","/v1/portal/mobile-config",[["portal_id","q",true],["raw","q"]]],["putMobileConfig","put","/v1/portal/mobile-config",[["portal_id","q",true]],1]],"v":"3.0.3","pp":{"/v2/portal/billing/accounts/{id}":[["id","p",true]],"/v2/portal/pages/{id}":[["id","p",true]],"/v2/portal/pages":[["domain","q",true]],"/v2/portal/config/triggered-journeys/{trigger_name}":[["trigger_name","p",true]],"/v2/portal/pages/{id}/blocks":[["id","p",true]],"/v2/portal/pages/{id}/blocks/{block_id}":[["id","p",true],["block_id","p",true]]}}
@@ -484,25 +484,75 @@
484
484
  "post": {
485
485
  "operationId": "createExport",
486
486
  "summary": "createExport",
487
- "description": "Request an asynchronous CSV export of the portal user's contracts, delivery points and meters. Returns a job id to poll.",
487
+ "description": "Request an asynchronous CSV export of the portal user's entities for one schema. Columns come from the request Returns a job id to poll.\n",
488
488
  "tags": [
489
489
  "ECP"
490
490
  ],
491
- "parameters": [
492
- {
493
- "in": "query",
494
- "name": "language",
495
- "required": false,
496
- "schema": {
497
- "type": "string",
498
- "enum": [
499
- "de",
500
- "en"
501
- ]
502
- },
503
- "description": "Output language for headers and value formatting. Defaults to German when omitted or unsupported."
491
+ "requestBody": {
492
+ "required": true,
493
+ "content": {
494
+ "application/json": {
495
+ "schema": {
496
+ "type": "object",
497
+ "required": [
498
+ "schema",
499
+ "columns"
500
+ ],
501
+ "properties": {
502
+ "schema": {
503
+ "type": "string",
504
+ "description": "Entity schema to export (must be an allowed portal entity)."
505
+ },
506
+ "search": {
507
+ "type": "object",
508
+ "description": "Search parameters, same shape the entity list queries with.",
509
+ "properties": {
510
+ "q": {
511
+ "type": "string"
512
+ },
513
+ "q_fields": {
514
+ "type": "array",
515
+ "items": {
516
+ "type": "string"
517
+ }
518
+ },
519
+ "filters": {
520
+ "type": "array",
521
+ "items": {
522
+ "type": "object"
523
+ }
524
+ },
525
+ "filters_context": {
526
+ "type": "array",
527
+ "items": {
528
+ "type": "object"
529
+ }
530
+ },
531
+ "sort": {}
532
+ }
533
+ },
534
+ "columns": {
535
+ "type": "array",
536
+ "description": "Ordered column definitions; order is the CSV column order.",
537
+ "items": {
538
+ "$ref": "#/components/schemas/PortalDataExportColumn"
539
+ }
540
+ },
541
+ "expand_over": {
542
+ "type": "string"
543
+ },
544
+ "language": {
545
+ "type": "string",
546
+ "enum": [
547
+ "de",
548
+ "en"
549
+ ]
550
+ }
551
+ }
552
+ }
553
+ }
504
554
  }
505
- ],
555
+ },
506
556
  "security": [
507
557
  {
508
558
  "PortalAuth": []
@@ -540,7 +590,7 @@
540
590
  "$ref": "#/components/responses/Forbidden"
541
591
  },
542
592
  "404": {
543
- "description": "No export profile configured for this organization."
593
+ "description": "Missing or invalid export columns."
544
594
  },
545
595
  "500": {
546
596
  "$ref": "#/components/responses/InternalServerError"
@@ -12013,6 +12063,13 @@
12013
12063
  "type": "boolean",
12014
12064
  "example": true,
12015
12065
  "description": "Require symbols"
12066
+ },
12067
+ "password_history_size": {
12068
+ "type": "integer",
12069
+ "minimum": 0,
12070
+ "maximum": 24,
12071
+ "example": 3,
12072
+ "description": "Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan."
12016
12073
  }
12017
12074
  }
12018
12075
  }
@@ -18207,6 +18264,13 @@
18207
18264
  "type": "boolean",
18208
18265
  "example": true,
18209
18266
  "description": "Require symbols"
18267
+ },
18268
+ "password_history_size": {
18269
+ "type": "integer",
18270
+ "minimum": 0,
18271
+ "maximum": 24,
18272
+ "example": 3,
18273
+ "description": "Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan."
18210
18274
  }
18211
18275
  }
18212
18276
  }
@@ -18523,6 +18587,90 @@
18523
18587
  "description": "ID of the portal",
18524
18588
  "example": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
18525
18589
  },
18590
+ "PortalDataExportColumn": {
18591
+ "type": "object",
18592
+ "description": "One column of the portal data export CSV.",
18593
+ "required": [
18594
+ "key",
18595
+ "header",
18596
+ "source"
18597
+ ],
18598
+ "properties": {
18599
+ "key": {
18600
+ "type": "string",
18601
+ "description": "Stable, immutable column id (snake_case). Append-only contract: never rename, reorder semantics, or remove an existing key; new columns are appended.\n",
18602
+ "example": "vertragsnummer"
18603
+ },
18604
+ "header": {
18605
+ "type": "object",
18606
+ "description": "Localized header label, keyed by language (de, en).",
18607
+ "additionalProperties": {
18608
+ "type": "string"
18609
+ },
18610
+ "example": {
18611
+ "de": "Vertragsnummer",
18612
+ "en": "Contract number"
18613
+ }
18614
+ },
18615
+ "source": {
18616
+ "type": "object",
18617
+ "description": "Where the value comes from: relation hops from the anchor entity plus the attribute to read on the resolved entity. An empty path means the anchor itself.\n",
18618
+ "required": [
18619
+ "attribute"
18620
+ ],
18621
+ "properties": {
18622
+ "path": {
18623
+ "type": "array",
18624
+ "description": "Relation hops from the anchor entity (max 3).",
18625
+ "items": {
18626
+ "type": "string"
18627
+ },
18628
+ "example": [
18629
+ "customer"
18630
+ ]
18631
+ },
18632
+ "attribute": {
18633
+ "type": "string",
18634
+ "description": "Attribute to read on the resolved entity.",
18635
+ "example": "customer_number"
18636
+ },
18637
+ "address_field": {
18638
+ "type": "string",
18639
+ "description": "Which part of an address-typed attribute to render.",
18640
+ "enum": [
18641
+ "full",
18642
+ "street",
18643
+ "street_number",
18644
+ "postal_code",
18645
+ "city",
18646
+ "additional_info",
18647
+ "country"
18648
+ ]
18649
+ }
18650
+ }
18651
+ },
18652
+ "formatter": {
18653
+ "type": "string",
18654
+ "enum": [
18655
+ "text",
18656
+ "date",
18657
+ "money_cents",
18658
+ "enum",
18659
+ "address"
18660
+ ]
18661
+ },
18662
+ "enum_labels": {
18663
+ "type": "object",
18664
+ "description": "Localized value maps for the enum formatter, keyed by language then raw value.\n",
18665
+ "additionalProperties": {
18666
+ "type": "object",
18667
+ "additionalProperties": {
18668
+ "type": "string"
18669
+ }
18670
+ }
18671
+ }
18672
+ }
18673
+ },
18526
18674
  "UpsertPortalConfigV3": {
18527
18675
  "allOf": [
18528
18676
  {
@@ -593,6 +593,23 @@
593
593
  "description": "Whether this event can be explicitly triggered by automations.\nWhen true, the event will appear in the automation builder as a\n\"Trigger Event\" action option.\nDefaults to false if not specified.\n",
594
594
  "default": false,
595
595
  "example": true
596
+ },
597
+ "success_criteria": {
598
+ "type": "array",
599
+ "description": "Org-defined success criteria for this event: the entity attributes that an\norganization considers must be captured for an event change request to be\ntreated as complete (e.g. for telephony / self-service flows).\n\nAdvisory metadata — event-catalog does NOT require an org to define any and\ndoes NOT enforce them when an event is triggered or published. The org may\ndefine none (empty array or omitted). When provided, each entry is validated\nfor well-formedness on write (see SuccessCriterion).\n",
600
+ "items": {
601
+ "$ref": "#/components/schemas/SuccessCriterion"
602
+ },
603
+ "example": [
604
+ {
605
+ "entity_schema": "contract",
606
+ "attribute": "installment_amount"
607
+ },
608
+ {
609
+ "entity_schema": "billing_account",
610
+ "attribute": "due_date"
611
+ }
612
+ ]
596
613
  }
597
614
  }
598
615
  },
@@ -613,7 +630,7 @@
613
630
  ]
614
631
  },
615
632
  "UpdateEventPayload": {
616
- "description": "Payload for updating an event configuration.\nAccepts the same fields as EventConfig (all optional for PATCH).\nCurrently `enabled` and `auto_trigger` fields are processed.\n",
633
+ "description": "Payload for updating an event configuration.\nAccepts the same fields as EventConfig (all optional for PATCH).\nCurrently `enabled`, `auto_trigger` and `success_criteria` fields are processed.\n",
617
634
  "allOf": [
618
635
  {
619
636
  "$ref": "#/components/schemas/EventConfigBase"
@@ -696,6 +713,26 @@
696
713
  }
697
714
  ]
698
715
  },
716
+ "SuccessCriterion": {
717
+ "type": "object",
718
+ "description": "A single org-defined success criterion: an entity attribute that must be captured\nfor this event's change request to be considered complete.\n\nIdentity is the entity schema plus the attribute name — mirroring the\nEntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both\n`attribute` and `entity_schema` are required and `entity_schema` must match the\n`schema` of a node in the event's `entity_graph` (else the request is rejected) —\nthis prevents unsatisfiable criteria. The criteria themselves are advisory and are\nnever enforced when an event is triggered or published.\n",
719
+ "properties": {
720
+ "entity_schema": {
721
+ "type": "string",
722
+ "description": "Entity schema slug the attribute belongs to (matches a node schema in the event's entity_graph).",
723
+ "example": "contract"
724
+ },
725
+ "attribute": {
726
+ "type": "string",
727
+ "description": "Attribute name on the entity schema.",
728
+ "example": "installment_amount"
729
+ }
730
+ },
731
+ "required": [
732
+ "entity_schema",
733
+ "attribute"
734
+ ]
735
+ },
699
736
  "CommonEventMetadata": {
700
737
  "type": "object",
701
738
  "description": "Common metadata fields present in all event payloads",
@@ -878,6 +915,24 @@
878
915
  ]
879
916
  }
880
917
  },
918
+ "InlineDowngradeStep": {
919
+ "type": "object",
920
+ "description": "One step of an event's inline `_downgrades` chain. Maps the current-version payload to the previous version via a JSONata expression. Stamped by Event Catalog at publish time; executed by consumers during walk-back, never by EC itself.",
921
+ "properties": {
922
+ "to": {
923
+ "type": "string",
924
+ "description": "Version label this step downgrades to (the previous version)."
925
+ },
926
+ "jsonata": {
927
+ "type": "string",
928
+ "description": "JSONata expression mapping the current-shape payload to the previous-shape payload."
929
+ }
930
+ },
931
+ "required": [
932
+ "to",
933
+ "jsonata"
934
+ ]
935
+ },
881
936
  "Event": {
882
937
  "type": "object",
883
938
  "description": "An event instance in the event history",
@@ -920,6 +975,13 @@
920
975
  "_ack_id": {
921
976
  "type": "string",
922
977
  "description": "Unique acknowledgment tracking ID for the event.\nUsed to track event delivery and processing status.\n"
978
+ },
979
+ "_downgrades": {
980
+ "type": "array",
981
+ "description": "Inline downgrade chain stamped by Event Catalog at publish time, ordered newest-to-oldest. Present ONLY on multi-version events. Internal versioning transport: consumers (e.g. svc-webhooks) walk the payload back to a pinned version using these JSONata steps, then strip the field before delivery -- end customers never receive it.",
982
+ "items": {
983
+ "$ref": "#/components/schemas/InlineDowngradeStep"
984
+ }
923
985
  }
924
986
  },
925
987
  "required": [
@@ -6,25 +6,25 @@ var _chunkS5HBBTKMcjs = require('../chunk-S5HBBTKM.cjs');
6
6
 
7
7
 
8
8
 
9
- var _chunkXGCTJYBWcjs = require('../chunk-XGCTJYBW.cjs');
9
+ var _chunk64QQ2WEYcjs = require('../chunk-64QQ2WEY.cjs');
10
10
  require('../chunk-NJK5F5TF.cjs');
11
11
 
12
12
  // src/apis/access-token.ts
13
13
  var loadDefinition = () => {
14
14
  const mod = _chunkS5HBBTKMcjs.require_access_token_runtime.call(void 0, );
15
- return _chunkXGCTJYBWcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
15
+ return _chunk64QQ2WEYcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
16
16
  };
17
17
  var _instance = null;
18
18
  var resolve = () => {
19
19
  if (!_instance) {
20
20
  const def = loadDefinition();
21
- _instance = _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
21
+ _instance = _chunk64QQ2WEYcjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
22
22
  }
23
23
  return _instance;
24
24
  };
25
- var _handle = _chunkXGCTJYBWcjs.createApiHandle.call(void 0, {
25
+ var _handle = _chunk64QQ2WEYcjs.createApiHandle.call(void 0, {
26
26
  resolveClient: resolve,
27
- createClient: () => _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
27
+ createClient: () => _chunk64QQ2WEYcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
28
28
  apiName: "accessToken"
29
29
  });
30
30
  var getClient = _handle.getClient;
@@ -35,4 +35,4 @@ var accessToken = _handle;
35
35
 
36
36
 
37
37
 
38
- exports.accessToken = accessToken; exports.authorize = _chunkXGCTJYBWcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
38
+ exports.accessToken = accessToken; exports.authorize = _chunk64QQ2WEYcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
@@ -6,7 +6,7 @@ import {
6
6
  createApiClient,
7
7
  createApiHandle,
8
8
  expand
9
- } from "../chunk-FOGUF2AK.js";
9
+ } from "../chunk-ZALT2KZ3.js";
10
10
  import "../chunk-YPSWSI3M.js";
11
11
 
12
12
  // src/apis/access-token.ts
@@ -6,25 +6,25 @@ var _chunkLKRBFBFNcjs = require('../chunk-LKRBFBFN.cjs');
6
6
 
7
7
 
8
8
 
9
- var _chunkXGCTJYBWcjs = require('../chunk-XGCTJYBW.cjs');
9
+ var _chunk64QQ2WEYcjs = require('../chunk-64QQ2WEY.cjs');
10
10
  require('../chunk-NJK5F5TF.cjs');
11
11
 
12
12
  // src/apis/address-suggestions.ts
13
13
  var loadDefinition = () => {
14
14
  const mod = _chunkLKRBFBFNcjs.require_address_suggestions_runtime.call(void 0, );
15
- return _chunkXGCTJYBWcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
15
+ return _chunk64QQ2WEYcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
16
16
  };
17
17
  var _instance = null;
18
18
  var resolve = () => {
19
19
  if (!_instance) {
20
20
  const def = loadDefinition();
21
- _instance = _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: def, apiName: "addressSuggestions" });
21
+ _instance = _chunk64QQ2WEYcjs.createApiClient.call(void 0, { definition: def, apiName: "addressSuggestions" });
22
22
  }
23
23
  return _instance;
24
24
  };
25
- var _handle = _chunkXGCTJYBWcjs.createApiHandle.call(void 0, {
25
+ var _handle = _chunk64QQ2WEYcjs.createApiHandle.call(void 0, {
26
26
  resolveClient: resolve,
27
- createClient: () => _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "addressSuggestions" }),
27
+ createClient: () => _chunk64QQ2WEYcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "addressSuggestions" }),
28
28
  apiName: "addressSuggestions"
29
29
  });
30
30
  var getClient = _handle.getClient;
@@ -35,4 +35,4 @@ var addressSuggestions = _handle;
35
35
 
36
36
 
37
37
 
38
- exports.addressSuggestions = addressSuggestions; exports.authorize = _chunkXGCTJYBWcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
38
+ exports.addressSuggestions = addressSuggestions; exports.authorize = _chunk64QQ2WEYcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
@@ -6,7 +6,7 @@ import {
6
6
  createApiClient,
7
7
  createApiHandle,
8
8
  expand
9
- } from "../chunk-FOGUF2AK.js";
9
+ } from "../chunk-ZALT2KZ3.js";
10
10
  import "../chunk-YPSWSI3M.js";
11
11
 
12
12
  // src/apis/address-suggestions.ts
@@ -6,25 +6,25 @@ var _chunkT67ZXTVGcjs = require('../chunk-T67ZXTVG.cjs');
6
6
 
7
7
 
8
8
 
9
- var _chunkXGCTJYBWcjs = require('../chunk-XGCTJYBW.cjs');
9
+ var _chunk64QQ2WEYcjs = require('../chunk-64QQ2WEY.cjs');
10
10
  require('../chunk-NJK5F5TF.cjs');
11
11
 
12
12
  // src/apis/address.ts
13
13
  var loadDefinition = () => {
14
14
  const mod = _chunkT67ZXTVGcjs.require_address_runtime.call(void 0, );
15
- return _chunkXGCTJYBWcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
15
+ return _chunk64QQ2WEYcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
16
16
  };
17
17
  var _instance = null;
18
18
  var resolve = () => {
19
19
  if (!_instance) {
20
20
  const def = loadDefinition();
21
- _instance = _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: def, apiName: "address" });
21
+ _instance = _chunk64QQ2WEYcjs.createApiClient.call(void 0, { definition: def, apiName: "address" });
22
22
  }
23
23
  return _instance;
24
24
  };
25
- var _handle = _chunkXGCTJYBWcjs.createApiHandle.call(void 0, {
25
+ var _handle = _chunk64QQ2WEYcjs.createApiHandle.call(void 0, {
26
26
  resolveClient: resolve,
27
- createClient: () => _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "address" }),
27
+ createClient: () => _chunk64QQ2WEYcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "address" }),
28
28
  apiName: "address"
29
29
  });
30
30
  var getClient = _handle.getClient;
@@ -35,4 +35,4 @@ var address = _handle;
35
35
 
36
36
 
37
37
 
38
- exports.address = address; exports.authorize = _chunkXGCTJYBWcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
38
+ exports.address = address; exports.authorize = _chunk64QQ2WEYcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
@@ -6,7 +6,7 @@ import {
6
6
  createApiClient,
7
7
  createApiHandle,
8
8
  expand
9
- } from "../chunk-FOGUF2AK.js";
9
+ } from "../chunk-ZALT2KZ3.js";
10
10
  import "../chunk-YPSWSI3M.js";
11
11
 
12
12
  // src/apis/address.ts
@@ -6,25 +6,25 @@ var _chunkYEBEA6XUcjs = require('../chunk-YEBEA6XU.cjs');
6
6
 
7
7
 
8
8
 
9
- var _chunkXGCTJYBWcjs = require('../chunk-XGCTJYBW.cjs');
9
+ var _chunk64QQ2WEYcjs = require('../chunk-64QQ2WEY.cjs');
10
10
  require('../chunk-NJK5F5TF.cjs');
11
11
 
12
12
  // src/apis/ai-agents.ts
13
13
  var loadDefinition = () => {
14
14
  const mod = _chunkYEBEA6XUcjs.require_ai_agents_runtime.call(void 0, );
15
- return _chunkXGCTJYBWcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
15
+ return _chunk64QQ2WEYcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
16
16
  };
17
17
  var _instance = null;
18
18
  var resolve = () => {
19
19
  if (!_instance) {
20
20
  const def = loadDefinition();
21
- _instance = _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: def, apiName: "aiAgents" });
21
+ _instance = _chunk64QQ2WEYcjs.createApiClient.call(void 0, { definition: def, apiName: "aiAgents" });
22
22
  }
23
23
  return _instance;
24
24
  };
25
- var _handle = _chunkXGCTJYBWcjs.createApiHandle.call(void 0, {
25
+ var _handle = _chunk64QQ2WEYcjs.createApiHandle.call(void 0, {
26
26
  resolveClient: resolve,
27
- createClient: () => _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "aiAgents" }),
27
+ createClient: () => _chunk64QQ2WEYcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "aiAgents" }),
28
28
  apiName: "aiAgents"
29
29
  });
30
30
  var getClient = _handle.getClient;
@@ -35,4 +35,4 @@ var aiAgents = _handle;
35
35
 
36
36
 
37
37
 
38
- exports.aiAgents = aiAgents; exports.authorize = _chunkXGCTJYBWcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
38
+ exports.aiAgents = aiAgents; exports.authorize = _chunk64QQ2WEYcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
@@ -6,7 +6,7 @@ import {
6
6
  createApiClient,
7
7
  createApiHandle,
8
8
  expand
9
- } from "../chunk-FOGUF2AK.js";
9
+ } from "../chunk-ZALT2KZ3.js";
10
10
  import "../chunk-YPSWSI3M.js";
11
11
 
12
12
  // src/apis/ai-agents.ts