@epilot/sdk 2.13.2 → 2.14.1

package/definitions/message-runtime.json

@@ -1 +1 @@
-{"s":"https://message.sls.epilot.io","o":[["sendMessage","post","/v1/message/messages",[["do_not_create_entities","q"]],1],["updateMessage","put","/v1/message/messages"],["getMessage","get","/v1/message/messages/{id}",[["id","p",true]]],["deleteMessage","delete","/v1/message/messages/{id}",[["id","p",true]]],["getMessageEml","get","/v1/message/messages/{id}/eml",[["id","p",true]]],["searchMessages","post","/v1/message/messages:search",null,1],["trashMessage","post","/v1/message/messages/{id}/trash",[["id","p",true]]],["untrashMessage","post","/v1/message/messages/{id}/untrash",[["id","p",true]]],["markReadMessage","post","/v1/message/messages/{id}/read",[["id","p",true]]],["markReadMessageV2","post","/v2/message/messages/{id}/read",[["id","p",true]],1],["markUnreadMessage","post","/v1/message/messages/{id}/unread",[["id","p",true]]],["getUnread","get","/v1/message/messages/unread/{actor}",[["actor","p",true],["email_filter","q"]]],["markUnreadMessageV2","post","/v2/message/messages/{id}/unread",[["id","p",true]],1],["searchThreads","post","/v1/message/threads:search",null,1],["searchThreadsV2","post","/v2/message/threads:search",null,1],["searchIds","post","/v1/message/threads:searchIds",null,1],["updateThread","put","/v1/message/threads"],["deleteThread","delete","/v1/message/threads/{id}",[["id","p",true]]],["moveThread","post","/v1/message/threads/{id}:move",[["id","p",true]],1],["markThreadAsDone","post","/v1/message/threads/{id}:markAsDone",[["id","p",true]]],["markThreadAsOpen","post","/v1/message/threads/{id}:markAsOpen",[["id","p",true]]],["getThreadTimeline","get","/v1/message/threads/{id}/timeline",[["id","p",true]]],["trashThread","post","/v1/message/threads/{id}/trash",[["id","p",true]]],["untrashThread","post","/v1/message/threads/{id}/untrash",[["id","p",true]]],["spamThread","post","/v1/message/threads/{id}/spam",[["id","p",true]]],["unspamThread","post","/v1/message/threads/{id}/unspam",[["id","p",true]]],["spamMessage","post","/v1/message/messages/{id}/spam",[["id","p",true]]],["unspamMessage","post","/v1/message/messages/{id}/unspam",[["id","p",true]]],["bulkMoveThreads","post","/v1/message/threads/bulk:move",null,1],["bulkAssignThreads","post","/v1/message/threads/bulk:assign",null,1],["threadBulkActionsRead","post","/v1/message/threads/bulk:read",null,1],["threadBulkActionsUnread","post","/v1/message/threads/bulk:unread",null,1],["threadBulkActionsFavorite","post","/v1/message/threads/bulk:favorite",null,1],["threadBulkActionsUnfavorite","post","/v1/message/threads/bulk:unfavorite",null,1],["threadBulkActionsTrash","post","/v1/message/threads/bulk:trash",null,1],["threadBulkActionsUntrash","post","/v1/message/threads/bulk:untrash",null,1],["threadBulkActionsDelete","post","/v1/message/threads/bulk:delete",null,1],["threadBulkActionsDone","post","/v1/message/threads/bulk:done",null,1],["threadBulkActionsOpen","post","/v1/message/threads/bulk:open",null,1],["markReadThread","post","/v1/message/threads/{id}/read",[["id","p",true]]],["markReadThreadV2","post","/v2/message/threads/{id}/read",[["id","p",true]],1],["markUnreadThread","post","/v1/message/threads/{id}/unread",[["id","p",true]]],["markUnreadThreadV2","post","/v2/message/threads/{id}/unread",[["id","p",true]],1],["assignThread","post","/v1/message/threads/{id}/assign",[["id","p",true]],1],["unassignThread","post","/v1/message/threads/{id}/unassign",[["id","p",true],["unlink_mapped_entities","q"]],1],["assignUsers","post","/v1/message/threads/{id}/assign:users",[["id","p",true]],1],["assignUsersV2","post","/v2/message/threads/{id}/assign:users",[["id","p",true]],1],["pinThread","post","/v1/message/threads/{id}:pin",[["id","p",true]]],["unpinThread","delete","/v1/message/threads/{id}:pin",[["id","p",true]]],["createDraft","post","/v1/message/drafts",null,1],["sendDraft","post","/v1/message/drafts:send"],["getMessageV2","get","/v2/message/messages/{id}",[["id","p",true]]]]}
+{"s":"https://message.sls.epilot.io","o":[["sendMessage","post","/v1/message/messages",[["do_not_create_entities","q"]],1],["updateMessage","put","/v1/message/messages"],["getMessage","get","/v1/message/messages/{id}",[["id","p",true]]],["deleteMessage","delete","/v1/message/messages/{id}",[["id","p",true]]],["getMessageEml","get","/v1/message/messages/{id}/eml",[["id","p",true]]],["searchMessages","post","/v1/message/messages:search",null,1],["trashMessage","post","/v1/message/messages/{id}/trash",[["id","p",true]]],["untrashMessage","post","/v1/message/messages/{id}/untrash",[["id","p",true]]],["markReadMessage","post","/v1/message/messages/{id}/read",[["id","p",true]]],["markReadMessageV2","post","/v2/message/messages/{id}/read",[["id","p",true]],1],["markUnreadMessage","post","/v1/message/messages/{id}/unread",[["id","p",true]]],["getUnread","get","/v1/message/messages/unread/{actor}",[["actor","p",true],["email_filter","q"]]],["markUnreadMessageV2","post","/v2/message/messages/{id}/unread",[["id","p",true]],1],["searchThreads","post","/v1/message/threads:search",null,1],["searchThreadsV2","post","/v2/message/threads:search",null,1],["searchIds","post","/v1/message/threads:searchIds",null,1],["getAssigneeWorkload","post","/v2/message/threads:workload",null,1],["updateThread","put","/v1/message/threads"],["deleteThread","delete","/v1/message/threads/{id}",[["id","p",true]]],["moveThread","post","/v1/message/threads/{id}:move",[["id","p",true]],1],["markThreadAsDone","post","/v1/message/threads/{id}:markAsDone",[["id","p",true]]],["markThreadAsOpen","post","/v1/message/threads/{id}:markAsOpen",[["id","p",true]]],["getThreadTimeline","get","/v1/message/threads/{id}/timeline",[["id","p",true]]],["trashThread","post","/v1/message/threads/{id}/trash",[["id","p",true]]],["untrashThread","post","/v1/message/threads/{id}/untrash",[["id","p",true]]],["spamThread","post","/v1/message/threads/{id}/spam",[["id","p",true]]],["unspamThread","post","/v1/message/threads/{id}/unspam",[["id","p",true]]],["spamMessage","post","/v1/message/messages/{id}/spam",[["id","p",true]]],["unspamMessage","post","/v1/message/messages/{id}/unspam",[["id","p",true]]],["bulkMoveThreads","post","/v1/message/threads/bulk:move",null,1],["bulkAssignThreads","post","/v1/message/threads/bulk:assign",null,1],["threadBulkActionsRead","post","/v1/message/threads/bulk:read",null,1],["threadBulkActionsUnread","post","/v1/message/threads/bulk:unread",null,1],["threadBulkActionsFavorite","post","/v1/message/threads/bulk:favorite",null,1],["threadBulkActionsUnfavorite","post","/v1/message/threads/bulk:unfavorite",null,1],["threadBulkActionsTrash","post","/v1/message/threads/bulk:trash",null,1],["threadBulkActionsUntrash","post","/v1/message/threads/bulk:untrash",null,1],["threadBulkActionsDelete","post","/v1/message/threads/bulk:delete",null,1],["threadBulkActionsDone","post","/v1/message/threads/bulk:done",null,1],["threadBulkActionsOpen","post","/v1/message/threads/bulk:open",null,1],["markReadThread","post","/v1/message/threads/{id}/read",[["id","p",true]]],["markReadThreadV2","post","/v2/message/threads/{id}/read",[["id","p",true]],1],["markUnreadThread","post","/v1/message/threads/{id}/unread",[["id","p",true]]],["markUnreadThreadV2","post","/v2/message/threads/{id}/unread",[["id","p",true]],1],["assignThread","post","/v1/message/threads/{id}/assign",[["id","p",true]],1],["unassignThread","post","/v1/message/threads/{id}/unassign",[["id","p",true],["unlink_mapped_entities","q"]],1],["assignUsers","post","/v1/message/threads/{id}/assign:users",[["id","p",true]],1],["assignUsersV2","post","/v2/message/threads/{id}/assign:users",[["id","p",true]],1],["pinThread","post","/v1/message/threads/{id}:pin",[["id","p",true]]],["unpinThread","delete","/v1/message/threads/{id}:pin",[["id","p",true]]],["createDraft","post","/v1/message/drafts",null,1],["sendDraft","post","/v1/message/drafts:send"],["getMessageV2","get","/v2/message/messages/{id}",[["id","p",true]]]]}

