@epilot/sdk 2.14.0 → 2.14.2

package/definitions/access-token.json

@@ -597,6 +597,12 @@
         "description": "When true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.",
         "example": true
       },
+      "Anonymize": {
+        "type": "boolean",
+        "default": false,
+        "description": "Forces PII anonymization on all entity data returned to this token. Cannot be disabled by the token bearer. See entity-api anonymized responses.",
+        "example": true
+      },
       "AccessTokenParameters": {
         "type": "object",
         "additionalProperties": false,
@@ -618,6 +624,9 @@
           },
           "read_only": {
             "$ref": "#/components/schemas/ReadOnly"
+          },
+          "anonymize": {
+            "$ref": "#/components/schemas/Anonymize"
           }
         },
         "required": [
@@ -692,6 +701,9 @@
           },
           "read_only": {
             "$ref": "#/components/schemas/ReadOnly"
+          },
+          "anonymize": {
+            "$ref": "#/components/schemas/Anonymize"
           }
         },
         "required": [
@@ -719,6 +731,9 @@
           },
           "read_only": {
             "$ref": "#/components/schemas/ReadOnly"
+          },
+          "anonymize": {
+            "$ref": "#/components/schemas/Anonymize"
           }
         },
         "required": [
@@ -782,6 +797,9 @@
           "read_only": {
             "$ref": "#/components/schemas/ReadOnly"
           },
+          "anonymize": {
+            "$ref": "#/components/schemas/Anonymize"
+          },
           "last_used": {
             "type": "string",
             "format": "date",

package/definitions/customer-portal-runtime.json

@@ -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]]],["createExport","post","/v1/portal/exports",null,1],["getExport","get","/v1/portal/exports/{jobId}",[["jobId","p",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]]],["migrateEmailTemplateReferences","post","/v3/portal/email-templates:migrate-references",null,1],["listEmailTemplateReferences","post","/v3/portal/email-templates:list-references",null,1],["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],["changePortalUserPassword","put","/v2/portal/user/change/password",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],["createPortalUserEntity","post","/v2/portal/entity/{slug}",[["slug","p",true]],1],["patchPortalUserEntity","patch","/v2/portal/entity/{slug}/{id}",[["slug","p",true],["id","p",true]],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],["page_upsert_mode","q"]],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],["getMobileConfig","get","/v1/portal/mobile-config",[["portal_id","q",true],["raw","q"]]],["putMobileConfig","put","/v1/portal/mobile-config",[["portal_id","q",true]],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]]}}
+{"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]]],["createExport","post","/v1/portal/exports",null,1],["getExport","get","/v1/portal/exports/{jobId}",[["jobId","p",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]]],["migrateEmailTemplateReferences","post","/v3/portal/email-templates:migrate-references",null,1],["listEmailTemplateReferences","post","/v3/portal/email-templates:list-references",null,1],["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],["changePortalUserPassword","put","/v2/portal/user/change/password",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]]],["getContractWithTemplates","post","/v2/portal/contract/{id}",[["id","p",true]],1],["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],["createPortalUserEntity","post","/v2/portal/entity/{slug}",[["slug","p",true]],1],["patchPortalUserEntity","patch","/v2/portal/entity/{slug}/{id}",[["slug","p",true],["id","p",true]],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],["page_upsert_mode","q"]],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],["getMobileConfig","get","/v1/portal/mobile-config",[["portal_id","q",true],["raw","q"]]],["putMobileConfig","put","/v1/portal/mobile-config",[["portal_id","q",true]],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]]}}

package/definitions/customer-portal.json

@@ -5929,6 +5929,125 @@
           }
         }
       },
