@epilot/sdk 2.1.8 → 2.1.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +261 -19
- package/definitions/journey.json +18 -1
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-management.cjs +6 -6
- package/dist/apis/data-management.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/erp-integration.cjs +6 -6
- package/dist/apis/erp-integration.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-GHAEATNY.cjs → chunk-6TKKEGYU.cjs} +3 -3
- package/dist/{chunk-V3SZ5A6F.js → chunk-G33CBNJD.js} +3 -3
- package/dist/chunk-XT54462S.js +14 -0
- package/dist/chunk-YWDWPVIC.cjs +14 -0
- package/dist/customer-portal-AEFMNNYP.cjs +7 -0
- package/dist/customer-portal-Y3GLUVMW.js +7 -0
- package/dist/{customer-portal-runtime-MRVZ7JR4.js → customer-portal-runtime-374XJ6LB.js} +1 -1
- package/dist/{customer-portal-runtime-VGK7RMLC.cjs → customer-portal-runtime-3LTXCTKD.cjs} +2 -2
- package/dist/{customer-portal.d-uN6lOpvy.d.cts → customer-portal.d-BJNWYMt9.d.cts} +221 -16
- package/dist/{customer-portal.d-uN6lOpvy.d.ts → customer-portal.d-BJNWYMt9.d.ts} +221 -16
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/journey-KDR5EU3W.js +7 -0
- package/dist/journey-REBN4TGQ.cjs +7 -0
- package/dist/{journey.d-C4N4t1Rh.d.cts → journey.d-ClXO0xK8.d.cts} +20 -0
- package/dist/{journey.d-C4N4t1Rh.d.ts → journey.d-ClXO0xK8.d.ts} +20 -0
- package/docs/customer-portal.md +245 -16
- package/docs/journey.md +21 -2
- package/package.json +1 -1
- package/dist/chunk-5NKXJA43.js +0 -14
- package/dist/chunk-COQMJFAB.cjs +0 -14
- package/dist/customer-portal-5JVN4Y5Y.js +0 -7
- package/dist/customer-portal-T7KIY3AE.cjs +0 -7
- package/dist/journey-7CKX67M7.js +0 -7
- package/dist/journey-EUZ6MVHG.cjs +0 -7
|
@@ -1 +1 @@
|
|
|
1
|
-
{"s":"https://customer-portal-api.sls.epilot.io","o":[["upsertPortal","post","/v2/portal/portal",[["origin","q",true],["portal_id","q"]],1],["createUser","post","/v2/portal/public/user",[["origin","q",true]],1],["createUserV3","post","/v3/portal/public/user",[["portal_id","q",true]],1],["validateToken","post","/v2/portal/token/validate"],["revokeToken","post","/v2/portal/token/revoke",null,1],["getPortalConfigByDomain","get","/v2/portal/public/config",[["domain","q",true]]],["getPortalConfig","get","/v2/portal/config",[["origin","q"]]],["deletePortal","delete","/v2/portal/config",[["origin","q",true]]],["getPortalExtensions","get","/v2/portal/extensions",[["origin","q"]]],["getPublicPortalExtensionDetails","get","/v2/portal/public/extensions",[["org_id","q",true],["origin","q",true]]],["getPortalExtensionsV3","get","/v3/portal/extensions",[["portal_id","q",true]]],["getPublicPortalExtensionDetailsV3","get","/v3/portal/public/extensions",[["org_id","q"],["portal_id","q"],["domain","q"]]],["getConsumption","get","/v2/portal/consumption",[["app_id","q"],["extensionId","q",true],["hookId","q",true],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getCosts","get","/v2/portal/costs",[["app_id","q"],["extensionId","q",true],["hookId","q",true],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getPrices","get","/v2/portal/prices",[["app_id","q"],["extensionId","q",true],["hookId","q",true],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getExternalLinks","get","/v2/portal/external-links",[["origin","q"],["contactId","q"]]],["getResolvedExternalLink","get","/v2/portal/resolve:external-link/{id}",[["id","p",true],["origin","q"],["contactId","q"]]],["getExternalLinksV3","get","/v3/portal/external-links",[["portal_id","q"],["contactId","q"]]],["getResolvedExternalLinkV3","get","/v3/portal/resolve:external-link/{id}",[["id","p",true],["portal_id","q"],["contactId","q"]]],["getResolvedSeamlessLink","get","/v2/portal/resolve:seamless-link",[["app_id","q"],["extension_id","q",true],["link_id","q",true],["context_entities","q"]]],["getPublicPortalConfig","get","/v2/portal/public/portal/config",[["org_id","q",true],["origin","q",true]]],["getOrgPortalConfig","get","/v2/portal/org/portal/config",[["origin","q",true]]],["getPublicPortalConfigV3","get","/v3/portal/public/portal/config",[["org_id","q",true],["portal_id","q",true]]],["getOrgPortalConfigV3","get","/v3/portal/org/portal/config",[["portal_id","q",true]]],["getAllPortalConfigs","get","/v2/portal/configs"],["upsertEmailTemplates","post","/v2/portal/email-templates",[["origin","q",true]],1],["getEmailTemplates","get","/v2/portal/email-templates",[["origin","q",true]]],["upsertEmailTemplatesByPortalId","post","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]],1],["getEmailTemplatesByPortalId","get","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]]],["getPublicPortalWidgets","get","/v2/portal/public-widgets",[["org_id","q",true],["origin","q",true]]],["upsertPortalWidget","post","/v2/portal/widgets",[["origin","q",true]],1],["getPortalWidgets","get","/v2/portal/widgets",[["origin","q"],["contract_id","q"]]],["replaceECPTemplateVariables","post","/v2/portal/replace-ecp-template-variables",null,1],["getOrganizationSettings","get","/v2/portal/org/settings"],["getSchemas","get","/v2/portal/schemas"],["getSchemasByDomain","get","/v2/portal/public/schemas",[["domain","q",true]]],["getOrganizationSettingsByDomain","get","/v2/portal/public/org/settings",[["domain","q",true]]],["extraPermissionAttributes","get","/v2/portal/extra-permission-attributes"],["validateCaaRecords","post","/v2/portal/validate/caa-records",[["origin","q",true]]],["validateCaaRecordsV3","post","/v3/portal/validate/caa-records",[["portal_id","q",true]]],["getContact","get","/v2/portal/contact"],["updateContact","patch","/v2/portal/contact",null,1],["getECPContact","get","/v2/portal/ecp/contact",[["id","q",true]]],["checkContactExists","post","/v2/portal/public/contact/exists",[["origin","q",true]],1],["checkContactExistsV3","post","/v3/portal/public/contact/exists",[["portal_id","q",true]],1],["getValidSecondaryAttributes","get","/v2/portal/contact/valid/secondary/attributes"],["getPortalUser","get","/v2/portal/user"],["updatePortalUser","patch","/v2/portal/user",null,1],["deletePortalUser","delete","/v2/portal/user"],["updatePortalUserEmail","put","/v2/portal/user/update/email",null,1],["resendConfirmationEmail","post","/v2/portal/user/resend/confirmation-email/{id}",[["id","p",true]]],["fetchPortalUsersByRelatedEntity","get","/v2/portal/users/by-related-entity",[["entity_id","q",true],["slug","q",true]]],["confirmUser","get","/v2/portal/user/confirm",[["confirmation_link_token","q",true],["use_redirect","q"]]],["confirmUserWithUserId","get","/v2/portal/user/confirm/{id}",[["origin","q",true],["id","p",true],["org_id","q",true]]],["userExists","get","/v2/portal/public/user/exists",[["email","q",true],["org_id","q",true],["origin","q"]]],["userExistsV3","get","/v3/portal/public/user/exists",[["email","q",true],["org_id","q",true],["portal_id","q"]]],["getRecipientsToNotifyOnAutomation","post","/v2/portal/recipients-to-notify",null,1],["configureDistribution","get","/v2/portal/configure-distribution",[["origin","q",true]]],["configureDistributionV3","get","/v3/portal/configure-distribution",[["portal_id","q",true]]],["getAllOrders","get","/v2/portal/order",[["from","q"],["size","q"]]],["postOrderAcceptance","post","/v2/portal/order/{id}/acceptance",[["id","p",true]],1],["getOrder","get","/v2/portal/order/{id}",[["id","p",true]]],["updateOrder","patch","/v2/portal/order/{id}",[["id","p",true]],1],["getAllOpportunities","get","/v2/portal/opportunity",[["from","q"],["size","q"]]],["getSearchableAttributesForOpportunities","get","/v2/portal/opportunities/searchable-attributes",[["from","q"],["size","q"]]],["getSearchResultsForOpportunities","post","/v2/portal/opportunities/search",[["from","q"],["size","q"]],1],["getOpportunity","get","/v2/portal/opportunities/{id}",[["id","p",true]]],["updateOpportunity","patch","/v2/portal/opportunities/{id}",[["id","p",true]],1],["getAllRequests","get","/v2/portal/request",[["from","q"],["size","q"]]],["getAllContracts","get","/v2/portal/contract",[["from","q"],["size","q"]]],["getContract","get","/v2/portal/contract/{id}",[["id","p",true]]],["updateContract","patch","/v2/portal/contract/{id}",[["id","p",true]],1],["addContractByIdentifiers","post","/v2/portal/contract/by-identifiers",null,1],["getEntityIdentifiers","get","/v2/portal/entity/identifiers/{slug}",[["slug","p",true]]],["getEntityActivityFeed","get","/v2/portal/entity/{slug}/{id}/activity",[["slug","p",true],["id","p",true],["after","q"],["before","q"],["from","q"],["size","q"],["type","q"],["include_relations","q"]]],["validateCadenceEntityEditRules","get","/v2/portal/{slug}/{id}:validateRule",[["slug","p",true],["id","p",true],["attribute","q"]]],["searchPaymentRelationsInEntities","get","/v2/portal/entities-by-payment/{id}",[["id","p",true]]],["createCustomEntityActivity","put","/v2/portal/entity/activity",[["entities","q",false,"form"]],1],["saveEntityFile","post","/v2/portal/entity/file",null,1],["deleteEntityFile","delete","/v2/portal/entity/file",null,1],["savePortalFiles","post","/v2/portal/portal/files",null,1],["getRegistrationIdentifiers","get","/v2/portal/registration/identifiers"],["getAllFiles","get","/v2/portal/user/files",[["from","q",true],["size","q",true],["entity_ids","q"],["file_types","q"]]],["getFileById","get","/v2/portal/user/file/{id}",[["id","p",true]]],["trackFileDownloaded","post","/v2/portal/user/file/{id}/downloaded",[["id","p",true]]],["getFilesCountByEntity","get","/v2/portal/user/files/count-by-entity"],["getBillingEvents","get","/v2/portal/billing/events",[["from","q"],["size","q"],["entity_id","q"],["event_type","q"],["paid","q"],["date_after","q"],["date_before","q"],["sort","q"]]],["getCustomerBalance","get","/v2/portal/billing/customers/balance"],["getBillingAccount","get","/v2/portal/billing/accounts/{id}"],["loginToPortalAsUser","post","/v2/portal/admin:login-as-user",null,1],["triggerEntityAccessEvent","post","/v2/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["origin","q",true]]],["triggerEntityAccessEventV3","post","/v3/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["portal_id","q",true]]],["getPortalUserEntity","post","/v2/portal/entity:get",null,1],["searchPortalUserEntities","post","/v2/portal/entity:search",null,1],["canTriggerPortalFlow","post","/v2/portal/can-trigger-portal-flow",[["origin","q"],["portal_id","q",true]],1],["getAutomationContext","get","/v2/portal/automation-context",[["activity_id","q",true],["type","q",true]]],["updateWorkflowStepAsDone","put","/v2/portal/workflow/{workflow_id}/{step_id}:markDone",[["workflow_id","p",true],["step_id","p",true]]],["getEntityWorkflows","get","/v2/portal/entity/{slug}/{id}/workflows",[["slug","p",true],["id","p",true]]],["uploadMeterReadingPhoto","post","/v2/portal/metering/reading/photo",null,1],["createMeterReading","post","/v2/portal/metering/reading",[["override_plausibility","q"]],1],["getAllowedMeterReadingRange","get","/v2/portal/metering/reading/allowed-range/{meter_id}",[["meter_id","p",true],["origin","q"],["timestamp","q"],["context_entities","q"]]],["ssoLogin","post","/v2/portal/public/sso/login",[["origin","q",true],["org_id","q",true],["contact_id","q"]],1],["ssoLoginV3","post","/v3/portal/public/sso/login",[["portal_id","q",true],["org_id","q",true],["contact_id","q"]],1],["ssoRedirect","post","/v2/portal/public/sso/redirect",[["web_uri","q",true]],1],["ssoCallback","post","/v2/portal/public/sso/callback",[["domain","q"]],1],["getPortalPage","get","/v2/portal/pages/{id}"],["updatePortalPage","put","/v2/portal/pages/{id}",null,1],["deletePortalPage","delete","/v2/portal/pages/{id}"],["getPortalPages","get","/v2/portal/pages",[["fields","q"],["filter","q"],["contract_id","q"],["context_entities","q"]]],["createPortalPage","post","/v2/portal/pages",null,1],["getPublicPages","get","/v2/portal/public/pages",[["domain","q",true],["fields","q"],["filter","q"]]],["interpolatePortalPages","post","/v2/portal/pages/interpolate",null,1],["getDefaultPages","get","/v2/portal/pages/default"],["createPortalPageBlock","post","/v2/portal/pages/{id}/blocks",null,1],["getPortalPageBlocks","get","/v2/portal/pages/{id}/blocks"],["getPortalPageBlock","get","/v2/portal/pages/{id}/blocks/{block_id}"],["updatePortalPageBlock","put","/v2/portal/pages/{id}/blocks/{block_id}",null,1],["deletePortalPageBlock","delete","/v2/portal/pages/{id}/blocks/{block_id}"],["getUserEntryPoint","get","/v2/portal/public/user/entry-point",[["email","q",true],["domain","q",true]]],["updateCampaignPortalBlockStatus","put","/v2/portal/campaign/{campaign_id}/entity:status",[["campaign_id","p",true]],1],["updateNotificationsStatus","put","/v2/portal/notifications/entity:status",null,1],["deRegisterMLoginUser","delete","/v2/portal/public/m-login/deregister/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]]],["notifyMLoginInterestChange","post","/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]],1],["createPortalConfig","post","/v3/portal/config",null,1],["getPortalConfigV3","get","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["putPortalConfig","put","/v3/portal/config/{portal_id}",[["portal_id","p",true]],1],["deletePortalConfig","delete","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["listAllPortalConfigs","get","/v3/portal/configs"],["swapPortalConfig","post","/v3/portal/config/swap",null,1],["invitePartner","post","/v3/portal/partner/invite",null,1],["listBusinessPartners","get","/v3/portal/partner/list"],["resendPartnerInvitation","post","/v3/portal/partner/{partner_id}/resend-invitation",[["partner_id","p",true]]],["revokePartner","delete","/v3/portal/partner/{partner_id}/revoke",[["partner_id","p",true]]],["disablePartner","post","/v3/portal/partner/{partner_id}/disable",[["partner_id","p",true]]],["enablePartner","post","/v3/portal/partner/{partner_id}/enable",[["partner_id","p",true]]]],"v":"3.0.3","pp":{"/v2/portal/billing/accounts/{id}":[["id","p",true]],"/v2/portal/pages/{id}":[["id","p",true]],"/v2/portal/pages":[["domain","q",true]],"/v2/portal/pages/{id}/blocks":[["id","p",true]],"/v2/portal/pages/{id}/blocks/{block_id}":[["id","p",true],["block_id","p",true]]}}
|
|
1
|
+
{"s":"https://customer-portal-api.sls.epilot.io","o":[["upsertPortal","post","/v2/portal/portal",[["origin","q",true],["portal_id","q"]],1],["createUser","post","/v2/portal/public/user",[["origin","q",true]],1],["createUserV3","post","/v3/portal/public/user",[["portal_id","q"],["domain","q"]],1],["validateToken","post","/v2/portal/token/validate"],["revokeToken","post","/v2/portal/token/revoke",null,1],["getPortalConfigByDomain","get","/v2/portal/public/config",[["domain","q",true]]],["getPortalConfig","get","/v2/portal/config",[["origin","q"]]],["deletePortal","delete","/v2/portal/config",[["origin","q",true]]],["getPortalExtensions","get","/v2/portal/extensions",[["origin","q"]]],["getPublicPortalExtensionDetails","get","/v2/portal/public/extensions",[["org_id","q",true],["origin","q",true]]],["getPortalExtensionsV3","get","/v3/portal/extensions",[["portal_id","q",true]]],["getPublicPortalExtensionDetailsV3","get","/v3/portal/public/extensions",[["org_id","q"],["portal_id","q"],["domain","q"]]],["getConsumption","get","/v2/portal/consumption",[["app_id","q"],["extensionId","q",true],["hookId","q",true],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getCosts","get","/v2/portal/costs",[["app_id","q"],["extensionId","q",true],["hookId","q",true],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getPrices","get","/v2/portal/prices",[["app_id","q"],["extensionId","q",true],["hookId","q",true],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["getExternalLinks","get","/v2/portal/external-links",[["origin","q"],["contactId","q"]]],["getResolvedExternalLink","get","/v2/portal/resolve:external-link/{id}",[["id","p",true],["origin","q"],["contactId","q"]]],["getExternalLinksV3","get","/v3/portal/external-links",[["portal_id","q"],["contactId","q"]]],["getResolvedExternalLinkV3","get","/v3/portal/resolve:external-link/{id}",[["id","p",true],["portal_id","q"],["contactId","q"]]],["getResolvedSeamlessLink","get","/v2/portal/resolve:seamless-link",[["app_id","q"],["extension_id","q",true],["link_id","q",true],["context_entities","q"]]],["getPublicPortalConfig","get","/v2/portal/public/portal/config",[["org_id","q",true],["origin","q",true]]],["getOrgPortalConfig","get","/v2/portal/org/portal/config",[["origin","q",true]]],["getPublicPortalConfigV3","get","/v3/portal/public/portal/config",[["org_id","q",true],["portal_id","q",true]]],["getOrgPortalConfigV3","get","/v3/portal/org/portal/config",[["portal_id","q",true]]],["getAllPortalConfigs","get","/v2/portal/configs"],["upsertEmailTemplates","post","/v2/portal/email-templates",[["origin","q",true]],1],["getEmailTemplates","get","/v2/portal/email-templates",[["origin","q",true]]],["upsertEmailTemplatesByPortalId","post","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]],1],["getEmailTemplatesByPortalId","get","/v3/portal/email-templates/{portal_id}",[["portal_id","p",true]]],["getPublicPortalWidgets","get","/v2/portal/public-widgets",[["org_id","q",true],["origin","q",true]]],["upsertPortalWidget","post","/v2/portal/widgets",[["origin","q",true]],1],["getPortalWidgets","get","/v2/portal/widgets",[["origin","q"],["contract_id","q"]]],["getPortalWidgetsV3","get","/v3/portal/widgets",[["portal_id","q",true],["contract_id","q"]]],["upsertPortalWidgetV3","post","/v3/portal/widgets",[["portal_id","q",true]],1],["savePortalFilesV3","post","/v3/portal/portal/files",[["portal_id","q",true]],1],["replaceECPTemplateVariables","post","/v2/portal/replace-ecp-template-variables",null,1],["getOrganizationSettings","get","/v2/portal/org/settings"],["getSchemas","get","/v2/portal/schemas"],["getSchemasByDomain","get","/v2/portal/public/schemas",[["domain","q",true]]],["getOrganizationSettingsByDomain","get","/v2/portal/public/org/settings",[["domain","q",true]]],["extraPermissionAttributes","get","/v2/portal/extra-permission-attributes"],["validateCaaRecords","post","/v2/portal/validate/caa-records",[["origin","q",true]]],["validateCaaRecordsV3","post","/v3/portal/validate/caa-records",[["portal_id","q",true]]],["getContact","get","/v2/portal/contact"],["updateContact","patch","/v2/portal/contact",null,1],["getECPContact","get","/v2/portal/ecp/contact",[["id","q",true]]],["checkContactExists","post","/v2/portal/public/contact/exists",[["origin","q",true]],1],["checkContactExistsV3","post","/v3/portal/public/contact/exists",[["portal_id","q"],["domain","q"]],1],["getValidSecondaryAttributes","get","/v2/portal/contact/valid/secondary/attributes"],["getPortalUser","get","/v2/portal/user"],["updatePortalUser","patch","/v2/portal/user",null,1],["deletePortalUser","delete","/v2/portal/user"],["updatePortalUserEmail","put","/v2/portal/user/update/email",null,1],["resendConfirmationEmail","post","/v2/portal/user/resend/confirmation-email/{id}",[["id","p",true]]],["fetchPortalUsersByRelatedEntity","get","/v2/portal/users/by-related-entity",[["entity_id","q",true],["slug","q",true]]],["confirmUser","get","/v2/portal/user/confirm",[["confirmation_link_token","q",true],["use_redirect","q"]]],["confirmUserWithUserId","get","/v2/portal/user/confirm/{id}",[["origin","q",true],["id","p",true],["org_id","q",true]]],["userExists","get","/v2/portal/public/user/exists",[["email","q",true],["org_id","q",true],["origin","q"]]],["userExistsV3","get","/v3/portal/public/user/exists",[["email","q",true],["org_id","q"],["portal_id","q"],["domain","q"]]],["getRecipientsToNotifyOnAutomation","post","/v2/portal/recipients-to-notify",null,1],["configureDistribution","get","/v2/portal/configure-distribution",[["origin","q",true]]],["configureDistributionV3","get","/v3/portal/configure-distribution",[["portal_id","q",true]]],["getAllOrders","get","/v2/portal/order",[["from","q"],["size","q"]]],["postOrderAcceptance","post","/v2/portal/order/{id}/acceptance",[["id","p",true]],1],["getOrder","get","/v2/portal/order/{id}",[["id","p",true]]],["updateOrder","patch","/v2/portal/order/{id}",[["id","p",true]],1],["getAllOpportunities","get","/v2/portal/opportunity",[["from","q"],["size","q"]]],["getSearchableAttributesForOpportunities","get","/v2/portal/opportunities/searchable-attributes",[["from","q"],["size","q"]]],["getSearchResultsForOpportunities","post","/v2/portal/opportunities/search",[["from","q"],["size","q"]],1],["getOpportunity","get","/v2/portal/opportunities/{id}",[["id","p",true]]],["updateOpportunity","patch","/v2/portal/opportunities/{id}",[["id","p",true]],1],["getAllRequests","get","/v2/portal/request",[["from","q"],["size","q"]]],["getAllContracts","get","/v2/portal/contract",[["from","q"],["size","q"]]],["getContract","get","/v2/portal/contract/{id}",[["id","p",true]]],["updateContract","patch","/v2/portal/contract/{id}",[["id","p",true]],1],["addContractByIdentifiers","post","/v2/portal/contract/by-identifiers",null,1],["getEntityIdentifiers","get","/v2/portal/entity/identifiers/{slug}",[["slug","p",true]]],["getEntityActivityFeed","get","/v2/portal/entity/{slug}/{id}/activity",[["slug","p",true],["id","p",true],["after","q"],["before","q"],["from","q"],["size","q"],["type","q"],["include_relations","q"]]],["validateCadenceEntityEditRules","get","/v2/portal/{slug}/{id}:validateRule",[["slug","p",true],["id","p",true],["attribute","q"]]],["searchPaymentRelationsInEntities","get","/v2/portal/entities-by-payment/{id}",[["id","p",true]]],["createCustomEntityActivity","put","/v2/portal/entity/activity",[["entities","q",false,"form"]],1],["saveEntityFile","post","/v2/portal/entity/file",null,1],["deleteEntityFile","delete","/v2/portal/entity/file",null,1],["savePortalFiles","post","/v2/portal/portal/files",null,1],["getRegistrationIdentifiers","get","/v2/portal/registration/identifiers"],["getAllFiles","get","/v2/portal/user/files",[["from","q",true],["size","q",true],["entity_ids","q"],["file_types","q"]]],["getFileById","get","/v2/portal/user/file/{id}",[["id","p",true]]],["trackFileDownloaded","post","/v2/portal/user/file/{id}/downloaded",[["id","p",true]]],["getFilesCountByEntity","get","/v2/portal/user/files/count-by-entity"],["getBillingEvents","get","/v2/portal/billing/events",[["from","q"],["size","q"],["entity_id","q"],["event_type","q"],["paid","q"],["date_after","q"],["date_before","q"],["sort","q"]]],["getCustomerBalance","get","/v2/portal/billing/customers/balance"],["getBillingAccount","get","/v2/portal/billing/accounts/{id}"],["loginToPortalAsUser","post","/v2/portal/admin:login-as-user",null,1],["triggerEntityAccessEvent","post","/v2/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["origin","q",true]]],["triggerEntityAccessEventV3","post","/v3/portal/entity/{schema}/access",[["schema","p",true],["entity_id","q"],["portal_id","q"],["domain","q"]]],["getPortalUserEntity","post","/v2/portal/entity:get",null,1],["searchPortalUserEntities","post","/v2/portal/entity:search",null,1],["canTriggerPortalFlow","post","/v2/portal/can-trigger-portal-flow",[["origin","q"],["portal_id","q",true]],1],["getAutomationContext","get","/v2/portal/automation-context",[["activity_id","q",true],["type","q",true]]],["updateWorkflowStepAsDone","put","/v2/portal/workflow/{workflow_id}/{step_id}:markDone",[["workflow_id","p",true],["step_id","p",true]]],["getEntityWorkflows","get","/v2/portal/entity/{slug}/{id}/workflows",[["slug","p",true],["id","p",true]]],["uploadMeterReadingPhoto","post","/v2/portal/metering/reading/photo",null,1],["createMeterReading","post","/v2/portal/metering/reading",[["override_plausibility","q"]],1],["getAllowedMeterReadingRange","get","/v2/portal/metering/reading/allowed-range/{meter_id}",[["meter_id","p",true],["origin","q"],["timestamp","q"],["context_entities","q"]]],["ssoLogin","post","/v2/portal/public/sso/login",[["origin","q",true],["org_id","q",true],["contact_id","q"]],1],["ssoLoginV3","post","/v3/portal/public/sso/login",[["portal_id","q"],["org_id","q"],["domain","q"],["contact_id","q"]],1],["ssoRedirect","post","/v2/portal/public/sso/redirect",[["web_uri","q",true]],1],["ssoCallback","post","/v2/portal/public/sso/callback",[["domain","q"]],1],["getPortalPage","get","/v2/portal/pages/{id}"],["updatePortalPage","put","/v2/portal/pages/{id}",null,1],["deletePortalPage","delete","/v2/portal/pages/{id}"],["getPortalPages","get","/v2/portal/pages",[["fields","q"],["filter","q"],["contract_id","q"],["context_entities","q"]]],["createPortalPage","post","/v2/portal/pages",null,1],["getPublicPages","get","/v2/portal/public/pages",[["domain","q",true],["fields","q"],["filter","q"]]],["interpolatePortalPages","post","/v2/portal/pages/interpolate",null,1],["getDefaultPages","get","/v2/portal/pages/default"],["createPortalPageBlock","post","/v2/portal/pages/{id}/blocks",null,1],["getPortalPageBlocks","get","/v2/portal/pages/{id}/blocks"],["getPortalPageBlock","get","/v2/portal/pages/{id}/blocks/{block_id}"],["updatePortalPageBlock","put","/v2/portal/pages/{id}/blocks/{block_id}",null,1],["deletePortalPageBlock","delete","/v2/portal/pages/{id}/blocks/{block_id}"],["getUserEntryPoint","get","/v2/portal/public/user/entry-point",[["email","q",true],["domain","q",true]]],["updateCampaignPortalBlockStatus","put","/v2/portal/campaign/{campaign_id}/entity:status",[["campaign_id","p",true]],1],["updateNotificationsStatus","put","/v2/portal/notifications/entity:status",null,1],["deRegisterMLoginUser","delete","/v2/portal/public/m-login/deregister/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]]],["notifyMLoginInterestChange","post","/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}",[["client_id","p",true],["user_id","p",true]],1],["createPortalConfig","post","/v3/portal/config",null,1],["getPortalConfigV3","get","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["putPortalConfig","put","/v3/portal/config/{portal_id}",[["portal_id","p",true]],1],["deletePortalConfig","delete","/v3/portal/config/{portal_id}",[["portal_id","p",true]]],["listAllPortalConfigs","get","/v3/portal/configs"],["swapPortalConfig","post","/v3/portal/config/swap",null,1],["invitePartner","post","/v3/portal/partner/invite",null,1],["listBusinessPartners","get","/v3/portal/partner/list"],["resendPartnerInvitation","post","/v3/portal/partner/{partner_id}/resend-invitation",[["partner_id","p",true]]],["revokePartner","delete","/v3/portal/partner/{partner_id}/revoke",[["partner_id","p",true]]],["disablePartner","post","/v3/portal/partner/{partner_id}/disable",[["partner_id","p",true]]],["enablePartner","post","/v3/portal/partner/{partner_id}/enable",[["partner_id","p",true]]]],"v":"3.0.3","pp":{"/v2/portal/billing/accounts/{id}":[["id","p",true]],"/v2/portal/pages/{id}":[["id","p",true]],"/v2/portal/pages":[["domain","q",true]],"/v2/portal/pages/{id}/blocks":[["id","p",true]],"/v2/portal/pages/{id}/blocks/{block_id}":[["id","p",true],["block_id","p",true]]}}
|
|
@@ -199,7 +199,7 @@
|
|
|
199
199
|
"post": {
|
|
200
200
|
"operationId": "createUserV3",
|
|
201
201
|
"summary": "createUserV3",
|
|
202
|
-
"description": "Registers a portal user
|
|
202
|
+
"description": "Registers a portal user.\nSupports two identification methods:\n1. Using portal_id\n2. Using domain\n",
|
|
203
203
|
"security": [],
|
|
204
204
|
"tags": [
|
|
205
205
|
"Public"
|
|
@@ -208,11 +208,20 @@
|
|
|
208
208
|
{
|
|
209
209
|
"in": "query",
|
|
210
210
|
"name": "portal_id",
|
|
211
|
-
"required":
|
|
211
|
+
"required": false,
|
|
212
212
|
"schema": {
|
|
213
213
|
"$ref": "#/components/schemas/PortalId"
|
|
214
214
|
},
|
|
215
|
-
"description": "
|
|
215
|
+
"description": "Portal ID (required if domain is not provided)"
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
"in": "query",
|
|
219
|
+
"name": "domain",
|
|
220
|
+
"required": false,
|
|
221
|
+
"schema": {
|
|
222
|
+
"type": "string"
|
|
223
|
+
},
|
|
224
|
+
"description": "Portal domain for identification (alternative to portal_id)"
|
|
216
225
|
}
|
|
217
226
|
],
|
|
218
227
|
"requestBody": {
|
|
@@ -2278,6 +2287,194 @@
|
|
|
2278
2287
|
}
|
|
2279
2288
|
}
|
|
2280
2289
|
},
|
|
2290
|
+
"/v3/portal/widgets": {
|
|
2291
|
+
"get": {
|
|
2292
|
+
"operationId": "getPortalWidgetsV3",
|
|
2293
|
+
"summary": "getPortalWidgetsV3",
|
|
2294
|
+
"description": "Retrieves the widgets of a portal by portal_id.",
|
|
2295
|
+
"tags": [
|
|
2296
|
+
"ECP Admin",
|
|
2297
|
+
"ECP"
|
|
2298
|
+
],
|
|
2299
|
+
"security": [
|
|
2300
|
+
{
|
|
2301
|
+
"EitherAuth": []
|
|
2302
|
+
}
|
|
2303
|
+
],
|
|
2304
|
+
"parameters": [
|
|
2305
|
+
{
|
|
2306
|
+
"in": "query",
|
|
2307
|
+
"name": "portal_id",
|
|
2308
|
+
"required": true,
|
|
2309
|
+
"schema": {
|
|
2310
|
+
"$ref": "#/components/schemas/PortalId"
|
|
2311
|
+
},
|
|
2312
|
+
"description": "PortalId of the portal"
|
|
2313
|
+
},
|
|
2314
|
+
{
|
|
2315
|
+
"in": "query",
|
|
2316
|
+
"name": "contract_id",
|
|
2317
|
+
"required": false,
|
|
2318
|
+
"schema": {
|
|
2319
|
+
"$ref": "#/components/schemas/EntityId"
|
|
2320
|
+
},
|
|
2321
|
+
"description": "Contract context for widgets"
|
|
2322
|
+
}
|
|
2323
|
+
],
|
|
2324
|
+
"responses": {
|
|
2325
|
+
"200": {
|
|
2326
|
+
"description": "Retrieved the portal widgets successfully.",
|
|
2327
|
+
"content": {
|
|
2328
|
+
"application/json": {
|
|
2329
|
+
"schema": {
|
|
2330
|
+
"$ref": "#/components/schemas/UpsertPortalWidget"
|
|
2331
|
+
}
|
|
2332
|
+
}
|
|
2333
|
+
}
|
|
2334
|
+
},
|
|
2335
|
+
"401": {
|
|
2336
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2337
|
+
},
|
|
2338
|
+
"403": {
|
|
2339
|
+
"$ref": "#/components/responses/Forbidden"
|
|
2340
|
+
},
|
|
2341
|
+
"500": {
|
|
2342
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2343
|
+
}
|
|
2344
|
+
}
|
|
2345
|
+
},
|
|
2346
|
+
"post": {
|
|
2347
|
+
"operationId": "upsertPortalWidgetV3",
|
|
2348
|
+
"summary": "upsertPortalWidgetV3",
|
|
2349
|
+
"description": "Upsert widget for a portal by portal_id.",
|
|
2350
|
+
"security": [
|
|
2351
|
+
{
|
|
2352
|
+
"EpilotAuth": []
|
|
2353
|
+
}
|
|
2354
|
+
],
|
|
2355
|
+
"tags": [
|
|
2356
|
+
"ECP Admin"
|
|
2357
|
+
],
|
|
2358
|
+
"parameters": [
|
|
2359
|
+
{
|
|
2360
|
+
"in": "query",
|
|
2361
|
+
"name": "portal_id",
|
|
2362
|
+
"required": true,
|
|
2363
|
+
"schema": {
|
|
2364
|
+
"$ref": "#/components/schemas/PortalId"
|
|
2365
|
+
},
|
|
2366
|
+
"description": "PortalId of the portal"
|
|
2367
|
+
}
|
|
2368
|
+
],
|
|
2369
|
+
"requestBody": {
|
|
2370
|
+
"description": "Portal widgets payload",
|
|
2371
|
+
"required": true,
|
|
2372
|
+
"content": {
|
|
2373
|
+
"application/json": {
|
|
2374
|
+
"schema": {
|
|
2375
|
+
"$ref": "#/components/schemas/UpsertPortalWidget"
|
|
2376
|
+
}
|
|
2377
|
+
}
|
|
2378
|
+
}
|
|
2379
|
+
},
|
|
2380
|
+
"responses": {
|
|
2381
|
+
"201": {
|
|
2382
|
+
"description": "Portal widget configuration upserted successfully.",
|
|
2383
|
+
"content": {
|
|
2384
|
+
"application/json": {
|
|
2385
|
+
"schema": {
|
|
2386
|
+
"$ref": "#/components/schemas/UpsertPortalWidget"
|
|
2387
|
+
}
|
|
2388
|
+
}
|
|
2389
|
+
}
|
|
2390
|
+
},
|
|
2391
|
+
"400": {
|
|
2392
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
2393
|
+
},
|
|
2394
|
+
"401": {
|
|
2395
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2396
|
+
},
|
|
2397
|
+
"403": {
|
|
2398
|
+
"$ref": "#/components/responses/Forbidden"
|
|
2399
|
+
},
|
|
2400
|
+
"500": {
|
|
2401
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2402
|
+
}
|
|
2403
|
+
}
|
|
2404
|
+
}
|
|
2405
|
+
},
|
|
2406
|
+
"/v3/portal/portal/files": {
|
|
2407
|
+
"post": {
|
|
2408
|
+
"operationId": "savePortalFilesV3",
|
|
2409
|
+
"summary": "savePortalFilesV3",
|
|
2410
|
+
"description": "Add files to portal by portal_id",
|
|
2411
|
+
"tags": [
|
|
2412
|
+
"ECP Admin"
|
|
2413
|
+
],
|
|
2414
|
+
"security": [
|
|
2415
|
+
{
|
|
2416
|
+
"EpilotAuth": []
|
|
2417
|
+
}
|
|
2418
|
+
],
|
|
2419
|
+
"parameters": [
|
|
2420
|
+
{
|
|
2421
|
+
"in": "query",
|
|
2422
|
+
"name": "portal_id",
|
|
2423
|
+
"required": true,
|
|
2424
|
+
"schema": {
|
|
2425
|
+
"$ref": "#/components/schemas/PortalId"
|
|
2426
|
+
},
|
|
2427
|
+
"description": "PortalId of the portal"
|
|
2428
|
+
}
|
|
2429
|
+
],
|
|
2430
|
+
"requestBody": {
|
|
2431
|
+
"description": "portal files request",
|
|
2432
|
+
"required": true,
|
|
2433
|
+
"content": {
|
|
2434
|
+
"application/json": {
|
|
2435
|
+
"schema": {
|
|
2436
|
+
"$ref": "#/components/schemas/SavePortalFile"
|
|
2437
|
+
}
|
|
2438
|
+
}
|
|
2439
|
+
}
|
|
2440
|
+
},
|
|
2441
|
+
"responses": {
|
|
2442
|
+
"201": {
|
|
2443
|
+
"description": "The files have been saved to the portal successfully.",
|
|
2444
|
+
"content": {
|
|
2445
|
+
"application/json": {
|
|
2446
|
+
"schema": {
|
|
2447
|
+
"type": "object",
|
|
2448
|
+
"properties": {
|
|
2449
|
+
"createdFiles": {
|
|
2450
|
+
"type": "array",
|
|
2451
|
+
"items": {
|
|
2452
|
+
"$ref": "#/components/schemas/File"
|
|
2453
|
+
}
|
|
2454
|
+
}
|
|
2455
|
+
}
|
|
2456
|
+
}
|
|
2457
|
+
}
|
|
2458
|
+
}
|
|
2459
|
+
},
|
|
2460
|
+
"400": {
|
|
2461
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
2462
|
+
},
|
|
2463
|
+
"401": {
|
|
2464
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2465
|
+
},
|
|
2466
|
+
"403": {
|
|
2467
|
+
"$ref": "#/components/responses/Forbidden"
|
|
2468
|
+
},
|
|
2469
|
+
"404": {
|
|
2470
|
+
"$ref": "#/components/responses/NotFound"
|
|
2471
|
+
},
|
|
2472
|
+
"500": {
|
|
2473
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2474
|
+
}
|
|
2475
|
+
}
|
|
2476
|
+
}
|
|
2477
|
+
},
|
|
2281
2478
|
"/v2/portal/replace-ecp-template-variables": {
|
|
2282
2479
|
"post": {
|
|
2283
2480
|
"operationId": "replaceECPTemplateVariables",
|
|
@@ -3001,7 +3198,7 @@
|
|
|
3001
3198
|
"post": {
|
|
3002
3199
|
"operationId": "checkContactExistsV3",
|
|
3003
3200
|
"summary": "checkContactExistsV3",
|
|
3004
|
-
"description": "True if contact with given identifiers exists.",
|
|
3201
|
+
"description": "True if contact with given identifiers exists.\nSupports two identification methods:\n1. Using portal_id\n2. Using domain\n",
|
|
3005
3202
|
"security": [],
|
|
3006
3203
|
"tags": [
|
|
3007
3204
|
"Public"
|
|
@@ -3010,11 +3207,20 @@
|
|
|
3010
3207
|
{
|
|
3011
3208
|
"in": "query",
|
|
3012
3209
|
"name": "portal_id",
|
|
3013
|
-
"required":
|
|
3210
|
+
"required": false,
|
|
3014
3211
|
"schema": {
|
|
3015
3212
|
"$ref": "#/components/schemas/PortalId"
|
|
3016
3213
|
},
|
|
3017
|
-
"description": "PortalId of the portal"
|
|
3214
|
+
"description": "PortalId of the portal (required if domain is not provided)"
|
|
3215
|
+
},
|
|
3216
|
+
{
|
|
3217
|
+
"in": "query",
|
|
3218
|
+
"name": "domain",
|
|
3219
|
+
"required": false,
|
|
3220
|
+
"schema": {
|
|
3221
|
+
"type": "string"
|
|
3222
|
+
},
|
|
3223
|
+
"description": "Portal domain for identification (alternative to portal_id)"
|
|
3018
3224
|
}
|
|
3019
3225
|
],
|
|
3020
3226
|
"requestBody": {
|
|
@@ -3617,7 +3823,7 @@
|
|
|
3617
3823
|
"get": {
|
|
3618
3824
|
"operationId": "userExistsV3",
|
|
3619
3825
|
"summary": "userExistsV3",
|
|
3620
|
-
"description": "Checks whether a user exists in the portal",
|
|
3826
|
+
"description": "Checks whether a user exists in the portal.\nSupports two identification methods:\n1. Using org_id + portal_id\n2. Using domain\n",
|
|
3621
3827
|
"tags": [
|
|
3622
3828
|
"Public"
|
|
3623
3829
|
],
|
|
@@ -3636,10 +3842,10 @@
|
|
|
3636
3842
|
{
|
|
3637
3843
|
"in": "query",
|
|
3638
3844
|
"name": "org_id",
|
|
3639
|
-
"required":
|
|
3845
|
+
"required": false,
|
|
3640
3846
|
"schema": {
|
|
3641
3847
|
"type": "string",
|
|
3642
|
-
"description": "Organization ID",
|
|
3848
|
+
"description": "Organization ID (required if domain is not provided)",
|
|
3643
3849
|
"example": 123
|
|
3644
3850
|
}
|
|
3645
3851
|
},
|
|
@@ -3647,10 +3853,19 @@
|
|
|
3647
3853
|
"in": "query",
|
|
3648
3854
|
"name": "portal_id",
|
|
3649
3855
|
"required": false,
|
|
3650
|
-
"description": "
|
|
3856
|
+
"description": "Checks if user exists in the given portal ID. If not provided, checks in all portals.",
|
|
3651
3857
|
"schema": {
|
|
3652
3858
|
"$ref": "#/components/schemas/PortalId"
|
|
3653
3859
|
}
|
|
3860
|
+
},
|
|
3861
|
+
{
|
|
3862
|
+
"in": "query",
|
|
3863
|
+
"name": "domain",
|
|
3864
|
+
"required": false,
|
|
3865
|
+
"schema": {
|
|
3866
|
+
"type": "string"
|
|
3867
|
+
},
|
|
3868
|
+
"description": "Portal domain for identification (alternative to org_id + portal_id)"
|
|
3654
3869
|
}
|
|
3655
3870
|
],
|
|
3656
3871
|
"responses": {
|
|
@@ -6119,7 +6334,7 @@
|
|
|
6119
6334
|
"post": {
|
|
6120
6335
|
"operationId": "loginToPortalAsUser",
|
|
6121
6336
|
"summary": "loginToPortalAsUser",
|
|
6122
|
-
"description": "Generate a token to log in to a portal impersonating a users.\n\nToken is valid for 5 minutes.\n",
|
|
6337
|
+
"description": "Generate a token to log in to a portal impersonating a users.\n\nToken is valid for 5 minutes.\n\nSupports three identification methods (at least one required):\n1. Using portal_id (takes precedence)\n2. Using domain\n3. Using origin (legacy)\n",
|
|
6123
6338
|
"tags": [
|
|
6124
6339
|
"ECP Admin"
|
|
6125
6340
|
],
|
|
@@ -6147,6 +6362,10 @@
|
|
|
6147
6362
|
"portal_id": {
|
|
6148
6363
|
"type": "string",
|
|
6149
6364
|
"description": "The portal ID to look up the portal config. When provided, takes precedence over origin."
|
|
6365
|
+
},
|
|
6366
|
+
"domain": {
|
|
6367
|
+
"type": "string",
|
|
6368
|
+
"description": "Portal domain for identification. Alternative to portal_id or origin."
|
|
6150
6369
|
}
|
|
6151
6370
|
}
|
|
6152
6371
|
}
|
|
@@ -6241,7 +6460,7 @@
|
|
|
6241
6460
|
"post": {
|
|
6242
6461
|
"operationId": "triggerEntityAccessEventV3",
|
|
6243
6462
|
"summary": "triggerEntityAccessEventV3",
|
|
6244
|
-
"description": "Trigger entity access event for a portal user",
|
|
6463
|
+
"description": "Trigger entity access event for a portal user.\nSupports two identification methods:\n1. Using portal_id\n2. Using domain\n",
|
|
6245
6464
|
"tags": [
|
|
6246
6465
|
"ECP"
|
|
6247
6466
|
],
|
|
@@ -6273,11 +6492,20 @@
|
|
|
6273
6492
|
{
|
|
6274
6493
|
"name": "portal_id",
|
|
6275
6494
|
"in": "query",
|
|
6276
|
-
"required":
|
|
6277
|
-
"description": "Portal ID",
|
|
6495
|
+
"required": false,
|
|
6496
|
+
"description": "Portal ID (required if domain is not provided)",
|
|
6278
6497
|
"schema": {
|
|
6279
6498
|
"$ref": "#/components/schemas/PortalId"
|
|
6280
6499
|
}
|
|
6500
|
+
},
|
|
6501
|
+
{
|
|
6502
|
+
"name": "domain",
|
|
6503
|
+
"in": "query",
|
|
6504
|
+
"required": false,
|
|
6505
|
+
"description": "Portal domain for identification (alternative to portal_id)",
|
|
6506
|
+
"schema": {
|
|
6507
|
+
"type": "string"
|
|
6508
|
+
}
|
|
6281
6509
|
}
|
|
6282
6510
|
],
|
|
6283
6511
|
"responses": {
|
|
@@ -6957,7 +7185,7 @@
|
|
|
6957
7185
|
"post": {
|
|
6958
7186
|
"operationId": "ssoLoginV3",
|
|
6959
7187
|
"summary": "ssoLoginV3",
|
|
6960
|
-
"description": "Initiate login using external SSO identity.\n\nVerifies the user with the issuer and matches the identity to an epilot user (or creates a new user).\n\nReturns parameters to be used with CUSTOM_AUTH flow against Cognito\n",
|
|
7188
|
+
"description": "Initiate login using external SSO identity.\n\nVerifies the user with the issuer and matches the identity to an epilot user (or creates a new user).\n\nReturns parameters to be used with CUSTOM_AUTH flow against Cognito.\n\nSupports two identification methods:\n1. Using org_id + portal_id\n2. Using domain\n",
|
|
6961
7189
|
"security": [
|
|
6962
7190
|
{
|
|
6963
7191
|
"ExternalOIDCAuth": []
|
|
@@ -6967,8 +7195,8 @@
|
|
|
6967
7195
|
{
|
|
6968
7196
|
"in": "query",
|
|
6969
7197
|
"name": "portal_id",
|
|
6970
|
-
"required":
|
|
6971
|
-
"description": "ID of the Portal",
|
|
7198
|
+
"required": false,
|
|
7199
|
+
"description": "ID of the Portal (required if domain is not provided)",
|
|
6972
7200
|
"schema": {
|
|
6973
7201
|
"$ref": "#/components/schemas/PortalId"
|
|
6974
7202
|
}
|
|
@@ -6976,13 +7204,22 @@
|
|
|
6976
7204
|
{
|
|
6977
7205
|
"in": "query",
|
|
6978
7206
|
"name": "org_id",
|
|
6979
|
-
"description": "epilot organization id",
|
|
6980
|
-
"required":
|
|
7207
|
+
"description": "epilot organization id (required if domain is not provided)",
|
|
7208
|
+
"required": false,
|
|
6981
7209
|
"schema": {
|
|
6982
7210
|
"type": "string",
|
|
6983
7211
|
"example": 123
|
|
6984
7212
|
}
|
|
6985
7213
|
},
|
|
7214
|
+
{
|
|
7215
|
+
"in": "query",
|
|
7216
|
+
"name": "domain",
|
|
7217
|
+
"description": "Portal domain for identification (alternative to org_id + portal_id)",
|
|
7218
|
+
"required": false,
|
|
7219
|
+
"schema": {
|
|
7220
|
+
"type": "string"
|
|
7221
|
+
}
|
|
7222
|
+
},
|
|
6986
7223
|
{
|
|
6987
7224
|
"in": "query",
|
|
6988
7225
|
"name": "contact_id",
|
|
@@ -14786,6 +15023,11 @@
|
|
|
14786
15023
|
"format": "date-time",
|
|
14787
15024
|
"description": "Last modified timestamp of the Page",
|
|
14788
15025
|
"example": "2021-02-09T12:41:43.662Z"
|
|
15026
|
+
},
|
|
15027
|
+
"portal_id": {
|
|
15028
|
+
"type": "string",
|
|
15029
|
+
"description": "The id of the portal",
|
|
15030
|
+
"example": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
|
|
14789
15031
|
}
|
|
14790
15032
|
}
|
|
14791
15033
|
}
|
package/definitions/journey.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Journey API",
|
|
5
5
|
"description": "API to configure journeys",
|
|
6
|
-
"version": "1.4.
|
|
6
|
+
"version": "1.4.1"
|
|
7
7
|
},
|
|
8
8
|
"security": [
|
|
9
9
|
{
|
|
@@ -1290,6 +1290,10 @@
|
|
|
1290
1290
|
"description": "Journey Template",
|
|
1291
1291
|
"example": "Sales template (Premium)"
|
|
1292
1292
|
},
|
|
1293
|
+
"protected": {
|
|
1294
|
+
"type": "boolean",
|
|
1295
|
+
"description": "If true, journey is displayed in read-only mode"
|
|
1296
|
+
},
|
|
1293
1297
|
"settings": {
|
|
1294
1298
|
"type": "object",
|
|
1295
1299
|
"properties": {
|
|
@@ -1489,6 +1493,15 @@
|
|
|
1489
1493
|
"validationRules": {
|
|
1490
1494
|
"$ref": "#/components/schemas/ValidationRuleRef"
|
|
1491
1495
|
},
|
|
1496
|
+
"_manifest": {
|
|
1497
|
+
"type": "array",
|
|
1498
|
+
"description": "Manifest/Blueprint ID used to create/update the entity",
|
|
1499
|
+
"items": {
|
|
1500
|
+
"type": "string",
|
|
1501
|
+
"format": "uuid",
|
|
1502
|
+
"example": "123e4567-e89b-12d3-a456-426614174000"
|
|
1503
|
+
}
|
|
1504
|
+
},
|
|
1492
1505
|
"createdBy": {
|
|
1493
1506
|
"type": "string"
|
|
1494
1507
|
},
|
|
@@ -1797,6 +1810,10 @@
|
|
|
1797
1810
|
"description": "Journey Template",
|
|
1798
1811
|
"example": "Sales template (Premium)"
|
|
1799
1812
|
},
|
|
1813
|
+
"protected": {
|
|
1814
|
+
"type": "boolean",
|
|
1815
|
+
"description": "If true, journey is displayed in read-only mode"
|
|
1816
|
+
},
|
|
1800
1817
|
"settings": {
|
|
1801
1818
|
"type": "object",
|
|
1802
1819
|
"properties": {
|
|
@@ -6,25 +6,25 @@ var _chunkOXJOO2YFcjs = require('../chunk-OXJOO2YF.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunk6TKKEGYUcjs = require('../chunk-6TKKEGYU.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/access-token.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkOXJOO2YFcjs.require_access_token_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunk6TKKEGYUcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunk6TKKEGYUcjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunk6TKKEGYUcjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunk6TKKEGYUcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
|
|
28
28
|
apiName: "accessToken"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var accessToken = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.accessToken = accessToken; exports.authorize =
|
|
38
|
+
exports.accessToken = accessToken; exports.authorize = _chunk6TKKEGYUcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|
|
@@ -6,25 +6,25 @@ var _chunkLKRBFBFNcjs = require('../chunk-LKRBFBFN.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunk6TKKEGYUcjs = require('../chunk-6TKKEGYU.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/address-suggestions.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkLKRBFBFNcjs.require_address_suggestions_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunk6TKKEGYUcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunk6TKKEGYUcjs.createApiClient.call(void 0, { definition: def, apiName: "addressSuggestions" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunk6TKKEGYUcjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunk6TKKEGYUcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "addressSuggestions" }),
|
|
28
28
|
apiName: "addressSuggestions"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var addressSuggestions = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.addressSuggestions = addressSuggestions; exports.authorize =
|
|
38
|
+
exports.addressSuggestions = addressSuggestions; exports.authorize = _chunk6TKKEGYUcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|