mavenagi 0.0.0-alpha.2 → 0.0.0-alpha.20

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 (779) hide show
  1. package/Client.d.ts +21 -0
  2. package/Client.js +20 -0
  3. package/README.md +70 -16
  4. package/api/resources/actions/client/Client.d.ts +96 -0
  5. package/api/resources/actions/client/Client.js +316 -0
  6. package/api/resources/actions/client/index.d.ts +1 -0
  7. package/api/resources/actions/client/index.js +1 -0
  8. package/api/resources/actions/index.d.ts +2 -0
  9. package/api/resources/actions/index.js +2 -0
  10. package/api/resources/actions/types/ActionBase.d.ts +18 -0
  11. package/api/resources/actions/types/ActionParameter.d.ts +9 -0
  12. package/api/resources/actions/types/ActionRequest.d.ts +31 -0
  13. package/api/resources/actions/types/ActionResponse.d.ts +35 -0
  14. package/api/resources/actions/types/ConversationExecutedActionPrecondition.d.ts +12 -0
  15. package/api/resources/actions/types/ConversationPrecondition.d.ts +20 -0
  16. package/api/resources/actions/types/MetadataPrecondition.d.ts +12 -0
  17. package/api/resources/actions/types/Precondition.d.ts +31 -0
  18. package/api/resources/actions/types/PreconditionGroup.d.ts +8 -0
  19. package/api/resources/actions/types/PreconditionGroupOperator.d.ts +8 -0
  20. package/api/resources/actions/types/PreconditionGroupOperator.js +7 -0
  21. package/api/resources/actions/types/PreconditionOperator.d.ts +7 -0
  22. package/api/resources/{knowledge/types/IdBody.d.ts → actions/types/PreconditionOperator.js} +3 -3
  23. package/api/resources/actions/types/index.d.ts +11 -0
  24. package/api/resources/actions/types/index.js +11 -0
  25. package/api/resources/appSettings/client/Client.d.ts +47 -0
  26. package/api/resources/appSettings/client/Client.js +124 -0
  27. package/api/resources/appSettings/client/index.d.ts +1 -0
  28. package/api/resources/appSettings/client/index.js +1 -0
  29. package/api/resources/appSettings/index.d.ts +1 -0
  30. package/api/resources/appSettings/index.js +1 -0
  31. package/api/resources/commons/errors/{AgentNotFoundError.d.ts → BadRequestError.d.ts} +1 -1
  32. package/api/resources/{conversation/errors/EmptyConversationError.js → commons/errors/BadRequestError.js} +3 -3
  33. package/{dist/api/resources/commons/errors/AgentNotFoundError.d.ts → api/resources/commons/errors/NotFoundError.d.ts} +1 -1
  34. package/{dist/api/resources/commons/errors/AgentNotFoundError.js → api/resources/commons/errors/NotFoundError.js} +3 -3
  35. package/api/resources/{conversation/errors/EmptyConversationError.d.ts → commons/errors/ServerError.d.ts} +1 -1
  36. package/api/resources/commons/errors/ServerError.js +14 -0
  37. package/api/resources/commons/errors/index.d.ts +3 -1
  38. package/api/resources/commons/errors/index.js +3 -1
  39. package/api/resources/commons/types/AppUser.d.ts +9 -0
  40. package/api/resources/commons/types/AppUserIdentifier.d.ts +9 -0
  41. package/api/resources/commons/types/AppUserIdentifyingPropertyType.d.ts +8 -0
  42. package/api/resources/commons/types/AppUserIdentifyingPropertyType.js +7 -0
  43. package/api/resources/commons/types/AppUserRequest.d.ts +26 -0
  44. package/api/resources/commons/types/AppUserResponse.d.ts +42 -0
  45. package/api/resources/commons/types/EntityId.d.ts +14 -0
  46. package/api/resources/commons/types/EntityIdBase.d.ts +10 -0
  47. package/api/resources/commons/types/EntityType.d.ts +16 -0
  48. package/api/resources/commons/types/EntityType.js +15 -0
  49. package/api/resources/commons/types/EventTriggerBase.d.ts +10 -0
  50. package/api/resources/commons/types/EventTriggerResponse.d.ts +22 -0
  51. package/api/resources/commons/types/EventTriggerResponse.js +4 -0
  52. package/api/resources/commons/types/EventTriggerType.d.ts +8 -0
  53. package/api/resources/commons/types/EventTriggerType.js +7 -0
  54. package/api/resources/commons/types/Feedback.d.ts +12 -0
  55. package/api/resources/commons/types/Feedback.js +4 -0
  56. package/api/resources/commons/types/FeedbackBase.d.ts +10 -0
  57. package/api/resources/commons/types/FeedbackBase.js +4 -0
  58. package/api/resources/{conversation → commons}/types/FeedbackType.d.ts +3 -1
  59. package/{dist/api/resources/conversation → api/resources/commons}/types/FeedbackType.js +2 -0
  60. package/api/resources/commons/types/UserData.d.ts +10 -0
  61. package/api/resources/commons/types/UserData.js +4 -0
  62. package/api/resources/commons/types/VisibilityType.d.ts +9 -0
  63. package/api/resources/commons/types/VisibilityType.js +8 -0
  64. package/api/resources/commons/types/index.d.ts +16 -1
  65. package/api/resources/commons/types/index.js +16 -1
  66. package/api/resources/conversation/client/Client.d.ts +136 -42
  67. package/api/resources/conversation/client/Client.js +451 -130
  68. package/api/resources/conversation/index.d.ts +0 -1
  69. package/api/resources/conversation/index.js +0 -1
  70. package/api/resources/conversation/types/ActionFormField.d.ts +1 -0
  71. package/api/resources/conversation/types/AskRequest.d.ts +15 -3
  72. package/api/resources/conversation/types/AskStreamActionEvent.d.ts +6 -0
  73. package/api/resources/conversation/types/AskStreamActionEvent.js +4 -0
  74. package/api/resources/conversation/types/AskStreamStartEvent.d.ts +2 -1
  75. package/api/resources/conversation/types/AskStreamTextEvent.d.ts +1 -0
  76. package/api/resources/conversation/types/BotActionFormResponse.d.ts +1 -0
  77. package/api/resources/conversation/types/BotMessage.d.ts +2 -0
  78. package/api/resources/conversation/types/Capability.d.ts +18 -0
  79. package/api/resources/conversation/types/Capability.js +8 -0
  80. package/{dist/api/resources/knowledge/types/IdBody.d.ts → api/resources/conversation/types/CategorizationResponse.d.ts} +2 -2
  81. package/api/resources/conversation/types/CategorizationResponse.js +4 -0
  82. package/api/resources/conversation/types/ConversationAnalysis.d.ts +12 -0
  83. package/api/resources/conversation/types/ConversationAnalysis.js +4 -0
  84. package/api/resources/conversation/types/ConversationBase.d.ts +14 -4
  85. package/api/resources/conversation/types/ConversationMessageBase.d.ts +4 -5
  86. package/api/resources/conversation/types/ConversationMessageRequest.d.ts +3 -1
  87. package/api/resources/conversation/types/ConversationRequest.d.ts +2 -0
  88. package/api/resources/conversation/types/ConversationResponse.d.ts +4 -0
  89. package/api/resources/conversation/types/FeedbackRequest.d.ts +7 -7
  90. package/api/resources/conversation/types/GenerateMavenSuggestionsRequest.d.ts +2 -1
  91. package/api/resources/conversation/types/ResponseConfig.d.ts +12 -0
  92. package/api/resources/conversation/types/ResponseConfig.js +4 -0
  93. package/api/resources/conversation/types/ResponseLength.d.ts +9 -0
  94. package/api/resources/conversation/types/ResponseLength.js +8 -0
  95. package/api/resources/conversation/types/Sentiment.d.ts +14 -0
  96. package/api/resources/conversation/types/Sentiment.js +10 -0
  97. package/api/resources/conversation/types/StreamResponse.d.ts +4 -1
  98. package/api/resources/conversation/types/SubmitActionFormRequest.d.ts +8 -0
  99. package/api/resources/conversation/types/SubmitActionFormRequest.js +4 -0
  100. package/api/resources/conversation/types/UserMessage.d.ts +3 -3
  101. package/api/resources/conversation/types/UserMessageBase.d.ts +11 -0
  102. package/api/resources/conversation/types/UserMessageBase.js +4 -0
  103. package/api/resources/conversation/types/index.d.ts +9 -3
  104. package/api/resources/conversation/types/index.js +9 -3
  105. package/api/resources/index.d.ts +6 -2
  106. package/api/resources/index.js +6 -2
  107. package/api/resources/knowledge/client/Client.d.ts +85 -73
  108. package/api/resources/knowledge/client/Client.js +233 -175
  109. package/api/resources/knowledge/index.d.ts +0 -1
  110. package/api/resources/knowledge/index.js +0 -1
  111. package/{dist/api/resources/knowledge/types/KnowledgeDocument.d.ts → api/resources/knowledge/types/BaseKnowledgeDocument.d.ts} +2 -5
  112. package/api/resources/knowledge/types/BaseKnowledgeDocument.js +4 -0
  113. package/api/resources/knowledge/types/{KnowledgeBase.d.ts → KnowledgeBaseProperties.d.ts} +3 -3
  114. package/api/resources/knowledge/types/KnowledgeBaseProperties.js +4 -0
  115. package/api/resources/knowledge/types/KnowledgeBaseRequest.d.ts +18 -0
  116. package/api/resources/knowledge/types/KnowledgeBaseRequest.js +4 -0
  117. package/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +22 -0
  118. package/api/resources/knowledge/types/KnowledgeBaseResponse.js +4 -0
  119. package/api/resources/knowledge/types/KnowledgeBaseType.d.ts +1 -1
  120. package/api/resources/knowledge/types/KnowledgeBaseVersion.d.ts +7 -3
  121. package/api/resources/knowledge/types/KnowledgeDocumentContentType.d.ts +11 -0
  122. package/api/resources/knowledge/types/KnowledgeDocumentContentType.js +7 -0
  123. package/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +22 -0
  124. package/api/resources/knowledge/types/KnowledgeDocumentRequest.js +4 -0
  125. package/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +24 -0
  126. package/api/resources/knowledge/types/KnowledgeDocumentResponse.js +4 -0
  127. package/api/resources/knowledge/types/index.d.ts +7 -5
  128. package/api/resources/knowledge/types/index.js +7 -5
  129. package/api/resources/triggers/client/Client.d.ts +83 -0
  130. package/api/resources/triggers/client/Client.js +303 -0
  131. package/api/resources/triggers/client/index.d.ts +1 -0
  132. package/api/resources/triggers/client/index.js +1 -0
  133. package/api/resources/triggers/index.d.ts +2 -0
  134. package/api/resources/triggers/index.js +2 -0
  135. package/api/resources/triggers/types/EventTriggerRequest.d.ts +18 -0
  136. package/api/resources/triggers/types/EventTriggerRequest.js +4 -0
  137. package/api/resources/triggers/types/index.d.ts +1 -0
  138. package/api/resources/triggers/types/index.js +1 -0
  139. package/api/resources/users/client/Client.d.ts +77 -0
  140. package/api/resources/users/client/Client.js +228 -0
  141. package/api/resources/users/client/index.d.ts +1 -0
  142. package/api/resources/users/client/index.js +1 -0
  143. package/api/resources/users/index.d.ts +1 -0
  144. package/api/resources/users/index.js +1 -0
  145. package/core/fetcher/Fetcher.d.ts +4 -1
  146. package/core/fetcher/Fetcher.js +18 -159
  147. package/core/fetcher/createRequestUrl.d.ts +1 -0
  148. package/core/fetcher/createRequestUrl.js +6 -0
  149. package/core/fetcher/getFetchFn.d.ts +4 -0
  150. package/core/fetcher/getFetchFn.js +32 -0
  151. package/core/fetcher/getRequestBody.d.ts +7 -0
  152. package/core/fetcher/getRequestBody.js +19 -0
  153. package/core/fetcher/getResponseBody.d.ts +1 -0
  154. package/core/fetcher/getResponseBody.js +48 -0
  155. package/core/fetcher/makeRequest.d.ts +1 -0
  156. package/core/fetcher/makeRequest.js +38 -0
  157. package/core/fetcher/requestWithRetries.d.ts +1 -0
  158. package/core/fetcher/requestWithRetries.js +28 -0
  159. package/core/fetcher/signals.d.ts +12 -0
  160. package/core/fetcher/signals.js +32 -0
  161. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
  162. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +222 -0
  163. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +21 -0
  164. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +104 -0
  165. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +30 -0
  166. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +204 -0
  167. package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +17 -0
  168. package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +23 -0
  169. package/core/index.d.ts +1 -1
  170. package/core/index.js +1 -1
  171. package/core/runtime/runtime.d.ts +1 -0
  172. package/core/runtime/runtime.js +1 -0
  173. package/core/schemas/Schema.d.ts +7 -4
  174. package/core/schemas/builders/lazy/lazy.d.ts +2 -2
  175. package/core/schemas/builders/lazy/lazy.js +8 -19
  176. package/core/schemas/builders/lazy/lazyObject.js +1 -10
  177. package/core/schemas/builders/list/list.js +31 -44
  178. package/core/schemas/builders/object/object.js +90 -111
  179. package/core/schemas/builders/object/types.d.ts +2 -2
  180. package/core/schemas/builders/object-like/getObjectLikeUtils.js +3 -12
  181. package/core/schemas/builders/record/record.js +49 -60
  182. package/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +2 -2
  183. package/core/schemas/builders/schema-utils/getSchemaUtils.js +18 -21
  184. package/core/schemas/builders/set/set.js +6 -15
  185. package/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +21 -32
  186. package/core/schemas/builders/union/union.js +51 -62
  187. package/core/schemas/utils/maybeSkipValidation.js +3 -12
  188. package/dist/Client.d.ts +21 -0
  189. package/dist/Client.js +20 -0
  190. package/dist/api/resources/actions/client/Client.d.ts +96 -0
  191. package/dist/api/resources/actions/client/Client.js +316 -0
  192. package/dist/api/resources/actions/client/index.d.ts +1 -0
  193. package/dist/api/resources/actions/client/index.js +1 -0
  194. package/dist/api/resources/actions/index.d.ts +2 -0
  195. package/dist/api/resources/actions/index.js +2 -0
  196. package/dist/api/resources/actions/types/ActionBase.d.ts +18 -0
  197. package/dist/api/resources/actions/types/ActionBase.js +4 -0
  198. package/dist/api/resources/actions/types/ActionParameter.d.ts +9 -0
  199. package/dist/api/resources/actions/types/ActionParameter.js +4 -0
  200. package/dist/api/resources/actions/types/ActionRequest.d.ts +31 -0
  201. package/dist/api/resources/actions/types/ActionRequest.js +4 -0
  202. package/dist/api/resources/actions/types/ActionResponse.d.ts +35 -0
  203. package/dist/api/resources/actions/types/ActionResponse.js +4 -0
  204. package/dist/api/resources/actions/types/ConversationExecutedActionPrecondition.d.ts +12 -0
  205. package/dist/api/resources/actions/types/ConversationExecutedActionPrecondition.js +4 -0
  206. package/dist/api/resources/actions/types/ConversationPrecondition.d.ts +20 -0
  207. package/dist/api/resources/actions/types/ConversationPrecondition.js +4 -0
  208. package/dist/api/resources/actions/types/MetadataPrecondition.d.ts +12 -0
  209. package/dist/api/resources/actions/types/MetadataPrecondition.js +4 -0
  210. package/dist/api/resources/actions/types/Precondition.d.ts +31 -0
  211. package/dist/api/resources/actions/types/Precondition.js +4 -0
  212. package/dist/api/resources/actions/types/PreconditionGroup.d.ts +8 -0
  213. package/dist/api/resources/actions/types/PreconditionGroup.js +4 -0
  214. package/dist/api/resources/actions/types/PreconditionGroupOperator.d.ts +8 -0
  215. package/dist/api/resources/actions/types/PreconditionGroupOperator.js +7 -0
  216. package/dist/api/resources/actions/types/PreconditionOperator.d.ts +7 -0
  217. package/dist/api/resources/actions/types/PreconditionOperator.js +6 -0
  218. package/dist/api/resources/actions/types/index.d.ts +11 -0
  219. package/dist/api/resources/actions/types/index.js +11 -0
  220. package/dist/api/resources/appSettings/client/Client.d.ts +47 -0
  221. package/dist/api/resources/appSettings/client/Client.js +124 -0
  222. package/dist/api/resources/appSettings/client/index.d.ts +1 -0
  223. package/dist/api/resources/appSettings/client/index.js +1 -0
  224. package/dist/api/resources/appSettings/index.d.ts +1 -0
  225. package/dist/api/resources/appSettings/index.js +1 -0
  226. package/dist/api/resources/{conversation/errors/EmptyConversationError.d.ts → commons/errors/BadRequestError.d.ts} +1 -1
  227. package/dist/api/resources/{knowledge/errors/VersionInProgressError.js → commons/errors/BadRequestError.js} +3 -3
  228. package/dist/api/resources/commons/errors/NotFoundError.d.ts +8 -0
  229. package/{api/resources/commons/errors/AgentNotFoundError.js → dist/api/resources/commons/errors/NotFoundError.js} +3 -3
  230. package/dist/api/resources/commons/errors/ServerError.d.ts +8 -0
  231. package/dist/api/resources/commons/errors/ServerError.js +14 -0
  232. package/dist/api/resources/commons/errors/index.d.ts +3 -1
  233. package/dist/api/resources/commons/errors/index.js +3 -1
  234. package/dist/api/resources/commons/types/AppUser.d.ts +9 -0
  235. package/dist/api/resources/commons/types/AppUser.js +4 -0
  236. package/dist/api/resources/commons/types/AppUserIdentifier.d.ts +9 -0
  237. package/dist/api/resources/commons/types/AppUserIdentifier.js +4 -0
  238. package/dist/api/resources/commons/types/AppUserIdentifyingPropertyType.d.ts +8 -0
  239. package/dist/api/resources/commons/types/AppUserIdentifyingPropertyType.js +7 -0
  240. package/dist/api/resources/commons/types/AppUserRequest.d.ts +26 -0
  241. package/dist/api/resources/commons/types/AppUserRequest.js +4 -0
  242. package/dist/api/resources/commons/types/AppUserResponse.d.ts +42 -0
  243. package/dist/api/resources/commons/types/AppUserResponse.js +4 -0
  244. package/dist/api/resources/commons/types/EntityId.d.ts +14 -0
  245. package/dist/api/resources/commons/types/EntityId.js +4 -0
  246. package/dist/api/resources/commons/types/EntityIdBase.d.ts +10 -0
  247. package/dist/api/resources/commons/types/EntityIdBase.js +4 -0
  248. package/dist/api/resources/commons/types/EntityType.d.ts +16 -0
  249. package/dist/api/resources/commons/types/EntityType.js +15 -0
  250. package/dist/api/resources/commons/types/EventTriggerBase.d.ts +10 -0
  251. package/dist/api/resources/commons/types/EventTriggerBase.js +4 -0
  252. package/dist/api/resources/commons/types/EventTriggerResponse.d.ts +22 -0
  253. package/dist/api/resources/commons/types/EventTriggerResponse.js +4 -0
  254. package/dist/api/resources/commons/types/EventTriggerType.d.ts +8 -0
  255. package/dist/api/resources/commons/types/EventTriggerType.js +7 -0
  256. package/dist/api/resources/commons/types/Feedback.d.ts +12 -0
  257. package/dist/api/resources/commons/types/Feedback.js +4 -0
  258. package/dist/api/resources/commons/types/FeedbackBase.d.ts +10 -0
  259. package/dist/api/resources/commons/types/FeedbackBase.js +4 -0
  260. package/dist/api/resources/{conversation → commons}/types/FeedbackType.d.ts +3 -1
  261. package/{api/resources/conversation → dist/api/resources/commons}/types/FeedbackType.js +2 -0
  262. package/dist/api/resources/commons/types/UserData.d.ts +10 -0
  263. package/dist/api/resources/commons/types/UserData.js +4 -0
  264. package/dist/api/resources/commons/types/VisibilityType.d.ts +9 -0
  265. package/dist/api/resources/commons/types/VisibilityType.js +8 -0
  266. package/dist/api/resources/commons/types/index.d.ts +16 -1
  267. package/dist/api/resources/commons/types/index.js +16 -1
  268. package/dist/api/resources/conversation/client/Client.d.ts +136 -42
  269. package/dist/api/resources/conversation/client/Client.js +451 -130
  270. package/dist/api/resources/conversation/index.d.ts +0 -1
  271. package/dist/api/resources/conversation/index.js +0 -1
  272. package/dist/api/resources/conversation/types/ActionFormField.d.ts +1 -0
  273. package/dist/api/resources/conversation/types/AskRequest.d.ts +15 -3
  274. package/dist/api/resources/conversation/types/AskStreamActionEvent.d.ts +6 -0
  275. package/dist/api/resources/conversation/types/AskStreamActionEvent.js +4 -0
  276. package/dist/api/resources/conversation/types/AskStreamStartEvent.d.ts +2 -1
  277. package/dist/api/resources/conversation/types/AskStreamTextEvent.d.ts +1 -0
  278. package/dist/api/resources/conversation/types/BotActionFormResponse.d.ts +1 -0
  279. package/dist/api/resources/conversation/types/BotMessage.d.ts +2 -0
  280. package/dist/api/resources/conversation/types/Capability.d.ts +18 -0
  281. package/dist/api/resources/conversation/types/Capability.js +8 -0
  282. package/dist/api/resources/conversation/types/CategorizationResponse.d.ts +6 -0
  283. package/dist/api/resources/conversation/types/CategorizationResponse.js +4 -0
  284. package/dist/api/resources/conversation/types/ConversationAnalysis.d.ts +12 -0
  285. package/dist/api/resources/conversation/types/ConversationAnalysis.js +4 -0
  286. package/dist/api/resources/conversation/types/ConversationBase.d.ts +14 -4
  287. package/dist/api/resources/conversation/types/ConversationMessageBase.d.ts +4 -5
  288. package/dist/api/resources/conversation/types/ConversationMessageRequest.d.ts +3 -1
  289. package/dist/api/resources/conversation/types/ConversationRequest.d.ts +2 -0
  290. package/dist/api/resources/conversation/types/ConversationResponse.d.ts +4 -0
  291. package/dist/api/resources/conversation/types/FeedbackRequest.d.ts +7 -7
  292. package/dist/api/resources/conversation/types/GenerateMavenSuggestionsRequest.d.ts +2 -1
  293. package/dist/api/resources/conversation/types/ResponseConfig.d.ts +12 -0
  294. package/dist/api/resources/conversation/types/ResponseConfig.js +4 -0
  295. package/dist/api/resources/conversation/types/ResponseLength.d.ts +9 -0
  296. package/dist/api/resources/conversation/types/ResponseLength.js +8 -0
  297. package/dist/api/resources/conversation/types/Sentiment.d.ts +14 -0
  298. package/dist/api/resources/conversation/types/Sentiment.js +10 -0
  299. package/dist/api/resources/conversation/types/StreamResponse.d.ts +4 -1
  300. package/dist/api/resources/conversation/types/SubmitActionFormRequest.d.ts +8 -0
  301. package/dist/api/resources/conversation/types/SubmitActionFormRequest.js +4 -0
  302. package/dist/api/resources/conversation/types/UserMessage.d.ts +3 -3
  303. package/dist/api/resources/conversation/types/UserMessageBase.d.ts +11 -0
  304. package/dist/api/resources/conversation/types/UserMessageBase.js +4 -0
  305. package/dist/api/resources/conversation/types/index.d.ts +9 -3
  306. package/dist/api/resources/conversation/types/index.js +9 -3
  307. package/dist/api/resources/index.d.ts +6 -2
  308. package/dist/api/resources/index.js +6 -2
  309. package/dist/api/resources/knowledge/client/Client.d.ts +85 -73
  310. package/dist/api/resources/knowledge/client/Client.js +233 -175
  311. package/dist/api/resources/knowledge/index.d.ts +0 -1
  312. package/dist/api/resources/knowledge/index.js +0 -1
  313. package/{api/resources/knowledge/types/KnowledgeDocument.d.ts → dist/api/resources/knowledge/types/BaseKnowledgeDocument.d.ts} +2 -5
  314. package/dist/api/resources/knowledge/types/BaseKnowledgeDocument.js +4 -0
  315. package/dist/api/resources/knowledge/types/{KnowledgeBase.d.ts → KnowledgeBaseProperties.d.ts} +3 -3
  316. package/dist/api/resources/knowledge/types/KnowledgeBaseProperties.js +4 -0
  317. package/dist/api/resources/knowledge/types/KnowledgeBaseRequest.d.ts +18 -0
  318. package/dist/api/resources/knowledge/types/KnowledgeBaseRequest.js +4 -0
  319. package/dist/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +22 -0
  320. package/dist/api/resources/knowledge/types/KnowledgeBaseResponse.js +4 -0
  321. package/dist/api/resources/knowledge/types/KnowledgeBaseType.d.ts +1 -1
  322. package/dist/api/resources/knowledge/types/KnowledgeBaseVersion.d.ts +7 -3
  323. package/dist/api/resources/knowledge/types/KnowledgeDocumentContentType.d.ts +11 -0
  324. package/dist/api/resources/knowledge/types/KnowledgeDocumentContentType.js +7 -0
  325. package/dist/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +22 -0
  326. package/dist/api/resources/knowledge/types/KnowledgeDocumentRequest.js +4 -0
  327. package/dist/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +24 -0
  328. package/dist/api/resources/knowledge/types/KnowledgeDocumentResponse.js +4 -0
  329. package/dist/api/resources/knowledge/types/index.d.ts +7 -5
  330. package/dist/api/resources/knowledge/types/index.js +7 -5
  331. package/dist/api/resources/triggers/client/Client.d.ts +83 -0
  332. package/dist/api/resources/triggers/client/Client.js +303 -0
  333. package/dist/api/resources/triggers/client/index.d.ts +1 -0
  334. package/dist/api/resources/triggers/client/index.js +1 -0
  335. package/dist/api/resources/triggers/index.d.ts +2 -0
  336. package/dist/api/resources/triggers/index.js +2 -0
  337. package/dist/api/resources/triggers/types/EventTriggerRequest.d.ts +18 -0
  338. package/dist/api/resources/triggers/types/EventTriggerRequest.js +4 -0
  339. package/dist/api/resources/triggers/types/index.d.ts +1 -0
  340. package/dist/api/resources/triggers/types/index.js +1 -0
  341. package/dist/api/resources/users/client/Client.d.ts +77 -0
  342. package/dist/api/resources/users/client/Client.js +228 -0
  343. package/dist/api/resources/users/client/index.d.ts +1 -0
  344. package/dist/api/resources/users/client/index.js +1 -0
  345. package/dist/api/resources/users/index.d.ts +1 -0
  346. package/dist/api/resources/users/index.js +1 -0
  347. package/dist/core/fetcher/Fetcher.d.ts +4 -1
  348. package/dist/core/fetcher/Fetcher.js +18 -159
  349. package/dist/core/fetcher/createRequestUrl.d.ts +1 -0
  350. package/dist/core/fetcher/createRequestUrl.js +6 -0
  351. package/dist/core/fetcher/getFetchFn.d.ts +4 -0
  352. package/dist/core/fetcher/getFetchFn.js +32 -0
  353. package/dist/core/fetcher/getRequestBody.d.ts +7 -0
  354. package/dist/core/fetcher/getRequestBody.js +19 -0
  355. package/dist/core/fetcher/getResponseBody.d.ts +1 -0
  356. package/dist/core/fetcher/getResponseBody.js +48 -0
  357. package/dist/core/fetcher/makeRequest.d.ts +1 -0
  358. package/dist/core/fetcher/makeRequest.js +38 -0
  359. package/dist/core/fetcher/requestWithRetries.d.ts +1 -0
  360. package/dist/core/fetcher/requestWithRetries.js +28 -0
  361. package/dist/core/fetcher/signals.d.ts +12 -0
  362. package/dist/core/fetcher/signals.js +32 -0
  363. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
  364. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +222 -0
  365. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +21 -0
  366. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +104 -0
  367. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +30 -0
  368. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +204 -0
  369. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +17 -0
  370. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js +23 -0
  371. package/dist/core/index.d.ts +1 -1
  372. package/dist/core/index.js +1 -1
  373. package/dist/core/runtime/runtime.d.ts +1 -0
  374. package/dist/core/runtime/runtime.js +1 -0
  375. package/dist/core/schemas/Schema.d.ts +7 -4
  376. package/dist/core/schemas/builders/lazy/lazy.d.ts +2 -2
  377. package/dist/core/schemas/builders/lazy/lazy.js +8 -19
  378. package/dist/core/schemas/builders/lazy/lazyObject.js +1 -10
  379. package/dist/core/schemas/builders/list/list.js +31 -44
  380. package/dist/core/schemas/builders/object/object.js +90 -111
  381. package/dist/core/schemas/builders/object/types.d.ts +2 -2
  382. package/dist/core/schemas/builders/object-like/getObjectLikeUtils.js +3 -12
  383. package/dist/core/schemas/builders/record/record.js +49 -60
  384. package/dist/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +2 -2
  385. package/dist/core/schemas/builders/schema-utils/getSchemaUtils.js +18 -21
  386. package/dist/core/schemas/builders/set/set.js +6 -15
  387. package/dist/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +21 -32
  388. package/dist/core/schemas/builders/union/union.js +51 -62
  389. package/dist/core/schemas/utils/maybeSkipValidation.js +3 -12
  390. package/dist/serialization/resources/actions/index.d.ts +1 -0
  391. package/dist/serialization/resources/actions/index.js +1 -0
  392. package/dist/serialization/resources/actions/types/ActionBase.d.ts +18 -0
  393. package/dist/serialization/resources/actions/types/ActionBase.js +14 -0
  394. package/dist/serialization/resources/actions/types/ActionParameter.d.ts +15 -0
  395. package/dist/serialization/resources/actions/types/ActionParameter.js +10 -0
  396. package/dist/serialization/resources/actions/types/ActionRequest.d.ts +14 -0
  397. package/dist/serialization/resources/actions/types/ActionRequest.js +11 -0
  398. package/dist/serialization/resources/actions/types/ActionResponse.d.ts +14 -0
  399. package/dist/serialization/resources/actions/types/ActionResponse.js +11 -0
  400. package/dist/serialization/resources/actions/types/ConversationExecutedActionPrecondition.d.ts +15 -0
  401. package/dist/serialization/resources/actions/types/ConversationExecutedActionPrecondition.js +10 -0
  402. package/dist/serialization/resources/actions/types/ConversationPrecondition.d.ts +22 -0
  403. package/dist/serialization/resources/actions/types/ConversationPrecondition.js +18 -0
  404. package/dist/serialization/resources/actions/types/MetadataPrecondition.d.ts +15 -0
  405. package/dist/serialization/resources/actions/types/MetadataPrecondition.js +10 -0
  406. package/dist/serialization/resources/actions/types/Precondition.d.ts +22 -0
  407. package/dist/serialization/resources/actions/types/Precondition.js +19 -0
  408. package/dist/serialization/resources/actions/types/PreconditionGroup.d.ts +14 -0
  409. package/dist/serialization/resources/actions/types/PreconditionGroup.js +10 -0
  410. package/dist/serialization/resources/actions/types/PreconditionGroupOperator.d.ts +10 -0
  411. package/dist/serialization/resources/actions/types/PreconditionGroupOperator.js +5 -0
  412. package/dist/serialization/resources/actions/types/PreconditionOperator.d.ts +10 -0
  413. package/dist/serialization/resources/actions/types/PreconditionOperator.js +5 -0
  414. package/dist/serialization/resources/actions/types/index.d.ts +11 -0
  415. package/dist/serialization/resources/actions/types/index.js +11 -0
  416. package/dist/serialization/resources/appSettings/client/get.d.ts +9 -0
  417. package/dist/serialization/resources/appSettings/client/get.js +5 -0
  418. package/dist/serialization/resources/appSettings/client/index.d.ts +1 -0
  419. package/dist/serialization/resources/appSettings/client/index.js +1 -0
  420. package/dist/serialization/resources/appSettings/index.d.ts +1 -0
  421. package/dist/serialization/resources/appSettings/index.js +1 -0
  422. package/dist/serialization/resources/commons/types/AppUser.d.ts +15 -0
  423. package/dist/serialization/resources/commons/types/AppUser.js +10 -0
  424. package/dist/serialization/resources/commons/types/AppUserIdentifier.d.ts +14 -0
  425. package/dist/serialization/resources/commons/types/AppUserIdentifier.js +9 -0
  426. package/dist/serialization/resources/commons/types/AppUserIdentifyingPropertyType.d.ts +10 -0
  427. package/dist/serialization/resources/commons/types/AppUserIdentifyingPropertyType.js +5 -0
  428. package/dist/serialization/resources/commons/types/AppUserRequest.d.ts +14 -0
  429. package/dist/serialization/resources/commons/types/AppUserRequest.js +11 -0
  430. package/dist/serialization/resources/commons/types/AppUserResponse.d.ts +16 -0
  431. package/dist/serialization/resources/commons/types/AppUserResponse.js +13 -0
  432. package/dist/serialization/resources/commons/types/EntityId.d.ts +17 -0
  433. package/dist/serialization/resources/commons/types/EntityId.js +14 -0
  434. package/{serialization/resources/knowledge/types/IdBody.d.ts → dist/serialization/resources/commons/types/EntityIdBase.d.ts} +3 -3
  435. package/dist/serialization/resources/{knowledge/types/IdBody.js → commons/types/EntityIdBase.js} +2 -2
  436. package/dist/serialization/resources/commons/types/EntityType.d.ts +10 -0
  437. package/dist/serialization/resources/commons/types/EntityType.js +16 -0
  438. package/dist/serialization/resources/commons/types/EventTriggerBase.d.ts +14 -0
  439. package/dist/serialization/resources/commons/types/EventTriggerBase.js +9 -0
  440. package/dist/serialization/resources/commons/types/EventTriggerResponse.d.ts +14 -0
  441. package/dist/serialization/resources/commons/types/EventTriggerResponse.js +11 -0
  442. package/dist/serialization/resources/commons/types/EventTriggerType.d.ts +10 -0
  443. package/dist/serialization/resources/commons/types/EventTriggerType.js +5 -0
  444. package/dist/serialization/resources/commons/types/Feedback.d.ts +16 -0
  445. package/dist/serialization/resources/commons/types/Feedback.js +13 -0
  446. package/dist/serialization/resources/commons/types/FeedbackBase.d.ts +14 -0
  447. package/dist/serialization/resources/commons/types/FeedbackBase.js +9 -0
  448. package/{serialization/resources/conversation → dist/serialization/resources/commons}/types/FeedbackType.d.ts +1 -1
  449. package/dist/serialization/resources/{conversation → commons}/types/FeedbackType.js +1 -1
  450. package/dist/serialization/resources/commons/types/UserData.d.ts +14 -0
  451. package/dist/serialization/resources/commons/types/UserData.js +9 -0
  452. package/dist/serialization/resources/commons/types/VisibilityType.d.ts +10 -0
  453. package/dist/serialization/resources/commons/types/VisibilityType.js +5 -0
  454. package/dist/serialization/resources/commons/types/index.d.ts +16 -1
  455. package/dist/serialization/resources/commons/types/index.js +16 -1
  456. package/dist/serialization/resources/conversation/client/addConversationMetadata.d.ts +13 -0
  457. package/dist/serialization/resources/conversation/client/addConversationMetadata.js +6 -0
  458. package/dist/serialization/resources/conversation/client/index.d.ts +1 -0
  459. package/dist/serialization/resources/conversation/client/index.js +1 -0
  460. package/dist/serialization/resources/conversation/types/ActionFormField.d.ts +1 -0
  461. package/dist/serialization/resources/conversation/types/ActionFormField.js +1 -0
  462. package/dist/serialization/resources/conversation/types/AskRequest.d.ts +3 -3
  463. package/dist/serialization/resources/conversation/types/AskRequest.js +3 -3
  464. package/dist/serialization/resources/conversation/types/AskStreamActionEvent.d.ts +12 -0
  465. package/dist/serialization/resources/conversation/types/AskStreamActionEvent.js +6 -0
  466. package/dist/serialization/resources/conversation/types/AskStreamStartEvent.d.ts +2 -1
  467. package/dist/serialization/resources/conversation/types/AskStreamStartEvent.js +2 -1
  468. package/dist/serialization/resources/conversation/types/BotActionFormResponse.d.ts +1 -0
  469. package/dist/serialization/resources/conversation/types/BotActionFormResponse.js +1 -0
  470. package/dist/serialization/resources/conversation/types/BotMessage.d.ts +2 -0
  471. package/dist/serialization/resources/conversation/types/BotMessage.js +2 -0
  472. package/dist/serialization/resources/conversation/types/Capability.d.ts +10 -0
  473. package/dist/serialization/resources/conversation/types/Capability.js +5 -0
  474. package/dist/serialization/resources/{commons/types/User.d.ts → conversation/types/CategorizationResponse.d.ts} +3 -5
  475. package/dist/serialization/resources/conversation/types/CategorizationResponse.js +7 -0
  476. package/dist/serialization/resources/conversation/types/ConversationAnalysis.d.ts +15 -0
  477. package/dist/serialization/resources/conversation/types/ConversationAnalysis.js +10 -0
  478. package/dist/serialization/resources/conversation/types/ConversationBase.d.ts +8 -3
  479. package/dist/serialization/resources/conversation/types/ConversationBase.js +8 -3
  480. package/dist/serialization/resources/conversation/types/ConversationMessageBase.d.ts +2 -3
  481. package/dist/serialization/resources/conversation/types/ConversationMessageBase.js +2 -3
  482. package/dist/serialization/resources/conversation/types/ConversationMessageRequest.d.ts +4 -2
  483. package/dist/serialization/resources/conversation/types/ConversationMessageRequest.js +7 -2
  484. package/dist/serialization/resources/conversation/types/ConversationRequest.d.ts +2 -0
  485. package/dist/serialization/resources/conversation/types/ConversationRequest.js +2 -0
  486. package/dist/serialization/resources/conversation/types/ConversationResponse.d.ts +4 -0
  487. package/dist/serialization/resources/conversation/types/ConversationResponse.js +4 -0
  488. package/dist/serialization/resources/conversation/types/FeedbackRequest.d.ts +6 -5
  489. package/dist/serialization/resources/conversation/types/FeedbackRequest.js +9 -6
  490. package/dist/serialization/resources/conversation/types/GenerateMavenSuggestionsRequest.d.ts +2 -1
  491. package/dist/serialization/resources/conversation/types/GenerateMavenSuggestionsRequest.js +2 -1
  492. package/dist/serialization/resources/conversation/types/ResponseConfig.d.ts +16 -0
  493. package/dist/serialization/resources/conversation/types/ResponseConfig.js +11 -0
  494. package/dist/serialization/resources/conversation/types/ResponseLength.d.ts +10 -0
  495. package/dist/serialization/resources/conversation/types/ResponseLength.js +5 -0
  496. package/dist/serialization/resources/conversation/types/Sentiment.d.ts +10 -0
  497. package/dist/serialization/resources/conversation/types/Sentiment.js +5 -0
  498. package/dist/serialization/resources/conversation/types/StreamResponse.d.ts +5 -1
  499. package/dist/serialization/resources/conversation/types/StreamResponse.js +2 -0
  500. package/dist/serialization/resources/conversation/types/SubmitActionFormRequest.d.ts +13 -0
  501. package/dist/serialization/resources/conversation/types/SubmitActionFormRequest.js +8 -0
  502. package/dist/serialization/resources/conversation/types/UserMessage.d.ts +4 -5
  503. package/dist/serialization/resources/conversation/types/UserMessage.js +4 -5
  504. package/dist/serialization/resources/conversation/types/UserMessageBase.d.ts +17 -0
  505. package/dist/serialization/resources/conversation/types/UserMessageBase.js +14 -0
  506. package/dist/serialization/resources/conversation/types/index.d.ts +9 -3
  507. package/dist/serialization/resources/conversation/types/index.js +9 -3
  508. package/dist/serialization/resources/index.d.ts +5 -0
  509. package/dist/serialization/resources/index.js +5 -0
  510. package/dist/serialization/resources/knowledge/types/{KnowledgeDocument.d.ts → BaseKnowledgeDocument.d.ts} +3 -5
  511. package/{serialization/resources/knowledge/types/KnowledgeDocument.js → dist/serialization/resources/knowledge/types/BaseKnowledgeDocument.js} +2 -6
  512. package/{serialization/resources/knowledge/types/KnowledgeBase.d.ts → dist/serialization/resources/knowledge/types/KnowledgeBaseProperties.d.ts} +4 -5
  513. package/dist/serialization/resources/knowledge/types/{KnowledgeBase.js → KnowledgeBaseProperties.js} +3 -6
  514. package/dist/serialization/resources/knowledge/types/KnowledgeBaseRequest.d.ts +14 -0
  515. package/dist/serialization/resources/knowledge/types/KnowledgeBaseRequest.js +11 -0
  516. package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +14 -0
  517. package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +11 -0
  518. package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersion.d.ts +0 -1
  519. package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersion.js +0 -1
  520. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentContentType.d.ts +10 -0
  521. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentContentType.js +5 -0
  522. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +17 -0
  523. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +14 -0
  524. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +15 -0
  525. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentResponse.js +12 -0
  526. package/dist/serialization/resources/knowledge/types/index.d.ts +7 -5
  527. package/dist/serialization/resources/knowledge/types/index.js +7 -5
  528. package/dist/serialization/resources/triggers/index.d.ts +1 -0
  529. package/dist/serialization/resources/triggers/index.js +1 -0
  530. package/dist/serialization/resources/triggers/types/EventTriggerRequest.d.ts +14 -0
  531. package/dist/serialization/resources/triggers/types/EventTriggerRequest.js +11 -0
  532. package/dist/serialization/resources/triggers/types/index.d.ts +1 -0
  533. package/dist/serialization/resources/triggers/types/index.js +1 -0
  534. package/package.json +7 -2
  535. package/reference.md +1863 -0
  536. package/serialization/resources/actions/index.d.ts +1 -0
  537. package/serialization/resources/actions/index.js +1 -0
  538. package/serialization/resources/actions/types/ActionBase.d.ts +18 -0
  539. package/serialization/resources/actions/types/ActionBase.js +14 -0
  540. package/serialization/resources/actions/types/ActionParameter.d.ts +15 -0
  541. package/serialization/resources/actions/types/ActionParameter.js +10 -0
  542. package/serialization/resources/actions/types/ActionRequest.d.ts +14 -0
  543. package/serialization/resources/actions/types/ActionRequest.js +11 -0
  544. package/serialization/resources/actions/types/ActionResponse.d.ts +14 -0
  545. package/serialization/resources/actions/types/ActionResponse.js +11 -0
  546. package/serialization/resources/actions/types/ConversationExecutedActionPrecondition.d.ts +15 -0
  547. package/serialization/resources/actions/types/ConversationExecutedActionPrecondition.js +10 -0
  548. package/serialization/resources/actions/types/ConversationPrecondition.d.ts +22 -0
  549. package/serialization/resources/actions/types/ConversationPrecondition.js +18 -0
  550. package/serialization/resources/actions/types/MetadataPrecondition.d.ts +15 -0
  551. package/serialization/resources/actions/types/MetadataPrecondition.js +10 -0
  552. package/serialization/resources/actions/types/Precondition.d.ts +22 -0
  553. package/serialization/resources/actions/types/Precondition.js +19 -0
  554. package/serialization/resources/actions/types/PreconditionGroup.d.ts +14 -0
  555. package/serialization/resources/actions/types/PreconditionGroup.js +10 -0
  556. package/serialization/resources/actions/types/PreconditionGroupOperator.d.ts +10 -0
  557. package/serialization/resources/actions/types/PreconditionGroupOperator.js +5 -0
  558. package/serialization/resources/actions/types/PreconditionOperator.d.ts +10 -0
  559. package/serialization/resources/actions/types/PreconditionOperator.js +5 -0
  560. package/serialization/resources/actions/types/index.d.ts +11 -0
  561. package/serialization/resources/actions/types/index.js +11 -0
  562. package/serialization/resources/appSettings/client/get.d.ts +9 -0
  563. package/serialization/resources/appSettings/client/get.js +5 -0
  564. package/serialization/resources/appSettings/client/index.d.ts +1 -0
  565. package/serialization/resources/appSettings/client/index.js +1 -0
  566. package/serialization/resources/appSettings/index.d.ts +1 -0
  567. package/serialization/resources/appSettings/index.js +1 -0
  568. package/serialization/resources/commons/types/AppUser.d.ts +15 -0
  569. package/serialization/resources/commons/types/AppUser.js +10 -0
  570. package/serialization/resources/commons/types/AppUserIdentifier.d.ts +14 -0
  571. package/serialization/resources/commons/types/AppUserIdentifier.js +9 -0
  572. package/serialization/resources/commons/types/AppUserIdentifyingPropertyType.d.ts +10 -0
  573. package/serialization/resources/commons/types/AppUserIdentifyingPropertyType.js +5 -0
  574. package/serialization/resources/commons/types/AppUserRequest.d.ts +14 -0
  575. package/serialization/resources/commons/types/AppUserRequest.js +11 -0
  576. package/serialization/resources/commons/types/AppUserResponse.d.ts +16 -0
  577. package/serialization/resources/commons/types/AppUserResponse.js +13 -0
  578. package/serialization/resources/commons/types/EntityId.d.ts +17 -0
  579. package/serialization/resources/commons/types/EntityId.js +14 -0
  580. package/{dist/serialization/resources/knowledge/types/IdBody.d.ts → serialization/resources/commons/types/EntityIdBase.d.ts} +3 -3
  581. package/serialization/resources/{knowledge/types/IdBody.js → commons/types/EntityIdBase.js} +2 -2
  582. package/serialization/resources/commons/types/EntityType.d.ts +10 -0
  583. package/serialization/resources/commons/types/EntityType.js +16 -0
  584. package/serialization/resources/commons/types/EventTriggerBase.d.ts +14 -0
  585. package/serialization/resources/commons/types/EventTriggerBase.js +9 -0
  586. package/serialization/resources/commons/types/EventTriggerResponse.d.ts +14 -0
  587. package/serialization/resources/commons/types/EventTriggerResponse.js +11 -0
  588. package/serialization/resources/commons/types/EventTriggerType.d.ts +10 -0
  589. package/serialization/resources/commons/types/EventTriggerType.js +5 -0
  590. package/serialization/resources/commons/types/Feedback.d.ts +16 -0
  591. package/serialization/resources/commons/types/Feedback.js +13 -0
  592. package/serialization/resources/commons/types/FeedbackBase.d.ts +14 -0
  593. package/serialization/resources/commons/types/FeedbackBase.js +9 -0
  594. package/{dist/serialization/resources/conversation → serialization/resources/commons}/types/FeedbackType.d.ts +1 -1
  595. package/serialization/resources/{conversation → commons}/types/FeedbackType.js +1 -1
  596. package/serialization/resources/commons/types/UserData.d.ts +14 -0
  597. package/serialization/resources/commons/types/UserData.js +9 -0
  598. package/serialization/resources/commons/types/VisibilityType.d.ts +10 -0
  599. package/serialization/resources/commons/types/VisibilityType.js +5 -0
  600. package/serialization/resources/commons/types/index.d.ts +16 -1
  601. package/serialization/resources/commons/types/index.js +16 -1
  602. package/serialization/resources/conversation/client/addConversationMetadata.d.ts +13 -0
  603. package/serialization/resources/conversation/client/addConversationMetadata.js +6 -0
  604. package/serialization/resources/conversation/client/index.d.ts +1 -0
  605. package/serialization/resources/conversation/client/index.js +1 -0
  606. package/serialization/resources/conversation/types/ActionFormField.d.ts +1 -0
  607. package/serialization/resources/conversation/types/ActionFormField.js +1 -0
  608. package/serialization/resources/conversation/types/AskRequest.d.ts +3 -3
  609. package/serialization/resources/conversation/types/AskRequest.js +3 -3
  610. package/serialization/resources/conversation/types/AskStreamActionEvent.d.ts +12 -0
  611. package/serialization/resources/conversation/types/AskStreamActionEvent.js +6 -0
  612. package/serialization/resources/conversation/types/AskStreamStartEvent.d.ts +2 -1
  613. package/serialization/resources/conversation/types/AskStreamStartEvent.js +2 -1
  614. package/serialization/resources/conversation/types/BotActionFormResponse.d.ts +1 -0
  615. package/serialization/resources/conversation/types/BotActionFormResponse.js +1 -0
  616. package/serialization/resources/conversation/types/BotMessage.d.ts +2 -0
  617. package/serialization/resources/conversation/types/BotMessage.js +2 -0
  618. package/serialization/resources/conversation/types/Capability.d.ts +10 -0
  619. package/serialization/resources/conversation/types/Capability.js +5 -0
  620. package/serialization/resources/{commons/types/User.d.ts → conversation/types/CategorizationResponse.d.ts} +3 -5
  621. package/serialization/resources/conversation/types/CategorizationResponse.js +7 -0
  622. package/serialization/resources/conversation/types/ConversationAnalysis.d.ts +15 -0
  623. package/serialization/resources/conversation/types/ConversationAnalysis.js +10 -0
  624. package/serialization/resources/conversation/types/ConversationBase.d.ts +8 -3
  625. package/serialization/resources/conversation/types/ConversationBase.js +8 -3
  626. package/serialization/resources/conversation/types/ConversationMessageBase.d.ts +2 -3
  627. package/serialization/resources/conversation/types/ConversationMessageBase.js +2 -3
  628. package/serialization/resources/conversation/types/ConversationMessageRequest.d.ts +4 -2
  629. package/serialization/resources/conversation/types/ConversationMessageRequest.js +7 -2
  630. package/serialization/resources/conversation/types/ConversationRequest.d.ts +2 -0
  631. package/serialization/resources/conversation/types/ConversationRequest.js +2 -0
  632. package/serialization/resources/conversation/types/ConversationResponse.d.ts +4 -0
  633. package/serialization/resources/conversation/types/ConversationResponse.js +4 -0
  634. package/serialization/resources/conversation/types/FeedbackRequest.d.ts +6 -5
  635. package/serialization/resources/conversation/types/FeedbackRequest.js +9 -6
  636. package/serialization/resources/conversation/types/GenerateMavenSuggestionsRequest.d.ts +2 -1
  637. package/serialization/resources/conversation/types/GenerateMavenSuggestionsRequest.js +2 -1
  638. package/serialization/resources/conversation/types/ResponseConfig.d.ts +16 -0
  639. package/serialization/resources/conversation/types/ResponseConfig.js +11 -0
  640. package/serialization/resources/conversation/types/ResponseLength.d.ts +10 -0
  641. package/serialization/resources/conversation/types/ResponseLength.js +5 -0
  642. package/serialization/resources/conversation/types/Sentiment.d.ts +10 -0
  643. package/serialization/resources/conversation/types/Sentiment.js +5 -0
  644. package/serialization/resources/conversation/types/StreamResponse.d.ts +5 -1
  645. package/serialization/resources/conversation/types/StreamResponse.js +2 -0
  646. package/serialization/resources/conversation/types/SubmitActionFormRequest.d.ts +13 -0
  647. package/serialization/resources/conversation/types/SubmitActionFormRequest.js +8 -0
  648. package/serialization/resources/conversation/types/UserMessage.d.ts +4 -5
  649. package/serialization/resources/conversation/types/UserMessage.js +4 -5
  650. package/serialization/resources/conversation/types/UserMessageBase.d.ts +17 -0
  651. package/serialization/resources/conversation/types/UserMessageBase.js +14 -0
  652. package/serialization/resources/conversation/types/index.d.ts +9 -3
  653. package/serialization/resources/conversation/types/index.js +9 -3
  654. package/serialization/resources/index.d.ts +5 -0
  655. package/serialization/resources/index.js +5 -0
  656. package/serialization/resources/knowledge/types/{KnowledgeDocument.d.ts → BaseKnowledgeDocument.d.ts} +3 -5
  657. package/{dist/serialization/resources/knowledge/types/KnowledgeDocument.js → serialization/resources/knowledge/types/BaseKnowledgeDocument.js} +2 -6
  658. package/{dist/serialization/resources/knowledge/types/KnowledgeBase.d.ts → serialization/resources/knowledge/types/KnowledgeBaseProperties.d.ts} +4 -5
  659. package/serialization/resources/knowledge/types/{KnowledgeBase.js → KnowledgeBaseProperties.js} +3 -6
  660. package/serialization/resources/knowledge/types/KnowledgeBaseRequest.d.ts +14 -0
  661. package/serialization/resources/knowledge/types/KnowledgeBaseRequest.js +11 -0
  662. package/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +14 -0
  663. package/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +11 -0
  664. package/serialization/resources/knowledge/types/KnowledgeBaseVersion.d.ts +0 -1
  665. package/serialization/resources/knowledge/types/KnowledgeBaseVersion.js +0 -1
  666. package/serialization/resources/knowledge/types/KnowledgeDocumentContentType.d.ts +10 -0
  667. package/serialization/resources/knowledge/types/KnowledgeDocumentContentType.js +5 -0
  668. package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +17 -0
  669. package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +14 -0
  670. package/serialization/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +15 -0
  671. package/serialization/resources/knowledge/types/KnowledgeDocumentResponse.js +12 -0
  672. package/serialization/resources/knowledge/types/index.d.ts +7 -5
  673. package/serialization/resources/knowledge/types/index.js +7 -5
  674. package/serialization/resources/triggers/index.d.ts +1 -0
  675. package/serialization/resources/triggers/index.js +1 -0
  676. package/serialization/resources/triggers/types/EventTriggerRequest.d.ts +14 -0
  677. package/serialization/resources/triggers/types/EventTriggerRequest.js +11 -0
  678. package/serialization/resources/triggers/types/index.d.ts +1 -0
  679. package/serialization/resources/triggers/types/index.js +1 -0
  680. package/api/resources/commons/types/User.d.ts +0 -9
  681. package/api/resources/conversation/errors/ConversationAlreadyExistsError.d.ts +0 -8
  682. package/api/resources/conversation/errors/ConversationAlreadyExistsError.js +0 -14
  683. package/api/resources/conversation/errors/ConversationMessageNotFoundError.d.ts +0 -8
  684. package/api/resources/conversation/errors/ConversationMessageNotFoundError.js +0 -14
  685. package/api/resources/conversation/errors/ConversationNotFoundError.d.ts +0 -8
  686. package/api/resources/conversation/errors/ConversationNotFoundError.js +0 -14
  687. package/api/resources/conversation/errors/InvalidConversationIdError.d.ts +0 -8
  688. package/api/resources/conversation/errors/InvalidConversationIdError.js +0 -14
  689. package/api/resources/conversation/errors/InvalidConversationMessageIdError.d.ts +0 -8
  690. package/api/resources/conversation/errors/InvalidConversationMessageIdError.js +0 -14
  691. package/api/resources/conversation/errors/InvalidFeedbackTypeError.d.ts +0 -8
  692. package/api/resources/conversation/errors/InvalidFeedbackTypeError.js +0 -14
  693. package/api/resources/conversation/errors/index.d.ts +0 -7
  694. package/api/resources/conversation/errors/index.js +0 -7
  695. package/api/resources/conversation/types/ConversationContext.d.ts +0 -20
  696. package/api/resources/conversation/types/ConversationMessageContext.d.ts +0 -12
  697. package/api/resources/knowledge/errors/DocumentCreationError.d.ts +0 -7
  698. package/api/resources/knowledge/errors/DocumentCreationError.js +0 -13
  699. package/api/resources/knowledge/errors/DocumentNotFoundError.d.ts +0 -8
  700. package/api/resources/knowledge/errors/DocumentNotFoundError.js +0 -14
  701. package/api/resources/knowledge/errors/IneligibleKnowledgeBaseError.d.ts +0 -8
  702. package/api/resources/knowledge/errors/IneligibleKnowledgeBaseError.js +0 -14
  703. package/api/resources/knowledge/errors/KnowledgeBaseNotFoundError.d.ts +0 -8
  704. package/api/resources/knowledge/errors/KnowledgeBaseNotFoundError.js +0 -14
  705. package/api/resources/knowledge/errors/VersionInProgressError.d.ts +0 -8
  706. package/api/resources/knowledge/errors/VersionInProgressError.js +0 -14
  707. package/api/resources/knowledge/errors/VersionNotInProgressError.d.ts +0 -8
  708. package/api/resources/knowledge/errors/VersionNotInProgressError.js +0 -14
  709. package/api/resources/knowledge/errors/index.d.ts +0 -6
  710. package/api/resources/knowledge/errors/index.js +0 -6
  711. package/api/resources/knowledge/types/KnowledgeBaseId.d.ts +0 -7
  712. package/api/resources/knowledge/types/KnowledgeDocumentId.d.ts +0 -9
  713. package/dist/api/resources/commons/types/User.d.ts +0 -9
  714. package/dist/api/resources/conversation/errors/ConversationAlreadyExistsError.d.ts +0 -8
  715. package/dist/api/resources/conversation/errors/ConversationAlreadyExistsError.js +0 -14
  716. package/dist/api/resources/conversation/errors/ConversationMessageNotFoundError.d.ts +0 -8
  717. package/dist/api/resources/conversation/errors/ConversationMessageNotFoundError.js +0 -14
  718. package/dist/api/resources/conversation/errors/ConversationNotFoundError.d.ts +0 -8
  719. package/dist/api/resources/conversation/errors/ConversationNotFoundError.js +0 -14
  720. package/dist/api/resources/conversation/errors/EmptyConversationError.js +0 -14
  721. package/dist/api/resources/conversation/errors/InvalidConversationIdError.d.ts +0 -8
  722. package/dist/api/resources/conversation/errors/InvalidConversationIdError.js +0 -14
  723. package/dist/api/resources/conversation/errors/InvalidConversationMessageIdError.d.ts +0 -8
  724. package/dist/api/resources/conversation/errors/InvalidConversationMessageIdError.js +0 -14
  725. package/dist/api/resources/conversation/errors/InvalidFeedbackTypeError.d.ts +0 -8
  726. package/dist/api/resources/conversation/errors/InvalidFeedbackTypeError.js +0 -14
  727. package/dist/api/resources/conversation/errors/index.d.ts +0 -7
  728. package/dist/api/resources/conversation/errors/index.js +0 -7
  729. package/dist/api/resources/conversation/types/ConversationContext.d.ts +0 -20
  730. package/dist/api/resources/conversation/types/ConversationMessageContext.d.ts +0 -12
  731. package/dist/api/resources/knowledge/errors/DocumentCreationError.d.ts +0 -7
  732. package/dist/api/resources/knowledge/errors/DocumentCreationError.js +0 -13
  733. package/dist/api/resources/knowledge/errors/DocumentNotFoundError.d.ts +0 -8
  734. package/dist/api/resources/knowledge/errors/DocumentNotFoundError.js +0 -14
  735. package/dist/api/resources/knowledge/errors/IneligibleKnowledgeBaseError.d.ts +0 -8
  736. package/dist/api/resources/knowledge/errors/IneligibleKnowledgeBaseError.js +0 -14
  737. package/dist/api/resources/knowledge/errors/KnowledgeBaseNotFoundError.d.ts +0 -8
  738. package/dist/api/resources/knowledge/errors/KnowledgeBaseNotFoundError.js +0 -14
  739. package/dist/api/resources/knowledge/errors/VersionInProgressError.d.ts +0 -8
  740. package/dist/api/resources/knowledge/errors/VersionNotInProgressError.d.ts +0 -8
  741. package/dist/api/resources/knowledge/errors/VersionNotInProgressError.js +0 -14
  742. package/dist/api/resources/knowledge/errors/index.d.ts +0 -6
  743. package/dist/api/resources/knowledge/errors/index.js +0 -6
  744. package/dist/api/resources/knowledge/types/KnowledgeBaseId.d.ts +0 -7
  745. package/dist/api/resources/knowledge/types/KnowledgeDocumentId.d.ts +0 -9
  746. package/dist/serialization/resources/commons/types/User.js +0 -9
  747. package/dist/serialization/resources/conversation/types/ConversationContext.d.ts +0 -20
  748. package/dist/serialization/resources/conversation/types/ConversationContext.js +0 -15
  749. package/dist/serialization/resources/conversation/types/ConversationMessageContext.d.ts +0 -16
  750. package/dist/serialization/resources/conversation/types/ConversationMessageContext.js +0 -11
  751. package/dist/serialization/resources/knowledge/types/KnowledgeBaseId.d.ts +0 -12
  752. package/dist/serialization/resources/knowledge/types/KnowledgeBaseId.js +0 -7
  753. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentId.d.ts +0 -13
  754. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentId.js +0 -8
  755. package/serialization/resources/commons/types/User.js +0 -9
  756. package/serialization/resources/conversation/types/ConversationContext.d.ts +0 -20
  757. package/serialization/resources/conversation/types/ConversationContext.js +0 -15
  758. package/serialization/resources/conversation/types/ConversationMessageContext.d.ts +0 -16
  759. package/serialization/resources/conversation/types/ConversationMessageContext.js +0 -11
  760. package/serialization/resources/knowledge/types/KnowledgeBaseId.d.ts +0 -12
  761. package/serialization/resources/knowledge/types/KnowledgeBaseId.js +0 -7
  762. package/serialization/resources/knowledge/types/KnowledgeDocumentId.d.ts +0 -13
  763. package/serialization/resources/knowledge/types/KnowledgeDocumentId.js +0 -8
  764. /package/api/resources/{commons/types/User.js → actions/types/ActionBase.js} +0 -0
  765. /package/api/resources/{conversation/types/ConversationContext.js → actions/types/ActionParameter.js} +0 -0
  766. /package/api/resources/{conversation/types/ConversationMessageContext.js → actions/types/ActionRequest.js} +0 -0
  767. /package/api/resources/{knowledge/types/IdBody.js → actions/types/ActionResponse.js} +0 -0
  768. /package/api/resources/{knowledge/types/KnowledgeBase.js → actions/types/ConversationExecutedActionPrecondition.js} +0 -0
  769. /package/api/resources/{knowledge/types/KnowledgeBaseId.js → actions/types/ConversationPrecondition.js} +0 -0
  770. /package/api/resources/{knowledge/types/KnowledgeDocument.js → actions/types/MetadataPrecondition.js} +0 -0
  771. /package/api/resources/{knowledge/types/KnowledgeDocumentId.js → actions/types/Precondition.js} +0 -0
  772. /package/{dist/api/resources/commons/types/User.js → api/resources/actions/types/PreconditionGroup.js} +0 -0
  773. /package/{dist/api/resources/conversation/types/ConversationContext.js → api/resources/commons/types/AppUser.js} +0 -0
  774. /package/{dist/api/resources/conversation/types/ConversationMessageContext.js → api/resources/commons/types/AppUserIdentifier.js} +0 -0
  775. /package/{dist/api/resources/knowledge/types/IdBody.js → api/resources/commons/types/AppUserRequest.js} +0 -0
  776. /package/{dist/api/resources/knowledge/types/KnowledgeBase.js → api/resources/commons/types/AppUserResponse.js} +0 -0
  777. /package/{dist/api/resources/knowledge/types/KnowledgeBaseId.js → api/resources/commons/types/EntityId.js} +0 -0
  778. /package/{dist/api/resources/knowledge/types/KnowledgeDocument.js → api/resources/commons/types/EntityIdBase.js} +0 -0
  779. /package/{dist/api/resources/knowledge/types/KnowledgeDocumentId.js → api/resources/commons/types/EventTriggerBase.js} +0 -0
