mavenagi 1.0.8 → 1.0.10

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 (294) hide show
  1. package/Client.d.ts +3 -0
  2. package/Client.js +11 -6
  3. package/api/resources/actions/client/Client.d.ts +2 -1
  4. package/api/resources/actions/client/Client.js +5 -4
  5. package/api/resources/actions/types/ActionRequest.d.ts +2 -1
  6. package/api/resources/analytics/client/Client.js +3 -3
  7. package/api/resources/appSettings/client/Client.d.ts +24 -0
  8. package/api/resources/appSettings/client/Client.js +91 -1
  9. package/api/resources/commons/types/ActionBase.d.ts +3 -1
  10. package/api/resources/commons/types/ActionResponse.d.ts +2 -1
  11. package/api/resources/commons/types/{ConversationBase.d.ts → BaseConversationResponse.d.ts} +9 -1
  12. package/api/resources/commons/types/BasePaginatedRequest.d.ts +11 -0
  13. package/api/resources/commons/types/BotMessage.d.ts +1 -0
  14. package/api/resources/commons/types/BotMessageStatus.d.ts +22 -0
  15. package/api/resources/commons/types/BotMessageStatus.js +14 -0
  16. package/api/resources/commons/types/ConversationAnalysis.d.ts +8 -0
  17. package/api/resources/commons/types/ConversationPreview.d.ts +6 -0
  18. package/api/resources/commons/types/ConversationPreview.js +5 -0
  19. package/api/resources/commons/types/ConversationResponse.d.ts +4 -10
  20. package/{dist/api/resources/conversation → api/resources/commons}/types/QualityReason.d.ts +1 -2
  21. package/api/resources/{conversation → commons}/types/QualityReason.js +0 -1
  22. package/api/resources/commons/types/index.d.ts +8 -3
  23. package/api/resources/commons/types/index.js +8 -3
  24. package/api/resources/conversation/client/Client.d.ts +22 -6
  25. package/api/resources/conversation/client/Client.js +100 -18
  26. package/api/resources/conversation/types/ConversationFilter.d.ts +1 -0
  27. package/api/resources/conversation/types/ConversationRequest.d.ts +15 -1
  28. package/api/resources/conversation/types/ConversationsResponse.d.ts +8 -0
  29. package/api/resources/conversation/types/ConversationsResponse.js +5 -0
  30. package/api/resources/conversation/types/ConversationsSearchRequest.d.ts +8 -0
  31. package/api/resources/conversation/types/ConversationsSearchRequest.js +5 -0
  32. package/api/resources/conversation/types/index.d.ts +2 -2
  33. package/api/resources/conversation/types/index.js +2 -2
  34. package/api/resources/inbox/client/Client.js +5 -5
  35. package/api/resources/index.d.ts +2 -0
  36. package/api/resources/index.js +3 -1
  37. package/api/resources/knowledge/client/Client.d.ts +4 -3
  38. package/api/resources/knowledge/client/Client.js +11 -10
  39. package/api/resources/knowledge/types/KnowledgeBaseProperties.d.ts +0 -4
  40. package/api/resources/knowledge/types/KnowledgeBaseRequest.d.ts +1 -2
  41. package/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +2 -0
  42. package/api/resources/knowledge/types/KnowledgeBaseType.d.ts +2 -4
  43. package/api/resources/knowledge/types/KnowledgeBaseType.js +0 -2
  44. package/api/resources/knowledge/types/index.d.ts +1 -1
  45. package/api/resources/knowledge/types/index.js +1 -1
  46. package/api/resources/realtime/client/Client.d.ts +34 -0
  47. package/api/resources/realtime/client/Client.js +87 -0
  48. package/api/resources/realtime/client/Socket.d.ts +41 -0
  49. package/api/resources/realtime/client/Socket.js +155 -0
  50. package/api/resources/realtime/client/index.d.ts +1 -0
  51. package/api/resources/realtime/client/index.js +2 -0
  52. package/api/resources/realtime/index.d.ts +2 -0
  53. package/api/resources/realtime/index.js +18 -0
  54. package/api/resources/realtime/types/AudioPublishEvent.d.ts +6 -0
  55. package/api/resources/realtime/types/AudioPublishEvent.js +5 -0
  56. package/api/resources/realtime/types/AudioSubscribeEvent.d.ts +6 -0
  57. package/api/resources/realtime/types/AudioSubscribeEvent.js +5 -0
  58. package/api/resources/realtime/types/ControlEvent.d.ts +6 -0
  59. package/api/resources/realtime/types/ControlEvent.js +5 -0
  60. package/api/resources/realtime/types/HangUpPublishEvent.d.ts +6 -0
  61. package/api/resources/realtime/types/HangUpPublishEvent.js +5 -0
  62. package/api/resources/realtime/types/PublishEvent.d.ts +16 -0
  63. package/api/resources/realtime/types/PublishEvent.js +5 -0
  64. package/api/resources/realtime/types/SubscribeEvent.d.ts +22 -0
  65. package/api/resources/realtime/types/SubscribeEvent.js +5 -0
  66. package/api/resources/realtime/types/index.d.ts +6 -0
  67. package/api/resources/realtime/types/index.js +22 -0
  68. package/api/resources/translations/client/Client.js +1 -1
  69. package/api/resources/triggers/client/Client.js +3 -3
  70. package/api/resources/users/client/Client.js +3 -3
  71. package/core/index.d.ts +1 -0
  72. package/core/index.js +1 -0
  73. package/core/websocket/events.d.ts +36 -0
  74. package/core/websocket/events.js +27 -0
  75. package/core/websocket/index.d.ts +1 -0
  76. package/core/websocket/index.js +17 -0
  77. package/core/websocket/ws.d.ts +137 -0
  78. package/core/websocket/ws.js +452 -0
  79. package/dist/Client.d.ts +3 -0
  80. package/dist/Client.js +11 -6
  81. package/dist/api/resources/actions/client/Client.d.ts +2 -1
  82. package/dist/api/resources/actions/client/Client.js +5 -4
  83. package/dist/api/resources/actions/types/ActionRequest.d.ts +2 -1
  84. package/dist/api/resources/analytics/client/Client.js +3 -3
  85. package/dist/api/resources/appSettings/client/Client.d.ts +24 -0
  86. package/dist/api/resources/appSettings/client/Client.js +91 -1
  87. package/dist/api/resources/commons/types/ActionBase.d.ts +3 -1
  88. package/dist/api/resources/commons/types/ActionResponse.d.ts +2 -1
  89. package/dist/api/resources/commons/types/{ConversationBase.d.ts → BaseConversationResponse.d.ts} +9 -1
  90. package/dist/api/resources/commons/types/BaseConversationResponse.js +5 -0
  91. package/dist/api/resources/commons/types/BasePaginatedRequest.d.ts +11 -0
  92. package/dist/api/resources/commons/types/BasePaginatedRequest.js +5 -0
  93. package/dist/api/resources/commons/types/BotMessage.d.ts +1 -0
  94. package/dist/api/resources/commons/types/BotMessageStatus.d.ts +22 -0
  95. package/dist/api/resources/commons/types/BotMessageStatus.js +14 -0
  96. package/dist/api/resources/commons/types/ConversationAnalysis.d.ts +8 -0
  97. package/dist/api/resources/commons/types/ConversationPreview.d.ts +6 -0
  98. package/dist/api/resources/commons/types/ConversationPreview.js +5 -0
  99. package/dist/api/resources/commons/types/ConversationResponse.d.ts +4 -10
  100. package/{api/resources/conversation → dist/api/resources/commons}/types/QualityReason.d.ts +1 -2
  101. package/dist/api/resources/{conversation → commons}/types/QualityReason.js +0 -1
  102. package/dist/api/resources/commons/types/index.d.ts +8 -3
  103. package/dist/api/resources/commons/types/index.js +8 -3
  104. package/dist/api/resources/conversation/client/Client.d.ts +22 -6
  105. package/dist/api/resources/conversation/client/Client.js +100 -18
  106. package/dist/api/resources/conversation/types/ConversationFilter.d.ts +1 -0
  107. package/dist/api/resources/conversation/types/ConversationRequest.d.ts +15 -1
  108. package/dist/api/resources/conversation/types/ConversationsResponse.d.ts +8 -0
  109. package/dist/api/resources/conversation/types/ConversationsResponse.js +5 -0
  110. package/dist/api/resources/conversation/types/ConversationsSearchRequest.d.ts +8 -0
  111. package/dist/api/resources/conversation/types/ConversationsSearchRequest.js +5 -0
  112. package/dist/api/resources/conversation/types/index.d.ts +2 -2
  113. package/dist/api/resources/conversation/types/index.js +2 -2
  114. package/dist/api/resources/inbox/client/Client.js +5 -5
  115. package/dist/api/resources/index.d.ts +2 -0
  116. package/dist/api/resources/index.js +3 -1
  117. package/dist/api/resources/knowledge/client/Client.d.ts +4 -3
  118. package/dist/api/resources/knowledge/client/Client.js +11 -10
  119. package/dist/api/resources/knowledge/types/KnowledgeBaseProperties.d.ts +0 -4
  120. package/dist/api/resources/knowledge/types/KnowledgeBaseRequest.d.ts +1 -2
  121. package/dist/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +2 -0
  122. package/dist/api/resources/knowledge/types/KnowledgeBaseType.d.ts +2 -4
  123. package/dist/api/resources/knowledge/types/KnowledgeBaseType.js +0 -2
  124. package/dist/api/resources/knowledge/types/index.d.ts +1 -1
  125. package/dist/api/resources/knowledge/types/index.js +1 -1
  126. package/dist/api/resources/realtime/client/Client.d.ts +34 -0
  127. package/dist/api/resources/realtime/client/Client.js +87 -0
  128. package/dist/api/resources/realtime/client/Socket.d.ts +41 -0
  129. package/dist/api/resources/realtime/client/Socket.js +155 -0
  130. package/dist/api/resources/realtime/client/index.d.ts +1 -0
  131. package/dist/api/resources/realtime/client/index.js +2 -0
  132. package/dist/api/resources/realtime/index.d.ts +2 -0
  133. package/dist/api/resources/realtime/index.js +18 -0
  134. package/dist/api/resources/realtime/types/AudioPublishEvent.d.ts +6 -0
  135. package/dist/api/resources/realtime/types/AudioPublishEvent.js +5 -0
  136. package/dist/api/resources/realtime/types/AudioSubscribeEvent.d.ts +6 -0
  137. package/dist/api/resources/realtime/types/AudioSubscribeEvent.js +5 -0
  138. package/dist/api/resources/realtime/types/ControlEvent.d.ts +6 -0
  139. package/dist/api/resources/realtime/types/ControlEvent.js +5 -0
  140. package/dist/api/resources/realtime/types/HangUpPublishEvent.d.ts +6 -0
  141. package/dist/api/resources/realtime/types/HangUpPublishEvent.js +5 -0
  142. package/dist/api/resources/realtime/types/PublishEvent.d.ts +16 -0
  143. package/dist/api/resources/realtime/types/PublishEvent.js +5 -0
  144. package/dist/api/resources/realtime/types/SubscribeEvent.d.ts +22 -0
  145. package/dist/api/resources/realtime/types/SubscribeEvent.js +5 -0
  146. package/dist/api/resources/realtime/types/index.d.ts +6 -0
  147. package/dist/api/resources/realtime/types/index.js +22 -0
  148. package/dist/api/resources/translations/client/Client.js +1 -1
  149. package/dist/api/resources/triggers/client/Client.js +3 -3
  150. package/dist/api/resources/users/client/Client.js +3 -3
  151. package/dist/core/index.d.ts +1 -0
  152. package/dist/core/index.js +1 -0
  153. package/dist/core/websocket/events.d.ts +36 -0
  154. package/dist/core/websocket/events.js +27 -0
  155. package/dist/core/websocket/index.d.ts +1 -0
  156. package/dist/core/websocket/index.js +17 -0
  157. package/dist/core/websocket/ws.d.ts +137 -0
  158. package/dist/core/websocket/ws.js +452 -0
  159. package/dist/serialization/resources/appSettings/client/index.d.ts +1 -0
  160. package/dist/serialization/resources/appSettings/client/index.js +2 -1
  161. package/dist/serialization/resources/appSettings/client/update.d.ts +13 -0
  162. package/dist/serialization/resources/appSettings/client/update.js +42 -0
  163. package/dist/serialization/resources/commons/types/ActionBase.d.ts +1 -0
  164. package/dist/serialization/resources/commons/types/ActionBase.js +1 -0
  165. package/{serialization/resources/commons/types/ConversationBase.d.ts → dist/serialization/resources/commons/types/BaseConversationResponse.d.ts} +9 -2
  166. package/dist/serialization/resources/commons/types/{ConversationBase.js → BaseConversationResponse.js} +9 -2
  167. package/dist/serialization/resources/commons/types/BasePaginatedRequest.d.ts +14 -0
  168. package/dist/serialization/resources/commons/types/BasePaginatedRequest.js +45 -0
  169. package/dist/serialization/resources/commons/types/BotMessage.d.ts +2 -0
  170. package/dist/serialization/resources/commons/types/BotMessage.js +2 -0
  171. package/dist/serialization/resources/commons/types/BotMessageStatus.d.ts +10 -0
  172. package/dist/serialization/resources/commons/types/BotMessageStatus.js +41 -0
  173. package/dist/serialization/resources/commons/types/ConversationAnalysis.d.ts +6 -0
  174. package/dist/serialization/resources/commons/types/ConversationAnalysis.js +6 -0
  175. package/dist/serialization/resources/commons/types/ConversationPreview.d.ts +12 -0
  176. package/dist/serialization/resources/commons/types/ConversationPreview.js +42 -0
  177. package/dist/serialization/resources/commons/types/ConversationResponse.d.ts +2 -9
  178. package/dist/serialization/resources/commons/types/ConversationResponse.js +2 -9
  179. package/dist/serialization/resources/{conversation → commons}/types/QualityReason.d.ts +1 -1
  180. package/dist/serialization/resources/{conversation → commons}/types/QualityReason.js +0 -1
  181. package/dist/serialization/resources/commons/types/index.d.ts +8 -3
  182. package/dist/serialization/resources/commons/types/index.js +8 -3
  183. package/dist/serialization/resources/conversation/types/ConversationFilter.d.ts +3 -2
  184. package/dist/serialization/resources/conversation/types/ConversationFilter.js +3 -2
  185. package/dist/serialization/resources/conversation/types/ConversationRequest.d.ts +9 -2
  186. package/dist/serialization/resources/conversation/types/ConversationRequest.js +10 -5
  187. package/dist/serialization/resources/conversation/types/ConversationsResponse.d.ts +14 -0
  188. package/dist/serialization/resources/conversation/types/ConversationsResponse.js +47 -0
  189. package/dist/serialization/resources/conversation/types/ConversationsSearchRequest.d.ts +16 -0
  190. package/dist/serialization/resources/conversation/types/ConversationsSearchRequest.js +49 -0
  191. package/dist/serialization/resources/conversation/types/index.d.ts +2 -2
  192. package/dist/serialization/resources/conversation/types/index.js +2 -2
  193. package/dist/serialization/resources/index.d.ts +2 -0
  194. package/dist/serialization/resources/index.js +3 -1
  195. package/dist/serialization/resources/knowledge/types/KnowledgeBaseProperties.d.ts +0 -3
  196. package/dist/serialization/resources/knowledge/types/KnowledgeBaseProperties.js +0 -3
  197. package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +2 -0
  198. package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +2 -0
  199. package/dist/serialization/resources/knowledge/types/KnowledgeBaseType.d.ts +1 -1
  200. package/dist/serialization/resources/knowledge/types/KnowledgeBaseType.js +1 -1
  201. package/dist/serialization/resources/knowledge/types/index.d.ts +1 -1
  202. package/dist/serialization/resources/knowledge/types/index.js +1 -1
  203. package/dist/serialization/resources/realtime/index.d.ts +1 -0
  204. package/dist/serialization/resources/realtime/index.js +17 -0
  205. package/dist/serialization/resources/realtime/types/AudioPublishEvent.d.ts +12 -0
  206. package/dist/serialization/resources/realtime/types/AudioPublishEvent.js +43 -0
  207. package/dist/serialization/resources/realtime/types/AudioSubscribeEvent.d.ts +12 -0
  208. package/dist/serialization/resources/realtime/types/AudioSubscribeEvent.js +43 -0
  209. package/dist/serialization/resources/realtime/types/ControlEvent.d.ts +12 -0
  210. package/dist/serialization/resources/realtime/types/ControlEvent.js +43 -0
  211. package/dist/serialization/resources/realtime/types/HangUpPublishEvent.d.ts +12 -0
  212. package/dist/serialization/resources/realtime/types/HangUpPublishEvent.js +43 -0
  213. package/dist/serialization/resources/realtime/types/PublishEvent.d.ts +18 -0
  214. package/dist/serialization/resources/realtime/types/PublishEvent.js +51 -0
  215. package/dist/serialization/resources/realtime/types/SubscribeEvent.d.ts +24 -0
  216. package/dist/serialization/resources/realtime/types/SubscribeEvent.js +53 -0
  217. package/dist/serialization/resources/realtime/types/index.d.ts +6 -0
  218. package/dist/serialization/resources/realtime/types/index.js +22 -0
  219. package/dist/version.d.ts +1 -1
  220. package/dist/version.js +1 -1
  221. package/package.json +3 -1
  222. package/reference.md +151 -11
  223. package/serialization/resources/appSettings/client/index.d.ts +1 -0
  224. package/serialization/resources/appSettings/client/index.js +2 -1
  225. package/serialization/resources/appSettings/client/update.d.ts +13 -0
  226. package/serialization/resources/appSettings/client/update.js +42 -0
  227. package/serialization/resources/commons/types/ActionBase.d.ts +1 -0
  228. package/serialization/resources/commons/types/ActionBase.js +1 -0
  229. package/{dist/serialization/resources/commons/types/ConversationBase.d.ts → serialization/resources/commons/types/BaseConversationResponse.d.ts} +9 -2
  230. package/serialization/resources/commons/types/{ConversationBase.js → BaseConversationResponse.js} +9 -2
  231. package/serialization/resources/commons/types/BasePaginatedRequest.d.ts +14 -0
  232. package/serialization/resources/commons/types/BasePaginatedRequest.js +45 -0
  233. package/serialization/resources/commons/types/BotMessage.d.ts +2 -0
  234. package/serialization/resources/commons/types/BotMessage.js +2 -0
  235. package/serialization/resources/commons/types/BotMessageStatus.d.ts +10 -0
  236. package/serialization/resources/commons/types/BotMessageStatus.js +41 -0
  237. package/serialization/resources/commons/types/ConversationAnalysis.d.ts +6 -0
  238. package/serialization/resources/commons/types/ConversationAnalysis.js +6 -0
  239. package/serialization/resources/commons/types/ConversationPreview.d.ts +12 -0
  240. package/serialization/resources/commons/types/ConversationPreview.js +42 -0
  241. package/serialization/resources/commons/types/ConversationResponse.d.ts +2 -9
  242. package/serialization/resources/commons/types/ConversationResponse.js +2 -9
  243. package/serialization/resources/{conversation → commons}/types/QualityReason.d.ts +1 -1
  244. package/serialization/resources/{conversation → commons}/types/QualityReason.js +0 -1
  245. package/serialization/resources/commons/types/index.d.ts +8 -3
  246. package/serialization/resources/commons/types/index.js +8 -3
  247. package/serialization/resources/conversation/types/ConversationFilter.d.ts +3 -2
  248. package/serialization/resources/conversation/types/ConversationFilter.js +3 -2
  249. package/serialization/resources/conversation/types/ConversationRequest.d.ts +9 -2
  250. package/serialization/resources/conversation/types/ConversationRequest.js +10 -5
  251. package/serialization/resources/conversation/types/ConversationsResponse.d.ts +14 -0
  252. package/serialization/resources/conversation/types/ConversationsResponse.js +47 -0
  253. package/serialization/resources/conversation/types/ConversationsSearchRequest.d.ts +16 -0
  254. package/serialization/resources/conversation/types/ConversationsSearchRequest.js +49 -0
  255. package/serialization/resources/conversation/types/index.d.ts +2 -2
  256. package/serialization/resources/conversation/types/index.js +2 -2
  257. package/serialization/resources/index.d.ts +2 -0
  258. package/serialization/resources/index.js +3 -1
  259. package/serialization/resources/knowledge/types/KnowledgeBaseProperties.d.ts +0 -3
  260. package/serialization/resources/knowledge/types/KnowledgeBaseProperties.js +0 -3
  261. package/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +2 -0
  262. package/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +2 -0
  263. package/serialization/resources/knowledge/types/KnowledgeBaseType.d.ts +1 -1
  264. package/serialization/resources/knowledge/types/KnowledgeBaseType.js +1 -1
  265. package/serialization/resources/knowledge/types/index.d.ts +1 -1
  266. package/serialization/resources/knowledge/types/index.js +1 -1
  267. package/serialization/resources/realtime/index.d.ts +1 -0
  268. package/serialization/resources/realtime/index.js +17 -0
  269. package/serialization/resources/realtime/types/AudioPublishEvent.d.ts +12 -0
  270. package/serialization/resources/realtime/types/AudioPublishEvent.js +43 -0
  271. package/serialization/resources/realtime/types/AudioSubscribeEvent.d.ts +12 -0
  272. package/serialization/resources/realtime/types/AudioSubscribeEvent.js +43 -0
  273. package/serialization/resources/realtime/types/ControlEvent.d.ts +12 -0
  274. package/serialization/resources/realtime/types/ControlEvent.js +43 -0
  275. package/serialization/resources/realtime/types/HangUpPublishEvent.d.ts +12 -0
  276. package/serialization/resources/realtime/types/HangUpPublishEvent.js +43 -0
  277. package/serialization/resources/realtime/types/PublishEvent.d.ts +18 -0
  278. package/serialization/resources/realtime/types/PublishEvent.js +51 -0
  279. package/serialization/resources/realtime/types/SubscribeEvent.d.ts +24 -0
  280. package/serialization/resources/realtime/types/SubscribeEvent.js +53 -0
  281. package/serialization/resources/realtime/types/index.d.ts +6 -0
  282. package/serialization/resources/realtime/types/index.js +22 -0
  283. package/version.d.ts +1 -1
  284. package/version.js +1 -1
  285. /package/api/resources/commons/types/{ConversationBase.js → BaseConversationResponse.js} +0 -0
  286. /package/{dist/api/resources/commons/types/ConversationBase.js → api/resources/commons/types/BasePaginatedRequest.js} +0 -0
  287. /package/api/resources/{conversation → commons}/types/Quality.d.ts +0 -0
  288. /package/api/resources/{conversation → commons}/types/Quality.js +0 -0
  289. /package/dist/api/resources/{conversation → commons}/types/Quality.d.ts +0 -0
  290. /package/dist/api/resources/{conversation → commons}/types/Quality.js +0 -0
  291. /package/dist/serialization/resources/{conversation → commons}/types/Quality.d.ts +0 -0
  292. /package/dist/serialization/resources/{conversation → commons}/types/Quality.js +0 -0
  293. /package/serialization/resources/{conversation → commons}/types/Quality.d.ts +0 -0
  294. /package/serialization/resources/{conversation → commons}/types/Quality.js +0 -0
