@epilot/customer-portal-client 0.38.4 → 0.38.6
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 +23 -0
- package/dist/openapi.d.ts +178 -8
- package/package.json +1 -1
- package/src/openapi-runtime.json +23 -0
- package/src/openapi.json +233 -12
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":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/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})})();
|
|
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})})();
|
|
@@ -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",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -3192,7 +3192,11 @@ declare namespace Components {
|
|
|
3192
3192
|
* - valid: false
|
|
3193
3193
|
*
|
|
3194
3194
|
*/
|
|
3195
|
-
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))[];
|
|
3196
3200
|
}
|
|
3197
3201
|
export interface ExtensionAuthBlock {
|
|
3198
3202
|
/**
|
|
@@ -3696,6 +3700,55 @@ declare namespace Components {
|
|
|
3696
3700
|
*/
|
|
3697
3701
|
hook_id: string;
|
|
3698
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
|
+
}
|
|
3699
3752
|
export interface ExtensionSeamlessLink {
|
|
3700
3753
|
/**
|
|
3701
3754
|
* Identifier of the link. Should not change between updates.
|
|
@@ -6286,7 +6339,10 @@ declare namespace Components {
|
|
|
6286
6339
|
en: string;
|
|
6287
6340
|
};
|
|
6288
6341
|
/**
|
|
6289
|
-
*
|
|
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
|
+
*
|
|
6290
6346
|
*/
|
|
6291
6347
|
intervals?: string[];
|
|
6292
6348
|
/**
|
|
@@ -7724,6 +7780,65 @@ declare namespace Components {
|
|
|
7724
7780
|
*/
|
|
7725
7781
|
EntityId /* uuid */;
|
|
7726
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
|
+
* Intervals supported for the current context. If omitted, all intervals are assumed supported.
|
|
7808
|
+
*/
|
|
7809
|
+
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
|
|
7810
|
+
data_range?: /* Earliest / latest timestamps for which data is available in the current context. */ VisualizationDataRange;
|
|
7811
|
+
}
|
|
7812
|
+
export interface VisualizationTypeOption {
|
|
7813
|
+
/**
|
|
7814
|
+
* Identifier of the type. Matches the `type` field on the data hook response.
|
|
7815
|
+
*/
|
|
7816
|
+
id: string;
|
|
7817
|
+
/**
|
|
7818
|
+
* Localized label for the type, keyed by ISO 3166-1 alpha-2 language code.
|
|
7819
|
+
*/
|
|
7820
|
+
label?: {
|
|
7821
|
+
[name: string]: string;
|
|
7822
|
+
};
|
|
7823
|
+
/**
|
|
7824
|
+
* 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 each type's `statistical_method`:
|
|
7825
|
+
* - bar chart (`sum`): same-group types are stacked into a single bar (e.g. ht/nt
|
|
7826
|
+
* summed into total consumption); different-group types render side-by-side.
|
|
7827
|
+
* - line chart (`min` / `average` / `max`): same-group types are rendered as an
|
|
7828
|
+
* area chart; different-group types render as separate lines.
|
|
7829
|
+
*
|
|
7830
|
+
*/
|
|
7831
|
+
aggregation_group?: string;
|
|
7832
|
+
/**
|
|
7833
|
+
* Statistical method already applied to this type's data. Determines the chart shape used to render the type's values: `sum` is shown as a bar chart; `min`, `average`, and `max` are shown as a line chart. Each type advertises its own method, so a single visualization can mix bar-shaped types with line-shaped types. Defaults to `sum` when omitted.
|
|
7834
|
+
*
|
|
7835
|
+
*/
|
|
7836
|
+
statistical_method?: "sum" | "average" | "min" | "max";
|
|
7837
|
+
/**
|
|
7838
|
+
* Unit shared by all values of this type (e.g. "kWh").
|
|
7839
|
+
*/
|
|
7840
|
+
unit?: string;
|
|
7841
|
+
}
|
|
7727
7842
|
export interface WidgetAction {
|
|
7728
7843
|
_id: string;
|
|
7729
7844
|
type: "link" | "journey";
|
|
@@ -9250,12 +9365,6 @@ declare namespace Paths {
|
|
|
9250
9365
|
* nt
|
|
9251
9366
|
*/
|
|
9252
9367
|
type?: string;
|
|
9253
|
-
/**
|
|
9254
|
-
* The method used to aggregate the consumption data. Assumed default is 'sum'.
|
|
9255
|
-
* example:
|
|
9256
|
-
* sum
|
|
9257
|
-
*/
|
|
9258
|
-
aggregation_method?: "sum" | "average" | "max" | "min";
|
|
9259
9368
|
/**
|
|
9260
9369
|
* Optional unit of the consumption value. Defaults to unit present on the relevant Meter Counter.
|
|
9261
9370
|
* example:
|
|
@@ -12014,6 +12123,39 @@ declare namespace Paths {
|
|
|
12014
12123
|
export type $500 = Components.Responses.InternalServerError;
|
|
12015
12124
|
}
|
|
12016
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
|
+
}
|
|
12017
12159
|
namespace InterpolatePortalPages {
|
|
12018
12160
|
export interface RequestBody {
|
|
12019
12161
|
/**
|
|
@@ -13701,6 +13843,17 @@ export interface OperationMethods {
|
|
|
13701
13843
|
data?: Paths.PrepareVisualizationExport.RequestBody,
|
|
13702
13844
|
config?: AxiosRequestConfig
|
|
13703
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>
|
|
13704
13857
|
/**
|
|
13705
13858
|
* getCosts - Get Costs
|
|
13706
13859
|
*
|
|
@@ -15221,6 +15374,19 @@ export interface PathsDictionary {
|
|
|
15221
15374
|
config?: AxiosRequestConfig
|
|
15222
15375
|
): OperationResponse<Paths.PrepareVisualizationExport.Responses.$200>
|
|
15223
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
|
+
}
|
|
15224
15390
|
['/v2/portal/costs']: {
|
|
15225
15391
|
/**
|
|
15226
15392
|
* getCosts - Get Costs
|
|
@@ -16857,6 +17023,7 @@ export type ExtensionHookMeterReadingPlausibilityCheck = Components.Schemas.Exte
|
|
|
16857
17023
|
export type ExtensionHookPriceDataRetrieval = Components.Schemas.ExtensionHookPriceDataRetrieval;
|
|
16858
17024
|
export type ExtensionHookRegistrationIdentifiersCheck = Components.Schemas.ExtensionHookRegistrationIdentifiersCheck;
|
|
16859
17025
|
export type ExtensionHookSelection = Components.Schemas.ExtensionHookSelection;
|
|
17026
|
+
export type ExtensionHookVisualizationMetadata = Components.Schemas.ExtensionHookVisualizationMetadata;
|
|
16860
17027
|
export type ExtensionSeamlessLink = Components.Schemas.ExtensionSeamlessLink;
|
|
16861
17028
|
export type ExternalLink = Components.Schemas.ExternalLink;
|
|
16862
17029
|
export type ExtraSchemaAttributes = Components.Schemas.ExtraSchemaAttributes;
|
|
@@ -16927,6 +17094,9 @@ export type UpsertPortalConfig = Components.Schemas.UpsertPortalConfig;
|
|
|
16927
17094
|
export type UpsertPortalConfigV3 = Components.Schemas.UpsertPortalConfigV3;
|
|
16928
17095
|
export type UpsertPortalWidget = Components.Schemas.UpsertPortalWidget;
|
|
16929
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;
|
|
16930
17100
|
export type WidgetAction = Components.Schemas.WidgetAction;
|
|
16931
17101
|
export type WidgetBase = Components.Schemas.WidgetBase;
|
|
16932
17102
|
export type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
|
package/package.json
CHANGED
package/src/openapi-runtime.json
CHANGED
|
@@ -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",
|
package/src/openapi.json
CHANGED
|
@@ -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.",
|
|
@@ -965,6 +954,74 @@
|
|
|
965
954
|
}
|
|
966
955
|
}
|
|
967
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
|
+
},
|
|
968
1025
|
"/v2/portal/costs": {
|
|
969
1026
|
"get": {
|
|
970
1027
|
"operationId": "getCosts",
|
|
@@ -13727,10 +13784,11 @@
|
|
|
13727
13784
|
},
|
|
13728
13785
|
"intervals": {
|
|
13729
13786
|
"type": "array",
|
|
13787
|
+
"deprecated": true,
|
|
13730
13788
|
"items": {
|
|
13731
13789
|
"type": "string"
|
|
13732
13790
|
},
|
|
13733
|
-
"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"
|
|
13734
13792
|
},
|
|
13735
13793
|
"block_types": {
|
|
13736
13794
|
"type": "array",
|
|
@@ -13741,6 +13799,88 @@
|
|
|
13741
13799
|
}
|
|
13742
13800
|
}
|
|
13743
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
|
+
"intervals": {
|
|
13814
|
+
"type": "array",
|
|
13815
|
+
"description": "Intervals supported for the current context. If omitted, all intervals are assumed supported.",
|
|
13816
|
+
"items": {
|
|
13817
|
+
"type": "string",
|
|
13818
|
+
"enum": [
|
|
13819
|
+
"PT15M",
|
|
13820
|
+
"PT1H",
|
|
13821
|
+
"P1D",
|
|
13822
|
+
"P1M"
|
|
13823
|
+
]
|
|
13824
|
+
}
|
|
13825
|
+
},
|
|
13826
|
+
"data_range": {
|
|
13827
|
+
"$ref": "#/components/schemas/VisualizationDataRange"
|
|
13828
|
+
}
|
|
13829
|
+
}
|
|
13830
|
+
},
|
|
13831
|
+
"VisualizationTypeOption": {
|
|
13832
|
+
"type": "object",
|
|
13833
|
+
"properties": {
|
|
13834
|
+
"id": {
|
|
13835
|
+
"type": "string",
|
|
13836
|
+
"description": "Identifier of the type. Matches the `type` field on the data hook response."
|
|
13837
|
+
},
|
|
13838
|
+
"label": {
|
|
13839
|
+
"type": "object",
|
|
13840
|
+
"additionalProperties": {
|
|
13841
|
+
"type": "string"
|
|
13842
|
+
},
|
|
13843
|
+
"description": "Localized label for the type, keyed by ISO 3166-1 alpha-2 language code."
|
|
13844
|
+
},
|
|
13845
|
+
"aggregation_group": {
|
|
13846
|
+
"type": "string",
|
|
13847
|
+
"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 each type's `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"
|
|
13848
|
+
},
|
|
13849
|
+
"statistical_method": {
|
|
13850
|
+
"type": "string",
|
|
13851
|
+
"enum": [
|
|
13852
|
+
"sum",
|
|
13853
|
+
"average",
|
|
13854
|
+
"min",
|
|
13855
|
+
"max"
|
|
13856
|
+
],
|
|
13857
|
+
"description": "Statistical method already applied to this type's data. Determines the chart shape used to render the type's values: `sum` is shown as a bar chart; `min`, `average`, and `max` are shown as a line chart. Each type advertises its own method, so a single visualization can mix bar-shaped types with line-shaped types. Defaults to `sum` when omitted.\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."
|
|
13881
|
+
}
|
|
13882
|
+
}
|
|
13883
|
+
},
|
|
13744
13884
|
"PublicContractIdentificationDetails": {
|
|
13745
13885
|
"type": "object",
|
|
13746
13886
|
"properties": {
|
|
@@ -13940,6 +14080,9 @@
|
|
|
13940
14080
|
},
|
|
13941
14081
|
{
|
|
13942
14082
|
"$ref": "#/components/schemas/ExtensionHookMeterReadingPlausibilityCheck"
|
|
14083
|
+
},
|
|
14084
|
+
{
|
|
14085
|
+
"$ref": "#/components/schemas/ExtensionHookVisualizationMetadata"
|
|
13943
14086
|
}
|
|
13944
14087
|
]
|
|
13945
14088
|
}
|
|
@@ -14558,6 +14701,84 @@
|
|
|
14558
14701
|
"call"
|
|
14559
14702
|
]
|
|
14560
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
|
+
},
|
|
14714
|
+
"auth": {
|
|
14715
|
+
"$ref": "#/components/schemas/ExtensionAuthBlock"
|
|
14716
|
+
},
|
|
14717
|
+
"call": {
|
|
14718
|
+
"type": "object",
|
|
14719
|
+
"properties": {
|
|
14720
|
+
"method": {
|
|
14721
|
+
"type": "string",
|
|
14722
|
+
"description": "HTTP method to use for the call",
|
|
14723
|
+
"default": "GET"
|
|
14724
|
+
},
|
|
14725
|
+
"url": {
|
|
14726
|
+
"type": "string",
|
|
14727
|
+
"description": "URL to call. Supports variable interpolation."
|
|
14728
|
+
},
|
|
14729
|
+
"params": {
|
|
14730
|
+
"type": "object",
|
|
14731
|
+
"description": "Parameters to append to the URL. Supports variable interpolation.",
|
|
14732
|
+
"additionalProperties": {
|
|
14733
|
+
"type": "string"
|
|
14734
|
+
},
|
|
14735
|
+
"default": {}
|
|
14736
|
+
},
|
|
14737
|
+
"headers": {
|
|
14738
|
+
"type": "object",
|
|
14739
|
+
"description": "Headers to use. Supports variable interpolation.",
|
|
14740
|
+
"additionalProperties": {
|
|
14741
|
+
"type": "string"
|
|
14742
|
+
},
|
|
14743
|
+
"default": {}
|
|
14744
|
+
},
|
|
14745
|
+
"body": {
|
|
14746
|
+
"type": "object",
|
|
14747
|
+
"description": "Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.",
|
|
14748
|
+
"additionalProperties": {
|
|
14749
|
+
"type": "string"
|
|
14750
|
+
},
|
|
14751
|
+
"default": {}
|
|
14752
|
+
}
|
|
14753
|
+
},
|
|
14754
|
+
"required": [
|
|
14755
|
+
"url"
|
|
14756
|
+
]
|
|
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
|
+
},
|
|
14767
|
+
"use_static_ips": {
|
|
14768
|
+
"type": "boolean",
|
|
14769
|
+
"deprecated": true,
|
|
14770
|
+
"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",
|
|
14771
|
+
"default": false
|
|
14772
|
+
},
|
|
14773
|
+
"secure_proxy": {
|
|
14774
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
14775
|
+
}
|
|
14776
|
+
},
|
|
14777
|
+
"required": [
|
|
14778
|
+
"type",
|
|
14779
|
+
"call"
|
|
14780
|
+
]
|
|
14781
|
+
},
|
|
14561
14782
|
"ExtensionHookCostDataRetrieval": {
|
|
14562
14783
|
"description": "Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:\n - 200 with the time series data\n",
|
|
14563
14784
|
"type": "object",
|