package/Client.d.ts CHANGED
@@ -3,28 +3,49 @@
3
3
  */
4
4
  import * as environments from "./environments";
5
5
  import * as core from "./core";
6
+ import { Actions } from "./api/resources/actions/client/Client";
7
+ import { AppSettings } from "./api/resources/appSettings/client/Client";
6
8
  import { Conversation } from "./api/resources/conversation/client/Client";
7
9
  import { Knowledge } from "./api/resources/knowledge/client/Client";
10
+ import { Triggers } from "./api/resources/triggers/client/Client";
11
+ import { Users } from "./api/resources/users/client/Client";
8
12
  export declare namespace MavenAGIClient {
9
13
  interface Options {
10
14
  environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
11
15
  appId?: core.Supplier<string | undefined>;
12
16
  appSecret?: core.Supplier<string | undefined>;
17
+ /** Override the X-Organization-Id header */
13
18
  organizationId: core.Supplier<string>;
19
+ /** Override the X-Agent-Id header */
14
20
  agentId: core.Supplier<string>;
15
21
  fetcher?: core.FetchFunction;
16
22
  }
17
23
  interface RequestOptions {
24
+ /** The maximum time to wait for a response in seconds. */
18
25
  timeoutInSeconds?: number;
26
+ /** The number of times to retry the request. Defaults to 2. */
19
27
  maxRetries?: number;
28
+ /** A hook to abort the request. */
20
29
  abortSignal?: AbortSignal;
30
+ /** Override the X-Organization-Id header */
31
+ organizationId?: string;
32
+ /** Override the X-Agent-Id header */
33
+ agentId?: string;
21
34
  }
22
35
  }