package/Client.d.ts CHANGED
@@ -9,6 +9,7 @@ import { AppSettings } from "./api/resources/appSettings/client/Client";
9
9
  import { Conversation } from "./api/resources/conversation/client/Client";
10
10
  import { Inbox } from "./api/resources/inbox/client/Client";
11
11
  import { Knowledge } from "./api/resources/knowledge/client/Client";
12
+ import { Realtime } from "./api/resources/realtime/client/Client";
12
13
  import { Translations } from "./api/resources/translations/client/Client";
13
14
  import { Triggers } from "./api/resources/triggers/client/Client";
14
15
  import { Users } from "./api/resources/users/client/Client";
@@ -48,6 +49,7 @@ export declare class MavenAGIClient {
48
49
  protected _conversation: Conversation | undefined;
49
50
  protected _inbox: Inbox | undefined;
50
51
  protected _knowledge: Knowledge | undefined;
52
+ protected _realtime: Realtime | undefined;
51
53
  protected _translations: Translations | undefined;
52
54
  protected _triggers: Triggers | undefined;
53
55
  protected _users: Users | undefined;
@@ -58,6 +60,7 @@ export declare class MavenAGIClient {
58
60
  get conversation(): Conversation;
59
61
  get inbox(): Inbox;
60
62
  get knowledge(): Knowledge;
63
+ get realtime(): Realtime;
61
64
  get translations(): Translations;
62
65
  get triggers(): Triggers;
63
66
  get users(): Users;
package/Client.js CHANGED
@@ -10,9 +10,10 @@ const Client_3 = require("./api/resources/appSettings/client/Client");
10
10
  const Client_4 = require("./api/resources/conversation/client/Client");
11
11
  const Client_5 = require("./api/resources/inbox/client/Client");
12
12
  const Client_6 = require("./api/resources/knowledge/client/Client");
13
- const Client_7 = require("./api/resources/translations/client/Client");
14
- const Client_8 = require("./api/resources/triggers/client/Client");
15
- const Client_9 = require("./api/resources/users/client/Client");
13
+ const Client_7 = require("./api/resources/realtime/client/Client");
14
+ const Client_8 = require("./api/resources/translations/client/Client");
15
+ const Client_9 = require("./api/resources/triggers/client/Client");
16
+ const Client_10 = require("./api/resources/users/client/Client");
16
17
  class MavenAGIClient {
17
18
  constructor(_options) {
18
19
  this._options = _options;
@@ -41,17 +42,21 @@ class MavenAGIClient {
41
42
  var _a;
42
43
  return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_6.Knowledge(this._options)));
43
44
  }
45
+ get realtime() {
46
+ var _a;
47
+ return ((_a = this._realtime) !== null && _a !== void 0 ? _a : (this._realtime = new Client_7.Realtime(this._options)));
48
+ }
44
49
  get translations() {
45
50
  var _a;
46
- return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_7.Translations(this._options)));
51
+ return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_8.Translations(this._options)));
47
52
  }
