Domain Ontology Reference
Auto-generated documentation from YAML ontology definition files.
Table of Contents
- coms
- coms.channel
- coms.channel.created@1.0.0
- coms.channel.updated@1.0.0
- coms.conversation
- coms.conversation.created@1.0.0
- coms.conversation.forked@1.0.0
- coms.conversation.merged@1.0.0
- coms.conversation.observer.added@1.0.0
- coms.conversation.observer.removed@1.0.0
- coms.conversation.participant.added@1.0.0
- coms.conversation.participant.removed@1.0.0
- coms.conversation.read@1.0.0
- coms.conversation.updated@1.0.0
- coms.interaction.content.added@1.0.0
- coms.interaction.delivered@1.0.0
- coms.interaction
- coms.interaction.emitted@1.0.0
- coms.interaction.failed@1.0.0
- coms.media.authorized@1.0.0
- coms.media.cached@1.0.0
- coms.media
- coms.media.discovered@1.0.0
<a name="coms"></a>
coms
The coms library defines a clean, transport-focused ontology for channels, conversations, interactions, and external media.
<a name="comschannel"></a>
coms.channel
A Channel represents a physical or network communication transport endpoint address (type + address).
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | - |
type | string | Yes | - |
address | string | Yes | Physical or network endpoint address (e.g. charles@sullux.com, +16035551212). |
label | string | No | Optional label (e.g. Work Email, Home Phone). |
Database Schema
- Table:
coms_channels
<a name="comschannelcreated100"></a>
coms.channel.created@1.0.0
Emitted when a new unique channel endpoint address is registered.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | - |
type | string | Yes | - |
address | string | Yes | Physical or network endpoint address (e.g. charles@sullux.com, +16035551212). |
label | string | No | Optional label (e.g. Work Email, Home Phone). |
Database Schema
- Table:
coms_channels
<a name="comschannelupdated100"></a>
coms.channel.updated@1.0.0
Emitted when channel details or label are updated.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | - |
type | string | No | - |
address | string | No | Physical or network endpoint address (e.g. charles@sullux.com, +16035551212). |
label | string | No | Optional label (e.g. Work Email, Home Phone). |
Database Schema
- Table:
coms_channels
<a name="comsconversation"></a>
coms.conversation
A Conversation is a logical thread grouping interactions across channels into a unified timeline.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | - |
parentConversationId | string | No | Optional ID of parent conversation if this thread is a fork or sub-thread. |
title | string | Yes | - |
status | string | Yes | - |
tags | array | No | - |
Database Schema
- Table:
coms_conversations
<a name="comsconversationcreated100"></a>
coms.conversation.created@1.0.0
Emitted when a new logical conversation thread is initialized.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | - |
parentConversationId | string | No | Optional ID of parent conversation if this thread is a fork or sub-thread. |
title | string | Yes | - |
status | string | Yes | - |
tags | array | No | - |
Database Schema
- Table:
coms_conversations
<a name="comsconversationforked100"></a>
coms.conversation.forked@1.0.0
Emitted when a new conversation thread is forked/branched from a parent conversation (BCC, message forwarding, side-chats).
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | - |
parentConversationId | string | Yes | Optional ID of parent conversation if this thread is a fork or sub-thread. |
title | string | No | - |
status | string | No | - |
tags | array | No | - |
selection | ref (interactionSelection) | Yes | - |
initialParticipants | array | No | - |
Database Schema
- Table:
coms_conversations
<a name="comsconversationmerged100"></a>
coms.conversation.merged@1.0.0
Emitted when interactions from a source conversation are merged back into a target conversation.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
sourceConversationId | string | Yes | - |
targetConversationId | string | Yes | - |
selection | ref (interactionSelection) | Yes | - |
keepSourceActive | boolean | No | - |
<a name="comsconversationobserveradded100"></a>
coms.conversation.observer.added@1.0.0
Emitted when a secondary observer/auditor channel is added to a conversation (e.g. CC in email).
Properties
| Property | Type | Required | Description |
|---|---|---|---|
conversationId | string | Yes | - |
channelId | string | Yes | - |
<a name="comsconversationobserverremoved100"></a>
coms.conversation.observer.removed@1.0.0
Emitted when an observer/auditor channel is removed from a conversation.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
conversationId | string | Yes | - |
channelId | string | Yes | - |
<a name="comsconversationparticipantadded100"></a>
coms.conversation.participant.added@1.0.0
Emitted when a primary active participant channel is added to a conversation.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
conversationId | string | Yes | - |
channelId | string | Yes | - |
<a name="comsconversationparticipantremoved100"></a>
coms.conversation.participant.removed@1.0.0
Emitted when a primary participant channel leaves or is removed from a conversation.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
conversationId | string | Yes | - |
channelId | string | Yes | - |
<a name="comsconversationread100"></a>
coms.conversation.read@1.0.0
Emitted when a user or channel advances their read cursor in a conversation.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
conversationId | string | Yes | - |
channelId | string | No | - |
latestSeenInteractionId | string | Yes | - |
<a name="comsconversationupdated100"></a>
coms.conversation.updated@1.0.0
Emitted when conversation details (title, status, tags) are updated.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | - |
parentConversationId | string | No | Optional ID of parent conversation if this thread is a fork or sub-thread. |
title | string | No | - |
status | string | No | - |
tags | array | No | - |
Database Schema
- Table:
coms_conversations
<a name="comsinteractioncontentadded100"></a>
coms.interaction.content.added@1.0.0
Emitted when asynchronous content or metadata enrichments (AI summaries, Markdown conversions, virus scan flags) are appended to an existing interaction.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
interactionId | string | Yes | - |
content | array | Yes | - |
<a name="comsinteractiondelivered100"></a>
coms.interaction.delivered@1.0.0
Emitted when an outbound driver dispatch completes delivery to the target provider.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
interactionId | string | Yes | - |
deliveredAt | number | No | - |
<a name="comsinteraction"></a>
coms.interaction
An Interaction represents a discrete, immutable historical communication item (message, call, or letter).
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | - |
conversationId | string | Yes | - |
channelId | string | Yes | Authoring channel endpoint. |
providerUniqueId | string | No | Provider unique ID for deduplication and remote lookup. |
tags | array | No | Optional tags (e.g. read, flagged, tier:1). |
content | array | No | - |
Database Schema
- Table:
coms_interactions
<a name="comsinteractionemitted100"></a>
coms.interaction.emitted@1.0.0
Emitted when a discrete communication item (message, call, or letter) arrives or is sent.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | - |
conversationId | string | Yes | - |
channelId | string | Yes | Authoring channel endpoint. |
providerUniqueId | string | No | Provider unique ID for deduplication and remote lookup. |
tags | array | No | Optional tags (e.g. read, flagged, tier:1). |
content | array | No | - |
Database Schema
- Table:
coms_interactions
<a name="comsinteractionfailed100"></a>
coms.interaction.failed@1.0.0
Emitted when an outbound driver dispatch fails.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
interactionId | string | Yes | - |
reason | string | Yes | - |
<a name="comsmediaauthorized100"></a>
coms.media.authorized@1.0.0
Emitted when a domain or URL pattern rule is authorized for background media downloading.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
pattern | string | Yes | - |
<a name="comsmediacached100"></a>
coms.media.cached@1.0.0
Emitted when an authorized external media URL is downloaded and cached in @sullux/event-engine-files-plugin.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
url | string | Yes | - |
fileLinkId | string | Yes | - |
<a name="comsmedia"></a>
coms.media
Discovered, authorized, and cached external email/web media assets.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
url | string | Yes | - |
interactionId | string | No | - |
<a name="comsmediadiscovered100"></a>
coms.media.discovered@1.0.0
Emitted when an un-cached external remote media URL is discovered in an interaction.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
url | string | Yes | - |
interactionId | string | No | - |