@zeyos/client 0.3.0 → 0.4.0

package/okf/entities/devices.md

@@ -0,0 +1,65 @@
+---
+type: ZeyOS Entity
+title: Devices
+description: Inventory device records.
+resource: zeyos://api/devices
+tags: [platform, generated]
+api_backed: true
+list_operation: listDevices
+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())` | — | — |
+| `item` | integer | no | — | yes | [items](/entities/items.md) |
+| `contract` | integer | yes | — | yes | [contracts](/entities/contracts.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `serialnum` | text | no | `''` | yes | — |
+| `chargenum` | text | no | `''` | yes | — |
+| `expdate` | bigint | yes | — | — | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `item` → [items](/entities/items.md) (`items.ID`)
+- `contract` → [contracts](/entities/contracts.md) (`contracts.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+# Indexes
+
+- `fk_devices_contract` — btree, partial on `contract`
+- `fk_devices_fork` — gin, partial on `fork`
+- `fk_devices_ownergroup` — gin on `ownergroup`
+- `i_devices_nofork` — gin, partial on `fork`
+- `i_devices_noowner` — gin, partial on `ownergroup`
+- `s_devices_chargenum` — gin, partial on `chargenum`
+- `s_devices_serialnum` — gin, partial on `serialnum`
+- `u_devices_item_serialnum_chargenum` — btree, unique on `item, serialnum, chargenum`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listDevices`
+- get: `getDevice`
+- create: `createDevice`
+- update: `updateDevice`
+- delete: `deleteDevice`
+- exists: `existsDevice`
+<!-- okf:generated:end -->

package/okf/entities/documents.md

@@ -0,0 +1,76 @@
+---
+type: ZeyOS Entity
+title: Documents
+description: Formal file-like business documents.
+resource: zeyos://api/documents
+tags: [knowledge, generated]
+api_backed: true
+list_operation: listDocuments
+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 | `EXTRACT(epoch FROM now())` | — | — |
+| `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `documentnum` | text | no | `''` | yes | — |
+| `status` | smallint | no | `0` | — | — |
+| `filename` | text | no | `''` | yes | — |
+| `mimetype` | text | no | `'application/octet-stream'` | — | — |
+| `public` | smallint | no | `0` | — | — |
+| `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`)
+- `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+### `status`
+
+`0` = DRAFT · `1` = FEEDBACKREQUIRED · `2` = INREVISION · `3` = AWAITINGAPPROVAL · `4` = FINAL · `5` = OBSOLETE
+
+# Indexes
+
+- `fk_documents_assigneduser` — gin, partial on `assigneduser`
+- `fk_documents_binfile` — btree, partial on `binfile`
+- `fk_documents_fork` — gin, partial on `fork`
+- `fk_documents_ownergroup` — gin, partial on `ownergroup`
+- `fk_documents_owneruser` — gin, partial on `owneruser`
+- `i_documents_nofork` — gin, partial on `fork`
+- `i_documents_noowner` — gin, partial on `ownergroup`
+- `s_documents_documentnum` — gin, partial on `documentnum`
+- `s_documents_filename` — gin, partial on `filename`
+- `s_documents_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: `listDocuments`
+- get: `getDocument`
+- create: `createDocument`
+- update: `updateDocument`
+- delete: `deleteDocument`
+- exists: `existsDocument`
+<!-- okf:generated:end -->

package/okf/entities/dunning.md

