@zeyos/client 0.2.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/CHANGELOG.md +33 -4
  2. package/README.md +31 -1
  3. package/agents/README.md +4 -0
  4. package/agents/shared/zeyos-entity-map.md +5 -1
  5. package/agents/shared/zeyos-entity-reference.md +89 -33
  6. package/agents/zeyos-mail-operations/SKILL.md +7 -1
  7. package/agents/zeyos-mail-operations/references/workflows.md +19 -2
  8. package/agents/zeyos-platform-and-schema/SKILL.md +1 -1
  9. package/agents/zeyos-platform-and-schema/references/workflows.md +21 -5
  10. package/agents/zeyos-time-tracking/SKILL.md +48 -0
  11. package/agents/zeyos-time-tracking/references/workflows.md +230 -0
  12. package/agents/zeyos-work-management/SKILL.md +5 -2
  13. package/agents/zeyos-work-management/references/workflows.md +54 -4
  14. package/docs/02-javascript-client/03-making-requests.md +46 -1
  15. package/docs/03-cli/02-commands.md +63 -1
  16. package/docs/03-cli/03-configuration.md +37 -5
  17. package/docs/04-agent-workflows/01-agent-quickstart.md +24 -0
  18. package/docs/04-agent-workflows/03-cli-coverage-and-escalation.md +3 -2
  19. package/docs/06-okf/01-overview.md +70 -0
  20. package/docs/06-okf/02-producing-and-consuming.md +46 -0
  21. package/docs/06-okf/03-keeping-fresh.md +53 -0
  22. package/docs/06-okf/04-loops.md +58 -0
  23. package/docs/06-okf/_category_.json +9 -0
  24. package/okf/concepts/counting-and-sums.md +10 -0
  25. package/okf/concepts/dates-unix-seconds.md +12 -0
  26. package/okf/concepts/enums.md +14 -0
  27. package/okf/concepts/filters-vs-filter.md +14 -0
  28. package/okf/concepts/index.md +8 -0
  29. package/okf/concepts/operationid-vocabulary.md +17 -0
  30. package/okf/concepts/visibility-column.md +13 -0
  31. package/okf/entities/accounts.md +82 -0
  32. package/okf/entities/actionsteps.md +84 -0
  33. package/okf/entities/addresses.md +50 -0
  34. package/okf/entities/applicationassets.md +43 -0
  35. package/okf/entities/applications.md +62 -0
  36. package/okf/entities/appointments.md +79 -0
  37. package/okf/entities/associations.md +41 -0
  38. package/okf/entities/binfiles.md +32 -0
  39. package/okf/entities/campaigns.md +66 -0
  40. package/okf/entities/categories.md +55 -0
  41. package/okf/entities/channels.md +54 -0
  42. package/okf/entities/comments.md +44 -0
  43. package/okf/entities/components.md +46 -0
  44. package/okf/entities/contacts.md +96 -0
  45. package/okf/entities/contacts2contacts.md +42 -0
  46. package/okf/entities/contracts.md +83 -0
  47. package/okf/entities/couponcodes.md +58 -0
  48. package/okf/entities/coupons.md +69 -0
  49. package/okf/entities/customfields.md +59 -0
  50. package/okf/entities/davservers.md +74 -0
  51. package/okf/entities/devices.md +65 -0
  52. package/okf/entities/documents.md +76 -0
  53. package/okf/entities/dunning.md +82 -0
  54. package/okf/entities/dunning2transactions.md +46 -0
  55. package/okf/entities/entities2channels.md +42 -0
  56. package/okf/entities/events.md +57 -0
  57. package/okf/entities/feedservers.md +67 -0
  58. package/okf/entities/files.md +50 -0
  59. package/okf/entities/follows.md +40 -0
  60. package/okf/entities/forks.md +54 -0
  61. package/okf/entities/groups.md +48 -0
  62. package/okf/entities/groups2users.md +44 -0
  63. package/okf/entities/index.md +93 -0
  64. package/okf/entities/invitations.md +53 -0
  65. package/okf/entities/items.md +95 -0
  66. package/okf/entities/ledgers.md +56 -0
  67. package/okf/entities/likes.md +40 -0
  68. package/okf/entities/links.md +70 -0
  69. package/okf/entities/mailinglists.md +67 -0
  70. package/okf/entities/mailingrecipients.md +45 -0
  71. package/okf/entities/mailservers.md +77 -0
  72. package/okf/entities/messagereads.md +40 -0
  73. package/okf/entities/messages.md +104 -0
  74. package/okf/entities/notes.md +73 -0
  75. package/okf/entities/objects.md +70 -0
  76. package/okf/entities/opportunities.md +87 -0
  77. package/okf/entities/participants.md +52 -0
  78. package/okf/entities/payments.md +76 -0
  79. package/okf/entities/permissions.md +46 -0
  80. package/okf/entities/pricelists.md +70 -0
  81. package/okf/entities/pricelists2accounts.md +46 -0
  82. package/okf/entities/prices.md +49 -0
  83. package/okf/entities/projects.md +72 -0
  84. package/okf/entities/records.md +75 -0
  85. package/okf/entities/relateditems.md +43 -0
  86. package/okf/entities/resources.md +55 -0
  87. package/okf/entities/services.md +64 -0
  88. package/okf/entities/stocktransactions.md +72 -0
  89. package/okf/entities/storages.md +56 -0
  90. package/okf/entities/suppliers.md +51 -0
  91. package/okf/entities/tasks.md +86 -0
  92. package/okf/entities/tickets.md +86 -0
  93. package/okf/entities/transactions.md +118 -0
  94. package/okf/entities/users.md +66 -0
  95. package/okf/entities/weblets.md +66 -0
  96. package/okf/index.md +11 -0
  97. package/okf/log.md +4 -0
  98. package/okf/metrics/cash-received.md +10 -0
  99. package/okf/metrics/index.md +6 -0
  100. package/okf/metrics/invoiced-net-revenue.md +16 -0
  101. package/okf/metrics/open-customers.md +14 -0
  102. package/okf/metrics/overdue-receivables.md +12 -0
  103. package/okf/playbooks/customer-360.md +12 -0
  104. package/okf/playbooks/index.md +5 -0
  105. package/okf/playbooks/revenue-this-year.md +19 -0
  106. package/okf/playbooks/ticket-work-packet.md +11 -0
  107. package/package.json +9 -5
  108. package/scripts/data/okf-curation.mjs +258 -0
  109. package/scripts/generate-client.mjs +4 -275
  110. package/scripts/generate-okf.mjs +241 -0
  111. package/scripts/lib/okf.mjs +272 -0
  112. package/scripts/lib/spec-model.mjs +325 -0
  113. package/src/index.js +4 -0
  114. package/src/runtime/client.js +199 -18
  115. package/src/runtime/okf.js +237 -0
  116. package/samples/missioncontrol/README.md +0 -106
  117. package/samples/missioncontrol/fetch-data.mjs +0 -341
  118. package/samples/missioncontrol/index.html +0 -419
