mavenagi 0.0.0-alpha.12 → 0.0.0-alpha.15

package/dist/serialization/resources/conversation/types/ConversationMessageBase.js

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as core from "../../../../core";
-import { ConversationMessageContext } from "./ConversationMessageContext";
 export const ConversationMessageBase = core.serialization.object({
-    context: ConversationMessageContext.optional(),
+    createdAt: core.serialization.date().optional(),
+    updatedAt: core.serialization.date().optional(),
 });

package/dist/serialization/resources/conversation/types/ConversationRequest.d.ts

@@ -6,13 +6,11 @@ import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { EntityIdBase } from "../../commons/types/EntityIdBase";
 import { ConversationMessageRequest } from "./ConversationMessageRequest";
-import { ConversationContext } from "./ConversationContext";
 import { ConversationBase } from "./ConversationBase";
 export declare const ConversationRequest: core.serialization.ObjectSchema<serializers.ConversationRequest.Raw, MavenAGI.ConversationRequest>;
 export declare namespace ConversationRequest {
     interface Raw extends ConversationBase.Raw {
         conversationId: EntityIdBase.Raw;
         messages: ConversationMessageRequest.Raw[];
-        context?: ConversationContext.Raw | null;
     }
 }

package/dist/serialization/resources/conversation/types/ConversationRequest.js

@@ -4,12 +4,10 @@
 import * as core from "../../../../core";
 import { EntityIdBase } from "../../commons/types/EntityIdBase";
 import { ConversationMessageRequest } from "./ConversationMessageRequest";
-import { ConversationContext } from "./ConversationContext";
 import { ConversationBase } from "./ConversationBase";
 export const ConversationRequest = core.serialization
     .object({
     conversationId: EntityIdBase,
     messages: core.serialization.list(ConversationMessageRequest),
-    context: ConversationContext.optional(),
 })
     .extend(ConversationBase);

package/dist/serialization/resources/conversation/types/ConversationResponse.d.ts

@@ -6,13 +6,11 @@ import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { EntityId } from "../../commons/types/EntityId";
 import { ConversationMessageResponse } from "./ConversationMessageResponse";
-import { ConversationContext } from "./ConversationContext";
 import { ConversationBase } from "./ConversationBase";
 export declare const ConversationResponse: core.serialization.ObjectSchema<serializers.ConversationResponse.Raw, MavenAGI.ConversationResponse>;
 export declare namespace ConversationResponse {
     interface Raw extends ConversationBase.Raw {
         conversationId: EntityId.Raw;
         messages: ConversationMessageResponse.Raw[];
-        context: ConversationContext.Raw;
     }
 }

package/dist/serialization/resources/conversation/types/ConversationResponse.js

@@ -4,12 +4,10 @@
 import * as core from "../../../../core";
 import { EntityId } from "../../commons/types/EntityId";
 import { ConversationMessageResponse } from "./ConversationMessageResponse";
-import { ConversationContext } from "./ConversationContext";
 import { ConversationBase } from "./ConversationBase";
 export const ConversationResponse = core.serialization
     .object({
     conversationId: EntityId,
     messages: core.serialization.list(ConversationMessageResponse),
-    context: ConversationContext,
 })
     .extend(ConversationBase);

package/dist/serialization/resources/conversation/types/SubmitActionFormRequest.d.ts

@@ -4,12 +4,10 @@
 import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
-import { User } from "../../commons/types/User";
 export declare const SubmitActionFormRequest: core.serialization.ObjectSchema<serializers.SubmitActionFormRequest.Raw, MavenAGI.SubmitActionFormRequest>;
 export declare namespace SubmitActionFormRequest {
     interface Raw {
         actionFormId: string;
-        userContext: User.Raw;
         parameters: Record<string, unknown>;
     }
 }

package/dist/serialization/resources/conversation/types/SubmitActionFormRequest.js

@@ -2,9 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as core from "../../../../core";
-import { User } from "../../commons/types/User";
 export const SubmitActionFormRequest = core.serialization.object({
     actionFormId: core.serialization.string(),
-    userContext: User,
     parameters: core.serialization.record(core.serialization.string(), core.serialization.unknown()),
 });

package/dist/serialization/resources/conversation/types/UserMessageBase.d.ts

@@ -4,11 +4,13 @@
 import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
