@gleanwork/api-client 0.9.1 → 0.10.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 (301) hide show
  1. package/dist/commonjs/__tests__/announcements.test.js +2 -2
  2. package/dist/commonjs/__tests__/announcements.test.js.map +1 -1
  3. package/dist/commonjs/__tests__/answers.test.js +2 -2
  4. package/dist/commonjs/__tests__/answers.test.js.map +1 -1
  5. package/dist/commonjs/__tests__/clientchat.test.js +24 -24
  6. package/dist/commonjs/__tests__/clientchat.test.js.map +1 -1
  7. package/dist/commonjs/__tests__/clientshortcuts.test.js +2 -2
  8. package/dist/commonjs/__tests__/clientshortcuts.test.js.map +1 -1
  9. package/dist/commonjs/__tests__/collections.test.js +2 -2
  10. package/dist/commonjs/__tests__/collections.test.js.map +1 -1
  11. package/dist/commonjs/__tests__/search.test.js +1 -1
  12. package/dist/commonjs/__tests__/search.test.js.map +1 -1
  13. package/dist/commonjs/__tests__/summarize.test.js +8 -2
  14. package/dist/commonjs/__tests__/summarize.test.js.map +1 -1
  15. package/dist/commonjs/funcs/clientCollectionsCreate.d.ts +2 -1
  16. package/dist/commonjs/funcs/clientCollectionsCreate.d.ts.map +1 -1
  17. package/dist/commonjs/funcs/clientCollectionsCreate.js +2 -1
  18. package/dist/commonjs/funcs/clientCollectionsCreate.js.map +1 -1
  19. package/dist/commonjs/lib/config.d.ts +2 -2
  20. package/dist/commonjs/lib/config.js +2 -2
  21. package/dist/commonjs/lib/config.js.map +1 -1
  22. package/dist/commonjs/models/components/agentconfig.d.ts +12 -0
  23. package/dist/commonjs/models/components/agentconfig.d.ts.map +1 -1
  24. package/dist/commonjs/models/components/agentconfig.js +5 -0
  25. package/dist/commonjs/models/components/agentconfig.js.map +1 -1
  26. package/dist/commonjs/models/components/chat.d.ts +9 -0
  27. package/dist/commonjs/models/components/chat.d.ts.map +1 -1
  28. package/dist/commonjs/models/components/chat.js +6 -0
  29. package/dist/commonjs/models/components/chat.js.map +1 -1
  30. package/dist/commonjs/models/components/chatmessage.d.ts +3 -0
  31. package/dist/commonjs/models/components/chatmessage.d.ts.map +1 -1
  32. package/dist/commonjs/models/components/chatmessage.js +3 -2
  33. package/dist/commonjs/models/components/chatmessage.js.map +1 -1
  34. package/dist/commonjs/models/components/chatmessagefragment.d.ts +1 -1
  35. package/dist/commonjs/models/components/chatsuggestion.d.ts +37 -0
  36. package/dist/commonjs/models/components/chatsuggestion.d.ts.map +1 -0
  37. package/dist/commonjs/models/components/chatsuggestion.js +71 -0
  38. package/dist/commonjs/models/components/chatsuggestion.js.map +1 -0
  39. package/dist/commonjs/models/components/clustertypeenum.d.ts +6 -0
  40. package/dist/commonjs/models/components/clustertypeenum.d.ts.map +1 -1
  41. package/dist/commonjs/models/components/clustertypeenum.js +2 -0
  42. package/dist/commonjs/models/components/clustertypeenum.js.map +1 -1
  43. package/dist/commonjs/models/components/customdatasourceconfig.d.ts +3 -0
  44. package/dist/commonjs/models/components/customdatasourceconfig.d.ts.map +1 -1
  45. package/dist/commonjs/models/components/customdatasourceconfig.js +1 -0
  46. package/dist/commonjs/models/components/customdatasourceconfig.js.map +1 -1
  47. package/dist/commonjs/models/components/digest.d.ts +48 -0
  48. package/dist/commonjs/models/components/digest.d.ts.map +1 -0
  49. package/dist/commonjs/models/components/digest.js +77 -0
  50. package/dist/commonjs/models/components/digest.js.map +1 -0
  51. package/dist/commonjs/models/components/digestsection.d.ts +64 -0
  52. package/dist/commonjs/models/components/digestsection.d.ts.map +1 -0
  53. package/dist/commonjs/models/components/digestsection.js +83 -0
  54. package/dist/commonjs/models/components/digestsection.js.map +1 -0
  55. package/dist/commonjs/models/components/digestupdate.d.ts +53 -0
  56. package/dist/commonjs/models/components/digestupdate.d.ts.map +1 -0
  57. package/dist/commonjs/models/components/digestupdate.js +78 -0
  58. package/dist/commonjs/models/components/digestupdate.js.map +1 -0
  59. package/dist/commonjs/models/components/documentspecunion.d.ts +99 -18
  60. package/dist/commonjs/models/components/documentspecunion.d.ts.map +1 -1
  61. package/dist/commonjs/models/components/documentspecunion.js +78 -19
  62. package/dist/commonjs/models/components/documentspecunion.js.map +1 -1
  63. package/dist/commonjs/models/components/feedentry.d.ts +12 -0
  64. package/dist/commonjs/models/components/feedentry.d.ts.map +1 -1
  65. package/dist/commonjs/models/components/feedentry.js +8 -0
  66. package/dist/commonjs/models/components/feedentry.js.map +1 -1
  67. package/dist/commonjs/models/components/feedrequest.d.ts +6 -0
  68. package/dist/commonjs/models/components/feedrequest.d.ts.map +1 -1
  69. package/dist/commonjs/models/components/feedrequest.js +2 -0
  70. package/dist/commonjs/models/components/feedrequest.js.map +1 -1
  71. package/dist/commonjs/models/components/feedresult.d.ts +6 -0
  72. package/dist/commonjs/models/components/feedresult.d.ts.map +1 -1
  73. package/dist/commonjs/models/components/feedresult.js +2 -0
  74. package/dist/commonjs/models/components/feedresult.js.map +1 -1
  75. package/dist/commonjs/models/components/getchatfilesrequest.d.ts +5 -0
  76. package/dist/commonjs/models/components/getchatfilesrequest.d.ts.map +1 -1
  77. package/dist/commonjs/models/components/getchatfilesrequest.js +2 -0
  78. package/dist/commonjs/models/components/getchatfilesrequest.js.map +1 -1
  79. package/dist/commonjs/models/components/group.d.ts +10 -0
  80. package/dist/commonjs/models/components/group.d.ts.map +1 -1
  81. package/dist/commonjs/models/components/group.js +4 -0
  82. package/dist/commonjs/models/components/group.js.map +1 -1
  83. package/dist/commonjs/models/components/index.d.ts +7 -1
  84. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  85. package/dist/commonjs/models/components/index.js +7 -1
  86. package/dist/commonjs/models/components/index.js.map +1 -1
  87. package/dist/commonjs/models/components/manualfeedbackinfo.d.ts +2 -0
  88. package/dist/commonjs/models/components/manualfeedbackinfo.d.ts.map +1 -1
  89. package/dist/commonjs/models/components/manualfeedbackinfo.js.map +1 -1
  90. package/dist/commonjs/models/components/objectdefinition.d.ts +3 -0
  91. package/dist/commonjs/models/components/objectdefinition.d.ts.map +1 -1
  92. package/dist/commonjs/models/components/objectdefinition.js +1 -0
  93. package/dist/commonjs/models/components/objectdefinition.js.map +1 -1
  94. package/dist/commonjs/models/components/searchrequestoptions.d.ts +1 -1
  95. package/dist/commonjs/models/components/searchresultsnippet.d.ts +7 -5
  96. package/dist/commonjs/models/components/searchresultsnippet.d.ts.map +1 -1
  97. package/dist/commonjs/models/components/searchresultsnippet.js +2 -2
  98. package/dist/commonjs/models/components/searchresultsnippet.js.map +1 -1
  99. package/dist/commonjs/models/components/sectiontype.d.ts +37 -0
  100. package/dist/commonjs/models/components/sectiontype.d.ts.map +1 -0
  101. package/dist/commonjs/models/components/sectiontype.js +65 -0
  102. package/dist/commonjs/models/components/sectiontype.js.map +1 -0
  103. package/dist/commonjs/models/components/toolsets.d.ts +40 -0
  104. package/dist/commonjs/models/components/toolsets.d.ts.map +1 -0
  105. package/dist/commonjs/models/components/toolsets.js +71 -0
  106. package/dist/commonjs/models/components/toolsets.js.map +1 -0
  107. package/dist/commonjs/models/components/updatetype.d.ts +34 -0
  108. package/dist/commonjs/models/components/updatetype.d.ts.map +1 -0
  109. package/dist/commonjs/models/components/updatetype.js +64 -0
  110. package/dist/commonjs/models/components/updatetype.js.map +1 -0
  111. package/dist/commonjs/models/operations/createcollection.d.ts +83 -0
  112. package/dist/commonjs/models/operations/createcollection.d.ts.map +1 -0
  113. package/dist/commonjs/models/operations/createcollection.js +130 -0
  114. package/dist/commonjs/models/operations/createcollection.js.map +1 -0
  115. package/dist/commonjs/models/operations/index.d.ts +1 -0
  116. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  117. package/dist/commonjs/models/operations/index.js +1 -0
  118. package/dist/commonjs/models/operations/index.js.map +1 -1
  119. package/dist/commonjs/react-query/clientCollectionsCreate.d.ts +2 -1
  120. package/dist/commonjs/react-query/clientCollectionsCreate.d.ts.map +1 -1
  121. package/dist/commonjs/react-query/clientCollectionsCreate.js.map +1 -1
  122. package/dist/commonjs/sdk/collections.d.ts +2 -1
  123. package/dist/commonjs/sdk/collections.d.ts.map +1 -1
  124. package/dist/commonjs/sdk/collections.js.map +1 -1
  125. package/dist/esm/__tests__/announcements.test.js +2 -2
  126. package/dist/esm/__tests__/announcements.test.js.map +1 -1
  127. package/dist/esm/__tests__/answers.test.js +2 -2
  128. package/dist/esm/__tests__/answers.test.js.map +1 -1
  129. package/dist/esm/__tests__/clientchat.test.js +24 -24
  130. package/dist/esm/__tests__/clientchat.test.js.map +1 -1
  131. package/dist/esm/__tests__/clientshortcuts.test.js +2 -2
  132. package/dist/esm/__tests__/clientshortcuts.test.js.map +1 -1
  133. package/dist/esm/__tests__/collections.test.js +2 -2
  134. package/dist/esm/__tests__/collections.test.js.map +1 -1
  135. package/dist/esm/__tests__/search.test.js +1 -1
  136. package/dist/esm/__tests__/search.test.js.map +1 -1
  137. package/dist/esm/__tests__/summarize.test.js +8 -2
  138. package/dist/esm/__tests__/summarize.test.js.map +1 -1
  139. package/dist/esm/funcs/clientCollectionsCreate.d.ts +2 -1
  140. package/dist/esm/funcs/clientCollectionsCreate.d.ts.map +1 -1
  141. package/dist/esm/funcs/clientCollectionsCreate.js +2 -1
  142. package/dist/esm/funcs/clientCollectionsCreate.js.map +1 -1
  143. package/dist/esm/lib/config.d.ts +2 -2
  144. package/dist/esm/lib/config.js +2 -2
  145. package/dist/esm/lib/config.js.map +1 -1
  146. package/dist/esm/models/components/agentconfig.d.ts +12 -0
  147. package/dist/esm/models/components/agentconfig.d.ts.map +1 -1
  148. package/dist/esm/models/components/agentconfig.js +5 -0
  149. package/dist/esm/models/components/agentconfig.js.map +1 -1
  150. package/dist/esm/models/components/chat.d.ts +9 -0
  151. package/dist/esm/models/components/chat.d.ts.map +1 -1
  152. package/dist/esm/models/components/chat.js +6 -0
  153. package/dist/esm/models/components/chat.js.map +1 -1
  154. package/dist/esm/models/components/chatmessage.d.ts +3 -0
  155. package/dist/esm/models/components/chatmessage.d.ts.map +1 -1
  156. package/dist/esm/models/components/chatmessage.js +3 -2
  157. package/dist/esm/models/components/chatmessage.js.map +1 -1
  158. package/dist/esm/models/components/chatmessagefragment.d.ts +1 -1
  159. package/dist/esm/models/components/chatsuggestion.d.ts +37 -0
  160. package/dist/esm/models/components/chatsuggestion.d.ts.map +1 -0
  161. package/dist/esm/models/components/chatsuggestion.js +33 -0
  162. package/dist/esm/models/components/chatsuggestion.js.map +1 -0
  163. package/dist/esm/models/components/clustertypeenum.d.ts +6 -0
  164. package/dist/esm/models/components/clustertypeenum.d.ts.map +1 -1
  165. package/dist/esm/models/components/clustertypeenum.js +2 -0
  166. package/dist/esm/models/components/clustertypeenum.js.map +1 -1
  167. package/dist/esm/models/components/customdatasourceconfig.d.ts +3 -0
  168. package/dist/esm/models/components/customdatasourceconfig.d.ts.map +1 -1
  169. package/dist/esm/models/components/customdatasourceconfig.js +1 -0
  170. package/dist/esm/models/components/customdatasourceconfig.js.map +1 -1
  171. package/dist/esm/models/components/digest.d.ts +48 -0
  172. package/dist/esm/models/components/digest.d.ts.map +1 -0
  173. package/dist/esm/models/components/digest.js +39 -0
  174. package/dist/esm/models/components/digest.js.map +1 -0
  175. package/dist/esm/models/components/digestsection.d.ts +64 -0
  176. package/dist/esm/models/components/digestsection.d.ts.map +1 -0
  177. package/dist/esm/models/components/digestsection.js +45 -0
  178. package/dist/esm/models/components/digestsection.js.map +1 -0
  179. package/dist/esm/models/components/digestupdate.d.ts +53 -0
  180. package/dist/esm/models/components/digestupdate.d.ts.map +1 -0
  181. package/dist/esm/models/components/digestupdate.js +40 -0
  182. package/dist/esm/models/components/digestupdate.js.map +1 -0
  183. package/dist/esm/models/components/documentspecunion.d.ts +99 -18
  184. package/dist/esm/models/components/documentspecunion.d.ts.map +1 -1
  185. package/dist/esm/models/components/documentspecunion.js +75 -18
  186. package/dist/esm/models/components/documentspecunion.js.map +1 -1
  187. package/dist/esm/models/components/feedentry.d.ts +12 -0
  188. package/dist/esm/models/components/feedentry.d.ts.map +1 -1
  189. package/dist/esm/models/components/feedentry.js +8 -0
  190. package/dist/esm/models/components/feedentry.js.map +1 -1
  191. package/dist/esm/models/components/feedrequest.d.ts +6 -0
  192. package/dist/esm/models/components/feedrequest.d.ts.map +1 -1
  193. package/dist/esm/models/components/feedrequest.js +2 -0
  194. package/dist/esm/models/components/feedrequest.js.map +1 -1
  195. package/dist/esm/models/components/feedresult.d.ts +6 -0
  196. package/dist/esm/models/components/feedresult.d.ts.map +1 -1
  197. package/dist/esm/models/components/feedresult.js +2 -0
  198. package/dist/esm/models/components/feedresult.js.map +1 -1
  199. package/dist/esm/models/components/getchatfilesrequest.d.ts +5 -0
  200. package/dist/esm/models/components/getchatfilesrequest.d.ts.map +1 -1
  201. package/dist/esm/models/components/getchatfilesrequest.js +2 -0
  202. package/dist/esm/models/components/getchatfilesrequest.js.map +1 -1
  203. package/dist/esm/models/components/group.d.ts +10 -0
  204. package/dist/esm/models/components/group.d.ts.map +1 -1
  205. package/dist/esm/models/components/group.js +4 -0
  206. package/dist/esm/models/components/group.js.map +1 -1
  207. package/dist/esm/models/components/index.d.ts +7 -1
  208. package/dist/esm/models/components/index.d.ts.map +1 -1
  209. package/dist/esm/models/components/index.js +7 -1
  210. package/dist/esm/models/components/index.js.map +1 -1
  211. package/dist/esm/models/components/manualfeedbackinfo.d.ts +2 -0
  212. package/dist/esm/models/components/manualfeedbackinfo.d.ts.map +1 -1
  213. package/dist/esm/models/components/manualfeedbackinfo.js.map +1 -1
  214. package/dist/esm/models/components/objectdefinition.d.ts +3 -0
  215. package/dist/esm/models/components/objectdefinition.d.ts.map +1 -1
  216. package/dist/esm/models/components/objectdefinition.js +1 -0
  217. package/dist/esm/models/components/objectdefinition.js.map +1 -1
  218. package/dist/esm/models/components/searchrequestoptions.d.ts +1 -1
  219. package/dist/esm/models/components/searchresultsnippet.d.ts +7 -5
  220. package/dist/esm/models/components/searchresultsnippet.d.ts.map +1 -1
  221. package/dist/esm/models/components/searchresultsnippet.js +2 -2
  222. package/dist/esm/models/components/searchresultsnippet.js.map +1 -1
  223. package/dist/esm/models/components/sectiontype.d.ts +37 -0
  224. package/dist/esm/models/components/sectiontype.d.ts.map +1 -0
  225. package/dist/esm/models/components/sectiontype.js +29 -0
  226. package/dist/esm/models/components/sectiontype.js.map +1 -0
  227. package/dist/esm/models/components/toolsets.d.ts +40 -0
  228. package/dist/esm/models/components/toolsets.d.ts.map +1 -0
  229. package/dist/esm/models/components/toolsets.js +33 -0
  230. package/dist/esm/models/components/toolsets.js.map +1 -0
  231. package/dist/esm/models/components/updatetype.d.ts +34 -0
  232. package/dist/esm/models/components/updatetype.d.ts.map +1 -0
  233. package/dist/esm/models/components/updatetype.js +28 -0
  234. package/dist/esm/models/components/updatetype.js.map +1 -0
  235. package/dist/esm/models/operations/createcollection.d.ts +83 -0
  236. package/dist/esm/models/operations/createcollection.d.ts.map +1 -0
  237. package/dist/esm/models/operations/createcollection.js +88 -0
  238. package/dist/esm/models/operations/createcollection.js.map +1 -0
  239. package/dist/esm/models/operations/index.d.ts +1 -0
  240. package/dist/esm/models/operations/index.d.ts.map +1 -1
  241. package/dist/esm/models/operations/index.js +1 -0
  242. package/dist/esm/models/operations/index.js.map +1 -1
  243. package/dist/esm/react-query/clientCollectionsCreate.d.ts +2 -1
  244. package/dist/esm/react-query/clientCollectionsCreate.d.ts.map +1 -1
  245. package/dist/esm/react-query/clientCollectionsCreate.js.map +1 -1
  246. package/dist/esm/sdk/collections.d.ts +2 -1
  247. package/dist/esm/sdk/collections.d.ts.map +1 -1
  248. package/dist/esm/sdk/collections.js.map +1 -1
  249. package/docs/sdks/announcements/README.md +70 -70
  250. package/docs/sdks/answers/README.md +8 -8
  251. package/docs/sdks/clientdocuments/README.md +22 -6
  252. package/docs/sdks/clientshortcuts/README.md +14 -14
  253. package/docs/sdks/collections/README.md +11 -11
  254. package/jsr.json +1 -1
  255. package/package.json +1 -1
  256. package/src/__tests__/announcements.test.ts +2 -2
  257. package/src/__tests__/answers.test.ts +2 -2
  258. package/src/__tests__/clientchat.test.ts +24 -24
  259. package/src/__tests__/clientshortcuts.test.ts +2 -2
  260. package/src/__tests__/collections.test.ts +2 -2
  261. package/src/__tests__/search.test.ts +1 -1
  262. package/src/__tests__/summarize.test.ts +8 -2
  263. package/src/funcs/clientCollectionsCreate.ts +5 -4
  264. package/src/lib/config.ts +2 -2
  265. package/src/models/components/agentconfig.ts +15 -0
  266. package/src/models/components/chat.ts +23 -0
  267. package/src/models/components/chatmessage.ts +3 -2
  268. package/src/models/components/chatmessagefragment.ts +1 -1
  269. package/src/models/components/chatsuggestion.ts +72 -0
  270. package/src/models/components/clustertypeenum.ts +2 -0
  271. package/src/models/components/customdatasourceconfig.ts +1 -0
  272. package/src/models/components/digest.ts +89 -0
  273. package/src/models/components/digestsection.ts +118 -0
  274. package/src/models/components/digestupdate.ts +98 -0
  275. package/src/models/components/documentspecunion.ts +147 -32
  276. package/src/models/components/feedentry.ts +22 -0
  277. package/src/models/components/feedrequest.ts +2 -0
  278. package/src/models/components/feedresult.ts +2 -0
  279. package/src/models/components/getchatfilesrequest.ts +7 -0
  280. package/src/models/components/group.ts +14 -0
  281. package/src/models/components/index.ts +7 -1
  282. package/src/models/components/manualfeedbackinfo.ts +2 -0
  283. package/src/models/components/objectdefinition.ts +1 -0
  284. package/src/models/components/searchrequestoptions.ts +1 -1
  285. package/src/models/components/searchresultsnippet.ts +9 -7
  286. package/src/models/components/sectiontype.ts +38 -0
  287. package/src/models/components/toolsets.ts +75 -0
  288. package/src/models/components/updatetype.ts +37 -0
  289. package/src/models/operations/createcollection.ts +186 -0
  290. package/src/models/operations/index.ts +1 -0
  291. package/src/react-query/clientCollectionsCreate.ts +2 -1
  292. package/src/sdk/collections.ts +2 -1
  293. package/dist/commonjs/models/components/createcollectionresponse.d.ts +0 -177
  294. package/dist/commonjs/models/components/createcollectionresponse.d.ts.map +0 -1
  295. package/dist/commonjs/models/components/createcollectionresponse.js +0 -154
  296. package/dist/commonjs/models/components/createcollectionresponse.js.map +0 -1
  297. package/dist/esm/models/components/createcollectionresponse.d.ts +0 -177
  298. package/dist/esm/models/components/createcollectionresponse.d.ts.map +0 -1
  299. package/dist/esm/models/components/createcollectionresponse.js +0 -116
  300. package/dist/esm/models/components/createcollectionresponse.js.map +0 -1
  301. package/src/models/components/createcollectionresponse.ts +0 -306
