@epilot/customer-portal-client 0.37.0 → 0.38.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +24 -0
- package/dist/openapi.d.ts +154 -82
- package/package.json +2 -2
- package/src/openapi-runtime.json +24 -0
- package/src/openapi.json +226 -41
- package/tsconfig.json +1 -0
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={914: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(240));r.default=n.default},240: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/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/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}(914),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
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})})();
|
|
@@ -1829,6 +1829,18 @@
|
|
|
1829
1829
|
"responses": {}
|
|
1830
1830
|
}
|
|
1831
1831
|
},
|
|
1832
|
+
"/v2/portal/metering/readings": {
|
|
1833
|
+
"post": {
|
|
1834
|
+
"operationId": "getMeterReadings",
|
|
1835
|
+
"requestBody": {
|
|
1836
|
+
"required": true,
|
|
1837
|
+
"content": {
|
|
1838
|
+
"application/json": {}
|
|
1839
|
+
}
|
|
1840
|
+
},
|
|
1841
|
+
"responses": {}
|
|
1842
|
+
}
|
|
1843
|
+
},
|
|
1832
1844
|
"/v2/portal/public/sso/login": {
|
|
1833
1845
|
"post": {
|
|
1834
1846
|
"operationId": "ssoLogin",
|
|
@@ -2258,6 +2270,18 @@
|
|
|
2258
2270
|
"responses": {}
|
|
2259
2271
|
}
|
|
2260
2272
|
},
|
|
2273
|
+
"/v3/portal/config/clone": {
|
|
2274
|
+
"post": {
|
|
2275
|
+
"operationId": "clonePortalConfig",
|
|
2276
|
+
"requestBody": {
|
|
2277
|
+
"required": true,
|
|
2278
|
+
"content": {
|
|
2279
|
+
"application/json": {}
|
|
2280
|
+
}
|
|
2281
|
+
},
|
|
2282
|
+
"responses": {}
|
|
2283
|
+
}
|
|
2284
|
+
},
|
|
2261
2285
|
"/v3/portal/partner/invite": {
|
|
2262
2286
|
"post": {
|
|
2263
2287
|
"operationId": "invitePartner",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -907,13 +907,6 @@ declare namespace Components {
|
|
|
907
907
|
* Mark true if the domain is an Epilot domain
|
|
908
908
|
*/
|
|
909
909
|
is_epilot_domain?: boolean;
|
|
910
|
-
/**
|
|
911
|
-
* The URL on which the portal is accessible
|
|
912
|
-
* example:
|
|
913
|
-
* example-portal-12345.ecp.epilot.cloud
|
|
914
|
-
*/
|
|
915
|
-
epilot_domain?: string;
|
|
916
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
917
910
|
/**
|
|
918
911
|
* ID of the design used to build the portal
|
|
919
912
|
*/
|
|
@@ -1335,13 +1328,6 @@ declare namespace Components {
|
|
|
1335
1328
|
* Mark true if the domain is an Epilot domain
|
|
1336
1329
|
*/
|
|
1337
1330
|
is_epilot_domain?: boolean;
|
|
1338
|
-
/**
|
|
1339
|
-
* The Epilot domain on which the portal is accessible
|
|
1340
|
-
* example:
|
|
1341
|
-
* example-portal-1.ecp.epilot.io
|
|
1342
|
-
*/
|
|
1343
|
-
epilot_domain?: string;
|
|
1344
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
1345
1331
|
/**
|
|
1346
1332
|
* ID of the design used to build the portal
|
|
1347
1333
|
*/
|
|
@@ -2223,23 +2209,6 @@ declare namespace Components {
|
|
|
2223
2209
|
de?: string;
|
|
2224
2210
|
};
|
|
2225
2211
|
}
|
|
2226
|
-
/**
|
|
2227
|
-
* Domain settings for the portal
|
|
2228
|
-
*/
|
|
2229
|
-
export interface DomainSettings {
|
|
2230
|
-
/**
|
|
2231
|
-
* Whether the custom domain is enabled
|
|
2232
|
-
*/
|
|
2233
|
-
is_custom_domain_enabled?: boolean;
|
|
2234
|
-
/**
|
|
2235
|
-
* Whether the Epilot domain is enabled
|
|
2236
|
-
*/
|
|
2237
|
-
is_epilot_domain_enabled?: boolean;
|
|
2238
|
-
/**
|
|
2239
|
-
* Whether the redirection is enabled
|
|
2240
|
-
*/
|
|
2241
|
-
is_redirection_enabled?: boolean;
|
|
2242
|
-
}
|
|
2243
2212
|
/**
|
|
2244
2213
|
* Email templates used for authentication and internal processes
|
|
2245
2214
|
*/
|
|
@@ -4126,12 +4095,6 @@ declare namespace Components {
|
|
|
4126
4095
|
* Whether the org is in canary mode
|
|
4127
4096
|
*/
|
|
4128
4097
|
is_canary?: boolean;
|
|
4129
|
-
/**
|
|
4130
|
-
* The URL to redirect to
|
|
4131
|
-
* example:
|
|
4132
|
-
* https://example.com
|
|
4133
|
-
*/
|
|
4134
|
-
redirect_to?: string;
|
|
4135
4098
|
}
|
|
4136
4099
|
/**
|
|
4137
4100
|
* The meter entity
|
|
@@ -4263,7 +4226,7 @@ declare namespace Components {
|
|
|
4263
4226
|
/**
|
|
4264
4227
|
* If the value is not provided, the system will be set with the time the request is processed.
|
|
4265
4228
|
* example:
|
|
4266
|
-
* 2022-10-
|
|
4229
|
+
* 2022-10-10
|
|
4267
4230
|
*/
|
|
4268
4231
|
timestamp?: string;
|
|
4269
4232
|
/**
|
|
@@ -4363,6 +4326,12 @@ declare namespace Components {
|
|
|
4363
4326
|
* ]
|
|
4364
4327
|
*/
|
|
4365
4328
|
meter_numbers?: string[];
|
|
4329
|
+
/**
|
|
4330
|
+
* ID of the created file entity for the uploaded photo.
|
|
4331
|
+
* example:
|
|
4332
|
+
* abc123def456
|
|
4333
|
+
*/
|
|
4334
|
+
file_id?: string;
|
|
4366
4335
|
}
|
|
4367
4336
|
export interface MeterReadingWidget {
|
|
4368
4337
|
id: string;
|
|
@@ -4880,6 +4849,16 @@ declare namespace Components {
|
|
|
4880
4849
|
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
4881
4850
|
*/
|
|
4882
4851
|
portal_id?: string;
|
|
4852
|
+
/**
|
|
4853
|
+
* Slugs that previously belonged to this page. The portal redirects requests for these slugs to the current slug. Managed by the server: when a page's slug changes, the old slug is appended here, and when another page claims one of these slugs it is removed from this list.
|
|
4854
|
+
*
|
|
4855
|
+
* example:
|
|
4856
|
+
* [
|
|
4857
|
+
* "old-dashboard",
|
|
4858
|
+
* "home"
|
|
4859
|
+
* ]
|
|
4860
|
+
*/
|
|
4861
|
+
past_routes?: string[];
|
|
4883
4862
|
}
|
|
4884
4863
|
export interface PageRequest {
|
|
4885
4864
|
[name: string]: any;
|
|
@@ -5041,13 +5020,6 @@ declare namespace Components {
|
|
|
5041
5020
|
* Mark true if the domain is an Epilot domain
|
|
5042
5021
|
*/
|
|
5043
5022
|
is_epilot_domain?: boolean;
|
|
5044
|
-
/**
|
|
5045
|
-
* The URL on which the portal is accessible
|
|
5046
|
-
* example:
|
|
5047
|
-
* example-portal-12345.ecp.epilot.cloud
|
|
5048
|
-
*/
|
|
5049
|
-
epilot_domain?: string;
|
|
5050
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
5051
5023
|
design_id?: /**
|
|
5052
5024
|
* Entity ID
|
|
5053
5025
|
* example:
|
|
@@ -5552,13 +5524,6 @@ declare namespace Components {
|
|
|
5552
5524
|
* Mark true if the domain is an Epilot domain
|
|
5553
5525
|
*/
|
|
5554
5526
|
is_epilot_domain?: boolean;
|
|
5555
|
-
/**
|
|
5556
|
-
* The Epilot domain on which the portal is accessible
|
|
5557
|
-
* example:
|
|
5558
|
-
* example-portal-1.ecp.epilot.io
|
|
5559
|
-
*/
|
|
5560
|
-
epilot_domain?: string;
|
|
5561
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
5562
5527
|
design_id?: /**
|
|
5563
5528
|
* Entity ID
|
|
5564
5529
|
* example:
|
|
@@ -6778,13 +6743,6 @@ declare namespace Components {
|
|
|
6778
6743
|
* Mark true if the domain is an Epilot domain
|
|
6779
6744
|
*/
|
|
6780
6745
|
is_epilot_domain?: boolean;
|
|
6781
|
-
/**
|
|
6782
|
-
* The URL on which the portal is accessible
|
|
6783
|
-
* example:
|
|
6784
|
-
* example-portal-12345.ecp.epilot.cloud
|
|
6785
|
-
*/
|
|
6786
|
-
epilot_domain?: string;
|
|
6787
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
6788
6746
|
design_id?: /**
|
|
6789
6747
|
* Entity ID
|
|
6790
6748
|
* example:
|
|
@@ -7243,13 +7201,6 @@ declare namespace Components {
|
|
|
7243
7201
|
* Mark true if the domain is an Epilot domain
|
|
7244
7202
|
*/
|
|
7245
7203
|
is_epilot_domain?: boolean;
|
|
7246
|
-
/**
|
|
7247
|
-
* The Epilot domain on which the portal is accessible
|
|
7248
|
-
* example:
|
|
7249
|
-
* example-portal-1.ecp.epilot.io
|
|
7250
|
-
*/
|
|
7251
|
-
epilot_domain?: string;
|
|
7252
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
7253
7204
|
design_id?: /**
|
|
7254
7205
|
* Entity ID
|
|
7255
7206
|
* example:
|
|
@@ -7646,6 +7597,14 @@ declare namespace Components {
|
|
|
7646
7597
|
pages?: PageRequest[];
|
|
7647
7598
|
}
|
|
7648
7599
|
export interface UpsertPortalWidget {
|
|
7600
|
+
/**
|
|
7601
|
+
* V3 portal-scoped storage key for the widget configuration
|
|
7602
|
+
*/
|
|
7603
|
+
portal_sk_v3?: string;
|
|
7604
|
+
/**
|
|
7605
|
+
* Indicates whether the widget configuration is stored as a V3 portal-scoped item
|
|
7606
|
+
*/
|
|
7607
|
+
is_v3_item?: boolean;
|
|
7649
7608
|
widgets: PortalWidget[];
|
|
7650
7609
|
}
|
|
7651
7610
|
export interface UserRequest {
|
|
@@ -7927,6 +7886,28 @@ declare namespace Paths {
|
|
|
7927
7886
|
export type $500 = Components.Responses.InternalServerError;
|
|
7928
7887
|
}
|
|
7929
7888
|
}
|
|
7889
|
+
namespace ClonePortalConfig {
|
|
7890
|
+
export interface RequestBody {
|
|
7891
|
+
source_portal_id: /**
|
|
7892
|
+
* ID of the portal
|
|
7893
|
+
* example:
|
|
7894
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
7895
|
+
*/
|
|
7896
|
+
Components.Schemas.PortalId;
|
|
7897
|
+
/**
|
|
7898
|
+
* Name for the cloned portal. Defaults to "Copy of <source portal name>".
|
|
7899
|
+
*/
|
|
7900
|
+
name?: string;
|
|
7901
|
+
}
|
|
7902
|
+
namespace Responses {
|
|
7903
|
+
export type $201 = Components.Schemas.PortalConfigV3;
|
|
7904
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
7905
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
7906
|
+
export type $403 = Components.Responses.Forbidden;
|
|
7907
|
+
export type $404 = Components.Responses.NotFound;
|
|
7908
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
7909
|
+
}
|
|
7910
|
+
}
|
|
7930
7911
|
namespace ConfigureDistribution {
|
|
7931
7912
|
namespace Parameters {
|
|
7932
7913
|
export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
|
|
@@ -9176,9 +9157,23 @@ declare namespace Paths {
|
|
|
9176
9157
|
*/
|
|
9177
9158
|
value: number;
|
|
9178
9159
|
/**
|
|
9179
|
-
* Optional type of the consumption, such as 'nt' (night time)
|
|
9160
|
+
* Optional type of the consumption, such as 'nt' (night time) and 'ht' (high time) or 'feed-in' and 'feed-out'. Can be any string.
|
|
9161
|
+
* example:
|
|
9162
|
+
* nt
|
|
9180
9163
|
*/
|
|
9181
9164
|
type?: string;
|
|
9165
|
+
/**
|
|
9166
|
+
* The method used to aggregate the consumption data. Assumed default is 'sum'.
|
|
9167
|
+
* example:
|
|
9168
|
+
* sum
|
|
9169
|
+
*/
|
|
9170
|
+
aggregation_method?: "sum" | "average" | "max" | "min";
|
|
9171
|
+
/**
|
|
9172
|
+
* Optional unit of the consumption value. Defaults to unit present on the relevant Meter Counter.
|
|
9173
|
+
* example:
|
|
9174
|
+
* kWh
|
|
9175
|
+
*/
|
|
9176
|
+
unit?: string;
|
|
9182
9177
|
}[];
|
|
9183
9178
|
}
|
|
9184
9179
|
export type $401 = Components.Responses.Unauthorized;
|
|
@@ -9679,6 +9674,48 @@ declare namespace Paths {
|
|
|
9679
9674
|
export type $500 = Components.Responses.InternalServerError;
|
|
9680
9675
|
}
|
|
9681
9676
|
}
|
|
9677
|
+
namespace GetMeterReadings {
|
|
9678
|
+
export interface RequestBody {
|
|
9679
|
+
meter_id: string;
|
|
9680
|
+
counter_id: string;
|
|
9681
|
+
sort?: "asc" | "desc";
|
|
9682
|
+
from?: number;
|
|
9683
|
+
size?: number;
|
|
9684
|
+
/**
|
|
9685
|
+
* Template map (key to Handlebars template string). Each template is resolved per reading.
|
|
9686
|
+
*/
|
|
9687
|
+
templates?: {
|
|
9688
|
+
[name: string]: string;
|
|
9689
|
+
};
|
|
9690
|
+
/**
|
|
9691
|
+
* Template map resolved against the counter entity.
|
|
9692
|
+
*/
|
|
9693
|
+
counter_templates?: {
|
|
9694
|
+
[name: string]: string;
|
|
9695
|
+
};
|
|
9696
|
+
}
|
|
9697
|
+
namespace Responses {
|
|
9698
|
+
export interface $200 {
|
|
9699
|
+
results?: {
|
|
9700
|
+
[name: string]: any;
|
|
9701
|
+
templates_output?: {
|
|
9702
|
+
[name: string]: string;
|
|
9703
|
+
};
|
|
9704
|
+
}[];
|
|
9705
|
+
hits?: number;
|
|
9706
|
+
/**
|
|
9707
|
+
* Resolved counter templates.
|
|
9708
|
+
*/
|
|
9709
|
+
counter_templates_output?: {
|
|
9710
|
+
[name: string]: string;
|
|
9711
|
+
};
|
|
9712
|
+
}
|
|
9713
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
9714
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
9715
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9716
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
9717
|
+
}
|
|
9718
|
+
}
|
|
9682
9719
|
namespace GetOpportunity {
|
|
9683
9720
|
namespace Parameters {
|
|
9684
9721
|
export type Id = /**
|
|
@@ -9886,13 +9923,6 @@ declare namespace Paths {
|
|
|
9886
9923
|
* Mark true if the domain is an Epilot domain
|
|
9887
9924
|
*/
|
|
9888
9925
|
is_epilot_domain?: boolean;
|
|
9889
|
-
/**
|
|
9890
|
-
* The URL on which the portal is accessible
|
|
9891
|
-
* example:
|
|
9892
|
-
* example-portal-12345.ecp.epilot.cloud
|
|
9893
|
-
*/
|
|
9894
|
-
epilot_domain?: string;
|
|
9895
|
-
domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
|
|
9896
9926
|
design_id?: /**
|
|
9897
9927
|
* Entity ID
|
|
9898
9928
|
* example:
|
|
@@ -10387,13 +10417,6 @@ declare namespace Paths {
|
|
|
10387
10417
|
* Mark true if the domain is an Epilot domain
|
|
10388
10418
|
*/
|
|
10389
10419
|
is_epilot_domain?: boolean;
|
|
10390
|
-
/**
|
|
10391
|
-
* The URL on which the portal is accessible
|
|
10392
|
-
* example:
|
|
10393
|
-
* example-portal-12345.ecp.epilot.cloud
|
|
10394
|
-
*/
|
|
10395
|
-
epilot_domain?: string;
|
|
10396
|
-
domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
|
|
10397
10420
|
design_id?: /**
|
|
10398
10421
|
* Entity ID
|
|
10399
10422
|
* example:
|
|
@@ -13378,6 +13401,7 @@ declare namespace Paths {
|
|
|
13378
13401
|
}
|
|
13379
13402
|
}
|
|
13380
13403
|
|
|
13404
|
+
|
|
13381
13405
|
export interface OperationMethods {
|
|
13382
13406
|
/**
|
|
13383
13407
|
* upsertPortal - upsertPortal
|
|
@@ -14479,6 +14503,18 @@ export interface OperationMethods {
|
|
|
14479
14503
|
data?: any,
|
|
14480
14504
|
config?: AxiosRequestConfig
|
|
14481
14505
|
): OperationResponse<Paths.GetAllowedMeterReadingRange.Responses.$200>
|
|
14506
|
+
/**
|
|
14507
|
+
* getMeterReadings - Get meter readings with optional template resolution
|
|
14508
|
+
*
|
|
14509
|
+
* Fetches meter readings for a counter and optionally resolves Handlebars
|
|
14510
|
+
* template strings against each reading object using @epilot/variables.
|
|
14511
|
+
*
|
|
14512
|
+
*/
|
|
14513
|
+
'getMeterReadings'(
|
|
14514
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
14515
|
+
data?: Paths.GetMeterReadings.RequestBody,
|
|
14516
|
+
config?: AxiosRequestConfig
|
|
14517
|
+
): OperationResponse<Paths.GetMeterReadings.Responses.$200>
|
|
14482
14518
|
/**
|
|
14483
14519
|
* ssoLogin - ssoLogin
|
|
14484
14520
|
*
|
|
@@ -14777,6 +14813,16 @@ export interface OperationMethods {
|
|
|
14777
14813
|
data?: Paths.SwapPortalConfig.RequestBody,
|
|
14778
14814
|
config?: AxiosRequestConfig
|
|
14779
14815
|
): OperationResponse<Paths.SwapPortalConfig.Responses.$200>
|
|
14816
|
+
/**
|
|
14817
|
+
* clonePortalConfig - clonePortalConfig
|
|
14818
|
+
*
|
|
14819
|
+
* Creates a new portal by cloning configuration and pages from an existing portal. The new portal gets its own domain, users, email templates, and authentication settings.
|
|
14820
|
+
*/
|
|
14821
|
+
'clonePortalConfig'(
|
|
14822
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
14823
|
+
data?: Paths.ClonePortalConfig.RequestBody,
|
|
14824
|
+
config?: AxiosRequestConfig
|
|
14825
|
+
): OperationResponse<Paths.ClonePortalConfig.Responses.$201>
|
|
14780
14826
|
/**
|
|
14781
14827
|
* invitePartner - invitePartner
|
|
14782
14828
|
*
|
|
@@ -16128,6 +16174,20 @@ export interface PathsDictionary {
|
|
|
16128
16174
|
config?: AxiosRequestConfig
|
|
16129
16175
|
): OperationResponse<Paths.GetAllowedMeterReadingRange.Responses.$200>
|
|
16130
16176
|
}
|
|
16177
|
+
['/v2/portal/metering/readings']: {
|
|
16178
|
+
/**
|
|
16179
|
+
* getMeterReadings - Get meter readings with optional template resolution
|
|
16180
|
+
*
|
|
16181
|
+
* Fetches meter readings for a counter and optionally resolves Handlebars
|
|
16182
|
+
* template strings against each reading object using @epilot/variables.
|
|
16183
|
+
*
|
|
16184
|
+
*/
|
|
16185
|
+
'post'(
|
|
16186
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
16187
|
+
data?: Paths.GetMeterReadings.RequestBody,
|
|
16188
|
+
config?: AxiosRequestConfig
|
|
16189
|
+
): OperationResponse<Paths.GetMeterReadings.Responses.$200>
|
|
16190
|
+
}
|
|
16131
16191
|
['/v2/portal/public/sso/login']: {
|
|
16132
16192
|
/**
|
|
16133
16193
|
* ssoLogin - ssoLogin
|
|
@@ -16466,6 +16526,18 @@ export interface PathsDictionary {
|
|
|
16466
16526
|
config?: AxiosRequestConfig
|
|
16467
16527
|
): OperationResponse<Paths.SwapPortalConfig.Responses.$200>
|
|
16468
16528
|
}
|
|
16529
|
+
['/v3/portal/config/clone']: {
|
|
16530
|
+
/**
|
|
16531
|
+
* clonePortalConfig - clonePortalConfig
|
|
16532
|
+
*
|
|
16533
|
+
* Creates a new portal by cloning configuration and pages from an existing portal. The new portal gets its own domain, users, email templates, and authentication settings.
|
|
16534
|
+
*/
|
|
16535
|
+
'post'(
|
|
16536
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
16537
|
+
data?: Paths.ClonePortalConfig.RequestBody,
|
|
16538
|
+
config?: AxiosRequestConfig
|
|
16539
|
+
): OperationResponse<Paths.ClonePortalConfig.Responses.$201>
|
|
16540
|
+
}
|
|
16469
16541
|
['/v3/portal/partner/invite']: {
|
|
16470
16542
|
/**
|
|
16471
16543
|
* invitePartner - invitePartner
|
|
@@ -16542,6 +16614,7 @@ export interface PathsDictionary {
|
|
|
16542
16614
|
|
|
16543
16615
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
16544
16616
|
|
|
16617
|
+
|
|
16545
16618
|
export type AcceptanceDecision = Components.Schemas.AcceptanceDecision;
|
|
16546
16619
|
export type ActionLabel = Components.Schemas.ActionLabel;
|
|
16547
16620
|
export type ActionWidget = Components.Schemas.ActionWidget;
|
|
@@ -16581,7 +16654,6 @@ export type DataRetrievalItem = Components.Schemas.DataRetrievalItem;
|
|
|
16581
16654
|
export type DeleteEntityFile = Components.Schemas.DeleteEntityFile;
|
|
16582
16655
|
export type Direction = Components.Schemas.Direction;
|
|
16583
16656
|
export type DocumentWidget = Components.Schemas.DocumentWidget;
|
|
16584
|
-
export type DomainSettings = Components.Schemas.DomainSettings;
|
|
16585
16657
|
export type EmailTemplates = Components.Schemas.EmailTemplates;
|
|
16586
16658
|
export type Entity = Components.Schemas.Entity;
|
|
16587
16659
|
export type EntityEditRule = Components.Schemas.EntityEditRule;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/customer-portal-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.38.2",
|
|
4
4
|
"description": "API Client for epilot portal API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
"axios": "^1.11.0",
|
|
62
62
|
"copy-webpack-plugin": "^7.0.0",
|
|
63
63
|
"json-loader": "^0.5.7",
|
|
64
|
-
"openapicmd": "^2.
|
|
64
|
+
"openapicmd": "^2.9.2",
|
|
65
65
|
"ts-loader": "^8.0.14",
|
|
66
66
|
"ts-node": "^10.9.1",
|
|
67
67
|
"typescript": "^4.1.3",
|
package/src/openapi-runtime.json
CHANGED
|
@@ -1829,6 +1829,18 @@
|
|
|
1829
1829
|
"responses": {}
|
|
1830
1830
|
}
|
|
1831
1831
|
},
|
|
1832
|
+
"/v2/portal/metering/readings": {
|
|
1833
|
+
"post": {
|
|
1834
|
+
"operationId": "getMeterReadings",
|
|
1835
|
+
"requestBody": {
|
|
1836
|
+
"required": true,
|
|
1837
|
+
"content": {
|
|
1838
|
+
"application/json": {}
|
|
1839
|
+
}
|
|
1840
|
+
},
|
|
1841
|
+
"responses": {}
|
|
1842
|
+
}
|
|
1843
|
+
},
|
|
1832
1844
|
"/v2/portal/public/sso/login": {
|
|
1833
1845
|
"post": {
|
|
1834
1846
|
"operationId": "ssoLogin",
|
|
@@ -2258,6 +2270,18 @@
|
|
|
2258
2270
|
"responses": {}
|
|
2259
2271
|
}
|
|
2260
2272
|
},
|
|
2273
|
+
"/v3/portal/config/clone": {
|
|
2274
|
+
"post": {
|
|
2275
|
+
"operationId": "clonePortalConfig",
|
|
2276
|
+
"requestBody": {
|
|
2277
|
+
"required": true,
|
|
2278
|
+
"content": {
|
|
2279
|
+
"application/json": {}
|
|
2280
|
+
}
|
|
2281
|
+
},
|
|
2282
|
+
"responses": {}
|
|
2283
|
+
}
|
|
2284
|
+
},
|
|
2261
2285
|
"/v3/portal/partner/invite": {
|
|
2262
2286
|
"post": {
|
|
2263
2287
|
"operationId": "invitePartner",
|
package/src/openapi.json
CHANGED
|
@@ -815,7 +815,24 @@
|
|
|
815
815
|
},
|
|
816
816
|
"type": {
|
|
817
817
|
"type": "string",
|
|
818
|
-
"description": "Optional type of the consumption, such as 'nt' (night time)
|
|
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
|
+
"example": "nt"
|
|
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
|
+
"unit": {
|
|
833
|
+
"type": "string",
|
|
834
|
+
"description": "Optional unit of the consumption value. Defaults to unit present on the relevant Meter Counter.",
|
|
835
|
+
"example": "kWh"
|
|
819
836
|
}
|
|
820
837
|
},
|
|
821
838
|
"required": [
|
|
@@ -7231,6 +7248,124 @@
|
|
|
7231
7248
|
}
|
|
7232
7249
|
}
|
|
7233
7250
|
},
|
|
7251
|
+
"/v2/portal/metering/readings": {
|
|
7252
|
+
"post": {
|
|
7253
|
+
"operationId": "getMeterReadings",
|
|
7254
|
+
"summary": "Get meter readings with optional template resolution",
|
|
7255
|
+
"description": "Fetches meter readings for a counter and optionally resolves Handlebars\ntemplate strings against each reading object using @epilot/variables.\n",
|
|
7256
|
+
"tags": [
|
|
7257
|
+
"ECP"
|
|
7258
|
+
],
|
|
7259
|
+
"security": [
|
|
7260
|
+
{
|
|
7261
|
+
"PortalAuth": []
|
|
7262
|
+
}
|
|
7263
|
+
],
|
|
7264
|
+
"requestBody": {
|
|
7265
|
+
"required": true,
|
|
7266
|
+
"content": {
|
|
7267
|
+
"application/json": {
|
|
7268
|
+
"schema": {
|
|
7269
|
+
"type": "object",
|
|
7270
|
+
"required": [
|
|
7271
|
+
"meter_id",
|
|
7272
|
+
"counter_id"
|
|
7273
|
+
],
|
|
7274
|
+
"properties": {
|
|
7275
|
+
"meter_id": {
|
|
7276
|
+
"type": "string"
|
|
7277
|
+
},
|
|
7278
|
+
"counter_id": {
|
|
7279
|
+
"type": "string"
|
|
7280
|
+
},
|
|
7281
|
+
"sort": {
|
|
7282
|
+
"type": "string",
|
|
7283
|
+
"enum": [
|
|
7284
|
+
"asc",
|
|
7285
|
+
"desc"
|
|
7286
|
+
],
|
|
7287
|
+
"default": "desc"
|
|
7288
|
+
},
|
|
7289
|
+
"from": {
|
|
7290
|
+
"type": "integer",
|
|
7291
|
+
"default": 0
|
|
7292
|
+
},
|
|
7293
|
+
"size": {
|
|
7294
|
+
"type": "integer",
|
|
7295
|
+
"default": 10
|
|
7296
|
+
},
|
|
7297
|
+
"templates": {
|
|
7298
|
+
"type": "object",
|
|
7299
|
+
"additionalProperties": {
|
|
7300
|
+
"type": "string"
|
|
7301
|
+
},
|
|
7302
|
+
"description": "Template map (key to Handlebars template string). Each template is resolved per reading."
|
|
7303
|
+
},
|
|
7304
|
+
"counter_templates": {
|
|
7305
|
+
"type": "object",
|
|
7306
|
+
"additionalProperties": {
|
|
7307
|
+
"type": "string"
|
|
7308
|
+
},
|
|
7309
|
+
"description": "Template map resolved against the counter entity."
|
|
7310
|
+
}
|
|
7311
|
+
}
|
|
7312
|
+
}
|
|
7313
|
+
}
|
|
7314
|
+
}
|
|
7315
|
+
},
|
|
7316
|
+
"responses": {
|
|
7317
|
+
"200": {
|
|
7318
|
+
"description": "Meter readings with resolved templates",
|
|
7319
|
+
"content": {
|
|
7320
|
+
"application/json": {
|
|
7321
|
+
"schema": {
|
|
7322
|
+
"type": "object",
|
|
7323
|
+
"properties": {
|
|
7324
|
+
"results": {
|
|
7325
|
+
"type": "array",
|
|
7326
|
+
"items": {
|
|
7327
|
+
"type": "object",
|
|
7328
|
+
"additionalProperties": true,
|
|
7329
|
+
"properties": {
|
|
7330
|
+
"templates_output": {
|
|
7331
|
+
"type": "object",
|
|
7332
|
+
"additionalProperties": {
|
|
7333
|
+
"type": "string"
|
|
7334
|
+
}
|
|
7335
|
+
}
|
|
7336
|
+
}
|
|
7337
|
+
}
|
|
7338
|
+
},
|
|
7339
|
+
"hits": {
|
|
7340
|
+
"type": "integer"
|
|
7341
|
+
},
|
|
7342
|
+
"counter_templates_output": {
|
|
7343
|
+
"type": "object",
|
|
7344
|
+
"additionalProperties": {
|
|
7345
|
+
"type": "string"
|
|
7346
|
+
},
|
|
7347
|
+
"description": "Resolved counter templates."
|
|
7348
|
+
}
|
|
7349
|
+
}
|
|
7350
|
+
}
|
|
7351
|
+
}
|
|
7352
|
+
}
|
|
7353
|
+
},
|
|
7354
|
+
"400": {
|
|
7355
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
7356
|
+
},
|
|
7357
|
+
"401": {
|
|
7358
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
7359
|
+
},
|
|
7360
|
+
"403": {
|
|
7361
|
+
"$ref": "#/components/responses/Forbidden"
|
|
7362
|
+
},
|
|
7363
|
+
"500": {
|
|
7364
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
7365
|
+
}
|
|
7366
|
+
}
|
|
7367
|
+
}
|
|
7368
|
+
},
|
|
7234
7369
|
"/v2/portal/public/sso/login": {
|
|
7235
7370
|
"post": {
|
|
7236
7371
|
"operationId": "ssoLogin",
|
|
@@ -8969,6 +9104,71 @@
|
|
|
8969
9104
|
}
|
|
8970
9105
|
}
|
|
8971
9106
|
},
|
|
9107
|
+
"/v3/portal/config/clone": {
|
|
9108
|
+
"post": {
|
|
9109
|
+
"operationId": "clonePortalConfig",
|
|
9110
|
+
"summary": "clonePortalConfig",
|
|
9111
|
+
"description": "Creates a new portal by cloning configuration and pages from an existing portal. The new portal gets its own domain, users, email templates, and authentication settings.",
|
|
9112
|
+
"tags": [
|
|
9113
|
+
"ECP Admin"
|
|
9114
|
+
],
|
|
9115
|
+
"security": [
|
|
9116
|
+
{
|
|
9117
|
+
"EpilotAuth": []
|
|
9118
|
+
}
|
|
9119
|
+
],
|
|
9120
|
+
"requestBody": {
|
|
9121
|
+
"description": "Source portal ID and optional name for the cloned portal",
|
|
9122
|
+
"required": true,
|
|
9123
|
+
"content": {
|
|
9124
|
+
"application/json": {
|
|
9125
|
+
"schema": {
|
|
9126
|
+
"type": "object",
|
|
9127
|
+
"required": [
|
|
9128
|
+
"source_portal_id"
|
|
9129
|
+
],
|
|
9130
|
+
"properties": {
|
|
9131
|
+
"source_portal_id": {
|
|
9132
|
+
"$ref": "#/components/schemas/PortalId"
|
|
9133
|
+
},
|
|
9134
|
+
"name": {
|
|
9135
|
+
"type": "string",
|
|
9136
|
+
"description": "Name for the cloned portal. Defaults to \"Copy of <source portal name>\"."
|
|
9137
|
+
}
|
|
9138
|
+
}
|
|
9139
|
+
}
|
|
9140
|
+
}
|
|
9141
|
+
}
|
|
9142
|
+
},
|
|
9143
|
+
"responses": {
|
|
9144
|
+
"201": {
|
|
9145
|
+
"description": "Portal cloned successfully.",
|
|
9146
|
+
"content": {
|
|
9147
|
+
"application/json": {
|
|
9148
|
+
"schema": {
|
|
9149
|
+
"$ref": "#/components/schemas/PortalConfigV3"
|
|
9150
|
+
}
|
|
9151
|
+
}
|
|
9152
|
+
}
|
|
9153
|
+
},
|
|
9154
|
+
"400": {
|
|
9155
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
9156
|
+
},
|
|
9157
|
+
"401": {
|
|
9158
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
9159
|
+
},
|
|
9160
|
+
"403": {
|
|
9161
|
+
"$ref": "#/components/responses/Forbidden"
|
|
9162
|
+
},
|
|
9163
|
+
"404": {
|
|
9164
|
+
"$ref": "#/components/responses/NotFound"
|
|
9165
|
+
},
|
|
9166
|
+
"500": {
|
|
9167
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
9168
|
+
}
|
|
9169
|
+
}
|
|
9170
|
+
}
|
|
9171
|
+
},
|
|
8972
9172
|
"/v3/portal/partner/invite": {
|
|
8973
9173
|
"post": {
|
|
8974
9174
|
"operationId": "invitePartner",
|
|
@@ -10069,14 +10269,6 @@
|
|
|
10069
10269
|
"type": "boolean",
|
|
10070
10270
|
"description": "Mark true if the domain is an Epilot domain"
|
|
10071
10271
|
},
|
|
10072
|
-
"epilot_domain": {
|
|
10073
|
-
"type": "string",
|
|
10074
|
-
"description": "The URL on which the portal is accessible",
|
|
10075
|
-
"example": "example-portal-12345.ecp.epilot.cloud"
|
|
10076
|
-
},
|
|
10077
|
-
"domain_settings": {
|
|
10078
|
-
"$ref": "#/components/schemas/DomainSettings"
|
|
10079
|
-
},
|
|
10080
10272
|
"design_id": {
|
|
10081
10273
|
"$ref": "#/components/schemas/EntityId",
|
|
10082
10274
|
"description": "ID of the design used to build the portal"
|
|
@@ -10617,6 +10809,14 @@
|
|
|
10617
10809
|
"widgets"
|
|
10618
10810
|
],
|
|
10619
10811
|
"properties": {
|
|
10812
|
+
"portal_sk_v3": {
|
|
10813
|
+
"type": "string",
|
|
10814
|
+
"description": "V3 portal-scoped storage key for the widget configuration"
|
|
10815
|
+
},
|
|
10816
|
+
"is_v3_item": {
|
|
10817
|
+
"type": "boolean",
|
|
10818
|
+
"description": "Indicates whether the widget configuration is stored as a V3 portal-scoped item"
|
|
10819
|
+
},
|
|
10620
10820
|
"widgets": {
|
|
10621
10821
|
"type": "array",
|
|
10622
10822
|
"items": {
|
|
@@ -10625,24 +10825,6 @@
|
|
|
10625
10825
|
}
|
|
10626
10826
|
}
|
|
10627
10827
|
},
|
|
10628
|
-
"DomainSettings": {
|
|
10629
|
-
"type": "object",
|
|
10630
|
-
"description": "Domain settings for the portal",
|
|
10631
|
-
"properties": {
|
|
10632
|
-
"is_custom_domain_enabled": {
|
|
10633
|
-
"type": "boolean",
|
|
10634
|
-
"description": "Whether the custom domain is enabled"
|
|
10635
|
-
},
|
|
10636
|
-
"is_epilot_domain_enabled": {
|
|
10637
|
-
"type": "boolean",
|
|
10638
|
-
"description": "Whether the Epilot domain is enabled"
|
|
10639
|
-
},
|
|
10640
|
-
"is_redirection_enabled": {
|
|
10641
|
-
"type": "boolean",
|
|
10642
|
-
"description": "Whether the redirection is enabled"
|
|
10643
|
-
}
|
|
10644
|
-
}
|
|
10645
|
-
},
|
|
10646
10828
|
"WidgetBase": {
|
|
10647
10829
|
"type": "object",
|
|
10648
10830
|
"required": [
|
|
@@ -14393,7 +14575,7 @@
|
|
|
14393
14575
|
"timestamp": {
|
|
14394
14576
|
"type": "string",
|
|
14395
14577
|
"description": "If the value is not provided, the system will be set with the time the request is processed.",
|
|
14396
|
-
"example": "2022-10-
|
|
14578
|
+
"example": "2022-10-10"
|
|
14397
14579
|
},
|
|
14398
14580
|
"source": {
|
|
14399
14581
|
"$ref": "#/components/schemas/Source",
|
|
@@ -14503,6 +14685,11 @@
|
|
|
14503
14685
|
"example": [
|
|
14504
14686
|
"00123456"
|
|
14505
14687
|
]
|
|
14688
|
+
},
|
|
14689
|
+
"file_id": {
|
|
14690
|
+
"type": "string",
|
|
14691
|
+
"description": "ID of the created file entity for the uploaded photo.",
|
|
14692
|
+
"example": "abc123def456"
|
|
14506
14693
|
}
|
|
14507
14694
|
}
|
|
14508
14695
|
},
|
|
@@ -15228,6 +15415,17 @@
|
|
|
15228
15415
|
"type": "string",
|
|
15229
15416
|
"description": "The id of the portal",
|
|
15230
15417
|
"example": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
|
|
15418
|
+
},
|
|
15419
|
+
"past_routes": {
|
|
15420
|
+
"type": "array",
|
|
15421
|
+
"description": "Slugs that previously belonged to this page. The portal redirects requests for these slugs to the current slug. Managed by the server: when a page's slug changes, the old slug is appended here, and when another page claims one of these slugs it is removed from this list.\n",
|
|
15422
|
+
"items": {
|
|
15423
|
+
"type": "string"
|
|
15424
|
+
},
|
|
15425
|
+
"example": [
|
|
15426
|
+
"old-dashboard",
|
|
15427
|
+
"home"
|
|
15428
|
+
]
|
|
15231
15429
|
}
|
|
15232
15430
|
}
|
|
15233
15431
|
}
|
|
@@ -15254,14 +15452,6 @@
|
|
|
15254
15452
|
"type": "boolean",
|
|
15255
15453
|
"description": "Mark true if the domain is an Epilot domain"
|
|
15256
15454
|
},
|
|
15257
|
-
"epilot_domain": {
|
|
15258
|
-
"type": "string",
|
|
15259
|
-
"description": "The Epilot domain on which the portal is accessible",
|
|
15260
|
-
"example": "example-portal-1.ecp.epilot.io"
|
|
15261
|
-
},
|
|
15262
|
-
"domain_settings": {
|
|
15263
|
-
"$ref": "#/components/schemas/DomainSettings"
|
|
15264
|
-
},
|
|
15265
15455
|
"design_id": {
|
|
15266
15456
|
"$ref": "#/components/schemas/EntityId",
|
|
15267
15457
|
"description": "ID of the design used to build the portal"
|
|
@@ -15818,11 +16008,6 @@
|
|
|
15818
16008
|
"is_canary": {
|
|
15819
16009
|
"type": "boolean",
|
|
15820
16010
|
"description": "Whether the org is in canary mode"
|
|
15821
|
-
},
|
|
15822
|
-
"redirect_to": {
|
|
15823
|
-
"type": "string",
|
|
15824
|
-
"description": "The URL to redirect to",
|
|
15825
|
-
"example": "https://example.com"
|
|
15826
16011
|
}
|
|
15827
16012
|
}
|
|
15828
16013
|
},
|