mavenagi 1.1.0 → 1.2.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 (895) hide show
  1. package/Client.d.ts +6 -0
  2. package/Client.js +28 -18
  3. package/README.md +8 -8
  4. package/api/resources/actions/client/Client.d.ts +34 -1
  5. package/api/resources/actions/client/Client.js +199 -4
  6. package/api/resources/actions/client/index.d.ts +1 -0
  7. package/api/resources/actions/client/index.js +15 -0
  8. package/api/resources/actions/client/requests/ActionGetRequest.d.ts +13 -0
  9. package/api/resources/actions/client/requests/index.d.ts +1 -0
  10. package/api/resources/actions/client/requests/index.js +2 -0
  11. package/api/resources/actions/types/ActionField.d.ts +11 -0
  12. package/api/resources/actions/types/ActionField.js +13 -0
  13. package/api/resources/actions/types/ActionFilter.d.ts +14 -0
  14. package/api/resources/actions/types/ActionPatchRequest.d.ts +12 -0
  15. package/api/resources/actions/types/ActionsResponse.d.ts +8 -0
  16. package/api/resources/actions/types/ActionsSearchRequest.d.ts +8 -0
  17. package/api/resources/actions/types/index.d.ts +5 -0
  18. package/api/resources/actions/types/index.js +5 -0
  19. package/api/resources/agents/client/Client.d.ts +66 -0
  20. package/api/resources/agents/client/Client.js +289 -0
  21. package/api/resources/agents/types/Agent.d.ts +10 -0
  22. package/api/resources/agents/types/AgentPatchRequest.d.ts +12 -0
  23. package/api/resources/agents/types/CreateAgentRequest.d.ts +10 -0
  24. package/api/resources/agents/types/PiiCategory.d.ts +63 -0
  25. package/api/resources/agents/types/PiiCategory.js +65 -0
  26. package/api/resources/agents/types/index.d.ts +3 -0
  27. package/api/resources/agents/types/index.js +3 -0
  28. package/api/resources/assets/client/Client.d.ts +76 -0
  29. package/api/resources/assets/client/Client.js +257 -0
  30. package/api/resources/assets/client/index.d.ts +1 -0
  31. package/api/resources/assets/client/index.js +2 -0
  32. package/api/resources/assets/index.d.ts +2 -0
  33. package/api/resources/assets/index.js +18 -0
  34. package/api/resources/assets/types/CommitAssetUploadRequest.d.ts +7 -0
  35. package/api/resources/assets/types/InitiateAssetUploadRequest.d.ts +6 -0
  36. package/api/resources/assets/types/InitiateAssetUploadResponse.d.ts +12 -0
  37. package/api/resources/assets/types/index.d.ts +3 -0
  38. package/api/resources/assets/types/index.js +19 -0
  39. package/api/resources/commons/types/ActionResponse.d.ts +27 -1
  40. package/api/resources/commons/types/AttachmentRequest.d.ts +22 -0
  41. package/api/resources/commons/types/AttachmentResponse.d.ts +12 -0
  42. package/api/resources/commons/types/AttachmentStatus.d.ts +10 -0
  43. package/api/resources/commons/types/AttachmentStatus.js +12 -0
  44. package/api/resources/commons/types/BaseAttachment.d.ts +32 -0
  45. package/api/resources/commons/types/BaseConversationResponse.d.ts +11 -0
  46. package/api/resources/commons/types/BotLogic.d.ts +7 -0
  47. package/api/resources/commons/types/BotLogicActionExecutedDetail.d.ts +9 -0
  48. package/api/resources/commons/types/BotLogicActionItem.d.ts +8 -0
  49. package/api/resources/commons/types/BotLogicActionReviewedDetail.d.ts +8 -0
  50. package/api/resources/commons/types/BotLogicActionReviewedDetail.js +5 -0
  51. package/api/resources/commons/types/BotLogicFormSubmissionItem.d.ts +6 -0
  52. package/api/resources/commons/types/BotLogicFormSubmissionItem.js +5 -0
  53. package/api/resources/commons/types/BotLogicItem.d.ts +25 -0
  54. package/api/resources/commons/types/BotLogicItem.js +5 -0
  55. package/api/resources/commons/types/{KnowledgeBaseInformation.d.ts → BotLogicKnowledgeDetail.d.ts} +4 -2
  56. package/api/resources/commons/types/BotLogicKnowledgeDetail.js +5 -0
  57. package/api/resources/commons/types/BotLogicKnowledgeItem.d.ts +8 -0
  58. package/api/resources/commons/types/BotLogicKnowledgeItem.js +5 -0
  59. package/api/resources/commons/types/BotLogicSafetyItem.d.ts +6 -0
  60. package/api/resources/commons/types/BotLogicSafetyItem.js +5 -0
  61. package/api/resources/commons/types/BotLogicSegmentsItem.d.ts +7 -0
  62. package/api/resources/commons/types/BotLogicSegmentsItem.js +5 -0
  63. package/api/resources/commons/types/BotLogicUserItem.d.ts +6 -0
  64. package/api/resources/commons/types/BotLogicUserItem.js +5 -0
  65. package/api/resources/commons/types/BotMessage.d.ts +3 -1
  66. package/api/resources/commons/types/Capability.d.ts +2 -1
  67. package/api/resources/commons/types/Capability.js +1 -0
  68. package/api/resources/commons/types/ConversationResponse.d.ts +14 -2
  69. package/api/resources/commons/types/DocumentInformation.d.ts +2 -0
  70. package/api/resources/commons/types/EntityType.d.ts +2 -1
  71. package/api/resources/commons/types/EntityType.js +1 -0
  72. package/api/resources/commons/types/InboxItem.d.ts +1 -7
  73. package/api/resources/commons/types/InboxItemBase.d.ts +2 -0
  74. package/api/resources/commons/types/InboxItemDuplicateDocuments.d.ts +1 -1
  75. package/api/resources/commons/types/InboxItemFix.d.ts +1 -4
  76. package/api/resources/commons/types/InboxItemSeverity.d.ts +9 -0
  77. package/api/resources/commons/types/InboxItemSeverity.js +11 -0
  78. package/api/resources/commons/types/InboxItemType.d.ts +1 -9
  79. package/api/resources/commons/types/InboxItemType.js +0 -2
  80. package/api/resources/commons/types/LlmInclusionStatus.d.ts +9 -0
  81. package/api/resources/commons/types/LlmInclusionStatus.js +11 -0
  82. package/api/resources/commons/types/{BotMessageStatus.d.ts → MessageStatus.d.ts} +3 -3
  83. package/{dist/api/resources/commons/types/BotMessageStatus.js → api/resources/commons/types/MessageStatus.js} +2 -2
  84. package/api/resources/commons/types/ResponseConfig.d.ts +6 -8
  85. package/api/resources/commons/types/UserMessage.d.ts +21 -1
  86. package/api/resources/commons/types/UserMessageResponseState.d.ts +9 -0
  87. package/api/resources/commons/types/UserMessageResponseState.js +11 -0
  88. package/api/resources/commons/types/index.d.ts +19 -7
  89. package/api/resources/commons/types/index.js +19 -7
  90. package/api/resources/conversation/client/Client.d.ts +75 -0
  91. package/api/resources/conversation/client/Client.js +320 -0
  92. package/api/resources/conversation/types/AskObjectRequest.d.ts +8 -0
  93. package/api/resources/conversation/types/AskObjectRequest.js +5 -0
  94. package/api/resources/conversation/types/AskRequest.d.ts +5 -2
  95. package/api/resources/conversation/types/ConversationField.d.ts +5 -1
  96. package/api/resources/conversation/types/ConversationField.js +4 -0
  97. package/api/resources/conversation/types/ConversationFilter.d.ts +23 -1
  98. package/api/resources/conversation/types/ConversationMessageRequest.d.ts +1 -1
  99. package/api/resources/conversation/types/ConversationPatchRequest.d.ts +20 -0
  100. package/api/resources/conversation/types/ConversationPatchRequest.js +5 -0
  101. package/api/resources/conversation/types/DeliverConversationMessageRequest.d.ts +10 -0
  102. package/api/resources/conversation/types/DeliverConversationMessageRequest.js +5 -0
  103. package/api/resources/conversation/types/DeliverMessageRequest.d.ts +13 -0
  104. package/api/resources/conversation/types/DeliverMessageRequest.js +5 -0
  105. package/api/resources/conversation/types/DeliverMessageResponse.d.ts +7 -0
  106. package/api/resources/conversation/types/DeliverMessageResponse.js +5 -0
  107. package/api/resources/conversation/types/DeliverUserMessageRequest.d.ts +10 -0
  108. package/api/resources/conversation/types/DeliverUserMessageRequest.js +5 -0
  109. package/api/resources/conversation/types/DeliveryStatus.d.ts +9 -0
  110. package/api/resources/{commons/types/InboxItemFixType.js → conversation/types/DeliveryStatus.js} +5 -4
  111. package/api/resources/conversation/types/NumericConversationField.d.ts +2 -1
  112. package/api/resources/conversation/types/NumericConversationField.js +1 -0
  113. package/api/resources/conversation/types/ObjectStreamResponse.d.ts +16 -0
  114. package/api/resources/conversation/types/ObjectStreamResponse.js +5 -0
  115. package/api/resources/conversation/types/index.d.ts +8 -1
  116. package/api/resources/conversation/types/index.js +8 -1
  117. package/api/resources/inbox/client/Client.d.ts +10 -13
  118. package/api/resources/inbox/client/Client.js +17 -25
  119. package/api/resources/inbox/client/requests/InboxItemFixRequest.d.ts +1 -7
  120. package/api/resources/inbox/client/requests/InboxItemIgnoreRequest.d.ts +1 -7
  121. package/api/resources/inbox/client/requests/InboxItemRequest.d.ts +1 -7
  122. package/api/resources/inbox/types/AddDocumentFixRequest.d.ts +4 -1
  123. package/api/resources/inbox/types/ApplyFixesRequest.d.ts +12 -0
  124. package/api/resources/inbox/types/ApplyFixesRequest.js +5 -0
  125. package/api/resources/inbox/types/InboxFilter.d.ts +14 -0
  126. package/api/resources/inbox/types/InboxFilter.js +5 -0
  127. package/api/resources/inbox/types/InboxSearchRequest.d.ts +2 -13
  128. package/api/resources/inbox/types/InboxSearchResponse.d.ts +1 -1
  129. package/api/resources/inbox/types/index.d.ts +2 -2
  130. package/api/resources/inbox/types/index.js +2 -2
  131. package/api/resources/index.d.ts +9 -1
  132. package/api/resources/index.js +10 -2
  133. package/api/resources/knowledge/client/Client.d.ts +51 -1
  134. package/api/resources/knowledge/client/Client.js +294 -4
  135. package/api/resources/knowledge/client/index.d.ts +1 -0
  136. package/api/resources/knowledge/client/index.js +15 -0
  137. package/api/resources/knowledge/client/requests/KnowledgeBaseGetRequest.d.ts +13 -0
  138. package/api/resources/knowledge/client/requests/KnowledgeBaseGetRequest.js +5 -0
  139. package/api/resources/knowledge/client/requests/index.d.ts +1 -0
  140. package/api/resources/knowledge/client/requests/index.js +2 -0
  141. package/api/resources/knowledge/types/KnowledgeBaseField.d.ts +8 -0
  142. package/api/resources/knowledge/types/KnowledgeBaseField.js +10 -0
  143. package/api/resources/knowledge/types/KnowledgeBaseFilter.d.ts +26 -0
  144. package/api/resources/knowledge/types/KnowledgeBaseFilter.js +5 -0
  145. package/api/resources/knowledge/types/KnowledgeBasePatchRequest.d.ts +16 -0
  146. package/api/resources/knowledge/types/KnowledgeBasePatchRequest.js +5 -0
  147. package/api/resources/knowledge/types/KnowledgeBaseProperties.d.ts +1 -1
  148. package/api/resources/knowledge/types/KnowledgeBaseRefreshFrequency.d.ts +10 -0
  149. package/api/resources/knowledge/types/KnowledgeBaseRefreshFrequency.js +12 -0
  150. package/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +15 -1
  151. package/api/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +8 -0
  152. package/api/resources/knowledge/types/KnowledgeBaseSearchRequest.js +5 -0
  153. package/api/resources/knowledge/types/KnowledgeBasesResponse.d.ts +8 -0
  154. package/api/resources/knowledge/types/KnowledgeBasesResponse.js +5 -0
  155. package/api/resources/knowledge/types/KnowledgeDocumentField.d.ts +10 -0
  156. package/api/resources/knowledge/types/KnowledgeDocumentField.js +12 -0
  157. package/api/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +26 -0
  158. package/api/resources/knowledge/types/KnowledgeDocumentFilter.js +5 -0
  159. package/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +8 -0
  160. package/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.js +5 -0
  161. package/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +10 -0
  162. package/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +5 -0
  163. package/api/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +8 -0
  164. package/api/resources/knowledge/types/KnowledgeDocumentsResponse.js +5 -0
  165. package/api/resources/knowledge/types/index.d.ts +11 -0
  166. package/api/resources/knowledge/types/index.js +11 -0
  167. package/api/resources/segments/client/Client.d.ts +120 -0
  168. package/api/resources/segments/client/Client.js +468 -0
  169. package/api/resources/segments/client/index.d.ts +2 -0
  170. package/api/resources/segments/client/index.js +17 -0
  171. package/api/resources/segments/client/requests/SegmentGetRequest.d.ts +13 -0
  172. package/api/resources/segments/client/requests/SegmentGetRequest.js +5 -0
  173. package/api/resources/segments/client/requests/index.d.ts +1 -0
  174. package/api/resources/segments/client/requests/index.js +2 -0
  175. package/api/resources/segments/index.d.ts +2 -0
  176. package/api/resources/segments/index.js +18 -0
  177. package/api/resources/segments/types/SegmentBase.d.ts +10 -0
  178. package/api/resources/segments/types/SegmentBase.js +5 -0
  179. package/api/resources/segments/types/SegmentField.d.ts +8 -0
  180. package/api/resources/segments/types/SegmentField.js +10 -0
  181. package/api/resources/segments/types/SegmentPatchRequest.d.ts +14 -0
  182. package/api/resources/segments/types/SegmentPatchRequest.js +5 -0
  183. package/api/resources/segments/types/SegmentRequest.d.ts +28 -0
  184. package/api/resources/segments/types/SegmentRequest.js +5 -0
  185. package/api/resources/segments/types/SegmentResponse.d.ts +39 -0
  186. package/api/resources/segments/types/SegmentResponse.js +5 -0
  187. package/api/resources/segments/types/SegmentStatus.d.ts +8 -0
  188. package/api/resources/segments/types/SegmentStatus.js +10 -0
  189. package/api/resources/segments/types/SegmentsSearchRequest.d.ts +8 -0
  190. package/api/resources/segments/types/SegmentsSearchRequest.js +5 -0
  191. package/api/resources/segments/types/SegmentsSearchResponse.d.ts +7 -0
  192. package/api/resources/segments/types/SegmentsSearchResponse.js +5 -0
  193. package/api/resources/segments/types/index.d.ts +8 -0
  194. package/api/resources/segments/types/index.js +24 -0
  195. package/api/resources/users/client/Client.d.ts +38 -4
  196. package/api/resources/users/client/Client.js +191 -4
  197. package/api/resources/users/client/requests/UserDeleteRequest.d.ts +1 -1
  198. package/api/resources/users/client/requests/UserGetRequest.d.ts +1 -1
  199. package/api/resources/users/index.d.ts +1 -0
  200. package/api/resources/users/index.js +1 -0
  201. package/api/resources/users/types/AgentUser.d.ts +24 -0
  202. package/api/resources/users/types/AgentUser.js +5 -0
  203. package/api/resources/users/types/AgentUserField.d.ts +8 -0
  204. package/api/resources/users/types/AgentUserField.js +10 -0
  205. package/api/resources/users/types/AgentUserFilter.d.ts +12 -0
  206. package/api/resources/users/types/AgentUserFilter.js +5 -0
  207. package/api/resources/users/types/AgentUserSearchRequest.d.ts +8 -0
  208. package/api/resources/users/types/AgentUserSearchRequest.js +5 -0
  209. package/api/resources/users/types/AgentUserSearchResponse.d.ts +8 -0
  210. package/api/resources/users/types/AgentUserSearchResponse.js +5 -0
  211. package/api/resources/users/types/AppUserSummary.d.ts +12 -0
  212. package/api/resources/users/types/AppUserSummary.js +5 -0
  213. package/api/resources/users/types/index.d.ts +6 -0
  214. package/api/resources/users/types/index.js +22 -0
  215. package/dist/Client.d.ts +6 -0
  216. package/dist/Client.js +28 -18
  217. package/dist/api/resources/actions/client/Client.d.ts +34 -1
  218. package/dist/api/resources/actions/client/Client.js +199 -4
  219. package/dist/api/resources/actions/client/index.d.ts +1 -0
  220. package/dist/api/resources/actions/client/index.js +15 -0
  221. package/dist/api/resources/actions/client/requests/ActionGetRequest.d.ts +13 -0
  222. package/dist/api/resources/actions/client/requests/ActionGetRequest.js +5 -0
  223. package/dist/api/resources/actions/client/requests/index.d.ts +1 -0
  224. package/dist/api/resources/actions/client/requests/index.js +2 -0
  225. package/dist/api/resources/actions/types/ActionField.d.ts +11 -0
  226. package/dist/api/resources/actions/types/ActionField.js +13 -0
  227. package/dist/api/resources/actions/types/ActionFilter.d.ts +14 -0
  228. package/dist/api/resources/actions/types/ActionFilter.js +5 -0
  229. package/dist/api/resources/actions/types/ActionPatchRequest.d.ts +12 -0
  230. package/dist/api/resources/actions/types/ActionPatchRequest.js +5 -0
  231. package/dist/api/resources/actions/types/ActionsResponse.d.ts +8 -0
  232. package/dist/api/resources/actions/types/ActionsResponse.js +5 -0
  233. package/dist/api/resources/actions/types/ActionsSearchRequest.d.ts +8 -0
  234. package/dist/api/resources/actions/types/ActionsSearchRequest.js +5 -0
  235. package/dist/api/resources/actions/types/index.d.ts +5 -0
  236. package/dist/api/resources/actions/types/index.js +5 -0
  237. package/dist/api/resources/agents/client/Client.d.ts +66 -0
  238. package/dist/api/resources/agents/client/Client.js +289 -0
  239. package/dist/api/resources/agents/types/Agent.d.ts +10 -0
  240. package/dist/api/resources/agents/types/AgentPatchRequest.d.ts +12 -0
  241. package/dist/api/resources/agents/types/AgentPatchRequest.js +5 -0
  242. package/dist/api/resources/agents/types/CreateAgentRequest.d.ts +10 -0
  243. package/dist/api/resources/agents/types/CreateAgentRequest.js +5 -0
  244. package/dist/api/resources/agents/types/PiiCategory.d.ts +63 -0
  245. package/dist/api/resources/agents/types/PiiCategory.js +65 -0
  246. package/dist/api/resources/agents/types/index.d.ts +3 -0
  247. package/dist/api/resources/agents/types/index.js +3 -0
  248. package/dist/api/resources/assets/client/Client.d.ts +76 -0
  249. package/dist/api/resources/assets/client/Client.js +257 -0
  250. package/dist/api/resources/assets/client/index.d.ts +1 -0
  251. package/dist/api/resources/assets/client/index.js +2 -0
  252. package/dist/api/resources/assets/index.d.ts +2 -0
  253. package/dist/api/resources/assets/index.js +18 -0
  254. package/dist/api/resources/assets/types/CommitAssetUploadRequest.d.ts +7 -0
  255. package/dist/api/resources/assets/types/CommitAssetUploadRequest.js +5 -0
  256. package/dist/api/resources/assets/types/InitiateAssetUploadRequest.d.ts +6 -0
  257. package/dist/api/resources/assets/types/InitiateAssetUploadRequest.js +5 -0
  258. package/dist/api/resources/assets/types/InitiateAssetUploadResponse.d.ts +12 -0
  259. package/dist/api/resources/assets/types/InitiateAssetUploadResponse.js +5 -0
  260. package/dist/api/resources/assets/types/index.d.ts +3 -0
  261. package/dist/api/resources/assets/types/index.js +19 -0
  262. package/dist/api/resources/commons/types/ActionResponse.d.ts +27 -1
  263. package/dist/api/resources/commons/types/AttachmentRequest.d.ts +22 -0
  264. package/dist/api/resources/commons/types/AttachmentRequest.js +5 -0
  265. package/dist/api/resources/commons/types/AttachmentResponse.d.ts +12 -0
  266. package/dist/api/resources/commons/types/AttachmentResponse.js +5 -0
  267. package/dist/api/resources/commons/types/AttachmentStatus.d.ts +10 -0
  268. package/dist/api/resources/commons/types/AttachmentStatus.js +12 -0
  269. package/dist/api/resources/commons/types/BaseAttachment.d.ts +32 -0
  270. package/dist/api/resources/commons/types/BaseAttachment.js +5 -0
  271. package/dist/api/resources/commons/types/BaseConversationResponse.d.ts +11 -0
  272. package/dist/api/resources/commons/types/BotLogic.d.ts +7 -0
  273. package/dist/api/resources/commons/types/BotLogic.js +5 -0
  274. package/dist/api/resources/commons/types/BotLogicActionExecutedDetail.d.ts +9 -0
  275. package/dist/api/resources/commons/types/BotLogicActionExecutedDetail.js +5 -0
  276. package/dist/api/resources/commons/types/BotLogicActionItem.d.ts +8 -0
  277. package/dist/api/resources/commons/types/BotLogicActionItem.js +5 -0
  278. package/dist/api/resources/commons/types/BotLogicActionReviewedDetail.d.ts +8 -0
  279. package/dist/api/resources/commons/types/BotLogicActionReviewedDetail.js +5 -0
  280. package/dist/api/resources/commons/types/BotLogicFormSubmissionItem.d.ts +6 -0
  281. package/dist/api/resources/commons/types/BotLogicFormSubmissionItem.js +5 -0
  282. package/dist/api/resources/commons/types/BotLogicItem.d.ts +25 -0
  283. package/dist/api/resources/commons/types/BotLogicItem.js +5 -0
  284. package/dist/api/resources/commons/types/{KnowledgeBaseInformation.d.ts → BotLogicKnowledgeDetail.d.ts} +4 -2
  285. package/dist/api/resources/commons/types/BotLogicKnowledgeDetail.js +5 -0
  286. package/dist/api/resources/commons/types/BotLogicKnowledgeItem.d.ts +8 -0
  287. package/dist/api/resources/commons/types/BotLogicKnowledgeItem.js +5 -0
  288. package/dist/api/resources/commons/types/BotLogicSafetyItem.d.ts +6 -0
  289. package/dist/api/resources/commons/types/BotLogicSafetyItem.js +5 -0
  290. package/dist/api/resources/commons/types/BotLogicSegmentsItem.d.ts +7 -0
  291. package/dist/api/resources/commons/types/BotLogicSegmentsItem.js +5 -0
  292. package/dist/api/resources/commons/types/BotLogicUserItem.d.ts +6 -0
  293. package/dist/api/resources/commons/types/BotLogicUserItem.js +5 -0
  294. package/dist/api/resources/commons/types/BotMessage.d.ts +3 -1
  295. package/dist/api/resources/commons/types/Capability.d.ts +2 -1
  296. package/dist/api/resources/commons/types/Capability.js +1 -0
  297. package/dist/api/resources/commons/types/ConversationResponse.d.ts +14 -2
  298. package/dist/api/resources/commons/types/DocumentInformation.d.ts +2 -0
  299. package/dist/api/resources/commons/types/EntityType.d.ts +2 -1
  300. package/dist/api/resources/commons/types/EntityType.js +1 -0
  301. package/dist/api/resources/commons/types/InboxItem.d.ts +1 -7
  302. package/dist/api/resources/commons/types/InboxItemBase.d.ts +2 -0
  303. package/dist/api/resources/commons/types/InboxItemDuplicateDocuments.d.ts +1 -1
  304. package/dist/api/resources/commons/types/InboxItemFix.d.ts +1 -4
  305. package/dist/api/resources/commons/types/InboxItemSeverity.d.ts +9 -0
  306. package/dist/api/resources/commons/types/InboxItemSeverity.js +11 -0
  307. package/dist/api/resources/commons/types/InboxItemType.d.ts +1 -9
  308. package/dist/api/resources/commons/types/InboxItemType.js +0 -2
  309. package/dist/api/resources/commons/types/LlmInclusionStatus.d.ts +9 -0
  310. package/dist/api/resources/commons/types/LlmInclusionStatus.js +11 -0
  311. package/dist/api/resources/commons/types/{BotMessageStatus.d.ts → MessageStatus.d.ts} +3 -3
  312. package/{api/resources/commons/types/BotMessageStatus.js → dist/api/resources/commons/types/MessageStatus.js} +2 -2
  313. package/dist/api/resources/commons/types/ResponseConfig.d.ts +6 -8
  314. package/dist/api/resources/commons/types/UserMessage.d.ts +21 -1
  315. package/dist/api/resources/commons/types/UserMessageResponseState.d.ts +9 -0
  316. package/dist/api/resources/commons/types/UserMessageResponseState.js +11 -0
  317. package/dist/api/resources/commons/types/index.d.ts +19 -7
  318. package/dist/api/resources/commons/types/index.js +19 -7
  319. package/dist/api/resources/conversation/client/Client.d.ts +75 -0
  320. package/dist/api/resources/conversation/client/Client.js +320 -0
  321. package/dist/api/resources/conversation/types/AskObjectRequest.d.ts +8 -0
  322. package/dist/api/resources/conversation/types/AskObjectRequest.js +5 -0
  323. package/dist/api/resources/conversation/types/AskRequest.d.ts +5 -2
  324. package/dist/api/resources/conversation/types/ConversationField.d.ts +5 -1
  325. package/dist/api/resources/conversation/types/ConversationField.js +4 -0
  326. package/dist/api/resources/conversation/types/ConversationFilter.d.ts +23 -1
  327. package/dist/api/resources/conversation/types/ConversationMessageRequest.d.ts +1 -1
  328. package/dist/api/resources/conversation/types/ConversationPatchRequest.d.ts +20 -0
  329. package/dist/api/resources/conversation/types/ConversationPatchRequest.js +5 -0
  330. package/dist/api/resources/conversation/types/DeliverConversationMessageRequest.d.ts +10 -0
  331. package/dist/api/resources/conversation/types/DeliverConversationMessageRequest.js +5 -0
  332. package/dist/api/resources/conversation/types/DeliverMessageRequest.d.ts +13 -0
  333. package/dist/api/resources/conversation/types/DeliverMessageRequest.js +5 -0
  334. package/dist/api/resources/conversation/types/DeliverMessageResponse.d.ts +7 -0
  335. package/dist/api/resources/conversation/types/DeliverMessageResponse.js +5 -0
  336. package/dist/api/resources/conversation/types/DeliverUserMessageRequest.d.ts +10 -0
  337. package/dist/api/resources/conversation/types/DeliverUserMessageRequest.js +5 -0
  338. package/dist/api/resources/conversation/types/DeliveryStatus.d.ts +9 -0
  339. package/dist/api/resources/{commons/types/InboxItemFixType.js → conversation/types/DeliveryStatus.js} +5 -4
  340. package/dist/api/resources/conversation/types/NumericConversationField.d.ts +2 -1
  341. package/dist/api/resources/conversation/types/NumericConversationField.js +1 -0
  342. package/dist/api/resources/conversation/types/ObjectStreamResponse.d.ts +16 -0
  343. package/dist/api/resources/conversation/types/ObjectStreamResponse.js +5 -0
  344. package/dist/api/resources/conversation/types/index.d.ts +8 -1
  345. package/dist/api/resources/conversation/types/index.js +8 -1
  346. package/dist/api/resources/inbox/client/Client.d.ts +10 -13
  347. package/dist/api/resources/inbox/client/Client.js +17 -25
  348. package/dist/api/resources/inbox/client/requests/InboxItemFixRequest.d.ts +1 -7
  349. package/dist/api/resources/inbox/client/requests/InboxItemIgnoreRequest.d.ts +1 -7
  350. package/dist/api/resources/inbox/client/requests/InboxItemRequest.d.ts +1 -7
  351. package/dist/api/resources/inbox/types/AddDocumentFixRequest.d.ts +4 -1
  352. package/dist/api/resources/inbox/types/ApplyFixesRequest.d.ts +12 -0
  353. package/dist/api/resources/inbox/types/ApplyFixesRequest.js +5 -0
  354. package/dist/api/resources/inbox/types/InboxFilter.d.ts +14 -0
  355. package/dist/api/resources/inbox/types/InboxFilter.js +5 -0
  356. package/dist/api/resources/inbox/types/InboxSearchRequest.d.ts +2 -13
  357. package/dist/api/resources/inbox/types/InboxSearchResponse.d.ts +1 -1
  358. package/dist/api/resources/inbox/types/index.d.ts +2 -2
  359. package/dist/api/resources/inbox/types/index.js +2 -2
  360. package/dist/api/resources/index.d.ts +9 -1
  361. package/dist/api/resources/index.js +10 -2
  362. package/dist/api/resources/knowledge/client/Client.d.ts +51 -1
  363. package/dist/api/resources/knowledge/client/Client.js +294 -4
  364. package/dist/api/resources/knowledge/client/index.d.ts +1 -0
  365. package/dist/api/resources/knowledge/client/index.js +15 -0
  366. package/dist/api/resources/knowledge/client/requests/KnowledgeBaseGetRequest.d.ts +13 -0
  367. package/dist/api/resources/knowledge/client/requests/KnowledgeBaseGetRequest.js +5 -0
  368. package/dist/api/resources/knowledge/client/requests/index.d.ts +1 -0
  369. package/dist/api/resources/knowledge/client/requests/index.js +2 -0
  370. package/dist/api/resources/knowledge/types/KnowledgeBaseField.d.ts +8 -0
  371. package/dist/api/resources/knowledge/types/KnowledgeBaseField.js +10 -0
  372. package/dist/api/resources/knowledge/types/KnowledgeBaseFilter.d.ts +26 -0
  373. package/dist/api/resources/knowledge/types/KnowledgeBaseFilter.js +5 -0
  374. package/dist/api/resources/knowledge/types/KnowledgeBasePatchRequest.d.ts +16 -0
  375. package/dist/api/resources/knowledge/types/KnowledgeBasePatchRequest.js +5 -0
  376. package/dist/api/resources/knowledge/types/KnowledgeBaseProperties.d.ts +1 -1
  377. package/dist/api/resources/knowledge/types/KnowledgeBaseRefreshFrequency.d.ts +10 -0
  378. package/dist/api/resources/knowledge/types/KnowledgeBaseRefreshFrequency.js +12 -0
  379. package/dist/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +15 -1
  380. package/dist/api/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +8 -0
  381. package/dist/api/resources/knowledge/types/KnowledgeBaseSearchRequest.js +5 -0
  382. package/dist/api/resources/knowledge/types/KnowledgeBasesResponse.d.ts +8 -0
  383. package/dist/api/resources/knowledge/types/KnowledgeBasesResponse.js +5 -0
  384. package/dist/api/resources/knowledge/types/KnowledgeDocumentField.d.ts +10 -0
  385. package/dist/api/resources/knowledge/types/KnowledgeDocumentField.js +12 -0
  386. package/dist/api/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +26 -0
  387. package/dist/api/resources/knowledge/types/KnowledgeDocumentFilter.js +5 -0
  388. package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +8 -0
  389. package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.js +5 -0
  390. package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +10 -0
  391. package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +5 -0
  392. package/dist/api/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +8 -0
  393. package/dist/api/resources/knowledge/types/KnowledgeDocumentsResponse.js +5 -0
  394. package/dist/api/resources/knowledge/types/index.d.ts +11 -0
  395. package/dist/api/resources/knowledge/types/index.js +11 -0
  396. package/dist/api/resources/segments/client/Client.d.ts +120 -0
  397. package/dist/api/resources/segments/client/Client.js +468 -0
  398. package/dist/api/resources/segments/client/index.d.ts +2 -0
  399. package/dist/api/resources/segments/client/index.js +17 -0
  400. package/dist/api/resources/segments/client/requests/SegmentGetRequest.d.ts +13 -0
  401. package/dist/api/resources/segments/client/requests/SegmentGetRequest.js +5 -0
  402. package/dist/api/resources/segments/client/requests/index.d.ts +1 -0
  403. package/dist/api/resources/segments/client/requests/index.js +2 -0
  404. package/dist/api/resources/segments/index.d.ts +2 -0
  405. package/dist/api/resources/segments/index.js +18 -0
  406. package/dist/api/resources/segments/types/SegmentBase.d.ts +10 -0
  407. package/dist/api/resources/segments/types/SegmentBase.js +5 -0
  408. package/dist/api/resources/segments/types/SegmentField.d.ts +8 -0
  409. package/dist/api/resources/segments/types/SegmentField.js +10 -0
  410. package/dist/api/resources/segments/types/SegmentPatchRequest.d.ts +14 -0
  411. package/dist/api/resources/segments/types/SegmentPatchRequest.js +5 -0
  412. package/dist/api/resources/segments/types/SegmentRequest.d.ts +28 -0
  413. package/dist/api/resources/segments/types/SegmentRequest.js +5 -0
  414. package/dist/api/resources/segments/types/SegmentResponse.d.ts +39 -0
  415. package/dist/api/resources/segments/types/SegmentResponse.js +5 -0
  416. package/dist/api/resources/segments/types/SegmentStatus.d.ts +8 -0
  417. package/dist/api/resources/segments/types/SegmentStatus.js +10 -0
  418. package/dist/api/resources/segments/types/SegmentsSearchRequest.d.ts +8 -0
  419. package/dist/api/resources/segments/types/SegmentsSearchRequest.js +5 -0
  420. package/dist/api/resources/segments/types/SegmentsSearchResponse.d.ts +7 -0
  421. package/dist/api/resources/segments/types/SegmentsSearchResponse.js +5 -0
  422. package/dist/api/resources/segments/types/index.d.ts +8 -0
  423. package/dist/api/resources/segments/types/index.js +24 -0
  424. package/dist/api/resources/users/client/Client.d.ts +38 -4
  425. package/dist/api/resources/users/client/Client.js +191 -4
  426. package/dist/api/resources/users/client/requests/UserDeleteRequest.d.ts +1 -1
  427. package/dist/api/resources/users/client/requests/UserGetRequest.d.ts +1 -1
  428. package/dist/api/resources/users/index.d.ts +1 -0
  429. package/dist/api/resources/users/index.js +1 -0
  430. package/dist/api/resources/users/types/AgentUser.d.ts +24 -0
  431. package/dist/api/resources/users/types/AgentUser.js +5 -0
  432. package/dist/api/resources/users/types/AgentUserField.d.ts +8 -0
  433. package/dist/api/resources/users/types/AgentUserField.js +10 -0
  434. package/dist/api/resources/users/types/AgentUserFilter.d.ts +12 -0
  435. package/dist/api/resources/users/types/AgentUserFilter.js +5 -0
  436. package/dist/api/resources/users/types/AgentUserSearchRequest.d.ts +8 -0
  437. package/dist/api/resources/users/types/AgentUserSearchRequest.js +5 -0
  438. package/dist/api/resources/users/types/AgentUserSearchResponse.d.ts +8 -0
  439. package/dist/api/resources/users/types/AgentUserSearchResponse.js +5 -0
  440. package/dist/api/resources/users/types/AppUserSummary.d.ts +12 -0
  441. package/dist/api/resources/users/types/AppUserSummary.js +5 -0
  442. package/dist/api/resources/users/types/index.d.ts +6 -0
  443. package/dist/api/resources/users/types/index.js +22 -0
  444. package/dist/serialization/resources/actions/types/ActionField.d.ts +10 -0
  445. package/dist/serialization/resources/actions/types/ActionField.js +41 -0
  446. package/dist/serialization/resources/actions/types/ActionFilter.d.ts +16 -0
  447. package/dist/serialization/resources/actions/types/ActionFilter.js +47 -0
  448. package/dist/serialization/resources/actions/types/ActionPatchRequest.d.ts +15 -0
  449. package/dist/serialization/resources/actions/types/ActionPatchRequest.js +46 -0
  450. package/dist/serialization/resources/actions/types/ActionsResponse.d.ts +14 -0
  451. package/dist/serialization/resources/actions/types/ActionsResponse.js +47 -0
  452. package/dist/serialization/resources/actions/types/ActionsSearchRequest.d.ts +16 -0
  453. package/dist/serialization/resources/actions/types/ActionsSearchRequest.js +49 -0
  454. package/dist/serialization/resources/actions/types/index.d.ts +5 -0
  455. package/dist/serialization/resources/actions/types/index.js +5 -0
  456. package/dist/serialization/resources/agents/types/Agent.d.ts +2 -0
  457. package/dist/serialization/resources/agents/types/Agent.js +2 -0
  458. package/dist/serialization/resources/agents/types/AgentPatchRequest.d.ts +16 -0
  459. package/{serialization/resources/commons/types/UserMessageAttachment.js → dist/serialization/resources/agents/types/AgentPatchRequest.js} +6 -4
  460. package/dist/serialization/resources/agents/types/CreateAgentRequest.d.ts +14 -0
  461. package/dist/serialization/resources/{commons/types/UserMessageAttachment.js → agents/types/CreateAgentRequest.js} +5 -5
  462. package/dist/serialization/resources/agents/types/PiiCategory.d.ts +10 -0
  463. package/dist/serialization/resources/agents/types/PiiCategory.js +99 -0
  464. package/dist/serialization/resources/agents/types/index.d.ts +3 -0
  465. package/dist/serialization/resources/agents/types/index.js +3 -0
  466. package/dist/serialization/resources/assets/index.d.ts +1 -0
  467. package/dist/serialization/resources/assets/index.js +17 -0
  468. package/dist/serialization/resources/assets/types/CommitAssetUploadRequest.d.ts +12 -0
  469. package/dist/serialization/resources/assets/types/CommitAssetUploadRequest.js +43 -0
  470. package/dist/serialization/resources/assets/types/InitiateAssetUploadRequest.d.ts +12 -0
  471. package/dist/serialization/resources/assets/types/InitiateAssetUploadRequest.js +42 -0
  472. package/dist/serialization/resources/assets/types/InitiateAssetUploadResponse.d.ts +15 -0
  473. package/dist/serialization/resources/assets/types/InitiateAssetUploadResponse.js +46 -0
  474. package/dist/serialization/resources/assets/types/index.d.ts +3 -0
  475. package/dist/serialization/resources/assets/types/index.js +19 -0
  476. package/dist/serialization/resources/commons/types/ActionResponse.d.ts +6 -0
  477. package/dist/serialization/resources/commons/types/ActionResponse.js +6 -0
  478. package/dist/serialization/resources/commons/types/AttachmentRequest.d.ts +15 -0
  479. package/dist/serialization/resources/commons/types/AttachmentRequest.js +48 -0
  480. package/dist/serialization/resources/commons/types/AttachmentResponse.d.ts +16 -0
  481. package/dist/serialization/resources/commons/types/AttachmentResponse.js +49 -0
  482. package/dist/serialization/resources/commons/types/AttachmentStatus.d.ts +10 -0
  483. package/dist/serialization/resources/commons/types/{BotMessageStatus.js → AttachmentStatus.js} +2 -2
  484. package/{serialization/resources/conversation/types/Attachment.d.ts → dist/serialization/resources/commons/types/BaseAttachment.d.ts} +2 -3
  485. package/{serialization/resources/conversation/types/Attachment.js → dist/serialization/resources/commons/types/BaseAttachment.js} +2 -3
  486. package/dist/serialization/resources/commons/types/BaseConversationResponse.d.ts +2 -0
  487. package/dist/serialization/resources/commons/types/BaseConversationResponse.js +2 -0
  488. package/dist/serialization/resources/commons/types/BotLogic.d.ts +13 -0
  489. package/dist/serialization/resources/commons/types/BotLogic.js +44 -0
  490. package/dist/serialization/resources/commons/types/BotLogicActionExecutedDetail.d.ts +15 -0
  491. package/dist/serialization/resources/commons/types/BotLogicActionExecutedDetail.js +48 -0
  492. package/dist/serialization/resources/commons/types/BotLogicActionItem.d.ts +15 -0
  493. package/dist/serialization/resources/commons/types/BotLogicActionItem.js +46 -0
  494. package/dist/serialization/resources/commons/types/BotLogicActionReviewedDetail.d.ts +14 -0
  495. package/{serialization/resources/commons/types/KnowledgeBaseInformation.js → dist/serialization/resources/commons/types/BotLogicActionReviewedDetail.js} +4 -3
  496. package/dist/serialization/resources/commons/types/BotLogicFormSubmissionItem.d.ts +12 -0
  497. package/dist/serialization/resources/commons/types/BotLogicFormSubmissionItem.js +42 -0
  498. package/dist/serialization/resources/commons/types/BotLogicItem.d.ts +34 -0
  499. package/dist/serialization/resources/commons/types/BotLogicItem.js +59 -0
  500. package/{serialization/resources/commons/types/KnowledgeBaseInformation.d.ts → dist/serialization/resources/commons/types/BotLogicKnowledgeDetail.d.ts} +5 -2
  501. package/dist/serialization/resources/commons/types/BotLogicKnowledgeDetail.js +47 -0
  502. package/dist/serialization/resources/commons/types/BotLogicKnowledgeItem.d.ts +14 -0
  503. package/dist/serialization/resources/commons/types/BotLogicKnowledgeItem.js +45 -0
  504. package/dist/serialization/resources/commons/types/BotLogicSafetyItem.d.ts +12 -0
  505. package/{serialization/resources/commons/types/BotMessageStatus.js → dist/serialization/resources/commons/types/BotLogicSafetyItem.js} +4 -2
  506. package/dist/serialization/resources/commons/types/BotLogicSegmentsItem.d.ts +13 -0
  507. package/dist/serialization/resources/commons/types/BotLogicSegmentsItem.js +44 -0
  508. package/dist/serialization/resources/commons/types/BotLogicUserItem.d.ts +12 -0
  509. package/dist/serialization/resources/commons/types/BotLogicUserItem.js +43 -0
  510. package/dist/serialization/resources/commons/types/BotMessage.d.ts +4 -2
  511. package/dist/serialization/resources/commons/types/BotMessage.js +4 -2
  512. package/dist/serialization/resources/commons/types/Capability.d.ts +1 -1
  513. package/dist/serialization/resources/commons/types/Capability.js +1 -1
  514. package/dist/serialization/resources/commons/types/ConversationResponse.d.ts +2 -0
  515. package/dist/serialization/resources/commons/types/ConversationResponse.js +2 -0
  516. package/dist/serialization/resources/commons/types/DocumentInformation.d.ts +1 -0
  517. package/dist/serialization/resources/commons/types/DocumentInformation.js +1 -0
  518. package/dist/serialization/resources/commons/types/EntityType.d.ts +1 -1
  519. package/dist/serialization/resources/commons/types/EntityType.js +1 -0
  520. package/dist/serialization/resources/commons/types/InboxItem.d.ts +1 -9
  521. package/dist/serialization/resources/commons/types/InboxItem.js +0 -4
  522. package/dist/serialization/resources/commons/types/InboxItemBase.d.ts +2 -0
  523. package/dist/serialization/resources/commons/types/InboxItemBase.js +2 -0
  524. package/dist/serialization/resources/commons/types/InboxItemDuplicateDocuments.d.ts +1 -1
  525. package/dist/serialization/resources/commons/types/InboxItemDuplicateDocuments.js +1 -1
  526. package/dist/serialization/resources/commons/types/InboxItemFix.d.ts +1 -5
  527. package/dist/serialization/resources/commons/types/InboxItemFix.js +0 -2
  528. package/dist/serialization/resources/commons/types/InboxItemSeverity.d.ts +10 -0
  529. package/dist/serialization/resources/commons/types/{InboxItemFixType.js → InboxItemSeverity.js} +2 -2
  530. package/dist/serialization/resources/commons/types/InboxItemType.d.ts +1 -1
  531. package/dist/serialization/resources/commons/types/InboxItemType.js +1 -6
  532. package/dist/serialization/resources/commons/types/LlmInclusionStatus.d.ts +10 -0
  533. package/dist/serialization/resources/commons/types/LlmInclusionStatus.js +41 -0
  534. package/dist/serialization/resources/commons/types/{BotMessageStatus.d.ts → MessageStatus.d.ts} +2 -2
  535. package/dist/serialization/resources/commons/types/MessageStatus.js +41 -0
  536. package/dist/serialization/resources/commons/types/UserMessage.d.ts +7 -2
  537. package/dist/serialization/resources/commons/types/UserMessage.js +7 -2
  538. package/dist/serialization/resources/commons/types/UserMessageResponseState.d.ts +10 -0
  539. package/dist/serialization/resources/commons/types/UserMessageResponseState.js +41 -0
  540. package/dist/serialization/resources/commons/types/index.d.ts +19 -7
  541. package/dist/serialization/resources/commons/types/index.js +19 -7
  542. package/dist/serialization/resources/conversation/types/AskObjectRequest.d.ts +13 -0
  543. package/dist/serialization/resources/conversation/types/AskObjectRequest.js +46 -0
  544. package/dist/serialization/resources/conversation/types/AskRequest.d.ts +2 -2
  545. package/dist/serialization/resources/conversation/types/AskRequest.js +2 -2
  546. package/dist/serialization/resources/conversation/types/ConversationField.d.ts +1 -1
  547. package/dist/serialization/resources/conversation/types/ConversationField.js +4 -0
  548. package/dist/serialization/resources/conversation/types/ConversationFilter.d.ts +1 -0
  549. package/dist/serialization/resources/conversation/types/ConversationFilter.js +1 -0
  550. package/dist/serialization/resources/conversation/types/ConversationMessageRequest.d.ts +2 -2
  551. package/dist/serialization/resources/conversation/types/ConversationMessageRequest.js +2 -2
  552. package/dist/serialization/resources/conversation/types/ConversationPatchRequest.d.ts +16 -0
  553. package/dist/serialization/resources/conversation/types/ConversationPatchRequest.js +47 -0
  554. package/dist/serialization/resources/conversation/types/DeliverConversationMessageRequest.d.ts +15 -0
  555. package/dist/serialization/resources/conversation/types/DeliverConversationMessageRequest.js +46 -0
  556. package/dist/serialization/resources/conversation/types/DeliverMessageRequest.d.ts +18 -0
  557. package/dist/serialization/resources/conversation/types/DeliverMessageRequest.js +51 -0
  558. package/dist/serialization/resources/conversation/types/DeliverMessageResponse.d.ts +13 -0
  559. package/{serialization/resources/inbox/types/BaseInboxSearchRequest.js → dist/serialization/resources/conversation/types/DeliverMessageResponse.js} +4 -4
  560. package/dist/serialization/resources/conversation/types/DeliverUserMessageRequest.d.ts +15 -0
  561. package/dist/serialization/resources/conversation/types/DeliverUserMessageRequest.js +46 -0
  562. package/dist/serialization/resources/conversation/types/DeliveryStatus.d.ts +10 -0
  563. package/{serialization/resources/commons/types/InboxItemFixType.js → dist/serialization/resources/conversation/types/DeliveryStatus.js} +2 -2
  564. package/dist/serialization/resources/conversation/types/NumericConversationField.d.ts +1 -1
  565. package/dist/serialization/resources/conversation/types/NumericConversationField.js +1 -0
  566. package/dist/serialization/resources/conversation/types/ObjectStreamResponse.d.ts +22 -0
  567. package/dist/serialization/resources/conversation/types/ObjectStreamResponse.js +53 -0
  568. package/dist/serialization/resources/conversation/types/index.d.ts +8 -1
  569. package/dist/serialization/resources/conversation/types/index.js +8 -1
  570. package/{serialization/resources/inbox/types/ApplyInboxItemFixRequest.d.ts → dist/serialization/resources/inbox/types/ApplyFixesRequest.d.ts} +3 -4
  571. package/{serialization/resources/inbox/types/ApplyInboxItemFixRequest.js → dist/serialization/resources/inbox/types/ApplyFixesRequest.js} +3 -4
  572. package/dist/serialization/resources/inbox/types/InboxFilter.d.ts +17 -0
  573. package/dist/serialization/resources/inbox/types/InboxFilter.js +48 -0
  574. package/dist/serialization/resources/inbox/types/InboxSearchRequest.d.ts +4 -10
  575. package/dist/serialization/resources/inbox/types/InboxSearchRequest.js +4 -10
  576. package/dist/serialization/resources/inbox/types/InboxSearchResponse.d.ts +1 -1
  577. package/dist/serialization/resources/inbox/types/InboxSearchResponse.js +1 -1
  578. package/dist/serialization/resources/inbox/types/index.d.ts +2 -2
  579. package/dist/serialization/resources/inbox/types/index.js +2 -2
  580. package/dist/serialization/resources/index.d.ts +6 -0
  581. package/dist/serialization/resources/index.js +7 -1
  582. package/dist/serialization/resources/knowledge/types/KnowledgeBaseField.d.ts +10 -0
  583. package/dist/serialization/resources/knowledge/types/KnowledgeBaseField.js +41 -0
  584. package/dist/serialization/resources/knowledge/types/KnowledgeBaseFilter.d.ts +15 -0
  585. package/dist/serialization/resources/knowledge/types/KnowledgeBaseFilter.js +46 -0
  586. package/dist/serialization/resources/knowledge/types/KnowledgeBasePatchRequest.d.ts +18 -0
  587. package/dist/serialization/resources/knowledge/types/KnowledgeBasePatchRequest.js +49 -0
  588. package/dist/serialization/resources/knowledge/types/KnowledgeBaseRefreshFrequency.d.ts +10 -0
  589. package/dist/serialization/resources/knowledge/types/KnowledgeBaseRefreshFrequency.js +41 -0
  590. package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +6 -0
  591. package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +6 -0
  592. package/dist/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +16 -0
  593. package/dist/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.js +49 -0
  594. package/dist/serialization/resources/knowledge/types/KnowledgeBasesResponse.d.ts +14 -0
  595. package/dist/serialization/resources/knowledge/types/KnowledgeBasesResponse.js +47 -0
  596. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentField.d.ts +10 -0
  597. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentField.js +41 -0
  598. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +15 -0
  599. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentFilter.js +46 -0
  600. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +16 -0
  601. package/dist/serialization/resources/{commons/types/InboxItemKnowledgeBaseAlert.js → knowledge/types/KnowledgeDocumentSearchRequest.js} +8 -8
  602. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +15 -0
  603. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +48 -0
  604. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +14 -0
  605. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentsResponse.js +47 -0
  606. package/dist/serialization/resources/knowledge/types/index.d.ts +11 -0
  607. package/dist/serialization/resources/knowledge/types/index.js +11 -0
  608. package/dist/serialization/resources/segments/index.d.ts +1 -0
  609. package/dist/serialization/resources/segments/index.js +17 -0
  610. package/dist/serialization/resources/segments/types/SegmentBase.d.ts +13 -0
  611. package/dist/serialization/resources/segments/types/SegmentBase.js +45 -0
  612. package/dist/serialization/resources/segments/types/SegmentField.d.ts +10 -0
  613. package/dist/serialization/resources/segments/types/SegmentField.js +41 -0
  614. package/dist/serialization/resources/segments/types/SegmentPatchRequest.d.ts +16 -0
  615. package/dist/serialization/resources/segments/types/SegmentPatchRequest.js +48 -0
  616. package/dist/serialization/resources/segments/types/SegmentRequest.d.ts +14 -0
  617. package/dist/serialization/resources/segments/types/SegmentRequest.js +47 -0
  618. package/dist/serialization/resources/segments/types/SegmentResponse.d.ts +16 -0
  619. package/{serialization/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.js → dist/serialization/resources/segments/types/SegmentResponse.js} +8 -6
  620. package/dist/serialization/resources/segments/types/SegmentStatus.d.ts +10 -0
  621. package/dist/serialization/resources/segments/types/SegmentStatus.js +41 -0
  622. package/dist/serialization/resources/segments/types/SegmentsSearchRequest.d.ts +14 -0
  623. package/dist/serialization/resources/segments/types/SegmentsSearchRequest.js +47 -0
  624. package/dist/serialization/resources/segments/types/SegmentsSearchResponse.d.ts +14 -0
  625. package/dist/serialization/resources/segments/types/SegmentsSearchResponse.js +47 -0
  626. package/dist/serialization/resources/segments/types/index.d.ts +8 -0
  627. package/dist/serialization/resources/segments/types/index.js +24 -0
  628. package/dist/serialization/resources/users/index.d.ts +1 -0
  629. package/dist/serialization/resources/users/index.js +17 -0
  630. package/dist/serialization/resources/users/types/AgentUser.d.ts +19 -0
  631. package/dist/serialization/resources/users/types/AgentUser.js +50 -0
  632. package/dist/serialization/resources/users/types/AgentUserField.d.ts +10 -0
  633. package/dist/serialization/resources/users/types/AgentUserField.js +41 -0
  634. package/dist/serialization/resources/users/types/AgentUserFilter.d.ts +13 -0
  635. package/dist/serialization/resources/users/types/AgentUserFilter.js +44 -0
  636. package/dist/serialization/resources/users/types/AgentUserSearchRequest.d.ts +16 -0
  637. package/dist/serialization/resources/users/types/AgentUserSearchRequest.js +49 -0
  638. package/dist/serialization/resources/users/types/AgentUserSearchResponse.d.ts +14 -0
  639. package/dist/serialization/resources/users/types/AgentUserSearchResponse.js +47 -0
  640. package/dist/serialization/resources/users/types/AppUserSummary.d.ts +16 -0
  641. package/dist/serialization/resources/users/types/AppUserSummary.js +47 -0
  642. package/dist/serialization/resources/users/types/index.d.ts +6 -0
  643. package/dist/serialization/resources/users/types/index.js +22 -0
  644. package/dist/version.d.ts +1 -1
  645. package/dist/version.js +1 -1
  646. package/package.json +1 -1
  647. package/reference.md +2127 -747
  648. package/serialization/resources/actions/types/ActionField.d.ts +10 -0
  649. package/serialization/resources/actions/types/ActionField.js +41 -0
  650. package/serialization/resources/actions/types/ActionFilter.d.ts +16 -0
  651. package/serialization/resources/actions/types/ActionFilter.js +47 -0
  652. package/serialization/resources/actions/types/ActionPatchRequest.d.ts +15 -0
  653. package/serialization/resources/actions/types/ActionPatchRequest.js +46 -0
  654. package/serialization/resources/actions/types/ActionsResponse.d.ts +14 -0
  655. package/serialization/resources/actions/types/ActionsResponse.js +47 -0
  656. package/serialization/resources/actions/types/ActionsSearchRequest.d.ts +16 -0
  657. package/serialization/resources/actions/types/ActionsSearchRequest.js +49 -0
  658. package/serialization/resources/actions/types/index.d.ts +5 -0
  659. package/serialization/resources/actions/types/index.js +5 -0
  660. package/serialization/resources/agents/types/Agent.d.ts +2 -0
  661. package/serialization/resources/agents/types/Agent.js +2 -0
  662. package/serialization/resources/agents/types/AgentPatchRequest.d.ts +16 -0
  663. package/serialization/resources/agents/types/AgentPatchRequest.js +47 -0
  664. package/serialization/resources/agents/types/CreateAgentRequest.d.ts +14 -0
  665. package/serialization/resources/agents/types/CreateAgentRequest.js +45 -0
  666. package/serialization/resources/agents/types/PiiCategory.d.ts +10 -0
  667. package/serialization/resources/agents/types/PiiCategory.js +99 -0
  668. package/serialization/resources/agents/types/index.d.ts +3 -0
  669. package/serialization/resources/agents/types/index.js +3 -0
  670. package/serialization/resources/assets/index.d.ts +1 -0
  671. package/serialization/resources/assets/index.js +17 -0
  672. package/serialization/resources/assets/types/CommitAssetUploadRequest.d.ts +12 -0
  673. package/serialization/resources/assets/types/CommitAssetUploadRequest.js +43 -0
  674. package/serialization/resources/assets/types/InitiateAssetUploadRequest.d.ts +12 -0
  675. package/serialization/resources/assets/types/InitiateAssetUploadRequest.js +42 -0
  676. package/serialization/resources/assets/types/InitiateAssetUploadResponse.d.ts +15 -0
  677. package/serialization/resources/assets/types/InitiateAssetUploadResponse.js +46 -0
  678. package/serialization/resources/assets/types/index.d.ts +3 -0
  679. package/serialization/resources/assets/types/index.js +19 -0
  680. package/serialization/resources/commons/types/ActionResponse.d.ts +6 -0
  681. package/serialization/resources/commons/types/ActionResponse.js +6 -0
  682. package/serialization/resources/commons/types/AttachmentRequest.d.ts +15 -0
  683. package/serialization/resources/commons/types/AttachmentRequest.js +48 -0
  684. package/serialization/resources/commons/types/AttachmentResponse.d.ts +16 -0
  685. package/serialization/resources/commons/types/AttachmentResponse.js +49 -0
  686. package/serialization/resources/commons/types/AttachmentStatus.d.ts +10 -0
  687. package/serialization/resources/commons/types/AttachmentStatus.js +41 -0
  688. package/{dist/serialization/resources/conversation/types/Attachment.d.ts → serialization/resources/commons/types/BaseAttachment.d.ts} +2 -3
  689. package/{dist/serialization/resources/conversation/types/Attachment.js → serialization/resources/commons/types/BaseAttachment.js} +2 -3
  690. package/serialization/resources/commons/types/BaseConversationResponse.d.ts +2 -0
  691. package/serialization/resources/commons/types/BaseConversationResponse.js +2 -0
  692. package/serialization/resources/commons/types/BotLogic.d.ts +13 -0
  693. package/serialization/resources/commons/types/BotLogic.js +44 -0
  694. package/serialization/resources/commons/types/BotLogicActionExecutedDetail.d.ts +15 -0
  695. package/serialization/resources/commons/types/BotLogicActionExecutedDetail.js +48 -0
  696. package/serialization/resources/commons/types/BotLogicActionItem.d.ts +15 -0
  697. package/serialization/resources/commons/types/BotLogicActionItem.js +46 -0
  698. package/serialization/resources/commons/types/BotLogicActionReviewedDetail.d.ts +14 -0
  699. package/{dist/serialization/resources/commons/types/KnowledgeBaseInformation.js → serialization/resources/commons/types/BotLogicActionReviewedDetail.js} +4 -3
  700. package/serialization/resources/commons/types/BotLogicFormSubmissionItem.d.ts +12 -0
  701. package/serialization/resources/commons/types/BotLogicFormSubmissionItem.js +42 -0
  702. package/serialization/resources/commons/types/BotLogicItem.d.ts +34 -0
  703. package/serialization/resources/commons/types/BotLogicItem.js +59 -0
  704. package/{dist/serialization/resources/commons/types/KnowledgeBaseInformation.d.ts → serialization/resources/commons/types/BotLogicKnowledgeDetail.d.ts} +5 -2
  705. package/serialization/resources/commons/types/BotLogicKnowledgeDetail.js +47 -0
  706. package/serialization/resources/commons/types/BotLogicKnowledgeItem.d.ts +14 -0
  707. package/serialization/resources/commons/types/BotLogicKnowledgeItem.js +45 -0
  708. package/serialization/resources/commons/types/BotLogicSafetyItem.d.ts +12 -0
  709. package/serialization/resources/commons/types/BotLogicSafetyItem.js +43 -0
  710. package/serialization/resources/commons/types/BotLogicSegmentsItem.d.ts +13 -0
  711. package/serialization/resources/commons/types/BotLogicSegmentsItem.js +44 -0
  712. package/serialization/resources/commons/types/BotLogicUserItem.d.ts +12 -0
  713. package/serialization/resources/commons/types/BotLogicUserItem.js +43 -0
  714. package/serialization/resources/commons/types/BotMessage.d.ts +4 -2
  715. package/serialization/resources/commons/types/BotMessage.js +4 -2
  716. package/serialization/resources/commons/types/Capability.d.ts +1 -1
  717. package/serialization/resources/commons/types/Capability.js +1 -1
  718. package/serialization/resources/commons/types/ConversationResponse.d.ts +2 -0
  719. package/serialization/resources/commons/types/ConversationResponse.js +2 -0
  720. package/serialization/resources/commons/types/DocumentInformation.d.ts +1 -0
  721. package/serialization/resources/commons/types/DocumentInformation.js +1 -0
  722. package/serialization/resources/commons/types/EntityType.d.ts +1 -1
  723. package/serialization/resources/commons/types/EntityType.js +1 -0
  724. package/serialization/resources/commons/types/InboxItem.d.ts +1 -9
  725. package/serialization/resources/commons/types/InboxItem.js +0 -4
  726. package/serialization/resources/commons/types/InboxItemBase.d.ts +2 -0
  727. package/serialization/resources/commons/types/InboxItemBase.js +2 -0
  728. package/serialization/resources/commons/types/InboxItemDuplicateDocuments.d.ts +1 -1
  729. package/serialization/resources/commons/types/InboxItemDuplicateDocuments.js +1 -1
  730. package/serialization/resources/commons/types/InboxItemFix.d.ts +1 -5
  731. package/serialization/resources/commons/types/InboxItemFix.js +0 -2
  732. package/serialization/resources/commons/types/InboxItemSeverity.d.ts +10 -0
  733. package/serialization/resources/commons/types/InboxItemSeverity.js +41 -0
  734. package/serialization/resources/commons/types/InboxItemType.d.ts +1 -1
  735. package/serialization/resources/commons/types/InboxItemType.js +1 -6
  736. package/serialization/resources/commons/types/LlmInclusionStatus.d.ts +10 -0
  737. package/serialization/resources/commons/types/LlmInclusionStatus.js +41 -0
  738. package/serialization/resources/commons/types/{BotMessageStatus.d.ts → MessageStatus.d.ts} +2 -2
  739. package/serialization/resources/commons/types/MessageStatus.js +41 -0
  740. package/serialization/resources/commons/types/UserMessage.d.ts +7 -2
  741. package/serialization/resources/commons/types/UserMessage.js +7 -2
  742. package/serialization/resources/commons/types/UserMessageResponseState.d.ts +10 -0
  743. package/serialization/resources/commons/types/UserMessageResponseState.js +41 -0
  744. package/serialization/resources/commons/types/index.d.ts +19 -7
  745. package/serialization/resources/commons/types/index.js +19 -7
  746. package/serialization/resources/conversation/types/AskObjectRequest.d.ts +13 -0
  747. package/serialization/resources/conversation/types/AskObjectRequest.js +46 -0
  748. package/serialization/resources/conversation/types/AskRequest.d.ts +2 -2
  749. package/serialization/resources/conversation/types/AskRequest.js +2 -2
  750. package/serialization/resources/conversation/types/ConversationField.d.ts +1 -1
  751. package/serialization/resources/conversation/types/ConversationField.js +4 -0
  752. package/serialization/resources/conversation/types/ConversationFilter.d.ts +1 -0
  753. package/serialization/resources/conversation/types/ConversationFilter.js +1 -0
  754. package/serialization/resources/conversation/types/ConversationMessageRequest.d.ts +2 -2
  755. package/serialization/resources/conversation/types/ConversationMessageRequest.js +2 -2
  756. package/serialization/resources/conversation/types/ConversationPatchRequest.d.ts +16 -0
  757. package/serialization/resources/conversation/types/ConversationPatchRequest.js +47 -0
  758. package/serialization/resources/conversation/types/DeliverConversationMessageRequest.d.ts +15 -0
  759. package/serialization/resources/conversation/types/DeliverConversationMessageRequest.js +46 -0
  760. package/serialization/resources/conversation/types/DeliverMessageRequest.d.ts +18 -0
  761. package/serialization/resources/conversation/types/DeliverMessageRequest.js +51 -0
  762. package/serialization/resources/conversation/types/DeliverMessageResponse.d.ts +13 -0
  763. package/{dist/serialization/resources/inbox/types/BaseInboxSearchRequest.js → serialization/resources/conversation/types/DeliverMessageResponse.js} +4 -4
  764. package/serialization/resources/conversation/types/DeliverUserMessageRequest.d.ts +15 -0
  765. package/serialization/resources/conversation/types/DeliverUserMessageRequest.js +46 -0
  766. package/serialization/resources/conversation/types/DeliveryStatus.d.ts +10 -0
  767. package/serialization/resources/conversation/types/DeliveryStatus.js +41 -0
  768. package/serialization/resources/conversation/types/NumericConversationField.d.ts +1 -1
  769. package/serialization/resources/conversation/types/NumericConversationField.js +1 -0
  770. package/serialization/resources/conversation/types/ObjectStreamResponse.d.ts +22 -0
  771. package/serialization/resources/conversation/types/ObjectStreamResponse.js +53 -0
  772. package/serialization/resources/conversation/types/index.d.ts +8 -1
  773. package/serialization/resources/conversation/types/index.js +8 -1
  774. package/{dist/serialization/resources/inbox/types/ApplyInboxItemFixRequest.d.ts → serialization/resources/inbox/types/ApplyFixesRequest.d.ts} +3 -4
  775. package/{dist/serialization/resources/inbox/types/ApplyInboxItemFixRequest.js → serialization/resources/inbox/types/ApplyFixesRequest.js} +3 -4
  776. package/serialization/resources/inbox/types/InboxFilter.d.ts +17 -0
  777. package/serialization/resources/inbox/types/InboxFilter.js +48 -0
  778. package/serialization/resources/inbox/types/InboxSearchRequest.d.ts +4 -10
  779. package/serialization/resources/inbox/types/InboxSearchRequest.js +4 -10
  780. package/serialization/resources/inbox/types/InboxSearchResponse.d.ts +1 -1
  781. package/serialization/resources/inbox/types/InboxSearchResponse.js +1 -1
  782. package/serialization/resources/inbox/types/index.d.ts +2 -2
  783. package/serialization/resources/inbox/types/index.js +2 -2
  784. package/serialization/resources/index.d.ts +6 -0
  785. package/serialization/resources/index.js +7 -1
  786. package/serialization/resources/knowledge/types/KnowledgeBaseField.d.ts +10 -0
  787. package/serialization/resources/knowledge/types/KnowledgeBaseField.js +41 -0
  788. package/serialization/resources/knowledge/types/KnowledgeBaseFilter.d.ts +15 -0
  789. package/serialization/resources/knowledge/types/KnowledgeBaseFilter.js +46 -0
  790. package/serialization/resources/knowledge/types/KnowledgeBasePatchRequest.d.ts +18 -0
  791. package/serialization/resources/knowledge/types/KnowledgeBasePatchRequest.js +49 -0
  792. package/serialization/resources/knowledge/types/KnowledgeBaseRefreshFrequency.d.ts +10 -0
  793. package/serialization/resources/knowledge/types/KnowledgeBaseRefreshFrequency.js +41 -0
  794. package/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +6 -0
  795. package/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +6 -0
  796. package/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +16 -0
  797. package/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.js +49 -0
  798. package/serialization/resources/knowledge/types/KnowledgeBasesResponse.d.ts +14 -0
  799. package/serialization/resources/knowledge/types/KnowledgeBasesResponse.js +47 -0
  800. package/serialization/resources/knowledge/types/KnowledgeDocumentField.d.ts +10 -0
  801. package/serialization/resources/knowledge/types/KnowledgeDocumentField.js +41 -0
  802. package/serialization/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +15 -0
  803. package/serialization/resources/knowledge/types/KnowledgeDocumentFilter.js +46 -0
  804. package/serialization/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +16 -0
  805. package/serialization/resources/{commons/types/InboxItemKnowledgeBaseAlert.js → knowledge/types/KnowledgeDocumentSearchRequest.js} +8 -8
  806. package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +15 -0
  807. package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +48 -0
  808. package/serialization/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +14 -0
  809. package/serialization/resources/knowledge/types/KnowledgeDocumentsResponse.js +47 -0
  810. package/serialization/resources/knowledge/types/index.d.ts +11 -0
  811. package/serialization/resources/knowledge/types/index.js +11 -0
  812. package/serialization/resources/segments/index.d.ts +1 -0
  813. package/serialization/resources/segments/index.js +17 -0
  814. package/serialization/resources/segments/types/SegmentBase.d.ts +13 -0
  815. package/serialization/resources/segments/types/SegmentBase.js +45 -0
  816. package/serialization/resources/segments/types/SegmentField.d.ts +10 -0
  817. package/serialization/resources/segments/types/SegmentField.js +41 -0
  818. package/serialization/resources/segments/types/SegmentPatchRequest.d.ts +16 -0
  819. package/serialization/resources/segments/types/SegmentPatchRequest.js +48 -0
  820. package/serialization/resources/segments/types/SegmentRequest.d.ts +14 -0
  821. package/serialization/resources/segments/types/SegmentRequest.js +47 -0
  822. package/serialization/resources/segments/types/SegmentResponse.d.ts +16 -0
  823. package/{dist/serialization/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.js → serialization/resources/segments/types/SegmentResponse.js} +8 -6
  824. package/serialization/resources/segments/types/SegmentStatus.d.ts +10 -0
  825. package/serialization/resources/segments/types/SegmentStatus.js +41 -0
  826. package/serialization/resources/segments/types/SegmentsSearchRequest.d.ts +14 -0
  827. package/serialization/resources/segments/types/SegmentsSearchRequest.js +47 -0
  828. package/serialization/resources/segments/types/SegmentsSearchResponse.d.ts +14 -0
  829. package/serialization/resources/segments/types/SegmentsSearchResponse.js +47 -0
  830. package/serialization/resources/segments/types/index.d.ts +8 -0
  831. package/serialization/resources/segments/types/index.js +24 -0
  832. package/serialization/resources/users/index.d.ts +1 -0
  833. package/serialization/resources/users/index.js +17 -0
  834. package/serialization/resources/users/types/AgentUser.d.ts +19 -0
  835. package/serialization/resources/users/types/AgentUser.js +50 -0
  836. package/serialization/resources/users/types/AgentUserField.d.ts +10 -0
  837. package/serialization/resources/users/types/AgentUserField.js +41 -0
  838. package/serialization/resources/users/types/AgentUserFilter.d.ts +13 -0
  839. package/serialization/resources/users/types/AgentUserFilter.js +44 -0
  840. package/serialization/resources/users/types/AgentUserSearchRequest.d.ts +16 -0
  841. package/serialization/resources/users/types/AgentUserSearchRequest.js +49 -0
  842. package/serialization/resources/users/types/AgentUserSearchResponse.d.ts +14 -0
  843. package/serialization/resources/users/types/AgentUserSearchResponse.js +47 -0
  844. package/serialization/resources/users/types/AppUserSummary.d.ts +16 -0
  845. package/serialization/resources/users/types/AppUserSummary.js +47 -0
  846. package/serialization/resources/users/types/index.d.ts +6 -0
  847. package/serialization/resources/users/types/index.js +22 -0
  848. package/version.d.ts +1 -1
  849. package/version.js +1 -1
  850. package/api/resources/commons/types/InboxItemDuplicateKnowledgeBase.d.ts +0 -12
  851. package/api/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.d.ts +0 -8
  852. package/api/resources/commons/types/InboxItemFixType.d.ts +0 -14
  853. package/api/resources/commons/types/InboxItemKnowledgeBaseAlert.d.ts +0 -10
  854. package/api/resources/commons/types/UserMessageAttachment.d.ts +0 -23
  855. package/api/resources/conversation/types/Attachment.d.ts +0 -26
  856. package/api/resources/inbox/types/ApplyInboxItemFixRequest.d.ts +0 -11
  857. package/api/resources/inbox/types/BaseInboxSearchRequest.d.ts +0 -9
  858. package/dist/api/resources/commons/types/InboxItemDuplicateKnowledgeBase.d.ts +0 -12
  859. package/dist/api/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.d.ts +0 -8
  860. package/dist/api/resources/commons/types/InboxItemFixType.d.ts +0 -14
  861. package/dist/api/resources/commons/types/InboxItemKnowledgeBaseAlert.d.ts +0 -10
  862. package/dist/api/resources/commons/types/UserMessageAttachment.d.ts +0 -23
  863. package/dist/api/resources/conversation/types/Attachment.d.ts +0 -26
  864. package/dist/api/resources/inbox/types/ApplyInboxItemFixRequest.d.ts +0 -11
  865. package/dist/api/resources/inbox/types/BaseInboxSearchRequest.d.ts +0 -9
  866. package/dist/serialization/resources/commons/types/InboxItemDuplicateKnowledgeBase.d.ts +0 -17
  867. package/dist/serialization/resources/commons/types/InboxItemDuplicateKnowledgeBase.js +0 -50
  868. package/dist/serialization/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.d.ts +0 -14
  869. package/dist/serialization/resources/commons/types/InboxItemFixType.d.ts +0 -10
  870. package/dist/serialization/resources/commons/types/InboxItemKnowledgeBaseAlert.d.ts +0 -16
  871. package/dist/serialization/resources/commons/types/UserMessageAttachment.d.ts +0 -14
  872. package/dist/serialization/resources/inbox/types/BaseInboxSearchRequest.d.ts +0 -13
  873. package/serialization/resources/commons/types/InboxItemDuplicateKnowledgeBase.d.ts +0 -17
  874. package/serialization/resources/commons/types/InboxItemDuplicateKnowledgeBase.js +0 -50
  875. package/serialization/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.d.ts +0 -14
  876. package/serialization/resources/commons/types/InboxItemFixType.d.ts +0 -10
  877. package/serialization/resources/commons/types/InboxItemKnowledgeBaseAlert.d.ts +0 -16
  878. package/serialization/resources/commons/types/UserMessageAttachment.d.ts +0 -14
  879. package/serialization/resources/inbox/types/BaseInboxSearchRequest.d.ts +0 -13
  880. /package/api/resources/{commons/types/InboxItemDuplicateKnowledgeBase.js → actions/client/requests/ActionGetRequest.js} +0 -0
  881. /package/api/resources/{commons/types/InboxItemFixDeactivateKnowledgeBase.js → actions/types/ActionFilter.js} +0 -0
  882. /package/api/resources/{commons/types/InboxItemKnowledgeBaseAlert.js → actions/types/ActionPatchRequest.js} +0 -0
  883. /package/api/resources/{commons/types/KnowledgeBaseInformation.js → actions/types/ActionsResponse.js} +0 -0
  884. /package/api/resources/{commons/types/UserMessageAttachment.js → actions/types/ActionsSearchRequest.js} +0 -0
  885. /package/api/resources/{conversation/types/Attachment.js → agents/types/AgentPatchRequest.js} +0 -0
  886. /package/api/resources/{inbox/types/ApplyInboxItemFixRequest.js → agents/types/CreateAgentRequest.js} +0 -0
  887. /package/api/resources/{inbox/types/BaseInboxSearchRequest.js → assets/types/CommitAssetUploadRequest.js} +0 -0
  888. /package/{dist/api/resources/commons/types/InboxItemDuplicateKnowledgeBase.js → api/resources/assets/types/InitiateAssetUploadRequest.js} +0 -0
  889. /package/{dist/api/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.js → api/resources/assets/types/InitiateAssetUploadResponse.js} +0 -0
  890. /package/{dist/api/resources/commons/types/InboxItemKnowledgeBaseAlert.js → api/resources/commons/types/AttachmentRequest.js} +0 -0
  891. /package/{dist/api/resources/commons/types/KnowledgeBaseInformation.js → api/resources/commons/types/AttachmentResponse.js} +0 -0
  892. /package/{dist/api/resources/commons/types/UserMessageAttachment.js → api/resources/commons/types/BaseAttachment.js} +0 -0
  893. /package/{dist/api/resources/conversation/types/Attachment.js → api/resources/commons/types/BotLogic.js} +0 -0
  894. /package/{dist/api/resources/inbox/types/ApplyInboxItemFixRequest.js → api/resources/commons/types/BotLogicActionExecutedDetail.js} +0 -0
  895. /package/{dist/api/resources/inbox/types/BaseInboxSearchRequest.js → api/resources/commons/types/BotLogicActionItem.js} +0 -0