@@ -1,306 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod";
6
- import { safeParse } from "../../lib/schemas.js";
7
- import { ClosedEnum } from "../../types/enums.js";
8
- import { Result as SafeParseResult } from "../../types/fp.js";
9
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
- import {
11
- Collection,
12
- Collection$inboundSchema,
13
- Collection$Outbound,
14
- Collection$outboundSchema,
15
- } from "./collection.js";
16
- import {
17
- CollectionError,
18
- CollectionError$inboundSchema,
19
- CollectionError$Outbound,
20
- CollectionError$outboundSchema,
21
- } from "./collectionerror.js";
22
- import {
23
- CollectionItem,
24
- CollectionItem$inboundSchema,
25
- CollectionItem$Outbound,
26
- CollectionItem$outboundSchema,
27
- } from "./collectionitem.js";
28
- import {
29
- CollectionPinnedMetadata,
30
- CollectionPinnedMetadata$inboundSchema,
31
- CollectionPinnedMetadata$Outbound,
32
- CollectionPinnedMetadata$outboundSchema,
33
- } from "./collectionpinnedmetadata.js";
34
- import {
35
- FacetFilter,
36
- FacetFilter$inboundSchema,
37
- FacetFilter$Outbound,
38
- FacetFilter$outboundSchema,
39
- } from "./facetfilter.js";
40
- import {
41
- ObjectPermissions,
42
- ObjectPermissions$inboundSchema,
43
- ObjectPermissions$Outbound,
44
- ObjectPermissions$outboundSchema,
45
- } from "./objectpermissions.js";
46
- import {
47
- Person,
48
- Person$inboundSchema,
49
- Person$Outbound,
50
- Person$outboundSchema,
51
- } from "./person.js";
52
- import {
53
- Thumbnail,
54
- Thumbnail$inboundSchema,
55
- Thumbnail$Outbound,
56
- Thumbnail$outboundSchema,
57
- } from "./thumbnail.js";
58
- import {
59
- UserRoleSpecification,
60
- UserRoleSpecification$inboundSchema,
61
- UserRoleSpecification$Outbound,
62
- UserRoleSpecification$outboundSchema,
63
- } from "./userrolespecification.js";
64
-
65
- export const CreateCollectionResponseErrorCode = {
66
- NameExists: "NAME_EXISTS",
67
- NotFound: "NOT_FOUND",
68
- CollectionPinned: "COLLECTION_PINNED",
69
- ConcurrentHierarchyEdit: "CONCURRENT_HIERARCHY_EDIT",
70
- HeightViolation: "HEIGHT_VIOLATION",
71
- WidthViolation: "WIDTH_VIOLATION",
72
- NoPermissions: "NO_PERMISSIONS",
73
- } as const;
74
- export type CreateCollectionResponseErrorCode = ClosedEnum<
75
- typeof CreateCollectionResponseErrorCode
76
- >;
77
-
78
- export type CreateCollectionResponse = {
79
- /**
80
- * The unique name of the Collection.
81
- */
82
- name: string;
83
- /**
84
- * A brief summary of the Collection's contents.
85
- */
86
- description: string;
87
- /**
88
- * A list of added user roles for the Collection.
89
- */
90
- addedRoles?: Array<UserRoleSpecification> | undefined;
91
- /**
92
- * A list of removed user roles for the Collection.
93
- */
94
- removedRoles?: Array<UserRoleSpecification> | undefined;
95
- /**
96
- * Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
97
- */
98
- audienceFilters?: Array<FacetFilter> | undefined;
99
- /**
100
- * The emoji icon of this Collection.
101
- */
102
- icon?: string | undefined;
103
- /**
104
- * Indicates whether edits are allowed for everyone or only admins.
105
- */
106
- adminLocked?: boolean | undefined;
107
- /**
108
- * The parent of this Collection, or 0 if it's a top-level Collection.
109
- */
110
- parentId?: number | undefined;
111
- thumbnail?: Thumbnail | undefined;
112
- /**
113
- * The datasource type this Collection can hold.
114
- */
115
- allowedDatasource?: string | undefined;
116
- permissions?: ObjectPermissions | undefined;
117
- /**
118
- * The unique ID of the Collection.
119
- */
120
- id: number;
121
- createTime?: Date | undefined;
122
- updateTime?: Date | undefined;
123
- creator?: Person | undefined;
124
- updatedBy?: Person | undefined;
125
- /**
126
- * The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
127
- */
128
- itemCount?: number | undefined;
129
- /**
130
- * The number of children Collections. Separated from the actual children so we can grab the count without children.
131
- */
132
- childCount?: number | undefined;
133
- /**
134
- * The items in this Collection.
135
- */
136
- items?: Array<CollectionItem> | undefined;
137
- pinMetadata?: CollectionPinnedMetadata | undefined;
138
- /**
139
- * The names of the shortcuts (Go Links) that point to this Collection.
140
- */
141
- shortcuts?: Array<string> | undefined;
142
- /**
143
- * The children Collections of this Collection.
144
- */
145
- children?: Array<Collection> | undefined;
146
- /**
147
- * A list of user roles for the Collection.
148
- */
149
- roles?: Array<UserRoleSpecification> | undefined;
150
- errorCode: CreateCollectionResponseErrorCode;
151
- collection?: Collection | undefined;
152
- error?: CollectionError | undefined;
153
- };
154
-
155
- /** @internal */
156
- export const CreateCollectionResponseErrorCode$inboundSchema: z.ZodNativeEnum<
157
- typeof CreateCollectionResponseErrorCode
158
- > = z.nativeEnum(CreateCollectionResponseErrorCode);
159
-
160
- /** @internal */
161
- export const CreateCollectionResponseErrorCode$outboundSchema: z.ZodNativeEnum<
162
- typeof CreateCollectionResponseErrorCode
163
- > = CreateCollectionResponseErrorCode$inboundSchema;
164
-
165
- /**
166
- * @internal
167
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
168
- */
169
- export namespace CreateCollectionResponseErrorCode$ {
170
- /** @deprecated use `CreateCollectionResponseErrorCode$inboundSchema` instead. */
171
- export const inboundSchema = CreateCollectionResponseErrorCode$inboundSchema;
172
- /** @deprecated use `CreateCollectionResponseErrorCode$outboundSchema` instead. */
173
- export const outboundSchema =
174
- CreateCollectionResponseErrorCode$outboundSchema;
175
- }
176
-
177
- /** @internal */
178
- export const CreateCollectionResponse$inboundSchema: z.ZodType<
179
- CreateCollectionResponse,
180
- z.ZodTypeDef,
181
- unknown
182
- > = z.object({
183
- name: z.string(),
184
- description: z.string(),
185
- addedRoles: z.array(UserRoleSpecification$inboundSchema).optional(),
186
- removedRoles: z.array(UserRoleSpecification$inboundSchema).optional(),
187
- audienceFilters: z.array(FacetFilter$inboundSchema).optional(),
188
- icon: z.string().optional(),
189
- adminLocked: z.boolean().optional(),
190
- parentId: z.number().int().optional(),
191
- thumbnail: Thumbnail$inboundSchema.optional(),
192
- allowedDatasource: z.string().optional(),
193
- permissions: ObjectPermissions$inboundSchema.optional(),
194
- id: z.number().int(),
195
- createTime: z.string().datetime({ offset: true }).transform(v => new Date(v))
196
- .optional(),
197
- updateTime: z.string().datetime({ offset: true }).transform(v => new Date(v))
198
- .optional(),
199
- creator: Person$inboundSchema.optional(),
200
- updatedBy: Person$inboundSchema.optional(),
201
- itemCount: z.number().int().optional(),
202
- childCount: z.number().int().optional(),
203
- items: z.array(CollectionItem$inboundSchema).optional(),
204
- pinMetadata: CollectionPinnedMetadata$inboundSchema.optional(),
205
- shortcuts: z.array(z.string()).optional(),
206
- children: z.array(Collection$inboundSchema).optional(),
207
- roles: z.array(UserRoleSpecification$inboundSchema).optional(),
208
- errorCode: CreateCollectionResponseErrorCode$inboundSchema,
209
- collection: Collection$inboundSchema.optional(),
210
- error: CollectionError$inboundSchema.optional(),
211
- });
212
-
213
- /** @internal */
214
- export type CreateCollectionResponse$Outbound = {
215
- name: string;
216
- description: string;
217
- addedRoles?: Array<UserRoleSpecification$Outbound> | undefined;
218
- removedRoles?: Array<UserRoleSpecification$Outbound> | undefined;
219
- audienceFilters?: Array<FacetFilter$Outbound> | undefined;
220
- icon?: string | undefined;
221
- adminLocked?: boolean | undefined;
222
- parentId?: number | undefined;
223
- thumbnail?: Thumbnail$Outbound | undefined;
224
- allowedDatasource?: string | undefined;
225
- permissions?: ObjectPermissions$Outbound | undefined;
226
- id: number;
227
- createTime?: string | undefined;
228
- updateTime?: string | undefined;
229
- creator?: Person$Outbound | undefined;
230
- updatedBy?: Person$Outbound | undefined;
231
- itemCount?: number | undefined;
232
- childCount?: number | undefined;
233
- items?: Array<CollectionItem$Outbound> | undefined;
234
- pinMetadata?: CollectionPinnedMetadata$Outbound | undefined;
235
- shortcuts?: Array<string> | undefined;
236
- children?: Array<Collection$Outbound> | undefined;
237
- roles?: Array<UserRoleSpecification$Outbound> | undefined;
238
- errorCode: string;
239
- collection?: Collection$Outbound | undefined;
240
- error?: CollectionError$Outbound | undefined;
241
- };
242
-
243
- /** @internal */
244
- export const CreateCollectionResponse$outboundSchema: z.ZodType<
245
- CreateCollectionResponse$Outbound,
246
- z.ZodTypeDef,
247
- CreateCollectionResponse
248
- > = z.object({
249
- name: z.string(),
250
- description: z.string(),
251
- addedRoles: z.array(UserRoleSpecification$outboundSchema).optional(),
252
- removedRoles: z.array(UserRoleSpecification$outboundSchema).optional(),
253
- audienceFilters: z.array(FacetFilter$outboundSchema).optional(),
254
- icon: z.string().optional(),
255
- adminLocked: z.boolean().optional(),
256
- parentId: z.number().int().optional(),
257
- thumbnail: Thumbnail$outboundSchema.optional(),
258
- allowedDatasource: z.string().optional(),
259
- permissions: ObjectPermissions$outboundSchema.optional(),
260
- id: z.number().int(),
261
- createTime: z.date().transform(v => v.toISOString()).optional(),
262
- updateTime: z.date().transform(v => v.toISOString()).optional(),
263
- creator: Person$outboundSchema.optional(),
264
- updatedBy: Person$outboundSchema.optional(),
265
- itemCount: z.number().int().optional(),
266
- childCount: z.number().int().optional(),
267
- items: z.array(CollectionItem$outboundSchema).optional(),
268
- pinMetadata: CollectionPinnedMetadata$outboundSchema.optional(),
269
- shortcuts: z.array(z.string()).optional(),
270
- children: z.array(Collection$outboundSchema).optional(),
271
- roles: z.array(UserRoleSpecification$outboundSchema).optional(),
272
- errorCode: CreateCollectionResponseErrorCode$outboundSchema,
273
- collection: Collection$outboundSchema.optional(),
274
- error: CollectionError$outboundSchema.optional(),
275
- });
276
-
277
- /**
278
- * @internal
279
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
280
- */
281
- export namespace CreateCollectionResponse$ {
282
- /** @deprecated use `CreateCollectionResponse$inboundSchema` instead. */
283
- export const inboundSchema = CreateCollectionResponse$inboundSchema;
284
- /** @deprecated use `CreateCollectionResponse$outboundSchema` instead. */
285
- export const outboundSchema = CreateCollectionResponse$outboundSchema;
286
- /** @deprecated use `CreateCollectionResponse$Outbound` instead. */
287
- export type Outbound = CreateCollectionResponse$Outbound;
288
- }
289
-
290
- export function createCollectionResponseToJSON(
291
- createCollectionResponse: CreateCollectionResponse,
292
- ): string {
293
- return JSON.stringify(
294
- CreateCollectionResponse$outboundSchema.parse(createCollectionResponse),
295
- );
296
- }
297
-
298
- export function createCollectionResponseFromJSON(
299
- jsonString: string,
300
- ): SafeParseResult<CreateCollectionResponse, SDKValidationError> {
301
- return safeParse(
302
- jsonString,
303
- (x) => CreateCollectionResponse$inboundSchema.parse(JSON.parse(x)),
304
- `Failed to parse 'CreateCollectionResponse' from JSON`,
305
- );
306
- }