mavenagi 0.0.0-alpha.12 → 0.0.0-alpha.14

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 (179) hide show
  1. package/README.md +8 -1
  2. package/api/resources/actions/client/Client.js +3 -3
  3. package/api/resources/commons/types/AppUser.d.ts +3 -2
  4. package/api/resources/commons/types/AppUserIdentifier.d.ts +1 -1
  5. package/api/resources/commons/types/AppUserRequest.d.ts +19 -1
  6. package/api/resources/commons/types/AppUserResponse.d.ts +34 -2
  7. package/api/resources/commons/types/Feedback.d.ts +12 -0
  8. package/api/resources/commons/types/UserData.d.ts +1 -1
  9. package/api/resources/commons/types/index.d.ts +4 -2
  10. package/api/resources/commons/types/index.js +4 -2
  11. package/api/resources/conversation/client/Client.d.ts +21 -19
  12. package/api/resources/conversation/client/Client.js +35 -28
  13. package/api/resources/conversation/types/AskRequest.d.ts +2 -4
  14. package/api/resources/conversation/types/ConversationBase.d.ts +12 -0
  15. package/api/resources/conversation/types/ConversationMessageBase.d.ts +4 -3
  16. package/api/resources/conversation/types/ConversationRequest.d.ts +0 -2
  17. package/api/resources/conversation/types/ConversationResponse.d.ts +0 -2
  18. package/api/resources/conversation/types/SubmitActionFormRequest.d.ts +1 -3
  19. package/api/resources/conversation/types/UserMessageBase.d.ts +2 -0
  20. package/api/resources/conversation/types/index.d.ts +0 -2
  21. package/api/resources/conversation/types/index.js +0 -2
  22. package/api/resources/knowledge/client/Client.js +7 -7
  23. package/api/resources/triggers/client/Client.js +3 -3
  24. package/api/resources/triggers/types/index.d.ts +0 -3
  25. package/api/resources/triggers/types/index.js +0 -3
  26. package/api/resources/users/client/Client.d.ts +18 -14
  27. package/api/resources/users/client/Client.js +21 -17
  28. package/dist/api/resources/actions/client/Client.js +3 -3
  29. package/dist/api/resources/commons/types/AppUser.d.ts +3 -2
  30. package/dist/api/resources/commons/types/AppUserIdentifier.d.ts +1 -1
  31. package/dist/api/resources/commons/types/AppUserRequest.d.ts +19 -1
  32. package/dist/api/resources/commons/types/AppUserResponse.d.ts +34 -2
  33. package/dist/api/resources/commons/types/Feedback.d.ts +12 -0
  34. package/dist/api/resources/commons/types/UserData.d.ts +1 -1
  35. package/dist/api/resources/commons/types/index.d.ts +4 -2
  36. package/dist/api/resources/commons/types/index.js +4 -2
  37. package/dist/api/resources/conversation/client/Client.d.ts +21 -19
  38. package/dist/api/resources/conversation/client/Client.js +35 -28
  39. package/dist/api/resources/conversation/types/AskRequest.d.ts +2 -4
  40. package/dist/api/resources/conversation/types/ConversationBase.d.ts +12 -0
  41. package/dist/api/resources/conversation/types/ConversationMessageBase.d.ts +4 -3
  42. package/dist/api/resources/conversation/types/ConversationRequest.d.ts +0 -2
  43. package/dist/api/resources/conversation/types/ConversationResponse.d.ts +0 -2
  44. package/dist/api/resources/conversation/types/SubmitActionFormRequest.d.ts +1 -3
  45. package/dist/api/resources/conversation/types/UserMessageBase.d.ts +2 -0
  46. package/dist/api/resources/conversation/types/index.d.ts +0 -2
  47. package/dist/api/resources/conversation/types/index.js +0 -2
  48. package/dist/api/resources/knowledge/client/Client.js +7 -7
  49. package/dist/api/resources/triggers/client/Client.js +3 -3
  50. package/dist/api/resources/triggers/types/index.d.ts +0 -3
  51. package/dist/api/resources/triggers/types/index.js +0 -3
  52. package/dist/api/resources/users/client/Client.d.ts +18 -14
  53. package/dist/api/resources/users/client/Client.js +21 -17
  54. package/dist/serialization/resources/commons/types/AppUser.d.ts +3 -3
  55. package/dist/serialization/resources/commons/types/AppUser.js +3 -3
  56. package/dist/serialization/resources/commons/types/AppUserIdentifier.d.ts +1 -1
  57. package/dist/serialization/resources/commons/types/AppUserIdentifier.js +1 -1
  58. package/dist/serialization/resources/commons/types/AppUserRequest.d.ts +1 -1
  59. package/dist/serialization/resources/commons/types/AppUserRequest.js +1 -1
  60. package/dist/serialization/resources/commons/types/AppUserResponse.d.ts +2 -1
  61. package/dist/serialization/resources/commons/types/AppUserResponse.js +2 -1
  62. package/{serialization/resources/triggers → dist/serialization/resources/commons}/types/EventTriggerResponse.d.ts +1 -1
  63. package/{serialization/resources/triggers → dist/serialization/resources/commons}/types/EventTriggerResponse.js +1 -1
  64. package/dist/serialization/resources/commons/types/Feedback.d.ts +16 -0
  65. package/dist/serialization/resources/commons/types/Feedback.js +13 -0
  66. package/dist/serialization/resources/commons/types/UserData.d.ts +1 -1
  67. package/dist/serialization/resources/commons/types/UserData.js +1 -1
  68. package/dist/serialization/resources/commons/types/index.d.ts +4 -2
  69. package/dist/serialization/resources/commons/types/index.js +4 -2
  70. package/dist/serialization/resources/conversation/types/AskRequest.d.ts +1 -4
  71. package/dist/serialization/resources/conversation/types/AskRequest.js +1 -4
  72. package/dist/serialization/resources/conversation/types/ConversationBase.d.ts +6 -0
  73. package/dist/serialization/resources/conversation/types/ConversationBase.js +6 -0
  74. package/dist/serialization/resources/conversation/types/ConversationMessageBase.d.ts +2 -2
  75. package/dist/serialization/resources/conversation/types/ConversationMessageBase.js +2 -2
  76. package/dist/serialization/resources/conversation/types/ConversationRequest.d.ts +0 -2
  77. package/dist/serialization/resources/conversation/types/ConversationRequest.js +0 -2
  78. package/dist/serialization/resources/conversation/types/ConversationResponse.d.ts +0 -2
  79. package/dist/serialization/resources/conversation/types/ConversationResponse.js +0 -2
  80. package/dist/serialization/resources/conversation/types/SubmitActionFormRequest.d.ts +0 -2
  81. package/dist/serialization/resources/conversation/types/SubmitActionFormRequest.js +0 -2
  82. package/dist/serialization/resources/conversation/types/UserMessageBase.d.ts +2 -0
  83. package/dist/serialization/resources/conversation/types/UserMessageBase.js +2 -0
  84. package/dist/serialization/resources/conversation/types/index.d.ts +0 -2
  85. package/dist/serialization/resources/conversation/types/index.js +0 -2
  86. package/dist/serialization/resources/triggers/types/EventTriggerRequest.d.ts +1 -1
  87. package/dist/serialization/resources/triggers/types/EventTriggerRequest.js +1 -1
  88. package/dist/serialization/resources/triggers/types/index.d.ts +0 -3
  89. package/dist/serialization/resources/triggers/types/index.js +0 -3
  90. package/package.json +1 -1
  91. package/reference.md +43 -34
  92. package/serialization/resources/commons/types/AppUser.d.ts +3 -3
  93. package/serialization/resources/commons/types/AppUser.js +3 -3
  94. package/serialization/resources/commons/types/AppUserIdentifier.d.ts +1 -1
  95. package/serialization/resources/commons/types/AppUserIdentifier.js +1 -1
  96. package/serialization/resources/commons/types/AppUserRequest.d.ts +1 -1
  97. package/serialization/resources/commons/types/AppUserRequest.js +1 -1
  98. package/serialization/resources/commons/types/AppUserResponse.d.ts +2 -1
  99. package/serialization/resources/commons/types/AppUserResponse.js +2 -1
  100. package/{dist/serialization/resources/triggers → serialization/resources/commons}/types/EventTriggerResponse.d.ts +1 -1
  101. package/{dist/serialization/resources/triggers → serialization/resources/commons}/types/EventTriggerResponse.js +1 -1
  102. package/serialization/resources/commons/types/Feedback.d.ts +16 -0
  103. package/serialization/resources/commons/types/Feedback.js +13 -0
  104. package/serialization/resources/commons/types/UserData.d.ts +1 -1
  105. package/serialization/resources/commons/types/UserData.js +1 -1
  106. package/serialization/resources/commons/types/index.d.ts +4 -2
  107. package/serialization/resources/commons/types/index.js +4 -2
  108. package/serialization/resources/conversation/types/AskRequest.d.ts +1 -4
  109. package/serialization/resources/conversation/types/AskRequest.js +1 -4
  110. package/serialization/resources/conversation/types/ConversationBase.d.ts +6 -0
  111. package/serialization/resources/conversation/types/ConversationBase.js +6 -0
  112. package/serialization/resources/conversation/types/ConversationMessageBase.d.ts +2 -2
  113. package/serialization/resources/conversation/types/ConversationMessageBase.js +2 -2
  114. package/serialization/resources/conversation/types/ConversationRequest.d.ts +0 -2
  115. package/serialization/resources/conversation/types/ConversationRequest.js +0 -2
  116. package/serialization/resources/conversation/types/ConversationResponse.d.ts +0 -2
  117. package/serialization/resources/conversation/types/ConversationResponse.js +0 -2
  118. package/serialization/resources/conversation/types/SubmitActionFormRequest.d.ts +0 -2
  119. package/serialization/resources/conversation/types/SubmitActionFormRequest.js +0 -2
  120. package/serialization/resources/conversation/types/UserMessageBase.d.ts +2 -0
  121. package/serialization/resources/conversation/types/UserMessageBase.js +2 -0
  122. package/serialization/resources/conversation/types/index.d.ts +0 -2
  123. package/serialization/resources/conversation/types/index.js +0 -2
  124. package/serialization/resources/triggers/types/EventTriggerRequest.d.ts +1 -1
  125. package/serialization/resources/triggers/types/EventTriggerRequest.js +1 -1
  126. package/serialization/resources/triggers/types/index.d.ts +0 -3
  127. package/serialization/resources/triggers/types/index.js +0 -3
  128. package/api/resources/commons/types/AppUserIdentification.d.ts +0 -8
  129. package/api/resources/commons/types/User.d.ts +0 -10
  130. package/api/resources/conversation/types/ConversationContext.d.ts +0 -20
  131. package/api/resources/conversation/types/ConversationContext.js +0 -4
  132. package/api/resources/conversation/types/ConversationMessageContext.d.ts +0 -12
  133. package/api/resources/conversation/types/ConversationMessageContext.js +0 -4
  134. package/dist/api/resources/commons/types/AppUserIdentification.d.ts +0 -8
  135. package/dist/api/resources/commons/types/AppUserIdentification.js +0 -4
  136. package/dist/api/resources/commons/types/User.d.ts +0 -10
  137. package/dist/api/resources/commons/types/User.js +0 -4
  138. package/dist/api/resources/conversation/types/ConversationContext.d.ts +0 -20
  139. package/dist/api/resources/conversation/types/ConversationContext.js +0 -4
  140. package/dist/api/resources/conversation/types/ConversationMessageContext.d.ts +0 -12
  141. package/dist/api/resources/conversation/types/ConversationMessageContext.js +0 -4
  142. package/dist/serialization/resources/commons/types/AppUserIdentification.d.ts +0 -13
  143. package/dist/serialization/resources/commons/types/AppUserIdentification.js +0 -8
  144. package/dist/serialization/resources/commons/types/User.d.ts +0 -15
  145. package/dist/serialization/resources/commons/types/User.js +0 -10
  146. package/dist/serialization/resources/conversation/types/ConversationContext.d.ts +0 -20
  147. package/dist/serialization/resources/conversation/types/ConversationContext.js +0 -15
  148. package/dist/serialization/resources/conversation/types/ConversationMessageContext.d.ts +0 -16
  149. package/dist/serialization/resources/conversation/types/ConversationMessageContext.js +0 -11
  150. package/serialization/resources/commons/types/AppUserIdentification.d.ts +0 -13
  151. package/serialization/resources/commons/types/AppUserIdentification.js +0 -8
  152. package/serialization/resources/commons/types/User.d.ts +0 -15
  153. package/serialization/resources/commons/types/User.js +0 -10
  154. package/serialization/resources/conversation/types/ConversationContext.d.ts +0 -20
  155. package/serialization/resources/conversation/types/ConversationContext.js +0 -15
  156. package/serialization/resources/conversation/types/ConversationMessageContext.d.ts +0 -16
  157. package/serialization/resources/conversation/types/ConversationMessageContext.js +0 -11
  158. /package/api/resources/{triggers → commons}/types/EventTriggerBase.d.ts +0 -0
  159. /package/api/resources/{triggers → commons}/types/EventTriggerBase.js +0 -0
  160. /package/api/resources/{triggers → commons}/types/EventTriggerResponse.d.ts +0 -0
  161. /package/api/resources/{triggers → commons}/types/EventTriggerResponse.js +0 -0
  162. /package/api/resources/{triggers → commons}/types/EventTriggerType.d.ts +0 -0
  163. /package/api/resources/{triggers → commons}/types/EventTriggerType.js +0 -0
  164. /package/api/resources/commons/types/{AppUserIdentification.js → Feedback.js} +0 -0
  165. /package/dist/api/resources/{triggers → commons}/types/EventTriggerBase.d.ts +0 -0
  166. /package/dist/api/resources/{triggers → commons}/types/EventTriggerBase.js +0 -0
  167. /package/dist/api/resources/{triggers → commons}/types/EventTriggerResponse.d.ts +0 -0
  168. /package/dist/api/resources/{triggers → commons}/types/EventTriggerResponse.js +0 -0
  169. /package/dist/api/resources/{triggers → commons}/types/EventTriggerType.d.ts +0 -0
  170. /package/dist/api/resources/{triggers → commons}/types/EventTriggerType.js +0 -0
  171. /package/{api/resources/commons/types/User.js → dist/api/resources/commons/types/Feedback.js} +0 -0
  172. /package/dist/serialization/resources/{triggers → commons}/types/EventTriggerBase.d.ts +0 -0
  173. /package/dist/serialization/resources/{triggers → commons}/types/EventTriggerBase.js +0 -0
  174. /package/dist/serialization/resources/{triggers → commons}/types/EventTriggerType.d.ts +0 -0
  175. /package/dist/serialization/resources/{triggers → commons}/types/EventTriggerType.js +0 -0
  176. /package/serialization/resources/{triggers → commons}/types/EventTriggerBase.d.ts +0 -0
  177. /package/serialization/resources/{triggers → commons}/types/EventTriggerBase.js +0 -0
  178. /package/serialization/resources/{triggers → commons}/types/EventTriggerType.d.ts +0 -0
  179. /package/serialization/resources/{triggers → commons}/types/EventTriggerType.js +0 -0
