@zeyos/client 0.3.0 → 0.4.0

package/okf/entities/index.md

@@ -0,0 +1,93 @@
+# CRM & Customer
+
+* [Accounts](accounts.md) - Customer, supplier, prospect, or employee master records.
+* [Addresses](addresses.md) - Additional address records linked to accounts or contacts.
+* [Contacts](contacts.md) - People linked to accounts.
+* [Contacts To Contacts](contacts2contacts.md) - Contact-to-contact relationships.
+* [Contracts](contracts.md) - Long-lived commercial agreements.
+* [Opportunities](opportunities.md) - Sales pipeline and deal records.
+
+# Work & Delivery
+
+* [Action Steps](actionsteps.md) - Cross-record follow-up work items with assignee, due date, status, and effort.
+* [Appointments](appointments.md) - Calendar appointments.
+* [Invitations](invitations.md) - Appointment invitations.
+* [Projects](projects.md) - Top-level initiatives.
+* [Tasks](tasks.md) - Actionable delivery work.
+* [Tickets](tickets.md) - Support or service work items.
+
+# Messaging
+
+* [Mail Servers](mailservers.md) - Mail server definitions.
+* [Message Reads](messagereads.md) - Read-tracking records for messages.
+* [Messages](messages.md) - Email and message records.
+
+# Outreach
+
+* [Campaigns](campaigns.md) - Marketing or outreach campaigns.
+* [Mailing Lists](mailinglists.md) - Mailing list definitions.
+* [Mailing Recipients](mailingrecipients.md) - Recipient records for a message.
+* [Participants](participants.md) - Contacts enrolled in campaigns or mailing lists.
+
+# Knowledge
+
+* [Documents](documents.md) - Formal file-like business documents.
+* [Files](files.md) - Attachments linked to a record or comment.
+* [Notes](notes.md) - Text-centric internal knowledge items.
+
+# Collaboration
+
+* [Channels](channels.md) - Collaboration or distribution channels.
+* [Comments](comments.md) - Record-linked comments.
+* [Entities To Channels](entities2channels.md) - Junction between records and channels.
+* [Events](events.md) - Generic event records attached to entities.
+* [Follows](follows.md) - Follow/watch subscriptions on entities.
+* [Likes](likes.md) - Lightweight positive reactions on records.
+* [Records](records.md) - Generic feed and discussion records with entity/index references.
+
+# Billing & Payments
+
+* [Ledgers](ledgers.md) - Payment ledger definitions.
+* [Payments](payments.md) - Cash movement records.
+* [Transactions](transactions.md) - Billing, procurement, or production business transactions.
+
+# Collections
+
+* [Dunning Notices](dunning.md) - Collection or dunning notices.
+* [Dunning To Transactions](dunning2transactions.md) - Dunning-to-transaction junction.
+
+# Commerce & Inventory
+
+* [Categorys](categories.md) - Category definitions.
+* [Components](components.md) - Item-to-item composition records (BOM/kit).
+* [Coupon Codes](couponcodes.md) - Codes under a coupon definition.
+* [Coupons](coupons.md) - Coupon definitions.
+* [Items](items.md) - Product and service catalog entries.
+* [Price Lists](pricelists.md) - Price list definitions.
+* [Price Lists To Accounts](pricelists2accounts.md) - Account-to-price-list assignments.
+* [Prices](prices.md) - Item prices within a price list.
+* [Related Items](relateditems.md) - Related product links (cross-sell, substitute, accessory).
+* [Stock Transactions](stocktransactions.md) - Inventory movements.
+* [Storages](storages.md) - Inventory storage locations.
+* [Suppliers](suppliers.md) - Supplier-to-item links.
+
+# Platform & Schema
+
+* [Application Assets](applicationassets.md) - Assets linked to an application.
+* [Applications](applications.md) - Application definitions.
+* [Associations](associations.md) - Generic cross-entity relation records with metadata.
+* [Bin Files](binfiles.md) - Binary file storage records.
+* [Custom Fields](customfields.md) - Custom field definitions.
+* [DAVServers](davservers.md) - DAV (calendar/contact sync) server definitions.
+* [Devices](devices.md) - Inventory device records.
+* [Feed Servers](feedservers.md) - Feed server definitions.
+* [Forks](forks.md) - Module/fork definitions with identifiers and module names.
+* [Groups](groups.md) - User groups.
+* [Groups To Users](groups2users.md) - Group membership junction.
+* [Links](links.md) - Link records with name and description.
+* [Objects](objects.md) - Custom object records with arbitrary JSON payloads.
+* [Permissions](permissions.md) - Group-level permission grants.
+* [Resources](resources.md) - Named resources linked to an application or standalone.
+* [Services](services.md) - Hook, timing, or remote-call services.
+* [Users](users.md) - System users.
+* [Weblets](weblets.md) - UI modules with view/type metadata.

