@zeyos/client 0.2.0 → 0.4.0

package/okf/entities/appointments.md

@@ -0,0 +1,79 @@
+---
+type: ZeyOS Entity
+title: Appointments
+description: Calendar appointments.
+resource: zeyos://api/appointments
+tags: [work, generated]
+api_backed: true
+list_operation: listAppointments
+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())` | — | — |
+| `davserver` | integer | yes | — | yes | [davservers](/entities/davservers.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `location` | text | no | `''` | yes | — |
+| `color` | character varying(6) | no | `''` | — | — |
+| `datefrom` | bigint | no | — | yes | — |
+| `dateto` | bigint | no | — | yes | — |
+| `recurrence` | smallint | yes | — | — | — |
+| `interval` | smallint | no | `1` | — | — |
+| `maxoccurrences` | integer | no | `0` | — | — |
+| `daterecurrence` | bigint | 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`)
+- `davserver` → [davservers](/entities/davservers.md) (`davservers.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+### `recurrence`
+
+`0` = DAY · `1` = WORKDAY · `2` = WEEK · `3` = MONTH · `4` = YEAR
+
+# Indexes
+
+- `fk_appointments_assigneduser` — gin, partial on `assigneduser`
+- `fk_appointments_davserver` — gin, partial on `davserver`
+- `fk_appointments_fork` — gin, partial on `fork`
+- `fk_appointments_ownergroup` — gin, partial on `ownergroup`
+- `fk_appointments_owneruser` — gin, partial on `owneruser`
+- `i_appointments_datefrom_dateto` — btree on `datefrom, dateto`
+- `i_appointments_nofork` — gin, partial on `fork`
+- `i_appointments_noowner` — gin, partial on `ownergroup`
+- `s_appointments_location` — gin, partial on `location`
+- `s_appointments_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: `listAppointments`
+- get: `getAppointment`
+- create: `createAppointment`
+- update: `updateAppointment`
+- delete: `deleteAppointment`
+- exists: `existsAppointment`
+<!-- okf:generated:end -->

package/okf/entities/associations.md

@@ -0,0 +1,41 @@
+---
+type: ZeyOS Entity
+title: Associations
+description: Generic cross-entity relation records with metadata.
+resource: zeyos://api/associations
+tags: [platform, generated]
+api_backed: true
+list_operation: listAssociations
+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())` | — | — |
+| `entity1` | t_entity | no | — | yes | — |
+| `entity2` | t_entity | no | — | yes | — |
+| `index1` | integer | no | — | yes | — |
+| `index2` | integer | no | — | yes | — |
+| `relation` | text | no | `''` | — | — |
+| `meta` | json | yes | — | — | — |
+
+# Indexes
+
+- `i_associations_entity2_index2` — btree on `entity2, index2`
+- `u_associations_entity1_index1_entity2_index2` — btree, unique on `entity1, index1, entity2, index2`
+
+# Operations
+
+- list: `listAssociations`
+- get: `getAssociation`
+- create: `createAssociation`
+- update: `updateAssociation`
+- delete: `deleteAssociation`
+- exists: `existsAssociation`
+<!-- okf:generated:end -->

package/okf/entities/binfiles.md

@@ -0,0 +1,32 @@
+---
+type: ZeyOS Entity
+title: Bin Files
+description: Binary file storage records.
+resource: zeyos://api/binfiles
+tags: [platform, generated]
+api_backed: true
+list_operation: listBinFiles
+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 | — |
+| `size` | integer | no | — | yes | — |
+| `hash` | bytea | no | — | yes | — |
+
+# Indexes
+
+- `i_binfiles_hash` — hash on `hash`
+
+# Operations
+
+- list: `listBinFiles`
+<!-- okf:generated:end -->
+
+# Notes
+
+List-only: `listBinFiles`.

package/okf/entities/campaigns.md

@@ -0,0 +1,66 @@
+---
+type: ZeyOS Entity
+title: Campaigns
+description: Marketing or outreach campaigns.
+resource: zeyos://api/campaigns
+tags: [outreach, generated]
+api_backed: true
+list_operation: listCampaigns
+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 | — | — | — |
+| `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 | — |
+| `datefrom` | bigint | no | — | — | — |
+| `dateto` | bigint | yes | — | — | — |
+| `status` | smallint | no | `0` | — | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `assigneduser` → [users](/entities/users.md) (`users.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+### `status`
+
+`0` = DRAFT · `1` = NOTSTARTED · `2` = AWAITINGAPPROVAL · `3` = APPROVED · `4` = DISMISSED · `5` = ACTIVE · `6` = INACTIVE · `7` = INEVALUATION · `8` = CANCELLED · `9` = CLOSED
+
+# Indexes
+
+- `fk_campaigns_assigneduser` — gin, partial on `assigneduser`
+- `fk_campaigns_fork` — gin, partial on `fork`
+- `fk_campaigns_ownergroup` — gin on `ownergroup`
+- `i_campaigns_nofork` — gin, partial on `fork`
+- `i_campaigns_noowner` — gin, partial on `ownergroup`
+- `s_campaigns_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: `listCampaigns`
+- get: `getCampaign`
+- create: `createCampaign`
+- update: `updateCampaign`
+- delete: `deleteCampaign`
+- exists: `existsCampaign`
+<!-- okf:generated:end -->

package/okf/entities/categories.md

@@ -0,0 +1,55 @@
+---
+type: ZeyOS Entity
+title: Categorys
+description: Category definitions.
+resource: zeyos://api/categories
+tags: [commerce, generated]
+api_backed: true
+list_operation: listCategorys
+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 | `EXTRACT(epoch FROM now())` | — | — |
+| `entity` | text | no | — | yes | — |
+| `name` | text | no | — | 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
+
+- `i_categories_entity_name_root` — btree, partial on `entity, name`
+- `i_categories_entity_name_sub` — btree, partial on `entity, name`
+- `i_categories_fork_entity_name_root` — btree, partial on `fork, entity, name`
+- `i_categories_fork_entity_name_sub` — btree, partial on `fork, entity, name`
+- `u_categories_fork_entity_name_owneruser_ownergroup` — btree, unique on `fork, entity, name, owneruser, 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: `listCategorys`
+- get: `getCategory`
+- create: `createCategory`
+- update: `updateCategory`
+- delete: `deleteCategory`
+- exists: `existsCategory`
+<!-- okf:generated:end -->
+
+# Notes
+
+operationId trap: list op is `listCategorys` (sic); singular ops use `Category`.

package/okf/entities/channels.md

@@ -0,0 +1,54 @@
+---
+type: ZeyOS Entity
+title: Channels
+description: Collaboration or distribution channels.
+resource: zeyos://api/channels
+tags: [collaboration, generated]
+api_backed: true
+list_operation: listChannels
+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 | `EXTRACT(epoch FROM now())` | — | — |
+| `activity` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `owneruser` → [users](/entities/users.md) (`users.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+
+# Enums
+
+### `activity`
+
+`0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
+
+# Indexes
+
+- `fk_channels_ownergroup` — gin, partial on `ownergroup`
+- `fk_channels_owneruser` — gin, partial on `owneruser`
+- `s_channels_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: `listChannels`
+- get: `getChannel`
+- create: `createChannel`
+- update: `updateChannel`
+- delete: `deleteChannel`
+- exists: `existsChannel`
+<!-- okf:generated:end -->

package/okf/entities/comments.md

@@ -0,0 +1,44 @@
+---
+type: ZeyOS Entity
+title: Comments
+description: Record-linked comments.
+resource: zeyos://api/comments
+tags: [collaboration, generated]
+api_backed: true
+list_operation: listComments
+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 | no | — | yes | [records](/entities/records.md) |
+| `date` | bigint | no | `EXTRACT(epoch FROM now())` | yes | — |
+| `sender` | text | no | `''` | — | — |
+| `text` | text | no | `''` | — | — |
+| `meta` | json | yes | — | — | — |
+
+# Foreign Keys
+
+- `record` → [records](/entities/records.md) (`records.ID`)
+
+# Indexes
+
+- `fk_comments_record` — btree on `record`
+- `i_comments_date` — btree on `date`
+
+# Operations
+
+- list: `listComments`
+- get: `getComment`
+- create: `createComment`
+- update: `updateComment`
+- delete: `deleteComment`
+- exists: `existsComment`
+<!-- okf:generated:end -->

package/okf/entities/components.md

@@ -0,0 +1,46 @@
+---
+type: ZeyOS Entity
+title: Components
+description: Item-to-item composition records (BOM/kit).
+resource: zeyos://api/components
+tags: [commerce, generated]
+api_backed: true
+list_operation: listComponents
+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())` | — | — |
+| `item` | integer | no | — | yes | [items](/entities/items.md) |
+| `component` | integer | no | — | yes | [items](/entities/items.md) |
+| `amount` | double precision | no | `0` | — | — |
+| `price` | double precision | yes | — | — | — |
+| `fixed` | smallint | no | `0` | — | — |
+| `order` | integer | yes | — | — | — |
+
+# Foreign Keys
+
+- `item` → [items](/entities/items.md) (`items.ID`)
+- `component` → [items](/entities/items.md) (`items.ID`)
+
+# Indexes
+
+- `fk_components_component` — btree on `component`
+- `u_components_item_component` — btree, unique on `item, component`
+
+# Operations
+
+- list: `listComponents`
+- get: `getComponent`
+- create: `createComponent`
+- update: `updateComponent`
+- delete: `deleteComponent`
+- exists: `existsComponent`
+<!-- okf:generated:end -->

package/okf/entities/contacts.md

@@ -0,0 +1,96 @@
+---
+type: ZeyOS Entity
+title: Contacts
+description: People linked to accounts.
+resource: zeyos://api/contacts
+tags: [crm, generated]
+api_backed: true
+list_operation: listContacts
+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())` | — | — |
+| `davserver` | integer | yes | — | yes | [davservers](/entities/davservers.md) |
+| `picbinfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `lastname` | text | no | `''` | yes | — |
+| `firstname` | text | no | `''` | yes | — |
+| `type` | smallint | no | `0` | — | — |
+| `title` | text | no | `''` | — | — |
+| `company` | text | no | `''` | yes | — |
+| `position` | text | no | `''` | — | — |
+| `department` | text | no | `''` | — | — |
+| `address` | text | no | `''` | — | — |
+| `postalcode` | text | no | `''` | — | — |
+| `city` | text | no | `''` | — | — |
+| `region` | text | no | `''` | — | — |
+| `country` | character varying(2) | no | `''` | — | — |
+| `phone` | text | no | `''` | — | — |
+| `phone2` | text | no | `''` | — | — |
+| `cell` | text | no | `''` | — | — |
+| `fax` | text | no | `''` | — | — |
+| `email` | text | no | `''` | yes | — |
+| `email2` | text | no | `''` | yes | — |
+| `website` | text | no | `''` | — | — |
+| `birthdate` | bigint | 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`)
+- `davserver` → [davservers](/entities/davservers.md) (`davservers.ID`)
+- `picbinfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+### `type`
+
+`0` = COMPANY · `1` = PERSON
+
+# Indexes
+
+- `fk_contacts_assigneduser` — gin, partial on `assigneduser`
+- `fk_contacts_davserver` — gin, partial on `davserver`
+- `fk_contacts_fork` — gin, partial on `fork`
+- `fk_contacts_ownergroup` — gin, partial on `ownergroup`
+- `fk_contacts_owneruser` — gin, partial on `owneruser`
+- `fk_contacts_picbinfile` — btree, partial on `picbinfile`
+- `i_contacts_lastname_firstname` — btree on `lastname, firstname`
+- `i_contacts_nofork` — gin, partial on `fork`
+- `i_contacts_noowner` — gin, partial on `ownergroup`
+- `s_contacts_company` — gin, partial on `company`
+- `s_contacts_email` — gin, partial on `email`
+- `s_contacts_email2` — gin, partial on `email2`
+- `s_contacts_firstname` — gin, partial on `firstname`
+- `s_contacts_lastname` — gin, partial on `lastname`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listContacts`
+- get: `getContact`
+- create: `createContact`
+- update: `updateContact`
+- delete: `deleteContact`
+- exists: `existsContact`
+<!-- okf:generated:end -->

