@zeyos/client 0.3.0 → 0.4.0

package/okf/concepts/operationid-vocabulary.md

@@ -0,0 +1,17 @@
+---
+type: Reference
+title: operationId ≠ table noun
+description: "REST operationIds are CamelCase compounds; several diverge from the dbref noun."
+tags: [query]
+---
+
+The dbref table noun (also the REST URL path segment) is **not** the `@zeyos/client` operationId. Most follow `list<Plural>`/`get<Singular>`/… but several diverge:
+
+- `dunning` → `listDunningNotices` / `getDunningNotice`
+- `dunning2transactions` → `listDunningToTransactions`
+- `pricelists` → `listPriceLists`; `pricelists2accounts` → `listPriceListsToAccounts`
+- `mailinglists` → `listMailingLists`; `actionsteps` → `listActionSteps`
+- `categories` → `listCategorys` (sic) but `getCategory`
+- `davservers` → `listDAVServers`; `binfiles` → `listBinFiles` (list-only)
+
+Each entity concept's **Operations** section lists its real operationIds (read straight from `api.json`). `client.schema.validate()` suggests the closest operationId for an unknown name.

package/okf/concepts/visibility-column.md

@@ -0,0 +1,13 @@
+---
+type: Reference
+title: visibility: 0 (only where the column exists)
+description: "visibility:0 hides archived rows — but only resources that have the column."
+tags: [query]
+---
+
+`visibility = 0` excludes archived/deleted rows, but **only some resources have a `visibility` column**:
+
+- Have it: [tickets](/entities/tickets.md), [accounts](/entities/accounts.md), [items](/entities/items.md).
+- Do **not** have it: [transactions](/entities/transactions.md) — adding `"visibility":0` there returns an opaque **HTTP 400**.
+
+More generally, filtering on any column a resource lacks 400s with no field name. Include `visibility:0` on resources that have it unless the user wants archived records; `zeyos describe <resource>` tells you whether the column exists.

package/okf/entities/accounts.md

@@ -0,0 +1,82 @@
+---
+type: ZeyOS Entity
+title: Accounts
+description: Customer, supplier, prospect, or employee master records.
+resource: zeyos://api/accounts
+tags: [crm, generated]
+api_backed: true
+list_operation: listAccounts
+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())` | — | — |
+| `contact` | integer | yes | — | yes | [contacts](/entities/contacts.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `lastname` | text | no | `''` | yes | — |
+| `firstname` | text | no | `''` | yes | — |
+| `type` | smallint | no | `0` | — | — |
+| `customernum` | text | no | `''` | yes | — |
+| `suppliernum` | text | no | `''` | yes | — |
+| `taxid` | text | no | `''` | — | — |
+| `currency` | character varying(3) | no | — | — | — |
+| `locked` | smallint | no | `0` | — | — |
+| `excludetax` | 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`)
+- `contact` → [contacts](/entities/contacts.md) (`contacts.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+### `type`
+
+`0` = PROSPECT · `1` = CUSTOMER · `2` = SUPPLIER · `3` = CUSTOMERANDSUPPLIER · `4` = COMPETITOR · `5` = EMPLOYEE
+
+# Indexes
+
+- `fk_accounts_assigneduser` — gin, partial on `assigneduser`
+- `fk_accounts_contact` — btree, partial on `contact`
+- `fk_accounts_fork` — gin, partial on `fork`
+- `fk_accounts_ownergroup` — gin on `ownergroup`
+- `i_accounts_lastname_firstname` — btree on `lastname, firstname`
+- `i_accounts_nofork` — gin, partial on `fork`
+- `i_accounts_noowner` — gin, partial on `ownergroup`
+- `s_accounts_customernum` — gin, partial on `customernum`
+- `s_accounts_firstname` — gin, partial on `firstname`
+- `s_accounts_lastname` — gin, partial on `lastname`
+- `s_accounts_suppliernum` — gin, partial on `suppliernum`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listAccounts`
+- get: `getAccount`
+- create: `createAccount`
+- update: `updateAccount`
+- delete: `deleteAccount`
+- exists: `existsAccount`
+<!-- okf:generated:end -->
+
+# Notes
+
+No `name` column — use `lastname` + `firstname`. `type`: 0=PROSPECT,1=CUSTOMER,2=SUPPLIER,3=CUSTOMERANDSUPPLIER,4=COMPETITOR,5=EMPLOYEE. `createAccount` REQUIRES `currency` (NOT NULL, no default) or it 500s.

package/okf/entities/actionsteps.md

@@ -0,0 +1,84 @@
+---
+type: ZeyOS Entity
+title: Action Steps
+description: Cross-record follow-up work items with assignee, due date, status, and effort.
+resource: zeyos://api/actionsteps
+tags: [work, generated]
+api_backed: true
+list_operation: listActionSteps
+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 | — | — | — |
+| `assigneduser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `task` | integer | yes | — | yes | [tasks](/entities/tasks.md) |
+| `ticket` | integer | yes | — | yes | [tickets](/entities/tickets.md) |
+| `account` | integer | yes | — | yes | [accounts](/entities/accounts.md) |
+| `transaction` | integer | yes | — | yes | [transactions](/entities/transactions.md) |
+| `name` | text | no | — | yes | — |
+| `actionnum` | text | no | `''` | yes | — |
+| `date` | bigint | no | `date_part('epoch', now())` | yes | — |
+| `duedate` | bigint | yes | — | — | — |
+| `status` | smallint | no | `0` | — | — |
+| `effort` | integer | 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`)
+- `task` → [tasks](/entities/tasks.md) (`tasks.ID`)
+- `ticket` → [tickets](/entities/tickets.md) (`tickets.ID`)
+- `account` → [accounts](/entities/accounts.md) (`accounts.ID`)
+- `transaction` → [transactions](/entities/transactions.md) (`transactions.ID`)
+
+# Enums
+
+### `status`
+
+`0` = DRAFT · `1` = COMPLETED · `2` = CANCELLED · `3` = BOOKED
+
+# Indexes
+
+- `fk_actionsteps_account` — btree, partial on `account`
+- `fk_actionsteps_assigneduser` — gin, partial on `assigneduser`
+- `fk_actionsteps_fork` — gin, partial on `fork`
+- `fk_actionsteps_ownergroup` — gin, partial on `ownergroup`
+- `fk_actionsteps_owneruser` — gin, partial on `owneruser`
+- `fk_actionsteps_task` — btree, partial on `task`
+- `fk_actionsteps_ticket` — btree, partial on `ticket`
+- `fk_actionsteps_transaction` — btree, partial on `transaction`
+- `i_actionsteps_date` — btree on `date`
+- `i_actionsteps_nofork` — gin, partial on `fork`
+- `i_actionsteps_noowner` — gin, partial on `ownergroup`
+- `s_actionsteps_actionnum` — gin, partial on `actionnum`
+- `s_actionsteps_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: `listActionSteps`
+- get: `getActionStep`
+- create: `createActionStep`
+- update: `updateActionStep`
+- delete: `deleteActionStep`
+- exists: `existsActionStep`
+<!-- okf:generated:end -->
+
+# Notes
+
+Record-bound follow-ups (linked to a task, ticket, or account, with optional transaction). Do not inflate into full project tasks.

package/okf/entities/addresses.md

@@ -0,0 +1,50 @@
+---
+type: ZeyOS Entity
+title: Addresses
+description: Additional address records linked to accounts or contacts.
+resource: zeyos://api/addresses
+tags: [crm, generated]
+api_backed: true
+list_operation: listAddresses
+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())` | — | — |
+| `account` | integer | no | — | yes | [accounts](/entities/accounts.md) |
+| `contact` | integer | no | — | yes | [contacts](/entities/contacts.md) |
+| `type` | smallint | no | `0` | yes | — |
+| `default` | smallint | no | `0` | yes | — |
+
+# Foreign Keys
+
+- `account` → [accounts](/entities/accounts.md) (`accounts.ID`)
+- `contact` → [contacts](/entities/contacts.md) (`contacts.ID`)
+
+# Enums
+
+### `type`
+
+`0` = BILLING_SHIPPING · `1` = BILLING_BILLING · `2` = PROCUREMENT_SHIPPING · `3` = PROCUREMENT_BILLING · `4` = COLLECTION · `5` = BILLING_SELLER · `6` = PROCUREMENT_SELLER
+
+# Indexes
+
+- `fk_addresses_contact` — btree on `contact`
+- `u_addresses_account_contact_type` — btree, unique on `account, contact, type, +default`
+
+# Operations
+
+- list: `listAddresses`
+- get: `getAddress`
+- create: `createAddress`
+- update: `updateAddress`
+- delete: `deleteAddress`
+- exists: `existsAddress`
+<!-- okf:generated:end -->

