@macro-inc/sdk 0.0.1

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 (296) hide show
  1. package/README.md +177 -0
  2. package/dist/chunk-5HAKQN23.js +1263 -0
  3. package/dist/chunk-77EI4LSQ.js +2492 -0
  4. package/dist/chunk-CTKR64MY.js +1436 -0
  5. package/dist/chunk-JXIQT5TH.js +1467 -0
  6. package/dist/chunk-P4DTO6VD.js +830 -0
  7. package/dist/chunk-PAAFJYGO.js +967 -0
  8. package/dist/chunk-QNUS5BC5.js +913 -0
  9. package/dist/chunk-SGAHIERJ.js +1235 -0
  10. package/dist/chunk-V45LUJDI.js +838 -0
  11. package/dist/chunk-YRUXFEZM.js +1044 -0
  12. package/dist/generated/agent-harness/client/client.gen.d.ts +2 -0
  13. package/dist/generated/agent-harness/client/index.d.ts +10 -0
  14. package/dist/generated/agent-harness/client/types.gen.d.ts +120 -0
  15. package/dist/generated/agent-harness/client/utils.gen.d.ts +37 -0
  16. package/dist/generated/agent-harness/client.gen.d.ts +12 -0
  17. package/dist/generated/agent-harness/core/auth.gen.d.ts +25 -0
  18. package/dist/generated/agent-harness/core/bodySerializer.gen.d.ts +25 -0
  19. package/dist/generated/agent-harness/core/params.gen.d.ts +43 -0
  20. package/dist/generated/agent-harness/core/pathSerializer.gen.d.ts +33 -0
  21. package/dist/generated/agent-harness/core/queryKeySerializer.gen.d.ts +18 -0
  22. package/dist/generated/agent-harness/core/serverSentEvents.gen.d.ts +71 -0
  23. package/dist/generated/agent-harness/core/types.gen.d.ts +83 -0
  24. package/dist/generated/agent-harness/core/utils.gen.d.ts +19 -0
  25. package/dist/generated/agent-harness/index.d.ts +2 -0
  26. package/dist/generated/agent-harness/index.js +6 -0
  27. package/dist/generated/agent-harness/sdk.gen.d.ts +84 -0
  28. package/dist/generated/agent-harness/types.gen.d.ts +539 -0
  29. package/dist/generated/auth/client/client.gen.d.ts +2 -0
  30. package/dist/generated/auth/client/index.d.ts +10 -0
  31. package/dist/generated/auth/client/types.gen.d.ts +120 -0
  32. package/dist/generated/auth/client/utils.gen.d.ts +37 -0
  33. package/dist/generated/auth/client.gen.d.ts +12 -0
  34. package/dist/generated/auth/core/auth.gen.d.ts +25 -0
  35. package/dist/generated/auth/core/bodySerializer.gen.d.ts +25 -0
  36. package/dist/generated/auth/core/params.gen.d.ts +43 -0
  37. package/dist/generated/auth/core/pathSerializer.gen.d.ts +33 -0
  38. package/dist/generated/auth/core/queryKeySerializer.gen.d.ts +18 -0
  39. package/dist/generated/auth/core/serverSentEvents.gen.d.ts +71 -0
  40. package/dist/generated/auth/core/types.gen.d.ts +83 -0
  41. package/dist/generated/auth/core/utils.gen.d.ts +19 -0
  42. package/dist/generated/auth/index.d.ts +2 -0
  43. package/dist/generated/auth/index.js +6 -0
  44. package/dist/generated/auth/sdk.gen.d.ts +383 -0
  45. package/dist/generated/auth/types.gen.d.ts +2175 -0
  46. package/dist/generated/cognition/client/client.gen.d.ts +2 -0
  47. package/dist/generated/cognition/client/index.d.ts +10 -0
  48. package/dist/generated/cognition/client/types.gen.d.ts +120 -0
  49. package/dist/generated/cognition/client/utils.gen.d.ts +37 -0
  50. package/dist/generated/cognition/client.gen.d.ts +12 -0
  51. package/dist/generated/cognition/core/auth.gen.d.ts +25 -0
  52. package/dist/generated/cognition/core/bodySerializer.gen.d.ts +25 -0
  53. package/dist/generated/cognition/core/params.gen.d.ts +43 -0
  54. package/dist/generated/cognition/core/pathSerializer.gen.d.ts +33 -0
  55. package/dist/generated/cognition/core/queryKeySerializer.gen.d.ts +18 -0
  56. package/dist/generated/cognition/core/serverSentEvents.gen.d.ts +71 -0
  57. package/dist/generated/cognition/core/types.gen.d.ts +83 -0
  58. package/dist/generated/cognition/core/utils.gen.d.ts +19 -0
  59. package/dist/generated/cognition/index.d.ts +2 -0
  60. package/dist/generated/cognition/index.js +6 -0
  61. package/dist/generated/cognition/sdk.gen.d.ts +224 -0
  62. package/dist/generated/cognition/types.gen.d.ts +2484 -0
  63. package/dist/generated/connection/client/client.gen.d.ts +2 -0
  64. package/dist/generated/connection/client/index.d.ts +10 -0
  65. package/dist/generated/connection/client/types.gen.d.ts +120 -0
  66. package/dist/generated/connection/client/utils.gen.d.ts +37 -0
  67. package/dist/generated/connection/client.gen.d.ts +12 -0
  68. package/dist/generated/connection/core/auth.gen.d.ts +25 -0
  69. package/dist/generated/connection/core/bodySerializer.gen.d.ts +25 -0
  70. package/dist/generated/connection/core/params.gen.d.ts +43 -0
  71. package/dist/generated/connection/core/pathSerializer.gen.d.ts +33 -0
  72. package/dist/generated/connection/core/queryKeySerializer.gen.d.ts +18 -0
  73. package/dist/generated/connection/core/serverSentEvents.gen.d.ts +71 -0
  74. package/dist/generated/connection/core/types.gen.d.ts +83 -0
  75. package/dist/generated/connection/core/utils.gen.d.ts +19 -0
  76. package/dist/generated/connection/index.d.ts +2 -0
  77. package/dist/generated/connection/index.js +839 -0
  78. package/dist/generated/connection/sdk.gen.d.ts +38 -0
  79. package/dist/generated/connection/types.gen.d.ts +235 -0
  80. package/dist/generated/contacts/client/client.gen.d.ts +2 -0
  81. package/dist/generated/contacts/client/index.d.ts +10 -0
  82. package/dist/generated/contacts/client/types.gen.d.ts +120 -0
  83. package/dist/generated/contacts/client/utils.gen.d.ts +37 -0
  84. package/dist/generated/contacts/client.gen.d.ts +12 -0
  85. package/dist/generated/contacts/core/auth.gen.d.ts +25 -0
  86. package/dist/generated/contacts/core/bodySerializer.gen.d.ts +25 -0
  87. package/dist/generated/contacts/core/params.gen.d.ts +43 -0
  88. package/dist/generated/contacts/core/pathSerializer.gen.d.ts +33 -0
  89. package/dist/generated/contacts/core/queryKeySerializer.gen.d.ts +18 -0
  90. package/dist/generated/contacts/core/serverSentEvents.gen.d.ts +71 -0
  91. package/dist/generated/contacts/core/types.gen.d.ts +83 -0
  92. package/dist/generated/contacts/core/utils.gen.d.ts +19 -0
  93. package/dist/generated/contacts/index.d.ts +2 -0
  94. package/dist/generated/contacts/index.js +6 -0
  95. package/dist/generated/contacts/sdk.gen.d.ts +43 -0
  96. package/dist/generated/contacts/types.gen.d.ts +52 -0
  97. package/dist/generated/email/client/client.gen.d.ts +2 -0
  98. package/dist/generated/email/client/index.d.ts +10 -0
  99. package/dist/generated/email/client/types.gen.d.ts +120 -0
  100. package/dist/generated/email/client/utils.gen.d.ts +37 -0
  101. package/dist/generated/email/client.gen.d.ts +12 -0
  102. package/dist/generated/email/core/auth.gen.d.ts +25 -0
  103. package/dist/generated/email/core/bodySerializer.gen.d.ts +25 -0
  104. package/dist/generated/email/core/params.gen.d.ts +43 -0
  105. package/dist/generated/email/core/pathSerializer.gen.d.ts +33 -0
  106. package/dist/generated/email/core/queryKeySerializer.gen.d.ts +18 -0
  107. package/dist/generated/email/core/serverSentEvents.gen.d.ts +71 -0
  108. package/dist/generated/email/core/types.gen.d.ts +83 -0
  109. package/dist/generated/email/core/utils.gen.d.ts +19 -0
  110. package/dist/generated/email/index.d.ts +2 -0
  111. package/dist/generated/email/index.js +6 -0
  112. package/dist/generated/email/sdk.gen.d.ts +254 -0
  113. package/dist/generated/email/types.gen.d.ts +2614 -0
  114. package/dist/generated/notification/client/client.gen.d.ts +2 -0
  115. package/dist/generated/notification/client/index.d.ts +10 -0
  116. package/dist/generated/notification/client/types.gen.d.ts +120 -0
  117. package/dist/generated/notification/client/utils.gen.d.ts +37 -0
  118. package/dist/generated/notification/client.gen.d.ts +12 -0
  119. package/dist/generated/notification/core/auth.gen.d.ts +25 -0
  120. package/dist/generated/notification/core/bodySerializer.gen.d.ts +25 -0
  121. package/dist/generated/notification/core/params.gen.d.ts +43 -0
  122. package/dist/generated/notification/core/pathSerializer.gen.d.ts +33 -0
  123. package/dist/generated/notification/core/queryKeySerializer.gen.d.ts +18 -0
  124. package/dist/generated/notification/core/serverSentEvents.gen.d.ts +71 -0
  125. package/dist/generated/notification/core/types.gen.d.ts +83 -0
  126. package/dist/generated/notification/core/utils.gen.d.ts +19 -0
  127. package/dist/generated/notification/index.d.ts +2 -0
  128. package/dist/generated/notification/index.js +6 -0
  129. package/dist/generated/notification/sdk.gen.d.ts +118 -0
  130. package/dist/generated/notification/types.gen.d.ts +1352 -0
  131. package/dist/generated/properties/client/client.gen.d.ts +2 -0
  132. package/dist/generated/properties/client/index.d.ts +10 -0
  133. package/dist/generated/properties/client/types.gen.d.ts +120 -0
  134. package/dist/generated/properties/client/utils.gen.d.ts +37 -0
  135. package/dist/generated/properties/client.gen.d.ts +12 -0
  136. package/dist/generated/properties/core/auth.gen.d.ts +25 -0
  137. package/dist/generated/properties/core/bodySerializer.gen.d.ts +25 -0
  138. package/dist/generated/properties/core/params.gen.d.ts +43 -0
  139. package/dist/generated/properties/core/pathSerializer.gen.d.ts +33 -0
  140. package/dist/generated/properties/core/queryKeySerializer.gen.d.ts +18 -0
  141. package/dist/generated/properties/core/serverSentEvents.gen.d.ts +71 -0
  142. package/dist/generated/properties/core/types.gen.d.ts +83 -0
  143. package/dist/generated/properties/core/utils.gen.d.ts +19 -0
  144. package/dist/generated/properties/index.d.ts +2 -0
  145. package/dist/generated/properties/index.js +6 -0
  146. package/dist/generated/properties/sdk.gen.d.ts +158 -0
  147. package/dist/generated/properties/types.gen.d.ts +1288 -0
  148. package/dist/generated/scheduled-action/client/client.gen.d.ts +2 -0
  149. package/dist/generated/scheduled-action/client/index.d.ts +10 -0
  150. package/dist/generated/scheduled-action/client/types.gen.d.ts +120 -0
  151. package/dist/generated/scheduled-action/client/utils.gen.d.ts +37 -0
  152. package/dist/generated/scheduled-action/client.gen.d.ts +12 -0
  153. package/dist/generated/scheduled-action/core/auth.gen.d.ts +25 -0
  154. package/dist/generated/scheduled-action/core/bodySerializer.gen.d.ts +25 -0
  155. package/dist/generated/scheduled-action/core/params.gen.d.ts +43 -0
  156. package/dist/generated/scheduled-action/core/pathSerializer.gen.d.ts +33 -0
  157. package/dist/generated/scheduled-action/core/queryKeySerializer.gen.d.ts +18 -0
  158. package/dist/generated/scheduled-action/core/serverSentEvents.gen.d.ts +71 -0
  159. package/dist/generated/scheduled-action/core/types.gen.d.ts +83 -0
  160. package/dist/generated/scheduled-action/core/utils.gen.d.ts +19 -0
  161. package/dist/generated/scheduled-action/index.d.ts +2 -0
  162. package/dist/generated/scheduled-action/index.js +845 -0
  163. package/dist/generated/scheduled-action/sdk.gen.d.ts +42 -0
  164. package/dist/generated/scheduled-action/types.gen.d.ts +241 -0
  165. package/dist/generated/search/client/client.gen.d.ts +2 -0
  166. package/dist/generated/search/client/index.d.ts +10 -0
  167. package/dist/generated/search/client/types.gen.d.ts +120 -0
  168. package/dist/generated/search/client/utils.gen.d.ts +37 -0
  169. package/dist/generated/search/client.gen.d.ts +12 -0
  170. package/dist/generated/search/core/auth.gen.d.ts +25 -0
  171. package/dist/generated/search/core/bodySerializer.gen.d.ts +25 -0
  172. package/dist/generated/search/core/params.gen.d.ts +43 -0
  173. package/dist/generated/search/core/pathSerializer.gen.d.ts +33 -0
  174. package/dist/generated/search/core/queryKeySerializer.gen.d.ts +18 -0
  175. package/dist/generated/search/core/serverSentEvents.gen.d.ts +71 -0
  176. package/dist/generated/search/core/types.gen.d.ts +83 -0
  177. package/dist/generated/search/core/utils.gen.d.ts +19 -0
  178. package/dist/generated/search/index.d.ts +2 -0
  179. package/dist/generated/search/index.js +6 -0
  180. package/dist/generated/search/sdk.gen.d.ts +44 -0
  181. package/dist/generated/search/types.gen.d.ts +2194 -0
  182. package/dist/generated/static-files/client/client.gen.d.ts +2 -0
  183. package/dist/generated/static-files/client/index.d.ts +10 -0
  184. package/dist/generated/static-files/client/types.gen.d.ts +120 -0
  185. package/dist/generated/static-files/client/utils.gen.d.ts +37 -0
  186. package/dist/generated/static-files/client.gen.d.ts +12 -0
  187. package/dist/generated/static-files/core/auth.gen.d.ts +25 -0
  188. package/dist/generated/static-files/core/bodySerializer.gen.d.ts +25 -0
  189. package/dist/generated/static-files/core/params.gen.d.ts +43 -0
  190. package/dist/generated/static-files/core/pathSerializer.gen.d.ts +33 -0
  191. package/dist/generated/static-files/core/queryKeySerializer.gen.d.ts +18 -0
  192. package/dist/generated/static-files/core/serverSentEvents.gen.d.ts +71 -0
  193. package/dist/generated/static-files/core/types.gen.d.ts +83 -0
  194. package/dist/generated/static-files/core/utils.gen.d.ts +19 -0
  195. package/dist/generated/static-files/index.d.ts +2 -0
  196. package/dist/generated/static-files/index.js +842 -0
  197. package/dist/generated/static-files/sdk.gen.d.ts +43 -0
  198. package/dist/generated/static-files/types.gen.d.ts +214 -0
  199. package/dist/generated/storage/client/client.gen.d.ts +2 -0
  200. package/dist/generated/storage/client/index.d.ts +10 -0
  201. package/dist/generated/storage/client/types.gen.d.ts +120 -0
  202. package/dist/generated/storage/client/utils.gen.d.ts +37 -0
  203. package/dist/generated/storage/client.gen.d.ts +12 -0
  204. package/dist/generated/storage/core/auth.gen.d.ts +25 -0
  205. package/dist/generated/storage/core/bodySerializer.gen.d.ts +25 -0
  206. package/dist/generated/storage/core/params.gen.d.ts +43 -0
  207. package/dist/generated/storage/core/pathSerializer.gen.d.ts +33 -0
  208. package/dist/generated/storage/core/queryKeySerializer.gen.d.ts +18 -0
  209. package/dist/generated/storage/core/serverSentEvents.gen.d.ts +71 -0
  210. package/dist/generated/storage/core/types.gen.d.ts +83 -0
  211. package/dist/generated/storage/core/utils.gen.d.ts +19 -0
  212. package/dist/generated/storage/index.d.ts +2 -0
  213. package/dist/generated/storage/index.js +6 -0
  214. package/dist/generated/storage/sdk.gen.d.ts +858 -0
  215. package/dist/generated/storage/types.gen.d.ts +12105 -0
  216. package/dist/generated/unfurl/client/client.gen.d.ts +2 -0
  217. package/dist/generated/unfurl/client/index.d.ts +10 -0
  218. package/dist/generated/unfurl/client/types.gen.d.ts +120 -0
  219. package/dist/generated/unfurl/client/utils.gen.d.ts +37 -0
  220. package/dist/generated/unfurl/client.gen.d.ts +12 -0
  221. package/dist/generated/unfurl/core/auth.gen.d.ts +25 -0
  222. package/dist/generated/unfurl/core/bodySerializer.gen.d.ts +25 -0
  223. package/dist/generated/unfurl/core/params.gen.d.ts +43 -0
  224. package/dist/generated/unfurl/core/pathSerializer.gen.d.ts +33 -0
  225. package/dist/generated/unfurl/core/queryKeySerializer.gen.d.ts +18 -0
  226. package/dist/generated/unfurl/core/serverSentEvents.gen.d.ts +71 -0
  227. package/dist/generated/unfurl/core/types.gen.d.ts +83 -0
  228. package/dist/generated/unfurl/core/utils.gen.d.ts +19 -0
  229. package/dist/generated/unfurl/index.d.ts +2 -0
  230. package/dist/generated/unfurl/index.js +835 -0
  231. package/dist/generated/unfurl/sdk.gen.d.ts +47 -0
  232. package/dist/generated/unfurl/types.gen.d.ts +125 -0
  233. package/dist/src/config.d.ts +51 -0
  234. package/dist/src/entities/agent-sessions/agent-session.d.ts +45 -0
  235. package/dist/src/entities/agent-sessions/namespace.d.ts +18 -0
  236. package/dist/src/entities/bots/namespace.d.ts +25 -0
  237. package/dist/src/entities/calls/call-record.d.ts +55 -0
  238. package/dist/src/entities/calls/namespace.d.ts +9 -0
  239. package/dist/src/entities/channels/channel.d.ts +88 -0
  240. package/dist/src/entities/channels/message.d.ts +64 -0
  241. package/dist/src/entities/channels/namespace.d.ts +30 -0
  242. package/dist/src/entities/channels/post.d.ts +20 -0
  243. package/dist/src/entities/channels/thread.d.ts +30 -0
  244. package/dist/src/entities/chats/chat.d.ts +55 -0
  245. package/dist/src/entities/chats/namespace.d.ts +14 -0
  246. package/dist/src/entities/crm/comment.d.ts +43 -0
  247. package/dist/src/entities/crm/company.d.ts +70 -0
  248. package/dist/src/entities/crm/contact.d.ts +48 -0
  249. package/dist/src/entities/crm/namespace.d.ts +22 -0
  250. package/dist/src/entities/documents/comment.d.ts +41 -0
  251. package/dist/src/entities/documents/document.d.ts +130 -0
  252. package/dist/src/entities/documents/namespace.d.ts +43 -0
  253. package/dist/src/entities/documents/system-skill.d.ts +16 -0
  254. package/dist/src/entities/email/attachment.d.ts +36 -0
  255. package/dist/src/entities/email/label.d.ts +31 -0
  256. package/dist/src/entities/email/link.d.ts +29 -0
  257. package/dist/src/entities/email/message.d.ts +58 -0
  258. package/dist/src/entities/email/namespace.d.ts +49 -0
  259. package/dist/src/entities/email/thread.d.ts +88 -0
  260. package/dist/src/entities/entity.d.ts +101 -0
  261. package/dist/src/entities/favorites/namespace.d.ts +19 -0
  262. package/dist/src/entities/foreign/foreign-entity.d.ts +30 -0
  263. package/dist/src/entities/foreign/namespace.d.ts +7 -0
  264. package/dist/src/entities/notifications/namespace.d.ts +29 -0
  265. package/dist/src/entities/notifications/notification.d.ts +50 -0
  266. package/dist/src/entities/pins/namespace.d.ts +19 -0
  267. package/dist/src/entities/projects/namespace.d.ts +13 -0
  268. package/dist/src/entities/projects/project.d.ts +42 -0
  269. package/dist/src/entities/properties/namespace.d.ts +47 -0
  270. package/dist/src/entities/properties/property-definition.d.ts +45 -0
  271. package/dist/src/entities/properties/property-option.d.ts +32 -0
  272. package/dist/src/entities/search.d.ts +23 -0
  273. package/dist/src/entities/tasks/namespace.d.ts +21 -0
  274. package/dist/src/entities/tasks/task.d.ts +34 -0
  275. package/dist/src/entities/teams/namespace.d.ts +12 -0
  276. package/dist/src/entities/teams/team.d.ts +40 -0
  277. package/dist/src/entities/users/namespace.d.ts +10 -0
  278. package/dist/src/entities/users/user.d.ts +43 -0
  279. package/dist/src/entities/webhooks/namespace.d.ts +31 -0
  280. package/dist/src/entities/webhooks/webhook.d.ts +88 -0
  281. package/dist/src/events/hydrate/channel.d.ts +85 -0
  282. package/dist/src/events/hydrate/document.d.ts +54 -0
  283. package/dist/src/events/receiver.d.ts +51 -0
  284. package/dist/src/events/types.d.ts +40 -0
  285. package/dist/src/events/verify.d.ts +13 -0
  286. package/dist/src/local-portmap.d.ts +8 -0
  287. package/dist/src/macro.d.ts +62 -0
  288. package/dist/src/macro.js +4215 -0
  289. package/dist/src/mentions.d.ts +37 -0
  290. package/dist/src/raw.d.ts +12 -0
  291. package/dist/src/utils/client.d.ts +53 -0
  292. package/dist/src/utils/index.d.ts +4 -0
  293. package/dist/src/utils/lazy.d.ts +18 -0
  294. package/dist/src/utils/pagination.d.ts +7 -0
  295. package/dist/src/utils/unwrap.d.ts +23 -0
  296. package/package.json +49 -0