23
36
  export declare class MavenAGIClient {
24
37
  protected readonly _options: MavenAGIClient.Options;
25
38
  constructor(_options: MavenAGIClient.Options);
39
+ protected _actions: Actions | undefined;
40
+ get actions(): Actions;
41
+ protected _appSettings: AppSettings | undefined;
42
+ get appSettings(): AppSettings;
26
43
  protected _conversation: Conversation | undefined;
27
44
  get conversation(): Conversation;
28
45
  protected _knowledge: Knowledge | undefined;
29
46
  get knowledge(): Knowledge;
47
+ protected _triggers: Triggers | undefined;
48
+ get triggers(): Triggers;
49
+ protected _users: Users | undefined;
50
+ get users(): Users;
30
51
  }
package/Client.js CHANGED
@@ -1,12 +1,24 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ import { Actions } from "./api/resources/actions/client/Client";
5
+ import { AppSettings } from "./api/resources/appSettings/client/Client";
4
6
  import { Conversation } from "./api/resources/conversation/client/Client";
5
7
  import { Knowledge } from "./api/resources/knowledge/client/Client";
8
+ import { Triggers } from "./api/resources/triggers/client/Client";
9
+ import { Users } from "./api/resources/users/client/Client";
6
10
  export class MavenAGIClient {
7
11
  constructor(_options) {
8
12
  this._options = _options;
9
13
  }
14
+ get actions() {
15
+ var _a;
16
+ return ((_a = this._actions) !== null && _a !== void 0 ? _a : (this._actions = new Actions(this._options)));
17
+ }
18
+ get appSettings() {
19
+ var _a;
20
+ return ((_a = this._appSettings) !== null && _a !== void 0 ? _a : (this._appSettings = new AppSettings(this._options)));
21
+ }
10
22
  get conversation() {
11
23
  var _a;
12
24
  return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Conversation(this._options)));