package/reference.md CHANGED
@@ -2,6 +2,54 @@
2
2
 
3
3
  ## Actions
4
4
 
5
+ <details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">search</a>({ ...params }) -> MavenAGI.ActionsResponse</code></summary>
6
+ <dl>
7
+ <dd>
8
+
9
+ #### 🔌 Usage
10
+
11
+ <dl>
12
+ <dd>
13
+
14
+ <dl>
15
+ <dd>
16
+
17
+ ```typescript
18
+ await client.actions.search({});
19
+ ```
20
+
21
+ </dd>
22
+ </dl>
23
+ </dd>
24
+ </dl>
25
+
26
+ #### ⚙️ Parameters
27
+
28
+ <dl>
29
+ <dd>
30
+
31
+ <dl>
32
+ <dd>
33
+
34
+ **request:** `MavenAGI.ActionsSearchRequest`
35
+
36
+ </dd>
37
+ </dl>
38
+
39
+ <dl>
40
+ <dd>
41
+
42
+ **requestOptions:** `Actions.RequestOptions`
43
+
44
+ </dd>
45
+ </dl>
46
+ </dd>
47
+ </dl>
48
+
49
+ </dd>
50
+ </dl>
51
+ </details>
52
+
5
53
  <details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.ActionResponse</code></summary>
