@epilot/customer-portal-client 0.44.0 → 0.45.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 +20 -0
- package/dist/openapi.d.ts +217 -5
- package/package.json +13 -14
- package/src/openapi-runtime.json +20 -0
- package/src/openapi.json +249 -9
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={438(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(466));r.default=n.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v1/portal/exports":{"post":{"operationId":"createExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/exports/{jobId}":{"get":{"operationId":"getExport","parameters":[{"in":"path","name":"jobId","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/visualization/metadata":{"get":{"operationId":"getVisualizationMetadata","parameters":[{"in":"query","name":"app_id","required":true},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates:migrate-references":{"post":{"operationId":"migrateEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates:list-references":{"post":{"operationId":"listEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates/{portal_id}":{"post":{"operationId":"upsertEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/public-widgets":{"get":{"operationId":"getPublicPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/widgets":{"get":{"operationId":"getPublicPortalWidgetsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"responses":{}}},"/v3/portal/widgets":{"get":{"operationId":"getPortalWidgetsV3","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"contract_id","required":false}],"responses":{}},"post":{"operationId":"upsertPortalWidgetV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/portal/files":{"post":{"operationId":"savePortalFilesV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","deprecated":true,"responses":{}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","responses":{}}},"/v2/portal/public/schemas":{"get":{"operationId":"getSchemasByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v3/portal/public/schemas":{"get":{"operationId":"getPublicSchemasV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/org/settings":{"get":{"operationId":"getOrganizationSettingsByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","responses":{}}},"/v2/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecords","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecordsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/contact":{"get":{"operationId":"getContact","responses":{}},"patch":{"operationId":"updateContact","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","parameters":[{"in":"query","name":"id","required":true}],"responses":{}}},"/v2/portal/public/contact/exists":{"post":{"operationId":"checkContactExists","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/contact/exists":{"post":{"operationId":"checkContactExistsV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/account/exists":{"post":{"operationId":"checkAccountExists","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","responses":{}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","responses":{}},"patch":{"operationId":"updatePortalUser","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalUser","responses":{}}},"/v2/portal/user/update/email":{"put":{"operationId":"updatePortalUserEmail","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/change/password":{"put":{"operationId":"changePortalUserPassword","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/{id}/resolve-templates":{"post":{"operationId":"getContractWithTemplates","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/preview":{"get":{"operationId":"getFilePreview","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/downloaded":{"post":{"operationId":"trackFileDownloaded","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/files/count-by-entity":{"get":{"operationId":"getFilesCountByEntity","deprecated":true,"responses":{}}},"/v2/portal/billing/events":{"get":{"operationId":"getBillingEvents","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"name":"entity_id","in":"query","required":false},{"name":"event_type","in":"query"},{"name":"paid","in":"query"},{"name":"date_after","in":"query"},{"name":"date_before","in":"query"},{"name":"sort","in":"query"}],"responses":{}}},"/v2/portal/billing/customers/balance":{"get":{"operationId":"getCustomerBalance","responses":{}}},"/v2/portal/billing/accounts/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getBillingAccount","responses":{}}},"/v2/portal/admin:login-as-user":{"post":{"operationId":"loginToPortalAsUser","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEvent","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"origin","in":"query","required":true}],"responses":{}}},"/v3/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEventV3","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"portal_id","in":"query","required":false},{"name":"domain","in":"query","required":false}],"responses":{}}},"/v2/portal/entity:get":{"post":{"operationId":"getPortalUserEntity","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity:search":{"post":{"operationId":"searchPortalUserEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{slug}":{"post":{"operationId":"createPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{slug}/{id}":{"patch":{"operationId":"patchPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/can-trigger-portal-flow":{"post":{"operationId":"canTriggerPortalFlow","parameters":[{"in":"query","name":"origin","required":false,"deprecated":true},{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/automation-context":{"get":{"operationId":"getAutomationContext","parameters":[{"in":"query","name":"activity_id","required":true},{"in":"query","name":"type","required":true}],"responses":{}}},"/v2/portal/workflow/{workflow_id}/{step_id}:markDone":{"put":{"operationId":"updateWorkflowStepAsDone","parameters":[{"in":"path","name":"workflow_id","required":true},{"in":"path","name":"step_id","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows":{"get":{"operationId":"getEntityWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/engagement/tasks":{"get":{"operationId":"getOutstandingTasks","responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows/linearized":{"get":{"operationId":"getEntityPortalWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entities/workflows/linearized/batch":{"post":{"operationId":"getEntityPortalWorkflowsBatch","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/metering/readings":{"post":{"operationId":"getMeterReadings","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/providers/{provider_slug}":{"get":{"operationId":"getSSOProvider","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"origin","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/sso/login":{"post":{"operationId":"ssoLogin","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/sso/login":{"post":{"operationId":"ssoLoginV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"org_id","required":false},{"in":"query","name":"domain","required":false},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/redirect":{"post":{"operationId":"ssoRedirect","parameters":[{"in":"query","name":"web_uri","required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{}}},"responses":{}}},"/v2/portal/public/sso/callback":{"post":{"operationId":"ssoCallback","parameters":[{"in":"query","name":"domain"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getPortalPage","responses":{}},"put":{"operationId":"updatePortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPage","responses":{}}},"/v2/portal/pages":{"parameters":[{"in":"query","name":"domain","required":true}],"get":{"operationId":"getPortalPages","parameters":[{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false},{"in":"query","name":"contract_id","required":false,"deprecated":true},{"in":"query","name":"context_entities","required":false}],"responses":{}},"post":{"operationId":"createPortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/pages":{"get":{"operationId":"getPublicPages","parameters":[{"in":"query","name":"domain","required":true},{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false}],"responses":{}}},"/v2/portal/pages/interpolate":{"post":{"operationId":"interpolatePortalPages","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/config/triggered-journeys/{trigger_name}":{"parameters":[{"in":"path","name":"trigger_name","required":true,"description":"The trigger event for the auto-triggered journey"}],"get":{"operationId":"getTriggeredJourney","parameters":[{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/pages/default":{"get":{"operationId":"getDefaultPages","responses":{}}},"/v2/portal/pages/{id}/blocks":{"parameters":[{"in":"path","name":"id","required":true}],"post":{"operationId":"createPortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalPageBlocks","responses":{}}},"/v2/portal/pages/{id}/blocks/{block_id}":{"parameters":[{"in":"path","name":"id","required":true},{"in":"path","name":"block_id","required":true}],"get":{"operationId":"getPortalPageBlock","responses":{}},"put":{"operationId":"updatePortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPageBlock","responses":{}}},"/v2/portal/public/user/entry-point":{"get":{"operationId":"getUserEntryPoint","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/campaign/{campaign_id}/entity:status":{"put":{"operationId":"updateCampaignPortalBlockStatus","parameters":[{"in":"path","name":"campaign_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/notifications":{"get":{"operationId":"listPortalNotifications","parameters":[{"in":"query","name":"cursor","required":false},{"in":"query","name":"limit","required":false}],"responses":{}}},"/v2/portal/notifications/unread-count":{"get":{"operationId":"getPortalNotificationsUnreadCount","responses":{}}},"/v2/portal/notifications/read-all":{"put":{"operationId":"markAllPortalNotificationsRead","responses":{}}},"/v2/portal/notifications/{id}/read":{"put":{"operationId":"markPortalNotificationRead","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/notifications/entity:status":{"put":{"operationId":"updateNotificationsStatus","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/m-login/deregister/{client_id}/{user_id}":{"delete":{"operationId":"deRegisterMLoginUser","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"responses":{}}},"/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}":{"post":{"operationId":"notifyMLoginInterestChange","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config":{"post":{"operationId":"createPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/{portal_id}":{"get":{"operationId":"getPortalConfigV3","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}},"put":{"operationId":"putPortalConfig","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"query","name":"page_upsert_mode","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalConfig","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/configs":{"get":{"operationId":"listAllPortalConfigs","responses":{}}},"/v3/portal/config/swap":{"post":{"operationId":"swapPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/clone":{"post":{"operationId":"clonePortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/invite":{"post":{"operationId":"invitePartner","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/list":{"get":{"operationId":"listBusinessPartners","responses":{}}},"/v3/portal/partner/{partner_id}/resend-invitation":{"post":{"operationId":"resendPartnerInvitation","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/revoke":{"delete":{"operationId":"revokePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/disable":{"post":{"operationId":"disablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/enable":{"post":{"operationId":"enablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/verify-dns":{"post":{"operationId":"verifyDns","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/proxy/execute":{"post":{"operationId":"portalProxyExecute","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/mobile-config":{"get":{"operationId":"getMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"raw","required":false}],"responses":{}},"put":{"operationId":"putMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"InvalidRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"ForbiddenByRule":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"ContractAssignmentConflict":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ConfirmUserInvalidRequest":{"content":{"application/json":{}}},"InvalidRequestCreateMeterReading":{"content":{"application/json":{}}}}},"servers":[{"url":"https://customer-portal-api.sls.epilot.io"}]}')}},r={},t=function t(a){var n=r[a];if(void 0!==n)return n.exports;var i=r[a]={exports:{}};return e[a].call(i.exports,i,i.exports,t),i.exports}(438),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={438(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(466));r.default=n.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"portal_id","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/user":{"post":{"operationId":"createUserV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/token/validate":{"post":{"operationId":"validateToken","responses":{}}},"/v2/portal/token/revoke":{"post":{"operationId":"revokeToken","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}},"delete":{"operationId":"deletePortal","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v1/portal/exports":{"post":{"operationId":"createExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/exports/{jobId}":{"get":{"operationId":"getExport","parameters":[{"in":"path","name":"jobId","required":true}],"responses":{}}},"/v2/portal/extensions":{"get":{"operationId":"getPortalExtensions","parameters":[{"in":"query","name":"origin","required":false}],"responses":{}}},"/v2/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetails","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/extensions":{"get":{"operationId":"getPortalExtensionsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/public/extensions":{"get":{"operationId":"getPublicPortalExtensionDetailsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/consumption":{"get":{"operationId":"getConsumption","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/visualization:export":{"post":{"operationId":"prepareVisualizationExport","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/visualization/metadata":{"get":{"operationId":"getVisualizationMetadata","parameters":[{"in":"query","name":"app_id","required":true},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/costs":{"get":{"operationId":"getCosts","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/prices":{"get":{"operationId":"getPrices","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extensionId","required":true},{"in":"query","name":"hookId","required":false},{"in":"query","name":"meter_id","required":false,"deprecated":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"interval","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/external-links":{"get":{"operationId":"getExternalLinks","parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLink","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/external-links":{"get":{"operationId":"getExternalLinksV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v3/portal/resolve:external-link/{id}":{"get":{"operationId":"getResolvedExternalLinkV3","deprecated":true,"parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"contactId","required":false}],"responses":{}}},"/v2/portal/resolve:seamless-link":{"get":{"operationId":"getResolvedSeamlessLink","parameters":[{"in":"query","name":"app_id","required":false},{"in":"query","name":"extension_id","required":true},{"in":"query","name":"link_id","required":true},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfigV3","parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfigV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","responses":{}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplates","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/email-templates:migrate-references":{"post":{"operationId":"migrateEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates:list-references":{"post":{"operationId":"listEmailTemplateReferences","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/email-templates/{portal_id}":{"post":{"operationId":"upsertEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getEmailTemplatesByPortalId","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/public-widgets":{"get":{"operationId":"getPublicPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/public/widgets":{"get":{"operationId":"getPublicPortalWidgetsV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/widgets":{"post":{"operationId":"upsertPortalWidget","deprecated":true,"parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalWidgets","deprecated":true,"parameters":[{"in":"query","name":"origin","required":false},{"in":"query","name":"contract_id","required":false}],"responses":{}}},"/v3/portal/widgets":{"get":{"operationId":"getPortalWidgetsV3","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"contract_id","required":false}],"responses":{}},"post":{"operationId":"upsertPortalWidgetV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/portal/files":{"post":{"operationId":"savePortalFilesV3","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","deprecated":true,"responses":{}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","responses":{}}},"/v2/portal/public/schemas":{"get":{"operationId":"getSchemasByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v3/portal/public/schemas":{"get":{"operationId":"getPublicSchemasV3","parameters":[{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/org/settings":{"get":{"operationId":"getOrganizationSettingsByDomain","parameters":[{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","responses":{}}},"/v2/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecords","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/validate/caa-records":{"post":{"operationId":"validateCaaRecordsV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/contact":{"get":{"operationId":"getContact","responses":{}},"patch":{"operationId":"updateContact","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","parameters":[{"in":"query","name":"id","required":true}],"responses":{}}},"/v2/portal/public/contact/exists":{"post":{"operationId":"checkContactExists","parameters":[{"in":"query","name":"origin","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/contact/exists":{"post":{"operationId":"checkContactExistsV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/account/exists":{"post":{"operationId":"checkAccountExists","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","responses":{}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","responses":{}},"patch":{"operationId":"updatePortalUser","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalUser","responses":{}}},"/v2/portal/user/update/email":{"put":{"operationId":"updatePortalUserEmail","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/change/password":{"put":{"operationId":"changePortalUserPassword","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/user/resend/confirmation-email/{id}":{"post":{"operationId":"resendConfirmationEmail","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/users/by-related-entity":{"get":{"operationId":"fetchPortalUsersByRelatedEntity","parameters":[{"in":"query","name":"entity_id","required":true},{"in":"query","name":"slug","required":true}],"responses":{}}},"/v2/portal/user/confirm":{"get":{"operationId":"confirmUser","parameters":[{"in":"query","name":"confirmation_link_token","required":true},{"in":"query","name":"use_redirect","required":false}],"responses":{}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUserWithUserId","parameters":[{"in":"query","name":"origin","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"org_id","required":true}],"responses":{}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"origin","required":false}],"responses":{}}},"/v3/portal/public/user/exists":{"get":{"operationId":"userExistsV3","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/recipients-to-notify":{"post":{"operationId":"getRecipientsToNotifyOnAutomation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","parameters":[{"in":"query","name":"origin","required":true}],"responses":{}}},"/v3/portal/configure-distribution":{"get":{"operationId":"configureDistributionV3","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/order/{id}/acceptance":{"post":{"operationId":"postOrderAcceptance","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOrder","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/searchable-attributes":{"get":{"operationId":"getSearchableAttributesForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/opportunities/search":{"post":{"operationId":"getSearchResultsForOpportunities","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateOpportunity","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/request":{"get":{"operationId":"getAllRequests","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","deprecated":true,"parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false}],"responses":{}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateContract","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/{id}/resolve-templates":{"post":{"operationId":"getContractWithTemplates","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/contract/by-identifiers":{"post":{"operationId":"addContractByIdentifiers","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","parameters":[{"in":"path","name":"slug","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v2/portal/{slug}/{id}:validateRule":{"get":{"operationId":"validateCadenceEntityEditRules","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"attribute"}],"responses":{}}},"/v2/portal/entities-by-payment/{id}":{"get":{"operationId":"searchPaymentRelationsInEntities","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entity/activity":{"put":{"operationId":"createCustomEntityActivity","parameters":[{"in":"query","name":"entities","deprecated":true,"style":"form"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteEntityFile","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/registration/identifiers":{"get":{"operationId":"getRegistrationIdentifiers","responses":{}}},"/v2/portal/user/files":{"get":{"operationId":"getAllFiles","deprecated":true,"parameters":[{"in":"query","name":"from","required":true},{"in":"query","name":"size","required":true},{"in":"query","name":"entity_ids"},{"in":"query","name":"file_types"}],"responses":{}}},"/v2/portal/user/file/{id}":{"get":{"operationId":"getFileById","deprecated":true,"parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/preview":{"get":{"operationId":"getFilePreview","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/file/{id}/downloaded":{"post":{"operationId":"trackFileDownloaded","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/user/files/count-by-entity":{"get":{"operationId":"getFilesCountByEntity","deprecated":true,"responses":{}}},"/v2/portal/billing/events":{"get":{"operationId":"getBillingEvents","parameters":[{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"name":"entity_id","in":"query","required":false},{"name":"event_type","in":"query"},{"name":"paid","in":"query"},{"name":"date_after","in":"query"},{"name":"date_before","in":"query"},{"name":"sort","in":"query"}],"responses":{}}},"/v2/portal/billing/customers/balance":{"get":{"operationId":"getCustomerBalance","responses":{}}},"/v2/portal/billing/accounts/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getBillingAccount","responses":{}}},"/v2/portal/admin:login-as-user":{"post":{"operationId":"loginToPortalAsUser","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEvent","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"origin","in":"query","required":true}],"responses":{}}},"/v3/portal/entity/{schema}/access":{"post":{"operationId":"triggerEntityAccessEventV3","parameters":[{"name":"schema","in":"path","required":true},{"name":"entity_id","in":"query","required":false},{"name":"portal_id","in":"query","required":false},{"name":"domain","in":"query","required":false}],"responses":{}}},"/v2/portal/entity:get":{"post":{"operationId":"getPortalUserEntity","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity:search":{"post":{"operationId":"searchPortalUserEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{slug}":{"post":{"operationId":"createPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/entity/{slug}/{id}":{"patch":{"operationId":"patchPortalUserEntity","deprecated":true,"parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/can-trigger-portal-flow":{"post":{"operationId":"canTriggerPortalFlow","parameters":[{"in":"query","name":"origin","required":false,"deprecated":true},{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/automation-context":{"get":{"operationId":"getAutomationContext","parameters":[{"in":"query","name":"activity_id","required":true},{"in":"query","name":"type","required":true}],"responses":{}}},"/v2/portal/workflow/{workflow_id}/{step_id}:markDone":{"put":{"operationId":"updateWorkflowStepAsDone","parameters":[{"in":"path","name":"workflow_id","required":true},{"in":"path","name":"step_id","required":true}],"responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows":{"get":{"operationId":"getEntityWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/engagement/tasks":{"get":{"operationId":"getOutstandingTasks","responses":{}}},"/v2/portal/entity/{slug}/{id}/workflows/linearized":{"get":{"operationId":"getEntityPortalWorkflows","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/entities/workflows/linearized/batch":{"post":{"operationId":"getEntityPortalWorkflowsBatch","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/photo":{"post":{"operationId":"uploadMeterReadingPhoto","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading":{"post":{"operationId":"createMeterReading","parameters":[{"name":"override_plausibility","in":"query","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/metering/reading/allowed-range/{meter_id}":{"get":{"operationId":"getAllowedMeterReadingRange","parameters":[{"in":"path","name":"meter_id","required":true},{"in":"query","name":"origin","required":false},{"in":"query","name":"timestamp","required":false},{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/metering/readings":{"post":{"operationId":"getMeterReadings","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/providers/{provider_slug}":{"get":{"operationId":"getSSOProvider","parameters":[{"in":"path","name":"provider_slug","required":true},{"in":"query","name":"org_id","required":false},{"in":"query","name":"origin","required":false},{"in":"query","name":"portal_id","required":false},{"in":"query","name":"domain","required":false}],"responses":{}}},"/v2/portal/public/sso/login":{"post":{"operationId":"ssoLogin","parameters":[{"in":"query","name":"origin","required":true},{"in":"query","name":"org_id","required":true},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/portal/public/sso/login":{"post":{"operationId":"ssoLoginV3","parameters":[{"in":"query","name":"portal_id","required":false},{"in":"query","name":"org_id","required":false},{"in":"query","name":"domain","required":false},{"in":"query","name":"contact_id","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/sso/redirect":{"post":{"operationId":"ssoRedirect","parameters":[{"in":"query","name":"web_uri","required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{}}},"responses":{}}},"/v2/portal/public/sso/callback":{"post":{"operationId":"ssoCallback","parameters":[{"in":"query","name":"domain"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/pages/{id}":{"parameters":[{"in":"path","name":"id","required":true}],"get":{"operationId":"getPortalPage","responses":{}},"put":{"operationId":"updatePortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPage","responses":{}}},"/v2/portal/pages":{"parameters":[{"in":"query","name":"domain","required":true}],"get":{"operationId":"getPortalPages","parameters":[{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false},{"in":"query","name":"contract_id","required":false,"deprecated":true},{"in":"query","name":"context_entities","required":false}],"responses":{}},"post":{"operationId":"createPortalPage","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/pages":{"get":{"operationId":"getPublicPages","parameters":[{"in":"query","name":"domain","required":true},{"in":"query","name":"fields","required":false},{"in":"query","name":"filter","required":false}],"responses":{}}},"/v2/portal/pages/interpolate":{"post":{"operationId":"interpolatePortalPages","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/config/triggered-journeys/{trigger_name}":{"parameters":[{"in":"path","name":"trigger_name","required":true,"description":"The trigger event for the auto-triggered journey"}],"get":{"operationId":"getTriggeredJourney","parameters":[{"in":"query","name":"context_entities","required":false}],"responses":{}}},"/v2/portal/pages/default":{"get":{"operationId":"getDefaultPages","responses":{}}},"/v2/portal/pages/{id}/blocks":{"parameters":[{"in":"path","name":"id","required":true}],"post":{"operationId":"createPortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"getPortalPageBlocks","responses":{}}},"/v2/portal/pages/{id}/blocks/{block_id}":{"parameters":[{"in":"path","name":"id","required":true},{"in":"path","name":"block_id","required":true}],"get":{"operationId":"getPortalPageBlock","responses":{}},"put":{"operationId":"updatePortalPageBlock","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalPageBlock","responses":{}}},"/v2/portal/public/user/entry-point":{"get":{"operationId":"getUserEntryPoint","parameters":[{"in":"query","name":"email","required":true},{"in":"query","name":"domain","required":true}],"responses":{}}},"/v2/portal/campaign/{campaign_id}/entity:status":{"put":{"operationId":"updateCampaignPortalBlockStatus","parameters":[{"in":"path","name":"campaign_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/notifications":{"get":{"operationId":"listPortalNotifications","parameters":[{"in":"query","name":"cursor","required":false},{"in":"query","name":"limit","required":false}],"responses":{}}},"/v2/portal/notifications/unread-count":{"get":{"operationId":"getPortalNotificationsUnreadCount","responses":{}}},"/v2/portal/notifications/read-all":{"put":{"operationId":"markAllPortalNotificationsRead","responses":{}}},"/v2/portal/notifications/{id}/read":{"put":{"operationId":"markPortalNotificationRead","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/portal/notifications/entity:status":{"put":{"operationId":"updateNotificationsStatus","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/portal/public/m-login/deregister/{client_id}/{user_id}":{"delete":{"operationId":"deRegisterMLoginUser","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"responses":{}}},"/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}":{"post":{"operationId":"notifyMLoginInterestChange","parameters":[{"in":"path","name":"client_id","required":true},{"in":"path","name":"user_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config":{"post":{"operationId":"createPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/{portal_id}":{"get":{"operationId":"getPortalConfigV3","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}},"put":{"operationId":"putPortalConfig","parameters":[{"in":"path","name":"portal_id","required":true},{"in":"query","name":"page_upsert_mode","required":false}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deletePortalConfig","parameters":[{"in":"path","name":"portal_id","required":true}],"responses":{}}},"/v3/portal/configs":{"get":{"operationId":"listAllPortalConfigs","responses":{}}},"/v3/portal/config/swap":{"post":{"operationId":"swapPortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/config/clone":{"post":{"operationId":"clonePortalConfig","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/invite":{"post":{"operationId":"invitePartner","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v3/portal/partner/list":{"get":{"operationId":"listBusinessPartners","responses":{}}},"/v3/portal/partner/{partner_id}/resend-invitation":{"post":{"operationId":"resendPartnerInvitation","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/revoke":{"delete":{"operationId":"revokePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/disable":{"post":{"operationId":"disablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/partner/{partner_id}/enable":{"post":{"operationId":"enablePartner","parameters":[{"name":"partner_id","in":"path","required":true}],"responses":{}}},"/v3/portal/verify-dns":{"post":{"operationId":"verifyDns","parameters":[{"in":"query","name":"portal_id","required":true}],"responses":{}}},"/v2/portal/proxy/execute":{"post":{"operationId":"portalProxyExecute","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/portal/mobile-config":{"get":{"operationId":"getMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true},{"in":"query","name":"raw","required":false}],"responses":{}},"put":{"operationId":"putMobileConfig","parameters":[{"in":"query","name":"portal_id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"InvalidRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"ForbiddenByRule":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"ContractAssignmentConflict":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"TooManyRequests":{"content":{"application/json":{}}},"BadGateway":{"content":{"application/json":{}}},"ServiceUnavailable":{"content":{"application/json":{}}},"GatewayTimeout":{"content":{"application/json":{}}},"ConfirmUserInvalidRequest":{"content":{"application/json":{}}},"InvalidRequestCreateMeterReading":{"content":{"application/json":{}}}}},"servers":[{"url":"https://customer-portal-api.sls.epilot.io"}]}')}},r={},t=function t(a){var n=r[a];if(void 0!==n)return n.exports;var i=r[a]={exports:{}};return e[a].call(i.exports,i,i.exports,t),i.exports}(438),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
|
|
@@ -2790,6 +2790,26 @@
|
|
|
2790
2790
|
"application/json": {}
|
|
2791
2791
|
}
|
|
2792
2792
|
},
|
|
2793
|
+
"TooManyRequests": {
|
|
2794
|
+
"content": {
|
|
2795
|
+
"application/json": {}
|
|
2796
|
+
}
|
|
2797
|
+
},
|
|
2798
|
+
"BadGateway": {
|
|
2799
|
+
"content": {
|
|
2800
|
+
"application/json": {}
|
|
2801
|
+
}
|
|
2802
|
+
},
|
|
2803
|
+
"ServiceUnavailable": {
|
|
2804
|
+
"content": {
|
|
2805
|
+
"application/json": {}
|
|
2806
|
+
}
|
|
2807
|
+
},
|
|
2808
|
+
"GatewayTimeout": {
|
|
2809
|
+
"content": {
|
|
2810
|
+
"application/json": {}
|
|
2811
|
+
}
|
|
2812
|
+
},
|
|
2793
2813
|
"ConfirmUserInvalidRequest": {
|
|
2794
2814
|
"content": {
|
|
2795
2815
|
"application/json": {}
|
package/dist/openapi.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ import type {
|
|
|
8
8
|
|
|
9
9
|
declare namespace Components {
|
|
10
10
|
namespace Responses {
|
|
11
|
+
export type BadGateway = Schemas.ErrorResp;
|
|
11
12
|
export interface ConfirmUserInvalidRequest {
|
|
12
13
|
/**
|
|
13
14
|
* Error message
|
|
@@ -31,6 +32,7 @@ declare namespace Components {
|
|
|
31
32
|
}
|
|
32
33
|
export type Forbidden = Schemas.ErrorResp;
|
|
33
34
|
export type ForbiddenByRule = Schemas.ErrorResp | Schemas.FailedRuleErrorResp;
|
|
35
|
+
export type GatewayTimeout = Schemas.ErrorResp;
|
|
34
36
|
export type InternalServerError = Schemas.ErrorResp;
|
|
35
37
|
export type InvalidRequest = Schemas.ErrorResp;
|
|
36
38
|
export type InvalidRequestCreateMeterReading = {
|
|
@@ -46,6 +48,8 @@ declare namespace Components {
|
|
|
46
48
|
message?: string;
|
|
47
49
|
} | void;
|
|
48
50
|
export type NotFound = Schemas.ErrorResp;
|
|
51
|
+
export type ServiceUnavailable = Schemas.ErrorResp;
|
|
52
|
+
export type TooManyRequests = Schemas.ErrorResp;
|
|
49
53
|
export type Unauthorized = Schemas.ErrorResp;
|
|
50
54
|
}
|
|
51
55
|
namespace Schemas {
|
|
@@ -933,6 +937,59 @@ declare namespace Components {
|
|
|
933
937
|
*/
|
|
934
938
|
campaign_id?: string;
|
|
935
939
|
}
|
|
940
|
+
export interface CleverPvContext {
|
|
941
|
+
/**
|
|
942
|
+
* Current Clever PV screen identifier
|
|
943
|
+
*/
|
|
944
|
+
screen?: string;
|
|
945
|
+
/**
|
|
946
|
+
* Clever PV application version
|
|
947
|
+
*/
|
|
948
|
+
version?: string;
|
|
949
|
+
/**
|
|
950
|
+
* Device connectivity at the time of the report
|
|
951
|
+
*/
|
|
952
|
+
connection_state?: string;
|
|
953
|
+
/**
|
|
954
|
+
* App locale at the time of the report
|
|
955
|
+
*/
|
|
956
|
+
locale?: string;
|
|
957
|
+
/**
|
|
958
|
+
* App timezone at the time of the report
|
|
959
|
+
*/
|
|
960
|
+
timezone?: string;
|
|
961
|
+
/**
|
|
962
|
+
* Device firmware version when known
|
|
963
|
+
*/
|
|
964
|
+
firmware_version?: string;
|
|
965
|
+
/**
|
|
966
|
+
* App build identifier when known
|
|
967
|
+
*/
|
|
968
|
+
build?: string;
|
|
969
|
+
/**
|
|
970
|
+
* Client-generated correlation id for the report
|
|
971
|
+
*/
|
|
972
|
+
trace_id?: string;
|
|
973
|
+
/**
|
|
974
|
+
* Optional device snapshot from the portal. Attached as a JSON file on
|
|
975
|
+
* the original Zendesk comment. Must include id when present. Serialized
|
|
976
|
+
* JSON is limited to 256 KiB.
|
|
977
|
+
*
|
|
978
|
+
*/
|
|
979
|
+
device?: {
|
|
980
|
+
[name: string]: any;
|
|
981
|
+
};
|
|
982
|
+
/**
|
|
983
|
+
* Optional onboarding vendor id and name. Included in the Zendesk
|
|
984
|
+
* comment. Not a portal entity.
|
|
985
|
+
*
|
|
986
|
+
*/
|
|
987
|
+
vendor?: {
|
|
988
|
+
[name: string]: any;
|
|
989
|
+
id?: string;
|
|
990
|
+
name?: string;
|
|
991
|
+
};
|
|
992
|
+
}
|
|
936
993
|
export interface CommonConfigAttributes {
|
|
937
994
|
/**
|
|
938
995
|
* Mobile app configuration (top-level; moved out of the config blob).
|
|
@@ -1030,6 +1087,14 @@ declare namespace Components {
|
|
|
1030
1087
|
* Enable or disable the new design for the portal
|
|
1031
1088
|
*/
|
|
1032
1089
|
new_design?: boolean;
|
|
1090
|
+
/**
|
|
1091
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
1092
|
+
*/
|
|
1093
|
+
mcp_enabled?: boolean;
|
|
1094
|
+
/**
|
|
1095
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
1096
|
+
*/
|
|
1097
|
+
mcp_grant_version?: number;
|
|
1033
1098
|
};
|
|
1034
1099
|
/**
|
|
1035
1100
|
* Access token for the portal
|
|
@@ -1565,6 +1630,14 @@ declare namespace Components {
|
|
|
1565
1630
|
* Enable or disable the new design for the portal
|
|
1566
1631
|
*/
|
|
1567
1632
|
new_design?: boolean;
|
|
1633
|
+
/**
|
|
1634
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
1635
|
+
*/
|
|
1636
|
+
mcp_enabled?: boolean;
|
|
1637
|
+
/**
|
|
1638
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
1639
|
+
*/
|
|
1640
|
+
mcp_grant_version?: number;
|
|
1568
1641
|
};
|
|
1569
1642
|
/**
|
|
1570
1643
|
* Access token for the portal
|
|
@@ -2362,6 +2435,34 @@ declare namespace Components {
|
|
|
2362
2435
|
*/
|
|
2363
2436
|
EntitySlug;
|
|
2364
2437
|
}
|
|
2438
|
+
export interface CreateSupportRequest {
|
|
2439
|
+
report_type: SupportReportType;
|
|
2440
|
+
description: string;
|
|
2441
|
+
/**
|
|
2442
|
+
* Client-generated id for correlating the request
|
|
2443
|
+
*/
|
|
2444
|
+
submission_id: string; // ^[A-Za-z0-9._-]+$
|
|
2445
|
+
site_id?: /**
|
|
2446
|
+
* Entity ID
|
|
2447
|
+
* example:
|
|
2448
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
2449
|
+
*/
|
|
2450
|
+
EntityId /* uuid */;
|
|
2451
|
+
device_id?: /**
|
|
2452
|
+
* Entity ID
|
|
2453
|
+
* example:
|
|
2454
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
2455
|
+
*/
|
|
2456
|
+
EntityId /* uuid */;
|
|
2457
|
+
clever_pv?: CleverPvContext;
|
|
2458
|
+
attachments?: [
|
|
2459
|
+
SupportRequestAttachment?,
|
|
2460
|
+
SupportRequestAttachment?,
|
|
2461
|
+
SupportRequestAttachment?,
|
|
2462
|
+
SupportRequestAttachment?,
|
|
2463
|
+
SupportRequestAttachment?
|
|
2464
|
+
];
|
|
2465
|
+
}
|
|
2365
2466
|
export interface CreateUserRequest {
|
|
2366
2467
|
/**
|
|
2367
2468
|
* User's email address
|
|
@@ -3129,7 +3230,7 @@ declare namespace Components {
|
|
|
3129
3230
|
.../* Per-slug search configuration with scoped targets and templates */ EntitySlugConfig[]
|
|
3130
3231
|
];
|
|
3131
3232
|
/**
|
|
3132
|
-
*
|
|
3233
|
+
* Free-text keyword search. This is plain text, **not** a query language: punctuation separates words rather than carrying any special meaning, and every word has to match. Use `q_fields` to restrict which fields are searched, and `filters`/`targets` for structured filtering. Overly long input is trimmed, and input with no words in it is ignored — the remaining parameters still apply.
|
|
3133
3234
|
* example:
|
|
3134
3235
|
* contract
|
|
3135
3236
|
*/
|
|
@@ -4965,6 +5066,10 @@ declare namespace Components {
|
|
|
4965
5066
|
* Whether the org is in canary mode
|
|
4966
5067
|
*/
|
|
4967
5068
|
is_canary?: boolean;
|
|
5069
|
+
/**
|
|
5070
|
+
* Whether the portal still runs the old design (the `new_design` feature setting is off). Legacy portals are always served the frozen legacy bundle, even when the org is in canary.
|
|
5071
|
+
*/
|
|
5072
|
+
is_legacy_design?: boolean;
|
|
4968
5073
|
/**
|
|
4969
5074
|
* The URL to redirect to
|
|
4970
5075
|
* example:
|
|
@@ -6204,6 +6309,14 @@ declare namespace Components {
|
|
|
6204
6309
|
* Enable or disable the new design for the portal
|
|
6205
6310
|
*/
|
|
6206
6311
|
new_design?: boolean;
|
|
6312
|
+
/**
|
|
6313
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
6314
|
+
*/
|
|
6315
|
+
mcp_enabled?: boolean;
|
|
6316
|
+
/**
|
|
6317
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
6318
|
+
*/
|
|
6319
|
+
mcp_grant_version?: number;
|
|
6207
6320
|
};
|
|
6208
6321
|
/**
|
|
6209
6322
|
* Access token for the portal
|
|
@@ -6832,6 +6945,14 @@ declare namespace Components {
|
|
|
6832
6945
|
* Enable or disable the new design for the portal
|
|
6833
6946
|
*/
|
|
6834
6947
|
new_design?: boolean;
|
|
6948
|
+
/**
|
|
6949
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
6950
|
+
*/
|
|
6951
|
+
mcp_enabled?: boolean;
|
|
6952
|
+
/**
|
|
6953
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
6954
|
+
*/
|
|
6955
|
+
mcp_grant_version?: number;
|
|
6835
6956
|
};
|
|
6836
6957
|
/**
|
|
6837
6958
|
* Access token for the portal
|
|
@@ -8310,6 +8431,35 @@ declare namespace Components {
|
|
|
8310
8431
|
use_case_slug: string;
|
|
8311
8432
|
}
|
|
8312
8433
|
export type Source = "ECP" | "ERP" | "360" | "journey-submission";
|
|
8434
|
+
export type SupportReportType = "bug" | "feedback";
|
|
8435
|
+
export interface SupportRequestAttachment {
|
|
8436
|
+
/**
|
|
8437
|
+
* example:
|
|
8438
|
+
* screenshot.png
|
|
8439
|
+
*/
|
|
8440
|
+
filename: string;
|
|
8441
|
+
/**
|
|
8442
|
+
* example:
|
|
8443
|
+
* image/png
|
|
8444
|
+
*/
|
|
8445
|
+
mime_type: string;
|
|
8446
|
+
/**
|
|
8447
|
+
* Base64-encoded file, optionally as a data URL
|
|
8448
|
+
*/
|
|
8449
|
+
contents: string;
|
|
8450
|
+
}
|
|
8451
|
+
export interface SupportRequestResult {
|
|
8452
|
+
/**
|
|
8453
|
+
* example:
|
|
8454
|
+
* 12345
|
|
8455
|
+
*/
|
|
8456
|
+
reference: string;
|
|
8457
|
+
/**
|
|
8458
|
+
* example:
|
|
8459
|
+
* new
|
|
8460
|
+
*/
|
|
8461
|
+
status: string;
|
|
8462
|
+
}
|
|
8313
8463
|
/**
|
|
8314
8464
|
* Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum.
|
|
8315
8465
|
*/
|
|
@@ -8612,6 +8762,14 @@ declare namespace Components {
|
|
|
8612
8762
|
* Enable or disable the new design for the portal
|
|
8613
8763
|
*/
|
|
8614
8764
|
new_design?: boolean;
|
|
8765
|
+
/**
|
|
8766
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
8767
|
+
*/
|
|
8768
|
+
mcp_enabled?: boolean;
|
|
8769
|
+
/**
|
|
8770
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
8771
|
+
*/
|
|
8772
|
+
mcp_grant_version?: number;
|
|
8615
8773
|
};
|
|
8616
8774
|
/**
|
|
8617
8775
|
* Access token for the portal
|
|
@@ -9208,6 +9366,14 @@ declare namespace Components {
|
|
|
9208
9366
|
* Enable or disable the new design for the portal
|
|
9209
9367
|
*/
|
|
9210
9368
|
new_design?: boolean;
|
|
9369
|
+
/**
|
|
9370
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
9371
|
+
*/
|
|
9372
|
+
mcp_enabled?: boolean;
|
|
9373
|
+
/**
|
|
9374
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
9375
|
+
*/
|
|
9376
|
+
mcp_grant_version?: number;
|
|
9211
9377
|
};
|
|
9212
9378
|
/**
|
|
9213
9379
|
* Access token for the portal
|
|
@@ -9700,9 +9866,10 @@ declare namespace Components {
|
|
|
9700
9866
|
*/
|
|
9701
9867
|
type_options?: VisualizationTypeOption[];
|
|
9702
9868
|
/**
|
|
9703
|
-
* Intervals supported for the current context. If omitted, all intervals are assumed supported.
|
|
9869
|
+
* Intervals supported for the current context. If omitted, all intervals are assumed supported. `custom` marks a period-based consumption source: the portal requests the whole `data_range` once with `interval=custom` and renders one bar per returned record (see `period` on the consumption data point) instead of offering interval / date navigation or period comparison. When `custom` is present it takes precedence over any fixed intervals also listed.
|
|
9870
|
+
*
|
|
9704
9871
|
*/
|
|
9705
|
-
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y")[];
|
|
9872
|
+
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y" | "custom")[];
|
|
9706
9873
|
data_range?: /* Earliest / latest timestamps for which data is available in the current context. */ VisualizationDataRange;
|
|
9707
9874
|
}
|
|
9708
9875
|
export interface VisualizationTypeOption {
|
|
@@ -10273,7 +10440,11 @@ declare namespace Paths {
|
|
|
10273
10440
|
*/
|
|
10274
10441
|
columns: /* One column of the portal data export CSV. */ Components.Schemas.PortalDataExportColumn[];
|
|
10275
10442
|
expand_over?: string;
|
|
10276
|
-
|
|
10443
|
+
/**
|
|
10444
|
+
* example:
|
|
10445
|
+
* de
|
|
10446
|
+
*/
|
|
10447
|
+
language?: string;
|
|
10277
10448
|
}
|
|
10278
10449
|
namespace Responses {
|
|
10279
10450
|
export interface $202 {
|
|
@@ -11393,7 +11564,7 @@ declare namespace Paths {
|
|
|
11393
11564
|
export type ExtensionId = string;
|
|
11394
11565
|
export type From = string; // date-time
|
|
11395
11566
|
export type HookId = string;
|
|
11396
|
-
export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y";
|
|
11567
|
+
export type Interval = "PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y" | "custom";
|
|
11397
11568
|
export type MeterId = string;
|
|
11398
11569
|
export type To = string; // date-time
|
|
11399
11570
|
}
|
|
@@ -11442,6 +11613,26 @@ declare namespace Paths {
|
|
|
11442
11613
|
label?: {
|
|
11443
11614
|
[name: string]: string;
|
|
11444
11615
|
};
|
|
11616
|
+
/**
|
|
11617
|
+
* The date range this value covers. Required for period-based sources (`interval=custom`), whose records don't sit on a fixed time grid: the portal renders one bar per record, orders them by `period.from`, and — unless `label` is set — labels each bar with the formatted `from` - `to` range. Ignored for interval-based retrieval.
|
|
11618
|
+
*
|
|
11619
|
+
* example:
|
|
11620
|
+
* {
|
|
11621
|
+
* "from": "2024-01-03T00:00:00.000Z",
|
|
11622
|
+
* "to": "2025-01-05T00:00:00.000Z"
|
|
11623
|
+
* }
|
|
11624
|
+
*/
|
|
11625
|
+
period?: {
|
|
11626
|
+
/**
|
|
11627
|
+
* Start of the covered period.
|
|
11628
|
+
*/
|
|
11629
|
+
from: string; // date-time
|
|
11630
|
+
/**
|
|
11631
|
+
* End of the covered period. Shown as given in the fallback label, so pass the date the period visibly ends on (consecutive periods may share this boundary).
|
|
11632
|
+
*
|
|
11633
|
+
*/
|
|
11634
|
+
to: string; // date-time
|
|
11635
|
+
};
|
|
11445
11636
|
}[];
|
|
11446
11637
|
}
|
|
11447
11638
|
export type $401 = Components.Responses.Unauthorized;
|
|
@@ -13163,6 +13354,14 @@ declare namespace Paths {
|
|
|
13163
13354
|
* Enable or disable the new design for the portal
|
|
13164
13355
|
*/
|
|
13165
13356
|
new_design?: boolean;
|
|
13357
|
+
/**
|
|
13358
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
13359
|
+
*/
|
|
13360
|
+
mcp_enabled?: boolean;
|
|
13361
|
+
/**
|
|
13362
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
13363
|
+
*/
|
|
13364
|
+
mcp_grant_version?: number;
|
|
13166
13365
|
};
|
|
13167
13366
|
/**
|
|
13168
13367
|
* Access token for the portal
|
|
@@ -13789,6 +13988,14 @@ declare namespace Paths {
|
|
|
13789
13988
|
* Enable or disable the new design for the portal
|
|
13790
13989
|
*/
|
|
13791
13990
|
new_design?: boolean;
|
|
13991
|
+
/**
|
|
13992
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
13993
|
+
*/
|
|
13994
|
+
mcp_enabled?: boolean;
|
|
13995
|
+
/**
|
|
13996
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
13997
|
+
*/
|
|
13998
|
+
mcp_grant_version?: number;
|
|
13792
13999
|
};
|
|
13793
14000
|
/**
|
|
13794
14001
|
* Access token for the portal
|
|
@@ -21192,6 +21399,7 @@ export type BlockRequest = Components.Schemas.BlockRequest;
|
|
|
21192
21399
|
export type BlockType = Components.Schemas.BlockType;
|
|
21193
21400
|
export type BusinessPartnerItem = Components.Schemas.BusinessPartnerItem;
|
|
21194
21401
|
export type CampaignWidget = Components.Schemas.CampaignWidget;
|
|
21402
|
+
export type CleverPvContext = Components.Schemas.CleverPvContext;
|
|
21195
21403
|
export type CommonConfigAttributes = Components.Schemas.CommonConfigAttributes;
|
|
21196
21404
|
export type CommonConfigAttributesV3 = Components.Schemas.CommonConfigAttributesV3;
|
|
21197
21405
|
export type Contact = Components.Schemas.Contact;
|
|
@@ -21202,6 +21410,7 @@ export type ContextEntities = Components.Schemas.ContextEntities;
|
|
|
21202
21410
|
export type ContextEntity = Components.Schemas.ContextEntity;
|
|
21203
21411
|
export type Contract = Components.Schemas.Contract;
|
|
21204
21412
|
export type ContractIdentifier = Components.Schemas.ContractIdentifier;
|
|
21413
|
+
export type CreateSupportRequest = Components.Schemas.CreateSupportRequest;
|
|
21205
21414
|
export type CreateUserRequest = Components.Schemas.CreateUserRequest;
|
|
21206
21415
|
export type Currency = Components.Schemas.Currency;
|
|
21207
21416
|
export type DataRetrievalItem = Components.Schemas.DataRetrievalItem;
|
|
@@ -21323,6 +21532,9 @@ export type Schema = Components.Schemas.Schema;
|
|
|
21323
21532
|
export type SearchIncludes = Components.Schemas.SearchIncludes;
|
|
21324
21533
|
export type SecureProxyConfig = Components.Schemas.SecureProxyConfig;
|
|
21325
21534
|
export type Source = Components.Schemas.Source;
|
|
21535
|
+
export type SupportReportType = Components.Schemas.SupportReportType;
|
|
21536
|
+
export type SupportRequestAttachment = Components.Schemas.SupportRequestAttachment;
|
|
21537
|
+
export type SupportRequestResult = Components.Schemas.SupportRequestResult;
|
|
21326
21538
|
export type SwappableConfig = Components.Schemas.SwappableConfig;
|
|
21327
21539
|
export type TariffType = Components.Schemas.TariffType;
|
|
21328
21540
|
export type TeaserWidget = Components.Schemas.TeaserWidget;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/customer-portal-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.45.0",
|
|
4
4
|
"description": "API Client for epilot portal API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -18,18 +18,6 @@
|
|
|
18
18
|
"sdk",
|
|
19
19
|
"customer-portal"
|
|
20
20
|
],
|
|
21
|
-
"scripts": {
|
|
22
|
-
"test": "vitest",
|
|
23
|
-
"typescript": "tsc",
|
|
24
|
-
"bundle-definition": "webpack",
|
|
25
|
-
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/customer-portal.yaml",
|
|
26
|
-
"typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
|
|
27
|
-
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
28
|
-
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
29
|
-
"build:watch": "npm run build && tsc -w",
|
|
30
|
-
"prepublishOnly": "npm run typegen && npm run build",
|
|
31
|
-
"lint": "biome check src"
|
|
32
|
-
},
|
|
33
21
|
"files": [
|
|
34
22
|
"*.js",
|
|
35
23
|
"*.d.ts",
|
|
@@ -67,5 +55,16 @@
|
|
|
67
55
|
"typescript": "^4.1.3",
|
|
68
56
|
"webpack": "^5.18.0",
|
|
69
57
|
"webpack-cli": "^4.4.0"
|
|
58
|
+
},
|
|
59
|
+
"scripts": {
|
|
60
|
+
"test": "vitest",
|
|
61
|
+
"typescript": "tsc",
|
|
62
|
+
"bundle-definition": "webpack",
|
|
63
|
+
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/customer-portal.yaml",
|
|
64
|
+
"typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
|
|
65
|
+
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
66
|
+
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
67
|
+
"build:watch": "npm run build && tsc -w",
|
|
68
|
+
"lint": "biome check src"
|
|
70
69
|
}
|
|
71
|
-
}
|
|
70
|
+
}
|
package/src/openapi-runtime.json
CHANGED
|
@@ -2790,6 +2790,26 @@
|
|
|
2790
2790
|
"application/json": {}
|
|
2791
2791
|
}
|
|
2792
2792
|
},
|
|
2793
|
+
"TooManyRequests": {
|
|
2794
|
+
"content": {
|
|
2795
|
+
"application/json": {}
|
|
2796
|
+
}
|
|
2797
|
+
},
|
|
2798
|
+
"BadGateway": {
|
|
2799
|
+
"content": {
|
|
2800
|
+
"application/json": {}
|
|
2801
|
+
}
|
|
2802
|
+
},
|
|
2803
|
+
"ServiceUnavailable": {
|
|
2804
|
+
"content": {
|
|
2805
|
+
"application/json": {}
|
|
2806
|
+
}
|
|
2807
|
+
},
|
|
2808
|
+
"GatewayTimeout": {
|
|
2809
|
+
"content": {
|
|
2810
|
+
"application/json": {}
|
|
2811
|
+
}
|
|
2812
|
+
},
|
|
2793
2813
|
"ConfirmUserInvalidRequest": {
|
|
2794
2814
|
"content": {
|
|
2795
2815
|
"application/json": {}
|
package/src/openapi.json
CHANGED
|
@@ -543,10 +543,7 @@
|
|
|
543
543
|
},
|
|
544
544
|
"language": {
|
|
545
545
|
"type": "string",
|
|
546
|
-
"
|
|
547
|
-
"de",
|
|
548
|
-
"en"
|
|
549
|
-
]
|
|
546
|
+
"example": "de"
|
|
550
547
|
}
|
|
551
548
|
}
|
|
552
549
|
}
|
|
@@ -962,11 +959,12 @@
|
|
|
962
959
|
"PT1H",
|
|
963
960
|
"P1D",
|
|
964
961
|
"P1M",
|
|
965
|
-
"P1Y"
|
|
962
|
+
"P1Y",
|
|
963
|
+
"custom"
|
|
966
964
|
]
|
|
967
965
|
},
|
|
968
966
|
"required": true,
|
|
969
|
-
"description": "Interval between consumption data points (e.g., PT15M for 15 minutes, PT1H for hourly). Not all intervals have to be supported."
|
|
967
|
+
"description": "Interval between consumption data points (e.g., PT15M for 15 minutes, PT1H for hourly). Not all intervals have to be supported. `custom` is period-based retrieval for sources that advertise it in their `visualizationMetadata.intervals`: the App returns one record per period it has data for within `from`..`to`, each carrying `period`, and the portal renders every record as its own bar.\n"
|
|
970
968
|
},
|
|
971
969
|
{
|
|
972
970
|
"in": "query",
|
|
@@ -1020,6 +1018,30 @@
|
|
|
1020
1018
|
"en": "Billing period 1",
|
|
1021
1019
|
"de": "Abrechnungszeitraum 1"
|
|
1022
1020
|
}
|
|
1021
|
+
},
|
|
1022
|
+
"period": {
|
|
1023
|
+
"type": "object",
|
|
1024
|
+
"description": "The date range this value covers. Required for period-based sources (`interval=custom`), whose records don't sit on a fixed time grid: the portal renders one bar per record, orders them by `period.from`, and — unless `label` is set — labels each bar with the formatted `from` - `to` range. Ignored for interval-based retrieval.\n",
|
|
1025
|
+
"properties": {
|
|
1026
|
+
"from": {
|
|
1027
|
+
"type": "string",
|
|
1028
|
+
"format": "date-time",
|
|
1029
|
+
"description": "Start of the covered period."
|
|
1030
|
+
},
|
|
1031
|
+
"to": {
|
|
1032
|
+
"type": "string",
|
|
1033
|
+
"format": "date-time",
|
|
1034
|
+
"description": "End of the covered period. Shown as given in the fallback label, so pass the date the period visibly ends on (consecutive periods may share this boundary).\n"
|
|
1035
|
+
}
|
|
1036
|
+
},
|
|
1037
|
+
"required": [
|
|
1038
|
+
"from",
|
|
1039
|
+
"to"
|
|
1040
|
+
],
|
|
1041
|
+
"example": {
|
|
1042
|
+
"from": "2024-01-03T00:00:00.000Z",
|
|
1043
|
+
"to": "2025-01-05T00:00:00.000Z"
|
|
1044
|
+
}
|
|
1023
1045
|
}
|
|
1024
1046
|
},
|
|
1025
1047
|
"required": [
|
|
@@ -11537,6 +11559,46 @@
|
|
|
11537
11559
|
}
|
|
11538
11560
|
}
|
|
11539
11561
|
},
|
|
11562
|
+
"TooManyRequests": {
|
|
11563
|
+
"description": "The upstream service rate-limited the request",
|
|
11564
|
+
"content": {
|
|
11565
|
+
"application/json": {
|
|
11566
|
+
"schema": {
|
|
11567
|
+
"$ref": "#/components/schemas/ErrorResp"
|
|
11568
|
+
}
|
|
11569
|
+
}
|
|
11570
|
+
}
|
|
11571
|
+
},
|
|
11572
|
+
"BadGateway": {
|
|
11573
|
+
"description": "The upstream service failed to process the request",
|
|
11574
|
+
"content": {
|
|
11575
|
+
"application/json": {
|
|
11576
|
+
"schema": {
|
|
11577
|
+
"$ref": "#/components/schemas/ErrorResp"
|
|
11578
|
+
}
|
|
11579
|
+
}
|
|
11580
|
+
}
|
|
11581
|
+
},
|
|
11582
|
+
"ServiceUnavailable": {
|
|
11583
|
+
"description": "The requested feature is not configured",
|
|
11584
|
+
"content": {
|
|
11585
|
+
"application/json": {
|
|
11586
|
+
"schema": {
|
|
11587
|
+
"$ref": "#/components/schemas/ErrorResp"
|
|
11588
|
+
}
|
|
11589
|
+
}
|
|
11590
|
+
}
|
|
11591
|
+
},
|
|
11592
|
+
"GatewayTimeout": {
|
|
11593
|
+
"description": "The upstream service timed out",
|
|
11594
|
+
"content": {
|
|
11595
|
+
"application/json": {
|
|
11596
|
+
"schema": {
|
|
11597
|
+
"$ref": "#/components/schemas/ErrorResp"
|
|
11598
|
+
}
|
|
11599
|
+
}
|
|
11600
|
+
}
|
|
11601
|
+
},
|
|
11540
11602
|
"ConfirmUserInvalidRequest": {
|
|
11541
11603
|
"description": "The request could not be validated",
|
|
11542
11604
|
"content": {
|
|
@@ -12571,6 +12633,17 @@
|
|
|
12571
12633
|
"new_design": {
|
|
12572
12634
|
"type": "boolean",
|
|
12573
12635
|
"description": "Enable or disable the new design for the portal"
|
|
12636
|
+
},
|
|
12637
|
+
"mcp_enabled": {
|
|
12638
|
+
"type": "boolean",
|
|
12639
|
+
"description": "Enable the MCP (AI agent) connector channel for this portal"
|
|
12640
|
+
},
|
|
12641
|
+
"mcp_grant_version": {
|
|
12642
|
+
"type": "integer",
|
|
12643
|
+
"minimum": 0,
|
|
12644
|
+
"default": 0,
|
|
12645
|
+
"readOnly": true,
|
|
12646
|
+
"description": "Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled"
|
|
12574
12647
|
}
|
|
12575
12648
|
}
|
|
12576
12649
|
},
|
|
@@ -15959,7 +16032,7 @@
|
|
|
15959
16032
|
},
|
|
15960
16033
|
"q": {
|
|
15961
16034
|
"type": "string",
|
|
15962
|
-
"description": "
|
|
16035
|
+
"description": "Free-text keyword search. This is plain text, **not** a query language: punctuation separates words rather than carrying any special meaning, and every word has to match. Use `q_fields` to restrict which fields are searched, and `filters`/`targets` for structured filtering. Overly long input is trimmed, and input with no words in it is ignored — the remaining parameters still apply.",
|
|
15963
16036
|
"example": "contract"
|
|
15964
16037
|
},
|
|
15965
16038
|
"q_fields": {
|
|
@@ -16597,7 +16670,7 @@
|
|
|
16597
16670
|
},
|
|
16598
16671
|
"intervals": {
|
|
16599
16672
|
"type": "array",
|
|
16600
|
-
"description": "Intervals supported for the current context. If omitted, all intervals are assumed supported.",
|
|
16673
|
+
"description": "Intervals supported for the current context. If omitted, all intervals are assumed supported. `custom` marks a period-based consumption source: the portal requests the whole `data_range` once with `interval=custom` and renders one bar per returned record (see `period` on the consumption data point) instead of offering interval / date navigation or period comparison. When `custom` is present it takes precedence over any fixed intervals also listed.\n",
|
|
16601
16674
|
"items": {
|
|
16602
16675
|
"type": "string",
|
|
16603
16676
|
"enum": [
|
|
@@ -16605,7 +16678,8 @@
|
|
|
16605
16678
|
"PT1H",
|
|
16606
16679
|
"P1D",
|
|
16607
16680
|
"P1M",
|
|
16608
|
-
"P1Y"
|
|
16681
|
+
"P1Y",
|
|
16682
|
+
"custom"
|
|
16609
16683
|
]
|
|
16610
16684
|
}
|
|
16611
16685
|
},
|
|
@@ -19219,6 +19293,17 @@
|
|
|
19219
19293
|
"new_design": {
|
|
19220
19294
|
"type": "boolean",
|
|
19221
19295
|
"description": "Enable or disable the new design for the portal"
|
|
19296
|
+
},
|
|
19297
|
+
"mcp_enabled": {
|
|
19298
|
+
"type": "boolean",
|
|
19299
|
+
"description": "Enable the MCP (AI agent) connector channel for this portal"
|
|
19300
|
+
},
|
|
19301
|
+
"mcp_grant_version": {
|
|
19302
|
+
"type": "integer",
|
|
19303
|
+
"minimum": 0,
|
|
19304
|
+
"default": 0,
|
|
19305
|
+
"readOnly": true,
|
|
19306
|
+
"description": "Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled"
|
|
19222
19307
|
}
|
|
19223
19308
|
}
|
|
19224
19309
|
},
|
|
@@ -19877,6 +19962,10 @@
|
|
|
19877
19962
|
"type": "boolean",
|
|
19878
19963
|
"description": "Whether the org is in canary mode"
|
|
19879
19964
|
},
|
|
19965
|
+
"is_legacy_design": {
|
|
19966
|
+
"type": "boolean",
|
|
19967
|
+
"description": "Whether the portal still runs the old design (the `new_design` feature setting is off). Legacy portals are always served the frozen legacy bundle, even when the org is in canary."
|
|
19968
|
+
},
|
|
19880
19969
|
"redirect_to": {
|
|
19881
19970
|
"type": "string",
|
|
19882
19971
|
"description": "The URL to redirect to",
|
|
@@ -19934,6 +20023,157 @@
|
|
|
19934
20023
|
"example": true
|
|
19935
20024
|
}
|
|
19936
20025
|
}
|
|
20026
|
+
},
|
|
20027
|
+
"SupportReportType": {
|
|
20028
|
+
"type": "string",
|
|
20029
|
+
"enum": [
|
|
20030
|
+
"bug",
|
|
20031
|
+
"feedback"
|
|
20032
|
+
]
|
|
20033
|
+
},
|
|
20034
|
+
"SupportRequestAttachment": {
|
|
20035
|
+
"type": "object",
|
|
20036
|
+
"required": [
|
|
20037
|
+
"filename",
|
|
20038
|
+
"mime_type",
|
|
20039
|
+
"contents"
|
|
20040
|
+
],
|
|
20041
|
+
"properties": {
|
|
20042
|
+
"filename": {
|
|
20043
|
+
"type": "string",
|
|
20044
|
+
"maxLength": 255,
|
|
20045
|
+
"example": "screenshot.png"
|
|
20046
|
+
},
|
|
20047
|
+
"mime_type": {
|
|
20048
|
+
"type": "string",
|
|
20049
|
+
"example": "image/png"
|
|
20050
|
+
},
|
|
20051
|
+
"contents": {
|
|
20052
|
+
"type": "string",
|
|
20053
|
+
"description": "Base64-encoded file, optionally as a data URL"
|
|
20054
|
+
}
|
|
20055
|
+
}
|
|
20056
|
+
},
|
|
20057
|
+
"CleverPvContext": {
|
|
20058
|
+
"type": "object",
|
|
20059
|
+
"properties": {
|
|
20060
|
+
"screen": {
|
|
20061
|
+
"type": "string",
|
|
20062
|
+
"maxLength": 256,
|
|
20063
|
+
"description": "Current Clever PV screen identifier"
|
|
20064
|
+
},
|
|
20065
|
+
"version": {
|
|
20066
|
+
"type": "string",
|
|
20067
|
+
"maxLength": 64,
|
|
20068
|
+
"description": "Clever PV application version"
|
|
20069
|
+
},
|
|
20070
|
+
"connection_state": {
|
|
20071
|
+
"type": "string",
|
|
20072
|
+
"maxLength": 64,
|
|
20073
|
+
"description": "Device connectivity at the time of the report"
|
|
20074
|
+
},
|
|
20075
|
+
"locale": {
|
|
20076
|
+
"type": "string",
|
|
20077
|
+
"maxLength": 32,
|
|
20078
|
+
"description": "App locale at the time of the report"
|
|
20079
|
+
},
|
|
20080
|
+
"timezone": {
|
|
20081
|
+
"type": "string",
|
|
20082
|
+
"maxLength": 64,
|
|
20083
|
+
"description": "App timezone at the time of the report"
|
|
20084
|
+
},
|
|
20085
|
+
"firmware_version": {
|
|
20086
|
+
"type": "string",
|
|
20087
|
+
"maxLength": 64,
|
|
20088
|
+
"description": "Device firmware version when known"
|
|
20089
|
+
},
|
|
20090
|
+
"build": {
|
|
20091
|
+
"type": "string",
|
|
20092
|
+
"maxLength": 64,
|
|
20093
|
+
"description": "App build identifier when known"
|
|
20094
|
+
},
|
|
20095
|
+
"trace_id": {
|
|
20096
|
+
"type": "string",
|
|
20097
|
+
"maxLength": 128,
|
|
20098
|
+
"description": "Client-generated correlation id for the report"
|
|
20099
|
+
},
|
|
20100
|
+
"device": {
|
|
20101
|
+
"type": "object",
|
|
20102
|
+
"additionalProperties": true,
|
|
20103
|
+
"description": "Optional device snapshot from the portal. Attached as a JSON file on\nthe original Zendesk comment. Must include id when present. Serialized\nJSON is limited to 256 KiB.\n"
|
|
20104
|
+
},
|
|
20105
|
+
"vendor": {
|
|
20106
|
+
"type": "object",
|
|
20107
|
+
"additionalProperties": true,
|
|
20108
|
+
"properties": {
|
|
20109
|
+
"id": {
|
|
20110
|
+
"type": "string"
|
|
20111
|
+
},
|
|
20112
|
+
"name": {
|
|
20113
|
+
"type": "string"
|
|
20114
|
+
}
|
|
20115
|
+
},
|
|
20116
|
+
"description": "Optional onboarding vendor id and name. Included in the Zendesk\ncomment. Not a portal entity.\n"
|
|
20117
|
+
}
|
|
20118
|
+
}
|
|
20119
|
+
},
|
|
20120
|
+
"CreateSupportRequest": {
|
|
20121
|
+
"type": "object",
|
|
20122
|
+
"required": [
|
|
20123
|
+
"report_type",
|
|
20124
|
+
"description",
|
|
20125
|
+
"submission_id"
|
|
20126
|
+
],
|
|
20127
|
+
"properties": {
|
|
20128
|
+
"report_type": {
|
|
20129
|
+
"$ref": "#/components/schemas/SupportReportType"
|
|
20130
|
+
},
|
|
20131
|
+
"description": {
|
|
20132
|
+
"type": "string",
|
|
20133
|
+
"minLength": 1,
|
|
20134
|
+
"maxLength": 8000
|
|
20135
|
+
},
|
|
20136
|
+
"submission_id": {
|
|
20137
|
+
"type": "string",
|
|
20138
|
+
"minLength": 8,
|
|
20139
|
+
"maxLength": 128,
|
|
20140
|
+
"pattern": "^[A-Za-z0-9._-]+$",
|
|
20141
|
+
"description": "Client-generated id for correlating the request"
|
|
20142
|
+
},
|
|
20143
|
+
"site_id": {
|
|
20144
|
+
"$ref": "#/components/schemas/EntityId"
|
|
20145
|
+
},
|
|
20146
|
+
"device_id": {
|
|
20147
|
+
"$ref": "#/components/schemas/EntityId"
|
|
20148
|
+
},
|
|
20149
|
+
"clever_pv": {
|
|
20150
|
+
"$ref": "#/components/schemas/CleverPvContext"
|
|
20151
|
+
},
|
|
20152
|
+
"attachments": {
|
|
20153
|
+
"type": "array",
|
|
20154
|
+
"maxItems": 5,
|
|
20155
|
+
"items": {
|
|
20156
|
+
"$ref": "#/components/schemas/SupportRequestAttachment"
|
|
20157
|
+
}
|
|
20158
|
+
}
|
|
20159
|
+
}
|
|
20160
|
+
},
|
|
20161
|
+
"SupportRequestResult": {
|
|
20162
|
+
"type": "object",
|
|
20163
|
+
"required": [
|
|
20164
|
+
"reference",
|
|
20165
|
+
"status"
|
|
20166
|
+
],
|
|
20167
|
+
"properties": {
|
|
20168
|
+
"reference": {
|
|
20169
|
+
"type": "string",
|
|
20170
|
+
"example": "12345"
|
|
20171
|
+
},
|
|
20172
|
+
"status": {
|
|
20173
|
+
"type": "string",
|
|
20174
|
+
"example": "new"
|
|
20175
|
+
}
|
|
20176
|
+
}
|
|
19937
20177
|
}
|
|
19938
20178
|
}
|
|
19939
20179
|
},
|