@zeyos/client 0.3.0 → 0.5.0

package/okf/entities/participants.md

@@ -0,0 +1,52 @@
+---
+type: ZeyOS Entity
+title: Participants
+description: Contacts enrolled in campaigns or mailing lists.
+resource: zeyos://api/participants
+tags: [outreach, generated]
+api_backed: true
+list_operation: listParticipants
+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())` | — | — |
+| `mailinglist` | integer | yes | — | yes | [mailinglists](/entities/mailinglists.md) |
+| `campaign` | integer | yes | — | yes | [campaigns](/entities/campaigns.md) |
+| `contact` | integer | yes | — | yes | [contacts](/entities/contacts.md) |
+| `name` | text | no | — | yes | — |
+| `phone` | text | no | `''` | — | — |
+| `email` | text | no | `''` | yes | — |
+
+# Foreign Keys
+
+- `mailinglist` → [mailinglists](/entities/mailinglists.md) (`mailinglists.ID`)
+- `campaign` → [campaigns](/entities/campaigns.md) (`campaigns.ID`)
+- `contact` → [contacts](/entities/contacts.md) (`contacts.ID`)
+
+# Indexes
+
+- `fk_participants_campaign` — gin, partial on `campaign`
+- `fk_participants_contact` — btree, partial on `contact`
+- `fk_participants_mailinglist` — gin, partial on `mailinglist`
+- `s_participants_email` — gin, partial on `email`
+- `s_participants_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: `listParticipants`
+- get: `getParticipant`
+- create: `createParticipant`
+- update: `updateParticipant`
+- delete: `deleteParticipant`
+- exists: `existsParticipant`
+<!-- okf:generated:end -->

package/okf/entities/payments.md

@@ -0,0 +1,76 @@
+---
+type: ZeyOS Entity
+title: Payments
+description: Cash movement records.
+resource: zeyos://api/payments
+tags: [billing, generated]
+api_backed: true
+list_operation: listPayments
+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())` | — | — |
+| `ledger` | integer | yes | — | yes | [ledgers](/entities/ledgers.md) |
+| `transaction` | integer | yes | — | yes | [transactions](/entities/transactions.md) |
+| `account` | integer | yes | — | yes | [accounts](/entities/accounts.md) |
+| `date` | bigint | no | `date_part('epoch', now())` | yes | — |
+| `subject` | text | no | `''` | yes | — |
+| `status` | smallint | no | `0` | — | — |
+| `amount` | double precision | no | — | — | — |
+| `autoadvance` | 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`)
+- `ledger` → [ledgers](/entities/ledgers.md) (`ledgers.ID`)
+- `transaction` → [transactions](/entities/transactions.md) (`transactions.ID`)
+- `account` → [accounts](/entities/accounts.md) (`accounts.ID`)
+
+# Enums
+
+### `status`
+
+`0` = DRAFT · `1` = COMPLETED · `2` = CANCELLED · `3` = BOOKED
+
+# Indexes
+
+- `fk_payments_account` — btree, partial on `account`
+- `fk_payments_assigneduser` — gin, partial on `assigneduser`
+- `fk_payments_fork` — gin, partial on `fork`
+- `fk_payments_ledger` — gin, partial on `ledger`
+- `fk_payments_ownergroup` — gin on `ownergroup`
+- `fk_payments_transaction` — btree, partial on `transaction`
+- `i_payments_date` — btree on `date`
+- `i_payments_nofork` — gin, partial on `fork`
+- `i_payments_noowner` — gin, partial on `ownergroup`
+- `s_payments_subject` — gin, partial on `subject`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listPayments`
+- get: `getPayment`
+- create: `createPayment`
+- update: `updatePayment`
+- delete: `deletePayment`
+- exists: `existsPayment`
+<!-- okf:generated:end -->
+
+# Notes
+
+Cash basis. Links to a `transaction` or directly to an `account`. Sum `amount` for cash received.

package/okf/entities/permissions.md

@@ -0,0 +1,46 @@
+---
+type: ZeyOS Entity
+title: Permissions
+description: Group-level permission grants.
+resource: zeyos://api/permissions
+tags: [platform, generated]
+api_backed: true
+list_operation: listPermissions
+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) |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `application` | integer | yes | — | yes | [applications](/entities/applications.md) |
+| `identifier` | character varying(200) | yes | — | yes | — |
+| `writable` | smallint | no | `0` | — | — |
+
+# Foreign Keys
+
+- `group` → [groups](/entities/groups.md) (`groups.ID`)
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `application` → [applications](/entities/applications.md) (`applications.ID`)
+
+# Indexes
+
+- `fk_permissions_application` — gin, partial on `application`
+- `fk_permissions_fork` — gin, partial on `fork`
+- `u_permissions_group_fork_application_identifier` — btree, unique on `group, fork, application, 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: `listPermissions`
+- get: `getPermission`
+- exists: `existsPermission`
+<!-- okf:generated:end -->