48
53
  get triggers() {
49
54
  var _a;
50
- return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_8.Triggers(this._options)));
55
+ return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_9.Triggers(this._options)));
51
56
  }
52
57
  get users() {
53
58
  var _a;
54
- return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_9.Users(this._options)));
59
+ return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_10.Users(this._options)));
55
60
  }
56
61
  }
57
62
  exports.MavenAGIClient = MavenAGIClient;
@@ -64,7 +64,8 @@ export declare class Actions {
64
64
  * preconditionType: "user",
65
65
  * key: "userKey2"
66
66
  * }]
67
- * }
67
+ * },
68
+ * language: "en"
68
69
  * })
69
70
  */
70
71
  createOrUpdate(request: MavenAGI.ActionRequest, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
@@ -88,7 +88,8 @@ class Actions {
88
88
  * preconditionType: "user",
89
89
  * key: "userKey2"
90
90
  * }]
91
- * }
91
+ * },
92
+ * language: "en"
92
93
  * })
93
94
  */
94
95
  createOrUpdate(request, requestOptions) {
@@ -97,7 +98,7 @@ class Actions {
97
98
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
98
99
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, "/v1/actions"),
99
100
  method: "PUT",
100
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.8", "User-Agent": "mavenagi/1.0.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
101
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
101
102
  contentType: "application/json",
102
103
  requestType: "json",
103
104
  body: serializers.ActionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -177,7 +178,7 @@ class Actions {
177
178
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
178
179
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionReferenceId)}`),
179
180
  method: "GET",
180
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.8", "User-Agent": "mavenagi/1.0.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
181
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
181
182
  contentType: "application/json",
182
183
  requestType: "json",
183
184
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -256,7 +257,7 @@ class Actions {
256
257
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
257
258
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionReferenceId)}`),
258
259
  method: "DELETE",