package/definitions/message.json

@@ -123,6 +123,34 @@
           },
           "403": {
             "description": "Forbidden"
+          },
+          "409": {
+            "description": "Conflict - the draft was edited by someone else since it was loaded",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string",
+                      "description": "Human-readable conflict message",
+                      "example": "This draft was edited by someone else. Please reload and try again."
+                    },
+                    "current_message": {
+                      "description": "The current server version of the message (includes updated_by / _updated_at)",
+                      "allOf": [
+                        {
+                          "$ref": "#/components/schemas/BaseEntity"
+                        },
+                        {
+                          "$ref": "#/components/schemas/Message"
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            }
           }
         }
       }
@@ -762,6 +790,41 @@
         }
       }
     },
+    "/v2/message/threads:workload": {
+      "post": {
+        "operationId": "getAssigneeWorkload",
+        "summary": "getAssigneeWorkload",
+        "description": "Return the open-thread workload for a set of user ids.\n\nFor each requested user id, returns the number of *open* threads assigned\ndirectly to that user — matching what the user sees in their central-inbox\nopen view: in inbox, not trashed, not done, and excluding notification-only\nand spam threads.\n\nOnly threads assigned directly to a user are counted; threads assigned to a\ngroup the user belongs to are not. Intended for assignment load-balancing\n(e.g. even-distribution automations) that need a consistent, inbox-aligned\nworkload per user.\n",
+        "tags": [
+          "Threads"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/AssigneeWorkloadParams"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AssigneeWorkloadResults"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        }
+      }
+    },
     "/v1/message/threads": {
       "put": {
         "operationId": "updateThread",
@@ -2242,6 +2305,11 @@
             "description": "User ID of user sends the message.",
             "example": "206801"
           },
+          "updated_by": {
+            "type": "string",
+            "description": "User ID of the user who last updated (edited) the message. Set for drafts on each save.",
+            "example": "206801"
+          },
           "subject": {
             "type": "string",
             "description": "Subject",
@@ -2466,6 +2534,11 @@
             "type": "boolean",
             "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.            In this case, service doesn't process this attachment.\n",
             "default": false
+          },
+          "save_to_entity": {
+            "type": "boolean",
+            "description": "If false, this file relation is kept on the message (e.g. for CID/inline rendering) but is NOT propagated to the entity the email is sent from. Used for inline images such as logos, signatures and social icons. Defaults to true.\n",
+            "default": true
           }
         }
       },