+import { EntityIdBase } from "../../commons/types/EntityIdBase";
 import { UserConversationMessageType } from "./UserConversationMessageType";
 import { ConversationMessageBase } from "./ConversationMessageBase";
 export declare const UserMessageBase: core.serialization.ObjectSchema<serializers.UserMessageBase.Raw, MavenAGI.UserMessageBase>;
 export declare namespace UserMessageBase {
     interface Raw extends ConversationMessageBase.Raw {
+        userId: EntityIdBase.Raw;
         text: string;
         userMessageType: UserConversationMessageType.Raw;
     }

package/dist/serialization/resources/conversation/types/UserMessageBase.js

@@ -2,10 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as core from "../../../../core";
+import { EntityIdBase } from "../../commons/types/EntityIdBase";
 import { UserConversationMessageType } from "./UserConversationMessageType";
 import { ConversationMessageBase } from "./ConversationMessageBase";
 export const UserMessageBase = core.serialization
     .object({
+    userId: EntityIdBase,
     text: core.serialization.string(),
     userMessageType: UserConversationMessageType,
 })

package/dist/serialization/resources/conversation/types/index.d.ts

@@ -18,8 +18,6 @@ export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
 export * from "./SubmitActionFormRequest";
-export * from "./ConversationContext";
-export * from "./ConversationMessageContext";
 export * from "./UserConversationMessageType";
 export * from "./BotConversationMessageType";
 export * from "./FeedbackRequest";

package/dist/serialization/resources/conversation/types/index.js

@@ -18,8 +18,6 @@ export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
 export * from "./SubmitActionFormRequest";
-export * from "./ConversationContext";
-export * from "./ConversationMessageContext";
 export * from "./UserConversationMessageType";
 export * from "./BotConversationMessageType";
 export * from "./FeedbackRequest";

package/dist/serialization/resources/index.d.ts

@@ -8,3 +8,4 @@ export * as knowledge from "./knowledge";
 export * from "./knowledge/types";
 export * as triggers from "./triggers";
 export * from "./triggers/types";
+export * as appSettings from "./appSettings";

package/dist/serialization/resources/index.js

@@ -8,3 +8,4 @@ export * as knowledge from "./knowledge";
 export * from "./knowledge/types";
 export * as triggers from "./triggers";
 export * from "./triggers/types";
+export * as appSettings from "./appSettings";

package/dist/serialization/resources/triggers/types/EventTriggerRequest.d.ts

@@ -5,7 +5,7 @@ import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { EntityIdBase } from "../../commons/types/EntityIdBase";
-import { EventTriggerBase } from "./EventTriggerBase";
+import { EventTriggerBase } from "../../commons/types/EventTriggerBase";
 export declare const EventTriggerRequest: core.serialization.ObjectSchema<serializers.EventTriggerRequest.Raw, MavenAGI.EventTriggerRequest>;
 export declare namespace EventTriggerRequest {
     interface Raw extends EventTriggerBase.Raw {

package/dist/serialization/resources/triggers/types/EventTriggerRequest.js

@@ -3,7 +3,7 @@
  */
 import * as core from "../../../../core";
 import { EntityIdBase } from "../../commons/types/EntityIdBase";
-import { EventTriggerBase } from "./EventTriggerBase";
+import { EventTriggerBase } from "../../commons/types/EventTriggerBase";
 export const EventTriggerRequest = core.serialization
     .object({
     triggerId: EntityIdBase,

package/dist/serialization/resources/triggers/types/index.d.ts

@@ -1,4 +1 @@
-export * from "./EventTriggerBase";
 export * from "./EventTriggerRequest";
-export * from "./EventTriggerResponse";
-export * from "./EventTriggerType";

package/dist/serialization/resources/triggers/types/index.js

@@ -1,4 +1 @@
-export * from "./EventTriggerBase";
 export * from "./EventTriggerRequest";
-export * from "./EventTriggerResponse";
-export * from "./EventTriggerType";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mavenagi",
-    "version": "0.0.0-alpha.12",
+    "version": "0.0.0-alpha.15",
     "private": false,
     "repository": "https://github.com/mavenagi/mavenagi-node",
     "main": "./index.js",

package/reference.md

@@ -202,6 +202,63 @@ await client.actions.delete("get-balance");
 </dl>
 </details>
 
+## AppSettings
+
+<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">get</a>() -> Record<string, unknown></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get app settings set during installation
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.appSettings.get();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `AppSettings.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Conversation
 
 <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">initialize</a>({ ...params }) -> MavenAGI.ConversationResponse</code></summary>
@@ -216,7 +273,7 @@ await client.actions.delete("get-balance");
 <dl>
 <dd>
 
-Pre-populate a new conversation with messages
+Initialize a new conversation. Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
 
 </dd>
 </dl>
@@ -237,12 +294,19 @@ await client.conversation.initialize({
         referenceId: "string",
     },
     messages: [{}],
-    context: {},
     responseConfig: {
         capabilities: [MavenAGI.Capability.Markdown],
         isCopilot: true,
         responseLength: MavenAGI.ResponseLength.Short,
     },
+    subject: "string",
+    url: "string",
+    createdAt: new Date("2024-01-15T09:30:00.000Z"),
+    updatedAt: new Date("2024-01-15T09:30:00.000Z"),
+    tags: new Set(["string"]),
+    metadata: {
+        string: "string",
+    },
 });
 ```
 
@@ -374,9 +438,13 @@ await client.conversation.appendNewMessages("string", [
         conversationMessageId: {
             referenceId: "string",
         },
+        userId: {
+            referenceId: "string",
+        },
         text: "string",
         userMessageType: MavenAGI.UserConversationMessageType.User,
-        context: {},
+        createdAt: new Date("2024-01-15T09:30:00.000Z"),
+        updatedAt: new Date("2024-01-15T09:30:00.000Z"),
     },
 ]);
 ```
@@ -433,7 +501,7 @@ await client.conversation.appendNewMessages("string", [
 <dl>
 <dd>
 
-Ask a question in a conversation
+Ask a question
 
 </dd>
 </dl>
@@ -453,9 +521,10 @@ await client.conversation.ask("string", {
     conversationMessageId: {
         referenceId: "string",
     },
+    userId: {
+        referenceId: "string",
+    },
     text: "string",
-    context: {},
-    responseConfig: {},
 });
 ```
 
@@ -531,9 +600,10 @@ await client.conversation.askStream("string", {
     conversationMessageId: {
         referenceId: "string",
     },
+    userId: {
+        referenceId: "string",
+    },
     text: "string",
-    context: {},
-    responseConfig: {},
 });
 ```
 
@@ -654,7 +724,7 @@ await client.conversation.generateMavenSuggestions("string", {
 </dl>
 </details>
 
-<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">createFeedback</a>({ ...params }) -> void</code></summary>
+<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">createFeedback</a>({ ...params }) -> MavenAGI.Feedback</code></summary>
 <dl>
 <dd>
 
@@ -759,16 +829,6 @@ Submit a filled out action form
 ```typescript
 await client.conversation.submitActionForm("string", {
     actionFormId: "string",
-    userContext: {
-        name: "string",
-        id: {
-            string: "string",
-        },
-        email: "string",
-        context: {
-            string: "string",
-        },
-    },
     parameters: {
         string: {
             key: "value",
@@ -829,7 +889,7 @@ await client.conversation.submitActionForm("string", {
 <dl>
 <dd>
 
-Add metadata to an existing conversation's Context. If a metadata field already exists, it will be overwritten.
+Add metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
 
 </dd>
 </dl>
@@ -1586,7 +1646,7 @@ await client.triggers.delete("store-in-snowflake");
 
 ## Users
 
-<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">upsertAppUser</a>({ ...params }) -> MavenAGI.AppUserResponse</code></summary>
+<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.AppUserResponse</code></summary>
 <dl>
 <dd>
 
@@ -1598,7 +1658,7 @@ await client.triggers.delete("store-in-snowflake");
 <dl>
 <dd>
 
-Create a new user or update an existing one
+Update a user or create it if it doesn't exist.
 
 </dd>
 </dl>
@@ -1614,15 +1674,21 @@ Create a new user or update an existing one
 <dd>
 
 ```typescript
-await client.users.upsertAppUser({
-    appUserId: {
-        referenceId: "string",
-    },
-    userIdentifiers: {
-        identifiers: new Set([{}]),
+await client.users.createOrUpdate({
+    userId: {
+        referenceId: "user-0",
     },
-    metadata: {
-        string: {},
+    identifiers: new Set([
+        {
+            value: "joe@myapp.com",
+            type: MavenAGI.AppUserIdentifyingPropertyType.Email,
+        },
+    ]),
+    data: {
+        name: {
+            value: "Joe",
+            visibility: MavenAGI.VisibilityType.Visible,
+        },
     },
 });
 ```
@@ -1659,7 +1725,7 @@ await client.users.upsertAppUser({
 </dl>
 </details>
 
-<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getAppUser</a>(userId) -> MavenAGI.AppUserResponse</code></summary>
+<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">get</a>(userId) -> MavenAGI.AppUserResponse</code></summary>
 <dl>
 <dd>
 
@@ -1671,7 +1737,7 @@ await client.users.upsertAppUser({
 <dl>
 <dd>
 
-Get a user
+Get a user by its supplied ID
 
 </dd>
 </dl>
@@ -1687,7 +1753,7 @@ Get a user
 <dd>
 
 ```typescript
-await client.users.getAppUser("string");
+await client.users.get("user-0");
 ```
 
 </dd>
@@ -1703,7 +1769,7 @@ await client.users.getAppUser("string");
 <dl>
 <dd>
 
-**userId:** `string` — Externally supplied unique ID of the user
+**userId:** `string` — The reference ID of the user to get. All other entity ID fields are inferred from the request.
 
 </dd>
 </dl>

package/serialization/resources/appSettings/client/get.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as core from "../../../../core";
+export declare const Response: core.serialization.Schema<serializers.appSettings.get.Response.Raw, Record<string, unknown>>;
+export declare namespace Response {
+    type Raw = Record<string, unknown>;
+}

package/serialization/resources/appSettings/client/get.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+export const Response = core.serialization.record(core.serialization.string(), core.serialization.unknown());

package/serialization/resources/appSettings/client/index.d.ts

@@ -0,0 +1 @@
+export * as get from "./get";

package/serialization/resources/appSettings/client/index.js

@@ -0,0 +1 @@
+export * as get from "./get";

package/serialization/resources/appSettings/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/serialization/resources/appSettings/index.js

@@ -0,0 +1 @@
+export * from "./client";

package/serialization/resources/commons/types/AppUser.d.ts

@@ -4,12 +4,12 @@
 import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
-import { AppUserIdentification } from "./AppUserIdentification";
+import { AppUserIdentifier } from "./AppUserIdentifier";
 import { UserData } from "./UserData";
 export declare const AppUser: core.serialization.ObjectSchema<serializers.AppUser.Raw, MavenAGI.AppUser>;
 export declare namespace AppUser {
     interface Raw {
-        userIdentifiers?: AppUserIdentification.Raw | null;
-        metadata?: Record<string, UserData.Raw> | null;
+        identifiers: AppUserIdentifier.Raw[];
+        data: Record<string, UserData.Raw>;
     }
 }

package/serialization/resources/commons/types/AppUser.js

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as core from "../../../../core";
-import { AppUserIdentification } from "./AppUserIdentification";
+import { AppUserIdentifier } from "./AppUserIdentifier";
 import { UserData } from "./UserData";
 export const AppUser = core.serialization.object({
-    userIdentifiers: AppUserIdentification.optional(),
-    metadata: core.serialization.record(core.serialization.string(), UserData).optional(),
+    identifiers: core.serialization.list(AppUserIdentifier),
+    data: core.serialization.record(core.serialization.string(), UserData),
 });

package/serialization/resources/commons/types/AppUserIdentifier.d.ts

@@ -9,6 +9,6 @@ export declare const AppUserIdentifier: core.serialization.ObjectSchema<serializ
 export declare namespace AppUserIdentifier {
     interface Raw {
         value: string;
-        userIdentifyingPropertyType: AppUserIdentifyingPropertyType.Raw;
+        type: AppUserIdentifyingPropertyType.Raw;
     }
 }

package/serialization/resources/commons/types/AppUserIdentifier.js

@@ -5,5 +5,5 @@ import * as core from "../../../../core";
 import { AppUserIdentifyingPropertyType } from "./AppUserIdentifyingPropertyType";
 export const AppUserIdentifier = core.serialization.object({
     value: core.serialization.string(),
-    userIdentifyingPropertyType: AppUserIdentifyingPropertyType,
+    type: AppUserIdentifyingPropertyType,
 });

package/serialization/resources/commons/types/AppUserRequest.d.ts

@@ -9,6 +9,6 @@ import { AppUser } from "./AppUser";
 export declare const AppUserRequest: core.serialization.ObjectSchema<serializers.AppUserRequest.Raw, MavenAGI.AppUserRequest>;
 export declare namespace AppUserRequest {
     interface Raw extends AppUser.Raw {
-        appUserId: EntityIdBase.Raw;
+        userId: EntityIdBase.Raw;
     }
 }

package/serialization/resources/commons/types/AppUserRequest.js

@@ -6,6 +6,6 @@ import { EntityIdBase } from "./EntityIdBase";
 import { AppUser } from "./AppUser";
 export const AppUserRequest = core.serialization
     .object({
-    appUserId: EntityIdBase,
+    userId: EntityIdBase,
 })
     .extend(AppUser);

package/serialization/resources/commons/types/AppUserResponse.d.ts

@@ -9,6 +9,7 @@ import { AppUser } from "./AppUser";
 export declare const AppUserResponse: core.serialization.ObjectSchema<serializers.AppUserResponse.Raw, MavenAGI.AppUserResponse>;
 export declare namespace AppUserResponse {
     interface Raw extends AppUser.Raw {
-        appUserId: EntityId.Raw;
+        userId: EntityId.Raw;
+        allUserData: Record<string, Record<string, string>>;
     }
 }

package/serialization/resources/commons/types/AppUserResponse.js

@@ -6,6 +6,7 @@ import { EntityId } from "./EntityId";
 import { AppUser } from "./AppUser";
 export const AppUserResponse = core.serialization
     .object({
-    appUserId: EntityId,
+    userId: EntityId,
+    allUserData: core.serialization.record(core.serialization.string(), core.serialization.record(core.serialization.string(), core.serialization.string())),
 })
     .extend(AppUser);

package/{dist/serialization/resources/triggers → serialization/resources/commons}/types/EventTriggerResponse.d.ts

@@ -4,7 +4,7 @@
 import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
-import { EntityId } from "../../commons/types/EntityId";
+import { EntityId } from "./EntityId";
 import { EventTriggerBase } from "./EventTriggerBase";
 export declare const EventTriggerResponse: core.serialization.ObjectSchema<serializers.EventTriggerResponse.Raw, MavenAGI.EventTriggerResponse>;
 export declare namespace EventTriggerResponse {

package/{dist/serialization/resources/triggers → serialization/resources/commons}/types/EventTriggerResponse.js

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as core from "../../../../core";
-import { EntityId } from "../../commons/types/EntityId";
+import { EntityId } from "./EntityId";
 import { EventTriggerBase } from "./EventTriggerBase";
 export const EventTriggerResponse = core.serialization
     .object({

package/serialization/resources/commons/types/Feedback.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+import { EntityId } from "./EntityId";
+import { FeedbackBase } from "./FeedbackBase";
+export declare const Feedback: core.serialization.ObjectSchema<serializers.Feedback.Raw, MavenAGI.Feedback>;
+export declare namespace Feedback {
+    interface Raw extends FeedbackBase.Raw {
+        feedbackId: EntityId.Raw;
+        conversationId: EntityId.Raw;
+        conversationMessageId: EntityId.Raw;
+    }
+}

package/serialization/resources/commons/types/Feedback.js

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+import { EntityId } from "./EntityId";
+import { FeedbackBase } from "./FeedbackBase";
+export const Feedback = core.serialization
+    .object({
+    feedbackId: EntityId,
+    conversationId: EntityId,
+    conversationMessageId: EntityId,
+})
+    .extend(FeedbackBase);

package/serialization/resources/commons/types/UserData.d.ts

@@ -9,6 +9,6 @@ export declare const UserData: core.serialization.ObjectSchema<serializers.UserD
 export declare namespace UserData {
     interface Raw {
         value: string;
-        visibility?: VisibilityType.Raw | null;
+        visibility: VisibilityType.Raw;
     }
 }

package/serialization/resources/commons/types/UserData.js

@@ -5,5 +5,5 @@ import * as core from "../../../../core";
 import { VisibilityType } from "./VisibilityType";
 export const UserData = core.serialization.object({
     value: core.serialization.string(),
-    visibility: VisibilityType.optional(),
+    visibility: VisibilityType,
 });