package/okf/entities/invitations.md

@@ -0,0 +1,53 @@
+---
+type: ZeyOS Entity
+title: Invitations
+description: Appointment invitations.
+resource: zeyos://api/invitations
+tags: [work, generated]
+api_backed: true
+list_operation: listInvitations
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | bigint | no | — | yes | — |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `appointment` | integer | no | — | yes | [appointments](/entities/appointments.md) |
+| `contact` | integer | yes | — | yes | [contacts](/entities/contacts.md) |
+| `name` | text | no | — | — | — |
+| `email` | text | no | `''` | — | — |
+| `flag` | smallint | no | `0` | — | — |
+
+# Foreign Keys
+
+- `appointment` → [appointments](/entities/appointments.md) (`appointments.ID`)
+- `contact` → [contacts](/entities/contacts.md) (`contacts.ID`)
+
+# Enums
+
+### `flag`
+
+`0` = UNANSWERED · `1` = CONFIRMED · `2` = REJECTED
+
+# Indexes
+
+- `fk_invitations_appointment` — btree on `appointment`
+- `fk_invitations_contact` — btree, partial on `contact`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listInvitations`
+- get: `getInvitation`
+- create: `createInvitation`
+- update: `updateInvitation`
+- delete: `deleteInvitation`
+- exists: `existsInvitation`
+<!-- okf:generated:end -->

package/okf/entities/items.md

@@ -0,0 +1,95 @@
+---
+type: ZeyOS Entity
+title: Items
+description: Product and service catalog entries.
+resource: zeyos://api/items
+tags: [commerce, generated]
+api_backed: true
+list_operation: listItems
+visibility_column: true
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `model` | integer | yes | — | yes | [items](/entities/items.md) |
+| `picbinfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `manufacturer` | text | no | `''` | yes | — |
+| `itemnum` | text | no | `''` | yes | — |
+| `barcode` | text | no | `''` | yes | — |
+| `type` | smallint | no | `0` | — | — |
+| `forcestock` | smallint | yes | — | — | — |
+| `applicability` | smallint | no | `0` | — | — |
+| `unit` | character varying(3) | no | `''` | — | — |
+| `sellingprice` | double precision | no | `0` | — | — |
+| `purchaseprice` | double precision | no | `0` | — | — |
+| `taxrate` | double precision | yes | — | — | — |
+| `weight` | double precision | no | `0` | — | — |
+| `classcode` | text | no | `''` | — | — |
+| `tariffcode` | text | no | `''` | — | — |
+| `origin` | character varying(2) | no | `''` | — | — |
+| `description` | text | no | `''` | — | — |
+| `foreigntaxrates` | json | yes | — | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `model` → [items](/entities/items.md) (`items.ID`)
+- `picbinfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+### `type`
+
+`0` = SIMPLE · `1` = SERIALS · `2` = CHARGES · `3` = SERIALSANDCHARGES · `4` = SET · `5` = CONTAINER · `6` = NOSTOCK · `7` = MODEL
+
+### `forcestock`
+
+`0` = STORAGE · `1` = LOCATION
+
+### `applicability`
+
+`0` = ALWAYS · `1` = NEVER · `2` = BILLINGONLY · `3` = PROCUREMENTONLY
+
+# Indexes
+
+- `fk_items_fork` — gin, partial on `fork`
+- `fk_items_model` — btree, partial on `model`
+- `fk_items_ownergroup` — gin on `ownergroup`
+- `fk_items_picbinfile` — btree, partial on `picbinfile`
+- `i_items_barcode` — btree, partial on `barcode`
+- `i_items_itemnum` — btree, partial on `itemnum`
+- `i_items_name` — btree on `name`
+- `i_items_nofork` — gin, partial on `fork`
+- `i_items_noowner` — gin, partial on `ownergroup`
+- `s_items_barcode` — gin, partial on `barcode`
+- `s_items_itemnum` — gin, partial on `itemnum`
+- `s_items_manufacturer` — gin, partial on `manufacturer`
+- `s_items_name` — gin on `name`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listItems`
+- get: `getItem`
+- create: `createItem`
+- update: `updateItem`
+- delete: `deleteItem`
+- exists: `existsItem`
+<!-- okf:generated:end -->

package/okf/entities/ledgers.md

