@zeyos/client 0.3.0 → 0.5.0

package/okf/entities/links.md

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

package/okf/entities/mailinglists.md

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

package/okf/entities/mailingrecipients.md

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

package/okf/entities/mailservers.md

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

package/okf/entities/messagereads.md

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

package/okf/entities/messages.md

@@ -0,0 +1,104 @@
+---
+type: ZeyOS Entity
+title: Messages
+description: Email and message records.
+resource: zeyos://api/messages
+tags: [messaging, generated]
+api_backed: true
+list_operation: listMessages
+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())` | — | — |
+| `mailserver` | integer | yes | — | yes | [mailservers](/entities/mailservers.md) |
+| `ticket` | integer | yes | — | yes | [tickets](/entities/tickets.md) |
+| `opportunity` | integer | yes | — | yes | [opportunities](/entities/opportunities.md) |
+| `mailinglist` | integer | yes | — | yes | [mailinglists](/entities/mailinglists.md) |
+| `reference` | integer | yes | — | yes | [messages](/entities/messages.md) |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `mailbox` | smallint | no | `0` | — | — |
+| `verified` | smallint | no | `0` | — | — |
+| `date` | bigint | no | `date_part('epoch', now())` | yes | — |
+| `subject` | text | no | `''` | yes | — |
+| `sender` | text | no | `''` | yes | — |
+| `sender_email` | text | no | `''` | — | — |
+| `sender_name` | text | no | `''` | — | — |
+| `to` | text | no | `''` | yes | — |
+| `to_email` | text | no | `''` | — | — |
+| `to_name` | text | no | `''` | — | — |
+| `to_count` | integer | no | `0` | — | — |
+| `cc` | text | no | `''` | — | — |
+| `bcc` | text | no | `''` | — | — |
+| `contenttype` | text | no | `''` | — | — |
+| `text` | text | no | `''` | — | — |
+| `attachments` | text[] | yes | — | — | — |
+| `senddate` | bigint | yes | — | — | — |
+| `senderror` | text | no | `''` | — | — |
+| `messageid` | 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`)
+- `mailserver` → [mailservers](/entities/mailservers.md) (`mailservers.ID`)
+- `ticket` → [tickets](/entities/tickets.md) (`tickets.ID`)
+- `opportunity` → [opportunities](/entities/opportunities.md) (`opportunities.ID`)
+- `mailinglist` → [mailinglists](/entities/mailinglists.md) (`mailinglists.ID`)
+- `reference` → [messages](/entities/messages.md) (`messages.ID`)
+- `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `mailbox`
+
+`0` = INBOX · `1` = DRAFTS · `2` = SENT · `3` = TEMPLATES · `4` = MAILINGS · `5` = ARCHIVE · `6` = TRASH · `7` = JUNK
+
+# Indexes
+
+- `fk_messages_binfile` — btree, partial on `binfile`
+- `fk_messages_fork` — gin, partial on `fork`
+- `fk_messages_mailinglist` — gin, partial on `mailinglist`
+- `fk_messages_mailserver` — gin, partial on `mailserver`
+- `fk_messages_opportunity` — btree, partial on `opportunity`
+- `fk_messages_ownergroup` — gin, partial on `ownergroup`
+- `fk_messages_owneruser` — gin, partial on `owneruser`
+- `fk_messages_reference` — btree, partial on `reference`
+- `fk_messages_ticket` — btree, partial on `ticket`
+- `i_messages_inbox_date` — btree, partial on `date`
+- `i_messages_messageid` — btree, partial on `messageid`
+- `i_messages_nofork` — gin, partial on `fork`
+- `i_messages_noowner` — gin, partial on `ownergroup`
+- `i_messages_regular_date` — btree, partial on `date`
+- `i_messages_sendmail` — btree, partial on `mailserver`
+- `i_messages_trash_date` — btree, partial on `date`
+- `s_messages_sender` — gin, partial on `sender`
+- `s_messages_subject` — gin, partial on `subject`
+- `s_messages_to` — gin, partial on `to`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listMessages`
+- get: `getMessage`
+- create: `createMessage`
+- update: `updateMessage`
+- delete: `deleteMessage`
+- exists: `existsMessage`
+<!-- okf:generated:end -->
+
+# Notes
+
+No direct `account` foreign key — link via `ticket`/`opportunity`/`mailinglist`/`reference`, or resolve customer email addresses first. Reconstruct threads via `reference`/`messageid`/`subject`.

package/okf/entities/notes.md

