mavenagi 0.0.0-alpha.11

package/api/resources/actions/types/ActionRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         actionId: {
+ *             referenceId: "get-balance"
+ *         },
+ *         name: "Get the user's balance",
+ *         description: "This action calls an API to get the user's current balance.",
+ *         userInteractionRequired: false,
+ *         preconditions: {
+ *             requiredUserContextFieldNames: new Set(["my-billing-system.userId"])
+ *         },
+ *         userFormParameters: []
+ *     }
+ */
+export interface ActionRequest extends MavenAGI.ActionBase {
+    /** ID that uniquely identifies this action */
+    actionId: MavenAGI.EntityIdBase;
+}

package/api/resources/actions/types/ActionRequest.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/actions/types/ActionResponse.d.ts

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         actionId: {
+ *             referenceId: "get-balance",
+ *             appId: "my-billing-system",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.Action
+ *         },
+ *         name: "Get the user's balance",
+ *         description: "This action calls an API to get the user's current balance.",
+ *         userInteractionRequired: false,
+ *         preconditions: {
+ *             requiredUserContextFieldNames: new Set(["my-billing-system.userId"])
+ *         },
+ *         userFormParameters: []
+ *     }
+ */
+export interface ActionResponse extends MavenAGI.ActionBase {
+    /** ID that uniquely identifies this action */
+    actionId: MavenAGI.EntityId;
+}

package/api/resources/actions/types/ActionResponse.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/actions/types/Preconditions.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Preconditions {
+    /** The names of the user context fields that must be present in order for this object to be considered relevant to a conversation. */
+    requiredUserContextFieldNames: Set<string>;
+}

package/api/resources/actions/types/Preconditions.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/actions/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./Preconditions";
+export * from "./ActionBase";
+export * from "./ActionParameter";
+export * from "./ActionRequest";
+export * from "./ActionResponse";

package/api/resources/actions/types/index.js

@@ -0,0 +1,5 @@
+export * from "./Preconditions";
+export * from "./ActionBase";
+export * from "./ActionParameter";
+export * from "./ActionRequest";
+export * from "./ActionResponse";

package/api/resources/commons/errors/BadRequestError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+import * as MavenAGI from "../../../index";
+export declare class BadRequestError extends errors.MavenAGIError {
+    constructor(body: MavenAGI.ErrorMessage);
+}

package/api/resources/commons/errors/BadRequestError.js

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+export class BadRequestError extends errors.MavenAGIError {
+    constructor(body) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+        });
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+    }
+}

package/api/resources/commons/errors/NotFoundError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+import * as MavenAGI from "../../../index";
+export declare class NotFoundError extends errors.MavenAGIError {
+    constructor(body: MavenAGI.ErrorMessage);
+}

package/api/resources/commons/errors/NotFoundError.js

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+export class NotFoundError extends errors.MavenAGIError {
+    constructor(body) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}

package/api/resources/commons/errors/ServerError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+import * as MavenAGI from "../../../index";
+export declare class ServerError extends errors.MavenAGIError {
+    constructor(body: MavenAGI.ErrorMessage);
+}

package/api/resources/commons/errors/ServerError.js

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+export class ServerError extends errors.MavenAGIError {
+    constructor(body) {
+        super({
+            message: "ServerError",
+            statusCode: 500,
+            body: body,
+        });
+        Object.setPrototypeOf(this, ServerError.prototype);
+    }
+}

package/api/resources/commons/errors/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./NotFoundError";
+export * from "./BadRequestError";
+export * from "./ServerError";

package/api/resources/commons/errors/index.js

@@ -0,0 +1,3 @@
+export * from "./NotFoundError";
+export * from "./BadRequestError";
+export * from "./ServerError";

package/api/resources/commons/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./errors";