@@ -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.12",
54
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
55
55
  "X-Fern-Runtime": core.RUNTIME.type,
56
56
  "X-Fern-Runtime-Version": core.RUNTIME.version,
57
57
  },
@@ -140,7 +140,7 @@ export class Triggers {
140
140
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
141
141
  "X-Fern-Language": "JavaScript",
142
142
  "X-Fern-SDK-Name": "mavenagi",
143
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
143
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
144
144
  "X-Fern-Runtime": core.RUNTIME.type,
145
145
  "X-Fern-Runtime-Version": core.RUNTIME.version,
146
146
  },
@@ -228,7 +228,7 @@ export class Triggers {
228
228
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
229
229
  "X-Fern-Language": "JavaScript",
230
230
  "X-Fern-SDK-Name": "mavenagi",
231
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
231
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
232
232
  "X-Fern-Runtime": core.RUNTIME.type,
233
233
  "X-Fern-Runtime-Version": core.RUNTIME.version,
234
234
  },
@@ -1,4 +1 @@
1
- export * from "./EventTriggerBase";
2
1
  export * from "./EventTriggerRequest";
3
- export * from "./EventTriggerResponse";
4
- export * from "./EventTriggerType";
@@ -1,4 +1 @@
1
- export * from "./EventTriggerBase";
2
1
  export * from "./EventTriggerRequest";
