@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
@@ -11,26 +11,57 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
11
  /**
12
12
  * The type of the user generated content (UGC datasource).
13
13
  */
14
- export const DocumentSpecUgcType = {
14
+ export const DocumentSpecUgcType2 = {
15
15
  Announcements: "ANNOUNCEMENTS",
16
16
  Answers: "ANSWERS",
17
17
  Collections: "COLLECTIONS",
18
18
  Shortcuts: "SHORTCUTS",
19
+ Chats: "CHATS",
19
20
  } as const;
20
21
  /**
21
22
  * The type of the user generated content (UGC datasource).
22
23
  */
23
- export type DocumentSpecUgcType = ClosedEnum<typeof DocumentSpecUgcType>;
24
+ export type DocumentSpecUgcType2 = ClosedEnum<typeof DocumentSpecUgcType2>;
25
+
26
+ export type DocumentSpec4 = {
27
+ /**
28
+ * The type of the user generated content (UGC datasource).
29
+ */
30
+ ugcType: DocumentSpecUgcType2;
31
+ /**
32
+ * The string id for user generated content. Used for CHATS.
33
+ */
34
+ ugcId: string;
35
+ /**
36
+ * The specific type of the user generated content type.
37
+ */
38
+ docType?: string | undefined;
39
+ };
40
+
41
+ /**
42
+ * The type of the user generated content (UGC datasource).
43
+ */
44
+ export const DocumentSpecUgcType1 = {
45
+ Announcements: "ANNOUNCEMENTS",
46
+ Answers: "ANSWERS",
47
+ Collections: "COLLECTIONS",
48
+ Shortcuts: "SHORTCUTS",
49
+ Chats: "CHATS",
50
+ } as const;
51
+ /**
52
+ * The type of the user generated content (UGC datasource).
53
+ */
54
+ export type DocumentSpecUgcType1 = ClosedEnum<typeof DocumentSpecUgcType1>;
24
55
 
25
56
  export type DocumentSpec3 = {
26
57
  /**
27
58
  * The type of the user generated content (UGC datasource).
28
59
  */
29
- ugcType?: DocumentSpecUgcType | undefined;
60
+ ugcType: DocumentSpecUgcType1;
30
61
  /**
31
- * The id for user generated content.
62
+ * The numeric id for user generated content. Used for ANNOUNCEMENTS, ANSWERS, COLLECTIONS, SHORTCUTS.
32
63
  */
33
- contentId?: number | undefined;
64
+ contentId: number;
34
65
  /**
35
66
  * The specific type of the user generated content type.
36
67
  */
@@ -41,37 +72,118 @@ export type DocumentSpec2 = {
41
72
  /**
42
73
  * The ID of the document.
43
74
  */
44
- id?: string | undefined;
75
+ id: string;
45
76
  };
46
77
 
47
78
  export type DocumentSpec1 = {
48
79
  /**
49
80
  * The URL of the document.
50
81
  */
51
- url?: string | undefined;
82
+ url: string;
83
+ };
84
+
85
+ export type DocumentSpecUnion =
86
+ | DocumentSpec1
87
+ | DocumentSpec2
88
+ | DocumentSpec3
89
+ | DocumentSpec4;
90
+
91
+ /** @internal */
92
+ export const DocumentSpecUgcType2$inboundSchema: z.ZodNativeEnum<
93
+ typeof DocumentSpecUgcType2
94
+ > = z.nativeEnum(DocumentSpecUgcType2);
95
+
96
+ /** @internal */
97
+ export const DocumentSpecUgcType2$outboundSchema: z.ZodNativeEnum<
98
+ typeof DocumentSpecUgcType2
99
+ > = DocumentSpecUgcType2$inboundSchema;
100
+
101
+ /**
102
+ * @internal
103
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
104
+ */
105
+ export namespace DocumentSpecUgcType2$ {
106
+ /** @deprecated use `DocumentSpecUgcType2$inboundSchema` instead. */
107
+ export const inboundSchema = DocumentSpecUgcType2$inboundSchema;
108
+ /** @deprecated use `DocumentSpecUgcType2$outboundSchema` instead. */
109
+ export const outboundSchema = DocumentSpecUgcType2$outboundSchema;
110
+ }
111
+
112
+ /** @internal */
113
+ export const DocumentSpec4$inboundSchema: z.ZodType<
114
+ DocumentSpec4,
115
+ z.ZodTypeDef,
116
+ unknown
117
+ > = z.object({
118
+ ugcType: DocumentSpecUgcType2$inboundSchema,
119
+ ugcId: z.string(),
120
+ docType: z.string().optional(),
121
+ });
122
+
123
+ /** @internal */
124
+ export type DocumentSpec4$Outbound = {
125
+ ugcType: string;
126
+ ugcId: string;
127
+ docType?: string | undefined;
52
128
  };
53
129
 
54
- export type DocumentSpecUnion = DocumentSpec1 | DocumentSpec2 | DocumentSpec3;
130
+ /** @internal */
131
+ export const DocumentSpec4$outboundSchema: z.ZodType<
132
+ DocumentSpec4$Outbound,
133
+ z.ZodTypeDef,
134
+ DocumentSpec4
135
+ > = z.object({
136
+ ugcType: DocumentSpecUgcType2$outboundSchema,
137
+ ugcId: z.string(),
138
+ docType: z.string().optional(),
139
+ });
140
+
141
+ /**
142
+ * @internal
143
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
144
+ */
145
+ export namespace DocumentSpec4$ {
146
+ /** @deprecated use `DocumentSpec4$inboundSchema` instead. */
147
+ export const inboundSchema = DocumentSpec4$inboundSchema;
148
+ /** @deprecated use `DocumentSpec4$outboundSchema` instead. */
149
+ export const outboundSchema = DocumentSpec4$outboundSchema;
150
+ /** @deprecated use `DocumentSpec4$Outbound` instead. */
151
+ export type Outbound = DocumentSpec4$Outbound;
152
+ }
153
+
154
+ export function documentSpec4ToJSON(documentSpec4: DocumentSpec4): string {
155
+ return JSON.stringify(DocumentSpec4$outboundSchema.parse(documentSpec4));
156
+ }
157
+
158
+ export function documentSpec4FromJSON(
159
+ jsonString: string,
160
+ ): SafeParseResult<DocumentSpec4, SDKValidationError> {
161
+ return safeParse(
162
+ jsonString,
163
+ (x) => DocumentSpec4$inboundSchema.parse(JSON.parse(x)),
164
+ `Failed to parse 'DocumentSpec4' from JSON`,
165
+ );
166
+ }
55
167
 
56
168
  /** @internal */
57
- export const DocumentSpecUgcType$inboundSchema: z.ZodNativeEnum<
58
- typeof DocumentSpecUgcType
59
- > = z.nativeEnum(DocumentSpecUgcType);
169
+ export const DocumentSpecUgcType1$inboundSchema: z.ZodNativeEnum<
170
+ typeof DocumentSpecUgcType1
171
+ > = z.nativeEnum(DocumentSpecUgcType1);
60
172
 
61
173
  /** @internal */
62
- export const DocumentSpecUgcType$outboundSchema: z.ZodNativeEnum<
63
- typeof DocumentSpecUgcType
64
- > = DocumentSpecUgcType$inboundSchema;
174
+ export const DocumentSpecUgcType1$outboundSchema: z.ZodNativeEnum<
175
+ typeof DocumentSpecUgcType1
176
+ > = DocumentSpecUgcType1$inboundSchema;
65
177
 
66
178
  /**
67
179
  * @internal
68
180
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
69
181
  */
70
- export namespace DocumentSpecUgcType$ {
71
- /** @deprecated use `DocumentSpecUgcType$inboundSchema` instead. */
72
- export const inboundSchema = DocumentSpecUgcType$inboundSchema;
73
- /** @deprecated use `DocumentSpecUgcType$outboundSchema` instead. */
74
- export const outboundSchema = DocumentSpecUgcType$outboundSchema;
182
+ export namespace DocumentSpecUgcType1$ {
183
+ /** @deprecated use `DocumentSpecUgcType1$inboundSchema` instead. */
184
+ export const inboundSchema = DocumentSpecUgcType1$inboundSchema;
185
+ /** @deprecated use `DocumentSpecUgcType1$outboundSchema` instead. */
186
+ export const outboundSchema = DocumentSpecUgcType1$outboundSchema;
75
187
  }
76
188
 
77
189
  /** @internal */
@@ -80,15 +192,15 @@ export const DocumentSpec3$inboundSchema: z.ZodType<
80
192
  z.ZodTypeDef,
81
193
  unknown
82
194
  > = z.object({
83
- ugcType: DocumentSpecUgcType$inboundSchema.optional(),
84
- contentId: z.number().int().optional(),
195
+ ugcType: DocumentSpecUgcType1$inboundSchema,
196
+ contentId: z.number().int(),
85
197
  docType: z.string().optional(),
86
198
  });
87
199
 
88
200
  /** @internal */
89
201
  export type DocumentSpec3$Outbound = {
90
- ugcType?: string | undefined;
91
- contentId?: number | undefined;
202
+ ugcType: string;
203
+ contentId: number;
92
204
  docType?: string | undefined;
93
205
  };
94
206
 
@@ -98,8 +210,8 @@ export const DocumentSpec3$outboundSchema: z.ZodType<
98
210
  z.ZodTypeDef,
99
211
  DocumentSpec3
100
212
  > = z.object({
101
- ugcType: DocumentSpecUgcType$outboundSchema.optional(),
102
- contentId: z.number().int().optional(),
213
+ ugcType: DocumentSpecUgcType1$outboundSchema,
214
+ contentId: z.number().int(),
103
215
  docType: z.string().optional(),
104
216
  });
105
217
 
@@ -136,12 +248,12 @@ export const DocumentSpec2$inboundSchema: z.ZodType<
136
248
  z.ZodTypeDef,
137
249
  unknown
138
250
  > = z.object({
139
- id: z.string().optional(),
251
+ id: z.string(),
140
252
  });
141
253
 
142
254
  /** @internal */
143
255
  export type DocumentSpec2$Outbound = {
144
- id?: string | undefined;
256
+ id: string;
145
257
  };
146
258
 
147
259
  /** @internal */
@@ -150,7 +262,7 @@ export const DocumentSpec2$outboundSchema: z.ZodType<
150
262
  z.ZodTypeDef,
151
263
  DocumentSpec2
152
264
  > = z.object({
153
- id: z.string().optional(),
265
+ id: z.string(),
154
266
  });
155
267
 
156
268
  /**
@@ -186,12 +298,12 @@ export const DocumentSpec1$inboundSchema: z.ZodType<
186
298
  z.ZodTypeDef,
187
299
  unknown
188
300
  > = z.object({
189
- url: z.string().optional(),
301
+ url: z.string(),
190
302
  });
191
303
 
192
304
  /** @internal */
193
305
  export type DocumentSpec1$Outbound = {
194
- url?: string | undefined;
306
+ url: string;
195
307
  };
196
308
 
197
309
  /** @internal */
@@ -200,7 +312,7 @@ export const DocumentSpec1$outboundSchema: z.ZodType<
200
312
  z.ZodTypeDef,
201
313
  DocumentSpec1
202
314
  > = z.object({
203
- url: z.string().optional(),
315
+ url: z.string(),
204
316
  });
205
317
 
206
318
  /**
@@ -239,13 +351,15 @@ export const DocumentSpecUnion$inboundSchema: z.ZodType<
239
351
  z.lazy(() => DocumentSpec1$inboundSchema),
240
352
  z.lazy(() => DocumentSpec2$inboundSchema),
241
353
  z.lazy(() => DocumentSpec3$inboundSchema),
354
+ z.lazy(() => DocumentSpec4$inboundSchema),
242
355
  ]);
243
356
 
244
357
  /** @internal */
245
358
  export type DocumentSpecUnion$Outbound =
246
359
  | DocumentSpec1$Outbound
247
360
  | DocumentSpec2$Outbound
248
- | DocumentSpec3$Outbound;
361
+ | DocumentSpec3$Outbound
362
+ | DocumentSpec4$Outbound;
249
363
 
250
364
  /** @internal */
251
365
  export const DocumentSpecUnion$outboundSchema: z.ZodType<
@@ -256,6 +370,7 @@ export const DocumentSpecUnion$outboundSchema: z.ZodType<
256
370
  z.lazy(() => DocumentSpec1$outboundSchema),
257
371
  z.lazy(() => DocumentSpec2$outboundSchema),
258
372
  z.lazy(() => DocumentSpec3$outboundSchema),
373
+ z.lazy(() => DocumentSpec4$outboundSchema),
259
374
  ]);
260
375
 
261
376
  /**
@@ -25,6 +25,12 @@ import {
25
25
  CalendarEvent$Outbound,
26
26
  CalendarEvent$outboundSchema,
27
27
  } from "./calendarevent.js";
28
+ import {
29
+ ChatSuggestion,
30
+ ChatSuggestion$inboundSchema,
31
+ ChatSuggestion$Outbound,
32
+ ChatSuggestion$outboundSchema,
33
+ } from "./chatsuggestion.js";
28
34
  import {
29
35
  Collection,
30
36
  Collection$inboundSchema,
@@ -43,6 +49,12 @@ import {
43
49
  CountInfo$Outbound,
44
50
  CountInfo$outboundSchema,
45
51
  } from "./countinfo.js";
52
+ import {
53
+ Digest,
54
+ Digest$inboundSchema,
55
+ Digest$Outbound,
56
+ Digest$outboundSchema,
57
+ } from "./digest.js";
46
58
  import {
47
59
  DisplayableListItemUIConfig,
48
60
  DisplayableListItemUIConfig$inboundSchema,
@@ -144,6 +156,8 @@ export const JustificationType = {
144
156
  ZeroStatePromptTemplateSuggestion: "ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION",
145
157
  ZeroStateStaticWorkflowSuggestion: "ZERO_STATE_STATIC_WORKFLOW_SUGGESTION",
146
158
  ZeroStateAgentSuggestion: "ZERO_STATE_AGENT_SUGGESTION",
159
+ PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION",
160
+ DailyDigest: "DAILY_DIGEST",
147
161
  } as const;
148
162
  /**
149
163
  * Type of the justification.
@@ -181,10 +195,12 @@ export type FeedEntry = {
181
195
  document?: Document | undefined;
182
196
  event?: CalendarEvent | undefined;
183
197
  announcement?: Announcement | undefined;
198
+ digest?: Digest | undefined;
184
199
  collection?: Collection | undefined;
185
200
  collectionItem?: CollectionItem | undefined;
186
201
  person?: Person | undefined;
187
202
  app?: AppResult | undefined;
203
+ chatSuggestion?: ChatSuggestion | undefined;
188
204
  promptTemplate?: PromptTemplateResult | undefined;
189
205
  workflow?: WorkflowResult | undefined;
190
206
  /**
@@ -305,10 +321,12 @@ export const FeedEntry$inboundSchema: z.ZodType<
305
321
  document: Document$inboundSchema.optional(),
306
322
  event: CalendarEvent$inboundSchema.optional(),
307
323
  announcement: Announcement$inboundSchema.optional(),
324
+ digest: Digest$inboundSchema.optional(),
308
325
  collection: Collection$inboundSchema.optional(),
309
326
  collectionItem: CollectionItem$inboundSchema.optional(),
310
327
  person: Person$inboundSchema.optional(),
311
328
  app: AppResult$inboundSchema.optional(),
329
+ chatSuggestion: ChatSuggestion$inboundSchema.optional(),
312
330
  promptTemplate: PromptTemplateResult$inboundSchema.optional(),
313
331
  workflow: WorkflowResult$inboundSchema.optional(),
314
332
  activities: z.array(UserActivity$inboundSchema).optional(),
@@ -329,10 +347,12 @@ export type FeedEntry$Outbound = {
329
347
  document?: Document$Outbound | undefined;
330
348
  event?: CalendarEvent$Outbound | undefined;
331
349
  announcement?: Announcement$Outbound | undefined;
350
+ digest?: Digest$Outbound | undefined;
332
351
  collection?: Collection$Outbound | undefined;
333
352
  collectionItem?: CollectionItem$Outbound | undefined;
334
353
  person?: Person$Outbound | undefined;
335
354
  app?: AppResult$Outbound | undefined;
355
+ chatSuggestion?: ChatSuggestion$Outbound | undefined;
336
356
  promptTemplate?: PromptTemplateResult$Outbound | undefined;
337
357
  workflow?: WorkflowResult$Outbound | undefined;
338
358
  activities?: Array<UserActivity$Outbound> | undefined;
@@ -357,10 +377,12 @@ export const FeedEntry$outboundSchema: z.ZodType<
357
377
  document: Document$outboundSchema.optional(),
358
378
  event: CalendarEvent$outboundSchema.optional(),
359
379
  announcement: Announcement$outboundSchema.optional(),
380
+ digest: Digest$outboundSchema.optional(),
360
381
  collection: Collection$outboundSchema.optional(),
361
382
  collectionItem: CollectionItem$outboundSchema.optional(),
362
383
  person: Person$outboundSchema.optional(),
363
384
  app: AppResult$outboundSchema.optional(),
385
+ chatSuggestion: ChatSuggestion$outboundSchema.optional(),
364
386
  promptTemplate: PromptTemplateResult$outboundSchema.optional(),
365
387
  workflow: WorkflowResult$outboundSchema.optional(),
366
388
  activities: z.array(UserActivity$outboundSchema).optional(),
@@ -43,6 +43,8 @@ export const FeedRequestCategory = {
43
43
  ZeroStateWorkflowFavorites: "ZERO_STATE_WORKFLOW_FAVORITES",
44
44
  ZeroStateWorkflowPopular: "ZERO_STATE_WORKFLOW_POPULAR",
45
45
  ZeroStateWorkflowSuggestion: "ZERO_STATE_WORKFLOW_SUGGESTION",
46
+ PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION",
47
+ DailyDigest: "DAILY_DIGEST",
46
48
  } as const;
47
49
  export type FeedRequestCategory = ClosedEnum<typeof FeedRequestCategory>;
48
50
 
@@ -40,6 +40,8 @@ export const FeedResultCategory = {
40
40
  ZeroStateWorkflowFavorites: "ZERO_STATE_WORKFLOW_FAVORITES",
41
41
  ZeroStateWorkflowPopular: "ZERO_STATE_WORKFLOW_POPULAR",
42
42
  ZeroStateWorkflowSuggestion: "ZERO_STATE_WORKFLOW_SUGGESTION",
43
+ PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION",
44
+ DailyDigest: "DAILY_DIGEST",
43
45
  } as const;
44
46
  /**
45
47
  * Category of the result, one of the requested categories in incoming request.
@@ -12,6 +12,10 @@ export type GetChatFilesRequest = {
12
12
  * IDs of files to fetch.
13
13
  */
14
14
  fileIds: Array<string>;
15
+ /**
16
+ * The ID of the chat that contains the chat file.
17
+ */
18
+ chatId?: string | undefined;
15
19
  };