@@ -0,0 +1,1288 @@
1
+ export type ClientOptions = {
2
+ baseUrl: `${string}://${string}` | (string & {});
3
+ };
4
+ /**
5
+ * Type-safe request to add a number option to a SelectNumber property.
6
+ */
7
+ export type AddNumberOptionRequest = {
8
+ display_order: number;
9
+ value: number;
10
+ };
11
+ /**
12
+ * Enum for type-safe property option addition requests.
13
+ */
14
+ export type AddPropertyOptionRequest = {
15
+ option: AddStringOptionRequest;
16
+ type: 'select_string';
17
+ } | {
18
+ option: AddNumberOptionRequest;
19
+ type: 'select_number';
20
+ };
21
+ /**
22
+ * Type-safe request to add a string option to a SelectString property.
23
+ */
24
+ export type AddStringOptionRequest = {
25
+ color?: string | null;
26
+ display_order: number;
27
+ value: string;
28
+ };
29
+ /**
30
+ * One entity's result in a cross-entity bulk option update.
31
+ */
32
+ export type BulkEntityOptionUpdateResult = {
33
+ /**
34
+ * The entity's id this result is for.
35
+ */
36
+ entity_id: string;
37
+ /**
38
+ * The entity's type this result is for.
39
+ */
40
+ entity_type: PropertyTargetEntityType;
41
+ /**
42
+ * A human-readable reason, present only when `failed`.
43
+ */
44
+ error?: string | null;
45
+ /**
46
+ * The entity's reconciled final option ids, present only when `applied`.
47
+ */
48
+ option_ids?: Array<string> | null;
49
+ /**
50
+ * Whether the delta was applied, skipped, or failed for this entity.
51
+ */
52
+ status: BulkEntityOptionUpdateStatus;
53
+ };
54
+ /**
55
+ * Per-entity outcome of a cross-entity bulk option update.
56
+ */
57
+ export type BulkEntityOptionUpdateStatus = 'applied' | 'skipped_no_permission' | 'failed';
58
+ /**
59
+ * Request for getting properties for multiple entities in bulk
60
+ */
61
+ export type BulkEntityPropertiesRequest = {
62
+ /**
63
+ * Array of entity references (entity_id and entity_type pairs)
64
+ */
65
+ entities: Array<PropertyTargetReference>;
66
+ /**
67
+ * Optional: only return properties with these definition IDs. If empty, returns all.
68
+ */
69
+ property_ids?: Array<string>;
70
+ };
71
+ /**
72
+ * Request to apply one shared option delta across several entities in a single
73
+ * call. Mirrors the per-entity bulk endpoint's delta semantics, applied to
74
+ * every listed entity (e.g. tag N emails with one label in one request).
75
+ */
76
+ export type BulkUpdateEntitiesPropertyOptionsRequest = {
77
+ /**
78
+ * Options to add to each entity's current value (deduped).
79
+ */
80
+ add_option_ids?: Array<string>;
81
+ /**
82
+ * The entities to update. Entities the caller cannot edit are skipped.
83
+ */
84
+ entities: Array<PropertyTargetReference>;
85
+ /**
86
+ * The multi-select property definition changed on every entity.
87
+ */
88
+ property_id: string;
89
+ /**
90
+ * Options to remove from each entity's current value (a no-op if absent).
91
+ */
92
+ remove_option_ids?: Array<string>;
93
+ };
94
+ /**
95
+ * Response for a cross-entity bulk option update: one result per requested
96
+ * entity, in request order.
97
+ */
98
+ export type BulkUpdateEntitiesPropertyOptionsResponse = {
99
+ /**
100
+ * Per-entity results, aligned to the request's `entities` order.
101
+ */
102
+ results: Array<BulkEntityOptionUpdateResult>;
103
+ };
104
+ /**
105
+ * Request to apply option deltas across one or more of an entity's multi-select
106
+ * properties in a single transaction.
107
+ */
108
+ export type BulkUpdateEntityPropertyOptionsRequest = {
109
+ /**
110
+ * The per-property option changes to apply.
111
+ */
112
+ properties: Array<EntityPropertyOptionUpdateRequest>;
113
+ };
114
+ /**
115
+ * Response for a bulk option update: each property's reconciled final ids.
116
+ */
117
+ export type BulkUpdateEntityPropertyOptionsResponse = {
118
+ /**
119
+ * The final option ids per updated property.
120
+ */
121
+ properties: Array<EntityPropertyOptionSelectionResponse>;
122
+ };
123
+ /**
124
+ * Request to create a new property definition.
125
+ */
126
+ export type CreatePropertyDefinitionRequest = {
127
+ data_type: PropertyDataType;
128
+ display_name: string;
129
+ scope: CreatePropertyScope;
130
+ };
131
+ /**
132
+ * Ownership scope a client may request when creating a property definition.
133
+ * The owning user or team is derived server-side from the authenticated caller -
134
+ * clients never supply owner ids. System properties are not creatable via the API.
135
+ */
136
+ export type CreatePropertyScope = 'user' | 'team';
137
+ /**
138
+ * Data type for property values, determining storage and validation.
139
+ */
140
+ export type DataType = 'BOOLEAN' | 'DATE' | 'NUMBER' | 'STRING' | 'SELECT_NUMBER' | 'SELECT_STRING' | 'TAG' | 'ENTITY' | 'LINK';
141
+ /**
142
+ * Request to provision (get-or-create) the caller's tag set for a scope.
143
+ */
144
+ export type EnsureTagSetRequest = {
145
+ scope: TagScope;
146
+ };
147
+ /**
148
+ * Response for document/entity properties endpoint.
149
+ */
150
+ export type EntityPropertiesResponse = {
151
+ entity_id: string;
152
+ properties: Array<EntityPropertyWithDefinition>;
153
+ };
154
+ /**
155
+ * Assignment of a property definition to a specific entity (service representation).
156
+ */
157
+ export type EntityProperty = {
158
+ created_at: string;
159
+ entity_id: string;
160
+ entity_type: EntityType;
161
+ id: string;
162
+ property_definition_id: string;
163
+ updated_at: string;
164
+ };
165
+ /**
166
+ * The reconciled final option ids stored for one property after a bulk update.
167
+ */
168
+ export type EntityPropertyOptionSelectionResponse = {
169
+ /**
170
+ * The final option ids the server persisted, in stored order.
171
+ */
172
+ option_ids: Array<string>;
173
+ /**
174
+ * The property definition the options belong to.
175
+ */
176
+ property_id: string;
177
+ };
178
+ /**
179
+ * One property's option changes in a bulk selection update. The change is a
180
+ * delta (options to add / remove) so it composes with concurrent edits rather
181
+ * than replacing the whole value.
182
+ */
183
+ export type EntityPropertyOptionUpdateRequest = {
184
+ /**
185
+ * Options to add (deduped against the current value).
186
+ */
187
+ add_option_ids?: Array<string>;
188
+ /**
189
+ * The multi-select property definition being changed.
190
+ */
191
+ property_id: string;
192
+ /**
193
+ * Options to remove (a no-op if not present).
194
+ */
195
+ remove_option_ids?: Array<string>;
196
+ };
197
+ /**
198
+ * Entity property response (API representation).
199
+ */
200
+ export type EntityPropertyResponse = {
201
+ createdAt?: string | null;
202
+ entityId: string;
203
+ entityType: EntityType;
204
+ id: string;
205
+ propertyDefinitionId: string;
206
+ updatedAt?: string | null;
207
+ };
208
+ /**
209
+ * Entity property with its definition, value, and options (service representation).
210
+ */
211
+ export type EntityPropertyWithDefinition = {
212
+ definition: PropertyDefinition;
213
+ options?: Array<PropertyOption> | null;
214
+ property: EntityProperty;
215
+ value?: null | PropertyValue;
216
+ };
217
+ /**
218
+ * Entity property with definition response (API representation).
219
+ */
220
+ export type EntityPropertyWithDefinitionResponse = {
221
+ definition: PropertyDefinitionDetailResponse;
222
+ options?: Array<PropertyOptionResponse> | null;
223
+ property: EntityPropertyResponse;
224
+ value?: null | PropertyValue;
225
+ };
226
+ /**
227
+ * Query parameters for entity properties endpoint.
228
+ */
229
+ export type EntityQueryParams = {
230
+ /**
231
+ * Whether to include system metadata properties (default: false)
232
+ */
233
+ include_metadata?: boolean;
234
+ };
235
+ /**
236
+ * Entity reference for entity-type property values.
237
+ */
238
+ export type EntityReference = {
239
+ entity_id: string;
240
+ entity_type: EntityType;
241
+ /**
242
+ * For CHANNEL, CHAT, THREAD entity types - optional specific message ID.
243
+ * This allows referencing a specific message within a thread/channel/chat.
244
+ */
245
+ specific_message_id?: string | null;
246
+ };
247
+ /**
248
+ * Type of entity that can be referenced by entity properties.
249
+ */
250
+ export type EntityType = 'CALENDAR_EVENT' | 'CALL_RECORD' | 'CHANNEL' | 'CHAT' | 'COMPANY' | 'DOCUMENT' | 'PROJECT' | 'TASK' | 'THREAD' | 'USER';
251
+ /**
252
+ * Query parameters for listing properties
253
+ */
254
+ export type ListPropertiesQuery = {
255
+ for_entity_type?: null | EntityType;
256
+ /**
257
+ * Whether to include property options in the response
258
+ */
259
+ include_options?: boolean;
260
+ /**
261
+ * Scope filter for properties
262
+ */
263
+ scope: PropertyScope;
264
+ };
265
+ /**
266
+ * Request to replace a personal label with an existing team label.
267
+ */
268
+ export type MergeTagRequest = {
269
+ /**
270
+ * The personal label to retire.
271
+ */
272
+ option_id: string;
273
+ /**
274
+ * The team label every entity carrying `option_id` is retagged with.
275
+ */
276
+ target_option_id: string;
277
+ };
278
+ /**
279
+ * Request to share one of the caller's personal labels with their team.
280
+ */
281
+ export type PromoteTagRequest = {
282
+ /**
283
+ * The personal label to move into the team tag set.
284
+ */
285
+ option_id: string;
286
+ };
287
+ /**
288
+ * Data type with embedded options for requests - provides compile-time validation.
289
+ */
290
+ export type PropertyDataType = {
291
+ type: 'boolean';
292
+ } | {
293
+ type: 'date';
294
+ } | {
295
+ type: 'number';
296
+ } | {
297
+ type: 'string';
298
+ } | {
299
+ multi: boolean;
300
+ options: Array<SelectNumberOption>;
301
+ type: 'select_number';
302
+ } | {
303
+ multi: boolean;
304
+ options: Array<SelectStringOption>;
305
+ type: 'select_string';
306
+ } | {
307
+ multi: boolean;
308
+ specific_type?: null | EntityType;
309
+ type: 'entity';
310
+ } | {
311
+ multi: boolean;
312
+ type: 'link';
313
+ };
314
+ /**
315
+ * Property definition model (service representation).
316
+ */
317
+ export type PropertyDefinition = {
318
+ created_at: string;
319
+ data_type: DataType;
320
+ display_name: string;
321
+ id: string;
322
+ /**
323
+ * Flag to indicate if this is a system-generated metadata property.
324
+ * Not stored in database - computed at service layer.
325
+ */
326
+ is_metadata: boolean;
327
+ is_multi_select: boolean;
328
+ /**
329
+ * Flag to indicate if this is a system property (stored in DB).
330
+ */
331
+ is_system: boolean;
332
+ owner: PropertyOwner;
333
+ specific_entity_type?: null | EntityType;
334
+ updated_at: string;
335
+ };
336
+ /**
337
+ * Property definition response (API representation).
338
+ */
339
+ export type PropertyDefinitionDetailResponse = PropertyOwner & {
340
+ createdAt?: string | null;
341
+ dataType: DataType;
342
+ displayName: string;
343
+ id: string;
344
+ /**
345
+ * Flag to indicate if this is a system-generated metadata property
346
+ */
347
+ isMetadata: boolean;
348
+ isMultiSelect: boolean;
349
+ /**
350
+ * Flag to indicate if this is a system property (managed by the system)
351
+ */
352
+ isSystem: boolean;
353
+ specificEntityType?: null | EntityType;
354
+ updatedAt?: string | null;
355
+ };
356
+ /**
357
+ * Response for property definition with optional property options
358
+ */
359
+ export type PropertyDefinitionResponse = PropertyDefinition | PropertyDefinitionWithOptions;
360
+ /**
361
+ * Property definition with its associated options (service representation).
362
+ */
363
+ export type PropertyDefinitionWithOptions = {
364
+ definition: PropertyDefinition;
365
+ property_options: Array<PropertyOption>;
366
+ };
367
+ /**
368
+ * Property definition with options response.
369
+ */
370
+ export type PropertyDefinitionWithOptionsResponse = {
371
+ definition: PropertyDefinitionDetailResponse;
372
+ propertyOptions: Array<PropertyOptionResponse>;
373
+ };
374
+ /**
375
+ * A selectable option for select-type properties (service representation).
376
+ */
377
+ export type PropertyOption = {
378
+ color?: string | null;
379
+ created_at: string;
380
+ display_order: number;
381
+ id: string;
382
+ property_definition_id: string;
383
+ updated_at: string;
384
+ value: PropertyOptionValue;
385
+ };
386
+ /**
387
+ * Property option response (API representation).
388
+ */
389
+ export type PropertyOptionResponse = {
390
+ color?: string | null;
391
+ displayOrder: number;
392
+ id: string;
393
+ propertyDefinitionId: string;
394
+ value: PropertyOptionValue;
395
+ };
396
+ /**
397
+ * The value of a property option - either a string or a number.
398
+ */
399
+ export type PropertyOptionValue = {
400
+ type: 'string';
401
+ /**
402
+ * String value for SelectString properties
403
+ */
404
+ value: string;
405
+ } | {
406
+ type: 'number';
407
+ /**
408
+ * Number value for SelectNumber properties
409
+ */
410
+ value: number;
411
+ };
412
+ /**
413
+ * Defines who owns a property - user-scoped, team-scoped, or system.
414
+ */
415
+ export type PropertyOwner = {
416
+ scope: 'user';
417
+ user_id: string;
418
+ } | {
419
+ scope: 'team';
420
+ team_id: string;
421
+ } | {
422
+ scope: 'system';
423
+ };
424
+ /**
425
+ * Scope filter for property queries
426
+ */
427
+ export type PropertyScope = 'user' | 'team' | 'system' | 'all';
428
+ /**
429
+ * Canonical type of an entity receiving properties.
430
+ *
431
+ * Tasks are documents at API boundaries. `Task` intentionally does not exist
432
+ * here; task classification is resolved by the properties domain from the
433
+ * document subtype.
434
+ */
435
+ export type PropertyTargetEntityType = 'CALL_RECORD' | 'CHANNEL' | 'CHAT' | 'COMPANY' | 'DOCUMENT' | 'PROJECT' | 'THREAD' | 'USER';
436
+ /**
437
+ * Canonical reference to an entity receiving properties.
438
+ */
439
+ export type PropertyTargetReference = {
440
+ /**
441
+ * Entity identifier.
442
+ */
443
+ entity_id: string;
444
+ /**
445
+ * Canonical entity type.
446
+ */
447
+ entity_type: PropertyTargetEntityType;
448
+ };
449
+ /**
450
+ * Property value (service representation).
451
+ *
452
+ * Represents the actual value stored for an entity property.
453
+ * This is serialized to/from JSONB in the database.
454
+ */
455
+ export type PropertyValue = {
456
+ type: 'Boolean';
457
+ /**
458
+ * Boolean value
459
+ * Serializes as: {"type": "Boolean", "value": true}
460
+ */
461
+ value: boolean;
462
+ } | {
463
+ type: 'Number';
464
+ /**
465
+ * Numeric value
466
+ * Serializes as: {"type": "Number", "value": 42.5}
467
+ */
468
+ value: number;
469
+ } | {
470
+ type: 'String';
471
+ /**
472
+ * String value
473
+ * Serializes as: {"type": "String", "value": "text"}
474
+ */
475
+ value: string;
476
+ } | {
477
+ type: 'Date';
478
+ /**
479
+ * Date/timestamp value
480
+ * Serializes as: {"type": "Date", "value": "2025-01-01T00:00:00Z"}
481
+ */
482
+ value: string;
483
+ } | {
484
+ type: 'SelectOption';
485
+ /**
486
+ * Select option(s) - always an array (check is_multi_select to determine if single or multi)
487
+ * Single-select: {"type": "SelectOption", "value": ["uuid"]} (length 0 or 1)
488
+ * Multi-select: {"type": "SelectOption", "value": ["uuid1", "uuid2", ...]} (length 0+)
489
+ */
490
+ value: Array<string>;
491
+ } | {
492
+ type: 'EntityReference';
493
+ /**
494
+ * Entity reference(s) - always an array (check is_multi_select to determine if single or multi)
495
+ * Single-select: {"type": "EntityReference", "value": [{...}]} (length 0 or 1)
496
+ * Multi-select: {"type": "EntityReference", "value": [{...}, {...}, ...]} (length 0+)
497
+ */
498
+ value: Array<EntityReference>;
499
+ } | {
500
+ type: 'Link';
501
+ /**
502
+ * Link value(s) - always an array (check is_multi_select to determine if single or multi)
503
+ * Single-select: {"type": "Link", "value": ["https://example.com"]} (length 0 or 1)
504
+ * Multi-select: {"type": "Link", "value": ["https://example.com", "https://other.com"]} (length 0+)
505
+ */
506
+ value: Array<string>;
507
+ };
508
+ /**
509
+ * Option for select number properties in requests.
510
+ */
511
+ export type SelectNumberOption = {
512
+ display_order: number;
513
+ value: number;
514
+ };
515
+ /**
516
+ * Option for select-type properties in requests.
517
+ */
518
+ export type SelectStringOption = {
519
+ display_order: number;
520
+ value: string;
521
+ };
522
+ /**
523
+ * Type-safe request for setting entity property values.
524
+ */
525
+ export type SetEntityPropertyRequest = {
526
+ value?: null | SetPropertyValue;
527
+ };
528
+ /**
529
+ * Type-safe enum for setting entity property values - provides compile-time validation.
530
+ */
531
+ export type SetPropertyValue = {
532
+ type: 'boolean';
533
+ value: boolean;
534
+ } | {
535
+ type: 'date';
536
+ value: string;
537
+ } | {
538
+ type: 'number';
539
+ value: number;
540
+ } | {
541
+ type: 'string';
542
+ value: string;
543
+ } | {
544
+ option_id: string;
545
+ type: 'select_option';
546
+ } | {
547
+ option_ids: Array<string>;
548
+ type: 'multi_select_option';
549
+ } | {
550
+ reference: EntityReference;
551
+ type: 'entity_reference';
552
+ } | {
553
+ references: Array<EntityReference>;
554
+ type: 'multi_entity_reference';
555
+ } | {
556
+ type: 'link';
557
+ url: string;
558
+ } | {
559
+ type: 'multi_link';
560
+ urls: Array<string>;
561
+ };
562
+ /**
563
+ * Body returned when a promotion collides with a label the team already has.
564
+ * The caller confirms with the user, then calls the merge endpoint with
565
+ * `conflicting_option.id` as the target.
566
+ */
567
+ export type TagPromotionConflictResponse = {
568
+ /**
569
+ * The team label that already uses this name.
570
+ */
571
+ conflicting_option: PropertyOptionResponse;
572
+ /**
573
+ * Human-readable description of the collision.
574
+ */
575
+ message: string;
576
+ };
577
+ /**
578
+ * Which owner a tag set belongs to.
579
+ */
580
+ export type TagScope = 'user' | 'team';
581
+ /**
582
+ * A tag set the caller can use. `definition` is absent until the set is provisioned
583
+ * (on first label create), in which case `options` is empty.
584
+ */
585
+ export type TagSetResponse = {
586
+ definition?: null | PropertyDefinitionDetailResponse;
587
+ options: Array<PropertyOptionResponse>;
588
+ scope: TagScope;
589
+ };
590
+ /**
591
+ * Request to update a property option in place. Omitted fields keep their current value.
592
+ * The option id is preserved, so the change propagates to every entity referencing it.
593
+ */
594
+ export type UpdatePropertyOptionRequest = {
595
+ /**
596
+ * New color as a hex string like `#RRGGBB`.
597
+ */
598
+ color?: string | null;
599
+ /**
600
+ * New display order.
601
+ */
602
+ display_order?: number | null;
603
+ /**
604
+ * New string value (label text). Only valid for SelectString and Tag properties.
605
+ */
606
+ value?: string | null;
607
+ };
608
+ export type ListPropertiesData = {
609
+ body?: never;
610
+ path?: never;
611
+ query: {
612
+ /**
613
+ * Filter by scope: 'user', 'team', 'system', or 'all'
614
+ */
615
+ scope: PropertyScope;
616
+ /**
617
+ * Whether to include property options in the response
618
+ */
619
+ include_options?: boolean;
620
+ /**
621
+ * Filter properties applicable to a specific entity type
622
+ */
623
+ for_entity_type?: EntityType;
624
+ };
625
+ url: '/properties/definitions';
626
+ };
627
+ export type ListPropertiesErrors = {
628
+ /**
629
+ * Invalid request
630
+ */
631
+ 400: unknown;
632
+ /**
633
+ * Internal server error
634
+ */
635
+ 500: unknown;
636
+ };
637
+ export type ListPropertiesResponses = {
638
+ /**
639
+ * Properties retrieved successfully
640
+ */
641
+ 200: Array<PropertyDefinitionResponse>;
642
+ };
643
+ export type ListPropertiesResponse = ListPropertiesResponses[keyof ListPropertiesResponses];
644
+ export type CreatePropertyDefinitionData = {
645
+ body: CreatePropertyDefinitionRequest;
646
+ path?: never;
647
+ query?: never;
648
+ url: '/properties/definitions';
649
+ };
650
+ export type CreatePropertyDefinitionErrors = {
651
+ /**
652
+ * Invalid request
653
+ */
654
+ 400: unknown;
655
+ /**
656
+ * Team membership required for team scope
657
+ */
658
+ 403: unknown;
659
+ /**
660
+ * Internal server error
661
+ */
662
+ 500: unknown;
663
+ };
664
+ export type CreatePropertyDefinitionResponses = {
665
+ /**
666
+ * Property definition created successfully
667
+ */
668
+ 201: PropertyDefinition;
669
+ };
670
+ export type CreatePropertyDefinitionResponse = CreatePropertyDefinitionResponses[keyof CreatePropertyDefinitionResponses];
671
+ export type DeletePropertyDefinitionData = {
672
+ body?: never;
673
+ path: {
674
+ /**
675
+ * Property definition ID
676
+ */
677
+ definition_id: string;
678
+ };
679
+ query?: never;
680
+ url: '/properties/definitions/{definition_id}';
681
+ };
682
+ export type DeletePropertyDefinitionErrors = {
683
+ /**
684
+ * Invalid property ID
685
+ */
686
+ 400: unknown;
687
+ /**
688
+ * Cannot modify system properties
689
+ */
690
+ 403: unknown;
691
+ /**
692
+ * Property definition not found
693
+ */
694
+ 404: unknown;
695
+ /**
696
+ * Internal server error
697
+ */
698
+ 500: unknown;
699
+ };
700
+ export type DeletePropertyDefinitionResponses = {
701
+ /**
702
+ * Property definition deleted successfully
703
+ */
704
+ 204: void;
705
+ };
706
+ export type DeletePropertyDefinitionResponse = DeletePropertyDefinitionResponses[keyof DeletePropertyDefinitionResponses];
707
+ export type GetPropertyDefinitionData = {
708
+ body?: never;
709
+ path: {
710
+ /**
711
+ * Property definition ID
712
+ */
713
+ definition_id: string;
714
+ };
715
+ query?: never;
716
+ url: '/properties/definitions/{definition_id}';
717
+ };
718
+ export type GetPropertyDefinitionErrors = {
719
+ /**
720
+ * Invalid property ID
721
+ */
722
+ 400: unknown;
723
+ /**
724
+ * Property definition not found
725
+ */
726
+ 404: unknown;
727
+ /**
728
+ * Internal server error
729
+ */
730
+ 500: unknown;
731
+ };
732
+ export type GetPropertyDefinitionResponses = {
733
+ /**
734
+ * Property definition retrieved successfully
735
+ */
736
+ 200: PropertyDefinition;
737
+ };
738
+ export type GetPropertyDefinitionResponse = GetPropertyDefinitionResponses[keyof GetPropertyDefinitionResponses];
739
+ export type GetPropertyOptionsData = {
740
+ body?: never;
741
+ path: {
742
+ /**
743
+ * Property definition ID
744
+ */
745
+ definition_id: string;
746
+ };
747
+ query?: never;
748
+ url: '/properties/definitions/{definition_id}/options';
749
+ };
750
+ export type GetPropertyOptionsErrors = {
751
+ /**
752
+ * Property not found
753
+ */
754
+ 404: unknown;
755
+ /**
756
+ * Internal server error
757
+ */
758
+ 500: unknown;
759
+ };
760
+ export type GetPropertyOptionsResponses = {
761
+ /**
762
+ * Property options retrieved successfully
763
+ */
764
+ 200: Array<PropertyOption>;
765
+ };
766
+ export type GetPropertyOptionsResponse = GetPropertyOptionsResponses[keyof GetPropertyOptionsResponses];
767
+ export type AddPropertyOptionData = {
768
+ body: AddPropertyOptionRequest;
769
+ path: {
770
+ /**
771
+ * Property definition ID
772
+ */
773
+ definition_id: string;
774
+ };
775
+ query?: never;
776
+ url: '/properties/definitions/{definition_id}/options';
777
+ };
778
+ export type AddPropertyOptionErrors = {
779
+ /**
780
+ * Invalid request
781
+ */
782
+ 400: unknown;
783
+ /**
784
+ * Cannot modify system properties
785
+ */
786
+ 403: unknown;
787
+ /**
788
+ * Property not found
789
+ */
790
+ 404: unknown;
791
+ /**
792
+ * Internal server error
793
+ */
794
+ 500: unknown;
795
+ };
796
+ export type AddPropertyOptionResponses = {
797
+ /**
798
+ * Property option created successfully
799
+ */
800
+ 201: PropertyOption;
801
+ };
802
+ export type AddPropertyOptionResponse = AddPropertyOptionResponses[keyof AddPropertyOptionResponses];
803
+ export type DeletePropertyOptionData = {
804
+ body?: never;
805
+ path: {
806
+ /**
807
+ * Property definition ID
808
+ */
809
+ definition_id: string;
810
+ /**
811
+ * Property option ID
812
+ */
813
+ option_id: string;
814
+ };
815
+ query?: never;
816
+ url: '/properties/definitions/{definition_id}/options/{option_id}';
817
+ };
818
+ export type DeletePropertyOptionErrors = {
819
+ /**
820
+ * Invalid option ID
821
+ */
822
+ 400: unknown;
823
+ /**
824
+ * Cannot modify system properties
825
+ */
826
+ 403: unknown;
827
+ /**
828
+ * Property option not found
829
+ */
830
+ 404: unknown;
831
+ /**
832
+ * Internal server error
833
+ */
834
+ 500: unknown;
835
+ };
836
+ export type DeletePropertyOptionResponses = {
837
+ /**
838
+ * Property option deleted successfully
839
+ */
840
+ 204: void;
841
+ };
842
+ export type DeletePropertyOptionResponse = DeletePropertyOptionResponses[keyof DeletePropertyOptionResponses];
843
+ export type UpdatePropertyOptionData = {
844
+ body: UpdatePropertyOptionRequest;
845
+ path: {
846
+ /**
847
+ * Property definition ID
848
+ */
849
+ definition_id: string;
850
+ /**
851
+ * Property option ID
852
+ */
853
+ option_id: string;
854
+ };
855
+ query?: never;
856
+ url: '/properties/definitions/{definition_id}/options/{option_id}';
857
+ };
858
+ export type UpdatePropertyOptionErrors = {
859
+ /**
860
+ * Invalid request
861
+ */
862
+ 400: unknown;
863
+ /**
864
+ * Cannot modify system properties
865
+ */
866
+ 403: unknown;
867
+ /**
868
+ * Property or option not found
869
+ */
870
+ 404: unknown;
871
+ /**
872
+ * An option with that value already exists
873
+ */
874
+ 409: unknown;
875
+ /**
876
+ * Internal server error
877
+ */
878
+ 500: unknown;
879
+ };
880
+ export type UpdatePropertyOptionResponses = {
881
+ /**
882
+ * Property option updated
883
+ */
884
+ 200: PropertyOption;
885
+ };
886
+ export type UpdatePropertyOptionResponse = UpdatePropertyOptionResponses[keyof UpdatePropertyOptionResponses];
887
+ export type GetBulkEntityPropertiesData = {
888
+ body: BulkEntityPropertiesRequest;
889
+ path?: never;
890
+ query?: never;
891
+ url: '/properties/entities/bulk';
892
+ };
893
+ export type GetBulkEntityPropertiesErrors = {
894
+ /**
895
+ * Invalid request body
896
+ */
897
+ 400: unknown;
898
+ /**
899
+ * Forbidden - User does not have permission
900
+ */
901
+ 403: unknown;
902
+ /**
903
+ * Internal server error
904
+ */
905
+ 500: unknown;
906
+ };
907
+ export type GetBulkEntityPropertiesResponses = {
908
+ /**
909
+ * Bulk entity properties retrieved successfully
910
+ */
911
+ 200: {
912
+ [key: string]: EntityPropertiesResponse;
913
+ };
914
+ };
915
+ export type GetBulkEntityPropertiesResponse = GetBulkEntityPropertiesResponses[keyof GetBulkEntityPropertiesResponses];
916
+ export type GetEntityPropertiesData = {
917
+ body?: never;
918
+ path: {
919
+ /**
920
+ * Canonical entity type; tasks use DOCUMENT
921
+ */
922
+ entity_type: PropertyTargetEntityType;
923
+ /**
924
+ * Entity ID
925
+ */
926
+ entity_id: string;
927
+ };
928
+ query?: {
929
+ /**
930
+ * Whether to include property metadata (default: false)
931
+ */
932
+ include_metadata?: boolean;
933
+ };
934
+ url: '/properties/entities/{entity_type}/{entity_id}';
935
+ };
936
+ export type GetEntityPropertiesErrors = {
937
+ /**
938
+ * Invalid entity type
939
+ */
940
+ 400: unknown;
941
+ /**
942
+ * Forbidden - User does not have permission to view this entity
943
+ */
944
+ 403: unknown;
945
+ /**
946
+ * Entity not found
947
+ */
948
+ 404: unknown;
949
+ /**
950
+ * Internal server error
951
+ */
952
+ 500: unknown;
953
+ };
954
+ export type GetEntityPropertiesResponses = {
955
+ /**
956
+ * Entity properties retrieved successfully
957
+ */
958
+ 200: EntityPropertiesResponse;
959
+ };
960
+ export type GetEntityPropertiesResponse = GetEntityPropertiesResponses[keyof GetEntityPropertiesResponses];
961
+ export type BulkUpdateEntityPropertyOptionsData = {
962
+ body: BulkUpdateEntityPropertyOptionsRequest;
963
+ path: {
964
+ /**
965
+ * Canonical entity type; tasks use DOCUMENT
966
+ */
967
+ entity_type: PropertyTargetEntityType;
968
+ /**
969
+ * Entity ID
970
+ */
971
+ entity_id: string;
972
+ };
973
+ query?: never;
974
+ url: '/properties/entities/{entity_type}/{entity_id}/options/bulk';
975
+ };
976
+ export type BulkUpdateEntityPropertyOptionsErrors = {
977
+ /**
978
+ * Invalid request, a property is not multi-select, or an option does not belong to its property
979
+ */
980
+ 400: unknown;
981
+ /**
982
+ * No edit access to the entity
983
+ */
984
+ 403: unknown;
985
+ /**
986
+ * Internal server error
987
+ */
988
+ 500: unknown;
989
+ };
990
+ export type BulkUpdateEntityPropertyOptionsResponses = {
991
+ /**
992
+ * Options updated; returns final ids per property
993
+ */
994
+ 200: BulkUpdateEntityPropertyOptionsResponse;
995
+ };
996
+ export type BulkUpdateEntityPropertyOptionsResponse2 = BulkUpdateEntityPropertyOptionsResponses[keyof BulkUpdateEntityPropertyOptionsResponses];
997
+ export type SetEntityPropertyData = {
998
+ body: SetEntityPropertyRequest;
999
+ path: {
1000
+ /**
1001
+ * Canonical entity type; tasks use DOCUMENT
1002
+ */
1003
+ entity_type: PropertyTargetEntityType;
1004
+ /**
1005
+ * Entity ID
1006
+ */
1007
+ entity_id: string;
1008
+ /**
1009
+ * Property ID
1010
+ */
1011
+ property_id: string;
1012
+ };
1013
+ query?: never;
1014
+ url: '/properties/entities/{entity_type}/{entity_id}/{property_id}';
1015
+ };
1016
+ export type SetEntityPropertyErrors = {
1017
+ /**
1018
+ * Invalid request or entity type
1019
+ */
1020
+ 400: unknown;
1021
+ /**
1022
+ * No edit access to the entity
1023
+ */
1024
+ 403: unknown;
1025
+ /**
1026
+ * Entity or property not found
1027
+ */
1028
+ 404: unknown;
1029
+ /**
1030
+ * Internal server error
1031
+ */
1032
+ 500: unknown;
1033
+ };
1034
+ export type SetEntityPropertyResponses = {
1035
+ /**
1036
+ * Entity property set successfully (with or without value)
1037
+ */
1038
+ 204: void;
1039
+ };
1040
+ export type SetEntityPropertyResponse = SetEntityPropertyResponses[keyof SetEntityPropertyResponses];
1041
+ export type RemoveEntityPropertyOptionData = {
1042
+ body?: never;
1043
+ path: {
1044
+ /**
1045
+ * Canonical entity type; tasks use DOCUMENT
1046
+ */
1047
+ entity_type: PropertyTargetEntityType;
1048
+ /**
1049
+ * Entity ID
1050
+ */
1051
+ entity_id: string;
1052
+ /**
1053
+ * Property ID
1054
+ */
1055
+ property_id: string;
1056
+ /**
1057
+ * Option ID to remove
1058
+ */
1059
+ option_id: string;
1060
+ };
1061
+ query?: never;
1062
+ url: '/properties/entities/{entity_type}/{entity_id}/{property_id}/options/{option_id}';
1063
+ };
1064
+ export type RemoveEntityPropertyOptionErrors = {
1065
+ /**
1066
+ * No edit access to the entity
1067
+ */
1068
+ 403: unknown;
1069
+ /**
1070
+ * Internal server error
1071
+ */
1072
+ 500: unknown;
1073
+ };
1074
+ export type RemoveEntityPropertyOptionResponses = {
1075
+ /**
1076
+ * Option removed successfully
1077
+ */
1078
+ 204: void;
1079
+ };
1080
+ export type RemoveEntityPropertyOptionResponse = RemoveEntityPropertyOptionResponses[keyof RemoveEntityPropertyOptionResponses];
1081
+ export type AddEntityPropertyOptionData = {
1082
+ body?: never;
1083
+ path: {
1084
+ /**
1085
+ * Canonical entity type; tasks use DOCUMENT
1086
+ */
1087
+ entity_type: PropertyTargetEntityType;
1088
+ /**
1089
+ * Entity ID
1090
+ */
1091
+ entity_id: string;
1092
+ /**
1093
+ * Property ID
1094
+ */
1095
+ property_id: string;
1096
+ /**
1097
+ * Option ID to add
1098
+ */
1099
+ option_id: string;
1100
+ };
1101
+ query?: never;
1102
+ url: '/properties/entities/{entity_type}/{entity_id}/{property_id}/options/{option_id}';
1103
+ };
1104
+ export type AddEntityPropertyOptionErrors = {
1105
+ /**
1106
+ * Invalid request, property is not multi-select, or option does not belong to the property
1107
+ */
1108
+ 400: unknown;
1109
+ /**
1110
+ * No edit access to the entity
1111
+ */
1112
+ 403: unknown;
1113
+ /**
1114
+ * Internal server error
1115
+ */
1116
+ 500: unknown;
1117
+ };
1118
+ export type AddEntityPropertyOptionResponses = {
1119
+ /**
1120
+ * Option added successfully
1121
+ */
1122
+ 204: void;
1123
+ };
1124
+ export type AddEntityPropertyOptionResponse = AddEntityPropertyOptionResponses[keyof AddEntityPropertyOptionResponses];
1125
+ export type DeleteEntityPropertyData = {
1126
+ body?: never;
1127
+ path: {
1128
+ /**
1129
+ * Entity Property ID
1130
+ */
1131
+ entity_property_id: string;
1132
+ };
1133
+ query?: never;
1134
+ url: '/properties/entity_properties/{entity_property_id}';
1135
+ };
1136
+ export type DeleteEntityPropertyErrors = {
1137
+ /**
1138
+ * Property is required and cannot be removed, or no edit access
1139
+ */
1140
+ 403: unknown;
1141
+ /**
1142
+ * Entity property not found
1143
+ */
1144
+ 404: unknown;
1145
+ /**
1146
+ * Internal server error
1147
+ */
1148
+ 500: unknown;
1149
+ };
1150
+ export type DeleteEntityPropertyResponses = {
1151
+ /**
1152
+ * Entity property removed successfully
1153
+ */
1154
+ 204: void;
1155
+ };
1156
+ export type DeleteEntityPropertyResponse = DeleteEntityPropertyResponses[keyof DeleteEntityPropertyResponses];
1157
+ export type BulkUpdateEntitiesPropertyOptionsData = {
1158
+ body: BulkUpdateEntitiesPropertyOptionsRequest;
1159
+ path?: never;
1160
+ query?: never;
1161
+ url: '/properties/options/bulk';
1162
+ };
1163
+ export type BulkUpdateEntitiesPropertyOptionsErrors = {
1164
+ /**
1165
+ * Invalid request, the property is not multi-select, or an option does not belong to the property
1166
+ */
1167
+ 400: unknown;
1168
+ /**
1169
+ * Unauthenticated
1170
+ */
1171
+ 401: unknown;
1172
+ /**
1173
+ * Internal server error
1174
+ */
1175
+ 500: unknown;
1176
+ };
1177
+ export type BulkUpdateEntitiesPropertyOptionsResponses = {
1178
+ /**
1179
+ * Per-entity results: each entity applied, skipped, or failed
1180
+ */
1181
+ 200: BulkUpdateEntitiesPropertyOptionsResponse;
1182
+ };
1183
+ export type BulkUpdateEntitiesPropertyOptionsResponse2 = BulkUpdateEntitiesPropertyOptionsResponses[keyof BulkUpdateEntitiesPropertyOptionsResponses];
1184
+ export type ListTagsData = {
1185
+ body?: never;
1186
+ path?: never;
1187
+ query?: never;
1188
+ url: '/properties/tags';
1189
+ };
1190
+ export type ListTagsErrors = {
1191
+ /**
1192
+ * Internal server error
1193
+ */
1194
+ 500: unknown;
1195
+ };
1196
+ export type ListTagsResponses = {
1197
+ /**
1198
+ * Tag sets retrieved
1199
+ */
1200
+ 200: Array<TagSetResponse>;
1201
+ };
1202
+ export type ListTagsResponse = ListTagsResponses[keyof ListTagsResponses];
1203
+ export type EnsureTagSetData = {
1204
+ body: EnsureTagSetRequest;
1205
+ path?: never;
1206
+ query?: never;
1207
+ url: '/properties/tags';
1208
+ };
1209
+ export type EnsureTagSetErrors = {
1210
+ /**
1211
+ * Team membership required for team scope
1212
+ */
1213
+ 403: unknown;
1214
+ /**
1215
+ * Internal server error
1216
+ */
1217
+ 500: unknown;
1218
+ };
1219
+ export type EnsureTagSetResponses = {
1220
+ /**
1221
+ * Tag set provisioned
1222
+ */
1223
+ 200: TagSetResponse;
1224
+ };
1225
+ export type EnsureTagSetResponse = EnsureTagSetResponses[keyof EnsureTagSetResponses];
1226
+ export type MergeTagData = {
1227
+ body: MergeTagRequest;
1228
+ path?: never;
1229
+ query?: never;
1230
+ url: '/properties/tags/merge';
1231
+ };
1232
+ export type MergeTagErrors = {
1233
+ /**
1234
+ * Invalid request
1235
+ */
1236
+ 400: unknown;
1237
+ /**
1238
+ * Team membership required
1239
+ */
1240
+ 403: unknown;
1241
+ /**
1242
+ * Either label was not found in the expected tag set
1243
+ */
1244
+ 404: unknown;
1245
+ /**
1246
+ * Internal server error
1247
+ */
1248
+ 500: unknown;
1249
+ };
1250
+ export type MergeTagResponses = {
1251
+ /**
1252
+ * Label merged into the team label
1253
+ */
1254
+ 200: PropertyOptionResponse;
1255
+ };
1256
+ export type MergeTagResponse = MergeTagResponses[keyof MergeTagResponses];
1257
+ export type PromoteTagData = {
1258
+ body: PromoteTagRequest;
1259
+ path?: never;
1260
+ query?: never;
1261
+ url: '/properties/tags/promote';
1262
+ };
1263
+ export type PromoteTagErrors = {
1264
+ /**
1265
+ * Team membership required
1266
+ */
1267
+ 403: unknown;
1268
+ /**
1269
+ * Label not found in the caller's tag set
1270
+ */
1271
+ 404: unknown;
1272
+ /**
1273
+ * The team already has a label with that name
1274
+ */
1275
+ 409: TagPromotionConflictResponse;
1276
+ /**
1277
+ * Internal server error
1278
+ */
1279
+ 500: unknown;
1280
+ };
1281
+ export type PromoteTagError = PromoteTagErrors[keyof PromoteTagErrors];
1282
+ export type PromoteTagResponses = {
1283
+ /**
1284
+ * Label moved to the team tag set
1285
+ */
1286
+ 200: PropertyOptionResponse;
1287
+ };
1288
+ export type PromoteTagResponse = PromoteTagResponses[keyof PromoteTagResponses];