@@ -15,4 +27,12 @@ export class MavenAGIClient {
15
27
  var _a;
16
28
  return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Knowledge(this._options)));
17
29
  }
30
+ get triggers() {
31
+ var _a;
32
+ return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Triggers(this._options)));
33
+ }
34
+ get users() {
35
+ var _a;
36
+ return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Users(this._options)));
37
+ }
18
38
  }
package/README.md CHANGED
@@ -16,18 +16,32 @@ npm i -s mavenagi
16
16
  Instantiate and use the client with the following:
17
17
 
18
18
  ```typescript
19
- import { MavenAGIClient } from "mavenagi";
19
+ import { MavenAGIClient, MavenAGI } from "mavenagi";
20
20
 
21
- const mavenAgi = new MavenAGIClient({
21
+ const client = new MavenAGIClient({
22
22
  appId: "YOUR_APP_ID",
23
23
  appSecret: "YOUR_APP_SECRET",
24
24
  organizationId: "YOUR_ORGANIZATION_ID",
25
25
  agentId: "YOUR_AGENT_ID",
26
26
  });
27
- await mavenAgi.conversation.initialize({
27
+ await client.conversation.initialize({
28
+ conversationId: {
29
+ referenceId: "string",
30
+ },
28
31
  messages: [{}],
29
- id: "string",
30
- context: {},
32
+ responseConfig: {
33
+ capabilities: [MavenAGI.Capability.Markdown],
34
+ isCopilot: true,
35
+ responseLength: MavenAGI.ResponseLength.Short,
36
+ },
37
+ subject: "string",
38
+ url: "string",
39
+ createdAt: new Date("2024-01-15T09:30:00.000Z"),
40
+ updatedAt: new Date("2024-01-15T09:30:00.000Z"),
41
+ tags: new Set(["string"]),
42
+ metadata: {
43
+ string: "string",
44
+ },
31
45
  });
32
46
  ```