259
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.8", "User-Agent": "mavenagi/1.0.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
260
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
260
261
  contentType: "application/json",
261
262
  requestType: "json",
262
263
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -22,7 +22,8 @@ import * as MavenAGI from "../../../index";
22
22
  * preconditionType: "user",
23
23
  * key: "userKey2"
24
24
  * }]
25
- * }
25
+ * },
26
+ * language: "en"
26
27
  * }
27
28
  */
28
29
  export interface ActionRequest extends MavenAGI.ActionBase {
@@ -105,7 +105,7 @@ class Analytics {
105
105
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
106
106
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, "/v1/tables/conversations"),
107
107
  method: "POST",
108
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.8", "User-Agent": "mavenagi/1.0.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
108
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
109
109
  contentType: "application/json",
110
110
  requestType: "json",
111
111
  body: serializers.ConversationTableRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -228,7 +228,7 @@ class Analytics {
228
228
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
229
229
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, "/v1/charts/conversations"),
230
230
  method: "POST",
231
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.8", "User-Agent": "mavenagi/1.0.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
231
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
232
232
  contentType: "application/json",
233
233
  requestType: "json",
234
234
  body: serializers.ConversationChartRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -321,7 +321,7 @@ class Analytics {
321
321
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
322
322
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, "/v1/tables/feedback"),
323
323
  method: "POST",
324
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.8", "User-Agent": "mavenagi/1.0.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
324
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
325
325
  contentType: "application/json",
326
326
  requestType: "json",
327
327
  body: serializers.FeedbackTableRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -47,5 +47,29 @@ export declare class AppSettings {
47
47
  * await client.appSettings.get()
48
48
  */
49
49
  get(requestOptions?: AppSettings.RequestOptions): Promise<Record<string, unknown>>;
50
+ /**
51
+ * Update app settings. Performs a merge of the provided settings with the existing app settings.
52
+ *
53
+ * - If a new key is provided, it will be added to the app settings.
54
+ * - If an existing key is provided, it will be updated.
55
+ * - No keys will be removed.
56
+ *
57
+ * Note that if an array value is provided it will fully replace an existing value as arrays cannot be merged.
58
+ *
59
+ * @param {Record<string, unknown>} request
60
+ * @param {AppSettings.RequestOptions} requestOptions - Request-specific configuration.
61
+ *
62
+ * @throws {@link MavenAGI.NotFoundError}
63
+ * @throws {@link MavenAGI.BadRequestError}
64
+ * @throws {@link MavenAGI.ServerError}
65
+ *
66
+ * @example
67
+ * await client.appSettings.update({
68
+ * "string": {
69
+ * "key": "value"
70
+ * }
71
+ * })
72
+ */
73
+ update(request: Record<string, unknown>, requestOptions?: AppSettings.RequestOptions): Promise<Record<string, unknown>>;
50
74
  protected _getAuthorizationHeader(): Promise<string | undefined>;
51
75
  }
@@ -77,7 +77,7 @@ class AppSettings {
77
77
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
78
78
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, "v1/app-settings"),
79
79
  method: "GET",
80
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.8", "User-Agent": "mavenagi/1.0.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
80
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
81
81
  contentType: "application/json",
82
82
  requestType: "json",
83
83
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -137,6 +137,96 @@ class AppSettings {
137
137
  }
138
138
  });