+      "post": {
+        "operationId": "getContractWithTemplates",
+        "summary": "getContractWithTemplates",
+        "description": "Get a contract by id, resolving the provided Handlebars templates against each related meter into templates_output. POST variant of getContract that accepts a request body; the GET remains as a fallback.",
+        "tags": [
+          "ECP"
+        ],
+        "security": [
+          {
+            "PortalAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "schema": {
+              "$ref": "#/components/schemas/EntityId"
+            },
+            "required": true,
+            "description": "The ID of the contract"
+          }
+        ],
+        "requestBody": {
+          "required": false,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "templates": {
+                    "type": "object",
+                    "additionalProperties": {
+                      "type": "string"
+                    },
+                    "description": "Map of content field name to Handlebars template string. Each template is resolved per related meter and returned as templates_output on the meter."
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The requested contract returned successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "entity": {
+                      "$ref": "#/components/schemas/Contract"
+                    },
+                    "orders": {
+                      "type": "array",
+                      "description": "The related orders of the requested contract",
+                      "items": {
+                        "$ref": "#/components/schemas/Order"
+                      }
+                    },
+                    "meters": {
+                      "type": "array",
+                      "description": "The related meters of the requested contract",
+                      "items": {
+                        "allOf": [
+                          {
+                            "$ref": "#/components/schemas/Meter"
+                          },
+                          {
+                            "$ref": "#/components/schemas/EntityTemplates"
+                          }
+                        ]
+                      }
+                    },
+                    "files": {
+                      "type": "array",
+                      "description": "The related files of the requested contract",
+                      "items": {
+                        "$ref": "#/components/schemas/File"
+                      }
+                    },
+                    "relations": {
+                      "type": "array",
+                      "description": "The related entities of the requested contract",
+                      "items": {
+                        "$ref": "#/components/schemas/EntityItem"
+                      }
+                    },
+                    "workflow": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/WorkflowExecution"
+                      }
+                    },
+                    "journey_actions": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/JourneyActions"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFound"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      },
       "patch": {
         "operationId": "updateContract",
         "summary": "updateContract",

package/definitions/targeting-runtime.json

@@ -1 +1 @@
-{"s":"https://targeting.sls.epilot.io","o":[["changeCampaignStatus","post","/v1/campaign/{campaign_id}/status",[["CampaignIdPathParam"]]],["getCampaignJobStatus","get","/v1/campaign/{campaign_id}/job",[["CampaignIdPathParam"]]],["getCampaignPortals","get","/v1/campaign/{campaign_id}/portals",[["CampaignIdPathParam"]]],["retriggerCampaignAutomations","post","/v1/campaign/{campaign_id}/automations:retrigger",[["CampaignIdPathParam"]],1],["setupCampaign","post","/v1/campaign:setup",null,1],["matchCampaigns","post","/v1/campaign:match",null,1],["matchTargets","post","/v1/target:match",null,1],["getTargetQueries","post","/v1/target/queries",null,1],["createRecipient","post","/v1/campaign/{campaign_id}/recipient",[["CampaignIdPathParam"]],1],["updateRecipient","patch","/v1/campaign/{campaign_id}/recipient/{recipient_id}",[["CampaignIdPathParam"],["RecipientIdPathParam"]],1],["updateRecipientPortalStatus","patch","/v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status",[["CampaignIdPathParam"],["RecipientIdPathParam"]],1],["getRecipients","get","/v1/campaign/{campaign_id}/recipients",[["CampaignIdPathParam"],["limit","q"],["next","q"],["q","q"],["automation_status","q",false,"form",true],["portal_status","q"]]]],"v":"3.0.3","cp":{"CampaignIdPathParam":["campaign_id","p",true],"RecipientIdPathParam":["recipient_id","p",true]}}
+{"s":"https://targeting.sls.epilot.io","o":[["changeCampaignStatus","post","/v1/campaign/{campaign_id}/status",[["CampaignIdPathParam"]]],["getCampaignJobStatus","get","/v1/campaign/{campaign_id}/job",[["CampaignIdPathParam"]]],["getCampaignPortals","get","/v1/campaign/{campaign_id}/portals",[["CampaignIdPathParam"]]],["retriggerCampaignAutomations","post","/v1/campaign/{campaign_id}/automations:retrigger",[["CampaignIdPathParam"]],1],["setupCampaign","post","/v1/campaign:setup",null,1],["matchCampaigns","post","/v1/campaign:match",null,1],["discoverCampaigns","post","/v1/campaign:discover",null,1],["matchTargets","post","/v1/target:match",null,1],["getTargetQueries","post","/v1/target/queries",null,1],["createRecipient","post","/v1/campaign/{campaign_id}/recipient",[["CampaignIdPathParam"]],1],["updateRecipient","patch","/v1/campaign/{campaign_id}/recipient/{recipient_id}",[["CampaignIdPathParam"],["RecipientIdPathParam"]],1],["updateRecipientPortalStatus","patch","/v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status",[["CampaignIdPathParam"],["RecipientIdPathParam"]],1],["updateRecipientEntityUiStatus","patch","/v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:status",[["CampaignIdPathParam"],["RecipientIdPathParam"]],1],["getRecipients","get","/v1/campaign/{campaign_id}/recipients",[["CampaignIdPathParam"],["limit","q"],["next","q"],["q","q"],["automation_status","q",false,"form",true],["portal_status","q"]]]],"v":"3.0.3","cp":{"CampaignIdPathParam":["campaign_id","p",true],"RecipientIdPathParam":["recipient_id","p",true]}}

package/definitions/targeting.json

@@ -243,6 +243,42 @@
         }
       }
     },
