mavenagi 0.0.0-alpha.7 → 0.0.0-alpha.9

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 (206) hide show
  1. package/README.md +3 -0
  2. package/api/resources/actions/client/Client.d.ts +12 -10
  3. package/api/resources/actions/client/Client.js +17 -15
  4. package/api/resources/actions/types/ActionBase.d.ts +7 -6
  5. package/api/resources/actions/types/ActionRequest.d.ts +5 -3
  6. package/api/resources/actions/types/ActionResponse.d.ts +5 -3
  7. package/api/resources/actions/types/Preconditions.d.ts +7 -0
  8. package/api/resources/actions/types/index.d.ts +1 -0
  9. package/api/resources/actions/types/index.js +1 -0
  10. package/api/resources/commons/types/AppUserIdentification.d.ts +2 -2
  11. package/api/resources/commons/types/{AppUserIdentifyingProperty.d.ts → AppUserIdentifier.d.ts} +1 -1
  12. package/api/resources/commons/types/AppUserRequest.d.ts +5 -0
  13. package/api/resources/commons/types/AppUserResponse.d.ts +5 -0
  14. package/api/resources/commons/types/index.d.ts +3 -1
  15. package/api/resources/commons/types/index.js +3 -1
  16. package/api/resources/conversation/client/Client.d.ts +5 -2
  17. package/api/resources/conversation/client/Client.js +15 -12
  18. package/api/resources/conversation/types/ConversationRequest.d.ts +2 -0
  19. package/api/resources/conversation/types/ConversationResponse.d.ts +2 -0
  20. package/api/resources/conversation/types/{ActionExecutionRequest.d.ts → SubmitActionFormRequest.d.ts} +1 -1
  21. package/api/resources/conversation/types/index.d.ts +1 -2
  22. package/api/resources/conversation/types/index.js +1 -2
  23. package/api/resources/knowledge/client/Client.d.ts +43 -52
  24. package/api/resources/knowledge/client/Client.js +60 -71
  25. package/api/resources/knowledge/types/BaseKnowledgeDocument.d.ts +2 -3
  26. package/{dist/api/resources/knowledge/types/KnowledgeBase.d.ts → api/resources/knowledge/types/KnowledgeBaseProperties.d.ts} +2 -2
  27. package/api/resources/knowledge/types/KnowledgeBaseRequest.d.ts +18 -0
  28. package/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +22 -0
  29. package/api/resources/knowledge/types/KnowledgeBaseVersion.d.ts +6 -2
  30. package/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +13 -0
  31. package/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +16 -0
  32. package/api/resources/knowledge/types/index.d.ts +4 -4
  33. package/api/resources/knowledge/types/index.js +4 -4
  34. package/api/resources/triggers/client/Client.d.ts +10 -10
  35. package/api/resources/triggers/client/Client.js +15 -15
  36. package/api/resources/triggers/types/EventTriggerRequest.d.ts +2 -2
  37. package/api/resources/triggers/types/EventTriggerResponse.d.ts +2 -2
  38. package/api/resources/users/client/Client.d.ts +4 -4
  39. package/api/resources/users/client/Client.js +7 -7
  40. package/dist/api/resources/actions/client/Client.d.ts +12 -10
  41. package/dist/api/resources/actions/client/Client.js +17 -15
  42. package/dist/api/resources/actions/types/ActionBase.d.ts +7 -6
  43. package/dist/api/resources/actions/types/ActionRequest.d.ts +5 -3
  44. package/dist/api/resources/actions/types/ActionResponse.d.ts +5 -3
  45. package/dist/api/resources/actions/types/Preconditions.d.ts +7 -0
  46. package/dist/api/resources/actions/types/index.d.ts +1 -0
  47. package/dist/api/resources/actions/types/index.js +1 -0
  48. package/dist/api/resources/commons/types/AppUserIdentification.d.ts +2 -2
  49. package/dist/api/resources/commons/types/{AppUserIdentifyingProperty.d.ts → AppUserIdentifier.d.ts} +1 -1
  50. package/dist/api/resources/commons/types/AppUserRequest.d.ts +5 -0
  51. package/dist/api/resources/commons/types/AppUserResponse.d.ts +5 -0
  52. package/dist/api/resources/commons/types/index.d.ts +3 -1
  53. package/dist/api/resources/commons/types/index.js +3 -1
  54. package/dist/api/resources/conversation/client/Client.d.ts +5 -2
  55. package/dist/api/resources/conversation/client/Client.js +15 -12
  56. package/dist/api/resources/conversation/types/ConversationRequest.d.ts +2 -0
  57. package/dist/api/resources/conversation/types/ConversationResponse.d.ts +2 -0
  58. package/dist/api/resources/conversation/types/{ActionExecutionRequest.d.ts → SubmitActionFormRequest.d.ts} +1 -1
  59. package/dist/api/resources/conversation/types/SubmitActionFormRequest.js +4 -0
  60. package/dist/api/resources/conversation/types/index.d.ts +1 -2
  61. package/dist/api/resources/conversation/types/index.js +1 -2
  62. package/dist/api/resources/knowledge/client/Client.d.ts +43 -52
  63. package/dist/api/resources/knowledge/client/Client.js +60 -71
  64. package/dist/api/resources/knowledge/types/BaseKnowledgeDocument.d.ts +2 -3
  65. package/{api/resources/knowledge/types/KnowledgeBase.d.ts → dist/api/resources/knowledge/types/KnowledgeBaseProperties.d.ts} +2 -2
  66. package/dist/api/resources/knowledge/types/KnowledgeBaseProperties.js +4 -0
  67. package/dist/api/resources/knowledge/types/KnowledgeBaseRequest.d.ts +18 -0
  68. package/dist/api/resources/knowledge/types/KnowledgeBaseRequest.js +4 -0
  69. package/dist/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +22 -0
  70. package/dist/api/resources/knowledge/types/KnowledgeBaseResponse.js +4 -0
  71. package/dist/api/resources/knowledge/types/KnowledgeBaseVersion.d.ts +6 -2
  72. package/dist/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +13 -0
  73. package/dist/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +16 -0
  74. package/dist/api/resources/knowledge/types/index.d.ts +4 -4
  75. package/dist/api/resources/knowledge/types/index.js +4 -4
  76. package/dist/api/resources/triggers/client/Client.d.ts +10 -10
  77. package/dist/api/resources/triggers/client/Client.js +15 -15
  78. package/dist/api/resources/triggers/types/EventTriggerRequest.d.ts +2 -2
  79. package/dist/api/resources/triggers/types/EventTriggerResponse.d.ts +2 -2
  80. package/dist/api/resources/users/client/Client.d.ts +4 -4
  81. package/dist/api/resources/users/client/Client.js +7 -7
  82. package/dist/serialization/resources/actions/types/ActionBase.d.ts +2 -1
  83. package/dist/serialization/resources/actions/types/ActionBase.js +2 -1
  84. package/dist/serialization/resources/actions/types/ActionRequest.d.ts +1 -1
  85. package/dist/serialization/resources/actions/types/ActionRequest.js +1 -1
  86. package/dist/serialization/resources/actions/types/ActionResponse.d.ts +1 -1
  87. package/dist/serialization/resources/actions/types/ActionResponse.js +1 -1
  88. package/{serialization/resources/knowledge/types/KnowledgeBaseId.d.ts → dist/serialization/resources/actions/types/Preconditions.d.ts} +3 -3
  89. package/dist/serialization/resources/actions/types/Preconditions.js +7 -0
  90. package/dist/serialization/resources/actions/types/index.d.ts +1 -0
  91. package/dist/serialization/resources/actions/types/index.js +1 -0
  92. package/dist/serialization/resources/commons/types/AppUserIdentification.d.ts +2 -2
  93. package/dist/serialization/resources/commons/types/AppUserIdentification.js +2 -2
  94. package/dist/serialization/resources/commons/types/{AppUserIdentifyingProperty.d.ts → AppUserIdentifier.d.ts} +2 -2
  95. package/{serialization/resources/commons/types/AppUserIdentifyingProperty.js → dist/serialization/resources/commons/types/AppUserIdentifier.js} +1 -1
  96. package/dist/serialization/resources/commons/types/AppUserRequest.d.ts +11 -0
  97. package/dist/serialization/resources/commons/types/AppUserRequest.js +5 -0
  98. package/dist/serialization/resources/commons/types/AppUserResponse.d.ts +11 -0
  99. package/dist/serialization/resources/commons/types/AppUserResponse.js +5 -0
  100. package/dist/serialization/resources/commons/types/index.d.ts +3 -1
  101. package/dist/serialization/resources/commons/types/index.js +3 -1
  102. package/dist/serialization/resources/conversation/types/ConversationRequest.d.ts +2 -0
  103. package/dist/serialization/resources/conversation/types/ConversationRequest.js +2 -0
  104. package/dist/serialization/resources/conversation/types/ConversationResponse.d.ts +2 -0
  105. package/dist/serialization/resources/conversation/types/ConversationResponse.js +2 -0
  106. package/{serialization/resources/conversation/types/ActionExecutionRequest.d.ts → dist/serialization/resources/conversation/types/SubmitActionFormRequest.d.ts} +2 -2
  107. package/{serialization/resources/conversation/types/ActionExecutionRequest.js → dist/serialization/resources/conversation/types/SubmitActionFormRequest.js} +1 -1
  108. package/dist/serialization/resources/conversation/types/index.d.ts +1 -2
  109. package/dist/serialization/resources/conversation/types/index.js +1 -2
  110. package/dist/serialization/resources/knowledge/types/BaseKnowledgeDocument.d.ts +3 -4
  111. package/dist/serialization/resources/knowledge/types/BaseKnowledgeDocument.js +4 -7
  112. package/{serialization/resources/knowledge/types/KnowledgeBase.d.ts → dist/serialization/resources/knowledge/types/KnowledgeBaseProperties.d.ts} +4 -5
  113. package/{serialization/resources/knowledge/types/KnowledgeBase.js → dist/serialization/resources/knowledge/types/KnowledgeBaseProperties.js} +3 -6
  114. package/dist/serialization/resources/knowledge/types/KnowledgeBaseRequest.d.ts +14 -0
  115. package/dist/serialization/resources/knowledge/types/KnowledgeBaseRequest.js +11 -0
  116. package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +14 -0
  117. package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +11 -0
  118. package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersion.d.ts +0 -1
  119. package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersion.js +0 -1
  120. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +3 -1
  121. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +3 -1
  122. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +2 -0
  123. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentResponse.js +2 -0
  124. package/dist/serialization/resources/knowledge/types/index.d.ts +4 -4
  125. package/dist/serialization/resources/knowledge/types/index.js +4 -4
  126. package/dist/serialization/resources/triggers/types/EventTriggerRequest.d.ts +1 -1
  127. package/dist/serialization/resources/triggers/types/EventTriggerRequest.js +1 -1
  128. package/dist/serialization/resources/triggers/types/EventTriggerResponse.d.ts +1 -1
  129. package/dist/serialization/resources/triggers/types/EventTriggerResponse.js +1 -1
  130. package/package.json +1 -1
  131. package/serialization/resources/actions/types/ActionBase.d.ts +2 -1
  132. package/serialization/resources/actions/types/ActionBase.js +2 -1
  133. package/serialization/resources/actions/types/ActionRequest.d.ts +1 -1
  134. package/serialization/resources/actions/types/ActionRequest.js +1 -1
  135. package/serialization/resources/actions/types/ActionResponse.d.ts +1 -1
  136. package/serialization/resources/actions/types/ActionResponse.js +1 -1
  137. package/{dist/serialization/resources/knowledge/types/KnowledgeBaseId.d.ts → serialization/resources/actions/types/Preconditions.d.ts} +3 -3
  138. package/serialization/resources/actions/types/Preconditions.js +7 -0
  139. package/serialization/resources/actions/types/index.d.ts +1 -0
  140. package/serialization/resources/actions/types/index.js +1 -0
  141. package/serialization/resources/commons/types/AppUserIdentification.d.ts +2 -2
  142. package/serialization/resources/commons/types/AppUserIdentification.js +2 -2
  143. package/serialization/resources/commons/types/{AppUserIdentifyingProperty.d.ts → AppUserIdentifier.d.ts} +2 -2
  144. package/{dist/serialization/resources/commons/types/AppUserIdentifyingProperty.js → serialization/resources/commons/types/AppUserIdentifier.js} +1 -1
  145. package/serialization/resources/commons/types/AppUserRequest.d.ts +11 -0
  146. package/serialization/resources/commons/types/AppUserRequest.js +5 -0
  147. package/serialization/resources/commons/types/AppUserResponse.d.ts +11 -0
  148. package/serialization/resources/commons/types/AppUserResponse.js +5 -0
  149. package/serialization/resources/commons/types/index.d.ts +3 -1
  150. package/serialization/resources/commons/types/index.js +3 -1
  151. package/serialization/resources/conversation/types/ConversationRequest.d.ts +2 -0
  152. package/serialization/resources/conversation/types/ConversationRequest.js +2 -0
  153. package/serialization/resources/conversation/types/ConversationResponse.d.ts +2 -0
  154. package/serialization/resources/conversation/types/ConversationResponse.js +2 -0
  155. package/{dist/serialization/resources/conversation/types/ActionExecutionRequest.d.ts → serialization/resources/conversation/types/SubmitActionFormRequest.d.ts} +2 -2
  156. package/{dist/serialization/resources/conversation/types/ActionExecutionRequest.js → serialization/resources/conversation/types/SubmitActionFormRequest.js} +1 -1
  157. package/serialization/resources/conversation/types/index.d.ts +1 -2
  158. package/serialization/resources/conversation/types/index.js +1 -2
  159. package/serialization/resources/knowledge/types/BaseKnowledgeDocument.d.ts +3 -4
  160. package/serialization/resources/knowledge/types/BaseKnowledgeDocument.js +4 -7
  161. package/{dist/serialization/resources/knowledge/types/KnowledgeBase.d.ts → serialization/resources/knowledge/types/KnowledgeBaseProperties.d.ts} +4 -5
  162. package/{dist/serialization/resources/knowledge/types/KnowledgeBase.js → serialization/resources/knowledge/types/KnowledgeBaseProperties.js} +3 -6
  163. package/serialization/resources/knowledge/types/KnowledgeBaseRequest.d.ts +14 -0
  164. package/serialization/resources/knowledge/types/KnowledgeBaseRequest.js +11 -0
  165. package/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +14 -0
  166. package/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +11 -0
  167. package/serialization/resources/knowledge/types/KnowledgeBaseVersion.d.ts +0 -1
  168. package/serialization/resources/knowledge/types/KnowledgeBaseVersion.js +0 -1
  169. package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +3 -1
  170. package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +3 -1
  171. package/serialization/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +2 -0
  172. package/serialization/resources/knowledge/types/KnowledgeDocumentResponse.js +2 -0
  173. package/serialization/resources/knowledge/types/index.d.ts +4 -4
  174. package/serialization/resources/knowledge/types/index.js +4 -4
  175. package/serialization/resources/triggers/types/EventTriggerRequest.d.ts +1 -1
  176. package/serialization/resources/triggers/types/EventTriggerRequest.js +1 -1
  177. package/serialization/resources/triggers/types/EventTriggerResponse.d.ts +1 -1
  178. package/serialization/resources/triggers/types/EventTriggerResponse.js +1 -1
  179. package/api/resources/conversation/types/ActionExecutionResponse.d.ts +0 -7
  180. package/api/resources/knowledge/types/KnowledgeBaseId.d.ts +0 -7
  181. package/api/resources/knowledge/types/KnowledgeDocumentId.d.ts +0 -9
  182. package/dist/api/resources/conversation/types/ActionExecutionResponse.d.ts +0 -7
  183. package/dist/api/resources/knowledge/types/KnowledgeBaseId.d.ts +0 -7
  184. package/dist/api/resources/knowledge/types/KnowledgeDocumentId.d.ts +0 -9
  185. package/dist/serialization/resources/conversation/types/ActionExecutionResponse.d.ts +0 -12
  186. package/dist/serialization/resources/conversation/types/ActionExecutionResponse.js +0 -7
  187. package/dist/serialization/resources/knowledge/types/KnowledgeBaseId.js +0 -7
  188. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentId.d.ts +0 -13
  189. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentId.js +0 -8
  190. package/serialization/resources/conversation/types/ActionExecutionResponse.d.ts +0 -12
  191. package/serialization/resources/conversation/types/ActionExecutionResponse.js +0 -7
  192. package/serialization/resources/knowledge/types/KnowledgeBaseId.js +0 -7
  193. package/serialization/resources/knowledge/types/KnowledgeDocumentId.d.ts +0 -13
  194. package/serialization/resources/knowledge/types/KnowledgeDocumentId.js +0 -8
  195. /package/api/resources/{commons/types/AppUserIdentifyingProperty.js → actions/types/Preconditions.js} +0 -0
  196. /package/api/resources/{conversation/types/ActionExecutionRequest.js → commons/types/AppUserIdentifier.js} +0 -0
  197. /package/api/resources/{conversation/types/ActionExecutionResponse.js → commons/types/AppUserRequest.js} +0 -0
  198. /package/api/resources/{knowledge/types/KnowledgeBase.js → commons/types/AppUserResponse.js} +0 -0
  199. /package/api/resources/{knowledge/types/KnowledgeBaseId.js → conversation/types/SubmitActionFormRequest.js} +0 -0
  200. /package/api/resources/knowledge/types/{KnowledgeDocumentId.js → KnowledgeBaseProperties.js} +0 -0
  201. /package/{dist/api/resources/commons/types/AppUserIdentifyingProperty.js → api/resources/knowledge/types/KnowledgeBaseRequest.js} +0 -0
  202. /package/{dist/api/resources/conversation/types/ActionExecutionRequest.js → api/resources/knowledge/types/KnowledgeBaseResponse.js} +0 -0
  203. /package/dist/api/resources/{conversation/types/ActionExecutionResponse.js → actions/types/Preconditions.js} +0 -0
  204. /package/dist/api/resources/{knowledge/types/KnowledgeBase.js → commons/types/AppUserIdentifier.js} +0 -0
  205. /package/dist/api/resources/{knowledge/types/KnowledgeBaseId.js → commons/types/AppUserRequest.js} +0 -0
  206. /package/dist/api/resources/{knowledge/types/KnowledgeDocumentId.js → commons/types/AppUserResponse.js} +0 -0
