mavenagi 0.0.0-alpha.3 → 0.0.0-alpha.5

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 (360) hide show
  1. package/Client.d.ts +11 -8
  2. package/Client.js +13 -8
  3. package/README.md +45 -37
  4. package/api/resources/actions/client/Client.d.ts +77 -0
  5. package/api/resources/{action → actions}/client/Client.js +42 -43
  6. package/api/resources/{action/types/Action.d.ts → actions/types/ActionBase.d.ts} +3 -9
  7. package/api/resources/{action → actions}/types/ActionParameter.d.ts +1 -0
  8. package/api/resources/actions/types/ActionRequest.d.ts +21 -0
  9. package/api/resources/actions/types/ActionResponse.d.ts +25 -0
  10. package/api/resources/actions/types/index.d.ts +4 -0
  11. package/api/resources/actions/types/index.js +4 -0
  12. package/api/resources/commons/types/AppUser.d.ts +10 -0
  13. package/api/resources/commons/types/AppUserIdentification.d.ts +8 -0
  14. package/api/resources/commons/types/AppUserIdentifyingProperty.d.ts +9 -0
  15. package/api/resources/commons/types/AppUserIdentifyingPropertyType.d.ts +8 -0
  16. package/api/resources/commons/types/AppUserIdentifyingPropertyType.js +7 -0
  17. package/api/resources/commons/types/EntityId.d.ts +14 -0
  18. package/api/resources/commons/types/EntityIdBase.d.ts +10 -0
  19. package/api/resources/commons/types/EntityType.d.ts +14 -0
  20. package/api/resources/commons/types/EntityType.js +13 -0
  21. package/api/resources/commons/types/Feedback.d.ts +1 -1
  22. package/api/resources/commons/types/index.d.ts +7 -0
  23. package/api/resources/commons/types/index.js +7 -0
  24. package/api/resources/conversation/client/Client.d.ts +27 -4
  25. package/api/resources/conversation/client/Client.js +125 -26
  26. package/api/resources/conversation/types/AskRequest.d.ts +2 -0
  27. package/api/resources/conversation/types/Capability.d.ts +8 -0
  28. package/api/resources/conversation/types/Capability.js +7 -0
  29. package/api/resources/conversation/types/ConversationBase.d.ts +2 -2
  30. package/api/resources/conversation/types/ConversationRequest.d.ts +2 -0
  31. package/api/resources/conversation/types/ConversationResponse.d.ts +2 -0
  32. package/api/resources/conversation/types/ResponseConfig.d.ts +12 -0
  33. package/api/resources/conversation/types/ResponseLength.d.ts +9 -0
  34. package/api/resources/conversation/types/ResponseLength.js +8 -0
  35. package/api/resources/conversation/types/index.d.ts +3 -0
  36. package/api/resources/conversation/types/index.js +3 -0
  37. package/api/resources/index.d.ts +5 -4
  38. package/api/resources/index.js +5 -4
  39. package/api/resources/knowledge/client/Client.d.ts +24 -8
  40. package/api/resources/knowledge/client/Client.js +115 -26
  41. package/api/resources/knowledge/types/{KnowledgeDocument.d.ts → BaseKnowledgeDocument.d.ts} +1 -3
  42. package/api/resources/knowledge/types/KnowledgeBase.d.ts +1 -1
  43. package/api/resources/knowledge/types/KnowledgeBaseType.d.ts +1 -1
  44. package/api/resources/knowledge/types/KnowledgeDocumentContentType.d.ts +11 -0
  45. package/api/resources/knowledge/types/KnowledgeDocumentContentType.js +7 -0
  46. package/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +9 -0
  47. package/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +8 -0
  48. package/api/resources/knowledge/types/KnowledgeDocumentResponse.js +4 -0
  49. package/api/resources/knowledge/types/index.d.ts +4 -1
  50. package/api/resources/knowledge/types/index.js +4 -1
  51. package/api/resources/triggers/client/Client.d.ts +74 -0
  52. package/api/resources/{actionSet → triggers}/client/Client.js +40 -37
  53. package/api/resources/triggers/types/EventTriggerBase.d.ts +10 -0
  54. package/api/resources/triggers/types/EventTriggerBase.js +4 -0
  55. package/api/resources/triggers/types/EventTriggerRequest.d.ts +18 -0
  56. package/api/resources/triggers/types/EventTriggerRequest.js +4 -0
  57. package/api/resources/triggers/types/EventTriggerResponse.d.ts +22 -0
  58. package/api/resources/triggers/types/EventTriggerResponse.js +4 -0
  59. package/api/resources/triggers/types/EventTriggerType.d.ts +8 -0
  60. package/api/resources/triggers/types/EventTriggerType.js +7 -0
  61. package/api/resources/triggers/types/index.d.ts +4 -0
  62. package/api/resources/triggers/types/index.js +4 -0
  63. package/api/resources/users/client/Client.d.ts +62 -0
  64. package/api/resources/users/client/Client.js +220 -0
  65. package/api/resources/users/index.d.ts +1 -0
  66. package/api/resources/users/index.js +1 -0
  67. package/dist/Client.d.ts +11 -8
  68. package/dist/Client.js +13 -8
  69. package/dist/api/resources/actions/client/Client.d.ts +77 -0
  70. package/dist/api/resources/{action → actions}/client/Client.js +42 -43
  71. package/dist/api/resources/{action/types/Action.d.ts → actions/types/ActionBase.d.ts} +3 -9
  72. package/dist/api/resources/actions/types/ActionBase.js +4 -0
  73. package/dist/api/resources/{action → actions}/types/ActionParameter.d.ts +1 -0
  74. package/dist/api/resources/actions/types/ActionParameter.js +4 -0
  75. package/dist/api/resources/actions/types/ActionRequest.d.ts +21 -0
  76. package/dist/api/resources/actions/types/ActionRequest.js +4 -0
  77. package/dist/api/resources/actions/types/ActionResponse.d.ts +25 -0
  78. package/dist/api/resources/actions/types/ActionResponse.js +4 -0
  79. package/dist/api/resources/actions/types/index.d.ts +4 -0
  80. package/dist/api/resources/actions/types/index.js +4 -0
  81. package/dist/api/resources/commons/types/AppUser.d.ts +10 -0
  82. package/dist/api/resources/commons/types/AppUser.js +4 -0
  83. package/dist/api/resources/commons/types/AppUserIdentification.d.ts +8 -0
  84. package/dist/api/resources/commons/types/AppUserIdentification.js +4 -0
  85. package/dist/api/resources/commons/types/AppUserIdentifyingProperty.d.ts +9 -0
  86. package/dist/api/resources/commons/types/AppUserIdentifyingProperty.js +4 -0
  87. package/dist/api/resources/commons/types/AppUserIdentifyingPropertyType.d.ts +8 -0
  88. package/dist/api/resources/commons/types/AppUserIdentifyingPropertyType.js +7 -0
  89. package/dist/api/resources/commons/types/EntityId.d.ts +14 -0
  90. package/dist/api/resources/commons/types/EntityId.js +4 -0
  91. package/dist/api/resources/commons/types/EntityIdBase.d.ts +10 -0
  92. package/dist/api/resources/commons/types/EntityIdBase.js +4 -0
  93. package/dist/api/resources/commons/types/EntityType.d.ts +14 -0
  94. package/dist/api/resources/commons/types/EntityType.js +13 -0
  95. package/dist/api/resources/commons/types/Feedback.d.ts +1 -1
  96. package/dist/api/resources/commons/types/index.d.ts +7 -0
  97. package/dist/api/resources/commons/types/index.js +7 -0
  98. package/dist/api/resources/conversation/client/Client.d.ts +27 -4
  99. package/dist/api/resources/conversation/client/Client.js +125 -26
  100. package/dist/api/resources/conversation/types/AskRequest.d.ts +2 -0
  101. package/dist/api/resources/conversation/types/Capability.d.ts +8 -0
  102. package/dist/api/resources/conversation/types/Capability.js +7 -0
  103. package/dist/api/resources/conversation/types/ConversationBase.d.ts +2 -2
  104. package/dist/api/resources/conversation/types/ConversationRequest.d.ts +2 -0
  105. package/dist/api/resources/conversation/types/ConversationResponse.d.ts +2 -0
  106. package/dist/api/resources/conversation/types/ResponseConfig.d.ts +12 -0
  107. package/dist/api/resources/conversation/types/ResponseConfig.js +4 -0
  108. package/dist/api/resources/conversation/types/ResponseLength.d.ts +9 -0
  109. package/dist/api/resources/conversation/types/ResponseLength.js +8 -0
  110. package/dist/api/resources/conversation/types/index.d.ts +3 -0
  111. package/dist/api/resources/conversation/types/index.js +3 -0
  112. package/dist/api/resources/index.d.ts +5 -4
  113. package/dist/api/resources/index.js +5 -4
  114. package/dist/api/resources/knowledge/client/Client.d.ts +24 -8
  115. package/dist/api/resources/knowledge/client/Client.js +115 -26
  116. package/dist/api/resources/knowledge/types/{KnowledgeDocument.d.ts → BaseKnowledgeDocument.d.ts} +1 -3
  117. package/dist/api/resources/knowledge/types/BaseKnowledgeDocument.js +4 -0
  118. package/dist/api/resources/knowledge/types/KnowledgeBase.d.ts +1 -1
  119. package/dist/api/resources/knowledge/types/KnowledgeBaseType.d.ts +1 -1
  120. package/dist/api/resources/knowledge/types/KnowledgeDocumentContentType.d.ts +11 -0
  121. package/dist/api/resources/knowledge/types/KnowledgeDocumentContentType.js +7 -0
  122. package/dist/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +9 -0
  123. package/dist/api/resources/knowledge/types/KnowledgeDocumentRequest.js +4 -0
  124. package/dist/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +8 -0
  125. package/dist/api/resources/knowledge/types/KnowledgeDocumentResponse.js +4 -0
  126. package/dist/api/resources/knowledge/types/index.d.ts +4 -1
  127. package/dist/api/resources/knowledge/types/index.js +4 -1
  128. package/dist/api/resources/triggers/client/Client.d.ts +74 -0
  129. package/dist/api/resources/{actionSet → triggers}/client/Client.js +40 -37
  130. package/dist/api/resources/triggers/client/index.d.ts +1 -0
  131. package/dist/api/resources/triggers/client/index.js +1 -0
  132. package/dist/api/resources/triggers/types/EventTriggerBase.d.ts +10 -0
  133. package/dist/api/resources/triggers/types/EventTriggerBase.js +4 -0
  134. package/dist/api/resources/triggers/types/EventTriggerRequest.d.ts +18 -0
  135. package/dist/api/resources/triggers/types/EventTriggerRequest.js +4 -0
  136. package/dist/api/resources/triggers/types/EventTriggerResponse.d.ts +22 -0
  137. package/dist/api/resources/triggers/types/EventTriggerResponse.js +4 -0
  138. package/dist/api/resources/triggers/types/EventTriggerType.d.ts +8 -0
  139. package/dist/api/resources/triggers/types/EventTriggerType.js +7 -0
  140. package/dist/api/resources/triggers/types/index.d.ts +4 -0
  141. package/dist/api/resources/triggers/types/index.js +4 -0
  142. package/dist/api/resources/users/client/Client.d.ts +62 -0
  143. package/dist/api/resources/users/client/Client.js +220 -0
  144. package/dist/api/resources/users/client/index.d.ts +1 -0
  145. package/dist/api/resources/users/client/index.js +1 -0
  146. package/dist/api/resources/users/index.d.ts +1 -0
  147. package/dist/api/resources/users/index.js +1 -0
  148. package/dist/serialization/resources/{action/types/Action.d.ts → actions/types/ActionBase.d.ts} +2 -5
  149. package/{serialization/resources/action/types/Action.js → dist/serialization/resources/actions/types/ActionBase.js} +1 -4
  150. package/dist/serialization/resources/{action → actions}/types/ActionParameter.d.ts +1 -0
  151. package/dist/serialization/resources/{action → actions}/types/ActionParameter.js +1 -0
  152. package/dist/serialization/resources/actions/types/ActionRequest.d.ts +14 -0
  153. package/dist/serialization/resources/actions/types/ActionRequest.js +11 -0
  154. package/dist/serialization/resources/actions/types/ActionResponse.d.ts +14 -0
  155. package/dist/serialization/resources/actions/types/ActionResponse.js +11 -0
  156. package/dist/serialization/resources/actions/types/index.d.ts +4 -0
  157. package/dist/serialization/resources/actions/types/index.js +4 -0
  158. package/dist/serialization/resources/commons/types/AppUser.d.ts +15 -0
  159. package/dist/serialization/resources/commons/types/AppUser.js +10 -0
  160. package/dist/serialization/resources/commons/types/AppUserIdentification.d.ts +13 -0
  161. package/dist/serialization/resources/commons/types/AppUserIdentification.js +8 -0
  162. package/dist/serialization/resources/commons/types/AppUserIdentifyingProperty.d.ts +14 -0
  163. package/dist/serialization/resources/commons/types/AppUserIdentifyingProperty.js +9 -0
  164. package/dist/serialization/resources/commons/types/AppUserIdentifyingPropertyType.d.ts +10 -0
  165. package/dist/serialization/resources/commons/types/AppUserIdentifyingPropertyType.js +5 -0
  166. package/dist/serialization/resources/commons/types/EntityId.d.ts +17 -0
  167. package/dist/serialization/resources/commons/types/EntityId.js +14 -0
  168. package/{serialization/resources/actionSet/types/ActionSetBase.d.ts → dist/serialization/resources/commons/types/EntityIdBase.d.ts} +3 -4
  169. package/dist/serialization/resources/commons/types/EntityIdBase.js +7 -0
  170. package/dist/serialization/resources/commons/types/EntityType.d.ts +10 -0
  171. package/dist/serialization/resources/commons/types/EntityType.js +14 -0
  172. package/dist/serialization/resources/commons/types/Feedback.d.ts +1 -1
  173. package/dist/serialization/resources/commons/types/Feedback.js +1 -1
  174. package/dist/serialization/resources/commons/types/index.d.ts +7 -0
  175. package/dist/serialization/resources/commons/types/index.js +7 -0
  176. package/dist/serialization/resources/conversation/client/addConversationMetadata.d.ts +13 -0
  177. package/dist/serialization/resources/conversation/client/addConversationMetadata.js +6 -0
  178. package/dist/serialization/resources/conversation/client/index.d.ts +1 -0
  179. package/dist/serialization/resources/conversation/client/index.js +1 -0
  180. package/dist/serialization/resources/conversation/types/AskRequest.d.ts +2 -0
  181. package/dist/serialization/resources/conversation/types/AskRequest.js +2 -0
  182. package/dist/serialization/resources/conversation/types/Capability.d.ts +10 -0
  183. package/dist/serialization/resources/conversation/types/Capability.js +5 -0
  184. package/dist/serialization/resources/conversation/types/ConversationBase.d.ts +2 -2
  185. package/dist/serialization/resources/conversation/types/ConversationBase.js +2 -2
  186. package/dist/serialization/resources/conversation/types/ConversationRequest.d.ts +2 -0
  187. package/dist/serialization/resources/conversation/types/ConversationRequest.js +2 -0
  188. package/dist/serialization/resources/conversation/types/ConversationResponse.d.ts +2 -0
  189. package/dist/serialization/resources/conversation/types/ConversationResponse.js +2 -0
  190. package/dist/serialization/resources/conversation/types/ResponseConfig.d.ts +16 -0
  191. package/dist/serialization/resources/conversation/types/ResponseConfig.js +11 -0
  192. package/dist/serialization/resources/conversation/types/ResponseLength.d.ts +10 -0
  193. package/dist/serialization/resources/conversation/types/ResponseLength.js +5 -0
  194. package/dist/serialization/resources/conversation/types/index.d.ts +3 -0
  195. package/dist/serialization/resources/conversation/types/index.js +3 -0
  196. package/dist/serialization/resources/index.d.ts +4 -4
  197. package/dist/serialization/resources/index.js +4 -4
  198. package/dist/serialization/resources/knowledge/types/{KnowledgeDocument.d.ts → BaseKnowledgeDocument.d.ts} +4 -5
  199. package/dist/serialization/resources/knowledge/types/{KnowledgeDocument.js → BaseKnowledgeDocument.js} +3 -4
  200. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentContentType.d.ts +10 -0
  201. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentContentType.js +5 -0
  202. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +15 -0
  203. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +12 -0
  204. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +13 -0
  205. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentResponse.js +10 -0
  206. package/dist/serialization/resources/knowledge/types/index.d.ts +4 -1
  207. package/dist/serialization/resources/knowledge/types/index.js +4 -1
  208. package/dist/serialization/resources/triggers/types/EventTriggerBase.d.ts +14 -0
  209. package/dist/serialization/resources/triggers/types/EventTriggerBase.js +9 -0
  210. package/dist/serialization/resources/triggers/types/EventTriggerRequest.d.ts +14 -0
  211. package/dist/serialization/resources/triggers/types/EventTriggerRequest.js +11 -0
  212. package/dist/serialization/resources/triggers/types/EventTriggerResponse.d.ts +14 -0
  213. package/dist/serialization/resources/triggers/types/EventTriggerResponse.js +11 -0
  214. package/dist/serialization/resources/triggers/types/EventTriggerType.d.ts +10 -0
  215. package/dist/serialization/resources/triggers/types/EventTriggerType.js +5 -0
  216. package/dist/serialization/resources/triggers/types/index.d.ts +4 -0
  217. package/dist/serialization/resources/triggers/types/index.js +4 -0
  218. package/package.json +1 -1
  219. package/serialization/resources/{action/types/Action.d.ts → actions/types/ActionBase.d.ts} +2 -5
  220. package/{dist/serialization/resources/action/types/Action.js → serialization/resources/actions/types/ActionBase.js} +1 -4
  221. package/serialization/resources/{action → actions}/types/ActionParameter.d.ts +1 -0
  222. package/serialization/resources/{action → actions}/types/ActionParameter.js +1 -0
  223. package/serialization/resources/actions/types/ActionRequest.d.ts +14 -0
  224. package/serialization/resources/actions/types/ActionRequest.js +11 -0
  225. package/serialization/resources/actions/types/ActionResponse.d.ts +14 -0
  226. package/serialization/resources/actions/types/ActionResponse.js +11 -0
  227. package/serialization/resources/actions/types/index.d.ts +4 -0
  228. package/serialization/resources/actions/types/index.js +4 -0
  229. package/serialization/resources/commons/types/AppUser.d.ts +15 -0
  230. package/serialization/resources/commons/types/AppUser.js +10 -0
  231. package/serialization/resources/commons/types/AppUserIdentification.d.ts +13 -0
  232. package/serialization/resources/commons/types/AppUserIdentification.js +8 -0
  233. package/serialization/resources/commons/types/AppUserIdentifyingProperty.d.ts +14 -0
  234. package/serialization/resources/commons/types/AppUserIdentifyingProperty.js +9 -0
  235. package/serialization/resources/commons/types/AppUserIdentifyingPropertyType.d.ts +10 -0
  236. package/serialization/resources/commons/types/AppUserIdentifyingPropertyType.js +5 -0
  237. package/serialization/resources/commons/types/EntityId.d.ts +17 -0
  238. package/serialization/resources/commons/types/EntityId.js +14 -0
  239. package/{dist/serialization/resources/actionSet/types/ActionSetBase.d.ts → serialization/resources/commons/types/EntityIdBase.d.ts} +3 -4
  240. package/serialization/resources/commons/types/EntityIdBase.js +7 -0
  241. package/serialization/resources/commons/types/EntityType.d.ts +10 -0
  242. package/serialization/resources/commons/types/EntityType.js +14 -0
  243. package/serialization/resources/commons/types/Feedback.d.ts +1 -1
  244. package/serialization/resources/commons/types/Feedback.js +1 -1
  245. package/serialization/resources/commons/types/index.d.ts +7 -0
  246. package/serialization/resources/commons/types/index.js +7 -0
  247. package/serialization/resources/conversation/client/addConversationMetadata.d.ts +13 -0
  248. package/serialization/resources/conversation/client/addConversationMetadata.js +6 -0
  249. package/serialization/resources/conversation/client/index.d.ts +1 -0
  250. package/serialization/resources/conversation/client/index.js +1 -0
  251. package/serialization/resources/conversation/types/AskRequest.d.ts +2 -0
  252. package/serialization/resources/conversation/types/AskRequest.js +2 -0
  253. package/serialization/resources/conversation/types/Capability.d.ts +10 -0
  254. package/serialization/resources/conversation/types/Capability.js +5 -0
  255. package/serialization/resources/conversation/types/ConversationBase.d.ts +2 -2
  256. package/serialization/resources/conversation/types/ConversationBase.js +2 -2
  257. package/serialization/resources/conversation/types/ConversationRequest.d.ts +2 -0
  258. package/serialization/resources/conversation/types/ConversationRequest.js +2 -0
  259. package/serialization/resources/conversation/types/ConversationResponse.d.ts +2 -0
  260. package/serialization/resources/conversation/types/ConversationResponse.js +2 -0
  261. package/serialization/resources/conversation/types/ResponseConfig.d.ts +16 -0
  262. package/serialization/resources/conversation/types/ResponseConfig.js +11 -0
  263. package/serialization/resources/conversation/types/ResponseLength.d.ts +10 -0
  264. package/serialization/resources/conversation/types/ResponseLength.js +5 -0
  265. package/serialization/resources/conversation/types/index.d.ts +3 -0
  266. package/serialization/resources/conversation/types/index.js +3 -0
  267. package/serialization/resources/index.d.ts +4 -4
  268. package/serialization/resources/index.js +4 -4
  269. package/serialization/resources/knowledge/types/{KnowledgeDocument.d.ts → BaseKnowledgeDocument.d.ts} +4 -5
  270. package/serialization/resources/knowledge/types/{KnowledgeDocument.js → BaseKnowledgeDocument.js} +3 -4
  271. package/serialization/resources/knowledge/types/KnowledgeDocumentContentType.d.ts +10 -0
  272. package/serialization/resources/knowledge/types/KnowledgeDocumentContentType.js +5 -0
  273. package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +15 -0
  274. package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +12 -0
  275. package/serialization/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +13 -0
  276. package/serialization/resources/knowledge/types/KnowledgeDocumentResponse.js +10 -0
  277. package/serialization/resources/knowledge/types/index.d.ts +4 -1
  278. package/serialization/resources/knowledge/types/index.js +4 -1
  279. package/serialization/resources/triggers/types/EventTriggerBase.d.ts +14 -0
  280. package/serialization/resources/triggers/types/EventTriggerBase.js +9 -0
  281. package/serialization/resources/triggers/types/EventTriggerRequest.d.ts +14 -0
  282. package/serialization/resources/triggers/types/EventTriggerRequest.js +11 -0
  283. package/serialization/resources/triggers/types/EventTriggerResponse.d.ts +14 -0
  284. package/serialization/resources/triggers/types/EventTriggerResponse.js +11 -0
  285. package/serialization/resources/triggers/types/EventTriggerType.d.ts +10 -0
  286. package/serialization/resources/triggers/types/EventTriggerType.js +5 -0
  287. package/serialization/resources/triggers/types/index.d.ts +4 -0
  288. package/serialization/resources/triggers/types/index.js +4 -0
  289. package/api/resources/action/client/Client.d.ts +0 -78
  290. package/api/resources/action/types/index.d.ts +0 -2
  291. package/api/resources/action/types/index.js +0 -2
  292. package/api/resources/actionSet/client/Client.d.ts +0 -71
  293. package/api/resources/actionSet/types/ActionSetBase.d.ts +0 -9
  294. package/api/resources/actionSet/types/ActionSetRequest.d.ts +0 -6
  295. package/api/resources/actionSet/types/ActionSetResponse.d.ts +0 -8
  296. package/api/resources/actionSet/types/index.d.ts +0 -3
  297. package/api/resources/actionSet/types/index.js +0 -3
  298. package/dist/api/resources/action/client/Client.d.ts +0 -78
  299. package/dist/api/resources/action/types/index.d.ts +0 -2
  300. package/dist/api/resources/action/types/index.js +0 -2
  301. package/dist/api/resources/actionSet/client/Client.d.ts +0 -71
  302. package/dist/api/resources/actionSet/types/ActionSetBase.d.ts +0 -9
  303. package/dist/api/resources/actionSet/types/ActionSetRequest.d.ts +0 -6
  304. package/dist/api/resources/actionSet/types/ActionSetResponse.d.ts +0 -8
  305. package/dist/api/resources/actionSet/types/index.d.ts +0 -3
  306. package/dist/api/resources/actionSet/types/index.js +0 -3
  307. package/dist/serialization/resources/action/types/index.d.ts +0 -2
  308. package/dist/serialization/resources/action/types/index.js +0 -2
  309. package/dist/serialization/resources/actionSet/types/ActionSetBase.js +0 -8
  310. package/dist/serialization/resources/actionSet/types/ActionSetRequest.d.ts +0 -12
  311. package/dist/serialization/resources/actionSet/types/ActionSetRequest.js +0 -6
  312. package/dist/serialization/resources/actionSet/types/ActionSetResponse.d.ts +0 -14
  313. package/dist/serialization/resources/actionSet/types/ActionSetResponse.js +0 -11
  314. package/dist/serialization/resources/actionSet/types/index.d.ts +0 -3
  315. package/dist/serialization/resources/actionSet/types/index.js +0 -3
  316. package/serialization/resources/action/types/index.d.ts +0 -2
  317. package/serialization/resources/action/types/index.js +0 -2
  318. package/serialization/resources/actionSet/types/ActionSetBase.js +0 -8
  319. package/serialization/resources/actionSet/types/ActionSetRequest.d.ts +0 -12
  320. package/serialization/resources/actionSet/types/ActionSetRequest.js +0 -6
  321. package/serialization/resources/actionSet/types/ActionSetResponse.d.ts +0 -14
  322. package/serialization/resources/actionSet/types/ActionSetResponse.js +0 -11
  323. package/serialization/resources/actionSet/types/index.d.ts +0 -3
  324. package/serialization/resources/actionSet/types/index.js +0 -3
  325. /package/api/resources/{action → actions}/client/index.d.ts +0 -0
  326. /package/api/resources/{action → actions}/client/index.js +0 -0
  327. /package/api/resources/{action → actions}/index.d.ts +0 -0
  328. /package/api/resources/{action → actions}/index.js +0 -0
  329. /package/api/resources/{action/types/Action.js → actions/types/ActionBase.js} +0 -0
  330. /package/api/resources/{action → actions}/types/ActionParameter.js +0 -0
  331. /package/api/resources/{actionSet/types/ActionSetBase.js → actions/types/ActionRequest.js} +0 -0
  332. /package/api/resources/{actionSet/types/ActionSetRequest.js → actions/types/ActionResponse.js} +0 -0
  333. /package/api/resources/{actionSet/types/ActionSetResponse.js → commons/types/AppUser.js} +0 -0
  334. /package/api/resources/{knowledge/types/KnowledgeDocument.js → commons/types/AppUserIdentification.js} +0 -0
  335. /package/{dist/api/resources/action/types/Action.js → api/resources/commons/types/AppUserIdentifyingProperty.js} +0 -0
  336. /package/{dist/api/resources/action/types/ActionParameter.js → api/resources/commons/types/EntityId.js} +0 -0
  337. /package/{dist/api/resources/actionSet/types/ActionSetBase.js → api/resources/commons/types/EntityIdBase.js} +0 -0
  338. /package/{dist/api/resources/actionSet/types/ActionSetRequest.js → api/resources/conversation/types/ResponseConfig.js} +0 -0
  339. /package/{dist/api/resources/actionSet/types/ActionSetResponse.js → api/resources/knowledge/types/BaseKnowledgeDocument.js} +0 -0
  340. /package/{dist/api/resources/knowledge/types/KnowledgeDocument.js → api/resources/knowledge/types/KnowledgeDocumentRequest.js} +0 -0
  341. /package/api/resources/{actionSet → triggers}/client/index.d.ts +0 -0
  342. /package/api/resources/{actionSet → triggers}/client/index.js +0 -0
  343. /package/api/resources/{actionSet → triggers}/index.d.ts +0 -0
  344. /package/api/resources/{actionSet → triggers}/index.js +0 -0
  345. /package/{dist/api/resources/action → api/resources/users}/client/index.d.ts +0 -0
  346. /package/{dist/api/resources/action → api/resources/users}/client/index.js +0 -0
  347. /package/dist/api/resources/{actionSet → actions}/client/index.d.ts +0 -0
  348. /package/dist/api/resources/{actionSet → actions}/client/index.js +0 -0
  349. /package/dist/api/resources/{action → actions}/index.d.ts +0 -0
  350. /package/dist/api/resources/{action → actions}/index.js +0 -0
  351. /package/dist/api/resources/{actionSet → triggers}/index.d.ts +0 -0
  352. /package/dist/api/resources/{actionSet → triggers}/index.js +0 -0
  353. /package/dist/serialization/resources/{action → actions}/index.d.ts +0 -0
  354. /package/dist/serialization/resources/{action → actions}/index.js +0 -0
  355. /package/dist/serialization/resources/{actionSet → triggers}/index.d.ts +0 -0
  356. /package/dist/serialization/resources/{actionSet → triggers}/index.js +0 -0
  357. /package/serialization/resources/{action → actions}/index.d.ts +0 -0
  358. /package/serialization/resources/{action → actions}/index.js +0 -0
  359. /package/serialization/resources/{actionSet → triggers}/index.d.ts +0 -0
  360. /package/serialization/resources/{actionSet → triggers}/index.js +0 -0
