@egain/egain-mcp-server 1.0.26 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (574) hide show
  1. package/README.md +20 -43
  2. package/bin/mcp-server.js +39534 -29516
  3. package/bin/mcp-server.js.map +298 -185
  4. package/esm/src/cloudflare-worker/cloudflare-worker.d.ts.map +1 -1
  5. package/esm/src/cloudflare-worker/cloudflare-worker.js +20 -9
  6. package/esm/src/cloudflare-worker/cloudflare-worker.js.map +1 -1
  7. package/esm/src/funcs/aiSearch.d.ts +63 -0
  8. package/esm/src/funcs/aiSearch.d.ts.map +1 -0
  9. package/esm/src/funcs/aiSearch.js +151 -0
  10. package/esm/src/funcs/aiSearch.js.map +1 -0
  11. package/esm/src/funcs/getAnnouncementArticles.d.ts +61 -0
  12. package/esm/src/funcs/getAnnouncementArticles.d.ts.map +1 -0
  13. package/esm/src/funcs/getAnnouncementArticles.js +152 -0
  14. package/esm/src/funcs/getAnnouncementArticles.js.map +1 -0
  15. package/esm/src/funcs/getAnnouncements.d.ts +39 -1
  16. package/esm/src/funcs/getAnnouncements.d.ts.map +1 -1
  17. package/esm/src/funcs/getAnnouncements.js +39 -1
  18. package/esm/src/funcs/getAnnouncements.js.map +1 -1
  19. package/esm/src/funcs/getArticle.d.ts +42 -0
  20. package/esm/src/funcs/getArticle.d.ts.map +1 -1
  21. package/esm/src/funcs/getArticle.js +42 -0
  22. package/esm/src/funcs/getArticle.js.map +1 -1
  23. package/esm/src/funcs/getArticleById.d.ts +70 -0
  24. package/esm/src/funcs/getArticleById.d.ts.map +1 -0
  25. package/esm/src/funcs/getArticleById.js +163 -0
  26. package/esm/src/funcs/getArticleById.js.map +1 -0
  27. package/esm/src/funcs/getBestAnswer.d.ts +66 -0
  28. package/esm/src/funcs/getBestAnswer.d.ts.map +1 -0
  29. package/esm/src/funcs/getBestAnswer.js +148 -0
  30. package/esm/src/funcs/getBestAnswer.js.map +1 -0
  31. package/esm/src/funcs/getMyPortals.d.ts +97 -0
  32. package/esm/src/funcs/getMyPortals.d.ts.map +1 -0
  33. package/esm/src/funcs/getMyPortals.js +180 -0
  34. package/esm/src/funcs/getMyPortals.js.map +1 -0
  35. package/esm/src/funcs/getPopularArticles.d.ts +39 -0
  36. package/esm/src/funcs/getPopularArticles.d.ts.map +1 -1
  37. package/esm/src/funcs/getPopularArticles.js +47 -3
  38. package/esm/src/funcs/getPopularArticles.js.map +1 -1
  39. package/esm/src/funcs/getPortals.d.ts +26 -1
  40. package/esm/src/funcs/getPortals.d.ts.map +1 -1
  41. package/esm/src/funcs/getPortals.js +35 -10
  42. package/esm/src/funcs/getPortals.js.map +1 -1
  43. package/esm/src/funcs/makeSuggestion.d.ts +46 -2
  44. package/esm/src/funcs/makeSuggestion.d.ts.map +1 -1
  45. package/esm/src/funcs/makeSuggestion.js +51 -3
  46. package/esm/src/funcs/makeSuggestion.js.map +1 -1
  47. package/esm/src/funcs/queryAnswers.d.ts +41 -5
  48. package/esm/src/funcs/queryAnswers.d.ts.map +1 -1
  49. package/esm/src/funcs/queryAnswers.js +41 -5
  50. package/esm/src/funcs/queryAnswers.js.map +1 -1
  51. package/esm/src/funcs/queryRetrieve.d.ts +41 -1
  52. package/esm/src/funcs/queryRetrieve.d.ts.map +1 -1
  53. package/esm/src/funcs/queryRetrieve.js +41 -1
  54. package/esm/src/funcs/queryRetrieve.js.map +1 -1
  55. package/esm/src/funcs/querySearch.d.ts +48 -1
  56. package/esm/src/funcs/querySearch.d.ts.map +1 -1
  57. package/esm/src/funcs/querySearch.js +48 -1
  58. package/esm/src/funcs/querySearch.js.map +1 -1
  59. package/esm/src/funcs/retrieveChunks.d.ts +41 -7
  60. package/esm/src/funcs/retrieveChunks.d.ts.map +1 -1
  61. package/esm/src/funcs/retrieveChunks.js +45 -19
  62. package/esm/src/funcs/retrieveChunks.js.map +1 -1
  63. package/esm/src/hooks/auth-hook.d.ts +1 -2
  64. package/esm/src/hooks/auth-hook.d.ts.map +1 -1
  65. package/esm/src/hooks/auth-hook.js +1 -65
  66. package/esm/src/hooks/auth-hook.js.map +1 -1
  67. package/esm/src/hooks/registration.d.ts.map +1 -1
  68. package/esm/src/hooks/registration.js +2 -16
  69. package/esm/src/hooks/registration.js.map +1 -1
  70. package/esm/src/landing-page.d.ts +5 -0
  71. package/esm/src/landing-page.d.ts.map +1 -0
  72. package/esm/src/landing-page.js +1070 -0
  73. package/esm/src/landing-page.js.map +1 -0
  74. package/esm/src/lib/base64.d.ts +2 -2
  75. package/esm/src/lib/base64.d.ts.map +1 -1
  76. package/esm/src/lib/base64.js +2 -2
  77. package/esm/src/lib/base64.js.map +1 -1
  78. package/esm/src/lib/config.d.ts +3 -3
  79. package/esm/src/lib/config.js +5 -5
  80. package/esm/src/lib/config.js.map +1 -1
  81. package/esm/src/lib/encodings.d.ts.map +1 -1
  82. package/esm/src/lib/encodings.js +10 -1
  83. package/esm/src/lib/encodings.js.map +1 -1
  84. package/esm/src/lib/matchers.d.ts.map +1 -1
  85. package/esm/src/lib/matchers.js +4 -1
  86. package/esm/src/lib/matchers.js.map +1 -1
  87. package/esm/src/lib/schemas.d.ts +4 -4
  88. package/esm/src/lib/schemas.d.ts.map +1 -1
  89. package/esm/src/lib/schemas.js +2 -2
  90. package/esm/src/lib/schemas.js.map +1 -1
  91. package/esm/src/lib/sdks.js +2 -2
  92. package/esm/src/lib/sdks.js.map +1 -1
  93. package/esm/src/lib/security.d.ts.map +1 -1
  94. package/esm/src/lib/security.js +18 -0
  95. package/esm/src/lib/security.js.map +1 -1
  96. package/esm/src/mcp-server/cli/start/command.d.ts.map +1 -1
  97. package/esm/src/mcp-server/cli/start/command.js +30 -0
  98. package/esm/src/mcp-server/cli/start/command.js.map +1 -1
  99. package/esm/src/mcp-server/cli/start/impl.d.ts +2 -7
  100. package/esm/src/mcp-server/cli/start/impl.d.ts.map +1 -1
  101. package/esm/src/mcp-server/cli/start/impl.js +98 -22
  102. package/esm/src/mcp-server/cli/start/impl.js.map +1 -1
  103. package/esm/src/mcp-server/extensions.d.ts +4 -4
  104. package/esm/src/mcp-server/extensions.d.ts.map +1 -1
  105. package/esm/src/mcp-server/flags.d.ts +17 -0
  106. package/esm/src/mcp-server/flags.d.ts.map +1 -0
  107. package/esm/src/mcp-server/flags.js +5 -0
  108. package/esm/src/mcp-server/flags.js.map +1 -0
  109. package/esm/src/mcp-server/mcp-server.js +1 -1
  110. package/esm/src/mcp-server/mcp-server.js.map +1 -1
  111. package/esm/src/mcp-server/prompts.d.ts +4 -7
  112. package/esm/src/mcp-server/prompts.d.ts.map +1 -1
  113. package/esm/src/mcp-server/prompts.js.map +1 -1
  114. package/esm/src/mcp-server/server.d.ts +8 -1
  115. package/esm/src/mcp-server/server.d.ts.map +1 -1
  116. package/esm/src/mcp-server/server.js +19 -16
  117. package/esm/src/mcp-server/server.js.map +1 -1
  118. package/esm/src/mcp-server/tools/aiSearch.d.ts +7 -0
  119. package/esm/src/mcp-server/tools/aiSearch.d.ts.map +1 -0
  120. package/esm/src/mcp-server/tools/aiSearch.js +83 -0
  121. package/esm/src/mcp-server/tools/aiSearch.js.map +1 -0
  122. package/esm/src/mcp-server/tools/getAnnouncementArticles.d.ts +7 -0
  123. package/esm/src/mcp-server/tools/getAnnouncementArticles.d.ts.map +1 -0
  124. package/esm/src/mcp-server/tools/getAnnouncementArticles.js +81 -0
  125. package/esm/src/mcp-server/tools/getAnnouncementArticles.js.map +1 -0
  126. package/esm/src/mcp-server/tools/getAnnouncements.d.ts.map +1 -1
  127. package/esm/src/mcp-server/tools/getAnnouncements.js +39 -1
  128. package/esm/src/mcp-server/tools/getAnnouncements.js.map +1 -1
  129. package/esm/src/mcp-server/tools/getArticle.d.ts.map +1 -1
  130. package/esm/src/mcp-server/tools/getArticle.js +42 -0
  131. package/esm/src/mcp-server/tools/getArticle.js.map +1 -1
  132. package/esm/src/mcp-server/tools/getArticleById.d.ts +7 -0
  133. package/esm/src/mcp-server/tools/getArticleById.d.ts.map +1 -0
  134. package/esm/src/mcp-server/tools/getArticleById.js +90 -0
  135. package/esm/src/mcp-server/tools/getArticleById.js.map +1 -0
  136. package/esm/src/mcp-server/tools/getBestAnswer.d.ts +7 -0
  137. package/esm/src/mcp-server/tools/getBestAnswer.d.ts.map +1 -0
  138. package/esm/src/mcp-server/tools/getBestAnswer.js +85 -0
  139. package/esm/src/mcp-server/tools/getBestAnswer.js.map +1 -0
  140. package/esm/src/mcp-server/tools/getMyPortals.d.ts +7 -0
  141. package/esm/src/mcp-server/tools/getMyPortals.d.ts.map +1 -0
  142. package/esm/src/mcp-server/tools/getMyPortals.js +117 -0
  143. package/esm/src/mcp-server/tools/getMyPortals.js.map +1 -0
  144. package/esm/src/mcp-server/tools/getPopularArticles.d.ts +1 -1
  145. package/esm/src/mcp-server/tools/getPopularArticles.d.ts.map +1 -1
  146. package/esm/src/mcp-server/tools/getPopularArticles.js +40 -0
  147. package/esm/src/mcp-server/tools/getPopularArticles.js.map +1 -1
  148. package/esm/src/mcp-server/tools/getPortals.d.ts +1 -1
  149. package/esm/src/mcp-server/tools/getPortals.d.ts.map +1 -1
  150. package/esm/src/mcp-server/tools/getPortals.js +26 -1
  151. package/esm/src/mcp-server/tools/getPortals.js.map +1 -1
  152. package/esm/src/mcp-server/tools/makeSuggestion.d.ts +1 -1
  153. package/esm/src/mcp-server/tools/makeSuggestion.d.ts.map +1 -1
  154. package/esm/src/mcp-server/tools/makeSuggestion.js +44 -0
  155. package/esm/src/mcp-server/tools/makeSuggestion.js.map +1 -1
  156. package/esm/src/mcp-server/tools/queryAnswers.d.ts.map +1 -1
  157. package/esm/src/mcp-server/tools/queryAnswers.js +41 -5
  158. package/esm/src/mcp-server/tools/queryAnswers.js.map +1 -1
  159. package/esm/src/mcp-server/tools/queryRetrieve.d.ts.map +1 -1
  160. package/esm/src/mcp-server/tools/queryRetrieve.js +41 -1
  161. package/esm/src/mcp-server/tools/queryRetrieve.js.map +1 -1
  162. package/esm/src/mcp-server/tools/querySearch.d.ts.map +1 -1
  163. package/esm/src/mcp-server/tools/querySearch.js +48 -1
  164. package/esm/src/mcp-server/tools/querySearch.js.map +1 -1
  165. package/esm/src/mcp-server/tools/retrieveChunks.d.ts +1 -1
  166. package/esm/src/mcp-server/tools/retrieveChunks.d.ts.map +1 -1
  167. package/esm/src/mcp-server/tools/retrieveChunks.js +41 -7
  168. package/esm/src/mcp-server/tools/retrieveChunks.js.map +1 -1
  169. package/esm/src/mcp-server/tools.d.ts +14 -4
  170. package/esm/src/mcp-server/tools.d.ts.map +1 -1
  171. package/esm/src/mcp-server/tools.js +203 -5
  172. package/esm/src/mcp-server/tools.js.map +1 -1
  173. package/esm/src/models/acceptlanguage.d.ts +36 -5
  174. package/esm/src/models/acceptlanguage.d.ts.map +1 -1
  175. package/esm/src/models/acceptlanguage.js +18 -4
  176. package/esm/src/models/acceptlanguage.js.map +1 -1
  177. package/esm/src/models/accessibleportal.d.ts +1 -1
  178. package/esm/src/models/accessibleportal.d.ts.map +1 -1
  179. package/esm/src/models/accessibleportal.js.map +1 -1
  180. package/esm/src/models/additionalsnippets.d.ts +18 -3
  181. package/esm/src/models/additionalsnippets.d.ts.map +1 -1
  182. package/esm/src/models/additionalsnippets.js +8 -1
  183. package/esm/src/models/additionalsnippets.js.map +1 -1
  184. package/esm/src/models/aisearchop.d.ts +4 -10
  185. package/esm/src/models/aisearchop.d.ts.map +1 -1
  186. package/esm/src/models/aisearchop.js +9 -20
  187. package/esm/src/models/aisearchop.js.map +1 -1
  188. package/esm/src/models/aisearchresponse.d.ts +2 -2
  189. package/esm/src/models/aisearchresponse.d.ts.map +1 -1
  190. package/esm/src/models/aisearchresponse.js.map +1 -1
  191. package/esm/src/models/aispaginationinfo.d.ts +1 -1
  192. package/esm/src/models/aispaginationinfo.d.ts.map +1 -1
  193. package/esm/src/models/aispaginationinfo.js +5 -4
  194. package/esm/src/models/aispaginationinfo.js.map +1 -1
  195. package/esm/src/models/aitopicbreadcrumb.d.ts +1 -1
  196. package/esm/src/models/aitopicbreadcrumb.d.ts.map +1 -1
  197. package/esm/src/models/aitopicbreadcrumb.js +2 -1
  198. package/esm/src/models/aitopicbreadcrumb.js.map +1 -1
  199. package/esm/src/models/aitopicsummary.d.ts +1 -1
  200. package/esm/src/models/aitopicsummary.d.ts.map +1 -1
  201. package/esm/src/models/aitopicsummary.js.map +1 -1
  202. package/esm/src/models/allaccessibleportals.d.ts +1 -1
  203. package/esm/src/models/allaccessibleportals.d.ts.map +1 -1
  204. package/esm/src/models/allaccessibleportals.js +2 -1
  205. package/esm/src/models/allaccessibleportals.js.map +1 -1
  206. package/esm/src/models/answersrequest.d.ts +16 -25
  207. package/esm/src/models/answersrequest.d.ts.map +1 -1
  208. package/esm/src/models/answersrequest.js +11 -25
  209. package/esm/src/models/answersrequest.js.map +1 -1
  210. package/esm/src/models/answersresponse.d.ts +28 -7
  211. package/esm/src/models/answersresponse.d.ts.map +1 -1
  212. package/esm/src/models/answersresponse.js +8 -0
  213. package/esm/src/models/answersresponse.js.map +1 -1
  214. package/esm/src/models/article.d.ts +2 -2
  215. package/esm/src/models/article.d.ts.map +1 -1
  216. package/esm/src/models/article.js +3 -4
  217. package/esm/src/models/article.js.map +1 -1
  218. package/esm/src/models/articleadditionalattributes.d.ts +36 -2
  219. package/esm/src/models/articleadditionalattributes.d.ts.map +1 -1
  220. package/esm/src/models/articleadditionalattributes.js +17 -0
  221. package/esm/src/models/articleadditionalattributes.js.map +1 -1
  222. package/esm/src/models/articleaisearchresult.d.ts +48 -9
  223. package/esm/src/models/articleaisearchresult.d.ts.map +1 -1
  224. package/esm/src/models/articleaisearchresult.js +17 -1
  225. package/esm/src/models/articleaisearchresult.js.map +1 -1
  226. package/esm/src/models/articleattachment.d.ts +14 -3
  227. package/esm/src/models/articleattachment.d.ts.map +1 -1
  228. package/esm/src/models/articleattachment.js +7 -2
  229. package/esm/src/models/articleattachment.js.map +1 -1
  230. package/esm/src/models/articleresult.d.ts +1 -1
  231. package/esm/src/models/articleresult.d.ts.map +1 -1
  232. package/esm/src/models/articleresult.js +1 -1
  233. package/esm/src/models/articleresult.js.map +1 -1
  234. package/esm/src/models/articleresultadditionalattributes.d.ts +34 -2
  235. package/esm/src/models/articleresultadditionalattributes.d.ts.map +1 -1
  236. package/esm/src/models/articleresultadditionalattributes.js +16 -0
  237. package/esm/src/models/articleresultadditionalattributes.js.map +1 -1
  238. package/esm/src/models/articleresults.d.ts +1 -1
  239. package/esm/src/models/articleresults.d.ts.map +1 -1
  240. package/esm/src/models/articleresults.js.map +1 -1
  241. package/esm/src/models/articletype.d.ts +2 -7
  242. package/esm/src/models/articletype.d.ts.map +1 -1
  243. package/esm/src/models/articletype.js +2 -16
  244. package/esm/src/models/articletype.js.map +1 -1
  245. package/esm/src/models/attachmentforcreatesuggestion.d.ts +1 -1
  246. package/esm/src/models/attachmentforcreatesuggestion.d.ts.map +1 -1
  247. package/esm/src/models/attachmentforcreatesuggestion.js.map +1 -1
  248. package/esm/src/models/bookmarkstatus.d.ts +1 -1
  249. package/esm/src/models/bookmarkstatus.d.ts.map +1 -1
  250. package/esm/src/models/bookmarkstatus.js +1 -1
  251. package/esm/src/models/bookmarkstatus.js.map +1 -1
  252. package/esm/src/models/complianceforarticle.d.ts +3 -3
  253. package/esm/src/models/complianceforarticle.d.ts.map +1 -1
  254. package/esm/src/models/complianceforarticle.js +8 -5
  255. package/esm/src/models/complianceforarticle.js.map +1 -1
  256. package/esm/src/models/createdby.d.ts +1 -1
  257. package/esm/src/models/createdby.d.ts.map +1 -1
  258. package/esm/src/models/createdby.js.map +1 -1
  259. package/esm/src/models/createsuggestion.d.ts +69 -6
  260. package/esm/src/models/createsuggestion.d.ts.map +1 -1
  261. package/esm/src/models/createsuggestion.js +31 -2
  262. package/esm/src/models/createsuggestion.js.map +1 -1
  263. package/esm/src/models/customattribute.d.ts +18 -3
  264. package/esm/src/models/customattribute.d.ts.map +1 -1
  265. package/esm/src/models/customattribute.js +6 -0
  266. package/esm/src/models/customattribute.js.map +1 -1
  267. package/esm/src/models/department.d.ts +1 -1
  268. package/esm/src/models/department.d.ts.map +1 -1
  269. package/esm/src/models/department.js.map +1 -1
  270. package/esm/src/models/edition.d.ts +2 -2
  271. package/esm/src/models/edition.d.ts.map +1 -1
  272. package/esm/src/models/edition.js +1 -2
  273. package/esm/src/models/edition.js.map +1 -1
  274. package/esm/src/models/errors/sdkvalidationerror.d.ts +1 -1
  275. package/esm/src/models/errors/sdkvalidationerror.d.ts.map +1 -1
  276. package/esm/src/models/errors/sdkvalidationerror.js +2 -49
  277. package/esm/src/models/errors/sdkvalidationerror.js.map +1 -1
  278. package/esm/src/models/folderbreadcrumb.d.ts +1 -1
  279. package/esm/src/models/folderbreadcrumb.d.ts.map +1 -1
  280. package/esm/src/models/folderbreadcrumb.js.map +1 -1
  281. package/esm/src/models/foldersummary.d.ts +1 -1
  282. package/esm/src/models/foldersummary.d.ts.map +1 -1
  283. package/esm/src/models/foldersummary.js +1 -1
  284. package/esm/src/models/foldersummary.js.map +1 -1
  285. package/esm/src/models/getannouncementarticlesop.d.ts +8 -9
  286. package/esm/src/models/getannouncementarticlesop.d.ts.map +1 -1
  287. package/esm/src/models/getannouncementarticlesop.js +12 -10
  288. package/esm/src/models/getannouncementarticlesop.js.map +1 -1
  289. package/esm/src/models/getarticlebyidop.d.ts +77 -11
  290. package/esm/src/models/getarticlebyidop.d.ts.map +1 -1
  291. package/esm/src/models/getarticlebyidop.js +31 -62
  292. package/esm/src/models/getarticlebyidop.js.map +1 -1
  293. package/esm/src/models/getbestanswerop.d.ts +1 -9
  294. package/esm/src/models/getbestanswerop.d.ts.map +1 -1
  295. package/esm/src/models/getbestanswerop.js +3 -16
  296. package/esm/src/models/getbestanswerop.js.map +1 -1
  297. package/esm/src/models/getmyportalsop.d.ts +4 -10
  298. package/esm/src/models/getmyportalsop.d.ts.map +1 -1
  299. package/esm/src/models/getmyportalsop.js +9 -10
  300. package/esm/src/models/getmyportalsop.js.map +1 -1
  301. package/esm/src/models/getpopulararticlesop.d.ts +8 -9
  302. package/esm/src/models/getpopulararticlesop.d.ts.map +1 -1
  303. package/esm/src/models/getpopulararticlesop.js +12 -10
  304. package/esm/src/models/getpopulararticlesop.js.map +1 -1
  305. package/esm/src/models/l10nstring.d.ts +1 -1
  306. package/esm/src/models/l10nstring.d.ts.map +1 -1
  307. package/esm/src/models/l10nstring.js.map +1 -1
  308. package/esm/src/models/languagecode.d.ts +69 -2
  309. package/esm/src/models/languagecode.d.ts.map +1 -1
  310. package/esm/src/models/languagecode.js +32 -0
  311. package/esm/src/models/languagecode.js.map +1 -1
  312. package/esm/src/models/languagecodeparameter.d.ts +90 -5
  313. package/esm/src/models/languagecodeparameter.d.ts.map +1 -1
  314. package/esm/src/models/languagecodeparameter.js +45 -4
  315. package/esm/src/models/languagecodeparameter.js.map +1 -1
  316. package/esm/src/models/languagequeryparameter.d.ts +90 -5
  317. package/esm/src/models/languagequeryparameter.d.ts.map +1 -1
  318. package/esm/src/models/languagequeryparameter.js +45 -4
  319. package/esm/src/models/languagequeryparameter.js.map +1 -1
  320. package/esm/src/models/link.d.ts +1 -1
  321. package/esm/src/models/link.d.ts.map +1 -1
  322. package/esm/src/models/link.js.map +1 -1
  323. package/esm/src/models/makesuggestionop.d.ts +4 -9
  324. package/esm/src/models/makesuggestionop.d.ts.map +1 -1
  325. package/esm/src/models/makesuggestionop.js +3 -7
  326. package/esm/src/models/makesuggestionop.js.map +1 -1
  327. package/esm/src/models/mandatorylanguagequeryparameter.d.ts +90 -5
  328. package/esm/src/models/mandatorylanguagequeryparameter.d.ts.map +1 -1
  329. package/esm/src/models/mandatorylanguagequeryparameter.js +45 -4
  330. package/esm/src/models/mandatorylanguagequeryparameter.js.map +1 -1
  331. package/esm/src/models/milestone.d.ts +1 -1
  332. package/esm/src/models/milestone.d.ts.map +1 -1
  333. package/esm/src/models/milestone.js.map +1 -1
  334. package/esm/src/models/milestonename.d.ts +1 -1
  335. package/esm/src/models/milestonename.d.ts.map +1 -1
  336. package/esm/src/models/milestonename.js.map +1 -1
  337. package/esm/src/models/modifiedby.d.ts +1 -1
  338. package/esm/src/models/modifiedby.d.ts.map +1 -1
  339. package/esm/src/models/modifiedby.js.map +1 -1
  340. package/esm/src/models/order.d.ts +10 -2
  341. package/esm/src/models/order.d.ts.map +1 -1
  342. package/esm/src/models/order.js +4 -0
  343. package/esm/src/models/order.js.map +1 -1
  344. package/esm/src/models/ownedby.d.ts +1 -1
  345. package/esm/src/models/ownedby.d.ts.map +1 -1
  346. package/esm/src/models/ownedby.js +1 -2
  347. package/esm/src/models/ownedby.js.map +1 -1
  348. package/esm/src/models/paginationinfo.d.ts +1 -1
  349. package/esm/src/models/paginationinfo.d.ts.map +1 -1
  350. package/esm/src/models/paginationinfo.js +3 -3
  351. package/esm/src/models/paginationinfo.js.map +1 -1
  352. package/esm/src/models/personalization.d.ts +4 -4
  353. package/esm/src/models/personalization.d.ts.map +1 -1
  354. package/esm/src/models/personalization.js +1 -2
  355. package/esm/src/models/personalization.js.map +1 -1
  356. package/esm/src/models/publishview.d.ts +2 -2
  357. package/esm/src/models/publishview.d.ts.map +1 -1
  358. package/esm/src/models/publishview.js.map +1 -1
  359. package/esm/src/models/referenceresponse.d.ts +30 -5
  360. package/esm/src/models/referenceresponse.d.ts.map +1 -1
  361. package/esm/src/models/referenceresponse.js +12 -1
  362. package/esm/src/models/referenceresponse.js.map +1 -1
  363. package/esm/src/models/requiredlanguagecode.d.ts +71 -2
  364. package/esm/src/models/requiredlanguagecode.d.ts.map +1 -1
  365. package/esm/src/models/requiredlanguagecode.js +33 -0
  366. package/esm/src/models/requiredlanguagecode.js.map +1 -1
  367. package/esm/src/models/retrievechunksop.d.ts +1 -9
  368. package/esm/src/models/retrievechunksop.d.ts.map +1 -1
  369. package/esm/src/models/retrievechunksop.js +1 -15
  370. package/esm/src/models/retrievechunksop.js.map +1 -1
  371. package/esm/src/models/retrieverequest.d.ts +15 -4
  372. package/esm/src/models/retrieverequest.d.ts.map +1 -1
  373. package/esm/src/models/retrieverequest.js +4 -0
  374. package/esm/src/models/retrieverequest.js.map +1 -1
  375. package/esm/src/models/retrieveresponse.d.ts +27 -8
  376. package/esm/src/models/retrieveresponse.d.ts.map +1 -1
  377. package/esm/src/models/retrieveresponse.js +8 -1
  378. package/esm/src/models/retrieveresponse.js.map +1 -1
  379. package/esm/src/models/schemaslink.d.ts +1 -1
  380. package/esm/src/models/schemaslink.d.ts.map +1 -1
  381. package/esm/src/models/schemaslink.js.map +1 -1
  382. package/esm/src/models/schemastags.d.ts +1 -1
  383. package/esm/src/models/schemastags.d.ts.map +1 -1
  384. package/esm/src/models/schemastags.js.map +1 -1
  385. package/esm/src/models/searchresult.d.ts +40 -5
  386. package/esm/src/models/searchresult.d.ts.map +1 -1
  387. package/esm/src/models/searchresult.js +19 -0
  388. package/esm/src/models/searchresult.js.map +1 -1
  389. package/esm/src/models/security.d.ts +5 -2
  390. package/esm/src/models/security.d.ts.map +1 -1
  391. package/esm/src/models/security.js +5 -3
  392. package/esm/src/models/security.js.map +1 -1
  393. package/esm/src/models/shorturl.d.ts +1 -1
  394. package/esm/src/models/shorturl.d.ts.map +1 -1
  395. package/esm/src/models/shorturl.js +1 -2
  396. package/esm/src/models/shorturl.js.map +1 -1
  397. package/esm/src/models/sortidnamedepartment.d.ts +12 -2
  398. package/esm/src/models/sortidnamedepartment.d.ts.map +1 -1
  399. package/esm/src/models/sortidnamedepartment.js +5 -0
  400. package/esm/src/models/sortidnamedepartment.js.map +1 -1
  401. package/esm/src/models/stage.d.ts +1 -1
  402. package/esm/src/models/stage.d.ts.map +1 -1
  403. package/esm/src/models/stage.js +1 -2
  404. package/esm/src/models/stage.js.map +1 -1
  405. package/esm/src/models/structuredauthoringfields.d.ts +1 -1
  406. package/esm/src/models/structuredauthoringfields.d.ts.map +1 -1
  407. package/esm/src/models/structuredauthoringfields.js.map +1 -1
  408. package/esm/src/models/tag.d.ts +1 -1
  409. package/esm/src/models/tag.d.ts.map +1 -1
  410. package/esm/src/models/tag.js.map +1 -1
  411. package/esm/src/models/tagcategory.d.ts +1 -1
  412. package/esm/src/models/tagcategory.d.ts.map +1 -1
  413. package/esm/src/models/tagcategory.js.map +1 -1
  414. package/esm/src/models/taggroup.d.ts +1 -1
  415. package/esm/src/models/taggroup.d.ts.map +1 -1
  416. package/esm/src/models/taggroup.js +1 -2
  417. package/esm/src/models/taggroup.js.map +1 -1
  418. package/esm/src/models/taggroups.d.ts +1 -1
  419. package/esm/src/models/taggroups.d.ts.map +1 -1
  420. package/esm/src/models/taggroups.js.map +1 -1
  421. package/esm/src/models/tags.d.ts +1 -1
  422. package/esm/src/models/tags.d.ts.map +1 -1
  423. package/esm/src/models/tags.js.map +1 -1
  424. package/esm/src/models/topicbreadcrumb.d.ts +1 -1
  425. package/esm/src/models/topicbreadcrumb.d.ts.map +1 -1
  426. package/esm/src/models/topicbreadcrumb.js.map +1 -1
  427. package/esm/src/models/topicsummary.d.ts +1 -1
  428. package/esm/src/models/topicsummary.d.ts.map +1 -1
  429. package/esm/src/models/topicsummary.js.map +1 -1
  430. package/esm/src/models/workflow.d.ts +1 -1
  431. package/esm/src/models/workflow.d.ts.map +1 -1
  432. package/esm/src/models/workflow.js +1 -2
  433. package/esm/src/models/workflow.js.map +1 -1
  434. package/esm/src/models/workflowmilestone.d.ts +12 -2
  435. package/esm/src/models/workflowmilestone.d.ts.map +1 -1
  436. package/esm/src/models/workflowmilestone.js +5 -0
  437. package/esm/src/models/workflowmilestone.js.map +1 -1
  438. package/esm/src/models/wserrorcommon.d.ts +2 -2
  439. package/esm/src/models/wserrorcommon.d.ts.map +1 -1
  440. package/esm/src/models/wserrorcommon.js +1 -2
  441. package/esm/src/models/wserrorcommon.js.map +1 -1
  442. package/esm/src/tool-names.d.ts +5 -0
  443. package/esm/src/tool-names.d.ts.map +1 -0
  444. package/esm/src/tool-names.js +36 -0
  445. package/esm/src/tool-names.js.map +1 -0
  446. package/esm/src/types/bigint.d.ts +6 -0
  447. package/esm/src/types/bigint.d.ts.map +1 -0
  448. package/esm/src/types/bigint.js +87 -0
  449. package/esm/src/types/bigint.js.map +1 -0
  450. package/esm/worker-configuration.d.ts +1 -0
  451. package/esm/worker-configuration.d.ts.map +1 -1
  452. package/manifest.json +78 -51
  453. package/package.json +11 -7
  454. package/src/cloudflare-worker/cloudflare-worker.ts +22 -9
  455. package/src/funcs/{querySearch.ts → aiSearch.ts} +49 -2
  456. package/src/funcs/{getAnnouncements.ts → getAnnouncementArticles.ts} +67 -10
  457. package/src/funcs/{getArticle.ts → getArticleById.ts} +58 -1
  458. package/src/funcs/{queryAnswers.ts → getBestAnswer.ts} +52 -14
  459. package/src/funcs/{getPortals.ts → getMyPortals.ts} +35 -2
  460. package/src/funcs/getPopularArticles.ts +68 -8
  461. package/src/funcs/makeSuggestion.ts +67 -9
  462. package/src/funcs/{queryRetrieve.ts → retrieveChunks.ts} +50 -15
  463. package/src/hooks/auth-hook.ts +3 -63
  464. package/src/hooks/registration.ts +3 -18
  465. package/src/landing-page.ts +1084 -0
  466. package/src/lib/base64.ts +2 -2
  467. package/src/lib/config.ts +5 -5
  468. package/src/lib/encodings.ts +12 -3
  469. package/src/lib/matchers.ts +5 -1
  470. package/src/lib/schemas.ts +10 -22
  471. package/src/lib/sdks.ts +2 -2
  472. package/src/lib/security.ts +21 -0
  473. package/src/mcp-server/cli/start/command.ts +31 -0
  474. package/src/mcp-server/cli/start/impl.ts +118 -31
  475. package/src/mcp-server/extensions.ts +6 -4
  476. package/src/mcp-server/flags.ts +21 -0
  477. package/src/mcp-server/mcp-server.ts +1 -1
  478. package/src/mcp-server/prompts.ts +9 -19
  479. package/src/mcp-server/server.ts +22 -16
  480. package/src/mcp-server/tools/aiSearch.ts +92 -0
  481. package/src/mcp-server/tools/getAnnouncementArticles.ts +90 -0
  482. package/src/mcp-server/tools/getArticleById.ts +99 -0
  483. package/src/mcp-server/tools/getBestAnswer.ts +94 -0
  484. package/src/mcp-server/tools/{getPortals.ts → getMyPortals.ts} +39 -5
  485. package/src/mcp-server/tools/getPopularArticles.ts +40 -0
  486. package/src/mcp-server/tools/makeSuggestion.ts +44 -0
  487. package/src/mcp-server/tools/retrieveChunks.ts +89 -0
  488. package/src/mcp-server/tools.ts +300 -46
  489. package/src/models/acceptlanguage.ts +21 -8
  490. package/src/models/accessibleportal.ts +9 -11
  491. package/src/models/additionalsnippets.ts +25 -18
  492. package/src/models/aisearchop.ts +14 -37
  493. package/src/models/aisearchresponse.ts +7 -13
  494. package/src/models/aispaginationinfo.ts +7 -10
  495. package/src/models/aitopicbreadcrumb.ts +4 -7
  496. package/src/models/aitopicsummary.ts +1 -5
  497. package/src/models/allaccessibleportals.ts +5 -8
  498. package/src/models/answersrequest.ts +22 -58
  499. package/src/models/answersresponse.ts +30 -24
  500. package/src/models/article.ts +39 -40
  501. package/src/models/articleadditionalattributes.ts +22 -4
  502. package/src/models/articleaisearchresult.ts +70 -52
  503. package/src/models/articleattachment.ts +18 -15
  504. package/src/models/articleresult.ts +2 -6
  505. package/src/models/articleresultadditionalattributes.ts +43 -0
  506. package/src/models/articleresults.ts +1 -5
  507. package/src/models/articletype.ts +4 -25
  508. package/src/models/attachmentforcreatesuggestion.ts +1 -3
  509. package/src/models/bookmarkstatus.ts +2 -6
  510. package/src/models/complianceforarticle.ts +13 -22
  511. package/src/models/createdby.ts +7 -8
  512. package/src/models/createsuggestion.ts +54 -31
  513. package/src/models/customattribute.ts +13 -7
  514. package/src/models/department.ts +1 -5
  515. package/src/models/edition.ts +8 -13
  516. package/src/models/errors/sdkvalidationerror.ts +2 -57
  517. package/src/models/folderbreadcrumb.ts +5 -7
  518. package/src/models/foldersummary.ts +2 -6
  519. package/src/models/getannouncementarticlesop.ts +34 -23
  520. package/src/models/getarticlebyidop.ts +91 -95
  521. package/src/models/getbestanswerop.ts +16 -48
  522. package/src/models/getmyportalsop.ts +29 -44
  523. package/src/models/getpopulararticlesop.ts +34 -23
  524. package/src/models/l10nstring.ts +1 -5
  525. package/src/models/languagecode.ts +38 -2
  526. package/src/models/languagecodeparameter.ts +48 -10
  527. package/src/models/languagequeryparameter.ts +48 -10
  528. package/src/models/link.ts +1 -1
  529. package/src/models/makesuggestionop.ts +20 -30
  530. package/src/models/mandatorylanguagequeryparameter.ts +50 -10
  531. package/src/models/milestone.ts +3 -4
  532. package/src/models/milestonename.ts +1 -5
  533. package/src/models/modifiedby.ts +1 -5
  534. package/src/models/order.ts +7 -2
  535. package/src/models/ownedby.ts +7 -8
  536. package/src/models/paginationinfo.ts +4 -8
  537. package/src/models/personalization.ts +6 -19
  538. package/src/models/publishview.ts +2 -8
  539. package/src/models/referenceresponse.ts +34 -20
  540. package/src/models/requiredlanguagecode.ts +39 -4
  541. package/src/models/retrievechunksop.ts +16 -48
  542. package/src/models/retrieverequest.ts +12 -10
  543. package/src/models/retrieveresponse.ts +34 -28
  544. package/src/models/schemaslink.ts +1 -5
  545. package/src/models/schemastags.ts +1 -5
  546. package/src/models/searchresult.ts +34 -8
  547. package/src/models/security.ts +14 -7
  548. package/src/models/shorturl.ts +6 -7
  549. package/src/models/sortidnamedepartment.ts +8 -4
  550. package/src/models/stage.ts +4 -5
  551. package/src/models/structuredauthoringfields.ts +1 -3
  552. package/src/models/tag.ts +1 -1
  553. package/src/models/tagcategory.ts +1 -5
  554. package/src/models/taggroup.ts +4 -5
  555. package/src/models/taggroups.ts +3 -4
  556. package/src/models/tags.ts +1 -1
  557. package/src/models/topicbreadcrumb.ts +1 -5
  558. package/src/models/topicsummary.ts +1 -5
  559. package/src/models/workflow.ts +3 -4
  560. package/src/models/workflowmilestone.ts +8 -2
  561. package/src/models/wserrorcommon.ts +5 -10
  562. package/src/tool-names.ts +35 -0
  563. package/src/types/bigint.ts +87 -0
  564. package/tsconfig.json +0 -1
  565. package/worker-configuration.d.ts +2 -2
  566. package/worker-configuration.ts +1 -0
  567. package/src/cloudflare-worker/landing-page.ts +0 -337
  568. package/src/hooks/portal-cache-hook.ts +0 -505
  569. package/src/hooks/portal-lookup-hook.ts +0 -429
  570. package/src/mcp-server/tools/getAnnouncements.ts +0 -53
  571. package/src/mcp-server/tools/getArticle.ts +0 -56
  572. package/src/mcp-server/tools/queryAnswers.ts +0 -57
  573. package/src/mcp-server/tools/queryRetrieve.ts +0 -55
  574. package/src/mcp-server/tools/querySearch.ts +0 -44