@@ -2,7 +2,23 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as MavenAGI from "../../../index";
5
+ /**
6
+ * @example
7
+ * {
8
+ * knowledgeDocumentId: {
9
+ * referenceId: "getting-started",
10
+ * appId: "readme",
11
+ * organizationId: "acme",
12
+ * agentId: "support",
13
+ * type: MavenAGI.EntityType.KnowledgeDocument
14
+ * },
15
+ * content: "## Getting started This is a getting started guide for the help center.",
16
+ * title: "Getting started"
17
+ * }
18
+ */
5
19
  export interface KnowledgeDocumentResponse extends MavenAGI.BaseKnowledgeDocument {
20
+ /** ID that uniquely identifies this knowledge document within its knowledge base */
21
+ knowledgeDocumentId: MavenAGI.EntityId;
6
22
  /** The content of the document in markdown format. Not shown directly to users. */
7
23
  content: string;
8
24
  }
@@ -1,10 +1,10 @@
1
- export * from "./KnowledgeBaseId";
2
- export * from "./KnowledgeBase";
1
+ export * from "./KnowledgeBaseProperties";
3
2
  export * from "./KnowledgeBaseType";
3
+ export * from "./KnowledgeBaseRequest";
4
+ export * from "./KnowledgeBaseResponse";
4
5
  export * from "./KnowledgeBaseVersion";