package/okf/entities/applicationassets.md

@@ -0,0 +1,43 @@
+---
+type: ZeyOS Entity
+title: Application Assets
+description: Assets linked to an application.
+resource: zeyos://api/applicationassets
+tags: [platform, generated]
+api_backed: true
+list_operation: listApplicationAssets
+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 | `EXTRACT(epoch FROM now())` | — | — |
+| `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
+| `application` | integer | no | — | yes | [applications](/entities/applications.md) |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `filename` | text | no | — | yes | — |
+| `mimetype` | text | no | `'application/octet-stream'` | — | — |
+
+# Foreign Keys
+
+- `application` → [applications](/entities/applications.md) (`applications.ID`)
+- `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Indexes
+
+- `fk_applicationassets_binfile` — btree, partial on `binfile`
+- `u_applicationassets_application_filename` — btree, unique on `application, 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: `listApplicationAssets`
+- get: `getApplicationAsset`
+- exists: `existsApplicationAsset`
+<!-- okf:generated:end -->

package/okf/entities/applications.md

@@ -0,0 +1,62 @@
+---
+type: ZeyOS Entity
+title: Applications
+description: Application definitions.
+resource: zeyos://api/applications
+tags: [platform, generated]
+api_backed: true
+list_operation: listApplications
+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())` | — | — |
+| `activity` | smallint | no | `0` | — | — |
+| `readmebinfile` | integer | yes | — | — | [binfiles](/entities/binfiles.md) |
+| `name` | text | no | — | yes | — |
+| `identifier` | character varying(200) | no | — | yes | — |
+| `vendor` | text | no | `''` | — | — |
+| `restricted` | smallint | no | `0` | — | — |
+| `callbackurls` | text[] | yes | — | — | — |
+| `settingscodebinfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `usersettingscodebinfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `secret` | bytea | yes | — | yes | — |
+| `defaultsettings` | json | yes | — | — | — |
+| `settings` | json | yes | — | — | — |
+
+# Foreign Keys
+
+- `readmebinfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+- `settingscodebinfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+- `usersettingscodebinfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `activity`
+
+`0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
+
+# Indexes
+
+- `fk_applications_settingscodebinfile` — btree, partial on `settingscodebinfile`
+- `fk_applications_usersettingscodebinfile` — btree, partial on `usersettingscodebinfile`
+- `s_applications_identifier` — gin on `identifier`
+- `s_applications_name` — gin on `name`
+- `u_applications_identifier` — btree, unique on `identifier`
+- `u_applications_secret` — btree, unique, partial on `secret`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listApplications`
+- get: `getApplication`
+- exists: `existsApplication`
+<!-- okf:generated:end -->

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`.