@@ -3,10 +3,54 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
7
+
8
+ export const LanguageQueryParameter = {
9
+ EnUS: "en-US",
10
+ FRFR: "fr-FR",
11
+ EnGB: "en-GB",
12
+ ESES: "es-ES",
13
+ ITIT: "it-IT",
14
+ NLNL: "nl-NL",
15
+ DADA: "da-DA",
16
+ SvSE: "sv-SE",
17
+ PTPT: "pt-PT",
18
+ FIFI: "fi-FI",
19
+ NoNB: "no-NB",
20
+ NoNN: "no-NN",
21
+ JAJA: "ja-JA",
22
+ DEDE: "de-DE",
23
+ PtBR: "pt-BR",
24
+ ZhCN: "zh-CN",
25
+ ZhTW: "zh-TW",
26
+ KOKO: "ko-KO",
27
+ RURU: "ru-RU",
28
+ ELEL: "el-EL",
29
+ TRTR: "tr-TR",
30
+ PLPL: "pl-PL",
31
+ CSCS: "cs-CS",
32
+ SKSK: "sk-SK",
33
+ HUHU: "hu-HU",
34
+ SRSR: "sr-SR",
35
+ ArSA: "ar-SA",
36
+ HRHR: "hr-HR",
37
+ RORO: "ro-RO",
38
+ THTH: "th-TH",
39
+ DeAT: "de-AT",
40
+ ViVN: "vi-VN",
41
+ IDID: "id-ID",
42
+ MsMY: "ms-MY",
43
+ FilPH: "fil-PH",
44
+ FrCA: "fr-CA",
45
+ HiIN: "hi-IN",
46
+ UkUA: "uk-UA",
47
+ BGBG: "bg-BG",
48
+ SlSI: "sl-SI",
49
+ SrRS: "sr-RS",
50
+ XXXX: "xx-XX",
51
+ } as const;
52
+ export type LanguageQueryParameter = ClosedEnum<typeof LanguageQueryParameter>;
6
53
 
