@epilot/customer-portal-client 0.39.13 → 0.39.15
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 +10 -8
- package/dist/openapi.d.ts +76 -41
- package/package.json +1 -1
- package/src/openapi-runtime.json +10 -8
- package/src/openapi.json +104 -74
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 n=a(t(466));r.default=n.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v1/portal/exports":{"post":{"operationId":"createExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/exports/{jobId}":{"get":{"operationId":"getExport","parameters":[{"in":"path","name":"jobId","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/visualization/metadata":{"get":{"operationId":"getVisualizationMetadata","parameters":[{"in":"query","name":"app_id","required":true},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates:migrate-references":{"post":{"operationId":"migrateEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates:list-references":{"post":{"operationId":"listEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates/{portal_id}":{"post":{"operationId":"upsertEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/public-widgets":{"get":{"operationId":"getPublicPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/widgets":{"get":{"operationId":"getPublicPortalWidgetsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"responses":{}}},"/v3/portal/widgets":{"get":{"operationId":"getPortalWidgetsV3","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"contract_id","required":false}],"responses":{}},"post":{"operationId":"upsertPortalWidgetV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/portal/files":{"post":{"operationId":"savePortalFilesV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","deprecated":true,"responses":{}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","responses":{}}},"/v2/portal/public/schemas":{"get":{"operationId":"getSchemasByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v3/portal/public/schemas":{"get":{"operationId":"getPublicSchemasV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/org/settings":{"get":{"operationId":"getOrganizationSettingsByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","responses":{}}},"/v2/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecords","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecordsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/contact":{"get":{"operationId":"getContact","responses":{}},"patch":{"operationId":"updateContact","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","parameters":[{"in":"query","name":"id","required":true}],"responses":{}}},"/v2/portal/public/contact/exists":{"post":{"operationId":"checkContactExists","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/contact/exists":{"post":{"operationId":"checkContactExistsV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/account/exists":{"post":{"operationId":"checkAccountExists","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","responses":{}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","responses":{}},"patch":{"operationId":"updatePortalUser","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalUser","responses":{}}},"/v2/portal/user/update/email":{"put":{"operationId":"updatePortalUserEmail","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/change/password":{"put":{"operationId":"changePortalUserPassword","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"post":{"operationId":"getContractWithTemplates","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/downloaded":{"post":{"operationId":"trackFileDownloaded","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/files/count-by-entity":{"get":{"operationId":"getFilesCountByEntity","deprecated":true,"responses":{}}},"/v2/portal/billing/events":{"get":{"operationId":"getBillingEvents","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"name":"entity_id","in":"query","required":false},{"name":"event_type","in":"query"},{"name":"paid","in":"query"},{"name":"date_after","in":"query"},{"name":"date_before","in":"query"},{"name":"sort","in":"query"}],"responses":{}}},"/v2/portal/billing/customers/balance":{"get":{"operationId":"getCustomerBalance","responses":{}}},"/v2/portal/billing/accounts/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getBillingAccount","responses":{}}},"/v2/portal/admin:login-as-user":{"post":{"operationId":"loginToPortalAsUser","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEvent","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"origin","in":"query","required":true}],"responses":{}}},"/v3/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEventV3","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"portal_id","in":"query","required":false},{"name":"domain","in":"query","required":false}],"responses":{}}},"/v2/portal/entity:get":{"post":{"operationId":"getPortalUserEntity","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity:search":{"post":{"operationId":"searchPortalUserEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/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/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/metering/readings":{"post":{"operationId":"getMeterReadings","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/providers/{provider_slug}":{"get":{"operationId":"getSSOProvider","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"origin","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/sso/login":{"post":{"operationId":"ssoLogin","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/sso/login":{"post":{"operationId":"ssoLoginV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"org_id","required":false},{"in":"query","name":"domain","required":false},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/redirect":{"post":{"operationId":"ssoRedirect","parameters":[{"in":"query","name":"web_uri","required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{}}},"responses":{}}},"/v2/portal/public/sso/callback":{"post":{"operationId":"ssoCallback","parameters":[{"in":"query","name":"domain"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getPortalPage","responses":{}},"put":{"operationId":"updatePortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPage","responses":{}}},"/v2/portal/pages":{"parameters":[{"in":"query","name":"domain","required":true}],"get":{"operationId":"getPortalPages","parameters":[{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false},{"in":"query","name":"contract_id","required":false,"deprecated":true},{"in":"query","name":"context_entities","required":false}],"responses":{}},"post":{"operationId":"createPortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/pages":{"get":{"operationId":"getPublicPages","parameters":[{"in":"query","name":"domain","required":true},{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false}],"responses":{}}},"/v2/portal/pages/interpolate":{"post":{"operationId":"interpolatePortalPages","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/config/triggered-journeys/{trigger_name}":{"parameters":[{"in":"path","name":"trigger_name","required":true,"description":"The trigger event for the auto-triggered journey"}],"get":{"operationId":"getTriggeredJourney","parameters":[{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/pages/default":{"get":{"operationId":"getDefaultPages","responses":{}}},"/v2/portal/pages/{id}/blocks":{"parameters":[{"in":"path","name":"id","required":true}],"post":{"operationId":"createPortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalPageBlocks","responses":{}}},"/v2/portal/pages/{id}/blocks/{block_id}":{"parameters":[{"in":"path","name":"id","required":true},{"in":"path","name":"block_id","required":true}],"get":{"operationId":"getPortalPageBlock","responses":{}},"put":{"operationId":"updatePortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPageBlock","responses":{}}},"/v2/portal/public/user/entry-point":{"get":{"operationId":"getUserEntryPoint","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/campaign/{campaign_id}/entity:status":{"put":{"operationId":"updateCampaignPortalBlockStatus","parameters":[{"in":"path","name":"campaign_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/notifications/entity:status":{"put":{"operationId":"updateNotificationsStatus","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/m-login/deregister/{client_id}/{user_id}":{"delete":{"operationId":"deRegisterMLoginUser","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"responses":{}}},"/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}":{"post":{"operationId":"notifyMLoginInterestChange","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config":{"post":{"operationId":"createPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/{portal_id}":{"get":{"operationId":"getPortalConfigV3","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}},"put":{"operationId":"putPortalConfig","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"query","name":"page_upsert_mode","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalConfig","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/configs":{"get":{"operationId":"listAllPortalConfigs","responses":{}}},"/v3/portal/config/swap":{"post":{"operationId":"swapPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/clone":{"post":{"operationId":"clonePortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/invite":{"post":{"operationId":"invitePartner","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/list":{"get":{"operationId":"listBusinessPartners","responses":{}}},"/v3/portal/partner/{partner_id}/resend-invitation":{"post":{"operationId":"resendPartnerInvitation","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/revoke":{"delete":{"operationId":"revokePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/disable":{"post":{"operationId":"disablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/enable":{"post":{"operationId":"enablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/verify-dns":{"post":{"operationId":"verifyDns","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/proxy/execute":{"post":{"operationId":"portalProxyExecute","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/mobile-config":{"get":{"operationId":"getMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"raw","required":false}],"responses":{}},"put":{"operationId":"putMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"InvalidRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"ForbiddenByRule":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"ContractAssignmentConflict":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ConfirmUserInvalidRequest":{"content":{"application/json":{}}},"InvalidRequestCreateMeterReading":{"content":{"application/json":{}}}}},"servers":[{"url":"https://customer-portal-api.sls.epilot.io"}]}')}},r={},t=function t(a){var n=r[a];if(void 0!==n)return n.exports;var i=r[a]={exports:{}};return e[a].call(i.exports,i,i.exports,t),i.exports}(438),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={330:function(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v1/portal/exports":{"post":{"operationId":"createExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/exports/{jobId}":{"get":{"operationId":"getExport","parameters":[{"in":"path","name":"jobId","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/visualization/metadata":{"get":{"operationId":"getVisualizationMetadata","parameters":[{"in":"query","name":"app_id","required":true},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates:migrate-references":{"post":{"operationId":"migrateEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates:list-references":{"post":{"operationId":"listEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates/{portal_id}":{"post":{"operationId":"upsertEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/public-widgets":{"get":{"operationId":"getPublicPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/widgets":{"get":{"operationId":"getPublicPortalWidgetsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"responses":{}}},"/v3/portal/widgets":{"get":{"operationId":"getPortalWidgetsV3","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"contract_id","required":false}],"responses":{}},"post":{"operationId":"upsertPortalWidgetV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/portal/files":{"post":{"operationId":"savePortalFilesV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","deprecated":true,"responses":{}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","responses":{}}},"/v2/portal/public/schemas":{"get":{"operationId":"getSchemasByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v3/portal/public/schemas":{"get":{"operationId":"getPublicSchemasV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/org/settings":{"get":{"operationId":"getOrganizationSettingsByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","responses":{}}},"/v2/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecords","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecordsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/contact":{"get":{"operationId":"getContact","responses":{}},"patch":{"operationId":"updateContact","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","parameters":[{"in":"query","name":"id","required":true}],"responses":{}}},"/v2/portal/public/contact/exists":{"post":{"operationId":"checkContactExists","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/contact/exists":{"post":{"operationId":"checkContactExistsV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/account/exists":{"post":{"operationId":"checkAccountExists","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","responses":{}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","responses":{}},"patch":{"operationId":"updatePortalUser","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalUser","responses":{}}},"/v2/portal/user/update/email":{"put":{"operationId":"updatePortalUserEmail","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/change/password":{"put":{"operationId":"changePortalUserPassword","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/{id}/resolve-templates":{"post":{"operationId":"getContractWithTemplates","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/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/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/metering/readings":{"post":{"operationId":"getMeterReadings","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/providers/{provider_slug}":{"get":{"operationId":"getSSOProvider","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"origin","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/sso/login":{"post":{"operationId":"ssoLogin","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/sso/login":{"post":{"operationId":"ssoLoginV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"org_id","required":false},{"in":"query","name":"domain","required":false},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/redirect":{"post":{"operationId":"ssoRedirect","parameters":[{"in":"query","name":"web_uri","required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{}}},"responses":{}}},"/v2/portal/public/sso/callback":{"post":{"operationId":"ssoCallback","parameters":[{"in":"query","name":"domain"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getPortalPage","responses":{}},"put":{"operationId":"updatePortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPage","responses":{}}},"/v2/portal/pages":{"parameters":[{"in":"query","name":"domain","required":true}],"get":{"operationId":"getPortalPages","parameters":[{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false},{"in":"query","name":"contract_id","required":false,"deprecated":true},{"in":"query","name":"context_entities","required":false}],"responses":{}},"post":{"operationId":"createPortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/pages":{"get":{"operationId":"getPublicPages","parameters":[{"in":"query","name":"domain","required":true},{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false}],"responses":{}}},"/v2/portal/pages/interpolate":{"post":{"operationId":"interpolatePortalPages","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/config/triggered-journeys/{trigger_name}":{"parameters":[{"in":"path","name":"trigger_name","required":true,"description":"The trigger event for the auto-triggered journey"}],"get":{"operationId":"getTriggeredJourney","parameters":[{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/pages/default":{"get":{"operationId":"getDefaultPages","responses":{}}},"/v2/portal/pages/{id}/blocks":{"parameters":[{"in":"path","name":"id","required":true}],"post":{"operationId":"createPortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalPageBlocks","responses":{}}},"/v2/portal/pages/{id}/blocks/{block_id}":{"parameters":[{"in":"path","name":"id","required":true},{"in":"path","name":"block_id","required":true}],"get":{"operationId":"getPortalPageBlock","responses":{}},"put":{"operationId":"updatePortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPageBlock","responses":{}}},"/v2/portal/public/user/entry-point":{"get":{"operationId":"getUserEntryPoint","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/campaign/{campaign_id}/entity:status":{"put":{"operationId":"updateCampaignPortalBlockStatus","parameters":[{"in":"path","name":"campaign_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/notifications/entity:status":{"put":{"operationId":"updateNotificationsStatus","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/m-login/deregister/{client_id}/{user_id}":{"delete":{"operationId":"deRegisterMLoginUser","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"responses":{}}},"/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}":{"post":{"operationId":"notifyMLoginInterestChange","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config":{"post":{"operationId":"createPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/{portal_id}":{"get":{"operationId":"getPortalConfigV3","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}},"put":{"operationId":"putPortalConfig","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"query","name":"page_upsert_mode","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalConfig","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/configs":{"get":{"operationId":"listAllPortalConfigs","responses":{}}},"/v3/portal/config/swap":{"post":{"operationId":"swapPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/clone":{"post":{"operationId":"clonePortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/invite":{"post":{"operationId":"invitePartner","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/list":{"get":{"operationId":"listBusinessPartners","responses":{}}},"/v3/portal/partner/{partner_id}/resend-invitation":{"post":{"operationId":"resendPartnerInvitation","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/revoke":{"delete":{"operationId":"revokePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/disable":{"post":{"operationId":"disablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/enable":{"post":{"operationId":"enablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/verify-dns":{"post":{"operationId":"verifyDns","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/proxy/execute":{"post":{"operationId":"portalProxyExecute","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/mobile-config":{"get":{"operationId":"getMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"raw","required":false}],"responses":{}},"put":{"operationId":"putMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"InvalidRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"ForbiddenByRule":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"ContractAssignmentConflict":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ConfirmUserInvalidRequest":{"content":{"application/json":{}}},"InvalidRequestCreateMeterReading":{"content":{"application/json":{}}}}},"servers":[{"url":"https://customer-portal-api.sls.epilot.io"}]}')}},r={},t=function t(a){var n=r[a];if(void 0!==n)return n.exports;var i=r[a]={exports:{}};return e[a].call(i.exports,i,i.exports,t),i.exports}(330),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
@@ -1423,8 +1423,9 @@
|
|
|
1423
1423
|
],
|
|
1424
1424
|
"responses": {}
|
|
1425
1425
|
},
|
|
1426
|
-
"
|
|
1427
|
-
"operationId": "
|
|
1426
|
+
"patch": {
|
|
1427
|
+
"operationId": "updateContract",
|
|
1428
|
+
"deprecated": true,
|
|
1428
1429
|
"parameters": [
|
|
1429
1430
|
{
|
|
1430
1431
|
"in": "path",
|
|
@@ -1433,16 +1434,17 @@
|
|
|
1433
1434
|
}
|
|
1434
1435
|
],
|
|
1435
1436
|
"requestBody": {
|
|
1436
|
-
"required":
|
|
1437
|
+
"required": true,
|
|
1437
1438
|
"content": {
|
|
1438
1439
|
"application/json": {}
|
|
1439
1440
|
}
|
|
1440
1441
|
},
|
|
1441
1442
|
"responses": {}
|
|
1442
|
-
}
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1443
|
+
}
|
|
1444
|
+
},
|
|
1445
|
+
"/v2/portal/contract/{id}/resolve-templates": {
|
|
1446
|
+
"post": {
|
|
1447
|
+
"operationId": "getContractWithTemplates",
|
|
1446
1448
|
"parameters": [
|
|
1447
1449
|
{
|
|
1448
1450
|
"in": "path",
|
|
@@ -1451,7 +1453,7 @@
|
|
|
1451
1453
|
}
|
|
1452
1454
|
],
|
|
1453
1455
|
"requestBody": {
|
|
1454
|
-
"required":
|
|
1456
|
+
"required": false,
|
|
1455
1457
|
"content": {
|
|
1456
1458
|
"application/json": {}
|
|
1457
1459
|
}
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1051,7 +1051,7 @@ declare namespace Components {
|
|
|
1051
1051
|
* example:
|
|
1052
1052
|
* office-365-login
|
|
1053
1053
|
*/
|
|
1054
|
-
ProviderSlug /* [0-9a-
|
|
1054
|
+
ProviderSlug /* [0-9a-z_-]+ */[];
|
|
1055
1055
|
/**
|
|
1056
1056
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
1057
1057
|
*/
|
|
@@ -1578,7 +1578,7 @@ declare namespace Components {
|
|
|
1578
1578
|
* example:
|
|
1579
1579
|
* office-365-login
|
|
1580
1580
|
*/
|
|
1581
|
-
ProviderSlug /* [0-9a-
|
|
1581
|
+
ProviderSlug /* [0-9a-z_-]+ */[];
|
|
1582
1582
|
/**
|
|
1583
1583
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
1584
1584
|
*/
|
|
@@ -3506,7 +3506,11 @@ declare namespace Components {
|
|
|
3506
3506
|
*
|
|
3507
3507
|
*/
|
|
3508
3508
|
ExtensionHookVisualizationMetadata | /**
|
|
3509
|
-
* Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not
|
|
3509
|
+
* Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not run its own change email flow. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change.
|
|
3510
|
+
* The `change_mode` controls what the portal does after the call:
|
|
3511
|
+
* - `asynchronous`: The third-party system takes the email change over entirely (most likely by sending the user instructions to confirm the new email address). The portal does not change the login email itself.
|
|
3512
|
+
* - `synchronous`: The third-party system applies the email change immediately. The portal waits for a successful (2xx) response and then also changes the portal user's login email right away, without sending a confirmation email. The user has to sign in again with the new email address afterwards.
|
|
3513
|
+
*
|
|
3510
3514
|
* The expected response http status code to the call is:
|
|
3511
3515
|
* - 2xx if the request was accepted
|
|
3512
3516
|
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
@@ -3525,6 +3529,8 @@ declare namespace Components {
|
|
|
3525
3529
|
* - `synchronous`: The third-party system deletes the user immediately. The portal waits for a successful (2xx) response and then also deletes the epilot user.
|
|
3526
3530
|
* - `asynchronous`: The third-party system handles deletion out-of-band. The portal does not delete anything immediately; cleanup is expected to happen later (e.g. via the user deletion API or webhooks).
|
|
3527
3531
|
*
|
|
3532
|
+
* The optional `delete_contact` additionally deletes the contact related to the portal user, once the portal user itself was deleted (`synchronous` mode only).
|
|
3533
|
+
*
|
|
3528
3534
|
* The expected response http status code to the call is:
|
|
3529
3535
|
* - 2xx if the request was accepted
|
|
3530
3536
|
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
@@ -3597,7 +3603,11 @@ declare namespace Components {
|
|
|
3597
3603
|
id?: string;
|
|
3598
3604
|
}
|
|
3599
3605
|
/**
|
|
3600
|
-
* Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not
|
|
3606
|
+
* Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not run its own change email flow. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change.
|
|
3607
|
+
* The `change_mode` controls what the portal does after the call:
|
|
3608
|
+
* - `asynchronous`: The third-party system takes the email change over entirely (most likely by sending the user instructions to confirm the new email address). The portal does not change the login email itself.
|
|
3609
|
+
* - `synchronous`: The third-party system applies the email change immediately. The portal waits for a successful (2xx) response and then also changes the portal user's login email right away, without sending a confirmation email. The user has to sign in again with the new email address afterwards.
|
|
3610
|
+
*
|
|
3601
3611
|
* The expected response http status code to the call is:
|
|
3602
3612
|
* - 2xx if the request was accepted
|
|
3603
3613
|
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
@@ -3606,7 +3616,12 @@ declare namespace Components {
|
|
|
3606
3616
|
export interface ExtensionHookChangeEmail {
|
|
3607
3617
|
type: "changeEmail";
|
|
3608
3618
|
/**
|
|
3609
|
-
*
|
|
3619
|
+
* Controls how the email change is handled once the third-party system accepted it. `asynchronous` hands the email change over entirely to the third-party system and the portal does not change the login email itself. `synchronous` waits for the third-party system to respond and then changes the portal user's login email immediately, without a confirmation email.
|
|
3620
|
+
*
|
|
3621
|
+
*/
|
|
3622
|
+
change_mode?: "synchronous" | "asynchronous";
|
|
3623
|
+
/**
|
|
3624
|
+
* Whether the portal user must confirm their current password before the change email request is handed over to the third-party system. When true, the portal collects and verifies the current password before calling the hook. Treated as true when `change_mode` is `synchronous`, since the portal re-creates the login with the confirmed password. Skipped either way for portal users whose identity is managed by an identity provider: an SSO login has no password to confirm.
|
|
3610
3625
|
*
|
|
3611
3626
|
*/
|
|
3612
3627
|
require_password_confirmation?: boolean;
|
|
@@ -4015,6 +4030,8 @@ declare namespace Components {
|
|
|
4015
4030
|
* - `synchronous`: The third-party system deletes the user immediately. The portal waits for a successful (2xx) response and then also deletes the epilot user.
|
|
4016
4031
|
* - `asynchronous`: The third-party system handles deletion out-of-band. The portal does not delete anything immediately; cleanup is expected to happen later (e.g. via the user deletion API or webhooks).
|
|
4017
4032
|
*
|
|
4033
|
+
* The optional `delete_contact` additionally deletes the contact related to the portal user, once the portal user itself was deleted (`synchronous` mode only).
|
|
4034
|
+
*
|
|
4018
4035
|
* The expected response http status code to the call is:
|
|
4019
4036
|
* - 2xx if the request was accepted
|
|
4020
4037
|
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
@@ -4027,6 +4044,11 @@ declare namespace Components {
|
|
|
4027
4044
|
*
|
|
4028
4045
|
*/
|
|
4029
4046
|
deletion_mode?: "synchronous" | "asynchronous";
|
|
4047
|
+
/**
|
|
4048
|
+
* Opt-in deletion of the contact related to the portal user, applied after the portal user itself was deleted. `none` (default) leaves the contact untouched. `soft` deletes the contact, so it can still be restored from the trash. `hard` permanently purges the contact. Only applied in `synchronous` deletion mode, as `asynchronous` mode hands the cleanup over to the third-party system.
|
|
4049
|
+
*
|
|
4050
|
+
*/
|
|
4051
|
+
delete_contact?: "none" | "soft" | "hard";
|
|
4030
4052
|
/**
|
|
4031
4053
|
* Optional explanation shown to the user in the delete account confirmation dialog.
|
|
4032
4054
|
*/
|
|
@@ -6063,7 +6085,7 @@ declare namespace Components {
|
|
|
6063
6085
|
* example:
|
|
6064
6086
|
* office-365-login
|
|
6065
6087
|
*/
|
|
6066
|
-
ProviderSlug /* [0-9a-
|
|
6088
|
+
ProviderSlug /* [0-9a-z_-]+ */[];
|
|
6067
6089
|
/**
|
|
6068
6090
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
6069
6091
|
*/
|
|
@@ -6682,7 +6704,7 @@ declare namespace Components {
|
|
|
6682
6704
|
* example:
|
|
6683
6705
|
* office-365-login
|
|
6684
6706
|
*/
|
|
6685
|
-
ProviderSlug /* [0-9a-
|
|
6707
|
+
ProviderSlug /* [0-9a-z_-]+ */[];
|
|
6686
6708
|
/**
|
|
6687
6709
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
6688
6710
|
*/
|
|
@@ -7369,7 +7391,7 @@ declare namespace Components {
|
|
|
7369
7391
|
* example:
|
|
7370
7392
|
* office-365-login
|
|
7371
7393
|
*/
|
|
7372
|
-
ProviderSlug /* [0-9a-
|
|
7394
|
+
ProviderSlug /* [0-9a-z_-]+ */;
|
|
7373
7395
|
display_name: /**
|
|
7374
7396
|
* Human-readable display name for identity provider shown in login
|
|
7375
7397
|
* example:
|
|
@@ -7421,7 +7443,7 @@ declare namespace Components {
|
|
|
7421
7443
|
* example:
|
|
7422
7444
|
* office-365-login
|
|
7423
7445
|
*/
|
|
7424
|
-
ProviderSlug /* [0-9a-
|
|
7446
|
+
ProviderSlug /* [0-9a-z_-]+ */;
|
|
7425
7447
|
display_name: /**
|
|
7426
7448
|
* Human-readable display name for identity provider shown in login
|
|
7427
7449
|
* example:
|
|
@@ -7451,7 +7473,7 @@ declare namespace Components {
|
|
|
7451
7473
|
* example:
|
|
7452
7474
|
* office-365-login
|
|
7453
7475
|
*/
|
|
7454
|
-
export type ProviderSlug = string; // [0-9a-
|
|
7476
|
+
export type ProviderSlug = string; // [0-9a-z_-]+
|
|
7455
7477
|
export interface PublicAppDetails {
|
|
7456
7478
|
/**
|
|
7457
7479
|
* Identifier of the app.
|
|
@@ -7470,8 +7492,16 @@ declare namespace Components {
|
|
|
7470
7492
|
* Identifier of the hook.
|
|
7471
7493
|
*/
|
|
7472
7494
|
id?: string;
|
|
7495
|
+
/**
|
|
7496
|
+
* Whether the third-party system applies the email change immediately (`synchronous`) or takes it over entirely (`asynchronous`).
|
|
7497
|
+
* In synchronous mode the login email is changed as soon as the request succeeds and the portal user has to sign in again with the new address.
|
|
7498
|
+
*
|
|
7499
|
+
*/
|
|
7500
|
+
change_mode?: "synchronous" | "asynchronous";
|
|
7473
7501
|
/**
|
|
7474
7502
|
* Whether the portal user must confirm their current password before the email change is handed over to the third-party system.
|
|
7503
|
+
* Also required when `change_mode` is `synchronous`, except for portal users whose identity is managed by an identity provider - an SSO login has no password to confirm.
|
|
7504
|
+
*
|
|
7475
7505
|
*/
|
|
7476
7506
|
require_password_confirmation?: boolean;
|
|
7477
7507
|
explanation?: /* Explanation of the hook. */ PublicSelfManagementExplanation;
|
|
@@ -7748,7 +7778,7 @@ declare namespace Components {
|
|
|
7748
7778
|
* example:
|
|
7749
7779
|
* office-365-login
|
|
7750
7780
|
*/
|
|
7751
|
-
ProviderSlug /* [0-9a-
|
|
7781
|
+
ProviderSlug /* [0-9a-z_-]+ */;
|
|
7752
7782
|
/**
|
|
7753
7783
|
* URL of the authorization endpoint
|
|
7754
7784
|
* example:
|
|
@@ -8244,7 +8274,7 @@ declare namespace Components {
|
|
|
8244
8274
|
* example:
|
|
8245
8275
|
* office-365-login
|
|
8246
8276
|
*/
|
|
8247
|
-
ProviderSlug /* [0-9a-
|
|
8277
|
+
ProviderSlug /* [0-9a-z_-]+ */[];
|
|
8248
8278
|
/**
|
|
8249
8279
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
8250
8280
|
*/
|
|
@@ -8831,7 +8861,7 @@ declare namespace Components {
|
|
|
8831
8861
|
* example:
|
|
8832
8862
|
* office-365-login
|
|
8833
8863
|
*/
|
|
8834
|
-
ProviderSlug /* [0-9a-
|
|
8864
|
+
ProviderSlug /* [0-9a-z_-]+ */[];
|
|
8835
8865
|
/**
|
|
8836
8866
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
8837
8867
|
*/
|
|
@@ -12086,7 +12116,7 @@ declare namespace Paths {
|
|
|
12086
12116
|
* example:
|
|
12087
12117
|
* office-365-login
|
|
12088
12118
|
*/
|
|
12089
|
-
Components.Schemas.ProviderSlug /* [0-9a-
|
|
12119
|
+
Components.Schemas.ProviderSlug /* [0-9a-z_-]+ */[];
|
|
12090
12120
|
/**
|
|
12091
12121
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
12092
12122
|
*/
|
|
@@ -12704,7 +12734,7 @@ declare namespace Paths {
|
|
|
12704
12734
|
* example:
|
|
12705
12735
|
* office-365-login
|
|
12706
12736
|
*/
|
|
12707
|
-
Components.Schemas.ProviderSlug /* [0-9a-
|
|
12737
|
+
Components.Schemas.ProviderSlug /* [0-9a-z_-]+ */[];
|
|
12708
12738
|
/**
|
|
12709
12739
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
12710
12740
|
*/
|
|
@@ -14055,7 +14085,7 @@ declare namespace Paths {
|
|
|
14055
14085
|
* example:
|
|
14056
14086
|
* office-365-login
|
|
14057
14087
|
*/
|
|
14058
|
-
Components.Schemas.ProviderSlug /* [0-9a-
|
|
14088
|
+
Components.Schemas.ProviderSlug /* [0-9a-z_-]+ */;
|
|
14059
14089
|
}
|
|
14060
14090
|
export interface PathParameters {
|
|
14061
14091
|
provider_slug: Parameters.ProviderSlug;
|
|
@@ -14284,7 +14314,7 @@ declare namespace Paths {
|
|
|
14284
14314
|
* example:
|
|
14285
14315
|
* office-365-login
|
|
14286
14316
|
*/
|
|
14287
|
-
Components.Schemas.ProviderSlug /* [0-9a-
|
|
14317
|
+
Components.Schemas.ProviderSlug /* [0-9a-z_-]+ */[];
|
|
14288
14318
|
/**
|
|
14289
14319
|
* Whether the user is soft deleted
|
|
14290
14320
|
* example:
|
|
@@ -15115,7 +15145,7 @@ declare namespace Paths {
|
|
|
15115
15145
|
* example:
|
|
15116
15146
|
* office-365-login
|
|
15117
15147
|
*/
|
|
15118
|
-
Components.Schemas.ProviderSlug /* [0-9a-
|
|
15148
|
+
Components.Schemas.ProviderSlug /* [0-9a-z_-]+ */;
|
|
15119
15149
|
}
|
|
15120
15150
|
namespace Responses {
|
|
15121
15151
|
export interface $200 {
|
|
@@ -15169,7 +15199,7 @@ declare namespace Paths {
|
|
|
15169
15199
|
* example:
|
|
15170
15200
|
* office-365-login
|
|
15171
15201
|
*/
|
|
15172
|
-
Components.Schemas.ProviderSlug /* [0-9a-
|
|
15202
|
+
Components.Schemas.ProviderSlug /* [0-9a-z_-]+ */;
|
|
15173
15203
|
}
|
|
15174
15204
|
namespace Responses {
|
|
15175
15205
|
export interface $200 {
|
|
@@ -15568,6 +15598,7 @@ declare namespace Paths {
|
|
|
15568
15598
|
/**
|
|
15569
15599
|
* Password of the portal user for confirmation.
|
|
15570
15600
|
* Required unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal.
|
|
15601
|
+
* Also required by a `changeEmail` hook with `change_mode` set to `synchronous`, except for portal users whose identity is managed by an identity provider - an SSO login has no password to confirm.
|
|
15571
15602
|
*
|
|
15572
15603
|
*/
|
|
15573
15604
|
password?: string;
|
|
@@ -15576,8 +15607,10 @@ declare namespace Paths {
|
|
|
15576
15607
|
export interface $200 {
|
|
15577
15608
|
/**
|
|
15578
15609
|
* `You will receive a confirmation mail soon on your updated email address.` for the built-in flow,
|
|
15579
|
-
*
|
|
15580
|
-
* the change over to a third party
|
|
15610
|
+
* `Your email change request has been received.` when a changeEmail portal extension hook handed
|
|
15611
|
+
* the change over to a third party, or `Your email has been changed.` when a synchronous changeEmail
|
|
15612
|
+
* portal extension hook changed the login email immediately - the portal user has to sign in again
|
|
15613
|
+
* with the new email address in that case.
|
|
15581
15614
|
*
|
|
15582
15615
|
* example:
|
|
15583
15616
|
* You will receive a confirmation mail soon on your updated email address.
|
|
@@ -16961,16 +16994,6 @@ export interface OperationMethods {
|
|
|
16961
16994
|
data?: any,
|
|
16962
16995
|
config?: AxiosRequestConfig
|
|
16963
16996
|
): OperationResponse<Paths.GetContract.Responses.$200>
|
|
16964
|
-
/**
|
|
16965
|
-
* getContractWithTemplates - getContractWithTemplates
|
|
16966
|
-
*
|
|
16967
|
-
* Get a contract by id, resolving the provided Handlebars templates against each related meter into templates_output. POST variant of getContract that accepts a request body; the GET remains as a fallback.
|
|
16968
|
-
*/
|
|
16969
|
-
'getContractWithTemplates'(
|
|
16970
|
-
parameters?: Parameters<Paths.GetContractWithTemplates.PathParameters> | null,
|
|
16971
|
-
data?: Paths.GetContractWithTemplates.RequestBody,
|
|
16972
|
-
config?: AxiosRequestConfig
|
|
16973
|
-
): OperationResponse<Paths.GetContractWithTemplates.Responses.$200>
|
|
16974
16997
|
/**
|
|
16975
16998
|
* updateContract - updateContract
|
|
16976
16999
|
*
|
|
@@ -16981,6 +17004,16 @@ export interface OperationMethods {
|
|
|
16981
17004
|
data?: Paths.UpdateContract.RequestBody,
|
|
16982
17005
|
config?: AxiosRequestConfig
|
|
16983
17006
|
): OperationResponse<Paths.UpdateContract.Responses.$200>
|
|
17007
|
+
/**
|
|
17008
|
+
* getContractWithTemplates - getContractWithTemplates
|
|
17009
|
+
*
|
|
17010
|
+
* Resolve Handlebars templates against a contract's related meters and return the contract with templates_output populated per meter. This is a read-only operation — it does not modify the contract. It uses POST only so the templates can be passed in the request body. Prefer getPortalUserEntity / getContract for reads that don't need templates.
|
|
17011
|
+
*/
|
|
17012
|
+
'getContractWithTemplates'(
|
|
17013
|
+
parameters?: Parameters<Paths.GetContractWithTemplates.PathParameters> | null,
|
|
17014
|
+
data?: Paths.GetContractWithTemplates.RequestBody,
|
|
17015
|
+
config?: AxiosRequestConfig
|
|
17016
|
+
): OperationResponse<Paths.GetContractWithTemplates.Responses.$200>
|
|
16984
17017
|
/**
|
|
16985
17018
|
* addContractByIdentifiers - addContractByIdentifiers
|
|
16986
17019
|
*
|
|
@@ -18806,16 +18839,6 @@ export interface PathsDictionary {
|
|
|
18806
18839
|
data?: any,
|
|
18807
18840
|
config?: AxiosRequestConfig
|
|
18808
18841
|
): OperationResponse<Paths.GetContract.Responses.$200>
|
|
18809
|
-
/**
|
|
18810
|
-
* getContractWithTemplates - getContractWithTemplates
|
|
18811
|
-
*
|
|
18812
|
-
* Get a contract by id, resolving the provided Handlebars templates against each related meter into templates_output. POST variant of getContract that accepts a request body; the GET remains as a fallback.
|
|
18813
|
-
*/
|
|
18814
|
-
'post'(
|
|
18815
|
-
parameters?: Parameters<Paths.GetContractWithTemplates.PathParameters> | null,
|
|
18816
|
-
data?: Paths.GetContractWithTemplates.RequestBody,
|
|
18817
|
-
config?: AxiosRequestConfig
|
|
18818
|
-
): OperationResponse<Paths.GetContractWithTemplates.Responses.$200>
|
|
18819
18842
|
/**
|
|
18820
18843
|
* updateContract - updateContract
|
|
18821
18844
|
*
|
|
@@ -18827,6 +18850,18 @@ export interface PathsDictionary {
|
|
|
18827
18850
|
config?: AxiosRequestConfig
|
|
18828
18851
|
): OperationResponse<Paths.UpdateContract.Responses.$200>
|
|
18829
18852
|
}
|
|
18853
|
+
['/v2/portal/contract/{id}/resolve-templates']: {
|
|
18854
|
+
/**
|
|
18855
|
+
* getContractWithTemplates - getContractWithTemplates
|
|
18856
|
+
*
|
|
18857
|
+
* Resolve Handlebars templates against a contract's related meters and return the contract with templates_output populated per meter. This is a read-only operation — it does not modify the contract. It uses POST only so the templates can be passed in the request body. Prefer getPortalUserEntity / getContract for reads that don't need templates.
|
|
18858
|
+
*/
|
|
18859
|
+
'post'(
|
|
18860
|
+
parameters?: Parameters<Paths.GetContractWithTemplates.PathParameters> | null,
|
|
18861
|
+
data?: Paths.GetContractWithTemplates.RequestBody,
|
|
18862
|
+
config?: AxiosRequestConfig
|
|
18863
|
+
): OperationResponse<Paths.GetContractWithTemplates.Responses.$200>
|
|
18864
|
+
}
|
|
18830
18865
|
['/v2/portal/contract/by-identifiers']: {
|
|
18831
18866
|
/**
|
|
18832
18867
|
* addContractByIdentifiers - addContractByIdentifiers
|
package/package.json
CHANGED
package/src/openapi-runtime.json
CHANGED
|
@@ -1423,8 +1423,9 @@
|
|
|
1423
1423
|
],
|
|
1424
1424
|
"responses": {}
|
|
1425
1425
|
},
|
|
1426
|
-
"
|
|
1427
|
-
"operationId": "
|
|
1426
|
+
"patch": {
|
|
1427
|
+
"operationId": "updateContract",
|
|
1428
|
+
"deprecated": true,
|
|
1428
1429
|
"parameters": [
|
|
1429
1430
|
{
|
|
1430
1431
|
"in": "path",
|
|
@@ -1433,16 +1434,17 @@
|
|
|
1433
1434
|
}
|
|
1434
1435
|
],
|
|
1435
1436
|
"requestBody": {
|
|
1436
|
-
"required":
|
|
1437
|
+
"required": true,
|
|
1437
1438
|
"content": {
|
|
1438
1439
|
"application/json": {}
|
|
1439
1440
|
}
|
|
1440
1441
|
},
|
|
1441
1442
|
"responses": {}
|
|
1442
|
-
}
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1443
|
+
}
|
|
1444
|
+
},
|
|
1445
|
+
"/v2/portal/contract/{id}/resolve-templates": {
|
|
1446
|
+
"post": {
|
|
1447
|
+
"operationId": "getContractWithTemplates",
|
|
1446
1448
|
"parameters": [
|
|
1447
1449
|
{
|
|
1448
1450
|
"in": "path",
|
|
@@ -1451,7 +1453,7 @@
|
|
|
1451
1453
|
}
|
|
1452
1454
|
],
|
|
1453
1455
|
"requestBody": {
|
|
1454
|
-
"required":
|
|
1456
|
+
"required": false,
|
|
1455
1457
|
"content": {
|
|
1456
1458
|
"application/json": {}
|
|
1457
1459
|
}
|
package/src/openapi.json
CHANGED
|
@@ -4252,7 +4252,7 @@
|
|
|
4252
4252
|
},
|
|
4253
4253
|
"password": {
|
|
4254
4254
|
"type": "string",
|
|
4255
|
-
"description": "Password of the portal user for confirmation.\nRequired unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal.\n"
|
|
4255
|
+
"description": "Password of the portal user for confirmation.\nRequired unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal.\nAlso required by a `changeEmail` hook with `change_mode` set to `synchronous`, except for portal users whose identity is managed by an identity provider - an SSO login has no password to confirm.\n"
|
|
4256
4256
|
}
|
|
4257
4257
|
}
|
|
4258
4258
|
}
|
|
@@ -4261,7 +4261,7 @@
|
|
|
4261
4261
|
},
|
|
4262
4262
|
"responses": {
|
|
4263
4263
|
"200": {
|
|
4264
|
-
"description": "Portal user email updated successfully
|
|
4264
|
+
"description": "Portal user email updated successfully.\nThe user receives a confirmation email, unless a `changeEmail` portal extension hook with\n`change_mode` set to `synchronous` changed the login email right away.\n",
|
|
4265
4265
|
"content": {
|
|
4266
4266
|
"application/json": {
|
|
4267
4267
|
"schema": {
|
|
@@ -4269,7 +4269,7 @@
|
|
|
4269
4269
|
"properties": {
|
|
4270
4270
|
"message": {
|
|
4271
4271
|
"type": "string",
|
|
4272
|
-
"description": "`You will receive a confirmation mail soon on your updated email address.` for the built-in flow,\
|
|
4272
|
+
"description": "`You will receive a confirmation mail soon on your updated email address.` for the built-in flow,\n`Your email change request has been received.` when a changeEmail portal extension hook handed\nthe change over to a third party, or `Your email has been changed.` when a synchronous changeEmail\nportal extension hook changed the login email immediately - the portal user has to sign in again\nwith the new email address in that case.\n",
|
|
4273
4273
|
"example": "You will receive a confirmation mail soon on your updated email address."
|
|
4274
4274
|
}
|
|
4275
4275
|
}
|
|
@@ -5929,10 +5929,77 @@
|
|
|
5929
5929
|
}
|
|
5930
5930
|
}
|
|
5931
5931
|
},
|
|
5932
|
+
"patch": {
|
|
5933
|
+
"operationId": "updateContract",
|
|
5934
|
+
"summary": "updateContract",
|
|
5935
|
+
"description": "Update a contract by id. Use getPortalUserEntity instead.",
|
|
5936
|
+
"deprecated": true,
|
|
5937
|
+
"tags": [
|
|
5938
|
+
"ECP"
|
|
5939
|
+
],
|
|
5940
|
+
"security": [
|
|
5941
|
+
{
|
|
5942
|
+
"PortalAuth": []
|
|
5943
|
+
}
|
|
5944
|
+
],
|
|
5945
|
+
"parameters": [
|
|
5946
|
+
{
|
|
5947
|
+
"in": "path",
|
|
5948
|
+
"name": "id",
|
|
5949
|
+
"schema": {
|
|
5950
|
+
"$ref": "#/components/schemas/EntityId"
|
|
5951
|
+
},
|
|
5952
|
+
"required": true,
|
|
5953
|
+
"description": "The ID of the contract"
|
|
5954
|
+
}
|
|
5955
|
+
],
|
|
5956
|
+
"requestBody": {
|
|
5957
|
+
"description": "Requested contract body to update",
|
|
5958
|
+
"required": true,
|
|
5959
|
+
"content": {
|
|
5960
|
+
"application/json": {
|
|
5961
|
+
"schema": {
|
|
5962
|
+
"$ref": "#/components/schemas/Entity"
|
|
5963
|
+
}
|
|
5964
|
+
}
|
|
5965
|
+
}
|
|
5966
|
+
},
|
|
5967
|
+
"responses": {
|
|
5968
|
+
"200": {
|
|
5969
|
+
"description": "Updated the contract successfully.",
|
|
5970
|
+
"content": {
|
|
5971
|
+
"application/json": {
|
|
5972
|
+
"schema": {
|
|
5973
|
+
"type": "object",
|
|
5974
|
+
"properties": {
|
|
5975
|
+
"data": {
|
|
5976
|
+
"$ref": "#/components/schemas/Contract"
|
|
5977
|
+
}
|
|
5978
|
+
}
|
|
5979
|
+
}
|
|
5980
|
+
}
|
|
5981
|
+
}
|
|
5982
|
+
},
|
|
5983
|
+
"401": {
|
|
5984
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
5985
|
+
},
|
|
5986
|
+
"403": {
|
|
5987
|
+
"$ref": "#/components/responses/ForbiddenByRule"
|
|
5988
|
+
},
|
|
5989
|
+
"404": {
|
|
5990
|
+
"$ref": "#/components/responses/NotFound"
|
|
5991
|
+
},
|
|
5992
|
+
"500": {
|
|
5993
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
5994
|
+
}
|
|
5995
|
+
}
|
|
5996
|
+
}
|
|
5997
|
+
},
|
|
5998
|
+
"/v2/portal/contract/{id}/resolve-templates": {
|
|
5932
5999
|
"post": {
|
|
5933
6000
|
"operationId": "getContractWithTemplates",
|
|
5934
6001
|
"summary": "getContractWithTemplates",
|
|
5935
|
-
"description": "
|
|
6002
|
+
"description": "Resolve Handlebars templates against a contract's related meters and return the contract with templates_output populated per meter. This is a read-only operation — it does not modify the contract. It uses POST only so the templates can be passed in the request body. Prefer getPortalUserEntity / getContract for reads that don't need templates.",
|
|
5936
6003
|
"tags": [
|
|
5937
6004
|
"ECP"
|
|
5938
6005
|
],
|
|
@@ -6047,71 +6114,6 @@
|
|
|
6047
6114
|
"$ref": "#/components/responses/InternalServerError"
|
|
6048
6115
|
}
|
|
6049
6116
|
}
|
|
6050
|
-
},
|
|
6051
|
-
"patch": {
|
|
6052
|
-
"operationId": "updateContract",
|
|
6053
|
-
"summary": "updateContract",
|
|
6054
|
-
"description": "Update a contract by id. Use getPortalUserEntity instead.",
|
|
6055
|
-
"deprecated": true,
|
|
6056
|
-
"tags": [
|
|
6057
|
-
"ECP"
|
|
6058
|
-
],
|
|
6059
|
-
"security": [
|
|
6060
|
-
{
|
|
6061
|
-
"PortalAuth": []
|
|
6062
|
-
}
|
|
6063
|
-
],
|
|
6064
|
-
"parameters": [
|
|
6065
|
-
{
|
|
6066
|
-
"in": "path",
|
|
6067
|
-
"name": "id",
|
|
6068
|
-
"schema": {
|
|
6069
|
-
"$ref": "#/components/schemas/EntityId"
|
|
6070
|
-
},
|
|
6071
|
-
"required": true,
|
|
6072
|
-
"description": "The ID of the contract"
|
|
6073
|
-
}
|
|
6074
|
-
],
|
|
6075
|
-
"requestBody": {
|
|
6076
|
-
"description": "Requested contract body to update",
|
|
6077
|
-
"required": true,
|
|
6078
|
-
"content": {
|
|
6079
|
-
"application/json": {
|
|
6080
|
-
"schema": {
|
|
6081
|
-
"$ref": "#/components/schemas/Entity"
|
|
6082
|
-
}
|
|
6083
|
-
}
|
|
6084
|
-
}
|
|
6085
|
-
},
|
|
6086
|
-
"responses": {
|
|
6087
|
-
"200": {
|
|
6088
|
-
"description": "Updated the contract successfully.",
|
|
6089
|
-
"content": {
|
|
6090
|
-
"application/json": {
|
|
6091
|
-
"schema": {
|
|
6092
|
-
"type": "object",
|
|
6093
|
-
"properties": {
|
|
6094
|
-
"data": {
|
|
6095
|
-
"$ref": "#/components/schemas/Contract"
|
|
6096
|
-
}
|
|
6097
|
-
}
|
|
6098
|
-
}
|
|
6099
|
-
}
|
|
6100
|
-
}
|
|
6101
|
-
},
|
|
6102
|
-
"401": {
|
|
6103
|
-
"$ref": "#/components/responses/Unauthorized"
|
|
6104
|
-
},
|
|
6105
|
-
"403": {
|
|
6106
|
-
"$ref": "#/components/responses/ForbiddenByRule"
|
|
6107
|
-
},
|
|
6108
|
-
"404": {
|
|
6109
|
-
"$ref": "#/components/responses/NotFound"
|
|
6110
|
-
},
|
|
6111
|
-
"500": {
|
|
6112
|
-
"$ref": "#/components/responses/InternalServerError"
|
|
6113
|
-
}
|
|
6114
|
-
}
|
|
6115
6117
|
}
|
|
6116
6118
|
},
|
|
6117
6119
|
"/v2/portal/contract/by-identifiers": {
|
|
@@ -15479,9 +15481,18 @@
|
|
|
15479
15481
|
"type": "string",
|
|
15480
15482
|
"description": "Identifier of the hook."
|
|
15481
15483
|
},
|
|
15484
|
+
"change_mode": {
|
|
15485
|
+
"type": "string",
|
|
15486
|
+
"enum": [
|
|
15487
|
+
"synchronous",
|
|
15488
|
+
"asynchronous"
|
|
15489
|
+
],
|
|
15490
|
+
"description": "Whether the third-party system applies the email change immediately (`synchronous`) or takes it over entirely (`asynchronous`).\nIn synchronous mode the login email is changed as soon as the request succeeds and the portal user has to sign in again with the new address.\n",
|
|
15491
|
+
"default": "asynchronous"
|
|
15492
|
+
},
|
|
15482
15493
|
"require_password_confirmation": {
|
|
15483
15494
|
"type": "boolean",
|
|
15484
|
-
"description": "Whether the portal user must confirm their current password before the email change is handed over to the third-party system
|
|
15495
|
+
"description": "Whether the portal user must confirm their current password before the email change is handed over to the third-party system.\nAlso required when `change_mode` is `synchronous`, except for portal users whose identity is managed by an identity provider - an SSO login has no password to confirm.\n",
|
|
15485
15496
|
"default": true
|
|
15486
15497
|
},
|
|
15487
15498
|
"explanation": {
|
|
@@ -16801,7 +16812,7 @@
|
|
|
16801
16812
|
]
|
|
16802
16813
|
},
|
|
16803
16814
|
"ExtensionHookChangeEmail": {
|
|
16804
|
-
"description": "Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not
|
|
16815
|
+
"description": "Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not run its own change email flow. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change.\nThe `change_mode` controls what the portal does after the call:\n - `asynchronous`: The third-party system takes the email change over entirely (most likely by sending the user instructions to confirm the new email address). The portal does not change the login email itself.\n - `synchronous`: The third-party system applies the email change immediately. The portal waits for a successful (2xx) response and then also changes the portal user's login email right away, without sending a confirmation email. The user has to sign in again with the new email address afterwards.\n\nThe expected response http status code to the call is:\n - 2xx if the request was accepted\n - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)\n",
|
|
16805
16816
|
"type": "object",
|
|
16806
16817
|
"properties": {
|
|
16807
16818
|
"type": {
|
|
@@ -16810,9 +16821,18 @@
|
|
|
16810
16821
|
"changeEmail"
|
|
16811
16822
|
]
|
|
16812
16823
|
},
|
|
16824
|
+
"change_mode": {
|
|
16825
|
+
"type": "string",
|
|
16826
|
+
"enum": [
|
|
16827
|
+
"synchronous",
|
|
16828
|
+
"asynchronous"
|
|
16829
|
+
],
|
|
16830
|
+
"description": "Controls how the email change is handled once the third-party system accepted it. `asynchronous` hands the email change over entirely to the third-party system and the portal does not change the login email itself. `synchronous` waits for the third-party system to respond and then changes the portal user's login email immediately, without a confirmation email.\n",
|
|
16831
|
+
"default": "asynchronous"
|
|
16832
|
+
},
|
|
16813
16833
|
"require_password_confirmation": {
|
|
16814
16834
|
"type": "boolean",
|
|
16815
|
-
"description": "Whether the portal user must confirm their current password before the change email request is handed over to the third-party system. When true, the portal collects and verifies the current password before calling the hook.\n",
|
|
16835
|
+
"description": "Whether the portal user must confirm their current password before the change email request is handed over to the third-party system. When true, the portal collects and verifies the current password before calling the hook. Treated as true when `change_mode` is `synchronous`, since the portal re-creates the login with the confirmed password. Skipped either way for portal users whose identity is managed by an identity provider: an SSO login has no password to confirm.\n",
|
|
16816
16836
|
"default": true
|
|
16817
16837
|
},
|
|
16818
16838
|
"explanation": {
|
|
@@ -16987,7 +17007,7 @@
|
|
|
16987
17007
|
]
|
|
16988
17008
|
},
|
|
16989
17009
|
"ExtensionHookDeleteAccount": {
|
|
16990
|
-
"description": "Hook that replaces the built-in delete account functionality for portal users. When configured, the portal does not delete the user itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the deletion.\nThe `deletion_mode` controls what the portal does after the call:\n - `synchronous`: The third-party system deletes the user immediately. The portal waits for a successful (2xx) response and then also deletes the epilot user.\n - `asynchronous`: The third-party system handles deletion out-of-band. The portal does not delete anything immediately; cleanup is expected to happen later (e.g. via the user deletion API or webhooks).\n\nThe expected response http status code to the call is:\n - 2xx if the request was accepted\n - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)\n",
|
|
17010
|
+
"description": "Hook that replaces the built-in delete account functionality for portal users. When configured, the portal does not delete the user itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the deletion.\nThe `deletion_mode` controls what the portal does after the call:\n - `synchronous`: The third-party system deletes the user immediately. The portal waits for a successful (2xx) response and then also deletes the epilot user.\n - `asynchronous`: The third-party system handles deletion out-of-band. The portal does not delete anything immediately; cleanup is expected to happen later (e.g. via the user deletion API or webhooks).\n\nThe optional `delete_contact` additionally deletes the contact related to the portal user, once the portal user itself was deleted (`synchronous` mode only).\n\nThe expected response http status code to the call is:\n - 2xx if the request was accepted\n - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)\n",
|
|
16991
17011
|
"type": "object",
|
|
16992
17012
|
"properties": {
|
|
16993
17013
|
"type": {
|
|
@@ -17005,6 +17025,16 @@
|
|
|
17005
17025
|
"description": "Controls how the account deletion is handled. `synchronous` waits for the third-party system to respond and then also deletes the epilot user. `asynchronous` hands the deletion over entirely to the third-party system and the portal does not delete anything immediately.\n",
|
|
17006
17026
|
"default": "synchronous"
|
|
17007
17027
|
},
|
|
17028
|
+
"delete_contact": {
|
|
17029
|
+
"type": "string",
|
|
17030
|
+
"enum": [
|
|
17031
|
+
"none",
|
|
17032
|
+
"soft",
|
|
17033
|
+
"hard"
|
|
17034
|
+
],
|
|
17035
|
+
"description": "Opt-in deletion of the contact related to the portal user, applied after the portal user itself was deleted. `none` (default) leaves the contact untouched. `soft` deletes the contact, so it can still be restored from the trash. `hard` permanently purges the contact. Only applied in `synchronous` deletion mode, as `asynchronous` mode hands the cleanup over to the third-party system.\n",
|
|
17036
|
+
"default": "none"
|
|
17037
|
+
},
|
|
17008
17038
|
"explanation": {
|
|
17009
17039
|
"type": "object",
|
|
17010
17040
|
"properties": {
|
|
@@ -17377,7 +17407,7 @@
|
|
|
17377
17407
|
"type": "string",
|
|
17378
17408
|
"example": "office-365-login",
|
|
17379
17409
|
"description": "URL-friendly slug to use as organization-unique identifier for Provider",
|
|
17380
|
-
"pattern": "[0-9a-
|
|
17410
|
+
"pattern": "[0-9a-z_-]+"
|
|
17381
17411
|
},
|
|
17382
17412
|
"ProviderDisplayName": {
|
|
17383
17413
|
"type": "string",
|