33
47
 
@@ -37,10 +51,10 @@ When the API returns a non-success status code (4xx or 5xx response), a subclass
37
51
  will be thrown.
38
52
 
39
53
  ```typescript
40
- import { MavenAGIError } from 'mavenagi';
54
+ import { MavenAGIError } from "mavenagi";
41
55
 
42
56
  try {
43
- await mavenAgi.initialize(...);
57
+ await client.conversation.initialize(...);
44
58
  } catch (err) {
45
59
  if (err instanceof MavenAGIError) {
46
60
  console.log(err.statusCode);
@@ -50,7 +64,47 @@ try {
50
64
  }
51
65
  ```
52
66
 
53
- ## Retries
67
+ ## Aborting Requests
68
+
69
+ The SDK allows users to abort requests at any point by passing in an abort signal.
70
+
71
+ ```typescript
72
+ const controller = new AbortController();
73
+ const response = await client.initialize(..., {
74
+ abortSignal: controller.signal
75
+ });
76
+ controller.abort(); // aborts the request
77
+ ```
78
+
79
+ ## Runtime Compatibility
80
+
81
+ The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
82
+ runtimes:
83
+
84
+ - Node.js 18+
85
+ - Vercel
86
+ - Cloudflare Workers
87
+ - Deno v1.25+
88
+ - Bun 1.0+
89
+ - React Native
90
+
91
+ ### Customizing Fetch Client
92
+
93
+ The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
94
+ unsupported environment, this provides a way for you to break glass and ensure the SDK works.
95
+
96
+ ```typescript
97
+ import { MavenAGIClient } from "mavenagi";
98
+
99
+ const client = new MavenAGIClient({
100
+ ...
101
+ fetcher: // provide your implementation here
102
+ });
103
+ ```
104
+
105
+ ## Advanced
106
+
107
+ ### Retries
54
108
 