@@ -0,0 +1,82 @@
+---
+type: ZeyOS Entity
+title: Dunning Notices
+description: Collection or dunning notices.
+resource: zeyos://api/dunning
+tags: [collections, generated]
+api_backed: true
+list_operation: listDunningNotices
+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 | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.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())` | — | — |
+| `account` | integer | yes | — | yes | [accounts](/entities/accounts.md) |
+| `dunningnum` | text | no | — | yes | — |
+| `type` | smallint | no | `0` | yes | — |
+| `date` | bigint | no | `date_part('epoch', now())` | yes | — |
+| `duedate` | bigint | yes | — | — | — |
+| `status` | smallint | no | `0` | — | — |
+| `fee` | double precision | no | `0` | — | — |
+| `recipient` | text | no | `''` | — | — |
+| `address` | text | no | `''` | — | — |
+| `postalcode` | text | no | `''` | — | — |
+| `city` | text | no | `''` | — | — |
+| `region` | text | no | `''` | — | — |
+| `country` | character varying(2) | no | `''` | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `assigneduser` → [users](/entities/users.md) (`users.ID`)
+- `account` → [accounts](/entities/accounts.md) (`accounts.ID`)
+
+# Enums
+
+### `type`
+
+`0` = LISTING · `1` = REMINDER · `2` = NOTICE
+
+### `status`
+
+`0` = DRAFT · `1` = BOOKED · `2` = CANCELLED · `3` = CLOSED
+
+# Indexes
+
+- `fk_dunning_account` — btree, partial on `account`
+- `fk_dunning_assigneduser` — gin, partial on `assigneduser`
+- `fk_dunning_fork` — gin, partial on `fork`
+- `fk_dunning_ownergroup` — gin on `ownergroup`
+- `i_dunning_date` — btree on `date`
+- `i_dunning_dunningnum` — btree on `dunningnum`
+- `i_dunning_nofork` — gin, partial on `fork`
+- `i_dunning_noowner` — gin, partial on `ownergroup`
+- `s_dunning_dunningnum` — gin on `dunningnum`
+- `u_dunning_dunningnum_type` — btree, unique, partial on `dunningnum, type`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listDunningNotices`
+- get: `getDunningNotice`
+- create: `createDunningNotice`
+- update: `updateDunningNotice`
+- delete: `deleteDunningNotice`
+- exists: `existsDunningNotice`
+<!-- okf:generated:end -->
+
+# Notes
+
+operationId trap: list via `listDunningNotices` / get via `getDunningNotice` (NOT `listDunning`). A collection-stage object, not the receivable itself.

package/okf/entities/dunning2transactions.md

@@ -0,0 +1,46 @@
+---
+type: ZeyOS Entity
+title: Dunning To Transactions
+description: Dunning-to-transaction junction.
+resource: zeyos://api/dunning2transactions
+tags: [collections, generated]
+api_backed: true
+list_operation: listDunningToTransactions
+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())` | — | — |
+| `dunning` | integer | no | — | yes | [dunning](/entities/dunning.md) |
+| `transaction` | integer | no | — | yes | [transactions](/entities/transactions.md) |
+
+# Foreign Keys
+
+- `dunning` → [dunning](/entities/dunning.md) (`dunning.ID`)
+- `transaction` → [transactions](/entities/transactions.md) (`transactions.ID`)
+
+# Indexes
+
+- `fk_dunning2transactions_transaction` — btree on `transaction`
+- `u_dunning2transactions_dunning_transaction` — btree, unique on `dunning, transaction`
+
+# Operations
+
+- list: `listDunningToTransactions`
+- get: `getDunningToTransaction`
+- create: `createDunningToTransaction`
+- update: `updateDunningToTransaction`
+- delete: `deleteDunningToTransaction`
+- exists: `existsDunningToTransaction`
+<!-- okf:generated:end -->
+
+# Notes
+
+operationId: `listDunningToTransactions`.

package/okf/entities/entities2channels.md

@@ -0,0 +1,42 @@
+---
+type: ZeyOS Entity
+title: Entities To Channels
+description: Junction between records and channels.
+resource: zeyos://api/entities2channels
+tags: [collaboration, generated]
+api_backed: true
+list_operation: listEntitiesToChannels
+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())` | — | — |
+| `entity` | t_entity | no | — | yes | — |
+| `index` | integer | no | — | yes | — |
+| `channel` | integer | no | — | yes | [channels](/entities/channels.md) |
+
+# Foreign Keys
+
+- `channel` → [channels](/entities/channels.md) (`channels.ID`)
+
+# Indexes
+
+- `fk_entities2channels_channel` — btree on `channel`
+- `u_entities2channels_entity_index` — btree, unique on `entity, index, +channel`
+
+# Operations
+
+- list: `listEntitiesToChannels`
+- get: `getEntityToChannel`
+- create: `createEntityToChannel`
+- update: `updateEntityToChannel`
+- delete: `deleteEntityToChannel`
+- exists: `existsEntityToChannel`
+<!-- okf:generated:end -->