7
- /**
8
- * The language that describes the details of a resource. Resources available in different languages may differ from each other.<li>If <code>$lang</code> is not passed, then the portal's default language is used.</li><br><br>**Important**: When using this API via SDK or MCP, use the parameter name `Dollar_lang`, not `$lang` or `lang`.
9
- */
10
54
  export const LanguageQueryParameter$zodSchema = z.enum([
11
55
  "en-US",
12
56
  "fr-FR",
@@ -50,10 +94,4 @@ export const LanguageQueryParameter$zodSchema = z.enum([
50
94
  "sl-SI",
51
95
  "sr-RS",
52
96
  "xx-XX",
53
- ]).describe(
54
- "The language that describes the details of a resource. Resources available in different languages may differ from each other.<li>If <code>$lang</code> is not passed, then the portal's default language is used.</li><br><br>**Important**: When using this API via SDK or MCP, use the parameter name `Dollar_lang`, not `$lang` or `lang`.",
55
- );
56
-
57
- export type LanguageQueryParameter = z.infer<
58
- typeof LanguageQueryParameter$zodSchema
59
- >;
97
+ ]);
@@ -9,7 +9,7 @@ import * as z from "zod";
9
9
  */
10
10
  export type Link = { rel?: string | undefined; href?: string | undefined };
