@epilot/customer-portal-client 0.38.3 → 0.38.5
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/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +26 -3
- package/dist/openapi.d.ts +210 -13
- package/package.json +1 -1
- package/src/openapi-runtime.json +26 -3
- package/src/openapi.json +283 -21
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={330:function(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":true},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":true},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":true},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates/{portal_id}":{"post":{"operationId":"upsertEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/public-widgets":{"get":{"operationId":"getPublicPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/widgets":{"get":{"operationId":"getPublicPortalWidgetsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"responses":{}}},"/v3/portal/widgets":{"get":{"operationId":"getPortalWidgetsV3","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"contract_id","required":false}],"responses":{}},"post":{"operationId":"upsertPortalWidgetV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/portal/files":{"post":{"operationId":"savePortalFilesV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","deprecated":true,"responses":{}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","responses":{}}},"/v2/portal/public/schemas":{"get":{"operationId":"getSchemasByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v3/portal/public/schemas":{"get":{"operationId":"getPublicSchemasV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/org/settings":{"get":{"operationId":"getOrganizationSettingsByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","responses":{}}},"/v2/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecords","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecordsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/contact":{"get":{"operationId":"getContact","responses":{}},"patch":{"operationId":"updateContact","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","parameters":[{"in":"query","name":"id","required":true}],"responses":{}}},"/v2/portal/public/contact/exists":{"post":{"operationId":"checkContactExists","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/contact/exists":{"post":{"operationId":"checkContactExistsV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","responses":{}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","responses":{}},"patch":{"operationId":"updatePortalUser","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalUser","responses":{}}},"/v2/portal/user/update/email":{"put":{"operationId":"updatePortalUserEmail","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/downloaded":{"post":{"operationId":"trackFileDownloaded","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/files/count-by-entity":{"get":{"operationId":"getFilesCountByEntity","deprecated":true,"responses":{}}},"/v2/portal/billing/events":{"get":{"operationId":"getBillingEvents","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"name":"entity_id","in":"query","required":false},{"name":"event_type","in":"query"},{"name":"paid","in":"query"},{"name":"date_after","in":"query"},{"name":"date_before","in":"query"},{"name":"sort","in":"query"}],"responses":{}}},"/v2/portal/billing/customers/balance":{"get":{"operationId":"getCustomerBalance","responses":{}}},"/v2/portal/billing/accounts/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getBillingAccount","responses":{}}},"/v2/portal/admin:login-as-user":{"post":{"operationId":"loginToPortalAsUser","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEvent","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"origin","in":"query","required":true}],"responses":{}}},"/v3/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEventV3","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"portal_id","in":"query","required":false},{"name":"domain","in":"query","required":false}],"responses":{}}},"/v2/portal/entity:get":{"post":{"operationId":"getPortalUserEntity","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity:search":{"post":{"operationId":"searchPortalUserEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/can-trigger-portal-flow":{"post":{"operationId":"canTriggerPortalFlow","parameters":[{"in":"query","name":"origin","required":false,"deprecated":true},{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/automation-context":{"get":{"operationId":"getAutomationContext","parameters":[{"in":"query","name":"activity_id","required":true},{"in":"query","name":"type","required":true}],"responses":{}}},"/v2/portal/workflow/{workflow_id}/{step_id}:markDone":{"put":{"operationId":"updateWorkflowStepAsDone","parameters":[{"in":"path","name":"workflow_id","required":true},{"in":"path","name":"step_id","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows":{"get":{"operationId":"getEntityWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/metering/readings":{"post":{"operationId":"getMeterReadings","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/login":{"post":{"operationId":"ssoLogin","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/sso/login":{"post":{"operationId":"ssoLoginV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"org_id","required":false},{"in":"query","name":"domain","required":false},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/redirect":{"post":{"operationId":"ssoRedirect","parameters":[{"in":"query","name":"web_uri","required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{}}},"responses":{}}},"/v2/portal/public/sso/callback":{"post":{"operationId":"ssoCallback","parameters":[{"in":"query","name":"domain"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getPortalPage","responses":{}},"put":{"operationId":"updatePortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPage","responses":{}}},"/v2/portal/pages":{"parameters":[{"in":"query","name":"domain","required":true}],"get":{"operationId":"getPortalPages","parameters":[{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false},{"in":"query","name":"contract_id","required":false,"deprecated":true},{"in":"query","name":"context_entities","required":false}],"responses":{}},"post":{"operationId":"createPortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/pages":{"get":{"operationId":"getPublicPages","parameters":[{"in":"query","name":"domain","required":true},{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false}],"responses":{}}},"/v2/portal/pages/interpolate":{"post":{"operationId":"interpolatePortalPages","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/default":{"get":{"operationId":"getDefaultPages","responses":{}}},"/v2/portal/pages/{id}/blocks":{"parameters":[{"in":"path","name":"id","required":true}],"post":{"operationId":"createPortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalPageBlocks","responses":{}}},"/v2/portal/pages/{id}/blocks/{block_id}":{"parameters":[{"in":"path","name":"id","required":true},{"in":"path","name":"block_id","required":true}],"get":{"operationId":"getPortalPageBlock","responses":{}},"put":{"operationId":"updatePortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPageBlock","responses":{}}},"/v2/portal/public/user/entry-point":{"get":{"operationId":"getUserEntryPoint","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/campaign/{campaign_id}/entity:status":{"put":{"operationId":"updateCampaignPortalBlockStatus","parameters":[{"in":"path","name":"campaign_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/notifications/entity:status":{"put":{"operationId":"updateNotificationsStatus","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/m-login/deregister/{client_id}/{user_id}":{"delete":{"operationId":"deRegisterMLoginUser","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"responses":{}}},"/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}":{"post":{"operationId":"notifyMLoginInterestChange","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config":{"post":{"operationId":"createPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/{portal_id}":{"get":{"operationId":"getPortalConfigV3","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}},"put":{"operationId":"putPortalConfig","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalConfig","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/configs":{"get":{"operationId":"listAllPortalConfigs","responses":{}}},"/v3/portal/config/swap":{"post":{"operationId":"swapPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/clone":{"post":{"operationId":"clonePortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/invite":{"post":{"operationId":"invitePartner","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/list":{"get":{"operationId":"listBusinessPartners","responses":{}}},"/v3/portal/partner/{partner_id}/resend-invitation":{"post":{"operationId":"resendPartnerInvitation","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/revoke":{"delete":{"operationId":"revokePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/disable":{"post":{"operationId":"disablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/enable":{"post":{"operationId":"enablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}}},"components":{"responses":{"InvalidRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"ForbiddenByRule":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"ContractAssignmentConflict":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ConfirmUserInvalidRequest":{"content":{"application/json":{}}},"InvalidRequestCreateMeterReading":{"content":{"application/json":{}}}}},"servers":[{"url":"https://customer-portal-api.sls.epilot.io"}]}')}},r={},t=function t(a){var n=r[a];if(void 0!==n)return n.exports;var i=r[a]={exports:{}};return e[a].call(i.exports,i,i.exports,t),i.exports}(330),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={330:function(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/visualization/metadata":{"get":{"operationId":"getVisualizationMetadata","parameters":[{"in":"query","name":"app_id","required":true},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates/{portal_id}":{"post":{"operationId":"upsertEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/public-widgets":{"get":{"operationId":"getPublicPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/widgets":{"get":{"operationId":"getPublicPortalWidgetsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"responses":{}}},"/v3/portal/widgets":{"get":{"operationId":"getPortalWidgetsV3","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"contract_id","required":false}],"responses":{}},"post":{"operationId":"upsertPortalWidgetV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/portal/files":{"post":{"operationId":"savePortalFilesV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","deprecated":true,"responses":{}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","responses":{}}},"/v2/portal/public/schemas":{"get":{"operationId":"getSchemasByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v3/portal/public/schemas":{"get":{"operationId":"getPublicSchemasV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/org/settings":{"get":{"operationId":"getOrganizationSettingsByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","responses":{}}},"/v2/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecords","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecordsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/contact":{"get":{"operationId":"getContact","responses":{}},"patch":{"operationId":"updateContact","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","parameters":[{"in":"query","name":"id","required":true}],"responses":{}}},"/v2/portal/public/contact/exists":{"post":{"operationId":"checkContactExists","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/contact/exists":{"post":{"operationId":"checkContactExistsV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","responses":{}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","responses":{}},"patch":{"operationId":"updatePortalUser","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalUser","responses":{}}},"/v2/portal/user/update/email":{"put":{"operationId":"updatePortalUserEmail","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/downloaded":{"post":{"operationId":"trackFileDownloaded","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/files/count-by-entity":{"get":{"operationId":"getFilesCountByEntity","deprecated":true,"responses":{}}},"/v2/portal/billing/events":{"get":{"operationId":"getBillingEvents","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"name":"entity_id","in":"query","required":false},{"name":"event_type","in":"query"},{"name":"paid","in":"query"},{"name":"date_after","in":"query"},{"name":"date_before","in":"query"},{"name":"sort","in":"query"}],"responses":{}}},"/v2/portal/billing/customers/balance":{"get":{"operationId":"getCustomerBalance","responses":{}}},"/v2/portal/billing/accounts/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getBillingAccount","responses":{}}},"/v2/portal/admin:login-as-user":{"post":{"operationId":"loginToPortalAsUser","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEvent","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"origin","in":"query","required":true}],"responses":{}}},"/v3/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEventV3","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"portal_id","in":"query","required":false},{"name":"domain","in":"query","required":false}],"responses":{}}},"/v2/portal/entity:get":{"post":{"operationId":"getPortalUserEntity","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity:search":{"post":{"operationId":"searchPortalUserEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/can-trigger-portal-flow":{"post":{"operationId":"canTriggerPortalFlow","parameters":[{"in":"query","name":"origin","required":false,"deprecated":true},{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/automation-context":{"get":{"operationId":"getAutomationContext","parameters":[{"in":"query","name":"activity_id","required":true},{"in":"query","name":"type","required":true}],"responses":{}}},"/v2/portal/workflow/{workflow_id}/{step_id}:markDone":{"put":{"operationId":"updateWorkflowStepAsDone","parameters":[{"in":"path","name":"workflow_id","required":true},{"in":"path","name":"step_id","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows":{"get":{"operationId":"getEntityWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/metering/readings":{"post":{"operationId":"getMeterReadings","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/login":{"post":{"operationId":"ssoLogin","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/sso/login":{"post":{"operationId":"ssoLoginV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"org_id","required":false},{"in":"query","name":"domain","required":false},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/redirect":{"post":{"operationId":"ssoRedirect","parameters":[{"in":"query","name":"web_uri","required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{}}},"responses":{}}},"/v2/portal/public/sso/callback":{"post":{"operationId":"ssoCallback","parameters":[{"in":"query","name":"domain"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getPortalPage","responses":{}},"put":{"operationId":"updatePortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPage","responses":{}}},"/v2/portal/pages":{"parameters":[{"in":"query","name":"domain","required":true}],"get":{"operationId":"getPortalPages","parameters":[{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false},{"in":"query","name":"contract_id","required":false,"deprecated":true},{"in":"query","name":"context_entities","required":false}],"responses":{}},"post":{"operationId":"createPortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/pages":{"get":{"operationId":"getPublicPages","parameters":[{"in":"query","name":"domain","required":true},{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false}],"responses":{}}},"/v2/portal/pages/interpolate":{"post":{"operationId":"interpolatePortalPages","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/default":{"get":{"operationId":"getDefaultPages","responses":{}}},"/v2/portal/pages/{id}/blocks":{"parameters":[{"in":"path","name":"id","required":true}],"post":{"operationId":"createPortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalPageBlocks","responses":{}}},"/v2/portal/pages/{id}/blocks/{block_id}":{"parameters":[{"in":"path","name":"id","required":true},{"in":"path","name":"block_id","required":true}],"get":{"operationId":"getPortalPageBlock","responses":{}},"put":{"operationId":"updatePortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPageBlock","responses":{}}},"/v2/portal/public/user/entry-point":{"get":{"operationId":"getUserEntryPoint","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/campaign/{campaign_id}/entity:status":{"put":{"operationId":"updateCampaignPortalBlockStatus","parameters":[{"in":"path","name":"campaign_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/notifications/entity:status":{"put":{"operationId":"updateNotificationsStatus","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/m-login/deregister/{client_id}/{user_id}":{"delete":{"operationId":"deRegisterMLoginUser","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"responses":{}}},"/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}":{"post":{"operationId":"notifyMLoginInterestChange","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config":{"post":{"operationId":"createPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/{portal_id}":{"get":{"operationId":"getPortalConfigV3","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}},"put":{"operationId":"putPortalConfig","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalConfig","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/configs":{"get":{"operationId":"listAllPortalConfigs","responses":{}}},"/v3/portal/config/swap":{"post":{"operationId":"swapPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/clone":{"post":{"operationId":"clonePortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/invite":{"post":{"operationId":"invitePartner","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/list":{"get":{"operationId":"listBusinessPartners","responses":{}}},"/v3/portal/partner/{partner_id}/resend-invitation":{"post":{"operationId":"resendPartnerInvitation","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/revoke":{"delete":{"operationId":"revokePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/disable":{"post":{"operationId":"disablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/enable":{"post":{"operationId":"enablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}}},"components":{"responses":{"InvalidRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"ForbiddenByRule":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"ContractAssignmentConflict":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ConfirmUserInvalidRequest":{"content":{"application/json":{}}},"InvalidRequestCreateMeterReading":{"content":{"application/json":{}}}}},"servers":[{"url":"https://customer-portal-api.sls.epilot.io"}]}')}},r={},t=function t(a){var n=r[a];if(void 0!==n)return n.exports;var i=r[a]={exports:{}};return e[a].call(i.exports,i,i.exports,t),i.exports}(330),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
@@ -212,7 +212,7 @@
|
|
|
212
212
|
{
|
|
213
213
|
"in": "query",
|
|
214
214
|
"name": "hookId",
|
|
215
|
-
"required":
|
|
215
|
+
"required": false
|
|
216
216
|
},
|
|
217
217
|
{
|
|
218
218
|
"in": "query",
|
|
@@ -256,6 +256,29 @@
|
|
|
256
256
|
"responses": {}
|
|
257
257
|
}
|
|
258
258
|
},
|
|
259
|
+
"/v2/portal/visualization/metadata": {
|
|
260
|
+
"get": {
|
|
261
|
+
"operationId": "getVisualizationMetadata",
|
|
262
|
+
"parameters": [
|
|
263
|
+
{
|
|
264
|
+
"in": "query",
|
|
265
|
+
"name": "app_id",
|
|
266
|
+
"required": true
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"in": "query",
|
|
270
|
+
"name": "extensionId",
|
|
271
|
+
"required": true
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"in": "query",
|
|
275
|
+
"name": "context_entities",
|
|
276
|
+
"required": false
|
|
277
|
+
}
|
|
278
|
+
],
|
|
279
|
+
"responses": {}
|
|
280
|
+
}
|
|
281
|
+
},
|
|
259
282
|
"/v2/portal/costs": {
|
|
260
283
|
"get": {
|
|
261
284
|
"operationId": "getCosts",
|
|
@@ -273,7 +296,7 @@
|
|
|
273
296
|
{
|
|
274
297
|
"in": "query",
|
|
275
298
|
"name": "hookId",
|
|
276
|
-
"required":
|
|
299
|
+
"required": false
|
|
277
300
|
},
|
|
278
301
|
{
|
|
279
302
|
"in": "query",
|
|
@@ -322,7 +345,7 @@
|
|
|
322
345
|
{
|
|
323
346
|
"in": "query",
|
|
324
347
|
"name": "hookId",
|
|
325
|
-
"required":
|
|
348
|
+
"required": false
|
|
326
349
|
},
|
|
327
350
|
{
|
|
328
351
|
"in": "query",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -2158,6 +2158,7 @@ declare namespace Components {
|
|
|
2158
2158
|
*/
|
|
2159
2159
|
export type Currency = string;
|
|
2160
2160
|
export interface DataRetrievalItem {
|
|
2161
|
+
app?: PublicAppDetails;
|
|
2161
2162
|
extension?: PublicExtensionDetails;
|
|
2162
2163
|
hook?: PublicDataRetrievalHookDetails;
|
|
2163
2164
|
}
|
|
@@ -3191,7 +3192,11 @@ declare namespace Components {
|
|
|
3191
3192
|
* - valid: false
|
|
3192
3193
|
*
|
|
3193
3194
|
*/
|
|
3194
|
-
ExtensionHookMeterReadingPlausibilityCheck
|
|
3195
|
+
ExtensionHookMeterReadingPlausibilityCheck | /**
|
|
3196
|
+
* Hook that returns runtime metadata describing how a visualization should be rendered for a given portal context. Invoked by the portal before fetching data, with the same context the data hook receives.
|
|
3197
|
+
*
|
|
3198
|
+
*/
|
|
3199
|
+
ExtensionHookVisualizationMetadata))[];
|
|
3195
3200
|
}
|
|
3196
3201
|
export interface ExtensionAuthBlock {
|
|
3197
3202
|
/**
|
|
@@ -3443,6 +3448,14 @@ declare namespace Components {
|
|
|
3443
3448
|
*/
|
|
3444
3449
|
export interface ExtensionHookDataExport {
|
|
3445
3450
|
type: "dataExport";
|
|
3451
|
+
/**
|
|
3452
|
+
* Optional list of portal block types this hook supports. If omitted,
|
|
3453
|
+
* the hook is usable on any export-capable block. Allowed values match
|
|
3454
|
+
* the block type identifiers used by the portal builder
|
|
3455
|
+
* (e.g. `consumption_visualization`, `dynamic_tariff`).
|
|
3456
|
+
*
|
|
3457
|
+
*/
|
|
3458
|
+
block_types?: string[];
|
|
3446
3459
|
auth?: ExtensionAuthBlock;
|
|
3447
3460
|
call: {
|
|
3448
3461
|
/**
|
|
@@ -3687,6 +3700,55 @@ declare namespace Components {
|
|
|
3687
3700
|
*/
|
|
3688
3701
|
hook_id: string;
|
|
3689
3702
|
} | null;
|
|
3703
|
+
/**
|
|
3704
|
+
* Hook that returns runtime metadata describing how a visualization should be rendered for a given portal context. Invoked by the portal before fetching data, with the same context the data hook receives.
|
|
3705
|
+
*
|
|
3706
|
+
*/
|
|
3707
|
+
export interface ExtensionHookVisualizationMetadata {
|
|
3708
|
+
type: "visualizationMetadata";
|
|
3709
|
+
auth?: ExtensionAuthBlock;
|
|
3710
|
+
call: {
|
|
3711
|
+
/**
|
|
3712
|
+
* HTTP method to use for the call
|
|
3713
|
+
*/
|
|
3714
|
+
method?: string;
|
|
3715
|
+
/**
|
|
3716
|
+
* URL to call. Supports variable interpolation.
|
|
3717
|
+
*/
|
|
3718
|
+
url: string;
|
|
3719
|
+
/**
|
|
3720
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
3721
|
+
*/
|
|
3722
|
+
params?: {
|
|
3723
|
+
[name: string]: string;
|
|
3724
|
+
};
|
|
3725
|
+
/**
|
|
3726
|
+
* Headers to use. Supports variable interpolation.
|
|
3727
|
+
*/
|
|
3728
|
+
headers?: {
|
|
3729
|
+
[name: string]: string;
|
|
3730
|
+
};
|
|
3731
|
+
/**
|
|
3732
|
+
* Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.
|
|
3733
|
+
*/
|
|
3734
|
+
body?: {
|
|
3735
|
+
[name: string]: string;
|
|
3736
|
+
};
|
|
3737
|
+
};
|
|
3738
|
+
resolved?: {
|
|
3739
|
+
/**
|
|
3740
|
+
* Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level.
|
|
3741
|
+
*/
|
|
3742
|
+
dataPath?: string;
|
|
3743
|
+
};
|
|
3744
|
+
/**
|
|
3745
|
+
* Deprecated. Prefer `secure_proxy` instead.
|
|
3746
|
+
* 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.
|
|
3747
|
+
*
|
|
3748
|
+
*/
|
|
3749
|
+
use_static_ips?: boolean;
|
|
3750
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3751
|
+
}
|
|
3690
3752
|
export interface ExtensionSeamlessLink {
|
|
3691
3753
|
/**
|
|
3692
3754
|
* Identifier of the link. Should not change between updates.
|
|
@@ -6237,6 +6299,19 @@ declare namespace Components {
|
|
|
6237
6299
|
* office-365-login
|
|
6238
6300
|
*/
|
|
6239
6301
|
export type ProviderSlug = string; // [0-9a-z-]+
|
|
6302
|
+
export interface PublicAppDetails {
|
|
6303
|
+
/**
|
|
6304
|
+
* Identifier of the app.
|
|
6305
|
+
*/
|
|
6306
|
+
app_id?: string;
|
|
6307
|
+
name?: {
|
|
6308
|
+
[name: string]: string;
|
|
6309
|
+
/**
|
|
6310
|
+
* Name of the app in English.
|
|
6311
|
+
*/
|
|
6312
|
+
en: string;
|
|
6313
|
+
};
|
|
6314
|
+
}
|
|
6240
6315
|
export interface PublicContractIdentificationDetails {
|
|
6241
6316
|
/**
|
|
6242
6317
|
* Explanation of the hook.
|
|
@@ -6264,9 +6339,16 @@ declare namespace Components {
|
|
|
6264
6339
|
en: string;
|
|
6265
6340
|
};
|
|
6266
6341
|
/**
|
|
6267
|
-
*
|
|
6342
|
+
* Deprecated. Prefer fetching `intervals` from the `visualizationMetadata` endpoint
|
|
6343
|
+
* (`GET /v2/portal/visualization/metadata`) so the supported intervals can vary per
|
|
6344
|
+
* meter/contract. Still emitted as a fallback for clients that have not migrated yet.
|
|
6345
|
+
*
|
|
6268
6346
|
*/
|
|
6269
6347
|
intervals?: string[];
|
|
6348
|
+
/**
|
|
6349
|
+
* Optional list of portal block types the hook supports. Empty/missing means the hook is usable on any export-capable block.
|
|
6350
|
+
*/
|
|
6351
|
+
block_types?: string[];
|
|
6270
6352
|
}
|
|
6271
6353
|
export interface PublicExtensionCapabilities {
|
|
6272
6354
|
consumptionDataRetrieval?: DataRetrievalItem[];
|
|
@@ -7698,6 +7780,65 @@ declare namespace Components {
|
|
|
7698
7780
|
*/
|
|
7699
7781
|
EntityId /* uuid */;
|
|
7700
7782
|
}
|
|
7783
|
+
/**
|
|
7784
|
+
* Earliest / latest timestamps for which data is available in the current context.
|
|
7785
|
+
*/
|
|
7786
|
+
export interface VisualizationDataRange {
|
|
7787
|
+
/**
|
|
7788
|
+
* ISO 8601 timestamp of the earliest available data point.
|
|
7789
|
+
*/
|
|
7790
|
+
from?: string; // date-time
|
|
7791
|
+
/**
|
|
7792
|
+
* ISO 8601 timestamp of the latest available data point.
|
|
7793
|
+
*/
|
|
7794
|
+
to?: string; // date-time
|
|
7795
|
+
}
|
|
7796
|
+
/**
|
|
7797
|
+
* Runtime metadata describing how a visualization should be rendered for a given portal context. Returned by `GET /v2/portal/visualization/metadata`.
|
|
7798
|
+
*
|
|
7799
|
+
*/
|
|
7800
|
+
export interface VisualizationMetadata {
|
|
7801
|
+
/**
|
|
7802
|
+
* Types advertised for the current context (e.g. `ht`/`nt`, `feed-in`/`feed-out`). The `id` matches the `type` field returned by the data hook.
|
|
7803
|
+
*
|
|
7804
|
+
*/
|
|
7805
|
+
type_options?: VisualizationTypeOption[];
|
|
7806
|
+
/**
|
|
7807
|
+
* Statistical method already applied to the data the data hook returns. Determines the chart shape used to render the values: `sum` is shown as a bar chart; `min`, `average`, and `max` are shown as a line chart. Defaults to `sum` when omitted.
|
|
7808
|
+
*
|
|
7809
|
+
*/
|
|
7810
|
+
statistical_method?: "sum" | "average" | "min" | "max";
|
|
7811
|
+
/**
|
|
7812
|
+
* Intervals supported for the current context. If omitted, all intervals are assumed supported.
|
|
7813
|
+
*/
|
|
7814
|
+
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
|
|
7815
|
+
data_range?: /* Earliest / latest timestamps for which data is available in the current context. */ VisualizationDataRange;
|
|
7816
|
+
}
|
|
7817
|
+
export interface VisualizationTypeOption {
|
|
7818
|
+
/**
|
|
7819
|
+
* Identifier of the type. Matches the `type` field on the data hook response.
|
|
7820
|
+
*/
|
|
7821
|
+
id: string;
|
|
7822
|
+
/**
|
|
7823
|
+
* Localized label for the type, keyed by ISO 3166-1 alpha-2 language code.
|
|
7824
|
+
*/
|
|
7825
|
+
label?: {
|
|
7826
|
+
[name: string]: string;
|
|
7827
|
+
};
|
|
7828
|
+
/**
|
|
7829
|
+
* Optional grouping key. Types in the same `aggregation_group` are visually combined; types in different groups (or without a group) render separately. How they combine depends on `statistical_method`:
|
|
7830
|
+
* - bar chart (`sum`): same-group types are stacked into a single bar (e.g. ht/nt
|
|
7831
|
+
* summed into total consumption); different-group types render side-by-side.
|
|
7832
|
+
* - line chart (`min` / `average` / `max`): same-group types are rendered as an
|
|
7833
|
+
* area chart; different-group types render as separate lines.
|
|
7834
|
+
*
|
|
7835
|
+
*/
|
|
7836
|
+
aggregation_group?: string;
|
|
7837
|
+
/**
|
|
7838
|
+
* Unit shared by all values of this type (e.g. "kWh").
|
|
7839
|
+
*/
|
|
7840
|
+
unit?: string;
|
|
7841
|
+
}
|
|
7701
7842
|
export interface WidgetAction {
|
|
7702
7843
|
_id: string;
|
|
7703
7844
|
type: "link" | "journey";
|
|
@@ -9200,7 +9341,7 @@ declare namespace Paths {
|
|
|
9200
9341
|
export interface QueryParameters {
|
|
9201
9342
|
app_id?: Parameters.AppId;
|
|
9202
9343
|
extensionId: Parameters.ExtensionId;
|
|
9203
|
-
hookId
|
|
9344
|
+
hookId?: Parameters.HookId;
|
|
9204
9345
|
meter_id?: Parameters.MeterId;
|
|
9205
9346
|
from: Parameters.From /* date-time */;
|
|
9206
9347
|
to: Parameters.To /* date-time */;
|
|
@@ -9224,12 +9365,6 @@ declare namespace Paths {
|
|
|
9224
9365
|
* nt
|
|
9225
9366
|
*/
|
|
9226
9367
|
type?: string;
|
|
9227
|
-
/**
|
|
9228
|
-
* The method used to aggregate the consumption data. Assumed default is 'sum'.
|
|
9229
|
-
* example:
|
|
9230
|
-
* sum
|
|
9231
|
-
*/
|
|
9232
|
-
aggregation_method?: "sum" | "average" | "max" | "min";
|
|
9233
9368
|
/**
|
|
9234
9369
|
* Optional unit of the consumption value. Defaults to unit present on the relevant Meter Counter.
|
|
9235
9370
|
* example:
|
|
@@ -9370,7 +9505,7 @@ declare namespace Paths {
|
|
|
9370
9505
|
export interface QueryParameters {
|
|
9371
9506
|
app_id?: Parameters.AppId;
|
|
9372
9507
|
extensionId: Parameters.ExtensionId;
|
|
9373
|
-
hookId
|
|
9508
|
+
hookId?: Parameters.HookId;
|
|
9374
9509
|
meter_id?: Parameters.MeterId;
|
|
9375
9510
|
from: Parameters.From /* date-time */;
|
|
9376
9511
|
to: Parameters.To /* date-time */;
|
|
@@ -11232,7 +11367,7 @@ declare namespace Paths {
|
|
|
11232
11367
|
export interface QueryParameters {
|
|
11233
11368
|
app_id?: Parameters.AppId;
|
|
11234
11369
|
extensionId: Parameters.ExtensionId;
|
|
11235
|
-
hookId
|
|
11370
|
+
hookId?: Parameters.HookId;
|
|
11236
11371
|
meter_id?: Parameters.MeterId;
|
|
11237
11372
|
from: Parameters.From /* date-time */;
|
|
11238
11373
|
to: Parameters.To /* date-time */;
|
|
@@ -11988,6 +12123,39 @@ declare namespace Paths {
|
|
|
11988
12123
|
export type $500 = Components.Responses.InternalServerError;
|
|
11989
12124
|
}
|
|
11990
12125
|
}
|
|
12126
|
+
namespace GetVisualizationMetadata {
|
|
12127
|
+
namespace Parameters {
|
|
12128
|
+
export type AppId = string;
|
|
12129
|
+
export type ContextEntities = /**
|
|
12130
|
+
* Additional entities to include in the context for variable interpolation. Portal User and Contact entities are automatically part of the context.
|
|
12131
|
+
* example:
|
|
12132
|
+
* [
|
|
12133
|
+
* {
|
|
12134
|
+
* "entity_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
12135
|
+
* "entity_schema": "contract"
|
|
12136
|
+
* }
|
|
12137
|
+
* ]
|
|
12138
|
+
*/
|
|
12139
|
+
Components.Schemas.ContextEntities;
|
|
12140
|
+
export type ExtensionId = string;
|
|
12141
|
+
}
|
|
12142
|
+
export interface QueryParameters {
|
|
12143
|
+
app_id: Parameters.AppId;
|
|
12144
|
+
extensionId: Parameters.ExtensionId;
|
|
12145
|
+
context_entities?: Parameters.ContextEntities;
|
|
12146
|
+
}
|
|
12147
|
+
namespace Responses {
|
|
12148
|
+
export type $200 = /**
|
|
12149
|
+
* Runtime metadata describing how a visualization should be rendered for a given portal context. Returned by `GET /v2/portal/visualization/metadata`.
|
|
12150
|
+
*
|
|
12151
|
+
*/
|
|
12152
|
+
Components.Schemas.VisualizationMetadata;
|
|
12153
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
12154
|
+
export type $403 = Components.Responses.Forbidden;
|
|
12155
|
+
export type $404 = Components.Responses.NotFound;
|
|
12156
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
12157
|
+
}
|
|
12158
|
+
}
|
|
11991
12159
|
namespace InterpolatePortalPages {
|
|
11992
12160
|
export interface RequestBody {
|
|
11993
12161
|
/**
|
|
@@ -12199,9 +12367,9 @@ declare namespace Paths {
|
|
|
12199
12367
|
*/
|
|
12200
12368
|
extension_id: string;
|
|
12201
12369
|
/**
|
|
12202
|
-
* Hook ID
|
|
12370
|
+
* Optional Hook ID. If omitted, the only `dataExport` hook on the extension is used; if the extension has multiple `dataExport` hooks, this becomes required.
|
|
12203
12371
|
*/
|
|
12204
|
-
hook_id
|
|
12372
|
+
hook_id?: string;
|
|
12205
12373
|
/**
|
|
12206
12374
|
* Optional start date for the export window (ISO 8601 format).
|
|
12207
12375
|
*/
|
|
@@ -13675,6 +13843,17 @@ export interface OperationMethods {
|
|
|
13675
13843
|
data?: Paths.PrepareVisualizationExport.RequestBody,
|
|
13676
13844
|
config?: AxiosRequestConfig
|
|
13677
13845
|
): OperationResponse<Paths.PrepareVisualizationExport.Responses.$200>
|
|
13846
|
+
/**
|
|
13847
|
+
* getVisualizationMetadata - Get Visualization Metadata
|
|
13848
|
+
*
|
|
13849
|
+
* Returns runtime metadata describing how a visualization (consumption / price / cost chart) should be rendered for a given portal context (meter, contract, etc). Resolves the extension's `visualizationMetadata` hook implicitly from `app_id` + `extensionId` and invokes it. Supplies the response as a structured payload that the portal uses to configure type/aggregation options, supported intervals, and the available data range.
|
|
13850
|
+
*
|
|
13851
|
+
*/
|
|
13852
|
+
'getVisualizationMetadata'(
|
|
13853
|
+
parameters?: Parameters<Paths.GetVisualizationMetadata.QueryParameters> | null,
|
|
13854
|
+
data?: any,
|
|
13855
|
+
config?: AxiosRequestConfig
|
|
13856
|
+
): OperationResponse<Paths.GetVisualizationMetadata.Responses.$200>
|
|
13678
13857
|
/**
|
|
13679
13858
|
* getCosts - Get Costs
|
|
13680
13859
|
*
|
|
@@ -15195,6 +15374,19 @@ export interface PathsDictionary {
|
|
|
15195
15374
|
config?: AxiosRequestConfig
|
|
15196
15375
|
): OperationResponse<Paths.PrepareVisualizationExport.Responses.$200>
|
|
15197
15376
|
}
|
|
15377
|
+
['/v2/portal/visualization/metadata']: {
|
|
15378
|
+
/**
|
|
15379
|
+
* getVisualizationMetadata - Get Visualization Metadata
|
|
15380
|
+
*
|
|
15381
|
+
* Returns runtime metadata describing how a visualization (consumption / price / cost chart) should be rendered for a given portal context (meter, contract, etc). Resolves the extension's `visualizationMetadata` hook implicitly from `app_id` + `extensionId` and invokes it. Supplies the response as a structured payload that the portal uses to configure type/aggregation options, supported intervals, and the available data range.
|
|
15382
|
+
*
|
|
15383
|
+
*/
|
|
15384
|
+
'get'(
|
|
15385
|
+
parameters?: Parameters<Paths.GetVisualizationMetadata.QueryParameters> | null,
|
|
15386
|
+
data?: any,
|
|
15387
|
+
config?: AxiosRequestConfig
|
|
15388
|
+
): OperationResponse<Paths.GetVisualizationMetadata.Responses.$200>
|
|
15389
|
+
}
|
|
15198
15390
|
['/v2/portal/costs']: {
|
|
15199
15391
|
/**
|
|
15200
15392
|
* getCosts - Get Costs
|
|
@@ -16831,6 +17023,7 @@ export type ExtensionHookMeterReadingPlausibilityCheck = Components.Schemas.Exte
|
|
|
16831
17023
|
export type ExtensionHookPriceDataRetrieval = Components.Schemas.ExtensionHookPriceDataRetrieval;
|
|
16832
17024
|
export type ExtensionHookRegistrationIdentifiersCheck = Components.Schemas.ExtensionHookRegistrationIdentifiersCheck;
|
|
16833
17025
|
export type ExtensionHookSelection = Components.Schemas.ExtensionHookSelection;
|
|
17026
|
+
export type ExtensionHookVisualizationMetadata = Components.Schemas.ExtensionHookVisualizationMetadata;
|
|
16834
17027
|
export type ExtensionSeamlessLink = Components.Schemas.ExtensionSeamlessLink;
|
|
16835
17028
|
export type ExternalLink = Components.Schemas.ExternalLink;
|
|
16836
17029
|
export type ExtraSchemaAttributes = Components.Schemas.ExtraSchemaAttributes;
|
|
@@ -16870,6 +17063,7 @@ export type ProviderConfig = Components.Schemas.ProviderConfig;
|
|
|
16870
17063
|
export type ProviderDisplayName = Components.Schemas.ProviderDisplayName;
|
|
16871
17064
|
export type ProviderPublicConfig = Components.Schemas.ProviderPublicConfig;
|
|
16872
17065
|
export type ProviderSlug = Components.Schemas.ProviderSlug;
|
|
17066
|
+
export type PublicAppDetails = Components.Schemas.PublicAppDetails;
|
|
16873
17067
|
export type PublicContractIdentificationDetails = Components.Schemas.PublicContractIdentificationDetails;
|
|
16874
17068
|
export type PublicDataRetrievalHookDetails = Components.Schemas.PublicDataRetrievalHookDetails;
|
|
16875
17069
|
export type PublicExtensionCapabilities = Components.Schemas.PublicExtensionCapabilities;
|
|
@@ -16900,6 +17094,9 @@ export type UpsertPortalConfig = Components.Schemas.UpsertPortalConfig;
|
|
|
16900
17094
|
export type UpsertPortalConfigV3 = Components.Schemas.UpsertPortalConfigV3;
|
|
16901
17095
|
export type UpsertPortalWidget = Components.Schemas.UpsertPortalWidget;
|
|
16902
17096
|
export type UserRequest = Components.Schemas.UserRequest;
|
|
17097
|
+
export type VisualizationDataRange = Components.Schemas.VisualizationDataRange;
|
|
17098
|
+
export type VisualizationMetadata = Components.Schemas.VisualizationMetadata;
|
|
17099
|
+
export type VisualizationTypeOption = Components.Schemas.VisualizationTypeOption;
|
|
16903
17100
|
export type WidgetAction = Components.Schemas.WidgetAction;
|
|
16904
17101
|
export type WidgetBase = Components.Schemas.WidgetBase;
|
|
16905
17102
|
export type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
|
package/package.json
CHANGED
package/src/openapi-runtime.json
CHANGED
|
@@ -212,7 +212,7 @@
|
|
|
212
212
|
{
|
|
213
213
|
"in": "query",
|
|
214
214
|
"name": "hookId",
|
|
215
|
-
"required":
|
|
215
|
+
"required": false
|
|
216
216
|
},
|
|
217
217
|
{
|
|
218
218
|
"in": "query",
|
|
@@ -256,6 +256,29 @@
|
|
|
256
256
|
"responses": {}
|
|
257
257
|
}
|
|
258
258
|
},
|
|
259
|
+
"/v2/portal/visualization/metadata": {
|
|
260
|
+
"get": {
|
|
261
|
+
"operationId": "getVisualizationMetadata",
|
|
262
|
+
"parameters": [
|
|
263
|
+
{
|
|
264
|
+
"in": "query",
|
|
265
|
+
"name": "app_id",
|
|
266
|
+
"required": true
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"in": "query",
|
|
270
|
+
"name": "extensionId",
|
|
271
|
+
"required": true
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"in": "query",
|
|
275
|
+
"name": "context_entities",
|
|
276
|
+
"required": false
|
|
277
|
+
}
|
|
278
|
+
],
|
|
279
|
+
"responses": {}
|
|
280
|
+
}
|
|
281
|
+
},
|
|
259
282
|
"/v2/portal/costs": {
|
|
260
283
|
"get": {
|
|
261
284
|
"operationId": "getCosts",
|
|
@@ -273,7 +296,7 @@
|
|
|
273
296
|
{
|
|
274
297
|
"in": "query",
|
|
275
298
|
"name": "hookId",
|
|
276
|
-
"required":
|
|
299
|
+
"required": false
|
|
277
300
|
},
|
|
278
301
|
{
|
|
279
302
|
"in": "query",
|
|
@@ -322,7 +345,7 @@
|
|
|
322
345
|
{
|
|
323
346
|
"in": "query",
|
|
324
347
|
"name": "hookId",
|
|
325
|
-
"required":
|
|
348
|
+
"required": false
|
|
326
349
|
},
|
|
327
350
|
{
|
|
328
351
|
"in": "query",
|
package/src/openapi.json
CHANGED
|
@@ -733,8 +733,8 @@
|
|
|
733
733
|
"schema": {
|
|
734
734
|
"type": "string"
|
|
735
735
|
},
|
|
736
|
-
"required":
|
|
737
|
-
"description": "Hook ID
|
|
736
|
+
"required": false,
|
|
737
|
+
"description": "Optional Hook ID. If omitted, the only matching hook on the extension is used; if the extension has multiple hooks of the relevant type, this becomes required."
|
|
738
738
|
},
|
|
739
739
|
{
|
|
740
740
|
"in": "query",
|
|
@@ -818,17 +818,6 @@
|
|
|
818
818
|
"description": "Optional type of the consumption, such as 'nt' (night time) and 'ht' (high time) or 'feed-in' and 'feed-out'. Can be any string.",
|
|
819
819
|
"example": "nt"
|
|
820
820
|
},
|
|
821
|
-
"aggregation_method": {
|
|
822
|
-
"type": "string",
|
|
823
|
-
"description": "The method used to aggregate the consumption data. Assumed default is 'sum'.",
|
|
824
|
-
"enum": [
|
|
825
|
-
"sum",
|
|
826
|
-
"average",
|
|
827
|
-
"max",
|
|
828
|
-
"min"
|
|
829
|
-
],
|
|
830
|
-
"example": "sum"
|
|
831
|
-
},
|
|
832
821
|
"unit": {
|
|
833
822
|
"type": "string",
|
|
834
823
|
"description": "Optional unit of the consumption value. Defaults to unit present on the relevant Meter Counter.",
|
|
@@ -891,7 +880,7 @@
|
|
|
891
880
|
},
|
|
892
881
|
"hook_id": {
|
|
893
882
|
"type": "string",
|
|
894
|
-
"description": "Hook ID
|
|
883
|
+
"description": "Optional Hook ID. If omitted, the only `dataExport` hook on the extension is used; if the extension has multiple `dataExport` hooks, this becomes required."
|
|
895
884
|
},
|
|
896
885
|
"from": {
|
|
897
886
|
"type": "string",
|
|
@@ -909,8 +898,7 @@
|
|
|
909
898
|
},
|
|
910
899
|
"required": [
|
|
911
900
|
"app_id",
|
|
912
|
-
"extension_id"
|
|
913
|
-
"hook_id"
|
|
901
|
+
"extension_id"
|
|
914
902
|
],
|
|
915
903
|
"additionalProperties": false
|
|
916
904
|
}
|
|
@@ -966,6 +954,74 @@
|
|
|
966
954
|
}
|
|
967
955
|
}
|
|
968
956
|
},
|
|
957
|
+
"/v2/portal/visualization/metadata": {
|
|
958
|
+
"get": {
|
|
959
|
+
"operationId": "getVisualizationMetadata",
|
|
960
|
+
"summary": "Get Visualization Metadata",
|
|
961
|
+
"description": "Returns runtime metadata describing how a visualization (consumption / price / cost chart) should be rendered for a given portal context (meter, contract, etc). Resolves the extension's `visualizationMetadata` hook implicitly from `app_id` + `extensionId` and invokes it. Supplies the response as a structured payload that the portal uses to configure type/aggregation options, supported intervals, and the available data range.\n",
|
|
962
|
+
"tags": [
|
|
963
|
+
"ECP"
|
|
964
|
+
],
|
|
965
|
+
"security": [
|
|
966
|
+
{
|
|
967
|
+
"PortalAuth": []
|
|
968
|
+
}
|
|
969
|
+
],
|
|
970
|
+
"parameters": [
|
|
971
|
+
{
|
|
972
|
+
"in": "query",
|
|
973
|
+
"name": "app_id",
|
|
974
|
+
"schema": {
|
|
975
|
+
"type": "string"
|
|
976
|
+
},
|
|
977
|
+
"required": true,
|
|
978
|
+
"description": "App ID providing the visualizationMetadata hook."
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"in": "query",
|
|
982
|
+
"name": "extensionId",
|
|
983
|
+
"schema": {
|
|
984
|
+
"type": "string"
|
|
985
|
+
},
|
|
986
|
+
"required": true,
|
|
987
|
+
"description": "Extension ID providing the visualizationMetadata hook."
|
|
988
|
+
},
|
|
989
|
+
{
|
|
990
|
+
"in": "query",
|
|
991
|
+
"name": "context_entities",
|
|
992
|
+
"required": false,
|
|
993
|
+
"description": "Entities to include in the context for variable interpolation in the hook (typically the meter and any other entities that scope the visualization).",
|
|
994
|
+
"schema": {
|
|
995
|
+
"$ref": "#/components/schemas/ContextEntities"
|
|
996
|
+
}
|
|
997
|
+
}
|
|
998
|
+
],
|
|
999
|
+
"responses": {
|
|
1000
|
+
"200": {
|
|
1001
|
+
"description": "Visualization metadata returned successfully.",
|
|
1002
|
+
"content": {
|
|
1003
|
+
"application/json": {
|
|
1004
|
+
"schema": {
|
|
1005
|
+
"$ref": "#/components/schemas/VisualizationMetadata"
|
|
1006
|
+
}
|
|
1007
|
+
}
|
|
1008
|
+
}
|
|
1009
|
+
},
|
|
1010
|
+
"401": {
|
|
1011
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
1012
|
+
},
|
|
1013
|
+
"403": {
|
|
1014
|
+
"$ref": "#/components/responses/Forbidden"
|
|
1015
|
+
},
|
|
1016
|
+
"404": {
|
|
1017
|
+
"$ref": "#/components/responses/NotFound"
|
|
1018
|
+
},
|
|
1019
|
+
"500": {
|
|
1020
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
1021
|
+
}
|
|
1022
|
+
}
|
|
1023
|
+
}
|
|
1024
|
+
},
|
|
969
1025
|
"/v2/portal/costs": {
|
|
970
1026
|
"get": {
|
|
971
1027
|
"operationId": "getCosts",
|
|
@@ -1004,8 +1060,8 @@
|
|
|
1004
1060
|
"schema": {
|
|
1005
1061
|
"type": "string"
|
|
1006
1062
|
},
|
|
1007
|
-
"required":
|
|
1008
|
-
"description": "Hook ID
|
|
1063
|
+
"required": false,
|
|
1064
|
+
"description": "Optional Hook ID. If omitted, the only matching hook on the extension is used; if the extension has multiple hooks of the relevant type, this becomes required."
|
|
1009
1065
|
},
|
|
1010
1066
|
{
|
|
1011
1067
|
"in": "query",
|
|
@@ -1178,8 +1234,8 @@
|
|
|
1178
1234
|
"schema": {
|
|
1179
1235
|
"type": "string"
|
|
1180
1236
|
},
|
|
1181
|
-
"required":
|
|
1182
|
-
"description": "Hook ID
|
|
1237
|
+
"required": false,
|
|
1238
|
+
"description": "Optional Hook ID. If omitted, the only matching hook on the extension is used; if the extension has multiple hooks of the relevant type, this becomes required."
|
|
1183
1239
|
},
|
|
1184
1240
|
{
|
|
1185
1241
|
"in": "query",
|
|
@@ -13642,6 +13698,9 @@
|
|
|
13642
13698
|
"DataRetrievalItem": {
|
|
13643
13699
|
"type": "object",
|
|
13644
13700
|
"properties": {
|
|
13701
|
+
"app": {
|
|
13702
|
+
"$ref": "#/components/schemas/PublicAppDetails"
|
|
13703
|
+
},
|
|
13645
13704
|
"extension": {
|
|
13646
13705
|
"$ref": "#/components/schemas/PublicExtensionDetails"
|
|
13647
13706
|
},
|
|
@@ -13650,6 +13709,31 @@
|
|
|
13650
13709
|
}
|
|
13651
13710
|
}
|
|
13652
13711
|
},
|
|
13712
|
+
"PublicAppDetails": {
|
|
13713
|
+
"type": "object",
|
|
13714
|
+
"properties": {
|
|
13715
|
+
"app_id": {
|
|
13716
|
+
"type": "string",
|
|
13717
|
+
"description": "Identifier of the app."
|
|
13718
|
+
},
|
|
13719
|
+
"name": {
|
|
13720
|
+
"type": "object",
|
|
13721
|
+
"properties": {
|
|
13722
|
+
"en": {
|
|
13723
|
+
"type": "string",
|
|
13724
|
+
"description": "Name of the app in English."
|
|
13725
|
+
}
|
|
13726
|
+
},
|
|
13727
|
+
"additionalProperties": {
|
|
13728
|
+
"type": "string",
|
|
13729
|
+
"description": "Name of the app in some other language denoted by ISO 3166-1 alpha-2 code."
|
|
13730
|
+
},
|
|
13731
|
+
"required": [
|
|
13732
|
+
"en"
|
|
13733
|
+
]
|
|
13734
|
+
}
|
|
13735
|
+
}
|
|
13736
|
+
},
|
|
13653
13737
|
"PublicExtensionDetails": {
|
|
13654
13738
|
"type": "object",
|
|
13655
13739
|
"properties": {
|
|
@@ -13700,10 +13784,100 @@
|
|
|
13700
13784
|
},
|
|
13701
13785
|
"intervals": {
|
|
13702
13786
|
"type": "array",
|
|
13787
|
+
"deprecated": true,
|
|
13703
13788
|
"items": {
|
|
13704
13789
|
"type": "string"
|
|
13705
13790
|
},
|
|
13706
|
-
"description": "
|
|
13791
|
+
"description": "Deprecated. Prefer fetching `intervals` from the `visualizationMetadata` endpoint\n(`GET /v2/portal/visualization/metadata`) so the supported intervals can vary per\nmeter/contract. Still emitted as a fallback for clients that have not migrated yet.\n"
|
|
13792
|
+
},
|
|
13793
|
+
"block_types": {
|
|
13794
|
+
"type": "array",
|
|
13795
|
+
"items": {
|
|
13796
|
+
"type": "string"
|
|
13797
|
+
},
|
|
13798
|
+
"description": "Optional list of portal block types the hook supports. Empty/missing means the hook is usable on any export-capable block."
|
|
13799
|
+
}
|
|
13800
|
+
}
|
|
13801
|
+
},
|
|
13802
|
+
"VisualizationMetadata": {
|
|
13803
|
+
"type": "object",
|
|
13804
|
+
"description": "Runtime metadata describing how a visualization should be rendered for a given portal context. Returned by `GET /v2/portal/visualization/metadata`.\n",
|
|
13805
|
+
"properties": {
|
|
13806
|
+
"type_options": {
|
|
13807
|
+
"type": "array",
|
|
13808
|
+
"description": "Types advertised for the current context (e.g. `ht`/`nt`, `feed-in`/`feed-out`). The `id` matches the `type` field returned by the data hook.\n",
|
|
13809
|
+
"items": {
|
|
13810
|
+
"$ref": "#/components/schemas/VisualizationTypeOption"
|
|
13811
|
+
}
|
|
13812
|
+
},
|
|
13813
|
+
"statistical_method": {
|
|
13814
|
+
"type": "string",
|
|
13815
|
+
"enum": [
|
|
13816
|
+
"sum",
|
|
13817
|
+
"average",
|
|
13818
|
+
"min",
|
|
13819
|
+
"max"
|
|
13820
|
+
],
|
|
13821
|
+
"description": "Statistical method already applied to the data the data hook returns. Determines the chart shape used to render the values: `sum` is shown as a bar chart; `min`, `average`, and `max` are shown as a line chart. Defaults to `sum` when omitted.\n"
|
|
13822
|
+
},
|
|
13823
|
+
"intervals": {
|
|
13824
|
+
"type": "array",
|
|
13825
|
+
"description": "Intervals supported for the current context. If omitted, all intervals are assumed supported.",
|
|
13826
|
+
"items": {
|
|
13827
|
+
"type": "string",
|
|
13828
|
+
"enum": [
|
|
13829
|
+
"PT15M",
|
|
13830
|
+
"PT1H",
|
|
13831
|
+
"P1D",
|
|
13832
|
+
"P1M"
|
|
13833
|
+
]
|
|
13834
|
+
}
|
|
13835
|
+
},
|
|
13836
|
+
"data_range": {
|
|
13837
|
+
"$ref": "#/components/schemas/VisualizationDataRange"
|
|
13838
|
+
}
|
|
13839
|
+
}
|
|
13840
|
+
},
|
|
13841
|
+
"VisualizationTypeOption": {
|
|
13842
|
+
"type": "object",
|
|
13843
|
+
"properties": {
|
|
13844
|
+
"id": {
|
|
13845
|
+
"type": "string",
|
|
13846
|
+
"description": "Identifier of the type. Matches the `type` field on the data hook response."
|
|
13847
|
+
},
|
|
13848
|
+
"label": {
|
|
13849
|
+
"type": "object",
|
|
13850
|
+
"additionalProperties": {
|
|
13851
|
+
"type": "string"
|
|
13852
|
+
},
|
|
13853
|
+
"description": "Localized label for the type, keyed by ISO 3166-1 alpha-2 language code."
|
|
13854
|
+
},
|
|
13855
|
+
"aggregation_group": {
|
|
13856
|
+
"type": "string",
|
|
13857
|
+
"description": "Optional grouping key. Types in the same `aggregation_group` are visually combined; types in different groups (or without a group) render separately. How they combine depends on `statistical_method`:\n - bar chart (`sum`): same-group types are stacked into a single bar (e.g. ht/nt\n summed into total consumption); different-group types render side-by-side.\n - line chart (`min` / `average` / `max`): same-group types are rendered as an\n area chart; different-group types render as separate lines.\n"
|
|
13858
|
+
},
|
|
13859
|
+
"unit": {
|
|
13860
|
+
"type": "string",
|
|
13861
|
+
"description": "Unit shared by all values of this type (e.g. \"kWh\")."
|
|
13862
|
+
}
|
|
13863
|
+
},
|
|
13864
|
+
"required": [
|
|
13865
|
+
"id"
|
|
13866
|
+
]
|
|
13867
|
+
},
|
|
13868
|
+
"VisualizationDataRange": {
|
|
13869
|
+
"type": "object",
|
|
13870
|
+
"description": "Earliest / latest timestamps for which data is available in the current context.",
|
|
13871
|
+
"properties": {
|
|
13872
|
+
"from": {
|
|
13873
|
+
"type": "string",
|
|
13874
|
+
"format": "date-time",
|
|
13875
|
+
"description": "ISO 8601 timestamp of the earliest available data point."
|
|
13876
|
+
},
|
|
13877
|
+
"to": {
|
|
13878
|
+
"type": "string",
|
|
13879
|
+
"format": "date-time",
|
|
13880
|
+
"description": "ISO 8601 timestamp of the latest available data point."
|
|
13707
13881
|
}
|
|
13708
13882
|
}
|
|
13709
13883
|
},
|
|
@@ -13906,6 +14080,9 @@
|
|
|
13906
14080
|
},
|
|
13907
14081
|
{
|
|
13908
14082
|
"$ref": "#/components/schemas/ExtensionHookMeterReadingPlausibilityCheck"
|
|
14083
|
+
},
|
|
14084
|
+
{
|
|
14085
|
+
"$ref": "#/components/schemas/ExtensionHookVisualizationMetadata"
|
|
13909
14086
|
}
|
|
13910
14087
|
]
|
|
13911
14088
|
}
|
|
@@ -14458,6 +14635,82 @@
|
|
|
14458
14635
|
"dataExport"
|
|
14459
14636
|
]
|
|
14460
14637
|
},
|
|
14638
|
+
"block_types": {
|
|
14639
|
+
"type": "array",
|
|
14640
|
+
"description": "Optional list of portal block types this hook supports. If omitted,\nthe hook is usable on any export-capable block. Allowed values match\nthe block type identifiers used by the portal builder\n(e.g. `consumption_visualization`, `dynamic_tariff`).\n",
|
|
14641
|
+
"items": {
|
|
14642
|
+
"type": "string"
|
|
14643
|
+
}
|
|
14644
|
+
},
|
|
14645
|
+
"auth": {
|
|
14646
|
+
"$ref": "#/components/schemas/ExtensionAuthBlock"
|
|
14647
|
+
},
|
|
14648
|
+
"call": {
|
|
14649
|
+
"type": "object",
|
|
14650
|
+
"properties": {
|
|
14651
|
+
"method": {
|
|
14652
|
+
"type": "string",
|
|
14653
|
+
"description": "HTTP method to use for the call",
|
|
14654
|
+
"default": "GET"
|
|
14655
|
+
},
|
|
14656
|
+
"url": {
|
|
14657
|
+
"type": "string",
|
|
14658
|
+
"description": "URL to call. Supports variable interpolation."
|
|
14659
|
+
},
|
|
14660
|
+
"params": {
|
|
14661
|
+
"type": "object",
|
|
14662
|
+
"description": "Parameters to append to the URL. Supports variable interpolation.",
|
|
14663
|
+
"additionalProperties": {
|
|
14664
|
+
"type": "string"
|
|
14665
|
+
},
|
|
14666
|
+
"default": {}
|
|
14667
|
+
},
|
|
14668
|
+
"headers": {
|
|
14669
|
+
"type": "object",
|
|
14670
|
+
"description": "Headers to use. Supports variable interpolation.",
|
|
14671
|
+
"additionalProperties": {
|
|
14672
|
+
"type": "string"
|
|
14673
|
+
},
|
|
14674
|
+
"default": {}
|
|
14675
|
+
},
|
|
14676
|
+
"body": {
|
|
14677
|
+
"type": "object",
|
|
14678
|
+
"description": "Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.",
|
|
14679
|
+
"additionalProperties": {
|
|
14680
|
+
"type": "string"
|
|
14681
|
+
},
|
|
14682
|
+
"default": {}
|
|
14683
|
+
}
|
|
14684
|
+
},
|
|
14685
|
+
"required": [
|
|
14686
|
+
"url"
|
|
14687
|
+
]
|
|
14688
|
+
},
|
|
14689
|
+
"use_static_ips": {
|
|
14690
|
+
"type": "boolean",
|
|
14691
|
+
"deprecated": true,
|
|
14692
|
+
"description": "Deprecated. Prefer `secure_proxy` instead.\nIf 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.\n",
|
|
14693
|
+
"default": false
|
|
14694
|
+
},
|
|
14695
|
+
"secure_proxy": {
|
|
14696
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
14697
|
+
}
|
|
14698
|
+
},
|
|
14699
|
+
"required": [
|
|
14700
|
+
"type",
|
|
14701
|
+
"call"
|
|
14702
|
+
]
|
|
14703
|
+
},
|
|
14704
|
+
"ExtensionHookVisualizationMetadata": {
|
|
14705
|
+
"description": "Hook that returns runtime metadata describing how a visualization should be rendered for a given portal context. Invoked by the portal before fetching data, with the same context the data hook receives.\n",
|
|
14706
|
+
"type": "object",
|
|
14707
|
+
"properties": {
|
|
14708
|
+
"type": {
|
|
14709
|
+
"type": "string",
|
|
14710
|
+
"enum": [
|
|
14711
|
+
"visualizationMetadata"
|
|
14712
|
+
]
|
|
14713
|
+
},
|
|
14461
14714
|
"auth": {
|
|
14462
14715
|
"$ref": "#/components/schemas/ExtensionAuthBlock"
|
|
14463
14716
|
},
|
|
@@ -14502,6 +14755,15 @@
|
|
|
14502
14755
|
"url"
|
|
14503
14756
|
]
|
|
14504
14757
|
},
|
|
14758
|
+
"resolved": {
|
|
14759
|
+
"type": "object",
|
|
14760
|
+
"properties": {
|
|
14761
|
+
"dataPath": {
|
|
14762
|
+
"type": "string",
|
|
14763
|
+
"description": "Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level."
|
|
14764
|
+
}
|
|
14765
|
+
}
|
|
14766
|
+
},
|
|
14505
14767
|
"use_static_ips": {
|
|
14506
14768
|
"type": "boolean",
|
|
14507
14769
|
"deprecated": true,
|