3
- export * from "./EventTriggerResponse";
4
- export * from "./EventTriggerType";
@@ -32,7 +32,7 @@ export declare class Users {
32
32
  protected readonly _options: Users.Options;
33
33
  constructor(_options: Users.Options);
34
34
  /**
35
- * Create a new user or update an existing one
35
+ * Update a user or create it if it doesn't exist.
36
36
  *
37
37
  * @param {MavenAGI.AppUserRequest} request
38
38
  * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
@@ -42,23 +42,27 @@ export declare class Users {
42
42
  * @throws {@link MavenAGI.ServerError}
43
43
  *
44
44
  * @example
45
- * await client.users.upsertAppUser({
46
- * appUserId: {
47
- * referenceId: "string"
45
+ * await client.users.createOrUpdate({
46
+ * userId: {
47
+ * referenceId: "user-0"
48
48
  * },
49
- * userIdentifiers: {
50
- * identifiers: new Set([{}])
51
- * },
52
- * metadata: {
53
- * "string": {}
49
+ * identifiers: new Set([{
50
+ * value: "joe@myapp.com",
51
+ * type: MavenAGI.AppUserIdentifyingPropertyType.Email
52
+ * }]),
53
+ * data: {
54
+ * "name": {
55
+ * value: "Joe",
56
+ * visibility: MavenAGI.VisibilityType.Visible
57
+ * }
54
58
  * }
55
59
  * })
56
60
  */
57
- upsertAppUser(request: MavenAGI.AppUserRequest, requestOptions?: Users.RequestOptions): Promise<MavenAGI.AppUserResponse>;
61
+ createOrUpdate(request: MavenAGI.AppUserRequest, requestOptions?: Users.RequestOptions): Promise<MavenAGI.AppUserResponse>;
58
62
  /**
59
- * Get a user
63
+ * Get a user by its supplied ID
60
64
  *
61
- * @param {string} userId - Externally supplied unique ID of the user
65
+ * @param {string} userId - The reference ID of the user to get. All other entity ID fields are inferred from the request.
62
66
  * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
63
67
  *
64
68
  * @throws {@link MavenAGI.NotFoundError}
@@ -66,8 +70,8 @@ export declare class Users {
66
70
  * @throws {@link MavenAGI.ServerError}
67
71
  *
68
72
  * @example
69
- * await client.users.getAppUser("string")
73
+ * await client.users.get("user-0")
70
74
  */
71
- getAppUser(userId: string, requestOptions?: Users.RequestOptions): Promise<MavenAGI.AppUserResponse>;
75
+ get(userId: string, requestOptions?: Users.RequestOptions): Promise<MavenAGI.AppUserResponse>;
72
76
  protected _getAuthorizationHeader(): Promise<string | undefined>;
73
77
  }