11
11
 
12
- export const Link$zodSchema: z.ZodType<Link, z.ZodTypeDef, unknown> = z.object({
12
+ export const Link$zodSchema: z.ZodType<Link> = z.object({
13
13
  href: z.string().optional(),
14
14
  rel: z.string().optional(),
15
15
  }).describe(
@@ -8,40 +8,30 @@ import {
8
8
  CreateSuggestion,
9
9
  CreateSuggestion$zodSchema,
10
10
  } from "./createsuggestion.js";
11
- import { WSErrorCommon, WSErrorCommon$zodSchema } from "./wserrorcommon.js";
12
11
 
13
12
  export type MakeSuggestionRequest = {
13
+ xEgainActivityId?: string | undefined;
14
+ xExtIntegrationId?: string | undefined;
15
+ xExtInteractionId?: string | undefined;
14
16
  acceptLanguage?: AcceptLanguage | undefined;
15
17
  portalID: string;
16
18
  CreateSuggestion?: CreateSuggestion | undefined;
17
19
  };
18
20
 
19
- export const MakeSuggestionRequest$zodSchema: z.ZodType<
20
- MakeSuggestionRequest,
21
- z.ZodTypeDef,
22
- unknown
23
- > = z.object({
24
- CreateSuggestion: CreateSuggestion$zodSchema.optional(),
25
- acceptLanguage: AcceptLanguage$zodSchema.default("en-US"),
26
- portalID: z.string().describe(
27
- "The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.",
28
- ),
29
- });
30
-
31
- export type MakeSuggestionResponse = {
32
- ContentType: string;
33
- StatusCode: number;
34
- RawResponse: Response;
35
- WSErrorCommon?: WSErrorCommon | undefined;
36
- };
37
-
38
- export const MakeSuggestionResponse$zodSchema: z.ZodType<
39
- MakeSuggestionResponse,
40
- z.ZodTypeDef,
41
- unknown
42
- > = z.object({
43
- ContentType: z.string(),
44
- RawResponse: z.instanceof(Response),
45
- StatusCode: z.number().int(),
46
- WSErrorCommon: WSErrorCommon$zodSchema.optional(),
47
- });
21
+ export const MakeSuggestionRequest$zodSchema: z.ZodType<MakeSuggestionRequest> =
22
+ z.object({
23
+ CreateSuggestion: CreateSuggestion$zodSchema.optional(),
24
+ acceptLanguage: AcceptLanguage$zodSchema.default("en-US"),
25
+ portalID: z.string().describe(
26
+ "The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.",
27
+ ),
28
+ xEgainActivityId: z.string().describe(
29
+ "A unique numeric interaction identifier from eGain.",
30
+ ).optional(),
31
+ xExtIntegrationId: z.string().describe(
32
+ "The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.*",
33
+ ).optional(),
34
+ xExtInteractionId: z.string().describe(
35
+ "A unique interaction identifier from other CRM applications.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.*",
36
+ ).optional(),
37
+ });
@@ -3,10 +3,56 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
7
+
8
+ export const MandatoryLanguageQueryParameter = {
9
+ EnUS: "en-US",
10
+ FRFR: "fr-FR",
11
+ EnGB: "en-GB",
12
+ ESES: "es-ES",
13
+ ITIT: "it-IT",
14
+ NLNL: "nl-NL",
15
+ DADA: "da-DA",
16
+ SvSE: "sv-SE",
17
+ PTPT: "pt-PT",
18
+ FIFI: "fi-FI",
19
+ NoNB: "no-NB",
20
+ NoNN: "no-NN",
21
+ JAJA: "ja-JA",
22
+ DEDE: "de-DE",
23
+ PtBR: "pt-BR",
24
+ ZhCN: "zh-CN",
25
+ ZhTW: "zh-TW",
26
+ KOKO: "ko-KO",
27
+ RURU: "ru-RU",
28
+ ELEL: "el-EL",
29
+ TRTR: "tr-TR",
30
+ PLPL: "pl-PL",
31
+ CSCS: "cs-CS",
32
+ SKSK: "sk-SK",
33
+ HUHU: "hu-HU",
34
+ SRSR: "sr-SR",
35
+ ArSA: "ar-SA",
36
+ HRHR: "hr-HR",
37
+ RORO: "ro-RO",
38
+ THTH: "th-TH",
39
+ DeAT: "de-AT",
40
+ ViVN: "vi-VN",
41
+ IDID: "id-ID",
42
+ MsMY: "ms-MY",
43
+ FilPH: "fil-PH",
44
+ FrCA: "fr-CA",
45
+ HiIN: "hi-IN",
46
+ UkUA: "uk-UA",
47
+ BGBG: "bg-BG",
48
+ SlSI: "sl-SI",
49
+ SrRS: "sr-RS",
50
+ XXXX: "xx-XX",
51
+ } as const;
52
+ export type MandatoryLanguageQueryParameter = ClosedEnum<
53
+ typeof MandatoryLanguageQueryParameter
54
+ >;
6
55
 
7
- /**
8
- * The language used for fetching the details of a resource. Resources available in different languages may differ from each other. **Important**: When using this API via SDK or MCP, use the parameter name `Dollar_lang`, not `$lang` or `lang`.
9
- */
10
56
  export const MandatoryLanguageQueryParameter$zodSchema = z.enum([
11
57
  "en-US",
12
58
  "fr-FR",
@@ -50,10 +96,4 @@ export const MandatoryLanguageQueryParameter$zodSchema = z.enum([
50
96
  "sl-SI",
51
97
  "sr-RS",
52
98
  "xx-XX",
53
- ]).describe(
54
- "The language used for fetching the details of a resource. Resources available in different languages may differ from each other. **Important**: When using this API via SDK or MCP, use the parameter name `Dollar_lang`, not `$lang` or `lang`.",
55
- );
56
-
57
- export type MandatoryLanguageQueryParameter = z.infer<
58
- typeof MandatoryLanguageQueryParameter$zodSchema
59
- >;
99
+ ]);
@@ -10,7 +10,6 @@ import { MilestoneName, MilestoneName$zodSchema } from "./milestonename.js";
10
10
  */
11
11
  export type Milestone = { name?: MilestoneName | undefined };
12
12
 
13
- export const Milestone$zodSchema: z.ZodType<Milestone, z.ZodTypeDef, unknown> =
14
- z.object({
15
- name: MilestoneName$zodSchema.optional(),
16
- }).describe("A resource's workflow milestone.");
13
+ export const Milestone$zodSchema: z.ZodType<Milestone> = z.object({
14
+ name: MilestoneName$zodSchema.optional(),
15
+ }).describe("A resource's workflow milestone.");
@@ -12,11 +12,7 @@ export type MilestoneName = {
12
12
  displayValue?: string | undefined;
13
13
  };
14
14
 
15
- export const MilestoneName$zodSchema: z.ZodType<
16
- MilestoneName,
17
- z.ZodTypeDef,
18
- unknown
19
- > = z.object({
15
+ export const MilestoneName$zodSchema: z.ZodType<MilestoneName> = z.object({
20
16
  displayValue: z.string().optional(),
21
17
  value: z.string().optional(),
22
18
  }).describe("The identifiers of the milestone.");
@@ -12,11 +12,7 @@ export type ModifiedBy = {
12
12
  lastName?: string | undefined;
13
13
  };
14
14
 
15
- export const ModifiedBy$zodSchema: z.ZodType<
16
- ModifiedBy,
17
- z.ZodTypeDef,
18
- unknown
19
- > = z.object({
15
+ export const ModifiedBy$zodSchema: z.ZodType<ModifiedBy> = z.object({
20
16
  firstName: z.string().optional(),
21
17
  id: z.string().optional(),
22
18
  lastName: z.string().optional(),
@@ -3,10 +3,15 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
7
+
8
+ export const Order = {
9
+ Asc: "asc",
10
+ Desc: "desc",
11
+ } as const;
12
+ export type Order = ClosedEnum<typeof Order>;
6
13
 
7
14
  export const Order$zodSchema = z.enum([
8
15
  "asc",
9
16
  "desc",
10
17
  ]);
11
-
12
- export type Order = z.infer<typeof Order$zodSchema>;
@@ -12,11 +12,10 @@ export type OwnedBy = {
12
12
  lastName?: string | undefined;
13
13
  };
14
14
 
15
- export const OwnedBy$zodSchema: z.ZodType<OwnedBy, z.ZodTypeDef, unknown> = z
16
- .object({
17
- firstName: z.string().optional(),
18
- id: z.string().optional(),
19
- lastName: z.string().optional(),
20
- middleName: z.string().optional(),
21
- userName: z.string().optional(),
22
- });
15
+ export const OwnedBy$zodSchema: z.ZodType<OwnedBy> = z.object({
16
+ firstName: z.string().optional(),
17
+ id: z.string().optional(),
18
+ lastName: z.string().optional(),
19
+ middleName: z.string().optional(),
20
+ userName: z.string().optional(),
21
+ });
@@ -12,13 +12,9 @@ export type PaginationInfo = {
12
12
  link?: Array<Link> | undefined;
13
13
  };
14
14
 
15
- export const PaginationInfo$zodSchema: z.ZodType<
16
- PaginationInfo,
17
- z.ZodTypeDef,
18
- unknown
19
- > = z.object({
20
- count: z.number().int(),
15
+ export const PaginationInfo$zodSchema: z.ZodType<PaginationInfo> = z.object({
16
+ count: z.int(),
21
17
  link: z.array(Link$zodSchema).optional(),
22
- pagenum: z.number().int(),
23
- pagesize: z.number().int(),
18
+ pagenum: z.int(),
19
+ pagesize: z.int(),
24
20
  });
@@ -8,28 +8,19 @@ import { TagCategory, TagCategory$zodSchema } from "./tagcategory.js";
8
8
 
9
9
  export type AccessTags = { tagCategory?: Array<TagCategory> | undefined };
10
10
 
11
- export const AccessTags$zodSchema: z.ZodType<
12
- AccessTags,
13
- z.ZodTypeDef,
14
- unknown
15
- > = z.object({
11
+ export const AccessTags$zodSchema: z.ZodType<AccessTags> = z.object({
16
12
  tagCategory: z.array(TagCategory$zodSchema).optional(),
17
13
  });
18
14
 
19
15
  export type Filters = { tagCategory?: Array<TagCategory> | undefined };
20
16
 
21
- export const Filters$zodSchema: z.ZodType<Filters, z.ZodTypeDef, unknown> = z
22
- .object({
23
- tagCategory: z.array(TagCategory$zodSchema).optional(),
24
- });
17
+ export const Filters$zodSchema: z.ZodType<Filters> = z.object({
18
+ tagCategory: z.array(TagCategory$zodSchema).optional(),
19
+ });
25
20
 
26
21
  export type PublishViews = { publishView?: Array<PublishView> | undefined };
27
22
 
28
- export const PublishViews$zodSchema: z.ZodType<
29
- PublishViews,
30
- z.ZodTypeDef,
31
- unknown
32
- > = z.object({
23
+ export const PublishViews$zodSchema: z.ZodType<PublishViews> = z.object({
33
24
  publishView: z.array(PublishView$zodSchema).optional(),
34
25
  });
35
26
 
@@ -42,11 +33,7 @@ export type Personalization = {
42
33
  publishViews?: PublishViews | undefined;
43
34
  };
44
35
 
45
- export const Personalization$zodSchema: z.ZodType<
46
- Personalization,
47
- z.ZodTypeDef,
48
- unknown
49
- > = z.object({
36
+ export const Personalization$zodSchema: z.ZodType<Personalization> = z.object({
50
37
  accessTags: z.lazy(() => AccessTags$zodSchema).optional(),
51
38
  filters: z.lazy(() => Filters$zodSchema).optional(),
52
39
  publishViews: z.lazy(() => PublishViews$zodSchema).optional(),
@@ -10,9 +10,7 @@ export type PublishViewTagCategory = {
10
10
  };
11
11
 
12
12
  export const PublishViewTagCategory$zodSchema: z.ZodType<
13
- PublishViewTagCategory,
14
- z.ZodTypeDef,
15
- unknown
13
+ PublishViewTagCategory
16
14
  > = z.object({
17
15
  tagCategory: z.array(TagCategory$zodSchema).optional(),
18
16
  });
@@ -23,11 +21,7 @@ export type PublishView = {
23
21
  tagCategories?: Array<PublishViewTagCategory> | undefined;
24
22
  };
25
23
 
26
- export const PublishView$zodSchema: z.ZodType<
27
- PublishView,
28
- z.ZodTypeDef,
29
- unknown
30
- > = z.object({
24
+ export const PublishView$zodSchema: z.ZodType<PublishView> = z.object({
31
25
  id: z.string().optional(),
32
26
  name: z.string().optional(),
33
27
  tagCategories: z.array(z.lazy(() => PublishViewTagCategory$zodSchema))
@@ -3,6 +3,7 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
6
7
  import {
7
8
  AITopicBreadcrumb,
8
9
  AITopicBreadcrumb$zodSchema,
@@ -11,6 +12,19 @@ import {
11
12
  /**
12
13
  * Format of the source document (HTML, DOCX, PPTX, or PDF).
13
14
  */
15
+ export const ReferenceResponseDocType = {
16
+ Html: "HTML",
17
+ Docx: "DOCX",
18
+ Pdf: "PDF",
19
+ Pptx: "PPTX",
20
+ } as const;
21
+ /**
22
+ * Format of the source document (HTML, DOCX, PPTX, or PDF).
23
+ */
24
+ export type ReferenceResponseDocType = ClosedEnum<
25
+ typeof ReferenceResponseDocType
26
+ >;
27
+
14
28
  export const ReferenceResponseDocType$zodSchema = z.enum([
15
29
  "HTML",
16
30
  "DOCX",
@@ -18,22 +32,25 @@ export const ReferenceResponseDocType$zodSchema = z.enum([
18
32
  "PPTX",
19
33
  ]).describe("Format of the source document (HTML, DOCX, PPTX, or PDF).");
20
34
 
21
- export type ReferenceResponseDocType = z.infer<
22
- typeof ReferenceResponseDocType$zodSchema
23
- >;
24
-
25
35
  /**
26
36
  * Source Type
27
37
  */
38
+ export const ReferenceResponseSource = {
39
+ EGainArticle: "eGain Article",
40
+ EGainAttachment: "eGain Attachment",
41
+ } as const;
42
+ /**
43
+ * Source Type
44
+ */
45
+ export type ReferenceResponseSource = ClosedEnum<
46
+ typeof ReferenceResponseSource
47
+ >;
48
+
28
49
  export const ReferenceResponseSource$zodSchema = z.enum([
29
50
  "eGain Article",
30
51
  "eGain Attachment",
31
52
  ]).describe("Source Type");
32
53
 
33
- export type ReferenceResponseSource = z.infer<
34
- typeof ReferenceResponseSource$zodSchema
35
- >;
36
-
37
54
  /**
38
55
  * One document used in generated response
39
56
  */
@@ -46,15 +63,12 @@ export type ReferenceResponse = {
46
63
  topicBreadcrumb?: Array<AITopicBreadcrumb> | undefined;
47
64
  };
48
65
 
49
- export const ReferenceResponse$zodSchema: z.ZodType<
50
- ReferenceResponse,
51
- z.ZodTypeDef,
52
- unknown
53
- > = z.object({
54
- docName: z.string().optional(),
55
- docType: ReferenceResponseDocType$zodSchema,
56
- id: z.string(),
57
- name: z.string(),
58
- source: ReferenceResponseSource$zodSchema,
59
- topicBreadcrumb: z.array(AITopicBreadcrumb$zodSchema).optional(),
60
- }).describe("One document used in generated response");
66
+ export const ReferenceResponse$zodSchema: z.ZodType<ReferenceResponse> = z
67
+ .object({
68
+ docName: z.string().optional(),
69
+ docType: ReferenceResponseDocType$zodSchema,
70
+ id: z.string(),
71
+ name: z.string(),
72
+ source: ReferenceResponseSource$zodSchema,
73
+ topicBreadcrumb: z.array(AITopicBreadcrumb$zodSchema).optional(),
74
+ }).describe("One document used in generated response");
@@ -3,10 +3,49 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
6
7
 
7
8
  /**
8
9
  * The language that describes the details of a resource. Resources available in different languages may differ from each other.
9
10
  */
11
+ export const RequiredLanguageCode = {
12
+ EnUS: "en-US",
13
+ FRFR: "fr-FR",
14
+ EnGB: "en-GB",
15
+ ESES: "es-ES",
16
+ ITIT: "it-IT",
17
+ NLNL: "nl-NL",
18
+ DADA: "da-DA",
19
+ SvSE: "sv-SE",
20
+ PTPT: "pt-PT",
21
+ FIFI: "fi-FI",
22
+ NoNB: "no-NB",
23
+ NoNN: "no-NN",
24
+ JAJA: "ja-JA",
25
+ DEDE: "de-DE",
26
+ PtBR: "pt-BR",
27
+ ZhCN: "zh-CN",
28
+ ZhTW: "zh-TW",
29
+ KOKO: "ko-KO",
30
+ RURU: "ru-RU",
31
+ ELEL: "el-EL",
32
+ TRTR: "tr-TR",
33
+ PLPL: "pl-PL",
34
+ CSCS: "cs-CS",
35
+ SKSK: "sk-SK",
36
+ HUHU: "hu-HU",
37
+ SRSR: "sr-SR",
38
+ ArSA: "ar-SA",
39
+ HRHR: "hr-HR",
40
+ RORO: "ro-RO",
41
+ THTH: "th-TH",
42
+ XXXX: "xx-XX",
43
+ } as const;
44
+ /**
45
+ * The language that describes the details of a resource. Resources available in different languages may differ from each other.
46
+ */
47
+ export type RequiredLanguageCode = ClosedEnum<typeof RequiredLanguageCode>;
48
+
10
49
  export const RequiredLanguageCode$zodSchema = z.enum([
11
50
  "en-US",
12
51
  "fr-FR",
@@ -42,7 +81,3 @@ export const RequiredLanguageCode$zodSchema = z.enum([
42
81
  ]).describe(
43
82
  "The language that describes the details of a resource. Resources available in different languages may differ from each other.",
44
83
  );
45
-
46
- export type RequiredLanguageCode = z.infer<
47
- typeof RequiredLanguageCode$zodSchema
48
- >;
@@ -11,10 +11,6 @@ import {
11
11
  RetrieveRequest,
12
12
  RetrieveRequest$zodSchema,
13
13
  } from "./retrieverequest.js";
14
- import {
15
- RetrieveResponse,
16
- RetrieveResponse$zodSchema,
17
- } from "./retrieveresponse.js";
18
14
 
19
15
  export type RetrieveChunksRequest = {
20
16
  q: string;
@@ -26,47 +22,19 @@ export type RetrieveChunksRequest = {
26
22
  RetrieveRequest?: RetrieveRequest | undefined;
27
23
  };
28
24
 
29
- export const RetrieveChunksRequest$zodSchema: z.ZodType<
30
- RetrieveChunksRequest,
31
- z.ZodTypeDef,
32
- unknown
33
- > = z.object({
34
- Dollar_lang: RequiredLanguageCode$zodSchema,
35
- RetrieveRequest: RetrieveRequest$zodSchema.optional(),
36
- dollarFilterTags: z.record(z.array(z.string())).describe(
37
- "An object where each key is a **Category Tag ID** (numeric string), \n"
38
- + "and each value is an array of **Tag IDs** for that category.\n"
39
- + " **Note**:\n"
40
- + " - The '$filter[tags]' query parameter JSON value should be url encoded.\n"
41
- + " - Some developer tools for invoking APIs may not url encode the '$filter[tags]' query parameter JSON value by default. Ensure that only url encoded values are used.\n"
42
- + " - Example of JSON value: {\"BASE-40845\":[\"BASE-40849\",\"BASE-40853\"]}\n"
43
- + " - Example of URL encoded value: %7B%22BASE-40845%22%3A%5B%22BASE-40849%22%2C%22BASE-40853%22%5D%7D\n"
44
- + "",
45
- ).optional(),
46
- dollarFilterTopicIds: z.array(z.string()).describe(
47
- "An array of topic IDs. It is used to restrict search results to specific topics.",
48
- ).optional(),
49
- dollarFilterUserProfileID: z.string().optional(),
50
- portalID: z.string().describe(
51
- "The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.",
52
- ),
53
- q: z.string().describe("The search query string."),
54
- });
55
-
56
- export type RetrieveChunksResponse = {
57
- ContentType: string;
58
- StatusCode: number;
59
- RawResponse: Response;
60
- RetrieveResponse?: RetrieveResponse | undefined;
61
- };
62
-
63
- export const RetrieveChunksResponse$zodSchema: z.ZodType<
64
- RetrieveChunksResponse,
65
- z.ZodTypeDef,
66
- unknown
67
- > = z.object({
68
- ContentType: z.string(),
69
- RawResponse: z.instanceof(Response),
70
- RetrieveResponse: RetrieveResponse$zodSchema.optional(),
71
- StatusCode: z.number().int(),
72
- });
25
+ export const RetrieveChunksRequest$zodSchema: z.ZodType<RetrieveChunksRequest> =
26
+ z.object({
27
+ Dollar_lang: RequiredLanguageCode$zodSchema,
28
+ RetrieveRequest: RetrieveRequest$zodSchema.optional(),
29
+ dollarFilterTags: z.record(z.string(), z.array(z.string())).describe(
30
+ "An object where each key is a **Category Tag ID** (numeric string), \nand each value is an array of **Tag IDs** for that category.\n **Note**:\n - The '$filter[tags]' query parameter JSON value should be url encoded.\n - Some developer tools for invoking APIs may not url encode the '$filter[tags]' query parameter JSON value by default. Ensure that only url encoded values are used.\n - Example of JSON value: {\"BASE-40845\":[\"BASE-40849\",\"BASE-40853\"]}\n - Example of URL encoded value: %7B%22BASE-40845%22%3A%5B%22BASE-40849%22%2C%22BASE-40853%22%5D%7D\n",
31
+ ).optional(),
32
+ dollarFilterTopicIds: z.array(z.string()).describe(
33
+ "An array of topic IDs. It is used to restrict search results to specific topics.",
34
+ ).optional(),
35
+ dollarFilterUserProfileID: z.string().optional(),
36
+ portalID: z.string().describe(
37
+ "The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.",
38
+ ),
39
+ q: z.string().describe("The search query string."),
40
+ });
@@ -3,10 +3,20 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
6
7
 
7
8
  /**
8
9
  * The channel where the query originated, e.g., directly from the portal or via a custom integration.
9
10
  */
11
+ export const RetrieveRequestType = {
12
+ Portal: "portal",
13
+ Custom: "custom",
14
+ } as const;
15
+ /**
16
+ * The channel where the query originated, e.g., directly from the portal or via a custom integration.
17
+ */
18
+ export type RetrieveRequestType = ClosedEnum<typeof RetrieveRequestType>;
19
+
10
20
  export const RetrieveRequestType$zodSchema = z.enum([
11
21
  "portal",
12
22
  "custom",
@@ -14,17 +24,13 @@ export const RetrieveRequestType$zodSchema = z.enum([
14
24
  "The channel where the query originated, e.g., directly from the portal or via a custom integration.",
15
25
  );
16
26
 
17
- export type RetrieveRequestType = z.infer<typeof RetrieveRequestType$zodSchema>;
18
-
19
27
  export type RetrieveRequestChannel = {
20
28
  type?: RetrieveRequestType | undefined;
21
29
  name?: string | undefined;
22
30
  };
23
31
 
24
32
  export const RetrieveRequestChannel$zodSchema: z.ZodType<
25
- RetrieveRequestChannel,
26
- z.ZodTypeDef,
27
- unknown
33
+ RetrieveRequestChannel
28
34
  > = z.object({
29
35
  name: z.string().optional(),
30
36
  type: RetrieveRequestType$zodSchema.default("custom"),
@@ -37,11 +43,7 @@ export type RetrieveRequest = {
37
43
  sessionId?: string | undefined;
38
44
  };
39
45
 
40
- export const RetrieveRequest$zodSchema: z.ZodType<
41
- RetrieveRequest,
42
- z.ZodTypeDef,
43
- unknown
44
- > = z.object({
46
+ export const RetrieveRequest$zodSchema: z.ZodType<RetrieveRequest> = z.object({
45
47
  channel: z.lazy(() => RetrieveRequestChannel$zodSchema).optional(),
46
48
  clientSessionId: z.string().optional(),
47
49
  eventId: z.string().optional(),