@@ -0,0 +1,13 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export const EntityType = {
5
+ Conversation: "CONVERSATION",
6
+ ConversationMessage: "CONVERSATION_MESSAGE",
7
+ KnowledgeBase: "KNOWLEDGE_BASE",
8
+ KnowledgeDocument: "KNOWLEDGE_DOCUMENT",
9
+ Action: "ACTION",
10
+ User: "USER",
11
+ UserEvent: "USER_EVENT",
12
+ EventTrigger: "EVENT_TRIGGER",
13
+ };
@@ -12,5 +12,5 @@ export interface Feedback {
12
12
  /** The type of feedback */
13
13
  type: MavenAGI.FeedbackType;
14
14
  /** The feedback text */
15
- text: string;
15
+ text?: string;
16
16
  }
@@ -1,4 +1,11 @@
1
1
  export * from "./ErrorMessage";
2
+ export * from "./EntityType";
3
+ export * from "./EntityIdBase";
4
+ export * from "./EntityId";
2
5
  export * from "./User";
3
6
  export * from "./FeedbackType";
4
7
  export * from "./Feedback";
8
+ export * from "./AppUserIdentification";
9
+ export * from "./AppUserIdentifyingProperty";
10
+ export * from "./AppUserIdentifyingPropertyType";
11
+ export * from "./AppUser";
@@ -1,4 +1,11 @@
1
1
  export * from "./ErrorMessage";