@@ -2481,6 +2554,11 @@
             "description": "Whether the thread is marked as Done immediately after sending the message",
             "default": false
           },
+          "mark_thread_as_read": {
+            "type": "boolean",
+            "description": "Whether to mark the thread as read by the sender's org/user after sending a reply.\nOnly applies when `parent_id` is set. When false, the thread's `org_read_message` and\n`user_read_message` arrays are left unchanged, so the thread remains unread for anyone\nwho had it unread before. Defaults to true for backward compatibility.\n",
+            "default": true
+          },
           "thread": {
             "type": "object",
             "required": [
@@ -2563,6 +2641,19 @@
             "type": "string",
             "description": "Template ID used for sending message.",
             "example": "3f34ce73-089c-4d45-a5ee-c161234e41c3"
+          },
+          "source": {
+            "type": "string",
+            "description": "Identifies who triggered the send so server-side policy can branch on it.\nFor `manual` sends, the caller's curated `_tags` are trusted as-is and no\nserver-side enrichment from the referenced `template_id` (e.g. merging the\ntemplate's `email_tags`) is performed. Any non-manual value (or omitting the\nfield) opts into template-derived enrichment.\n",
+            "enum": [
+              "manual",
+              "automation",
+              "workflow",
+              "partner",
+              "bulk",
+              "system"
+            ],
+            "example": "manual"
           }
         }
       },
@@ -2661,6 +2752,60 @@
           }
         }
       },
