@epilot/customer-portal-client 0.42.0 → 0.44.0
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.d.ts +100 -15
- package/package.json +1 -1
- package/src/openapi.json +89 -14
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={330:function(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v1/portal/exports":{"post":{"operationId":"createExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/exports/{jobId}":{"get":{"operationId":"getExport","parameters":[{"in":"path","name":"jobId","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/visualization/metadata":{"get":{"operationId":"getVisualizationMetadata","parameters":[{"in":"query","name":"app_id","required":true},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates:migrate-references":{"post":{"operationId":"migrateEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates:list-references":{"post":{"operationId":"listEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"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":{}}},"/v3/portal/public/account/exists":{"post":{"operationId":"checkAccountExists","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/change/password":{"put":{"operationId":"changePortalUserPassword","requestBody":{"required":false,"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/{id}/resolve-templates":{"post":{"operationId":"getContractWithTemplates","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":false,"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}/preview":{"get":{"operationId":"getFilePreview","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/entity/{slug}":{"post":{"operationId":"createPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{slug}/{id}":{"patch":{"operationId":"patchPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"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/engagement/tasks":{"get":{"operationId":"getOutstandingTasks","responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows/linearized":{"get":{"operationId":"getEntityPortalWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entities/workflows/linearized/batch":{"post":{"operationId":"getEntityPortalWorkflowsBatch","requestBody":{"required":true,"content":{"application/json":{}}},"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/providers/{provider_slug}":{"get":{"operationId":"getSSOProvider","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"origin","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","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/config/triggered-journeys/{trigger_name}":{"parameters":[{"in":"path","name":"trigger_name","required":true,"description":"The trigger event for the auto-triggered journey"}],"get":{"operationId":"getTriggeredJourney","parameters":[{"in":"query","name":"context_entities","required":false}],"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":{"get":{"operationId":"listPortalNotifications","parameters":[{"in":"query","name":"cursor","required":false},{"in":"query","name":"limit","required":false}],"responses":{}}},"/v2/portal/notifications/unread-count":{"get":{"operationId":"getPortalNotificationsUnreadCount","responses":{}}},"/v2/portal/notifications/read-all":{"put":{"operationId":"markAllPortalNotificationsRead","responses":{}}},"/v2/portal/notifications/{id}/read":{"put":{"operationId":"markPortalNotificationRead","parameters":[{"in":"path","name":"id","required":true}],"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},{"in":"query","name":"page_upsert_mode","required":false}],"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":{}}},"/v3/portal/verify-dns":{"post":{"operationId":"verifyDns","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/proxy/execute":{"post":{"operationId":"portalProxyExecute","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/mobile-config":{"get":{"operationId":"getMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"raw","required":false}],"responses":{}},"put":{"operationId":"putMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"InvalidRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"ForbiddenByRule":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"ContractAssignmentConflict":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ConfirmUserInvalidRequest":{"content":{"application/json":{}}},"InvalidRequestCreateMeterReading":{"content":{"application/json":{}}}}},"servers":[{"url":"https://customer-portal-api.sls.epilot.io"}]}')}},r={},t=function t(a){var n=r[a];if(void 0!==n)return n.exports;var i=r[a]={exports:{}};return e[a].call(i.exports,i,i.exports,t),i.exports}(330),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={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":{}}},"/v1/portal/exports":{"post":{"operationId":"createExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/exports/{jobId}":{"get":{"operationId":"getExport","parameters":[{"in":"path","name":"jobId","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/visualization/metadata":{"get":{"operationId":"getVisualizationMetadata","parameters":[{"in":"query","name":"app_id","required":true},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates:migrate-references":{"post":{"operationId":"migrateEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates:list-references":{"post":{"operationId":"listEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"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":{}}},"/v3/portal/public/account/exists":{"post":{"operationId":"checkAccountExists","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/change/password":{"put":{"operationId":"changePortalUserPassword","requestBody":{"required":false,"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/{id}/resolve-templates":{"post":{"operationId":"getContractWithTemplates","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":false,"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}/preview":{"get":{"operationId":"getFilePreview","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/entity/{slug}":{"post":{"operationId":"createPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{slug}/{id}":{"patch":{"operationId":"patchPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"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/engagement/tasks":{"get":{"operationId":"getOutstandingTasks","responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows/linearized":{"get":{"operationId":"getEntityPortalWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entities/workflows/linearized/batch":{"post":{"operationId":"getEntityPortalWorkflowsBatch","requestBody":{"required":true,"content":{"application/json":{}}},"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/providers/{provider_slug}":{"get":{"operationId":"getSSOProvider","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"origin","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","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/config/triggered-journeys/{trigger_name}":{"parameters":[{"in":"path","name":"trigger_name","required":true,"description":"The trigger event for the auto-triggered journey"}],"get":{"operationId":"getTriggeredJourney","parameters":[{"in":"query","name":"context_entities","required":false}],"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":{"get":{"operationId":"listPortalNotifications","parameters":[{"in":"query","name":"cursor","required":false},{"in":"query","name":"limit","required":false}],"responses":{}}},"/v2/portal/notifications/unread-count":{"get":{"operationId":"getPortalNotificationsUnreadCount","responses":{}}},"/v2/portal/notifications/read-all":{"put":{"operationId":"markAllPortalNotificationsRead","responses":{}}},"/v2/portal/notifications/{id}/read":{"put":{"operationId":"markPortalNotificationRead","parameters":[{"in":"path","name":"id","required":true}],"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},{"in":"query","name":"page_upsert_mode","required":false}],"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":{}}},"/v3/portal/verify-dns":{"post":{"operationId":"verifyDns","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/proxy/execute":{"post":{"operationId":"portalProxyExecute","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/mobile-config":{"get":{"operationId":"getMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"raw","required":false}],"responses":{}},"put":{"operationId":"putMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"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})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1463,6 +1463,10 @@ declare namespace Components {
|
|
|
1463
1463
|
* Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
|
|
1464
1464
|
*/
|
|
1465
1465
|
notification_triggers?: NotificationTriggerConfig[];
|
|
1466
|
+
/**
|
|
1467
|
+
* Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
|
|
1468
|
+
*/
|
|
1469
|
+
engagement_center_enabled?: boolean;
|
|
1466
1470
|
}
|
|
1467
1471
|
export interface CommonConfigAttributesV3 {
|
|
1468
1472
|
/**
|
|
@@ -2769,7 +2773,7 @@ declare namespace Components {
|
|
|
2769
2773
|
*/
|
|
2770
2774
|
fields?: string[];
|
|
2771
2775
|
/**
|
|
2772
|
-
*
|
|
2776
|
+
* DEPRECATED — client-supplied template strings to parse and return as synthetic fields. Supports both string values and nested objects of strings. Use `templates_ref` instead so templates are derived server-side from admin-authored portal configuration; ignored when `templates_ref` is present and rejected once the org has the `portals-reject-client-templates` flag enabled.
|
|
2773
2777
|
* example:
|
|
2774
2778
|
* {
|
|
2775
2779
|
* "content_top_name": "Customer #{{contract.customer_number}}",
|
|
@@ -2786,6 +2790,10 @@ declare namespace Components {
|
|
|
2786
2790
|
[name: string]: string;
|
|
2787
2791
|
};
|
|
2788
2792
|
};
|
|
2793
|
+
/**
|
|
2794
|
+
* Reference to the portal page (or a single block within it) whose admin-configured content provides the templates, derived server-side. With only `page_id`, the derived templates are a nested map keyed by block id, mirroring the entity detail page contract.
|
|
2795
|
+
*/
|
|
2796
|
+
templates_ref?: /* Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored. */ TemplatesRef;
|
|
2789
2797
|
/**
|
|
2790
2798
|
* Additional filters to apply to the search query
|
|
2791
2799
|
* example:
|
|
@@ -3144,7 +3152,7 @@ declare namespace Components {
|
|
|
3144
3152
|
*/
|
|
3145
3153
|
group?: string;
|
|
3146
3154
|
/**
|
|
3147
|
-
*
|
|
3155
|
+
* DEPRECATED — client-supplied Handlebars template for the group title. Use `templates_ref` (global_search_config_id) instead; overridden when `templates_ref` derives a group title and rejected once the org has the `portals-reject-client-templates` flag enabled.
|
|
3148
3156
|
* example:
|
|
3149
3157
|
* {{customer[Primary].first_name}} {{customer[Primary].last_name}}
|
|
3150
3158
|
*/
|
|
@@ -3189,7 +3197,7 @@ declare namespace Components {
|
|
|
3189
3197
|
*/
|
|
3190
3198
|
fields?: string[];
|
|
3191
3199
|
/**
|
|
3192
|
-
*
|
|
3200
|
+
* DEPRECATED — client-supplied template strings to parse and return as synthetic fields. Use `templates_ref` instead; ignored when `templates_ref` is present and rejected once the org has the `portals-reject-client-templates` flag enabled.
|
|
3193
3201
|
* example:
|
|
3194
3202
|
* {
|
|
3195
3203
|
* "content_top_name": "Customer #{{contract.customer_number}}",
|
|
@@ -3200,6 +3208,10 @@ declare namespace Components {
|
|
|
3200
3208
|
templates?: {
|
|
3201
3209
|
[name: string]: string;
|
|
3202
3210
|
};
|
|
3211
|
+
/**
|
|
3212
|
+
* Reference to admin-authored configuration providing the templates, derived server-side. For the global search block pass `global_search_config_id`; the derived templates also supply the group title template (overriding `group_title`).
|
|
3213
|
+
*/
|
|
3214
|
+
templates_ref?: /* Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored. */ TemplatesRef;
|
|
3203
3215
|
/**
|
|
3204
3216
|
* Additional filters to apply to the search query
|
|
3205
3217
|
* example:
|
|
@@ -3279,9 +3291,33 @@ declare namespace Components {
|
|
|
3279
3291
|
*/
|
|
3280
3292
|
EntitySlug;
|
|
3281
3293
|
targets?: string /* uuid */[];
|
|
3294
|
+
/**
|
|
3295
|
+
* DEPRECATED — client-supplied Handlebars templates. Use `templates_ref` instead so templates are derived server-side from admin-authored portal configuration. Ignored when `templates_ref` is present; rejected once the org has the `portals-reject-client-templates` flag enabled.
|
|
3296
|
+
*/
|
|
3282
3297
|
templates?: {
|
|
3283
3298
|
[name: string]: string;
|
|
3284
3299
|
};
|
|
3300
|
+
/**
|
|
3301
|
+
* Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored.
|
|
3302
|
+
*/
|
|
3303
|
+
templates_ref?: {
|
|
3304
|
+
/**
|
|
3305
|
+
* ID of the portal page to derive templates from. When given without `block_id`, templates are derived from every block of the page and returned resolved as a nested map keyed by block id (the entity detail page contract).
|
|
3306
|
+
*/
|
|
3307
|
+
page_id?: string;
|
|
3308
|
+
/**
|
|
3309
|
+
* ID of a block within the page. Templates are derived from the block's content according to its block type (e.g. meter_selector, meter_reading, entity_list).
|
|
3310
|
+
*/
|
|
3311
|
+
block_id?: string;
|
|
3312
|
+
/**
|
|
3313
|
+
* For blocks carrying a per-schema configuration array (entity_list), the id of the configuration item to derive templates from. Requires `page_id` and `block_id`.
|
|
3314
|
+
*/
|
|
3315
|
+
config_id?: string;
|
|
3316
|
+
/**
|
|
3317
|
+
* ID of the portal's `global_search` configuration item to derive search result templates and the group title template from. Mutually exclusive with `page_id`.
|
|
3318
|
+
*/
|
|
3319
|
+
global_search_config_id?: string;
|
|
3320
|
+
};
|
|
3285
3321
|
}
|
|
3286
3322
|
export interface EntityTemplates {
|
|
3287
3323
|
/**
|
|
@@ -6601,6 +6637,10 @@ declare namespace Components {
|
|
|
6601
6637
|
* Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
|
|
6602
6638
|
*/
|
|
6603
6639
|
notification_triggers?: NotificationTriggerConfig[];
|
|
6640
|
+
/**
|
|
6641
|
+
* Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
|
|
6642
|
+
*/
|
|
6643
|
+
engagement_center_enabled?: boolean;
|
|
6604
6644
|
/**
|
|
6605
6645
|
* ID of the organization
|
|
6606
6646
|
* example:
|
|
@@ -8094,11 +8134,14 @@ declare namespace Components {
|
|
|
8094
8134
|
*/
|
|
8095
8135
|
code: string;
|
|
8096
8136
|
/**
|
|
8097
|
-
* The redirect uri
|
|
8137
|
+
* The redirect uri used in the authorization request. Optional: when omitted it is
|
|
8138
|
+
* resolved server-side from the provider's configured `redirect_uri`, falling back to
|
|
8139
|
+
* the portal's own callback route (`https://<domain>/sso`).
|
|
8140
|
+
*
|
|
8098
8141
|
* example:
|
|
8099
|
-
* https://customer-portal.com/
|
|
8142
|
+
* https://customer-portal.com/sso
|
|
8100
8143
|
*/
|
|
8101
|
-
redirect_uri
|
|
8144
|
+
redirect_uri?: string;
|
|
8102
8145
|
/**
|
|
8103
8146
|
* The client id
|
|
8104
8147
|
* example:
|
|
@@ -8296,6 +8339,27 @@ declare namespace Components {
|
|
|
8296
8339
|
url?: string;
|
|
8297
8340
|
};
|
|
8298
8341
|
}
|
|
8342
|
+
/**
|
|
8343
|
+
* Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored.
|
|
8344
|
+
*/
|
|
8345
|
+
export interface TemplatesRef {
|
|
8346
|
+
/**
|
|
8347
|
+
* ID of the portal page to derive templates from. When given without `block_id`, templates are derived from every block of the page and returned resolved as a nested map keyed by block id (the entity detail page contract).
|
|
8348
|
+
*/
|
|
8349
|
+
page_id?: string;
|
|
8350
|
+
/**
|
|
8351
|
+
* ID of a block within the page. Templates are derived from the block's content according to its block type (e.g. meter_selector, meter_reading, entity_list).
|
|
8352
|
+
*/
|
|
8353
|
+
block_id?: string;
|
|
8354
|
+
/**
|
|
8355
|
+
* For blocks carrying a per-schema configuration array (entity_list), the id of the configuration item to derive templates from. Requires `page_id` and `block_id`.
|
|
8356
|
+
*/
|
|
8357
|
+
config_id?: string;
|
|
8358
|
+
/**
|
|
8359
|
+
* ID of the portal's `global_search` configuration item to derive search result templates and the group title template from. Mutually exclusive with `page_id`.
|
|
8360
|
+
*/
|
|
8361
|
+
global_search_config_id?: string;
|
|
8362
|
+
}
|
|
8299
8363
|
export interface TriggerPortalFlow {
|
|
8300
8364
|
/**
|
|
8301
8365
|
* Id of the activity
|
|
@@ -8981,6 +9045,10 @@ declare namespace Components {
|
|
|
8981
9045
|
* Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
|
|
8982
9046
|
*/
|
|
8983
9047
|
notification_triggers?: NotificationTriggerConfig[];
|
|
9048
|
+
/**
|
|
9049
|
+
* Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
|
|
9050
|
+
*/
|
|
9051
|
+
engagement_center_enabled?: boolean;
|
|
8984
9052
|
}
|
|
8985
9053
|
export interface UpsertPortalConfigV3 {
|
|
8986
9054
|
/**
|
|
@@ -9634,7 +9702,7 @@ declare namespace Components {
|
|
|
9634
9702
|
/**
|
|
9635
9703
|
* Intervals supported for the current context. If omitted, all intervals are assumed supported.
|
|
9636
9704
|
*/
|
|
9637
|
-
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
|
|
9705
|
+
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y")[];
|
|
9638
9706
|
data_range?: /* Earliest / latest timestamps for which data is available in the current context. */ VisualizationDataRange;
|
|
9639
9707
|
}
|
|
9640
9708
|
export interface VisualizationTypeOption {
|
|
@@ -11325,7 +11393,7 @@ declare namespace Paths {
|
|
|
11325
11393
|
export type ExtensionId = string;
|
|
11326
11394
|
export type From = string; // date-time
|
|
11327
11395
|
export type HookId = string;
|
|
11328
|
-
export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M";
|
|
11396
|
+
export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y";
|
|
11329
11397
|
export type MeterId = string;
|
|
11330
11398
|
export type To = string; // date-time
|
|
11331
11399
|
}
|
|
@@ -11498,11 +11566,15 @@ declare namespace Paths {
|
|
|
11498
11566
|
}
|
|
11499
11567
|
export interface RequestBody {
|
|
11500
11568
|
/**
|
|
11501
|
-
*
|
|
11569
|
+
* DEPRECATED — client-supplied map of content field name to Handlebars template string, resolved per related meter and returned as templates_output on the meter. Use `templates_ref` instead; ignored when `templates_ref` is present and rejected once the org has the `portals-reject-client-templates` flag enabled.
|
|
11502
11570
|
*/
|
|
11503
11571
|
templates?: {
|
|
11504
11572
|
[name: string]: string;
|
|
11505
11573
|
};
|
|
11574
|
+
/**
|
|
11575
|
+
* Reference to the meter selector block whose admin-configured content provides the templates, derived server-side.
|
|
11576
|
+
*/
|
|
11577
|
+
templates_ref?: /* Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored. */ Components.Schemas.TemplatesRef;
|
|
11506
11578
|
}
|
|
11507
11579
|
namespace Responses {
|
|
11508
11580
|
export interface $200 {
|
|
@@ -11678,7 +11750,7 @@ declare namespace Paths {
|
|
|
11678
11750
|
export type ExtensionId = string;
|
|
11679
11751
|
export type From = string; // date-time
|
|
11680
11752
|
export type HookId = string;
|
|
11681
|
-
export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M";
|
|
11753
|
+
export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y";
|
|
11682
11754
|
export type MeterId = string;
|
|
11683
11755
|
export type To = string; // date-time
|
|
11684
11756
|
}
|
|
@@ -12759,17 +12831,21 @@ declare namespace Paths {
|
|
|
12759
12831
|
from?: number;
|
|
12760
12832
|
size?: number;
|
|
12761
12833
|
/**
|
|
12762
|
-
*
|
|
12834
|
+
* DEPRECATED — client-supplied template map (key to Handlebars template string), resolved per reading. Use `templates_ref` instead; ignored when `templates_ref` is present and rejected once the org has the `portals-reject-client-templates` flag enabled.
|
|
12763
12835
|
*/
|
|
12764
12836
|
templates?: {
|
|
12765
12837
|
[name: string]: string;
|
|
12766
12838
|
};
|
|
12767
12839
|
/**
|
|
12768
|
-
*
|
|
12840
|
+
* DEPRECATED — client-supplied template map resolved against the counter entity. Use `templates_ref` instead; same deprecation rules as `templates`.
|
|
12769
12841
|
*/
|
|
12770
12842
|
counter_templates?: {
|
|
12771
12843
|
[name: string]: string;
|
|
12772
12844
|
};
|
|
12845
|
+
/**
|
|
12846
|
+
* Reference to the meter reading block whose admin-configured content provides both the per-reading templates (content_top_name, main_content_name, content_bottom_name) and the counter templates (counter_title_name, counter_subtitle_name), derived server-side.
|
|
12847
|
+
*/
|
|
12848
|
+
templates_ref?: /* Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored. */ Components.Schemas.TemplatesRef;
|
|
12773
12849
|
}
|
|
12774
12850
|
namespace Responses {
|
|
12775
12851
|
export interface $200 {
|
|
@@ -13520,6 +13596,10 @@ declare namespace Paths {
|
|
|
13520
13596
|
* Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
|
|
13521
13597
|
*/
|
|
13522
13598
|
notification_triggers?: Components.Schemas.NotificationTriggerConfig[];
|
|
13599
|
+
/**
|
|
13600
|
+
* Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
|
|
13601
|
+
*/
|
|
13602
|
+
engagement_center_enabled?: boolean;
|
|
13523
13603
|
/**
|
|
13524
13604
|
* ID of the organization
|
|
13525
13605
|
* example:
|
|
@@ -14142,6 +14222,10 @@ declare namespace Paths {
|
|
|
14142
14222
|
* Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
|
|
14143
14223
|
*/
|
|
14144
14224
|
notification_triggers?: Components.Schemas.NotificationTriggerConfig[];
|
|
14225
|
+
/**
|
|
14226
|
+
* Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it.
|
|
14227
|
+
*/
|
|
14228
|
+
engagement_center_enabled?: boolean;
|
|
14145
14229
|
/**
|
|
14146
14230
|
* ID of the organization
|
|
14147
14231
|
* example:
|
|
@@ -14542,7 +14626,7 @@ declare namespace Paths {
|
|
|
14542
14626
|
export type ExtensionId = string;
|
|
14543
14627
|
export type From = string; // date-time
|
|
14544
14628
|
export type HookId = string;
|
|
14545
|
-
export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M";
|
|
14629
|
+
export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y";
|
|
14546
14630
|
export type MeterId = string;
|
|
14547
14631
|
export type To = string; // date-time
|
|
14548
14632
|
}
|
|
@@ -18641,7 +18725,7 @@ export interface OperationMethods {
|
|
|
18641
18725
|
/**
|
|
18642
18726
|
* interpolatePortalPages - interpolatePortalPages
|
|
18643
18727
|
*
|
|
18644
|
-
* Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved.
|
|
18728
|
+
* Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved. Portal Builder preview only: requires a 360 (epilot) token or a `portal_preview` token; plain portal user tokens get 403.
|
|
18645
18729
|
*/
|
|
18646
18730
|
'interpolatePortalPages'(
|
|
18647
18731
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -20676,7 +20760,7 @@ export interface PathsDictionary {
|
|
|
20676
20760
|
/**
|
|
20677
20761
|
* interpolatePortalPages - interpolatePortalPages
|
|
20678
20762
|
*
|
|
20679
|
-
* Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved.
|
|
20763
|
+
* Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved. Portal Builder preview only: requires a 360 (epilot) token or a `portal_preview` token; plain portal user tokens get 403.
|
|
20680
20764
|
*/
|
|
20681
20765
|
'post'(
|
|
20682
20766
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -21242,6 +21326,7 @@ export type Source = Components.Schemas.Source;
|
|
|
21242
21326
|
export type SwappableConfig = Components.Schemas.SwappableConfig;
|
|
21243
21327
|
export type TariffType = Components.Schemas.TariffType;
|
|
21244
21328
|
export type TeaserWidget = Components.Schemas.TeaserWidget;
|
|
21329
|
+
export type TemplatesRef = Components.Schemas.TemplatesRef;
|
|
21245
21330
|
export type TriggerPortalFlow = Components.Schemas.TriggerPortalFlow;
|
|
21246
21331
|
export type UpdateOnlyPortalConfigAttributes = Components.Schemas.UpdateOnlyPortalConfigAttributes;
|
|
21247
21332
|
export type UpsertPortalConfig = Components.Schemas.UpsertPortalConfig;
|
package/package.json
CHANGED
package/src/openapi.json
CHANGED
|
@@ -961,7 +961,8 @@
|
|
|
961
961
|
"PT15M",
|
|
962
962
|
"PT1H",
|
|
963
963
|
"P1D",
|
|
964
|
-
"P1M"
|
|
964
|
+
"P1M",
|
|
965
|
+
"P1Y"
|
|
965
966
|
]
|
|
966
967
|
},
|
|
967
968
|
"required": true,
|
|
@@ -1299,7 +1300,8 @@
|
|
|
1299
1300
|
"PT15M",
|
|
1300
1301
|
"PT1H",
|
|
1301
1302
|
"P1D",
|
|
1302
|
-
"P1M"
|
|
1303
|
+
"P1M",
|
|
1304
|
+
"P1Y"
|
|
1303
1305
|
]
|
|
1304
1306
|
},
|
|
1305
1307
|
"required": true,
|
|
@@ -1473,7 +1475,8 @@
|
|
|
1473
1475
|
"PT15M",
|
|
1474
1476
|
"PT1H",
|
|
1475
1477
|
"P1D",
|
|
1476
|
-
"P1M"
|
|
1478
|
+
"P1M",
|
|
1479
|
+
"P1Y"
|
|
1477
1480
|
]
|
|
1478
1481
|
},
|
|
1479
1482
|
"required": true,
|
|
@@ -6043,10 +6046,15 @@
|
|
|
6043
6046
|
"properties": {
|
|
6044
6047
|
"templates": {
|
|
6045
6048
|
"type": "object",
|
|
6049
|
+
"deprecated": true,
|
|
6046
6050
|
"additionalProperties": {
|
|
6047
6051
|
"type": "string"
|
|
6048
6052
|
},
|
|
6049
|
-
"description": "
|
|
6053
|
+
"description": "DEPRECATED — client-supplied map of content field name to Handlebars template string, resolved per related meter and returned as templates_output on the meter. Use `templates_ref` instead; ignored when `templates_ref` is present and rejected once the org has the `portals-reject-client-templates` flag enabled."
|
|
6054
|
+
},
|
|
6055
|
+
"templates_ref": {
|
|
6056
|
+
"$ref": "#/components/schemas/TemplatesRef",
|
|
6057
|
+
"description": "Reference to the meter selector block whose admin-configured content provides the templates, derived server-side."
|
|
6050
6058
|
}
|
|
6051
6059
|
}
|
|
6052
6060
|
}
|
|
@@ -8521,17 +8529,23 @@
|
|
|
8521
8529
|
},
|
|
8522
8530
|
"templates": {
|
|
8523
8531
|
"type": "object",
|
|
8532
|
+
"deprecated": true,
|
|
8524
8533
|
"additionalProperties": {
|
|
8525
8534
|
"type": "string"
|
|
8526
8535
|
},
|
|
8527
|
-
"description": "
|
|
8536
|
+
"description": "DEPRECATED — client-supplied template map (key to Handlebars template string), resolved per reading. Use `templates_ref` instead; ignored when `templates_ref` is present and rejected once the org has the `portals-reject-client-templates` flag enabled."
|
|
8528
8537
|
},
|
|
8529
8538
|
"counter_templates": {
|
|
8530
8539
|
"type": "object",
|
|
8540
|
+
"deprecated": true,
|
|
8531
8541
|
"additionalProperties": {
|
|
8532
8542
|
"type": "string"
|
|
8533
8543
|
},
|
|
8534
|
-
"description": "
|
|
8544
|
+
"description": "DEPRECATED — client-supplied template map resolved against the counter entity. Use `templates_ref` instead; same deprecation rules as `templates`."
|
|
8545
|
+
},
|
|
8546
|
+
"templates_ref": {
|
|
8547
|
+
"$ref": "#/components/schemas/TemplatesRef",
|
|
8548
|
+
"description": "Reference to the meter reading block whose admin-configured content provides both the per-reading templates (content_top_name, main_content_name, content_bottom_name) and the counter templates (counter_title_name, counter_subtitle_name), derived server-side."
|
|
8535
8549
|
}
|
|
8536
8550
|
}
|
|
8537
8551
|
}
|
|
@@ -9303,7 +9317,7 @@
|
|
|
9303
9317
|
"post": {
|
|
9304
9318
|
"operationId": "interpolatePortalPages",
|
|
9305
9319
|
"summary": "interpolatePortalPages",
|
|
9306
|
-
"description": "Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved.",
|
|
9320
|
+
"description": "Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved. Portal Builder preview only: requires a 360 (epilot) token or a `portal_preview` token; plain portal user tokens get 403.",
|
|
9307
9321
|
"tags": [
|
|
9308
9322
|
"ECP Admin"
|
|
9309
9323
|
],
|
|
@@ -13031,6 +13045,10 @@
|
|
|
13031
13045
|
"items": {
|
|
13032
13046
|
"$ref": "#/components/schemas/NotificationTriggerConfig"
|
|
13033
13047
|
}
|
|
13048
|
+
},
|
|
13049
|
+
"engagement_center_enabled": {
|
|
13050
|
+
"type": "boolean",
|
|
13051
|
+
"description": "Master toggle for the portal's engagement center (in-app notifications including the notification triggers above). Off when absent — portal users only see the engagement center and receive trigger notifications after an admin enables it."
|
|
13034
13052
|
}
|
|
13035
13053
|
}
|
|
13036
13054
|
},
|
|
@@ -13929,9 +13947,55 @@
|
|
|
13929
13947
|
},
|
|
13930
13948
|
"templates": {
|
|
13931
13949
|
"type": "object",
|
|
13950
|
+
"deprecated": true,
|
|
13951
|
+
"description": "DEPRECATED — client-supplied Handlebars templates. Use `templates_ref` instead so templates are derived server-side from admin-authored portal configuration. Ignored when `templates_ref` is present; rejected once the org has the `portals-reject-client-templates` flag enabled.",
|
|
13932
13952
|
"additionalProperties": {
|
|
13933
13953
|
"type": "string"
|
|
13934
13954
|
}
|
|
13955
|
+
},
|
|
13956
|
+
"templates_ref": {
|
|
13957
|
+
"type": "object",
|
|
13958
|
+
"description": "Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored.",
|
|
13959
|
+
"properties": {
|
|
13960
|
+
"page_id": {
|
|
13961
|
+
"type": "string",
|
|
13962
|
+
"description": "ID of the portal page to derive templates from. When given without `block_id`, templates are derived from every block of the page and returned resolved as a nested map keyed by block id (the entity detail page contract)."
|
|
13963
|
+
},
|
|
13964
|
+
"block_id": {
|
|
13965
|
+
"type": "string",
|
|
13966
|
+
"description": "ID of a block within the page. Templates are derived from the block's content according to its block type (e.g. meter_selector, meter_reading, entity_list)."
|
|
13967
|
+
},
|
|
13968
|
+
"config_id": {
|
|
13969
|
+
"type": "string",
|
|
13970
|
+
"description": "For blocks carrying a per-schema configuration array (entity_list), the id of the configuration item to derive templates from. Requires `page_id` and `block_id`."
|
|
13971
|
+
},
|
|
13972
|
+
"global_search_config_id": {
|
|
13973
|
+
"type": "string",
|
|
13974
|
+
"description": "ID of the portal's `global_search` configuration item to derive search result templates and the group title template from. Mutually exclusive with `page_id`."
|
|
13975
|
+
}
|
|
13976
|
+
}
|
|
13977
|
+
}
|
|
13978
|
+
}
|
|
13979
|
+
},
|
|
13980
|
+
"TemplatesRef": {
|
|
13981
|
+
"type": "object",
|
|
13982
|
+
"description": "Reference to admin-authored portal configuration (a page block or a global search configuration item) from which the API derives Handlebars templates server-side. This replaces client-supplied template strings so portal users can never submit arbitrary templates for resolution. When both a reference and raw `templates` are provided, the reference wins and the raw templates are ignored.",
|
|
13983
|
+
"properties": {
|
|
13984
|
+
"page_id": {
|
|
13985
|
+
"type": "string",
|
|
13986
|
+
"description": "ID of the portal page to derive templates from. When given without `block_id`, templates are derived from every block of the page and returned resolved as a nested map keyed by block id (the entity detail page contract)."
|
|
13987
|
+
},
|
|
13988
|
+
"block_id": {
|
|
13989
|
+
"type": "string",
|
|
13990
|
+
"description": "ID of a block within the page. Templates are derived from the block's content according to its block type (e.g. meter_selector, meter_reading, entity_list)."
|
|
13991
|
+
},
|
|
13992
|
+
"config_id": {
|
|
13993
|
+
"type": "string",
|
|
13994
|
+
"description": "For blocks carrying a per-schema configuration array (entity_list), the id of the configuration item to derive templates from. Requires `page_id` and `block_id`."
|
|
13995
|
+
},
|
|
13996
|
+
"global_search_config_id": {
|
|
13997
|
+
"type": "string",
|
|
13998
|
+
"description": "ID of the portal's `global_search` configuration item to derive search result templates and the group title template from. Mutually exclusive with `page_id`."
|
|
13935
13999
|
}
|
|
13936
14000
|
}
|
|
13937
14001
|
},
|
|
@@ -15773,7 +15837,8 @@
|
|
|
15773
15837
|
},
|
|
15774
15838
|
"templates": {
|
|
15775
15839
|
"type": "object",
|
|
15776
|
-
"
|
|
15840
|
+
"deprecated": true,
|
|
15841
|
+
"description": "DEPRECATED — client-supplied template strings to parse and return as synthetic fields. Supports both string values and nested objects of strings. Use `templates_ref` instead so templates are derived server-side from admin-authored portal configuration; ignored when `templates_ref` is present and rejected once the org has the `portals-reject-client-templates` flag enabled.",
|
|
15777
15842
|
"additionalProperties": {
|
|
15778
15843
|
"oneOf": [
|
|
15779
15844
|
{
|
|
@@ -15797,6 +15862,10 @@
|
|
|
15797
15862
|
}
|
|
15798
15863
|
}
|
|
15799
15864
|
},
|
|
15865
|
+
"templates_ref": {
|
|
15866
|
+
"$ref": "#/components/schemas/TemplatesRef",
|
|
15867
|
+
"description": "Reference to the portal page (or a single block within it) whose admin-configured content provides the templates, derived server-side. With only `page_id`, the derived templates are a nested map keyed by block id, mirroring the entity detail page contract."
|
|
15868
|
+
},
|
|
15800
15869
|
"filters": {
|
|
15801
15870
|
"type": "array",
|
|
15802
15871
|
"description": "Additional filters to apply to the search query",
|
|
@@ -15913,7 +15982,8 @@
|
|
|
15913
15982
|
},
|
|
15914
15983
|
"group_title": {
|
|
15915
15984
|
"type": "string",
|
|
15916
|
-
"
|
|
15985
|
+
"deprecated": true,
|
|
15986
|
+
"description": "DEPRECATED — client-supplied Handlebars template for the group title. Use `templates_ref` (global_search_config_id) instead; overridden when `templates_ref` derives a group title and rejected once the org has the `portals-reject-client-templates` flag enabled.",
|
|
15917
15987
|
"example": "{{customer[Primary].first_name}} {{customer[Primary].last_name}}"
|
|
15918
15988
|
},
|
|
15919
15989
|
"group_size": {
|
|
@@ -15980,7 +16050,8 @@
|
|
|
15980
16050
|
},
|
|
15981
16051
|
"templates": {
|
|
15982
16052
|
"type": "object",
|
|
15983
|
-
"
|
|
16053
|
+
"deprecated": true,
|
|
16054
|
+
"description": "DEPRECATED — client-supplied template strings to parse and return as synthetic fields. Use `templates_ref` instead; ignored when `templates_ref` is present and rejected once the org has the `portals-reject-client-templates` flag enabled.",
|
|
15984
16055
|
"additionalProperties": {
|
|
15985
16056
|
"type": "string"
|
|
15986
16057
|
},
|
|
@@ -15990,6 +16061,10 @@
|
|
|
15990
16061
|
"content_bottom_name": "{{custom_contract_delivery_address}}"
|
|
15991
16062
|
}
|
|
15992
16063
|
},
|
|
16064
|
+
"templates_ref": {
|
|
16065
|
+
"$ref": "#/components/schemas/TemplatesRef",
|
|
16066
|
+
"description": "Reference to admin-authored configuration providing the templates, derived server-side. For the global search block pass `global_search_config_id`; the derived templates also supply the group title template (overriding `group_title`)."
|
|
16067
|
+
},
|
|
15993
16068
|
"filters": {
|
|
15994
16069
|
"type": "array",
|
|
15995
16070
|
"description": "Additional filters to apply to the search query",
|
|
@@ -16529,7 +16604,8 @@
|
|
|
16529
16604
|
"PT15M",
|
|
16530
16605
|
"PT1H",
|
|
16531
16606
|
"P1D",
|
|
16532
|
-
"P1M"
|
|
16607
|
+
"P1M",
|
|
16608
|
+
"P1Y"
|
|
16533
16609
|
]
|
|
16534
16610
|
}
|
|
16535
16611
|
},
|
|
@@ -18634,7 +18710,6 @@
|
|
|
18634
18710
|
"token_endpoint",
|
|
18635
18711
|
"grant_type",
|
|
18636
18712
|
"code",
|
|
18637
|
-
"redirect_uri",
|
|
18638
18713
|
"client_id",
|
|
18639
18714
|
"code_verifier"
|
|
18640
18715
|
],
|
|
@@ -18660,8 +18735,8 @@
|
|
|
18660
18735
|
},
|
|
18661
18736
|
"redirect_uri": {
|
|
18662
18737
|
"type": "string",
|
|
18663
|
-
"description": "The redirect uri",
|
|
18664
|
-
"example": "https://customer-portal.com/
|
|
18738
|
+
"description": "The redirect uri used in the authorization request. Optional: when omitted it is\nresolved server-side from the provider's configured `redirect_uri`, falling back to\nthe portal's own callback route (`https://<domain>/sso`).\n",
|
|
18739
|
+
"example": "https://customer-portal.com/sso"
|
|
18665
18740
|
},
|
|
18666
18741
|
"client_id": {
|
|
18667
18742
|
"type": "string",
|