6
54
  <dl>
7
55
  <dd>
@@ -88,7 +136,7 @@ await client.actions.createOrUpdate({
88
136
  </dl>
89
137
  </details>
90
138
 
91
- <details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">get</a>(actionReferenceId) -> MavenAGI.ActionResponse</code></summary>
139
+ <details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">get</a>(actionReferenceId, { ...params }) -> MavenAGI.ActionResponse</code></summary>
92
140
  <dl>
93
141
  <dd>
94
142
 
@@ -140,6 +188,14 @@ await client.actions.get("get-balance");
140
188
  <dl>
141
189
  <dd>
142
190
 
191
+ **request:** `MavenAGI.ActionGetRequest`
192
+
193
+ </dd>
194
+ </dl>
195
+
196
+ <dl>
197
+ <dd>
198
+
143
199
  **requestOptions:** `Actions.RequestOptions`
144
200
 
145
201
  </dd>
@@ -151,7 +207,7 @@ await client.actions.get("get-balance");
151
207
  </dl>
152
208
  </details>
153
209
 
154
- <details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">delete</a>(actionReferenceId) -> void</code></summary>
210
+ <details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">patch</a>(actionReferenceId, { ...params }) -> MavenAGI.ActionResponse</code></summary>
155
211
  <dl>
156
212
  <dd>
157
213
 
@@ -163,7 +219,10 @@ await client.actions.get("get-balance");
163
219
  <dl>
164
220
  <dd>
165
221
 
166
- Delete an action
222
+ Update mutable action fields
223
+
224
+ The `appId` field can be provided to update an action owned by a different app.
225
+ All other fields will overwrite the existing value on the action only if provided.
167
226
 
168
227
  </dd>
169
228
  </dl>
@@ -179,7 +238,7 @@ Delete an action
179
238
  <dd>
180
239
 
181
240
  ```typescript
182
- await client.actions.delete("get-balance");
241
+ await client.actions.patch("actionReferenceId", {});
183
242
  ```
184
243
 
185
244
  </dd>
@@ -195,7 +254,15 @@ await client.actions.delete("get-balance");
195
254
  <dl>
196
255
  <dd>
197
256
 
198
- **actionReferenceId:** `string` — The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
257
+ **actionReferenceId:** `string` — The reference ID of the action to patch.
258
+
259
+ </dd>
260
+ </dl>
261
+
262
+ <dl>
263
+ <dd>
264
+
265
+ **request:** `MavenAGI.ActionPatchRequest`
199
266
 
200
267
  </dd>
201
268
  </dl>
@@ -214,9 +281,7 @@ await client.actions.delete("get-balance");
214
281
  </dl>
215
282
  </details>
216
283
 
217
- ## Agents
218
-
219
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">search</a>({ ...params }) -> MavenAGI.AgentsSearchResponse</code></summary>
284
+ <details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">delete</a>(actionReferenceId) -> void</code></summary>
220
285
  <dl>
221
286
  <dd>
222
287
 
@@ -228,11 +293,8 @@ await client.actions.delete("get-balance");
228
293
  <dl>
229
294
  <dd>
230
295
 
231
- Search for agents across all organizations.
296
+ Delete an action
232
297
 
233
- <Tip>
234
- This endpoint requires additional permissions. Contact support to request access.
235
- </Tip>
236
298
  </dd>
237
299
  </dl>
238
300
  </dd>
@@ -247,7 +309,7 @@ This endpoint requires additional permissions. Contact support to request access
247
309
  <dd>
248
310
 
249
311
  ```typescript
250
- await client.agents.search({});
312
+ await client.actions.delete("get-balance");
251
313
  ```
252
314
 
253
315
  </dd>
@@ -263,7 +325,7 @@ await client.agents.search({});
263
325
  <dl>
264
326
  <dd>
265
327
 
266
- **request:** `MavenAGI.AgentsSearchRequest`
328
+ **actionReferenceId:** `string` — The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
267
329
 
268
330
  </dd>
269
331
  </dl>
@@ -271,7 +333,7 @@ await client.agents.search({});
271
333
  <dl>
272
334
  <dd>
273
335
 
274
- **requestOptions:** `Agents.RequestOptions`
336
+ **requestOptions:** `Actions.RequestOptions`
275
337
 
276
338
  </dd>
277
339
  </dl>
@@ -282,7 +344,9 @@ await client.agents.search({});
282
344
  </dl>
283
345
  </details>
284
346
 
285
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">list</a>(organizationReferenceId) -> MavenAGI.Agent[]</code></summary>
347
+ ## Agents
348
+
349
+ <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">search</a>({ ...params }) -> MavenAGI.AgentsSearchResponse</code></summary>
286
350
  <dl>
287
351
  <dd>
288
352
 
@@ -294,8 +358,11 @@ await client.agents.search({});
294
358
  <dl>
295
359
  <dd>
296
360
 
297
- Lists all agents for an organization
361
+ Search for agents across all organizations.
298
362
 
363
+ <Tip>
364
+ This endpoint requires additional permissions. Contact support to request access.
365
+ </Tip>
299
366
  </dd>
300
367
  </dl>
301
368
  </dd>
@@ -310,7 +377,7 @@ Lists all agents for an organization
310
377
  <dd>
311
378
 
312
379
  ```typescript
313
- await client.agents.list("organizationReferenceId");
380
+ await client.agents.search({});
314
381
  ```
315
382
 
316
383
  </dd>
@@ -326,7 +393,7 @@ await client.agents.list("organizationReferenceId");
326
393
  <dl>
327
394
  <dd>
328
395
 
329
- **organizationReferenceId:** `string` — The ID of the organization.
396
+ **request:** `MavenAGI.AgentsSearchRequest`
330
397
 
331
398
  </dd>
332
399
  </dl>
@@ -345,7 +412,7 @@ await client.agents.list("organizationReferenceId");
345
412
  </dl>
346
413
  </details>
347
414
 
348
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">get</a>(organizationReferenceId, agentReferenceId) -> MavenAGI.Agent</code></summary>
415
+ <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">list</a>(organizationReferenceId) -> MavenAGI.Agent[]</code></summary>
349
416
  <dl>
350
417
  <dd>
351
418
 
@@ -357,7 +424,7 @@ await client.agents.list("organizationReferenceId");
357
424
  <dl>
358
425
  <dd>
359
426
 
360
- Get an agent
427
+ Lists all agents for an organization
361
428
 
362
429
  </dd>
363
430
  </dl>
@@ -373,7 +440,7 @@ Get an agent
373
440
  <dd>
374
441
 
375
442
  ```typescript
376
- await client.agents.get("organizationReferenceId", "agentReferenceId");
443
+ await client.agents.list("organizationReferenceId");
377
444
  ```
378
445
 
379
446
  </dd>
@@ -397,14 +464,6 @@ await client.agents.get("organizationReferenceId", "agentReferenceId");
397
464
  <dl>
398
465
  <dd>
399
466
 
400
- **agentReferenceId:** `string` — The ID of the agent.
401
-
402
- </dd>
403
- </dl>
404
-
405
- <dl>
406
- <dd>
407
-
408
467
  **requestOptions:** `Agents.RequestOptions`
409
468
 
410
469
  </dd>
@@ -416,9 +475,7 @@ await client.agents.get("organizationReferenceId", "agentReferenceId");
416
475
  </dl>
417
476
  </details>
418
477
 
419
- ## Analytics
420
-
421
- <details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
478
+ <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">create</a>(organizationReferenceId, agentReferenceId, { ...params }) -> MavenAGI.Agent</code></summary>
422
479
  <dl>
423
480
  <dd>
424
481
 
@@ -430,8 +487,11 @@ await client.agents.get("organizationReferenceId", "agentReferenceId");
430
487
  <dl>
431
488
  <dd>
432
489
 
433
- Retrieves structured conversation data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
490
+ Create a new agent
434
491
 
492
+ <Tip>
493
+ This endpoint requires additional permissions. Contact support to request access.
494
+ </Tip>
435
495
  </dd>
436
496
  </dl>
437
497
  </dd>
@@ -446,39 +506,9 @@ Retrieves structured conversation data formatted as a table, allowing users to g
446
506
  <dd>
447
507
 
448
508
  ```typescript
449
- await client.analytics.getConversationTable({
450
- conversationFilter: {
451
- languages: ["en", "es"],
452
- },
453
- timeGrouping: "DAY",
454
- fieldGroupings: [
455
- {
456
- field: "Category",
457
- },
458
- ],
459
- columnDefinitions: [
460
- {
461
- header: "count",
462
- metric: {
463
- type: "count",
464
- },
465
- },
466
- {
467
- header: "avg_first_response_time",
468
- metric: {
469
- type: "average",
470
- targetField: "FirstResponseTime",
471
- },
472
- },
473
- {
474
- header: "percentile_handle_time",
475
- metric: {
476
- type: "percentile",
477
- targetField: "HandleTime",
478
- percentile: 25,
479
- },
480
- },
481
- ],
509
+ await client.agents.create("organizationReferenceId", "agentReferenceId", {
510
+ name: "name",
511
+ environment: "DEMO",
482
512
  });
483
513
  ```
484
514
 
@@ -495,7 +525,7 @@ await client.analytics.getConversationTable({
495
525
  <dl>
496
526
  <dd>
497
527
 
498
- **request:** `MavenAGI.ConversationTableRequest`
528
+ **organizationReferenceId:** `string` — The ID of the organization.
499
529
 
500
530
  </dd>
501
531
  </dl>
@@ -503,7 +533,23 @@ await client.analytics.getConversationTable({
503
533
  <dl>
504
534
  <dd>
505
535
 
506
- **requestOptions:** `Analytics.RequestOptions`
536
+ **agentReferenceId:** `string` — The ID of the agent.
537
+
538
+ </dd>
539
+ </dl>
540
+
541
+ <dl>
542
+ <dd>
543
+
544
+ **request:** `MavenAGI.CreateAgentRequest`
545
+
546
+ </dd>
547
+ </dl>
548
+
549
+ <dl>
550
+ <dd>
551
+
552
+ **requestOptions:** `Agents.RequestOptions`
507
553
 
508
554
  </dd>
509
555
  </dl>
@@ -514,7 +560,7 @@ await client.analytics.getConversationTable({
514
560
  </dl>
515
561
  </details>
516
562
 
517
- <details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationChart</a>({ ...params }) -> MavenAGI.ChartResponse</code></summary>
563
+ <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">get</a>(organizationReferenceId, agentReferenceId) -> MavenAGI.Agent</code></summary>
518
564
  <dl>
519
565
  <dd>
520
566
 
@@ -526,7 +572,7 @@ await client.analytics.getConversationTable({
526
572
  <dl>
527
573
  <dd>
528
574
 
529
- Fetches conversation data visualized in a chart format. Supported chart types include pie chart, date histogram, and stacked bar charts.
575
+ Get an agent
530
576
 
531
577
  </dd>
532
578
  </dl>
@@ -542,18 +588,7 @@ Fetches conversation data visualized in a chart format. Supported chart types in
542
588
  <dd>
543
589
 
544
590
  ```typescript
545
- await client.analytics.getConversationChart({
546
- type: "pieChart",
547
- conversationFilter: {
548
- languages: ["en", "es"],
549
- },
550
- groupBy: {
551
- field: "Category",
552
- },
553
- metric: {
554
- type: "count",
555
- },
556
- });
591
+ await client.agents.get("organizationReferenceId", "agentReferenceId");
557
592
  ```
558
593
 
559
594
  </dd>
@@ -569,7 +604,7 @@ await client.analytics.getConversationChart({
569
604
  <dl>
570
605
  <dd>
571
606
 
572
- **request:** `MavenAGI.ConversationChartRequest`
607
+ **organizationReferenceId:** `string` — The ID of the organization.
573
608
 
574
609
  </dd>
575
610
  </dl>
@@ -577,7 +612,15 @@ await client.analytics.getConversationChart({
577
612
  <dl>
578
613
  <dd>
579
614
 
580
- **requestOptions:** `Analytics.RequestOptions`
615
+ **agentReferenceId:** `string` — The ID of the agent.
616
+
617
+ </dd>
618
+ </dl>
619
+
620
+ <dl>
621
+ <dd>
622
+
623
+ **requestOptions:** `Agents.RequestOptions`
581
624
 
582
625
  </dd>
583
626
  </dl>
@@ -588,7 +631,7 @@ await client.analytics.getConversationChart({
588
631
  </dl>
589
632
  </details>
590
633
 
591
- <details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getFeedbackTable</a>({ ...params }) -> MavenAGI.FeedbackTableResponse</code></summary>
634
+ <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">patch</a>(organizationReferenceId, agentReferenceId, { ...params }) -> MavenAGI.Agent</code></summary>
592
635
  <dl>
593
636
  <dd>
594
637
 
@@ -600,8 +643,12 @@ await client.analytics.getConversationChart({
600
643
  <dl>
601
644
  <dd>
602
645
 
603
- Retrieves structured feedback data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
646
+ Update mutable agent fields
647
+ All fields will overwrite the existing value on the agent only if provided.
604
648
 
649
+ <Tip>
650
+ This endpoint requires additional permissions. Contact support to request access.
651
+ </Tip>
605
652
  </dd>
606
653
  </dl>
607
654
  </dd>
@@ -616,24 +663,7 @@ Retrieves structured feedback data formatted as a table, allowing users to group
616
663
  <dd>
617
664
 
618
665
  ```typescript
619
- await client.analytics.getFeedbackTable({
620
- feedbackFilter: {
621
- types: ["THUMBS_UP", "INSERT"],
622
- },
623
- fieldGroupings: [
624
- {
625
- field: "CreatedBy",
626
- },
627
- ],
628
- columnDefinitions: [
629
- {
630
- header: "feedback_count",
631
- metric: {
632
- type: "count",
633
- },
634
- },
635
- ],
636
- });
666
+ await client.agents.patch("organizationReferenceId", "agentReferenceId", {});
637
667
  ```
638
668
 
639
669
  </dd>
@@ -649,7 +679,7 @@ await client.analytics.getFeedbackTable({
649
679
  <dl>
650
680
  <dd>
651
681
 
652
- **request:** `MavenAGI.FeedbackTableRequest`
682
+ **organizationReferenceId:** `string` — The ID of the organization.
653
683
 
654
684
  </dd>
655
685
  </dl>
@@ -657,7 +687,23 @@ await client.analytics.getFeedbackTable({
657
687
  <dl>
658
688
  <dd>
659
689
 
660
- **requestOptions:** `Analytics.RequestOptions`
690
+ **agentReferenceId:** `string` — The ID of the agent.
691
+
692
+ </dd>
693
+ </dl>
694
+
695
+ <dl>
696
+ <dd>
697
+
698
+ **request:** `MavenAGI.AgentPatchRequest`
699
+
700
+ </dd>
701
+ </dl>
702
+
703
+ <dl>
704
+ <dd>
705
+
706
+ **requestOptions:** `Agents.RequestOptions`
661
707
 
662
708
  </dd>
663
709
  </dl>
@@ -668,9 +714,7 @@ await client.analytics.getFeedbackTable({
668
714
  </dl>
669
715
  </details>
670
716
 
671
- ## AppSettings
672
-
673
- <details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SearchAppSettingsResponse</code></summary>
717
+ <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">delete</a>(organizationReferenceId, agentReferenceId) -> void</code></summary>
674
718
  <dl>
675
719
  <dd>
676
720
 
@@ -682,12 +726,11 @@ await client.analytics.getFeedbackTable({
682
726
  <dl>
683
727
  <dd>
684
728
 
685
- Search for app settings which have the `$index` key set to the provided value.
686
-
687
- You can set the `$index` key using the Update app settings API.
688
-
689
- <Warning>This API currently requires an organization ID and agent ID for any agent which is installed on the app. This requirement will be removed in a future update.</Warning>
729
+ Delete an agent.
690
730
 
731
+ <Tip>
732
+ This endpoint requires additional permissions. Contact support to request access.
733
+ </Tip>
691
734
  </dd>
692
735
  </dl>
693
736
  </dd>
@@ -702,9 +745,7 @@ You can set the `$index` key using the Update app settings API.
702
745
  <dd>
703
746
 
704
747
  ```typescript
705
- await client.appSettings.search({
706
- index: "index",
707
- });
748
+ await client.agents.delete("organizationReferenceId", "agentReferenceId");
708
749
  ```
709
750
 
710
751
  </dd>
@@ -720,7 +761,7 @@ await client.appSettings.search({
720
761
  <dl>
721
762
  <dd>
722
763
 
723
- **request:** `MavenAGI.SearchAppSettingsRequest`
764
+ **organizationReferenceId:** `string` — The ID of the organization.
724
765
 
725
766
  </dd>
726
767
  </dl>
@@ -728,10 +769,1230 @@ await client.appSettings.search({
728
769
  <dl>
729
770
  <dd>
730
771
 
731
- **requestOptions:** `AppSettings.RequestOptions`
772
+ **agentReferenceId:** `string` — The ID of the agent.
732
773
 
733
- </dd>
734
- </dl>
774
+ </dd>
775
+ </dl>
776
+
777
+ <dl>
778
+ <dd>
779
+
780
+ **requestOptions:** `Agents.RequestOptions`
781
+
782
+ </dd>
783
+ </dl>
784
+ </dd>
785
+ </dl>
786
+
787
+ </dd>
788
+ </dl>
789
+ </details>
790
+
791
+ ## Analytics
792
+
793
+ <details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
794
+ <dl>
795
+ <dd>
796
+
797
+ #### 📝 Description
798
+
799
+ <dl>
800
+ <dd>
801
+
802
+ <dl>
803
+ <dd>
804
+
805
+ Retrieves structured conversation data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
806
+
807
+ </dd>
808
+ </dl>
809
+ </dd>
810
+ </dl>
811
+
812
+ #### 🔌 Usage
813
+
814
+ <dl>
815
+ <dd>
816
+
817
+ <dl>
818
+ <dd>
819
+
820
+ ```typescript
821
+ await client.analytics.getConversationTable({
822
+ conversationFilter: {
823
+ languages: ["en", "es"],
824
+ },
825
+ timeGrouping: "DAY",
826
+ fieldGroupings: [
827
+ {
828
+ field: "Category",
829
+ },
830
+ ],
831
+ columnDefinitions: [
832
+ {
833
+ header: "count",
834
+ metric: {
835
+ type: "count",
836
+ },
837
+ },
838
+ {
839
+ header: "avg_first_response_time",
840
+ metric: {
841
+ type: "average",
842
+ targetField: "FirstResponseTime",
843
+ },
844
+ },
845
+ {
846
+ header: "percentile_handle_time",
847
+ metric: {
848
+ type: "percentile",
849
+ targetField: "HandleTime",
850
+ percentile: 25,
851
+ },
852
+ },
853
+ ],
854
+ });
855
+ ```
856
+
857
+ </dd>
858
+ </dl>
859
+ </dd>
860
+ </dl>
861
+
862
+ #### ⚙️ Parameters
863
+
864
+ <dl>
865
+ <dd>
866
+
867
+ <dl>
868
+ <dd>
869
+
870
+ **request:** `MavenAGI.ConversationTableRequest`
871
+
872
+ </dd>
873
+ </dl>
874
+
875
+ <dl>
876
+ <dd>
877
+
878
+ **requestOptions:** `Analytics.RequestOptions`
879
+
880
+ </dd>
881
+ </dl>
882
+ </dd>
883
+ </dl>
884
+
885
+ </dd>
886
+ </dl>
887
+ </details>
888
+
889
+ <details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationChart</a>({ ...params }) -> MavenAGI.ChartResponse</code></summary>
890
+ <dl>
891
+ <dd>
892
+
893
+ #### 📝 Description
894
+
895
+ <dl>
896
+ <dd>
897
+
898
+ <dl>
899
+ <dd>
900
+
901
+ Fetches conversation data visualized in a chart format. Supported chart types include pie chart, date histogram, and stacked bar charts.
902
+
903
+ </dd>
904
+ </dl>
905
+ </dd>
906
+ </dl>
907
+
908
+ #### 🔌 Usage
909
+
910
+ <dl>
911
+ <dd>
912
+
913
+ <dl>
914
+ <dd>
915
+
916
+ ```typescript
917
+ await client.analytics.getConversationChart({
918
+ type: "pieChart",
919
+ conversationFilter: {
920
+ languages: ["en", "es"],
921
+ },
922
+ groupBy: {
923
+ field: "Category",
924
+ },
925
+ metric: {
926
+ type: "count",
927
+ },
928
+ });
929
+ ```
930
+
931
+ </dd>
932
+ </dl>
933
+ </dd>
934
+ </dl>
935
+
936
+ #### ⚙️ Parameters
937
+
938
+ <dl>
939
+ <dd>
940
+
941
+ <dl>
942
+ <dd>
943
+
944
+ **request:** `MavenAGI.ConversationChartRequest`
945
+
946
+ </dd>
947
+ </dl>
948
+
949
+ <dl>
950
+ <dd>
951
+
952
+ **requestOptions:** `Analytics.RequestOptions`
953
+
954
+ </dd>
955
+ </dl>
956
+ </dd>
957
+ </dl>
958
+
959
+ </dd>
960
+ </dl>
961
+ </details>
962
+
963
+ <details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getFeedbackTable</a>({ ...params }) -> MavenAGI.FeedbackTableResponse</code></summary>
964
+ <dl>
965
+ <dd>
966
+
967
+ #### 📝 Description
968
+
969
+ <dl>
970
+ <dd>
971
+
972
+ <dl>
973
+ <dd>
974
+
975
+ Retrieves structured feedback data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
976
+
977
+ </dd>
978
+ </dl>
979
+ </dd>
980
+ </dl>
981
+
982
+ #### 🔌 Usage
983
+
984
+ <dl>
985
+ <dd>
986
+
987
+ <dl>
988
+ <dd>
989
+
990
+ ```typescript
991
+ await client.analytics.getFeedbackTable({
992
+ feedbackFilter: {
993
+ types: ["THUMBS_UP", "INSERT"],
994
+ },
995
+ fieldGroupings: [
996
+ {
997
+ field: "CreatedBy",
998
+ },
999
+ ],
1000
+ columnDefinitions: [
1001
+ {
1002
+ header: "feedback_count",
1003
+ metric: {
1004
+ type: "count",
1005
+ },
1006
+ },
1007
+ ],
1008
+ });
1009
+ ```
1010
+
1011
+ </dd>
1012
+ </dl>
1013
+ </dd>
1014
+ </dl>
1015
+
1016
+ #### ⚙️ Parameters
1017
+
1018
+ <dl>
1019
+ <dd>
1020
+
1021
+ <dl>
1022
+ <dd>
1023
+
1024
+ **request:** `MavenAGI.FeedbackTableRequest`
1025
+
1026
+ </dd>
1027
+ </dl>
1028
+
1029
+ <dl>
1030
+ <dd>
1031
+
1032
+ **requestOptions:** `Analytics.RequestOptions`
1033
+
1034
+ </dd>
1035
+ </dl>
1036
+ </dd>
1037
+ </dl>
1038
+
1039
+ </dd>
1040
+ </dl>
1041
+ </details>
1042
+
1043
+ ## AppSettings
1044
+
1045
+ <details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SearchAppSettingsResponse</code></summary>
1046
+ <dl>
1047
+ <dd>
1048
+
1049
+ #### 📝 Description
1050
+
1051
+ <dl>
1052
+ <dd>
1053
+
1054
+ <dl>
1055
+ <dd>
1056
+
1057
+ Search for app settings which have the `$index` key set to the provided value.
1058
+
1059
+ You can set the `$index` key using the Update app settings API.
1060
+
1061
+ <Warning>This API currently requires an organization ID and agent ID for any agent which is installed on the app. This requirement will be removed in a future update.</Warning>
1062
+
1063
+ </dd>
1064
+ </dl>
1065
+ </dd>
1066
+ </dl>
1067
+
1068
+ #### 🔌 Usage
1069
+
1070
+ <dl>
1071
+ <dd>
1072
+
1073
+ <dl>
1074
+ <dd>
1075
+
1076
+ ```typescript
1077
+ await client.appSettings.search({
1078
+ index: "index",
1079
+ });
1080
+ ```
1081
+
1082
+ </dd>
1083
+ </dl>
1084
+ </dd>
1085
+ </dl>
1086
+
1087
+ #### ⚙️ Parameters
1088
+
1089
+ <dl>
1090
+ <dd>
1091
+
1092
+ <dl>
1093
+ <dd>
1094
+
1095
+ **request:** `MavenAGI.SearchAppSettingsRequest`
1096
+
1097
+ </dd>
1098
+ </dl>
1099
+
1100
+ <dl>
1101
+ <dd>
1102
+
1103
+ **requestOptions:** `AppSettings.RequestOptions`
1104
+
1105
+ </dd>
1106
+ </dl>
1107
+ </dd>
1108
+ </dl>
1109
+
1110
+ </dd>
1111
+ </dl>
1112
+ </details>
1113
+
1114
+ <details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">get</a>() -> Record<string, unknown></code></summary>
1115
+ <dl>
1116
+ <dd>
1117
+
1118
+ #### 📝 Description
1119
+
1120
+ <dl>
1121
+ <dd>
1122
+
1123
+ <dl>
1124
+ <dd>
1125
+
1126
+ Get app settings set during installation
1127
+
1128
+ </dd>
1129
+ </dl>
1130
+ </dd>
1131
+ </dl>
1132
+
1133
+ #### 🔌 Usage
1134
+
1135
+ <dl>
1136
+ <dd>
1137
+
1138
+ <dl>
1139
+ <dd>
1140
+
1141
+ ```typescript
1142
+ await client.appSettings.get();
1143
+ ```
1144
+
1145
+ </dd>
1146
+ </dl>
1147
+ </dd>
1148
+ </dl>
1149
+
1150
+ #### ⚙️ Parameters
1151
+
1152
+ <dl>
1153
+ <dd>
1154
+
1155
+ <dl>
1156
+ <dd>
1157
+
1158
+ **requestOptions:** `AppSettings.RequestOptions`
1159
+
1160
+ </dd>
1161
+ </dl>
1162
+ </dd>
1163
+ </dl>
1164
+
1165
+ </dd>
1166
+ </dl>
1167
+ </details>
1168
+
1169
+ <details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">update</a>({ ...params }) -> Record<string, unknown></code></summary>
1170
+ <dl>
1171
+ <dd>
1172
+
1173
+ #### 📝 Description
1174
+
1175
+ <dl>
1176
+ <dd>
1177
+
1178
+ <dl>
1179
+ <dd>
1180
+
1181
+ Update app settings. Performs a merge of the provided settings with the existing app settings.
1182
+
1183
+ - If a new key is provided, it will be added to the app settings.
1184
+ - If an existing key is provided, it will be updated.
1185
+ - No keys will be removed.
1186
+
1187
+ Note that if an array value is provided it will fully replace an existing value as arrays cannot be merged.
1188
+
1189
+ </dd>
1190
+ </dl>
1191
+ </dd>
1192
+ </dl>
1193
+
1194
+ #### 🔌 Usage
1195
+
1196
+ <dl>
1197
+ <dd>
1198
+
1199
+ <dl>
1200
+ <dd>
1201
+
1202
+ ```typescript
1203
+ await client.appSettings.update({
1204
+ string: {
1205
+ key: "value",
1206
+ },
1207
+ });
1208
+ ```
1209
+
1210
+ </dd>
1211
+ </dl>
1212
+ </dd>
1213
+ </dl>
1214
+
1215
+ #### ⚙️ Parameters
1216
+
1217
+ <dl>
1218
+ <dd>
1219
+
1220
+ <dl>
1221
+ <dd>
1222
+
1223
+ **request:** `Record<string, unknown>`
1224
+
1225
+ </dd>
1226
+ </dl>
1227
+
1228
+ <dl>
1229
+ <dd>
1230
+
1231
+ **requestOptions:** `AppSettings.RequestOptions`
1232
+
1233
+ </dd>
1234
+ </dl>
1235
+ </dd>
1236
+ </dl>
1237
+
1238
+ </dd>
1239
+ </dl>
1240
+ </details>
1241
+
1242
+ ## Assets
1243
+
1244
+ <details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">initiateUpload</a>({ ...params }) -> MavenAGI.InitiateAssetUploadResponse</code></summary>
1245
+ <dl>
1246
+ <dd>
1247
+
1248
+ #### 📝 Description
1249
+
1250
+ <dl>
1251
+ <dd>
1252
+
1253
+ <dl>
1254
+ <dd>
1255
+
1256
+ Initiate an upload.
1257
+ Returns a pre-signed URL for direct file upload and an asset ID for subsequent operations.
1258
+
1259
+ </dd>
1260
+ </dl>
1261
+ </dd>
1262
+ </dl>
1263
+
1264
+ #### 🔌 Usage
1265
+
1266
+ <dl>
1267
+ <dd>
1268
+
1269
+ <dl>
1270
+ <dd>
1271
+
1272
+ ```typescript
1273
+ await client.assets.initiateUpload({
1274
+ type: "type",
1275
+ });
1276
+ ```
1277
+
1278
+ </dd>
1279
+ </dl>
1280
+ </dd>
1281
+ </dl>
1282
+
1283
+ #### ⚙️ Parameters
1284
+
1285
+ <dl>
1286
+ <dd>
1287
+
1288
+ <dl>
1289
+ <dd>
1290
+
1291
+ **request:** `MavenAGI.InitiateAssetUploadRequest`
1292
+
1293
+ </dd>
1294
+ </dl>
1295
+
1296
+ <dl>
1297
+ <dd>
1298
+
1299
+ **requestOptions:** `Assets.RequestOptions`
1300
+
1301
+ </dd>
1302
+ </dl>
1303
+ </dd>
1304
+ </dl>
1305
+
1306
+ </dd>
1307
+ </dl>
1308
+ </details>
1309
+
1310
+ <details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">commitUpload</a>(assetReferenceId, { ...params }) -> void</code></summary>
1311
+ <dl>
1312
+ <dd>
1313
+
1314
+ #### 📝 Description
1315
+
1316
+ <dl>
1317
+ <dd>
1318
+
1319
+ <dl>
1320
+ <dd>
1321
+
1322
+ Commit an upload after successful file transfer.
1323
+ Updates the asset status and makes it available for use.
1324
+
1325
+ </dd>
1326
+ </dl>
1327
+ </dd>
1328
+ </dl>
1329
+
1330
+ #### 🔌 Usage
1331
+
1332
+ <dl>
1333
+ <dd>
1334
+
1335
+ <dl>
1336
+ <dd>
1337
+
1338
+ ```typescript
1339
+ await client.assets.commitUpload("assetReferenceId", {});
1340
+ ```
1341
+
1342
+ </dd>
1343
+ </dl>
1344
+ </dd>
1345
+ </dl>
1346
+
1347
+ #### ⚙️ Parameters
1348
+
1349
+ <dl>
1350
+ <dd>
1351
+
1352
+ <dl>
1353
+ <dd>
1354
+
1355
+ **assetReferenceId:** `string` — The reference ID of the asset to commit (provided by the initiate call). All other entity ID fields are inferred from the API request.
1356
+
1357
+ </dd>
1358
+ </dl>
1359
+
1360
+ <dl>
1361
+ <dd>
1362
+
1363
+ **request:** `MavenAGI.CommitAssetUploadRequest`
1364
+
1365
+ </dd>
1366
+ </dl>
1367
+
1368
+ <dl>
1369
+ <dd>
1370
+
1371
+ **requestOptions:** `Assets.RequestOptions`
1372
+
1373
+ </dd>
1374
+ </dl>
1375
+ </dd>
1376
+ </dl>
1377
+
1378
+ </dd>
1379
+ </dl>
1380
+ </details>
1381
+
1382
+ ## Conversation
1383
+
1384
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">initialize</a>({ ...params }) -> MavenAGI.ConversationResponse</code></summary>
1385
+ <dl>
1386
+ <dd>
1387
+
1388
+ #### 📝 Description
1389
+
1390
+ <dl>
1391
+ <dd>
1392
+
1393
+ <dl>
1394
+ <dd>
1395
+
1396
+ Initialize a new conversation.
1397
+ Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
1398
+
1399
+ Conversations can not be modified using this API. If the conversation already exists then the existing conversation will be returned.
1400
+
1401
+ After initialization,
1402
+
1403
+ - metadata can be changed using the `updateConversationMetadata` API.
1404
+ - messages can be added to the conversation with the `appendNewMessages` or `ask` APIs.
1405
+ </dd>
1406
+ </dl>
1407
+ </dd>
1408
+ </dl>
1409
+
1410
+ #### 🔌 Usage
1411
+
1412
+ <dl>
1413
+ <dd>
1414
+
1415
+ <dl>
1416
+ <dd>
1417
+
1418
+ ```typescript
1419
+ await client.conversation.initialize({
1420
+ conversationId: {
1421
+ referenceId: "referenceId",
1422
+ },
1423
+ messages: [
1424
+ {
1425
+ conversationMessageId: {
1426
+ referenceId: "referenceId",
1427
+ },
1428
+ userId: {
1429
+ referenceId: "referenceId",
1430
+ },
1431
+ text: "text",
1432
+ userMessageType: "USER",
1433
+ },
1434
+ {
1435
+ conversationMessageId: {
1436
+ referenceId: "referenceId",
1437
+ },
1438
+ userId: {
1439
+ referenceId: "referenceId",
1440
+ },
1441
+ text: "text",
1442
+ userMessageType: "USER",
1443
+ },
1444
+ ],
1445
+ });
1446
+ ```
1447
+
1448
+ </dd>
1449
+ </dl>
1450
+ </dd>
1451
+ </dl>
1452
+
1453
+ #### ⚙️ Parameters
1454
+
1455
+ <dl>
1456
+ <dd>
1457
+
1458
+ <dl>
1459
+ <dd>
1460
+
1461
+ **request:** `MavenAGI.ConversationRequest`
1462
+
1463
+ </dd>
1464
+ </dl>
1465
+
1466
+ <dl>
1467
+ <dd>
1468
+
1469
+ **requestOptions:** `Conversation.RequestOptions`
1470
+
1471
+ </dd>
1472
+ </dl>
1473
+ </dd>
1474
+ </dl>
1475
+
1476
+ </dd>
1477
+ </dl>
1478
+ </details>
1479
+
1480
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">patch</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
1481
+ <dl>
1482
+ <dd>
1483
+
1484
+ #### 📝 Description
1485
+
1486
+ <dl>
1487
+ <dd>
1488
+
1489
+ <dl>
1490
+ <dd>
1491
+
1492
+ Update mutable conversation fields.
1493
+
1494
+ The `appId` field can be provided to update a conversation owned by a different app.
1495
+ All other fields will overwrite the existing value on the conversation only if provided.
1496
+
1497
+ </dd>
1498
+ </dl>
1499
+ </dd>
1500
+ </dl>
1501
+
1502
+ #### 🔌 Usage
1503
+
1504
+ <dl>
1505
+ <dd>
1506
+
1507
+ <dl>
1508
+ <dd>
1509
+
1510
+ ```typescript
1511
+ await client.conversation.patch("conversation-0", {
1512
+ llmEnabled: true,
1513
+ });
1514
+ ```
1515
+
1516
+ </dd>
1517
+ </dl>
1518
+ </dd>
1519
+ </dl>
1520
+
1521
+ #### ⚙️ Parameters
1522
+
1523
+ <dl>
1524
+ <dd>
1525
+
1526
+ <dl>
1527
+ <dd>
1528
+
1529
+ **conversationId:** `string` — The ID of the conversation to patch
1530
+
1531
+ </dd>
1532
+ </dl>
1533
+
1534
+ <dl>
1535
+ <dd>
1536
+
1537
+ **request:** `MavenAGI.ConversationPatchRequest`
1538
+
1539
+ </dd>
1540
+ </dl>
1541
+
1542
+ <dl>
1543
+ <dd>
1544
+
1545
+ **requestOptions:** `Conversation.RequestOptions`
1546
+
1547
+ </dd>
1548
+ </dl>
1549
+ </dd>
1550
+ </dl>
1551
+
1552
+ </dd>
1553
+ </dl>
1554
+ </details>
1555
+
1556
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">get</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
1557
+ <dl>
1558
+ <dd>
1559
+
1560
+ #### 📝 Description
1561
+
1562
+ <dl>
1563
+ <dd>
1564
+
1565
+ <dl>
1566
+ <dd>
1567
+
1568
+ Get a conversation
1569
+
1570
+ </dd>
1571
+ </dl>
1572
+ </dd>
1573
+ </dl>
1574
+
1575
+ #### 🔌 Usage
1576
+
1577
+ <dl>
1578
+ <dd>
1579
+
1580
+ <dl>
1581
+ <dd>
1582
+
1583
+ ```typescript
1584
+ await client.conversation.get("conversationId");
1585
+ ```
1586
+
1587
+ </dd>
1588
+ </dl>
1589
+ </dd>
1590
+ </dl>
1591
+
1592
+ #### ⚙️ Parameters
1593
+
1594
+ <dl>
1595
+ <dd>
1596
+
1597
+ <dl>
1598
+ <dd>
1599
+
1600
+ **conversationId:** `string` — The ID of the conversation to get
1601
+
1602
+ </dd>
1603
+ </dl>
1604
+
1605
+ <dl>
1606
+ <dd>
1607
+
1608
+ **request:** `MavenAGI.ConversationGetRequest`
1609
+
1610
+ </dd>
1611
+ </dl>
1612
+
1613
+ <dl>
1614
+ <dd>
1615
+
1616
+ **requestOptions:** `Conversation.RequestOptions`
1617
+
1618
+ </dd>
1619
+ </dl>
1620
+ </dd>
1621
+ </dl>
1622
+
1623
+ </dd>
1624
+ </dl>
1625
+ </details>
1626
+
1627
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">delete</a>(conversationId, { ...params }) -> void</code></summary>
1628
+ <dl>
1629
+ <dd>
1630
+
1631
+ #### 📝 Description
1632
+
1633
+ <dl>
1634
+ <dd>
1635
+
1636
+ <dl>
1637
+ <dd>
1638
+
1639
+ Wipes a conversation of all user data.
1640
+ The conversation ID will still exist and non-user specific data will still be retained.
1641
+ Attempts to modify or add messages to the conversation will throw an error.
1642
+
1643
+ <Warning>This is a destructive operation and cannot be undone. <br/><br/>
1644
+ The exact fields cleared include: the conversation subject, userRequest, agentResponse.
1645
+ As well as the text response, followup questions, and backend LLM prompt of all messages.</Warning>
1646
+
1647
+ </dd>
1648
+ </dl>
1649
+ </dd>
1650
+ </dl>
1651
+
1652
+ #### 🔌 Usage
1653
+
1654
+ <dl>
1655
+ <dd>
1656
+
1657
+ <dl>
1658
+ <dd>
1659
+
1660
+ ```typescript
1661
+ await client.conversation.delete("conversation-0", {
1662
+ reason: "GDPR deletion request 1234.",
1663
+ });
1664
+ ```
1665
+
1666
+ </dd>
1667
+ </dl>
1668
+ </dd>
1669
+ </dl>
1670
+
1671
+ #### ⚙️ Parameters
1672
+
1673
+ <dl>
1674
+ <dd>
1675
+
1676
+ <dl>
1677
+ <dd>
1678
+
1679
+ **conversationId:** `string` — The ID of the conversation to delete
1680
+
1681
+ </dd>
1682
+ </dl>
1683
+
1684
+ <dl>
1685
+ <dd>
1686
+
1687
+ **request:** `MavenAGI.ConversationDeleteRequest`
1688
+
1689
+ </dd>
1690
+ </dl>
1691
+
1692
+ <dl>
1693
+ <dd>
1694
+
1695
+ **requestOptions:** `Conversation.RequestOptions`
1696
+
1697
+ </dd>
1698
+ </dl>
1699
+ </dd>
1700
+ </dl>
1701
+
1702
+ </dd>
1703
+ </dl>
1704
+ </details>
1705
+
1706
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">appendNewMessages</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
1707
+ <dl>
1708
+ <dd>
1709
+
1710
+ #### 📝 Description
1711
+
1712
+ <dl>
1713
+ <dd>
1714
+
1715
+ <dl>
1716
+ <dd>
1717
+
1718
+ Append messages to an existing conversation. The conversation must be initialized first. If a message with the same ID already exists, it will be ignored. Messages do not allow modification.
1719
+
1720
+ </dd>
1721
+ </dl>
1722
+ </dd>
1723
+ </dl>
1724
+
1725
+ #### 🔌 Usage
1726
+
1727
+ <dl>
1728
+ <dd>
1729
+
1730
+ <dl>
1731
+ <dd>
1732
+
1733
+ ```typescript
1734
+ await client.conversation.appendNewMessages("conversationId", [
1735
+ {
1736
+ conversationMessageId: {
1737
+ referenceId: "referenceId",
1738
+ },
1739
+ userId: {
1740
+ referenceId: "referenceId",
1741
+ },
1742
+ text: "text",
1743
+ userMessageType: "USER",
1744
+ },
1745
+ {
1746
+ conversationMessageId: {
1747
+ referenceId: "referenceId",
1748
+ },
1749
+ userId: {
1750
+ referenceId: "referenceId",
1751
+ },
1752
+ text: "text",
1753
+ userMessageType: "USER",
1754
+ },
1755
+ ]);
1756
+ ```
1757
+
1758
+ </dd>
1759
+ </dl>
1760
+ </dd>
1761
+ </dl>
1762
+
1763
+ #### ⚙️ Parameters
1764
+
1765
+ <dl>
1766
+ <dd>
1767
+
1768
+ <dl>
1769
+ <dd>
1770
+
1771
+ **conversationId:** `string` — The ID of the conversation to append messages to
1772
+
1773
+ </dd>
1774
+ </dl>
1775
+
1776
+ <dl>
1777
+ <dd>
1778
+
1779
+ **request:** `MavenAGI.ConversationMessageRequest[]`
1780
+
1781
+ </dd>
1782
+ </dl>
1783
+
1784
+ <dl>
1785
+ <dd>
1786
+
1787
+ **requestOptions:** `Conversation.RequestOptions`
1788
+
1789
+ </dd>
1790
+ </dl>
1791
+ </dd>
1792
+ </dl>
1793
+
1794
+ </dd>
1795
+ </dl>
1796
+ </details>
1797
+
1798
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">ask</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
1799
+ <dl>
1800
+ <dd>
1801
+
1802
+ #### 📝 Description
1803
+
1804
+ <dl>
1805
+ <dd>
1806
+
1807
+ <dl>
1808
+ <dd>
1809
+
1810
+ Get an answer from Maven for a given user question. If the user question or its answer already exists,
1811
+ they will be reused and will not be updated. Messages do not allow modification once generated.
1812
+
1813
+ Concurrency Behavior:
1814
+
1815
+ - If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
1816
+ - The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
1817
+
1818
+ Known Limitation:
1819
+
1820
+ - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
1821
+ </dd>
1822
+ </dl>
1823
+ </dd>
1824
+ </dl>
1825
+
1826
+ #### 🔌 Usage
1827
+
1828
+ <dl>
1829
+ <dd>
1830
+
1831
+ <dl>
1832
+ <dd>
1833
+
1834
+ ```typescript
1835
+ await client.conversation.ask("conversation-0", {
1836
+ conversationMessageId: {
1837
+ referenceId: "message-0",
1838
+ },
1839
+ userId: {
1840
+ referenceId: "user-0",
1841
+ },
1842
+ text: "How do I reset my password?",
1843
+ attachments: [
1844
+ {
1845
+ type: "image/png",
1846
+ content: "iVBORw0KGgo...",
1847
+ },
1848
+ ],
1849
+ transientData: {
1850
+ userToken: "abcdef123",
1851
+ queryApiKey: "foobar456",
1852
+ },
1853
+ timezone: "America/New_York",
1854
+ });
1855
+ ```
1856
+
1857
+ </dd>
1858
+ </dl>
1859
+ </dd>
1860
+ </dl>
1861
+
1862
+ #### ⚙️ Parameters
1863
+
1864
+ <dl>
1865
+ <dd>
1866
+
1867
+ <dl>
1868
+ <dd>
1869
+
1870
+ **conversationId:** `string` — The ID of a new or existing conversation to use as context for the question
1871
+
1872
+ </dd>
1873
+ </dl>
1874
+
1875
+ <dl>
1876
+ <dd>
1877
+
1878
+ **request:** `MavenAGI.AskRequest`
1879
+
1880
+ </dd>
1881
+ </dl>
1882
+
1883
+ <dl>
1884
+ <dd>
1885
+
1886
+ **requestOptions:** `Conversation.RequestOptions`
1887
+
1888
+ </dd>
1889
+ </dl>
1890
+ </dd>
1891
+ </dl>
1892
+
1893
+ </dd>
1894
+ </dl>
1895
+ </details>
1896
+
1897
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">askStream</a>(conversationId, { ...params }) -> core.Stream<MavenAGI.StreamResponse></code></summary>
1898
+ <dl>
1899
+ <dd>
1900
+
1901
+ #### 📝 Description
1902
+
1903
+ <dl>
1904
+ <dd>
1905
+
1906
+ <dl>
1907
+ <dd>
1908
+
1909
+ Get an answer from Maven for a given user question with a streaming response. The response will be sent as a stream of events.
1910
+ The text portions of stream responses should be concatenated to form the full response text.
1911
+ Action and metadata events should overwrite past data and do not need concatenation.
1912
+
1913
+ If the user question or its answer already exists, they will be reused and will not be updated.
1914
+ Messages do not allow modification once generated.
1915
+
1916
+ Concurrency Behavior:
1917
+
1918
+ - If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
1919
+ - The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
1920
+
1921
+ Known Limitation:
1922
+
1923
+ - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
1924
+ </dd>
1925
+ </dl>
1926
+ </dd>
1927
+ </dl>
1928
+
1929
+ #### 🔌 Usage
1930
+
1931
+ <dl>
1932
+ <dd>
1933
+
1934
+ <dl>
1935
+ <dd>
1936
+
1937
+ ```typescript
1938
+ const response = await client.conversation.askStream("conversation-0", {
1939
+ conversationMessageId: {
1940
+ referenceId: "message-0",
1941
+ },
1942
+ userId: {
1943
+ referenceId: "user-0",
1944
+ },
1945
+ text: "How do I reset my password?",
1946
+ attachments: [
1947
+ {
1948
+ type: "image/png",
1949
+ content: "iVBORw0KGgo...",
1950
+ },
1951
+ ],
1952
+ transientData: {
1953
+ userToken: "abcdef123",
1954
+ queryApiKey: "foobar456",
1955
+ },
1956
+ timezone: "America/New_York",
1957
+ });
1958
+ for await (const item of response) {
1959
+ console.log(item);
1960
+ }
1961
+ ```
1962
+
1963
+ </dd>
1964
+ </dl>
1965
+ </dd>
1966
+ </dl>
1967
+
1968
+ #### ⚙️ Parameters
1969
+
1970
+ <dl>
1971
+ <dd>
1972
+
1973
+ <dl>
1974
+ <dd>
1975
+
1976
+ **conversationId:** `string` — The ID of a new or existing conversation to use as context for the question
1977
+
1978
+ </dd>
1979
+ </dl>
1980
+
1981
+ <dl>
1982
+ <dd>
1983
+
1984
+ **request:** `MavenAGI.AskRequest`
1985
+
1986
+ </dd>
1987
+ </dl>
1988
+
1989
+ <dl>
1990
+ <dd>
1991
+
1992
+ **requestOptions:** `Conversation.RequestOptions`
1993
+
1994
+ </dd>
1995
+ </dl>
735
1996
  </dd>
736
1997
  </dl>
737
1998
 
@@ -739,7 +2000,7 @@ await client.appSettings.search({
739
2000
  </dl>
740
2001
  </details>
741
2002
 
742
- <details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">get</a>() -> Record<string, unknown></code></summary>
2003
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">generateMavenSuggestions</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
743
2004
  <dl>
744
2005
  <dd>
745
2006
 
@@ -751,7 +2012,7 @@ await client.appSettings.search({
751
2012
  <dl>
752
2013
  <dd>
753
2014
 
754
- Get app settings set during installation
2015
+ This method is deprecated and will be removed in a future release. Use either `ask` or `askStream` instead.
755
2016
 
756
2017
  </dd>
757
2018
  </dl>
@@ -767,7 +2028,261 @@ Get app settings set during installation
767
2028
  <dd>
768
2029
 
769
2030
  ```typescript
770
- await client.appSettings.get();
2031
+ await client.conversation.generateMavenSuggestions("conversationId", {
2032
+ conversationMessageIds: [
2033
+ {
2034
+ referenceId: "referenceId",
2035
+ },
2036
+ {
2037
+ referenceId: "referenceId",
2038
+ },
2039
+ ],
2040
+ });
2041
+ ```
2042
+
2043
+ </dd>
2044
+ </dl>
2045
+ </dd>
2046
+ </dl>
2047
+
2048
+ #### ⚙️ Parameters
2049
+
2050
+ <dl>
2051
+ <dd>
2052
+
2053
+ <dl>
2054
+ <dd>
2055
+
2056
+ **conversationId:** `string` — The ID of a conversation the messages belong to
2057
+
2058
+ </dd>
2059
+ </dl>
2060
+
2061
+ <dl>
2062
+ <dd>
2063
+
2064
+ **request:** `MavenAGI.GenerateMavenSuggestionsRequest`
2065
+
2066
+ </dd>
2067
+ </dl>
2068
+
2069
+ <dl>
2070
+ <dd>
2071
+
2072
+ **requestOptions:** `Conversation.RequestOptions`
2073
+
2074
+ </dd>
2075
+ </dl>
2076
+ </dd>
2077
+ </dl>
2078
+
2079
+ </dd>
2080
+ </dl>
2081
+ </details>
2082
+
2083
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">askObjectStream</a>(conversationId, { ...params }) -> core.Stream<MavenAGI.ObjectStreamResponse></code></summary>
2084
+ <dl>
2085
+ <dd>
2086
+
2087
+ #### 📝 Description
2088
+
2089
+ <dl>
2090
+ <dd>
2091
+
2092
+ <dl>
2093
+ <dd>
2094
+
2095
+ Generate a structured object response based on a provided schema and user prompt with a streaming response.
2096
+ The response will be sent as a stream of events containing text, start, and end events.
2097
+ The text portions of stream responses should be concatenated to form the full response text.
2098
+
2099
+ If the user question and object response already exist, they will be reused and not updated.
2100
+
2101
+ Concurrency Behavior:
2102
+
2103
+ - If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
2104
+ - The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
2105
+
2106
+ Known Limitations:
2107
+
2108
+ - Schema enforcement is best-effort and may not guarantee exact conformity.
2109
+ - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
2110
+ </dd>
2111
+ </dl>
2112
+ </dd>
2113
+ </dl>
2114
+
2115
+ #### 🔌 Usage
2116
+
2117
+ <dl>
2118
+ <dd>
2119
+
2120
+ <dl>
2121
+ <dd>
2122
+
2123
+ ```typescript
2124
+ const response = await client.conversation.askObjectStream("conversationId", {
2125
+ schema: "schema",
2126
+ conversationMessageId: {
2127
+ referenceId: "referenceId",
2128
+ },
2129
+ userId: {
2130
+ referenceId: "referenceId",
2131
+ },
2132
+ text: "text",
2133
+ });
2134
+ for await (const item of response) {
2135
+ console.log(item);
2136
+ }
2137
+ ```
2138
+
2139
+ </dd>
2140
+ </dl>
2141
+ </dd>
2142
+ </dl>
2143
+
2144
+ #### ⚙️ Parameters
2145
+
2146
+ <dl>
2147
+ <dd>
2148
+
2149
+ <dl>
2150
+ <dd>
2151
+
2152
+ **conversationId:** `string` — The ID of a new or existing conversation to use as context for the object generation request
2153
+
2154
+ </dd>
2155
+ </dl>
2156
+
2157
+ <dl>
2158
+ <dd>
2159
+
2160
+ **request:** `MavenAGI.AskObjectRequest`
2161
+
2162
+ </dd>
2163
+ </dl>
2164
+
2165
+ <dl>
2166
+ <dd>
2167
+
2168
+ **requestOptions:** `Conversation.RequestOptions`
2169
+
2170
+ </dd>
2171
+ </dl>
2172
+ </dd>
2173
+ </dl>
2174
+
2175
+ </dd>
2176
+ </dl>
2177
+ </details>
2178
+
2179
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">categorize</a>(conversationId) -> MavenAGI.CategorizationResponse</code></summary>
2180
+ <dl>
2181
+ <dd>
2182
+
2183
+ #### 📝 Description
2184
+
2185
+ <dl>
2186
+ <dd>
2187
+
2188
+ <dl>
2189
+ <dd>
2190
+
2191
+ Uses an LLM flow to categorize the conversation. Experimental.
2192
+
2193
+ </dd>
2194
+ </dl>
2195
+ </dd>
2196
+ </dl>
2197
+
2198
+ #### 🔌 Usage
2199
+
2200
+ <dl>
2201
+ <dd>
2202
+
2203
+ <dl>
2204
+ <dd>
2205
+
2206
+ ```typescript
2207
+ await client.conversation.categorize("conversationId");
2208
+ ```
2209
+
2210
+ </dd>
2211
+ </dl>
2212
+ </dd>
2213
+ </dl>
2214
+
2215
+ #### ⚙️ Parameters
2216
+
2217
+ <dl>
2218
+ <dd>
2219
+
2220
+ <dl>
2221
+ <dd>
2222
+
2223
+ **conversationId:** `string` — The ID of the conversation to categorize
2224
+
2225
+ </dd>
2226
+ </dl>
2227
+
2228
+ <dl>
2229
+ <dd>
2230
+
2231
+ **requestOptions:** `Conversation.RequestOptions`
2232
+
2233
+ </dd>
2234
+ </dl>
2235
+ </dd>
2236
+ </dl>
2237
+
2238
+ </dd>
2239
+ </dl>
2240
+ </details>
2241
+
2242
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">createFeedback</a>({ ...params }) -> MavenAGI.Feedback</code></summary>
2243
+ <dl>
2244
+ <dd>
2245
+
2246
+ #### 📝 Description
2247
+
2248
+ <dl>
2249
+ <dd>
2250
+
2251
+ <dl>
2252
+ <dd>
2253
+
2254
+ Update feedback or create it if it doesn't exist
2255
+
2256
+ </dd>
2257
+ </dl>
2258
+ </dd>
2259
+ </dl>
2260
+
2261
+ #### 🔌 Usage
2262
+
2263
+ <dl>
2264
+ <dd>
2265
+
2266
+ <dl>
2267
+ <dd>
2268
+
2269
+ ```typescript
2270
+ await client.conversation.createFeedback({
2271
+ feedbackId: {
2272
+ referenceId: "feedback-0",
2273
+ },
2274
+ userId: {
2275
+ referenceId: "user-0",
2276
+ },
2277
+ conversationId: {
2278
+ referenceId: "conversation-0",
2279
+ },
2280
+ conversationMessageId: {
2281
+ referenceId: "message-1",
2282
+ },
2283
+ type: "THUMBS_UP",
2284
+ text: "Great answer!",
2285
+ });
771
2286
  ```
772
2287
 
773
2288
  </dd>
@@ -783,7 +2298,15 @@ await client.appSettings.get();
783
2298
  <dl>
784
2299
  <dd>
785
2300
 
786
- **requestOptions:** `AppSettings.RequestOptions`
2301
+ **request:** `MavenAGI.FeedbackRequest`
2302
+
2303
+ </dd>
2304
+ </dl>
2305
+
2306
+ <dl>
2307
+ <dd>
2308
+
2309
+ **requestOptions:** `Conversation.RequestOptions`
787
2310
 
788
2311
  </dd>
789
2312
  </dl>
@@ -794,7 +2317,7 @@ await client.appSettings.get();
794
2317
  </dl>
795
2318
  </details>
796
2319
 
797
- <details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">update</a>({ ...params }) -> Record<string, unknown></code></summary>
2320
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">submitActionForm</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
798
2321
  <dl>
799
2322
  <dd>
800
2323
 
@@ -806,13 +2329,7 @@ await client.appSettings.get();
806
2329
  <dl>
807
2330
  <dd>
808
2331
 
809
- Update app settings. Performs a merge of the provided settings with the existing app settings.
810
-
811
- - If a new key is provided, it will be added to the app settings.
812
- - If an existing key is provided, it will be updated.
813
- - No keys will be removed.
814
-
815
- Note that if an array value is provided it will fully replace an existing value as arrays cannot be merged.
2332
+ Submit a filled out action form
816
2333
 
817
2334
  </dd>
818
2335
  </dl>
@@ -828,9 +2345,12 @@ Note that if an array value is provided it will fully replace an existing value
828
2345
  <dd>
829
2346
 
830
2347
  ```typescript
831
- await client.appSettings.update({
832
- string: {
833
- key: "value",
2348
+ await client.conversation.submitActionForm("conversationId", {
2349
+ actionFormId: "actionFormId",
2350
+ parameters: {
2351
+ parameters: {
2352
+ key: "value",
2353
+ },
834
2354
  },
835
2355
  });
836
2356
  ```
@@ -848,7 +2368,7 @@ await client.appSettings.update({
848
2368
  <dl>
849
2369
  <dd>
850
2370
 
851
- **request:** `Record<string, unknown>`
2371
+ **conversationId:** `string` — The ID of a conversation the form being submitted belongs to
852
2372
 
853
2373
  </dd>
854
2374
  </dl>
@@ -856,7 +2376,15 @@ await client.appSettings.update({
856
2376
  <dl>
857
2377
  <dd>
858
2378
 
859
- **requestOptions:** `AppSettings.RequestOptions`
2379
+ **request:** `MavenAGI.SubmitActionFormRequest`
2380
+
2381
+ </dd>
2382
+ </dl>
2383
+
2384
+ <dl>
2385
+ <dd>
2386
+
2387
+ **requestOptions:** `Conversation.RequestOptions`
860
2388
 
861
2389
  </dd>
862
2390
  </dl>
@@ -867,9 +2395,7 @@ await client.appSettings.update({
867
2395
  </dl>
868
2396
  </details>
869
2397
 
870
- ## Conversation
871
-
872
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">initialize</a>({ ...params }) -> MavenAGI.ConversationResponse</code></summary>
2398
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">addConversationMetadata</a>(conversationId, { ...params }) -> Record<string, string></code></summary>
873
2399
  <dl>
874
2400
  <dd>
875
2401
 
@@ -881,19 +2407,14 @@ await client.appSettings.update({
881
2407
  <dl>
882
2408
  <dd>
883
2409
 
884
- Initialize a new conversation.
885
- Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
886
-
887
- Conversations can not be modified using this API. If the conversation already exists then the existing conversation will be returned.
2410
+ Replaced by `updateConversationMetadata`.
888
2411
 
889
- After initialization,
2412
+ Adds metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
890
2413
 
891
- - metadata can be changed using the `updateConversationMetadata` API.
892
- - messages can be added to the conversation with the `appendNewMessages` or `ask` APIs.
893
- </dd>
894
- </dl>
895
- </dd>
896
- </dl>
2414
+ </dd>
2415
+ </dl>
2416
+ </dd>
2417
+ </dl>
897
2418
 
898
2419
  #### 🔌 Usage
899
2420
 
@@ -904,32 +2425,8 @@ After initialization,
904
2425
  <dd>
905
2426
 
906
2427
  ```typescript
907
- await client.conversation.initialize({
908
- conversationId: {
909
- referenceId: "referenceId",
910
- },
911
- messages: [
912
- {
913
- conversationMessageId: {
914
- referenceId: "referenceId",
915
- },
916
- userId: {
917
- referenceId: "referenceId",
918
- },
919
- text: "text",
920
- userMessageType: "USER",
921
- },
922
- {
923
- conversationMessageId: {
924
- referenceId: "referenceId",
925
- },
926
- userId: {
927
- referenceId: "referenceId",
928
- },
929
- text: "text",
930
- userMessageType: "USER",
931
- },
932
- ],
2428
+ await client.conversation.addConversationMetadata("conversationId", {
2429
+ string: "string",
933
2430
  });
934
2431
  ```
935
2432
 
@@ -946,7 +2443,15 @@ await client.conversation.initialize({
946
2443
  <dl>
947
2444
  <dd>
948
2445
 
949
- **request:** `MavenAGI.ConversationRequest`
2446
+ **conversationId:** `string` — The ID of a conversation the metadata being added belongs to
2447
+
2448
+ </dd>
2449
+ </dl>
2450
+
2451
+ <dl>
2452
+ <dd>
2453
+
2454
+ **request:** `Record<string, string>`
950
2455
 
951
2456
  </dd>
952
2457
  </dl>
@@ -965,7 +2470,7 @@ await client.conversation.initialize({
965
2470
  </dl>
966
2471
  </details>
967
2472
 
968
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">get</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
2473
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">updateConversationMetadata</a>(conversationId, { ...params }) -> MavenAGI.ConversationMetadata</code></summary>
969
2474
  <dl>
970
2475
  <dd>
971
2476
 
@@ -977,7 +2482,13 @@ await client.conversation.initialize({
977
2482
  <dl>
978
2483
  <dd>
979
2484
 
980
- Get a conversation
2485
+ Update metadata supplied by the calling application for an existing conversation.
2486
+ Does not modify metadata saved by other apps.
2487
+
2488
+ If a metadata field already exists for the calling app, it will be overwritten.
2489
+ If it does not exist, it will be added. Will not remove metadata fields.
2490
+
2491
+ Returns all metadata saved by any app on the conversation.
981
2492
 
982
2493
  </dd>
983
2494
  </dl>
@@ -993,7 +2504,12 @@ Get a conversation
993
2504
  <dd>
994
2505
 
995
2506
  ```typescript
996
- await client.conversation.get("conversationId");
2507
+ await client.conversation.updateConversationMetadata("conversation-0", {
2508
+ appId: "conversation-owning-app",
2509
+ values: {
2510
+ key: "newValue",
2511
+ },
2512
+ });
997
2513
  ```
998
2514
 
999
2515
  </dd>
@@ -1009,7 +2525,7 @@ await client.conversation.get("conversationId");
1009
2525
  <dl>
1010
2526
  <dd>
1011
2527
 
1012
- **conversationId:** `string` — The ID of the conversation to get
2528
+ **conversationId:** `string` — The ID of the conversation to modify metadata for
1013
2529
 
1014
2530
  </dd>
1015
2531
  </dl>
@@ -1017,7 +2533,7 @@ await client.conversation.get("conversationId");
1017
2533
  <dl>
1018
2534
  <dd>
1019
2535
 
1020
- **request:** `MavenAGI.ConversationGetRequest`
2536
+ **request:** `MavenAGI.UpdateMetadataRequest`
1021
2537
 
1022
2538
  </dd>
1023
2539
  </dl>
@@ -1036,7 +2552,7 @@ await client.conversation.get("conversationId");
1036
2552
  </dl>
1037
2553
  </details>
1038
2554
 
1039
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">delete</a>(conversationId, { ...params }) -> void</code></summary>
2555
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">search</a>({ ...params }) -> MavenAGI.ConversationsResponse</code></summary>
1040
2556
  <dl>
1041
2557
  <dd>
1042
2558
 
@@ -1048,13 +2564,7 @@ await client.conversation.get("conversationId");
1048
2564
  <dl>
1049
2565
  <dd>
1050
2566
 
1051
- Wipes a conversation of all user data.
1052
- The conversation ID will still exist and non-user specific data will still be retained.
1053
- Attempts to modify or add messages to the conversation will throw an error.
1054
-
1055
- <Warning>This is a destructive operation and cannot be undone. <br/><br/>
1056
- The exact fields cleared include: the conversation subject, userRequest, agentResponse.
1057
- As well as the text response, followup questions, and backend LLM prompt of all messages.</Warning>
2567
+ Search conversations
1058
2568
 
1059
2569
  </dd>
1060
2570
  </dl>
@@ -1070,9 +2580,7 @@ As well as the text response, followup questions, and backend LLM prompt of all
1070
2580
  <dd>
1071
2581
 
1072
2582
  ```typescript
1073
- await client.conversation.delete("conversation-0", {
1074
- reason: "GDPR deletion request 1234.",
1075
- });
2583
+ await client.conversation.search({});
1076
2584
  ```
1077
2585
 
1078
2586
  </dd>
@@ -1088,15 +2596,7 @@ await client.conversation.delete("conversation-0", {
1088
2596
  <dl>
1089
2597
  <dd>
1090
2598
 
1091
- **conversationId:** `string` — The ID of the conversation to delete
1092
-
1093
- </dd>
1094
- </dl>
1095
-
1096
- <dl>
1097
- <dd>
1098
-
1099
- **request:** `MavenAGI.ConversationDeleteRequest`
2599
+ **request:** `MavenAGI.ConversationsSearchRequest`
1100
2600
 
1101
2601
  </dd>
1102
2602
  </dl>
@@ -1115,7 +2615,7 @@ await client.conversation.delete("conversation-0", {
1115
2615
  </dl>
1116
2616
  </details>
1117
2617
 
1118
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">appendNewMessages</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
2618
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">deliverMessage</a>({ ...params }) -> MavenAGI.DeliverMessageResponse</code></summary>
1119
2619
  <dl>
1120
2620
  <dd>
1121
2621
 
@@ -1127,8 +2627,12 @@ await client.conversation.delete("conversation-0", {
1127
2627
  <dl>
1128
2628
  <dd>
1129
2629
 
1130
- Append messages to an existing conversation. The conversation must be initialized first. If a message with the same ID already exists, it will be ignored. Messages do not allow modification.
2630
+ Deliver a message to a user or conversation.
1131
2631
 
2632
+ <Warning>
2633
+ Currently, messages can only be successfully delivered to conversations with the `ASYNC` capability that are `open`.
2634
+ User message delivery is not yet supported.
2635
+ </Warning>
1132
2636
  </dd>
1133
2637
  </dl>
1134
2638
  </dd>
@@ -1143,18 +2647,14 @@ Append messages to an existing conversation. The conversation must be initialize
1143
2647
  <dd>
1144
2648
 
1145
2649
  ```typescript
1146
- await client.conversation.appendNewMessages("conversationId", [
1147
- {
1148
- conversationMessageId: {
1149
- referenceId: "referenceId",
1150
- },
1151
- userId: {
1152
- referenceId: "referenceId",
1153
- },
1154
- text: "text",
1155
- userMessageType: "USER",
2650
+ await client.conversation.deliverMessage({
2651
+ type: "user",
2652
+ userId: {
2653
+ type: "AGENT",
2654
+ appId: "appId",
2655
+ referenceId: "referenceId",
1156
2656
  },
1157
- {
2657
+ message: {
1158
2658
  conversationMessageId: {
1159
2659
  referenceId: "referenceId",
1160
2660
  },
@@ -1164,7 +2664,7 @@ await client.conversation.appendNewMessages("conversationId", [
1164
2664
  text: "text",
1165
2665
  userMessageType: "USER",
1166
2666
  },
1167
- ]);
2667
+ });
1168
2668
  ```
1169
2669
 
1170
2670
  </dd>
@@ -1180,15 +2680,7 @@ await client.conversation.appendNewMessages("conversationId", [
1180
2680
  <dl>
1181
2681
  <dd>
1182
2682
 
1183
- **conversationId:** `string` — The ID of the conversation to append messages to
1184
-
1185
- </dd>
1186
- </dl>
1187
-
1188
- <dl>
1189
- <dd>
1190
-
1191
- **request:** `MavenAGI.ConversationMessageRequest[]`
2683
+ **request:** `MavenAGI.DeliverMessageRequest`
1192
2684
 
1193
2685
  </dd>
1194
2686
  </dl>
@@ -1207,7 +2699,9 @@ await client.conversation.appendNewMessages("conversationId", [
1207
2699
  </dl>
1208
2700
  </details>
1209
2701
 
1210
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">ask</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
2702
+ ## Events
2703
+
2704
+ <details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventsSearchResponse</code></summary>
1211
2705
  <dl>
1212
2706
  <dd>
1213
2707
 
@@ -1219,21 +2713,12 @@ await client.conversation.appendNewMessages("conversationId", [
1219
2713
  <dl>
1220
2714
  <dd>
1221
2715
 
1222
- Get an answer from Maven for a given user question. If the user question or its answer already exists,
1223
- they will be reused and will not be updated. Messages do not allow modification once generated.
1224
-
1225
- Concurrency Behavior:
1226
-
1227
- - If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
1228
- - The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
1229
-
1230
- Known Limitation:
2716
+ Search events
1231
2717
 
1232
- - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
1233
- </dd>
1234
- </dl>
1235
- </dd>
1236
- </dl>
2718
+ </dd>
2719
+ </dl>
2720
+ </dd>
2721
+ </dl>
1237
2722
 
1238
2723
  #### 🔌 Usage
1239
2724
 
@@ -1244,26 +2729,7 @@ Known Limitation:
1244
2729
  <dd>
1245
2730
 
1246
2731
  ```typescript
1247
- await client.conversation.ask("conversation-0", {
1248
- conversationMessageId: {
1249
- referenceId: "message-0",
1250
- },
1251
- userId: {
1252
- referenceId: "user-0",
1253
- },
1254
- text: "How do I reset my password?",
1255
- attachments: [
1256
- {
1257
- type: "image/png",
1258
- content: "iVBORw0KGgo...",
1259
- },
1260
- ],
1261
- transientData: {
1262
- userToken: "abcdef123",
1263
- queryApiKey: "foobar456",
1264
- },
1265
- timezone: "America/New_York",
1266
- });
2732
+ await client.events.search({});
1267
2733
  ```
1268
2734
 
1269
2735
  </dd>
@@ -1279,15 +2745,7 @@ await client.conversation.ask("conversation-0", {
1279
2745
  <dl>
1280
2746
  <dd>
1281
2747
 
1282
- **conversationId:** `string` — The ID of a new or existing conversation to use as context for the question
1283
-
1284
- </dd>
1285
- </dl>
1286
-
1287
- <dl>
1288
- <dd>
1289
-
1290
- **request:** `MavenAGI.AskRequest`
2748
+ **request:** `MavenAGI.EventsSearchRequest`
1291
2749
 
1292
2750
  </dd>
1293
2751
  </dl>
@@ -1295,7 +2753,7 @@ await client.conversation.ask("conversation-0", {
1295
2753
  <dl>
1296
2754
  <dd>
1297
2755
 
1298
- **requestOptions:** `Conversation.RequestOptions`
2756
+ **requestOptions:** `Events.RequestOptions`
1299
2757
 
1300
2758
  </dd>
1301
2759
  </dl>
@@ -1306,39 +2764,13 @@ await client.conversation.ask("conversation-0", {
1306
2764
  </dl>
1307
2765
  </details>
1308
2766
 
1309
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">askStream</a>(conversationId, { ...params }) -> core.Stream<MavenAGI.StreamResponse></code></summary>
1310
- <dl>
1311
- <dd>
1312
-
1313
- #### 📝 Description
1314
-
1315
- <dl>
1316
- <dd>
1317
-
1318
- <dl>
1319
- <dd>
1320
-
1321
- Get an answer from Maven for a given user question with a streaming response. The response will be sent as a stream of events.
1322
- The text portions of stream responses should be concatenated to form the full response text.
1323
- Action and metadata events should overwrite past data and do not need concatenation.
1324
-
1325
- If the user question or its answer already exists, they will be reused and will not be updated.
1326
- Messages do not allow modification once generated.
1327
-
1328
- Concurrency Behavior:
1329
-
1330
- - If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
1331
- - The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
1332
-
1333
- Known Limitation:
2767
+ ## Inbox
1334
2768
 
1335
- - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
1336
- </dd>
1337
- </dl>
1338
- </dd>
1339
- </dl>
2769
+ <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">search</a>({ ...params }) -> MavenAGI.InboxSearchResponse</code></summary>
2770
+ <dl>
2771
+ <dd>
1340
2772
 
1341
- #### 🔌 Usage
2773
+ #### 📝 Description
1342
2774
 
1343
2775
  <dl>
1344
2776
  <dd>
@@ -1346,38 +2778,14 @@ Known Limitation:
1346
2778
  <dl>
1347
2779
  <dd>
1348
2780
 
1349
- ```typescript
1350
- const response = await client.conversation.askStream("conversation-0", {
1351
- conversationMessageId: {
1352
- referenceId: "message-0",
1353
- },
1354
- userId: {
1355
- referenceId: "user-0",
1356
- },
1357
- text: "How do I reset my password?",
1358
- attachments: [
1359
- {
1360
- type: "image/png",
1361
- content: "iVBORw0KGgo...",
1362
- },
1363
- ],
1364
- transientData: {
1365
- userToken: "abcdef123",
1366
- queryApiKey: "foobar456",
1367
- },
1368
- timezone: "America/New_York",
1369
- });
1370
- for await (const item of response) {
1371
- console.log(item);
1372
- }
1373
- ```
2781
+ Retrieve a paginated list of inbox items for an agent.
1374
2782
 
1375
2783
  </dd>
1376
2784
  </dl>
1377
2785
  </dd>
1378
2786
  </dl>
1379
2787
 
1380
- #### ⚙️ Parameters
2788
+ #### 🔌 Usage
1381
2789
 
1382
2790
  <dl>
1383
2791
  <dd>
@@ -1385,15 +2793,24 @@ for await (const item of response) {
1385
2793
  <dl>
1386
2794
  <dd>
1387
2795
 
1388
- **conversationId:** `string` — The ID of a new or existing conversation to use as context for the question
2796
+ ```typescript
2797
+ await client.inbox.search({});
2798
+ ```
1389
2799
 
2800
+ </dd>
2801
+ </dl>
1390
2802
  </dd>
1391
2803
  </dl>
1392
2804
 
2805
+ #### ⚙️ Parameters
2806
+
1393
2807
  <dl>
1394
2808
  <dd>
1395
2809
 
1396
- **request:** `MavenAGI.AskRequest`
2810
+ <dl>
2811
+ <dd>
2812
+
2813
+ **request:** `MavenAGI.InboxSearchRequest`
1397
2814
 
1398
2815
  </dd>
1399
2816
  </dl>
@@ -1401,7 +2818,7 @@ for await (const item of response) {
1401
2818
  <dl>
1402
2819
  <dd>
1403
2820
 
1404
- **requestOptions:** `Conversation.RequestOptions`
2821
+ **requestOptions:** `Inbox.RequestOptions`
1405
2822
 
1406
2823
  </dd>
1407
2824
  </dl>
@@ -1412,7 +2829,7 @@ for await (const item of response) {
1412
2829
  </dl>
1413
2830
  </details>
1414
2831
 
1415
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">generateMavenSuggestions</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
2832
+ <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">get</a>(inboxItemId, { ...params }) -> MavenAGI.InboxItem</code></summary>
1416
2833
  <dl>
1417
2834
  <dd>
1418
2835
 
@@ -1424,7 +2841,7 @@ for await (const item of response) {
1424
2841
  <dl>
1425
2842
  <dd>
1426
2843
 
1427
- This method is deprecated and will be removed in a future release. Use either `ask` or `askStream` instead.
2844
+ Retrieve details of a specific inbox item by its ID.
1428
2845
 
1429
2846
  </dd>
1430
2847
  </dl>
@@ -1440,15 +2857,8 @@ This method is deprecated and will be removed in a future release. Use either `a
1440
2857
  <dd>
1441
2858
 
1442
2859
  ```typescript
1443
- await client.conversation.generateMavenSuggestions("conversationId", {
1444
- conversationMessageIds: [
1445
- {
1446
- referenceId: "referenceId",
1447
- },
1448
- {
1449
- referenceId: "referenceId",
1450
- },
1451
- ],
2860
+ await client.inbox.get("inboxItemId", {
2861
+ appId: "appId",
1452
2862
  });
1453
2863
  ```
1454
2864
 
@@ -1465,7 +2875,7 @@ await client.conversation.generateMavenSuggestions("conversationId", {
1465
2875
  <dl>
1466
2876
  <dd>
1467
2877
 
1468
- **conversationId:** `string` — The ID of a conversation the messages belong to
2878
+ **inboxItemId:** `string` — The ID of the inbox item to get. All other entity ID fields are inferred from the request.
1469
2879
 
1470
2880
  </dd>
1471
2881
  </dl>
@@ -1473,7 +2883,7 @@ await client.conversation.generateMavenSuggestions("conversationId", {
1473
2883
  <dl>
1474
2884
  <dd>
1475
2885
 
1476
- **request:** `MavenAGI.GenerateMavenSuggestionsRequest`
2886
+ **request:** `MavenAGI.InboxItemRequest`
1477
2887
 
1478
2888
  </dd>
1479
2889
  </dl>
@@ -1481,7 +2891,7 @@ await client.conversation.generateMavenSuggestions("conversationId", {
1481
2891
  <dl>
1482
2892
  <dd>
1483
2893
 
1484
- **requestOptions:** `Conversation.RequestOptions`
2894
+ **requestOptions:** `Inbox.RequestOptions`
1485
2895
 
1486
2896
  </dd>
1487
2897
  </dl>
@@ -1492,7 +2902,7 @@ await client.conversation.generateMavenSuggestions("conversationId", {
1492
2902
  </dl>
1493
2903
  </details>
1494
2904
 
1495
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">categorize</a>(conversationId) -> MavenAGI.CategorizationResponse</code></summary>
2905
+ <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">getFix</a>(inboxItemFixId, { ...params }) -> MavenAGI.InboxItemFix</code></summary>
1496
2906
  <dl>
1497
2907
  <dd>
1498
2908
 
@@ -1504,7 +2914,7 @@ await client.conversation.generateMavenSuggestions("conversationId", {
1504
2914
  <dl>
1505
2915
  <dd>
1506
2916
 
1507
- Uses an LLM flow to categorize the conversation. Experimental.
2917
+ Retrieve a suggested fix. Includes document information if the fix is a Missing Knowledge suggestion.
1508
2918
 
1509
2919
  </dd>
1510
2920
  </dl>
@@ -1520,7 +2930,9 @@ Uses an LLM flow to categorize the conversation. Experimental.
1520
2930
  <dd>
1521
2931
 
1522
2932
  ```typescript
1523
- await client.conversation.categorize("conversationId");
2933
+ await client.inbox.getFix("inboxItemFixId", {
2934
+ appId: "appId",
2935
+ });
1524
2936
  ```
1525
2937
 
1526
2938
  </dd>
@@ -1536,7 +2948,7 @@ await client.conversation.categorize("conversationId");
1536
2948
  <dl>
1537
2949
  <dd>
1538
2950
 
1539
- **conversationId:** `string` — The ID of the conversation to categorize
2951
+ **inboxItemFixId:** `string` — Unique identifier for the inbox fix.
1540
2952
 
1541
2953
  </dd>
1542
2954
  </dl>
@@ -1544,7 +2956,15 @@ await client.conversation.categorize("conversationId");
1544
2956
  <dl>
1545
2957
  <dd>
1546
2958
 
1547
- **requestOptions:** `Conversation.RequestOptions`
2959
+ **request:** `MavenAGI.InboxItemFixRequest`
2960
+
2961
+ </dd>
2962
+ </dl>
2963
+
2964
+ <dl>
2965
+ <dd>
2966
+
2967
+ **requestOptions:** `Inbox.RequestOptions`
1548
2968
 
1549
2969
  </dd>
1550
2970
  </dl>
@@ -1555,7 +2975,7 @@ await client.conversation.categorize("conversationId");
1555
2975
  </dl>
1556
2976
  </details>
1557
2977
 
1558
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">createFeedback</a>({ ...params }) -> MavenAGI.Feedback</code></summary>
2978
+ <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">applyFixes</a>(inboxItemId, { ...params }) -> void</code></summary>
1559
2979
  <dl>
1560
2980
  <dd>
1561
2981
 
@@ -1567,7 +2987,7 @@ await client.conversation.categorize("conversationId");
1567
2987
  <dl>
1568
2988
  <dd>
1569
2989
 
1570
- Update feedback or create it if it doesn't exist
2990
+ Apply a list of fixes belonging to an inbox item.
1571
2991
 
1572
2992
  </dd>
1573
2993
  </dl>
@@ -1583,21 +3003,9 @@ Update feedback or create it if it doesn't exist
1583
3003
  <dd>
1584
3004
 
1585
3005
  ```typescript
1586
- await client.conversation.createFeedback({
1587
- feedbackId: {
1588
- referenceId: "feedback-0",
1589
- },
1590
- userId: {
1591
- referenceId: "user-0",
1592
- },
1593
- conversationId: {
1594
- referenceId: "conversation-0",
1595
- },
1596
- conversationMessageId: {
1597
- referenceId: "message-1",
1598
- },
1599
- type: "THUMBS_UP",
1600
- text: "Great answer!",
3006
+ await client.inbox.applyFixes("inboxItemId", {
3007
+ appId: "appId",
3008
+ fixReferenceIds: ["fixReferenceIds", "fixReferenceIds"],
1601
3009
  });
1602
3010
  ```
1603
3011
 
@@ -1614,7 +3022,7 @@ await client.conversation.createFeedback({
1614
3022
  <dl>
1615
3023
  <dd>
1616
3024
 
1617
- **request:** `MavenAGI.FeedbackRequest`
3025
+ **inboxItemId:** `string` — Unique identifier for the inbox item.
1618
3026
 
1619
3027
  </dd>
1620
3028
  </dl>
@@ -1622,7 +3030,15 @@ await client.conversation.createFeedback({
1622
3030
  <dl>
1623
3031
  <dd>
1624
3032
 
1625
- **requestOptions:** `Conversation.RequestOptions`
3033
+ **request:** `MavenAGI.ApplyFixesRequest`
3034
+
3035
+ </dd>
3036
+ </dl>
3037
+
3038
+ <dl>
3039
+ <dd>
3040
+
3041
+ **requestOptions:** `Inbox.RequestOptions`
1626
3042
 
1627
3043
  </dd>
1628
3044
  </dl>
@@ -1633,7 +3049,7 @@ await client.conversation.createFeedback({
1633
3049
  </dl>
1634
3050
  </details>
1635
3051
 
1636
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">submitActionForm</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
3052
+ <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">ignore</a>(inboxItemId, { ...params }) -> void</code></summary>
1637
3053
  <dl>
1638
3054
  <dd>
1639
3055
 
@@ -1645,7 +3061,7 @@ await client.conversation.createFeedback({
1645
3061
  <dl>
1646
3062
  <dd>
1647
3063
 
1648
- Submit a filled out action form
3064
+ Ignore a specific inbox item by its ID.
1649
3065
 
1650
3066
  </dd>
1651
3067
  </dl>
@@ -1661,13 +3077,8 @@ Submit a filled out action form
1661
3077
  <dd>
1662
3078
 
1663
3079
  ```typescript
1664
- await client.conversation.submitActionForm("conversationId", {
1665
- actionFormId: "actionFormId",
1666
- parameters: {
1667
- parameters: {
1668
- key: "value",
1669
- },
1670
- },
3080
+ await client.inbox.ignore("inboxItemId", {
3081
+ appId: "appId",
1671
3082
  });
1672
3083
  ```
1673
3084
 
@@ -1684,7 +3095,7 @@ await client.conversation.submitActionForm("conversationId", {
1684
3095
  <dl>
1685
3096
  <dd>
1686
3097
 
1687
- **conversationId:** `string` — The ID of a conversation the form being submitted belongs to
3098
+ **inboxItemId:** `string` — Unique identifier for the inbox item.
1688
3099
 
1689
3100
  </dd>
1690
3101
  </dl>
@@ -1692,7 +3103,7 @@ await client.conversation.submitActionForm("conversationId", {
1692
3103
  <dl>
1693
3104
  <dd>
1694
3105
 
1695
- **request:** `MavenAGI.SubmitActionFormRequest`
3106
+ **request:** `MavenAGI.InboxItemIgnoreRequest`
1696
3107
 
1697
3108
  </dd>
1698
3109
  </dl>
@@ -1700,7 +3111,7 @@ await client.conversation.submitActionForm("conversationId", {
1700
3111
  <dl>
1701
3112
  <dd>
1702
3113
 
1703
- **requestOptions:** `Conversation.RequestOptions`
3114
+ **requestOptions:** `Inbox.RequestOptions`
1704
3115
 
1705
3116
  </dd>
1706
3117
  </dl>
@@ -1711,7 +3122,9 @@ await client.conversation.submitActionForm("conversationId", {
1711
3122
  </dl>
1712
3123
  </details>
1713
3124
 
1714
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">addConversationMetadata</a>(conversationId, { ...params }) -> Record<string, string></code></summary>
3125
+ ## Knowledge
3126
+
3127
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">searchKnowledgeBases</a>({ ...params }) -> MavenAGI.KnowledgeBasesResponse</code></summary>
1715
3128
  <dl>
1716
3129
  <dd>
1717
3130
 
@@ -1723,9 +3136,7 @@ await client.conversation.submitActionForm("conversationId", {
1723
3136
  <dl>
1724
3137
  <dd>
1725
3138
 
1726
- Replaced by `updateConversationMetadata`.
1727
-
1728
- Adds metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
3139
+ Search knowledge bases
1729
3140
 
1730
3141
  </dd>
1731
3142
  </dl>
@@ -1741,9 +3152,7 @@ Adds metadata to an existing conversation. If a metadata field already exists, i
1741
3152
  <dd>
1742
3153
 
1743
3154
  ```typescript
1744
- await client.conversation.addConversationMetadata("conversationId", {
1745
- string: "string",
1746
- });
3155
+ await client.knowledge.searchKnowledgeBases({});
1747
3156
  ```
1748
3157
 
1749
3158
  </dd>
@@ -1759,15 +3168,7 @@ await client.conversation.addConversationMetadata("conversationId", {
1759
3168
  <dl>
1760
3169
  <dd>
1761
3170
 
1762
- **conversationId:** `string` — The ID of a conversation the metadata being added belongs to
1763
-
1764
- </dd>
1765
- </dl>
1766
-
1767
- <dl>
1768
- <dd>
1769
-
1770
- **request:** `Record<string, string>`
3171
+ **request:** `MavenAGI.KnowledgeBaseSearchRequest`
1771
3172
 
1772
3173
  </dd>
1773
3174
  </dl>
@@ -1775,7 +3176,7 @@ await client.conversation.addConversationMetadata("conversationId", {
1775
3176
  <dl>
1776
3177
  <dd>
1777
3178
 
1778
- **requestOptions:** `Conversation.RequestOptions`
3179
+ **requestOptions:** `Knowledge.RequestOptions`
1779
3180
 
1780
3181
  </dd>
1781
3182
  </dl>
@@ -1786,7 +3187,7 @@ await client.conversation.addConversationMetadata("conversationId", {
1786
3187
  </dl>
1787
3188
  </details>
1788
3189
 
1789
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">updateConversationMetadata</a>(conversationId, { ...params }) -> MavenAGI.ConversationMetadata</code></summary>
3190
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">createOrUpdateKnowledgeBase</a>({ ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
1790
3191
  <dl>
1791
3192
  <dd>
1792
3193
 
@@ -1798,13 +3199,7 @@ await client.conversation.addConversationMetadata("conversationId", {
1798
3199
  <dl>
1799
3200
  <dd>
1800
3201
 
1801
- Update metadata supplied by the calling application for an existing conversation.
1802
- Does not modify metadata saved by other apps.
1803
-
1804
- If a metadata field already exists for the calling app, it will be overwritten.
1805
- If it does not exist, it will be added. Will not remove metadata fields.
1806
-
1807
- Returns all metadata saved by any app on the conversation.
3202
+ Update a knowledge base or create it if it doesn't exist.
1808
3203
 
1809
3204
  </dd>
1810
3205
  </dl>
@@ -1820,11 +3215,11 @@ Returns all metadata saved by any app on the conversation.
1820
3215
  <dd>
1821
3216
 
1822
3217
  ```typescript
1823
- await client.conversation.updateConversationMetadata("conversation-0", {
1824
- appId: "conversation-owning-app",
1825
- values: {
1826
- key: "newValue",
3218
+ await client.knowledge.createOrUpdateKnowledgeBase({
3219
+ knowledgeBaseId: {
3220
+ referenceId: "help-center",
1827
3221
  },
3222
+ name: "Help center",
1828
3223
  });
1829
3224
  ```
1830
3225
 
@@ -1841,15 +3236,7 @@ await client.conversation.updateConversationMetadata("conversation-0", {
1841
3236
  <dl>
1842
3237
  <dd>
1843
3238
 
1844
- **conversationId:** `string` — The ID of the conversation to modify metadata for
1845
-
1846
- </dd>
1847
- </dl>
1848
-
1849
- <dl>
1850
- <dd>
1851
-
1852
- **request:** `MavenAGI.UpdateMetadataRequest`
3239
+ **request:** `MavenAGI.KnowledgeBaseRequest`
1853
3240
 
1854
3241
  </dd>
1855
3242
  </dl>
@@ -1857,7 +3244,7 @@ await client.conversation.updateConversationMetadata("conversation-0", {
1857
3244
  <dl>
1858
3245
  <dd>
1859
3246
 
1860
- **requestOptions:** `Conversation.RequestOptions`
3247
+ **requestOptions:** `Knowledge.RequestOptions`
1861
3248
 
1862
3249
  </dd>
1863
3250
  </dl>
@@ -1868,7 +3255,7 @@ await client.conversation.updateConversationMetadata("conversation-0", {
1868
3255
  </dl>
1869
3256
  </details>
1870
3257
 
1871
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">search</a>({ ...params }) -> MavenAGI.ConversationsResponse</code></summary>
3258
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">getKnowledgeBase</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
1872
3259
  <dl>
1873
3260
  <dd>
1874
3261
 
@@ -1880,7 +3267,7 @@ await client.conversation.updateConversationMetadata("conversation-0", {
1880
3267
  <dl>
1881
3268
  <dd>
1882
3269
 
1883
- Search conversations
3270
+ Get an existing knowledge base by its supplied ID
1884
3271
 
1885
3272
  </dd>
1886
3273
  </dl>
@@ -1896,7 +3283,7 @@ Search conversations
1896
3283
  <dd>
1897
3284
 
1898
3285
  ```typescript
1899
- await client.conversation.search({});
3286
+ await client.knowledge.getKnowledgeBase("help-center");
1900
3287
  ```
1901
3288
 
1902
3289
  </dd>
@@ -1912,7 +3299,7 @@ await client.conversation.search({});
1912
3299
  <dl>
1913
3300
  <dd>
1914
3301
 
1915
- **request:** `MavenAGI.ConversationsSearchRequest`
3302
+ **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to get. All other entity ID fields are inferred from the request.
1916
3303
 
1917
3304
  </dd>
1918
3305
  </dl>
@@ -1920,7 +3307,15 @@ await client.conversation.search({});
1920
3307
  <dl>
1921
3308
  <dd>
1922
3309
 
1923
- **requestOptions:** `Conversation.RequestOptions`
3310
+ **request:** `MavenAGI.KnowledgeBaseGetRequest`
3311
+
3312
+ </dd>
3313
+ </dl>
3314
+
3315
+ <dl>
3316
+ <dd>
3317
+
3318
+ **requestOptions:** `Knowledge.RequestOptions`
1924
3319
 
1925
3320
  </dd>
1926
3321
  </dl>
@@ -1931,9 +3326,7 @@ await client.conversation.search({});
1931
3326
  </dl>
1932
3327
  </details>
1933
3328
 
1934
- ## Events
1935
-
1936
- <details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventsSearchResponse</code></summary>
3329
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">patchKnowledgeBase</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
1937
3330
  <dl>
1938
3331
  <dd>
1939
3332
 
@@ -1945,7 +3338,10 @@ await client.conversation.search({});
1945
3338
  <dl>
1946
3339
  <dd>
1947
3340
 
1948
- Search events
3341
+ Update mutable knowledge base fields
3342
+
3343
+ The `appId` field can be provided to update a knowledge base owned by a different app.
3344
+ All other fields will overwrite the existing value on the knowledge base only if provided.
1949
3345
 
1950
3346
  </dd>
1951
3347
  </dl>
@@ -1961,7 +3357,7 @@ Search events
1961
3357
  <dd>
1962
3358
 
1963
3359
  ```typescript
1964
- await client.events.search({});
3360
+ await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId", {});
1965
3361
  ```
1966
3362
 
1967
3363
  </dd>
@@ -1977,7 +3373,7 @@ await client.events.search({});
1977
3373
  <dl>
1978
3374
  <dd>
1979
3375
 
1980
- **request:** `MavenAGI.EventsSearchRequest`
3376
+ **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to patch.
1981
3377
 
1982
3378
  </dd>
1983
3379
  </dl>
@@ -1985,7 +3381,15 @@ await client.events.search({});
1985
3381
  <dl>
1986
3382
  <dd>
1987
3383
 
1988
- **requestOptions:** `Events.RequestOptions`
3384
+ **request:** `MavenAGI.KnowledgeBasePatchRequest`
3385
+
3386
+ </dd>
3387
+ </dl>
3388
+
3389
+ <dl>
3390
+ <dd>
3391
+
3392
+ **requestOptions:** `Knowledge.RequestOptions`
1989
3393
 
1990
3394
  </dd>
1991
3395
  </dl>
@@ -1996,9 +3400,7 @@ await client.events.search({});
1996
3400
  </dl>
1997
3401
  </details>
1998
3402
 
1999
- ## Inbox
2000
-
2001
- <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">search</a>({ ...params }) -> MavenAGI.InboxSearchResponse</code></summary>
3403
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">createKnowledgeBaseVersion</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseVersion</code></summary>
2002
3404
  <dl>
2003
3405
  <dd>
2004
3406
 
@@ -2010,14 +3412,43 @@ await client.events.search({});
2010
3412
  <dl>
2011
3413
  <dd>
2012
3414
 
2013
- Retrieve a paginated list of inbox items for an agent.
3415
+ Create a new knowledge base version.
3416
+
3417
+ If an existing version is in progress, then that version will be finalized in an error state.
3418
+
3419
+ </dd>
3420
+ </dl>
3421
+ </dd>
3422
+ </dl>
3423
+
3424
+ #### 🔌 Usage
3425
+
3426
+ <dl>
3427
+ <dd>
3428
+
3429
+ <dl>
3430
+ <dd>
3431
+
3432
+ ```typescript
3433
+ await client.knowledge.createKnowledgeBaseVersion("help-center", {
3434
+ versionId: {
3435
+ type: "KNOWLEDGE_BASE_VERSION",
3436
+ referenceId: "versionId",
3437
+ appId: "maven",
3438
+ organizationId: "acme",
3439
+ agentId: "support",
3440
+ },
3441
+ type: "FULL",
3442
+ status: "IN_PROGRESS",
3443
+ });
3444
+ ```
2014
3445
 
2015
3446
  </dd>
2016
3447
  </dl>
2017
3448
  </dd>
2018
3449
  </dl>
2019
3450
 
2020
- #### 🔌 Usage
3451
+ #### ⚙️ Parameters
2021
3452
 
2022
3453
  <dl>
2023
3454
  <dd>
@@ -2025,24 +3456,15 @@ Retrieve a paginated list of inbox items for an agent.
2025
3456
  <dl>
2026
3457
  <dd>
2027
3458
 
2028
- ```typescript
2029
- await client.inbox.search({});
2030
- ```
3459
+ **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to create a version for. All other entity ID fields are inferred from the request.
2031
3460
 
2032
3461
  </dd>
2033
3462
  </dl>
2034
- </dd>
2035
- </dl>
2036
-
2037
- #### ⚙️ Parameters
2038
-
2039
- <dl>
2040
- <dd>
2041
3463
 
2042
3464
  <dl>
2043
3465
  <dd>
2044
3466
 
2045
- **request:** `MavenAGI.InboxSearchRequest`
3467
+ **request:** `MavenAGI.KnowledgeBaseVersion`
2046
3468
 
2047
3469
  </dd>
2048
3470
  </dl>
@@ -2050,7 +3472,7 @@ await client.inbox.search({});
2050
3472
  <dl>
2051
3473
  <dd>
2052
3474
 
2053
- **requestOptions:** `Inbox.RequestOptions`
3475
+ **requestOptions:** `Knowledge.RequestOptions`
2054
3476
 
2055
3477
  </dd>
2056
3478
  </dl>
@@ -2061,7 +3483,7 @@ await client.inbox.search({});
2061
3483
  </dl>
2062
3484
  </details>
2063
3485
 
2064
- <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">get</a>(inboxItemId, { ...params }) -> MavenAGI.InboxItem</code></summary>
3486
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">finalizeKnowledgeBaseVersion</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseVersion</code></summary>
2065
3487
  <dl>
2066
3488
  <dd>
2067
3489
 
@@ -2073,7 +3495,7 @@ await client.inbox.search({});
2073
3495
  <dl>
2074
3496
  <dd>
2075
3497
 
2076
- Retrieve details of a specific inbox item by its ID.
3498
+ Finalize the latest knowledge base version. Required to indicate the version is complete. Will throw an exception if the latest version is not in progress.
2077
3499
 
2078
3500
  </dd>
2079
3501
  </dl>
@@ -2089,9 +3511,13 @@ Retrieve details of a specific inbox item by its ID.
2089
3511
  <dd>
2090
3512
 
2091
3513
  ```typescript
2092
- await client.inbox.get("inboxItemId", {
2093
- appId: "appId",
2094
- itemType: "DUPLICATE_DOCUMENT",
3514
+ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
3515
+ versionId: {
3516
+ type: "KNOWLEDGE_BASE_VERSION",
3517
+ referenceId: "versionId",
3518
+ appId: "maven",
3519
+ },
3520
+ status: "SUCCEEDED",
2095
3521
  });
2096
3522
  ```
2097
3523
 
@@ -2108,7 +3534,7 @@ await client.inbox.get("inboxItemId", {
2108
3534
  <dl>
2109
3535
  <dd>
2110
3536
 
2111
- **inboxItemId:** `string` — The ID of the inbox item to get. All other entity ID fields are inferred from the request.
3537
+ **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to finalize a version for. All other entity ID fields are inferred from the request.
2112
3538
 
2113
3539
  </dd>
2114
3540
  </dl>
@@ -2116,7 +3542,7 @@ await client.inbox.get("inboxItemId", {
2116
3542
  <dl>
2117
3543
  <dd>
2118
3544
 
2119
- **request:** `MavenAGI.InboxItemRequest`
3545
+ **request:** `MavenAGI.FinalizeKnowledgeBaseVersionRequest`
2120
3546
 
2121
3547
  </dd>
2122
3548
  </dl>
@@ -2124,7 +3550,7 @@ await client.inbox.get("inboxItemId", {
2124
3550
  <dl>
2125
3551
  <dd>
2126
3552
 
2127
- **requestOptions:** `Inbox.RequestOptions`
3553
+ **requestOptions:** `Knowledge.RequestOptions`
2128
3554
 
2129
3555
  </dd>
2130
3556
  </dl>
@@ -2135,7 +3561,7 @@ await client.inbox.get("inboxItemId", {
2135
3561
  </dl>
2136
3562
  </details>
2137
3563
 
2138
- <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">getFix</a>(inboxItemFixId, { ...params }) -> MavenAGI.InboxItemFix</code></summary>
3564
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">searchKnowledgeDocuments</a>({ ...params }) -> MavenAGI.KnowledgeDocumentsResponse</code></summary>
2139
3565
  <dl>
2140
3566
  <dd>
2141
3567
 
@@ -2147,7 +3573,7 @@ await client.inbox.get("inboxItemId", {
2147
3573
  <dl>
2148
3574
  <dd>
2149
3575
 
2150
- Retrieve a suggested fix. Includes document information if the fix is a Missing Knowledge suggestion.
3576
+ Search knowledge documents
2151
3577
 
2152
3578
  </dd>
2153
3579
  </dl>
@@ -2163,10 +3589,7 @@ Retrieve a suggested fix. Includes document information if the fix is a Missing
2163
3589
  <dd>
2164
3590
 
2165
3591
  ```typescript
2166
- await client.inbox.getFix("inboxItemFixId", {
2167
- appId: "appId",
2168
- fixType: "REMOVE_DOCUMENT",
2169
- });
3592
+ await client.knowledge.searchKnowledgeDocuments({});
2170
3593
  ```
2171
3594
 
2172
3595
  </dd>
@@ -2182,15 +3605,7 @@ await client.inbox.getFix("inboxItemFixId", {
2182
3605
  <dl>
2183
3606
  <dd>
2184
3607
 
2185
- **inboxItemFixId:** `string` — Unique identifier for the inbox fix.
2186
-
2187
- </dd>
2188
- </dl>
2189
-
2190
- <dl>
2191
- <dd>
2192
-
2193
- **request:** `MavenAGI.InboxItemFixRequest`
3608
+ **request:** `MavenAGI.KnowledgeDocumentSearchRequest`
2194
3609
 
2195
3610
  </dd>
2196
3611
  </dl>
@@ -2198,7 +3613,7 @@ await client.inbox.getFix("inboxItemFixId", {
2198
3613
  <dl>
2199
3614
  <dd>
2200
3615
 
2201
- **requestOptions:** `Inbox.RequestOptions`
3616
+ **requestOptions:** `Knowledge.RequestOptions`
2202
3617
 
2203
3618
  </dd>
2204
3619
  </dl>
@@ -2209,7 +3624,7 @@ await client.inbox.getFix("inboxItemFixId", {
2209
3624
  </dl>
2210
3625
  </details>
2211
3626
 
2212
- <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">applyFix</a>(inboxItemFixId, { ...params }) -> void</code></summary>
3627
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">createKnowledgeDocument</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeDocumentResponse</code></summary>
2213
3628
  <dl>
2214
3629
  <dd>
2215
3630
 
@@ -2221,8 +3636,12 @@ await client.inbox.getFix("inboxItemFixId", {
2221
3636
  <dl>
2222
3637
  <dd>
2223
3638
 
2224
- Apply a fix to an inbox item with a specific document.
3639
+ Create knowledge document. Requires an existing knowledge base with an in progress version. Will throw an exception if the latest version is not in progress.
2225
3640
 
3641
+ <Tip>
3642
+ This API maintains document version history. If for the same reference ID neither the `title` nor `text` fields
3643
+ have changed, a new document version will not be created. The existing version will be reused.
3644
+ </Tip>
2226
3645
  </dd>
2227
3646
  </dl>
2228
3647
  </dd>
@@ -2237,9 +3656,21 @@ Apply a fix to an inbox item with a specific document.
2237
3656
  <dd>
2238
3657
 
2239
3658
  ```typescript
2240
- await client.inbox.applyFix("inboxItemFixId", {
2241
- appId: "appId",
2242
- fixType: "REMOVE_DOCUMENT",
3659
+ await client.knowledge.createKnowledgeDocument("help-center", {
3660
+ knowledgeDocumentId: {
3661
+ referenceId: "getting-started",
3662
+ },
3663
+ versionId: {
3664
+ type: "KNOWLEDGE_BASE_VERSION",
3665
+ referenceId: "versionId",
3666
+ appId: "maven",
3667
+ },
3668
+ contentType: "MARKDOWN",
3669
+ content: "## Getting started\\nThis is a getting started guide for the help center.",
3670
+ title: "Getting started",
3671
+ metadata: {
3672
+ category: "getting-started",
3673
+ },
2243
3674
  });
2244
3675
  ```
2245
3676
 
@@ -2256,7 +3687,7 @@ await client.inbox.applyFix("inboxItemFixId", {
2256
3687
  <dl>
2257
3688
  <dd>
2258
3689
 
2259
- **inboxItemFixId:** `string` — Unique identifier for the inbox fix.
3690
+ **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to create a document for. All other entity ID fields are inferred from the request.
2260
3691
 
2261
3692
  </dd>
2262
3693
  </dl>
@@ -2264,7 +3695,7 @@ await client.inbox.applyFix("inboxItemFixId", {
2264
3695
  <dl>
2265
3696
  <dd>
2266
3697
 
2267
- **request:** `MavenAGI.ApplyInboxItemFixRequest`
3698
+ **request:** `MavenAGI.KnowledgeDocumentRequest`
2268
3699
 
2269
3700
  </dd>
2270
3701
  </dl>
@@ -2272,7 +3703,7 @@ await client.inbox.applyFix("inboxItemFixId", {
2272
3703
  <dl>
2273
3704
  <dd>
2274
3705
 
2275
- **requestOptions:** `Inbox.RequestOptions`
3706
+ **requestOptions:** `Knowledge.RequestOptions`
2276
3707
 
2277
3708
  </dd>
2278
3709
  </dl>
@@ -2283,7 +3714,7 @@ await client.inbox.applyFix("inboxItemFixId", {
2283
3714
  </dl>
2284
3715
  </details>
2285
3716
 
2286
- <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">ignore</a>(inboxItemId, { ...params }) -> void</code></summary>
3717
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">updateKnowledgeDocument</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeDocumentResponse</code></summary>
2287
3718
  <dl>
2288
3719
  <dd>
2289
3720
 
@@ -2295,7 +3726,7 @@ await client.inbox.applyFix("inboxItemFixId", {
2295
3726
  <dl>
2296
3727
  <dd>
2297
3728
 
2298
- Ignore a specific inbox item by its ID.
3729
+ Not yet implemented. Update knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.
2299
3730
 
2300
3731
  </dd>
2301
3732
  </dl>
@@ -2311,9 +3742,21 @@ Ignore a specific inbox item by its ID.
2311
3742
  <dd>
2312
3743
 
2313
3744
  ```typescript
2314
- await client.inbox.ignore("inboxItemId", {
2315
- appId: "appId",
2316
- itemType: "DUPLICATE_DOCUMENT",
3745
+ await client.knowledge.updateKnowledgeDocument("help-center", {
3746
+ knowledgeDocumentId: {
3747
+ referenceId: "getting-started",
3748
+ },
3749
+ versionId: {
3750
+ type: "KNOWLEDGE_BASE_VERSION",
3751
+ referenceId: "versionId",
3752
+ appId: "maven",
3753
+ },
3754
+ contentType: "MARKDOWN",
3755
+ content: "## Getting started\\nThis is a getting started guide for the help center.",
3756
+ title: "Getting started",
3757
+ metadata: {
3758
+ category: "getting-started",
3759
+ },
2317
3760
  });
2318
3761
  ```
2319
3762
 
@@ -2330,7 +3773,7 @@ await client.inbox.ignore("inboxItemId", {
2330
3773
  <dl>
2331
3774
  <dd>
2332
3775
 
2333
- **inboxItemId:** `string` — Unique identifier for the inbox item.
3776
+ **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base that contains the document to update. All other entity ID fields are inferred from the request.
2334
3777
 
2335
3778
  </dd>
2336
3779
  </dl>
@@ -2338,7 +3781,7 @@ await client.inbox.ignore("inboxItemId", {
2338
3781
  <dl>
2339
3782
  <dd>
2340
3783
 
2341
- **request:** `MavenAGI.InboxItemIgnoreRequest`
3784
+ **request:** `MavenAGI.KnowledgeDocumentRequest`
2342
3785
 
2343
3786
  </dd>
2344
3787
  </dl>
@@ -2346,7 +3789,7 @@ await client.inbox.ignore("inboxItemId", {
2346
3789
  <dl>
2347
3790
  <dd>
2348
3791
 
2349
- **requestOptions:** `Inbox.RequestOptions`
3792
+ **requestOptions:** `Knowledge.RequestOptions`
2350
3793
 
2351
3794
  </dd>
2352
3795
  </dl>
@@ -2357,9 +3800,7 @@ await client.inbox.ignore("inboxItemId", {
2357
3800
  </dl>
2358
3801
  </details>
2359
3802
 
2360
- ## Knowledge
2361
-
2362
- <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">createOrUpdateKnowledgeBase</a>({ ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
3803
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">deleteKnowledgeDocument</a>(knowledgeBaseReferenceId, knowledgeDocumentReferenceId) -> void</code></summary>
2363
3804
  <dl>
2364
3805
  <dd>
2365
3806
 
@@ -2371,7 +3812,7 @@ await client.inbox.ignore("inboxItemId", {
2371
3812
  <dl>
2372
3813
  <dd>
2373
3814
 
2374
- Update a knowledge base or create it if it doesn't exist.
3815
+ Not yet implemented. Delete knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.
2375
3816
 
2376
3817
  </dd>
2377
3818
  </dl>
@@ -2387,12 +3828,7 @@ Update a knowledge base or create it if it doesn't exist.
2387
3828
  <dd>
2388
3829
 
2389
3830
  ```typescript
2390
- await client.knowledge.createOrUpdateKnowledgeBase({
2391
- knowledgeBaseId: {
2392
- referenceId: "help-center",
2393
- },
2394
- name: "Help center",
2395
- });
3831
+ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started");
2396
3832
  ```
2397
3833
 
2398
3834
  </dd>
@@ -2408,7 +3844,15 @@ await client.knowledge.createOrUpdateKnowledgeBase({
2408
3844
  <dl>
2409
3845
  <dd>
2410
3846
 
2411
- **request:** `MavenAGI.KnowledgeBaseRequest`
3847
+ **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base that contains the document to delete. All other entity ID fields are inferred from the request
3848
+
3849
+ </dd>
3850
+ </dl>
3851
+
3852
+ <dl>
3853
+ <dd>
3854
+
3855
+ **knowledgeDocumentReferenceId:** `string` — The reference ID of the knowledge document to delete. All other entity ID fields are inferred from the request.
2412
3856
 
2413
3857
  </dd>
2414
3858
  </dl>
@@ -2427,7 +3871,9 @@ await client.knowledge.createOrUpdateKnowledgeBase({
2427
3871
  </dl>
2428
3872
  </details>
2429
3873
 
2430
- <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">getKnowledgeBase</a>(knowledgeBaseReferenceId) -> MavenAGI.KnowledgeBaseResponse</code></summary>
3874
+ ## Organizations
3875
+
3876
+ <details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
2431
3877
  <dl>
2432
3878
  <dd>
2433
3879
 
@@ -2439,8 +3885,12 @@ await client.knowledge.createOrUpdateKnowledgeBase({
2439
3885
  <dl>
2440
3886
  <dd>
2441
3887
 
2442
- Get an existing knowledge base by its supplied ID
3888
+ Retrieves structured conversation data across all organizations, formatted as a table,
3889
+ allowing users to group, filter, and define specific metrics to display as columns.
2443
3890
 
3891
+ <Tip>
3892
+ This endpoint requires additional permissions. Contact support to request access.
3893
+ </Tip>
2444
3894
  </dd>
2445
3895
  </dl>
2446
3896
  </dd>
@@ -2455,7 +3905,40 @@ Get an existing knowledge base by its supplied ID
2455
3905
  <dd>
2456
3906
 
2457
3907
  ```typescript
2458
- await client.knowledge.getKnowledgeBase("help-center");
3908
+ await client.organizations.getConversationTable({
3909
+ conversationFilter: {
3910
+ languages: ["en", "es"],
3911
+ },
3912
+ timeGrouping: "DAY",
3913
+ fieldGroupings: [
3914
+ {
3915
+ field: "Category",
3916
+ },
3917
+ ],
3918
+ columnDefinitions: [
3919
+ {
3920
+ header: "count",
3921
+ metric: {
3922
+ type: "count",
3923
+ },
3924
+ },
3925
+ {
3926
+ header: "avg_first_response_time",
3927
+ metric: {
3928
+ type: "average",
3929
+ targetField: "FirstResponseTime",
3930
+ },
3931
+ },
3932
+ {
3933
+ header: "percentile_handle_time",
3934
+ metric: {
3935
+ type: "percentile",
3936
+ targetField: "HandleTime",
3937
+ percentile: 25,
3938
+ },
3939
+ },
3940
+ ],
3941
+ });
2459
3942
  ```
2460
3943
 
2461
3944
  </dd>
@@ -2471,7 +3954,7 @@ await client.knowledge.getKnowledgeBase("help-center");
2471
3954
  <dl>
2472
3955
  <dd>
2473
3956
 
2474
- **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to get. All other entity ID fields are inferred from the request.
3957
+ **request:** `MavenAGI.ConversationTableRequest`
2475
3958
 
2476
3959
  </dd>
2477
3960
  </dl>
@@ -2479,7 +3962,7 @@ await client.knowledge.getKnowledgeBase("help-center");
2479
3962
  <dl>
2480
3963
  <dd>
2481
3964
 
2482
- **requestOptions:** `Knowledge.RequestOptions`
3965
+ **requestOptions:** `Organizations.RequestOptions`
2483
3966
 
2484
3967
  </dd>
2485
3968
  </dl>
@@ -2490,7 +3973,7 @@ await client.knowledge.getKnowledgeBase("help-center");
2490
3973
  </dl>
2491
3974
  </details>
2492
3975
 
2493
- <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">createKnowledgeBaseVersion</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseVersion</code></summary>
3976
+ <details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getConversationChart</a>({ ...params }) -> MavenAGI.ChartResponse</code></summary>
2494
3977
  <dl>
2495
3978
  <dd>
2496
3979
 
@@ -2502,10 +3985,12 @@ await client.knowledge.getKnowledgeBase("help-center");
2502
3985
  <dl>
2503
3986
  <dd>
2504
3987
 
2505
- Create a new knowledge base version.
2506
-
2507
- If an existing version is in progress, then that version will be finalized in an error state.
3988
+ Fetches conversation data across all organizations, visualized in a chart format.
3989
+ Supported chart types include pie chart, date histogram, and stacked bar charts.
2508
3990
 
3991
+ <Tip>
3992
+ This endpoint requires additional permissions. Contact support to request access.
3993
+ </Tip>
2509
3994
  </dd>
2510
3995
  </dl>
2511
3996
  </dd>
@@ -2520,16 +4005,17 @@ If an existing version is in progress, then that version will be finalized in an
2520
4005
  <dd>
2521
4006
 
2522
4007
  ```typescript
2523
- await client.knowledge.createKnowledgeBaseVersion("help-center", {
2524
- versionId: {
2525
- type: "KNOWLEDGE_BASE_VERSION",
2526
- referenceId: "versionId",
2527
- appId: "maven",
2528
- organizationId: "acme",
2529
- agentId: "support",
4008
+ await client.organizations.getConversationChart({
4009
+ type: "pieChart",
4010
+ conversationFilter: {
4011
+ languages: ["en", "es"],
4012
+ },
4013
+ groupBy: {
4014
+ field: "Category",
4015
+ },
4016
+ metric: {
4017
+ type: "count",
2530
4018
  },
2531
- type: "FULL",
2532
- status: "IN_PROGRESS",
2533
4019
  });
2534
4020
  ```
2535
4021
 
@@ -2546,15 +4032,7 @@ await client.knowledge.createKnowledgeBaseVersion("help-center", {
2546
4032
  <dl>
2547
4033
  <dd>
2548
4034
 
2549
- **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to create a version for. All other entity ID fields are inferred from the request.
2550
-
2551
- </dd>
2552
- </dl>
2553
-
2554
- <dl>
2555
- <dd>
2556
-
2557
- **request:** `MavenAGI.KnowledgeBaseVersion`
4035
+ **request:** `MavenAGI.ConversationChartRequest`
2558
4036
 
2559
4037
  </dd>
2560
4038
  </dl>
@@ -2562,7 +4040,7 @@ await client.knowledge.createKnowledgeBaseVersion("help-center", {
2562
4040
  <dl>
2563
4041
  <dd>
2564
4042
 
2565
- **requestOptions:** `Knowledge.RequestOptions`
4043
+ **requestOptions:** `Organizations.RequestOptions`
2566
4044
 
2567
4045
  </dd>
2568
4046
  </dl>
@@ -2573,25 +4051,12 @@ await client.knowledge.createKnowledgeBaseVersion("help-center", {
2573
4051
  </dl>
2574
4052
  </details>
2575
4053
 
2576
- <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">finalizeKnowledgeBaseVersion</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseVersion</code></summary>
2577
- <dl>
2578
- <dd>
2579
-
2580
- #### 📝 Description
2581
-
2582
- <dl>
2583
- <dd>
4054
+ ## Segments
2584
4055
 
4056
+ <details><summary><code>client.segments.<a href="/src/api/resources/segments/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SegmentsSearchResponse</code></summary>
2585
4057
  <dl>
2586
4058
  <dd>
2587
4059
 
2588
- Finalize the latest knowledge base version. Required to indicate the version is complete. Will throw an exception if the latest version is not in progress.
2589
-
2590
- </dd>
2591
- </dl>
2592
- </dd>
2593
- </dl>
2594
-
2595
4060
  #### 🔌 Usage
2596
4061
 
2597
4062
  <dl>
@@ -2601,14 +4066,7 @@ Finalize the latest knowledge base version. Required to indicate the version is
2601
4066
  <dd>
2602
4067
 
2603
4068
  ```typescript
2604
- await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
2605
- versionId: {
2606
- type: "KNOWLEDGE_BASE_VERSION",
2607
- referenceId: "versionId",
2608
- appId: "maven",
2609
- },
2610
- status: "SUCCEEDED",
2611
- });
4069
+ await client.segments.search({});
2612
4070
  ```
2613
4071
 
2614
4072
  </dd>
@@ -2624,15 +4082,7 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
2624
4082
  <dl>
2625
4083
  <dd>
2626
4084
 
2627
- **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to finalize a version for. All other entity ID fields are inferred from the request.
2628
-
2629
- </dd>
2630
- </dl>
2631
-
2632
- <dl>
2633
- <dd>
2634
-
2635
- **request:** `MavenAGI.FinalizeKnowledgeBaseVersionRequest`
4085
+ **request:** `MavenAGI.SegmentsSearchRequest`
2636
4086
 
2637
4087
  </dd>
2638
4088
  </dl>
@@ -2640,7 +4090,7 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
2640
4090
  <dl>
2641
4091
  <dd>
2642
4092
 
2643
- **requestOptions:** `Knowledge.RequestOptions`
4093
+ **requestOptions:** `Segments.RequestOptions`
2644
4094
 
2645
4095
  </dd>
2646
4096
  </dl>
@@ -2651,7 +4101,7 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
2651
4101
  </dl>
2652
4102
  </details>
2653
4103
 
2654
- <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">createKnowledgeDocument</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeDocumentResponse</code></summary>
4104
+ <details><summary><code>client.segments.<a href="/src/api/resources/segments/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.SegmentResponse</code></summary>
2655
4105
  <dl>
2656
4106
  <dd>
2657
4107
 
@@ -2663,12 +4113,8 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
2663
4113
  <dl>
2664
4114
  <dd>
2665
4115
 
2666
- Create knowledge document. Requires an existing knowledge base with an in progress version. Will throw an exception if the latest version is not in progress.
4116
+ Update a segment or create it if it doesn't exist.
2667
4117
 
2668
- <Tip>
2669
- This API maintains document version history. If for the same reference ID neither the `title` nor `text` fields
2670
- have changed, a new document version will not be created. The existing version will be reused.
2671
- </Tip>
2672
4118
  </dd>
2673
4119
  </dl>
2674
4120
  </dd>
@@ -2683,20 +4129,24 @@ have changed, a new document version will not be created. The existing version w
2683
4129
  <dd>
2684
4130
 
2685
4131
  ```typescript
2686
- await client.knowledge.createKnowledgeDocument("help-center", {
2687
- knowledgeDocumentId: {
2688
- referenceId: "getting-started",
2689
- },
2690
- versionId: {
2691
- type: "KNOWLEDGE_BASE_VERSION",
2692
- referenceId: "versionId",
2693
- appId: "maven",
4132
+ await client.segments.createOrUpdate({
4133
+ segmentId: {
4134
+ referenceId: "admin-users",
2694
4135
  },
2695
- contentType: "MARKDOWN",
2696
- content: "## Getting started\\nThis is a getting started guide for the help center.",
2697
- title: "Getting started",
2698
- metadata: {
2699
- category: "getting-started",
4136
+ name: "Admin users",
4137
+ precondition: {
4138
+ preconditionType: "group",
4139
+ operator: "AND",
4140
+ preconditions: [
4141
+ {
4142
+ preconditionType: "user",
4143
+ key: "userKey",
4144
+ },
4145
+ {
4146
+ preconditionType: "user",
4147
+ key: "userKey2",
4148
+ },
4149
+ ],
2700
4150
  },
2701
4151
  });
2702
4152
  ```
@@ -2714,15 +4164,7 @@ await client.knowledge.createKnowledgeDocument("help-center", {
2714
4164
  <dl>
2715
4165
  <dd>
2716
4166
 
2717
- **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to create a document for. All other entity ID fields are inferred from the request.
2718
-
2719
- </dd>
2720
- </dl>
2721
-
2722
- <dl>
2723
- <dd>
2724
-
2725
- **request:** `MavenAGI.KnowledgeDocumentRequest`
4167
+ **request:** `MavenAGI.SegmentRequest`
2726
4168
 
2727
4169
  </dd>
2728
4170
  </dl>
@@ -2730,7 +4172,7 @@ await client.knowledge.createKnowledgeDocument("help-center", {
2730
4172
  <dl>
2731
4173
  <dd>
2732
4174
 
2733
- **requestOptions:** `Knowledge.RequestOptions`
4175
+ **requestOptions:** `Segments.RequestOptions`
2734
4176
 
2735
4177
  </dd>
2736
4178
  </dl>
@@ -2741,7 +4183,7 @@ await client.knowledge.createKnowledgeDocument("help-center", {
2741
4183
  </dl>
2742
4184
  </details>
2743
4185
 
2744
- <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">updateKnowledgeDocument</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeDocumentResponse</code></summary>
4186
+ <details><summary><code>client.segments.<a href="/src/api/resources/segments/client/Client.ts">get</a>(segmentReferenceId, { ...params }) -> MavenAGI.SegmentResponse</code></summary>
2745
4187
  <dl>
2746
4188
  <dd>
2747
4189
 
@@ -2753,7 +4195,7 @@ await client.knowledge.createKnowledgeDocument("help-center", {
2753
4195
  <dl>
2754
4196
  <dd>
2755
4197
 
2756
- Not yet implemented. Update knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.
4198
+ Get a segment by its supplied ID
2757
4199
 
2758
4200
  </dd>
2759
4201
  </dl>
@@ -2769,22 +4211,7 @@ Not yet implemented. Update knowledge document. Requires an existing knowledge b
2769
4211
  <dd>
2770
4212
 
2771
4213
  ```typescript
2772
- await client.knowledge.updateKnowledgeDocument("help-center", {
2773
- knowledgeDocumentId: {
2774
- referenceId: "getting-started",
2775
- },
2776
- versionId: {
2777
- type: "KNOWLEDGE_BASE_VERSION",
2778
- referenceId: "versionId",
2779
- appId: "maven",
2780
- },
2781
- contentType: "MARKDOWN",
2782
- content: "## Getting started\\nThis is a getting started guide for the help center.",
2783
- title: "Getting started",
2784
- metadata: {
2785
- category: "getting-started",
2786
- },
2787
- });
4214
+ await client.segments.get("admin-users");
2788
4215
  ```
2789
4216
 
2790
4217
  </dd>
@@ -2800,7 +4227,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
2800
4227
  <dl>
2801
4228
  <dd>
2802
4229
 
2803
- **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base that contains the document to update. All other entity ID fields are inferred from the request.
4230
+ **segmentReferenceId:** `string` — The reference ID of the segment to get. All other entity ID fields are inferred from the request.
2804
4231
 
2805
4232
  </dd>
2806
4233
  </dl>
@@ -2808,7 +4235,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
2808
4235
  <dl>
2809
4236
  <dd>
2810
4237
 
2811
- **request:** `MavenAGI.KnowledgeDocumentRequest`
4238
+ **request:** `MavenAGI.SegmentGetRequest`
2812
4239
 
2813
4240
  </dd>
2814
4241
  </dl>
@@ -2816,7 +4243,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
2816
4243
  <dl>
2817
4244
  <dd>
2818
4245
 
2819
- **requestOptions:** `Knowledge.RequestOptions`
4246
+ **requestOptions:** `Segments.RequestOptions`
2820
4247
 
2821
4248
  </dd>
2822
4249
  </dl>
@@ -2827,7 +4254,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
2827
4254
  </dl>
2828
4255
  </details>
2829
4256
 
2830
- <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">deleteKnowledgeDocument</a>(knowledgeBaseReferenceId, knowledgeDocumentReferenceId) -> void</code></summary>
4257
+ <details><summary><code>client.segments.<a href="/src/api/resources/segments/client/Client.ts">patch</a>(segmentReferenceId, { ...params }) -> MavenAGI.SegmentResponse</code></summary>
2831
4258
  <dl>
2832
4259
  <dd>
2833
4260
 
@@ -2839,7 +4266,10 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
2839
4266
  <dl>
2840
4267
  <dd>
2841
4268
 
2842
- Not yet implemented. Delete knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.
4269
+ Update mutable segment fields
4270
+
4271
+ The `appId` field can be provided to update a segment owned by a different app.
4272
+ All other fields will overwrite the existing value on the segment only if provided.
2843
4273
 
2844
4274
  </dd>
2845
4275
  </dl>
@@ -2855,7 +4285,7 @@ Not yet implemented. Delete knowledge document. Requires an existing knowledge b
2855
4285
  <dd>
2856
4286
 
2857
4287
  ```typescript
2858
- await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started");
4288
+ await client.segments.patch("segmentReferenceId", {});
2859
4289
  ```
2860
4290
 
2861
4291
  </dd>
@@ -2871,7 +4301,7 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
2871
4301
  <dl>
2872
4302
  <dd>
2873
4303
 
2874
- **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base that contains the document to delete. All other entity ID fields are inferred from the request
4304
+ **segmentReferenceId:** `string` — The reference ID of the segment to update. All other entity ID fields are inferred from the request.
2875
4305
 
2876
4306
  </dd>
2877
4307
  </dl>
@@ -2879,7 +4309,7 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
2879
4309
  <dl>
2880
4310
  <dd>
2881
4311
 
2882
- **knowledgeDocumentReferenceId:** `string` — The reference ID of the knowledge document to delete. All other entity ID fields are inferred from the request.
4312
+ **request:** `MavenAGI.SegmentPatchRequest`
2883
4313
 
2884
4314
  </dd>
2885
4315
  </dl>
@@ -2887,7 +4317,7 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
2887
4317
  <dl>
2888
4318
  <dd>
2889
4319
 
2890
- **requestOptions:** `Knowledge.RequestOptions`
4320
+ **requestOptions:** `Segments.RequestOptions`
2891
4321
 
2892
4322
  </dd>
2893
4323
  </dl>
@@ -2898,9 +4328,9 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
2898
4328
  </dl>
2899
4329
  </details>
2900
4330
 
2901
- ## Organizations
4331
+ ## Translations
2902
4332
 
2903
- <details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
4333
+ <details><summary><code>client.translations.<a href="/src/api/resources/translations/client/Client.ts">translate</a>({ ...params }) -> MavenAGI.TranslationResponse</code></summary>
2904
4334
  <dl>
2905
4335
  <dd>
2906
4336
 
@@ -2912,12 +4342,8 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
2912
4342
  <dl>
2913
4343
  <dd>
2914
4344
 
2915
- Retrieves structured conversation data across all organizations, formatted as a table,
2916
- allowing users to group, filter, and define specific metrics to display as columns.
4345
+ Translate text from one language to another
2917
4346
 
2918
- <Tip>
2919
- This endpoint requires additional permissions. Contact support to request access.
2920
- </Tip>
2921
4347
  </dd>
2922
4348
  </dl>
2923
4349
  </dd>
@@ -2932,39 +4358,9 @@ This endpoint requires additional permissions. Contact support to request access
2932
4358
  <dd>
2933
4359
 
2934
4360
  ```typescript
2935
- await client.organizations.getConversationTable({
2936
- conversationFilter: {
2937
- languages: ["en", "es"],
2938
- },
2939
- timeGrouping: "DAY",
2940
- fieldGroupings: [
2941
- {
2942
- field: "Category",
2943
- },
2944
- ],
2945
- columnDefinitions: [
2946
- {
2947
- header: "count",
2948
- metric: {
2949
- type: "count",
2950
- },
2951
- },
2952
- {
2953
- header: "avg_first_response_time",
2954
- metric: {
2955
- type: "average",
2956
- targetField: "FirstResponseTime",
2957
- },
2958
- },
2959
- {
2960
- header: "percentile_handle_time",
2961
- metric: {
2962
- type: "percentile",
2963
- targetField: "HandleTime",
2964
- percentile: 25,
2965
- },
2966
- },
2967
- ],
4361
+ await client.translations.translate({
4362
+ text: "Hello world",
4363
+ targetLanguage: "es",
2968
4364
  });
2969
4365
  ```
2970
4366
 
@@ -2981,7 +4377,7 @@ await client.organizations.getConversationTable({
2981
4377
  <dl>
2982
4378
  <dd>
2983
4379
 
2984
- **request:** `MavenAGI.ConversationTableRequest`
4380
+ **request:** `MavenAGI.TranslationRequest`
2985
4381
 
2986
4382
  </dd>
2987
4383
  </dl>
@@ -2989,7 +4385,7 @@ await client.organizations.getConversationTable({
2989
4385
  <dl>
2990
4386
  <dd>
2991
4387
 
2992
- **requestOptions:** `Organizations.RequestOptions`
4388
+ **requestOptions:** `Translations.RequestOptions`
2993
4389
 
2994
4390
  </dd>
2995
4391
  </dl>
@@ -3000,29 +4396,12 @@ await client.organizations.getConversationTable({
3000
4396
  </dl>
3001
4397
  </details>
3002
4398
 
3003
- <details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getConversationChart</a>({ ...params }) -> MavenAGI.ChartResponse</code></summary>
3004
- <dl>
3005
- <dd>
3006
-
3007
- #### 📝 Description
3008
-
3009
- <dl>
3010
- <dd>
4399
+ ## Triggers
3011
4400
 
4401
+ <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventTriggersSearchResponse</code></summary>
3012
4402
  <dl>
3013
4403
  <dd>
3014
4404
 
3015
- Fetches conversation data across all organizations, visualized in a chart format.
3016
- Supported chart types include pie chart, date histogram, and stacked bar charts.
3017
-
3018
- <Tip>
3019
- This endpoint requires additional permissions. Contact support to request access.
3020
- </Tip>
3021
- </dd>
3022
- </dl>
3023
- </dd>
3024
- </dl>
3025
-
3026
4405
  #### 🔌 Usage
3027
4406
 
3028
4407
  <dl>
@@ -3032,18 +4411,7 @@ This endpoint requires additional permissions. Contact support to request access
3032
4411
  <dd>
3033
4412
 
3034
4413
  ```typescript
3035
- await client.organizations.getConversationChart({
3036
- type: "pieChart",
3037
- conversationFilter: {
3038
- languages: ["en", "es"],
3039
- },
3040
- groupBy: {
3041
- field: "Category",
3042
- },
3043
- metric: {
3044
- type: "count",
3045
- },
3046
- });
4414
+ await client.triggers.search({});
3047
4415
  ```
3048
4416
 
3049
4417
  </dd>
@@ -3059,7 +4427,7 @@ await client.organizations.getConversationChart({
3059
4427
  <dl>
3060
4428
  <dd>
3061
4429
 
3062
- **request:** `MavenAGI.ConversationChartRequest`
4430
+ **request:** `MavenAGI.EventTriggersSearchRequest`
3063
4431
 
3064
4432
  </dd>
3065
4433
  </dl>
@@ -3067,7 +4435,7 @@ await client.organizations.getConversationChart({
3067
4435
  <dl>
3068
4436
  <dd>
3069
4437
 
3070
- **requestOptions:** `Organizations.RequestOptions`
4438
+ **requestOptions:** `Triggers.RequestOptions`
3071
4439
 
3072
4440
  </dd>
3073
4441
  </dl>
@@ -3078,9 +4446,7 @@ await client.organizations.getConversationChart({
3078
4446
  </dl>
3079
4447
  </details>
3080
4448
 
3081
- ## Translations
3082
-
3083
- <details><summary><code>client.translations.<a href="/src/api/resources/translations/client/Client.ts">translate</a>({ ...params }) -> MavenAGI.TranslationResponse</code></summary>
4449
+ <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.EventTriggerResponse</code></summary>
3084
4450
  <dl>
3085
4451
  <dd>
3086
4452
 
@@ -3092,7 +4458,7 @@ await client.organizations.getConversationChart({
3092
4458
  <dl>
3093
4459
  <dd>
3094
4460
 
3095
- Translate text from one language to another
4461
+ Update an event trigger or create it if it doesn't exist.
3096
4462
 
3097
4463
  </dd>
3098
4464
  </dl>
@@ -3108,9 +4474,12 @@ Translate text from one language to another
3108
4474
  <dd>
3109
4475
 
3110
4476
  ```typescript
3111
- await client.translations.translate({
3112
- text: "Hello world",
3113
- targetLanguage: "es",
4477
+ await client.triggers.createOrUpdate({
4478
+ triggerId: {
4479
+ referenceId: "store-in-snowflake",
4480
+ },
4481
+ description: "Stores conversation data in Snowflake",
4482
+ type: "CONVERSATION_CREATED",
3114
4483
  });
3115
4484
  ```
3116
4485
 
@@ -3127,7 +4496,7 @@ await client.translations.translate({
3127
4496
  <dl>
3128
4497
  <dd>
3129
4498
 
3130
- **request:** `MavenAGI.TranslationRequest`
4499
+ **request:** `MavenAGI.EventTriggerRequest`
3131
4500
 
3132
4501
  </dd>
3133
4502
  </dl>
@@ -3135,7 +4504,7 @@ await client.translations.translate({
3135
4504
  <dl>
3136
4505
  <dd>
3137
4506
 
3138
- **requestOptions:** `Translations.RequestOptions`
4507
+ **requestOptions:** `Triggers.RequestOptions`
3139
4508
 
3140
4509
  </dd>
3141
4510
  </dl>
@@ -3146,12 +4515,25 @@ await client.translations.translate({
3146
4515
  </dl>
3147
4516
  </details>
3148
4517
 
3149
- ## Triggers
4518
+ <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">get</a>(triggerReferenceId) -> MavenAGI.EventTriggerResponse</code></summary>
4519
+ <dl>
4520
+ <dd>
4521
+
4522
+ #### 📝 Description
4523
+
4524
+ <dl>
4525
+ <dd>
3150
4526
 
3151
- <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventTriggersSearchResponse</code></summary>
3152
4527
  <dl>
3153
4528
  <dd>
3154
4529
 
4530
+ Get an event trigger by its supplied ID
4531
+
4532
+ </dd>
4533
+ </dl>
4534
+ </dd>
4535
+ </dl>
4536
+
3155
4537
  #### 🔌 Usage
3156
4538
 
3157
4539
  <dl>
@@ -3161,7 +4543,7 @@ await client.translations.translate({
3161
4543
  <dd>
3162
4544
 
3163
4545
  ```typescript
3164
- await client.triggers.search({});
4546
+ await client.triggers.get("store-in-snowflake");
3165
4547
  ```
3166
4548
 
3167
4549
  </dd>
@@ -3177,7 +4559,7 @@ await client.triggers.search({});
3177
4559
  <dl>
3178
4560
  <dd>
3179
4561
 
3180
- **request:** `MavenAGI.EventTriggersSearchRequest`
4562
+ **triggerReferenceId:** `string` — The reference ID of the event trigger to get. All other entity ID fields are inferred from the request.
3181
4563
 
3182
4564
  </dd>
3183
4565
  </dl>
@@ -3196,7 +4578,7 @@ await client.triggers.search({});
3196
4578
  </dl>
3197
4579
  </details>
3198
4580
 
3199
- <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.EventTriggerResponse</code></summary>
4581
+ <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">delete</a>(triggerReferenceId) -> void</code></summary>
3200
4582
  <dl>
3201
4583
  <dd>
3202
4584
 
@@ -3208,7 +4590,7 @@ await client.triggers.search({});
3208
4590
  <dl>
3209
4591
  <dd>
3210
4592
 
3211
- Update an event trigger or create it if it doesn't exist.
4593
+ Delete an event trigger
3212
4594
 
3213
4595
  </dd>
3214
4596
  </dl>
@@ -3224,13 +4606,7 @@ Update an event trigger or create it if it doesn't exist.
3224
4606
  <dd>
3225
4607
 
3226
4608
  ```typescript
3227
- await client.triggers.createOrUpdate({
3228
- triggerId: {
3229
- referenceId: "store-in-snowflake",
3230
- },
3231
- description: "Stores conversation data in Snowflake",
3232
- type: "CONVERSATION_CREATED",
3233
- });
4609
+ await client.triggers.delete("store-in-snowflake");
3234
4610
  ```
3235
4611
 
3236
4612
  </dd>
@@ -3246,7 +4622,7 @@ await client.triggers.createOrUpdate({
3246
4622
  <dl>
3247
4623
  <dd>
3248
4624
 
3249
- **request:** `MavenAGI.EventTriggerRequest`
4625
+ **triggerReferenceId:** `string` — The reference ID of the event trigger to delete. All other entity ID fields are inferred from the request.
3250
4626
 
3251
4627
  </dd>
3252
4628
  </dl>
@@ -3265,7 +4641,7 @@ await client.triggers.createOrUpdate({
3265
4641
  </dl>
3266
4642
  </details>
3267
4643
 
3268
- <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">get</a>(triggerReferenceId) -> MavenAGI.EventTriggerResponse</code></summary>
4644
+ <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">partialUpdate</a>(triggerReferenceId, { ...params }) -> MavenAGI.EventTriggerResponse</code></summary>
3269
4645
  <dl>
3270
4646
  <dd>
3271
4647
 
@@ -3277,7 +4653,7 @@ await client.triggers.createOrUpdate({
3277
4653
  <dl>
3278
4654
  <dd>
3279
4655
 
3280
- Get an event trigger by its supplied ID
4656
+ Updates an event trigger. Only the enabled field is editable.
3281
4657
 
3282
4658
  </dd>
3283
4659
  </dl>
@@ -3293,7 +4669,9 @@ Get an event trigger by its supplied ID
3293
4669
  <dd>
3294
4670
 
3295
4671
  ```typescript
3296
- await client.triggers.get("store-in-snowflake");
4672
+ await client.triggers.partialUpdate("triggerReferenceId", {
4673
+ body: {},
4674
+ });
3297
4675
  ```
3298
4676
 
3299
4677
  </dd>
@@ -3309,7 +4687,15 @@ await client.triggers.get("store-in-snowflake");
3309
4687
  <dl>
3310
4688
  <dd>
3311
4689
 
3312
- **triggerReferenceId:** `string` — The reference ID of the event trigger to get. All other entity ID fields are inferred from the request.
4690
+ **triggerReferenceId:** `string` — The reference ID of the event trigger to update. All other entity ID fields are inferred from the request.
4691
+
4692
+ </dd>
4693
+ </dl>
4694
+
4695
+ <dl>
4696
+ <dd>
4697
+
4698
+ **request:** `MavenAGI.PartialUpdateRequest`
3313
4699
 
3314
4700
  </dd>
3315
4701
  </dl>
@@ -3328,7 +4714,9 @@ await client.triggers.get("store-in-snowflake");
3328
4714
  </dl>
3329
4715
  </details>
3330
4716
 
3331
- <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">delete</a>(triggerReferenceId) -> void</code></summary>
4717
+ ## Users
4718
+
4719
+ <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">search</a>({ ...params }) -> MavenAGI.AgentUserSearchResponse</code></summary>
3332
4720
  <dl>
3333
4721
  <dd>
3334
4722
 
@@ -3340,7 +4728,9 @@ await client.triggers.get("store-in-snowflake");
3340
4728
  <dl>
3341
4729
  <dd>
3342
4730
 
3343
- Delete an event trigger
4731
+ Search across all agent users on an agent.
4732
+
4733
+ Agent users are a merged view of the users created by individual apps.
3344
4734
 
3345
4735
  </dd>
3346
4736
  </dl>
@@ -3356,7 +4746,7 @@ Delete an event trigger
3356
4746
  <dd>
3357
4747
 
3358
4748
  ```typescript
3359
- await client.triggers.delete("store-in-snowflake");
4749
+ await client.users.search({});
3360
4750
  ```
3361
4751
 
3362
4752
  </dd>
@@ -3372,7 +4762,7 @@ await client.triggers.delete("store-in-snowflake");
3372
4762
  <dl>
3373
4763
  <dd>
3374
4764
 
3375
- **triggerReferenceId:** `string` — The reference ID of the event trigger to delete. All other entity ID fields are inferred from the request.
4765
+ **request:** `MavenAGI.AgentUserSearchRequest`
3376
4766
 
3377
4767
  </dd>
3378
4768
  </dl>
@@ -3380,7 +4770,7 @@ await client.triggers.delete("store-in-snowflake");
3380
4770
  <dl>
3381
4771
  <dd>
3382
4772
 
3383
- **requestOptions:** `Triggers.RequestOptions`
4773
+ **requestOptions:** `Users.RequestOptions`
3384
4774
 
3385
4775
  </dd>
3386
4776
  </dl>
@@ -3391,7 +4781,7 @@ await client.triggers.delete("store-in-snowflake");
3391
4781
  </dl>
3392
4782
  </details>
3393
4783
 
3394
- <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">partialUpdate</a>(triggerReferenceId, { ...params }) -> MavenAGI.EventTriggerResponse</code></summary>
4784
+ <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getAgentUser</a>(userId) -> MavenAGI.AgentUser</code></summary>
3395
4785
  <dl>
3396
4786
  <dd>
3397
4787
 
@@ -3403,7 +4793,9 @@ await client.triggers.delete("store-in-snowflake");
3403
4793
  <dl>
3404
4794
  <dd>
3405
4795
 
3406
- Updates an event trigger. Only the enabled field is editable.
4796
+ Get an agent user by its supplied ID.
4797
+
4798
+ Agent users are a merged view of the users created by individual apps.
3407
4799
 
3408
4800
  </dd>
3409
4801
  </dl>
@@ -3419,9 +4811,7 @@ Updates an event trigger. Only the enabled field is editable.
3419
4811
  <dd>
3420
4812
 
3421
4813
  ```typescript
3422
- await client.triggers.partialUpdate("triggerReferenceId", {
3423
- body: {},
3424
- });
4814
+ await client.users.getAgentUser("userId");
3425
4815
  ```
3426
4816
 
3427
4817
  </dd>
@@ -3437,15 +4827,7 @@ await client.triggers.partialUpdate("triggerReferenceId", {
3437
4827
  <dl>
3438
4828
  <dd>
3439
4829
 
3440
- **triggerReferenceId:** `string` — The reference ID of the event trigger to update. All other entity ID fields are inferred from the request.
3441
-
3442
- </dd>
3443
- </dl>
3444
-
3445
- <dl>
3446
- <dd>
3447
-
3448
- **request:** `MavenAGI.PartialUpdateRequest`
4830
+ **userId:** `string` — The ID of the agent user to get.
3449
4831
 
3450
4832
  </dd>
3451
4833
  </dl>
@@ -3453,7 +4835,7 @@ await client.triggers.partialUpdate("triggerReferenceId", {
3453
4835
  <dl>
3454
4836
  <dd>
3455
4837
 
3456
- **requestOptions:** `Triggers.RequestOptions`
4838
+ **requestOptions:** `Users.RequestOptions`
3457
4839
 
3458
4840
  </dd>
3459
4841
  </dl>
@@ -3464,8 +4846,6 @@ await client.triggers.partialUpdate("triggerReferenceId", {
3464
4846
  </dl>
3465
4847
  </details>
3466
4848
 
3467
- ## Users
3468
-
3469
4849
  <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.AppUserResponse</code></summary>
3470
4850
  <dl>
3471
4851
  <dd>
@@ -3478,7 +4858,7 @@ await client.triggers.partialUpdate("triggerReferenceId", {
3478
4858
  <dl>
3479
4859
  <dd>
3480
4860
 
3481
- Update a user or create it if it doesn't exist.
4861
+ Update an app user or create it if it doesn't exist.
3482
4862
 
3483
4863
  </dd>
3484
4864
  </dl>
@@ -3557,7 +4937,7 @@ await client.users.createOrUpdate({
3557
4937
  <dl>
3558
4938
  <dd>
3559
4939
 
3560
- Get a user by its supplied ID
4940
+ Get an app user by its supplied ID
3561
4941
 
3562
4942
  </dd>
3563
4943
  </dl>
@@ -3589,7 +4969,7 @@ await client.users.get("user-0");
3589
4969
  <dl>
3590
4970
  <dd>
3591
4971
 
3592
- **userId:** `string` — The reference ID of the user to get. All other entity ID fields are inferred from the request.
4972
+ **userId:** `string` — The reference ID of the app user to get. All other entity ID fields are inferred from the request.
3593
4973
 
3594
4974
  </dd>
3595
4975
  </dl>
@@ -3665,7 +5045,7 @@ await client.users.delete("user-0");
3665
5045
  <dl>
3666
5046
  <dd>
3667
5047
 
3668
- **userId:** `string` — The reference ID of the user to delete. All other entity ID fields are inferred from the request.
5048
+ **userId:** `string` — The reference ID of the app user to delete. All other entity ID fields are inferred from the request.
3669
5049
 
3670
5050
  </dd>
3671
5051
  </dl>