55
109
  The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
56
110
  as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
@@ -65,34 +119,34 @@ A request is deemed retriable when any of the following HTTP status codes is ret
65
119
  Use the `maxRetries` request option to configure this behavior.
66
120
 
67
121
  ```typescript
68
- const response = await mavenAgi.initialize(..., {
122
+ const response = await client.conversation.initialize(..., {
69
123
  maxRetries: 0 // override maxRetries at the request level
70
124
  });
71
125
  ```
72
126
 
73
- ## Timeouts
127
+ ### Timeouts
74
128
 
75
129
  The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
76
130
 
77
131
  ```typescript
78
- const response = await mavenAgi.initialize(..., {
132
+ const response = await client.conversation.initialize(..., {
79
133
  timeoutInSeconds: 30 // override timeout to 30s
80
134
  });
81
135
  ```
82
136
 
83
- ## Aborting Requests
137
+ ### Aborting Requests
84
138
 
85
139
  The SDK allows users to abort requests at any point by passing in an abort signal.
86
140
 
87
141
  ```typescript
88
142
  const controller = new AbortController();
89
- const response = await mavenAgi.initialize(..., {
143
+ const response = await client.conversation.initialize(..., {
90
144
  abortSignal: controller.signal
91
145
  });
92
146
  controller.abort(); // aborts the request
93
147
  ```