16
20
 
17
21
  /** @internal */
@@ -21,11 +25,13 @@ export const GetChatFilesRequest$inboundSchema: z.ZodType<
21
25
  unknown
22
26
  > = z.object({
23
27
  fileIds: z.array(z.string()),
28
+ chatId: z.string().optional(),
24
29
  });
25
30
 
26
31
  /** @internal */
27
32
  export type GetChatFilesRequest$Outbound = {
28
33
  fileIds: Array<string>;
34
+ chatId?: string | undefined;
29
35
  };
30
36
 
31
37
  /** @internal */
@@ -35,6 +41,7 @@ export const GetChatFilesRequest$outboundSchema: z.ZodType<
35
41
  GetChatFilesRequest
36
42
  > = z.object({
37
43
  fileIds: z.array(z.string()),
44
+ chatId: z.string().optional(),
38
45
  });
39
46
 
40
47
  /**
@@ -25,6 +25,14 @@ export type Group = {
25
25
  * Name of the group.
26
26
  */
27
27
  name?: string | undefined;
28
+ /**
29
+ * Datasource instance if the group belongs to one e.g. external groups.
30
+ */
31
+ datasourceInstance?: string | undefined;
32
+ /**
33
+ * identifier for greenlist provisioning, aka sciokey
34
+ */
35
+ provisioningId?: string | undefined;
28
36
  };
