@epilot/customer-portal-client 0.39.10 → 0.39.12

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.
@@ -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":{}}},"/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/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={438(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(466));r.default=n.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v1/portal/exports":{"post":{"operationId":"createExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/exports/{jobId}":{"get":{"operationId":"getExport","parameters":[{"in":"path","name":"jobId","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/visualization/metadata":{"get":{"operationId":"getVisualizationMetadata","parameters":[{"in":"query","name":"app_id","required":true},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates:migrate-references":{"post":{"operationId":"migrateEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates:list-references":{"post":{"operationId":"listEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates/{portal_id}":{"post":{"operationId":"upsertEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/public-widgets":{"get":{"operationId":"getPublicPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/widgets":{"get":{"operationId":"getPublicPortalWidgetsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"responses":{}}},"/v3/portal/widgets":{"get":{"operationId":"getPortalWidgetsV3","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"contract_id","required":false}],"responses":{}},"post":{"operationId":"upsertPortalWidgetV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/portal/files":{"post":{"operationId":"savePortalFilesV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","deprecated":true,"responses":{}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","responses":{}}},"/v2/portal/public/schemas":{"get":{"operationId":"getSchemasByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v3/portal/public/schemas":{"get":{"operationId":"getPublicSchemasV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/org/settings":{"get":{"operationId":"getOrganizationSettingsByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","responses":{}}},"/v2/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecords","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecordsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/contact":{"get":{"operationId":"getContact","responses":{}},"patch":{"operationId":"updateContact","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","parameters":[{"in":"query","name":"id","required":true}],"responses":{}}},"/v2/portal/public/contact/exists":{"post":{"operationId":"checkContactExists","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/contact/exists":{"post":{"operationId":"checkContactExistsV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/account/exists":{"post":{"operationId":"checkAccountExists","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","responses":{}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","responses":{}},"patch":{"operationId":"updatePortalUser","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalUser","responses":{}}},"/v2/portal/user/update/email":{"put":{"operationId":"updatePortalUserEmail","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/change/password":{"put":{"operationId":"changePortalUserPassword","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/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})})();
@@ -128,6 +128,31 @@
128
128
  "responses": {}
129
129
  }
130
130
  },
131
+ "/v1/portal/exports": {
132
+ "post": {
133
+ "operationId": "createExport",
134
+ "requestBody": {
135
+ "required": true,
136
+ "content": {
137
+ "application/json": {}
138
+ }
139
+ },
140
+ "responses": {}
141
+ }
142
+ },
143
+ "/v1/portal/exports/{jobId}": {
144
+ "get": {
145
+ "operationId": "getExport",
146
+ "parameters": [
147
+ {
148
+ "in": "path",
149
+ "name": "jobId",
150
+ "required": true
151
+ }
152
+ ],
153
+ "responses": {}
154
+ }
155
+ },
131
156
  "/v2/portal/extensions": {
132
157
  "get": {
133
158
  "operationId": "getPortalExtensions",
package/dist/openapi.d.ts CHANGED
@@ -928,6 +928,10 @@ declare namespace Components {
928
928
  campaign_id?: string;
929
929
  }
930
930
  export interface CommonConfigAttributes {
931
+ /**
932
+ * Mobile app configuration (top-level; moved out of the config blob).
933
+ */
934
+ mobile_config?: /* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here. */ MobileConfig;
931
935
  /**
932
936
  * Enable/Disable the portal access
933
937
  */
@@ -1166,6 +1170,12 @@ declare namespace Components {
1166
1170
  * true
1167
1171
  */
1168
1172
  require_symbols?: boolean;
1173
+ /**
1174
+ * Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
1175
+ * example:
1176
+ * 3
1177
+ */
1178
+ password_history_size?: number;
1169
1179
  };
1170
1180
  };
1171
1181
  /**
@@ -1445,6 +1455,10 @@ declare namespace Components {
1445
1455
  };
1446
1456
  }
1447
1457
  export interface CommonConfigAttributesV3 {
1458
+ /**
1459
+ * Mobile app configuration (top-level; moved out of the config blob).
1460
+ */
1461
+ mobile_config?: /* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here. */ MobileConfig;
1448
1462
  /**
1449
1463
  * Enable/Disable the portal access
1450
1464
  */
@@ -1683,6 +1697,12 @@ declare namespace Components {
1683
1697
  * true
1684
1698
  */
1685
1699
  require_symbols?: boolean;
1700
+ /**
1701
+ * Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
1702
+ * example:
1703
+ * 3
1704
+ */
1705
+ password_history_size?: number;
1686
1706
  };
1687
1707
  };
1688
1708
  /**
@@ -5926,6 +5946,7 @@ declare namespace Components {
5926
5946
  };
5927
5947
  }
5928
5948
  export interface PortalConfig {
5949
+ mobile_config?: /* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here. */ MobileConfig;
5929
5950
  /**
5930
5951
  * Enable/Disable the portal access
5931
5952
  */
@@ -6161,6 +6182,12 @@ declare namespace Components {
6161
6182
  * true
6162
6183
  */
6163
6184
  require_symbols?: boolean;
6185
+ /**
6186
+ * Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
6187
+ * example:
6188
+ * 3
6189
+ */
6190
+ password_history_size?: number;
6164
6191
  };
6165
6192
  };
6166
6193
  /**
@@ -6538,6 +6565,7 @@ declare namespace Components {
6538
6565
  *
6539
6566
  */
6540
6567
  identity_providers?: ProviderPublicConfig[];
6568
+ mobile_config?: /* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here. */ MobileConfig;
6541
6569
  /**
6542
6570
  * Enable/Disable the portal access
6543
6571
  */
@@ -6773,6 +6801,12 @@ declare namespace Components {
6773
6801
  * true
6774
6802
  */
6775
6803
  require_symbols?: boolean;
6804
+ /**
6805
+ * Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
6806
+ * example:
6807
+ * 3
6808
+ */
6809
+ password_history_size?: number;
6776
6810
  };
6777
6811
  };
6778
6812
  /**
@@ -7088,6 +7122,63 @@ declare namespace Components {
7088
7122
  grants?: Grant[];
7089
7123
  pages?: Page[];
7090
7124
  }
7125
+ /**
7126
+ * One column of the portal data export CSV.
7127
+ */
7128
+ export interface PortalDataExportColumn {
7129
+ /**
7130
+ * Stable, immutable column id (snake_case). Append-only contract: never rename, reorder semantics, or remove an existing key; new columns are appended.
7131
+ *
7132
+ * example:
7133
+ * vertragsnummer
7134
+ */
7135
+ key: string;
7136
+ /**
7137
+ * Localized header label, keyed by language (de, en).
7138
+ * example:
7139
+ * {
7140
+ * "de": "Vertragsnummer",
7141
+ * "en": "Contract number"
7142
+ * }
7143
+ */
7144
+ header: {
7145
+ [name: string]: string;
7146
+ };
7147
+ /**
7148
+ * Where the value comes from: relation hops from the anchor entity plus the attribute to read on the resolved entity. An empty path means the anchor itself.
7149
+ *
7150
+ */
7151
+ source: {
7152
+ /**
7153
+ * Relation hops from the anchor entity (max 3).
7154
+ * example:
7155
+ * [
7156
+ * "customer"
7157
+ * ]
7158
+ */
7159
+ path?: string[];
7160
+ /**
7161
+ * Attribute to read on the resolved entity.
7162
+ * example:
7163
+ * customer_number
7164
+ */
7165
+ attribute: string;
7166
+ /**
7167
+ * Which part of an address-typed attribute to render.
7168
+ */
7169
+ address_field?: "full" | "street" | "street_number" | "postal_code" | "city" | "additional_info" | "country";
7170
+ };
7171
+ formatter?: "text" | "date" | "money_cents" | "enum" | "address";
7172
+ /**
7173
+ * Localized value maps for the enum formatter, keyed by language then raw value.
7174
+ *
7175
+ */
7176
+ enum_labels?: {
7177
+ [name: string]: {
7178
+ [name: string]: string;
7179
+ };
7180
+ };
7181
+ }
7091
7182
  /**
7092
7183
  * ID of the portal
7093
7184
  * example:
@@ -8036,6 +8127,7 @@ declare namespace Components {
8036
8127
  *
8037
8128
  */
8038
8129
  ProviderConfig[];
8130
+ mobile_config?: /* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here. */ MobileConfig;
8039
8131
  /**
8040
8132
  * Enable/Disable the portal access
8041
8133
  */
@@ -8271,6 +8363,12 @@ declare namespace Components {
8271
8363
  * true
8272
8364
  */
8273
8365
  require_symbols?: boolean;
8366
+ /**
8367
+ * Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
8368
+ * example:
8369
+ * 3
8370
+ */
8371
+ password_history_size?: number;
8274
8372
  };
8275
8373
  };
8276
8374
  /**
@@ -8616,6 +8714,7 @@ declare namespace Components {
8616
8714
  *
8617
8715
  */
8618
8716
  ProviderConfig[];
8717
+ mobile_config?: /* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here. */ MobileConfig;
8619
8718
  /**
8620
8719
  * Enable/Disable the portal access
8621
8720
  */
@@ -8851,6 +8950,12 @@ declare namespace Components {
8851
8950
  * true
8852
8951
  */
8853
8952
  require_symbols?: boolean;
8953
+ /**
8954
+ * Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
8955
+ * example:
8956
+ * 3
8957
+ */
8958
+ password_history_size?: number;
8854
8959
  };
8855
8960
  };
8856
8961
  /**
@@ -9739,6 +9844,45 @@ declare namespace Paths {
9739
9844
  export type $500 = Components.Responses.InternalServerError;
9740
9845
  }
9741
9846
  }
9847
+ namespace CreateExport {
9848
+ export interface RequestBody {
9849
+ /**
9850
+ * Entity schema to export (must be an allowed portal entity).
9851
+ */
9852
+ schema: string;
9853
+ /**
9854
+ * Search parameters, same shape the entity list queries with.
9855
+ */
9856
+ search?: {
9857
+ q?: string;
9858
+ q_fields?: string[];
9859
+ filters?: {
9860
+ [key: string]: any;
9861
+ }[];
9862
+ filters_context?: {
9863
+ [key: string]: any;
9864
+ }[];
9865
+ sort?: any;
9866
+ };
9867
+ /**
9868
+ * Ordered column definitions; order is the CSV column order.
9869
+ */
9870
+ columns: /* One column of the portal data export CSV. */ Components.Schemas.PortalDataExportColumn[];
9871
+ expand_over?: string;
9872
+ language?: "de" | "en";
9873
+ }
9874
+ namespace Responses {
9875
+ export interface $202 {
9876
+ jobId?: string;
9877
+ status?: "queued" | "running" | "ready" | "failed";
9878
+ }
9879
+ export type $401 = Components.Responses.Unauthorized;
9880
+ export type $403 = Components.Responses.Forbidden;
9881
+ export interface $404 {
9882
+ }
9883
+ export type $500 = Components.Responses.InternalServerError;
9884
+ }
9885
+ }
9742
9886
  namespace CreateMeterReading {
9743
9887
  namespace Parameters {
9744
9888
  export type OverridePlausibility = boolean;
@@ -11304,6 +11448,26 @@ declare namespace Paths {
11304
11448
  export type $500 = Components.Responses.InternalServerError;
11305
11449
  }
11306
11450
  }
11451
+ namespace GetExport {
11452
+ namespace Parameters {
11453
+ export type JobId = string;
11454
+ }
11455
+ export interface PathParameters {
11456
+ jobId: Parameters.JobId;
11457
+ }
11458
+ namespace Responses {
11459
+ export interface $200 {
11460
+ jobId?: string;
11461
+ status?: "queued" | "running" | "ready" | "failed" | "expired";
11462
+ downloadUrl?: string;
11463
+ error?: string;
11464
+ }
11465
+ export type $401 = Components.Responses.Unauthorized;
11466
+ export interface $404 {
11467
+ }
11468
+ export type $500 = Components.Responses.InternalServerError;
11469
+ }
11470
+ }
11307
11471
  namespace GetExternalLinks {
11308
11472
  namespace Parameters {
11309
11473
  export type ContactId = /**
@@ -11628,6 +11792,7 @@ declare namespace Paths {
11628
11792
  }
11629
11793
  namespace Responses {
11630
11794
  export interface $200 {
11795
+ mobile_config?: /* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here. */ Components.Schemas.MobileConfig;
11631
11796
  /**
11632
11797
  * Enable/Disable the portal access
11633
11798
  */
@@ -11863,6 +12028,12 @@ declare namespace Paths {
11863
12028
  * true
11864
12029
  */
11865
12030
  require_symbols?: boolean;
12031
+ /**
12032
+ * Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
12033
+ * example:
12034
+ * 3
12035
+ */
12036
+ password_history_size?: number;
11866
12037
  };
11867
12038
  };
11868
12039
  /**
@@ -12239,6 +12410,7 @@ declare namespace Paths {
12239
12410
  }
12240
12411
  namespace Responses {
12241
12412
  export interface $200 {
12413
+ mobile_config?: /* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here. */ Components.Schemas.MobileConfig;
12242
12414
  /**
12243
12415
  * Enable/Disable the portal access
12244
12416
  */
@@ -12474,6 +12646,12 @@ declare namespace Paths {
12474
12646
  * true
12475
12647
  */
12476
12648
  require_symbols?: boolean;
12649
+ /**
12650
+ * Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
12651
+ * example:
12652
+ * 3
12653
+ */
12654
+ password_history_size?: number;
12477
12655
  };
12478
12656
  };
12479
12657
  /**
@@ -14442,6 +14620,10 @@ declare namespace Paths {
14442
14620
  */
14443
14621
  Components.Schemas.EntityId /* uuid */;
14444
14622
  is_main_entity?: boolean;
14623
+ /**
14624
+ * The email address registered in the journey's Login & Registration block
14625
+ */
14626
+ journey_registration_email?: string;
14445
14627
  };
14446
14628
  };
14447
14629
  }
@@ -15801,6 +15983,27 @@ export interface OperationMethods {
15801
15983
  data?: any,
15802
15984
  config?: AxiosRequestConfig
15803
15985
  ): OperationResponse<Paths.DeletePortal.Responses.$204>
15986
+ /**
15987
+ * createExport - createExport
15988
+ *
15989
+ * Request an asynchronous CSV export of the portal user's entities for one schema. Columns come from the request Returns a job id to poll.
15990
+ *
15991
+ */
15992
+ 'createExport'(
15993
+ parameters?: Parameters<UnknownParamsObject> | null,
15994
+ data?: Paths.CreateExport.RequestBody,
15995
+ config?: AxiosRequestConfig
15996
+ ): OperationResponse<Paths.CreateExport.Responses.$202>
15997
+ /**
15998
+ * getExport - getExport
15999
+ *
16000
+ * Get the status of an export job, including the download URL once ready.
16001
+ */
16002
+ 'getExport'(
16003
+ parameters?: Parameters<Paths.GetExport.PathParameters> | null,
16004
+ data?: any,
16005
+ config?: AxiosRequestConfig
16006
+ ): OperationResponse<Paths.GetExport.Responses.$200>
15804
16007
  /**
15805
16008
  * getPortalExtensions - getPortalExtensions
15806
16009
  *
@@ -17482,6 +17685,31 @@ export interface PathsDictionary {
17482
17685
  config?: AxiosRequestConfig
17483
17686
  ): OperationResponse<Paths.DeletePortal.Responses.$204>
17484
17687
  }
17688
+ ['/v1/portal/exports']: {
17689
+ /**
17690
+ * createExport - createExport
17691
+ *
17692
+ * Request an asynchronous CSV export of the portal user's entities for one schema. Columns come from the request Returns a job id to poll.
17693
+ *
17694
+ */
17695
+ 'post'(
17696
+ parameters?: Parameters<UnknownParamsObject> | null,
17697
+ data?: Paths.CreateExport.RequestBody,
17698
+ config?: AxiosRequestConfig
17699
+ ): OperationResponse<Paths.CreateExport.Responses.$202>
17700
+ }
17701
+ ['/v1/portal/exports/{jobId}']: {
17702
+ /**
17703
+ * getExport - getExport
17704
+ *
17705
+ * Get the status of an export job, including the download URL once ready.
17706
+ */
17707
+ 'get'(
17708
+ parameters?: Parameters<Paths.GetExport.PathParameters> | null,
17709
+ data?: any,
17710
+ config?: AxiosRequestConfig
17711
+ ): OperationResponse<Paths.GetExport.Responses.$200>
17712
+ }
17485
17713
  ['/v2/portal/extensions']: {
17486
17714
  /**
17487
17715
  * getPortalExtensions - getPortalExtensions
@@ -19434,6 +19662,7 @@ export type PageRequest = Components.Schemas.PageRequest;
19434
19662
  export type PaymentWidget = Components.Schemas.PaymentWidget;
19435
19663
  export type PortalConfig = Components.Schemas.PortalConfig;
19436
19664
  export type PortalConfigV3 = Components.Schemas.PortalConfigV3;
19665
+ export type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
19437
19666
  export type PortalId = Components.Schemas.PortalId;
19438
19667
  export type PortalUser = Components.Schemas.PortalUser;
19439
19668
  export type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/customer-portal-client",
3
- "version": "0.39.10",
3
+ "version": "0.39.12",
4
4
  "description": "API Client for epilot portal API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -18,18 +18,6 @@
18
18
  "sdk",
19
19
  "customer-portal"
20
20
  ],
21
- "scripts": {
22
- "test": "vitest",
23
- "typescript": "tsc",
24
- "bundle-definition": "webpack",
25
- "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/customer-portal.yaml",
26
- "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
27
- "build": "tsc && npm run build:patch && npm run bundle-definition",
28
- "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
29
- "build:watch": "npm run build && tsc -w",
30
- "prepublishOnly": "npm run typegen && npm run build",
31
- "lint": "biome check src"
32
- },
33
21
  "files": [
34
22
  "*.js",
35
23
  "*.d.ts",
@@ -67,5 +55,16 @@
67
55
  "typescript": "^4.1.3",
68
56
  "webpack": "^5.18.0",
69
57
  "webpack-cli": "^4.4.0"
58
+ },
59
+ "scripts": {
60
+ "test": "vitest",
61
+ "typescript": "tsc",
62
+ "bundle-definition": "webpack",
63
+ "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/customer-portal.yaml",
64
+ "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
65
+ "build": "tsc && npm run build:patch && npm run bundle-definition",
66
+ "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
67
+ "build:watch": "npm run build && tsc -w",
68
+ "lint": "biome check src"
70
69
  }
71
- }
70
+ }
@@ -128,6 +128,31 @@
128
128
  "responses": {}
129
129
  }
130
130
  },
131
+ "/v1/portal/exports": {
132
+ "post": {
133
+ "operationId": "createExport",
134
+ "requestBody": {
135
+ "required": true,
136
+ "content": {
137
+ "application/json": {}
138
+ }
139
+ },
140
+ "responses": {}
141
+ }
142
+ },
143
+ "/v1/portal/exports/{jobId}": {
144
+ "get": {
145
+ "operationId": "getExport",
146
+ "parameters": [
147
+ {
148
+ "in": "path",
149
+ "name": "jobId",
150
+ "required": true
151
+ }
152
+ ],
153
+ "responses": {}
154
+ }
155
+ },
131
156
  "/v2/portal/extensions": {
132
157
  "get": {
133
158
  "operationId": "getPortalExtensions",
package/src/openapi.json CHANGED
@@ -480,6 +480,192 @@
480
480
  }
481
481
  }
482
482
  },
483
+ "/v1/portal/exports": {
484
+ "post": {
485
+ "operationId": "createExport",
486
+ "summary": "createExport",
487
+ "description": "Request an asynchronous CSV export of the portal user's entities for one schema. Columns come from the request Returns a job id to poll.\n",
488
+ "tags": [
489
+ "ECP"
490
+ ],
491
+ "requestBody": {
492
+ "required": true,
493
+ "content": {
494
+ "application/json": {
495
+ "schema": {
496
+ "type": "object",
497
+ "required": [
498
+ "schema",
499
+ "columns"
500
+ ],
501
+ "properties": {
502
+ "schema": {
503
+ "type": "string",
504
+ "description": "Entity schema to export (must be an allowed portal entity)."
505
+ },
506
+ "search": {
507
+ "type": "object",
508
+ "description": "Search parameters, same shape the entity list queries with.",
509
+ "properties": {
510
+ "q": {
511
+ "type": "string"
512
+ },
513
+ "q_fields": {
514
+ "type": "array",
515
+ "items": {
516
+ "type": "string"
517
+ }
518
+ },
519
+ "filters": {
520
+ "type": "array",
521
+ "items": {
522
+ "type": "object"
523
+ }
524
+ },
525
+ "filters_context": {
526
+ "type": "array",
527
+ "items": {
528
+ "type": "object"
529
+ }
530
+ },
531
+ "sort": {}
532
+ }
533
+ },
534
+ "columns": {
535
+ "type": "array",
536
+ "description": "Ordered column definitions; order is the CSV column order.",
537
+ "items": {
538
+ "$ref": "#/components/schemas/PortalDataExportColumn"
539
+ }
540
+ },
541
+ "expand_over": {
542
+ "type": "string"
543
+ },
544
+ "language": {
545
+ "type": "string",
546
+ "enum": [
547
+ "de",
548
+ "en"
549
+ ]
550
+ }
551
+ }
552
+ }
553
+ }
554
+ }
555
+ },
556
+ "security": [
557
+ {
558
+ "PortalAuth": []
559
+ }
560
+ ],
561
+ "responses": {
562
+ "202": {
563
+ "description": "Export job accepted.",
564
+ "content": {
565
+ "application/json": {
566
+ "schema": {
567
+ "type": "object",
568
+ "properties": {
569
+ "jobId": {
570
+ "type": "string"
571
+ },
572
+ "status": {
573
+ "type": "string",
574
+ "enum": [
575
+ "queued",
576
+ "running",
577
+ "ready",
578
+ "failed"
579
+ ]
580
+ }
581
+ }
582
+ }
583
+ }
584
+ }
585
+ },
586
+ "401": {
587
+ "$ref": "#/components/responses/Unauthorized"
588
+ },
589
+ "403": {
590
+ "$ref": "#/components/responses/Forbidden"
591
+ },
592
+ "404": {
593
+ "description": "Missing or invalid export columns."
594
+ },
595
+ "500": {
596
+ "$ref": "#/components/responses/InternalServerError"
597
+ }
598
+ }
599
+ }
600
+ },
601
+ "/v1/portal/exports/{jobId}": {
602
+ "get": {
603
+ "operationId": "getExport",
604
+ "summary": "getExport",
605
+ "description": "Get the status of an export job, including the download URL once ready.",
606
+ "tags": [
607
+ "ECP"
608
+ ],
609
+ "parameters": [
610
+ {
611
+ "in": "path",
612
+ "name": "jobId",
613
+ "required": true,
614
+ "schema": {
615
+ "type": "string"
616
+ },
617
+ "description": "The export job id returned by createExport."
618
+ }
619
+ ],
620
+ "security": [
621
+ {
622
+ "PortalAuth": []
623
+ }
624
+ ],
625
+ "responses": {
626
+ "200": {
627
+ "description": "Export job status.",
628
+ "content": {
629
+ "application/json": {
630
+ "schema": {
631
+ "type": "object",
632
+ "properties": {
633
+ "jobId": {
634
+ "type": "string"
635
+ },
636
+ "status": {
637
+ "type": "string",
638
+ "enum": [
639
+ "queued",
640
+ "running",
641
+ "ready",
642
+ "failed",
643
+ "expired"
644
+ ]
645
+ },
646
+ "downloadUrl": {
647
+ "type": "string"
648
+ },
649
+ "error": {
650
+ "type": "string"
651
+ }
652
+ }
653
+ }
654
+ }
655
+ }
656
+ },
657
+ "401": {
658
+ "$ref": "#/components/responses/Unauthorized"
659
+ },
660
+ "404": {
661
+ "description": "Export job not found."
662
+ },
663
+ "500": {
664
+ "$ref": "#/components/responses/InternalServerError"
665
+ }
666
+ }
667
+ }
668
+ },
483
669
  "/v2/portal/extensions": {
484
670
  "get": {
485
671
  "operationId": "getPortalExtensions",
@@ -2929,6 +3115,10 @@
2929
3115
  },
2930
3116
  "is_main_entity": {
2931
3117
  "type": "boolean"
3118
+ },
3119
+ "journey_registration_email": {
3120
+ "type": "string",
3121
+ "description": "The email address registered in the journey's Login & Registration block"
2932
3122
  }
2933
3123
  }
2934
3124
  }
@@ -11624,6 +11814,10 @@
11624
11814
  "CommonConfigAttributes": {
11625
11815
  "type": "object",
11626
11816
  "properties": {
11817
+ "mobile_config": {
11818
+ "description": "Mobile app configuration (top-level; moved out of the config blob).",
11819
+ "$ref": "#/components/schemas/MobileConfig"
11820
+ },
11627
11821
  "enabled": {
11628
11822
  "type": "boolean",
11629
11823
  "description": "Enable/Disable the portal access"
@@ -11869,6 +12063,13 @@
11869
12063
  "type": "boolean",
11870
12064
  "example": true,
11871
12065
  "description": "Require symbols"
12066
+ },
12067
+ "password_history_size": {
12068
+ "type": "integer",
12069
+ "minimum": 0,
12070
+ "maximum": 24,
12071
+ "example": 3,
12072
+ "description": "Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan."
11872
12073
  }
11873
12074
  }
11874
12075
  }
@@ -17814,6 +18015,10 @@
17814
18015
  "CommonConfigAttributesV3": {
17815
18016
  "type": "object",
17816
18017
  "properties": {
18018
+ "mobile_config": {
18019
+ "description": "Mobile app configuration (top-level; moved out of the config blob).",
18020
+ "$ref": "#/components/schemas/MobileConfig"
18021
+ },
17817
18022
  "enabled": {
17818
18023
  "type": "boolean",
17819
18024
  "description": "Enable/Disable the portal access"
@@ -18059,6 +18264,13 @@
18059
18264
  "type": "boolean",
18060
18265
  "example": true,
18061
18266
  "description": "Require symbols"
18267
+ },
18268
+ "password_history_size": {
18269
+ "type": "integer",
18270
+ "minimum": 0,
18271
+ "maximum": 24,
18272
+ "example": 3,
18273
+ "description": "Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan."
18062
18274
  }
18063
18275
  }
18064
18276
  }
@@ -18375,6 +18587,90 @@
18375
18587
  "description": "ID of the portal",
18376
18588
  "example": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
18377
18589
  },
18590
+ "PortalDataExportColumn": {
18591
+ "type": "object",
18592
+ "description": "One column of the portal data export CSV.",
18593
+ "required": [
18594
+ "key",
18595
+ "header",
18596
+ "source"
18597
+ ],
18598
+ "properties": {
18599
+ "key": {
18600
+ "type": "string",
18601
+ "description": "Stable, immutable column id (snake_case). Append-only contract: never rename, reorder semantics, or remove an existing key; new columns are appended.\n",
18602
+ "example": "vertragsnummer"
18603
+ },
18604
+ "header": {
18605
+ "type": "object",
18606
+ "description": "Localized header label, keyed by language (de, en).",
18607
+ "additionalProperties": {
18608
+ "type": "string"
18609
+ },
18610
+ "example": {
18611
+ "de": "Vertragsnummer",
18612
+ "en": "Contract number"
18613
+ }
18614
+ },
18615
+ "source": {
18616
+ "type": "object",
18617
+ "description": "Where the value comes from: relation hops from the anchor entity plus the attribute to read on the resolved entity. An empty path means the anchor itself.\n",
18618
+ "required": [
18619
+ "attribute"
18620
+ ],
18621
+ "properties": {
18622
+ "path": {
18623
+ "type": "array",
18624
+ "description": "Relation hops from the anchor entity (max 3).",
18625
+ "items": {
18626
+ "type": "string"
18627
+ },
18628
+ "example": [
18629
+ "customer"
18630
+ ]
18631
+ },
18632
+ "attribute": {
18633
+ "type": "string",
18634
+ "description": "Attribute to read on the resolved entity.",
18635
+ "example": "customer_number"
18636
+ },
18637
+ "address_field": {
18638
+ "type": "string",
18639
+ "description": "Which part of an address-typed attribute to render.",
18640
+ "enum": [
18641
+ "full",
18642
+ "street",
18643
+ "street_number",
18644
+ "postal_code",
18645
+ "city",
18646
+ "additional_info",
18647
+ "country"
18648
+ ]
18649
+ }
18650
+ }
18651
+ },
18652
+ "formatter": {
18653
+ "type": "string",
18654
+ "enum": [
18655
+ "text",
18656
+ "date",
18657
+ "money_cents",
18658
+ "enum",
18659
+ "address"
18660
+ ]
18661
+ },
18662
+ "enum_labels": {
18663
+ "type": "object",
18664
+ "description": "Localized value maps for the enum formatter, keyed by language then raw value.\n",
18665
+ "additionalProperties": {
18666
+ "type": "object",
18667
+ "additionalProperties": {
18668
+ "type": "string"
18669
+ }
18670
+ }
18671
+ }
18672
+ }
18673
+ },
18378
18674
  "UpsertPortalConfigV3": {
18379
18675
  "allOf": [
18380
18676
  {