94
148
 
95
- ## Runtime Compatibility
149
+ ### Runtime Compatibility
96
150
 
97
151
  The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
98
152
  runtimes:
@@ -110,9 +164,9 @@ The SDK provides a way for your to customize the underlying HTTP client / Fetch
110
164
  unsupported environment, this provides a way for you to break glass and ensure the SDK works.
111
165
 
112
166
  ```typescript
113
- import { MavenAGIClient } from 'mavenagi';
167
+ import { MavenAGIClient } from "mavenagi";
114
168
 
115
- const mavenAgi = new MavenAGIClient({
169
+ const client = new MavenAGIClient({
116
170
  ...
117
171
  fetcher: // provide your implementation here
118
172
  });
@@ -0,0 +1,96 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as environments from "../../../../environments";
5
+ import * as core from "../../../../core";
6
+ import * as MavenAGI from "../../../index";
7
+ export declare namespace Actions {
8
+ interface Options {
9
+ environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
10
+ appId?: core.Supplier<string | undefined>;
11
+ appSecret?: core.Supplier<string | undefined>;
12
+ /** Override the X-Organization-Id header */
13
+ organizationId: core.Supplier<string>;
14
+ /** Override the X-Agent-Id header */
15
+ agentId: core.Supplier<string>;
16
+ fetcher?: core.FetchFunction;
17
+ }
18
+ interface RequestOptions {
19
+ /** The maximum time to wait for a response in seconds. */
20
+ timeoutInSeconds?: number;
21
+ /** The number of times to retry the request. Defaults to 2. */
22
+ maxRetries?: number;
23
+ /** A hook to abort the request. */
24
+ abortSignal?: AbortSignal;
25
+ /** Override the X-Organization-Id header */
26
+ organizationId?: string;
27
+ /** Override the X-Agent-Id header */
28
+ agentId?: string;
29
+ }
30
+ }
31
+ export declare class Actions {
32
+ protected readonly _options: Actions.Options;
33
+ constructor(_options: Actions.Options);
34
+ /**
35
+ * Update an action or create it if it doesn't exist
36
+ *
37
+ * @param {MavenAGI.ActionRequest} request
38
+ * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
39
+ *
40
+ * @throws {@link MavenAGI.NotFoundError}
41
+ * @throws {@link MavenAGI.BadRequestError}
42
+ * @throws {@link MavenAGI.ServerError}
43
+ *
44
+ * @example
45
+ * await client.actions.createOrUpdate({
46
+ * actionId: {
47
+ * referenceId: "get-balance"
48
+ * },
49
+ * name: "Get the user's balance",
50
+ * description: "This action calls an API to get the user's current balance.",
51
+ * userInteractionRequired: false,
52
+ * userFormParameters: [],
53
+ * precondition: {
54
+ * preconditionType: "group",
55
+ * operator: MavenAGI.PreconditionGroupOperator.And,
56
+ * preconditions: [{
57
+ * preconditionType: "user",
58
+ * key: "userKey"
59
+ * }, {
60
+ * preconditionType: "user",
61
+ * key: "userKey2"
62
+ * }]
63
+ * }
64
+ * })
65
+ */
66
+ createOrUpdate(request: MavenAGI.ActionRequest, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
67
+ /**
68
+ * Get an action by its supplied ID
69
+ *
70
+ * @param {string} actionReferenceId - The reference ID of the action to get. All other entity ID fields are inferred from the request.
71
+ * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
72
+ *
73
+ * @throws {@link MavenAGI.NotFoundError}
74
+ * @throws {@link MavenAGI.BadRequestError}
75
+ * @throws {@link MavenAGI.ServerError}
76
+ *
77
+ * @example
78
+ * await client.actions.get("get-balance")
79
+ */
80
+ get(actionReferenceId: string, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
81
+ /**
82
+ * Delete an action
83
+ *
84
+ * @param {string} actionReferenceId - The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
85
+ * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
86
+ *
87
+ * @throws {@link MavenAGI.NotFoundError}
88
+ * @throws {@link MavenAGI.BadRequestError}
89
+ * @throws {@link MavenAGI.ServerError}
90
+ *
91
+ * @example
92
+ * await client.actions.delete("get-balance")
93
+ */
94
+ delete(actionReferenceId: string, requestOptions?: Actions.RequestOptions): Promise<void>;
95
+ protected _getAuthorizationHeader(): Promise<string | undefined>;
96
+ }
@@ -0,0 +1,316 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
5
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
6
+ return new (P || (P = Promise))(function (resolve, reject) {
7
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
8
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
9
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
10
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
11
+ });
12
+ };
13
+ import * as environments from "../../../../environments";
14
+ import * as core from "../../../../core";
15
+ import * as MavenAGI from "../../../index";
16
+ import * as serializers from "../../../../serialization/index";
17
+ import urlJoin from "url-join";
18
+ import * as errors from "../../../../errors/index";
19
+ export class Actions {
20
+ constructor(_options) {
21
+ this._options = _options;
22
+ }
23
+ /**
24
+ * Update an action or create it if it doesn't exist
25
+ *
26
+ * @param {MavenAGI.ActionRequest} request
27
+ * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
28
+ *
29
+ * @throws {@link MavenAGI.NotFoundError}
30
+ * @throws {@link MavenAGI.BadRequestError}
31
+ * @throws {@link MavenAGI.ServerError}
32
+ *
33
+ * @example
34
+ * await client.actions.createOrUpdate({
35
+ * actionId: {
36
+ * referenceId: "get-balance"
37
+ * },
38
+ * name: "Get the user's balance",
39
+ * description: "This action calls an API to get the user's current balance.",
40
+ * userInteractionRequired: false,
41
+ * userFormParameters: [],
42
+ * precondition: {
43
+ * preconditionType: "group",
44
+ * operator: MavenAGI.PreconditionGroupOperator.And,
45
+ * preconditions: [{
46
+ * preconditionType: "user",
47
+ * key: "userKey"
48
+ * }, {
49
+ * preconditionType: "user",
50
+ * key: "userKey2"
51
+ * }]
52
+ * }
53
+ * })
54
+ */
55
+ createOrUpdate(request, requestOptions) {
56
+ var _a, _b;
57
+ return __awaiter(this, void 0, void 0, function* () {
58
+ const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
59
+ url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "/v1/actions"),
60
+ method: "PUT",
61
+ headers: {
62
+ Authorization: yield this._getAuthorizationHeader(),
63
+ "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
64
+ "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
65
+ "X-Fern-Language": "JavaScript",
66
+ "X-Fern-SDK-Name": "mavenagi",
67
+ "X-Fern-SDK-Version": "0.0.0-alpha.20",
68
+ "X-Fern-Runtime": core.RUNTIME.type,
69
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
70
+ },
71
+ contentType: "application/json",
72
+ requestType: "json",
73
+ body: serializers.ActionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
74
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
75
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
76
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
77
+ });
78
+ if (_response.ok) {
79
+ return serializers.ActionResponse.parseOrThrow(_response.body, {
80
+ unrecognizedObjectKeys: "passthrough",
81
+ allowUnrecognizedUnionMembers: true,
82
+ allowUnrecognizedEnumValues: true,
83
+ breadcrumbsPrefix: ["response"],
84
+ });
85
+ }
86
+ if (_response.error.reason === "status-code") {
87
+ switch (_response.error.statusCode) {
88
+ case 404:
89
+ throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
90
+ unrecognizedObjectKeys: "passthrough",
91
+ allowUnrecognizedUnionMembers: true,
92
+ allowUnrecognizedEnumValues: true,
93
+ breadcrumbsPrefix: ["response"],
94
+ }));
95
+ case 400:
96
+ throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
97
+ unrecognizedObjectKeys: "passthrough",
98
+ allowUnrecognizedUnionMembers: true,
99
+ allowUnrecognizedEnumValues: true,
100
+ breadcrumbsPrefix: ["response"],
101
+ }));
102
+ case 500:
103
+ throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
104
+ unrecognizedObjectKeys: "passthrough",
105
+ allowUnrecognizedUnionMembers: true,
106
+ allowUnrecognizedEnumValues: true,
107
+ breadcrumbsPrefix: ["response"],
108
+ }));
109
+ default:
110
+ throw new errors.MavenAGIError({
111
+ statusCode: _response.error.statusCode,
112
+ body: _response.error.body,
113
+ });
114
+ }
115
+ }
116
+ switch (_response.error.reason) {
117
+ case "non-json":
118
+ throw new errors.MavenAGIError({
119
+ statusCode: _response.error.statusCode,
120
+ body: _response.error.rawBody,
121
+ });
122
+ case "timeout":
123
+ throw new errors.MavenAGITimeoutError();
124
+ case "unknown":
125
+ throw new errors.MavenAGIError({
126
+ message: _response.error.errorMessage,
127
+ });
128
+ }
129
+ });
130
+ }
131
+ /**
132
+ * Get an action by its supplied ID
133
+ *
134
+ * @param {string} actionReferenceId - The reference ID of the action to get. All other entity ID fields are inferred from the request.
135
+ * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
136
+ *
137
+ * @throws {@link MavenAGI.NotFoundError}
138
+ * @throws {@link MavenAGI.BadRequestError}
139
+ * @throws {@link MavenAGI.ServerError}
140
+ *
141
+ * @example
142
+ * await client.actions.get("get-balance")
143
+ */
144
+ get(actionReferenceId, requestOptions) {
145
+ var _a, _b;
146
+ return __awaiter(this, void 0, void 0, function* () {
147
+ const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
148
+ url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionReferenceId)}`),
149
+ method: "GET",
150
+ headers: {
151
+ Authorization: yield this._getAuthorizationHeader(),
152
+ "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
153
+ "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
154
+ "X-Fern-Language": "JavaScript",
155
+ "X-Fern-SDK-Name": "mavenagi",
156
+ "X-Fern-SDK-Version": "0.0.0-alpha.20",
157
+ "X-Fern-Runtime": core.RUNTIME.type,
158
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
159
+ },
160
+ contentType: "application/json",
161
+ requestType: "json",
162
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
163
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
164
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
165
+ });
166
+ if (_response.ok) {
167
+ return serializers.ActionResponse.parseOrThrow(_response.body, {
168
+ unrecognizedObjectKeys: "passthrough",
169
+ allowUnrecognizedUnionMembers: true,
170
+ allowUnrecognizedEnumValues: true,
171
+ breadcrumbsPrefix: ["response"],
172
+ });
173
+ }
174
+ if (_response.error.reason === "status-code") {
175
+ switch (_response.error.statusCode) {
176
+ case 404:
177
+ throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
178
+ unrecognizedObjectKeys: "passthrough",
179
+ allowUnrecognizedUnionMembers: true,
180
+ allowUnrecognizedEnumValues: true,
181
+ breadcrumbsPrefix: ["response"],
182
+ }));
183
+ case 400:
184
+ throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
185
+ unrecognizedObjectKeys: "passthrough",
186
+ allowUnrecognizedUnionMembers: true,
187
+ allowUnrecognizedEnumValues: true,
188
+ breadcrumbsPrefix: ["response"],
189
+ }));
190
+ case 500:
191
+ throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
192
+ unrecognizedObjectKeys: "passthrough",
193
+ allowUnrecognizedUnionMembers: true,
194
+ allowUnrecognizedEnumValues: true,
195
+ breadcrumbsPrefix: ["response"],
196
+ }));
197
+ default:
198
+ throw new errors.MavenAGIError({
199
+ statusCode: _response.error.statusCode,
200
+ body: _response.error.body,
201
+ });
202
+ }
203
+ }
204
+ switch (_response.error.reason) {
205
+ case "non-json":
206
+ throw new errors.MavenAGIError({
207
+ statusCode: _response.error.statusCode,
208
+ body: _response.error.rawBody,
209
+ });
210
+ case "timeout":
211
+ throw new errors.MavenAGITimeoutError();
212
+ case "unknown":
213
+ throw new errors.MavenAGIError({
214
+ message: _response.error.errorMessage,
215
+ });
216
+ }
217
+ });
218
+ }
219
+ /**
220
+ * Delete an action
221
+ *
222
+ * @param {string} actionReferenceId - The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
223
+ * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
224
+ *
225
+ * @throws {@link MavenAGI.NotFoundError}
226
+ * @throws {@link MavenAGI.BadRequestError}
227
+ * @throws {@link MavenAGI.ServerError}
228
+ *
229
+ * @example
230
+ * await client.actions.delete("get-balance")
231
+ */
232
+ delete(actionReferenceId, requestOptions) {
233
+ var _a, _b;
234
+ return __awaiter(this, void 0, void 0, function* () {
235
+ const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
236
+ url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionReferenceId)}`),
237
+ method: "DELETE",
238
+ headers: {
239
+ Authorization: yield this._getAuthorizationHeader(),
240
+ "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
241
+ "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
242
+ "X-Fern-Language": "JavaScript",
243
+ "X-Fern-SDK-Name": "mavenagi",
244
+ "X-Fern-SDK-Version": "0.0.0-alpha.20",
245
+ "X-Fern-Runtime": core.RUNTIME.type,
246
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
247
+ },
248
+ contentType: "application/json",
249
+ requestType: "json",
250
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
251
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
252
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
253
+ });
254
+ if (_response.ok) {
255
+ return;
256
+ }
257
+ if (_response.error.reason === "status-code") {
258
+ switch (_response.error.statusCode) {
259
+ case 404:
260
+ throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
261
+ unrecognizedObjectKeys: "passthrough",
262
+ allowUnrecognizedUnionMembers: true,
263
+ allowUnrecognizedEnumValues: true,
264
+ breadcrumbsPrefix: ["response"],
265
+ }));
266
+ case 400:
267
+ throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
268
+ unrecognizedObjectKeys: "passthrough",
269
+ allowUnrecognizedUnionMembers: true,
270
+ allowUnrecognizedEnumValues: true,
271
+ breadcrumbsPrefix: ["response"],
272
+ }));
273
+ case 500:
274
+ throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
275
+ unrecognizedObjectKeys: "passthrough",
276
+ allowUnrecognizedUnionMembers: true,
277
+ allowUnrecognizedEnumValues: true,
278
+ breadcrumbsPrefix: ["response"],
279
+ }));
280
+ default:
281
+ throw new errors.MavenAGIError({
282
+ statusCode: _response.error.statusCode,
283
+ body: _response.error.body,
284
+ });
285
+ }
286
+ }
287
+ switch (_response.error.reason) {
288
+ case "non-json":
289
+ throw new errors.MavenAGIError({
290
+ statusCode: _response.error.statusCode,
291
+ body: _response.error.rawBody,
292
+ });
293
+ case "timeout":
294
+ throw new errors.MavenAGITimeoutError();
295
+ case "unknown":
296
+ throw new errors.MavenAGIError({
297
+ message: _response.error.errorMessage,
298
+ });
299
+ }
300
+ });
301
+ }
302
+ _getAuthorizationHeader() {
303
+ var _a, _b;
304
+ return __awaiter(this, void 0, void 0, function* () {
305
+ const appId = (_a = (yield core.Supplier.get(this._options.appId))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["MAVENAGI_APP_ID"];
306
+ const appSecret = (_b = (yield core.Supplier.get(this._options.appSecret))) !== null && _b !== void 0 ? _b : process === null || process === void 0 ? void 0 : process.env["MAVENAGI_APP_SECRET"];
307
+ if (appId != null && appSecret != null) {
308
+ return core.BasicAuth.toAuthorizationHeader({
309
+ username: appId,
310
+ password: appSecret,
311
+ });
312
+ }
313
+ return undefined;
314
+ });
315
+ }
316
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,2 @@
1
+ export * from "./types";
2
+ export * from "./client";
@@ -0,0 +1,2 @@
1
+ export * from "./types";
2
+ export * from "./client";