package/okf/entities/events.md

@@ -0,0 +1,57 @@
+---
+type: ZeyOS Entity
+title: Events
+description: Generic event records attached to entities.
+resource: zeyos://api/events
+tags: [collaboration, generated]
+api_backed: true
+list_operation: listEvents
+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 | — |
+| `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 | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `entity` | t_entity | no | — | yes | — |
+| `index` | integer | no | — | yes | — |
+| `name` | text | no | — | — | — |
+| `color` | character varying(6) | no | `''` | — | — |
+| `datefrom` | bigint | no | — | yes | — |
+| `dateto` | bigint | no | — | yes | — |
+| `meta` | json | yes | — | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `owneruser` → [users](/entities/users.md) (`users.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+
+# Indexes
+
+- `fk_events_fork` — gin, partial on `fork`
+- `fk_events_ownergroup` — gin, partial on `ownergroup`
+- `fk_events_owneruser` — gin, partial on `owneruser`
+- `i_events_datefrom_dateto` — btree on `datefrom, dateto`
+- `i_events_entity_index` — btree, partial on `entity, index`
+- `i_events_noowner` — gin, partial on `ownergroup`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listEvents`
+- get: `getEvent`
+- create: `createEvent`
+- update: `updateEvent`
+- delete: `deleteEvent`
+- exists: `existsEvent`
+<!-- okf:generated:end -->

package/okf/entities/feedservers.md

@@ -0,0 +1,67 @@
+---
+type: ZeyOS Entity
+title: Feed Servers
+description: Feed server definitions.
+resource: zeyos://api/feedservers
+tags: [platform, generated]
+api_backed: true
+list_operation: listFeedServers
+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) |
+| `channel` | integer | yes | — | — | [channels](/entities/channels.md) |
+| `activity` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `url` | text | no | — | yes | — |
+| `username` | text | no | `''` | — | — |
+| `notify` | smallint | no | `0` | — | — |
+| `etag` | text | no | `''` | — | — |
+| `description` | text | no | `''` | — | — |
+| `password` | 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`)
+- `channel` → [channels](/entities/channels.md) (`channels.ID`)
+
+# Enums
+
+### `activity`
+
+`0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
+
+# Indexes
+
+- `fk_feedservers_ownergroup` — gin, partial on `ownergroup`
+- `fk_feedservers_owneruser` — gin, partial on `owneruser`
+- `i_feedservers_noowner` — gin, partial on `ownergroup`
+- `s_feedservers_name` — gin on `name`
+- `s_feedservers_url` — gin 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: `listFeedServers`
+- get: `getFeedServer`
+- create: `createFeedServer`
+- update: `updateFeedServer`
+- delete: `deleteFeedServer`
+- exists: `existsFeedServer`
+<!-- okf:generated:end -->

package/okf/entities/files.md

@@ -0,0 +1,50 @@
+---
+type: ZeyOS Entity
+title: Files
+description: Attachments linked to a record or comment.
+resource: zeyos://api/files
+tags: [knowledge, generated]
+api_backed: true
+list_operation: listFiles
+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())` | — | — |
+| `record` | bigint | yes | — | yes | [records](/entities/records.md) |
+| `comment` | bigint | yes | — | yes | [comments](/entities/comments.md) |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `filename` | text | no | `''` | yes | — |
+| `mimetype` | text | no | `'application/octet-stream'` | — | — |
+
+# Foreign Keys
+
+- `record` → [records](/entities/records.md) (`records.ID`)
+- `comment` → [comments](/entities/comments.md) (`comments.ID`)
+- `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Indexes
+
+- `fk_files_binfile` — btree, partial on `binfile`
+- `fk_files_comment` — btree, partial on `comment`
+- `fk_files_record` — btree, partial on `record`
+- `s_files_filename` — gin, partial on `filename`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listFiles`
+- get: `getFile`
+- create: `createFile`
+- update: `updateFile`
+- delete: `deleteFile`
+- exists: `existsFile`
+<!-- okf:generated:end -->