5
6
  export * from "./KnowledgeBaseVersionType";
6
- export * from "./KnowledgeDocumentId";
7
7
  export * from "./BaseKnowledgeDocument";
8
- export * from "./KnowledgeDocumentRequest";
9
8
  export * from "./KnowledgeDocumentContentType";
9
+ export * from "./KnowledgeDocumentRequest";
10
10
  export * from "./KnowledgeDocumentResponse";
@@ -1,10 +1,10 @@
1
- export * from "./KnowledgeBaseId";
2
- export * from "./KnowledgeBase";
1
+ export * from "./KnowledgeBaseProperties";
3
2
  export * from "./KnowledgeBaseType";
3
+ export * from "./KnowledgeBaseRequest";
4
+ export * from "./KnowledgeBaseResponse";
4
5
  export * from "./KnowledgeBaseVersion";
5
6
  export * from "./KnowledgeBaseVersionType";
6
- export * from "./KnowledgeDocumentId";
7
7
  export * from "./BaseKnowledgeDocument";
8
- export * from "./KnowledgeDocumentRequest";
9
8
  export * from "./KnowledgeDocumentContentType";
9
+ export * from "./KnowledgeDocumentRequest";
10
10
  export * from "./KnowledgeDocumentResponse";
@@ -33,19 +33,19 @@ export declare class Triggers {
33
33
  * @throws {@link MavenAGI.ServerError}
34
34
  *
35
35
  * @example
36
- * await client.triggers.registerTrigger({
37
- * entityId: {
36
+ * await client.triggers.createOrUpdate({
37
+ * triggerId: {
38
38
  * referenceId: "store-in-snowflake"
39
39
  * },
40
40
  * description: "Stores conversation data in Snowflake",
41
41
  * type: MavenAGI.EventTriggerType.ConversationCreated
42
42
  * })
43
43
  */
44
- registerTrigger(request: MavenAGI.EventTriggerRequest, requestOptions?: Triggers.RequestOptions): Promise<MavenAGI.EventTriggerResponse>;
44
+ createOrUpdate(request: MavenAGI.EventTriggerRequest, requestOptions?: Triggers.RequestOptions): Promise<MavenAGI.EventTriggerResponse>;
45
45
  /**
46
46
  * Get an event trigger by its supplied ID
47
47
  *
48
- * @param {string} referenceId - The reference ID of the event trigger to get. All other entity ID fields are inferred from the request.
48
+ * @param {string} triggerReferenceId - The reference ID of the event trigger to get. All other entity ID fields are inferred from the request.
49
49
  * @param {Triggers.RequestOptions} requestOptions - Request-specific configuration.
50
50
  *
51
51
  * @throws {@link MavenAGI.NotFoundError}
@@ -53,13 +53,13 @@ export declare class Triggers {
53
53
  * @throws {@link MavenAGI.ServerError}
54
54
  *
55
55
  * @example
56
- * await client.triggers.getTrigger("store-in-snowflake")
56
+ * await client.triggers.get("store-in-snowflake")
57
57
  */
58
- getTrigger(referenceId: string, requestOptions?: Triggers.RequestOptions): Promise<MavenAGI.EventTriggerResponse>;
58
+ get(triggerReferenceId: string, requestOptions?: Triggers.RequestOptions): Promise<MavenAGI.EventTriggerResponse>;
59
59
  /**
60
- * Unregister an event trigger
60
+ * Delete an event trigger
61
61
  *
62
- * @param {string} referenceId - The reference ID of the event trigger to unregister. All other entity ID fields are inferred from the request.
62
+ * @param {string} triggerReferenceId - The reference ID of the event trigger to delete. All other entity ID fields are inferred from the request.
63
63
  * @param {Triggers.RequestOptions} requestOptions - Request-specific configuration.
64
64
  *
65
65
  * @throws {@link MavenAGI.NotFoundError}
@@ -67,8 +67,8 @@ export declare class Triggers {
67
67
  * @throws {@link MavenAGI.ServerError}
68
68
  *
69
69
  * @example
70
- * await client.triggers.unregisterTrigger("store-in-snowflake")
70
+ * await client.triggers.delete("store-in-snowflake")
71
71
  */
72
- unregisterTrigger(referenceId: string, requestOptions?: Triggers.RequestOptions): Promise<void>;
72
+ delete(triggerReferenceId: string, requestOptions?: Triggers.RequestOptions): Promise<void>;
73
73
  protected _getAuthorizationHeader(): Promise<string | undefined>;
74
74
  }
@@ -31,15 +31,15 @@ export class Triggers {
31
31
  * @throws {@link MavenAGI.ServerError}
32
32
  *
33
33
  * @example
34
- * await client.triggers.registerTrigger({
35
- * entityId: {
34
+ * await client.triggers.createOrUpdate({
35
+ * triggerId: {
36
36
  * referenceId: "store-in-snowflake"
37
37
  * },
38
38
  * description: "Stores conversation data in Snowflake",
39
39
  * type: MavenAGI.EventTriggerType.ConversationCreated
40
40
  * })
41
41
  */
42
- registerTrigger(request, requestOptions) {
42
+ createOrUpdate(request, requestOptions) {
43
43
  var _a, _b;
44
44
  return __awaiter(this, void 0, void 0, function* () {
45
45
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -51,7 +51,7 @@ export class Triggers {
51
51
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
52
52
  "X-Fern-Language": "JavaScript",
53
53
  "X-Fern-SDK-Name": "mavenagi",
54
- "X-Fern-SDK-Version": "0.0.0-alpha.7",
54
+ "X-Fern-SDK-Version": "0.0.0-alpha.9",
55
55
  "X-Fern-Runtime": core.RUNTIME.type,
56
56
  "X-Fern-Runtime-Version": core.RUNTIME.version,
57
57
  },
@@ -117,7 +117,7 @@ export class Triggers {
117
117
  /**
118
118
  * Get an event trigger by its supplied ID
119
119
  *
120
- * @param {string} referenceId - The reference ID of the event trigger to get. All other entity ID fields are inferred from the request.
120
+ * @param {string} triggerReferenceId - The reference ID of the event trigger to get. All other entity ID fields are inferred from the request.
121
121
  * @param {Triggers.RequestOptions} requestOptions - Request-specific configuration.
122
122
  *
123
123
  * @throws {@link MavenAGI.NotFoundError}
@@ -125,13 +125,13 @@ export class Triggers {
125
125
  * @throws {@link MavenAGI.ServerError}
126
126
  *
127
127
  * @example
128
- * await client.triggers.getTrigger("store-in-snowflake")
128
+ * await client.triggers.get("store-in-snowflake")
129
129
  */
130
- getTrigger(referenceId, requestOptions) {
130
+ get(triggerReferenceId, requestOptions) {
131
131
  var _a, _b;
132
132
  return __awaiter(this, void 0, void 0, function* () {
133
133
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
134
- url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/triggers/${encodeURIComponent(referenceId)}`),
134
+ url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/triggers/${encodeURIComponent(triggerReferenceId)}`),
135
135
  method: "GET",
136
136
  headers: {
137
137
  Authorization: yield this._getAuthorizationHeader(),
@@ -139,7 +139,7 @@ export class Triggers {
139
139
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
140
140
  "X-Fern-Language": "JavaScript",
141
141
  "X-Fern-SDK-Name": "mavenagi",
142
- "X-Fern-SDK-Version": "0.0.0-alpha.7",
142
+ "X-Fern-SDK-Version": "0.0.0-alpha.9",
143
143
  "X-Fern-Runtime": core.RUNTIME.type,
144
144
  "X-Fern-Runtime-Version": core.RUNTIME.version,
145
145
  },
@@ -202,9 +202,9 @@ export class Triggers {
202
202
  });
203
203
  }
204
204
  /**
205
- * Unregister an event trigger
205
+ * Delete an event trigger
206
206
  *
207
- * @param {string} referenceId - The reference ID of the event trigger to unregister. All other entity ID fields are inferred from the request.
207
+ * @param {string} triggerReferenceId - The reference ID of the event trigger to delete. All other entity ID fields are inferred from the request.
208
208
  * @param {Triggers.RequestOptions} requestOptions - Request-specific configuration.
209
209
  *
210
210
  * @throws {@link MavenAGI.NotFoundError}
@@ -212,13 +212,13 @@ export class Triggers {
212
212
  * @throws {@link MavenAGI.ServerError}
213
213
  *
214
214
  * @example
215
- * await client.triggers.unregisterTrigger("store-in-snowflake")
215
+ * await client.triggers.delete("store-in-snowflake")
216
216
  */
217
- unregisterTrigger(referenceId, requestOptions) {
217
+ delete(triggerReferenceId, requestOptions) {
218
218
  var _a, _b;
219
219
  return __awaiter(this, void 0, void 0, function* () {
220
220
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
221
- url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/triggers/${encodeURIComponent(referenceId)}`),
221
+ url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/triggers/${encodeURIComponent(triggerReferenceId)}`),
222
222
  method: "DELETE",
223
223
  headers: {
224
224
  Authorization: yield this._getAuthorizationHeader(),
@@ -226,7 +226,7 @@ export class Triggers {
226
226
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
227
227
  "X-Fern-Language": "JavaScript",
228
228
  "X-Fern-SDK-Name": "mavenagi",
229
- "X-Fern-SDK-Version": "0.0.0-alpha.7",
229
+ "X-Fern-SDK-Version": "0.0.0-alpha.9",
230
230
  "X-Fern-Runtime": core.RUNTIME.type,
231
231
  "X-Fern-Runtime-Version": core.RUNTIME.version,
232
232
  },
@@ -5,7 +5,7 @@ import * as MavenAGI from "../../../index";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * entityId: {
8
+ * triggerId: {
9
9
  * referenceId: "store-in-snowflake"
10
10
  * },
11
11
  * description: "Stores conversation data in Snowflake",
@@ -14,5 +14,5 @@ import * as MavenAGI from "../../../index";
14
14
  */
15
15
  export interface EventTriggerRequest extends MavenAGI.EventTriggerBase {
16
16
  /** ID that uniquely identifies this event trigger */
17
- entityId: MavenAGI.EntityIdBase;
17
+ triggerId: MavenAGI.EntityIdBase;
18
18
  }
@@ -5,7 +5,7 @@ import * as MavenAGI from "../../../index";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * entityId: {
8
+ * triggerId: {
9
9
  * referenceId: "store-in-snowflake",
10
10
  * appId: "snowflake",
11
11
  * organizationId: "acme",
@@ -18,5 +18,5 @@ import * as MavenAGI from "../../../index";
18
18
  */
19
19
  export interface EventTriggerResponse extends MavenAGI.EventTriggerBase {
20
20
  /** ID that uniquely identifies this event trigger */
21
- entityId: MavenAGI.EntityId;
21
+ triggerId: MavenAGI.EntityId;
22
22
  }
@@ -25,7 +25,7 @@ export declare class Users {
25
25
  /**
26
26
  * Create a new user or update an existing one
27
27
  *
28
- * @param {MavenAGI.AppUser} request
28
+ * @param {MavenAGI.AppUserRequest} request
29
29
  * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
30
30
  *
31
31
  * @throws {@link MavenAGI.NotFoundError}
@@ -43,11 +43,11 @@ export declare class Users {
43
43
  * }
44
44
  * })
45
45
  */
46
- upsertAppUser(request: MavenAGI.AppUser, requestOptions?: Users.RequestOptions): Promise<MavenAGI.AppUser>;
46
+ upsertAppUser(request: MavenAGI.AppUserRequest, requestOptions?: Users.RequestOptions): Promise<MavenAGI.AppUserResponse>;
47
47
  /**
48
48
  * Get a user
49
49
  *
50
- * @param {string} userId - The ID of the user to get
50
+ * @param {string} userId - Externally supplied unique ID of the user
51
51
  * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
52
52
  *
53
53
  * @throws {@link MavenAGI.NotFoundError}
@@ -57,6 +57,6 @@ export declare class Users {
57
57
  * @example
58
58
  * await client.users.getAppUser("string")
59
59
  */
60
- getAppUser(userId: string, requestOptions?: Users.RequestOptions): Promise<MavenAGI.AppUser>;
60
+ getAppUser(userId: string, requestOptions?: Users.RequestOptions): Promise<MavenAGI.AppUserResponse>;
61
61
  protected _getAuthorizationHeader(): Promise<string | undefined>;
62
62
  }
@@ -23,7 +23,7 @@ export class Users {
23
23
  /**
24
24
  * Create a new user or update an existing one
25
25
  *
26
- * @param {MavenAGI.AppUser} request
26
+ * @param {MavenAGI.AppUserRequest} request
27
27
  * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
28
28
  *
29
29
  * @throws {@link MavenAGI.NotFoundError}
@@ -53,18 +53,18 @@ export class Users {
53
53
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
54
54
  "X-Fern-Language": "JavaScript",
55
55
  "X-Fern-SDK-Name": "mavenagi",
56
- "X-Fern-SDK-Version": "0.0.0-alpha.7",
56
+ "X-Fern-SDK-Version": "0.0.0-alpha.9",
57
57
  "X-Fern-Runtime": core.RUNTIME.type,
58
58
  "X-Fern-Runtime-Version": core.RUNTIME.version,
59
59
  },
60
60
  contentType: "application/json",
61
- body: yield serializers.AppUser.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
61
+ body: yield serializers.AppUserRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
62
62
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
63
63
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
64
64
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
65
65
  });
66
66
  if (_response.ok) {
67
- return yield serializers.AppUser.parseOrThrow(_response.body, {
67
+ return yield serializers.AppUserResponse.parseOrThrow(_response.body, {
68
68
  unrecognizedObjectKeys: "passthrough",
69
69
  allowUnrecognizedUnionMembers: true,
70
70
  allowUnrecognizedEnumValues: true,
@@ -119,7 +119,7 @@ export class Users {
119
119
  /**
120
120
  * Get a user
121
121
  *
122
- * @param {string} userId - The ID of the user to get
122
+ * @param {string} userId - Externally supplied unique ID of the user
123
123
  * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
124
124
  *
125
125
  * @throws {@link MavenAGI.NotFoundError}
@@ -141,7 +141,7 @@ export class Users {
141
141
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
142
142
  "X-Fern-Language": "JavaScript",
143
143
  "X-Fern-SDK-Name": "mavenagi",
144
- "X-Fern-SDK-Version": "0.0.0-alpha.7",
144
+ "X-Fern-SDK-Version": "0.0.0-alpha.9",
145
145
  "X-Fern-Runtime": core.RUNTIME.type,
146
146
  "X-Fern-Runtime-Version": core.RUNTIME.version,
147
147
  },
@@ -151,7 +151,7 @@ export class Users {
151
151
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
152
152
  });
153
153
  if (_response.ok) {
154
- return yield serializers.AppUser.parseOrThrow(_response.body, {
154
+ return yield serializers.AppUserResponse.parseOrThrow(_response.body, {
155
155
  unrecognizedObjectKeys: "passthrough",
156
156
  allowUnrecognizedUnionMembers: true,
157
157
  allowUnrecognizedEnumValues: true,
@@ -33,22 +33,24 @@ export declare class Actions {
33
33
  * @throws {@link MavenAGI.ServerError}
34
34
  *
35
35
  * @example
36
- * await client.actions.createOrUpdateAction({
37
- * entityId: {
36
+ * await client.actions.createOrUpdate({
37
+ * actionId: {
38
38
  * referenceId: "get-balance"
39
39
  * },
40
40
  * name: "Get the user's balance",
41
41
  * description: "This action calls an API to get the user's current balance.",
42
42
  * userInteractionRequired: false,
43
- * requiredUserContextFieldNames: new Set(["my-billing-system.userId"]),
43
+ * preconditions: {
44
+ * requiredUserContextFieldNames: new Set(["my-billing-system.userId"])
45
+ * },
44
46
  * userFormParameters: []
45
47
  * })
46
48
  */
47
- createOrUpdateAction(request: MavenAGI.ActionRequest, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
49
+ createOrUpdate(request: MavenAGI.ActionRequest, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
48
50
  /**
49
51
  * Get an action by its supplied ID
50
52
  *
51
- * @param {string} referenceId - The reference ID of the action to get. All other entity ID fields are inferred from the request.
53
+ * @param {string} actionReferenceId - The reference ID of the action to get. All other entity ID fields are inferred from the request.
52
54
  * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
53
55
  *
54
56
  * @throws {@link MavenAGI.NotFoundError}
@@ -56,13 +58,13 @@ export declare class Actions {
56
58
  * @throws {@link MavenAGI.ServerError}
57
59
  *
58
60
  * @example
59
- * await client.actions.getAction("get-balance")
61
+ * await client.actions.get("get-balance")
60
62
  */
61
- getAction(referenceId: string, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
63
+ get(actionReferenceId: string, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
62
64
  /**
63
65
  * Delete an action
64
66
  *
65
- * @param {string} referenceId - The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
67
+ * @param {string} actionReferenceId - The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
66
68
  * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
67
69
  *
68
70
  * @throws {@link MavenAGI.NotFoundError}
@@ -70,8 +72,8 @@ export declare class Actions {
70
72
  * @throws {@link MavenAGI.ServerError}
71
73
  *
72
74
  * @example
73
- * await client.actions.deleteAction("get-balance")
75
+ * await client.actions.delete("get-balance")
74
76
  */
75
- deleteAction(referenceId: string, requestOptions?: Actions.RequestOptions): Promise<void>;
77
+ delete(actionReferenceId: string, requestOptions?: Actions.RequestOptions): Promise<void>;
76
78
  protected _getAuthorizationHeader(): Promise<string | undefined>;
77
79
  }
@@ -31,18 +31,20 @@ export class Actions {
31
31
  * @throws {@link MavenAGI.ServerError}
32
32
  *
33
33
  * @example
34
- * await client.actions.createOrUpdateAction({
35
- * entityId: {
34
+ * await client.actions.createOrUpdate({
35
+ * actionId: {
36
36
  * referenceId: "get-balance"
37
37
  * },
38
38
  * name: "Get the user's balance",
39
39
  * description: "This action calls an API to get the user's current balance.",
40
40
  * userInteractionRequired: false,
41
- * requiredUserContextFieldNames: new Set(["my-billing-system.userId"]),
41
+ * preconditions: {
42
+ * requiredUserContextFieldNames: new Set(["my-billing-system.userId"])
43
+ * },
42
44
  * userFormParameters: []
43
45
  * })
44
46
  */
45
- createOrUpdateAction(request, requestOptions) {
47
+ createOrUpdate(request, requestOptions) {
46
48
  var _a, _b;
47
49
  return __awaiter(this, void 0, void 0, function* () {
48
50
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -54,7 +56,7 @@ export class Actions {
54
56
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
55
57
  "X-Fern-Language": "JavaScript",
56
58
  "X-Fern-SDK-Name": "mavenagi",
57
- "X-Fern-SDK-Version": "0.0.0-alpha.7",
59
+ "X-Fern-SDK-Version": "0.0.0-alpha.9",
58
60
  "X-Fern-Runtime": core.RUNTIME.type,
59
61
  "X-Fern-Runtime-Version": core.RUNTIME.version,
60
62
  },
@@ -120,7 +122,7 @@ export class Actions {
120
122
  /**
121
123
  * Get an action by its supplied ID
122
124
  *
123
- * @param {string} referenceId - The reference ID of the action to get. All other entity ID fields are inferred from the request.
125
+ * @param {string} actionReferenceId - The reference ID of the action to get. All other entity ID fields are inferred from the request.
124
126
  * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
125
127
  *
126
128
  * @throws {@link MavenAGI.NotFoundError}
@@ -128,13 +130,13 @@ export class Actions {
128
130
  * @throws {@link MavenAGI.ServerError}
129
131
  *
130
132
  * @example
131
- * await client.actions.getAction("get-balance")
133
+ * await client.actions.get("get-balance")
132
134
  */
133
- getAction(referenceId, requestOptions) {
135
+ get(actionReferenceId, requestOptions) {
134
136
  var _a, _b;
135
137
  return __awaiter(this, void 0, void 0, function* () {
136
138
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
137
- url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(referenceId)}`),
139
+ url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionReferenceId)}`),
138
140
  method: "GET",
139
141
  headers: {
140
142
  Authorization: yield this._getAuthorizationHeader(),
@@ -142,7 +144,7 @@ export class Actions {
142
144
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
143
145
  "X-Fern-Language": "JavaScript",
144
146
  "X-Fern-SDK-Name": "mavenagi",
145
- "X-Fern-SDK-Version": "0.0.0-alpha.7",
147
+ "X-Fern-SDK-Version": "0.0.0-alpha.9",
146
148
  "X-Fern-Runtime": core.RUNTIME.type,
147
149
  "X-Fern-Runtime-Version": core.RUNTIME.version,
148
150
  },
@@ -207,7 +209,7 @@ export class Actions {
207
209
  /**
208
210
  * Delete an action
209
211
  *
210
- * @param {string} referenceId - The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
212
+ * @param {string} actionReferenceId - The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
211
213
  * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
212
214
  *
213
215
  * @throws {@link MavenAGI.NotFoundError}
@@ -215,13 +217,13 @@ export class Actions {
215
217
  * @throws {@link MavenAGI.ServerError}
216
218
  *
217
219
  * @example
218
- * await client.actions.deleteAction("get-balance")
220
+ * await client.actions.delete("get-balance")
219
221
  */
220
- deleteAction(referenceId, requestOptions) {
222
+ delete(actionReferenceId, requestOptions) {
221
223
  var _a, _b;
222
224
  return __awaiter(this, void 0, void 0, function* () {
223
225
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
224
- url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(referenceId)}`),
226
+ url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionReferenceId)}`),
225
227
  method: "DELETE",
226
228
  headers: {
227
229
  Authorization: yield this._getAuthorizationHeader(),
@@ -229,7 +231,7 @@ export class Actions {
229
231
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
230
232
  "X-Fern-Language": "JavaScript",
231
233
  "X-Fern-SDK-Name": "mavenagi",
232
- "X-Fern-SDK-Version": "0.0.0-alpha.7",
234
+ "X-Fern-SDK-Version": "0.0.0-alpha.9",
233
235
  "X-Fern-Runtime": core.RUNTIME.type,
234
236
  "X-Fern-Runtime-Version": core.RUNTIME.version,
235
237
  },
@@ -3,15 +3,16 @@
3
3
  */
4
4
  import * as MavenAGI from "../../../index";
5
5
  export interface ActionBase {
6
- /** The name of the action */
6
+ /** The name of the action. This is displayed to the end user as part of forms when user interaction is required. It is also used to help Maven decide if the action is relevant to a conversation. */
7
7
  name: string;
8
- /** The description of the action. This helps Maven decide when to trigger the action and is not displayed directly to the end user. */
8
+ /** The description of the action. This helps Maven decide if the action is relevant to a conversation and is not displayed directly to the end user. */
9
9
  description: string;
10
- /** Whether the action requires user interaction to execute */
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 execute 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 */
13
13
  buttonName?: string;
14
- /** The names of the user context fields required by the action */
15
- requiredUserContextFieldNames: Set<string>;
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
+ preconditions: MavenAGI.Preconditions;
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. */
16
17
  userFormParameters: MavenAGI.ActionParameter[];
17
18
  }
@@ -5,17 +5,19 @@ import * as MavenAGI from "../../../index";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * entityId: {
8
+ * actionId: {
9
9
  * referenceId: "get-balance"
10
10
  * },
11
11
  * name: "Get the user's balance",
12
12
  * description: "This action calls an API to get the user's current balance.",
13
13
  * userInteractionRequired: false,
14
- * requiredUserContextFieldNames: new Set(["my-billing-system.userId"]),
14
+ * preconditions: {
15
+ * requiredUserContextFieldNames: new Set(["my-billing-system.userId"])
16
+ * },
15
17
  * userFormParameters: []
16
18
  * }
17
19
  */
18
20
  export interface ActionRequest extends MavenAGI.ActionBase {
19
21
  /** ID that uniquely identifies this action */
20
- entityId: MavenAGI.EntityIdBase;
22
+ actionId: MavenAGI.EntityIdBase;
21
23
  }
@@ -5,7 +5,7 @@ import * as MavenAGI from "../../../index";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * entityId: {
8
+ * actionId: {
9
9
  * referenceId: "get-balance",
10
10
  * appId: "my-billing-system",
11
11
  * organizationId: "acme",
@@ -15,11 +15,13 @@ import * as MavenAGI from "../../../index";
15
15
  * name: "Get the user's balance",
16
16
  * description: "This action calls an API to get the user's current balance.",
17
17
  * userInteractionRequired: false,
18
- * requiredUserContextFieldNames: new Set(["my-billing-system.userId"]),
18
+ * preconditions: {
19
+ * requiredUserContextFieldNames: new Set(["my-billing-system.userId"])
20
+ * },
19
21
  * userFormParameters: []
20
22
  * }
21
23
  */
22
24
  export interface ActionResponse extends MavenAGI.ActionBase {
23
25
  /** ID that uniquely identifies this action */
24
- entityId: MavenAGI.EntityId;
26
+ actionId: MavenAGI.EntityId;
25
27
  }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface Preconditions {
5
+ /** The names of the user context fields that must be present in order for this object to be considered relevant to a conversation. */
6
+ requiredUserContextFieldNames: Set<string>;
7
+ }
@@ -1,3 +1,4 @@
1
+ export * from "./Preconditions";
1
2
  export * from "./ActionBase";
2
3
  export * from "./ActionParameter";
3
4
  export * from "./ActionRequest";
@@ -1,3 +1,4 @@
1
+ export * from "./Preconditions";
1
2
  export * from "./ActionBase";
2
3
  export * from "./ActionParameter";
3
4
  export * from "./ActionRequest";
@@ -3,6 +3,6 @@
3
3
  */
4
4
  import * as MavenAGI from "../../../index";
5
5
  export interface AppUserIdentification {
6
- /** At least one identifying property must be provided. etc */
7
- identifiers: MavenAGI.AppUserIdentifyingProperty[];
6
+ /** At least one identifying property must be provided */
7
+ identifiers: MavenAGI.AppUserIdentifier[];
8
8
  }
@@ -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 AppUserIdentifyingProperty {
5
+ export interface AppUserIdentifier {
6
6
  /** The identifying property text */
7
7
  value: string;
8
8
  userIdentifyingPropertyType: MavenAGI.AppUserIdentifyingPropertyType;
@@ -0,0 +1,5 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as MavenAGI from "../../../index";
5
+ export declare type AppUserRequest = MavenAGI.AppUser;
@@ -0,0 +1,5 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as MavenAGI from "../../../index";
5
+ export declare type AppUserResponse = MavenAGI.AppUser;
@@ -6,6 +6,8 @@ export * from "./User";
6
6
  export * from "./FeedbackType";
7
7
  export * from "./Feedback";
8
8
  export * from "./AppUserIdentification";
9
- export * from "./AppUserIdentifyingProperty";
9
+ export * from "./AppUserIdentifier";
10
10
  export * from "./AppUserIdentifyingPropertyType";
11
11
  export * from "./AppUser";
12
+ export * from "./AppUserRequest";
13
+ export * from "./AppUserResponse";