@epilot/customer-portal-client 0.38.2 → 0.38.4
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 +15 -3
- package/dist/openapi.d.ts +178 -3
- package/package.json +1 -1
- package/src/openapi-runtime.json +15 -3
- package/src/openapi.json +242 -12
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={438(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/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}(438),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/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",
|
|
@@ -244,6 +244,18 @@
|
|
|
244
244
|
"responses": {}
|
|
245
245
|
}
|
|
246
246
|
},
|
|
247
|
+
"/v2/portal/visualization:export": {
|
|
248
|
+
"post": {
|
|
249
|
+
"operationId": "prepareVisualizationExport",
|
|
250
|
+
"requestBody": {
|
|
251
|
+
"required": true,
|
|
252
|
+
"content": {
|
|
253
|
+
"application/json": {}
|
|
254
|
+
}
|
|
255
|
+
},
|
|
256
|
+
"responses": {}
|
|
257
|
+
}
|
|
258
|
+
},
|
|
247
259
|
"/v2/portal/costs": {
|
|
248
260
|
"get": {
|
|
249
261
|
"operationId": "getCosts",
|
|
@@ -261,7 +273,7 @@
|
|
|
261
273
|
{
|
|
262
274
|
"in": "query",
|
|
263
275
|
"name": "hookId",
|
|
264
|
-
"required":
|
|
276
|
+
"required": false
|
|
265
277
|
},
|
|
266
278
|
{
|
|
267
279
|
"in": "query",
|
|
@@ -310,7 +322,7 @@
|
|
|
310
322
|
{
|
|
311
323
|
"in": "query",
|
|
312
324
|
"name": "hookId",
|
|
313
|
-
"required":
|
|
325
|
+
"required": false
|
|
314
326
|
},
|
|
315
327
|
{
|
|
316
328
|
"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
|
}
|
|
@@ -3173,6 +3174,11 @@ declare namespace Components {
|
|
|
3173
3174
|
*
|
|
3174
3175
|
*/
|
|
3175
3176
|
ExtensionHookConsumptionDataRetrieval | /**
|
|
3177
|
+
* Generic data export hook. When configured on a visualization block, the portal delegates the export action (e.g. CSV/Excel/PDF download) to the configured external source instead of generating the file itself. Can be used by any block that supports export — consumption charts, dynamic tariff charts, etc. The expected response to the call is:
|
|
3178
|
+
* - 200 with a JSON body describing the exported file (download_url, optional filename, content_type, expires_at)
|
|
3179
|
+
*
|
|
3180
|
+
*/
|
|
3181
|
+
ExtensionHookDataExport | /**
|
|
3176
3182
|
* 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:
|
|
3177
3183
|
* - 200 with the time series data
|
|
3178
3184
|
*
|
|
@@ -3295,7 +3301,9 @@ declare namespace Components {
|
|
|
3295
3301
|
dataPath?: string;
|
|
3296
3302
|
};
|
|
3297
3303
|
/**
|
|
3304
|
+
* Deprecated. Prefer `secure_proxy` instead.
|
|
3298
3305
|
* 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.
|
|
3306
|
+
*
|
|
3299
3307
|
*/
|
|
3300
3308
|
use_static_ips?: boolean;
|
|
3301
3309
|
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
@@ -3372,7 +3380,9 @@ declare namespace Components {
|
|
|
3372
3380
|
en: string;
|
|
3373
3381
|
};
|
|
3374
3382
|
/**
|
|
3383
|
+
* Deprecated. Prefer `secure_proxy` instead.
|
|
3375
3384
|
* 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.
|
|
3385
|
+
*
|
|
3376
3386
|
*/
|
|
3377
3387
|
use_static_ips?: boolean;
|
|
3378
3388
|
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
@@ -3420,7 +3430,61 @@ declare namespace Components {
|
|
|
3420
3430
|
dataPath?: string;
|
|
3421
3431
|
};
|
|
3422
3432
|
/**
|
|
3433
|
+
* Deprecated. Prefer `secure_proxy` instead.
|
|
3434
|
+
* 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.
|
|
3435
|
+
*
|
|
3436
|
+
*/
|
|
3437
|
+
use_static_ips?: boolean;
|
|
3438
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3439
|
+
}
|
|
3440
|
+
/**
|
|
3441
|
+
* Generic data export hook. When configured on a visualization block, the portal delegates the export action (e.g. CSV/Excel/PDF download) to the configured external source instead of generating the file itself. Can be used by any block that supports export — consumption charts, dynamic tariff charts, etc. The expected response to the call is:
|
|
3442
|
+
* - 200 with a JSON body describing the exported file (download_url, optional filename, content_type, expires_at)
|
|
3443
|
+
*
|
|
3444
|
+
*/
|
|
3445
|
+
export interface ExtensionHookDataExport {
|
|
3446
|
+
type: "dataExport";
|
|
3447
|
+
/**
|
|
3448
|
+
* Optional list of portal block types this hook supports. If omitted,
|
|
3449
|
+
* the hook is usable on any export-capable block. Allowed values match
|
|
3450
|
+
* the block type identifiers used by the portal builder
|
|
3451
|
+
* (e.g. `consumption_visualization`, `dynamic_tariff`).
|
|
3452
|
+
*
|
|
3453
|
+
*/
|
|
3454
|
+
block_types?: string[];
|
|
3455
|
+
auth?: ExtensionAuthBlock;
|
|
3456
|
+
call: {
|
|
3457
|
+
/**
|
|
3458
|
+
* HTTP method to use for the call
|
|
3459
|
+
*/
|
|
3460
|
+
method?: string;
|
|
3461
|
+
/**
|
|
3462
|
+
* URL to call. Supports variable interpolation.
|
|
3463
|
+
*/
|
|
3464
|
+
url: string;
|
|
3465
|
+
/**
|
|
3466
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
3467
|
+
*/
|
|
3468
|
+
params?: {
|
|
3469
|
+
[name: string]: string;
|
|
3470
|
+
};
|
|
3471
|
+
/**
|
|
3472
|
+
* Headers to use. Supports variable interpolation.
|
|
3473
|
+
*/
|
|
3474
|
+
headers?: {
|
|
3475
|
+
[name: string]: string;
|
|
3476
|
+
};
|
|
3477
|
+
/**
|
|
3478
|
+
* Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.
|
|
3479
|
+
*/
|
|
3480
|
+
body?: {
|
|
3481
|
+
[name: string]: string;
|
|
3482
|
+
};
|
|
3483
|
+
};
|
|
3484
|
+
/**
|
|
3485
|
+
* Deprecated. Prefer `secure_proxy` instead.
|
|
3423
3486
|
* 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.
|
|
3487
|
+
*
|
|
3424
3488
|
*/
|
|
3425
3489
|
use_static_ips?: boolean;
|
|
3426
3490
|
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
@@ -3512,7 +3576,9 @@ declare namespace Components {
|
|
|
3512
3576
|
lower_limit?: string;
|
|
3513
3577
|
};
|
|
3514
3578
|
/**
|
|
3579
|
+
* Deprecated. Prefer `secure_proxy` instead.
|
|
3515
3580
|
* 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.
|
|
3581
|
+
*
|
|
3516
3582
|
*/
|
|
3517
3583
|
use_static_ips?: boolean;
|
|
3518
3584
|
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
@@ -3560,7 +3626,9 @@ declare namespace Components {
|
|
|
3560
3626
|
dataPath?: string;
|
|
3561
3627
|
};
|
|
3562
3628
|
/**
|
|
3629
|
+
* Deprecated. Prefer `secure_proxy` instead.
|
|
3563
3630
|
* 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.
|
|
3631
|
+
*
|
|
3564
3632
|
*/
|
|
3565
3633
|
use_static_ips?: boolean;
|
|
3566
3634
|
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
@@ -3607,7 +3675,9 @@ declare namespace Components {
|
|
|
3607
3675
|
result?: string;
|
|
3608
3676
|
};
|
|
3609
3677
|
/**
|
|
3678
|
+
* Deprecated. Prefer `secure_proxy` instead.
|
|
3610
3679
|
* 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.
|
|
3680
|
+
*
|
|
3611
3681
|
*/
|
|
3612
3682
|
use_static_ips?: boolean;
|
|
3613
3683
|
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
@@ -6176,6 +6246,19 @@ declare namespace Components {
|
|
|
6176
6246
|
* office-365-login
|
|
6177
6247
|
*/
|
|
6178
6248
|
export type ProviderSlug = string; // [0-9a-z-]+
|
|
6249
|
+
export interface PublicAppDetails {
|
|
6250
|
+
/**
|
|
6251
|
+
* Identifier of the app.
|
|
6252
|
+
*/
|
|
6253
|
+
app_id?: string;
|
|
6254
|
+
name?: {
|
|
6255
|
+
[name: string]: string;
|
|
6256
|
+
/**
|
|
6257
|
+
* Name of the app in English.
|
|
6258
|
+
*/
|
|
6259
|
+
en: string;
|
|
6260
|
+
};
|
|
6261
|
+
}
|
|
6179
6262
|
export interface PublicContractIdentificationDetails {
|
|
6180
6263
|
/**
|
|
6181
6264
|
* Explanation of the hook.
|
|
@@ -6206,9 +6289,14 @@ declare namespace Components {
|
|
|
6206
6289
|
* The intervals associated with the hook.
|
|
6207
6290
|
*/
|
|
6208
6291
|
intervals?: string[];
|
|
6292
|
+
/**
|
|
6293
|
+
* Optional list of portal block types the hook supports. Empty/missing means the hook is usable on any export-capable block.
|
|
6294
|
+
*/
|
|
6295
|
+
block_types?: string[];
|
|
6209
6296
|
}
|
|
6210
6297
|
export interface PublicExtensionCapabilities {
|
|
6211
6298
|
consumptionDataRetrieval?: DataRetrievalItem[];
|
|
6299
|
+
dataExport?: DataRetrievalItem[];
|
|
6212
6300
|
priceDataRetrieval?: DataRetrievalItem[];
|
|
6213
6301
|
costDataRetrieval?: DataRetrievalItem[];
|
|
6214
6302
|
contractIdentification?: {
|
|
@@ -9138,7 +9226,7 @@ declare namespace Paths {
|
|
|
9138
9226
|
export interface QueryParameters {
|
|
9139
9227
|
app_id?: Parameters.AppId;
|
|
9140
9228
|
extensionId: Parameters.ExtensionId;
|
|
9141
|
-
hookId
|
|
9229
|
+
hookId?: Parameters.HookId;
|
|
9142
9230
|
meter_id?: Parameters.MeterId;
|
|
9143
9231
|
from: Parameters.From /* date-time */;
|
|
9144
9232
|
to: Parameters.To /* date-time */;
|
|
@@ -9308,7 +9396,7 @@ declare namespace Paths {
|
|
|
9308
9396
|
export interface QueryParameters {
|
|
9309
9397
|
app_id?: Parameters.AppId;
|
|
9310
9398
|
extensionId: Parameters.ExtensionId;
|
|
9311
|
-
hookId
|
|
9399
|
+
hookId?: Parameters.HookId;
|
|
9312
9400
|
meter_id?: Parameters.MeterId;
|
|
9313
9401
|
from: Parameters.From /* date-time */;
|
|
9314
9402
|
to: Parameters.To /* date-time */;
|
|
@@ -11170,7 +11258,7 @@ declare namespace Paths {
|
|
|
11170
11258
|
export interface QueryParameters {
|
|
11171
11259
|
app_id?: Parameters.AppId;
|
|
11172
11260
|
extensionId: Parameters.ExtensionId;
|
|
11173
|
-
hookId
|
|
11261
|
+
hookId?: Parameters.HookId;
|
|
11174
11262
|
meter_id?: Parameters.MeterId;
|
|
11175
11263
|
from: Parameters.From /* date-time */;
|
|
11176
11264
|
to: Parameters.To /* date-time */;
|
|
@@ -12126,6 +12214,67 @@ declare namespace Paths {
|
|
|
12126
12214
|
export type $500 = Components.Responses.InternalServerError;
|
|
12127
12215
|
}
|
|
12128
12216
|
}
|
|
12217
|
+
namespace PrepareVisualizationExport {
|
|
12218
|
+
export interface RequestBody {
|
|
12219
|
+
/**
|
|
12220
|
+
* App ID providing the dataExport hook.
|
|
12221
|
+
*/
|
|
12222
|
+
app_id: string;
|
|
12223
|
+
/**
|
|
12224
|
+
* Extension ID providing the dataExport hook.
|
|
12225
|
+
*/
|
|
12226
|
+
extension_id: string;
|
|
12227
|
+
/**
|
|
12228
|
+
* Optional Hook ID. If omitted, the only `dataExport` hook on the extension is used; if the extension has multiple `dataExport` hooks, this becomes required.
|
|
12229
|
+
*/
|
|
12230
|
+
hook_id?: string;
|
|
12231
|
+
/**
|
|
12232
|
+
* Optional start date for the export window (ISO 8601 format).
|
|
12233
|
+
*/
|
|
12234
|
+
from?: string; // date-time
|
|
12235
|
+
/**
|
|
12236
|
+
* Optional end date for the export window (ISO 8601 format).
|
|
12237
|
+
*/
|
|
12238
|
+
to?: string; // date-time
|
|
12239
|
+
context_entities?: /**
|
|
12240
|
+
* Additional entities to include in the context for variable interpolation. Portal User and Contact entities are automatically part of the context.
|
|
12241
|
+
* example:
|
|
12242
|
+
* [
|
|
12243
|
+
* {
|
|
12244
|
+
* "entity_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
12245
|
+
* "entity_schema": "contract"
|
|
12246
|
+
* }
|
|
12247
|
+
* ]
|
|
12248
|
+
*/
|
|
12249
|
+
Components.Schemas.ContextEntities;
|
|
12250
|
+
}
|
|
12251
|
+
namespace Responses {
|
|
12252
|
+
export interface $200 {
|
|
12253
|
+
/**
|
|
12254
|
+
* URL the client can use to download the exported file. May be a pre-signed or short-lived URL.
|
|
12255
|
+
*/
|
|
12256
|
+
download_url: string;
|
|
12257
|
+
/**
|
|
12258
|
+
* Suggested filename for the exported file.
|
|
12259
|
+
*/
|
|
12260
|
+
filename?: string;
|
|
12261
|
+
/**
|
|
12262
|
+
* MIME type of the exported file.
|
|
12263
|
+
* example:
|
|
12264
|
+
* text/csv
|
|
12265
|
+
*/
|
|
12266
|
+
content_type?: string;
|
|
12267
|
+
/**
|
|
12268
|
+
* Optional expiration timestamp for the download URL.
|
|
12269
|
+
*/
|
|
12270
|
+
expires_at?: string; // date-time
|
|
12271
|
+
}
|
|
12272
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
12273
|
+
export type $403 = Components.Responses.Forbidden;
|
|
12274
|
+
export type $404 = Components.Responses.NotFound;
|
|
12275
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
12276
|
+
}
|
|
12277
|
+
}
|
|
12129
12278
|
namespace PutPortalConfig {
|
|
12130
12279
|
namespace Parameters {
|
|
12131
12280
|
/**
|
|
@@ -13541,6 +13690,17 @@ export interface OperationMethods {
|
|
|
13541
13690
|
data?: any,
|
|
13542
13691
|
config?: AxiosRequestConfig
|
|
13543
13692
|
): OperationResponse<Paths.GetConsumption.Responses.$200>
|
|
13693
|
+
/**
|
|
13694
|
+
* prepareVisualizationExport - Prepare Visualization Export
|
|
13695
|
+
*
|
|
13696
|
+
* Asks an installed App to prepare a downloadable export of a visualization (consumption chart, dynamic tariff chart, etc.). The export is produced by the third-party App via a configured portal extension hook of type `dataExport` — this endpoint does not generate the file itself, it forwards the request to the configured hook and returns the descriptor the App provides (typically a `download_url`).
|
|
13697
|
+
*
|
|
13698
|
+
*/
|
|
13699
|
+
'prepareVisualizationExport'(
|
|
13700
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13701
|
+
data?: Paths.PrepareVisualizationExport.RequestBody,
|
|
13702
|
+
config?: AxiosRequestConfig
|
|
13703
|
+
): OperationResponse<Paths.PrepareVisualizationExport.Responses.$200>
|
|
13544
13704
|
/**
|
|
13545
13705
|
* getCosts - Get Costs
|
|
13546
13706
|
*
|
|
@@ -15048,6 +15208,19 @@ export interface PathsDictionary {
|
|
|
15048
15208
|
config?: AxiosRequestConfig
|
|
15049
15209
|
): OperationResponse<Paths.GetConsumption.Responses.$200>
|
|
15050
15210
|
}
|
|
15211
|
+
['/v2/portal/visualization:export']: {
|
|
15212
|
+
/**
|
|
15213
|
+
* prepareVisualizationExport - Prepare Visualization Export
|
|
15214
|
+
*
|
|
15215
|
+
* Asks an installed App to prepare a downloadable export of a visualization (consumption chart, dynamic tariff chart, etc.). The export is produced by the third-party App via a configured portal extension hook of type `dataExport` — this endpoint does not generate the file itself, it forwards the request to the configured hook and returns the descriptor the App provides (typically a `download_url`).
|
|
15216
|
+
*
|
|
15217
|
+
*/
|
|
15218
|
+
'post'(
|
|
15219
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
15220
|
+
data?: Paths.PrepareVisualizationExport.RequestBody,
|
|
15221
|
+
config?: AxiosRequestConfig
|
|
15222
|
+
): OperationResponse<Paths.PrepareVisualizationExport.Responses.$200>
|
|
15223
|
+
}
|
|
15051
15224
|
['/v2/portal/costs']: {
|
|
15052
15225
|
/**
|
|
15053
15226
|
* getCosts - Get Costs
|
|
@@ -16679,6 +16852,7 @@ export type ExtensionHook = Components.Schemas.ExtensionHook;
|
|
|
16679
16852
|
export type ExtensionHookConsumptionDataRetrieval = Components.Schemas.ExtensionHookConsumptionDataRetrieval;
|
|
16680
16853
|
export type ExtensionHookContractIdentification = Components.Schemas.ExtensionHookContractIdentification;
|
|
16681
16854
|
export type ExtensionHookCostDataRetrieval = Components.Schemas.ExtensionHookCostDataRetrieval;
|
|
16855
|
+
export type ExtensionHookDataExport = Components.Schemas.ExtensionHookDataExport;
|
|
16682
16856
|
export type ExtensionHookMeterReadingPlausibilityCheck = Components.Schemas.ExtensionHookMeterReadingPlausibilityCheck;
|
|
16683
16857
|
export type ExtensionHookPriceDataRetrieval = Components.Schemas.ExtensionHookPriceDataRetrieval;
|
|
16684
16858
|
export type ExtensionHookRegistrationIdentifiersCheck = Components.Schemas.ExtensionHookRegistrationIdentifiersCheck;
|
|
@@ -16722,6 +16896,7 @@ export type ProviderConfig = Components.Schemas.ProviderConfig;
|
|
|
16722
16896
|
export type ProviderDisplayName = Components.Schemas.ProviderDisplayName;
|
|
16723
16897
|
export type ProviderPublicConfig = Components.Schemas.ProviderPublicConfig;
|
|
16724
16898
|
export type ProviderSlug = Components.Schemas.ProviderSlug;
|
|
16899
|
+
export type PublicAppDetails = Components.Schemas.PublicAppDetails;
|
|
16725
16900
|
export type PublicContractIdentificationDetails = Components.Schemas.PublicContractIdentificationDetails;
|
|
16726
16901
|
export type PublicDataRetrievalHookDetails = Components.Schemas.PublicDataRetrievalHookDetails;
|
|
16727
16902
|
export type PublicExtensionCapabilities = Components.Schemas.PublicExtensionCapabilities;
|
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",
|
|
@@ -244,6 +244,18 @@
|
|
|
244
244
|
"responses": {}
|
|
245
245
|
}
|
|
246
246
|
},
|
|
247
|
+
"/v2/portal/visualization:export": {
|
|
248
|
+
"post": {
|
|
249
|
+
"operationId": "prepareVisualizationExport",
|
|
250
|
+
"requestBody": {
|
|
251
|
+
"required": true,
|
|
252
|
+
"content": {
|
|
253
|
+
"application/json": {}
|
|
254
|
+
}
|
|
255
|
+
},
|
|
256
|
+
"responses": {}
|
|
257
|
+
}
|
|
258
|
+
},
|
|
247
259
|
"/v2/portal/costs": {
|
|
248
260
|
"get": {
|
|
249
261
|
"operationId": "getCosts",
|
|
@@ -261,7 +273,7 @@
|
|
|
261
273
|
{
|
|
262
274
|
"in": "query",
|
|
263
275
|
"name": "hookId",
|
|
264
|
-
"required":
|
|
276
|
+
"required": false
|
|
265
277
|
},
|
|
266
278
|
{
|
|
267
279
|
"in": "query",
|
|
@@ -310,7 +322,7 @@
|
|
|
310
322
|
{
|
|
311
323
|
"in": "query",
|
|
312
324
|
"name": "hookId",
|
|
313
|
-
"required":
|
|
325
|
+
"required": false
|
|
314
326
|
},
|
|
315
327
|
{
|
|
316
328
|
"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",
|
|
@@ -861,6 +861,110 @@
|
|
|
861
861
|
}
|
|
862
862
|
}
|
|
863
863
|
},
|
|
864
|
+
"/v2/portal/visualization:export": {
|
|
865
|
+
"post": {
|
|
866
|
+
"operationId": "prepareVisualizationExport",
|
|
867
|
+
"summary": "Prepare Visualization Export",
|
|
868
|
+
"description": "Asks an installed App to prepare a downloadable export of a visualization (consumption chart, dynamic tariff chart, etc.). The export is produced by the third-party App via a configured portal extension hook of type `dataExport` — this endpoint does not generate the file itself, it forwards the request to the configured hook and returns the descriptor the App provides (typically a `download_url`).\n",
|
|
869
|
+
"tags": [
|
|
870
|
+
"ECP"
|
|
871
|
+
],
|
|
872
|
+
"security": [
|
|
873
|
+
{
|
|
874
|
+
"PortalAuth": []
|
|
875
|
+
}
|
|
876
|
+
],
|
|
877
|
+
"requestBody": {
|
|
878
|
+
"required": true,
|
|
879
|
+
"content": {
|
|
880
|
+
"application/json": {
|
|
881
|
+
"schema": {
|
|
882
|
+
"type": "object",
|
|
883
|
+
"properties": {
|
|
884
|
+
"app_id": {
|
|
885
|
+
"type": "string",
|
|
886
|
+
"description": "App ID providing the dataExport hook."
|
|
887
|
+
},
|
|
888
|
+
"extension_id": {
|
|
889
|
+
"type": "string",
|
|
890
|
+
"description": "Extension ID providing the dataExport hook."
|
|
891
|
+
},
|
|
892
|
+
"hook_id": {
|
|
893
|
+
"type": "string",
|
|
894
|
+
"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
|
+
},
|
|
896
|
+
"from": {
|
|
897
|
+
"type": "string",
|
|
898
|
+
"format": "date-time",
|
|
899
|
+
"description": "Optional start date for the export window (ISO 8601 format)."
|
|
900
|
+
},
|
|
901
|
+
"to": {
|
|
902
|
+
"type": "string",
|
|
903
|
+
"format": "date-time",
|
|
904
|
+
"description": "Optional end date for the export window (ISO 8601 format)."
|
|
905
|
+
},
|
|
906
|
+
"context_entities": {
|
|
907
|
+
"$ref": "#/components/schemas/ContextEntities"
|
|
908
|
+
}
|
|
909
|
+
},
|
|
910
|
+
"required": [
|
|
911
|
+
"app_id",
|
|
912
|
+
"extension_id"
|
|
913
|
+
],
|
|
914
|
+
"additionalProperties": false
|
|
915
|
+
}
|
|
916
|
+
}
|
|
917
|
+
}
|
|
918
|
+
},
|
|
919
|
+
"responses": {
|
|
920
|
+
"200": {
|
|
921
|
+
"description": "Export descriptor returned by the App.",
|
|
922
|
+
"content": {
|
|
923
|
+
"application/json": {
|
|
924
|
+
"schema": {
|
|
925
|
+
"type": "object",
|
|
926
|
+
"properties": {
|
|
927
|
+
"download_url": {
|
|
928
|
+
"type": "string",
|
|
929
|
+
"description": "URL the client can use to download the exported file. May be a pre-signed or short-lived URL."
|
|
930
|
+
},
|
|
931
|
+
"filename": {
|
|
932
|
+
"type": "string",
|
|
933
|
+
"description": "Suggested filename for the exported file."
|
|
934
|
+
},
|
|
935
|
+
"content_type": {
|
|
936
|
+
"type": "string",
|
|
937
|
+
"description": "MIME type of the exported file.",
|
|
938
|
+
"example": "text/csv"
|
|
939
|
+
},
|
|
940
|
+
"expires_at": {
|
|
941
|
+
"type": "string",
|
|
942
|
+
"format": "date-time",
|
|
943
|
+
"description": "Optional expiration timestamp for the download URL."
|
|
944
|
+
}
|
|
945
|
+
},
|
|
946
|
+
"required": [
|
|
947
|
+
"download_url"
|
|
948
|
+
]
|
|
949
|
+
}
|
|
950
|
+
}
|
|
951
|
+
}
|
|
952
|
+
},
|
|
953
|
+
"401": {
|
|
954
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
955
|
+
},
|
|
956
|
+
"403": {
|
|
957
|
+
"$ref": "#/components/responses/Forbidden"
|
|
958
|
+
},
|
|
959
|
+
"404": {
|
|
960
|
+
"$ref": "#/components/responses/NotFound"
|
|
961
|
+
},
|
|
962
|
+
"500": {
|
|
963
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
964
|
+
}
|
|
965
|
+
}
|
|
966
|
+
}
|
|
967
|
+
},
|
|
864
968
|
"/v2/portal/costs": {
|
|
865
969
|
"get": {
|
|
866
970
|
"operationId": "getCosts",
|
|
@@ -899,8 +1003,8 @@
|
|
|
899
1003
|
"schema": {
|
|
900
1004
|
"type": "string"
|
|
901
1005
|
},
|
|
902
|
-
"required":
|
|
903
|
-
"description": "Hook ID
|
|
1006
|
+
"required": false,
|
|
1007
|
+
"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."
|
|
904
1008
|
},
|
|
905
1009
|
{
|
|
906
1010
|
"in": "query",
|
|
@@ -1073,8 +1177,8 @@
|
|
|
1073
1177
|
"schema": {
|
|
1074
1178
|
"type": "string"
|
|
1075
1179
|
},
|
|
1076
|
-
"required":
|
|
1077
|
-
"description": "Hook ID
|
|
1180
|
+
"required": false,
|
|
1181
|
+
"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."
|
|
1078
1182
|
},
|
|
1079
1183
|
{
|
|
1080
1184
|
"in": "query",
|
|
@@ -13492,6 +13596,12 @@
|
|
|
13492
13596
|
"$ref": "#/components/schemas/DataRetrievalItem"
|
|
13493
13597
|
}
|
|
13494
13598
|
},
|
|
13599
|
+
"dataExport": {
|
|
13600
|
+
"type": "array",
|
|
13601
|
+
"items": {
|
|
13602
|
+
"$ref": "#/components/schemas/DataRetrievalItem"
|
|
13603
|
+
}
|
|
13604
|
+
},
|
|
13495
13605
|
"priceDataRetrieval": {
|
|
13496
13606
|
"type": "array",
|
|
13497
13607
|
"items": {
|
|
@@ -13531,6 +13641,9 @@
|
|
|
13531
13641
|
"DataRetrievalItem": {
|
|
13532
13642
|
"type": "object",
|
|
13533
13643
|
"properties": {
|
|
13644
|
+
"app": {
|
|
13645
|
+
"$ref": "#/components/schemas/PublicAppDetails"
|
|
13646
|
+
},
|
|
13534
13647
|
"extension": {
|
|
13535
13648
|
"$ref": "#/components/schemas/PublicExtensionDetails"
|
|
13536
13649
|
},
|
|
@@ -13539,6 +13652,31 @@
|
|
|
13539
13652
|
}
|
|
13540
13653
|
}
|
|
13541
13654
|
},
|
|
13655
|
+
"PublicAppDetails": {
|
|
13656
|
+
"type": "object",
|
|
13657
|
+
"properties": {
|
|
13658
|
+
"app_id": {
|
|
13659
|
+
"type": "string",
|
|
13660
|
+
"description": "Identifier of the app."
|
|
13661
|
+
},
|
|
13662
|
+
"name": {
|
|
13663
|
+
"type": "object",
|
|
13664
|
+
"properties": {
|
|
13665
|
+
"en": {
|
|
13666
|
+
"type": "string",
|
|
13667
|
+
"description": "Name of the app in English."
|
|
13668
|
+
}
|
|
13669
|
+
},
|
|
13670
|
+
"additionalProperties": {
|
|
13671
|
+
"type": "string",
|
|
13672
|
+
"description": "Name of the app in some other language denoted by ISO 3166-1 alpha-2 code."
|
|
13673
|
+
},
|
|
13674
|
+
"required": [
|
|
13675
|
+
"en"
|
|
13676
|
+
]
|
|
13677
|
+
}
|
|
13678
|
+
}
|
|
13679
|
+
},
|
|
13542
13680
|
"PublicExtensionDetails": {
|
|
13543
13681
|
"type": "object",
|
|
13544
13682
|
"properties": {
|
|
@@ -13593,6 +13731,13 @@
|
|
|
13593
13731
|
"type": "string"
|
|
13594
13732
|
},
|
|
13595
13733
|
"description": "The intervals associated with the hook."
|
|
13734
|
+
},
|
|
13735
|
+
"block_types": {
|
|
13736
|
+
"type": "array",
|
|
13737
|
+
"items": {
|
|
13738
|
+
"type": "string"
|
|
13739
|
+
},
|
|
13740
|
+
"description": "Optional list of portal block types the hook supports. Empty/missing means the hook is usable on any export-capable block."
|
|
13596
13741
|
}
|
|
13597
13742
|
}
|
|
13598
13743
|
},
|
|
@@ -13787,6 +13932,9 @@
|
|
|
13787
13932
|
{
|
|
13788
13933
|
"$ref": "#/components/schemas/ExtensionHookConsumptionDataRetrieval"
|
|
13789
13934
|
},
|
|
13935
|
+
{
|
|
13936
|
+
"$ref": "#/components/schemas/ExtensionHookDataExport"
|
|
13937
|
+
},
|
|
13790
13938
|
{
|
|
13791
13939
|
"$ref": "#/components/schemas/ExtensionHookCostDataRetrieval"
|
|
13792
13940
|
},
|
|
@@ -13950,7 +14098,8 @@
|
|
|
13950
14098
|
},
|
|
13951
14099
|
"use_static_ips": {
|
|
13952
14100
|
"type": "boolean",
|
|
13953
|
-
"
|
|
14101
|
+
"deprecated": true,
|
|
14102
|
+
"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",
|
|
13954
14103
|
"default": false
|
|
13955
14104
|
},
|
|
13956
14105
|
"secure_proxy": {
|
|
@@ -14052,7 +14201,8 @@
|
|
|
14052
14201
|
},
|
|
14053
14202
|
"use_static_ips": {
|
|
14054
14203
|
"type": "boolean",
|
|
14055
|
-
"
|
|
14204
|
+
"deprecated": true,
|
|
14205
|
+
"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",
|
|
14056
14206
|
"default": false
|
|
14057
14207
|
},
|
|
14058
14208
|
"secure_proxy": {
|
|
@@ -14162,7 +14312,8 @@
|
|
|
14162
14312
|
},
|
|
14163
14313
|
"use_static_ips": {
|
|
14164
14314
|
"type": "boolean",
|
|
14165
|
-
"
|
|
14315
|
+
"deprecated": true,
|
|
14316
|
+
"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",
|
|
14166
14317
|
"default": false
|
|
14167
14318
|
},
|
|
14168
14319
|
"secure_proxy": {
|
|
@@ -14240,7 +14391,8 @@
|
|
|
14240
14391
|
},
|
|
14241
14392
|
"use_static_ips": {
|
|
14242
14393
|
"type": "boolean",
|
|
14243
|
-
"
|
|
14394
|
+
"deprecated": true,
|
|
14395
|
+
"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",
|
|
14244
14396
|
"default": false
|
|
14245
14397
|
},
|
|
14246
14398
|
"secure_proxy": {
|
|
@@ -14317,7 +14469,84 @@
|
|
|
14317
14469
|
},
|
|
14318
14470
|
"use_static_ips": {
|
|
14319
14471
|
"type": "boolean",
|
|
14320
|
-
"
|
|
14472
|
+
"deprecated": true,
|
|
14473
|
+
"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",
|
|
14474
|
+
"default": false
|
|
14475
|
+
},
|
|
14476
|
+
"secure_proxy": {
|
|
14477
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
14478
|
+
}
|
|
14479
|
+
},
|
|
14480
|
+
"required": [
|
|
14481
|
+
"type",
|
|
14482
|
+
"call"
|
|
14483
|
+
]
|
|
14484
|
+
},
|
|
14485
|
+
"ExtensionHookDataExport": {
|
|
14486
|
+
"description": "Generic data export hook. When configured on a visualization block, the portal delegates the export action (e.g. CSV/Excel/PDF download) to the configured external source instead of generating the file itself. Can be used by any block that supports export — consumption charts, dynamic tariff charts, etc. The expected response to the call is:\n - 200 with a JSON body describing the exported file (download_url, optional filename, content_type, expires_at)\n",
|
|
14487
|
+
"type": "object",
|
|
14488
|
+
"properties": {
|
|
14489
|
+
"type": {
|
|
14490
|
+
"type": "string",
|
|
14491
|
+
"enum": [
|
|
14492
|
+
"dataExport"
|
|
14493
|
+
]
|
|
14494
|
+
},
|
|
14495
|
+
"block_types": {
|
|
14496
|
+
"type": "array",
|
|
14497
|
+
"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",
|
|
14498
|
+
"items": {
|
|
14499
|
+
"type": "string"
|
|
14500
|
+
}
|
|
14501
|
+
},
|
|
14502
|
+
"auth": {
|
|
14503
|
+
"$ref": "#/components/schemas/ExtensionAuthBlock"
|
|
14504
|
+
},
|
|
14505
|
+
"call": {
|
|
14506
|
+
"type": "object",
|
|
14507
|
+
"properties": {
|
|
14508
|
+
"method": {
|
|
14509
|
+
"type": "string",
|
|
14510
|
+
"description": "HTTP method to use for the call",
|
|
14511
|
+
"default": "GET"
|
|
14512
|
+
},
|
|
14513
|
+
"url": {
|
|
14514
|
+
"type": "string",
|
|
14515
|
+
"description": "URL to call. Supports variable interpolation."
|
|
14516
|
+
},
|
|
14517
|
+
"params": {
|
|
14518
|
+
"type": "object",
|
|
14519
|
+
"description": "Parameters to append to the URL. Supports variable interpolation.",
|
|
14520
|
+
"additionalProperties": {
|
|
14521
|
+
"type": "string"
|
|
14522
|
+
},
|
|
14523
|
+
"default": {}
|
|
14524
|
+
},
|
|
14525
|
+
"headers": {
|
|
14526
|
+
"type": "object",
|
|
14527
|
+
"description": "Headers to use. Supports variable interpolation.",
|
|
14528
|
+
"additionalProperties": {
|
|
14529
|
+
"type": "string"
|
|
14530
|
+
},
|
|
14531
|
+
"default": {}
|
|
14532
|
+
},
|
|
14533
|
+
"body": {
|
|
14534
|
+
"type": "object",
|
|
14535
|
+
"description": "Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.",
|
|
14536
|
+
"additionalProperties": {
|
|
14537
|
+
"type": "string"
|
|
14538
|
+
},
|
|
14539
|
+
"default": {}
|
|
14540
|
+
}
|
|
14541
|
+
},
|
|
14542
|
+
"required": [
|
|
14543
|
+
"url"
|
|
14544
|
+
]
|
|
14545
|
+
},
|
|
14546
|
+
"use_static_ips": {
|
|
14547
|
+
"type": "boolean",
|
|
14548
|
+
"deprecated": true,
|
|
14549
|
+
"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",
|
|
14321
14550
|
"default": false
|
|
14322
14551
|
},
|
|
14323
14552
|
"secure_proxy": {
|
|
@@ -14394,7 +14623,8 @@
|
|
|
14394
14623
|
},
|
|
14395
14624
|
"use_static_ips": {
|
|
14396
14625
|
"type": "boolean",
|
|
14397
|
-
"
|
|
14626
|
+
"deprecated": true,
|
|
14627
|
+
"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",
|
|
14398
14628
|
"default": false
|
|
14399
14629
|
},
|
|
14400
14630
|
"secure_proxy": {
|