+    "/v1/campaign:discover": {
+      "post": {
+        "operationId": "discoverCampaigns",
+        "summary": "Discover Entity-UI Next Best Actions for an entity",
+        "description": "Given an entity, returns the Next Best Actions it should see on the Entity-UI channel.\n\nEnumerates the organization's **active** campaigns that carry a valid Entity-UI Next Best\nAction, live-matches each against the entity using the existing match engine, and returns\nthe matching NBAs priority-sorted (one per campaign).\n\nThis is a pure read: it writes nothing. An entity that matches no campaigns returns an\nempty list, not an error.\n",
+        "tags": [
+          "Campaign"
+        ],
+        "security": [
+          {
+            "EpilotAuth": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/DiscoverCampaignsParams"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/DiscoverCampaignsResponse"
+          },
+          "400": {
+            "$ref": "#/components/responses/ClientErrorResponse"
+          },
+          "500": {
+            "$ref": "#/components/responses/ServerErrorResponse"
+          }
+        }
+      }
+    },
     "/v1/target:match": {
       "post": {
         "operationId": "matchTargets",
@@ -450,6 +486,56 @@
         }
       }
     },
+    "/v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:status": {
+      "patch": {
+        "operationId": "updateRecipientEntityUiStatus",
+        "summary": "Update Entity-UI (Next Best Action) status for a campaign recipient",
+        "description": "Records a Next Best Action interaction for a recipient on the Entity-UI channel.\n\nUnlike the portal channel, an NBA recipient is created lazily: the first `seen` creates\nthe recipient record (and requires `entity_schema`). `seen` is idempotent — re-viewing an\nNBA that is already seen/clicked/dismissed is a no-op success and never regresses the status.\n\nStatus transition rules:\n- `seen`: lazily creates the recipient; a no-op success if a status already exists\n- From `seen`: can change to `clicked` or `dismissed`\n- From `clicked`: can change to `dismissed`\n- From `dismissed`: cannot be changed (final state)\n\n`dismissed` and `clicked` require an existing recipient (404 otherwise, since an NBA is\nborn at `seen`) and reject invalid transitions (409).\n\nThe entity_ui_status_updated_at timestamp is automatically set when the status changes.\n",
+        "tags": [
+          "Campaign Recipient"
+        ],
+        "security": [
+          {
+            "EpilotAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/CampaignIdPathParam"
+          },
+          {
+            "$ref": "#/components/parameters/RecipientIdPathParam"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateEntityUiStatusRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/RecipientResponse"
+          },
+          "400": {
+            "$ref": "#/components/responses/ClientErrorResponse"
+          },
+          "404": {
+            "$ref": "#/components/responses/ClientErrorResponse"
+          },
+          "409": {
+            "$ref": "#/components/responses/ClientErrorResponse"
+          },
+          "500": {
+            "$ref": "#/components/responses/ServerErrorResponse"
+          }
+        }
+      }
+    },
     "/v1/campaign/{campaign_id}/recipients": {
       "get": {
         "operationId": "getRecipients",
@@ -918,6 +1004,122 @@
         ],
         "additionalProperties": false
       },
+      "NextBestAction": {
+        "type": "object",
+        "description": "A Next Best Action configured on a campaign's Entity-UI channel.\nThis is the canonical NBA contract shared by discovery (this API), authoring, and rendering.\nNBA content is single-language in v1; text fields may contain `{{placeholders}}` resolved at render time.\n",
+        "properties": {
+          "category": {
+            "type": "string",
+            "description": "Light category label shown above the title. Free-form text."
+          },
+          "icon": {
+            "type": "object",
+            "description": "Curated icon for the NBA.",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Icon name from \"@epilot360/icons\"."
+              },
+              "color": {
+                "type": "string",
+                "description": "Optional icon color."
+              }
+            },
+            "required": [
+              "name"
+            ]
+          },
+          "title": {
+            "type": "string",
+            "description": "Bold action title. Required. Supports `{{placeholders}}`."
+          },
+          "body": {
+            "type": "string",
+            "description": "Optional description. Supports `{{placeholders}}` (incl. relative dates)."
+          },
+          "priority": {
+            "type": "string",
+            "enum": [
+              "low",
+              "medium",
+              "high"
+            ],
+            "default": "medium",
+            "description": "Display priority. NBAs are shown highest-priority first."
+          },
+          "is_dismissable": {
+            "type": "boolean",
+            "default": true,
+            "description": "Whether the agent can dismiss the NBA."
+          },
+          "cta": {
+            "type": "object",
+            "description": "The NBA's single call-to-action.",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "journey",
+                  "workflow",
+                  "url"
+                ]
+              },
+              "target": {
+                "type": "string",
+                "description": "Journey id, workflow definition id, or URL, depending on `type`."
+              },
+              "label": {
+                "type": "string",
+                "description": "Optional CTA button label."
+              },
+              "context_params": {
+                "type": "array",
+                "description": "Journey context parameters (journey CTA only). Maps the journey's declared\ncontext parameters so the journey knows which entity it is about. Discovery\nreturns them verbatim; they are passed to the journey when it launches.\n",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "key": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "key",
+                    "value"
+                  ]
+                }
+              }
+            },
+            "required": [
+              "type",
+              "target"
+            ]
+          }
+        },
+        "required": [
+          "title",
+          "cta"
+        ]
+      },
+      "DiscoverCampaignsParams": {
+        "type": "object",
+        "properties": {
+          "entity_id": {
+            "$ref": "#/components/schemas/BaseUUID"
+          },
+          "entity_schema": {
+            "type": "string",
+            "description": "The schema slug of the entity (e.g. \"contact\" or \"account\")."
+          }
+        },
+        "required": [
+          "entity_id",
+          "entity_schema"
+        ],
+        "additionalProperties": false
+      },
       "MatchTargetParams": {
         "type": "object",
         "properties": {
@@ -1022,6 +1224,22 @@
           "clicked"
         ]
       },