@@ -0,0 +1,56 @@
+---
+type: ZeyOS Entity
+title: Ledgers
+description: Payment ledger definitions.
+resource: zeyos://api/ledgers
+tags: [billing, generated]
+api_backed: true
+list_operation: listLedgers
+visibility_column: true
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+# Indexes
+
+- `fk_ledgers_fork` — gin, partial on `fork`
+- `fk_ledgers_ownergroup` — gin on `ownergroup`
+- `i_ledgers_nofork` — gin, partial on `fork`
+- `i_ledgers_noowner` — gin, partial on `ownergroup`
+- `s_ledgers_name` — gin on `name`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listLedgers`
+- get: `getLedger`
+- create: `createLedger`
+- update: `updateLedger`
+- delete: `deleteLedger`
+- exists: `existsLedger`
+<!-- okf:generated:end -->

package/okf/entities/likes.md

@@ -0,0 +1,40 @@
+---
+type: ZeyOS Entity
+title: Likes
+description: Lightweight positive reactions on records.
+resource: zeyos://api/likes
+tags: [collaboration, generated]
+api_backed: true
+list_operation: listLikes
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | bigint | no | — | yes | — |
+| `creator` | integer | no | — | yes | [users](/entities/users.md) |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
+| `record` | bigint | no | — | yes | [records](/entities/records.md) |
+
+# Foreign Keys
+
+- `creator` → [users](/entities/users.md) (`users.ID`)
+- `record` → [records](/entities/records.md) (`records.ID`)
+
+# Indexes
+
+- `u_likes_record_creator` — btree, unique on `record, creator`
+
+# Operations
+
+- list: `listLikes`
+- get: `getLike`
+- create: `createLike`
+- update: `updateLike`
+- delete: `deleteLike`
+- exists: `existsLike`
+<!-- okf:generated:end -->

package/okf/entities/links.md

@@ -0,0 +1,70 @@
+---
+type: ZeyOS Entity
+title: Links
+description: Link records with name and description.
+resource: zeyos://api/links
+tags: [platform, generated]
+api_backed: true
+list_operation: listLinks
+visibility_column: true
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `owneruser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `assigneduser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `url` | text | no | `''` | yes | — |
+| `expdate` | bigint | yes | — | — | — |
+| `username` | text | no | `''` | — | — |
+| `password` | text | no | `''` | — | — |
+| `visits` | integer | no | `0` | — | — |
+| `description` | text | no | `''` | — | — |
+| `password_encrypted` | bytea | yes | — | — | — |
+| `otpsecret` | bytea | yes | — | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `owneruser` → [users](/entities/users.md) (`users.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `assigneduser` → [users](/entities/users.md) (`users.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+# Indexes
+
+- `fk_links_assigneduser` — gin, partial on `assigneduser`
+- `fk_links_fork` — gin, partial on `fork`
+- `fk_links_ownergroup` — gin, partial on `ownergroup`
+- `fk_links_owneruser` — gin, partial on `owneruser`
+- `i_links_nofork` — gin, partial on `fork`
+- `i_links_noowner` — gin, partial on `ownergroup`
+- `s_links_name` — gin on `name`
+- `s_links_url` — gin, partial on `url`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listLinks`
+- get: `getLink`
+- create: `createLink`
+- update: `updateLink`
+- delete: `deleteLink`
+- exists: `existsLink`
+<!-- okf:generated:end -->

package/okf/entities/mailinglists.md

@@ -0,0 +1,67 @@
+---
+type: ZeyOS Entity
+title: Mailing Lists
+description: Mailing list definitions.
+resource: zeyos://api/mailinglists
+tags: [outreach, generated]
+api_backed: true
+list_operation: listMailingLists
+visibility_column: true
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `owneruser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `assigneduser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `campaign` | integer | yes | — | yes | [campaigns](/entities/campaigns.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `sender` | text | no | `''` | yes | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `owneruser` → [users](/entities/users.md) (`users.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `assigneduser` → [users](/entities/users.md) (`users.ID`)
+- `campaign` → [campaigns](/entities/campaigns.md) (`campaigns.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+# Indexes
+
+- `fk_mailinglists_assigneduser` — gin, partial on `assigneduser`
+- `fk_mailinglists_campaign` — btree, partial on `campaign`
+- `fk_mailinglists_fork` — gin, partial on `fork`
+- `fk_mailinglists_ownergroup` — gin, partial on `ownergroup`
+- `fk_mailinglists_owneruser` — gin, partial on `owneruser`
+- `i_mailinglists_nofork` — gin, partial on `fork`
+- `i_mailinglists_noowner` — gin, partial on `ownergroup`
+- `s_mailinglists_name` — gin on `name`
+- `s_mailinglists_sender` — gin, partial on `sender`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listMailingLists`
+- get: `getMailingList`
+- create: `createMailingList`
+- update: `updateMailingList`
+- delete: `deleteMailingList`
+- exists: `existsMailingList`
+<!-- okf:generated:end -->

package/okf/entities/mailingrecipients.md

@@ -0,0 +1,45 @@
+---
+type: ZeyOS Entity
+title: Mailing Recipients
+description: Recipient records for a message.
+resource: zeyos://api/mailingrecipients
+tags: [outreach, generated]
+api_backed: true
+list_operation: listMailingRecipients
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | bigint | no | — | yes | — |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
+| `message` | integer | no | — | yes | [messages](/entities/messages.md) |
+| `participant` | bigint | yes | — | yes | [participants](/entities/participants.md) |
+| `email` | text | no | — | — | — |
+
+# Foreign Keys
+
+- `message` → [messages](/entities/messages.md) (`messages.ID`)
+- `participant` → [participants](/entities/participants.md) (`participants.ID`)
+
+# Indexes
+
+- `fk_mailingrecipients_message` — btree on `message`
+- `u_mailingrecipients_participant_message` — btree, unique, partial on `participant, message`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listMailingRecipients`
+- get: `getMailingRecipient`
+- create: `createMailingRecipient`
+- update: `updateMailingRecipient`
+- delete: `deleteMailingRecipient`
+- exists: `existsMailingRecipients`
+<!-- okf:generated:end -->

package/okf/entities/mailservers.md

@@ -0,0 +1,77 @@
+---
+type: ZeyOS Entity
+title: Mail Servers
+description: Mail server definitions.
+resource: zeyos://api/mailservers
+tags: [messaging, generated]
+api_backed: true
+list_operation: listMailServers
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `owneruser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `recipientuser` | integer | yes | — | — | [users](/entities/users.md) |
+| `recipientgroup` | integer | yes | — | — | [groups](/entities/groups.md) |
+| `autoreplybinfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `signaturebinfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `activity` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `sender` | text | no | `''` | yes | — |
+| `serverin` | text | no | `''` | yes | — |
+| `usernamein` | text | no | `''` | — | — |
+| `serverout` | text | no | `''` | yes | — |
+| `usernameout` | text | no | `''` | — | — |
+| `description` | text | no | `''` | — | — |
+| `ticketing` | json | yes | — | — | — |
+| `folders` | json | yes | — | — | — |
+| `passwordin` | bytea | yes | — | — | — |
+| `passwordout` | bytea | yes | — | — | — |
+
+# Foreign Keys
+
+- `owneruser` → [users](/entities/users.md) (`users.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `recipientuser` → [users](/entities/users.md) (`users.ID`)
+- `recipientgroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `autoreplybinfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+- `signaturebinfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `activity`
+
+`0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
+
+# Indexes
+
+- `fk_mailservers_autoreplybinfile` — btree, partial on `autoreplybinfile`
+- `fk_mailservers_ownergroup` — gin, partial on `ownergroup`
+- `fk_mailservers_owneruser` — gin, partial on `owneruser`
+- `fk_mailservers_signaturebinfile` — btree, partial on `signaturebinfile`
+- `i_mailservers_noowner` — gin, partial on `ownergroup`
+- `s_mailservers_name` — gin on `name`
+- `s_mailservers_sender` — gin, partial on `sender`
+- `s_mailservers_serverin` — gin, partial on `serverin`
+- `s_mailservers_serverout` — gin, partial on `serverout`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listMailServers`
+- get: `getMailServer`
+- create: `createMailServer`
+- update: `updateMailServer`
+- delete: `deleteMailServer`
+- exists: `existsMailServer`
+<!-- okf:generated:end -->

package/okf/entities/messagereads.md

@@ -0,0 +1,40 @@
+---
+type: ZeyOS Entity
+title: Message Reads
+description: Read-tracking records for messages.
+resource: zeyos://api/messagereads
+tags: [messaging, generated]
+api_backed: true
+list_operation: listMessageReads
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | bigint | no | — | yes | — |
+| `creator` | integer | no | — | yes | [users](/entities/users.md) |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
+| `message` | integer | no | — | yes | [messages](/entities/messages.md) |
+
+# Foreign Keys
+
+- `creator` → [users](/entities/users.md) (`users.ID`)
+- `message` → [messages](/entities/messages.md) (`messages.ID`)
+
+# Indexes
+
+- `u_messagereads_message_creator` — btree, unique on `message, creator`
+
+# Operations
+
+- list: `listMessageReads`
+- get: `getMessageRead`
+- create: `createMessageRead`
+- update: `updateMessageRead`
+- delete: `deleteMessageRead`
+- exists: `existsMessageRead`
+<!-- okf:generated:end -->