@@ -0,0 +1,67 @@
1
+ ---
2
+ type: ZeyOS Entity
3
+ title: Feed Servers
4
+ description: Feed server definitions.
5
+ resource: zeyos://api/feedservers
6
+ tags: [platform, generated]
7
+ api_backed: true
8
+ list_operation: listFeedServers
9
+ visibility_column: false
10
+ ---
11
+
12
+ <!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
13
+ # Schema
14
+
15
+ | Column | Type | Nullable | Default | Indexed | FK |
16
+ |---|---|---|---|---|---|
17
+ | `ID` | integer | no | — | yes | — |
18
+ | `owneruser` | integer | yes | — | yes | [users](/entities/users.md) |
19
+ | `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
20
+ | `creator` | integer | yes | — | — | — |
21
+ | `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
22
+ | `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
23
+ | `recipientuser` | integer | yes | — | — | [users](/entities/users.md) |
24
+ | `recipientgroup` | integer | yes | — | — | [groups](/entities/groups.md) |
25
+ | `channel` | integer | yes | — | — | [channels](/entities/channels.md) |
26
+ | `activity` | smallint | no | `0` | — | — |
27
+ | `name` | text | no | — | yes | — |
28
+ | `url` | text | no | — | yes | — |
29
+ | `username` | text | no | `''` | — | — |
30
+ | `notify` | smallint | no | `0` | — | — |
31
+ | `etag` | text | no | `''` | — | — |
32
+ | `description` | text | no | `''` | — | — |
33
+ | `password` | bytea | yes | — | — | — |
34
+
35
+ # Foreign Keys
36
+
37
+ - `owneruser` → [users](/entities/users.md) (`users.ID`)
38
+ - `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
39
+ - `recipientuser` → [users](/entities/users.md) (`users.ID`)
40
+ - `recipientgroup` → [groups](/entities/groups.md) (`groups.ID`)
41
+ - `channel` → [channels](/entities/channels.md) (`channels.ID`)
42
+
43
+ # Enums
44
+
45
+ ### `activity`
46
+
47
+ `0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
48
+
49
+ # Indexes
50
+
51
+ - `fk_feedservers_ownergroup` — gin, partial on `ownergroup`
52
+ - `fk_feedservers_owneruser` — gin, partial on `owneruser`
53
+ - `i_feedservers_noowner` — gin, partial on `ownergroup`
54
+ - `s_feedservers_name` — gin on `name`
55
+ - `s_feedservers_url` — gin on `url`
56
+
57
+ > Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
58
+
59
+ # Operations
60
+
61
+ - list: `listFeedServers`
62
+ - get: `getFeedServer`
63
+ - create: `createFeedServer`
64
+ - update: `updateFeedServer`
65
+ - delete: `deleteFeedServer`
66
+ - exists: `existsFeedServer`
67
+ <!-- okf:generated:end -->
@@ -0,0 +1,50 @@
1
+ ---
2
+ type: ZeyOS Entity
3
+ title: Files
4
+ description: Attachments linked to a record or comment.
5
+ resource: zeyos://api/files
6
+ tags: [knowledge, generated]
7
+ api_backed: true
8
+ list_operation: listFiles
9
+ visibility_column: false
10
+ ---
11
+
12
+ <!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
13
+ # Schema
14
+
15
+ | Column | Type | Nullable | Default | Indexed | FK |
16
+ |---|---|---|---|---|---|
17
+ | `ID` | bigint | no | — | yes | — |
18
+ | `creator` | integer | yes | — | — | — |
19
+ | `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
20
+ | `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
21
+ | `record` | bigint | yes | — | yes | [records](/entities/records.md) |
22
+ | `comment` | bigint | yes | — | yes | [comments](/entities/comments.md) |
23
+ | `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
24
+ | `filename` | text | no | `''` | yes | — |
25
+ | `mimetype` | text | no | `'application/octet-stream'` | — | — |
26
+
27
+ # Foreign Keys
28
+
29
+ - `record` → [records](/entities/records.md) (`records.ID`)
30
+ - `comment` → [comments](/entities/comments.md) (`comments.ID`)
31
+ - `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
32
+
33
+ # Indexes
34
+
35
+ - `fk_files_binfile` — btree, partial on `binfile`
36
+ - `fk_files_comment` — btree, partial on `comment`
37
+ - `fk_files_record` — btree, partial on `record`
38
+ - `s_files_filename` — gin, partial on `filename`
39
+
40
+ > Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
41
+
42
+ # Operations
43
+
44
+ - list: `listFiles`
45
+ - get: `getFile`
46
+ - create: `createFile`
47
+ - update: `updateFile`
48
+ - delete: `deleteFile`
49
+ - exists: `existsFile`
50
+ <!-- okf:generated:end -->
@@ -0,0 +1,40 @@
1
+ ---
2
+ type: ZeyOS Entity
3
+ title: Follows
4
+ description: Follow/watch subscriptions on entities.
5
+ resource: zeyos://api/follows
6
+ tags: [collaboration, generated]
7
+ api_backed: true
8
+ list_operation: listFollows
9
+ visibility_column: false
10
+ ---
11
+
12
+ <!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
13
+ # Schema
14
+
15
+ | Column | Type | Nullable | Default | Indexed | FK |
16
+ |---|---|---|---|---|---|
17
+ | `ID` | bigint | no | — | yes | — |
18
+ | `creator` | integer | no | — | yes | [users](/entities/users.md) |
19
+ | `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
20
+ | `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
21
+ | `entity` | t_entity | no | — | yes | — |
22
+ | `index` | bigint | no | — | yes | — |
23
+
24
+ # Foreign Keys
25
+
26
+ - `creator` → [users](/entities/users.md) (`users.ID`)
27
+
28
+ # Indexes
29
+
30
+ - `u_follows_entity_creator_index` — btree, unique on `entity, creator, index`
31
+
32
+ # Operations
33
+
34
+ - list: `listFollows`
35
+ - get: `getFollow`
36
+ - create: `createFollow`
37
+ - update: `updateFollow`
38
+ - delete: `deleteFollow`
39
+ - exists: `existsFollow`
40
+ <!-- okf:generated:end -->
@@ -0,0 +1,54 @@
1
+ ---
2
+ type: ZeyOS Entity
3
+ title: Forks
4
+ description: Module/fork definitions with identifiers and module names.
5
+ resource: zeyos://api/forks
6
+ tags: [platform, generated]
7
+ api_backed: true
8
+ list_operation: listForks
9
+ visibility_column: false
10
+ ---
11
+
12
+ <!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
13
+ # Schema
14
+
15
+ | Column | Type | Nullable | Default | Indexed | FK |
16
+ |---|---|---|---|---|---|
17
+ | `ID` | integer | no | — | yes | — |
18
+ | `creator` | integer | yes | — | — | — |
19
+ | `creationdate` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
20
+ | `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
21
+ | `group` | integer | yes | — | — | [groups](/entities/groups.md) |
22
+ | `activity` | smallint | no | `0` | — | — |
23
+ | `name` | text | no | — | yes | — |
24
+ | `identifier` | character varying(200) | no | — | yes | — |
25
+ | `module` | text | no | — | — | — |
26
+ | `color` | character varying(6) | no | `''` | — | — |
27
+ | `langaliases` | json | yes | — | — | — |
28
+ | `description` | text | no | `''` | — | — |
29
+ | `settings` | json | yes | — | — | — |
30
+
31
+ # Foreign Keys
32
+
33
+ - `group` → [groups](/entities/groups.md) (`groups.ID`)
34
+
35
+ # Enums
36
+
37
+ ### `activity`
38
+
39
+ `0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
40
+
41
+ # Indexes
42
+
43
+ - `s_forks_identifier` — gin on `identifier`
44
+ - `s_forks_name` — gin on `name`
45
+ - `u_forks_identifier` — btree, unique on `identifier`
46
+
47
+ > Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
48
+
49
+ # Operations
50
+
51
+ - list: `listForks`
52
+ - get: `getFork`
53
+ - exists: `existsFork`
54
+ <!-- okf:generated:end -->
@@ -0,0 +1,48 @@
1
+ ---
2
+ type: ZeyOS Entity
3
+ title: Groups
4
+ description: User groups.
5
+ resource: zeyos://api/groups
6
+ tags: [platform, generated]
7
+ api_backed: true
8
+ list_operation: listGroups
9
+ visibility_column: false
10
+ ---
11
+
12
+ <!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
13
+ # Schema
14
+
15
+ | Column | Type | Nullable | Default | Indexed | FK |
16
+ |---|---|---|---|---|---|
17
+ | `ID` | integer | no | — | yes | — |
18
+ | `creator` | integer | yes | — | — | — |
19
+ | `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
20
+ | `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
21
+ | `leader` | integer | yes | — | — | [users](/entities/users.md) |
22
+ | `activity` | smallint | no | `0` | — | — |
23
+ | `name` | text | no | — | yes | — |
24
+ | `description` | text | no | `''` | — | — |
25
+
26
+ # Foreign Keys
27
+
28
+ - `leader` → [users](/entities/users.md) (`users.ID`)
29
+
30
+ # Enums
31
+
32
+ ### `activity`
33
+
34
+ `0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
35
+
36
+ # Indexes
37
+
38
+ - `s_groups_name` — gin on `name`
39
+ - `u_groups_name` — btree, unique on `lower(name)`
40
+
41
+ > Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
42
+
43
+ # Operations
44
+
45
+ - list: `listGroups`
46
+ - get: `getGroup`
47
+ - exists: `existsGroup`
48
+ <!-- okf:generated:end -->
@@ -0,0 +1,44 @@
1
+ ---
2
+ type: ZeyOS Entity
3
+ title: Groups To Users
4
+ description: Group membership junction.
5
+ resource: zeyos://api/groups2users
6
+ tags: [platform, generated]
7
+ api_backed: true
8
+ list_operation: listGroupsToUsers
9
+ visibility_column: false
10
+ ---
11
+
12
+ <!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
13
+ # Schema
14
+
15
+ | Column | Type | Nullable | Default | Indexed | FK |
16
+ |---|---|---|---|---|---|
17
+ | `ID` | bigint | no | — | yes | — |
18
+ | `creator` | integer | yes | — | — | — |
19
+ | `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
20
+ | `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
21
+ | `group` | integer | no | — | yes | [groups](/entities/groups.md) |
22
+ | `user` | integer | no | — | yes | [users](/entities/users.md) |
23
+ | `writable` | smallint | no | `0` | — | — |
24
+
25
+ # Foreign Keys
26
+
27
+ - `group` → [groups](/entities/groups.md) (`groups.ID`)
28
+ - `user` → [users](/entities/users.md) (`users.ID`)
29
+
30
+ # Indexes
31
+
32
+ - `fk_groups2users_user` — btree on `user`
33
+ - `u_groups2users_group_user` — btree, unique on `group, user`
34
+
35
+ # Operations
36
+
37
+ - list: `listGroupsToUsers`
38
+ - get: `getGroupToUser`
39
+ - exists: `existsGroupToUser`
40
+ <!-- okf:generated:end -->
41
+
42
+ # Notes
43
+
44
+ Read-only; operationId `listGroupsToUsers`.
@@ -0,0 +1,93 @@
1
+ # CRM & Customer
2
+
3
+ * [Accounts](accounts.md) - Customer, supplier, prospect, or employee master records.
4
+ * [Addresses](addresses.md) - Additional address records linked to accounts or contacts.
5
+ * [Contacts](contacts.md) - People linked to accounts.
6
+ * [Contacts To Contacts](contacts2contacts.md) - Contact-to-contact relationships.
7
+ * [Contracts](contracts.md) - Long-lived commercial agreements.
8
+ * [Opportunities](opportunities.md) - Sales pipeline and deal records.
9
+
10
+ # Work & Delivery
11
+
12
+ * [Action Steps](actionsteps.md) - Cross-record follow-up work items with assignee, due date, status, and effort.
13
+ * [Appointments](appointments.md) - Calendar appointments.
14
+ * [Invitations](invitations.md) - Appointment invitations.
15
+ * [Projects](projects.md) - Top-level initiatives.
16
+ * [Tasks](tasks.md) - Actionable delivery work.
17
+ * [Tickets](tickets.md) - Support or service work items.
18
+
19
+ # Messaging
20
+
21
+ * [Mail Servers](mailservers.md) - Mail server definitions.
22
+ * [Message Reads](messagereads.md) - Read-tracking records for messages.
23
+ * [Messages](messages.md) - Email and message records.
24
+
25
+ # Outreach
26
+
27
+ * [Campaigns](campaigns.md) - Marketing or outreach campaigns.
28
+ * [Mailing Lists](mailinglists.md) - Mailing list definitions.
29
+ * [Mailing Recipients](mailingrecipients.md) - Recipient records for a message.
30
+ * [Participants](participants.md) - Contacts enrolled in campaigns or mailing lists.
31
+
32
+ # Knowledge
33
+
34
+ * [Documents](documents.md) - Formal file-like business documents.
35
+ * [Files](files.md) - Attachments linked to a record or comment.
36
+ * [Notes](notes.md) - Text-centric internal knowledge items.
37
+
38
+ # Collaboration
39
+
40
+ * [Channels](channels.md) - Collaboration or distribution channels.
41
+ * [Comments](comments.md) - Record-linked comments.
42
+ * [Entities To Channels](entities2channels.md) - Junction between records and channels.
43
+ * [Events](events.md) - Generic event records attached to entities.
44
+ * [Follows](follows.md) - Follow/watch subscriptions on entities.
45
+ * [Likes](likes.md) - Lightweight positive reactions on records.
46
+ * [Records](records.md) - Generic feed and discussion records with entity/index references.
47
+
48
+ # Billing & Payments
49
+
50
+ * [Ledgers](ledgers.md) - Payment ledger definitions.
51
+ * [Payments](payments.md) - Cash movement records.
52
+ * [Transactions](transactions.md) - Billing, procurement, or production business transactions.
53
+
54
+ # Collections
55
+
56
+ * [Dunning Notices](dunning.md) - Collection or dunning notices.
57
+ * [Dunning To Transactions](dunning2transactions.md) - Dunning-to-transaction junction.
58
+
59
+ # Commerce & Inventory
60
+
61
+ * [Categorys](categories.md) - Category definitions.
62
+ * [Components](components.md) - Item-to-item composition records (BOM/kit).
63
+ * [Coupon Codes](couponcodes.md) - Codes under a coupon definition.
64
+ * [Coupons](coupons.md) - Coupon definitions.
65
+ * [Items](items.md) - Product and service catalog entries.
66
+ * [Price Lists](pricelists.md) - Price list definitions.
67
+ * [Price Lists To Accounts](pricelists2accounts.md) - Account-to-price-list assignments.
68
+ * [Prices](prices.md) - Item prices within a price list.
69
+ * [Related Items](relateditems.md) - Related product links (cross-sell, substitute, accessory).
70
+ * [Stock Transactions](stocktransactions.md) - Inventory movements.
71
+ * [Storages](storages.md) - Inventory storage locations.
72
+ * [Suppliers](suppliers.md) - Supplier-to-item links.
73
+
74
+ # Platform & Schema
75
+
76
+ * [Application Assets](applicationassets.md) - Assets linked to an application.
77
+ * [Applications](applications.md) - Application definitions.
78
+ * [Associations](associations.md) - Generic cross-entity relation records with metadata.
79
+ * [Bin Files](binfiles.md) - Binary file storage records.
80
+ * [Custom Fields](customfields.md) - Custom field definitions.
81
+ * [DAVServers](davservers.md) - DAV (calendar/contact sync) server definitions.
82
+ * [Devices](devices.md) - Inventory device records.
83
+ * [Feed Servers](feedservers.md) - Feed server definitions.
84
+ * [Forks](forks.md) - Module/fork definitions with identifiers and module names.
85
+ * [Groups](groups.md) - User groups.
86
+ * [Groups To Users](groups2users.md) - Group membership junction.
87
+ * [Links](links.md) - Link records with name and description.
88
+ * [Objects](objects.md) - Custom object records with arbitrary JSON payloads.
89
+ * [Permissions](permissions.md) - Group-level permission grants.
90
+ * [Resources](resources.md) - Named resources linked to an application or standalone.
91
+ * [Services](services.md) - Hook, timing, or remote-call services.
92
+ * [Users](users.md) - System users.
93
+ * [Weblets](weblets.md) - UI modules with view/type metadata.
@@ -0,0 +1,53 @@
1
+ ---
2
+ type: ZeyOS Entity
3
+ title: Invitations
4
+ description: Appointment invitations.
5
+ resource: zeyos://api/invitations
6
+ tags: [work, generated]
7
+ api_backed: true
8
+ list_operation: listInvitations
9
+ visibility_column: false
10
+ ---
11
+
12
+ <!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
13
+ # Schema
14
+
15
+ | Column | Type | Nullable | Default | Indexed | FK |
16
+ |---|---|---|---|---|---|
17
+ | `ID` | bigint | no | — | yes | — |
18
+ | `creator` | integer | yes | — | — | — |
19
+ | `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
20
+ | `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
21
+ | `appointment` | integer | no | — | yes | [appointments](/entities/appointments.md) |
22
+ | `contact` | integer | yes | — | yes | [contacts](/entities/contacts.md) |
23
+ | `name` | text | no | — | — | — |
24
+ | `email` | text | no | `''` | — | — |
25
+ | `flag` | smallint | no | `0` | — | — |
26
+
27
+ # Foreign Keys
28
+
29
+ - `appointment` → [appointments](/entities/appointments.md) (`appointments.ID`)
30
+ - `contact` → [contacts](/entities/contacts.md) (`contacts.ID`)
31
+
32
+ # Enums
33
+
34
+ ### `flag`
35
+
36
+ `0` = UNANSWERED · `1` = CONFIRMED · `2` = REJECTED
37
+
38
+ # Indexes
39
+
40
+ - `fk_invitations_appointment` — btree on `appointment`
41
+ - `fk_invitations_contact` — btree, partial on `contact`
42
+
43
+ > Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
44
+
45
+ # Operations
46
+
47
+ - list: `listInvitations`
48
+ - get: `getInvitation`
49
+ - create: `createInvitation`
50
+ - update: `updateInvitation`
51
+ - delete: `deleteInvitation`
52
+ - exists: `existsInvitation`
53
+ <!-- okf:generated:end -->
@@ -0,0 +1,95 @@
1
+ ---
2
+ type: ZeyOS Entity
3
+ title: Items
4
+ description: Product and service catalog entries.
5
+ resource: zeyos://api/items
6
+ tags: [commerce, generated]
7
+ api_backed: true
8
+ list_operation: listItems
9
+ visibility_column: true
10
+ ---
11
+
12
+ <!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
13
+ # Schema
14
+
15
+ | Column | Type | Nullable | Default | Indexed | FK |
16
+ |---|---|---|---|---|---|
17
+ | `ID` | integer | no | — | yes | — |
18
+ | `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
19
+ | `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
20
+ | `creator` | integer | yes | — | — | — |
21
+ | `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
22
+ | `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
23
+ | `model` | integer | yes | — | yes | [items](/entities/items.md) |
24
+ | `picbinfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
25
+ | `visibility` | smallint | no | `0` | — | — |
26
+ | `name` | text | no | — | yes | — |
27
+ | `manufacturer` | text | no | `''` | yes | — |
28
+ | `itemnum` | text | no | `''` | yes | — |
29
+ | `barcode` | text | no | `''` | yes | — |
30
+ | `type` | smallint | no | `0` | — | — |
31
+ | `forcestock` | smallint | yes | — | — | — |
32
+ | `applicability` | smallint | no | `0` | — | — |
33
+ | `unit` | character varying(3) | no | `''` | — | — |
34
+ | `sellingprice` | double precision | no | `0` | — | — |
35
+ | `purchaseprice` | double precision | no | `0` | — | — |
36
+ | `taxrate` | double precision | yes | — | — | — |
37
+ | `weight` | double precision | no | `0` | — | — |
38
+ | `classcode` | text | no | `''` | — | — |
39
+ | `tariffcode` | text | no | `''` | — | — |
40
+ | `origin` | character varying(2) | no | `''` | — | — |
41
+ | `description` | text | no | `''` | — | — |
42
+ | `foreigntaxrates` | json | yes | — | — | — |
43
+
44
+ # Foreign Keys
45
+
46
+ - `fork` → [forks](/entities/forks.md) (`forks.ID`)
47
+ - `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
48
+ - `model` → [items](/entities/items.md) (`items.ID`)
49
+ - `picbinfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
50
+
51
+ # Enums
52
+
53
+ ### `visibility`
54
+
55
+ `0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
56
+
57
+ ### `type`
58
+
59
+ `0` = SIMPLE · `1` = SERIALS · `2` = CHARGES · `3` = SERIALSANDCHARGES · `4` = SET · `5` = CONTAINER · `6` = NOSTOCK · `7` = MODEL
60
+
61
+ ### `forcestock`
62
+
63
+ `0` = STORAGE · `1` = LOCATION
64
+
65
+ ### `applicability`
66
+
67
+ `0` = ALWAYS · `1` = NEVER · `2` = BILLINGONLY · `3` = PROCUREMENTONLY
68
+
69
+ # Indexes
70
+
71
+ - `fk_items_fork` — gin, partial on `fork`
72
+ - `fk_items_model` — btree, partial on `model`
73
+ - `fk_items_ownergroup` — gin on `ownergroup`
74
+ - `fk_items_picbinfile` — btree, partial on `picbinfile`
75
+ - `i_items_barcode` — btree, partial on `barcode`
76
+ - `i_items_itemnum` — btree, partial on `itemnum`
77
+ - `i_items_name` — btree on `name`
78
+ - `i_items_nofork` — gin, partial on `fork`
79
+ - `i_items_noowner` — gin, partial on `ownergroup`
80
+ - `s_items_barcode` — gin, partial on `barcode`
81
+ - `s_items_itemnum` — gin, partial on `itemnum`
82
+ - `s_items_manufacturer` — gin, partial on `manufacturer`
83
+ - `s_items_name` — gin on `name`
84
+
85
+ > Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
86
+
87
+ # Operations
88
+
89
+ - list: `listItems`
90
+ - get: `getItem`
91
+ - create: `createItem`
92
+ - update: `updateItem`
93
+ - delete: `deleteItem`
94
+ - exists: `existsItem`
95
+ <!-- okf:generated:end -->
@@ -0,0 +1,56 @@
1
+ ---
2
+ type: ZeyOS Entity
3
+ title: Ledgers
4
+ description: Payment ledger definitions.
5
+ resource: zeyos://api/ledgers
6
+ tags: [billing, generated]
7
+ api_backed: true
8
+ list_operation: listLedgers
9
+ visibility_column: true
10
+ ---
11
+
12
+ <!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
13
+ # Schema
14
+
15
+ | Column | Type | Nullable | Default | Indexed | FK |
16
+ |---|---|---|---|---|---|
17
+ | `ID` | integer | no | — | yes | — |
18
+ | `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
19
+ | `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
20
+ | `creator` | integer | yes | — | — | — |
21
+ | `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
22
+ | `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
23
+ | `visibility` | smallint | no | `0` | — | — |
24
+ | `name` | text | no | — | yes | — |
25
+ | `description` | text | no | `''` | — | — |
26
+
27
+ # Foreign Keys
28
+
29
+ - `fork` → [forks](/entities/forks.md) (`forks.ID`)
30
+ - `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
31
+
32
+ # Enums
33
+
34
+ ### `visibility`
35
+
36
+ `0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
37
+
38
+ # Indexes
39
+
40
+ - `fk_ledgers_fork` — gin, partial on `fork`
41
+ - `fk_ledgers_ownergroup` — gin on `ownergroup`
42
+ - `i_ledgers_nofork` — gin, partial on `fork`
43
+ - `i_ledgers_noowner` — gin, partial on `ownergroup`
44
+ - `s_ledgers_name` — gin on `name`
45
+
46
+ > Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
47
+
48
+ # Operations
49
+
50
+ - list: `listLedgers`
51
+ - get: `getLedger`
52
+ - create: `createLedger`
53
+ - update: `updateLedger`
54
+ - delete: `deleteLedger`
55
+ - exists: `existsLedger`
56
+ <!-- okf:generated:end -->
@@ -0,0 +1,40 @@
1
+ ---
2
+ type: ZeyOS Entity
3
+ title: Likes
4
+ description: Lightweight positive reactions on records.
5
+ resource: zeyos://api/likes
6
+ tags: [collaboration, generated]
7
+ api_backed: true
8
+ list_operation: listLikes
9
+ visibility_column: false
10
+ ---
11
+
12
+ <!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
13
+ # Schema
14
+
15
+ | Column | Type | Nullable | Default | Indexed | FK |
16
+ |---|---|---|---|---|---|
17
+ | `ID` | bigint | no | — | yes | — |
18
+ | `creator` | integer | no | — | yes | [users](/entities/users.md) |
19
+ | `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
20
+ | `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
21
+ | `record` | bigint | no | — | yes | [records](/entities/records.md) |
22
+
23
+ # Foreign Keys
24
+
25
+ - `creator` → [users](/entities/users.md) (`users.ID`)
26
+ - `record` → [records](/entities/records.md) (`records.ID`)
27
+
28
+ # Indexes
29
+
30
+ - `u_likes_record_creator` — btree, unique on `record, creator`
31
+
32
+ # Operations
33
+
34
+ - list: `listLikes`
35
+ - get: `getLike`
36
+ - create: `createLike`
37
+ - update: `updateLike`
38
+ - delete: `deleteLike`
39
+ - exists: `existsLike`
40
+ <!-- okf:generated:end -->