139
139
  }
140
+ /**
141
+ * Update app settings. Performs a merge of the provided settings with the existing app settings.
142
+ *
143
+ * - If a new key is provided, it will be added to the app settings.
144
+ * - If an existing key is provided, it will be updated.
145
+ * - No keys will be removed.
146
+ *
147
+ * Note that if an array value is provided it will fully replace an existing value as arrays cannot be merged.
148
+ *
149
+ * @param {Record<string, unknown>} request
150
+ * @param {AppSettings.RequestOptions} requestOptions - Request-specific configuration.
151
+ *
152
+ * @throws {@link MavenAGI.NotFoundError}
153
+ * @throws {@link MavenAGI.BadRequestError}
154
+ * @throws {@link MavenAGI.ServerError}
155
+ *
156
+ * @example
157
+ * await client.appSettings.update({
158
+ * "string": {
159
+ * "key": "value"
160
+ * }
161
+ * })
162
+ */
163
+ update(request, requestOptions) {
164
+ return __awaiter(this, void 0, void 0, function* () {
165
+ var _a, _b, _c;
166
+ const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
167
+ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, "v1/app-settings"),
168
+ method: "PATCH",
169
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
170
+ contentType: "application/json",
171
+ requestType: "json",
172
+ body: serializers.appSettings.update.Request.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
173
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
174
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
175
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
176
+ });
177
+ if (_response.ok) {
178
+ return serializers.appSettings.update.Response.parseOrThrow(_response.body, {
179
+ unrecognizedObjectKeys: "passthrough",
180
+ allowUnrecognizedUnionMembers: true,
181
+ allowUnrecognizedEnumValues: true,
182
+ breadcrumbsPrefix: ["response"],
183
+ });
184
+ }
185
+ if (_response.error.reason === "status-code") {
186
+ switch (_response.error.statusCode) {
187
+ case 404:
188
+ throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
189
+ unrecognizedObjectKeys: "passthrough",
190
+ allowUnrecognizedUnionMembers: true,
191
+ allowUnrecognizedEnumValues: true,
192
+ breadcrumbsPrefix: ["response"],
193
+ }));
194
+ case 400:
195
+ throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
196
+ unrecognizedObjectKeys: "passthrough",
197
+ allowUnrecognizedUnionMembers: true,
198
+ allowUnrecognizedEnumValues: true,
199
+ breadcrumbsPrefix: ["response"],
200
+ }));
201
+ case 500:
202
+ throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
203
+ unrecognizedObjectKeys: "passthrough",
204
+ allowUnrecognizedUnionMembers: true,
205
+ allowUnrecognizedEnumValues: true,
206
+ breadcrumbsPrefix: ["response"],
207
+ }));
208
+ default:
209
+ throw new errors.MavenAGIError({
210
+ statusCode: _response.error.statusCode,
211
+ body: _response.error.body,
212
+ });
213
+ }
214
+ }
215
+ switch (_response.error.reason) {
216
+ case "non-json":
217
+ throw new errors.MavenAGIError({
218
+ statusCode: _response.error.statusCode,
219
+ body: _response.error.rawBody,
220
+ });
221
+ case "timeout":
222
+ throw new errors.MavenAGITimeoutError("Timeout exceeded when calling PATCH /v1/app-settings.");
223
+ case "unknown":
224
+ throw new errors.MavenAGIError({
225
+ message: _response.error.errorMessage,
226
+ });
227
+ }
228
+ });
229
+ }
140
230
  _getAuthorizationHeader() {
141
231
  return __awaiter(this, void 0, void 0, function* () {
142
232
  var _a, _b;
@@ -9,10 +9,12 @@ export interface ActionBase {
9
9
  description: string;
10
10
  /** Whether the action requires user interaction to execute. If false, and all of the required action parameters are known, the LLM may call the action automatically. If true, an conversations ask call will return a BotActionFormResponse which must be submitted by an API caller. API callers must display a button with the buttonName label to confirm the user's intent. */
11
11
  userInteractionRequired: boolean;
12
- /** When user interaction is required, the name of the button that is shown to the end user to confirm execution of the action */
12
+ /** When user interaction is required, the name of the button that is shown to the end user to confirm execution of the action. Defaults to "Submit" if not supplied. */
13
13
  buttonName?: string;
14
14
  /** The preconditions that must be met for an action to be relevant to a conversation. Can be used to restrict actions to certain types of users. */
15
15
  precondition?: MavenAGI.Precondition;
16
16
  /** The parameters that the action uses as input. An action will only be executed when all of the required parameters are provided. During execution, actions all have access to the full Conversation and User objects. Parameter values may be inferred from the user's conversation by the LLM. */
17
17
  userFormParameters: MavenAGI.ActionParameter[];
18
+ /** The ISO 639-1 code for the language used in all fields of this action. Will be derived using the description's text if not specified. */
19
+ language?: string;
18
20
  }
@@ -26,7 +26,8 @@ import * as MavenAGI from "../../../index";
26
26
  * preconditionType: "user",
27
27
  * key: "userKey2"
28
28
  * }]
29
- * }
29
+ * },
30
+ * language: "en"
30
31
  * }
