@epilot/customer-portal-client 0.47.2 → 0.48.1
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 +12 -0
- package/dist/openapi.d.ts +162 -6
- package/package.json +13 -14
- package/src/openapi-runtime.json +12 -0
- package/src/openapi.json +202 -7
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":{}}},"/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":{}}},"/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})})();
|
|
@@ -2460,6 +2460,18 @@
|
|
|
2460
2460
|
"responses": {}
|
|
2461
2461
|
}
|
|
2462
2462
|
},
|
|
2463
|
+
"/v3/portal/public/user/temporary-password/complete": {
|
|
2464
|
+
"post": {
|
|
2465
|
+
"operationId": "completeTemporaryPassword",
|
|
2466
|
+
"requestBody": {
|
|
2467
|
+
"required": true,
|
|
2468
|
+
"content": {
|
|
2469
|
+
"application/json": {}
|
|
2470
|
+
}
|
|
2471
|
+
},
|
|
2472
|
+
"responses": {}
|
|
2473
|
+
}
|
|
2474
|
+
},
|
|
2463
2475
|
"/v2/portal/campaign/{campaign_id}/entity:status": {
|
|
2464
2476
|
"put": {
|
|
2465
2477
|
"operationId": "updateCampaignPortalBlockStatus",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -2277,6 +2277,15 @@ declare namespace Components {
|
|
|
2277
2277
|
* []
|
|
2278
2278
|
*/
|
|
2279
2279
|
allowed_operations?: string[];
|
|
2280
|
+
/**
|
|
2281
|
+
* Whether the identified contact already has a portal user on this portal, so the caller
|
|
2282
|
+
* can skip offering account creation. Present only on a match; omitted when it could not
|
|
2283
|
+
* be determined.
|
|
2284
|
+
*
|
|
2285
|
+
* example:
|
|
2286
|
+
* false
|
|
2287
|
+
*/
|
|
2288
|
+
has_portal_user?: boolean;
|
|
2280
2289
|
/**
|
|
2281
2290
|
* Present only when no token was issued. NOT_FOUND means the given identifiers did not
|
|
2282
2291
|
* match any contact (definitive - the client should not retry). TIMEOUT means the contact
|
|
@@ -5200,7 +5209,7 @@ declare namespace Components {
|
|
|
5200
5209
|
*/
|
|
5201
5210
|
scanned: number;
|
|
5202
5211
|
usages: {
|
|
5203
|
-
kind: "portal-config" | "portal-block"
|
|
5212
|
+
kind: "portal-config" | "portal-block";
|
|
5204
5213
|
resource: {
|
|
5205
5214
|
type: "portal";
|
|
5206
5215
|
id: string;
|
|
@@ -5235,6 +5244,26 @@ declare namespace Components {
|
|
|
5235
5244
|
* https://example.com
|
|
5236
5245
|
*/
|
|
5237
5246
|
redirect_to?: string;
|
|
5247
|
+
/**
|
|
5248
|
+
* Portal name, served as the document title before the app boots
|
|
5249
|
+
* example:
|
|
5250
|
+
* Kundenportal
|
|
5251
|
+
*/
|
|
5252
|
+
title?: string;
|
|
5253
|
+
/**
|
|
5254
|
+
* Whether the served document should carry a `noindex, nofollow` robots meta tag
|
|
5255
|
+
*/
|
|
5256
|
+
prevent_indexing?: boolean;
|
|
5257
|
+
/**
|
|
5258
|
+
* Organization of the portal, used to preload its design from the served document
|
|
5259
|
+
* example:
|
|
5260
|
+
* 123
|
|
5261
|
+
*/
|
|
5262
|
+
organization_id?: string;
|
|
5263
|
+
/**
|
|
5264
|
+
* Design of the portal, used to preload it from the served document
|
|
5265
|
+
*/
|
|
5266
|
+
design_id?: string;
|
|
5238
5267
|
}
|
|
5239
5268
|
/**
|
|
5240
5269
|
* The meter entity
|
|
@@ -7791,15 +7820,19 @@ declare namespace Components {
|
|
|
7791
7820
|
*/
|
|
7792
7821
|
export interface PortalFeatureSettings {
|
|
7793
7822
|
/**
|
|
7794
|
-
*
|
|
7823
|
+
* Retired, not read. A portal shows a start page by having a `dashboard` page.
|
|
7795
7824
|
*/
|
|
7796
7825
|
start_page?: boolean;
|
|
7797
7826
|
/**
|
|
7798
|
-
* Billing
|
|
7827
|
+
* Retired, not read. Billing follows the organization's `commodity_billing` setting.
|
|
7799
7828
|
*/
|
|
7800
7829
|
billing?: boolean;
|
|
7801
7830
|
/**
|
|
7802
|
-
*
|
|
7831
|
+
* Retired, not read. Billing pages and blocks follow the organization's `commodity_billing` setting.
|
|
7832
|
+
*/
|
|
7833
|
+
commodity_billing?: boolean;
|
|
7834
|
+
/**
|
|
7835
|
+
* Retired, not read.
|
|
7803
7836
|
*/
|
|
7804
7837
|
change_due_date?: boolean;
|
|
7805
7838
|
/**
|
|
@@ -7814,6 +7847,14 @@ declare namespace Components {
|
|
|
7814
7847
|
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
7815
7848
|
*/
|
|
7816
7849
|
mcp_grant_version?: number;
|
|
7850
|
+
/**
|
|
7851
|
+
* Enable the portal copilot chat for this portal
|
|
7852
|
+
*/
|
|
7853
|
+
portal_copilot?: boolean;
|
|
7854
|
+
/**
|
|
7855
|
+
* ID of the Agent Builder portal agent this portal's copilot chat runs, set by Agent Builder. When unset, or when the agent no longer exists in the portal's organization, the chat runs the default portal copilot.
|
|
7856
|
+
*/
|
|
7857
|
+
portal_copilot_agent_id?: string;
|
|
7817
7858
|
}
|
|
7818
7859
|
/**
|
|
7819
7860
|
* ID of the portal
|
|
@@ -10066,10 +10107,52 @@ declare namespace Components {
|
|
|
10066
10107
|
*/
|
|
10067
10108
|
status: string;
|
|
10068
10109
|
}
|
|
10110
|
+
export interface SwapPortalReferenceGroup {
|
|
10111
|
+
/**
|
|
10112
|
+
* Items whose references now point at the target portal.
|
|
10113
|
+
*/
|
|
10114
|
+
updated: SwapPortalReferenceItem[];
|
|
10115
|
+
/**
|
|
10116
|
+
* Items that reference the source portal but could not be updated.
|
|
10117
|
+
*/
|
|
10118
|
+
failed: SwapPortalReferenceItem[];
|
|
10119
|
+
/**
|
|
10120
|
+
* Set when the items could not be listed, so none of them were checked.
|
|
10121
|
+
*/
|
|
10122
|
+
list_error?: string;
|
|
10123
|
+
}
|
|
10124
|
+
export interface SwapPortalReferenceItem {
|
|
10125
|
+
/**
|
|
10126
|
+
* Journey id or automation flow id.
|
|
10127
|
+
*/
|
|
10128
|
+
id: string;
|
|
10129
|
+
name?: string;
|
|
10130
|
+
/**
|
|
10131
|
+
* Where the reference sat in the item.
|
|
10132
|
+
* example:
|
|
10133
|
+
* [
|
|
10134
|
+
* "steps[0].uischema.elements[2].options.portalId"
|
|
10135
|
+
* ]
|
|
10136
|
+
*/
|
|
10137
|
+
paths?: string[];
|
|
10138
|
+
/**
|
|
10139
|
+
* Why the update failed. Only set on failed items.
|
|
10140
|
+
*/
|
|
10141
|
+
error?: string;
|
|
10142
|
+
}
|
|
10143
|
+
/**
|
|
10144
|
+
* 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.
|
|
10145
|
+
*/
|
|
10146
|
+
export interface SwapPortalReferencesResult {
|
|
10147
|
+
journeys: SwapPortalReferenceGroup;
|
|
10148
|
+
automation_flows: SwapPortalReferenceGroup;
|
|
10149
|
+
}
|
|
10069
10150
|
/**
|
|
10070
10151
|
* 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.
|
|
10152
|
+
* - `email_templates`: swap the email templates of the two portals.
|
|
10153
|
+
* - `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`.
|
|
10071
10154
|
*/
|
|
10072
|
-
export type SwappableConfig = "email_templates";
|
|
10155
|
+
export type SwappableConfig = "email_templates" | "portal_references";
|
|
10073
10156
|
export type TariffType = "ht" | "nt";
|
|
10074
10157
|
export interface TeaserWidget {
|
|
10075
10158
|
id: string;
|
|
@@ -11870,6 +11953,48 @@ declare namespace Paths {
|
|
|
11870
11953
|
export type $500 = Components.Responses.InternalServerError;
|
|
11871
11954
|
}
|
|
11872
11955
|
}
|
|
11956
|
+
namespace CompleteTemporaryPassword {
|
|
11957
|
+
export interface RequestBody {
|
|
11958
|
+
/**
|
|
11959
|
+
* Organization ID
|
|
11960
|
+
* example:
|
|
11961
|
+
* 123
|
|
11962
|
+
*/
|
|
11963
|
+
org_id: string;
|
|
11964
|
+
/**
|
|
11965
|
+
* ID of the portal the user belongs to
|
|
11966
|
+
* example:
|
|
11967
|
+
* 7hj28akg-97fb-4f5c-b2a1-3e4fbc1d8c7a
|
|
11968
|
+
*/
|
|
11969
|
+
portal_id: string;
|
|
11970
|
+
/**
|
|
11971
|
+
* Email address of the portal user
|
|
11972
|
+
* example:
|
|
11973
|
+
* user@example.com
|
|
11974
|
+
*/
|
|
11975
|
+
email: string;
|
|
11976
|
+
/**
|
|
11977
|
+
* Temporary password from the email
|
|
11978
|
+
*/
|
|
11979
|
+
temporary_password: string;
|
|
11980
|
+
/**
|
|
11981
|
+
* New password, must match the portal's password policy
|
|
11982
|
+
*/
|
|
11983
|
+
new_password: string;
|
|
11984
|
+
}
|
|
11985
|
+
namespace Responses {
|
|
11986
|
+
export interface $200 {
|
|
11987
|
+
/**
|
|
11988
|
+
* example:
|
|
11989
|
+
* Password set successfully.
|
|
11990
|
+
*/
|
|
11991
|
+
message?: string;
|
|
11992
|
+
}
|
|
11993
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
11994
|
+
export type $429 = Components.Responses.TooManyRequests;
|
|
11995
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11996
|
+
}
|
|
11997
|
+
}
|
|
11873
11998
|
namespace ConfigureDistribution {
|
|
11874
11999
|
namespace Parameters {
|
|
11875
12000
|
export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
|
|
@@ -19037,7 +19162,12 @@ declare namespace Paths {
|
|
|
19037
19162
|
/**
|
|
19038
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.
|
|
19039
19164
|
*/
|
|
19040
|
-
items_to_swap?:
|
|
19165
|
+
items_to_swap?: /**
|
|
19166
|
+
* 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.
|
|
19167
|
+
* - `email_templates`: swap the email templates of the two portals.
|
|
19168
|
+
* - `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
|
+
*/
|
|
19170
|
+
Components.Schemas.SwappableConfig[];
|
|
19041
19171
|
}
|
|
19042
19172
|
namespace Responses {
|
|
19043
19173
|
export interface $200 {
|
|
@@ -19046,6 +19176,7 @@ declare namespace Paths {
|
|
|
19046
19176
|
* Domain and users swapped successfully.
|
|
19047
19177
|
*/
|
|
19048
19178
|
message?: string;
|
|
19179
|
+
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;
|
|
19049
19180
|
}
|
|
19050
19181
|
export type $400 = Components.Responses.InvalidRequest;
|
|
19051
19182
|
export type $401 = Components.Responses.Unauthorized;
|
|
@@ -21468,6 +21599,16 @@ export interface OperationMethods {
|
|
|
21468
21599
|
data?: any,
|
|
21469
21600
|
config?: AxiosRequestConfig
|
|
21470
21601
|
): OperationResponse<Paths.GetUserEntryPoint.Responses.$200>
|
|
21602
|
+
/**
|
|
21603
|
+
* completeTemporaryPassword - completeTemporaryPassword
|
|
21604
|
+
*
|
|
21605
|
+
* Replaces a portal user's temporary password with the password they chose.
|
|
21606
|
+
*/
|
|
21607
|
+
'completeTemporaryPassword'(
|
|
21608
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
21609
|
+
data?: Paths.CompleteTemporaryPassword.RequestBody,
|
|
21610
|
+
config?: AxiosRequestConfig
|
|
21611
|
+
): OperationResponse<Paths.CompleteTemporaryPassword.Responses.$200>
|
|
21471
21612
|
/**
|
|
21472
21613
|
* updateCampaignPortalBlockStatus - updateCampaignPortalBlockStatus
|
|
21473
21614
|
*
|
|
@@ -23645,6 +23786,18 @@ export interface PathsDictionary {
|
|
|
23645
23786
|
config?: AxiosRequestConfig
|
|
23646
23787
|
): OperationResponse<Paths.GetUserEntryPoint.Responses.$200>
|
|
23647
23788
|
}
|
|
23789
|
+
['/v3/portal/public/user/temporary-password/complete']: {
|
|
23790
|
+
/**
|
|
23791
|
+
* completeTemporaryPassword - completeTemporaryPassword
|
|
23792
|
+
*
|
|
23793
|
+
* Replaces a portal user's temporary password with the password they chose.
|
|
23794
|
+
*/
|
|
23795
|
+
'post'(
|
|
23796
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
23797
|
+
data?: Paths.CompleteTemporaryPassword.RequestBody,
|
|
23798
|
+
config?: AxiosRequestConfig
|
|
23799
|
+
): OperationResponse<Paths.CompleteTemporaryPassword.Responses.$200>
|
|
23800
|
+
}
|
|
23648
23801
|
['/v2/portal/campaign/{campaign_id}/entity:status']: {
|
|
23649
23802
|
/**
|
|
23650
23803
|
* updateCampaignPortalBlockStatus - updateCampaignPortalBlockStatus
|
|
@@ -24221,6 +24374,9 @@ export type Source = Components.Schemas.Source;
|
|
|
24221
24374
|
export type SupportReportType = Components.Schemas.SupportReportType;
|
|
24222
24375
|
export type SupportRequestAttachment = Components.Schemas.SupportRequestAttachment;
|
|
24223
24376
|
export type SupportRequestResult = Components.Schemas.SupportRequestResult;
|
|
24377
|
+
export type SwapPortalReferenceGroup = Components.Schemas.SwapPortalReferenceGroup;
|
|
24378
|
+
export type SwapPortalReferenceItem = Components.Schemas.SwapPortalReferenceItem;
|
|
24379
|
+
export type SwapPortalReferencesResult = Components.Schemas.SwapPortalReferencesResult;
|
|
24224
24380
|
export type SwappableConfig = Components.Schemas.SwappableConfig;
|
|
24225
24381
|
export type TariffType = Components.Schemas.TariffType;
|
|
24226
24382
|
export type TeaserWidget = Components.Schemas.TeaserWidget;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/customer-portal-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.48.1",
|
|
4
4
|
"description": "API Client for epilot portal API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -18,18 +18,6 @@
|
|
|
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
|
-
},
|
|
33
21
|
"files": [
|
|
34
22
|
"*.js",
|
|
35
23
|
"*.d.ts",
|
|
@@ -67,5 +55,16 @@
|
|
|
67
55
|
"typescript": "^4.1.3",
|
|
68
56
|
"webpack": "^5.18.0",
|
|
69
57
|
"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"
|
|
70
69
|
}
|
|
71
|
-
}
|
|
70
|
+
}
|
package/src/openapi-runtime.json
CHANGED
|
@@ -2460,6 +2460,18 @@
|
|
|
2460
2460
|
"responses": {}
|
|
2461
2461
|
}
|
|
2462
2462
|
},
|
|
2463
|
+
"/v3/portal/public/user/temporary-password/complete": {
|
|
2464
|
+
"post": {
|
|
2465
|
+
"operationId": "completeTemporaryPassword",
|
|
2466
|
+
"requestBody": {
|
|
2467
|
+
"required": true,
|
|
2468
|
+
"content": {
|
|
2469
|
+
"application/json": {}
|
|
2470
|
+
}
|
|
2471
|
+
},
|
|
2472
|
+
"responses": {}
|
|
2473
|
+
}
|
|
2474
|
+
},
|
|
2463
2475
|
"/v2/portal/campaign/{campaign_id}/entity:status": {
|
|
2464
2476
|
"put": {
|
|
2465
2477
|
"operationId": "updateCampaignPortalBlockStatus",
|
package/src/openapi.json
CHANGED
|
@@ -10025,6 +10025,86 @@
|
|
|
10025
10025
|
}
|
|
10026
10026
|
}
|
|
10027
10027
|
},
|
|
10028
|
+
"/v3/portal/public/user/temporary-password/complete": {
|
|
10029
|
+
"post": {
|
|
10030
|
+
"operationId": "completeTemporaryPassword",
|
|
10031
|
+
"summary": "completeTemporaryPassword",
|
|
10032
|
+
"description": "Replaces a portal user's temporary password with the password they chose.",
|
|
10033
|
+
"tags": [
|
|
10034
|
+
"Public"
|
|
10035
|
+
],
|
|
10036
|
+
"security": [],
|
|
10037
|
+
"requestBody": {
|
|
10038
|
+
"required": true,
|
|
10039
|
+
"content": {
|
|
10040
|
+
"application/json": {
|
|
10041
|
+
"schema": {
|
|
10042
|
+
"type": "object",
|
|
10043
|
+
"required": [
|
|
10044
|
+
"org_id",
|
|
10045
|
+
"portal_id",
|
|
10046
|
+
"email",
|
|
10047
|
+
"temporary_password",
|
|
10048
|
+
"new_password"
|
|
10049
|
+
],
|
|
10050
|
+
"properties": {
|
|
10051
|
+
"org_id": {
|
|
10052
|
+
"type": "string",
|
|
10053
|
+
"description": "Organization ID",
|
|
10054
|
+
"example": "123"
|
|
10055
|
+
},
|
|
10056
|
+
"portal_id": {
|
|
10057
|
+
"type": "string",
|
|
10058
|
+
"description": "ID of the portal the user belongs to",
|
|
10059
|
+
"example": "7hj28akg-97fb-4f5c-b2a1-3e4fbc1d8c7a"
|
|
10060
|
+
},
|
|
10061
|
+
"email": {
|
|
10062
|
+
"type": "string",
|
|
10063
|
+
"description": "Email address of the portal user",
|
|
10064
|
+
"example": "user@example.com"
|
|
10065
|
+
},
|
|
10066
|
+
"temporary_password": {
|
|
10067
|
+
"type": "string",
|
|
10068
|
+
"description": "Temporary password from the email"
|
|
10069
|
+
},
|
|
10070
|
+
"new_password": {
|
|
10071
|
+
"type": "string",
|
|
10072
|
+
"description": "New password, must match the portal's password policy"
|
|
10073
|
+
}
|
|
10074
|
+
}
|
|
10075
|
+
}
|
|
10076
|
+
}
|
|
10077
|
+
}
|
|
10078
|
+
},
|
|
10079
|
+
"responses": {
|
|
10080
|
+
"200": {
|
|
10081
|
+
"description": "The new password was set.",
|
|
10082
|
+
"content": {
|
|
10083
|
+
"application/json": {
|
|
10084
|
+
"schema": {
|
|
10085
|
+
"type": "object",
|
|
10086
|
+
"properties": {
|
|
10087
|
+
"message": {
|
|
10088
|
+
"type": "string",
|
|
10089
|
+
"example": "Password set successfully."
|
|
10090
|
+
}
|
|
10091
|
+
}
|
|
10092
|
+
}
|
|
10093
|
+
}
|
|
10094
|
+
}
|
|
10095
|
+
},
|
|
10096
|
+
"400": {
|
|
10097
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
10098
|
+
},
|
|
10099
|
+
"429": {
|
|
10100
|
+
"$ref": "#/components/responses/TooManyRequests"
|
|
10101
|
+
},
|
|
10102
|
+
"500": {
|
|
10103
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
10104
|
+
}
|
|
10105
|
+
}
|
|
10106
|
+
}
|
|
10107
|
+
},
|
|
10028
10108
|
"/v2/portal/campaign/{campaign_id}/entity:status": {
|
|
10029
10109
|
"put": {
|
|
10030
10110
|
"operationId": "updateCampaignPortalBlockStatus",
|
|
@@ -11213,6 +11293,9 @@
|
|
|
11213
11293
|
"message": {
|
|
11214
11294
|
"type": "string",
|
|
11215
11295
|
"example": "Domain and users swapped successfully."
|
|
11296
|
+
},
|
|
11297
|
+
"portal_references": {
|
|
11298
|
+
"$ref": "#/components/schemas/SwapPortalReferencesResult"
|
|
11216
11299
|
}
|
|
11217
11300
|
}
|
|
11218
11301
|
}
|
|
@@ -14216,6 +14299,11 @@
|
|
|
14216
14299
|
},
|
|
14217
14300
|
"example": []
|
|
14218
14301
|
},
|
|
14302
|
+
"has_portal_user": {
|
|
14303
|
+
"type": "boolean",
|
|
14304
|
+
"description": "Whether the identified contact already has a portal user on this portal, so the caller\ncan skip offering account creation. Present only on a match; omitted when it could not\nbe determined.\n",
|
|
14305
|
+
"example": false
|
|
14306
|
+
},
|
|
14219
14307
|
"reason": {
|
|
14220
14308
|
"type": "string",
|
|
14221
14309
|
"enum": [
|
|
@@ -15968,8 +16056,7 @@
|
|
|
15968
16056
|
"type": "string",
|
|
15969
16057
|
"enum": [
|
|
15970
16058
|
"portal-config",
|
|
15971
|
-
"portal-block"
|
|
15972
|
-
"portal-widget"
|
|
16059
|
+
"portal-block"
|
|
15973
16060
|
]
|
|
15974
16061
|
},
|
|
15975
16062
|
"resource": {
|
|
@@ -20900,15 +20987,23 @@
|
|
|
20900
20987
|
"properties": {
|
|
20901
20988
|
"start_page": {
|
|
20902
20989
|
"type": "boolean",
|
|
20903
|
-
"
|
|
20990
|
+
"deprecated": true,
|
|
20991
|
+
"description": "Retired, not read. A portal shows a start page by having a `dashboard` page."
|
|
20904
20992
|
},
|
|
20905
20993
|
"billing": {
|
|
20906
20994
|
"type": "boolean",
|
|
20907
|
-
"
|
|
20995
|
+
"deprecated": true,
|
|
20996
|
+
"description": "Retired, not read. Billing follows the organization's `commodity_billing` setting."
|
|
20997
|
+
},
|
|
20998
|
+
"commodity_billing": {
|
|
20999
|
+
"type": "boolean",
|
|
21000
|
+
"deprecated": true,
|
|
21001
|
+
"description": "Retired, not read. Billing pages and blocks follow the organization's `commodity_billing` setting."
|
|
20908
21002
|
},
|
|
20909
21003
|
"change_due_date": {
|
|
20910
21004
|
"type": "boolean",
|
|
20911
|
-
"
|
|
21005
|
+
"deprecated": true,
|
|
21006
|
+
"description": "Retired, not read."
|
|
20912
21007
|
},
|
|
20913
21008
|
"new_design": {
|
|
20914
21009
|
"type": "boolean",
|
|
@@ -20924,6 +21019,15 @@
|
|
|
20924
21019
|
"default": 0,
|
|
20925
21020
|
"readOnly": true,
|
|
20926
21021
|
"description": "Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled"
|
|
21022
|
+
},
|
|
21023
|
+
"portal_copilot": {
|
|
21024
|
+
"type": "boolean",
|
|
21025
|
+
"default": false,
|
|
21026
|
+
"description": "Enable the portal copilot chat for this portal"
|
|
21027
|
+
},
|
|
21028
|
+
"portal_copilot_agent_id": {
|
|
21029
|
+
"type": "string",
|
|
21030
|
+
"description": "ID of the Agent Builder portal agent this portal's copilot chat runs, set by Agent Builder. When unset, or when the agent no longer exists in the portal's organization, the chat runs the default portal copilot."
|
|
20927
21031
|
}
|
|
20928
21032
|
}
|
|
20929
21033
|
},
|
|
@@ -21098,6 +21202,24 @@
|
|
|
21098
21202
|
"type": "string",
|
|
21099
21203
|
"description": "The URL to redirect to",
|
|
21100
21204
|
"example": "https://example.com"
|
|
21205
|
+
},
|
|
21206
|
+
"title": {
|
|
21207
|
+
"type": "string",
|
|
21208
|
+
"description": "Portal name, served as the document title before the app boots",
|
|
21209
|
+
"example": "Kundenportal"
|
|
21210
|
+
},
|
|
21211
|
+
"prevent_indexing": {
|
|
21212
|
+
"type": "boolean",
|
|
21213
|
+
"description": "Whether the served document should carry a `noindex, nofollow` robots meta tag"
|
|
21214
|
+
},
|
|
21215
|
+
"organization_id": {
|
|
21216
|
+
"type": "string",
|
|
21217
|
+
"description": "Organization of the portal, used to preload its design from the served document",
|
|
21218
|
+
"example": "123"
|
|
21219
|
+
},
|
|
21220
|
+
"design_id": {
|
|
21221
|
+
"type": "string",
|
|
21222
|
+
"description": "Design of the portal, used to preload it from the served document"
|
|
21101
21223
|
}
|
|
21102
21224
|
}
|
|
21103
21225
|
},
|
|
@@ -21376,9 +21498,82 @@
|
|
|
21376
21498
|
},
|
|
21377
21499
|
"SwappableConfig": {
|
|
21378
21500
|
"type": "string",
|
|
21379
|
-
"description": "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.",
|
|
21501
|
+
"description": "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.\n- `email_templates`: swap the email templates of the two portals.\n- `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`.",
|
|
21380
21502
|
"enum": [
|
|
21381
|
-
"email_templates"
|
|
21503
|
+
"email_templates",
|
|
21504
|
+
"portal_references"
|
|
21505
|
+
]
|
|
21506
|
+
},
|
|
21507
|
+
"SwapPortalReferencesResult": {
|
|
21508
|
+
"type": "object",
|
|
21509
|
+
"description": "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.",
|
|
21510
|
+
"properties": {
|
|
21511
|
+
"journeys": {
|
|
21512
|
+
"$ref": "#/components/schemas/SwapPortalReferenceGroup"
|
|
21513
|
+
},
|
|
21514
|
+
"automation_flows": {
|
|
21515
|
+
"$ref": "#/components/schemas/SwapPortalReferenceGroup"
|
|
21516
|
+
}
|
|
21517
|
+
},
|
|
21518
|
+
"required": [
|
|
21519
|
+
"journeys",
|
|
21520
|
+
"automation_flows"
|
|
21521
|
+
]
|
|
21522
|
+
},
|
|
21523
|
+
"SwapPortalReferenceGroup": {
|
|
21524
|
+
"type": "object",
|
|
21525
|
+
"properties": {
|
|
21526
|
+
"updated": {
|
|
21527
|
+
"type": "array",
|
|
21528
|
+
"description": "Items whose references now point at the target portal.",
|
|
21529
|
+
"items": {
|
|
21530
|
+
"$ref": "#/components/schemas/SwapPortalReferenceItem"
|
|
21531
|
+
}
|
|
21532
|
+
},
|
|
21533
|
+
"failed": {
|
|
21534
|
+
"type": "array",
|
|
21535
|
+
"description": "Items that reference the source portal but could not be updated.",
|
|
21536
|
+
"items": {
|
|
21537
|
+
"$ref": "#/components/schemas/SwapPortalReferenceItem"
|
|
21538
|
+
}
|
|
21539
|
+
},
|
|
21540
|
+
"list_error": {
|
|
21541
|
+
"type": "string",
|
|
21542
|
+
"description": "Set when the items could not be listed, so none of them were checked."
|
|
21543
|
+
}
|
|
21544
|
+
},
|
|
21545
|
+
"required": [
|
|
21546
|
+
"updated",
|
|
21547
|
+
"failed"
|
|
21548
|
+
]
|
|
21549
|
+
},
|
|
21550
|
+
"SwapPortalReferenceItem": {
|
|
21551
|
+
"type": "object",
|
|
21552
|
+
"properties": {
|
|
21553
|
+
"id": {
|
|
21554
|
+
"type": "string",
|
|
21555
|
+
"description": "Journey id or automation flow id."
|
|
21556
|
+
},
|
|
21557
|
+
"name": {
|
|
21558
|
+
"type": "string"
|
|
21559
|
+
},
|
|
21560
|
+
"paths": {
|
|
21561
|
+
"type": "array",
|
|
21562
|
+
"description": "Where the reference sat in the item.",
|
|
21563
|
+
"items": {
|
|
21564
|
+
"type": "string"
|
|
21565
|
+
},
|
|
21566
|
+
"example": [
|
|
21567
|
+
"steps[0].uischema.elements[2].options.portalId"
|
|
21568
|
+
]
|
|
21569
|
+
},
|
|
21570
|
+
"error": {
|
|
21571
|
+
"type": "string",
|
|
21572
|
+
"description": "Why the update failed. Only set on failed items."
|
|
21573
|
+
}
|
|
21574
|
+
},
|
|
21575
|
+
"required": [
|
|
21576
|
+
"id"
|
|
21382
21577
|
]
|
|
21383
21578
|
},
|
|
21384
21579
|
"PortalUserRegistrationStatus": {
|