2
+ export * from "./EntityType";
3
+ export * from "./EntityIdBase";
4
+ export * from "./EntityId";
2
5
  export * from "./User";
3
6
  export * from "./FeedbackType";
4
7
  export * from "./Feedback";
8
+ export * from "./AppUserIdentification";
9
+ export * from "./AppUserIdentifyingProperty";
10
+ export * from "./AppUserIdentifyingPropertyType";
11
+ export * from "./AppUser";
@@ -9,8 +9,8 @@ export declare namespace Conversation {
9
9
  environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
10
10
  appId?: core.Supplier<string | undefined>;
11
11
  appSecret?: core.Supplier<string | undefined>;
12
- organizationId: core.Supplier<string>;
13
- agentId: core.Supplier<string>;
12
+ xOrganizationId: core.Supplier<string>;
13
+ xAgentId: core.Supplier<string>;
14
14
  fetcher?: core.FetchFunction;
15
15
  }
16
16
  interface RequestOptions {
@@ -35,8 +35,13 @@ export declare class Conversation {
35
35
  * @example
36
36
  * await client.conversation.initialize({
37
37
  * messages: [{}],
38
+ * context: {},
38
39
  * id: "string",
39
- * context: {}
40
+ * responseConfig: {
41
+ * capabilities: [MavenAGI.Capability.Markdown],
42
+ * isCopilot: true,
43
+ * responseLength: MavenAGI.ResponseLength.Short
44
+ * }
40
45
  * })
41
46
  */
42
47
  initialize(request: MavenAGI.ConversationRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
@@ -89,7 +94,8 @@ export declare class Conversation {
89
94
  * await client.conversation.ask("string", {
90
95
  * id: "string",
91
96
  * text: "string",
92
- * context: {}
97
+ * context: {},
98
+ * responseConfig: {}
93
99
  * })
94
100
  */
95
101
  ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
@@ -166,5 +172,22 @@ export declare class Conversation {
166
172
  * })
167
173
  */
168
174
  submitActionForm(conversationId: string, request: MavenAGI.ActionExecutionRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ActionExecutionResponse>;
175
+ /**
176
+ * Add metadata to an existing conversation's Context. If a metadata field already exists, it will be overwritten.
177
+ *
178
+ * @param {string} conversationId - The ID of a conversation the metadata being added belongs to
179
+ * @param {Record<string, string>} request
180
+ * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
181
+ *
182
+ * @throws {@link MavenAGI.NotFoundError}
183
+ * @throws {@link MavenAGI.BadRequestError}
184
+ * @throws {@link MavenAGI.ServerError}
185
+ *
186
+ * @example
187
+ * await client.conversation.addConversationMetadata("string", {
188
+ * "string": "string"
189
+ * })
190
+ */
191
+ addConversationMetadata(conversationId: string, request: Record<string, string>, requestOptions?: Conversation.RequestOptions): Promise<Record<string, string>>;
169
192
  protected _getAuthorizationHeader(): Promise<string | undefined>;
170
193
  }
@@ -33,8 +33,13 @@ export class Conversation {
33
33
  * @example
34
34
  * await client.conversation.initialize({
35
35
  * messages: [{}],
36
+ * context: {},
36
37
  * id: "string",
37
- * context: {}
38
+ * responseConfig: {
39
+ * capabilities: [MavenAGI.Capability.Markdown],
40
+ * isCopilot: true,
41
+ * responseLength: MavenAGI.ResponseLength.Short
42
+ * }
38
43
  * })
39
44
  */
40
45
  initialize(request, requestOptions) {
@@ -45,11 +50,11 @@ export class Conversation {
45
50
  method: "POST",
46
51
  headers: {
47
52
  Authorization: yield this._getAuthorizationHeader(),
48
- "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
49
- "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
53
+ "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
54
+ "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
50
55
  "X-Fern-Language": "JavaScript",
51
56
  "X-Fern-SDK-Name": "mavenagi",
52
- "X-Fern-SDK-Version": "0.0.0-alpha.3",
57
+ "X-Fern-SDK-Version": "0.0.0-alpha.5",
53
58
  "X-Fern-Runtime": core.RUNTIME.type,
54
59
  "X-Fern-Runtime-Version": core.RUNTIME.version,
55
60
  },
@@ -133,11 +138,11 @@ export class Conversation {
133
138
  method: "GET",
134
139
  headers: {
135
140
  Authorization: yield this._getAuthorizationHeader(),
136
- "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
137
- "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
141
+ "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
142
+ "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
138
143
  "X-Fern-Language": "JavaScript",
139
144
  "X-Fern-SDK-Name": "mavenagi",
140
- "X-Fern-SDK-Version": "0.0.0-alpha.3",
145
+ "X-Fern-SDK-Version": "0.0.0-alpha.5",
141
146
  "X-Fern-Runtime": core.RUNTIME.type,
142
147
  "X-Fern-Runtime-Version": core.RUNTIME.version,
143
148
  },
@@ -226,11 +231,11 @@ export class Conversation {
226
231
  method: "POST",
227
232
  headers: {
228
233
  Authorization: yield this._getAuthorizationHeader(),
229
- "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
230
- "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
234
+ "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
235
+ "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
231
236
  "X-Fern-Language": "JavaScript",
232
237
  "X-Fern-SDK-Name": "mavenagi",
233
- "X-Fern-SDK-Version": "0.0.0-alpha.3",
238
+ "X-Fern-SDK-Version": "0.0.0-alpha.5",
234
239
  "X-Fern-Runtime": core.RUNTIME.type,
235
240
  "X-Fern-Runtime-Version": core.RUNTIME.version,
236
241
  },
@@ -310,7 +315,8 @@ export class Conversation {
310
315
  * await client.conversation.ask("string", {
311
316
  * id: "string",
312
317
  * text: "string",
313
- * context: {}
318
+ * context: {},
319
+ * responseConfig: {}
314
320
  * })
315
321
  */
316
322
  ask(conversationId, request, requestOptions) {
@@ -321,11 +327,11 @@ export class Conversation {
321
327
  method: "POST",
322
328
  headers: {
323
329
  Authorization: yield this._getAuthorizationHeader(),
324
- "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
325
- "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
330
+ "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
331
+ "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
326
332
  "X-Fern-Language": "JavaScript",
327
333
  "X-Fern-SDK-Name": "mavenagi",
328
- "X-Fern-SDK-Version": "0.0.0-alpha.3",
334
+ "X-Fern-SDK-Version": "0.0.0-alpha.5",
329
335
  "X-Fern-Runtime": core.RUNTIME.type,
330
336
  "X-Fern-Runtime-Version": core.RUNTIME.version,
331
337
  },
@@ -399,11 +405,11 @@ export class Conversation {
399
405
  method: "POST",
400
406
  headers: {
401
407
  Authorization: yield this._getAuthorizationHeader(),
402
- "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
403
- "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
408
+ "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
409
+ "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
404
410
  "X-Fern-Language": "JavaScript",
405
411
  "X-Fern-SDK-Name": "mavenagi",
406
- "X-Fern-SDK-Version": "0.0.0-alpha.3",
412
+ "X-Fern-SDK-Version": "0.0.0-alpha.5",
407
413
  "X-Fern-Runtime": core.RUNTIME.type,
408
414
  "X-Fern-Runtime-Version": core.RUNTIME.version,
409
415
  },
@@ -501,11 +507,11 @@ export class Conversation {
501
507
  method: "POST",
502
508
  headers: {
503
509
  Authorization: yield this._getAuthorizationHeader(),
504
- "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
505
- "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
510
+ "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
511
+ "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
506
512
  "X-Fern-Language": "JavaScript",
507
513
  "X-Fern-SDK-Name": "mavenagi",
508
- "X-Fern-SDK-Version": "0.0.0-alpha.3",
514
+ "X-Fern-SDK-Version": "0.0.0-alpha.5",
509
515
  "X-Fern-Runtime": core.RUNTIME.type,
510
516
  "X-Fern-Runtime-Version": core.RUNTIME.version,
511
517
  },
@@ -597,11 +603,11 @@ export class Conversation {
597
603
  method: "POST",
598
604
  headers: {
599
605
  Authorization: yield this._getAuthorizationHeader(),
600
- "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
601
- "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
606
+ "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
607
+ "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
602
608
  "X-Fern-Language": "JavaScript",
603
609
  "X-Fern-SDK-Name": "mavenagi",
604
- "X-Fern-SDK-Version": "0.0.0-alpha.3",
610
+ "X-Fern-SDK-Version": "0.0.0-alpha.5",
605
611
  "X-Fern-Runtime": core.RUNTIME.type,
606
612
  "X-Fern-Runtime-Version": core.RUNTIME.version,
607
613
  },
@@ -698,11 +704,11 @@ export class Conversation {
698
704
  method: "POST",
699
705
  headers: {
700
706
  Authorization: yield this._getAuthorizationHeader(),
701
- "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
702
- "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
707
+ "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
708
+ "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
703
709
  "X-Fern-Language": "JavaScript",
704
710
  "X-Fern-SDK-Name": "mavenagi",
705
- "X-Fern-SDK-Version": "0.0.0-alpha.3",
711
+ "X-Fern-SDK-Version": "0.0.0-alpha.5",
706
712
  "X-Fern-Runtime": core.RUNTIME.type,
707
713
  "X-Fern-Runtime-Version": core.RUNTIME.version,
708
714
  },
@@ -765,6 +771,99 @@ export class Conversation {
765
771
  }
766
772
  });
767
773
  }
774
+ /**
775
+ * Add metadata to an existing conversation's Context. If a metadata field already exists, it will be overwritten.
776
+ *
777
+ * @param {string} conversationId - The ID of a conversation the metadata being added belongs to
778
+ * @param {Record<string, string>} request
779
+ * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
780
+ *
781
+ * @throws {@link MavenAGI.NotFoundError}
782
+ * @throws {@link MavenAGI.BadRequestError}
783
+ * @throws {@link MavenAGI.ServerError}
784
+ *
785
+ * @example
786
+ * await client.conversation.addConversationMetadata("string", {
787
+ * "string": "string"
788
+ * })
789
+ */
790
+ addConversationMetadata(conversationId, request, requestOptions) {
791
+ var _a, _b;
792
+ return __awaiter(this, void 0, void 0, function* () {
793
+ const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
794
+ url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/conversations/${encodeURIComponent(conversationId)}/metadata`),
795
+ method: "POST",
796
+ headers: {
797
+ Authorization: yield this._getAuthorizationHeader(),
798
+ "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
799
+ "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
800
+ "X-Fern-Language": "JavaScript",
801
+ "X-Fern-SDK-Name": "mavenagi",
802
+ "X-Fern-SDK-Version": "0.0.0-alpha.5",
803
+ "X-Fern-Runtime": core.RUNTIME.type,
804
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
805
+ },
806
+ contentType: "application/json",
807
+ body: yield serializers.conversation.addConversationMetadata.Request.jsonOrThrow(request, {
808
+ unrecognizedObjectKeys: "strip",
809
+ }),
810
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
811
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
812
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
813
+ });
814
+ if (_response.ok) {
815
+ return yield serializers.conversation.addConversationMetadata.Response.parseOrThrow(_response.body, {
816
+ unrecognizedObjectKeys: "passthrough",
817
+ allowUnrecognizedUnionMembers: true,
818
+ allowUnrecognizedEnumValues: true,
819
+ breadcrumbsPrefix: ["response"],
820
+ });
821
+ }
822
+ if (_response.error.reason === "status-code") {
823
+ switch (_response.error.statusCode) {
824
+ case 404:
825
+ throw new MavenAGI.NotFoundError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
826
+ unrecognizedObjectKeys: "passthrough",
827
+ allowUnrecognizedUnionMembers: true,
828
+ allowUnrecognizedEnumValues: true,
829
+ breadcrumbsPrefix: ["response"],
830
+ }));
831
+ case 400:
832
+ throw new MavenAGI.BadRequestError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
833
+ unrecognizedObjectKeys: "passthrough",
834
+ allowUnrecognizedUnionMembers: true,
835
+ allowUnrecognizedEnumValues: true,
836
+ breadcrumbsPrefix: ["response"],
837
+ }));
838
+ case 500:
839
+ throw new MavenAGI.ServerError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
840
+ unrecognizedObjectKeys: "passthrough",
841
+ allowUnrecognizedUnionMembers: true,
842
+ allowUnrecognizedEnumValues: true,
843
+ breadcrumbsPrefix: ["response"],
844
+ }));
845
+ default:
846
+ throw new errors.MavenAGIError({
847
+ statusCode: _response.error.statusCode,
848
+ body: _response.error.body,
849
+ });
850
+ }
851
+ }
852
+ switch (_response.error.reason) {
853
+ case "non-json":
854
+ throw new errors.MavenAGIError({
855
+ statusCode: _response.error.statusCode,
856
+ body: _response.error.rawBody,
857
+ });
858
+ case "timeout":
859
+ throw new errors.MavenAGITimeoutError();
860
+ case "unknown":
861
+ throw new errors.MavenAGIError({
862
+ message: _response.error.errorMessage,
863
+ });
864
+ }
865
+ });
866
+ }
768
867
  _getAuthorizationHeader() {
769
868
  var _a, _b;
770
869
  return __awaiter(this, void 0, void 0, function* () {
@@ -9,4 +9,6 @@ export interface AskRequest {
9
9
  text: string;
10
10
  /** The context of the message */
11
11
  context?: MavenAGI.ConversationMessageContext;
12
+ /** Optional configuration for responses to this conversation. Only applies to new conversations. */
13
+ responseConfig?: MavenAGI.ResponseConfig;
12
14
  }
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export declare type Capability = "MARKDOWN" | "FORMS";
5
+ export declare const Capability: {
6
+ readonly Markdown: "MARKDOWN";
7
+ readonly Forms: "FORMS";
8
+ };
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export const Capability = {
5
+ Markdown: "MARKDOWN",
6
+ Forms: "FORMS",
7
+ };
@@ -5,6 +5,6 @@ import * as MavenAGI from "../../../index";
5
5
  export interface ConversationBase {
6
6
  /** Externally supplied ID to uniquely identify this conversation */
7
7
  id: string;
8
- /** The context of the conversation */
9
- context?: MavenAGI.ConversationContext;
8
+ /** Optional configurations for responses to this conversation */
9
+ responseConfig?: MavenAGI.ResponseConfig;
10
10
  }
@@ -5,4 +5,6 @@ import * as MavenAGI from "../../../index";
5
5
  export interface ConversationRequest extends MavenAGI.ConversationBase {
6
6
  /** The messages in the conversation */
7
7
  messages: MavenAGI.ConversationMessageRequest[];
8
+ /** The context of the conversation */
9
+ context?: MavenAGI.ConversationContext;
8
10
  }
@@ -5,4 +5,6 @@ import * as MavenAGI from "../../../index";
5
5
  export interface ConversationResponse extends MavenAGI.ConversationBase {
6
6
  /** The messages in the conversation */
7
7
  messages: MavenAGI.ConversationMessageResponse[];
8
+ /** The context of the conversation */
9
+ context: MavenAGI.ConversationContext;
8
10
  }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as MavenAGI from "../../../index";
5
+ export interface ResponseConfig {
6
+ /** List of capabilities supported by the caller. Defaults to all */
7
+ capabilities?: MavenAGI.Capability[];
8
+ /** Whether the response is for an human agent (true) or an end user (false). Defaults to false. */
9
+ isCopilot?: boolean;
10
+ /** The desired response length. Defaults to ResponseLength.MEDIUM. */
11
+ responseLength?: MavenAGI.ResponseLength;
12
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export declare type ResponseLength = "SHORT" | "MEDIUM" | "LONG";
5
+ export declare const ResponseLength: {
6
+ readonly Short: "SHORT";
7
+ readonly Medium: "MEDIUM";
8
+ readonly Long: "LONG";
9
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export const ResponseLength = {
5
+ Short: "SHORT",
6
+ Medium: "MEDIUM",
7
+ Long: "LONG",
8
+ };
@@ -1,4 +1,7 @@
1
1
  export * from "./AskRequest";
2
+ export * from "./ResponseConfig";
3
+ export * from "./Capability";
4
+ export * from "./ResponseLength";
2
5
  export * from "./GenerateMavenSuggestionsRequest";
3
6
  export * from "./ConversationBase";
4
7
  export * from "./ConversationResponse";
@@ -1,4 +1,7 @@
1
1
  export * from "./AskRequest";
2
+ export * from "./ResponseConfig";
3
+ export * from "./Capability";
4
+ export * from "./ResponseLength";
2
5
  export * from "./GenerateMavenSuggestionsRequest";
3
6
  export * from "./ConversationBase";
4
7
  export * from "./ConversationResponse";
@@ -1,11 +1,12 @@
1
- export * as actionSet from "./actionSet";
2
- export * from "./actionSet/types";
3
- export * as action from "./action";
4
- export * from "./action/types";
1
+ export * as actions from "./actions";
2
+ export * from "./actions/types";
5
3
  export * as commons from "./commons";
6
4
  export * from "./commons/types";
7
5
  export * as conversation from "./conversation";
8
6
  export * from "./conversation/types";
9
7
  export * as knowledge from "./knowledge";
10
8
  export * from "./knowledge/types";
9
+ export * as triggers from "./triggers";
10
+ export * from "./triggers/types";
11
11
  export * from "./commons/errors";
12
+ export * as users from "./users";
@@ -1,11 +1,12 @@
1
- export * as actionSet from "./actionSet";
2
- export * from "./actionSet/types";
3
- export * as action from "./action";
4
- export * from "./action/types";
1
+ export * as actions from "./actions";
2
+ export * from "./actions/types";
5
3
  export * as commons from "./commons";
6
4
  export * from "./commons/types";
7
5
  export * as conversation from "./conversation";
8
6
  export * from "./conversation/types";
9
7
  export * as knowledge from "./knowledge";
10
8
  export * from "./knowledge/types";
9
+ export * as triggers from "./triggers";
10
+ export * from "./triggers/types";
11
11
  export * from "./commons/errors";
12
+ export * as users from "./users";
@@ -9,8 +9,8 @@ export declare namespace Knowledge {
9
9
  environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
10
10
  appId?: core.Supplier<string | undefined>;
11
11
  appSecret?: core.Supplier<string | undefined>;
12
- organizationId: core.Supplier<string>;
13
- agentId: core.Supplier<string>;
12
+ xOrganizationId: core.Supplier<string>;
13
+ xAgentId: core.Supplier<string>;
14
14
  fetcher?: core.FetchFunction;
15
15
  }
16
16
  interface RequestOptions {
@@ -41,6 +41,20 @@ export declare class Knowledge {
41
41
  * })
42
42
  */
43
43
  createKnowledgeBase(request: MavenAGI.KnowledgeBase, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBase>;
44
+ /**
45
+ * Get an existing knowledge base.
46
+ *
47
+ * @param {string} knowledgeBaseId - The ID of the knowledge base to get
48
+ * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
49
+ *
50
+ * @throws {@link MavenAGI.NotFoundError}
51
+ * @throws {@link MavenAGI.BadRequestError}
52
+ * @throws {@link MavenAGI.ServerError}
53
+ *
54
+ * @example
55
+ * await client.knowledge.getKnowledgeBase("string")
56
+ */
57
+ getKnowledgeBase(knowledgeBaseId: string, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBase>;
44
58
  /**
45
59
  * Create a new knowledge base version. Only supported on API knowledge bases. Will throw an exception if there is an existing version in progress.
46
60
  *
@@ -77,7 +91,7 @@ export declare class Knowledge {
77
91
  /**
78
92
  * 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.
79
93
  *
80
- * @param {MavenAGI.KnowledgeDocument} request
94
+ * @param {MavenAGI.KnowledgeDocumentRequest} request
81
95
  * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
82
96
  *
83
97
  * @throws {@link MavenAGI.NotFoundError}
@@ -86,8 +100,9 @@ export declare class Knowledge {
86
100
  *
87
101
  * @example
88
102
  * await client.knowledge.createKnowledgeDocument({
89
- * title: "string",
103
+ * contentType: MavenAGI.KnowledgeDocumentContentType.Html,
90
104
  * content: "string",
105
+ * title: "string",
91
106
  * url: "string",
92
107
  * language: "string",
93
108
  * createdAt: new Date("2024-01-15T09:30:00.000Z"),
@@ -97,11 +112,11 @@ export declare class Knowledge {
97
112
  * documentId: "string"
98
113
  * })
99
114
  */
100
- createKnowledgeDocument(request: MavenAGI.KnowledgeDocument, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocument>;
115
+ createKnowledgeDocument(request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
101
116
  /**
102
117
  * 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.
103
118
  *
104
- * @param {MavenAGI.KnowledgeDocument} request
119
+ * @param {MavenAGI.KnowledgeDocumentRequest} request
105
120
  * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
106
121
  *
107
122
  * @throws {@link MavenAGI.NotFoundError}
@@ -110,8 +125,9 @@ export declare class Knowledge {
110
125
  *
111
126
  * @example
112
127
  * await client.knowledge.updateKnowledgeDocument({
113
- * title: "string",
128
+ * contentType: MavenAGI.KnowledgeDocumentContentType.Html,
114
129
  * content: "string",
130
+ * title: "string",
115
131
  * url: "string",
116
132
  * language: "string",
117
133
  * createdAt: new Date("2024-01-15T09:30:00.000Z"),
@@ -121,7 +137,7 @@ export declare class Knowledge {
121
137
  * documentId: "string"
122
138
  * })
123
139
  */
124
- updateKnowledgeDocument(request: MavenAGI.KnowledgeDocument, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocument>;
140
+ updateKnowledgeDocument(request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
125
141
  /**
126
142
  * 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.
127
143
  *