@epilot/customer-portal-client 0.41.0 → 0.41.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +49 -0
- package/dist/openapi.d.ts +323 -3
- package/package.json +1 -1
- package/src/openapi-runtime.json +49 -0
- package/src/openapi.json +392 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={330(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(466));r.default=n.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v1/portal/exports":{"post":{"operationId":"createExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/exports/{jobId}":{"get":{"operationId":"getExport","parameters":[{"in":"path","name":"jobId","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/visualization/metadata":{"get":{"operationId":"getVisualizationMetadata","parameters":[{"in":"query","name":"app_id","required":true},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates:migrate-references":{"post":{"operationId":"migrateEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates:list-references":{"post":{"operationId":"listEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates/{portal_id}":{"post":{"operationId":"upsertEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/public-widgets":{"get":{"operationId":"getPublicPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/widgets":{"get":{"operationId":"getPublicPortalWidgetsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"responses":{}}},"/v3/portal/widgets":{"get":{"operationId":"getPortalWidgetsV3","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"contract_id","required":false}],"responses":{}},"post":{"operationId":"upsertPortalWidgetV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/portal/files":{"post":{"operationId":"savePortalFilesV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","deprecated":true,"responses":{}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","responses":{}}},"/v2/portal/public/schemas":{"get":{"operationId":"getSchemasByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v3/portal/public/schemas":{"get":{"operationId":"getPublicSchemasV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/org/settings":{"get":{"operationId":"getOrganizationSettingsByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","responses":{}}},"/v2/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecords","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecordsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/contact":{"get":{"operationId":"getContact","responses":{}},"patch":{"operationId":"updateContact","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","parameters":[{"in":"query","name":"id","required":true}],"responses":{}}},"/v2/portal/public/contact/exists":{"post":{"operationId":"checkContactExists","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/contact/exists":{"post":{"operationId":"checkContactExistsV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/account/exists":{"post":{"operationId":"checkAccountExists","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","responses":{}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","responses":{}},"patch":{"operationId":"updatePortalUser","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalUser","responses":{}}},"/v2/portal/user/update/email":{"put":{"operationId":"updatePortalUserEmail","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/change/password":{"put":{"operationId":"changePortalUserPassword","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/{id}/resolve-templates":{"post":{"operationId":"getContractWithTemplates","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/preview":{"get":{"operationId":"getFilePreview","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/downloaded":{"post":{"operationId":"trackFileDownloaded","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/files/count-by-entity":{"get":{"operationId":"getFilesCountByEntity","deprecated":true,"responses":{}}},"/v2/portal/billing/events":{"get":{"operationId":"getBillingEvents","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"name":"entity_id","in":"query","required":false},{"name":"event_type","in":"query"},{"name":"paid","in":"query"},{"name":"date_after","in":"query"},{"name":"date_before","in":"query"},{"name":"sort","in":"query"}],"responses":{}}},"/v2/portal/billing/customers/balance":{"get":{"operationId":"getCustomerBalance","responses":{}}},"/v2/portal/billing/accounts/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getBillingAccount","responses":{}}},"/v2/portal/admin:login-as-user":{"post":{"operationId":"loginToPortalAsUser","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEvent","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"origin","in":"query","required":true}],"responses":{}}},"/v3/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEventV3","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"portal_id","in":"query","required":false},{"name":"domain","in":"query","required":false}],"responses":{}}},"/v2/portal/entity:get":{"post":{"operationId":"getPortalUserEntity","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity:search":{"post":{"operationId":"searchPortalUserEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{slug}":{"post":{"operationId":"createPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{slug}/{id}":{"patch":{"operationId":"patchPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/can-trigger-portal-flow":{"post":{"operationId":"canTriggerPortalFlow","parameters":[{"in":"query","name":"origin","required":false,"deprecated":true},{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/automation-context":{"get":{"operationId":"getAutomationContext","parameters":[{"in":"query","name":"activity_id","required":true},{"in":"query","name":"type","required":true}],"responses":{}}},"/v2/portal/workflow/{workflow_id}/{step_id}:markDone":{"put":{"operationId":"updateWorkflowStepAsDone","parameters":[{"in":"path","name":"workflow_id","required":true},{"in":"path","name":"step_id","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows":{"get":{"operationId":"getEntityWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows/linearized":{"get":{"operationId":"getEntityPortalWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entities/workflows/linearized/batch":{"post":{"operationId":"getEntityPortalWorkflowsBatch","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/metering/readings":{"post":{"operationId":"getMeterReadings","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/providers/{provider_slug}":{"get":{"operationId":"getSSOProvider","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"origin","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/sso/login":{"post":{"operationId":"ssoLogin","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/sso/login":{"post":{"operationId":"ssoLoginV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"org_id","required":false},{"in":"query","name":"domain","required":false},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/redirect":{"post":{"operationId":"ssoRedirect","parameters":[{"in":"query","name":"web_uri","required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{}}},"responses":{}}},"/v2/portal/public/sso/callback":{"post":{"operationId":"ssoCallback","parameters":[{"in":"query","name":"domain"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getPortalPage","responses":{}},"put":{"operationId":"updatePortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPage","responses":{}}},"/v2/portal/pages":{"parameters":[{"in":"query","name":"domain","required":true}],"get":{"operationId":"getPortalPages","parameters":[{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false},{"in":"query","name":"contract_id","required":false,"deprecated":true},{"in":"query","name":"context_entities","required":false}],"responses":{}},"post":{"operationId":"createPortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/pages":{"get":{"operationId":"getPublicPages","parameters":[{"in":"query","name":"domain","required":true},{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false}],"responses":{}}},"/v2/portal/pages/interpolate":{"post":{"operationId":"interpolatePortalPages","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/config/triggered-journeys/{trigger_name}":{"parameters":[{"in":"path","name":"trigger_name","required":true,"description":"The trigger event for the auto-triggered journey"}],"get":{"operationId":"getTriggeredJourney","parameters":[{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/pages/default":{"get":{"operationId":"getDefaultPages","responses":{}}},"/v2/portal/pages/{id}/blocks":{"parameters":[{"in":"path","name":"id","required":true}],"post":{"operationId":"createPortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalPageBlocks","responses":{}}},"/v2/portal/pages/{id}/blocks/{block_id}":{"parameters":[{"in":"path","name":"id","required":true},{"in":"path","name":"block_id","required":true}],"get":{"operationId":"getPortalPageBlock","responses":{}},"put":{"operationId":"updatePortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPageBlock","responses":{}}},"/v2/portal/public/user/entry-point":{"get":{"operationId":"getUserEntryPoint","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/campaign/{campaign_id}/entity:status":{"put":{"operationId":"updateCampaignPortalBlockStatus","parameters":[{"in":"path","name":"campaign_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/notifications/entity:status":{"put":{"operationId":"updateNotificationsStatus","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/m-login/deregister/{client_id}/{user_id}":{"delete":{"operationId":"deRegisterMLoginUser","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"responses":{}}},"/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}":{"post":{"operationId":"notifyMLoginInterestChange","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config":{"post":{"operationId":"createPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/{portal_id}":{"get":{"operationId":"getPortalConfigV3","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}},"put":{"operationId":"putPortalConfig","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"query","name":"page_upsert_mode","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalConfig","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/configs":{"get":{"operationId":"listAllPortalConfigs","responses":{}}},"/v3/portal/config/swap":{"post":{"operationId":"swapPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/clone":{"post":{"operationId":"clonePortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/invite":{"post":{"operationId":"invitePartner","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/list":{"get":{"operationId":"listBusinessPartners","responses":{}}},"/v3/portal/partner/{partner_id}/resend-invitation":{"post":{"operationId":"resendPartnerInvitation","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/revoke":{"delete":{"operationId":"revokePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/disable":{"post":{"operationId":"disablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/enable":{"post":{"operationId":"enablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/verify-dns":{"post":{"operationId":"verifyDns","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/proxy/execute":{"post":{"operationId":"portalProxyExecute","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/mobile-config":{"get":{"operationId":"getMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"raw","required":false}],"responses":{}},"put":{"operationId":"putMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"InvalidRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"ForbiddenByRule":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"ContractAssignmentConflict":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ConfirmUserInvalidRequest":{"content":{"application/json":{}}},"InvalidRequestCreateMeterReading":{"content":{"application/json":{}}}}},"servers":[{"url":"https://customer-portal-api.sls.epilot.io"}]}')}},r={},t=function t(a){var n=r[a];if(void 0!==n)return n.exports;var i=r[a]={exports:{}};return e[a].call(i.exports,i,i.exports,t),i.exports}(330),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={914:function(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(240));r.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v1/portal/exports":{"post":{"operationId":"createExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/exports/{jobId}":{"get":{"operationId":"getExport","parameters":[{"in":"path","name":"jobId","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/visualization/metadata":{"get":{"operationId":"getVisualizationMetadata","parameters":[{"in":"query","name":"app_id","required":true},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates:migrate-references":{"post":{"operationId":"migrateEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates:list-references":{"post":{"operationId":"listEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates/{portal_id}":{"post":{"operationId":"upsertEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/public-widgets":{"get":{"operationId":"getPublicPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/widgets":{"get":{"operationId":"getPublicPortalWidgetsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"responses":{}}},"/v3/portal/widgets":{"get":{"operationId":"getPortalWidgetsV3","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"contract_id","required":false}],"responses":{}},"post":{"operationId":"upsertPortalWidgetV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/portal/files":{"post":{"operationId":"savePortalFilesV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","deprecated":true,"responses":{}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","responses":{}}},"/v2/portal/public/schemas":{"get":{"operationId":"getSchemasByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v3/portal/public/schemas":{"get":{"operationId":"getPublicSchemasV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/org/settings":{"get":{"operationId":"getOrganizationSettingsByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","responses":{}}},"/v2/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecords","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecordsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/contact":{"get":{"operationId":"getContact","responses":{}},"patch":{"operationId":"updateContact","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","parameters":[{"in":"query","name":"id","required":true}],"responses":{}}},"/v2/portal/public/contact/exists":{"post":{"operationId":"checkContactExists","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/contact/exists":{"post":{"operationId":"checkContactExistsV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/account/exists":{"post":{"operationId":"checkAccountExists","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","responses":{}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","responses":{}},"patch":{"operationId":"updatePortalUser","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalUser","responses":{}}},"/v2/portal/user/update/email":{"put":{"operationId":"updatePortalUserEmail","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/change/password":{"put":{"operationId":"changePortalUserPassword","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/{id}/resolve-templates":{"post":{"operationId":"getContractWithTemplates","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/preview":{"get":{"operationId":"getFilePreview","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/downloaded":{"post":{"operationId":"trackFileDownloaded","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/files/count-by-entity":{"get":{"operationId":"getFilesCountByEntity","deprecated":true,"responses":{}}},"/v2/portal/billing/events":{"get":{"operationId":"getBillingEvents","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"name":"entity_id","in":"query","required":false},{"name":"event_type","in":"query"},{"name":"paid","in":"query"},{"name":"date_after","in":"query"},{"name":"date_before","in":"query"},{"name":"sort","in":"query"}],"responses":{}}},"/v2/portal/billing/customers/balance":{"get":{"operationId":"getCustomerBalance","responses":{}}},"/v2/portal/billing/accounts/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getBillingAccount","responses":{}}},"/v2/portal/admin:login-as-user":{"post":{"operationId":"loginToPortalAsUser","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEvent","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"origin","in":"query","required":true}],"responses":{}}},"/v3/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEventV3","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"portal_id","in":"query","required":false},{"name":"domain","in":"query","required":false}],"responses":{}}},"/v2/portal/entity:get":{"post":{"operationId":"getPortalUserEntity","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity:search":{"post":{"operationId":"searchPortalUserEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{slug}":{"post":{"operationId":"createPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{slug}/{id}":{"patch":{"operationId":"patchPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/can-trigger-portal-flow":{"post":{"operationId":"canTriggerPortalFlow","parameters":[{"in":"query","name":"origin","required":false,"deprecated":true},{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/automation-context":{"get":{"operationId":"getAutomationContext","parameters":[{"in":"query","name":"activity_id","required":true},{"in":"query","name":"type","required":true}],"responses":{}}},"/v2/portal/workflow/{workflow_id}/{step_id}:markDone":{"put":{"operationId":"updateWorkflowStepAsDone","parameters":[{"in":"path","name":"workflow_id","required":true},{"in":"path","name":"step_id","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows":{"get":{"operationId":"getEntityWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/engagement/tasks":{"get":{"operationId":"getOutstandingTasks","responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows/linearized":{"get":{"operationId":"getEntityPortalWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entities/workflows/linearized/batch":{"post":{"operationId":"getEntityPortalWorkflowsBatch","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/metering/readings":{"post":{"operationId":"getMeterReadings","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/providers/{provider_slug}":{"get":{"operationId":"getSSOProvider","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"origin","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/sso/login":{"post":{"operationId":"ssoLogin","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/sso/login":{"post":{"operationId":"ssoLoginV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"org_id","required":false},{"in":"query","name":"domain","required":false},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/redirect":{"post":{"operationId":"ssoRedirect","parameters":[{"in":"query","name":"web_uri","required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{}}},"responses":{}}},"/v2/portal/public/sso/callback":{"post":{"operationId":"ssoCallback","parameters":[{"in":"query","name":"domain"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getPortalPage","responses":{}},"put":{"operationId":"updatePortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPage","responses":{}}},"/v2/portal/pages":{"parameters":[{"in":"query","name":"domain","required":true}],"get":{"operationId":"getPortalPages","parameters":[{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false},{"in":"query","name":"contract_id","required":false,"deprecated":true},{"in":"query","name":"context_entities","required":false}],"responses":{}},"post":{"operationId":"createPortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/pages":{"get":{"operationId":"getPublicPages","parameters":[{"in":"query","name":"domain","required":true},{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false}],"responses":{}}},"/v2/portal/pages/interpolate":{"post":{"operationId":"interpolatePortalPages","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/config/triggered-journeys/{trigger_name}":{"parameters":[{"in":"path","name":"trigger_name","required":true,"description":"The trigger event for the auto-triggered journey"}],"get":{"operationId":"getTriggeredJourney","parameters":[{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/pages/default":{"get":{"operationId":"getDefaultPages","responses":{}}},"/v2/portal/pages/{id}/blocks":{"parameters":[{"in":"path","name":"id","required":true}],"post":{"operationId":"createPortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalPageBlocks","responses":{}}},"/v2/portal/pages/{id}/blocks/{block_id}":{"parameters":[{"in":"path","name":"id","required":true},{"in":"path","name":"block_id","required":true}],"get":{"operationId":"getPortalPageBlock","responses":{}},"put":{"operationId":"updatePortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPageBlock","responses":{}}},"/v2/portal/public/user/entry-point":{"get":{"operationId":"getUserEntryPoint","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/campaign/{campaign_id}/entity:status":{"put":{"operationId":"updateCampaignPortalBlockStatus","parameters":[{"in":"path","name":"campaign_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/notifications":{"get":{"operationId":"listPortalNotifications","parameters":[{"in":"query","name":"cursor","required":false},{"in":"query","name":"limit","required":false}],"responses":{}}},"/v2/portal/notifications/unread-count":{"get":{"operationId":"getPortalNotificationsUnreadCount","responses":{}}},"/v2/portal/notifications/read-all":{"put":{"operationId":"markAllPortalNotificationsRead","responses":{}}},"/v2/portal/notifications/{id}/read":{"put":{"operationId":"markPortalNotificationRead","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/notifications/entity:status":{"put":{"operationId":"updateNotificationsStatus","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/m-login/deregister/{client_id}/{user_id}":{"delete":{"operationId":"deRegisterMLoginUser","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"responses":{}}},"/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}":{"post":{"operationId":"notifyMLoginInterestChange","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config":{"post":{"operationId":"createPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/{portal_id}":{"get":{"operationId":"getPortalConfigV3","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}},"put":{"operationId":"putPortalConfig","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"query","name":"page_upsert_mode","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalConfig","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/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}(914),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
@@ -1967,6 +1967,12 @@
|
|
|
1967
1967
|
"responses": {}
|
|
1968
1968
|
}
|
|
1969
1969
|
},
|
|
1970
|
+
"/v2/portal/engagement/tasks": {
|
|
1971
|
+
"get": {
|
|
1972
|
+
"operationId": "getOutstandingTasks",
|
|
1973
|
+
"responses": {}
|
|
1974
|
+
}
|
|
1975
|
+
},
|
|
1970
1976
|
"/v2/portal/entity/{slug}/{id}/workflows/linearized": {
|
|
1971
1977
|
"get": {
|
|
1972
1978
|
"operationId": "getEntityPortalWorkflows",
|
|
@@ -2426,6 +2432,49 @@
|
|
|
2426
2432
|
"responses": {}
|
|
2427
2433
|
}
|
|
2428
2434
|
},
|
|
2435
|
+
"/v2/portal/notifications": {
|
|
2436
|
+
"get": {
|
|
2437
|
+
"operationId": "listPortalNotifications",
|
|
2438
|
+
"parameters": [
|
|
2439
|
+
{
|
|
2440
|
+
"in": "query",
|
|
2441
|
+
"name": "cursor",
|
|
2442
|
+
"required": false
|
|
2443
|
+
},
|
|
2444
|
+
{
|
|
2445
|
+
"in": "query",
|
|
2446
|
+
"name": "limit",
|
|
2447
|
+
"required": false
|
|
2448
|
+
}
|
|
2449
|
+
],
|
|
2450
|
+
"responses": {}
|
|
2451
|
+
}
|
|
2452
|
+
},
|
|
2453
|
+
"/v2/portal/notifications/unread-count": {
|
|
2454
|
+
"get": {
|
|
2455
|
+
"operationId": "getPortalNotificationsUnreadCount",
|
|
2456
|
+
"responses": {}
|
|
2457
|
+
}
|
|
2458
|
+
},
|
|
2459
|
+
"/v2/portal/notifications/read-all": {
|
|
2460
|
+
"put": {
|
|
2461
|
+
"operationId": "markAllPortalNotificationsRead",
|
|
2462
|
+
"responses": {}
|
|
2463
|
+
}
|
|
2464
|
+
},
|
|
2465
|
+
"/v2/portal/notifications/{id}/read": {
|
|
2466
|
+
"put": {
|
|
2467
|
+
"operationId": "markPortalNotificationRead",
|
|
2468
|
+
"parameters": [
|
|
2469
|
+
{
|
|
2470
|
+
"in": "path",
|
|
2471
|
+
"name": "id",
|
|
2472
|
+
"required": true
|
|
2473
|
+
}
|
|
2474
|
+
],
|
|
2475
|
+
"responses": {}
|
|
2476
|
+
}
|
|
2477
|
+
},
|
|
2429
2478
|
"/v2/portal/notifications/entity:status": {
|
|
2430
2479
|
"put": {
|
|
2431
2480
|
"operationId": "updateNotificationsStatus",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1459,6 +1459,10 @@ declare namespace Components {
|
|
|
1459
1459
|
global_blocks?: {
|
|
1460
1460
|
[name: string]: Block;
|
|
1461
1461
|
};
|
|
1462
|
+
/**
|
|
1463
|
+
* Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
|
|
1464
|
+
*/
|
|
1465
|
+
notification_triggers?: NotificationTriggerConfig[];
|
|
1462
1466
|
}
|
|
1463
1467
|
export interface CommonConfigAttributesV3 {
|
|
1464
1468
|
/**
|
|
@@ -5054,7 +5058,7 @@ declare namespace Components {
|
|
|
5054
5058
|
/**
|
|
5055
5059
|
* If the value is not provided, the system will be set with the time the request is processed.
|
|
5056
5060
|
* example:
|
|
5057
|
-
* 2022-10-
|
|
5061
|
+
* 2022-10-10T00:00:00.000Z
|
|
5058
5062
|
*/
|
|
5059
5063
|
timestamp?: string;
|
|
5060
5064
|
/**
|
|
@@ -5331,6 +5335,26 @@ declare namespace Components {
|
|
|
5331
5335
|
*/
|
|
5332
5336
|
client_secret?: string;
|
|
5333
5337
|
}
|
|
5338
|
+
export interface NotificationTriggerConfig {
|
|
5339
|
+
/**
|
|
5340
|
+
* The 360 event that fires this notification trigger.
|
|
5341
|
+
*/
|
|
5342
|
+
trigger_type: "entity_created" | "entity_assigned" | "workflow_step_overdue";
|
|
5343
|
+
/**
|
|
5344
|
+
* For `entity_created` / `entity_assigned` triggers, the entity schema slug (e.g. `opportunity`, `order`) whose creation or assignment fires this trigger. Ignored for other trigger types.
|
|
5345
|
+
* example:
|
|
5346
|
+
* opportunity
|
|
5347
|
+
*/
|
|
5348
|
+
entity_schema?: string;
|
|
5349
|
+
/**
|
|
5350
|
+
* Whether this trigger is active.
|
|
5351
|
+
*/
|
|
5352
|
+
enabled?: boolean;
|
|
5353
|
+
/**
|
|
5354
|
+
* Entity id of the notification_template to render for this trigger.
|
|
5355
|
+
*/
|
|
5356
|
+
template_id?: string; // uuid
|
|
5357
|
+
}
|
|
5334
5358
|
/**
|
|
5335
5359
|
* OIDC provider configuration. Values are resolved at SSO invocation time
|
|
5336
5360
|
* (login / callback), so the fields below may reference org env vars via
|
|
@@ -5717,6 +5741,44 @@ declare namespace Components {
|
|
|
5717
5741
|
*/
|
|
5718
5742
|
minNativeVersion?: string;
|
|
5719
5743
|
}
|
|
5744
|
+
export interface OutstandingTask {
|
|
5745
|
+
/**
|
|
5746
|
+
* ID of the entity the task belongs to
|
|
5747
|
+
*/
|
|
5748
|
+
entity_id: string;
|
|
5749
|
+
/**
|
|
5750
|
+
* Schema slug of the entity (opportunity, order or contract)
|
|
5751
|
+
*/
|
|
5752
|
+
entity_schema: string;
|
|
5753
|
+
/**
|
|
5754
|
+
* Title (_title) of the entity
|
|
5755
|
+
*/
|
|
5756
|
+
entity_title: string;
|
|
5757
|
+
/**
|
|
5758
|
+
* Workflow execution id
|
|
5759
|
+
*/
|
|
5760
|
+
workflow_id: string;
|
|
5761
|
+
/**
|
|
5762
|
+
* Workflow execution / template name
|
|
5763
|
+
*/
|
|
5764
|
+
workflow_name: string;
|
|
5765
|
+
/**
|
|
5766
|
+
* Task (step) id within the workflow execution
|
|
5767
|
+
*/
|
|
5768
|
+
step_id: string;
|
|
5769
|
+
/**
|
|
5770
|
+
* Task (step) name
|
|
5771
|
+
*/
|
|
5772
|
+
step_name: string;
|
|
5773
|
+
/**
|
|
5774
|
+
* Journey id the customer needs to fill out
|
|
5775
|
+
*/
|
|
5776
|
+
journey_id: string;
|
|
5777
|
+
/**
|
|
5778
|
+
* Whether submitting the journey from the portal should auto-complete the task. When false, an internal user completes it.
|
|
5779
|
+
*/
|
|
5780
|
+
complete_task_automatically?: boolean;
|
|
5781
|
+
}
|
|
5720
5782
|
export interface Page {
|
|
5721
5783
|
[name: string]: any;
|
|
5722
5784
|
/**
|
|
@@ -6527,6 +6589,10 @@ declare namespace Components {
|
|
|
6527
6589
|
global_blocks?: {
|
|
6528
6590
|
[name: string]: Block;
|
|
6529
6591
|
};
|
|
6592
|
+
/**
|
|
6593
|
+
* Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
|
|
6594
|
+
*/
|
|
6595
|
+
notification_triggers?: NotificationTriggerConfig[];
|
|
6530
6596
|
/**
|
|
6531
6597
|
* ID of the organization
|
|
6532
6598
|
* example:
|
|
@@ -7248,6 +7314,57 @@ declare namespace Components {
|
|
|
7248
7314
|
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
7249
7315
|
*/
|
|
7250
7316
|
export type PortalId = string;
|
|
7317
|
+
/**
|
|
7318
|
+
* A 360 notification addressed to a portal user.
|
|
7319
|
+
*/
|
|
7320
|
+
export interface PortalNotification {
|
|
7321
|
+
/**
|
|
7322
|
+
* Stable string identifier of the notification (the numeric notification id as a string).
|
|
7323
|
+
* example:
|
|
7324
|
+
* 1234567890
|
|
7325
|
+
*/
|
|
7326
|
+
id: string;
|
|
7327
|
+
/**
|
|
7328
|
+
* Numeric id of the notification, used to mark it as read.
|
|
7329
|
+
* example:
|
|
7330
|
+
* 1234567890
|
|
7331
|
+
*/
|
|
7332
|
+
notification_id?: number;
|
|
7333
|
+
/**
|
|
7334
|
+
* Type of notification.
|
|
7335
|
+
* example:
|
|
7336
|
+
* workflow_step_overdue
|
|
7337
|
+
*/
|
|
7338
|
+
type?: string;
|
|
7339
|
+
/**
|
|
7340
|
+
* Localized, already-rendered notification title.
|
|
7341
|
+
*/
|
|
7342
|
+
title?: {
|
|
7343
|
+
en?: string;
|
|
7344
|
+
de?: string;
|
|
7345
|
+
};
|
|
7346
|
+
/**
|
|
7347
|
+
* Localized, already-rendered notification message.
|
|
7348
|
+
*/
|
|
7349
|
+
message?: {
|
|
7350
|
+
en?: string;
|
|
7351
|
+
de?: string;
|
|
7352
|
+
};
|
|
7353
|
+
/**
|
|
7354
|
+
* When the notification was created.
|
|
7355
|
+
*/
|
|
7356
|
+
created_at?: string; // date-time
|
|
7357
|
+
/**
|
|
7358
|
+
* Whether the notification has been read by the user.
|
|
7359
|
+
* example:
|
|
7360
|
+
* false
|
|
7361
|
+
*/
|
|
7362
|
+
read: boolean;
|
|
7363
|
+
/**
|
|
7364
|
+
* Optional URL the notification points to.
|
|
7365
|
+
*/
|
|
7366
|
+
redirect_url?: string;
|
|
7367
|
+
}
|
|
7251
7368
|
/**
|
|
7252
7369
|
* Portal-specific (ECP / installer) display config of a workflow task
|
|
7253
7370
|
*/
|
|
@@ -8852,6 +8969,10 @@ declare namespace Components {
|
|
|
8852
8969
|
global_blocks?: {
|
|
8853
8970
|
[name: string]: Block;
|
|
8854
8971
|
};
|
|
8972
|
+
/**
|
|
8973
|
+
* Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
|
|
8974
|
+
*/
|
|
8975
|
+
notification_triggers?: NotificationTriggerConfig[];
|
|
8855
8976
|
}
|
|
8856
8977
|
export interface UpsertPortalConfigV3 {
|
|
8857
8978
|
/**
|
|
@@ -13375,6 +13496,10 @@ declare namespace Paths {
|
|
|
13375
13496
|
global_blocks?: {
|
|
13376
13497
|
[name: string]: Components.Schemas.Block;
|
|
13377
13498
|
};
|
|
13499
|
+
/**
|
|
13500
|
+
* Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
|
|
13501
|
+
*/
|
|
13502
|
+
notification_triggers?: Components.Schemas.NotificationTriggerConfig[];
|
|
13378
13503
|
/**
|
|
13379
13504
|
* ID of the organization
|
|
13380
13505
|
* example:
|
|
@@ -13993,6 +14118,10 @@ declare namespace Paths {
|
|
|
13993
14118
|
global_blocks?: {
|
|
13994
14119
|
[name: string]: Components.Schemas.Block;
|
|
13995
14120
|
};
|
|
14121
|
+
/**
|
|
14122
|
+
* Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
|
|
14123
|
+
*/
|
|
14124
|
+
notification_triggers?: Components.Schemas.NotificationTriggerConfig[];
|
|
13996
14125
|
/**
|
|
13997
14126
|
* ID of the organization
|
|
13998
14127
|
* example:
|
|
@@ -14111,6 +14240,21 @@ declare namespace Paths {
|
|
|
14111
14240
|
export type $500 = Components.Responses.InternalServerError;
|
|
14112
14241
|
}
|
|
14113
14242
|
}
|
|
14243
|
+
namespace GetOutstandingTasks {
|
|
14244
|
+
namespace Responses {
|
|
14245
|
+
export interface $200 {
|
|
14246
|
+
tasks: Components.Schemas.OutstandingTask[];
|
|
14247
|
+
/**
|
|
14248
|
+
* example:
|
|
14249
|
+
* 0
|
|
14250
|
+
*/
|
|
14251
|
+
total: number;
|
|
14252
|
+
}
|
|
14253
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14254
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14255
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14256
|
+
}
|
|
14257
|
+
}
|
|
14114
14258
|
namespace GetPortalConfig {
|
|
14115
14259
|
namespace Parameters {
|
|
14116
14260
|
export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
|
|
@@ -14203,6 +14347,20 @@ declare namespace Paths {
|
|
|
14203
14347
|
export type $500 = Components.Responses.InternalServerError;
|
|
14204
14348
|
}
|
|
14205
14349
|
}
|
|
14350
|
+
namespace GetPortalNotificationsUnreadCount {
|
|
14351
|
+
namespace Responses {
|
|
14352
|
+
export interface $200 {
|
|
14353
|
+
/**
|
|
14354
|
+
* example:
|
|
14355
|
+
* 3
|
|
14356
|
+
*/
|
|
14357
|
+
count?: number;
|
|
14358
|
+
}
|
|
14359
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14360
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14361
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14362
|
+
}
|
|
14363
|
+
}
|
|
14206
14364
|
namespace GetPortalPage {
|
|
14207
14365
|
namespace Responses {
|
|
14208
14366
|
export type $200 = Components.Schemas.Page;
|
|
@@ -15355,6 +15513,32 @@ declare namespace Paths {
|
|
|
15355
15513
|
export type $500 = Components.Responses.InternalServerError;
|
|
15356
15514
|
}
|
|
15357
15515
|
}
|
|
15516
|
+
namespace ListPortalNotifications {
|
|
15517
|
+
namespace Parameters {
|
|
15518
|
+
export type Cursor = string;
|
|
15519
|
+
export type Limit = number;
|
|
15520
|
+
}
|
|
15521
|
+
export interface QueryParameters {
|
|
15522
|
+
cursor?: Parameters.Cursor;
|
|
15523
|
+
limit?: Parameters.Limit;
|
|
15524
|
+
}
|
|
15525
|
+
namespace Responses {
|
|
15526
|
+
export interface $200 {
|
|
15527
|
+
/**
|
|
15528
|
+
* Base64 encoded cursor to fetch the next page. Absent when there are no more results.
|
|
15529
|
+
*/
|
|
15530
|
+
cursor?: string;
|
|
15531
|
+
/**
|
|
15532
|
+
* Total number of unread notifications for the user.
|
|
15533
|
+
*/
|
|
15534
|
+
total_unread?: number;
|
|
15535
|
+
results?: /* A 360 notification addressed to a portal user. */ Components.Schemas.PortalNotification[];
|
|
15536
|
+
}
|
|
15537
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
15538
|
+
export type $403 = Components.Responses.Forbidden;
|
|
15539
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
15540
|
+
}
|
|
15541
|
+
}
|
|
15358
15542
|
namespace LoginToPortalAsUser {
|
|
15359
15543
|
export interface RequestBody {
|
|
15360
15544
|
/**
|
|
@@ -15382,6 +15566,31 @@ declare namespace Paths {
|
|
|
15382
15566
|
}
|
|
15383
15567
|
}
|
|
15384
15568
|
}
|
|
15569
|
+
namespace MarkAllPortalNotificationsRead {
|
|
15570
|
+
namespace Responses {
|
|
15571
|
+
export interface $204 {
|
|
15572
|
+
}
|
|
15573
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
15574
|
+
export type $403 = Components.Responses.Forbidden;
|
|
15575
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
15576
|
+
}
|
|
15577
|
+
}
|
|
15578
|
+
namespace MarkPortalNotificationRead {
|
|
15579
|
+
namespace Parameters {
|
|
15580
|
+
export type Id = number;
|
|
15581
|
+
}
|
|
15582
|
+
export interface PathParameters {
|
|
15583
|
+
id: Parameters.Id;
|
|
15584
|
+
}
|
|
15585
|
+
namespace Responses {
|
|
15586
|
+
export interface $204 {
|
|
15587
|
+
}
|
|
15588
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
15589
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
15590
|
+
export type $403 = Components.Responses.Forbidden;
|
|
15591
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
15592
|
+
}
|
|
15593
|
+
}
|
|
15385
15594
|
namespace MigrateEmailTemplateReferences {
|
|
15386
15595
|
export interface RequestBody {
|
|
15387
15596
|
/**
|
|
@@ -16968,7 +17177,6 @@ declare namespace Paths {
|
|
|
16968
17177
|
}
|
|
16969
17178
|
}
|
|
16970
17179
|
|
|
16971
|
-
|
|
16972
17180
|
export interface OperationMethods {
|
|
16973
17181
|
/**
|
|
16974
17182
|
* upsertPortal - upsertPortal
|
|
@@ -18182,6 +18390,16 @@ export interface OperationMethods {
|
|
|
18182
18390
|
data?: any,
|
|
18183
18391
|
config?: AxiosRequestConfig
|
|
18184
18392
|
): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
|
|
18393
|
+
/**
|
|
18394
|
+
* getOutstandingTasks - Get outstanding workflow tasks for the portal user
|
|
18395
|
+
*
|
|
18396
|
+
* Returns all outstanding workflow journey tasks for the authenticated portal user, across their opportunity, order and contract entities. Each task is an active workflow step that exposes a journey the customer still needs to fill out.
|
|
18397
|
+
*/
|
|
18398
|
+
'getOutstandingTasks'(
|
|
18399
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
18400
|
+
data?: any,
|
|
18401
|
+
config?: AxiosRequestConfig
|
|
18402
|
+
): OperationResponse<Paths.GetOutstandingTasks.Responses.$200>
|
|
18185
18403
|
/**
|
|
18186
18404
|
* getEntityPortalWorkflows - getEntityPortalWorkflows
|
|
18187
18405
|
*
|
|
@@ -18510,6 +18728,46 @@ export interface OperationMethods {
|
|
|
18510
18728
|
data?: Paths.UpdateCampaignPortalBlockStatus.RequestBody,
|
|
18511
18729
|
config?: AxiosRequestConfig
|
|
18512
18730
|
): OperationResponse<Paths.UpdateCampaignPortalBlockStatus.Responses.$200>
|
|
18731
|
+
/**
|
|
18732
|
+
* listPortalNotifications - listPortalNotifications
|
|
18733
|
+
*
|
|
18734
|
+
* Lists the 360 notifications addressed to the authenticated portal user, newest first. The organization and the portal user are derived from the authenticated session, so a user can only ever read their own notifications.
|
|
18735
|
+
*/
|
|
18736
|
+
'listPortalNotifications'(
|
|
18737
|
+
parameters?: Parameters<Paths.ListPortalNotifications.QueryParameters> | null,
|
|
18738
|
+
data?: any,
|
|
18739
|
+
config?: AxiosRequestConfig
|
|
18740
|
+
): OperationResponse<Paths.ListPortalNotifications.Responses.$200>
|
|
18741
|
+
/**
|
|
18742
|
+
* getPortalNotificationsUnreadCount - getPortalNotificationsUnreadCount
|
|
18743
|
+
*
|
|
18744
|
+
* Returns the number of unread notifications for the authenticated portal user.
|
|
18745
|
+
*/
|
|
18746
|
+
'getPortalNotificationsUnreadCount'(
|
|
18747
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
18748
|
+
data?: any,
|
|
18749
|
+
config?: AxiosRequestConfig
|
|
18750
|
+
): OperationResponse<Paths.GetPortalNotificationsUnreadCount.Responses.$200>
|
|
18751
|
+
/**
|
|
18752
|
+
* markAllPortalNotificationsRead - markAllPortalNotificationsRead
|
|
18753
|
+
*
|
|
18754
|
+
* Marks all notifications of the authenticated portal user as read.
|
|
18755
|
+
*/
|
|
18756
|
+
'markAllPortalNotificationsRead'(
|
|
18757
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
18758
|
+
data?: any,
|
|
18759
|
+
config?: AxiosRequestConfig
|
|
18760
|
+
): OperationResponse<Paths.MarkAllPortalNotificationsRead.Responses.$204>
|
|
18761
|
+
/**
|
|
18762
|
+
* markPortalNotificationRead - markPortalNotificationRead
|
|
18763
|
+
*
|
|
18764
|
+
* Marks a single notification of the authenticated portal user as read.
|
|
18765
|
+
*/
|
|
18766
|
+
'markPortalNotificationRead'(
|
|
18767
|
+
parameters?: Parameters<Paths.MarkPortalNotificationRead.PathParameters> | null,
|
|
18768
|
+
data?: any,
|
|
18769
|
+
config?: AxiosRequestConfig
|
|
18770
|
+
): OperationResponse<Paths.MarkPortalNotificationRead.Responses.$204>
|
|
18513
18771
|
/**
|
|
18514
18772
|
* updateNotificationsStatus - updateNotificationsStatus
|
|
18515
18773
|
*
|
|
@@ -20136,6 +20394,18 @@ export interface PathsDictionary {
|
|
|
20136
20394
|
config?: AxiosRequestConfig
|
|
20137
20395
|
): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
|
|
20138
20396
|
}
|
|
20397
|
+
['/v2/portal/engagement/tasks']: {
|
|
20398
|
+
/**
|
|
20399
|
+
* getOutstandingTasks - Get outstanding workflow tasks for the portal user
|
|
20400
|
+
*
|
|
20401
|
+
* Returns all outstanding workflow journey tasks for the authenticated portal user, across their opportunity, order and contract entities. Each task is an active workflow step that exposes a journey the customer still needs to fill out.
|
|
20402
|
+
*/
|
|
20403
|
+
'get'(
|
|
20404
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
20405
|
+
data?: any,
|
|
20406
|
+
config?: AxiosRequestConfig
|
|
20407
|
+
): OperationResponse<Paths.GetOutstandingTasks.Responses.$200>
|
|
20408
|
+
}
|
|
20139
20409
|
['/v2/portal/entity/{slug}/{id}/workflows/linearized']: {
|
|
20140
20410
|
/**
|
|
20141
20411
|
* getEntityPortalWorkflows - getEntityPortalWorkflows
|
|
@@ -20506,6 +20776,54 @@ export interface PathsDictionary {
|
|
|
20506
20776
|
config?: AxiosRequestConfig
|
|
20507
20777
|
): OperationResponse<Paths.UpdateCampaignPortalBlockStatus.Responses.$200>
|
|
20508
20778
|
}
|
|
20779
|
+
['/v2/portal/notifications']: {
|
|
20780
|
+
/**
|
|
20781
|
+
* listPortalNotifications - listPortalNotifications
|
|
20782
|
+
*
|
|
20783
|
+
* Lists the 360 notifications addressed to the authenticated portal user, newest first. The organization and the portal user are derived from the authenticated session, so a user can only ever read their own notifications.
|
|
20784
|
+
*/
|
|
20785
|
+
'get'(
|
|
20786
|
+
parameters?: Parameters<Paths.ListPortalNotifications.QueryParameters> | null,
|
|
20787
|
+
data?: any,
|
|
20788
|
+
config?: AxiosRequestConfig
|
|
20789
|
+
): OperationResponse<Paths.ListPortalNotifications.Responses.$200>
|
|
20790
|
+
}
|
|
20791
|
+
['/v2/portal/notifications/unread-count']: {
|
|
20792
|
+
/**
|
|
20793
|
+
* getPortalNotificationsUnreadCount - getPortalNotificationsUnreadCount
|
|
20794
|
+
*
|
|
20795
|
+
* Returns the number of unread notifications for the authenticated portal user.
|
|
20796
|
+
*/
|
|
20797
|
+
'get'(
|
|
20798
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
20799
|
+
data?: any,
|
|
20800
|
+
config?: AxiosRequestConfig
|
|
20801
|
+
): OperationResponse<Paths.GetPortalNotificationsUnreadCount.Responses.$200>
|
|
20802
|
+
}
|
|
20803
|
+
['/v2/portal/notifications/read-all']: {
|
|
20804
|
+
/**
|
|
20805
|
+
* markAllPortalNotificationsRead - markAllPortalNotificationsRead
|
|
20806
|
+
*
|
|
20807
|
+
* Marks all notifications of the authenticated portal user as read.
|
|
20808
|
+
*/
|
|
20809
|
+
'put'(
|
|
20810
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
20811
|
+
data?: any,
|
|
20812
|
+
config?: AxiosRequestConfig
|
|
20813
|
+
): OperationResponse<Paths.MarkAllPortalNotificationsRead.Responses.$204>
|
|
20814
|
+
}
|
|
20815
|
+
['/v2/portal/notifications/{id}/read']: {
|
|
20816
|
+
/**
|
|
20817
|
+
* markPortalNotificationRead - markPortalNotificationRead
|
|
20818
|
+
*
|
|
20819
|
+
* Marks a single notification of the authenticated portal user as read.
|
|
20820
|
+
*/
|
|
20821
|
+
'put'(
|
|
20822
|
+
parameters?: Parameters<Paths.MarkPortalNotificationRead.PathParameters> | null,
|
|
20823
|
+
data?: any,
|
|
20824
|
+
config?: AxiosRequestConfig
|
|
20825
|
+
): OperationResponse<Paths.MarkPortalNotificationRead.Responses.$204>
|
|
20826
|
+
}
|
|
20509
20827
|
['/v2/portal/notifications/entity:status']: {
|
|
20510
20828
|
/**
|
|
20511
20829
|
* updateNotificationsStatus - updateNotificationsStatus
|
|
@@ -20749,7 +21067,6 @@ export interface PathsDictionary {
|
|
|
20749
21067
|
|
|
20750
21068
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
20751
21069
|
|
|
20752
|
-
|
|
20753
21070
|
export type AcceptanceDecision = Components.Schemas.AcceptanceDecision;
|
|
20754
21071
|
export type AccountExistsRequest = Components.Schemas.AccountExistsRequest;
|
|
20755
21072
|
export type ActionLabel = Components.Schemas.ActionLabel;
|
|
@@ -20851,6 +21168,7 @@ export type MobileConfig = Components.Schemas.MobileConfig;
|
|
|
20851
21168
|
export type MobileConfigUpdate = Components.Schemas.MobileConfigUpdate;
|
|
20852
21169
|
export type MobileOtaConfig = Components.Schemas.MobileOtaConfig;
|
|
20853
21170
|
export type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
|
|
21171
|
+
export type NotificationTriggerConfig = Components.Schemas.NotificationTriggerConfig;
|
|
20854
21172
|
export type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
|
|
20855
21173
|
export type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
|
|
20856
21174
|
export type Opportunity = Components.Schemas.Opportunity;
|
|
@@ -20858,6 +21176,7 @@ export type Order = Components.Schemas.Order;
|
|
|
20858
21176
|
export type OrganizationSettings = Components.Schemas.OrganizationSettings;
|
|
20859
21177
|
export type Origin = Components.Schemas.Origin;
|
|
20860
21178
|
export type OtaPortal = Components.Schemas.OtaPortal;
|
|
21179
|
+
export type OutstandingTask = Components.Schemas.OutstandingTask;
|
|
20861
21180
|
export type Page = Components.Schemas.Page;
|
|
20862
21181
|
export type PageRequest = Components.Schemas.PageRequest;
|
|
20863
21182
|
export type PaymentWidget = Components.Schemas.PaymentWidget;
|
|
@@ -20865,6 +21184,7 @@ export type PortalConfig = Components.Schemas.PortalConfig;
|
|
|
20865
21184
|
export type PortalConfigV3 = Components.Schemas.PortalConfigV3;
|
|
20866
21185
|
export type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
|
|
20867
21186
|
export type PortalId = Components.Schemas.PortalId;
|
|
21187
|
+
export type PortalNotification = Components.Schemas.PortalNotification;
|
|
20868
21188
|
export type PortalTaskConfig = Components.Schemas.PortalTaskConfig;
|
|
20869
21189
|
export type PortalUser = Components.Schemas.PortalUser;
|
|
20870
21190
|
export type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
|
package/package.json
CHANGED
package/src/openapi-runtime.json
CHANGED
|
@@ -1967,6 +1967,12 @@
|
|
|
1967
1967
|
"responses": {}
|
|
1968
1968
|
}
|
|
1969
1969
|
},
|
|
1970
|
+
"/v2/portal/engagement/tasks": {
|
|
1971
|
+
"get": {
|
|
1972
|
+
"operationId": "getOutstandingTasks",
|
|
1973
|
+
"responses": {}
|
|
1974
|
+
}
|
|
1975
|
+
},
|
|
1970
1976
|
"/v2/portal/entity/{slug}/{id}/workflows/linearized": {
|
|
1971
1977
|
"get": {
|
|
1972
1978
|
"operationId": "getEntityPortalWorkflows",
|
|
@@ -2426,6 +2432,49 @@
|
|
|
2426
2432
|
"responses": {}
|
|
2427
2433
|
}
|
|
2428
2434
|
},
|
|
2435
|
+
"/v2/portal/notifications": {
|
|
2436
|
+
"get": {
|
|
2437
|
+
"operationId": "listPortalNotifications",
|
|
2438
|
+
"parameters": [
|
|
2439
|
+
{
|
|
2440
|
+
"in": "query",
|
|
2441
|
+
"name": "cursor",
|
|
2442
|
+
"required": false
|
|
2443
|
+
},
|
|
2444
|
+
{
|
|
2445
|
+
"in": "query",
|
|
2446
|
+
"name": "limit",
|
|
2447
|
+
"required": false
|
|
2448
|
+
}
|
|
2449
|
+
],
|
|
2450
|
+
"responses": {}
|
|
2451
|
+
}
|
|
2452
|
+
},
|
|
2453
|
+
"/v2/portal/notifications/unread-count": {
|
|
2454
|
+
"get": {
|
|
2455
|
+
"operationId": "getPortalNotificationsUnreadCount",
|
|
2456
|
+
"responses": {}
|
|
2457
|
+
}
|
|
2458
|
+
},
|
|
2459
|
+
"/v2/portal/notifications/read-all": {
|
|
2460
|
+
"put": {
|
|
2461
|
+
"operationId": "markAllPortalNotificationsRead",
|
|
2462
|
+
"responses": {}
|
|
2463
|
+
}
|
|
2464
|
+
},
|
|
2465
|
+
"/v2/portal/notifications/{id}/read": {
|
|
2466
|
+
"put": {
|
|
2467
|
+
"operationId": "markPortalNotificationRead",
|
|
2468
|
+
"parameters": [
|
|
2469
|
+
{
|
|
2470
|
+
"in": "path",
|
|
2471
|
+
"name": "id",
|
|
2472
|
+
"required": true
|
|
2473
|
+
}
|
|
2474
|
+
],
|
|
2475
|
+
"responses": {}
|
|
2476
|
+
}
|
|
2477
|
+
},
|
|
2429
2478
|
"/v2/portal/notifications/entity:status": {
|
|
2430
2479
|
"put": {
|
|
2431
2480
|
"operationId": "updateNotificationsStatus",
|
package/src/openapi.json
CHANGED
|
@@ -8031,6 +8031,58 @@
|
|
|
8031
8031
|
}
|
|
8032
8032
|
}
|
|
8033
8033
|
},
|
|
8034
|
+
"/v2/portal/engagement/tasks": {
|
|
8035
|
+
"get": {
|
|
8036
|
+
"operationId": "getOutstandingTasks",
|
|
8037
|
+
"summary": "Get outstanding workflow tasks for the portal user",
|
|
8038
|
+
"description": "Returns all outstanding workflow journey tasks for the authenticated portal user, across their opportunity, order and contract entities. Each task is an active workflow step that exposes a journey the customer still needs to fill out.",
|
|
8039
|
+
"tags": [
|
|
8040
|
+
"ECP"
|
|
8041
|
+
],
|
|
8042
|
+
"security": [
|
|
8043
|
+
{
|
|
8044
|
+
"PortalAuth": []
|
|
8045
|
+
}
|
|
8046
|
+
],
|
|
8047
|
+
"responses": {
|
|
8048
|
+
"200": {
|
|
8049
|
+
"description": "List of outstanding workflow tasks for the portal user",
|
|
8050
|
+
"content": {
|
|
8051
|
+
"application/json": {
|
|
8052
|
+
"schema": {
|
|
8053
|
+
"type": "object",
|
|
8054
|
+
"required": [
|
|
8055
|
+
"tasks",
|
|
8056
|
+
"total"
|
|
8057
|
+
],
|
|
8058
|
+
"properties": {
|
|
8059
|
+
"tasks": {
|
|
8060
|
+
"type": "array",
|
|
8061
|
+
"items": {
|
|
8062
|
+
"$ref": "#/components/schemas/OutstandingTask"
|
|
8063
|
+
}
|
|
8064
|
+
},
|
|
8065
|
+
"total": {
|
|
8066
|
+
"type": "integer",
|
|
8067
|
+
"example": 0
|
|
8068
|
+
}
|
|
8069
|
+
}
|
|
8070
|
+
}
|
|
8071
|
+
}
|
|
8072
|
+
}
|
|
8073
|
+
},
|
|
8074
|
+
"401": {
|
|
8075
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
8076
|
+
},
|
|
8077
|
+
"403": {
|
|
8078
|
+
"$ref": "#/components/responses/Forbidden"
|
|
8079
|
+
},
|
|
8080
|
+
"500": {
|
|
8081
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
8082
|
+
}
|
|
8083
|
+
}
|
|
8084
|
+
}
|
|
8085
|
+
},
|
|
8034
8086
|
"/v2/portal/entity/{slug}/{id}/workflows/linearized": {
|
|
8035
8087
|
"get": {
|
|
8036
8088
|
"operationId": "getEntityPortalWorkflows",
|
|
@@ -9881,6 +9933,192 @@
|
|
|
9881
9933
|
}
|
|
9882
9934
|
}
|
|
9883
9935
|
},
|
|
9936
|
+
"/v2/portal/notifications": {
|
|
9937
|
+
"get": {
|
|
9938
|
+
"operationId": "listPortalNotifications",
|
|
9939
|
+
"summary": "listPortalNotifications",
|
|
9940
|
+
"description": "Lists the 360 notifications addressed to the authenticated portal user, newest first. The organization and the portal user are derived from the authenticated session, so a user can only ever read their own notifications.",
|
|
9941
|
+
"tags": [
|
|
9942
|
+
"ECP"
|
|
9943
|
+
],
|
|
9944
|
+
"security": [
|
|
9945
|
+
{
|
|
9946
|
+
"PortalAuth": []
|
|
9947
|
+
}
|
|
9948
|
+
],
|
|
9949
|
+
"parameters": [
|
|
9950
|
+
{
|
|
9951
|
+
"in": "query",
|
|
9952
|
+
"name": "cursor",
|
|
9953
|
+
"required": false,
|
|
9954
|
+
"schema": {
|
|
9955
|
+
"type": "string"
|
|
9956
|
+
},
|
|
9957
|
+
"description": "Base64 encoded cursor returned by a previous call, used for pagination."
|
|
9958
|
+
},
|
|
9959
|
+
{
|
|
9960
|
+
"in": "query",
|
|
9961
|
+
"name": "limit",
|
|
9962
|
+
"required": false,
|
|
9963
|
+
"schema": {
|
|
9964
|
+
"type": "integer"
|
|
9965
|
+
},
|
|
9966
|
+
"description": "The maximum number of notifications to return."
|
|
9967
|
+
}
|
|
9968
|
+
],
|
|
9969
|
+
"responses": {
|
|
9970
|
+
"200": {
|
|
9971
|
+
"description": "List of notifications for the authenticated portal user.",
|
|
9972
|
+
"content": {
|
|
9973
|
+
"application/json": {
|
|
9974
|
+
"schema": {
|
|
9975
|
+
"type": "object",
|
|
9976
|
+
"properties": {
|
|
9977
|
+
"cursor": {
|
|
9978
|
+
"type": "string",
|
|
9979
|
+
"description": "Base64 encoded cursor to fetch the next page. Absent when there are no more results."
|
|
9980
|
+
},
|
|
9981
|
+
"total_unread": {
|
|
9982
|
+
"type": "integer",
|
|
9983
|
+
"description": "Total number of unread notifications for the user."
|
|
9984
|
+
},
|
|
9985
|
+
"results": {
|
|
9986
|
+
"type": "array",
|
|
9987
|
+
"items": {
|
|
9988
|
+
"$ref": "#/components/schemas/PortalNotification"
|
|
9989
|
+
}
|
|
9990
|
+
}
|
|
9991
|
+
}
|
|
9992
|
+
}
|
|
9993
|
+
}
|
|
9994
|
+
}
|
|
9995
|
+
},
|
|
9996
|
+
"401": {
|
|
9997
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
9998
|
+
},
|
|
9999
|
+
"403": {
|
|
10000
|
+
"$ref": "#/components/responses/Forbidden"
|
|
10001
|
+
},
|
|
10002
|
+
"500": {
|
|
10003
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
10004
|
+
}
|
|
10005
|
+
}
|
|
10006
|
+
}
|
|
10007
|
+
},
|
|
10008
|
+
"/v2/portal/notifications/unread-count": {
|
|
10009
|
+
"get": {
|
|
10010
|
+
"operationId": "getPortalNotificationsUnreadCount",
|
|
10011
|
+
"summary": "getPortalNotificationsUnreadCount",
|
|
10012
|
+
"description": "Returns the number of unread notifications for the authenticated portal user.",
|
|
10013
|
+
"tags": [
|
|
10014
|
+
"ECP"
|
|
10015
|
+
],
|
|
10016
|
+
"security": [
|
|
10017
|
+
{
|
|
10018
|
+
"PortalAuth": []
|
|
10019
|
+
}
|
|
10020
|
+
],
|
|
10021
|
+
"responses": {
|
|
10022
|
+
"200": {
|
|
10023
|
+
"description": "Unread notification count.",
|
|
10024
|
+
"content": {
|
|
10025
|
+
"application/json": {
|
|
10026
|
+
"schema": {
|
|
10027
|
+
"type": "object",
|
|
10028
|
+
"properties": {
|
|
10029
|
+
"count": {
|
|
10030
|
+
"type": "integer",
|
|
10031
|
+
"example": 3
|
|
10032
|
+
}
|
|
10033
|
+
}
|
|
10034
|
+
}
|
|
10035
|
+
}
|
|
10036
|
+
}
|
|
10037
|
+
},
|
|
10038
|
+
"401": {
|
|
10039
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
10040
|
+
},
|
|
10041
|
+
"403": {
|
|
10042
|
+
"$ref": "#/components/responses/Forbidden"
|
|
10043
|
+
},
|
|
10044
|
+
"500": {
|
|
10045
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
10046
|
+
}
|
|
10047
|
+
}
|
|
10048
|
+
}
|
|
10049
|
+
},
|
|
10050
|
+
"/v2/portal/notifications/read-all": {
|
|
10051
|
+
"put": {
|
|
10052
|
+
"operationId": "markAllPortalNotificationsRead",
|
|
10053
|
+
"summary": "markAllPortalNotificationsRead",
|
|
10054
|
+
"description": "Marks all notifications of the authenticated portal user as read.",
|
|
10055
|
+
"tags": [
|
|
10056
|
+
"ECP"
|
|
10057
|
+
],
|
|
10058
|
+
"security": [
|
|
10059
|
+
{
|
|
10060
|
+
"PortalAuth": []
|
|
10061
|
+
}
|
|
10062
|
+
],
|
|
10063
|
+
"responses": {
|
|
10064
|
+
"204": {
|
|
10065
|
+
"description": "All notifications marked as read."
|
|
10066
|
+
},
|
|
10067
|
+
"401": {
|
|
10068
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
10069
|
+
},
|
|
10070
|
+
"403": {
|
|
10071
|
+
"$ref": "#/components/responses/Forbidden"
|
|
10072
|
+
},
|
|
10073
|
+
"500": {
|
|
10074
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
10075
|
+
}
|
|
10076
|
+
}
|
|
10077
|
+
}
|
|
10078
|
+
},
|
|
10079
|
+
"/v2/portal/notifications/{id}/read": {
|
|
10080
|
+
"put": {
|
|
10081
|
+
"operationId": "markPortalNotificationRead",
|
|
10082
|
+
"summary": "markPortalNotificationRead",
|
|
10083
|
+
"description": "Marks a single notification of the authenticated portal user as read.",
|
|
10084
|
+
"tags": [
|
|
10085
|
+
"ECP"
|
|
10086
|
+
],
|
|
10087
|
+
"security": [
|
|
10088
|
+
{
|
|
10089
|
+
"PortalAuth": []
|
|
10090
|
+
}
|
|
10091
|
+
],
|
|
10092
|
+
"parameters": [
|
|
10093
|
+
{
|
|
10094
|
+
"in": "path",
|
|
10095
|
+
"name": "id",
|
|
10096
|
+
"required": true,
|
|
10097
|
+
"schema": {
|
|
10098
|
+
"type": "integer"
|
|
10099
|
+
},
|
|
10100
|
+
"description": "Numeric id of the notification to mark as read."
|
|
10101
|
+
}
|
|
10102
|
+
],
|
|
10103
|
+
"responses": {
|
|
10104
|
+
"204": {
|
|
10105
|
+
"description": "Notification marked as read."
|
|
10106
|
+
},
|
|
10107
|
+
"400": {
|
|
10108
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
10109
|
+
},
|
|
10110
|
+
"401": {
|
|
10111
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
10112
|
+
},
|
|
10113
|
+
"403": {
|
|
10114
|
+
"$ref": "#/components/responses/Forbidden"
|
|
10115
|
+
},
|
|
10116
|
+
"500": {
|
|
10117
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
10118
|
+
}
|
|
10119
|
+
}
|
|
10120
|
+
}
|
|
10121
|
+
},
|
|
9884
10122
|
"/v2/portal/notifications/entity:status": {
|
|
9885
10123
|
"put": {
|
|
9886
10124
|
"operationId": "updateNotificationsStatus",
|
|
@@ -11404,6 +11642,69 @@
|
|
|
11404
11642
|
}
|
|
11405
11643
|
},
|
|
11406
11644
|
"schemas": {
|
|
11645
|
+
"PortalNotification": {
|
|
11646
|
+
"type": "object",
|
|
11647
|
+
"description": "A 360 notification addressed to a portal user.",
|
|
11648
|
+
"required": [
|
|
11649
|
+
"id",
|
|
11650
|
+
"read"
|
|
11651
|
+
],
|
|
11652
|
+
"properties": {
|
|
11653
|
+
"id": {
|
|
11654
|
+
"type": "string",
|
|
11655
|
+
"description": "Stable string identifier of the notification (the numeric notification id as a string).",
|
|
11656
|
+
"example": "1234567890"
|
|
11657
|
+
},
|
|
11658
|
+
"notification_id": {
|
|
11659
|
+
"type": "number",
|
|
11660
|
+
"description": "Numeric id of the notification, used to mark it as read.",
|
|
11661
|
+
"example": 1234567890
|
|
11662
|
+
},
|
|
11663
|
+
"type": {
|
|
11664
|
+
"type": "string",
|
|
11665
|
+
"description": "Type of notification.",
|
|
11666
|
+
"example": "workflow_step_overdue"
|
|
11667
|
+
},
|
|
11668
|
+
"title": {
|
|
11669
|
+
"type": "object",
|
|
11670
|
+
"description": "Localized, already-rendered notification title.",
|
|
11671
|
+
"properties": {
|
|
11672
|
+
"en": {
|
|
11673
|
+
"type": "string"
|
|
11674
|
+
},
|
|
11675
|
+
"de": {
|
|
11676
|
+
"type": "string"
|
|
11677
|
+
}
|
|
11678
|
+
}
|
|
11679
|
+
},
|
|
11680
|
+
"message": {
|
|
11681
|
+
"type": "object",
|
|
11682
|
+
"description": "Localized, already-rendered notification message.",
|
|
11683
|
+
"properties": {
|
|
11684
|
+
"en": {
|
|
11685
|
+
"type": "string"
|
|
11686
|
+
},
|
|
11687
|
+
"de": {
|
|
11688
|
+
"type": "string"
|
|
11689
|
+
}
|
|
11690
|
+
}
|
|
11691
|
+
},
|
|
11692
|
+
"created_at": {
|
|
11693
|
+
"type": "string",
|
|
11694
|
+
"format": "date-time",
|
|
11695
|
+
"description": "When the notification was created."
|
|
11696
|
+
},
|
|
11697
|
+
"read": {
|
|
11698
|
+
"type": "boolean",
|
|
11699
|
+
"description": "Whether the notification has been read by the user.",
|
|
11700
|
+
"example": false
|
|
11701
|
+
},
|
|
11702
|
+
"redirect_url": {
|
|
11703
|
+
"type": "string",
|
|
11704
|
+
"description": "Optional URL the notification points to."
|
|
11705
|
+
}
|
|
11706
|
+
}
|
|
11707
|
+
},
|
|
11407
11708
|
"MobileBuildStatus": {
|
|
11408
11709
|
"type": "object",
|
|
11409
11710
|
"description": "Latest build/upload status for a platform (system-written).",
|
|
@@ -12719,6 +13020,45 @@
|
|
|
12719
13020
|
"additionalProperties": {
|
|
12720
13021
|
"$ref": "#/components/schemas/Block"
|
|
12721
13022
|
}
|
|
13023
|
+
},
|
|
13024
|
+
"notification_triggers": {
|
|
13025
|
+
"type": "array",
|
|
13026
|
+
"description": "Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.",
|
|
13027
|
+
"items": {
|
|
13028
|
+
"$ref": "#/components/schemas/NotificationTriggerConfig"
|
|
13029
|
+
}
|
|
13030
|
+
}
|
|
13031
|
+
}
|
|
13032
|
+
},
|
|
13033
|
+
"NotificationTriggerConfig": {
|
|
13034
|
+
"type": "object",
|
|
13035
|
+
"required": [
|
|
13036
|
+
"trigger_type"
|
|
13037
|
+
],
|
|
13038
|
+
"properties": {
|
|
13039
|
+
"trigger_type": {
|
|
13040
|
+
"type": "string",
|
|
13041
|
+
"description": "The 360 event that fires this notification trigger.",
|
|
13042
|
+
"enum": [
|
|
13043
|
+
"entity_created",
|
|
13044
|
+
"entity_assigned",
|
|
13045
|
+
"workflow_step_overdue"
|
|
13046
|
+
]
|
|
13047
|
+
},
|
|
13048
|
+
"entity_schema": {
|
|
13049
|
+
"type": "string",
|
|
13050
|
+
"description": "For `entity_created` / `entity_assigned` triggers, the entity schema slug (e.g. `opportunity`, `order`) whose creation or assignment fires this trigger. Ignored for other trigger types.",
|
|
13051
|
+
"example": "opportunity"
|
|
13052
|
+
},
|
|
13053
|
+
"enabled": {
|
|
13054
|
+
"type": "boolean",
|
|
13055
|
+
"description": "Whether this trigger is active.",
|
|
13056
|
+
"default": true
|
|
13057
|
+
},
|
|
13058
|
+
"template_id": {
|
|
13059
|
+
"type": "string",
|
|
13060
|
+
"format": "uuid",
|
|
13061
|
+
"description": "Entity id of the notification_template to render for this trigger."
|
|
12722
13062
|
}
|
|
12723
13063
|
}
|
|
12724
13064
|
},
|
|
@@ -14786,6 +15126,57 @@
|
|
|
14786
15126
|
"link"
|
|
14787
15127
|
]
|
|
14788
15128
|
},
|
|
15129
|
+
"OutstandingTask": {
|
|
15130
|
+
"type": "object",
|
|
15131
|
+
"required": [
|
|
15132
|
+
"entity_id",
|
|
15133
|
+
"entity_schema",
|
|
15134
|
+
"entity_title",
|
|
15135
|
+
"workflow_id",
|
|
15136
|
+
"workflow_name",
|
|
15137
|
+
"step_id",
|
|
15138
|
+
"step_name",
|
|
15139
|
+
"journey_id"
|
|
15140
|
+
],
|
|
15141
|
+
"properties": {
|
|
15142
|
+
"entity_id": {
|
|
15143
|
+
"type": "string",
|
|
15144
|
+
"description": "ID of the entity the task belongs to"
|
|
15145
|
+
},
|
|
15146
|
+
"entity_schema": {
|
|
15147
|
+
"type": "string",
|
|
15148
|
+
"description": "Schema slug of the entity (opportunity, order or contract)"
|
|
15149
|
+
},
|
|
15150
|
+
"entity_title": {
|
|
15151
|
+
"type": "string",
|
|
15152
|
+
"description": "Title (_title) of the entity"
|
|
15153
|
+
},
|
|
15154
|
+
"workflow_id": {
|
|
15155
|
+
"type": "string",
|
|
15156
|
+
"description": "Workflow execution id"
|
|
15157
|
+
},
|
|
15158
|
+
"workflow_name": {
|
|
15159
|
+
"type": "string",
|
|
15160
|
+
"description": "Workflow execution / template name"
|
|
15161
|
+
},
|
|
15162
|
+
"step_id": {
|
|
15163
|
+
"type": "string",
|
|
15164
|
+
"description": "Task (step) id within the workflow execution"
|
|
15165
|
+
},
|
|
15166
|
+
"step_name": {
|
|
15167
|
+
"type": "string",
|
|
15168
|
+
"description": "Task (step) name"
|
|
15169
|
+
},
|
|
15170
|
+
"journey_id": {
|
|
15171
|
+
"type": "string",
|
|
15172
|
+
"description": "Journey id the customer needs to fill out"
|
|
15173
|
+
},
|
|
15174
|
+
"complete_task_automatically": {
|
|
15175
|
+
"type": "boolean",
|
|
15176
|
+
"description": "Whether submitting the journey from the portal should auto-complete the task. When false, an internal user completes it."
|
|
15177
|
+
}
|
|
15178
|
+
}
|
|
15179
|
+
},
|
|
14789
15180
|
"WorkflowExecution": {
|
|
14790
15181
|
"type": "object",
|
|
14791
15182
|
"properties": {},
|
|
@@ -17751,7 +18142,7 @@
|
|
|
17751
18142
|
"timestamp": {
|
|
17752
18143
|
"type": "string",
|
|
17753
18144
|
"description": "If the value is not provided, the system will be set with the time the request is processed.",
|
|
17754
|
-
"example": "2022-10-
|
|
18145
|
+
"example": "2022-10-10T00:00:00.000Z"
|
|
17755
18146
|
},
|
|
17756
18147
|
"source": {
|
|
17757
18148
|
"$ref": "#/components/schemas/Source",
|