@epilot/customer-portal-client 0.39.11 → 0.39.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +22 -6
- package/dist/openapi.d.ts +336 -11
- package/package.json +1 -1
- package/src/openapi-runtime.json +22 -6
- package/src/openapi.json +283 -16
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","parameters":[{"in":"query","name":"language","required":false}],"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})})();
|
|
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})})();
|
|
@@ -131,13 +131,12 @@
|
|
|
131
131
|
"/v1/portal/exports": {
|
|
132
132
|
"post": {
|
|
133
133
|
"operationId": "createExport",
|
|
134
|
-
"
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
"
|
|
138
|
-
"required": false
|
|
134
|
+
"requestBody": {
|
|
135
|
+
"required": true,
|
|
136
|
+
"content": {
|
|
137
|
+
"application/json": {}
|
|
139
138
|
}
|
|
140
|
-
|
|
139
|
+
},
|
|
141
140
|
"responses": {}
|
|
142
141
|
}
|
|
143
142
|
},
|
|
@@ -1424,6 +1423,23 @@
|
|
|
1424
1423
|
],
|
|
1425
1424
|
"responses": {}
|
|
1426
1425
|
},
|
|
1426
|
+
"post": {
|
|
1427
|
+
"operationId": "getContractWithTemplates",
|
|
1428
|
+
"parameters": [
|
|
1429
|
+
{
|
|
1430
|
+
"in": "path",
|
|
1431
|
+
"name": "id",
|
|
1432
|
+
"required": true
|
|
1433
|
+
}
|
|
1434
|
+
],
|
|
1435
|
+
"requestBody": {
|
|
1436
|
+
"required": false,
|
|
1437
|
+
"content": {
|
|
1438
|
+
"application/json": {}
|
|
1439
|
+
}
|
|
1440
|
+
},
|
|
1441
|
+
"responses": {}
|
|
1442
|
+
},
|
|
1427
1443
|
"patch": {
|
|
1428
1444
|
"operationId": "updateContract",
|
|
1429
1445
|
"deprecated": true,
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1170,6 +1170,12 @@ declare namespace Components {
|
|
|
1170
1170
|
* true
|
|
1171
1171
|
*/
|
|
1172
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;
|
|
1173
1179
|
};
|
|
1174
1180
|
};
|
|
1175
1181
|
/**
|
|
@@ -1691,6 +1697,12 @@ declare namespace Components {
|
|
|
1691
1697
|
* true
|
|
1692
1698
|
*/
|
|
1693
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;
|
|
1694
1706
|
};
|
|
1695
1707
|
};
|
|
1696
1708
|
/**
|
|
@@ -6170,6 +6182,12 @@ declare namespace Components {
|
|
|
6170
6182
|
* true
|
|
6171
6183
|
*/
|
|
6172
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;
|
|
6173
6191
|
};
|
|
6174
6192
|
};
|
|
6175
6193
|
/**
|
|
@@ -6783,6 +6801,12 @@ declare namespace Components {
|
|
|
6783
6801
|
* true
|
|
6784
6802
|
*/
|
|
6785
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;
|
|
6786
6810
|
};
|
|
6787
6811
|
};
|
|
6788
6812
|
/**
|
|
@@ -7098,6 +7122,63 @@ declare namespace Components {
|
|
|
7098
7122
|
grants?: Grant[];
|
|
7099
7123
|
pages?: Page[];
|
|
7100
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
|
+
}
|
|
7101
7182
|
/**
|
|
7102
7183
|
* ID of the portal
|
|
7103
7184
|
* example:
|
|
@@ -8282,6 +8363,12 @@ declare namespace Components {
|
|
|
8282
8363
|
* true
|
|
8283
8364
|
*/
|
|
8284
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;
|
|
8285
8372
|
};
|
|
8286
8373
|
};
|
|
8287
8374
|
/**
|
|
@@ -8863,6 +8950,12 @@ declare namespace Components {
|
|
|
8863
8950
|
* true
|
|
8864
8951
|
*/
|
|
8865
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;
|
|
8866
8959
|
};
|
|
8867
8960
|
};
|
|
8868
8961
|
/**
|
|
@@ -9752,11 +9845,31 @@ declare namespace Paths {
|
|
|
9752
9845
|
}
|
|
9753
9846
|
}
|
|
9754
9847
|
namespace CreateExport {
|
|
9755
|
-
|
|
9756
|
-
|
|
9757
|
-
|
|
9758
|
-
|
|
9759
|
-
|
|
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";
|
|
9760
9873
|
}
|
|
9761
9874
|
namespace Responses {
|
|
9762
9875
|
export interface $202 {
|
|
@@ -11023,6 +11136,183 @@ declare namespace Paths {
|
|
|
11023
11136
|
export type $500 = Components.Responses.InternalServerError;
|
|
11024
11137
|
}
|
|
11025
11138
|
}
|
|
11139
|
+
namespace GetContractWithTemplates {
|
|
11140
|
+
namespace Parameters {
|
|
11141
|
+
export type Id = /**
|
|
11142
|
+
* Entity ID
|
|
11143
|
+
* example:
|
|
11144
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
11145
|
+
*/
|
|
11146
|
+
Components.Schemas.EntityId /* uuid */;
|
|
11147
|
+
}
|
|
11148
|
+
export interface PathParameters {
|
|
11149
|
+
id: Parameters.Id;
|
|
11150
|
+
}
|
|
11151
|
+
export interface RequestBody {
|
|
11152
|
+
/**
|
|
11153
|
+
* Map of content field name to Handlebars template string. Each template is resolved per related meter and returned as templates_output on the meter.
|
|
11154
|
+
*/
|
|
11155
|
+
templates?: {
|
|
11156
|
+
[name: string]: string;
|
|
11157
|
+
};
|
|
11158
|
+
}
|
|
11159
|
+
namespace Responses {
|
|
11160
|
+
export interface $200 {
|
|
11161
|
+
entity?: /* The contract entity */ Components.Schemas.Contract;
|
|
11162
|
+
/**
|
|
11163
|
+
* The related orders of the requested contract
|
|
11164
|
+
*/
|
|
11165
|
+
orders?: /* The order entity */ Components.Schemas.Order[];
|
|
11166
|
+
/**
|
|
11167
|
+
* The related meters of the requested contract
|
|
11168
|
+
*/
|
|
11169
|
+
meters?: {
|
|
11170
|
+
[name: string]: any;
|
|
11171
|
+
_id: /**
|
|
11172
|
+
* Entity ID
|
|
11173
|
+
* example:
|
|
11174
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
11175
|
+
*/
|
|
11176
|
+
Components.Schemas.EntityId /* uuid */;
|
|
11177
|
+
/**
|
|
11178
|
+
* Title of the entity
|
|
11179
|
+
* example:
|
|
11180
|
+
* Example Entity
|
|
11181
|
+
*/
|
|
11182
|
+
_title: string;
|
|
11183
|
+
/**
|
|
11184
|
+
* Organization ID the entity belongs to
|
|
11185
|
+
* example:
|
|
11186
|
+
* 123
|
|
11187
|
+
*/
|
|
11188
|
+
_org: string;
|
|
11189
|
+
/**
|
|
11190
|
+
* Array of entity tags
|
|
11191
|
+
* example:
|
|
11192
|
+
* [
|
|
11193
|
+
* "example",
|
|
11194
|
+
* "mock"
|
|
11195
|
+
* ]
|
|
11196
|
+
*/
|
|
11197
|
+
_tags?: string[];
|
|
11198
|
+
/**
|
|
11199
|
+
* Creation timestamp of the entity
|
|
11200
|
+
* example:
|
|
11201
|
+
* 2021-02-09T12:41:43.662Z
|
|
11202
|
+
*/
|
|
11203
|
+
_created_at: string; // date-time
|
|
11204
|
+
/**
|
|
11205
|
+
* Last update timestamp of the entity
|
|
11206
|
+
* example:
|
|
11207
|
+
* 2021-02-09T12:41:43.662Z
|
|
11208
|
+
*/
|
|
11209
|
+
_updated_at: string; // date-time
|
|
11210
|
+
/**
|
|
11211
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
11212
|
+
*/
|
|
11213
|
+
templates_output_highlighted?: {
|
|
11214
|
+
[name: string]: string | {
|
|
11215
|
+
[name: string]: string;
|
|
11216
|
+
};
|
|
11217
|
+
};
|
|
11218
|
+
/**
|
|
11219
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
11220
|
+
*/
|
|
11221
|
+
search_snippets?: {
|
|
11222
|
+
/**
|
|
11223
|
+
* Human-readable field label
|
|
11224
|
+
*/
|
|
11225
|
+
field?: string;
|
|
11226
|
+
/**
|
|
11227
|
+
* Highlighted text fragment with <em> tags
|
|
11228
|
+
*/
|
|
11229
|
+
fragment?: string;
|
|
11230
|
+
}[];
|
|
11231
|
+
_schema: "meter";
|
|
11232
|
+
/**
|
|
11233
|
+
* Resolved template strings corresponding to the templates parameter. Supports both string values and nested objects of strings.
|
|
11234
|
+
* example:
|
|
11235
|
+
* {
|
|
11236
|
+
* "content_top_name": "Customer #123456",
|
|
11237
|
+
* "main_content_name": "Orange Flexible A2 (654321)",
|
|
11238
|
+
* "content_bottom_name": "Porscheplatz 1, 70435 Stuttgart, Germany",
|
|
11239
|
+
* "nested_content": {
|
|
11240
|
+
* "title": "Orange Flexible A2",
|
|
11241
|
+
* "subtitle": "654321"
|
|
11242
|
+
* }
|
|
11243
|
+
* }
|
|
11244
|
+
*/
|
|
11245
|
+
templates_output?: {
|
|
11246
|
+
[name: string]: string | {
|
|
11247
|
+
[name: string]: string;
|
|
11248
|
+
};
|
|
11249
|
+
};
|
|
11250
|
+
}[];
|
|
11251
|
+
/**
|
|
11252
|
+
* The related files of the requested contract
|
|
11253
|
+
*/
|
|
11254
|
+
files?: /* The file entity */ Components.Schemas.File[];
|
|
11255
|
+
/**
|
|
11256
|
+
* The related entities of the requested contract
|
|
11257
|
+
*/
|
|
11258
|
+
relations?: Components.Schemas.EntityItem[];
|
|
11259
|
+
workflow?: /**
|
|
11260
|
+
* example:
|
|
11261
|
+
* {
|
|
11262
|
+
* "id": "8gja72h6kas6h",
|
|
11263
|
+
* "name": "Lead Qualification",
|
|
11264
|
+
* "trigger": "MANUAL",
|
|
11265
|
+
* "status": "STARTED",
|
|
11266
|
+
* "creationTime": "2021-04-27T12:01:13.000Z",
|
|
11267
|
+
* "lastUpdateTime": "2021-04-27T12:01:13.000Z",
|
|
11268
|
+
* "dueDate": "2021-04-27T12:01:13.000Z",
|
|
11269
|
+
* "assignedTo": [
|
|
11270
|
+
* "252",
|
|
11271
|
+
* "29052"
|
|
11272
|
+
* ],
|
|
11273
|
+
* "flow": [
|
|
11274
|
+
* {
|
|
11275
|
+
* "id": "sectionId1",
|
|
11276
|
+
* "name": "Initial Information Gathering",
|
|
11277
|
+
* "steps": [
|
|
11278
|
+
* {
|
|
11279
|
+
* "id": "sada5641f3a21",
|
|
11280
|
+
* "name": "Call client and confirm address and product",
|
|
11281
|
+
* "status": "ASSIGNED",
|
|
11282
|
+
* "assignedTo": [
|
|
11283
|
+
* "11"
|
|
11284
|
+
* ]
|
|
11285
|
+
* },
|
|
11286
|
+
* {
|
|
11287
|
+
* "id": "sada5641f3a22",
|
|
11288
|
+
* "name": "Check product availability",
|
|
11289
|
+
* "status": "UNASSIGNED"
|
|
11290
|
+
* },
|
|
11291
|
+
* {
|
|
11292
|
+
* "id": "sada5641f3a23",
|
|
11293
|
+
* "name": "Send email confirming contact with the client",
|
|
11294
|
+
* "status": "SKIPPED"
|
|
11295
|
+
* }
|
|
11296
|
+
* ]
|
|
11297
|
+
* },
|
|
11298
|
+
* {
|
|
11299
|
+
* "id": "firstLevelStepId1",
|
|
11300
|
+
* "name": "Print and send catalog",
|
|
11301
|
+
* "status": "SKIPPED",
|
|
11302
|
+
* "dueDate": "2023-01-15T20:00:00"
|
|
11303
|
+
* }
|
|
11304
|
+
* ]
|
|
11305
|
+
* }
|
|
11306
|
+
*/
|
|
11307
|
+
Components.Schemas.WorkflowExecution[];
|
|
11308
|
+
journey_actions?: Components.Schemas.JourneyActions[];
|
|
11309
|
+
}
|
|
11310
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11311
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11312
|
+
export type $404 = Components.Responses.NotFound;
|
|
11313
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11314
|
+
}
|
|
11315
|
+
}
|
|
11026
11316
|
namespace GetCosts {
|
|
11027
11317
|
namespace Parameters {
|
|
11028
11318
|
export type AppId = string;
|
|
@@ -11915,6 +12205,12 @@ declare namespace Paths {
|
|
|
11915
12205
|
* true
|
|
11916
12206
|
*/
|
|
11917
12207
|
require_symbols?: boolean;
|
|
12208
|
+
/**
|
|
12209
|
+
* 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.
|
|
12210
|
+
* example:
|
|
12211
|
+
* 3
|
|
12212
|
+
*/
|
|
12213
|
+
password_history_size?: number;
|
|
11918
12214
|
};
|
|
11919
12215
|
};
|
|
11920
12216
|
/**
|
|
@@ -12527,6 +12823,12 @@ declare namespace Paths {
|
|
|
12527
12823
|
* true
|
|
12528
12824
|
*/
|
|
12529
12825
|
require_symbols?: boolean;
|
|
12826
|
+
/**
|
|
12827
|
+
* 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.
|
|
12828
|
+
* example:
|
|
12829
|
+
* 3
|
|
12830
|
+
*/
|
|
12831
|
+
password_history_size?: number;
|
|
12530
12832
|
};
|
|
12531
12833
|
};
|
|
12532
12834
|
/**
|
|
@@ -15861,11 +16163,12 @@ export interface OperationMethods {
|
|
|
15861
16163
|
/**
|
|
15862
16164
|
* createExport - createExport
|
|
15863
16165
|
*
|
|
15864
|
-
* Request an asynchronous CSV export of the portal user's
|
|
16166
|
+
* 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.
|
|
16167
|
+
*
|
|
15865
16168
|
*/
|
|
15866
16169
|
'createExport'(
|
|
15867
|
-
parameters?: Parameters<
|
|
15868
|
-
data?:
|
|
16170
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
16171
|
+
data?: Paths.CreateExport.RequestBody,
|
|
15869
16172
|
config?: AxiosRequestConfig
|
|
15870
16173
|
): OperationResponse<Paths.CreateExport.Responses.$202>
|
|
15871
16174
|
/**
|
|
@@ -16658,6 +16961,16 @@ export interface OperationMethods {
|
|
|
16658
16961
|
data?: any,
|
|
16659
16962
|
config?: AxiosRequestConfig
|
|
16660
16963
|
): 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>
|
|
16661
16974
|
/**
|
|
16662
16975
|
* updateContract - updateContract
|
|
16663
16976
|
*
|
|
@@ -17563,11 +17876,12 @@ export interface PathsDictionary {
|
|
|
17563
17876
|
/**
|
|
17564
17877
|
* createExport - createExport
|
|
17565
17878
|
*
|
|
17566
|
-
* Request an asynchronous CSV export of the portal user's
|
|
17879
|
+
* 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.
|
|
17880
|
+
*
|
|
17567
17881
|
*/
|
|
17568
17882
|
'post'(
|
|
17569
|
-
parameters?: Parameters<
|
|
17570
|
-
data?:
|
|
17883
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
17884
|
+
data?: Paths.CreateExport.RequestBody,
|
|
17571
17885
|
config?: AxiosRequestConfig
|
|
17572
17886
|
): OperationResponse<Paths.CreateExport.Responses.$202>
|
|
17573
17887
|
}
|
|
@@ -18492,6 +18806,16 @@ export interface PathsDictionary {
|
|
|
18492
18806
|
data?: any,
|
|
18493
18807
|
config?: AxiosRequestConfig
|
|
18494
18808
|
): 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>
|
|
18495
18819
|
/**
|
|
18496
18820
|
* updateContract - updateContract
|
|
18497
18821
|
*
|
|
@@ -19535,6 +19859,7 @@ export type PageRequest = Components.Schemas.PageRequest;
|
|
|
19535
19859
|
export type PaymentWidget = Components.Schemas.PaymentWidget;
|
|
19536
19860
|
export type PortalConfig = Components.Schemas.PortalConfig;
|
|
19537
19861
|
export type PortalConfigV3 = Components.Schemas.PortalConfigV3;
|
|
19862
|
+
export type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
|
|
19538
19863
|
export type PortalId = Components.Schemas.PortalId;
|
|
19539
19864
|
export type PortalUser = Components.Schemas.PortalUser;
|
|
19540
19865
|
export type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
|
package/package.json
CHANGED
package/src/openapi-runtime.json
CHANGED
|
@@ -131,13 +131,12 @@
|
|
|
131
131
|
"/v1/portal/exports": {
|
|
132
132
|
"post": {
|
|
133
133
|
"operationId": "createExport",
|
|
134
|
-
"
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
"
|
|
138
|
-
"required": false
|
|
134
|
+
"requestBody": {
|
|
135
|
+
"required": true,
|
|
136
|
+
"content": {
|
|
137
|
+
"application/json": {}
|
|
139
138
|
}
|
|
140
|
-
|
|
139
|
+
},
|
|
141
140
|
"responses": {}
|
|
142
141
|
}
|
|
143
142
|
},
|
|
@@ -1424,6 +1423,23 @@
|
|
|
1424
1423
|
],
|
|
1425
1424
|
"responses": {}
|
|
1426
1425
|
},
|
|
1426
|
+
"post": {
|
|
1427
|
+
"operationId": "getContractWithTemplates",
|
|
1428
|
+
"parameters": [
|
|
1429
|
+
{
|
|
1430
|
+
"in": "path",
|
|
1431
|
+
"name": "id",
|
|
1432
|
+
"required": true
|
|
1433
|
+
}
|
|
1434
|
+
],
|
|
1435
|
+
"requestBody": {
|
|
1436
|
+
"required": false,
|
|
1437
|
+
"content": {
|
|
1438
|
+
"application/json": {}
|
|
1439
|
+
}
|
|
1440
|
+
},
|
|
1441
|
+
"responses": {}
|
|
1442
|
+
},
|
|
1427
1443
|
"patch": {
|
|
1428
1444
|
"operationId": "updateContract",
|
|
1429
1445
|
"deprecated": true,
|
package/src/openapi.json
CHANGED
|
@@ -484,25 +484,75 @@
|
|
|
484
484
|
"post": {
|
|
485
485
|
"operationId": "createExport",
|
|
486
486
|
"summary": "createExport",
|
|
487
|
-
"description": "Request an asynchronous CSV export of the portal user's
|
|
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
488
|
"tags": [
|
|
489
489
|
"ECP"
|
|
490
490
|
],
|
|
491
|
-
"
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
"
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
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
|
+
}
|
|
504
554
|
}
|
|
505
|
-
|
|
555
|
+
},
|
|
506
556
|
"security": [
|
|
507
557
|
{
|
|
508
558
|
"PortalAuth": []
|
|
@@ -540,7 +590,7 @@
|
|
|
540
590
|
"$ref": "#/components/responses/Forbidden"
|
|
541
591
|
},
|
|
542
592
|
"404": {
|
|
543
|
-
"description": "
|
|
593
|
+
"description": "Missing or invalid export columns."
|
|
544
594
|
},
|
|
545
595
|
"500": {
|
|
546
596
|
"$ref": "#/components/responses/InternalServerError"
|
|
@@ -5879,6 +5929,125 @@
|
|
|
5879
5929
|
}
|
|
5880
5930
|
}
|
|
5881
5931
|
},
|
|
5932
|
+
"post": {
|
|
5933
|
+
"operationId": "getContractWithTemplates",
|
|
5934
|
+
"summary": "getContractWithTemplates",
|
|
5935
|
+
"description": "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.",
|
|
5936
|
+
"tags": [
|
|
5937
|
+
"ECP"
|
|
5938
|
+
],
|
|
5939
|
+
"security": [
|
|
5940
|
+
{
|
|
5941
|
+
"PortalAuth": []
|
|
5942
|
+
}
|
|
5943
|
+
],
|
|
5944
|
+
"parameters": [
|
|
5945
|
+
{
|
|
5946
|
+
"in": "path",
|
|
5947
|
+
"name": "id",
|
|
5948
|
+
"schema": {
|
|
5949
|
+
"$ref": "#/components/schemas/EntityId"
|
|
5950
|
+
},
|
|
5951
|
+
"required": true,
|
|
5952
|
+
"description": "The ID of the contract"
|
|
5953
|
+
}
|
|
5954
|
+
],
|
|
5955
|
+
"requestBody": {
|
|
5956
|
+
"required": false,
|
|
5957
|
+
"content": {
|
|
5958
|
+
"application/json": {
|
|
5959
|
+
"schema": {
|
|
5960
|
+
"type": "object",
|
|
5961
|
+
"properties": {
|
|
5962
|
+
"templates": {
|
|
5963
|
+
"type": "object",
|
|
5964
|
+
"additionalProperties": {
|
|
5965
|
+
"type": "string"
|
|
5966
|
+
},
|
|
5967
|
+
"description": "Map of content field name to Handlebars template string. Each template is resolved per related meter and returned as templates_output on the meter."
|
|
5968
|
+
}
|
|
5969
|
+
}
|
|
5970
|
+
}
|
|
5971
|
+
}
|
|
5972
|
+
}
|
|
5973
|
+
},
|
|
5974
|
+
"responses": {
|
|
5975
|
+
"200": {
|
|
5976
|
+
"description": "The requested contract returned successfully.",
|
|
5977
|
+
"content": {
|
|
5978
|
+
"application/json": {
|
|
5979
|
+
"schema": {
|
|
5980
|
+
"type": "object",
|
|
5981
|
+
"properties": {
|
|
5982
|
+
"entity": {
|
|
5983
|
+
"$ref": "#/components/schemas/Contract"
|
|
5984
|
+
},
|
|
5985
|
+
"orders": {
|
|
5986
|
+
"type": "array",
|
|
5987
|
+
"description": "The related orders of the requested contract",
|
|
5988
|
+
"items": {
|
|
5989
|
+
"$ref": "#/components/schemas/Order"
|
|
5990
|
+
}
|
|
5991
|
+
},
|
|
5992
|
+
"meters": {
|
|
5993
|
+
"type": "array",
|
|
5994
|
+
"description": "The related meters of the requested contract",
|
|
5995
|
+
"items": {
|
|
5996
|
+
"allOf": [
|
|
5997
|
+
{
|
|
5998
|
+
"$ref": "#/components/schemas/Meter"
|
|
5999
|
+
},
|
|
6000
|
+
{
|
|
6001
|
+
"$ref": "#/components/schemas/EntityTemplates"
|
|
6002
|
+
}
|
|
6003
|
+
]
|
|
6004
|
+
}
|
|
6005
|
+
},
|
|
6006
|
+
"files": {
|
|
6007
|
+
"type": "array",
|
|
6008
|
+
"description": "The related files of the requested contract",
|
|
6009
|
+
"items": {
|
|
6010
|
+
"$ref": "#/components/schemas/File"
|
|
6011
|
+
}
|
|
6012
|
+
},
|
|
6013
|
+
"relations": {
|
|
6014
|
+
"type": "array",
|
|
6015
|
+
"description": "The related entities of the requested contract",
|
|
6016
|
+
"items": {
|
|
6017
|
+
"$ref": "#/components/schemas/EntityItem"
|
|
6018
|
+
}
|
|
6019
|
+
},
|
|
6020
|
+
"workflow": {
|
|
6021
|
+
"type": "array",
|
|
6022
|
+
"items": {
|
|
6023
|
+
"$ref": "#/components/schemas/WorkflowExecution"
|
|
6024
|
+
}
|
|
6025
|
+
},
|
|
6026
|
+
"journey_actions": {
|
|
6027
|
+
"type": "array",
|
|
6028
|
+
"items": {
|
|
6029
|
+
"$ref": "#/components/schemas/JourneyActions"
|
|
6030
|
+
}
|
|
6031
|
+
}
|
|
6032
|
+
}
|
|
6033
|
+
}
|
|
6034
|
+
}
|
|
6035
|
+
}
|
|
6036
|
+
},
|
|
6037
|
+
"401": {
|
|
6038
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
6039
|
+
},
|
|
6040
|
+
"403": {
|
|
6041
|
+
"$ref": "#/components/responses/Forbidden"
|
|
6042
|
+
},
|
|
6043
|
+
"404": {
|
|
6044
|
+
"$ref": "#/components/responses/NotFound"
|
|
6045
|
+
},
|
|
6046
|
+
"500": {
|
|
6047
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
6048
|
+
}
|
|
6049
|
+
}
|
|
6050
|
+
},
|
|
5882
6051
|
"patch": {
|
|
5883
6052
|
"operationId": "updateContract",
|
|
5884
6053
|
"summary": "updateContract",
|
|
@@ -12013,6 +12182,13 @@
|
|
|
12013
12182
|
"type": "boolean",
|
|
12014
12183
|
"example": true,
|
|
12015
12184
|
"description": "Require symbols"
|
|
12185
|
+
},
|
|
12186
|
+
"password_history_size": {
|
|
12187
|
+
"type": "integer",
|
|
12188
|
+
"minimum": 0,
|
|
12189
|
+
"maximum": 24,
|
|
12190
|
+
"example": 3,
|
|
12191
|
+
"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."
|
|
12016
12192
|
}
|
|
12017
12193
|
}
|
|
12018
12194
|
}
|
|
@@ -18207,6 +18383,13 @@
|
|
|
18207
18383
|
"type": "boolean",
|
|
18208
18384
|
"example": true,
|
|
18209
18385
|
"description": "Require symbols"
|
|
18386
|
+
},
|
|
18387
|
+
"password_history_size": {
|
|
18388
|
+
"type": "integer",
|
|
18389
|
+
"minimum": 0,
|
|
18390
|
+
"maximum": 24,
|
|
18391
|
+
"example": 3,
|
|
18392
|
+
"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."
|
|
18210
18393
|
}
|
|
18211
18394
|
}
|
|
18212
18395
|
}
|
|
@@ -18523,6 +18706,90 @@
|
|
|
18523
18706
|
"description": "ID of the portal",
|
|
18524
18707
|
"example": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
|
|
18525
18708
|
},
|
|
18709
|
+
"PortalDataExportColumn": {
|
|
18710
|
+
"type": "object",
|
|
18711
|
+
"description": "One column of the portal data export CSV.",
|
|
18712
|
+
"required": [
|
|
18713
|
+
"key",
|
|
18714
|
+
"header",
|
|
18715
|
+
"source"
|
|
18716
|
+
],
|
|
18717
|
+
"properties": {
|
|
18718
|
+
"key": {
|
|
18719
|
+
"type": "string",
|
|
18720
|
+
"description": "Stable, immutable column id (snake_case). Append-only contract: never rename, reorder semantics, or remove an existing key; new columns are appended.\n",
|
|
18721
|
+
"example": "vertragsnummer"
|
|
18722
|
+
},
|
|
18723
|
+
"header": {
|
|
18724
|
+
"type": "object",
|
|
18725
|
+
"description": "Localized header label, keyed by language (de, en).",
|
|
18726
|
+
"additionalProperties": {
|
|
18727
|
+
"type": "string"
|
|
18728
|
+
},
|
|
18729
|
+
"example": {
|
|
18730
|
+
"de": "Vertragsnummer",
|
|
18731
|
+
"en": "Contract number"
|
|
18732
|
+
}
|
|
18733
|
+
},
|
|
18734
|
+
"source": {
|
|
18735
|
+
"type": "object",
|
|
18736
|
+
"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",
|
|
18737
|
+
"required": [
|
|
18738
|
+
"attribute"
|
|
18739
|
+
],
|
|
18740
|
+
"properties": {
|
|
18741
|
+
"path": {
|
|
18742
|
+
"type": "array",
|
|
18743
|
+
"description": "Relation hops from the anchor entity (max 3).",
|
|
18744
|
+
"items": {
|
|
18745
|
+
"type": "string"
|
|
18746
|
+
},
|
|
18747
|
+
"example": [
|
|
18748
|
+
"customer"
|
|
18749
|
+
]
|
|
18750
|
+
},
|
|
18751
|
+
"attribute": {
|
|
18752
|
+
"type": "string",
|
|
18753
|
+
"description": "Attribute to read on the resolved entity.",
|
|
18754
|
+
"example": "customer_number"
|
|
18755
|
+
},
|
|
18756
|
+
"address_field": {
|
|
18757
|
+
"type": "string",
|
|
18758
|
+
"description": "Which part of an address-typed attribute to render.",
|
|
18759
|
+
"enum": [
|
|
18760
|
+
"full",
|
|
18761
|
+
"street",
|
|
18762
|
+
"street_number",
|
|
18763
|
+
"postal_code",
|
|
18764
|
+
"city",
|
|
18765
|
+
"additional_info",
|
|
18766
|
+
"country"
|
|
18767
|
+
]
|
|
18768
|
+
}
|
|
18769
|
+
}
|
|
18770
|
+
},
|
|
18771
|
+
"formatter": {
|
|
18772
|
+
"type": "string",
|
|
18773
|
+
"enum": [
|
|
18774
|
+
"text",
|
|
18775
|
+
"date",
|
|
18776
|
+
"money_cents",
|
|
18777
|
+
"enum",
|
|
18778
|
+
"address"
|
|
18779
|
+
]
|
|
18780
|
+
},
|
|
18781
|
+
"enum_labels": {
|
|
18782
|
+
"type": "object",
|
|
18783
|
+
"description": "Localized value maps for the enum formatter, keyed by language then raw value.\n",
|
|
18784
|
+
"additionalProperties": {
|
|
18785
|
+
"type": "object",
|
|
18786
|
+
"additionalProperties": {
|
|
18787
|
+
"type": "string"
|
|
18788
|
+
}
|
|
18789
|
+
}
|
|
18790
|
+
}
|
|
18791
|
+
}
|
|
18792
|
+
},
|
|
18526
18793
|
"UpsertPortalConfigV3": {
|
|
18527
18794
|
"allOf": [
|
|
18528
18795
|
{
|