@epilot/sdk 2.7.3 → 2.7.5
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 +317 -26
- package/definitions/pricing.json +43 -2
- 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/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.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-governance.cjs +6 -6
- package/dist/apis/data-governance.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/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/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- 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/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.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-KJPOUJBU.cjs → chunk-5ZXGKLB6.cjs} +1 -1
- package/dist/{chunk-PTEJYAYJ.js → chunk-774ASAAH.js} +1 -1
- package/dist/{chunk-2FJMQLXE.js → chunk-JFMD3PPY.js} +2 -2
- package/dist/{chunk-QNMDISUR.cjs → chunk-QZON5VFY.cjs} +2 -2
- package/dist/customer-portal-4DXHY42V.js +7 -0
- package/dist/customer-portal-5OSGSYGF.cjs +7 -0
- package/dist/{customer-portal-runtime-IYHJ3RME.cjs → customer-portal-runtime-HA6CPWB4.cjs} +2 -2
- package/dist/{customer-portal-runtime-ZYU3WIXY.js → customer-portal-runtime-TDHV2YVY.js} +1 -1
- package/dist/{customer-portal.d-CTTCBAZI.d.cts → customer-portal.d-BRwiQehb.d.cts} +763 -31
- package/dist/{customer-portal.d-CTTCBAZI.d.ts → customer-portal.d-BRwiQehb.d.ts} +763 -31
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/docs/customer-portal.md +463 -54
- package/package.json +1 -1
- package/dist/customer-portal-IBM3K2EZ.cjs +0 -7
- package/dist/customer-portal-XPYKMIIA.js +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"],["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"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["prepareVisualizationExport","post","/v2/portal/visualization:export",null,1],["getVisualizationMetadata","get","/v2/portal/visualization/metadata",[["app_id","q",true],["extensionId","q",true],["context_entities","q"]]],["getCosts","get","/v2/portal/costs",[["app_id","q"],["extensionId","q",true],["hookId","q"],["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"],["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]]],["getPublicPortalWidgetsV3","get","/v3/portal/public/widgets",[["org_id","q"],["portal_id","q"],["domain","q"]]],["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]]],["getPublicSchemasV3","get","/v3/portal/public/schemas",[["org_id","q"],["portal_id","q"],["domain","q"]]],["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],["checkAccountExists","post","/v3/portal/public/account/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"]]],["getMeterReadings","post","/v2/portal/metering/readings",null,1],["getSSOProvider","get","/v2/portal/public/sso/providers/{provider_slug}",[["provider_slug","p",true],["org_id","q"],["origin","q"],["portal_id","q"],["domain","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],["clonePortalConfig","post","/v3/portal/config/clone",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]]],["verifyDns","post","/v3/portal/verify-dns",[["portal_id","q",true]]],["portalProxyExecute","post","/v2/portal/proxy/execute",null,1]],"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"],["meter_id","q"],["from","q",true],["to","q",true],["interval","q",true],["context_entities","q"]]],["prepareVisualizationExport","post","/v2/portal/visualization:export",null,1],["getVisualizationMetadata","get","/v2/portal/visualization/metadata",[["app_id","q",true],["extensionId","q",true],["context_entities","q"]]],["getCosts","get","/v2/portal/costs",[["app_id","q"],["extensionId","q",true],["hookId","q"],["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"],["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]]],["getPublicPortalWidgetsV3","get","/v3/portal/public/widgets",[["org_id","q"],["portal_id","q"],["domain","q"]]],["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]]],["getPublicSchemasV3","get","/v3/portal/public/schemas",[["org_id","q"],["portal_id","q"],["domain","q"]]],["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],["checkAccountExists","post","/v3/portal/public/account/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"]]],["getMeterReadings","post","/v2/portal/metering/readings",null,1],["getSSOProvider","get","/v2/portal/public/sso/providers/{provider_slug}",[["provider_slug","p",true],["org_id","q"],["origin","q"],["portal_id","q"],["domain","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],["getTriggeredJourney","get","/v2/portal/config/triggered-journeys/{trigger_name}",[["context_entities","q"]]],["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],["clonePortalConfig","post","/v3/portal/config/clone",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]]],["verifyDns","post","/v3/portal/verify-dns",[["portal_id","q",true]]],["portalProxyExecute","post","/v2/portal/proxy/execute",null,1]],"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/config/triggered-journeys/{trigger_name}":[["trigger_name","p",true]],"/v2/portal/pages/{id}/blocks":[["id","p",true]],"/v2/portal/pages/{id}/blocks/{block_id}":[["id","p",true],["block_id","p",true]]}}
|
|
@@ -8395,6 +8395,96 @@
|
|
|
8395
8395
|
}
|
|
8396
8396
|
}
|
|
8397
8397
|
},
|
|
8398
|
+
"/v2/portal/config/triggered-journeys/{trigger_name}": {
|
|
8399
|
+
"parameters": [
|
|
8400
|
+
{
|
|
8401
|
+
"in": "path",
|
|
8402
|
+
"name": "trigger_name",
|
|
8403
|
+
"required": true,
|
|
8404
|
+
"schema": {
|
|
8405
|
+
"type": "string",
|
|
8406
|
+
"enum": [
|
|
8407
|
+
"FIRST_LOGIN",
|
|
8408
|
+
"ACCEPT_ORDER",
|
|
8409
|
+
"DECLINE_ORDER"
|
|
8410
|
+
]
|
|
8411
|
+
},
|
|
8412
|
+
"description": "The trigger event for the auto-triggered journey"
|
|
8413
|
+
}
|
|
8414
|
+
],
|
|
8415
|
+
"get": {
|
|
8416
|
+
"operationId": "getTriggeredJourney",
|
|
8417
|
+
"summary": "getTriggeredJourney",
|
|
8418
|
+
"description": "Returns the auto-triggered journey configured for the given trigger\nwith handlebars templates in `context_params` already resolved.\nUses the caller's auth context (contact, portal user) plus any\n`context_entities` supplied at trigger time (e.g. the order being\naccepted) — same resolver as `getPortalPages`.\n",
|
|
8419
|
+
"tags": [
|
|
8420
|
+
"ECP"
|
|
8421
|
+
],
|
|
8422
|
+
"security": [
|
|
8423
|
+
{
|
|
8424
|
+
"PortalAuth": []
|
|
8425
|
+
}
|
|
8426
|
+
],
|
|
8427
|
+
"parameters": [
|
|
8428
|
+
{
|
|
8429
|
+
"in": "query",
|
|
8430
|
+
"name": "context_entities",
|
|
8431
|
+
"required": false,
|
|
8432
|
+
"description": "Additional entities to include in the resolution context (e.g. the order being accepted at trigger time). Portal User and Contact entities are automatically part of the context.",
|
|
8433
|
+
"schema": {
|
|
8434
|
+
"$ref": "#/components/schemas/ContextEntities"
|
|
8435
|
+
}
|
|
8436
|
+
}
|
|
8437
|
+
],
|
|
8438
|
+
"responses": {
|
|
8439
|
+
"200": {
|
|
8440
|
+
"description": "The triggered journey has been resolved successfully.",
|
|
8441
|
+
"content": {
|
|
8442
|
+
"application/json": {
|
|
8443
|
+
"schema": {
|
|
8444
|
+
"type": "object",
|
|
8445
|
+
"properties": {
|
|
8446
|
+
"trigger_name": {
|
|
8447
|
+
"type": "string",
|
|
8448
|
+
"enum": [
|
|
8449
|
+
"FIRST_LOGIN",
|
|
8450
|
+
"ACCEPT_ORDER",
|
|
8451
|
+
"DECLINE_ORDER"
|
|
8452
|
+
]
|
|
8453
|
+
},
|
|
8454
|
+
"journey_id": {
|
|
8455
|
+
"$ref": "#/components/schemas/EntityId"
|
|
8456
|
+
},
|
|
8457
|
+
"context_params": {
|
|
8458
|
+
"type": "array",
|
|
8459
|
+
"items": {
|
|
8460
|
+
"type": "object",
|
|
8461
|
+
"properties": {
|
|
8462
|
+
"key": {
|
|
8463
|
+
"type": "string"
|
|
8464
|
+
},
|
|
8465
|
+
"value": {
|
|
8466
|
+
"type": "string"
|
|
8467
|
+
}
|
|
8468
|
+
}
|
|
8469
|
+
}
|
|
8470
|
+
}
|
|
8471
|
+
}
|
|
8472
|
+
}
|
|
8473
|
+
}
|
|
8474
|
+
}
|
|
8475
|
+
},
|
|
8476
|
+
"401": {
|
|
8477
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
8478
|
+
},
|
|
8479
|
+
"404": {
|
|
8480
|
+
"$ref": "#/components/responses/NotFound"
|
|
8481
|
+
},
|
|
8482
|
+
"500": {
|
|
8483
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
8484
|
+
}
|
|
8485
|
+
}
|
|
8486
|
+
}
|
|
8487
|
+
},
|
|
8398
8488
|
"/v2/portal/pages/default": {
|
|
8399
8489
|
"get": {
|
|
8400
8490
|
"operationId": "getDefaultPages",
|
|
@@ -10734,9 +10824,6 @@
|
|
|
10734
10824
|
},
|
|
10735
10825
|
"CommonConfigAttributes": {
|
|
10736
10826
|
"type": "object",
|
|
10737
|
-
"required": [
|
|
10738
|
-
"domain"
|
|
10739
|
-
],
|
|
10740
10827
|
"properties": {
|
|
10741
10828
|
"enabled": {
|
|
10742
10829
|
"type": "boolean",
|
|
@@ -10792,14 +10879,19 @@
|
|
|
10792
10879
|
},
|
|
10793
10880
|
"self_registration_account_setting": {
|
|
10794
10881
|
"type": "string",
|
|
10795
|
-
"description": "Controls behavior of self-registration when account is
|
|
10882
|
+
"description": "Controls behavior of self-registration when account is the registration\nentity. `BLOCK_IF_PORTAL_USER_EXISTS` matches an existing account and\nrejects the request when any portal user is already linked to that\naccount (no creation). Blocking can also be enabled on the other\nnon-create modes via `block_registration_if_portal_user_exists`.\n",
|
|
10796
10883
|
"enum": [
|
|
10797
|
-
"
|
|
10884
|
+
"ALLOW_WITH_CREATION",
|
|
10798
10885
|
"DENY",
|
|
10799
|
-
"
|
|
10886
|
+
"ALWAYS_CREATE",
|
|
10887
|
+
"BLOCK_IF_PORTAL_USER_EXISTS",
|
|
10800
10888
|
"DISALLOW_COMPLETELY"
|
|
10801
10889
|
]
|
|
10802
10890
|
},
|
|
10891
|
+
"block_registration_if_portal_user_exists": {
|
|
10892
|
+
"type": "boolean",
|
|
10893
|
+
"description": "Account-mode only. Reject registration when the resolved account already\nhas any portal user (any portal user whose mapped contact is linked to\nthe account).\n"
|
|
10894
|
+
},
|
|
10803
10895
|
"self_registration_entity": {
|
|
10804
10896
|
"type": "string",
|
|
10805
10897
|
"description": "Entity type used as the primary identifier for self-registration",
|
|
@@ -11116,6 +11208,40 @@
|
|
|
11116
11208
|
}
|
|
11117
11209
|
]
|
|
11118
11210
|
},
|
|
11211
|
+
"contact_identifiers_for_account": {
|
|
11212
|
+
"type": "array",
|
|
11213
|
+
"description": "Account-mode only. Identifiers on the contact entity of the primarily\nidentified account. Used to pick an existing related contact within the\nresolved account; if none matches, the values are written onto the new\ncontact that is created and linked to the account.\n",
|
|
11214
|
+
"items": {
|
|
11215
|
+
"$ref": "#/components/schemas/RegistrationIdentifier"
|
|
11216
|
+
},
|
|
11217
|
+
"example": [
|
|
11218
|
+
{
|
|
11219
|
+
"name": "first_name",
|
|
11220
|
+
"schema": "contact"
|
|
11221
|
+
},
|
|
11222
|
+
{
|
|
11223
|
+
"name": "last_name",
|
|
11224
|
+
"schema": "contact"
|
|
11225
|
+
}
|
|
11226
|
+
]
|
|
11227
|
+
},
|
|
11228
|
+
"additional_contact_attributes": {
|
|
11229
|
+
"type": "array",
|
|
11230
|
+
"description": "Contact attributes collected from the user during self-registration that are\nwritten onto the newly created contact but are not used to identify an\nexisting one.\n",
|
|
11231
|
+
"items": {
|
|
11232
|
+
"$ref": "#/components/schemas/AdditionalContactAttribute"
|
|
11233
|
+
},
|
|
11234
|
+
"example": [
|
|
11235
|
+
{
|
|
11236
|
+
"name": "first_name",
|
|
11237
|
+
"required": true
|
|
11238
|
+
},
|
|
11239
|
+
{
|
|
11240
|
+
"name": "last_name",
|
|
11241
|
+
"required": true
|
|
11242
|
+
}
|
|
11243
|
+
]
|
|
11244
|
+
},
|
|
11119
11245
|
"triggered_journeys": {
|
|
11120
11246
|
"type": "array",
|
|
11121
11247
|
"description": "Journeys automatically opened on a portal user action",
|
|
@@ -11132,6 +11258,21 @@
|
|
|
11132
11258
|
},
|
|
11133
11259
|
"journey_id": {
|
|
11134
11260
|
"$ref": "#/components/schemas/EntityId"
|
|
11261
|
+
},
|
|
11262
|
+
"context_params": {
|
|
11263
|
+
"type": "array",
|
|
11264
|
+
"description": "Context parameters forwarded to the journey when it is\nauto-triggered. Values may contain handlebars templates\nthat reference the available context (e.g.\n`{{contact._id}}`, `{{portal_user.email}}`,\n`{{order._id}}`) — these are resolved at trigger time by\n`GET /v2/portal/config/triggered-journeys/{trigger_name}`\nusing the caller's auth context plus runtime entities\nsupplied via the `context_entities` query param.\n",
|
|
11265
|
+
"items": {
|
|
11266
|
+
"type": "object",
|
|
11267
|
+
"properties": {
|
|
11268
|
+
"key": {
|
|
11269
|
+
"type": "string"
|
|
11270
|
+
},
|
|
11271
|
+
"value": {
|
|
11272
|
+
"type": "string"
|
|
11273
|
+
}
|
|
11274
|
+
}
|
|
11275
|
+
}
|
|
11135
11276
|
}
|
|
11136
11277
|
}
|
|
11137
11278
|
}
|
|
@@ -11243,9 +11384,6 @@
|
|
|
11243
11384
|
}
|
|
11244
11385
|
},
|
|
11245
11386
|
"UpsertPortalConfig": {
|
|
11246
|
-
"required": [
|
|
11247
|
-
"domain"
|
|
11248
|
-
],
|
|
11249
11387
|
"allOf": [
|
|
11250
11388
|
{
|
|
11251
11389
|
"$ref": "#/components/schemas/UpdateOnlyPortalConfigAttributes"
|
|
@@ -11823,6 +11961,28 @@
|
|
|
11823
11961
|
}
|
|
11824
11962
|
}
|
|
11825
11963
|
},
|
|
11964
|
+
"contact_identifiers_for_account": {
|
|
11965
|
+
"type": "object",
|
|
11966
|
+
"description": "Account-mode only. Values for the contact identifiers configured\nunder `contact_identifiers_for_account` on the portal. Used to\nfind an existing related contact within the resolved account, or\nwritten onto the new contact if none matches.\n",
|
|
11967
|
+
"additionalProperties": {
|
|
11968
|
+
"type": "string"
|
|
11969
|
+
},
|
|
11970
|
+
"example": {
|
|
11971
|
+
"first_name": "John",
|
|
11972
|
+
"last_name": "Doe"
|
|
11973
|
+
}
|
|
11974
|
+
},
|
|
11975
|
+
"additional_contact_attributes": {
|
|
11976
|
+
"type": "object",
|
|
11977
|
+
"description": "Values for the contact attributes configured under\n`additional_contact_attributes` on the portal. These are written\nonto the newly created contact but are not used to identify an\nexisting one.\n",
|
|
11978
|
+
"additionalProperties": {
|
|
11979
|
+
"type": "string"
|
|
11980
|
+
},
|
|
11981
|
+
"example": {
|
|
11982
|
+
"first_name": "John",
|
|
11983
|
+
"last_name": "Doe"
|
|
11984
|
+
}
|
|
11985
|
+
},
|
|
11826
11986
|
"account_id": {
|
|
11827
11987
|
"type": "string",
|
|
11828
11988
|
"description": "ID of the account"
|
|
@@ -13936,6 +14096,24 @@
|
|
|
13936
14096
|
}
|
|
13937
14097
|
}
|
|
13938
14098
|
},
|
|
14099
|
+
"AdditionalContactAttribute": {
|
|
14100
|
+
"type": "object",
|
|
14101
|
+
"description": "A contact attribute that is collected from the user during self-registration\nand written onto the newly created contact, but is NOT used to identify\nan existing contact.\n",
|
|
14102
|
+
"required": [
|
|
14103
|
+
"name"
|
|
14104
|
+
],
|
|
14105
|
+
"properties": {
|
|
14106
|
+
"name": {
|
|
14107
|
+
"type": "string",
|
|
14108
|
+
"description": "Name of the contact attribute"
|
|
14109
|
+
},
|
|
14110
|
+
"required": {
|
|
14111
|
+
"type": "boolean",
|
|
14112
|
+
"description": "Whether the user must provide a value for this attribute",
|
|
14113
|
+
"default": false
|
|
14114
|
+
}
|
|
14115
|
+
}
|
|
14116
|
+
},
|
|
13939
14117
|
"ContractIdentifier": {
|
|
13940
14118
|
"type": "object",
|
|
13941
14119
|
"properties": {
|
|
@@ -14083,6 +14261,9 @@
|
|
|
14083
14261
|
"contractIdentification": {
|
|
14084
14262
|
"type": "object",
|
|
14085
14263
|
"properties": {
|
|
14264
|
+
"app": {
|
|
14265
|
+
"$ref": "#/components/schemas/PublicAppDetails"
|
|
14266
|
+
},
|
|
14086
14267
|
"extension": {
|
|
14087
14268
|
"$ref": "#/components/schemas/PublicExtensionDetails"
|
|
14088
14269
|
},
|
|
@@ -14661,7 +14842,8 @@
|
|
|
14661
14842
|
},
|
|
14662
14843
|
"result": {
|
|
14663
14844
|
"type": "string",
|
|
14664
|
-
"
|
|
14845
|
+
"deprecated": true,
|
|
14846
|
+
"description": "Deprecated. Use `resolved.result` instead. Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
|
|
14665
14847
|
}
|
|
14666
14848
|
},
|
|
14667
14849
|
"required": [
|
|
@@ -14669,6 +14851,20 @@
|
|
|
14669
14851
|
"headers"
|
|
14670
14852
|
]
|
|
14671
14853
|
},
|
|
14854
|
+
"resolved": {
|
|
14855
|
+
"type": "object",
|
|
14856
|
+
"properties": {
|
|
14857
|
+
"result": {
|
|
14858
|
+
"type": "string",
|
|
14859
|
+
"description": "Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation. Supersedes the deprecated `call.result`."
|
|
14860
|
+
},
|
|
14861
|
+
"error_message_path": {
|
|
14862
|
+
"type": "string",
|
|
14863
|
+
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
14864
|
+
"example": "error.message"
|
|
14865
|
+
}
|
|
14866
|
+
}
|
|
14867
|
+
},
|
|
14672
14868
|
"use_static_ips": {
|
|
14673
14869
|
"type": "boolean",
|
|
14674
14870
|
"deprecated": true,
|
|
@@ -14731,7 +14927,8 @@
|
|
|
14731
14927
|
},
|
|
14732
14928
|
"result": {
|
|
14733
14929
|
"type": "string",
|
|
14734
|
-
"
|
|
14930
|
+
"deprecated": true,
|
|
14931
|
+
"description": "Deprecated. Use `resolved.result` instead. Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
|
|
14735
14932
|
}
|
|
14736
14933
|
},
|
|
14737
14934
|
"required": [
|
|
@@ -14739,6 +14936,20 @@
|
|
|
14739
14936
|
"headers"
|
|
14740
14937
|
]
|
|
14741
14938
|
},
|
|
14939
|
+
"resolved": {
|
|
14940
|
+
"type": "object",
|
|
14941
|
+
"properties": {
|
|
14942
|
+
"result": {
|
|
14943
|
+
"type": "string",
|
|
14944
|
+
"description": "Contract or Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation. Supersedes the deprecated `call.result`."
|
|
14945
|
+
},
|
|
14946
|
+
"error_message_path": {
|
|
14947
|
+
"type": "string",
|
|
14948
|
+
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
14949
|
+
"example": "error.message"
|
|
14950
|
+
}
|
|
14951
|
+
}
|
|
14952
|
+
},
|
|
14742
14953
|
"assignment_mode": {
|
|
14743
14954
|
"type": "string",
|
|
14744
14955
|
"enum": [
|
|
@@ -14843,11 +15054,16 @@
|
|
|
14843
15054
|
"type": "object",
|
|
14844
15055
|
"description": "Response to the call",
|
|
14845
15056
|
"properties": {
|
|
14846
|
-
"
|
|
15057
|
+
"data_path": {
|
|
14847
15058
|
"type": "string",
|
|
14848
15059
|
"description": "Optional path to an array in the response. If specified and the path points to an array,\nthe hook will map over each item using 'Item' variable for interpolation.\nRelevant only if plausibility_mode is \"range\".\n",
|
|
14849
15060
|
"example": "data.results"
|
|
14850
15061
|
},
|
|
15062
|
+
"dataPath": {
|
|
15063
|
+
"type": "string",
|
|
15064
|
+
"deprecated": true,
|
|
15065
|
+
"description": "Deprecated. Use `data_path` instead."
|
|
15066
|
+
},
|
|
14851
15067
|
"counter_identifiers": {
|
|
14852
15068
|
"description": "Counter identifier(s) used to match against the meter's counters.\nCan be a string (counter ID) or an object with counter properties.\nThe backend resolves this to meter_counter_id in the final response.\nRelevant only if plausibility_mode is \"range\".\n",
|
|
14853
15069
|
"oneOf": [
|
|
@@ -14881,7 +15097,7 @@
|
|
|
14881
15097
|
"description": "Lower allowed limit of the meter reading",
|
|
14882
15098
|
"example": "{{CallResponse.data.lower_limit}}"
|
|
14883
15099
|
},
|
|
14884
|
-
"
|
|
15100
|
+
"error_message_path": {
|
|
14885
15101
|
"type": "string",
|
|
14886
15102
|
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
14887
15103
|
"example": "error.message"
|
|
@@ -14961,11 +15177,16 @@
|
|
|
14961
15177
|
"resolved": {
|
|
14962
15178
|
"type": "object",
|
|
14963
15179
|
"properties": {
|
|
14964
|
-
"
|
|
15180
|
+
"data_path": {
|
|
14965
15181
|
"type": "string",
|
|
14966
15182
|
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
14967
15183
|
},
|
|
14968
|
-
"
|
|
15184
|
+
"dataPath": {
|
|
15185
|
+
"type": "string",
|
|
15186
|
+
"deprecated": true,
|
|
15187
|
+
"description": "Deprecated. Use `data_path` instead."
|
|
15188
|
+
},
|
|
15189
|
+
"error_message_path": {
|
|
14969
15190
|
"type": "string",
|
|
14970
15191
|
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
14971
15192
|
"example": "error.message"
|
|
@@ -15044,11 +15265,16 @@
|
|
|
15044
15265
|
"resolved": {
|
|
15045
15266
|
"type": "object",
|
|
15046
15267
|
"properties": {
|
|
15047
|
-
"
|
|
15268
|
+
"data_path": {
|
|
15048
15269
|
"type": "string",
|
|
15049
15270
|
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
15050
15271
|
},
|
|
15051
|
-
"
|
|
15272
|
+
"dataPath": {
|
|
15273
|
+
"type": "string",
|
|
15274
|
+
"deprecated": true,
|
|
15275
|
+
"description": "Deprecated. Use `data_path` instead."
|
|
15276
|
+
},
|
|
15277
|
+
"error_message_path": {
|
|
15052
15278
|
"type": "string",
|
|
15053
15279
|
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
15054
15280
|
"example": "error.message"
|
|
@@ -15134,7 +15360,7 @@
|
|
|
15134
15360
|
"resolved": {
|
|
15135
15361
|
"type": "object",
|
|
15136
15362
|
"properties": {
|
|
15137
|
-
"
|
|
15363
|
+
"error_message_path": {
|
|
15138
15364
|
"type": "string",
|
|
15139
15365
|
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
15140
15366
|
"example": "error.message"
|
|
@@ -15213,11 +15439,16 @@
|
|
|
15213
15439
|
"resolved": {
|
|
15214
15440
|
"type": "object",
|
|
15215
15441
|
"properties": {
|
|
15216
|
-
"
|
|
15442
|
+
"data_path": {
|
|
15217
15443
|
"type": "string",
|
|
15218
15444
|
"description": "Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level."
|
|
15219
15445
|
},
|
|
15220
|
-
"
|
|
15446
|
+
"dataPath": {
|
|
15447
|
+
"type": "string",
|
|
15448
|
+
"deprecated": true,
|
|
15449
|
+
"description": "Deprecated. Use `data_path` instead."
|
|
15450
|
+
},
|
|
15451
|
+
"error_message_path": {
|
|
15221
15452
|
"type": "string",
|
|
15222
15453
|
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
15223
15454
|
"example": "error.message"
|
|
@@ -15296,11 +15527,16 @@
|
|
|
15296
15527
|
"resolved": {
|
|
15297
15528
|
"type": "object",
|
|
15298
15529
|
"properties": {
|
|
15299
|
-
"
|
|
15530
|
+
"data_path": {
|
|
15300
15531
|
"type": "string",
|
|
15301
15532
|
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
15302
15533
|
},
|
|
15303
|
-
"
|
|
15534
|
+
"dataPath": {
|
|
15535
|
+
"type": "string",
|
|
15536
|
+
"deprecated": true,
|
|
15537
|
+
"description": "Deprecated. Use `data_path` instead."
|
|
15538
|
+
},
|
|
15539
|
+
"error_message_path": {
|
|
15304
15540
|
"type": "string",
|
|
15305
15541
|
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
15306
15542
|
"example": "error.message"
|
|
@@ -15865,7 +16101,8 @@
|
|
|
15865
16101
|
"enum": [
|
|
15866
16102
|
"login",
|
|
15867
16103
|
"select_account",
|
|
15868
|
-
"consent"
|
|
16104
|
+
"consent",
|
|
16105
|
+
"signup"
|
|
15869
16106
|
]
|
|
15870
16107
|
}
|
|
15871
16108
|
},
|
|
@@ -16421,14 +16658,19 @@
|
|
|
16421
16658
|
},
|
|
16422
16659
|
"self_registration_account_setting": {
|
|
16423
16660
|
"type": "string",
|
|
16424
|
-
"description": "Controls behavior of self-registration when account is
|
|
16661
|
+
"description": "Controls behavior of self-registration when account is the registration\nentity. `BLOCK_IF_PORTAL_USER_EXISTS` matches an existing account and\nrejects the request when any portal user is already linked to that\naccount (no creation). Blocking can also be enabled on the other\nnon-create modes via `block_registration_if_portal_user_exists`.\n",
|
|
16425
16662
|
"enum": [
|
|
16426
|
-
"
|
|
16663
|
+
"ALLOW_WITH_CREATION",
|
|
16427
16664
|
"DENY",
|
|
16428
|
-
"
|
|
16665
|
+
"ALWAYS_CREATE",
|
|
16666
|
+
"BLOCK_IF_PORTAL_USER_EXISTS",
|
|
16429
16667
|
"DISALLOW_COMPLETELY"
|
|
16430
16668
|
]
|
|
16431
16669
|
},
|
|
16670
|
+
"block_registration_if_portal_user_exists": {
|
|
16671
|
+
"type": "boolean",
|
|
16672
|
+
"description": "Account-mode only. Reject registration when the resolved account already\nhas any portal user (any portal user whose mapped contact is linked to\nthe account).\n"
|
|
16673
|
+
},
|
|
16432
16674
|
"self_registration_entity": {
|
|
16433
16675
|
"type": "string",
|
|
16434
16676
|
"description": "Entity type used as the primary identifier for self-registration",
|
|
@@ -16745,6 +16987,40 @@
|
|
|
16745
16987
|
}
|
|
16746
16988
|
]
|
|
16747
16989
|
},
|
|
16990
|
+
"contact_identifiers_for_account": {
|
|
16991
|
+
"type": "array",
|
|
16992
|
+
"description": "Account-mode only. Identifiers on the contact entity of the primarily\nidentified account. Used to pick an existing related contact within the\nresolved account; if none matches, the values are written onto the new\ncontact that is created and linked to the account.\n",
|
|
16993
|
+
"items": {
|
|
16994
|
+
"$ref": "#/components/schemas/RegistrationIdentifier"
|
|
16995
|
+
},
|
|
16996
|
+
"example": [
|
|
16997
|
+
{
|
|
16998
|
+
"name": "first_name",
|
|
16999
|
+
"schema": "contact"
|
|
17000
|
+
},
|
|
17001
|
+
{
|
|
17002
|
+
"name": "last_name",
|
|
17003
|
+
"schema": "contact"
|
|
17004
|
+
}
|
|
17005
|
+
]
|
|
17006
|
+
},
|
|
17007
|
+
"additional_contact_attributes": {
|
|
17008
|
+
"type": "array",
|
|
17009
|
+
"description": "Contact attributes collected from the user during self-registration that are\nwritten onto the newly created contact but are not used to identify an\nexisting one.\n",
|
|
17010
|
+
"items": {
|
|
17011
|
+
"$ref": "#/components/schemas/AdditionalContactAttribute"
|
|
17012
|
+
},
|
|
17013
|
+
"example": [
|
|
17014
|
+
{
|
|
17015
|
+
"name": "first_name",
|
|
17016
|
+
"required": true
|
|
17017
|
+
},
|
|
17018
|
+
{
|
|
17019
|
+
"name": "last_name",
|
|
17020
|
+
"required": true
|
|
17021
|
+
}
|
|
17022
|
+
]
|
|
17023
|
+
},
|
|
16748
17024
|
"triggered_journeys": {
|
|
16749
17025
|
"type": "array",
|
|
16750
17026
|
"description": "Journeys automatically opened on a portal user action",
|
|
@@ -16761,6 +17037,21 @@
|
|
|
16761
17037
|
},
|
|
16762
17038
|
"journey_id": {
|
|
16763
17039
|
"$ref": "#/components/schemas/EntityId"
|
|
17040
|
+
},
|
|
17041
|
+
"context_params": {
|
|
17042
|
+
"type": "array",
|
|
17043
|
+
"description": "Context parameters forwarded to the journey when it is\nauto-triggered. Values may contain handlebars templates\nthat reference the available context (e.g.\n`{{contact._id}}`, `{{portal_user.email}}`,\n`{{order._id}}`) — these are resolved at trigger time by\n`GET /v2/portal/config/triggered-journeys/{trigger_name}`\nusing the caller's auth context plus runtime entities\nsupplied via the `context_entities` query param.\n",
|
|
17044
|
+
"items": {
|
|
17045
|
+
"type": "object",
|
|
17046
|
+
"properties": {
|
|
17047
|
+
"key": {
|
|
17048
|
+
"type": "string"
|
|
17049
|
+
},
|
|
17050
|
+
"value": {
|
|
17051
|
+
"type": "string"
|
|
17052
|
+
}
|
|
17053
|
+
}
|
|
17054
|
+
}
|
|
16764
17055
|
}
|
|
16765
17056
|
}
|
|
16766
17057
|
}
|