@epilot/customer-portal-client 0.38.9 → 0.39.0
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 +33 -0
- package/dist/openapi.d.ts +197 -10
- package/package.json +1 -1
- package/src/openapi-runtime.json +33 -0
- package/src/openapi.json +150 -7
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":{}}},"/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/{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/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/downloaded":{"post":{"operationId":"trackFileDownloaded","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/files/count-by-entity":{"get":{"operationId":"getFilesCountByEntity","deprecated":true,"responses":{}}},"/v2/portal/billing/events":{"get":{"operationId":"getBillingEvents","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"name":"entity_id","in":"query","required":false},{"name":"event_type","in":"query"},{"name":"paid","in":"query"},{"name":"date_after","in":"query"},{"name":"date_before","in":"query"},{"name":"sort","in":"query"}],"responses":{}}},"/v2/portal/billing/customers/balance":{"get":{"operationId":"getCustomerBalance","responses":{}}},"/v2/portal/billing/accounts/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getBillingAccount","responses":{}}},"/v2/portal/admin:login-as-user":{"post":{"operationId":"loginToPortalAsUser","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEvent","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"origin","in":"query","required":true}],"responses":{}}},"/v3/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEventV3","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"portal_id","in":"query","required":false},{"name":"domain","in":"query","required":false}],"responses":{}}},"/v2/portal/entity:get":{"post":{"operationId":"getPortalUserEntity","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity:search":{"post":{"operationId":"searchPortalUserEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/can-trigger-portal-flow":{"post":{"operationId":"canTriggerPortalFlow","parameters":[{"in":"query","name":"origin","required":false,"deprecated":true},{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/automation-context":{"get":{"operationId":"getAutomationContext","parameters":[{"in":"query","name":"activity_id","required":true},{"in":"query","name":"type","required":true}],"responses":{}}},"/v2/portal/workflow/{workflow_id}/{step_id}:markDone":{"put":{"operationId":"updateWorkflowStepAsDone","parameters":[{"in":"path","name":"workflow_id","required":true},{"in":"path","name":"step_id","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows":{"get":{"operationId":"getEntityWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/metering/readings":{"post":{"operationId":"getMeterReadings","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/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/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/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":{}}}},"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={330:function(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/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/{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/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/downloaded":{"post":{"operationId":"trackFileDownloaded","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/files/count-by-entity":{"get":{"operationId":"getFilesCountByEntity","deprecated":true,"responses":{}}},"/v2/portal/billing/events":{"get":{"operationId":"getBillingEvents","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"name":"entity_id","in":"query","required":false},{"name":"event_type","in":"query"},{"name":"paid","in":"query"},{"name":"date_after","in":"query"},{"name":"date_before","in":"query"},{"name":"sort","in":"query"}],"responses":{}}},"/v2/portal/billing/customers/balance":{"get":{"operationId":"getCustomerBalance","responses":{}}},"/v2/portal/billing/accounts/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getBillingAccount","responses":{}}},"/v2/portal/admin:login-as-user":{"post":{"operationId":"loginToPortalAsUser","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEvent","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"origin","in":"query","required":true}],"responses":{}}},"/v3/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEventV3","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"portal_id","in":"query","required":false},{"name":"domain","in":"query","required":false}],"responses":{}}},"/v2/portal/entity:get":{"post":{"operationId":"getPortalUserEntity","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity:search":{"post":{"operationId":"searchPortalUserEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/can-trigger-portal-flow":{"post":{"operationId":"canTriggerPortalFlow","parameters":[{"in":"query","name":"origin","required":false,"deprecated":true},{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/automation-context":{"get":{"operationId":"getAutomationContext","parameters":[{"in":"query","name":"activity_id","required":true},{"in":"query","name":"type","required":true}],"responses":{}}},"/v2/portal/workflow/{workflow_id}/{step_id}:markDone":{"put":{"operationId":"updateWorkflowStepAsDone","parameters":[{"in":"path","name":"workflow_id","required":true},{"in":"path","name":"step_id","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows":{"get":{"operationId":"getEntityWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/metering/readings":{"post":{"operationId":"getMeterReadings","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/providers/{provider_slug}":{"get":{"operationId":"getSSOProvider","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"origin","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/sso/login":{"post":{"operationId":"ssoLogin","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/sso/login":{"post":{"operationId":"ssoLoginV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"org_id","required":false},{"in":"query","name":"domain","required":false},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/redirect":{"post":{"operationId":"ssoRedirect","parameters":[{"in":"query","name":"web_uri","required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{}}},"responses":{}}},"/v2/portal/public/sso/callback":{"post":{"operationId":"ssoCallback","parameters":[{"in":"query","name":"domain"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getPortalPage","responses":{}},"put":{"operationId":"updatePortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPage","responses":{}}},"/v2/portal/pages":{"parameters":[{"in":"query","name":"domain","required":true}],"get":{"operationId":"getPortalPages","parameters":[{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false},{"in":"query","name":"contract_id","required":false,"deprecated":true},{"in":"query","name":"context_entities","required":false}],"responses":{}},"post":{"operationId":"createPortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/pages":{"get":{"operationId":"getPublicPages","parameters":[{"in":"query","name":"domain","required":true},{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false}],"responses":{}}},"/v2/portal/pages/interpolate":{"post":{"operationId":"interpolatePortalPages","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/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/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":{}}}},"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})})();
|
|
@@ -1900,6 +1900,39 @@
|
|
|
1900
1900
|
"responses": {}
|
|
1901
1901
|
}
|
|
1902
1902
|
},
|
|
1903
|
+
"/v2/portal/public/sso/providers/{provider_slug}": {
|
|
1904
|
+
"get": {
|
|
1905
|
+
"operationId": "getSSOProvider",
|
|
1906
|
+
"parameters": [
|
|
1907
|
+
{
|
|
1908
|
+
"in": "path",
|
|
1909
|
+
"name": "provider_slug",
|
|
1910
|
+
"required": true
|
|
1911
|
+
},
|
|
1912
|
+
{
|
|
1913
|
+
"in": "query",
|
|
1914
|
+
"name": "org_id",
|
|
1915
|
+
"required": false
|
|
1916
|
+
},
|
|
1917
|
+
{
|
|
1918
|
+
"in": "query",
|
|
1919
|
+
"name": "origin",
|
|
1920
|
+
"required": false
|
|
1921
|
+
},
|
|
1922
|
+
{
|
|
1923
|
+
"in": "query",
|
|
1924
|
+
"name": "portal_id",
|
|
1925
|
+
"required": false
|
|
1926
|
+
},
|
|
1927
|
+
{
|
|
1928
|
+
"in": "query",
|
|
1929
|
+
"name": "domain",
|
|
1930
|
+
"required": false
|
|
1931
|
+
}
|
|
1932
|
+
],
|
|
1933
|
+
"responses": {}
|
|
1934
|
+
}
|
|
1935
|
+
},
|
|
1903
1936
|
"/v2/portal/public/sso/login": {
|
|
1904
1937
|
"post": {
|
|
1905
1938
|
"operationId": "ssoLogin",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -4563,40 +4563,57 @@ declare namespace Components {
|
|
|
4563
4563
|
};
|
|
4564
4564
|
schema?: string;
|
|
4565
4565
|
}
|
|
4566
|
+
/**
|
|
4567
|
+
* Mobile OIDC configuration. All string fields support env var interpolation
|
|
4568
|
+
* (incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
|
|
4569
|
+
*
|
|
4570
|
+
*/
|
|
4566
4571
|
export interface MoblieOIDCConfig {
|
|
4567
4572
|
/**
|
|
4568
|
-
* Client ID for the mobile app
|
|
4573
|
+
* Client ID for the mobile app. Supports env var interpolation.
|
|
4569
4574
|
* example:
|
|
4570
4575
|
* 123456
|
|
4571
4576
|
*/
|
|
4572
4577
|
client_id?: string;
|
|
4573
4578
|
/**
|
|
4574
|
-
* Client Secret for the mobile app
|
|
4579
|
+
* Client Secret for the mobile app. Supports env var interpolation (incl. secrets),
|
|
4580
|
+
* e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
|
|
4581
|
+
*
|
|
4575
4582
|
* example:
|
|
4576
4583
|
* 123456
|
|
4577
4584
|
*/
|
|
4578
4585
|
client_secret?: string;
|
|
4579
4586
|
}
|
|
4587
|
+
/**
|
|
4588
|
+
* OIDC provider configuration. All string fields support env var interpolation
|
|
4589
|
+
* (incl. secrets) via mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
|
|
4590
|
+
*
|
|
4591
|
+
*/
|
|
4580
4592
|
export interface OIDCProviderConfig {
|
|
4581
4593
|
type?: "authorization_code" | "implicit";
|
|
4582
4594
|
/**
|
|
4583
|
-
* Issuing Authority URL
|
|
4595
|
+
* Issuing Authority URL. Supports env var interpolation, e.g. `{{ env.MY_ISSUER }}`.
|
|
4584
4596
|
* example:
|
|
4585
4597
|
* https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0
|
|
4586
4598
|
*/
|
|
4587
4599
|
oidc_issuer: string;
|
|
4588
4600
|
/**
|
|
4589
|
-
* Redirect URI for the OIDC flow
|
|
4601
|
+
* Redirect URI for the OIDC flow. Supports env var interpolation.
|
|
4590
4602
|
* example:
|
|
4591
4603
|
* https://customer-portal.com/login
|
|
4592
4604
|
*/
|
|
4593
4605
|
redirect_uri?: string;
|
|
4594
4606
|
/**
|
|
4607
|
+
* Supports env var interpolation, e.g. `{{ env.MY_CLIENT_ID }}`.
|
|
4595
4608
|
* example:
|
|
4596
4609
|
* ab81daf8-8b1f-42d6-94ca-c51621054c75
|
|
4597
4610
|
*/
|
|
4598
4611
|
client_id: string;
|
|
4599
4612
|
/**
|
|
4613
|
+
* Client Secret. Supports env var interpolation (incl. secrets), e.g.
|
|
4614
|
+
* `{{ env.MY_CLIENT_SECRET }}`. Prefer storing the actual secret as an org
|
|
4615
|
+
* env var and referencing it here.
|
|
4616
|
+
*
|
|
4600
4617
|
* example:
|
|
4601
4618
|
* 7BIUnn~6shh.7fNtXb..3k1Mp3s6k6WK3B
|
|
4602
4619
|
*/
|
|
@@ -4658,16 +4675,61 @@ declare namespace Components {
|
|
|
4658
4675
|
*/
|
|
4659
4676
|
mobile_redirect_uri?: string;
|
|
4660
4677
|
/**
|
|
4661
|
-
* The username for the test auth, only used for testing on auth code flow
|
|
4678
|
+
* The username for the test auth, only used for testing on auth code flow.
|
|
4679
|
+
* Supports env var interpolation, e.g. `{{ env.MY_TEST_AUTH_USERNAME }}`.
|
|
4680
|
+
*
|
|
4662
4681
|
* example:
|
|
4663
4682
|
* test@epilot.io
|
|
4664
4683
|
*/
|
|
4665
4684
|
test_auth_username?: string;
|
|
4666
4685
|
/**
|
|
4667
|
-
* The password for the test auth, only used for testing on auth code flow
|
|
4686
|
+
* The password for the test auth, only used for testing on auth code flow.
|
|
4687
|
+
* Supports env var interpolation (incl. secrets), e.g. `{{ env.MY_TEST_AUTH_PASSWORD }}`.
|
|
4688
|
+
*
|
|
4668
4689
|
*/
|
|
4669
4690
|
test_auth_password?: string;
|
|
4670
4691
|
}
|
|
4692
|
+
/**
|
|
4693
|
+
* Public OIDC provider configuration. Same as OIDCProviderConfig but never includes
|
|
4694
|
+
* the `client_secret` field — it is kept server-side and only used to exchange the
|
|
4695
|
+
* authorization code at the SSO callback. String fields are returned with env var
|
|
4696
|
+
* placeholders already resolved when fetched via `GET /v2/portal/public/sso/providers/{provider_slug}`.
|
|
4697
|
+
*
|
|
4698
|
+
*/
|
|
4699
|
+
export interface OIDCProviderPublicConfig {
|
|
4700
|
+
type?: "authorization_code" | "implicit";
|
|
4701
|
+
/**
|
|
4702
|
+
* Issuing Authority URL
|
|
4703
|
+
* example:
|
|
4704
|
+
* https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0
|
|
4705
|
+
*/
|
|
4706
|
+
oidc_issuer: string;
|
|
4707
|
+
/**
|
|
4708
|
+
* Redirect URI for the OIDC flow
|
|
4709
|
+
* example:
|
|
4710
|
+
* https://customer-portal.com/login
|
|
4711
|
+
*/
|
|
4712
|
+
redirect_uri?: string;
|
|
4713
|
+
/**
|
|
4714
|
+
* example:
|
|
4715
|
+
* ab81daf8-8b1f-42d6-94ca-c51621054c75
|
|
4716
|
+
*/
|
|
4717
|
+
client_id: string;
|
|
4718
|
+
/**
|
|
4719
|
+
* Whether the client secret is present (the value itself is kept server-side)
|
|
4720
|
+
* example:
|
|
4721
|
+
* true
|
|
4722
|
+
*/
|
|
4723
|
+
has_client_secret?: boolean;
|
|
4724
|
+
/**
|
|
4725
|
+
* Space-separated list of OAuth 2.0 scopes to request from OpenID Connect
|
|
4726
|
+
* example:
|
|
4727
|
+
* openid email
|
|
4728
|
+
*/
|
|
4729
|
+
scope: string;
|
|
4730
|
+
metadata?: OIDCProviderMetadata;
|
|
4731
|
+
prompt?: "login" | "select_account" | "consent";
|
|
4732
|
+
}
|
|
4671
4733
|
/**
|
|
4672
4734
|
* The opportunity entity
|
|
4673
4735
|
*/
|
|
@@ -6384,6 +6446,20 @@ declare namespace Components {
|
|
|
6384
6446
|
*/
|
|
6385
6447
|
campaign_id?: string;
|
|
6386
6448
|
}
|
|
6449
|
+
/**
|
|
6450
|
+
* SSO identity provider configuration.
|
|
6451
|
+
*
|
|
6452
|
+
* Env var interpolation: only string fields under `oidc_config` and
|
|
6453
|
+
* `mobile_oidc_config` (incl. their nested `metadata`) are passed through
|
|
6454
|
+
* Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
|
|
6455
|
+
* get resolved at runtime against the organization's environment.
|
|
6456
|
+
*
|
|
6457
|
+
* The following fields are used as literal values and MUST NOT contain
|
|
6458
|
+
* template syntax: `slug`, `display_name`, `provider_type`, all keys and
|
|
6459
|
+
* values under `attribute_mappings` (used as JSONPath-like accessors into
|
|
6460
|
+
* token claims), and all keys and values under `entity_matching`.
|
|
6461
|
+
*
|
|
6462
|
+
*/
|
|
6387
6463
|
export interface ProviderConfig {
|
|
6388
6464
|
slug?: /**
|
|
6389
6465
|
* URL-friendly slug to use as organization-unique identifier for Provider
|
|
@@ -6400,8 +6476,18 @@ declare namespace Components {
|
|
|
6400
6476
|
provider_type: "OIDC";
|
|
6401
6477
|
attribute_mappings?: /* Dictionary of epilot user attributes to claims */ AttributeMappingConfig;
|
|
6402
6478
|
entity_matching?: /* Configuration for matching existing entities during SSO login using token claims */ EntityMatchingConfig;
|
|
6403
|
-
oidc_config?:
|
|
6404
|
-
|
|
6479
|
+
oidc_config?: /**
|
|
6480
|
+
* OIDC provider configuration. All string fields support env var interpolation
|
|
6481
|
+
* (incl. secrets) via mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
|
|
6482
|
+
*
|
|
6483
|
+
*/
|
|
6484
|
+
OIDCProviderConfig;
|
|
6485
|
+
mobile_oidc_config?: /**
|
|
6486
|
+
* Mobile OIDC configuration. All string fields support env var interpolation
|
|
6487
|
+
* (incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
|
|
6488
|
+
*
|
|
6489
|
+
*/
|
|
6490
|
+
MoblieOIDCConfig;
|
|
6405
6491
|
}
|
|
6406
6492
|
/**
|
|
6407
6493
|
* Human-readable display name for identity provider shown in login
|
|
@@ -6422,8 +6508,20 @@ declare namespace Components {
|
|
|
6422
6508
|
* Office 365 Login
|
|
6423
6509
|
*/
|
|
6424
6510
|
ProviderDisplayName;
|
|
6425
|
-
oidc_config?:
|
|
6426
|
-
|
|
6511
|
+
oidc_config?: /**
|
|
6512
|
+
* Public OIDC provider configuration. Same as OIDCProviderConfig but never includes
|
|
6513
|
+
* the `client_secret` field — it is kept server-side and only used to exchange the
|
|
6514
|
+
* authorization code at the SSO callback. String fields are returned with env var
|
|
6515
|
+
* placeholders already resolved when fetched via `GET /v2/portal/public/sso/providers/{provider_slug}`.
|
|
6516
|
+
*
|
|
6517
|
+
*/
|
|
6518
|
+
OIDCProviderPublicConfig;
|
|
6519
|
+
mobile_oidc_config?: /**
|
|
6520
|
+
* Mobile OIDC configuration. All string fields support env var interpolation
|
|
6521
|
+
* (incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
|
|
6522
|
+
*
|
|
6523
|
+
*/
|
|
6524
|
+
MoblieOIDCConfig;
|
|
6427
6525
|
}
|
|
6428
6526
|
/**
|
|
6429
6527
|
* URL-friendly slug to use as organization-unique identifier for Provider
|
|
@@ -12191,6 +12289,48 @@ declare namespace Paths {
|
|
|
12191
12289
|
export type $500 = Components.Responses.InternalServerError;
|
|
12192
12290
|
}
|
|
12193
12291
|
}
|
|
12292
|
+
namespace GetSSOProvider {
|
|
12293
|
+
namespace Parameters {
|
|
12294
|
+
export type Domain = string;
|
|
12295
|
+
/**
|
|
12296
|
+
* example:
|
|
12297
|
+
* 123
|
|
12298
|
+
*/
|
|
12299
|
+
export type OrgId = string;
|
|
12300
|
+
export type Origin = "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL";
|
|
12301
|
+
export type PortalId = /**
|
|
12302
|
+
* ID of the portal
|
|
12303
|
+
* example:
|
|
12304
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
12305
|
+
*/
|
|
12306
|
+
Components.Schemas.PortalId;
|
|
12307
|
+
export type ProviderSlug = /**
|
|
12308
|
+
* URL-friendly slug to use as organization-unique identifier for Provider
|
|
12309
|
+
* example:
|
|
12310
|
+
* office-365-login
|
|
12311
|
+
*/
|
|
12312
|
+
Components.Schemas.ProviderSlug /* [0-9a-z-]+ */;
|
|
12313
|
+
}
|
|
12314
|
+
export interface PathParameters {
|
|
12315
|
+
provider_slug: Parameters.ProviderSlug;
|
|
12316
|
+
}
|
|
12317
|
+
export interface QueryParameters {
|
|
12318
|
+
org_id?: /**
|
|
12319
|
+
* example:
|
|
12320
|
+
* 123
|
|
12321
|
+
*/
|
|
12322
|
+
Parameters.OrgId;
|
|
12323
|
+
origin?: Parameters.Origin;
|
|
12324
|
+
portal_id?: Parameters.PortalId;
|
|
12325
|
+
domain?: Parameters.Domain;
|
|
12326
|
+
}
|
|
12327
|
+
namespace Responses {
|
|
12328
|
+
export type $200 = Components.Schemas.ProviderPublicConfig;
|
|
12329
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
12330
|
+
export type $404 = Components.Responses.NotFound;
|
|
12331
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
12332
|
+
}
|
|
12333
|
+
}
|
|
12194
12334
|
namespace GetSchemas {
|
|
12195
12335
|
namespace Responses {
|
|
12196
12336
|
export interface $200 {
|
|
@@ -15179,6 +15319,28 @@ export interface OperationMethods {
|
|
|
15179
15319
|
data?: Paths.GetMeterReadings.RequestBody,
|
|
15180
15320
|
config?: AxiosRequestConfig
|
|
15181
15321
|
): OperationResponse<Paths.GetMeterReadings.Responses.$200>
|
|
15322
|
+
/**
|
|
15323
|
+
* getSSOProvider - getSSOProvider
|
|
15324
|
+
*
|
|
15325
|
+
* Returns the public configuration of a single SSO identity provider with env var
|
|
15326
|
+
* placeholders (incl. secrets) already resolved against the organization's environment.
|
|
15327
|
+
*
|
|
15328
|
+
* Use this endpoint at SSO initiation time (i.e. when the end user clicks "Sign in with X")
|
|
15329
|
+
* to obtain the resolved OIDC settings needed to construct the authorization URL.
|
|
15330
|
+
* The web `client_secret` is intentionally never returned — it is used server-side by
|
|
15331
|
+
* the SSO callback to exchange the authorization code for tokens.
|
|
15332
|
+
*
|
|
15333
|
+
* Supports three identification methods:
|
|
15334
|
+
* 1. `org_id` + `origin`
|
|
15335
|
+
* 2. `org_id` + `portal_id`
|
|
15336
|
+
* 3. `domain`
|
|
15337
|
+
*
|
|
15338
|
+
*/
|
|
15339
|
+
'getSSOProvider'(
|
|
15340
|
+
parameters?: Parameters<Paths.GetSSOProvider.QueryParameters & Paths.GetSSOProvider.PathParameters> | null,
|
|
15341
|
+
data?: any,
|
|
15342
|
+
config?: AxiosRequestConfig
|
|
15343
|
+
): OperationResponse<Paths.GetSSOProvider.Responses.$200>
|
|
15182
15344
|
/**
|
|
15183
15345
|
* ssoLogin - ssoLogin
|
|
15184
15346
|
*
|
|
@@ -16916,6 +17078,30 @@ export interface PathsDictionary {
|
|
|
16916
17078
|
config?: AxiosRequestConfig
|
|
16917
17079
|
): OperationResponse<Paths.GetMeterReadings.Responses.$200>
|
|
16918
17080
|
}
|
|
17081
|
+
['/v2/portal/public/sso/providers/{provider_slug}']: {
|
|
17082
|
+
/**
|
|
17083
|
+
* getSSOProvider - getSSOProvider
|
|
17084
|
+
*
|
|
17085
|
+
* Returns the public configuration of a single SSO identity provider with env var
|
|
17086
|
+
* placeholders (incl. secrets) already resolved against the organization's environment.
|
|
17087
|
+
*
|
|
17088
|
+
* Use this endpoint at SSO initiation time (i.e. when the end user clicks "Sign in with X")
|
|
17089
|
+
* to obtain the resolved OIDC settings needed to construct the authorization URL.
|
|
17090
|
+
* The web `client_secret` is intentionally never returned — it is used server-side by
|
|
17091
|
+
* the SSO callback to exchange the authorization code for tokens.
|
|
17092
|
+
*
|
|
17093
|
+
* Supports three identification methods:
|
|
17094
|
+
* 1. `org_id` + `origin`
|
|
17095
|
+
* 2. `org_id` + `portal_id`
|
|
17096
|
+
* 3. `domain`
|
|
17097
|
+
*
|
|
17098
|
+
*/
|
|
17099
|
+
'get'(
|
|
17100
|
+
parameters?: Parameters<Paths.GetSSOProvider.QueryParameters & Paths.GetSSOProvider.PathParameters> | null,
|
|
17101
|
+
data?: any,
|
|
17102
|
+
config?: AxiosRequestConfig
|
|
17103
|
+
): OperationResponse<Paths.GetSSOProvider.Responses.$200>
|
|
17104
|
+
}
|
|
16919
17105
|
['/v2/portal/public/sso/login']: {
|
|
16920
17106
|
/**
|
|
16921
17107
|
* ssoLogin - ssoLogin
|
|
@@ -17461,6 +17647,7 @@ export type MeterReadingWidget = Components.Schemas.MeterReadingWidget;
|
|
|
17461
17647
|
export type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
|
|
17462
17648
|
export type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
|
|
17463
17649
|
export type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
|
|
17650
|
+
export type OIDCProviderPublicConfig = Components.Schemas.OIDCProviderPublicConfig;
|
|
17464
17651
|
export type Opportunity = Components.Schemas.Opportunity;
|
|
17465
17652
|
export type Order = Components.Schemas.Order;
|
|
17466
17653
|
export type OrganizationSettings = Components.Schemas.OrganizationSettings;
|
package/package.json
CHANGED
package/src/openapi-runtime.json
CHANGED
|
@@ -1900,6 +1900,39 @@
|
|
|
1900
1900
|
"responses": {}
|
|
1901
1901
|
}
|
|
1902
1902
|
},
|
|
1903
|
+
"/v2/portal/public/sso/providers/{provider_slug}": {
|
|
1904
|
+
"get": {
|
|
1905
|
+
"operationId": "getSSOProvider",
|
|
1906
|
+
"parameters": [
|
|
1907
|
+
{
|
|
1908
|
+
"in": "path",
|
|
1909
|
+
"name": "provider_slug",
|
|
1910
|
+
"required": true
|
|
1911
|
+
},
|
|
1912
|
+
{
|
|
1913
|
+
"in": "query",
|
|
1914
|
+
"name": "org_id",
|
|
1915
|
+
"required": false
|
|
1916
|
+
},
|
|
1917
|
+
{
|
|
1918
|
+
"in": "query",
|
|
1919
|
+
"name": "origin",
|
|
1920
|
+
"required": false
|
|
1921
|
+
},
|
|
1922
|
+
{
|
|
1923
|
+
"in": "query",
|
|
1924
|
+
"name": "portal_id",
|
|
1925
|
+
"required": false
|
|
1926
|
+
},
|
|
1927
|
+
{
|
|
1928
|
+
"in": "query",
|
|
1929
|
+
"name": "domain",
|
|
1930
|
+
"required": false
|
|
1931
|
+
}
|
|
1932
|
+
],
|
|
1933
|
+
"responses": {}
|
|
1934
|
+
}
|
|
1935
|
+
},
|
|
1903
1936
|
"/v2/portal/public/sso/login": {
|
|
1904
1937
|
"post": {
|
|
1905
1938
|
"operationId": "ssoLogin",
|
package/src/openapi.json
CHANGED
|
@@ -7605,6 +7605,90 @@
|
|
|
7605
7605
|
}
|
|
7606
7606
|
}
|
|
7607
7607
|
},
|
|
7608
|
+
"/v2/portal/public/sso/providers/{provider_slug}": {
|
|
7609
|
+
"get": {
|
|
7610
|
+
"operationId": "getSSOProvider",
|
|
7611
|
+
"summary": "getSSOProvider",
|
|
7612
|
+
"description": "Returns the public configuration of a single SSO identity provider with env var\nplaceholders (incl. secrets) already resolved against the organization's environment.\n\nUse this endpoint at SSO initiation time (i.e. when the end user clicks \"Sign in with X\")\nto obtain the resolved OIDC settings needed to construct the authorization URL.\nThe web `client_secret` is intentionally never returned — it is used server-side by\nthe SSO callback to exchange the authorization code for tokens.\n\nSupports three identification methods:\n1. `org_id` + `origin`\n2. `org_id` + `portal_id`\n3. `domain`\n",
|
|
7613
|
+
"security": [],
|
|
7614
|
+
"tags": [
|
|
7615
|
+
"Public"
|
|
7616
|
+
],
|
|
7617
|
+
"parameters": [
|
|
7618
|
+
{
|
|
7619
|
+
"in": "path",
|
|
7620
|
+
"name": "provider_slug",
|
|
7621
|
+
"required": true,
|
|
7622
|
+
"description": "Provider slug (organization-unique)",
|
|
7623
|
+
"schema": {
|
|
7624
|
+
"$ref": "#/components/schemas/ProviderSlug"
|
|
7625
|
+
}
|
|
7626
|
+
},
|
|
7627
|
+
{
|
|
7628
|
+
"in": "query",
|
|
7629
|
+
"name": "org_id",
|
|
7630
|
+
"required": false,
|
|
7631
|
+
"description": "epilot organization id (required with `origin` or `portal_id`)",
|
|
7632
|
+
"schema": {
|
|
7633
|
+
"type": "string",
|
|
7634
|
+
"example": 123
|
|
7635
|
+
}
|
|
7636
|
+
},
|
|
7637
|
+
{
|
|
7638
|
+
"in": "query",
|
|
7639
|
+
"name": "origin",
|
|
7640
|
+
"required": false,
|
|
7641
|
+
"description": "Origin of the Portal",
|
|
7642
|
+
"schema": {
|
|
7643
|
+
"type": "string",
|
|
7644
|
+
"enum": [
|
|
7645
|
+
"END_CUSTOMER_PORTAL",
|
|
7646
|
+
"INSTALLER_PORTAL"
|
|
7647
|
+
]
|
|
7648
|
+
}
|
|
7649
|
+
},
|
|
7650
|
+
{
|
|
7651
|
+
"in": "query",
|
|
7652
|
+
"name": "portal_id",
|
|
7653
|
+
"required": false,
|
|
7654
|
+
"description": "ID of the Portal",
|
|
7655
|
+
"schema": {
|
|
7656
|
+
"$ref": "#/components/schemas/PortalId"
|
|
7657
|
+
}
|
|
7658
|
+
},
|
|
7659
|
+
{
|
|
7660
|
+
"in": "query",
|
|
7661
|
+
"name": "domain",
|
|
7662
|
+
"required": false,
|
|
7663
|
+
"description": "Portal domain for identification (alternative to org_id + origin/portal_id)",
|
|
7664
|
+
"schema": {
|
|
7665
|
+
"type": "string"
|
|
7666
|
+
}
|
|
7667
|
+
}
|
|
7668
|
+
],
|
|
7669
|
+
"responses": {
|
|
7670
|
+
"200": {
|
|
7671
|
+
"description": "Resolved public SSO provider configuration",
|
|
7672
|
+
"content": {
|
|
7673
|
+
"application/json": {
|
|
7674
|
+
"schema": {
|
|
7675
|
+
"$ref": "#/components/schemas/ProviderPublicConfig"
|
|
7676
|
+
}
|
|
7677
|
+
}
|
|
7678
|
+
}
|
|
7679
|
+
},
|
|
7680
|
+
"400": {
|
|
7681
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
7682
|
+
},
|
|
7683
|
+
"404": {
|
|
7684
|
+
"$ref": "#/components/responses/NotFound"
|
|
7685
|
+
},
|
|
7686
|
+
"500": {
|
|
7687
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
7688
|
+
}
|
|
7689
|
+
}
|
|
7690
|
+
}
|
|
7691
|
+
},
|
|
7608
7692
|
"/v2/portal/public/sso/login": {
|
|
7609
7693
|
"post": {
|
|
7610
7694
|
"operationId": "ssoLogin",
|
|
@@ -15485,6 +15569,7 @@
|
|
|
15485
15569
|
},
|
|
15486
15570
|
"ProviderConfig": {
|
|
15487
15571
|
"type": "object",
|
|
15572
|
+
"description": "SSO identity provider configuration.\n\nEnv var interpolation: only string fields under `oidc_config` and\n`mobile_oidc_config` (incl. their nested `metadata`) are passed through\nLiquid templating, so they may contain `{{ env.VAR }}` placeholders that\nget resolved at runtime against the organization's environment.\n\nThe following fields are used as literal values and MUST NOT contain\ntemplate syntax: `slug`, `display_name`, `provider_type`, all keys and\nvalues under `attribute_mappings` (used as JSONPath-like accessors into\ntoken claims), and all keys and values under `entity_matching`.\n",
|
|
15488
15573
|
"properties": {
|
|
15489
15574
|
"slug": {
|
|
15490
15575
|
"$ref": "#/components/schemas/ProviderSlug"
|
|
@@ -15526,7 +15611,7 @@
|
|
|
15526
15611
|
"$ref": "#/components/schemas/ProviderDisplayName"
|
|
15527
15612
|
},
|
|
15528
15613
|
"oidc_config": {
|
|
15529
|
-
"$ref": "#/components/schemas/
|
|
15614
|
+
"$ref": "#/components/schemas/OIDCProviderPublicConfig"
|
|
15530
15615
|
},
|
|
15531
15616
|
"mobile_oidc_config": {
|
|
15532
15617
|
"$ref": "#/components/schemas/MoblieOIDCConfig"
|
|
@@ -15676,6 +15761,7 @@
|
|
|
15676
15761
|
},
|
|
15677
15762
|
"OIDCProviderConfig": {
|
|
15678
15763
|
"type": "object",
|
|
15764
|
+
"description": "OIDC provider configuration. All string fields support env var interpolation\n(incl. secrets) via mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.\n",
|
|
15679
15765
|
"properties": {
|
|
15680
15766
|
"type": {
|
|
15681
15767
|
"type": "string",
|
|
@@ -15687,20 +15773,22 @@
|
|
|
15687
15773
|
},
|
|
15688
15774
|
"oidc_issuer": {
|
|
15689
15775
|
"type": "string",
|
|
15690
|
-
"description": "Issuing Authority URL",
|
|
15776
|
+
"description": "Issuing Authority URL. Supports env var interpolation, e.g. `{{ env.MY_ISSUER }}`.",
|
|
15691
15777
|
"example": "https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0"
|
|
15692
15778
|
},
|
|
15693
15779
|
"redirect_uri": {
|
|
15694
15780
|
"type": "string",
|
|
15695
|
-
"description": "Redirect URI for the OIDC flow",
|
|
15781
|
+
"description": "Redirect URI for the OIDC flow. Supports env var interpolation.",
|
|
15696
15782
|
"example": "https://customer-portal.com/login"
|
|
15697
15783
|
},
|
|
15698
15784
|
"client_id": {
|
|
15699
15785
|
"type": "string",
|
|
15786
|
+
"description": "Supports env var interpolation, e.g. `{{ env.MY_CLIENT_ID }}`.",
|
|
15700
15787
|
"example": "ab81daf8-8b1f-42d6-94ca-c51621054c75"
|
|
15701
15788
|
},
|
|
15702
15789
|
"client_secret": {
|
|
15703
15790
|
"type": "string",
|
|
15791
|
+
"description": "Client Secret. Supports env var interpolation (incl. secrets), e.g.\n`{{ env.MY_CLIENT_SECRET }}`. Prefer storing the actual secret as an org\nenv var and referencing it here.\n",
|
|
15704
15792
|
"example": "7BIUnn~6shh.7fNtXb..3k1Mp3s6k6WK3B"
|
|
15705
15793
|
},
|
|
15706
15794
|
"has_client_secret": {
|
|
@@ -15731,17 +15819,72 @@
|
|
|
15731
15819
|
"scope"
|
|
15732
15820
|
]
|
|
15733
15821
|
},
|
|
15822
|
+
"OIDCProviderPublicConfig": {
|
|
15823
|
+
"type": "object",
|
|
15824
|
+
"description": "Public OIDC provider configuration. Same as OIDCProviderConfig but never includes\nthe `client_secret` field — it is kept server-side and only used to exchange the\nauthorization code at the SSO callback. String fields are returned with env var\nplaceholders already resolved when fetched via `GET /v2/portal/public/sso/providers/{provider_slug}`.\n",
|
|
15825
|
+
"properties": {
|
|
15826
|
+
"type": {
|
|
15827
|
+
"type": "string",
|
|
15828
|
+
"enum": [
|
|
15829
|
+
"authorization_code",
|
|
15830
|
+
"implicit"
|
|
15831
|
+
],
|
|
15832
|
+
"default": "implicit"
|
|
15833
|
+
},
|
|
15834
|
+
"oidc_issuer": {
|
|
15835
|
+
"type": "string",
|
|
15836
|
+
"description": "Issuing Authority URL",
|
|
15837
|
+
"example": "https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0"
|
|
15838
|
+
},
|
|
15839
|
+
"redirect_uri": {
|
|
15840
|
+
"type": "string",
|
|
15841
|
+
"description": "Redirect URI for the OIDC flow",
|
|
15842
|
+
"example": "https://customer-portal.com/login"
|
|
15843
|
+
},
|
|
15844
|
+
"client_id": {
|
|
15845
|
+
"type": "string",
|
|
15846
|
+
"example": "ab81daf8-8b1f-42d6-94ca-c51621054c75"
|
|
15847
|
+
},
|
|
15848
|
+
"has_client_secret": {
|
|
15849
|
+
"type": "boolean",
|
|
15850
|
+
"description": "Whether the client secret is present (the value itself is kept server-side)",
|
|
15851
|
+
"example": true
|
|
15852
|
+
},
|
|
15853
|
+
"scope": {
|
|
15854
|
+
"type": "string",
|
|
15855
|
+
"description": "Space-separated list of OAuth 2.0 scopes to request from OpenID Connect",
|
|
15856
|
+
"example": "openid email"
|
|
15857
|
+
},
|
|
15858
|
+
"metadata": {
|
|
15859
|
+
"$ref": "#/components/schemas/OIDCProviderMetadata"
|
|
15860
|
+
},
|
|
15861
|
+
"prompt": {
|
|
15862
|
+
"type": "string",
|
|
15863
|
+
"enum": [
|
|
15864
|
+
"login",
|
|
15865
|
+
"select_account",
|
|
15866
|
+
"consent"
|
|
15867
|
+
]
|
|
15868
|
+
}
|
|
15869
|
+
},
|
|
15870
|
+
"required": [
|
|
15871
|
+
"oidc_issuer",
|
|
15872
|
+
"client_id",
|
|
15873
|
+
"scope"
|
|
15874
|
+
]
|
|
15875
|
+
},
|
|
15734
15876
|
"MoblieOIDCConfig": {
|
|
15735
15877
|
"type": "object",
|
|
15878
|
+
"description": "Mobile OIDC configuration. All string fields support env var interpolation\n(incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.\n",
|
|
15736
15879
|
"properties": {
|
|
15737
15880
|
"client_id": {
|
|
15738
15881
|
"type": "string",
|
|
15739
|
-
"description": "Client ID for the mobile app",
|
|
15882
|
+
"description": "Client ID for the mobile app. Supports env var interpolation.",
|
|
15740
15883
|
"example": 123456
|
|
15741
15884
|
},
|
|
15742
15885
|
"client_secret": {
|
|
15743
15886
|
"type": "string",
|
|
15744
|
-
"description": "Client Secret for the mobile app",
|
|
15887
|
+
"description": "Client Secret for the mobile app. Supports env var interpolation (incl. secrets),\ne.g. `{{ env.MOBILE_CLIENT_SECRET }}`.\n",
|
|
15745
15888
|
"example": 123456
|
|
15746
15889
|
}
|
|
15747
15890
|
}
|
|
@@ -15786,12 +15929,12 @@
|
|
|
15786
15929
|
},
|
|
15787
15930
|
"test_auth_username": {
|
|
15788
15931
|
"type": "string",
|
|
15789
|
-
"description": "The username for the test auth, only used for testing on auth code flow",
|
|
15932
|
+
"description": "The username for the test auth, only used for testing on auth code flow.\nSupports env var interpolation, e.g. `{{ env.MY_TEST_AUTH_USERNAME }}`.\n",
|
|
15790
15933
|
"example": "test@epilot.io"
|
|
15791
15934
|
},
|
|
15792
15935
|
"test_auth_password": {
|
|
15793
15936
|
"type": "string",
|
|
15794
|
-
"description": "The password for the test auth, only used for testing on auth code flow"
|
|
15937
|
+
"description": "The password for the test auth, only used for testing on auth code flow.\nSupports env var interpolation (incl. secrets), e.g. `{{ env.MY_TEST_AUTH_PASSWORD }}`.\n"
|
|
15795
15938
|
}
|
|
15796
15939
|
}
|
|
15797
15940
|
},
|