@epilot/customer-portal-client 0.48.1 → 0.49.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-runtime.json +22 -0
- package/dist/openapi.d.ts +221 -6
- package/package.json +14 -13
- package/src/openapi-runtime.json +22 -0
- package/src/openapi.json +186 -3
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={438(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var i=a(t(466));r.default=i.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/contact/identify":{"post":{"operationId":"identifyContact","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":{}}},"/v3/portal/public/sso/providers/{provider_slug}":{"get":{"operationId":"getPublicSSOProviderV3","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"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":{}}},"/v3/portal/public/user/temporary-password/complete":{"post":{"operationId":"completeTemporaryPassword","requestBody":{"required":true,"content":{"application/json":{}}},"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/config/{portal_id}/revisions":{"post":{"operationId":"createPortalRevision","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"listPortalRevisions","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"query","name":"limit","required":false},{"in":"query","name":"cursor","required":false}],"responses":{}}},"/v3/portal/config/{portal_id}/revisions/{revision_id}":{"get":{"operationId":"getPortalRevision","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"path","name":"revision_id","required":true}],"responses":{}}},"/v3/portal/config/{portal_id}/publish":{"post":{"operationId":"publishPortalRevision","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/configs":{"get":{"operationId":"listAllPortalConfigs","responses":{}}},"/v3/portal/configs/summaries":{"get":{"operationId":"listPortalConfigSummaries","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":{}}},"TooManyRequests":{"content":{"application/json":{}}},"BadGateway":{"content":{"application/json":{}}},"ServiceUnavailable":{"content":{"application/json":{}}},"GatewayTimeout":{"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 i=r[a];if(void 0!==i)return i.exports;var n=r[a]={exports:{}};return e[a].call(n.exports,n,n.exports,t),n.exports}(438),a=exports;for(var i in t)a[i]=t[i];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 i=a(t(466));r.default=i.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/contact/identify":{"post":{"operationId":"identifyContact","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":{}}},"/v3/portal/public/sso/providers/{provider_slug}":{"get":{"operationId":"getPublicSSOProviderV3","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"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":{}}},"/v3/portal/public/user/temporary-password/complete":{"post":{"operationId":"completeTemporaryPassword","requestBody":{"required":true,"content":{"application/json":{}}},"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/config/{portal_id}/revisions":{"post":{"operationId":"createPortalRevision","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"listPortalRevisions","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"query","name":"limit","required":false},{"in":"query","name":"cursor","required":false}],"responses":{}}},"/v3/portal/config/{portal_id}/revisions/{revision_id}":{"get":{"operationId":"getPortalRevision","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"path","name":"revision_id","required":true}],"responses":{}},"patch":{"operationId":"updatePortalRevision","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"path","name":"revision_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/{portal_id}/publish":{"post":{"operationId":"publishPortalRevision","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/configs":{"get":{"operationId":"listAllPortalConfigs","responses":{}}},"/v3/portal/configs/summaries":{"get":{"operationId":"listPortalConfigSummaries","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":{}}},"TooManyRequests":{"content":{"application/json":{}}},"BadGateway":{"content":{"application/json":{}}},"ServiceUnavailable":{"content":{"application/json":{}}},"GatewayTimeout":{"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 i=r[a];if(void 0!==i)return i.exports;var n=r[a]={exports:{}};return e[a].call(n.exports,n,n.exports,t),n.exports}(438),a=exports;for(var i in t)a[i]=t[i];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
@@ -2702,6 +2702,28 @@
|
|
|
2702
2702
|
}
|
|
2703
2703
|
],
|
|
2704
2704
|
"responses": {}
|
|
2705
|
+
},
|
|
2706
|
+
"patch": {
|
|
2707
|
+
"operationId": "updatePortalRevision",
|
|
2708
|
+
"parameters": [
|
|
2709
|
+
{
|
|
2710
|
+
"in": "path",
|
|
2711
|
+
"name": "portal_id",
|
|
2712
|
+
"required": true
|
|
2713
|
+
},
|
|
2714
|
+
{
|
|
2715
|
+
"in": "path",
|
|
2716
|
+
"name": "revision_id",
|
|
2717
|
+
"required": true
|
|
2718
|
+
}
|
|
2719
|
+
],
|
|
2720
|
+
"requestBody": {
|
|
2721
|
+
"required": true,
|
|
2722
|
+
"content": {
|
|
2723
|
+
"application/json": {}
|
|
2724
|
+
}
|
|
2725
|
+
},
|
|
2726
|
+
"responses": {}
|
|
2705
2727
|
}
|
|
2706
2728
|
},
|
|
2707
2729
|
"/v3/portal/config/{portal_id}/publish": {
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1307,6 +1307,13 @@ declare namespace Components {
|
|
|
1307
1307
|
* ]
|
|
1308
1308
|
*/
|
|
1309
1309
|
contract_identifiers?: ContractIdentifier[];
|
|
1310
|
+
/**
|
|
1311
|
+
* What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
|
|
1312
|
+
* - `contracts`: the user's Contact is added as a customer of the Contract.
|
|
1313
|
+
* - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
|
|
1314
|
+
*
|
|
1315
|
+
*/
|
|
1316
|
+
self_assignment_mode?: "contracts" | "customer_to_portal_user";
|
|
1310
1317
|
/**
|
|
1311
1318
|
* Configuration for contract selector in the portal
|
|
1312
1319
|
*/
|
|
@@ -1847,6 +1854,13 @@ declare namespace Components {
|
|
|
1847
1854
|
* ]
|
|
1848
1855
|
*/
|
|
1849
1856
|
contract_identifiers?: ContractIdentifier[];
|
|
1857
|
+
/**
|
|
1858
|
+
* What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
|
|
1859
|
+
* - `contracts`: the user's Contact is added as a customer of the Contract.
|
|
1860
|
+
* - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
|
|
1861
|
+
*
|
|
1862
|
+
*/
|
|
1863
|
+
self_assignment_mode?: "contracts" | "customer_to_portal_user";
|
|
1850
1864
|
/**
|
|
1851
1865
|
* Configuration for contract selector in the portal
|
|
1852
1866
|
*/
|
|
@@ -5264,6 +5278,12 @@ declare namespace Components {
|
|
|
5264
5278
|
* Design of the portal, used to preload it from the served document
|
|
5265
5279
|
*/
|
|
5266
5280
|
design_id?: string;
|
|
5281
|
+
/**
|
|
5282
|
+
* The portal design as returned by design-builder parse (theme=NEW), for the served document; absent when the design could not be read
|
|
5283
|
+
*/
|
|
5284
|
+
design?: {
|
|
5285
|
+
[name: string]: any;
|
|
5286
|
+
} | null;
|
|
5267
5287
|
}
|
|
5268
5288
|
/**
|
|
5269
5289
|
* The meter entity
|
|
@@ -6738,6 +6758,13 @@ declare namespace Components {
|
|
|
6738
6758
|
* ]
|
|
6739
6759
|
*/
|
|
6740
6760
|
contract_identifiers?: ContractIdentifier[];
|
|
6761
|
+
/**
|
|
6762
|
+
* What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
|
|
6763
|
+
* - `contracts`: the user's Contact is added as a customer of the Contract.
|
|
6764
|
+
* - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
|
|
6765
|
+
*
|
|
6766
|
+
*/
|
|
6767
|
+
self_assignment_mode?: "contracts" | "customer_to_portal_user";
|
|
6741
6768
|
/**
|
|
6742
6769
|
* Configuration for contract selector in the portal
|
|
6743
6770
|
*/
|
|
@@ -7488,6 +7515,13 @@ declare namespace Components {
|
|
|
7488
7515
|
* ]
|
|
7489
7516
|
*/
|
|
7490
7517
|
contract_identifiers?: ContractIdentifier[];
|
|
7518
|
+
/**
|
|
7519
|
+
* What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
|
|
7520
|
+
* - `contracts`: the user's Contact is added as a customer of the Contract.
|
|
7521
|
+
* - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
|
|
7522
|
+
*
|
|
7523
|
+
*/
|
|
7524
|
+
self_assignment_mode?: "contracts" | "customer_to_portal_user";
|
|
7491
7525
|
/**
|
|
7492
7526
|
* Configuration for contract selector in the portal
|
|
7493
7527
|
*/
|
|
@@ -7943,13 +7977,18 @@ declare namespace Components {
|
|
|
7943
7977
|
*/
|
|
7944
7978
|
created_by?: string;
|
|
7945
7979
|
/**
|
|
7946
|
-
* Set at publish time
|
|
7980
|
+
* Set at publish time when the publish request carries one, or by renaming the revision with `updatePortalRevision`. A revision can have been published and still have no name; `published_at` is the signal that a revision was live at some point, not this field.
|
|
7947
7981
|
*
|
|
7948
7982
|
* example:
|
|
7949
7983
|
* FAQ page launch
|
|
7950
7984
|
*/
|
|
7951
7985
|
name?: string;
|
|
7952
7986
|
description?: string;
|
|
7987
|
+
source?: /**
|
|
7988
|
+
* Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.
|
|
7989
|
+
*
|
|
7990
|
+
*/
|
|
7991
|
+
RevisionSource;
|
|
7953
7992
|
page_count: number;
|
|
7954
7993
|
/**
|
|
7955
7994
|
* The last time this revision was published. NOT the same question as `is_published`: a revision that was live yesterday still carries a `published_at`.
|
|
@@ -8018,13 +8057,18 @@ declare namespace Components {
|
|
|
8018
8057
|
*/
|
|
8019
8058
|
created_by?: string;
|
|
8020
8059
|
/**
|
|
8021
|
-
* Set at publish time
|
|
8060
|
+
* Set at publish time when the publish request carries one, or by renaming the revision with `updatePortalRevision`. A revision can have been published and still have no name; `published_at` is the signal that a revision was live at some point, not this field.
|
|
8022
8061
|
*
|
|
8023
8062
|
* example:
|
|
8024
8063
|
* FAQ page launch
|
|
8025
8064
|
*/
|
|
8026
8065
|
name?: string;
|
|
8027
8066
|
description?: string;
|
|
8067
|
+
source?: /**
|
|
8068
|
+
* Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.
|
|
8069
|
+
*
|
|
8070
|
+
*/
|
|
8071
|
+
RevisionSource;
|
|
8028
8072
|
page_count: number;
|
|
8029
8073
|
/**
|
|
8030
8074
|
* The last time this revision was published. NOT the same question as `is_published`: a revision that was live yesterday still carries a `published_at`.
|
|
@@ -8446,6 +8490,13 @@ declare namespace Components {
|
|
|
8446
8490
|
* ]
|
|
8447
8491
|
*/
|
|
8448
8492
|
contract_identifiers?: ContractIdentifier[];
|
|
8493
|
+
/**
|
|
8494
|
+
* What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
|
|
8495
|
+
* - `contracts`: the user's Contact is added as a customer of the Contract.
|
|
8496
|
+
* - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
|
|
8497
|
+
*
|
|
8498
|
+
*/
|
|
8499
|
+
self_assignment_mode?: "contracts" | "customer_to_portal_user";
|
|
8449
8500
|
/**
|
|
8450
8501
|
* Configuration for contract selector in the portal
|
|
8451
8502
|
*/
|
|
@@ -8658,6 +8709,11 @@ declare namespace Components {
|
|
|
8658
8709
|
[name: string]: Block;
|
|
8659
8710
|
};
|
|
8660
8711
|
based_on_revision_id?: string;
|
|
8712
|
+
revision_source?: /**
|
|
8713
|
+
* Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.
|
|
8714
|
+
*
|
|
8715
|
+
*/
|
|
8716
|
+
RevisionSource;
|
|
8661
8717
|
pages: /**
|
|
8662
8718
|
* A page inside a revision snapshot. `additionalProperties` is true on purpose — a page carries fields this schema does not name and they must survive into the snapshot and back onto the live page when it is published.
|
|
8663
8719
|
*
|
|
@@ -8676,13 +8732,18 @@ declare namespace Components {
|
|
|
8676
8732
|
*/
|
|
8677
8733
|
created_by?: string;
|
|
8678
8734
|
/**
|
|
8679
|
-
* Set at publish time
|
|
8735
|
+
* Set at publish time when the publish request carries one, or by renaming the revision with `updatePortalRevision`. A revision can have been published and still have no name; `published_at` is the signal that a revision was live at some point, not this field.
|
|
8680
8736
|
*
|
|
8681
8737
|
* example:
|
|
8682
8738
|
* FAQ page launch
|
|
8683
8739
|
*/
|
|
8684
8740
|
name?: string;
|
|
8685
8741
|
description?: string;
|
|
8742
|
+
source?: /**
|
|
8743
|
+
* Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.
|
|
8744
|
+
*
|
|
8745
|
+
*/
|
|
8746
|
+
RevisionSource;
|
|
8686
8747
|
page_count: number;
|
|
8687
8748
|
/**
|
|
8688
8749
|
* The last time this revision was published. NOT the same question as `is_published`: a revision that was live yesterday still carries a `published_at`.
|
|
@@ -8899,6 +8960,28 @@ declare namespace Components {
|
|
|
8899
8960
|
_schema: "portal_user";
|
|
8900
8961
|
}
|
|
8901
8962
|
export type PortalUserRegistrationStatus = "Registration Pending" | "Confirmation Email Sent" | "Registered" | "Email Update In Progress";
|
|
8963
|
+
/**
|
|
8964
|
+
* A portal whose design_id is the design asked about.
|
|
8965
|
+
*/
|
|
8966
|
+
export interface PortalUsingDesign {
|
|
8967
|
+
portal_id: /**
|
|
8968
|
+
* ID of the portal
|
|
8969
|
+
* example:
|
|
8970
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
8971
|
+
*/
|
|
8972
|
+
PortalId;
|
|
8973
|
+
/**
|
|
8974
|
+
* example:
|
|
8975
|
+
* Kundenportal
|
|
8976
|
+
*/
|
|
8977
|
+
name?: string;
|
|
8978
|
+
origin?: /* Origin of the portal */ Origin;
|
|
8979
|
+
/**
|
|
8980
|
+
* example:
|
|
8981
|
+
* 9ba94f20-b872-11ed-b30a-b3e3bf2dc8ab
|
|
8982
|
+
*/
|
|
8983
|
+
design_id?: string;
|
|
8984
|
+
}
|
|
8902
8985
|
export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget | PaymentWidget | MeterReadingWidget | MeterChartWidget | CampaignWidget | ProductRecommendationsWidget;
|
|
8903
8986
|
/**
|
|
8904
8987
|
* A portal-facing projection of a workflow execution (V1 or V2), with the execution
|
|
@@ -9869,6 +9952,14 @@ declare namespace Components {
|
|
|
9869
9952
|
[name: string]: any;
|
|
9870
9953
|
};
|
|
9871
9954
|
}
|
|
9955
|
+
/**
|
|
9956
|
+
* Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.
|
|
9957
|
+
*
|
|
9958
|
+
*/
|
|
9959
|
+
export interface RevisionSource {
|
|
9960
|
+
type: "blueprint_sync";
|
|
9961
|
+
blueprint_title?: string;
|
|
9962
|
+
}
|
|
9872
9963
|
export interface Rule {
|
|
9873
9964
|
entity?: string | null;
|
|
9874
9965
|
attribute?: string | null;
|
|
@@ -10293,6 +10384,15 @@ declare namespace Components {
|
|
|
10293
10384
|
*/
|
|
10294
10385
|
ProviderConfig[];
|
|
10295
10386
|
}
|
|
10387
|
+
export interface UpdatePortalRevisionRequest {
|
|
10388
|
+
/**
|
|
10389
|
+
* New label for the revision. Trimmed by the server; an empty name after trimming removes the revision's name.
|
|
10390
|
+
*
|
|
10391
|
+
* example:
|
|
10392
|
+
* FAQ page launch
|
|
10393
|
+
*/
|
|
10394
|
+
name: string;
|
|
10395
|
+
}
|
|
10296
10396
|
export interface UpsertPortalConfig {
|
|
10297
10397
|
/**
|
|
10298
10398
|
* Journey actions allowed on an entity by a portal user
|
|
@@ -10671,6 +10771,13 @@ declare namespace Components {
|
|
|
10671
10771
|
* ]
|
|
10672
10772
|
*/
|
|
10673
10773
|
contract_identifiers?: ContractIdentifier[];
|
|
10774
|
+
/**
|
|
10775
|
+
* What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
|
|
10776
|
+
* - `contracts`: the user's Contact is added as a customer of the Contract.
|
|
10777
|
+
* - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
|
|
10778
|
+
*
|
|
10779
|
+
*/
|
|
10780
|
+
self_assignment_mode?: "contracts" | "customer_to_portal_user";
|
|
10674
10781
|
/**
|
|
10675
10782
|
* Configuration for contract selector in the portal
|
|
10676
10783
|
*/
|
|
@@ -11272,6 +11379,13 @@ declare namespace Components {
|
|
|
11272
11379
|
* ]
|
|
11273
11380
|
*/
|
|
11274
11381
|
contract_identifiers?: ContractIdentifier[];
|
|
11382
|
+
/**
|
|
11383
|
+
* What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
|
|
11384
|
+
* - `contracts`: the user's Contact is added as a customer of the Contract.
|
|
11385
|
+
* - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
|
|
11386
|
+
*
|
|
11387
|
+
*/
|
|
11388
|
+
self_assignment_mode?: "contracts" | "customer_to_portal_user";
|
|
11275
11389
|
/**
|
|
11276
11390
|
* Configuration for contract selector in the portal
|
|
11277
11391
|
*/
|
|
@@ -15328,6 +15442,13 @@ declare namespace Paths {
|
|
|
15328
15442
|
* ]
|
|
15329
15443
|
*/
|
|
15330
15444
|
contract_identifiers?: Components.Schemas.ContractIdentifier[];
|
|
15445
|
+
/**
|
|
15446
|
+
* What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
|
|
15447
|
+
* - `contracts`: the user's Contact is added as a customer of the Contract.
|
|
15448
|
+
* - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
|
|
15449
|
+
*
|
|
15450
|
+
*/
|
|
15451
|
+
self_assignment_mode?: "contracts" | "customer_to_portal_user";
|
|
15331
15452
|
/**
|
|
15332
15453
|
* Configuration for contract selector in the portal
|
|
15333
15454
|
*/
|
|
@@ -15959,6 +16080,13 @@ declare namespace Paths {
|
|
|
15959
16080
|
* ]
|
|
15960
16081
|
*/
|
|
15961
16082
|
contract_identifiers?: Components.Schemas.ContractIdentifier[];
|
|
16083
|
+
/**
|
|
16084
|
+
* What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
|
|
16085
|
+
* - `contracts`: the user's Contact is added as a customer of the Contract.
|
|
16086
|
+
* - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
|
|
16087
|
+
*
|
|
16088
|
+
*/
|
|
16089
|
+
self_assignment_mode?: "contracts" | "customer_to_portal_user";
|
|
15962
16090
|
/**
|
|
15963
16091
|
* Configuration for contract selector in the portal
|
|
15964
16092
|
*/
|
|
@@ -17144,6 +17272,13 @@ declare namespace Paths {
|
|
|
17144
17272
|
* ]
|
|
17145
17273
|
*/
|
|
17146
17274
|
contract_identifiers?: Components.Schemas.ContractIdentifier[];
|
|
17275
|
+
/**
|
|
17276
|
+
* What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
|
|
17277
|
+
* - `contracts`: the user's Contact is added as a customer of the Contract.
|
|
17278
|
+
* - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
|
|
17279
|
+
*
|
|
17280
|
+
*/
|
|
17281
|
+
self_assignment_mode?: "contracts" | "customer_to_portal_user";
|
|
17147
17282
|
/**
|
|
17148
17283
|
* Configuration for contract selector in the portal
|
|
17149
17284
|
*/
|
|
@@ -19160,7 +19295,7 @@ declare namespace Paths {
|
|
|
19160
19295
|
*/
|
|
19161
19296
|
Components.Schemas.PortalId;
|
|
19162
19297
|
/**
|
|
19163
|
-
* Optional, opt-in configuration items to additionally swap on top of the always-swapped pages and functional config. Defaults to an empty list (nothing extra swapped). Domain and access/security settings can never be swapped.
|
|
19298
|
+
* Optional, opt-in configuration items to additionally swap on top of the always-swapped pages and functional config. Defaults to an empty list (nothing extra swapped). Domain and access/security settings can never be swapped. With `mode` the listed items are included in the draft revisions.
|
|
19164
19299
|
*/
|
|
19165
19300
|
items_to_swap?: /**
|
|
19166
19301
|
* Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum.
|
|
@@ -19168,6 +19303,10 @@ declare namespace Paths {
|
|
|
19168
19303
|
* - `portal_references`: after the swap, re-point configuration in other services from the source portal to the target portal: the portal on journey login (AuthControl) blocks and in file upload portal access, and the portal of automation flow portal triggers. One-directional: references to the target portal are left unchanged, because the target keeps its domain and users. System flows are not changed. Uses the caller's permissions; the outcome is returned in `portal_references`.
|
|
19169
19304
|
*/
|
|
19170
19305
|
Components.Schemas.SwappableConfig[];
|
|
19306
|
+
/**
|
|
19307
|
+
* Requires portal versioning (flag on, V3 target portal), otherwise 400. `copy` saves an unpublished revision on the target holding the source's setup; neither portal changes live and the source is untouched. Omit for the original live swap. Cannot be combined with the `portal_references` item, which only applies to a live swap.
|
|
19308
|
+
*/
|
|
19309
|
+
mode?: "copy";
|
|
19171
19310
|
}
|
|
19172
19311
|
namespace Responses {
|
|
19173
19312
|
export interface $200 {
|
|
@@ -19177,6 +19316,18 @@ declare namespace Paths {
|
|
|
19177
19316
|
*/
|
|
19178
19317
|
message?: string;
|
|
19179
19318
|
portal_references?: /* Outcome of the `portal_references` swap option. Only present when that option was requested. The swap itself has already succeeded when this is returned, so failures here do not undo it. */ Components.Schemas.SwapPortalReferencesResult;
|
|
19319
|
+
/**
|
|
19320
|
+
* Only with `mode`. The draft revision created on the target.
|
|
19321
|
+
*/
|
|
19322
|
+
revisions?: {
|
|
19323
|
+
portal_id?: /**
|
|
19324
|
+
* ID of the portal
|
|
19325
|
+
* example:
|
|
19326
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
19327
|
+
*/
|
|
19328
|
+
Components.Schemas.PortalId;
|
|
19329
|
+
revision_id?: string;
|
|
19330
|
+
}[];
|
|
19180
19331
|
}
|
|
19181
19332
|
export type $400 = Components.Responses.InvalidRequest;
|
|
19182
19333
|
export type $401 = Components.Responses.Unauthorized;
|
|
@@ -19479,6 +19630,41 @@ declare namespace Paths {
|
|
|
19479
19630
|
export type $500 = Components.Responses.InternalServerError;
|
|
19480
19631
|
}
|
|
19481
19632
|
}
|
|
19633
|
+
namespace UpdatePortalRevision {
|
|
19634
|
+
namespace Parameters {
|
|
19635
|
+
/**
|
|
19636
|
+
* example:
|
|
19637
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
19638
|
+
*/
|
|
19639
|
+
export type PortalId = string; // uuid
|
|
19640
|
+
/**
|
|
19641
|
+
* example:
|
|
19642
|
+
* 2026-08-25T14:03:11.482Z-a7f3c1d9
|
|
19643
|
+
*/
|
|
19644
|
+
export type RevisionId = string;
|
|
19645
|
+
}
|
|
19646
|
+
export interface PathParameters {
|
|
19647
|
+
portal_id: /**
|
|
19648
|
+
* example:
|
|
19649
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
19650
|
+
*/
|
|
19651
|
+
Parameters.PortalId /* uuid */;
|
|
19652
|
+
revision_id: /**
|
|
19653
|
+
* example:
|
|
19654
|
+
* 2026-08-25T14:03:11.482Z-a7f3c1d9
|
|
19655
|
+
*/
|
|
19656
|
+
Parameters.RevisionId;
|
|
19657
|
+
}
|
|
19658
|
+
export type RequestBody = Components.Schemas.UpdatePortalRevisionRequest;
|
|
19659
|
+
namespace Responses {
|
|
19660
|
+
export type $200 = Components.Schemas.PortalRevisionSummary;
|
|
19661
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
19662
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
19663
|
+
export type $403 = Components.Responses.Forbidden;
|
|
19664
|
+
export type $404 = Components.Responses.NotFound;
|
|
19665
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
19666
|
+
}
|
|
19667
|
+
}
|
|
19482
19668
|
namespace UpdatePortalUser {
|
|
19483
19669
|
export type RequestBody = Components.Schemas.Entity;
|
|
19484
19670
|
namespace Responses {
|
|
@@ -21775,6 +21961,19 @@ export interface OperationMethods {
|
|
|
21775
21961
|
data?: any,
|
|
21776
21962
|
config?: AxiosRequestConfig
|
|
21777
21963
|
): OperationResponse<Paths.GetPortalRevision.Responses.$200>
|
|
21964
|
+
/**
|
|
21965
|
+
* updatePortalRevision - updatePortalRevision
|
|
21966
|
+
*
|
|
21967
|
+
* Renames a revision without publishing it. Any revision can be renamed, published or not. Only the revision's `name` changes: its content, `published_at`, `published_by` and which revision is live stay as they are.
|
|
21968
|
+
*
|
|
21969
|
+
* The server trims `name`. An empty name after trimming removes the revision's name, and clients fall back to a label derived from `published_at` / `created_at`. A later publish without a `name` keeps the renamed name.
|
|
21970
|
+
*
|
|
21971
|
+
*/
|
|
21972
|
+
'updatePortalRevision'(
|
|
21973
|
+
parameters?: Parameters<Paths.UpdatePortalRevision.PathParameters> | null,
|
|
21974
|
+
data?: Paths.UpdatePortalRevision.RequestBody,
|
|
21975
|
+
config?: AxiosRequestConfig
|
|
21976
|
+
): OperationResponse<Paths.UpdatePortalRevision.Responses.$200>
|
|
21778
21977
|
/**
|
|
21779
21978
|
* publishPortalRevision - publishPortalRevision
|
|
21780
21979
|
*
|
|
@@ -21821,7 +22020,7 @@ export interface OperationMethods {
|
|
|
21821
22020
|
/**
|
|
21822
22021
|
* swapPortalConfig - swapPortalConfig
|
|
21823
22022
|
*
|
|
21824
|
-
* Swaps the portal configuration of two portals.
|
|
22023
|
+
* Swaps the portal configuration of two portals. Without `mode` both portals exchange pages and experience config live, as before. With `mode: copy` (portal versioning only) nothing live changes: the source's setup is saved as an unpublished revision on the target to review and publish. Domain and access/security settings never move.
|
|
21825
22024
|
*/
|
|
21826
22025
|
'swapPortalConfig'(
|
|
21827
22026
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -23987,6 +24186,19 @@ export interface PathsDictionary {
|
|
|
23987
24186
|
data?: any,
|
|
23988
24187
|
config?: AxiosRequestConfig
|
|
23989
24188
|
): OperationResponse<Paths.GetPortalRevision.Responses.$200>
|
|
24189
|
+
/**
|
|
24190
|
+
* updatePortalRevision - updatePortalRevision
|
|
24191
|
+
*
|
|
24192
|
+
* Renames a revision without publishing it. Any revision can be renamed, published or not. Only the revision's `name` changes: its content, `published_at`, `published_by` and which revision is live stay as they are.
|
|
24193
|
+
*
|
|
24194
|
+
* The server trims `name`. An empty name after trimming removes the revision's name, and clients fall back to a label derived from `published_at` / `created_at`. A later publish without a `name` keeps the renamed name.
|
|
24195
|
+
*
|
|
24196
|
+
*/
|
|
24197
|
+
'patch'(
|
|
24198
|
+
parameters?: Parameters<Paths.UpdatePortalRevision.PathParameters> | null,
|
|
24199
|
+
data?: Paths.UpdatePortalRevision.RequestBody,
|
|
24200
|
+
config?: AxiosRequestConfig
|
|
24201
|
+
): OperationResponse<Paths.UpdatePortalRevision.Responses.$200>
|
|
23990
24202
|
}
|
|
23991
24203
|
['/v3/portal/config/{portal_id}/publish']: {
|
|
23992
24204
|
/**
|
|
@@ -24041,7 +24253,7 @@ export interface PathsDictionary {
|
|
|
24041
24253
|
/**
|
|
24042
24254
|
* swapPortalConfig - swapPortalConfig
|
|
24043
24255
|
*
|
|
24044
|
-
* Swaps the portal configuration of two portals.
|
|
24256
|
+
* Swaps the portal configuration of two portals. Without `mode` both portals exchange pages and experience config live, as before. With `mode: copy` (portal versioning only) nothing live changes: the source's setup is saved as an unpublished revision on the target to review and publish. Domain and access/security settings never move.
|
|
24045
24257
|
*/
|
|
24046
24258
|
'post'(
|
|
24047
24259
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -24329,6 +24541,7 @@ export type PortalSurfaceEntityAccess = Components.Schemas.PortalSurfaceEntityAc
|
|
|
24329
24541
|
export type PortalTaskConfig = Components.Schemas.PortalTaskConfig;
|
|
24330
24542
|
export type PortalUser = Components.Schemas.PortalUser;
|
|
24331
24543
|
export type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
|
|
24544
|
+
export type PortalUsingDesign = Components.Schemas.PortalUsingDesign;
|
|
24332
24545
|
export type PortalWidget = Components.Schemas.PortalWidget;
|
|
24333
24546
|
export type PortalWorkflow = Components.Schemas.PortalWorkflow;
|
|
24334
24547
|
export type PortalWorkflowStage = Components.Schemas.PortalWorkflowStage;
|
|
@@ -24360,6 +24573,7 @@ export type RegistrationIdentifier = Components.Schemas.RegistrationIdentifier;
|
|
|
24360
24573
|
export type ReimbursementEvent = Components.Schemas.ReimbursementEvent;
|
|
24361
24574
|
export type RevisionPage = Components.Schemas.RevisionPage;
|
|
24362
24575
|
export type RevisionPageRequest = Components.Schemas.RevisionPageRequest;
|
|
24576
|
+
export type RevisionSource = Components.Schemas.RevisionSource;
|
|
24363
24577
|
export type Rule = Components.Schemas.Rule;
|
|
24364
24578
|
export type SAMLProviderConfig = Components.Schemas.SAMLProviderConfig;
|
|
24365
24579
|
export type SSOCallbackRequest = Components.Schemas.SSOCallbackRequest;
|
|
@@ -24383,6 +24597,7 @@ export type TeaserWidget = Components.Schemas.TeaserWidget;
|
|
|
24383
24597
|
export type TemplatesRef = Components.Schemas.TemplatesRef;
|
|
24384
24598
|
export type TriggerPortalFlow = Components.Schemas.TriggerPortalFlow;
|
|
24385
24599
|
export type UpdateOnlyPortalConfigAttributes = Components.Schemas.UpdateOnlyPortalConfigAttributes;
|
|
24600
|
+
export type UpdatePortalRevisionRequest = Components.Schemas.UpdatePortalRevisionRequest;
|
|
24386
24601
|
export type UpsertPortalConfig = Components.Schemas.UpsertPortalConfig;
|
|
24387
24602
|
export type UpsertPortalConfigV3 = Components.Schemas.UpsertPortalConfigV3;
|
|
24388
24603
|
export type UpsertPortalWidget = Components.Schemas.UpsertPortalWidget;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/customer-portal-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.49.0",
|
|
4
4
|
"description": "API Client for epilot portal API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -18,6 +18,18 @@
|
|
|
18
18
|
"sdk",
|
|
19
19
|
"customer-portal"
|
|
20
20
|
],
|
|
21
|
+
"scripts": {
|
|
22
|
+
"test": "vitest",
|
|
23
|
+
"typescript": "tsc",
|
|
24
|
+
"bundle-definition": "webpack",
|
|
25
|
+
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/customer-portal.yaml",
|
|
26
|
+
"typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
|
|
27
|
+
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
28
|
+
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
29
|
+
"build:watch": "npm run build && tsc -w",
|
|
30
|
+
"prepublishOnly": "npm run typegen && npm run build",
|
|
31
|
+
"lint": "biome check src"
|
|
32
|
+
},
|
|
21
33
|
"files": [
|
|
22
34
|
"*.js",
|
|
23
35
|
"*.d.ts",
|
|
@@ -55,16 +67,5 @@
|
|
|
55
67
|
"typescript": "^4.1.3",
|
|
56
68
|
"webpack": "^5.18.0",
|
|
57
69
|
"webpack-cli": "^4.4.0"
|
|
58
|
-
},
|
|
59
|
-
"scripts": {
|
|
60
|
-
"test": "vitest",
|
|
61
|
-
"typescript": "tsc",
|
|
62
|
-
"bundle-definition": "webpack",
|
|
63
|
-
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/customer-portal.yaml",
|
|
64
|
-
"typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
|
|
65
|
-
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
66
|
-
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
67
|
-
"build:watch": "npm run build && tsc -w",
|
|
68
|
-
"lint": "biome check src"
|
|
69
70
|
}
|
|
70
|
-
}
|
|
71
|
+
}
|
package/src/openapi-runtime.json
CHANGED
|
@@ -2702,6 +2702,28 @@
|
|
|
2702
2702
|
}
|
|
2703
2703
|
],
|
|
2704
2704
|
"responses": {}
|
|
2705
|
+
},
|
|
2706
|
+
"patch": {
|
|
2707
|
+
"operationId": "updatePortalRevision",
|
|
2708
|
+
"parameters": [
|
|
2709
|
+
{
|
|
2710
|
+
"in": "path",
|
|
2711
|
+
"name": "portal_id",
|
|
2712
|
+
"required": true
|
|
2713
|
+
},
|
|
2714
|
+
{
|
|
2715
|
+
"in": "path",
|
|
2716
|
+
"name": "revision_id",
|
|
2717
|
+
"required": true
|
|
2718
|
+
}
|
|
2719
|
+
],
|
|
2720
|
+
"requestBody": {
|
|
2721
|
+
"required": true,
|
|
2722
|
+
"content": {
|
|
2723
|
+
"application/json": {}
|
|
2724
|
+
}
|
|
2725
|
+
},
|
|
2726
|
+
"responses": {}
|
|
2705
2727
|
}
|
|
2706
2728
|
},
|
|
2707
2729
|
"/v3/portal/config/{portal_id}/publish": {
|
package/src/openapi.json
CHANGED
|
@@ -11077,6 +11077,80 @@
|
|
|
11077
11077
|
"$ref": "#/components/responses/InternalServerError"
|
|
11078
11078
|
}
|
|
11079
11079
|
}
|
|
11080
|
+
},
|
|
11081
|
+
"patch": {
|
|
11082
|
+
"operationId": "updatePortalRevision",
|
|
11083
|
+
"summary": "updatePortalRevision",
|
|
11084
|
+
"description": "Renames a revision without publishing it. Any revision can be renamed, published or not. Only the revision's `name` changes: its content, `published_at`, `published_by` and which revision is live stay as they are.\n\nThe server trims `name`. An empty name after trimming removes the revision's name, and clients fall back to a label derived from `published_at` / `created_at`. A later publish without a `name` keeps the renamed name.\n",
|
|
11085
|
+
"tags": [
|
|
11086
|
+
"ECP Admin"
|
|
11087
|
+
],
|
|
11088
|
+
"parameters": [
|
|
11089
|
+
{
|
|
11090
|
+
"in": "path",
|
|
11091
|
+
"name": "portal_id",
|
|
11092
|
+
"required": true,
|
|
11093
|
+
"schema": {
|
|
11094
|
+
"type": "string",
|
|
11095
|
+
"format": "uuid",
|
|
11096
|
+
"example": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
11097
|
+
},
|
|
11098
|
+
"description": "Portal ID (readonly UUID generated on portal creation)"
|
|
11099
|
+
},
|
|
11100
|
+
{
|
|
11101
|
+
"in": "path",
|
|
11102
|
+
"name": "revision_id",
|
|
11103
|
+
"required": true,
|
|
11104
|
+
"schema": {
|
|
11105
|
+
"type": "string",
|
|
11106
|
+
"example": "2026-08-25T14:03:11.482Z-a7f3c1d9"
|
|
11107
|
+
},
|
|
11108
|
+
"description": "Revision ID. Contains `:` characters, so percent-encode it."
|
|
11109
|
+
}
|
|
11110
|
+
],
|
|
11111
|
+
"requestBody": {
|
|
11112
|
+
"description": "The new revision name",
|
|
11113
|
+
"required": true,
|
|
11114
|
+
"content": {
|
|
11115
|
+
"application/json": {
|
|
11116
|
+
"schema": {
|
|
11117
|
+
"$ref": "#/components/schemas/UpdatePortalRevisionRequest"
|
|
11118
|
+
}
|
|
11119
|
+
}
|
|
11120
|
+
}
|
|
11121
|
+
},
|
|
11122
|
+
"security": [
|
|
11123
|
+
{
|
|
11124
|
+
"EpilotAuth": []
|
|
11125
|
+
}
|
|
11126
|
+
],
|
|
11127
|
+
"responses": {
|
|
11128
|
+
"200": {
|
|
11129
|
+
"description": "Revision renamed successfully.",
|
|
11130
|
+
"content": {
|
|
11131
|
+
"application/json": {
|
|
11132
|
+
"schema": {
|
|
11133
|
+
"$ref": "#/components/schemas/PortalRevisionSummary"
|
|
11134
|
+
}
|
|
11135
|
+
}
|
|
11136
|
+
}
|
|
11137
|
+
},
|
|
11138
|
+
"400": {
|
|
11139
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
11140
|
+
},
|
|
11141
|
+
"401": {
|
|
11142
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
11143
|
+
},
|
|
11144
|
+
"403": {
|
|
11145
|
+
"$ref": "#/components/responses/Forbidden"
|
|
11146
|
+
},
|
|
11147
|
+
"404": {
|
|
11148
|
+
"$ref": "#/components/responses/NotFound"
|
|
11149
|
+
},
|
|
11150
|
+
"500": {
|
|
11151
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
11152
|
+
}
|
|
11153
|
+
}
|
|
11080
11154
|
}
|
|
11081
11155
|
},
|
|
11082
11156
|
"/v3/portal/config/{portal_id}/publish": {
|
|
@@ -11243,7 +11317,7 @@
|
|
|
11243
11317
|
"post": {
|
|
11244
11318
|
"operationId": "swapPortalConfig",
|
|
11245
11319
|
"summary": "swapPortalConfig",
|
|
11246
|
-
"description": "Swaps the portal configuration of two portals.",
|
|
11320
|
+
"description": "Swaps the portal configuration of two portals. Without `mode` both portals exchange pages and experience config live, as before. With `mode: copy` (portal versioning only) nothing live changes: the source's setup is saved as an unpublished revision on the target to review and publish. Domain and access/security settings never move.",
|
|
11247
11321
|
"tags": [
|
|
11248
11322
|
"ECP Admin"
|
|
11249
11323
|
],
|
|
@@ -11275,7 +11349,14 @@
|
|
|
11275
11349
|
"items": {
|
|
11276
11350
|
"$ref": "#/components/schemas/SwappableConfig"
|
|
11277
11351
|
},
|
|
11278
|
-
"description": "Optional, opt-in configuration items to additionally swap on top of the always-swapped pages and functional config. Defaults to an empty list (nothing extra swapped). Domain and access/security settings can never be swapped."
|
|
11352
|
+
"description": "Optional, opt-in configuration items to additionally swap on top of the always-swapped pages and functional config. Defaults to an empty list (nothing extra swapped). Domain and access/security settings can never be swapped. With `mode` the listed items are included in the draft revisions."
|
|
11353
|
+
},
|
|
11354
|
+
"mode": {
|
|
11355
|
+
"type": "string",
|
|
11356
|
+
"enum": [
|
|
11357
|
+
"copy"
|
|
11358
|
+
],
|
|
11359
|
+
"description": "Requires portal versioning (flag on, V3 target portal), otherwise 400. `copy` saves an unpublished revision on the target holding the source's setup; neither portal changes live and the source is untouched. Omit for the original live swap. Cannot be combined with the `portal_references` item, which only applies to a live swap."
|
|
11279
11360
|
}
|
|
11280
11361
|
}
|
|
11281
11362
|
}
|
|
@@ -11296,6 +11377,21 @@
|
|
|
11296
11377
|
},
|
|
11297
11378
|
"portal_references": {
|
|
11298
11379
|
"$ref": "#/components/schemas/SwapPortalReferencesResult"
|
|
11380
|
+
},
|
|
11381
|
+
"revisions": {
|
|
11382
|
+
"type": "array",
|
|
11383
|
+
"description": "Only with `mode`. The draft revision created on the target.",
|
|
11384
|
+
"items": {
|
|
11385
|
+
"type": "object",
|
|
11386
|
+
"properties": {
|
|
11387
|
+
"portal_id": {
|
|
11388
|
+
"$ref": "#/components/schemas/PortalId"
|
|
11389
|
+
},
|
|
11390
|
+
"revision_id": {
|
|
11391
|
+
"type": "string"
|
|
11392
|
+
}
|
|
11393
|
+
}
|
|
11394
|
+
}
|
|
11299
11395
|
}
|
|
11300
11396
|
}
|
|
11301
11397
|
}
|
|
@@ -13495,6 +13591,15 @@
|
|
|
13495
13591
|
}
|
|
13496
13592
|
]
|
|
13497
13593
|
},
|
|
13594
|
+
"self_assignment_mode": {
|
|
13595
|
+
"type": "string",
|
|
13596
|
+
"enum": [
|
|
13597
|
+
"contracts",
|
|
13598
|
+
"customer_to_portal_user"
|
|
13599
|
+
],
|
|
13600
|
+
"default": "contracts",
|
|
13601
|
+
"description": "What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:\n - `contracts`: the user's Contact is added as a customer of the Contract.\n - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.\n"
|
|
13602
|
+
},
|
|
13498
13603
|
"contract_selector_config": {
|
|
13499
13604
|
"type": "object",
|
|
13500
13605
|
"description": "Configuration for contract selector in the portal",
|
|
@@ -20585,6 +20690,15 @@
|
|
|
20585
20690
|
}
|
|
20586
20691
|
]
|
|
20587
20692
|
},
|
|
20693
|
+
"self_assignment_mode": {
|
|
20694
|
+
"type": "string",
|
|
20695
|
+
"enum": [
|
|
20696
|
+
"contracts",
|
|
20697
|
+
"customer_to_portal_user"
|
|
20698
|
+
],
|
|
20699
|
+
"default": "contracts",
|
|
20700
|
+
"description": "What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:\n - `contracts`: the user's Contact is added as a customer of the Contract.\n - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.\n"
|
|
20701
|
+
},
|
|
20588
20702
|
"contract_selector_config": {
|
|
20589
20703
|
"type": "object",
|
|
20590
20704
|
"description": "Configuration for contract selector in the portal",
|
|
@@ -21031,6 +21145,29 @@
|
|
|
21031
21145
|
}
|
|
21032
21146
|
}
|
|
21033
21147
|
},
|
|
21148
|
+
"PortalUsingDesign": {
|
|
21149
|
+
"type": "object",
|
|
21150
|
+
"description": "A portal whose design_id is the design asked about.",
|
|
21151
|
+
"required": [
|
|
21152
|
+
"portal_id"
|
|
21153
|
+
],
|
|
21154
|
+
"properties": {
|
|
21155
|
+
"portal_id": {
|
|
21156
|
+
"$ref": "#/components/schemas/PortalId"
|
|
21157
|
+
},
|
|
21158
|
+
"name": {
|
|
21159
|
+
"type": "string",
|
|
21160
|
+
"example": "Kundenportal"
|
|
21161
|
+
},
|
|
21162
|
+
"origin": {
|
|
21163
|
+
"$ref": "#/components/schemas/Origin"
|
|
21164
|
+
},
|
|
21165
|
+
"design_id": {
|
|
21166
|
+
"type": "string",
|
|
21167
|
+
"example": "9ba94f20-b872-11ed-b30a-b3e3bf2dc8ab"
|
|
21168
|
+
}
|
|
21169
|
+
}
|
|
21170
|
+
},
|
|
21034
21171
|
"PortalConfigSummaryV3": {
|
|
21035
21172
|
"type": "object",
|
|
21036
21173
|
"description": "Lightweight view of a portal config for lists and pickers. Carries the identifying,\ndisplay and registration fields only. Pages, email templates, grants, feature flags,\nidentity providers and certificate details are left out; read them per portal with\n`getPortalConfigV3`.\n",
|
|
@@ -21220,6 +21357,12 @@
|
|
|
21220
21357
|
"design_id": {
|
|
21221
21358
|
"type": "string",
|
|
21222
21359
|
"description": "Design of the portal, used to preload it from the served document"
|
|
21360
|
+
},
|
|
21361
|
+
"design": {
|
|
21362
|
+
"type": "object",
|
|
21363
|
+
"additionalProperties": true,
|
|
21364
|
+
"nullable": true,
|
|
21365
|
+
"description": "The portal design as returned by design-builder parse (theme=NEW), for the served document; absent when the design could not be read"
|
|
21223
21366
|
}
|
|
21224
21367
|
}
|
|
21225
21368
|
},
|
|
@@ -21282,6 +21425,9 @@
|
|
|
21282
21425
|
"based_on_revision_id": {
|
|
21283
21426
|
"type": "string"
|
|
21284
21427
|
},
|
|
21428
|
+
"revision_source": {
|
|
21429
|
+
"$ref": "#/components/schemas/RevisionSource"
|
|
21430
|
+
},
|
|
21285
21431
|
"pages": {
|
|
21286
21432
|
"type": "array",
|
|
21287
21433
|
"items": {
|
|
@@ -21315,6 +21461,40 @@
|
|
|
21315
21461
|
}
|
|
21316
21462
|
}
|
|
21317
21463
|
},
|
|
21464
|
+
"UpdatePortalRevisionRequest": {
|
|
21465
|
+
"type": "object",
|
|
21466
|
+
"required": [
|
|
21467
|
+
"name"
|
|
21468
|
+
],
|
|
21469
|
+
"properties": {
|
|
21470
|
+
"name": {
|
|
21471
|
+
"type": "string",
|
|
21472
|
+
"maxLength": 255,
|
|
21473
|
+
"description": "New label for the revision. Trimmed by the server; an empty name after trimming removes the revision's name.\n",
|
|
21474
|
+
"example": "FAQ page launch"
|
|
21475
|
+
}
|
|
21476
|
+
}
|
|
21477
|
+
},
|
|
21478
|
+
"RevisionSource": {
|
|
21479
|
+
"type": "object",
|
|
21480
|
+
"description": "Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.\n",
|
|
21481
|
+
"additionalProperties": false,
|
|
21482
|
+
"required": [
|
|
21483
|
+
"type"
|
|
21484
|
+
],
|
|
21485
|
+
"properties": {
|
|
21486
|
+
"type": {
|
|
21487
|
+
"type": "string",
|
|
21488
|
+
"enum": [
|
|
21489
|
+
"blueprint_sync"
|
|
21490
|
+
]
|
|
21491
|
+
},
|
|
21492
|
+
"blueprint_title": {
|
|
21493
|
+
"type": "string",
|
|
21494
|
+
"maxLength": 200
|
|
21495
|
+
}
|
|
21496
|
+
}
|
|
21497
|
+
},
|
|
21318
21498
|
"PortalRevisionSummary": {
|
|
21319
21499
|
"type": "object",
|
|
21320
21500
|
"required": [
|
|
@@ -21338,12 +21518,15 @@
|
|
|
21338
21518
|
},
|
|
21339
21519
|
"name": {
|
|
21340
21520
|
"type": "string",
|
|
21341
|
-
"description": "Set at publish time
|
|
21521
|
+
"description": "Set at publish time when the publish request carries one, or by renaming the revision with `updatePortalRevision`. A revision can have been published and still have no name; `published_at` is the signal that a revision was live at some point, not this field.\n",
|
|
21342
21522
|
"example": "FAQ page launch"
|
|
21343
21523
|
},
|
|
21344
21524
|
"description": {
|
|
21345
21525
|
"type": "string"
|
|
21346
21526
|
},
|
|
21527
|
+
"source": {
|
|
21528
|
+
"$ref": "#/components/schemas/RevisionSource"
|
|
21529
|
+
},
|
|
21347
21530
|
"page_count": {
|
|
21348
21531
|
"type": "number"
|
|
21349
21532
|
},
|