+      "EntityUiStatus": {
+        "type": "string",
+        "description": "Lifecycle status of a Next Best Action on the Entity-UI channel. Unlike the portal\nchannel there is no `sent` state: an NBA recipient is born at `seen`, the moment the\naction is first rendered to an agent.\n",
+        "enum": [
+          "seen",
+          "dismissed",
+          "clicked"
+        ]
+      },
+      "Resolution": {
+        "type": "string",
+        "description": "Cross-channel resolution of a campaign for a recipient. Unlike the per-channel `*_status`\nfields (where `dismissed` is channel-local), a resolution suppresses the campaign on EVERY\nchannel — the 360 Entity-UI card and the portal teaser alike. Server-managed and read-only:\nnever sent by a client. Absence means unresolved.\n",
+        "enum": [
+          "accepted"
+        ]
+      },
       "Recipient": {
         "type": "object",
         "properties": {
@@ -1051,6 +1269,16 @@
             "type": "object",
             "additionalProperties": true
           },
+          "entity_ui_status": {
+            "$ref": "#/components/schemas/EntityUiStatus"
+          },
+          "entity_ui_status_updated_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "resolution": {
+            "$ref": "#/components/schemas/Resolution"
+          },
           "updated_at": {
             "type": "string",
             "format": "date-time"
@@ -1216,6 +1444,22 @@
           "status"
         ]
       },
+      "UpdateEntityUiStatusRequest": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "$ref": "#/components/schemas/EntityUiStatus"
+          },
+          "entity_schema": {
+            "type": "string",
+            "description": "Schema slug of the recipient entity (e.g. \"contact\"). Required when recording the\nfirst `seen`, which lazily creates the recipient record; ignored on later transitions.\n"
+          }
+        },
+        "required": [
+          "status"
+        ],
+        "additionalProperties": false
+      },
       "SetupCampaignRequest": {
         "description": "Discriminated by `type`. Each campaign variant has its own request shape;\nnew variants are added by introducing a new schema and extending the `oneOf` list.\n",
         "oneOf": [
@@ -1561,6 +1805,53 @@
           }
         }
       },
+      "DiscoverCampaignsResponse": {
+        "description": "The Next Best Actions the entity should see on the Entity-UI channel, priority-sorted.",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "hits": {
+                  "type": "number",
+                  "description": "Number of matching NBAs."
+                },
+                "results": {
+                  "type": "array",
+                  "description": "Matching NBAs, sorted by priority (desc); one entry per campaign.",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "campaign_id": {
+                        "$ref": "#/components/schemas/BaseUUID"
+                      },
+                      "nba": {
+                        "$ref": "#/components/schemas/NextBestAction"
+                      },
+                      "status": {
+                        "allOf": [
+                          {
+                            "$ref": "#/components/schemas/EntityUiStatus"
+                          }
+                        ],
+                        "description": "The recipient's current Entity-UI status for this campaign, present only\nwhen a recipient record already exists (i.e. the entity has previously seen\nor clicked this NBA). Absent when the entity has not yet interacted with it.\nDismissed NBAs are filtered out server-side, so this is only ever `seen` or\n`clicked`. Lets the client skip a redundant `seen` call for NBAs already seen.\n"
+                      }
+                    },
+                    "required": [
+                      "campaign_id",
+                      "nba"
+                    ]
+                  }
+                }
+              },
+              "required": [
+                "hits",
+                "results"
+              ]
+            }
+          }
+        }
+      },
       "MatchTargetsResponse": {
         "description": "List of targets where the given entities are found.",
         "content": {