@epilot/customer-portal-client 0.33.1 → 0.33.3
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 +30 -0
- package/dist/openapi.d.ts +241 -3
- package/package.json +1 -1
- package/src/openapi-runtime.json +30 -0
- package/src/openapi.json +197 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={390:function(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var a=n(t(466));r.default=a.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","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":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":true},{"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/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":true},{"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":true},{"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/{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","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"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":{}}},"/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","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":true}],"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/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":true},{"in":"query","name":"portal_id","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","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","parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","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","parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","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":true}],"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/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/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/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":true},{"in":"query","name":"org_id","required":true},{"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/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/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}],"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/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":{}}}},"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(n){var a=r[n];if(void 0!==a)return a.exports;var i=r[n]={exports:{}};return e[n].call(i.exports,i,i.exports,t),i.exports}(390),n=exports;for(var a in t)n[a]=t[a];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={914:function(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var a=n(t(240));r.default=a.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","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":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":true},{"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/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":true},{"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":true},{"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/{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","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"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":{}}},"/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","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":true}],"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/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":true},{"in":"query","name":"portal_id","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","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","parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","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","parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","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":true}],"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/can-trigger-portal-flow":{"post":{"operationId":"canTriggerPortalFlow","parameters":[{"in":"query","name":"origin","required":false,"deprecated":true},{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/automation-context":{"get":{"operationId":"getAutomationContext","parameters":[{"in":"query","name":"activity_id","required":true},{"in":"query","name":"type","required":true}],"responses":{}}},"/v2/portal/workflow/{workflow_id}/{step_id}:markDone":{"put":{"operationId":"updateWorkflowStepAsDone","parameters":[{"in":"path","name":"workflow_id","required":true},{"in":"path","name":"step_id","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows":{"get":{"operationId":"getEntityWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/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":true},{"in":"query","name":"org_id","required":true},{"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/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}],"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/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":{}}}},"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(n){var a=r[n];if(void 0!==a)return a.exports;var i=r[n]={exports:{}};return e[n].call(i.exports,i,i.exports,t),i.exports}(914),n=exports;for(var a in t)n[a]=t[a];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
|
|
@@ -1614,6 +1614,24 @@
|
|
|
1614
1614
|
"responses": {}
|
|
1615
1615
|
}
|
|
1616
1616
|
},
|
|
1617
|
+
"/v2/portal/entity/{slug}/{id}/workflows": {
|
|
1618
|
+
"get": {
|
|
1619
|
+
"operationId": "getEntityWorkflows",
|
|
1620
|
+
"parameters": [
|
|
1621
|
+
{
|
|
1622
|
+
"in": "path",
|
|
1623
|
+
"name": "slug",
|
|
1624
|
+
"required": true
|
|
1625
|
+
},
|
|
1626
|
+
{
|
|
1627
|
+
"in": "path",
|
|
1628
|
+
"name": "id",
|
|
1629
|
+
"required": true
|
|
1630
|
+
}
|
|
1631
|
+
],
|
|
1632
|
+
"responses": {}
|
|
1633
|
+
}
|
|
1634
|
+
},
|
|
1617
1635
|
"/v2/portal/metering/reading/photo": {
|
|
1618
1636
|
"post": {
|
|
1619
1637
|
"operationId": "uploadMeterReadingPhoto",
|
|
@@ -1960,6 +1978,18 @@
|
|
|
1960
1978
|
"responses": {}
|
|
1961
1979
|
}
|
|
1962
1980
|
},
|
|
1981
|
+
"/v2/portal/notifications/entity:status": {
|
|
1982
|
+
"put": {
|
|
1983
|
+
"operationId": "updateNotificationsStatus",
|
|
1984
|
+
"requestBody": {
|
|
1985
|
+
"required": true,
|
|
1986
|
+
"content": {
|
|
1987
|
+
"application/json": {}
|
|
1988
|
+
}
|
|
1989
|
+
},
|
|
1990
|
+
"responses": {}
|
|
1991
|
+
}
|
|
1992
|
+
},
|
|
1963
1993
|
"/v2/portal/public/m-login/deregister/{client_id}/{user_id}": {
|
|
1964
1994
|
"delete": {
|
|
1965
1995
|
"operationId": "deRegisterMLoginUser",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -827,6 +827,13 @@ declare namespace Components {
|
|
|
827
827
|
* Mark true if the domain is an Epilot domain
|
|
828
828
|
*/
|
|
829
829
|
is_epilot_domain?: boolean;
|
|
830
|
+
/**
|
|
831
|
+
* The URL on which the portal is accessible
|
|
832
|
+
* example:
|
|
833
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
834
|
+
*/
|
|
835
|
+
epilot_domain?: string;
|
|
836
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
830
837
|
/**
|
|
831
838
|
* ID of the design used to build the portal
|
|
832
839
|
*/
|
|
@@ -1193,6 +1200,13 @@ declare namespace Components {
|
|
|
1193
1200
|
* Mark true if the domain is an Epilot domain
|
|
1194
1201
|
*/
|
|
1195
1202
|
is_epilot_domain?: boolean;
|
|
1203
|
+
/**
|
|
1204
|
+
* The Epilot domain on which the portal is accessible
|
|
1205
|
+
* example:
|
|
1206
|
+
* example-portal-1.ecp.epilot.io
|
|
1207
|
+
*/
|
|
1208
|
+
epilot_domain?: string;
|
|
1209
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
1196
1210
|
/**
|
|
1197
1211
|
* ID of the design used to build the portal
|
|
1198
1212
|
*/
|
|
@@ -1977,6 +1991,23 @@ declare namespace Components {
|
|
|
1977
1991
|
de?: string;
|
|
1978
1992
|
};
|
|
1979
1993
|
}
|
|
1994
|
+
/**
|
|
1995
|
+
* Domain settings for the portal
|
|
1996
|
+
*/
|
|
1997
|
+
export interface DomainSettings {
|
|
1998
|
+
/**
|
|
1999
|
+
* Whether the custom domain is enabled
|
|
2000
|
+
*/
|
|
2001
|
+
is_custom_domain_enabled?: boolean;
|
|
2002
|
+
/**
|
|
2003
|
+
* Whether the Epilot domain is enabled
|
|
2004
|
+
*/
|
|
2005
|
+
is_epilot_domain_enabled?: boolean;
|
|
2006
|
+
/**
|
|
2007
|
+
* Whether the redirection is enabled
|
|
2008
|
+
*/
|
|
2009
|
+
is_redirection_enabled?: boolean;
|
|
2010
|
+
}
|
|
1980
2011
|
/**
|
|
1981
2012
|
* Email templates used for authentication and internal processes
|
|
1982
2013
|
*/
|
|
@@ -3718,6 +3749,12 @@ declare namespace Components {
|
|
|
3718
3749
|
* Whether the org is in canary mode
|
|
3719
3750
|
*/
|
|
3720
3751
|
is_canary?: boolean;
|
|
3752
|
+
/**
|
|
3753
|
+
* The URL to redirect to
|
|
3754
|
+
* example:
|
|
3755
|
+
* https://example.com
|
|
3756
|
+
*/
|
|
3757
|
+
redirect_to?: string;
|
|
3721
3758
|
}
|
|
3722
3759
|
/**
|
|
3723
3760
|
* The meter entity
|
|
@@ -3828,7 +3865,7 @@ declare namespace Components {
|
|
|
3828
3865
|
/**
|
|
3829
3866
|
* If the value is not provided, the system will be set with the time the request is processed.
|
|
3830
3867
|
* example:
|
|
3831
|
-
* 2022-10-
|
|
3868
|
+
* 2022-10-10T00:00:00.000Z
|
|
3832
3869
|
*/
|
|
3833
3870
|
timestamp?: string;
|
|
3834
3871
|
/**
|
|
@@ -4482,6 +4519,13 @@ declare namespace Components {
|
|
|
4482
4519
|
* Mark true if the domain is an Epilot domain
|
|
4483
4520
|
*/
|
|
4484
4521
|
is_epilot_domain?: boolean;
|
|
4522
|
+
/**
|
|
4523
|
+
* The URL on which the portal is accessible
|
|
4524
|
+
* example:
|
|
4525
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
4526
|
+
*/
|
|
4527
|
+
epilot_domain?: string;
|
|
4528
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
4485
4529
|
design_id?: /**
|
|
4486
4530
|
* Entity ID
|
|
4487
4531
|
* example:
|
|
@@ -4931,6 +4975,13 @@ declare namespace Components {
|
|
|
4931
4975
|
* Mark true if the domain is an Epilot domain
|
|
4932
4976
|
*/
|
|
4933
4977
|
is_epilot_domain?: boolean;
|
|
4978
|
+
/**
|
|
4979
|
+
* The Epilot domain on which the portal is accessible
|
|
4980
|
+
* example:
|
|
4981
|
+
* example-portal-1.ecp.epilot.io
|
|
4982
|
+
*/
|
|
4983
|
+
epilot_domain?: string;
|
|
4984
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
4934
4985
|
design_id?: /**
|
|
4935
4986
|
* Entity ID
|
|
4936
4987
|
* example:
|
|
@@ -5978,6 +6029,13 @@ declare namespace Components {
|
|
|
5978
6029
|
* Mark true if the domain is an Epilot domain
|
|
5979
6030
|
*/
|
|
5980
6031
|
is_epilot_domain?: boolean;
|
|
6032
|
+
/**
|
|
6033
|
+
* The URL on which the portal is accessible
|
|
6034
|
+
* example:
|
|
6035
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
6036
|
+
*/
|
|
6037
|
+
epilot_domain?: string;
|
|
6038
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
5981
6039
|
design_id?: /**
|
|
5982
6040
|
* Entity ID
|
|
5983
6041
|
* example:
|
|
@@ -6381,6 +6439,13 @@ declare namespace Components {
|
|
|
6381
6439
|
* Mark true if the domain is an Epilot domain
|
|
6382
6440
|
*/
|
|
6383
6441
|
is_epilot_domain?: boolean;
|
|
6442
|
+
/**
|
|
6443
|
+
* The Epilot domain on which the portal is accessible
|
|
6444
|
+
* example:
|
|
6445
|
+
* example-portal-1.ecp.epilot.io
|
|
6446
|
+
*/
|
|
6447
|
+
epilot_domain?: string;
|
|
6448
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
6384
6449
|
design_id?: /**
|
|
6385
6450
|
* Entity ID
|
|
6386
6451
|
* example:
|
|
@@ -8523,6 +8588,93 @@ declare namespace Paths {
|
|
|
8523
8588
|
export type $500 = Components.Responses.InternalServerError;
|
|
8524
8589
|
}
|
|
8525
8590
|
}
|
|
8591
|
+
namespace GetEntityWorkflows {
|
|
8592
|
+
namespace Parameters {
|
|
8593
|
+
/**
|
|
8594
|
+
* ID of the entity
|
|
8595
|
+
* example:
|
|
8596
|
+
* abc123
|
|
8597
|
+
*/
|
|
8598
|
+
export type Id = string;
|
|
8599
|
+
/**
|
|
8600
|
+
* Schema slug of the entity
|
|
8601
|
+
* example:
|
|
8602
|
+
* contact
|
|
8603
|
+
*/
|
|
8604
|
+
export type Slug = string;
|
|
8605
|
+
}
|
|
8606
|
+
export interface PathParameters {
|
|
8607
|
+
slug: /**
|
|
8608
|
+
* Schema slug of the entity
|
|
8609
|
+
* example:
|
|
8610
|
+
* contact
|
|
8611
|
+
*/
|
|
8612
|
+
Parameters.Slug;
|
|
8613
|
+
id: /**
|
|
8614
|
+
* ID of the entity
|
|
8615
|
+
* example:
|
|
8616
|
+
* abc123
|
|
8617
|
+
*/
|
|
8618
|
+
Parameters.Id;
|
|
8619
|
+
}
|
|
8620
|
+
namespace Responses {
|
|
8621
|
+
export interface $200 {
|
|
8622
|
+
workflow_executions?: /**
|
|
8623
|
+
* example:
|
|
8624
|
+
* {
|
|
8625
|
+
* "id": "8gja72h6kas6h",
|
|
8626
|
+
* "name": "Lead Qualification",
|
|
8627
|
+
* "trigger": "MANUAL",
|
|
8628
|
+
* "status": "STARTED",
|
|
8629
|
+
* "creationTime": "2021-04-27T12:01:13.000Z",
|
|
8630
|
+
* "lastUpdateTime": "2021-04-27T12:01:13.000Z",
|
|
8631
|
+
* "dueDate": "2021-04-27T12:01:13.000Z",
|
|
8632
|
+
* "assignedTo": [
|
|
8633
|
+
* "252",
|
|
8634
|
+
* "29052"
|
|
8635
|
+
* ],
|
|
8636
|
+
* "flow": [
|
|
8637
|
+
* {
|
|
8638
|
+
* "id": "sectionId1",
|
|
8639
|
+
* "name": "Initial Information Gathering",
|
|
8640
|
+
* "steps": [
|
|
8641
|
+
* {
|
|
8642
|
+
* "id": "sada5641f3a21",
|
|
8643
|
+
* "name": "Call client and confirm address and product",
|
|
8644
|
+
* "status": "ASSIGNED",
|
|
8645
|
+
* "assignedTo": [
|
|
8646
|
+
* "11"
|
|
8647
|
+
* ]
|
|
8648
|
+
* },
|
|
8649
|
+
* {
|
|
8650
|
+
* "id": "sada5641f3a22",
|
|
8651
|
+
* "name": "Check product availability",
|
|
8652
|
+
* "status": "UNASSIGNED"
|
|
8653
|
+
* },
|
|
8654
|
+
* {
|
|
8655
|
+
* "id": "sada5641f3a23",
|
|
8656
|
+
* "name": "Send email confirming contact with the client",
|
|
8657
|
+
* "status": "SKIPPED"
|
|
8658
|
+
* }
|
|
8659
|
+
* ]
|
|
8660
|
+
* },
|
|
8661
|
+
* {
|
|
8662
|
+
* "id": "firstLevelStepId1",
|
|
8663
|
+
* "name": "Print and send catalog",
|
|
8664
|
+
* "status": "SKIPPED",
|
|
8665
|
+
* "dueDate": "2023-01-15T20:00:00"
|
|
8666
|
+
* }
|
|
8667
|
+
* ]
|
|
8668
|
+
* }
|
|
8669
|
+
*/
|
|
8670
|
+
Components.Schemas.WorkflowExecution[];
|
|
8671
|
+
}
|
|
8672
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
8673
|
+
export type $403 = Components.Responses.Forbidden;
|
|
8674
|
+
export type $404 = Components.Responses.NotFound;
|
|
8675
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
8676
|
+
}
|
|
8677
|
+
}
|
|
8526
8678
|
namespace GetExternalLinks {
|
|
8527
8679
|
namespace Parameters {
|
|
8528
8680
|
export type ContactId = /**
|
|
@@ -8808,6 +8960,13 @@ declare namespace Paths {
|
|
|
8808
8960
|
* Mark true if the domain is an Epilot domain
|
|
8809
8961
|
*/
|
|
8810
8962
|
is_epilot_domain?: boolean;
|
|
8963
|
+
/**
|
|
8964
|
+
* The URL on which the portal is accessible
|
|
8965
|
+
* example:
|
|
8966
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
8967
|
+
*/
|
|
8968
|
+
epilot_domain?: string;
|
|
8969
|
+
domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
|
|
8811
8970
|
design_id?: /**
|
|
8812
8971
|
* Entity ID
|
|
8813
8972
|
* example:
|
|
@@ -9247,6 +9406,13 @@ declare namespace Paths {
|
|
|
9247
9406
|
* Mark true if the domain is an Epilot domain
|
|
9248
9407
|
*/
|
|
9249
9408
|
is_epilot_domain?: boolean;
|
|
9409
|
+
/**
|
|
9410
|
+
* The URL on which the portal is accessible
|
|
9411
|
+
* example:
|
|
9412
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
9413
|
+
*/
|
|
9414
|
+
epilot_domain?: string;
|
|
9415
|
+
domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
|
|
9250
9416
|
design_id?: /**
|
|
9251
9417
|
* Entity ID
|
|
9252
9418
|
* example:
|
|
@@ -11427,6 +11593,35 @@ declare namespace Paths {
|
|
|
11427
11593
|
export type $500 = Components.Responses.InternalServerError;
|
|
11428
11594
|
}
|
|
11429
11595
|
}
|
|
11596
|
+
namespace UpdateNotificationsStatus {
|
|
11597
|
+
export interface RequestBody {
|
|
11598
|
+
notifications: {
|
|
11599
|
+
/**
|
|
11600
|
+
* ID of the notification
|
|
11601
|
+
*/
|
|
11602
|
+
id: string;
|
|
11603
|
+
/**
|
|
11604
|
+
* The status to set for the notification
|
|
11605
|
+
*/
|
|
11606
|
+
status: "read" | "important";
|
|
11607
|
+
}[];
|
|
11608
|
+
}
|
|
11609
|
+
namespace Responses {
|
|
11610
|
+
export interface $200 {
|
|
11611
|
+
/**
|
|
11612
|
+
* Message indicating the status of the notifications
|
|
11613
|
+
* example:
|
|
11614
|
+
* Notifications status updated successfully.
|
|
11615
|
+
*/
|
|
11616
|
+
message?: string;
|
|
11617
|
+
}
|
|
11618
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
11619
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11620
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11621
|
+
export type $404 = Components.Responses.NotFound;
|
|
11622
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11623
|
+
}
|
|
11624
|
+
}
|
|
11430
11625
|
namespace UpdateOpportunity {
|
|
11431
11626
|
namespace Parameters {
|
|
11432
11627
|
export type Id = /**
|
|
@@ -11951,7 +12146,6 @@ declare namespace Paths {
|
|
|
11951
12146
|
}
|
|
11952
12147
|
}
|
|
11953
12148
|
|
|
11954
|
-
|
|
11955
12149
|
export interface OperationMethods {
|
|
11956
12150
|
/**
|
|
11957
12151
|
* upsertPortal - upsertPortal
|
|
@@ -12933,6 +13127,16 @@ export interface OperationMethods {
|
|
|
12933
13127
|
data?: any,
|
|
12934
13128
|
config?: AxiosRequestConfig
|
|
12935
13129
|
): OperationResponse<Paths.UpdateWorkflowStepAsDone.Responses.$200>
|
|
13130
|
+
/**
|
|
13131
|
+
* getEntityWorkflows - Get workflows for an entity
|
|
13132
|
+
*
|
|
13133
|
+
* Get all workflows associated with an entity (requires access to the entity)
|
|
13134
|
+
*/
|
|
13135
|
+
'getEntityWorkflows'(
|
|
13136
|
+
parameters?: Parameters<Paths.GetEntityWorkflows.PathParameters> | null,
|
|
13137
|
+
data?: any,
|
|
13138
|
+
config?: AxiosRequestConfig
|
|
13139
|
+
): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
|
|
12936
13140
|
/**
|
|
12937
13141
|
* uploadMeterReadingPhoto - Upload Meter Reading Photo
|
|
12938
13142
|
*
|
|
@@ -13158,6 +13362,16 @@ export interface OperationMethods {
|
|
|
13158
13362
|
data?: Paths.UpdateCampaignPortalBlockStatus.RequestBody,
|
|
13159
13363
|
config?: AxiosRequestConfig
|
|
13160
13364
|
): OperationResponse<Paths.UpdateCampaignPortalBlockStatus.Responses.$200>
|
|
13365
|
+
/**
|
|
13366
|
+
* updateNotificationsStatus - updateNotificationsStatus
|
|
13367
|
+
*
|
|
13368
|
+
* Updates the statuses of multiple notifications at once.
|
|
13369
|
+
*/
|
|
13370
|
+
'updateNotificationsStatus'(
|
|
13371
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13372
|
+
data?: Paths.UpdateNotificationsStatus.RequestBody,
|
|
13373
|
+
config?: AxiosRequestConfig
|
|
13374
|
+
): OperationResponse<Paths.UpdateNotificationsStatus.Responses.$200>
|
|
13161
13375
|
/**
|
|
13162
13376
|
* deRegisterMLoginUser - deRegisterMLoginUser
|
|
13163
13377
|
*
|
|
@@ -14453,6 +14667,18 @@ export interface PathsDictionary {
|
|
|
14453
14667
|
config?: AxiosRequestConfig
|
|
14454
14668
|
): OperationResponse<Paths.UpdateWorkflowStepAsDone.Responses.$200>
|
|
14455
14669
|
}
|
|
14670
|
+
['/v2/portal/entity/{slug}/{id}/workflows']: {
|
|
14671
|
+
/**
|
|
14672
|
+
* getEntityWorkflows - Get workflows for an entity
|
|
14673
|
+
*
|
|
14674
|
+
* Get all workflows associated with an entity (requires access to the entity)
|
|
14675
|
+
*/
|
|
14676
|
+
'get'(
|
|
14677
|
+
parameters?: Parameters<Paths.GetEntityWorkflows.PathParameters> | null,
|
|
14678
|
+
data?: any,
|
|
14679
|
+
config?: AxiosRequestConfig
|
|
14680
|
+
): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
|
|
14681
|
+
}
|
|
14456
14682
|
['/v2/portal/metering/reading/photo']: {
|
|
14457
14683
|
/**
|
|
14458
14684
|
* uploadMeterReadingPhoto - Upload Meter Reading Photo
|
|
@@ -14708,6 +14934,18 @@ export interface PathsDictionary {
|
|
|
14708
14934
|
config?: AxiosRequestConfig
|
|
14709
14935
|
): OperationResponse<Paths.UpdateCampaignPortalBlockStatus.Responses.$200>
|
|
14710
14936
|
}
|
|
14937
|
+
['/v2/portal/notifications/entity:status']: {
|
|
14938
|
+
/**
|
|
14939
|
+
* updateNotificationsStatus - updateNotificationsStatus
|
|
14940
|
+
*
|
|
14941
|
+
* Updates the statuses of multiple notifications at once.
|
|
14942
|
+
*/
|
|
14943
|
+
'put'(
|
|
14944
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
14945
|
+
data?: Paths.UpdateNotificationsStatus.RequestBody,
|
|
14946
|
+
config?: AxiosRequestConfig
|
|
14947
|
+
): OperationResponse<Paths.UpdateNotificationsStatus.Responses.$200>
|
|
14948
|
+
}
|
|
14711
14949
|
['/v2/portal/public/m-login/deregister/{client_id}/{user_id}']: {
|
|
14712
14950
|
/**
|
|
14713
14951
|
* deRegisterMLoginUser - deRegisterMLoginUser
|
|
@@ -14876,7 +15114,6 @@ export interface PathsDictionary {
|
|
|
14876
15114
|
|
|
14877
15115
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
14878
15116
|
|
|
14879
|
-
|
|
14880
15117
|
export type AcceptanceDecision = Components.Schemas.AcceptanceDecision;
|
|
14881
15118
|
export type ActionLabel = Components.Schemas.ActionLabel;
|
|
14882
15119
|
export type ActionWidget = Components.Schemas.ActionWidget;
|
|
@@ -14916,6 +15153,7 @@ export type DataRetrievalItem = Components.Schemas.DataRetrievalItem;
|
|
|
14916
15153
|
export type DeleteEntityFile = Components.Schemas.DeleteEntityFile;
|
|
14917
15154
|
export type Direction = Components.Schemas.Direction;
|
|
14918
15155
|
export type DocumentWidget = Components.Schemas.DocumentWidget;
|
|
15156
|
+
export type DomainSettings = Components.Schemas.DomainSettings;
|
|
14919
15157
|
export type EmailTemplates = Components.Schemas.EmailTemplates;
|
|
14920
15158
|
export type Entity = Components.Schemas.Entity;
|
|
14921
15159
|
export type EntityEditRule = Components.Schemas.EntityEditRule;
|
package/package.json
CHANGED
package/src/openapi-runtime.json
CHANGED
|
@@ -1614,6 +1614,24 @@
|
|
|
1614
1614
|
"responses": {}
|
|
1615
1615
|
}
|
|
1616
1616
|
},
|
|
1617
|
+
"/v2/portal/entity/{slug}/{id}/workflows": {
|
|
1618
|
+
"get": {
|
|
1619
|
+
"operationId": "getEntityWorkflows",
|
|
1620
|
+
"parameters": [
|
|
1621
|
+
{
|
|
1622
|
+
"in": "path",
|
|
1623
|
+
"name": "slug",
|
|
1624
|
+
"required": true
|
|
1625
|
+
},
|
|
1626
|
+
{
|
|
1627
|
+
"in": "path",
|
|
1628
|
+
"name": "id",
|
|
1629
|
+
"required": true
|
|
1630
|
+
}
|
|
1631
|
+
],
|
|
1632
|
+
"responses": {}
|
|
1633
|
+
}
|
|
1634
|
+
},
|
|
1617
1635
|
"/v2/portal/metering/reading/photo": {
|
|
1618
1636
|
"post": {
|
|
1619
1637
|
"operationId": "uploadMeterReadingPhoto",
|
|
@@ -1960,6 +1978,18 @@
|
|
|
1960
1978
|
"responses": {}
|
|
1961
1979
|
}
|
|
1962
1980
|
},
|
|
1981
|
+
"/v2/portal/notifications/entity:status": {
|
|
1982
|
+
"put": {
|
|
1983
|
+
"operationId": "updateNotificationsStatus",
|
|
1984
|
+
"requestBody": {
|
|
1985
|
+
"required": true,
|
|
1986
|
+
"content": {
|
|
1987
|
+
"application/json": {}
|
|
1988
|
+
}
|
|
1989
|
+
},
|
|
1990
|
+
"responses": {}
|
|
1991
|
+
}
|
|
1992
|
+
},
|
|
1963
1993
|
"/v2/portal/public/m-login/deregister/{client_id}/{user_id}": {
|
|
1964
1994
|
"delete": {
|
|
1965
1995
|
"operationId": "deRegisterMLoginUser",
|
package/src/openapi.json
CHANGED
|
@@ -6557,6 +6557,75 @@
|
|
|
6557
6557
|
}
|
|
6558
6558
|
}
|
|
6559
6559
|
},
|
|
6560
|
+
"/v2/portal/entity/{slug}/{id}/workflows": {
|
|
6561
|
+
"get": {
|
|
6562
|
+
"operationId": "getEntityWorkflows",
|
|
6563
|
+
"summary": "Get workflows for an entity",
|
|
6564
|
+
"description": "Get all workflows associated with an entity (requires access to the entity)",
|
|
6565
|
+
"tags": [
|
|
6566
|
+
"ECP"
|
|
6567
|
+
],
|
|
6568
|
+
"security": [
|
|
6569
|
+
{
|
|
6570
|
+
"PortalAuth": []
|
|
6571
|
+
}
|
|
6572
|
+
],
|
|
6573
|
+
"parameters": [
|
|
6574
|
+
{
|
|
6575
|
+
"in": "path",
|
|
6576
|
+
"name": "slug",
|
|
6577
|
+
"required": true,
|
|
6578
|
+
"schema": {
|
|
6579
|
+
"type": "string",
|
|
6580
|
+
"description": "Schema slug of the entity",
|
|
6581
|
+
"example": "contact"
|
|
6582
|
+
}
|
|
6583
|
+
},
|
|
6584
|
+
{
|
|
6585
|
+
"in": "path",
|
|
6586
|
+
"name": "id",
|
|
6587
|
+
"required": true,
|
|
6588
|
+
"schema": {
|
|
6589
|
+
"type": "string",
|
|
6590
|
+
"description": "ID of the entity",
|
|
6591
|
+
"example": "abc123"
|
|
6592
|
+
}
|
|
6593
|
+
}
|
|
6594
|
+
],
|
|
6595
|
+
"responses": {
|
|
6596
|
+
"200": {
|
|
6597
|
+
"description": "List of workflows for the entity",
|
|
6598
|
+
"content": {
|
|
6599
|
+
"application/json": {
|
|
6600
|
+
"schema": {
|
|
6601
|
+
"type": "object",
|
|
6602
|
+
"properties": {
|
|
6603
|
+
"workflow_executions": {
|
|
6604
|
+
"type": "array",
|
|
6605
|
+
"items": {
|
|
6606
|
+
"$ref": "#/components/schemas/WorkflowExecution"
|
|
6607
|
+
}
|
|
6608
|
+
}
|
|
6609
|
+
}
|
|
6610
|
+
}
|
|
6611
|
+
}
|
|
6612
|
+
}
|
|
6613
|
+
},
|
|
6614
|
+
"401": {
|
|
6615
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
6616
|
+
},
|
|
6617
|
+
"403": {
|
|
6618
|
+
"$ref": "#/components/responses/Forbidden"
|
|
6619
|
+
},
|
|
6620
|
+
"404": {
|
|
6621
|
+
"$ref": "#/components/responses/NotFound"
|
|
6622
|
+
},
|
|
6623
|
+
"500": {
|
|
6624
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
6625
|
+
}
|
|
6626
|
+
}
|
|
6627
|
+
}
|
|
6628
|
+
},
|
|
6560
6629
|
"/v2/portal/metering/reading/photo": {
|
|
6561
6630
|
"post": {
|
|
6562
6631
|
"operationId": "uploadMeterReadingPhoto",
|
|
@@ -7882,6 +7951,94 @@
|
|
|
7882
7951
|
}
|
|
7883
7952
|
}
|
|
7884
7953
|
},
|
|
7954
|
+
"/v2/portal/notifications/entity:status": {
|
|
7955
|
+
"put": {
|
|
7956
|
+
"operationId": "updateNotificationsStatus",
|
|
7957
|
+
"summary": "updateNotificationsStatus",
|
|
7958
|
+
"description": "Updates the statuses of multiple notifications at once.",
|
|
7959
|
+
"tags": [
|
|
7960
|
+
"ECP"
|
|
7961
|
+
],
|
|
7962
|
+
"security": [
|
|
7963
|
+
{
|
|
7964
|
+
"PortalAuth": []
|
|
7965
|
+
}
|
|
7966
|
+
],
|
|
7967
|
+
"requestBody": {
|
|
7968
|
+
"required": true,
|
|
7969
|
+
"content": {
|
|
7970
|
+
"application/json": {
|
|
7971
|
+
"schema": {
|
|
7972
|
+
"type": "object",
|
|
7973
|
+
"required": [
|
|
7974
|
+
"notifications"
|
|
7975
|
+
],
|
|
7976
|
+
"properties": {
|
|
7977
|
+
"notifications": {
|
|
7978
|
+
"type": "array",
|
|
7979
|
+
"items": {
|
|
7980
|
+
"type": "object",
|
|
7981
|
+
"required": [
|
|
7982
|
+
"id",
|
|
7983
|
+
"status"
|
|
7984
|
+
],
|
|
7985
|
+
"properties": {
|
|
7986
|
+
"id": {
|
|
7987
|
+
"type": "string",
|
|
7988
|
+
"description": "ID of the notification"
|
|
7989
|
+
},
|
|
7990
|
+
"status": {
|
|
7991
|
+
"type": "string",
|
|
7992
|
+
"enum": [
|
|
7993
|
+
"read",
|
|
7994
|
+
"important"
|
|
7995
|
+
],
|
|
7996
|
+
"description": "The status to set for the notification"
|
|
7997
|
+
}
|
|
7998
|
+
}
|
|
7999
|
+
}
|
|
8000
|
+
}
|
|
8001
|
+
}
|
|
8002
|
+
}
|
|
8003
|
+
}
|
|
8004
|
+
}
|
|
8005
|
+
},
|
|
8006
|
+
"responses": {
|
|
8007
|
+
"200": {
|
|
8008
|
+
"description": "Notifications status updated successfully.",
|
|
8009
|
+
"content": {
|
|
8010
|
+
"application/json": {
|
|
8011
|
+
"schema": {
|
|
8012
|
+
"type": "object",
|
|
8013
|
+
"properties": {
|
|
8014
|
+
"message": {
|
|
8015
|
+
"type": "string",
|
|
8016
|
+
"description": "Message indicating the status of the notifications",
|
|
8017
|
+
"example": "Notifications status updated successfully."
|
|
8018
|
+
}
|
|
8019
|
+
}
|
|
8020
|
+
}
|
|
8021
|
+
}
|
|
8022
|
+
}
|
|
8023
|
+
},
|
|
8024
|
+
"400": {
|
|
8025
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
8026
|
+
},
|
|
8027
|
+
"401": {
|
|
8028
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
8029
|
+
},
|
|
8030
|
+
"403": {
|
|
8031
|
+
"$ref": "#/components/responses/Forbidden"
|
|
8032
|
+
},
|
|
8033
|
+
"404": {
|
|
8034
|
+
"$ref": "#/components/responses/NotFound"
|
|
8035
|
+
},
|
|
8036
|
+
"500": {
|
|
8037
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
8038
|
+
}
|
|
8039
|
+
}
|
|
8040
|
+
}
|
|
8041
|
+
},
|
|
7885
8042
|
"/v2/portal/public/m-login/deregister/{client_id}/{user_id}": {
|
|
7886
8043
|
"delete": {
|
|
7887
8044
|
"operationId": "deRegisterMLoginUser",
|
|
@@ -9410,6 +9567,14 @@
|
|
|
9410
9567
|
"type": "boolean",
|
|
9411
9568
|
"description": "Mark true if the domain is an Epilot domain"
|
|
9412
9569
|
},
|
|
9570
|
+
"epilot_domain": {
|
|
9571
|
+
"type": "string",
|
|
9572
|
+
"description": "The URL on which the portal is accessible",
|
|
9573
|
+
"example": "example-portal-12345.ecp.epilot.cloud"
|
|
9574
|
+
},
|
|
9575
|
+
"domain_settings": {
|
|
9576
|
+
"$ref": "#/components/schemas/DomainSettings"
|
|
9577
|
+
},
|
|
9413
9578
|
"design_id": {
|
|
9414
9579
|
"$ref": "#/components/schemas/EntityId",
|
|
9415
9580
|
"description": "ID of the design used to build the portal"
|
|
@@ -9905,6 +10070,24 @@
|
|
|
9905
10070
|
}
|
|
9906
10071
|
}
|
|
9907
10072
|
},
|
|
10073
|
+
"DomainSettings": {
|
|
10074
|
+
"type": "object",
|
|
10075
|
+
"description": "Domain settings for the portal",
|
|
10076
|
+
"properties": {
|
|
10077
|
+
"is_custom_domain_enabled": {
|
|
10078
|
+
"type": "boolean",
|
|
10079
|
+
"description": "Whether the custom domain is enabled"
|
|
10080
|
+
},
|
|
10081
|
+
"is_epilot_domain_enabled": {
|
|
10082
|
+
"type": "boolean",
|
|
10083
|
+
"description": "Whether the Epilot domain is enabled"
|
|
10084
|
+
},
|
|
10085
|
+
"is_redirection_enabled": {
|
|
10086
|
+
"type": "boolean",
|
|
10087
|
+
"description": "Whether the redirection is enabled"
|
|
10088
|
+
}
|
|
10089
|
+
}
|
|
10090
|
+
},
|
|
9908
10091
|
"WidgetBase": {
|
|
9909
10092
|
"type": "object",
|
|
9910
10093
|
"required": [
|
|
@@ -13493,7 +13676,7 @@
|
|
|
13493
13676
|
"timestamp": {
|
|
13494
13677
|
"type": "string",
|
|
13495
13678
|
"description": "If the value is not provided, the system will be set with the time the request is processed.",
|
|
13496
|
-
"example": "2022-10-
|
|
13679
|
+
"example": "2022-10-10T00:00:00.000Z"
|
|
13497
13680
|
},
|
|
13498
13681
|
"source": {
|
|
13499
13682
|
"$ref": "#/components/schemas/Source",
|
|
@@ -14235,6 +14418,14 @@
|
|
|
14235
14418
|
"type": "boolean",
|
|
14236
14419
|
"description": "Mark true if the domain is an Epilot domain"
|
|
14237
14420
|
},
|
|
14421
|
+
"epilot_domain": {
|
|
14422
|
+
"type": "string",
|
|
14423
|
+
"description": "The Epilot domain on which the portal is accessible",
|
|
14424
|
+
"example": "example-portal-1.ecp.epilot.io"
|
|
14425
|
+
},
|
|
14426
|
+
"domain_settings": {
|
|
14427
|
+
"$ref": "#/components/schemas/DomainSettings"
|
|
14428
|
+
},
|
|
14238
14429
|
"design_id": {
|
|
14239
14430
|
"$ref": "#/components/schemas/EntityId",
|
|
14240
14431
|
"description": "ID of the design used to build the portal"
|
|
@@ -14738,6 +14929,11 @@
|
|
|
14738
14929
|
"is_canary": {
|
|
14739
14930
|
"type": "boolean",
|
|
14740
14931
|
"description": "Whether the org is in canary mode"
|
|
14932
|
+
},
|
|
14933
|
+
"redirect_to": {
|
|
14934
|
+
"type": "string",
|
|
14935
|
+
"description": "The URL to redirect to",
|
|
14936
|
+
"example": "https://example.com"
|
|
14741
14937
|
}
|
|
14742
14938
|
}
|
|
14743
14939
|
},
|