29
37
 
30
38
  /** @internal */
@@ -33,6 +41,8 @@ export const Group$inboundSchema: z.ZodType<Group, z.ZodTypeDef, unknown> = z
33
41
  type: GroupType$inboundSchema,
34
42
  id: z.string(),
35
43
  name: z.string().optional(),
44
+ datasourceInstance: z.string().optional(),
45
+ provisioningId: z.string().optional(),
36
46
  });
37
47
 
38
48
  /** @internal */
@@ -40,6 +50,8 @@ export type Group$Outbound = {
40
50
  type: string;
41
51
  id: string;
42
52
  name?: string | undefined;
53
+ datasourceInstance?: string | undefined;
54
+ provisioningId?: string | undefined;
43
55
  };
44
56
 
45
57
  /** @internal */
@@ -51,6 +63,8 @@ export const Group$outboundSchema: z.ZodType<
51
63
  type: GroupType$outboundSchema,
52
64
  id: z.string(),
53
65
  name: z.string().optional(),
66
+ datasourceInstance: z.string().optional(),
67
+ provisioningId: z.string().optional(),
54
68
  });
55
69
 
56
70
  /**
@@ -63,6 +63,7 @@ export * from "./chatrequest.js";
63
63
  export * from "./chatresponse.js";
64
64
  export * from "./chatrestrictionfilters.js";
65
65
  export * from "./chatresult.js";
66
+ export * from "./chatsuggestion.js";
66
67
  export * from "./chatzerostatesuggestionoptions.js";
67
68
  export * from "./checkdocumentaccessrequest.js";
68
69
  export * from "./checkdocumentaccessresponse.js";
@@ -92,7 +93,6 @@ export * from "./createannouncementrequest.js";
92
93
  export * from "./createanswerrequest.js";
93
94
  export * from "./createauthtokenresponse.js";
94
95
  export * from "./createcollectionrequest.js";
95
- export * from "./createcollectionresponse.js";
96
96
  export * from "./createdlpreportrequest.js";
97
97
  export * from "./createdlpreportresponse.js";
98
98
  export * from "./createshortcutrequest.js";
@@ -138,6 +138,9 @@ export * from "./deletemembershiprequest.js";
138
138
  export * from "./deleteshortcutrequest.js";
139
139
  export * from "./deleteteamrequest.js";
140
140
  export * from "./deleteuserrequest.js";
141
+ export * from "./digest.js";
142
+ export * from "./digestsection.js";
143
+ export * from "./digestupdate.js";
141
144
  export * from "./disambiguation.js";
142
145
  export * from "./displayablelistitemuiconfig.js";
143
146
  export * from "./dlpconfig.js";
@@ -332,6 +335,7 @@ export * from "./searchresult.js";
332
335
  export * from "./searchresultprominenceenum.js";
333
336
  export * from "./searchresultsnippet.js";
334
337
  export * from "./searchwarning.js";
338
+ export * from "./sectiontype.js";
335
339
  export * from "./security.js";
336
340
  export * from "./seenfeedbackinfo.js";
337
341
  export * from "./sensitivecontentoptions.js";
@@ -375,6 +379,7 @@ export * from "./toolparameter.js";
375
379
  export * from "./toolscallparameter.js";
376
380
  export * from "./toolscallrequest.js";
377
381
  export * from "./toolscallresponse.js";
382
+ export * from "./toolsets.js";
378
383
  export * from "./toolslistresponse.js";
379
384
  export * from "./ugctype.js";
380
385
  export * from "./unpin.js";
@@ -388,6 +393,7 @@ export * from "./updatedocumentvisibilityoverridesresponse.js";
388
393
  export * from "./updatepermissionsrequest.js";
389
394
  export * from "./updateshortcutrequest.js";
390
395
  export * from "./updateshortcutresponse.js";
396
+ export * from "./updatetype.js";
391
397
  export * from "./uploadchatfilesrequest.js";
392
398
  export * from "./uploadchatfilesresponse.js";
393
399
  export * from "./uploadshortcutsrequest.js";
@@ -75,6 +75,8 @@ export type ManualFeedbackInfoVote = ClosedEnum<typeof ManualFeedbackInfoVote>;
75
75
  export type ManualFeedbackInfo = {
76
76
  /**
77
77
  * The email address of the user who submitted the Feedback.event.MANUAL_FEEDBACK event.
78
+ *
79
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
78
80
  */
