@epilot/customer-portal-client 0.8.10 → 0.8.12

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.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={914:function(e,t,r){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=i(r(534));t.default=a.default},534:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Customer Portal API","description":"Backend for epilot end customer portals","version":"1.0.0"},"tags":[{"name":"ECP","description":"ECP"},{"name":"ECP Admin","description":"ECP Admin"},{"name":"Public","description":"Public"}],"security":[{"PortalAuth":[]},{"AsOrganization":[]},{"AsCustomer":[]}],"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","summary":"upserts a portal","description":"upserts a portal and db item","security":[{"EpilotAuth":[]}],"tags":["ECP Admin"],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}}}}},"responses":{"201":{"description":"Success - portal created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","summary":"creates a user","description":"Creates a user in cognito pool and db item","security":[],"tags":["Public"],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","example":"testemail921@yopmail.com"},"password":{"type":"string","example":"Pass1234!"},"orgId":{"type":"string","example":728},"secondaryIdentifier":{"type":"string","example":123456},"contactId":{"type":"string","example":123456}}}}}},"responses":{"201":{"description":"Success - user created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v2/portal/public/activate":{"post":{"operationId":"activateUser","summary":"activateUser","description":"Activates the user","security":[],"tags":["Public"],"parameters":[{"in":"query","name":"token","schema":{"type":"string"},"required":true,"description":"Invite Token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}}}}},"responses":{"200":{"description":"Activated successfully"},"404":{"description":"Token not found for the user"}}}},"/v2/portal/auth":{"get":{"operationId":"testAuth","summary":"testAuth","description":"TODO","tags":["ECP"],"responses":{"200":{"description":"ok"}}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","summary":"getPortalConfigByDomain","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"domain","required":true,"schema":{"type":"string","example":"example.com"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]}}}}}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","summary":"getPortalConfig","description":"TODO","tags":["ECP Admin","ECP"],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"security":[{"EpilotAuth":[]},{"PortalAuth":[]}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]}}}}}},"delete":{"operationId":"deletePortal","summary":"deletePortal","description":"TODO","tags":["ECP Admin"],"parameters":[{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"security":[{"EpilotAuth":[]}],"responses":{"204":{"description":"Success"},"403":{"description":"Forbidden"}}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","summary":"getPublicPortalConfig","description":"TODO","tags":["ECP Admin"],"security":[],"parameters":[{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":12324}},{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]}}}}}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","summary":"getOrgPortalConfig","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]}}}}}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","summary":"getAllPortalConfigs","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]}}}}}}}}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","summary":"upsertEmailTemplates","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirmAccount":{"type":"string"},"forgotPassword":{"type":"string"},"invitation":{"type":"string"},"onNewQuote":{"type":"string"},"onMapAPendingUser":{"type":"string"}}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"emailTemplates":{"type":"object","properties":{"confirmAccount":{"type":"string"},"forgotPassword":{"type":"string"},"invitation":{"type":"string"},"onNewQuote":{"type":"string"},"onMapAPendingUser":{"type":"string"}}}}}}}}}},"get":{"operationId":"getEmailTemplates","summary":"getEmailTemplates","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"confirmAccount":{"type":"string"},"forgotPassword":{"type":"string"},"invitation":{"type":"string"},"onNewQuote":{"type":"string"},"onMapAPendingUser":{"type":"string"}}}}}}}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","summary":"replaceECPTemplateVariables","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"requestBody":{"description":"ECPVariables payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contactId":{"type":"string","example":"7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51"}}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"portalUser":{"type":"object","properties":{"invitationLink":{"type":"string","example":"https://end-customer-portal.ecp.dev.epilot.io/register/existing-customer?contactId=7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51&email=john@doe.com"}}}}}}}}}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","summary":"getOrganizationSettings","description":"get organization settings","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"automation_entity_mapping":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"automation_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"central_inbox_preview_setting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"contracts_preview_setting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"disable_ivy":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"double_opt_in":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_catalog_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_opportunities_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"end_customer_portal":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"entity_schema_builder":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"logic_editor_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"new_navigation":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"partnering":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"product-availability":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"sso":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"submission_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"user_roles_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}}}}}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","summary":"getSchemas","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","summary":"extraPermissionAttributes","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"contact":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"contract":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"order":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"opportunity":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}}}}}}}}}}}},"/v2/portal/contact":{"get":{"operationId":"getContact","summary":"getContact","description":"Get the Contact by id","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"patch":{"operationId":"updateContact","summary":"updateContact","description":"Update the contact details","tags":["ECP"],"security":[{"PortalAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","summary":"getECPContact","description":"Get the Contact by id","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"id","required":true,"schema":{"type":"string","example":1234}}],"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v2/portal/contact/email/count":{"get":{"operationId":"getCountByEmail","summary":"getCountByEmail","description":"Check Contact by email","tags":["Public"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"test@test.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number","example":2}}}}}}}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","summary":"getValidSecondaryAttributes","description":"Get Valid Secondary Attributes","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"first_name"},"type":{"type":"string","example":"string"}}}}}}}}}}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","summary":"getPortalUser","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}},"patch":{"operationId":"updatePortalUser","summary":"updatePortalUser","description":"Update the portal user details","tags":["ECP"],"security":[{"PortalAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}},"delete":{"operationId":"deletePortalUser","summary":"deletePortalUser","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned portal user id","content":{"application/json":{"schema":{"type":"string","example":123}}}}}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUser","summary":"confirmUser","description":"TODO","tags":["Public"],"security":[],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","summary":"userExists","description":"Checks whether a user exists in the customer portal","tags":["Public"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"user@example.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"User exists in the portal","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":true},"user":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}},"404":{"description":"User does not exist in the portal","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":false}}}}}}}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","summary":"configureDistribution","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"responses":{"200":{"description":"The returned configured distribution id","content":{"application/json":{"schema":{"type":"object","properties":{"domainName":{"type":"string","example":"dsj8op4ha01jha23.cloudfront.net"}}}}}}}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","summary":"getAllOrders","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned orders","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","summary":"getOrder","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of order"}],"responses":{"200":{"description":"The returned order","content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]},"relations":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}},"patch":{"operationId":"updateOrder","summary":"updateOrder","description":"Update the order details","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of order"}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"responses":{"200":{"description":"The returned order","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","summary":"getAllOpportunities","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned opportunities","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","summary":"getOpportunity","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of opportunities"}],"responses":{"200":{"description":"The returned opportunities","content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]},"relations":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","summary":"getAllContracts","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned contracts","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","summary":"get contract based on id","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of the contract"}],"responses":{"200":{"description":"The returned contract","content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]},"relations":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}},"put":{"operationId":"updateContract","summary":"edit contract based on id","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of the contract"}],"requestBody":{"description":"Updated Contract body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"The returned updated contract","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","summary":"getEntityIdentifiers","description":"Get Entity\'s Identifiers","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"path","name":"slug","schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"required":true,"description":"The slug of an entity"}],"responses":{"200":{"description":"The returned identifiers of an entity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"contract_number"},"type":{"type":"string","example":"string"}}}}}}}}}}}},"/v2/portal/entity/by-identifiers/{slug}":{"post":{"operationId":"getEntitiesByIdentifiers","summary":"getEntitiesByIdentifiers","description":"Get Entities By Identifiers","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"slug","schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"required":true,"description":"The slug of an entity"}],"requestBody":{"description":"Entity Identifiers","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"The returned Entities","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/entity/add-end-customer/{slug}/{id}":{"put":{"operationId":"addEndCustomerRelationToEntity","summary":"addEndCustomerRelationToEntity","description":"Add EndCustomer Relation To an Entity","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"slug","schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"required":true,"description":"The slug of an entity"},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of the Entity"}],"responses":{"200":{"description":"The returned Entity","content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]},"relations":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","summary":"Add files to an entity","description":"Add files to an entity","tags":["ECP"],"security":[{"PortalAuth":[]}],"requestBody":{"description":"Save file","required":true,"content":{"application/json":{"schema":{"type":"object","required":["entity_id","entity_type","files"],"properties":{"entity_id":{"type":"string","example":123456},"entity_type":{"type":"string","example":"order"},"files":{"type":"array","items":{"type":"object","required":["filename","s3ref"],"properties":{"filename":{"type":"string","example":12345},"file_entity_id":{"type":"string","example":12345},"document_type":{"type":"string","example":12345},"access_control":{"type":"string","default":"private","enum":["private","public-read"]},"_tags":{"type":"array","items":{"type":"string","example":12345}},"s3ref":{"type":"object","required":["bucket","key"],"properties":{"bucket":{"type":"string","example":12345},"key":{"type":"string","example":12345}}}}}}}}}}},"responses":{"200":{"description":"The returned File Entities","content":{"application/json":{"schema":{"type":"object","properties":{"createdFiles":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}},"delete":{"operationId":"deleteEntityFile","summary":"Delete files from an entity","description":"Delete files from an entity","tags":["ECP"],"security":[{"PortalAuth":[]}],"requestBody":{"description":"Delete file","required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_entity_ids","entity_type","entity_id"],"properties":{"entity_id":{"type":"string","example":123456},"entity_type":{"type":"string","example":"order"},"file_entity_ids":{"type":"array","items":{"type":"string","example":12345}}}}}}},"responses":{"200":{"description":"The returned File Entities","content":{"application/json":{"schema":{"type":"object","properties":{"deletedFiles":{"type":"array","items":{"type":"string","example":123}}}}}}}}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","summary":"Add files to portal","description":"Add files to portal","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"requestBody":{"description":"Save portal file","required":true,"content":{"application/json":{"schema":{"type":"object","required":["files","origin"],"properties":{"origin":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]},"files":{"type":"array","items":{"type":"object","required":["file_type"],"properties":{"filename":{"type":"string","example":12345},"file_type":{"type":"string","example":"orderRightTeaser"},"_tags":{"type":"array","items":{"type":"string","example":12345}},"s3ref":{"type":"object","required":["bucket","key"],"properties":{"bucket":{"type":"string","example":12345},"key":{"type":"string","example":12345}}}}}}}}}}},"responses":{"200":{"description":"The returned portal files","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}},"components":{"securitySchemes":{"PortalAuth":{"type":"http","scheme":"bearer","description":"Customer Portal Cognito Token"},"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id as internal user"},"AsContact":{"type":"apiKey","in":"header","name":"x-contact-id","description":"Set contact id as internal user"},"AsCustomer":{"type":"apiKey","in":"header","name":"x-portal-id","description":"Set portal id as customer"}},"schemas":{"InviteToken":{"type":"string"},"UserActivationPayload":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}},"ErrorResp":{"type":"object","properties":{"message":{"type":"string"}}},"AddPortalResp":{"type":"object","properties":{"message":{"type":"string"}}},"EmailTemplates":{"type":"object","properties":{"confirmAccount":{"type":"string"},"forgotPassword":{"type":"string"},"invitation":{"type":"string"},"onNewQuote":{"type":"string"},"onMapAPendingUser":{"type":"string"}}},"DeleteEntityFile":{"type":"object","required":["file_entity_ids","entity_type","entity_id"],"properties":{"entity_id":{"type":"string","example":123456},"entity_type":{"type":"string","example":"order"},"file_entity_ids":{"type":"array","items":{"type":"string","example":12345}}}},"SaveEntityFile":{"type":"object","required":["entity_id","entity_type","files"],"properties":{"entity_id":{"type":"string","example":123456},"entity_type":{"type":"string","example":"order"},"files":{"type":"array","items":{"type":"object","required":["filename","s3ref"],"properties":{"filename":{"type":"string","example":12345},"file_entity_id":{"type":"string","example":12345},"document_type":{"type":"string","example":12345},"access_control":{"type":"string","default":"private","enum":["private","public-read"]},"_tags":{"type":"array","items":{"type":"string","example":12345}},"s3ref":{"type":"object","required":["bucket","key"],"properties":{"bucket":{"type":"string","example":12345},"key":{"type":"string","example":12345}}}}}}}},"SavePortalFile":{"type":"object","required":["files","origin"],"properties":{"origin":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]},"files":{"type":"array","items":{"type":"object","required":["file_type"],"properties":{"filename":{"type":"string","example":12345},"file_type":{"type":"string","example":"orderRightTeaser"},"_tags":{"type":"array","items":{"type":"string","example":12345}},"s3ref":{"type":"object","required":["bucket","key"],"properties":{"bucket":{"type":"string","example":12345},"key":{"type":"string","example":12345}}}}}}}},"ExtraSchemaAttributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"Origin":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]},"UpsertPortalConfig":{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},"PortalConfig":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","default":"END_CUSTOMER_PORTAL","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]},"OrganizationSettings":{"type":"object","properties":{"automation_entity_mapping":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"automation_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"central_inbox_preview_setting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"contracts_preview_setting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"disable_ivy":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"double_opt_in":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_catalog_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_opportunities_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"end_customer_portal":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"entity_schema_builder":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"logic_editor_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"new_navigation":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"partnering":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"product-availability":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"sso":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"submission_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"user_roles_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}},"AuthConfig":{"type":"object","properties":{"user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"},"user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"user_pool_identity_pool_id":{"type":"string","example":"eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1"},"portal_id":{"type":"string","example":"7h2hwdj7hhjsdcjkq03eidna3ep"}},"required":["user_pool_id","user_pool_client_id","portal_id"]},"Exists":{"type":"object","required":["exists"],"properties":{"exists":{"type":"boolean"},"active":{"type":"boolean"}},"example":{"exists":true,"active":false}},"EntitySlug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"EntityId":{"type":"string"},"BaseEntity":{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},"Entity":{"type":"object","properties":{},"additionalProperties":true},"EntityItem":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]},"Grant":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}}}}')}},t={},r=function r(i){var a=t[i];if(void 0!==a)return a.exports;var p=t[i]={exports:{}};return e[i].call(p.exports,p,p.exports,r),p.exports}(914),i=exports;for(var a in r)i[a]=r[a];r.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={914:function(e,t,r){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=i(r(534));t.default=a.default},534:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Customer Portal API","description":"Backend for epilot end customer portals","version":"1.0.0"},"tags":[{"name":"ECP","description":"ECP"},{"name":"ECP Admin","description":"ECP Admin"},{"name":"Public","description":"Public"}],"security":[{"PortalAuth":[]},{"AsOrganization":[]},{"AsCustomer":[]}],"paths":{"/v2/portal/portal":{"post":{"operationId":"upsertPortal","summary":"upserts a portal","description":"upserts a portal and db item","security":[{"EpilotAuth":[]}],"tags":["ECP Admin"],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}}}}},"responses":{"201":{"description":"Success - portal created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v2/portal/public/user":{"post":{"operationId":"createUser","summary":"creates a user","description":"Creates a user in cognito pool and db item","security":[],"tags":["Public"],"parameters":[{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","example":"testemail921@yopmail.com"},"password":{"type":"string","example":"Pass1234!"},"orgId":{"type":"string","example":728},"secondaryIdentifier":{"type":"string","example":123456},"contactId":{"type":"string","example":123456}}}}}},"responses":{"201":{"description":"Success - user created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v2/portal/sso/user":{"post":{"operationId":"createSSOUser","summary":"creates a sso user","description":"Creates a sso user as portal user","security":[],"tags":["Public"],"parameters":[{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","example":"testemail921@yopmail.com"},"orgId":{"type":"string","example":728}}}}}},"responses":{"201":{"description":"Success - user created with success.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Authentication Errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v2/portal/public/activate":{"post":{"operationId":"activateUser","summary":"activateUser","description":"Activates the user","security":[],"tags":["Public"],"parameters":[{"in":"query","name":"token","schema":{"type":"string"},"required":true,"description":"Invite Token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}}}}},"responses":{"200":{"description":"Activated successfully"},"404":{"description":"Token not found for the user"}}}},"/v2/portal/auth":{"get":{"operationId":"testAuth","summary":"testAuth","description":"TODO","tags":["ECP"],"responses":{"200":{"description":"ok"}}}},"/v2/portal/public/config":{"get":{"operationId":"getPortalConfigByDomain","summary":"getPortalConfigByDomain","description":"TODO","tags":["ECP"],"security":[],"parameters":[{"in":"query","name":"domain","required":true,"schema":{"type":"string","example":"example.com"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]}}}}}}},"/v2/portal/config":{"get":{"operationId":"getPortalConfig","summary":"getPortalConfig","description":"TODO","tags":["ECP Admin","ECP"],"parameters":[{"in":"query","name":"origin","required":false,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"security":[{"EpilotAuth":[]},{"PortalAuth":[]}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]}}}}}},"delete":{"operationId":"deletePortal","summary":"deletePortal","description":"TODO","tags":["ECP Admin"],"parameters":[{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"security":[{"EpilotAuth":[]}],"responses":{"204":{"description":"Success"},"403":{"description":"Forbidden"}}}},"/v2/portal/public/portal/config":{"get":{"operationId":"getPublicPortalConfig","summary":"getPublicPortalConfig","description":"TODO","tags":["ECP Admin"],"security":[],"parameters":[{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":12324}},{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]}}}}}}},"/v2/portal/org/portal/config":{"get":{"operationId":"getOrgPortalConfig","summary":"getOrgPortalConfig","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]}}}}}}},"/v2/portal/configs":{"get":{"operationId":"getAllPortalConfigs","summary":"getAllPortalConfigs","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]}}}}}}}}}},"/v2/portal/email-templates":{"post":{"operationId":"upsertEmailTemplates","summary":"upsertEmailTemplates","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"requestBody":{"description":"Portal payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirmAccount":{"type":"string"},"forgotPassword":{"type":"string"},"invitation":{"type":"string"},"onNewQuote":{"type":"string"},"onMapAPendingUser":{"type":"string"}}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"emailTemplates":{"type":"object","properties":{"confirmAccount":{"type":"string"},"forgotPassword":{"type":"string"},"invitation":{"type":"string"},"onNewQuote":{"type":"string"},"onMapAPendingUser":{"type":"string"}}}}}}}}}},"get":{"operationId":"getEmailTemplates","summary":"getEmailTemplates","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"confirmAccount":{"type":"string"},"forgotPassword":{"type":"string"},"invitation":{"type":"string"},"onNewQuote":{"type":"string"},"onMapAPendingUser":{"type":"string"}}}}}}}}},"/v2/portal/replace-ecp-template-variables":{"post":{"operationId":"replaceECPTemplateVariables","summary":"replaceECPTemplateVariables","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"requestBody":{"description":"ECPVariables payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contactId":{"type":"string","example":"7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51"}}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"portalUser":{"type":"object","properties":{"invitationLink":{"type":"string","example":"https://end-customer-portal.ecp.dev.epilot.io/register/existing-customer?contactId=7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51&email=john@doe.com"}}}}}}}}}}},"/v2/portal/org/settings":{"get":{"operationId":"getOrganizationSettings","summary":"getOrganizationSettings","description":"get organization settings","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"automation_entity_mapping":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"automation_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"central_inbox_preview_setting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"contracts_preview_setting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"disable_ivy":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"double_opt_in":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_catalog_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_opportunities_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"end_customer_portal":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"entity_schema_builder":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"logic_editor_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"new_navigation":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"partnering":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"product-availability":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"sso":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"submission_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"user_roles_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}}}}}}},"/v2/portal/schemas":{"get":{"operationId":"getSchemas","summary":"getSchemas","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/extra-permission-attributes":{"get":{"operationId":"extraPermissionAttributes","summary":"extraPermissionAttributes","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"contact":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"contract":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"order":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"opportunity":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}}}}}}}}}}}},"/v2/portal/contact":{"get":{"operationId":"getContact","summary":"getContact","description":"Get the Contact by id","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"patch":{"operationId":"updateContact","summary":"updateContact","description":"Update the contact details","tags":["ECP"],"security":[{"PortalAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}},"/v2/portal/ecp/contact":{"get":{"operationId":"getECPContact","summary":"getECPContact","description":"Get the Contact by id","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"id","required":true,"schema":{"type":"string","example":1234}}],"responses":{"200":{"description":"The returned contact","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"500":{"description":"Other errors","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/v2/portal/contact/email/count":{"get":{"operationId":"getCountByEmail","summary":"getCountByEmail","description":"Check Contact by email","tags":["Public"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"test@test.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number","example":2}}}}}}}}},"/v2/portal/contact/valid/secondary/attributes":{"get":{"operationId":"getValidSecondaryAttributes","summary":"getValidSecondaryAttributes","description":"Get Valid Secondary Attributes","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"responses":{"200":{"description":"The returned count of contact","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"first_name"},"type":{"type":"string","example":"string"}}}}}}}}}}}},"/v2/portal/user":{"get":{"operationId":"getPortalUser","summary":"getPortalUser","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}},"patch":{"operationId":"updatePortalUser","summary":"updatePortalUser","description":"Update the portal user details","tags":["ECP"],"security":[{"PortalAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}},"delete":{"operationId":"deletePortalUser","summary":"deletePortalUser","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned portal user id","content":{"application/json":{"schema":{"type":"string","example":123}}}}}}},"/v2/portal/user/confirm/{id}":{"get":{"operationId":"confirmUser","summary":"confirmUser","description":"TODO","tags":["Public"],"security":[],"parameters":[{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of portal user id"},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"The returned portal user","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}},"/v2/portal/public/user/exists":{"get":{"operationId":"userExists","summary":"userExists","description":"Checks whether a user exists in the customer portal","tags":["Public"],"security":[],"parameters":[{"in":"query","name":"email","required":true,"schema":{"type":"string","example":"user@example.com"}},{"in":"query","name":"org_id","required":true,"schema":{"type":"string","example":123}}],"responses":{"200":{"description":"User exists in the portal","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":true},"user":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}},"404":{"description":"User does not exist in the portal","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":false}}}}}}}}},"/v2/portal/configure-distribution":{"get":{"operationId":"configureDistribution","summary":"configureDistribution","description":"TODO","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"query","name":"origin","required":true,"schema":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}],"responses":{"200":{"description":"The returned configured distribution id","content":{"application/json":{"schema":{"type":"object","properties":{"domainName":{"type":"string","example":"dsj8op4ha01jha23.cloudfront.net"}}}}}}}}},"/v2/portal/order":{"get":{"operationId":"getAllOrders","summary":"getAllOrders","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned orders","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/order/{id}":{"get":{"operationId":"getOrder","summary":"getOrder","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of order"}],"responses":{"200":{"description":"The returned order","content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]},"relations":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}},"patch":{"operationId":"updateOrder","summary":"updateOrder","description":"Update the order details","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of order"}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}},"responses":{"200":{"description":"The returned order","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}},"/v2/portal/opportunity":{"get":{"operationId":"getAllOpportunities","summary":"getAllOpportunities","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned opportunities","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/opportunities/{id}":{"get":{"operationId":"getOpportunity","summary":"getOpportunity","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of opportunities"}],"responses":{"200":{"description":"The returned opportunities","content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]},"relations":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}},"patch":{"operationId":"updateOpportunity","summary":"Update an opportunity based on id","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of opportunities"}],"requestBody":{"description":"Updated opportunity body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"The returned opportunity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}},"/v2/portal/contract":{"get":{"operationId":"getAllContracts","summary":"getAllContracts","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"responses":{"200":{"description":"The returned contracts","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/contract/{id}":{"get":{"operationId":"getContract","summary":"get contract based on id","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of the contract"}],"responses":{"200":{"description":"The returned contract","content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]},"relations":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}},"patch":{"operationId":"updateContract","summary":"Update contract based on id","description":"TODO","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of the contract"}],"requestBody":{"description":"Updated Contract body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"The returned updated contract","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}},"/v2/portal/entity/identifiers/{slug}":{"get":{"operationId":"getEntityIdentifiers","summary":"getEntityIdentifiers","description":"Get Entity\'s Identifiers","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"path","name":"slug","schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"required":true,"description":"The slug of an entity"}],"responses":{"200":{"description":"The returned identifiers of an entity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"contract_number"},"type":{"type":"string","example":"string"}}}}}}}}}}}},"/v2/portal/entity/by-identifiers/{slug}":{"post":{"operationId":"getEntitiesByIdentifiers","summary":"getEntitiesByIdentifiers","description":"Get Entities By Identifiers","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"slug","schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"required":true,"description":"The slug of an entity"}],"requestBody":{"description":"Entity Identifiers","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"The returned Entities","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/entity/add-end-customer/{slug}/{id}":{"put":{"operationId":"addEndCustomerRelationToEntity","summary":"addEndCustomerRelationToEntity","description":"Add EndCustomer Relation To an Entity","tags":["ECP"],"security":[{"PortalAuth":[]}],"parameters":[{"in":"path","name":"slug","schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"required":true,"description":"The slug of an entity"},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Id of the Entity"}],"responses":{"200":{"description":"The returned Entity","content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]},"relations":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}}},"/v2/portal/entity/file":{"post":{"operationId":"saveEntityFile","summary":"Add files to an entity","description":"Add files to an entity","tags":["ECP"],"security":[{"PortalAuth":[]}],"requestBody":{"description":"Save file","required":true,"content":{"application/json":{"schema":{"type":"object","required":["entity_id","entity_type","files"],"properties":{"entity_id":{"type":"string","example":123456},"entity_type":{"type":"string","example":"order"},"files":{"type":"array","items":{"type":"object","required":["filename","s3ref"],"properties":{"filename":{"type":"string","example":12345},"file_entity_id":{"type":"string","example":12345},"document_type":{"type":"string","example":12345},"access_control":{"type":"string","default":"private","enum":["private","public-read"]},"_tags":{"type":"array","items":{"type":"string","example":12345}},"s3ref":{"type":"object","required":["bucket","key"],"properties":{"bucket":{"type":"string","example":12345},"key":{"type":"string","example":12345}}}}}}}}}}},"responses":{"200":{"description":"The returned File Entities","content":{"application/json":{"schema":{"type":"object","properties":{"createdFiles":{"type":"array","items":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}}},"delete":{"operationId":"deleteEntityFile","summary":"Delete files from an entity","description":"Delete files from an entity","tags":["ECP"],"security":[{"PortalAuth":[]}],"requestBody":{"description":"Delete file","required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_entity_ids","entity_type","entity_id"],"properties":{"entity_id":{"type":"string","example":123456},"entity_type":{"type":"string","example":"order"},"file_entity_ids":{"type":"array","items":{"type":"string","example":12345}}}}}}},"responses":{"200":{"description":"The returned File Entities","content":{"application/json":{"schema":{"type":"object","properties":{"deletedFiles":{"type":"array","items":{"type":"string","example":123}}}}}}}}}},"/v2/portal/portal/files":{"post":{"operationId":"savePortalFiles","summary":"Add files to portal","description":"Add files to portal","tags":["ECP Admin"],"security":[{"EpilotAuth":[]}],"requestBody":{"description":"Save portal file","required":true,"content":{"application/json":{"schema":{"type":"object","required":["files","origin"],"properties":{"origin":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]},"files":{"type":"array","items":{"type":"object","required":["file_type"],"properties":{"filename":{"type":"string","example":12345},"file_type":{"type":"string","example":"orderRightTeaser"},"_tags":{"type":"array","items":{"type":"string","example":12345}},"s3ref":{"type":"object","required":["bucket","key"],"properties":{"bucket":{"type":"string","example":12345},"key":{"type":"string","example":12345}}}}}}}}}}},"responses":{"200":{"description":"The returned portal files","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]}}}}}}}},"components":{"securitySchemes":{"PortalAuth":{"type":"http","scheme":"bearer","description":"Customer Portal Cognito Token"},"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id as internal user"},"AsContact":{"type":"apiKey","in":"header","name":"x-contact-id","description":"Set contact id as internal user"},"AsCustomer":{"type":"apiKey","in":"header","name":"x-portal-id","description":"Set portal id as customer"}},"schemas":{"InviteToken":{"type":"string"},"UserActivationPayload":{"type":"object","properties":{"display_name":{"type":"string","description":"User\'s display name (default: email address)","example":"Example User"},"password":{"type":"string","description":"User\'s password","example":"AKjhdakjsdh@!34"}}},"ErrorResp":{"type":"object","properties":{"message":{"type":"string"}}},"AddPortalResp":{"type":"object","properties":{"message":{"type":"string"}}},"EmailTemplates":{"type":"object","properties":{"confirmAccount":{"type":"string"},"forgotPassword":{"type":"string"},"invitation":{"type":"string"},"onNewQuote":{"type":"string"},"onMapAPendingUser":{"type":"string"}}},"DeleteEntityFile":{"type":"object","required":["file_entity_ids","entity_type","entity_id"],"properties":{"entity_id":{"type":"string","example":123456},"entity_type":{"type":"string","example":"order"},"file_entity_ids":{"type":"array","items":{"type":"string","example":12345}}}},"SaveEntityFile":{"type":"object","required":["entity_id","entity_type","files"],"properties":{"entity_id":{"type":"string","example":123456},"entity_type":{"type":"string","example":"order"},"files":{"type":"array","items":{"type":"object","required":["filename","s3ref"],"properties":{"filename":{"type":"string","example":12345},"file_entity_id":{"type":"string","example":12345},"document_type":{"type":"string","example":12345},"access_control":{"type":"string","default":"private","enum":["private","public-read"]},"_tags":{"type":"array","items":{"type":"string","example":12345}},"s3ref":{"type":"object","required":["bucket","key"],"properties":{"bucket":{"type":"string","example":12345},"key":{"type":"string","example":12345}}}}}}}},"SavePortalFile":{"type":"object","required":["files","origin"],"properties":{"origin":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]},"files":{"type":"array","items":{"type":"object","required":["file_type"],"properties":{"filename":{"type":"string","example":12345},"file_type":{"type":"string","example":"orderRightTeaser"},"_tags":{"type":"array","items":{"type":"string","example":12345}},"s3ref":{"type":"object","required":["bucket","key"],"properties":{"bucket":{"type":"string","example":12345},"key":{"type":"string","example":12345}}}}}}}},"ExtraSchemaAttributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"Origin":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]},"UpsertPortalConfig":{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},"PortalConfig":{"allOf":[{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"name":{"type":"string","example":"My Portal"},"is_epilot_domain":{"type":"boolean","example":true},"design_id":{"type":"string","example":3134},"default_user_to_notify":{"type":"object"},"self_registration":{"description":"Whether portal user has self registration","type":"boolean","example":false},"cognito_details":{"type":"object","properties":{"cognito_user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"cognito_user_pool_arn":{"type":"string","example":"arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341"},"cognito_user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"}}},"config":{"type":"string"},"contact_secondary_identifier":{"type":"string","example":"full_name"},"email_templates":{"type":"object","properties":{"confirmAccount":{"type":"string","example":"701f089d-6953-48b5-ac35-442de7c59cd3"},"forgotPassword":{"type":"string","example":"6538fddb-f0e9-4f0f-af51-6e57891ff20a"},"invitation":{"type":"string","example":"14ae65fb-0dc1-4863-8743-6bc01da469f6"}}},"grants":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}},"images":{"type":"object","properties":{"orderLeftTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg"},"orderRightTeaser":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg"},"welcomeBanner":{"type":"string","nullable":true,"example":"https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"}}},"entity_identifiers":{"type":"object","additionalProperties":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string","example":"contract_number"}}}}},"entity_actions":{"type":"array","items":{"type":"object","properties":{"journey_id":{"type":"string"},"slug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"action_Label":{"type":"object","properties":{"en":{"type":"string"},"de":{"type":"string"}}}}}}}},{"properties":{"id":{"type":"string","example":12345,"description":"ID of the organization"},"org_name":{"type":"string","example":"ABC Company"},"origin":{"type":"string","description":"Origin of the portal","enum":["END_CUSTOMER_PORTAL","INSTALLER_PORTAL"]}}}]},"OrganizationSettings":{"type":"object","properties":{"automation_entity_mapping":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"automation_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"central_inbox_preview_setting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"contracts_preview_setting":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"disable_ivy":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"double_opt_in":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_catalog_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_opportunities_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ecommerce_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"end_customer_portal":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"entity_schema_builder":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"logic_editor_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"new_navigation":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"partnering":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"product-availability":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"sso":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"submission_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"user_roles_preview":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}},"AuthConfig":{"type":"object","properties":{"user_pool_id":{"type":"string","example":"eu-central-1_CUEQRNbUb"},"user_pool_client_id":{"type":"string","example":"6bsd0jkgoie74k2i8mrhc1vest"},"user_pool_identity_pool_id":{"type":"string","example":"eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1"},"portal_id":{"type":"string","example":"7h2hwdj7hhjsdcjkq03eidna3ep"}},"required":["user_pool_id","user_pool_client_id","portal_id"]},"Exists":{"type":"object","required":["exists"],"properties":{"exists":{"type":"boolean"},"active":{"type":"boolean"}},"example":{"exists":true,"active":false}},"EntitySlug":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"EntityId":{"type":"string"},"BaseEntity":{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},"Entity":{"type":"object","properties":{},"additionalProperties":true},"EntityItem":{"allOf":[{"type":"object","properties":{"_id":{"type":"string"},"_title":{"type":"string","description":"Title of entity"},"_org":{"type":"string","description":"Organization Id the entity belongs to"},"_schema":{"description":"URL-friendly identifier for the entity schema","type":"string","example":"contact"},"_tags":{"type":"array","items":{"type":"string"}},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"}},"required":["_id","_title","_org","_schema","_created_at","_updated_at"],"example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","_org":"123","_schema":"contact","_tags":["example","mock"],"_created_at":"2021-02-09T12:41:43.662Z","_updated_at":"2021-02-09T12:41:43.662Z"}},{"type":"object","properties":{},"additionalProperties":true}]},"Grant":{"type":"object","properties":{"action":{"type":"string","example":"entity-read"},"resource":{"type":"string","example":"entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"},"effect":{"type":"string","default":"allow","enum":["allow","deny"]}},"required":["action"]}}}}')}},t={},r=function r(i){var a=t[i];if(void 0!==a)return a.exports;var p=t[i]={exports:{}};return e[i].call(p.exports,p,p.exports,r),p.exports}(914),i=exports;for(var a in r)i[a]=r[a];r.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();
package/dist/openapi.d.ts CHANGED
@@ -611,7 +611,7 @@ declare namespace Paths {
611
611
  export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
612
612
  }
613
613
  export interface QueryParameters {
614
- origin?: Parameters.Origin;
614
+ origin: Parameters.Origin;
615
615
  }
616
616
  namespace Responses {
617
617
  export interface $200 {
@@ -637,7 +637,7 @@ declare namespace Paths {
637
637
  id: Parameters.Id;
638
638
  }
639
639
  export interface QueryParameters {
640
- origin?: Parameters.Origin;
640
+ origin: Parameters.Origin;
641
641
  org_id: /**
642
642
  * example:
643
643
  * 123
@@ -662,12 +662,38 @@ declare namespace Paths {
662
662
  Components.Schemas.EntityItem;
663
663
  }
664
664
  }
665
+ namespace CreateSSOUser {
666
+ namespace Parameters {
667
+ export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
668
+ }
669
+ export interface QueryParameters {
670
+ origin: Parameters.Origin;
671
+ }
672
+ export interface RequestBody {
673
+ /**
674
+ * example:
675
+ * testemail921@yopmail.com
676
+ */
677
+ email?: string;
678
+ /**
679
+ * example:
680
+ * 728
681
+ */
682
+ orgId?: string;
683
+ }
684
+ namespace Responses {
685
+ export type $201 = Components.Schemas.AddPortalResp;
686
+ export type $400 = Components.Schemas.ErrorResp;
687
+ export type $401 = Components.Schemas.ErrorResp;
688
+ export type $500 = Components.Schemas.ErrorResp;
689
+ }
690
+ }
665
691
  namespace CreateUser {
666
692
  namespace Parameters {
667
693
  export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
668
694
  }
669
695
  export interface QueryParameters {
670
- origin?: Parameters.Origin;
696
+ origin: Parameters.Origin;
671
697
  }
672
698
  export interface RequestBody {
673
699
  /**
@@ -952,7 +978,7 @@ declare namespace Paths {
952
978
  export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
953
979
  }
954
980
  export interface QueryParameters {
955
- origin?: Parameters.Origin;
981
+ origin: Parameters.Origin;
956
982
  }
957
983
  namespace Responses {
958
984
  export type $200 = Components.Schemas.EmailTemplates;
@@ -1109,7 +1135,7 @@ declare namespace Paths {
1109
1135
  export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
1110
1136
  }
1111
1137
  export interface QueryParameters {
1112
- origin?: Parameters.Origin;
1138
+ origin: Parameters.Origin;
1113
1139
  }
1114
1140
  namespace Responses {
1115
1141
  export type $200 = Components.Schemas.PortalConfig;
@@ -1184,7 +1210,7 @@ declare namespace Paths {
1184
1210
  * 12324
1185
1211
  */
1186
1212
  Parameters.OrgId;
1187
- origin?: Parameters.Origin;
1213
+ origin: Parameters.Origin;
1188
1214
  }
1189
1215
  namespace Responses {
1190
1216
  export type $200 = Components.Schemas.PortalConfig;
@@ -1234,7 +1260,7 @@ declare namespace Paths {
1234
1260
  export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
1235
1261
  }
1236
1262
  export interface QueryParameters {
1237
- origin?: Parameters.Origin;
1263
+ origin: Parameters.Origin;
1238
1264
  }
1239
1265
  export interface RequestBody {
1240
1266
  /**
@@ -1365,6 +1391,34 @@ declare namespace Paths {
1365
1391
  }
1366
1392
  }
1367
1393
  }
1394
+ namespace UpdateOpportunity {
1395
+ namespace Parameters {
1396
+ export type Id = Components.Schemas.EntityId;
1397
+ }
1398
+ export interface PathParameters {
1399
+ id: Parameters.Id;
1400
+ }
1401
+ export type RequestBody = Components.Schemas.Entity;
1402
+ namespace Responses {
1403
+ export interface $200 {
1404
+ data?: /**
1405
+ * example:
1406
+ * {
1407
+ * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1408
+ * "_org": "123",
1409
+ * "_schema": "contact",
1410
+ * "_tags": [
1411
+ * "example",
1412
+ * "mock"
1413
+ * ],
1414
+ * "_created_at": {},
1415
+ * "_updated_at": {}
1416
+ * }
1417
+ */
1418
+ Components.Schemas.EntityItem;
1419
+ }
1420
+ }
1421
+ }
1368
1422
  namespace UpdateOrder {
1369
1423
  namespace Parameters {
1370
1424
  export type Id = Components.Schemas.EntityId;
@@ -1444,7 +1498,7 @@ declare namespace Paths {
1444
1498
  export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
1445
1499
  }
1446
1500
  export interface QueryParameters {
1447
- origin?: Parameters.Origin;
1501
+ origin: Parameters.Origin;
1448
1502
  }
1449
1503
  export type RequestBody = Components.Schemas.EmailTemplates;
1450
1504
  namespace Responses {
@@ -1549,6 +1603,16 @@ export interface OperationMethods {
1549
1603
  data?: Paths.CreateUser.RequestBody,
1550
1604
  config?: AxiosRequestConfig
1551
1605
  ): OperationResponse<Paths.CreateUser.Responses.$201>
1606
+ /**
1607
+ * createSSOUser - creates a sso user
1608
+ *
1609
+ * Creates a sso user as portal user
1610
+ */
1611
+ 'createSSOUser'(
1612
+ parameters?: Parameters<Paths.CreateSSOUser.QueryParameters> | null,
1613
+ data?: Paths.CreateSSOUser.RequestBody,
1614
+ config?: AxiosRequestConfig
1615
+ ): OperationResponse<Paths.CreateSSOUser.Responses.$201>
1552
1616
  /**
1553
1617
  * activateUser - activateUser
1554
1618
  *
@@ -1849,6 +1913,16 @@ export interface OperationMethods {
1849
1913
  data?: any,
1850
1914
  config?: AxiosRequestConfig
1851
1915
  ): OperationResponse<Paths.GetOpportunity.Responses.$200>
1916
+ /**
1917
+ * updateOpportunity - Update an opportunity based on id
1918
+ *
1919
+ * TODO
1920
+ */
1921
+ 'updateOpportunity'(
1922
+ parameters?: Parameters<Paths.UpdateOpportunity.PathParameters> | null,
1923
+ data?: Paths.UpdateOpportunity.RequestBody,
1924
+ config?: AxiosRequestConfig
1925
+ ): OperationResponse<Paths.UpdateOpportunity.Responses.$200>
1852
1926
  /**
1853
1927
  * getAllContracts - getAllContracts
1854
1928
  *
@@ -1870,7 +1944,7 @@ export interface OperationMethods {
1870
1944
  config?: AxiosRequestConfig
1871
1945
  ): OperationResponse<Paths.GetContract.Responses.$200>
1872
1946
  /**
1873
- * updateContract - edit contract based on id
1947
+ * updateContract - Update contract based on id
1874
1948
  *
1875
1949
  * TODO
1876
1950
  */
@@ -1966,6 +2040,18 @@ export interface PathsDictionary {
1966
2040
  config?: AxiosRequestConfig
1967
2041
  ): OperationResponse<Paths.CreateUser.Responses.$201>
1968
2042
  }
2043
+ ['/v2/portal/sso/user']: {
2044
+ /**
2045
+ * createSSOUser - creates a sso user
2046
+ *
2047
+ * Creates a sso user as portal user
2048
+ */
2049
+ 'post'(
2050
+ parameters?: Parameters<Paths.CreateSSOUser.QueryParameters> | null,
2051
+ data?: Paths.CreateSSOUser.RequestBody,
2052
+ config?: AxiosRequestConfig
2053
+ ): OperationResponse<Paths.CreateSSOUser.Responses.$201>
2054
+ }
1969
2055
  ['/v2/portal/public/activate']: {
1970
2056
  /**
1971
2057
  * activateUser - activateUser
@@ -2313,6 +2399,16 @@ export interface PathsDictionary {
2313
2399
  data?: any,
2314
2400
  config?: AxiosRequestConfig
2315
2401
  ): OperationResponse<Paths.GetOpportunity.Responses.$200>
2402
+ /**
2403
+ * updateOpportunity - Update an opportunity based on id
2404
+ *
2405
+ * TODO
2406
+ */
2407
+ 'patch'(
2408
+ parameters?: Parameters<Paths.UpdateOpportunity.PathParameters> | null,
2409
+ data?: Paths.UpdateOpportunity.RequestBody,
2410
+ config?: AxiosRequestConfig
2411
+ ): OperationResponse<Paths.UpdateOpportunity.Responses.$200>
2316
2412
  }
2317
2413
  ['/v2/portal/contract']: {
2318
2414
  /**
@@ -2338,11 +2434,11 @@ export interface PathsDictionary {
2338
2434
  config?: AxiosRequestConfig
2339
2435
  ): OperationResponse<Paths.GetContract.Responses.$200>
2340
2436
  /**
2341
- * updateContract - edit contract based on id
2437
+ * updateContract - Update contract based on id
2342
2438
  *
2343
2439
  * TODO
2344
2440
  */
2345
- 'put'(
2441
+ 'patch'(
2346
2442
  parameters?: Parameters<Paths.UpdateContract.PathParameters> | null,
2347
2443
  data?: Paths.UpdateContract.RequestBody,
2348
2444
  config?: AxiosRequestConfig
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/customer-portal-client",
3
- "version": "0.8.10",
3
+ "version": "0.8.12",
4
4
  "description": "API Client for epilot customer-portal API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",