31
32
  */
32
33
  export interface ActionResponse extends MavenAGI.ActionBase {
@@ -2,7 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as MavenAGI from "../../../index";
5
- export interface ConversationBase {
5
+ export interface BaseConversationResponse {
6
6
  /** Optional configurations for responses to this conversation */
7
7
  responseConfig?: MavenAGI.ResponseConfig;
8
8
  /** The subject of the conversation */
@@ -19,4 +19,12 @@ export interface ConversationBase {
19
19
  metadata?: Record<string, string>;
20
20
  /** All metadata for the conversation. Keyed by appId. */
21
21
  allMetadata: Record<string, Record<string, string>>;
22
+ /** The ID that uniquely identifies this conversation */
23
+ conversationId: MavenAGI.EntityId;
24
+ /** An analysis of the conversation. Fields are generated by Maven via an analysis of user messages. This object is calculated on a delay. Fields will not be up to date on ask requests. */
25
+ analysis: MavenAGI.ConversationAnalysis;
26
+ /** A summary of the conversation. Fields are calculated from conversation data. Unlike analysis, all fields can be derived from other data available in the API. This object is provided as a convenience and is calculated on a delay. Fields will not be up to date on ask requests. */
27
+ summary: MavenAGI.ConversationSummary;
28
+ /** Whether the conversation user-specific data has been deleted. See `deleteConversation` for details. */
29
+ deleted: boolean;
22
30
  }
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface BasePaginatedRequest {
5
+ /** Page number to return, defaults to 0 */
6
+ page?: number;
7
+ /** The size of the page to return, defaults to 20 */
8
+ size?: number;
9
+ /** Whether to sort descending, defaults to true */
10
+ sortDesc?: boolean;
11
+ }
@@ -8,4 +8,5 @@ export interface BotMessage extends MavenAGI.ConversationMessageBase {
8
8
  botMessageType: MavenAGI.BotConversationMessageType;
9
9
  responses: MavenAGI.BotResponse[];
10
10
  metadata: MavenAGI.BotResponseMetadata;
11
+ status: MavenAGI.BotMessageStatus;
11
12
  }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * The delivery status of the bot message.
6
+ *
7
+ * * `SENDING`: The message is being streamed to the user.
8
+ * * `SENT`: The message has been sent to the user.
9
+ * * `REJECTED`: The message was rejected by the system.
10
+ * * `CANCELED`: The message was canceled by the user before streaming was complete.
11
+ * * `FAILED`: The message generating or sending encountered an error.
12
+ * * `UNKNOWN`: The message status is unknown.
13
+ */
14
+ export type BotMessageStatus = "SENDING" | "SENT" | "REJECTED" | "CANCELED" | "FAILED" | "UNKNOWN";
15
+ export declare const BotMessageStatus: {
16
+ readonly Sending: "SENDING";
17
+ readonly Sent: "SENT";
18
+ readonly Rejected: "REJECTED";
19
+ readonly Canceled: "CANCELED";
20
+ readonly Failed: "FAILED";
21
+ readonly Unknown: "UNKNOWN";
22
+ };
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.BotMessageStatus = void 0;
7
+ exports.BotMessageStatus = {
8
+ Sending: "SENDING",
9
+ Sent: "SENT",
10
+ Rejected: "REJECTED",
11
+ Canceled: "CANCELED",
12
+ Failed: "FAILED",
13
+ Unknown: "UNKNOWN",
14
+ };
@@ -13,4 +13,12 @@ export interface ConversationAnalysis {
13
13
  category?: string;
14
14
  /** Generated sentiment of the conversation */
15
15
  sentiment?: MavenAGI.Sentiment;
16
+ /** Generated quality of the conversation */
17
+ quality?: MavenAGI.Quality;
18
+ /** If the quality of the conversation is `UNKNOWN` or `NEEDS_IMPROVEMENT` then a reason for the quality will be provided when possible. */
19
+ qualityReason?: MavenAGI.QualityReason;
20
+ /** Whether the conversation was resolved by Maven */
21
+ resolvedByMaven?: boolean;
22
+ /** Primary language of the conversation in ISO 639-1 code format */
23
+ primaryLanguage?: string;
16
24
  }
@@ -0,0 +1,6 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as MavenAGI from "../../../index";
5
+ export interface ConversationPreview extends MavenAGI.BaseConversationResponse {
6
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -15,7 +15,8 @@ import * as MavenAGI from "../../../index";
15
15
  * deleted: false,
16
16
  * analysis: {
17
17
  * resolutionStatus: "Resolved",
18
- * sentiment: MavenAGI.Sentiment.Positive
18
+ * sentiment: MavenAGI.Sentiment.Positive,
19
+ * resolvedByMaven: true
19
20
  * },
20
21
  * summary: {
21
22
  * actionIds: [],
@@ -50,6 +51,7 @@ import * as MavenAGI from "../../../index";
50
51
  * agentId: "support",
51
52
  * type: MavenAGI.EntityType.ConversationMessage
52
53
  * },
54
+ * status: MavenAGI.BotMessageStatus.Sent,
53
55
  * responses: [{
54
56
  * type: "text",
55
57
  * text: "Hi! Go to acme.com/reset-password"
@@ -61,15 +63,7 @@ import * as MavenAGI from "../../../index";
61
63
  * }]
62
64
  * }
63
65
  */
64
- export interface ConversationResponse extends MavenAGI.ConversationBase {
65
- /** The ID that uniquely identifies this conversation */
66
- conversationId: MavenAGI.EntityId;
66
+ export interface ConversationResponse extends MavenAGI.BaseConversationResponse {
67
67
  /** The messages in the conversation */
68
68
  messages: MavenAGI.ConversationMessageResponse[];
69
- /** An analysis of the conversation. Fields are generated by Maven via an analysis of user messages. This object is calculated on a delay. Fields will not be up to date on ask requests. */
70
- analysis: MavenAGI.ConversationAnalysis;
71
- /** A summary of the conversation. Fields are calculated from conversation data. Unlike analysis, all fields can be derived from other data available in the API. This object is provided as a convenience and is calculated on a delay. Fields will not be up to date on ask requests. */
72
- summary: MavenAGI.ConversationSummary;
73
- /** Whether the conversation user-specific data has been deleted. See `deleteConversation` for details. */
74
- deleted: boolean;
75
69
  }
@@ -1,14 +1,13 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export type QualityReason = "MISSING_KNOWLEDGE" | "MISSING_USER_INFORMATION" | "MISSING_ACTION" | "NEEDS_USER_CLARIFICATION" | "UNSUPPORTED_FORMAT" | "GREAT_ANSWER" | "INTERRUPTED" | "UNSUPPORTED_USER_BEHAVIOR" | "UNKNOWN";
4
+ export type QualityReason = "MISSING_KNOWLEDGE" | "MISSING_USER_INFORMATION" | "MISSING_ACTION" | "NEEDS_USER_CLARIFICATION" | "UNSUPPORTED_FORMAT" | "INTERRUPTED" | "UNSUPPORTED_USER_BEHAVIOR" | "UNKNOWN";
5
5
  export declare const QualityReason: {
6
6
  readonly MissingKnowledge: "MISSING_KNOWLEDGE";
7
7
  readonly MissingUserInformation: "MISSING_USER_INFORMATION";
8
8
  readonly MissingAction: "MISSING_ACTION";
9
9
  readonly NeedsUserClarification: "NEEDS_USER_CLARIFICATION";
10
10
  readonly UnsupportedFormat: "UNSUPPORTED_FORMAT";
11
- readonly GreatAnswer: "GREAT_ANSWER";
12
11
  readonly Interrupted: "INTERRUPTED";
13
12
  readonly UnsupportedUserBehavior: "UNSUPPORTED_USER_BEHAVIOR";
14
13
  readonly Unknown: "UNKNOWN";
@@ -10,7 +10,6 @@ exports.QualityReason = {
10
10
  MissingAction: "MISSING_ACTION",
11
11
  NeedsUserClarification: "NEEDS_USER_CLARIFICATION",
12
12
  UnsupportedFormat: "UNSUPPORTED_FORMAT",
13
- GreatAnswer: "GREAT_ANSWER",
14
13
  Interrupted: "INTERRUPTED",
15
14
  UnsupportedUserBehavior: "UNSUPPORTED_USER_BEHAVIOR",
16
15
  Unknown: "UNKNOWN",
@@ -2,10 +2,10 @@ export * from "./ErrorMessage";
2
2
  export * from "./EntityType";
3
3
  export * from "./EntityIdBase";
4
4
  export * from "./EntityIdWithoutAgent";
5
- export * from "./EntityIdFilter";
6
5
  export * from "./EntityId";
7
- export * from "./FeedbackBase";
6
+ export * from "./EntityIdFilter";
8
7
  export * from "./FeedbackType";
8
+ export * from "./FeedbackBase";
9
9
  export * from "./Feedback";
10
10
  export * from "./AppUserIdentifier";
11
11
  export * from "./AppUserIdentifyingPropertyType";
@@ -18,17 +18,21 @@ export * from "./EventTriggerBase";
18
18
  export * from "./EventTriggerResponse";
19
19
  export * from "./EventTriggerType";
20
20
  export * from "./Page";
21
+ export * from "./BasePaginatedRequest";
21
22
  export * from "./ActionParameterType";
22
23
  export * from "./ActionEnumOption";
23
24
  export * from "./Sentiment";
25
+ export * from "./Quality";
26
+ export * from "./QualityReason";
24
27
  export * from "./ConversationSummary";
25
28
  export * from "./ConversationAnalysis";
26
29
  export * from "./ConversationInformation";
27
30
  export * from "./ResponseLength";
28
31
  export * from "./Capability";
29
32
  export * from "./ResponseConfig";
30
- export * from "./ConversationBase";
31
33
  export * from "./ConversationResponse";
34
+ export * from "./ConversationPreview";
35
+ export * from "./BaseConversationResponse";
32
36
  export * from "./ConversationMessageResponse";
33
37
  export * from "./ConversationMessageBase";
34
38
  export * from "./UserConversationMessageType";
@@ -36,6 +40,7 @@ export * from "./UserMessageBase";
36
40
  export * from "./UserMessageAttachment";
37
41
  export * from "./UserMessage";
38
42
  export * from "./BotConversationMessageType";
43
+ export * from "./BotMessageStatus";
39
44
  export * from "./BotMessage";
40
45
  export * from "./Source";
41
46
  export * from "./BotResponseMetadata";
@@ -18,10 +18,10 @@ __exportStar(require("./ErrorMessage"), exports);
18
18
  __exportStar(require("./EntityType"), exports);
19
19
  __exportStar(require("./EntityIdBase"), exports);
20
20
  __exportStar(require("./EntityIdWithoutAgent"), exports);
21
- __exportStar(require("./EntityIdFilter"), exports);
22
21
  __exportStar(require("./EntityId"), exports);
23
- __exportStar(require("./FeedbackBase"), exports);
22
+ __exportStar(require("./EntityIdFilter"), exports);
24
23
  __exportStar(require("./FeedbackType"), exports);
24
+ __exportStar(require("./FeedbackBase"), exports);
25
25
  __exportStar(require("./Feedback"), exports);
26
26
  __exportStar(require("./AppUserIdentifier"), exports);
27
27
  __exportStar(require("./AppUserIdentifyingPropertyType"), exports);
@@ -34,17 +34,21 @@ __exportStar(require("./EventTriggerBase"), exports);
34
34
  __exportStar(require("./EventTriggerResponse"), exports);
35
35
  __exportStar(require("./EventTriggerType"), exports);
36
36
  __exportStar(require("./Page"), exports);
37
+ __exportStar(require("./BasePaginatedRequest"), exports);
37
38
  __exportStar(require("./ActionParameterType"), exports);
38
39
  __exportStar(require("./ActionEnumOption"), exports);
39
40
  __exportStar(require("./Sentiment"), exports);
41
+ __exportStar(require("./Quality"), exports);
42
+ __exportStar(require("./QualityReason"), exports);
40
43
  __exportStar(require("./ConversationSummary"), exports);
41
44
  __exportStar(require("./ConversationAnalysis"), exports);
42
45
  __exportStar(require("./ConversationInformation"), exports);
43
46
  __exportStar(require("./ResponseLength"), exports);
44
47
  __exportStar(require("./Capability"), exports);
45
48
  __exportStar(require("./ResponseConfig"), exports);
46
- __exportStar(require("./ConversationBase"), exports);
47
49
  __exportStar(require("./ConversationResponse"), exports);
50
+ __exportStar(require("./ConversationPreview"), exports);
51
+ __exportStar(require("./BaseConversationResponse"), exports);
48
52
  __exportStar(require("./ConversationMessageResponse"), exports);
49
53
  __exportStar(require("./ConversationMessageBase"), exports);
50
54
  __exportStar(require("./UserConversationMessageType"), exports);
@@ -52,6 +56,7 @@ __exportStar(require("./UserMessageBase"), exports);
52
56
  __exportStar(require("./UserMessageAttachment"), exports);
53
57
  __exportStar(require("./UserMessage"), exports);
54
58
  __exportStar(require("./BotConversationMessageType"), exports);
59
+ __exportStar(require("./BotMessageStatus"), exports);
55
60
  __exportStar(require("./BotMessage"), exports);
56
61
  __exportStar(require("./Source"), exports);
57
62
  __exportStar(require("./BotResponseMetadata"), exports);