79
81
  email?: string | undefined;
80
82
  /**
@@ -41,6 +41,7 @@ export const DocCategory = {
41
41
  ExternalShortcut: "EXTERNAL_SHORTCUT",
42
42
  Entity: "ENTITY",
43
43
  Calendar: "CALENDAR",
44
+ Agents: "AGENTS",
44
45
  } as const;
45
46
  /**
46
47
  * The document category of this object type.
@@ -108,7 +108,7 @@ export type SearchRequestOptions = {
108
108
  */
109
109
  disableQueryAutocorrect?: boolean | undefined;
110
110
  /**
111
- * [beta] Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, https://docs.google.com/document/d/1CTOLSxWWT9WDEnHVLoCUaxbGYyXYP8kctPRF-RluSQY/edit. Requires sufficient permissions.
111
+ * Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content.
112
112
  */
113
113
  returnLlmContentOverSnippets?: boolean | undefined;
114
114
  inclusions?: RestrictionFilters | undefined;
@@ -14,10 +14,6 @@ import {
14
14
  } from "./textrange.js";
15
15
 
16
16
  export type SearchResultSnippet = {
17
- /**
18
- * A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
19
- */
20
- snippet: string;
21
17
  /**
22
18
  * The mime type of the snippets, currently either text/plain or text/html.
23
19
  */
@@ -38,6 +34,12 @@ export type SearchResultSnippet = {
38
34
  * A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
39
35
  */
40
36
  url?: string | undefined;
37
+ /**
38
+ * A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007. Use 'text' field instead.
39
+ *
40
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
41
+ */
42
+ snippet: string;
41
43
  };
42
44
 
43
45
  /** @internal */
@@ -46,22 +48,22 @@ export const SearchResultSnippet$inboundSchema: z.ZodType<
46
48
  z.ZodTypeDef,
47
49
  unknown
48
50
  > = z.object({
49
- snippet: z.string(),
50
51
  mimeType: z.string().optional(),
51
52
  text: z.string().optional(),
52
53
  snippetTextOrdering: z.number().int().optional(),
53
54
  ranges: z.array(z.lazy(() => TextRange$inboundSchema)).optional(),
54
55
  url: z.string().optional(),
56
+ snippet: z.string(),
55
57
  });
56
58
 
57
59
  /** @internal */
58
60
  export type SearchResultSnippet$Outbound = {
59
- snippet: string;
60
61
  mimeType?: string | undefined;
61
62
  text?: string | undefined;
62
63
  snippetTextOrdering?: number | undefined;
63
64
  ranges?: Array<TextRange$Outbound> | undefined;
64
65
  url?: string | undefined;
66
+ snippet: string;
65
67
  };
66
68
 
67
69
  /** @internal */
@@ -70,12 +72,12 @@ export const SearchResultSnippet$outboundSchema: z.ZodType<
70
72
  z.ZodTypeDef,
71
73
  SearchResultSnippet
72
74
  > = z.object({
73
- snippet: z.string(),
74
75
  mimeType: z.string().optional(),
75
76
  text: z.string().optional(),
76
77
  snippetTextOrdering: z.number().int().optional(),
77
78
  ranges: z.array(z.lazy(() => TextRange$outboundSchema)).optional(),
78
79
  url: z.string().optional(),
80
+ snippet: z.string(),
79
81
  });
80
82
 
81
83
  /**
@@ -0,0 +1,38 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { ClosedEnum } from "../../types/enums.js";
7
+
8
+ /**
9
+ * Type of the section. This defines how the section should be interpreted and rendered in the digest.
10
+ */
11
+ export const SectionType = {
12
+ Channel: "CHANNEL",
13
+ Mentions: "MENTIONS",
14
+ Topic: "TOPIC",
15
+ } as const;
16
+ /**
17
+ * Type of the section. This defines how the section should be interpreted and rendered in the digest.
18
+ */
19
+ export type SectionType = ClosedEnum<typeof SectionType>;
20
+
21
+ /** @internal */
22
+ export const SectionType$inboundSchema: z.ZodNativeEnum<typeof SectionType> = z
23
+ .nativeEnum(SectionType);
24
+
25
+ /** @internal */
26
+ export const SectionType$outboundSchema: z.ZodNativeEnum<typeof SectionType> =
27
+ SectionType$inboundSchema;
28
+
29
+ /**
30
+ * @internal
31
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
32
+ */
33
+ export namespace SectionType$ {
34
+ /** @deprecated use `SectionType$inboundSchema` instead. */
35
+ export const inboundSchema = SectionType$inboundSchema;
36
+ /** @deprecated use `SectionType$outboundSchema` instead. */
37
+ export const outboundSchema = SectionType$outboundSchema;
38
+ }