package/okf/entities/pricelists.md

@@ -0,0 +1,70 @@
+---
+type: ZeyOS Entity
+title: Price Lists
+description: Price list definitions.
+resource: zeyos://api/pricelists
+tags: [commerce, generated]
+api_backed: true
+list_operation: listPriceLists
+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 | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `activity` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `type` | smallint | no | `0` | — | — |
+| `currency` | character varying(3) | no | — | — | — |
+| `discount` | double precision | no | `0` | — | — |
+| `datefrom` | bigint | yes | — | — | — |
+| `dateto` | bigint | yes | — | — | — |
+| `applytoall` | smallint | no | `0` | — | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+
+# Enums
+
+### `activity`
+
+`0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
+
+### `type`
+
+`0` = BILLING_MIN · `1` = BILLING_MAX · `2` = PROCUREMENT_MIN · `3` = PROCUREMENT_MAX · `4` = PRODUCTION_MIN · `5` = PRODUCTION_MAX
+
+# Indexes
+
+- `fk_pricelists_fork` — gin, partial on `fork`
+- `fk_pricelists_ownergroup` — gin on `ownergroup`
+- `i_pricelists_nofork` — gin, partial on `fork`
+- `i_pricelists_noowner` — gin, partial on `ownergroup`
+- `s_pricelists_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: `listPriceLists`
+- get: `getPriceList`
+- create: `createPriceList`
+- update: `updatePriceList`
+- delete: `deletePriceList`
+- exists: `existsPriceList`
+<!-- okf:generated:end -->
+
+# Notes
+
+operationId: `listPriceLists`.

package/okf/entities/pricelists2accounts.md

@@ -0,0 +1,46 @@
+---
+type: ZeyOS Entity
+title: Price Lists To Accounts
+description: Account-to-price-list assignments.
+resource: zeyos://api/pricelists2accounts
+tags: [commerce, generated]
+api_backed: true
+list_operation: listPriceListsToAccounts
+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())` | — | — |
+| `pricelist` | integer | no | — | yes | [pricelists](/entities/pricelists.md) |
+| `account` | integer | no | — | yes | [accounts](/entities/accounts.md) |
+
+# Foreign Keys
+
+- `pricelist` → [pricelists](/entities/pricelists.md) (`pricelists.ID`)
+- `account` → [accounts](/entities/accounts.md) (`accounts.ID`)
+
+# Indexes
+
+- `fk_pricelists2accounts_account` — btree on `account`
+- `u_pricelists2accounts_pricelist_account` — btree, unique on `pricelist, account`
+
+# Operations
+
+- list: `listPriceListsToAccounts`
+- get: `getPriceListToAccount`
+- create: `createPriceListToAccount`
+- update: `updatePriceListToAccount`
+- delete: `deletePriceListToAccount`
+- exists: `existsPriceListToAccount`
+<!-- okf:generated:end -->
+
+# Notes
+
+operationId: `listPriceListsToAccounts`.

package/okf/entities/prices.md

@@ -0,0 +1,49 @@
+---
+type: ZeyOS Entity
+title: Prices
+description: Item prices within a price list.
+resource: zeyos://api/prices
+tags: [commerce, generated]
+api_backed: true
+list_operation: listPrices
+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) |
+| `pricelist` | integer | no | — | yes | [pricelists](/entities/pricelists.md) |
+| `price` | double precision | yes | — | — | — |
+| `rebate` | double precision | no | `0` | — | — |
+| `discount` | double precision | yes | — | — | — |
+| `minamount` | double precision | no | `0` | — | — |
+| `costprice` | double precision | yes | — | — | — |
+
+# Foreign Keys
+
+- `item` → [items](/entities/items.md) (`items.ID`)
+- `pricelist` → [pricelists](/entities/pricelists.md) (`pricelists.ID`)
+
+# Indexes
+
+- `fk_prices_item` — btree on `item`
+- `fk_prices_pricelist` — gin on `pricelist`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listPrices`
+- get: `getPrice`
+- create: `createPrice`
+- update: `updatePrice`
+- delete: `deletePrice`
+- exists: `existsPrice`
+<!-- okf:generated:end -->