package/api/resources/commons/index.js

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./errors";

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AppUser {
+    userIdentifiers?: MavenAGI.AppUserIdentification;
+    metadata?: Record<string, MavenAGI.UserData>;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/commons/types/AppUserIdentification.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AppUserIdentification {
+    /** At least one identifying property must be provided */
+    identifiers: MavenAGI.AppUserIdentifier[];
+}

package/api/resources/commons/types/AppUserIdentification.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AppUserIdentifier {
+    /** The identifying property text */
+    value: string;
+    userIdentifyingPropertyType: MavenAGI.AppUserIdentifyingPropertyType;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/commons/types/AppUserIdentifyingPropertyType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type AppUserIdentifyingPropertyType = "EMAIL" | "PHONE_NUMBER";
+export declare const AppUserIdentifyingPropertyType: {
+    readonly Email: "EMAIL";
+    readonly PhoneNumber: "PHONE_NUMBER";
+};

package/api/resources/commons/types/AppUserIdentifyingPropertyType.js

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const AppUserIdentifyingPropertyType = {
+    Email: "EMAIL",
+    PhoneNumber: "PHONE_NUMBER",
+};

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AppUserRequest extends MavenAGI.AppUser {
+    /** ID that uniquely identifies this app user */
+    appUserId: MavenAGI.EntityIdBase;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AppUserResponse extends MavenAGI.AppUser {
+    /** ID that uniquely identifies this app user */
+    appUserId: MavenAGI.EntityId;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/commons/types/EntityId.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface EntityId extends MavenAGI.EntityIdBase {
+    /** The object type */
+    type: MavenAGI.EntityType;
+    /** The ID of the application that created this object */
+    appId: string;
+    /** The ID of the organization that this object belongs too */
+    organizationId: string;
+    /** The ID of the agent that this object belongs too */
+    agentId: string;
+}

package/api/resources/commons/types/EntityId.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/commons/types/EntityIdBase.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * All other entityId fields are inferred from the API request.
+ */
+export interface EntityIdBase {
+    /** Externally supplied ID to uniquely identify this object. Is globally unique when combined with all other entityId fields (type, appId, organizationId, agentId) */
+    referenceId: string;
+}

package/api/resources/commons/types/EntityIdBase.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/commons/types/EntityType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type EntityType = "CONVERSATION" | "CONVERSATION_MESSAGE" | "KNOWLEDGE_BASE" | "KNOWLEDGE_DOCUMENT" | "ACTION" | "USER" | "USER_EVENT" | "EVENT_TRIGGER" | "USER_PROFILE";
+export declare const EntityType: {
+    readonly Conversation: "CONVERSATION";
+    readonly ConversationMessage: "CONVERSATION_MESSAGE";
+    readonly KnowledgeBase: "KNOWLEDGE_BASE";
+    readonly KnowledgeDocument: "KNOWLEDGE_DOCUMENT";
+    readonly Action: "ACTION";
+    readonly User: "USER";
+    readonly UserEvent: "USER_EVENT";
+    readonly EventTrigger: "EVENT_TRIGGER";
+    readonly UserProfile: "USER_PROFILE";
+};

package/api/resources/commons/types/EntityType.js

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const EntityType = {
+    Conversation: "CONVERSATION",
+    ConversationMessage: "CONVERSATION_MESSAGE",
+    KnowledgeBase: "KNOWLEDGE_BASE",
+    KnowledgeDocument: "KNOWLEDGE_DOCUMENT",
+    Action: "ACTION",
+    User: "USER",
+    UserEvent: "USER_EVENT",
+    EventTrigger: "EVENT_TRIGGER",
+    UserProfile: "USER_PROFILE",
+};

package/api/resources/commons/types/ErrorMessage.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ErrorMessage {
+    message?: string;
+}

package/api/resources/commons/types/ErrorMessage.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface Feedback {
+    /** The ID of the piece of feedback */
+    id: string;
+    /** The ID of the conversation the feedback is about */
+    conversationId: string;
+    /** The ID of the conversation message the feedback is about */
+    conversationMessageId: string;
+    /** The type of feedback */
+    type: MavenAGI.FeedbackType;
+    /** The feedback text */
+    text?: string;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/commons/types/FeedbackType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of feedback
+ */
+export declare type FeedbackType = "THUMBS_UP" | "THUMBS_DOWN" | "INSERT" | "HANDOFF";
+export declare const FeedbackType: {
+    readonly ThumbsUp: "THUMBS_UP";
+    readonly ThumbsDown: "THUMBS_DOWN";
+    readonly Insert: "INSERT";
+    readonly Handoff: "HANDOFF";
+};

package/api/resources/commons/types/FeedbackType.js

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const FeedbackType = {
+    ThumbsUp: "THUMBS_UP",
+    ThumbsDown: "THUMBS_DOWN",
+    Insert: "INSERT",
+    Handoff: "HANDOFF",
+};

package/api/resources/commons/types/User.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface User {
+    name?: string;
+    /** The unique ID of the user */
+    id?: Record<string, string>;
+    email?: string;
+    context?: Record<string, string>;
+}

package/api/resources/commons/types/User.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface UserData {
+    /** The value of the user metadata */
+    value: string;
+    /** The visibility of the user metadata */
+    visibility?: MavenAGI.VisibilityType;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/commons/types/VisibilityType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type VisibilityType = "VISIBLE" | "PARTIALLY_VISIBLE" | "HIDDEN";
+export declare const VisibilityType: {
+    readonly Visible: "VISIBLE";
+    readonly PartiallyVisible: "PARTIALLY_VISIBLE";
+    readonly Hidden: "HIDDEN";
+};

package/api/resources/commons/types/VisibilityType.js

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const VisibilityType = {
+    Visible: "VISIBLE",
+    PartiallyVisible: "PARTIALLY_VISIBLE",
+    Hidden: "HIDDEN",
+};

package/api/resources/commons/types/index.d.ts

@@ -0,0 +1,15 @@
+export * from "./ErrorMessage";
+export * from "./EntityType";
+export * from "./EntityIdBase";
+export * from "./EntityId";
+export * from "./User";
+export * from "./FeedbackType";
+export * from "./Feedback";
+export * from "./AppUserIdentification";
+export * from "./AppUserIdentifier";
+export * from "./AppUserIdentifyingPropertyType";
+export * from "./AppUser";
+export * from "./UserData";
+export * from "./VisibilityType";
+export * from "./AppUserRequest";
+export * from "./AppUserResponse";

package/api/resources/commons/types/index.js

@@ -0,0 +1,15 @@
+export * from "./ErrorMessage";
+export * from "./EntityType";
+export * from "./EntityIdBase";
+export * from "./EntityId";
+export * from "./User";
+export * from "./FeedbackType";
+export * from "./Feedback";
+export * from "./AppUserIdentification";
+export * from "./AppUserIdentifier";
+export * from "./AppUserIdentifyingPropertyType";
+export * from "./AppUser";
+export * from "./UserData";
+export * from "./VisibilityType";
+export * from "./AppUserRequest";
+export * from "./AppUserResponse";