@epilot/customer-portal-client 0.47.1 → 0.48.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +0 -6
- package/dist/openapi.d.ts +290 -192
- package/package.json +13 -14
- package/src/openapi-runtime.json +0 -6
- package/src/openapi.json +62 -216
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":{}}},"/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/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})})();
|
|
@@ -2717,12 +2717,6 @@
|
|
|
2717
2717
|
"responses": {}
|
|
2718
2718
|
}
|
|
2719
2719
|
},
|
|
2720
|
-
"/v3/portal/configs/summaries": {
|
|
2721
|
-
"get": {
|
|
2722
|
-
"operationId": "listPortalConfigSummaries",
|
|
2723
|
-
"responses": {}
|
|
2724
|
-
}
|
|
2725
|
-
},
|
|
2726
2720
|
"/v3/portal/config/swap": {
|
|
2727
2721
|
"post": {
|
|
2728
2722
|
"operationId": "swapPortalConfig",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1067,7 +1067,35 @@ declare namespace Components {
|
|
|
1067
1067
|
* false
|
|
1068
1068
|
*/
|
|
1069
1069
|
user_account_self_management?: boolean;
|
|
1070
|
-
|
|
1070
|
+
/**
|
|
1071
|
+
* Feature settings for the portal
|
|
1072
|
+
*/
|
|
1073
|
+
feature_settings?: {
|
|
1074
|
+
/**
|
|
1075
|
+
* Start page feature flag
|
|
1076
|
+
*/
|
|
1077
|
+
start_page?: boolean;
|
|
1078
|
+
/**
|
|
1079
|
+
* Billing feature flag
|
|
1080
|
+
*/
|
|
1081
|
+
billing?: boolean;
|
|
1082
|
+
/**
|
|
1083
|
+
* Change due date feature flag
|
|
1084
|
+
*/
|
|
1085
|
+
change_due_date?: boolean;
|
|
1086
|
+
/**
|
|
1087
|
+
* Enable or disable the new design for the portal
|
|
1088
|
+
*/
|
|
1089
|
+
new_design?: boolean;
|
|
1090
|
+
/**
|
|
1091
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
1092
|
+
*/
|
|
1093
|
+
mcp_enabled?: boolean;
|
|
1094
|
+
/**
|
|
1095
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
1096
|
+
*/
|
|
1097
|
+
mcp_grant_version?: number;
|
|
1098
|
+
};
|
|
1071
1099
|
/**
|
|
1072
1100
|
* Access token for the portal
|
|
1073
1101
|
*/
|
|
@@ -1607,7 +1635,35 @@ declare namespace Components {
|
|
|
1607
1635
|
* false
|
|
1608
1636
|
*/
|
|
1609
1637
|
user_account_self_management?: boolean;
|
|
1610
|
-
|
|
1638
|
+
/**
|
|
1639
|
+
* Feature settings for the portal
|
|
1640
|
+
*/
|
|
1641
|
+
feature_settings?: {
|
|
1642
|
+
/**
|
|
1643
|
+
* Start page feature flag
|
|
1644
|
+
*/
|
|
1645
|
+
start_page?: boolean;
|
|
1646
|
+
/**
|
|
1647
|
+
* Billing feature flag
|
|
1648
|
+
*/
|
|
1649
|
+
billing?: boolean;
|
|
1650
|
+
/**
|
|
1651
|
+
* Change due date feature flag
|
|
1652
|
+
*/
|
|
1653
|
+
change_due_date?: boolean;
|
|
1654
|
+
/**
|
|
1655
|
+
* Enable or disable the new design for the portal
|
|
1656
|
+
*/
|
|
1657
|
+
new_design?: boolean;
|
|
1658
|
+
/**
|
|
1659
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
1660
|
+
*/
|
|
1661
|
+
mcp_enabled?: boolean;
|
|
1662
|
+
/**
|
|
1663
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
1664
|
+
*/
|
|
1665
|
+
mcp_grant_version?: number;
|
|
1666
|
+
};
|
|
1611
1667
|
/**
|
|
1612
1668
|
* Access token for the portal
|
|
1613
1669
|
*/
|
|
@@ -6469,7 +6525,35 @@ declare namespace Components {
|
|
|
6469
6525
|
* false
|
|
6470
6526
|
*/
|
|
6471
6527
|
user_account_self_management?: boolean;
|
|
6472
|
-
|
|
6528
|
+
/**
|
|
6529
|
+
* Feature settings for the portal
|
|
6530
|
+
*/
|
|
6531
|
+
feature_settings?: {
|
|
6532
|
+
/**
|
|
6533
|
+
* Start page feature flag
|
|
6534
|
+
*/
|
|
6535
|
+
start_page?: boolean;
|
|
6536
|
+
/**
|
|
6537
|
+
* Billing feature flag
|
|
6538
|
+
*/
|
|
6539
|
+
billing?: boolean;
|
|
6540
|
+
/**
|
|
6541
|
+
* Change due date feature flag
|
|
6542
|
+
*/
|
|
6543
|
+
change_due_date?: boolean;
|
|
6544
|
+
/**
|
|
6545
|
+
* Enable or disable the new design for the portal
|
|
6546
|
+
*/
|
|
6547
|
+
new_design?: boolean;
|
|
6548
|
+
/**
|
|
6549
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
6550
|
+
*/
|
|
6551
|
+
mcp_enabled?: boolean;
|
|
6552
|
+
/**
|
|
6553
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
6554
|
+
*/
|
|
6555
|
+
mcp_grant_version?: number;
|
|
6556
|
+
};
|
|
6473
6557
|
/**
|
|
6474
6558
|
* Access token for the portal
|
|
6475
6559
|
*/
|
|
@@ -6978,106 +7062,6 @@ declare namespace Components {
|
|
|
6978
7062
|
grants?: Grant[];
|
|
6979
7063
|
identity_providers?: ProviderPublicConfig[];
|
|
6980
7064
|
}
|
|
6981
|
-
/**
|
|
6982
|
-
* Lightweight view of a portal config for lists and pickers. Carries the identifying,
|
|
6983
|
-
* display and registration fields only. Pages, email templates, grants, feature flags,
|
|
6984
|
-
* identity providers and certificate details are left out; read them per portal with
|
|
6985
|
-
* `getPortalConfigV3`.
|
|
6986
|
-
*
|
|
6987
|
-
*/
|
|
6988
|
-
export interface PortalConfigSummaryV3 {
|
|
6989
|
-
portal_id?: /**
|
|
6990
|
-
* ID of the portal
|
|
6991
|
-
* example:
|
|
6992
|
-
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
6993
|
-
*/
|
|
6994
|
-
PortalId;
|
|
6995
|
-
/**
|
|
6996
|
-
* ID of the organization
|
|
6997
|
-
* example:
|
|
6998
|
-
* 12345
|
|
6999
|
-
*/
|
|
7000
|
-
organization_id?: string;
|
|
7001
|
-
origin?: /* Origin of the portal */ Origin;
|
|
7002
|
-
/**
|
|
7003
|
-
* Name of the portal
|
|
7004
|
-
*/
|
|
7005
|
-
name?: string;
|
|
7006
|
-
/**
|
|
7007
|
-
* Whether the portal is enabled
|
|
7008
|
-
*/
|
|
7009
|
-
enabled?: boolean;
|
|
7010
|
-
/**
|
|
7011
|
-
* Custom domain of the portal
|
|
7012
|
-
*/
|
|
7013
|
-
domain?: string;
|
|
7014
|
-
/**
|
|
7015
|
-
* epilot-hosted domain of the portal
|
|
7016
|
-
*/
|
|
7017
|
-
epilot_domain?: string;
|
|
7018
|
-
is_epilot_domain?: boolean;
|
|
7019
|
-
/**
|
|
7020
|
-
* Status of the custom domain setup, when a custom domain is configured
|
|
7021
|
-
*/
|
|
7022
|
-
dnsStatus?: "CONFIGURING" | "PENDING" | "SUCCEED" | "EXPIRED" | "NEW_CERT_IN_PROGRESS";
|
|
7023
|
-
design_id?: /**
|
|
7024
|
-
* Entity ID
|
|
7025
|
-
* example:
|
|
7026
|
-
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
7027
|
-
*/
|
|
7028
|
-
EntityId /* uuid */;
|
|
7029
|
-
/**
|
|
7030
|
-
* Default 360 user to notify upon an internal notification
|
|
7031
|
-
*/
|
|
7032
|
-
default_user_to_notify?: {
|
|
7033
|
-
/**
|
|
7034
|
-
* Default admin users for pending user notification to notify
|
|
7035
|
-
*/
|
|
7036
|
-
onPendingUser?: AdminUser[];
|
|
7037
|
-
};
|
|
7038
|
-
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
7039
|
-
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
7040
|
-
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
|
|
7041
|
-
block_registration_if_portal_user_exists?: boolean;
|
|
7042
|
-
/**
|
|
7043
|
-
* Entity type used as the primary identifier for self-registration
|
|
7044
|
-
*/
|
|
7045
|
-
self_registration_entity?: "contact" | "account";
|
|
7046
|
-
/**
|
|
7047
|
-
* Enable or disable user account self management
|
|
7048
|
-
*/
|
|
7049
|
-
user_account_self_management?: boolean;
|
|
7050
|
-
/**
|
|
7051
|
-
* Identifiers to identify a contact of a portal user during the registration.
|
|
7052
|
-
*/
|
|
7053
|
-
registration_identifiers?: ContractIdentifier[];
|
|
7054
|
-
/**
|
|
7055
|
-
* Surfaces this portal's data is reached from besides the portal UI itself.
|
|
7056
|
-
*/
|
|
7057
|
-
surfaces?: /**
|
|
7058
|
-
* One surface a portal's data is reached from (see `surfaces` on the portal config).
|
|
7059
|
-
*
|
|
7060
|
-
* A surface names how callers authenticate on it and what they may reach once they
|
|
7061
|
-
* have. Data access is always a subset of the portal's own: a schema not in
|
|
7062
|
-
* `allowed_portal_entities` cannot be opened up by a surface, and the portal's
|
|
7063
|
-
* contact-relation rules still apply underneath the surface's own.
|
|
7064
|
-
*
|
|
7065
|
-
* Tokens minted for a surface (currently: contact identification tokens for
|
|
7066
|
-
* `registration_identifiers` surfaces) carry the surface id. The surface's data
|
|
7067
|
-
* access is resolved from the portal config on every request, not baked into the
|
|
7068
|
-
* token, so tightening a surface applies to tokens already in circulation.
|
|
7069
|
-
*
|
|
7070
|
-
*/
|
|
7071
|
-
PortalSurface[];
|
|
7072
|
-
is_dummy?: boolean;
|
|
7073
|
-
is_v3_item?: boolean;
|
|
7074
|
-
/**
|
|
7075
|
-
* ID of the currently published revision, if the portal has been published
|
|
7076
|
-
*/
|
|
7077
|
-
published_revision_id?: string;
|
|
7078
|
-
_created_at?: string; // date-time
|
|
7079
|
-
_updated_at?: string; // date-time
|
|
7080
|
-
}
|
|
7081
7065
|
export interface PortalConfigV3 {
|
|
7082
7066
|
/**
|
|
7083
7067
|
* Journey actions allowed on an entity by a portal user
|
|
@@ -7202,7 +7186,35 @@ declare namespace Components {
|
|
|
7202
7186
|
* false
|
|
7203
7187
|
*/
|
|
7204
7188
|
user_account_self_management?: boolean;
|
|
7205
|
-
|
|
7189
|
+
/**
|
|
7190
|
+
* Feature settings for the portal
|
|
7191
|
+
*/
|
|
7192
|
+
feature_settings?: {
|
|
7193
|
+
/**
|
|
7194
|
+
* Start page feature flag
|
|
7195
|
+
*/
|
|
7196
|
+
start_page?: boolean;
|
|
7197
|
+
/**
|
|
7198
|
+
* Billing feature flag
|
|
7199
|
+
*/
|
|
7200
|
+
billing?: boolean;
|
|
7201
|
+
/**
|
|
7202
|
+
* Change due date feature flag
|
|
7203
|
+
*/
|
|
7204
|
+
change_due_date?: boolean;
|
|
7205
|
+
/**
|
|
7206
|
+
* Enable or disable the new design for the portal
|
|
7207
|
+
*/
|
|
7208
|
+
new_design?: boolean;
|
|
7209
|
+
/**
|
|
7210
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
7211
|
+
*/
|
|
7212
|
+
mcp_enabled?: boolean;
|
|
7213
|
+
/**
|
|
7214
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
7215
|
+
*/
|
|
7216
|
+
mcp_grant_version?: number;
|
|
7217
|
+
};
|
|
7206
7218
|
/**
|
|
7207
7219
|
* Access token for the portal
|
|
7208
7220
|
*/
|
|
@@ -7769,35 +7781,6 @@ declare namespace Components {
|
|
|
7769
7781
|
*/
|
|
7770
7782
|
installer?: string;
|
|
7771
7783
|
}
|
|
7772
|
-
/**
|
|
7773
|
-
* Feature settings for the portal
|
|
7774
|
-
*/
|
|
7775
|
-
export interface PortalFeatureSettings {
|
|
7776
|
-
/**
|
|
7777
|
-
* Start page feature flag
|
|
7778
|
-
*/
|
|
7779
|
-
start_page?: boolean;
|
|
7780
|
-
/**
|
|
7781
|
-
* Billing feature flag
|
|
7782
|
-
*/
|
|
7783
|
-
billing?: boolean;
|
|
7784
|
-
/**
|
|
7785
|
-
* Change due date feature flag
|
|
7786
|
-
*/
|
|
7787
|
-
change_due_date?: boolean;
|
|
7788
|
-
/**
|
|
7789
|
-
* Enable or disable the new design for the portal
|
|
7790
|
-
*/
|
|
7791
|
-
new_design?: boolean;
|
|
7792
|
-
/**
|
|
7793
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
7794
|
-
*/
|
|
7795
|
-
mcp_enabled?: boolean;
|
|
7796
|
-
/**
|
|
7797
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
7798
|
-
*/
|
|
7799
|
-
mcp_grant_version?: number;
|
|
7800
|
-
}
|
|
7801
7784
|
/**
|
|
7802
7785
|
* ID of the portal
|
|
7803
7786
|
* example:
|
|
@@ -8148,7 +8131,35 @@ declare namespace Components {
|
|
|
8148
8131
|
* false
|
|
8149
8132
|
*/
|
|
8150
8133
|
user_account_self_management?: boolean;
|
|
8151
|
-
|
|
8134
|
+
/**
|
|
8135
|
+
* Feature settings for the portal
|
|
8136
|
+
*/
|
|
8137
|
+
feature_settings?: {
|
|
8138
|
+
/**
|
|
8139
|
+
* Start page feature flag
|
|
8140
|
+
*/
|
|
8141
|
+
start_page?: boolean;
|
|
8142
|
+
/**
|
|
8143
|
+
* Billing feature flag
|
|
8144
|
+
*/
|
|
8145
|
+
billing?: boolean;
|
|
8146
|
+
/**
|
|
8147
|
+
* Change due date feature flag
|
|
8148
|
+
*/
|
|
8149
|
+
change_due_date?: boolean;
|
|
8150
|
+
/**
|
|
8151
|
+
* Enable or disable the new design for the portal
|
|
8152
|
+
*/
|
|
8153
|
+
new_design?: boolean;
|
|
8154
|
+
/**
|
|
8155
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
8156
|
+
*/
|
|
8157
|
+
mcp_enabled?: boolean;
|
|
8158
|
+
/**
|
|
8159
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
8160
|
+
*/
|
|
8161
|
+
mcp_grant_version?: number;
|
|
8162
|
+
};
|
|
8152
8163
|
/**
|
|
8153
8164
|
* Access token for the portal
|
|
8154
8165
|
*/
|
|
@@ -10331,7 +10342,35 @@ declare namespace Components {
|
|
|
10331
10342
|
* false
|
|
10332
10343
|
*/
|
|
10333
10344
|
user_account_self_management?: boolean;
|
|
10334
|
-
|
|
10345
|
+
/**
|
|
10346
|
+
* Feature settings for the portal
|
|
10347
|
+
*/
|
|
10348
|
+
feature_settings?: {
|
|
10349
|
+
/**
|
|
10350
|
+
* Start page feature flag
|
|
10351
|
+
*/
|
|
10352
|
+
start_page?: boolean;
|
|
10353
|
+
/**
|
|
10354
|
+
* Billing feature flag
|
|
10355
|
+
*/
|
|
10356
|
+
billing?: boolean;
|
|
10357
|
+
/**
|
|
10358
|
+
* Change due date feature flag
|
|
10359
|
+
*/
|
|
10360
|
+
change_due_date?: boolean;
|
|
10361
|
+
/**
|
|
10362
|
+
* Enable or disable the new design for the portal
|
|
10363
|
+
*/
|
|
10364
|
+
new_design?: boolean;
|
|
10365
|
+
/**
|
|
10366
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
10367
|
+
*/
|
|
10368
|
+
mcp_enabled?: boolean;
|
|
10369
|
+
/**
|
|
10370
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
10371
|
+
*/
|
|
10372
|
+
mcp_grant_version?: number;
|
|
10373
|
+
};
|
|
10335
10374
|
/**
|
|
10336
10375
|
* Access token for the portal
|
|
10337
10376
|
*/
|
|
@@ -10932,7 +10971,35 @@ declare namespace Components {
|
|
|
10932
10971
|
* false
|
|
10933
10972
|
*/
|
|
10934
10973
|
user_account_self_management?: boolean;
|
|
10935
|
-
|
|
10974
|
+
/**
|
|
10975
|
+
* Feature settings for the portal
|
|
10976
|
+
*/
|
|
10977
|
+
feature_settings?: {
|
|
10978
|
+
/**
|
|
10979
|
+
* Start page feature flag
|
|
10980
|
+
*/
|
|
10981
|
+
start_page?: boolean;
|
|
10982
|
+
/**
|
|
10983
|
+
* Billing feature flag
|
|
10984
|
+
*/
|
|
10985
|
+
billing?: boolean;
|
|
10986
|
+
/**
|
|
10987
|
+
* Change due date feature flag
|
|
10988
|
+
*/
|
|
10989
|
+
change_due_date?: boolean;
|
|
10990
|
+
/**
|
|
10991
|
+
* Enable or disable the new design for the portal
|
|
10992
|
+
*/
|
|
10993
|
+
new_design?: boolean;
|
|
10994
|
+
/**
|
|
10995
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
10996
|
+
*/
|
|
10997
|
+
mcp_enabled?: boolean;
|
|
10998
|
+
/**
|
|
10999
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
11000
|
+
*/
|
|
11001
|
+
mcp_grant_version?: number;
|
|
11002
|
+
};
|
|
10936
11003
|
/**
|
|
10937
11004
|
* Access token for the portal
|
|
10938
11005
|
*/
|
|
@@ -14946,7 +15013,35 @@ declare namespace Paths {
|
|
|
14946
15013
|
* false
|
|
14947
15014
|
*/
|
|
14948
15015
|
user_account_self_management?: boolean;
|
|
14949
|
-
|
|
15016
|
+
/**
|
|
15017
|
+
* Feature settings for the portal
|
|
15018
|
+
*/
|
|
15019
|
+
feature_settings?: {
|
|
15020
|
+
/**
|
|
15021
|
+
* Start page feature flag
|
|
15022
|
+
*/
|
|
15023
|
+
start_page?: boolean;
|
|
15024
|
+
/**
|
|
15025
|
+
* Billing feature flag
|
|
15026
|
+
*/
|
|
15027
|
+
billing?: boolean;
|
|
15028
|
+
/**
|
|
15029
|
+
* Change due date feature flag
|
|
15030
|
+
*/
|
|
15031
|
+
change_due_date?: boolean;
|
|
15032
|
+
/**
|
|
15033
|
+
* Enable or disable the new design for the portal
|
|
15034
|
+
*/
|
|
15035
|
+
new_design?: boolean;
|
|
15036
|
+
/**
|
|
15037
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
15038
|
+
*/
|
|
15039
|
+
mcp_enabled?: boolean;
|
|
15040
|
+
/**
|
|
15041
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
15042
|
+
*/
|
|
15043
|
+
mcp_grant_version?: number;
|
|
15044
|
+
};
|
|
14950
15045
|
/**
|
|
14951
15046
|
* Access token for the portal
|
|
14952
15047
|
*/
|
|
@@ -15577,7 +15672,35 @@ declare namespace Paths {
|
|
|
15577
15672
|
* false
|
|
15578
15673
|
*/
|
|
15579
15674
|
user_account_self_management?: boolean;
|
|
15580
|
-
|
|
15675
|
+
/**
|
|
15676
|
+
* Feature settings for the portal
|
|
15677
|
+
*/
|
|
15678
|
+
feature_settings?: {
|
|
15679
|
+
/**
|
|
15680
|
+
* Start page feature flag
|
|
15681
|
+
*/
|
|
15682
|
+
start_page?: boolean;
|
|
15683
|
+
/**
|
|
15684
|
+
* Billing feature flag
|
|
15685
|
+
*/
|
|
15686
|
+
billing?: boolean;
|
|
15687
|
+
/**
|
|
15688
|
+
* Change due date feature flag
|
|
15689
|
+
*/
|
|
15690
|
+
change_due_date?: boolean;
|
|
15691
|
+
/**
|
|
15692
|
+
* Enable or disable the new design for the portal
|
|
15693
|
+
*/
|
|
15694
|
+
new_design?: boolean;
|
|
15695
|
+
/**
|
|
15696
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
15697
|
+
*/
|
|
15698
|
+
mcp_enabled?: boolean;
|
|
15699
|
+
/**
|
|
15700
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
15701
|
+
*/
|
|
15702
|
+
mcp_grant_version?: number;
|
|
15703
|
+
};
|
|
15581
15704
|
/**
|
|
15582
15705
|
* Access token for the portal
|
|
15583
15706
|
*/
|
|
@@ -16762,7 +16885,35 @@ declare namespace Paths {
|
|
|
16762
16885
|
* false
|
|
16763
16886
|
*/
|
|
16764
16887
|
user_account_self_management?: boolean;
|
|
16765
|
-
|
|
16888
|
+
/**
|
|
16889
|
+
* Feature settings for the portal
|
|
16890
|
+
*/
|
|
16891
|
+
feature_settings?: {
|
|
16892
|
+
/**
|
|
16893
|
+
* Start page feature flag
|
|
16894
|
+
*/
|
|
16895
|
+
start_page?: boolean;
|
|
16896
|
+
/**
|
|
16897
|
+
* Billing feature flag
|
|
16898
|
+
*/
|
|
16899
|
+
billing?: boolean;
|
|
16900
|
+
/**
|
|
16901
|
+
* Change due date feature flag
|
|
16902
|
+
*/
|
|
16903
|
+
change_due_date?: boolean;
|
|
16904
|
+
/**
|
|
16905
|
+
* Enable or disable the new design for the portal
|
|
16906
|
+
*/
|
|
16907
|
+
new_design?: boolean;
|
|
16908
|
+
/**
|
|
16909
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
16910
|
+
*/
|
|
16911
|
+
mcp_enabled?: boolean;
|
|
16912
|
+
/**
|
|
16913
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
16914
|
+
*/
|
|
16915
|
+
mcp_grant_version?: number;
|
|
16916
|
+
};
|
|
16766
16917
|
/**
|
|
16767
16918
|
* Access token for the portal
|
|
16768
16919
|
*/
|
|
@@ -18118,23 +18269,6 @@ declare namespace Paths {
|
|
|
18118
18269
|
export type $500 = Components.Responses.InternalServerError;
|
|
18119
18270
|
}
|
|
18120
18271
|
}
|
|
18121
|
-
namespace ListPortalConfigSummaries {
|
|
18122
|
-
namespace Responses {
|
|
18123
|
-
export interface $200 {
|
|
18124
|
-
data?: /**
|
|
18125
|
-
* Lightweight view of a portal config for lists and pickers. Carries the identifying,
|
|
18126
|
-
* display and registration fields only. Pages, email templates, grants, feature flags,
|
|
18127
|
-
* identity providers and certificate details are left out; read them per portal with
|
|
18128
|
-
* `getPortalConfigV3`.
|
|
18129
|
-
*
|
|
18130
|
-
*/
|
|
18131
|
-
Components.Schemas.PortalConfigSummaryV3[];
|
|
18132
|
-
}
|
|
18133
|
-
export type $401 = Components.Responses.Unauthorized;
|
|
18134
|
-
export type $403 = Components.Responses.Forbidden;
|
|
18135
|
-
export type $500 = Components.Responses.InternalServerError;
|
|
18136
|
-
}
|
|
18137
|
-
}
|
|
18138
18272
|
namespace ListPortalNotifications {
|
|
18139
18273
|
namespace Parameters {
|
|
18140
18274
|
export type Cursor = string;
|
|
@@ -21644,22 +21778,6 @@ export interface OperationMethods {
|
|
|
21644
21778
|
data?: any,
|
|
21645
21779
|
config?: AxiosRequestConfig
|
|
21646
21780
|
): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
|
|
21647
|
-
/**
|
|
21648
|
-
* listPortalConfigSummaries - listPortalConfigSummaries
|
|
21649
|
-
*
|
|
21650
|
-
* Lists the portals of the organization as lightweight summaries: the identifying,
|
|
21651
|
-
* display and registration fields of each portal config, without pages, email
|
|
21652
|
-
* templates, grants, feature flags, identity providers or certificate details.
|
|
21653
|
-
*
|
|
21654
|
-
* Use it for portal overviews and pickers. Read a single portal with
|
|
21655
|
-
* `getPortalConfigV3` when the full configuration is needed.
|
|
21656
|
-
*
|
|
21657
|
-
*/
|
|
21658
|
-
'listPortalConfigSummaries'(
|
|
21659
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
21660
|
-
data?: any,
|
|
21661
|
-
config?: AxiosRequestConfig
|
|
21662
|
-
): OperationResponse<Paths.ListPortalConfigSummaries.Responses.$200>
|
|
21663
21781
|
/**
|
|
21664
21782
|
* swapPortalConfig - swapPortalConfig
|
|
21665
21783
|
*
|
|
@@ -23849,24 +23967,6 @@ export interface PathsDictionary {
|
|
|
23849
23967
|
config?: AxiosRequestConfig
|
|
23850
23968
|
): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
|
|
23851
23969
|
}
|
|
23852
|
-
['/v3/portal/configs/summaries']: {
|
|
23853
|
-
/**
|
|
23854
|
-
* listPortalConfigSummaries - listPortalConfigSummaries
|
|
23855
|
-
*
|
|
23856
|
-
* Lists the portals of the organization as lightweight summaries: the identifying,
|
|
23857
|
-
* display and registration fields of each portal config, without pages, email
|
|
23858
|
-
* templates, grants, feature flags, identity providers or certificate details.
|
|
23859
|
-
*
|
|
23860
|
-
* Use it for portal overviews and pickers. Read a single portal with
|
|
23861
|
-
* `getPortalConfigV3` when the full configuration is needed.
|
|
23862
|
-
*
|
|
23863
|
-
*/
|
|
23864
|
-
'get'(
|
|
23865
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
23866
|
-
data?: any,
|
|
23867
|
-
config?: AxiosRequestConfig
|
|
23868
|
-
): OperationResponse<Paths.ListPortalConfigSummaries.Responses.$200>
|
|
23869
|
-
}
|
|
23870
23970
|
['/v3/portal/config/swap']: {
|
|
23871
23971
|
/**
|
|
23872
23972
|
* swapPortalConfig - swapPortalConfig
|
|
@@ -24140,11 +24240,9 @@ export type Page = Components.Schemas.Page;
|
|
|
24140
24240
|
export type PageRequest = Components.Schemas.PageRequest;
|
|
24141
24241
|
export type PaymentWidget = Components.Schemas.PaymentWidget;
|
|
24142
24242
|
export type PortalConfig = Components.Schemas.PortalConfig;
|
|
24143
|
-
export type PortalConfigSummaryV3 = Components.Schemas.PortalConfigSummaryV3;
|
|
24144
24243
|
export type PortalConfigV3 = Components.Schemas.PortalConfigV3;
|
|
24145
24244
|
export type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
|
|
24146
24245
|
export type PortalDescriptionOverrides = Components.Schemas.PortalDescriptionOverrides;
|
|
24147
|
-
export type PortalFeatureSettings = Components.Schemas.PortalFeatureSettings;
|
|
24148
24246
|
export type PortalId = Components.Schemas.PortalId;
|
|
24149
24247
|
export type PortalNameOverrides = Components.Schemas.PortalNameOverrides;
|
|
24150
24248
|
export type PortalNotification = Components.Schemas.PortalNotification;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/customer-portal-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.48.0",
|
|
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
|
@@ -2717,12 +2717,6 @@
|
|
|
2717
2717
|
"responses": {}
|
|
2718
2718
|
}
|
|
2719
2719
|
},
|
|
2720
|
-
"/v3/portal/configs/summaries": {
|
|
2721
|
-
"get": {
|
|
2722
|
-
"operationId": "listPortalConfigSummaries",
|
|
2723
|
-
"responses": {}
|
|
2724
|
-
}
|
|
2725
|
-
},
|
|
2726
2720
|
"/v3/portal/config/swap": {
|
|
2727
2721
|
"post": {
|
|
2728
2722
|
"operationId": "swapPortalConfig",
|
package/src/openapi.json
CHANGED
|
@@ -11115,50 +11115,6 @@
|
|
|
11115
11115
|
}
|
|
11116
11116
|
}
|
|
11117
11117
|
},
|
|
11118
|
-
"/v3/portal/configs/summaries": {
|
|
11119
|
-
"get": {
|
|
11120
|
-
"operationId": "listPortalConfigSummaries",
|
|
11121
|
-
"summary": "listPortalConfigSummaries",
|
|
11122
|
-
"description": "Lists the portals of the organization as lightweight summaries: the identifying,\ndisplay and registration fields of each portal config, without pages, email\ntemplates, grants, feature flags, identity providers or certificate details.\n\nUse it for portal overviews and pickers. Read a single portal with\n`getPortalConfigV3` when the full configuration is needed.\n",
|
|
11123
|
-
"tags": [
|
|
11124
|
-
"ECP Admin"
|
|
11125
|
-
],
|
|
11126
|
-
"security": [
|
|
11127
|
-
{
|
|
11128
|
-
"EpilotAuth": []
|
|
11129
|
-
}
|
|
11130
|
-
],
|
|
11131
|
-
"responses": {
|
|
11132
|
-
"200": {
|
|
11133
|
-
"description": "Portal config summaries retrieved successfully.",
|
|
11134
|
-
"content": {
|
|
11135
|
-
"application/json": {
|
|
11136
|
-
"schema": {
|
|
11137
|
-
"type": "object",
|
|
11138
|
-
"properties": {
|
|
11139
|
-
"data": {
|
|
11140
|
-
"type": "array",
|
|
11141
|
-
"items": {
|
|
11142
|
-
"$ref": "#/components/schemas/PortalConfigSummaryV3"
|
|
11143
|
-
}
|
|
11144
|
-
}
|
|
11145
|
-
}
|
|
11146
|
-
}
|
|
11147
|
-
}
|
|
11148
|
-
}
|
|
11149
|
-
},
|
|
11150
|
-
"401": {
|
|
11151
|
-
"$ref": "#/components/responses/Unauthorized"
|
|
11152
|
-
},
|
|
11153
|
-
"403": {
|
|
11154
|
-
"$ref": "#/components/responses/Forbidden"
|
|
11155
|
-
},
|
|
11156
|
-
"500": {
|
|
11157
|
-
"$ref": "#/components/responses/InternalServerError"
|
|
11158
|
-
}
|
|
11159
|
-
}
|
|
11160
|
-
}
|
|
11161
|
-
},
|
|
11162
11118
|
"/v3/portal/config/swap": {
|
|
11163
11119
|
"post": {
|
|
11164
11120
|
"operationId": "swapPortalConfig",
|
|
@@ -13149,7 +13105,37 @@
|
|
|
13149
13105
|
"example": false
|
|
13150
13106
|
},
|
|
13151
13107
|
"feature_settings": {
|
|
13152
|
-
"
|
|
13108
|
+
"type": "object",
|
|
13109
|
+
"description": "Feature settings for the portal",
|
|
13110
|
+
"properties": {
|
|
13111
|
+
"start_page": {
|
|
13112
|
+
"type": "boolean",
|
|
13113
|
+
"description": "Start page feature flag"
|
|
13114
|
+
},
|
|
13115
|
+
"billing": {
|
|
13116
|
+
"type": "boolean",
|
|
13117
|
+
"description": "Billing feature flag"
|
|
13118
|
+
},
|
|
13119
|
+
"change_due_date": {
|
|
13120
|
+
"type": "boolean",
|
|
13121
|
+
"description": "Change due date feature flag"
|
|
13122
|
+
},
|
|
13123
|
+
"new_design": {
|
|
13124
|
+
"type": "boolean",
|
|
13125
|
+
"description": "Enable or disable the new design for the portal"
|
|
13126
|
+
},
|
|
13127
|
+
"mcp_enabled": {
|
|
13128
|
+
"type": "boolean",
|
|
13129
|
+
"description": "Enable the MCP (AI agent) connector channel for this portal"
|
|
13130
|
+
},
|
|
13131
|
+
"mcp_grant_version": {
|
|
13132
|
+
"type": "integer",
|
|
13133
|
+
"minimum": 0,
|
|
13134
|
+
"default": 0,
|
|
13135
|
+
"readOnly": true,
|
|
13136
|
+
"description": "Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled"
|
|
13137
|
+
}
|
|
13138
|
+
}
|
|
13153
13139
|
},
|
|
13154
13140
|
"accessToken": {
|
|
13155
13141
|
"type": "string",
|
|
@@ -20235,7 +20221,37 @@
|
|
|
20235
20221
|
"example": false
|
|
20236
20222
|
},
|
|
20237
20223
|
"feature_settings": {
|
|
20238
|
-
"
|
|
20224
|
+
"type": "object",
|
|
20225
|
+
"description": "Feature settings for the portal",
|
|
20226
|
+
"properties": {
|
|
20227
|
+
"start_page": {
|
|
20228
|
+
"type": "boolean",
|
|
20229
|
+
"description": "Start page feature flag"
|
|
20230
|
+
},
|
|
20231
|
+
"billing": {
|
|
20232
|
+
"type": "boolean",
|
|
20233
|
+
"description": "Billing feature flag"
|
|
20234
|
+
},
|
|
20235
|
+
"change_due_date": {
|
|
20236
|
+
"type": "boolean",
|
|
20237
|
+
"description": "Change due date feature flag"
|
|
20238
|
+
},
|
|
20239
|
+
"new_design": {
|
|
20240
|
+
"type": "boolean",
|
|
20241
|
+
"description": "Enable or disable the new design for the portal"
|
|
20242
|
+
},
|
|
20243
|
+
"mcp_enabled": {
|
|
20244
|
+
"type": "boolean",
|
|
20245
|
+
"description": "Enable the MCP (AI agent) connector channel for this portal"
|
|
20246
|
+
},
|
|
20247
|
+
"mcp_grant_version": {
|
|
20248
|
+
"type": "integer",
|
|
20249
|
+
"minimum": 0,
|
|
20250
|
+
"default": 0,
|
|
20251
|
+
"readOnly": true,
|
|
20252
|
+
"description": "Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled"
|
|
20253
|
+
}
|
|
20254
|
+
}
|
|
20239
20255
|
},
|
|
20240
20256
|
"accessToken": {
|
|
20241
20257
|
"type": "string",
|
|
@@ -20894,176 +20910,6 @@
|
|
|
20894
20910
|
}
|
|
20895
20911
|
]
|
|
20896
20912
|
},
|
|
20897
|
-
"PortalFeatureSettings": {
|
|
20898
|
-
"type": "object",
|
|
20899
|
-
"description": "Feature settings for the portal",
|
|
20900
|
-
"properties": {
|
|
20901
|
-
"start_page": {
|
|
20902
|
-
"type": "boolean",
|
|
20903
|
-
"description": "Start page feature flag"
|
|
20904
|
-
},
|
|
20905
|
-
"billing": {
|
|
20906
|
-
"type": "boolean",
|
|
20907
|
-
"description": "Billing feature flag"
|
|
20908
|
-
},
|
|
20909
|
-
"change_due_date": {
|
|
20910
|
-
"type": "boolean",
|
|
20911
|
-
"description": "Change due date feature flag"
|
|
20912
|
-
},
|
|
20913
|
-
"new_design": {
|
|
20914
|
-
"type": "boolean",
|
|
20915
|
-
"description": "Enable or disable the new design for the portal"
|
|
20916
|
-
},
|
|
20917
|
-
"mcp_enabled": {
|
|
20918
|
-
"type": "boolean",
|
|
20919
|
-
"description": "Enable the MCP (AI agent) connector channel for this portal"
|
|
20920
|
-
},
|
|
20921
|
-
"mcp_grant_version": {
|
|
20922
|
-
"type": "integer",
|
|
20923
|
-
"minimum": 0,
|
|
20924
|
-
"default": 0,
|
|
20925
|
-
"readOnly": true,
|
|
20926
|
-
"description": "Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled"
|
|
20927
|
-
}
|
|
20928
|
-
}
|
|
20929
|
-
},
|
|
20930
|
-
"PortalConfigSummaryV3": {
|
|
20931
|
-
"type": "object",
|
|
20932
|
-
"description": "Lightweight view of a portal config for lists and pickers. Carries the identifying,\ndisplay and registration fields only. Pages, email templates, grants, feature flags,\nidentity providers and certificate details are left out; read them per portal with\n`getPortalConfigV3`.\n",
|
|
20933
|
-
"properties": {
|
|
20934
|
-
"portal_id": {
|
|
20935
|
-
"$ref": "#/components/schemas/PortalId"
|
|
20936
|
-
},
|
|
20937
|
-
"organization_id": {
|
|
20938
|
-
"type": "string",
|
|
20939
|
-
"example": 12345,
|
|
20940
|
-
"description": "ID of the organization"
|
|
20941
|
-
},
|
|
20942
|
-
"origin": {
|
|
20943
|
-
"$ref": "#/components/schemas/Origin"
|
|
20944
|
-
},
|
|
20945
|
-
"name": {
|
|
20946
|
-
"type": "string",
|
|
20947
|
-
"description": "Name of the portal"
|
|
20948
|
-
},
|
|
20949
|
-
"enabled": {
|
|
20950
|
-
"type": "boolean",
|
|
20951
|
-
"description": "Whether the portal is enabled"
|
|
20952
|
-
},
|
|
20953
|
-
"domain": {
|
|
20954
|
-
"type": "string",
|
|
20955
|
-
"description": "Custom domain of the portal"
|
|
20956
|
-
},
|
|
20957
|
-
"epilot_domain": {
|
|
20958
|
-
"type": "string",
|
|
20959
|
-
"description": "epilot-hosted domain of the portal"
|
|
20960
|
-
},
|
|
20961
|
-
"is_epilot_domain": {
|
|
20962
|
-
"type": "boolean"
|
|
20963
|
-
},
|
|
20964
|
-
"dnsStatus": {
|
|
20965
|
-
"type": "string",
|
|
20966
|
-
"description": "Status of the custom domain setup, when a custom domain is configured",
|
|
20967
|
-
"enum": [
|
|
20968
|
-
"CONFIGURING",
|
|
20969
|
-
"PENDING",
|
|
20970
|
-
"SUCCEED",
|
|
20971
|
-
"EXPIRED",
|
|
20972
|
-
"NEW_CERT_IN_PROGRESS"
|
|
20973
|
-
]
|
|
20974
|
-
},
|
|
20975
|
-
"design_id": {
|
|
20976
|
-
"$ref": "#/components/schemas/EntityId"
|
|
20977
|
-
},
|
|
20978
|
-
"default_user_to_notify": {
|
|
20979
|
-
"type": "object",
|
|
20980
|
-
"description": "Default 360 user to notify upon an internal notification",
|
|
20981
|
-
"properties": {
|
|
20982
|
-
"onPendingUser": {
|
|
20983
|
-
"type": "array",
|
|
20984
|
-
"items": {
|
|
20985
|
-
"$ref": "#/components/schemas/AdminUser"
|
|
20986
|
-
},
|
|
20987
|
-
"description": "Default admin users for pending user notification to notify"
|
|
20988
|
-
}
|
|
20989
|
-
}
|
|
20990
|
-
},
|
|
20991
|
-
"feature_settings": {
|
|
20992
|
-
"$ref": "#/components/schemas/PortalFeatureSettings"
|
|
20993
|
-
},
|
|
20994
|
-
"self_registration_setting": {
|
|
20995
|
-
"type": "string",
|
|
20996
|
-
"enum": [
|
|
20997
|
-
"ALLOW_WITH_CONTACT_CREATION",
|
|
20998
|
-
"ALLOW_WITHOUT_CONTACT_CREATION",
|
|
20999
|
-
"DENY",
|
|
21000
|
-
"ALWAYS_CREATE_CONTACT",
|
|
21001
|
-
"DISALLOW_COMPLETELY",
|
|
21002
|
-
"BLOCK_IF_PORTAL_USER_EXISTS"
|
|
21003
|
-
]
|
|
21004
|
-
},
|
|
21005
|
-
"self_registration_account_setting": {
|
|
21006
|
-
"type": "string",
|
|
21007
|
-
"enum": [
|
|
21008
|
-
"ALLOW_WITH_CREATION",
|
|
21009
|
-
"DENY",
|
|
21010
|
-
"ALWAYS_CREATE",
|
|
21011
|
-
"BLOCK_IF_PORTAL_USER_EXISTS",
|
|
21012
|
-
"DISALLOW_COMPLETELY"
|
|
21013
|
-
]
|
|
21014
|
-
},
|
|
21015
|
-
"block_registration_if_portal_user_exists": {
|
|
21016
|
-
"type": "boolean"
|
|
21017
|
-
},
|
|
21018
|
-
"self_registration_entity": {
|
|
21019
|
-
"type": "string",
|
|
21020
|
-
"description": "Entity type used as the primary identifier for self-registration",
|
|
21021
|
-
"enum": [
|
|
21022
|
-
"contact",
|
|
21023
|
-
"account"
|
|
21024
|
-
]
|
|
21025
|
-
},
|
|
21026
|
-
"user_account_self_management": {
|
|
21027
|
-
"type": "boolean",
|
|
21028
|
-
"description": "Enable or disable user account self management"
|
|
21029
|
-
},
|
|
21030
|
-
"registration_identifiers": {
|
|
21031
|
-
"type": "array",
|
|
21032
|
-
"description": "Identifiers to identify a contact of a portal user during the registration.",
|
|
21033
|
-
"items": {
|
|
21034
|
-
"$ref": "#/components/schemas/ContractIdentifier"
|
|
21035
|
-
}
|
|
21036
|
-
},
|
|
21037
|
-
"surfaces": {
|
|
21038
|
-
"type": "array",
|
|
21039
|
-
"description": "Surfaces this portal's data is reached from besides the portal UI itself.",
|
|
21040
|
-
"items": {
|
|
21041
|
-
"$ref": "#/components/schemas/PortalSurface"
|
|
21042
|
-
}
|
|
21043
|
-
},
|
|
21044
|
-
"is_dummy": {
|
|
21045
|
-
"type": "boolean"
|
|
21046
|
-
},
|
|
21047
|
-
"is_v3_item": {
|
|
21048
|
-
"type": "boolean"
|
|
21049
|
-
},
|
|
21050
|
-
"published_revision_id": {
|
|
21051
|
-
"type": "string",
|
|
21052
|
-
"readOnly": true,
|
|
21053
|
-
"description": "ID of the currently published revision, if the portal has been published"
|
|
21054
|
-
},
|
|
21055
|
-
"_created_at": {
|
|
21056
|
-
"type": "string",
|
|
21057
|
-
"format": "date-time",
|
|
21058
|
-
"readOnly": true
|
|
21059
|
-
},
|
|
21060
|
-
"_updated_at": {
|
|
21061
|
-
"type": "string",
|
|
21062
|
-
"format": "date-time",
|
|
21063
|
-
"readOnly": true
|
|
21064
|
-
}
|
|
21065
|
-
}
|
|
21066
|
-
},
|
|
21067
20913
|
"JuiceSettings": {
|
|
21068
20914
|
"type": "object",
|
|
21069
20915
|
"properties": {
|