package/okf/entities/follows.md

@@ -0,0 +1,40 @@
+---
+type: ZeyOS Entity
+title: Follows
+description: Follow/watch subscriptions on entities.
+resource: zeyos://api/follows
+tags: [collaboration, generated]
+api_backed: true
+list_operation: listFollows
+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())` | — | — |
+| `entity` | t_entity | no | — | yes | — |
+| `index` | bigint | no | — | yes | — |
+
+# Foreign Keys
+
+- `creator` → [users](/entities/users.md) (`users.ID`)
+
+# Indexes
+
+- `u_follows_entity_creator_index` — btree, unique on `entity, creator, index`
+
+# Operations
+
+- list: `listFollows`
+- get: `getFollow`
+- create: `createFollow`
+- update: `updateFollow`
+- delete: `deleteFollow`
+- exists: `existsFollow`
+<!-- okf:generated:end -->

package/okf/entities/forks.md

@@ -0,0 +1,54 @@
+---
+type: ZeyOS Entity
+title: Forks
+description: Module/fork definitions with identifiers and module names.
+resource: zeyos://api/forks
+tags: [platform, generated]
+api_backed: true
+list_operation: listForks
+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 | — |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
+| `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
+| `group` | integer | yes | — | — | [groups](/entities/groups.md) |
+| `activity` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `identifier` | character varying(200) | no | — | yes | — |
+| `module` | text | no | — | — | — |
+| `color` | character varying(6) | no | `''` | — | — |
+| `langaliases` | json | yes | — | — | — |
+| `description` | text | no | `''` | — | — |
+| `settings` | json | yes | — | — | — |
+
+# Foreign Keys
+
+- `group` → [groups](/entities/groups.md) (`groups.ID`)
+
+# Enums
+
+### `activity`
+
+`0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
+
+# Indexes
+
+- `s_forks_identifier` — gin on `identifier`
+- `s_forks_name` — gin on `name`
+- `u_forks_identifier` — btree, unique on `identifier`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listForks`
+- get: `getFork`
+- exists: `existsFork`
+<!-- okf:generated:end -->

package/okf/entities/groups.md

@@ -0,0 +1,48 @@
+---
+type: ZeyOS Entity
+title: Groups
+description: User groups.
+resource: zeyos://api/groups
+tags: [platform, generated]
+api_backed: true
+list_operation: listGroups
+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 | — |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `leader` | integer | yes | — | — | [users](/entities/users.md) |
+| `activity` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `leader` → [users](/entities/users.md) (`users.ID`)
+
+# Enums
+
+### `activity`
+
+`0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
+
+# Indexes
+
+- `s_groups_name` — gin on `name`
+- `u_groups_name` — btree, unique on `lower(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: `listGroups`
+- get: `getGroup`
+- exists: `existsGroup`
+<!-- okf:generated:end -->

package/okf/entities/groups2users.md

@@ -0,0 +1,44 @@
+---
+type: ZeyOS Entity
+title: Groups To Users
+description: Group membership junction.
+resource: zeyos://api/groups2users
+tags: [platform, generated]
+api_backed: true
+list_operation: listGroupsToUsers
+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())` | — | — |
+| `group` | integer | no | — | yes | [groups](/entities/groups.md) |
+| `user` | integer | no | — | yes | [users](/entities/users.md) |
+| `writable` | smallint | no | `0` | — | — |
+
+# Foreign Keys
+
+- `group` → [groups](/entities/groups.md) (`groups.ID`)
+- `user` → [users](/entities/users.md) (`users.ID`)
+
+# Indexes
+
+- `fk_groups2users_user` — btree on `user`
+- `u_groups2users_group_user` — btree, unique on `group, user`
+
+# Operations
+
+- list: `listGroupsToUsers`
+- get: `getGroupToUser`
+- exists: `existsGroupToUser`
+<!-- okf:generated:end -->
+
+# Notes
+
+Read-only; operationId `listGroupsToUsers`.