@@ -21,7 +21,7 @@ export class Users {
21
21
  this._options = _options;
22
22
  }
23
23
  /**
24
- * Create a new user or update an existing one
24
+ * Update a user or create it if it doesn't exist.
25
25
  *
26
26
  * @param {MavenAGI.AppUserRequest} request
27
27
  * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
@@ -31,19 +31,23 @@ export class Users {
31
31
  * @throws {@link MavenAGI.ServerError}
32
32
  *
33
33
  * @example
34
- * await client.users.upsertAppUser({
35
- * appUserId: {
36
- * referenceId: "string"
34
+ * await client.users.createOrUpdate({
35
+ * userId: {
36
+ * referenceId: "user-0"
37
37
  * },
38
- * userIdentifiers: {
39
- * identifiers: new Set([{}])
40
- * },
41
- * metadata: {
42
- * "string": {}
38
+ * identifiers: new Set([{
39
+ * value: "joe@myapp.com",
40
+ * type: MavenAGI.AppUserIdentifyingPropertyType.Email
41
+ * }]),
42
+ * data: {
43
+ * "name": {
44
+ * value: "Joe",
45
+ * visibility: MavenAGI.VisibilityType.Visible
46
+ * }
43
47
  * }
44
48
  * })
45
49
  */
46
- upsertAppUser(request, requestOptions) {
50
+ createOrUpdate(request, requestOptions) {
47
51
  var _a, _b;
48
52
  return __awaiter(this, void 0, void 0, function* () {
49
53
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -55,7 +59,7 @@ export class Users {
55
59
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
56
60
  "X-Fern-Language": "JavaScript",
57
61
  "X-Fern-SDK-Name": "mavenagi",
58
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
62
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
59
63
  "X-Fern-Runtime": core.RUNTIME.type,
60
64
  "X-Fern-Runtime-Version": core.RUNTIME.version,
61
65
  },
@@ -120,9 +124,9 @@ export class Users {
120
124
  });
121
125
  }
122
126
  /**
123
- * Get a user
127
+ * Get a user by its supplied ID
124
128
  *
125
- * @param {string} userId - Externally supplied unique ID of the user
129
+ * @param {string} userId - The reference ID of the user to get. All other entity ID fields are inferred from the request.
126
130
  * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
127
131
  *
128
132
  * @throws {@link MavenAGI.NotFoundError}
@@ -130,13 +134,13 @@ export class Users {
130
134
  * @throws {@link MavenAGI.ServerError}
131
135
  *
132
136
  * @example
133
- * await client.users.getAppUser("string")
137
+ * await client.users.get("user-0")
134
138
  */
135
- getAppUser(userId, requestOptions) {
139
+ get(userId, requestOptions) {
136
140
  var _a, _b;
137
141
  return __awaiter(this, void 0, void 0, function* () {
138
142
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
139
- url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/users/agent_user/${encodeURIComponent(userId)}`),
143
+ url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/users/${encodeURIComponent(userId)}`),
140
144
  method: "GET",
141
145
  headers: {
142
146
  Authorization: yield this._getAuthorizationHeader(),
@@ -144,7 +148,7 @@ export class Users {
144
148
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
145
149
  "X-Fern-Language": "JavaScript",
146
150
  "X-Fern-SDK-Name": "mavenagi",
147
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
151
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
148
152
  "X-Fern-Runtime": core.RUNTIME.type,
149
153
  "X-Fern-Runtime-Version": core.RUNTIME.version,
150
154
  },
@@ -56,7 +56,7 @@ export class Actions {
56
56
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
57
57
  "X-Fern-Language": "JavaScript",
58
58
  "X-Fern-SDK-Name": "mavenagi",
59
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
59
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
60
60
  "X-Fern-Runtime": core.RUNTIME.type,
61
61
  "X-Fern-Runtime-Version": core.RUNTIME.version,
62
62
  },
@@ -145,7 +145,7 @@ export class Actions {
145
145
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
146
146
  "X-Fern-Language": "JavaScript",
147
147
  "X-Fern-SDK-Name": "mavenagi",
148
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
148
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
149
149
  "X-Fern-Runtime": core.RUNTIME.type,
150
150
  "X-Fern-Runtime-Version": core.RUNTIME.version,
151
151
  },
@@ -233,7 +233,7 @@ export class Actions {
233
233
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
234
234
  "X-Fern-Language": "JavaScript",
235
235
  "X-Fern-SDK-Name": "mavenagi",
236
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
236
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
237
237
  "X-Fern-Runtime": core.RUNTIME.type,
238
238
  "X-Fern-Runtime-Version": core.RUNTIME.version,
239
239
  },
@@ -3,6 +3,7 @@
3
3
  */
4
4
  import * as MavenAGI from "../../../index";
5
5
  export interface AppUser {
6
- userIdentifiers?: MavenAGI.AppUserIdentification;
7
- metadata?: Record<string, MavenAGI.UserData>;
6
+ /** Used to determine whether two users from different apps are the same */
7
+ identifiers: MavenAGI.AppUserIdentifier[];
8
+ data: Record<string, MavenAGI.UserData>;
8
9
  }
@@ -5,5 +5,5 @@ import * as MavenAGI from "../../../index";
5
5
  export interface AppUserIdentifier {
6
6
  /** The identifying property text */
7
7
  value: string;
8
- userIdentifyingPropertyType: MavenAGI.AppUserIdentifyingPropertyType;
8
+ type: MavenAGI.AppUserIdentifyingPropertyType;
9
9
  }
@@ -2,7 +2,25 @@
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
+ * userId: {
9
+ * referenceId: "user-0"
10
+ * },
11
+ * identifiers: new Set([{
12
+ * value: "joe@myapp.com",
13
+ * type: MavenAGI.AppUserIdentifyingPropertyType.Email
14
+ * }]),
15
+ * data: {
16
+ * "name": {
17
+ * value: "Joe",
18
+ * visibility: MavenAGI.VisibilityType.Visible
19
+ * }
20
+ * }
21
+ * }
22
+ */
5
23
  export interface AppUserRequest extends MavenAGI.AppUser {
6
24
  /** ID that uniquely identifies this app user */
7
- appUserId: MavenAGI.EntityIdBase;
25
+ userId: MavenAGI.EntityIdBase;
8
26
  }
@@ -2,7 +2,39 @@
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
+ * userId: {
9
+ * referenceId: "user-0",
10
+ * appId: "myapp",
11
+ * organizationId: "acme",
12
+ * agentId: "support",
13
+ * type: MavenAGI.EntityType.UserProfile
14
+ * },
15
+ * identifiers: new Set([{
16
+ * value: "joe@myapp.com",
17
+ * type: MavenAGI.AppUserIdentifyingPropertyType.Email
18
+ * }]),
19
+ * data: {
20
+ * "name": {
21
+ * value: "Joe",
22
+ * visibility: MavenAGI.VisibilityType.Visible
23
+ * }
24
+ * },
25
+ * allUserData: {
26
+ * "myapp": {
27
+ * "name": "Joe"
28
+ * },
29
+ * "defaultUserData": {
30
+ * "name": "Joe"
31
+ * }
32
+ * }
33
+ * }
34
+ */
5
35
  export interface AppUserResponse extends MavenAGI.AppUser {
6
- /** ID that uniquely identifies this app user */
7
- appUserId: MavenAGI.EntityId;
36
+ /** ID that uniquely identifies this user */
37
+ userId: MavenAGI.EntityId;
38
+ /** Data from all apps */
39
+ allUserData: Record<string, Record<string, string>>;
8
40
  }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as MavenAGI from "../../../index";
5
+ export interface Feedback extends MavenAGI.FeedbackBase {
6
+ /** The ID of the piece of feedback */
7
+ feedbackId: MavenAGI.EntityId;
8
+ /** The ID of the conversation the feedback is about */
9
+ conversationId: MavenAGI.EntityId;
10
+ /** The ID of the conversation message the feedback is about */
11
+ conversationMessageId: MavenAGI.EntityId;
12
+ }
@@ -6,5 +6,5 @@ export interface UserData {
6
6
  /** The value of the user metadata */
7
7
  value: string;
8
8
  /** The visibility of the user metadata */
9
- visibility?: MavenAGI.VisibilityType;
9
+ visibility: MavenAGI.VisibilityType;
10
10
  }
@@ -2,10 +2,9 @@ export * from "./ErrorMessage";
2
2
  export * from "./EntityType";
3
3
  export * from "./EntityIdBase";
4
4
  export * from "./EntityId";
5
- export * from "./User";
6
5
  export * from "./FeedbackBase";
7
6
  export * from "./FeedbackType";
8
- export * from "./AppUserIdentification";
7
+ export * from "./Feedback";
9
8
  export * from "./AppUserIdentifier";
10
9
  export * from "./AppUserIdentifyingPropertyType";
11
10
  export * from "./AppUser";
@@ -13,3 +12,6 @@ export * from "./UserData";
13
12
  export * from "./VisibilityType";
14
13
  export * from "./AppUserRequest";
15
14
  export * from "./AppUserResponse";
15
+ export * from "./EventTriggerBase";
16
+ export * from "./EventTriggerResponse";
17
+ export * from "./EventTriggerType";
@@ -2,10 +2,9 @@ export * from "./ErrorMessage";
2
2
  export * from "./EntityType";
3
3
  export * from "./EntityIdBase";
4
4
  export * from "./EntityId";
5
- export * from "./User";
6
5
  export * from "./FeedbackBase";
7
6
  export * from "./FeedbackType";
8
- export * from "./AppUserIdentification";
7
+ export * from "./Feedback";
9
8
  export * from "./AppUserIdentifier";
10
9
  export * from "./AppUserIdentifyingPropertyType";
11
10
  export * from "./AppUser";
@@ -13,3 +12,6 @@ export * from "./UserData";
13
12
  export * from "./VisibilityType";
14
13
  export * from "./AppUserRequest";
15
14
  export * from "./AppUserResponse";
15
+ export * from "./EventTriggerBase";
16
+ export * from "./EventTriggerResponse";
17
+ export * from "./EventTriggerType";
@@ -32,7 +32,7 @@ export declare class Conversation {
32
32
  protected readonly _options: Conversation.Options;
33
33
  constructor(_options: Conversation.Options);
34
34
  /**
35
- * Pre-populate a new conversation with messages
35
+ * Initialize a new conversation. Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
36
36
  *
37
37
  * @param {MavenAGI.ConversationRequest} request
38
38
  * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
@@ -47,11 +47,18 @@ export declare class Conversation {
47
47
  * referenceId: "string"
48
48
  * },
49
49
  * messages: [{}],
50
- * context: {},
51
50
  * responseConfig: {
52
51
  * capabilities: [MavenAGI.Capability.Markdown],
53
52
  * isCopilot: true,
54
53
  * responseLength: MavenAGI.ResponseLength.Short
54
+ * },
55
+ * subject: "string",
56
+ * url: "string",
57
+ * createdAt: new Date("2024-01-15T09:30:00.000Z"),
58
+ * updatedAt: new Date("2024-01-15T09:30:00.000Z"),
59
+ * tags: new Set(["string"]),
60
+ * metadata: {
61
+ * "string": "string"
55
62
  * }
56
63
  * })
57
64
  */
@@ -86,14 +93,18 @@ export declare class Conversation {
86
93
  * conversationMessageId: {
87
94
  * referenceId: "string"
88
95
  * },
96
+ * userId: {
97
+ * referenceId: "string"
98
+ * },
89
99
  * text: "string",
90
100
  * userMessageType: MavenAGI.UserConversationMessageType.User,
91
- * context: {}
101
+ * createdAt: new Date("2024-01-15T09:30:00.000Z"),
102
+ * updatedAt: new Date("2024-01-15T09:30:00.000Z")
92
103
  * }])
93
104
  */
94
105
  appendNewMessages(conversationId: string, request: MavenAGI.ConversationMessageRequest[], requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
95
106
  /**
96
- * Ask a question in a conversation
107
+ * Ask a question
97
108
  *
98
109
  * @param {string} conversationId - The ID of a new or existing conversation to use as context for the question
99
110
  * @param {MavenAGI.AskRequest} request
@@ -108,9 +119,10 @@ export declare class Conversation {
108
119
  * conversationMessageId: {
109
120
  * referenceId: "string"
110
121
  * },
111
- * text: "string",
112
- * context: {},
113
- * responseConfig: {}
122
+ * userId: {
123
+ * referenceId: "string"
124
+ * },
125
+ * text: "string"
114
126
  * })
115
127
  */
116
128
  ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
@@ -162,7 +174,7 @@ export declare class Conversation {
162
174
  * text: "string"
163
175
  * })
164
176
  */
165
- createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<void>;
177
+ createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.Feedback>;
166
178
  /**
167
179
  * Submit a filled out action form
168
180
  *
@@ -177,16 +189,6 @@ export declare class Conversation {
177
189
  * @example
178
190
  * await client.conversation.submitActionForm("string", {
179
191
  * actionFormId: "string",
180
- * userContext: {
181
- * name: "string",
182
- * id: {
183
- * "string": "string"
184
- * },
185
- * email: "string",
186
- * context: {
187
- * "string": "string"
188
- * }
189
- * },
190
192
  * parameters: {
191
193
  * "string": {
192
194
  * "key": "value"
@@ -196,7 +198,7 @@ export declare class Conversation {
196
198
  */
197
199
  submitActionForm(conversationId: string, request: MavenAGI.SubmitActionFormRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
198
200
  /**
199
- * Add metadata to an existing conversation's Context. If a metadata field already exists, it will be overwritten.
201
+ * Add metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
200
202
  *
201
203
  * @param {string} conversationId - The ID of a conversation the metadata being added belongs to
202
204
  * @param {Record<string, string>} request
@@ -21,7 +21,7 @@ export class Conversation {
21
21
  this._options = _options;
22
22
  }
23
23
  /**
24
- * Pre-populate a new conversation with messages
24
+ * Initialize a new conversation. Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
25
25
  *
26
26
  * @param {MavenAGI.ConversationRequest} request
27
27
  * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
@@ -36,11 +36,18 @@ export class Conversation {
36
36
  * referenceId: "string"
37
37
  * },
38
38
  * messages: [{}],
39
- * context: {},
40
39
  * responseConfig: {
41
40
  * capabilities: [MavenAGI.Capability.Markdown],
42
41
  * isCopilot: true,
43
42
  * responseLength: MavenAGI.ResponseLength.Short
43
+ * },
44
+ * subject: "string",
45
+ * url: "string",
46
+ * createdAt: new Date("2024-01-15T09:30:00.000Z"),
47
+ * updatedAt: new Date("2024-01-15T09:30:00.000Z"),
48
+ * tags: new Set(["string"]),
49
+ * metadata: {
50
+ * "string": "string"
44
51
  * }
45
52
  * })
46
53
  */
@@ -56,7 +63,7 @@ export class Conversation {
56
63
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
57
64
  "X-Fern-Language": "JavaScript",
58
65
  "X-Fern-SDK-Name": "mavenagi",
59
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
66
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
60
67
  "X-Fern-Runtime": core.RUNTIME.type,
61
68
  "X-Fern-Runtime-Version": core.RUNTIME.version,
62
69
  },
@@ -145,7 +152,7 @@ export class Conversation {
145
152
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
146
153
  "X-Fern-Language": "JavaScript",
147
154
  "X-Fern-SDK-Name": "mavenagi",
148
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
155
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
149
156
  "X-Fern-Runtime": core.RUNTIME.type,
150
157
  "X-Fern-Runtime-Version": core.RUNTIME.version,
151
158
  },
@@ -224,9 +231,13 @@ export class Conversation {
224
231
  * conversationMessageId: {
225
232
  * referenceId: "string"
226
233
  * },
234
+ * userId: {
235
+ * referenceId: "string"
236
+ * },
227
237
  * text: "string",
228
238
  * userMessageType: MavenAGI.UserConversationMessageType.User,
229
- * context: {}
239
+ * createdAt: new Date("2024-01-15T09:30:00.000Z"),
240
+ * updatedAt: new Date("2024-01-15T09:30:00.000Z")
230
241
  * }])
231
242
  */
232
243
  appendNewMessages(conversationId, request, requestOptions) {
@@ -241,7 +252,7 @@ export class Conversation {
241
252
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
242
253
  "X-Fern-Language": "JavaScript",
243
254
  "X-Fern-SDK-Name": "mavenagi",
244
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
255
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
245
256
  "X-Fern-Runtime": core.RUNTIME.type,
246
257
  "X-Fern-Runtime-Version": core.RUNTIME.version,
247
258
  },
@@ -308,7 +319,7 @@ export class Conversation {
308
319
  });
309
320
  }
310
321
  /**
311
- * Ask a question in a conversation
322
+ * Ask a question
312
323
  *
313
324
  * @param {string} conversationId - The ID of a new or existing conversation to use as context for the question
314
325
  * @param {MavenAGI.AskRequest} request
@@ -323,9 +334,10 @@ export class Conversation {
323
334
  * conversationMessageId: {
324
335
  * referenceId: "string"
325
336
  * },
326
- * text: "string",
327
- * context: {},
328
- * responseConfig: {}
337
+ * userId: {
338
+ * referenceId: "string"
339
+ * },
340
+ * text: "string"
329
341
  * })
330
342
  */
331
343
  ask(conversationId, request, requestOptions) {
@@ -340,7 +352,7 @@ export class Conversation {
340
352
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
341
353
  "X-Fern-Language": "JavaScript",
342
354
  "X-Fern-SDK-Name": "mavenagi",
343
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
355
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
344
356
  "X-Fern-Runtime": core.RUNTIME.type,
345
357
  "X-Fern-Runtime-Version": core.RUNTIME.version,
346
358
  },
@@ -419,7 +431,7 @@ export class Conversation {
419
431
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
420
432
  "X-Fern-Language": "JavaScript",
421
433
  "X-Fern-SDK-Name": "mavenagi",
422
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
434
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
423
435
  "X-Fern-Runtime": core.RUNTIME.type,
424
436
  "X-Fern-Runtime-Version": core.RUNTIME.version,
425
437
  },
@@ -524,7 +536,7 @@ export class Conversation {
524
536
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
525
537
  "X-Fern-Language": "JavaScript",
526
538
  "X-Fern-SDK-Name": "mavenagi",
527
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
539
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
528
540
  "X-Fern-Runtime": core.RUNTIME.type,
529
541
  "X-Fern-Runtime-Version": core.RUNTIME.version,
530
542
  },
@@ -625,7 +637,7 @@ export class Conversation {
625
637
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
626
638
  "X-Fern-Language": "JavaScript",
627
639
  "X-Fern-SDK-Name": "mavenagi",
628
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
640
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
629
641
  "X-Fern-Runtime": core.RUNTIME.type,
630
642
  "X-Fern-Runtime-Version": core.RUNTIME.version,
631
643
  },
@@ -637,7 +649,12 @@ export class Conversation {
637
649
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
638
650
  });
639
651
  if (_response.ok) {
640
- return;
652
+ return serializers.Feedback.parseOrThrow(_response.body, {
653
+ unrecognizedObjectKeys: "passthrough",
654
+ allowUnrecognizedUnionMembers: true,
655
+ allowUnrecognizedEnumValues: true,
656
+ breadcrumbsPrefix: ["response"],
657
+ });
641
658
  }
642
659
  if (_response.error.reason === "status-code") {
643
660
  switch (_response.error.statusCode) {
@@ -698,16 +715,6 @@ export class Conversation {
698
715
  * @example
699
716
  * await client.conversation.submitActionForm("string", {
700
717
  * actionFormId: "string",
701
- * userContext: {
702
- * name: "string",
703
- * id: {
704
- * "string": "string"
705
- * },
706
- * email: "string",
707
- * context: {
708
- * "string": "string"
709
- * }
710
- * },
711
718
  * parameters: {
712
719
  * "string": {
713
720
  * "key": "value"
@@ -727,7 +734,7 @@ export class Conversation {
727
734
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
728
735
  "X-Fern-Language": "JavaScript",
729
736
  "X-Fern-SDK-Name": "mavenagi",
730
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
737
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
731
738
  "X-Fern-Runtime": core.RUNTIME.type,
732
739
  "X-Fern-Runtime-Version": core.RUNTIME.version,
733
740
  },
@@ -792,7 +799,7 @@ export class Conversation {
792
799
  });
793
800
  }
794
801
  /**
795
- * Add metadata to an existing conversation's Context. If a metadata field already exists, it will be overwritten.
802
+ * Add metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
796
803
  *
797
804
  * @param {string} conversationId - The ID of a conversation the metadata being added belongs to
798
805
  * @param {Record<string, string>} request
@@ -819,7 +826,7 @@ export class Conversation {
819
826
  "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
820
827
  "X-Fern-Language": "JavaScript",
821
828
  "X-Fern-SDK-Name": "mavenagi",
822
- "X-Fern-SDK-Version": "0.0.0-alpha.12",
829
+ "X-Fern-SDK-Version": "0.0.0-alpha.14",
823
830
  "X-Fern-Runtime": core.RUNTIME.type,
824
831
  "X-Fern-Runtime-Version": core.RUNTIME.version,
825
832
  },