+      "AssigneeWorkloadParams": {
+        "type": "object",
+        "required": [
+          "user_ids"
+        ],
+        "properties": {
+          "user_ids": {
+            "type": "array",
+            "description": "User ids to compute the open-thread workload for. At most 100 per request; larger requests are rejected with 422.",
+            "minItems": 1,
+            "items": {
+              "type": "string"
+            },
+            "example": [
+              "11000902",
+              "11001053"
+            ]
+          }
+        }
+      },
+      "AssigneeWorkload": {
+        "type": "object",
+        "required": [
+          "user_id",
+          "open_threads"
+        ],
+        "properties": {
+          "user_id": {
+            "type": "string",
+            "description": "The user id.",
+            "example": "11000902"
+          },
+          "open_threads": {
+            "type": "number",
+            "description": "Number of open threads assigned directly to the user.",
+            "example": 2
+          }
+        }
+      },
+      "AssigneeWorkloadResults": {
+        "type": "object",
+        "required": [
+          "workloads"
+        ],
+        "properties": {
+          "workloads": {
+            "type": "array",
+            "description": "Open-thread workload per requested user id, in request order.",
+            "items": {
+              "$ref": "#/components/schemas/AssigneeWorkload"
+            }
+          }
+        }
+      },
       "ReadMessagePayload": {
         "type": "object",
         "required": [
@@ -2785,7 +2930,7 @@
           "timestamp": {
             "type": "string",
             "description": "Timestamp of the event",
-            "example": "2024-01-01T00:00:00Z"
+            "example": "2024-01-01T00:00:00.000Z"
           }
         }
       },

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": {

package/definitions/webhooks.json

@@ -1094,11 +1094,11 @@
       },
       "WebhookCondition": {
         "type": "object",
-        "description": "A condition that must be met for the webhook to fire.",
+        "description": "A condition that must be met for the webhook to fire. A condition is EITHER a classic field + operation comparison OR a single jsonata_expression evaluated against the event payload — the two forms are mutually exclusive.",
         "properties": {
           "field": {
             "type": "string",
-            "description": "Dot-notation path to the field in the event payload (e.g. \"entity.status\", \"entity.line_items\")"
+            "description": "Dot-notation path to the field in the event payload (e.g. \"entity.status\", \"entity.line_items\"). Supports array indices in either spelling, which resolve identically: \"meter_readings.1.file_id\" or \"meter_readings[1].file_id\"."
           },
           "operation": {
             "type": "string",
@@ -1154,12 +1154,13 @@
             "type": "boolean",
             "description": "When true, evaluates conditions per-item in repeatable array fields",
             "default": false
+          },
+          "jsonata_expression": {
+            "type": "string",
+            "maxLength": 15000,
+            "description": "JSONata expression evaluated against the event payload; the condition passes when the result is truthy per JSONata $boolean semantics. Mutually exclusive with field/operation."
           }
-        },
-        "required": [
-          "field",
-          "operation"
-        ]
+        }
       },
       "WebhookConditionGroup": {
         "type": "object",

package/dist/apis/access-token.cjs

@@ -6,25 +6,25 @@ var _chunkS5HBBTKMcjs = require('../chunk-S5HBBTKM.cjs');
 
 
 
-var _chunkGHPSNA2Ucjs = require('../chunk-GHPSNA2U.cjs');
+var _chunkSNERI3PKcjs = require('../chunk-SNERI3PK.cjs');
 require('../chunk-NJK5F5TF.cjs');
 
 // src/apis/access-token.ts
 var loadDefinition = () => {
   const mod = _chunkS5HBBTKMcjs.require_access_token_runtime.call(void 0, );
-  return _chunkGHPSNA2Ucjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+  return _chunkSNERI3PKcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 };
 var _instance = null;
 var resolve = () => {
   if (!_instance) {
     const def = loadDefinition();
-    _instance = _chunkGHPSNA2Ucjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
+    _instance = _chunkSNERI3PKcjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
   }
   return _instance;
 };
-var _handle = _chunkGHPSNA2Ucjs.createApiHandle.call(void 0, {
+var _handle = _chunkSNERI3PKcjs.createApiHandle.call(void 0, {
   resolveClient: resolve,
-  createClient: () => _chunkGHPSNA2Ucjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
+  createClient: () => _chunkSNERI3PKcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
   apiName: "accessToken"
 });
 var getClient = _handle.getClient;
@@ -35,4 +35,4 @@ var accessToken = _handle;
 
 
 
-exports.accessToken = accessToken; exports.authorize = _chunkGHPSNA2Ucjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
+exports.accessToken = accessToken; exports.authorize = _chunkSNERI3PKcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;

package/dist/apis/access-token.js

@@ -6,7 +6,7 @@ import {
   createApiClient,
   createApiHandle,
   expand
-} from "../chunk-CRUXTTHI.js";
+} from "../chunk-OJLX6U66.js";
 import "../chunk-YPSWSI3M.js";
 
 // src/apis/access-token.ts