package/okf/entities/projects.md

@@ -0,0 +1,72 @@
+---
+type: ZeyOS Entity
+title: Projects
+description: Top-level initiatives.
+resource: zeyos://api/projects
+tags: [work, generated]
+api_backed: true
+list_operation: listProjects
+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())` | — | — |
+| `account` | integer | yes | — | yes | [accounts](/entities/accounts.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `projectnum` | text | no | `''` | yes | — |
+| `status` | 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`)
+- `account` → [accounts](/entities/accounts.md) (`accounts.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` = TESTING · `8` = CANCELLED · `9` = COMPLETED · `10` = FAILED · `11` = BOOKED
+
+# Indexes
+
+- `fk_projects_account` — btree, partial on `account`
+- `fk_projects_assigneduser` — gin, partial on `assigneduser`
+- `fk_projects_fork` — gin, partial on `fork`
+- `fk_projects_ownergroup` — gin, partial on `ownergroup`
+- `fk_projects_owneruser` — gin, partial on `owneruser`
+- `i_projects_nofork` — gin, partial on `fork`
+- `i_projects_noowner` — gin, partial on `ownergroup`
+- `s_projects_name` — gin on `name`
+- `s_projects_projectnum` — gin, partial on `projectnum`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listProjects`
+- get: `getProject`
+- create: `createProject`
+- update: `updateProject`
+- delete: `deleteProject`
+- exists: `existsProject`
+<!-- okf:generated:end -->

package/okf/entities/records.md

@@ -0,0 +1,75 @@
+---
+type: ZeyOS Entity
+title: Records
+description: Generic feed and discussion records with entity/index references.
+resource: zeyos://api/records
+tags: [collaboration, generated]
+api_backed: true
+list_operation: listRecords
+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 | — |
+| `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 | — | yes | — |
+| `assigneduser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `entity` | t_entity | yes | — | yes | — |
+| `index` | integer | yes | — | yes | — |
+| `channel` | integer | yes | — | yes | [channels](/entities/channels.md) |
+| `flag` | smallint | no | `0` | — | — |
+| `date` | bigint | no | `date_part('epoch', now())` | yes | — |
+| `stickydate` | bigint | yes | — | yes | — |
+| `sender` | text | no | `''` | yes | — |
+| `location` | text | no | `''` | — | — |
+| `text` | text | 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`)
+- `assigneduser` → [users](/entities/users.md) (`users.ID`)
+- `channel` → [channels](/entities/channels.md) (`channels.ID`)
+
+# Enums
+
+### `flag`
+
+`0` = REGULAR · `1` = ASSOCONLY · `2` = MINDLOGONLY · `3` = MONITOR · `4` = FEED
+
+# Indexes
+
+- `fk_records_assigneduser` — gin, partial on `assigneduser`
+- `fk_records_channel` — btree, partial on `channel`
+- `fk_records_fork` — gin, partial on `fork`
+- `fk_records_ownergroup` — gin, partial on `ownergroup`
+- `fk_records_owneruser` — gin, partial on `owneruser`
+- `i_records_creator` — gin, partial on `creator`
+- `i_records_date` — btree on `date`
+- `i_records_entity_index` — btree, partial on `entity, index`
+- `i_records_noowner` — gin, partial on `ownergroup`
+- `i_records_stickydate` — btree, partial on `stickydate`
+- `s_records_sender` — gin, partial on `sender`
+- `s_records_text` — gin, partial on `text`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listRecords`
+- get: `getRecord`
+- create: `createRecord`
+- update: `updateRecord`
+- delete: `deleteRecord`
+- exists: `existsRecord`
+<!-- okf:generated:end -->

package/okf/entities/relateditems.md

@@ -0,0 +1,43 @@
+---
+type: ZeyOS Entity
+title: Related Items
+description: Related product links (cross-sell, substitute, accessory).
+resource: zeyos://api/relateditems
+tags: [commerce, generated]
+api_backed: true
+list_operation: listRelatedItems
+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())` | — | — |
+| `item` | integer | no | — | yes | [items](/entities/items.md) |
+| `relateditem` | integer | no | — | yes | [items](/entities/items.md) |
+| `relation` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `item` → [items](/entities/items.md) (`items.ID`)
+- `relateditem` → [items](/entities/items.md) (`items.ID`)
+
+# Indexes
+
+- `fk_relateditems_relateditem` — btree on `relateditem`
+- `u_relateditems_item_relateditem` — btree, unique on `item, relateditem`
+
+# Operations
+
+- list: `listRelatedItems`
+- get: `getRelatedItem`
+- create: `createRelatedItem`
+- update: `updateRelatedItem`
+- delete: `deleteRelatedItem`
+- exists: `existsRelatedItem`
+<!-- okf:generated:end -->