@@ -0,0 +1,73 @@
+---
+type: ZeyOS Entity
+title: Notes
+description: Text-centric internal knowledge items.
+resource: zeyos://api/notes
+tags: [knowledge, generated]
+api_backed: true
+list_operation: listNotes
+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())` | — | — |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `status` | smallint | no | `0` | — | — |
+| `contenttype` | text | no | `''` | — | — |
+| `text` | text | no | `''` | — | — |
+| `attachments` | text[] | 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`)
+- `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_notes_assigneduser` — gin, partial on `assigneduser`
+- `fk_notes_binfile` — btree, partial on `binfile`
+- `fk_notes_fork` — gin, partial on `fork`
+- `fk_notes_ownergroup` — gin, partial on `ownergroup`
+- `fk_notes_owneruser` — gin, partial on `owneruser`
+- `i_notes_nofork` — gin, partial on `fork`
+- `i_notes_noowner` — gin, partial on `ownergroup`
+- `s_notes_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: `listNotes`
+- get: `getNote`
+- create: `createNote`
+- update: `updateNote`
+- delete: `deleteNote`
+- exists: `existsNote`
+<!-- okf:generated:end -->

package/okf/entities/objects.md

@@ -0,0 +1,70 @@
+---
+type: ZeyOS Entity
+title: Objects
+description: Custom object records with arbitrary JSON payloads.
+resource: zeyos://api/objects
+tags: [platform, generated]
+api_backed: true
+list_operation: listObjects
+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())` | — | — |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `entity` | text | no | — | yes | — |
+| `date` | bigint | no | `EXTRACT(epoch FROM now())` | yes | — |
+| `description` | text | no | `''` | — | — |
+| `data` | 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`)
+- `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+# Indexes
+
+- `fk_objects_assigneduser` — gin, partial on `assigneduser`
+- `fk_objects_binfile` — btree, partial on `binfile`
+- `fk_objects_fork` — gin, partial on `fork`
+- `fk_objects_ownergroup` — gin, partial on `ownergroup`
+- `fk_objects_owneruser` — gin, partial on `owneruser`
+- `i_objects_date` — btree on `date`
+- `i_objects_entity` — gin on `entity`
+- `i_objects_nofork` — gin, partial on `fork`
+- `i_objects_noowner` — gin, partial on `ownergroup`
+- `s_objects_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: `listObjects`
+- get: `getObject`
+- create: `createObject`
+- update: `updateObject`
+- delete: `deleteObject`
+- exists: `existsObject`
+<!-- okf:generated:end -->

package/okf/entities/opportunities.md

@@ -0,0 +1,87 @@
+---
+type: ZeyOS Entity
+title: Opportunities
+description: Sales pipeline and deal records.
+resource: zeyos://api/opportunities
+tags: [crm, generated]
+api_backed: true
+list_operation: listOpportunities
+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) |
+| `contact` | integer | yes | — | yes | [contacts](/entities/contacts.md) |
+| `campaign` | integer | yes | — | yes | [campaigns](/entities/campaigns.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `opportunitynum` | text | no | `''` | yes | — |
+| `date` | bigint | no | `EXTRACT(epoch FROM now())` | yes | — |
+| `duedate` | bigint | yes | — | — | — |
+| `status` | smallint | no | `0` | — | — |
+| `priority` | smallint | no | `2` | — | — |
+| `probability` | smallint | no | `0` | — | — |
+| `worstcase` | double precision | no | `0` | — | — |
+| `mostlikely` | double precision | no | `0` | — | — |
+| `upside` | double precision | 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`)
+- `account` → [accounts](/entities/accounts.md) (`accounts.ID`)
+- `contact` → [contacts](/entities/contacts.md) (`contacts.ID`)
+- `campaign` → [campaigns](/entities/campaigns.md) (`campaigns.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+### `status`
+
+`0` = UNEVALUATED · `1` = ELIGIBLE · `2` = FEEDBACKREQUIRED · `3` = INNEGOTIATION · `4` = OFFERED · `5` = ACCEPTED · `6` = REJECTED
+
+### `priority`
+
+`0` = LOWEST · `1` = LOW · `2` = MEDIUM · `3` = HIGH · `4` = HIGHEST
+
+# Indexes
+
+- `fk_opportunities_account` — btree, partial on `account`
+- `fk_opportunities_assigneduser` — gin, partial on `assigneduser`
+- `fk_opportunities_campaign` — btree, partial on `campaign`
+- `fk_opportunities_contact` — btree, partial on `contact`
+- `fk_opportunities_fork` — gin, partial on `fork`
+- `fk_opportunities_ownergroup` — gin on `ownergroup`
+- `i_opportunities_date` — btree on `date`
+- `i_opportunities_nofork` — gin, partial on `fork`
+- `i_opportunities_noowner` — gin, partial on `ownergroup`
+- `s_opportunities_name` — gin on `name`
+- `s_opportunities_opportunitynum` — gin, partial on `opportunitynum`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listOpportunities`
+- get: `getOpportunity`
+- create: `createOpportunity`
+- update: `updateOpportunity`
+- delete: `deleteOpportunity`
+- exists: `existsOpportunity`
+<!-- okf:generated:end -->