@epilot/customer-portal-client

{ "openapi": "3.0.3", "info": { "title": "", "version": "" }, "paths": { "/v2/portal/portal": { "post": { "operationId": "upsertPortal", "parameters": [ { "in": "query", "name": "origin", "required": true }, { "in": "query", "name": "portal_id", "required": false } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/public/user": { "post": { "operationId": "createUser", "deprecated": true, "parameters": [ { "in": "query", "name": "origin", "required": true } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v3/portal/public/user": { "post": { "operationId": "createUserV3", "parameters": [ { "in": "query", "name": "portal_id", "required": false }, { "in": "query", "name": "domain", "required": false } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/token/validate": { "post": { "operationId": "validateToken", "responses": {} } }, "/v2/portal/token/revoke": { "post": { "operationId": "revokeToken", "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/public/config": { "get": { "operationId": "getPortalConfigByDomain", "parameters": [ { "in": "query", "name": "domain", "required": true } ], "responses": {} } }, "/v2/portal/config": { "get": { "operationId": "getPortalConfig", "parameters": [ { "in": "query", "name": "origin", "required": false } ], "responses": {} }, "delete": { "operationId": "deletePortal", "parameters": [ { "in": "query", "name": "origin", "required": true } ], "responses": {} } }, "/v2/portal/extensions": { "get": { "operationId": "getPortalExtensions", "parameters": [ { "in": "query", "name": "origin", "required": false } ], "responses": {} } }, "/v2/portal/public/extensions": { "get": { "operationId": "getPublicPortalExtensionDetails", "parameters": [ { "in": "query", "name": "org_id", "required": true }, { "in": "query", "name": "origin", "required": true } ], "responses": {} } }, "/v3/portal/extensions": { "get": { "operationId": "getPortalExtensionsV3", "parameters": [ { "in": "query", "name": "portal_id", "required": true } ], "responses": {} } }, "/v3/portal/public/extensions": { "get": { "operationId": "getPublicPortalExtensionDetailsV3", "parameters": [ { "in": "query", "name": "org_id", "required": false }, { "in": "query", "name": "portal_id", "required": false }, { "in": "query", "name": "domain", "required": false } ], "responses": {} } }, "/v2/portal/consumption": { "get": { "operationId": "getConsumption", "parameters": [ { "in": "query", "name": "app_id", "required": false }, { "in": "query", "name": "extensionId", "required": true }, { "in": "query", "name": "hookId", "required": false }, { "in": "query", "name": "meter_id", "required": false, "deprecated": true }, { "in": "query", "name": "from", "required": true }, { "in": "query", "name": "to", "required": true }, { "in": "query", "name": "interval", "required": true }, { "in": "query", "name": "context_entities", "required": false } ], "responses": {} } }, "/v2/portal/visualization:export": { "post": { "operationId": "prepareVisualizationExport", "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/visualization/metadata": { "get": { "operationId": "getVisualizationMetadata", "parameters": [ { "in": "query", "name": "app_id", "required": true }, { "in": "query", "name": "extensionId", "required": true }, { "in": "query", "name": "context_entities", "required": false } ], "responses": {} } }, "/v2/portal/costs": { "get": { "operationId": "getCosts", "parameters": [ { "in": "query", "name": "app_id", "required": false }, { "in": "query", "name": "extensionId", "required": true }, { "in": "query", "name": "hookId", "required": false }, { "in": "query", "name": "meter_id", "required": false, "deprecated": true }, { "in": "query", "name": "from", "required": true }, { "in": "query", "name": "to", "required": true }, { "in": "query", "name": "interval", "required": true }, { "in": "query", "name": "context_entities", "required": false } ], "responses": {} } }, "/v2/portal/prices": { "get": { "operationId": "getPrices", "parameters": [ { "in": "query", "name": "app_id", "required": false }, { "in": "query", "name": "extensionId", "required": true }, { "in": "query", "name": "hookId", "required": false }, { "in": "query", "name": "meter_id", "required": false, "deprecated": true }, { "in": "query", "name": "from", "required": true }, { "in": "query", "name": "to", "required": true }, { "in": "query", "name": "interval", "required": true }, { "in": "query", "name": "context_entities", "required": false } ], "responses": {} } }, "/v2/portal/external-links": { "get": { "operationId": "getExternalLinks", "parameters": [ { "in": "query", "name": "origin", "required": false }, { "in": "query", "name": "contactId", "required": false } ], "responses": {} } }, "/v2/portal/resolve:external-link/{id}": { "get": { "operationId": "getResolvedExternalLink", "deprecated": true, "parameters": [ { "in": "path", "name": "id", "required": true }, { "in": "query", "name": "origin", "required": false }, { "in": "query", "name": "contactId", "required": false } ], "responses": {} } }, "/v3/portal/external-links": { "get": { "operationId": "getExternalLinksV3", "parameters": [ { "in": "query", "name": "portal_id", "required": false }, { "in": "query", "name": "contactId", "required": false } ], "responses": {} } }, "/v3/portal/resolve:external-link/{id}": { "get": { "operationId": "getResolvedExternalLinkV3", "deprecated": true, "parameters": [ { "in": "path", "name": "id", "required": true }, { "in": "query", "name": "portal_id", "required": false }, { "in": "query", "name": "contactId", "required": false } ], "responses": {} } }, "/v2/portal/resolve:seamless-link": { "get": { "operationId": "getResolvedSeamlessLink", "parameters": [ { "in": "query", "name": "app_id", "required": false }, { "in": "query", "name": "extension_id", "required": true }, { "in": "query", "name": "link_id", "required": true }, { "in": "query", "name": "context_entities", "required": false } ], "responses": {} } }, "/v2/portal/public/portal/config": { "get": { "operationId": "getPublicPortalConfig", "parameters": [ { "in": "query", "name": "org_id", "required": true }, { "in": "query", "name": "origin", "required": true } ], "responses": {} } }, "/v2/portal/org/portal/config": { "get": { "operationId": "getOrgPortalConfig", "parameters": [ { "in": "query", "name": "origin", "required": true } ], "responses": {} } }, "/v3/portal/public/portal/config": { "get": { "operationId": "getPublicPortalConfigV3", "parameters": [ { "in": "query", "name": "org_id", "required": true }, { "in": "query", "name": "portal_id", "required": true } ], "responses": {} } }, "/v3/portal/org/portal/config": { "get": { "operationId": "getOrgPortalConfigV3", "parameters": [ { "in": "query", "name": "portal_id", "required": true } ], "responses": {} } }, "/v2/portal/configs": { "get": { "operationId": "getAllPortalConfigs", "responses": {} } }, "/v2/portal/email-templates": { "post": { "operationId": "upsertEmailTemplates", "parameters": [ { "in": "query", "name": "origin", "required": true } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} }, "get": { "operationId": "getEmailTemplates", "parameters": [ { "in": "query", "name": "origin", "required": true } ], "responses": {} } }, "/v3/portal/email-templates/{portal_id}": { "post": { "operationId": "upsertEmailTemplatesByPortalId", "parameters": [ { "in": "path", "name": "portal_id", "required": true } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} }, "get": { "operationId": "getEmailTemplatesByPortalId", "parameters": [ { "in": "path", "name": "portal_id", "required": true } ], "responses": {} } }, "/v2/portal/public-widgets": { "get": { "operationId": "getPublicPortalWidgets", "deprecated": true, "parameters": [ { "in": "query", "name": "org_id", "required": true }, { "in": "query", "name": "origin", "required": true } ], "responses": {} } }, "/v3/portal/public/widgets": { "get": { "operationId": "getPublicPortalWidgetsV3", "parameters": [ { "in": "query", "name": "org_id", "required": false }, { "in": "query", "name": "portal_id", "required": false }, { "in": "query", "name": "domain", "required": false } ], "responses": {} } }, "/v2/portal/widgets": { "post": { "operationId": "upsertPortalWidget", "deprecated": true, "parameters": [ { "in": "query", "name": "origin", "required": true } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} }, "get": { "operationId": "getPortalWidgets", "deprecated": true, "parameters": [ { "in": "query", "name": "origin", "required": false }, { "in": "query", "name": "contract_id", "required": false } ], "responses": {} } }, "/v3/portal/widgets": { "get": { "operationId": "getPortalWidgetsV3", "parameters": [ { "in": "query", "name": "portal_id", "required": true }, { "in": "query", "name": "contract_id", "required": false } ], "responses": {} }, "post": { "operationId": "upsertPortalWidgetV3", "parameters": [ { "in": "query", "name": "portal_id", "required": true } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v3/portal/portal/files": { "post": { "operationId": "savePortalFilesV3", "parameters": [ { "in": "query", "name": "portal_id", "required": true } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/replace-ecp-template-variables": { "post": { "operationId": "replaceECPTemplateVariables", "requestBody": { "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/org/settings": { "get": { "operationId": "getOrganizationSettings", "deprecated": true, "responses": {} } }, "/v2/portal/schemas": { "get": { "operationId": "getSchemas", "responses": {} } }, "/v2/portal/public/schemas": { "get": { "operationId": "getSchemasByDomain", "parameters": [ { "in": "query", "name": "domain", "required": true } ], "responses": {} } }, "/v3/portal/public/schemas": { "get": { "operationId": "getPublicSchemasV3", "parameters": [ { "in": "query", "name": "org_id", "required": false }, { "in": "query", "name": "portal_id", "required": false }, { "in": "query", "name": "domain", "required": false } ], "responses": {} } }, "/v2/portal/public/org/settings": { "get": { "operationId": "getOrganizationSettingsByDomain", "parameters": [ { "in": "query", "name": "domain", "required": true } ], "responses": {} } }, "/v2/portal/extra-permission-attributes": { "get": { "operationId": "extraPermissionAttributes", "responses": {} } }, "/v2/portal/validate/caa-records": { "post": { "operationId": "validateCaaRecords", "parameters": [ { "in": "query", "name": "origin", "required": true } ], "responses": {} } }, "/v3/portal/validate/caa-records": { "post": { "operationId": "validateCaaRecordsV3", "parameters": [ { "in": "query", "name": "portal_id", "required": true } ], "responses": {} } }, "/v2/portal/contact": { "get": { "operationId": "getContact", "responses": {} }, "patch": { "operationId": "updateContact", "deprecated": true, "requestBody": { "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/ecp/contact": { "get": { "operationId": "getECPContact", "parameters": [ { "in": "query", "name": "id", "required": true } ], "responses": {} } }, "/v2/portal/public/contact/exists": { "post": { "operationId": "checkContactExists", "parameters": [ { "in": "query", "name": "origin", "required": true } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v3/portal/public/contact/exists": { "post": { "operationId": "checkContactExistsV3", "parameters": [ { "in": "query", "name": "portal_id", "required": false }, { "in": "query", "name": "domain", "required": false } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v3/portal/public/account/exists": { "post": { "operationId": "checkAccountExists", "parameters": [ { "in": "query", "name": "portal_id", "required": false }, { "in": "query", "name": "domain", "required": false } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/contact/valid/secondary/attributes": { "get": { "operationId": "getValidSecondaryAttributes", "responses": {} } }, "/v2/portal/user": { "get": { "operationId": "getPortalUser", "responses": {} }, "patch": { "operationId": "updatePortalUser", "requestBody": { "content": { "application/json": {} } }, "responses": {} }, "delete": { "operationId": "deletePortalUser", "responses": {} } }, "/v2/portal/user/update/email": { "put": { "operationId": "updatePortalUserEmail", "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/user/resend/confirmation-email/{id}": { "post": { "operationId": "resendConfirmationEmail", "parameters": [ { "in": "path", "name": "id", "required": true } ], "responses": {} } }, "/v2/portal/users/by-related-entity": { "get": { "operationId": "fetchPortalUsersByRelatedEntity", "parameters": [ { "in": "query", "name": "entity_id", "required": true }, { "in": "query", "name": "slug", "required": true } ], "responses": {} } }, "/v2/portal/user/confirm": { "get": { "operationId": "confirmUser", "parameters": [ { "in": "query", "name": "confirmation_link_token", "required": true }, { "in": "query", "name": "use_redirect", "required": false } ], "responses": {} } }, "/v2/portal/user/confirm/{id}": { "get": { "operationId": "confirmUserWithUserId", "parameters": [ { "in": "query", "name": "origin", "required": true }, { "in": "path", "name": "id", "required": true }, { "in": "query", "name": "org_id", "required": true } ], "responses": {} } }, "/v2/portal/public/user/exists": { "get": { "operationId": "userExists", "parameters": [ { "in": "query", "name": "email", "required": true }, { "in": "query", "name": "org_id", "required": true }, { "in": "query", "name": "origin", "required": false } ], "responses": {} } }, "/v3/portal/public/user/exists": { "get": { "operationId": "userExistsV3", "parameters": [ { "in": "query", "name": "email", "required": true }, { "in": "query", "name": "org_id", "required": false }, { "in": "query", "name": "portal_id", "required": false }, { "in": "query", "name": "domain", "required": false } ], "responses": {} } }, "/v2/portal/recipients-to-notify": { "post": { "operationId": "getRecipientsToNotifyOnAutomation", "requestBody": { "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/configure-distribution": { "get": { "operationId": "configureDistribution", "parameters": [ { "in": "query", "name": "origin", "required": true } ], "responses": {} } }, "/v3/portal/configure-distribution": { "get": { "operationId": "configureDistributionV3", "parameters": [ { "in": "query", "name": "portal_id", "required": true } ], "responses": {} } }, "/v2/portal/order": { "get": { "operationId": "getAllOrders", "deprecated": true, "parameters": [ { "in": "query", "name": "from", "required": false }, { "in": "query", "name": "size", "required": false } ], "responses": {} } }, "/v2/portal/order/{id}/acceptance": { "post": { "operationId": "postOrderAcceptance", "parameters": [ { "in": "path", "name": "id", "required": true } ], "requestBody": { "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/order/{id}": { "get": { "operationId": "getOrder", "deprecated": true, "parameters": [ { "in": "path", "name": "id", "required": true } ], "responses": {} }, "patch": { "operationId": "updateOrder", "deprecated": true, "parameters": [ { "in": "path", "name": "id", "required": true } ], "requestBody": { "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/opportunity": { "get": { "operationId": "getAllOpportunities", "deprecated": true, "parameters": [ { "in": "query", "name": "from", "required": false }, { "in": "query", "name": "size", "required": false } ], "responses": {} } }, "/v2/portal/opportunities/searchable-attributes": { "get": { "operationId": "getSearchableAttributesForOpportunities", "deprecated": true, "parameters": [ { "in": "query", "name": "from", "required": false }, { "in": "query", "name": "size", "required": false } ], "responses": {} } }, "/v2/portal/opportunities/search": { "post": { "operationId": "getSearchResultsForOpportunities", "deprecated": true, "parameters": [ { "in": "query", "name": "from", "required": false }, { "in": "query", "name": "size", "required": false } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/opportunities/{id}": { "get": { "operationId": "getOpportunity", "deprecated": true, "parameters": [ { "in": "path", "name": "id", "required": true } ], "responses": {} }, "patch": { "operationId": "updateOpportunity", "deprecated": true, "parameters": [ { "in": "path", "name": "id", "required": true } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/request": { "get": { "operationId": "getAllRequests", "deprecated": true, "parameters": [ { "in": "query", "name": "from", "required": false }, { "in": "query", "name": "size", "required": false } ], "responses": {} } }, "/v2/portal/contract": { "get": { "operationId": "getAllContracts", "deprecated": true, "parameters": [ { "in": "query", "name": "from", "required": false }, { "in": "query", "name": "size", "required": false } ], "responses": {} } }, "/v2/portal/contract/{id}": { "get": { "operationId": "getContract", "deprecated": true, "parameters": [ { "in": "path", "name": "id", "required": true } ], "responses": {} }, "patch": { "operationId": "updateContract", "deprecated": true, "parameters": [ { "in": "path", "name": "id", "required": true } ], "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/contract/by-identifiers": { "post": { "operationId": "addContractByIdentifiers", "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/entity/identifiers/{slug}": { "get": { "operationId": "getEntityIdentifiers", "parameters": [ { "in": "path", "name": "slug", "required": true } ], "responses": {} } }, "/v2/portal/entity/{slug}/{id}/activity": { "get": { "operationId": "getEntityActivityFeed", "parameters": [ { "in": "path", "name": "slug", "required": true }, { "in": "path", "name": "id", "required": true }, { "in": "query", "name": "after" }, { "in": "query", "name": "before" }, { "in": "query", "name": "from" }, { "in": "query", "name": "size" }, { "in": "query", "name": "type" }, { "in": "query", "name": "include_relations" } ], "responses": {} } }, "/v2/portal/{slug}/{id}:validateRule": { "get": { "operationId": "validateCadenceEntityEditRules", "parameters": [ { "in": "path", "name": "slug", "required": true }, { "in": "path", "name": "id", "required": true }, { "in": "query", "name": "attribute" } ], "responses": {} } }, "/v2/portal/entities-by-payment/{id}": { "get": { "operationId": "searchPaymentRelationsInEntities", "parameters": [ { "in": "path", "name": "id", "required": true } ], "responses": {} } }, "/v2/portal/entity/activity": { "put": { "operationId": "createCustomEntityActivity", "parameters": [ { "in": "query", "name": "entities", "deprecated": true, "style": "form" } ], "requestBody": { "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/entity/file": { "post": { "operationId": "saveEntityFile", "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} }, "delete": { "operationId": "deleteEntityFile", "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/portal/files": { "post": { "operationId": "savePortalFiles", "requestBody": { "required": true, "content": { "application/json": {} } }, "responses": {} } }, "/v2/portal/registration/identifiers": { "get": { "operationId": "getRegistrationIdentifiers", "responses": {} } }, "/v2/portal/user/files": { "get": { "operationId": "getAllFiles", "deprecated": true, "parameters": [ { "in": "query", "name": "from", "required": true }, { "in": "query", "name": "size", "required": true }, { "in": "query", "name": "entity_ids" }, { "in": "query", "name": "file_types" } ], "responses": {} } }, "/v2/portal/user/file/{id}": { "get": { "operationId": "getFileById", "deprecated": true, "parameters": [ { "in": "path", "name": "id", "required": true } ], "responses": {} } }, "/v2/portal/user/file/{id}/downloaded": { "post": { "operationId": "trackFileDownloaded", "parameters": [ { "in": "path", "name": "id", "required": true } ], "responses": {} } }, "/v2/portal/user/files/count-by-entity": { "get": { "operationId": "getFilesCountByEntity", "deprecated": true, "responses": {} } }, "/v2/portal/billing/events": { "get": { "operationId": "getBillingEvents",