package/okf/entities/resources.md

@@ -0,0 +1,55 @@
+---
+type: ZeyOS Entity
+title: Resources
+description: Named resources linked to an application or standalone.
+resource: zeyos://api/resources
+tags: [platform, generated]
+api_backed: true
+list_operation: listResources
+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())` | — | — |
+| `application` | integer | yes | — | yes | [applications](/entities/applications.md) |
+| `activity` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `identifier` | character varying(200) | no | — | yes | — |
+| `mimetype` | text | no | `'text/x-zymba'` | — | — |
+| `public` | smallint | no | `0` | — | — |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+
+# Foreign Keys
+
+- `application` → [applications](/entities/applications.md) (`applications.ID`)
+- `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `activity`
+
+`0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
+
+# Indexes
+
+- `fk_resources_application` — gin, partial on `application`
+- `fk_resources_binfile` — btree, partial on `binfile`
+- `s_resources_identifier` — gin on `identifier`
+- `s_resources_name` — gin on `name`
+- `u_resources_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: `listResources`
+- get: `getResource`
+- exists: `existsResource`
+<!-- okf:generated:end -->

package/okf/entities/services.md

@@ -0,0 +1,64 @@
+---
+type: ZeyOS Entity
+title: Services
+description: Hook, timing, or remote-call services.
+resource: zeyos://api/services
+tags: [platform, generated]
+api_backed: true
+list_operation: listServices
+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())` | — | — |
+| `application` | integer | yes | — | yes | [applications](/entities/applications.md) |
+| `activity` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `identifier` | character varying(200) | no | — | yes | — |
+| `type` | smallint | yes | — | — | — |
+| `entity` | text | no | `''` | — | — |
+| `schedule` | integer | no | `0` | — | — |
+| `interval` | smallint | no | `1` | — | — |
+| `mimetype` | text | no | `'text/x-zymba'` | — | — |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `url` | text | no | `''` | — | — |
+| `accesskey` | bytea | yes | — | — | — |
+
+# Foreign Keys
+
+- `application` → [applications](/entities/applications.md) (`applications.ID`)
+- `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `activity`
+
+`0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
+
+### `type`
+
+`0` = TIMING · `1` = REMOTECALL · `2` = AFTER_CREATION · `3` = BEFORE_MODIFICATION · `4` = AFTER_MODIFICATION · `5` = AFTER_CREATION_MODIFICATION · `6` = BEFORE_DELETION · `7` = AFTER_DELETION
+
+# Indexes
+
+- `fk_services_application` — gin, partial on `application`
+- `fk_services_binfile` — btree, partial on `binfile`
+- `s_services_identifier` — gin on `identifier`
+- `s_services_name` — gin on `name`
+- `u_services_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: `listServices`
+- get: `getService`
+- exists: `existsService`
+<!-- okf:generated:end -->