package/okf/entities/contacts2contacts.md

@@ -0,0 +1,42 @@
+---
+type: ZeyOS Entity
+title: Contacts To Contacts
+description: Contact-to-contact relationships.
+resource: zeyos://api/contacts2contacts
+tags: [crm, generated]
+api_backed: true
+list_operation: listContactsToContacts
+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())` | — | — |
+| `contact1` | integer | no | — | yes | [contacts](/entities/contacts.md) |
+| `contact2` | integer | no | — | yes | [contacts](/entities/contacts.md) |
+
+# Foreign Keys
+
+- `contact1` → [contacts](/entities/contacts.md) (`contacts.ID`)
+- `contact2` → [contacts](/entities/contacts.md) (`contacts.ID`)
+
+# Indexes
+
+- `fk_contacts2contacts_contact2` — btree on `contact2`
+- `u_contacts2contacts_contact1_contact2` — btree, unique on `contact1, contact2`
+
+# Operations
+
+- list: `listContactsToContacts`
+- get: `getContactToContact`
+- create: `createContactToContact`
+- update: `updateContactToContact`
+- delete: `deleteContactToContact`
+- exists: `existsContactToContact`
+<!-- okf:generated:end -->

package/okf/entities/contracts.md

@@ -0,0 +1,83 @@
+---
+type: ZeyOS Entity
+title: Contracts
+description: Long-lived commercial agreements.
+resource: zeyos://api/contracts
+tags: [crm, generated]
+api_backed: true
+list_operation: listContracts
+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 | — | — | — |
+| `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) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `contractnum` | text | no | `''` | yes | — |
+| `date` | bigint | no | `EXTRACT(epoch FROM now())` | yes | — |
+| `datefrom` | bigint | yes | — | — | — |
+| `dateto` | bigint | yes | — | — | — |
+| `datecancel` | bigint | yes | — | — | — |
+| `status` | smallint | no | `0` | yes | — |
+| `currency` | character varying(3) | no | — | — | — |
+| `exchangerate` | double precision | no | `1` | — | — |
+| `billingcycle` | smallint | yes | — | — | — |
+| `lastbilling` | bigint | yes | — | — | — |
+| `description` | text | no | `''` | — | — |
+| `contractitems` | json | yes | — | — | — |
+| `billingitems` | json | yes | — | — | — |
+| `procurementitems` | json | yes | — | — | — |
+| `autobilling` | json | yes | — | — | — |
+
+# 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
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+### `status`
+
+`0` = DRAFT · `1` = AWAITINGAPPROVAL · `2` = APPROVED · `3` = DISMISSED · `4` = ACTIVE · `5` = INACTIVE · `6` = EXPIRED · `7` = CANCELLED · `8` = CLOSED
+
+# Indexes
+
+- `fk_contracts_account` — btree, partial on `account`
+- `fk_contracts_assigneduser` — gin, partial on `assigneduser`
+- `fk_contracts_fork` — gin, partial on `fork`
+- `fk_contracts_ownergroup` — gin on `ownergroup`
+- `i_contracts_autobilling` — gin, partial on `status`
+- `i_contracts_date` — btree on `date`
+- `i_contracts_nofork` — gin, partial on `fork`
+- `i_contracts_noowner` — gin, partial on `ownergroup`
+- `s_contracts_contractnum` — gin, partial on `contractnum`
+- `s_contracts_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: `listContracts`
+- get: `getContract`
+- create: `createContract`
+- update: `updateContract`
+- delete: `deleteContract`
+- exists: `existsContract`
+<!-- okf:generated:end -->