mavenagi 0.0.0-alpha.4 → 0.0.0-alpha.6

package/api/resources/triggers/types/EventTriggerResponse.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         entityId: {
+ *             referenceId: "store-in-snowflake",
+ *             appId: "snowflake",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.EventTrigger
+ *         },
+ *         description: "Stores conversation data in Snowflake",
+ *         type: MavenAGI.EventTriggerType.ConversationCreated
+ *     }
+ */
+export interface EventTriggerResponse extends MavenAGI.EventTriggerBase {
+    /** ID that uniquely identifies this event trigger */
+    entityId: MavenAGI.EntityId;
+}

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

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

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

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

package/api/resources/{user → users}/client/Client.d.ts

@@ -4,13 +4,13 @@
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
 import * as MavenAGI from "../../../index";
-export declare namespace User {
+export declare namespace Users {
     interface Options {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
-        organizationId: core.Supplier<string>;
-        agentId: core.Supplier<string>;
+        xOrganizationId: core.Supplier<string>;
+        xAgentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -19,21 +19,21 @@ export declare namespace User {
         abortSignal?: AbortSignal;
     }
 }
-export declare class User {
-    protected readonly _options: User.Options;
-    constructor(_options: User.Options);
+export declare class Users {
+    protected readonly _options: Users.Options;
+    constructor(_options: Users.Options);
     /**
      * Create a new user or update an existing one
      *
      * @param {MavenAGI.AppUser} request
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
      * @throws {@link MavenAGI.BadRequestError}
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.user.upsertAppUser({
+     *     await client.users.upsertAppUser({
      *         id: "string",
      *         userIdentifiers: {
      *             identifiers: new Set([{}])
@@ -43,20 +43,20 @@ export declare class User {
      *         }
      *     })
      */
-    upsertAppUser(request: MavenAGI.AppUser, requestOptions?: User.RequestOptions): Promise<MavenAGI.AppUser>;
+    upsertAppUser(request: MavenAGI.AppUser, requestOptions?: Users.RequestOptions): Promise<MavenAGI.AppUser>;
     /**
      * Get a user
      *
      * @param {string} userId - The ID of the user to get
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
      * @throws {@link MavenAGI.BadRequestError}
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.user.getAppUser("string")
+     *     await client.users.getAppUser("string")
      */
-    getAppUser(userId: string, requestOptions?: User.RequestOptions): Promise<MavenAGI.AppUser>;
+    getAppUser(userId: string, requestOptions?: Users.RequestOptions): Promise<MavenAGI.AppUser>;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/api/resources/{user → users}/client/Client.js

@@ -16,7 +16,7 @@ import * as MavenAGI from "../../../index";
 import * as serializers from "../../../../serialization/index";
 import urlJoin from "url-join";
 import * as errors from "../../../../errors/index";
-export class User {
+export class Users {
     constructor(_options) {
         this._options = _options;
     }
@@ -24,14 +24,14 @@ export class User {
      * Create a new user or update an existing one
      *
      * @param {MavenAGI.AppUser} request
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
      * @throws {@link MavenAGI.BadRequestError}
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.user.upsertAppUser({
+     *     await client.users.upsertAppUser({
      *         id: "string",
      *         userIdentifiers: {
      *             identifiers: new Set([{}])
@@ -49,11 +49,11 @@ export class User {
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
-                    "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
-                    "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
+                    "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
+                    "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.4",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -120,14 +120,14 @@ export class User {
      * Get a user
      *
      * @param {string} userId - The ID of the user to get
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
      * @throws {@link MavenAGI.BadRequestError}
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.user.getAppUser("string")
+     *     await client.users.getAppUser("string")
      */
     getAppUser(userId, requestOptions) {
         var _a, _b;
@@ -137,11 +137,11 @@ export class User {
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
-                    "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
-                    "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
+                    "X-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
+                    "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.4",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/dist/Client.d.ts

@@ -7,14 +7,14 @@ import { Actions } from "./api/resources/actions/client/Client";
 import { Conversation } from "./api/resources/conversation/client/Client";
 import { Knowledge } from "./api/resources/knowledge/client/Client";
 import { Triggers } from "./api/resources/triggers/client/Client";
-import { User } from "./api/resources/user/client/Client";
+import { Users } from "./api/resources/users/client/Client";
 export declare namespace MavenAGIClient {
     interface Options {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
-        organizationId: core.Supplier<string>;
-        agentId: core.Supplier<string>;
+        xOrganizationId: core.Supplier<string>;
+        xAgentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -34,6 +34,6 @@ export declare class MavenAGIClient {
     get knowledge(): Knowledge;
     protected _triggers: Triggers | undefined;
     get triggers(): Triggers;
-    protected _user: User | undefined;
-    get user(): User;
+    protected _users: Users | undefined;
+    get users(): Users;
 }

package/dist/Client.js

@@ -5,7 +5,7 @@ import { Actions } from "./api/resources/actions/client/Client";
 import { Conversation } from "./api/resources/conversation/client/Client";
 import { Knowledge } from "./api/resources/knowledge/client/Client";
 import { Triggers } from "./api/resources/triggers/client/Client";
-import { User } from "./api/resources/user/client/Client";
+import { Users } from "./api/resources/users/client/Client";
 export class MavenAGIClient {
     constructor(_options) {
         this._options = _options;
@@ -26,8 +26,8 @@ export class MavenAGIClient {
         var _a;
         return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Triggers(this._options)));
     }
-    get user() {
+    get users() {
         var _a;
-        return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new User(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Users(this._options)));
     }
 }

package/dist/api/resources/actions/client/Client.d.ts

@@ -9,8 +9,8 @@ export declare namespace Actions {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
-        organizationId: core.Supplier<string>;
-        agentId: core.Supplier<string>;
+        xOrganizationId: core.Supplier<string>;
+        xAgentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -22,55 +22,10 @@ export declare namespace Actions {
 export declare class Actions {
     protected readonly _options: Actions.Options;
     constructor(_options: Actions.Options);
-    /**
-     * Update an action set or create it if it doesn't exist
-     *
-     * @param {MavenAGI.ActionSetRequest} request
-     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link MavenAGI.NotFoundError}
-     * @throws {@link MavenAGI.BadRequestError}
-     * @throws {@link MavenAGI.ServerError}
-     *
-     * @example
-     *     await client.actions.createActionSet({
-     *         id: "string",
-     *         name: "string"
-     *     })
-     */
-    createActionSet(request: MavenAGI.ActionSetRequest, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionSetResponse>;
-    /**
-     * Get an action set by its supplied ID
-     *
-     * @param {string} actionSetId - The ID of the action set to get
-     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link MavenAGI.NotFoundError}
-     * @throws {@link MavenAGI.BadRequestError}
-     * @throws {@link MavenAGI.ServerError}
-     *
-     * @example
-     *     await client.actions.getActionSet("string")
-     */
-    getActionSet(actionSetId: string, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionSetResponse>;
-    /**
-     * Delete an action set
-     *
-     * @param {string} actionSetId - The ID of the action set to delete
-     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link MavenAGI.NotFoundError}
-     * @throws {@link MavenAGI.BadRequestError}
-     * @throws {@link MavenAGI.ServerError}
-     *
-     * @example
-     *     await client.actions.deleteActionSet("string")
-     */
-    deleteActionSet(actionSetId: string, requestOptions?: Actions.RequestOptions): Promise<void>;
     /**
      * Update an action or create it if it doesn't exist
      *
-     * @param {MavenAGI.Action} request
+     * @param {MavenAGI.ActionRequest} request
      * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -78,23 +33,22 @@ export declare class Actions {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.actions.registerAction({
-     *         id: "string",
-     *         actionSetId: "string",
-     *         appId: "string",
-     *         name: "string",
-     *         description: "string",
-     *         userInteractionRequired: true,
-     *         buttonName: "string",
-     *         requiredUserContextFieldNames: new Set(["string"]),
-     *         userFormParameters: [{}]
+     *     await client.actions.createOrUpdateAction({
+     *         entityId: {
+     *             referenceId: "get-balance"
+     *         },
+     *         name: "Get the user's balance",
+     *         description: "This action calls an API to get the user's current balance.",
+     *         userInteractionRequired: false,
+     *         requiredUserContextFieldNames: new Set(["my-billing-system.userId"]),
+     *         userFormParameters: []
      *     })
      */
-    registerAction(request: MavenAGI.Action, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.Action>;
+    createOrUpdateAction(request: MavenAGI.ActionRequest, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
     /**
      * Get an action by its supplied ID
      *
-     * @param {string} actionId - The ID of the action to get
+     * @param {string} referenceId - The reference ID of the action to get. All other entity ID fields are inferred from the request.
      * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -102,13 +56,13 @@ export declare class Actions {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.actions.getAction("string")
+     *     await client.actions.getAction("get-balance")
      */
-    getAction(actionId: string, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.Action>;
+    getAction(referenceId: string, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
     /**
      * Delete an action
      *
-     * @param {string} actionId - The ID of the action to delete
+     * @param {string} referenceId - The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
      * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -116,8 +70,8 @@ export declare class Actions {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.actions.deleteAction("string")
+     *     await client.actions.deleteAction("get-balance")
      */
-    deleteAction(actionId: string, requestOptions?: Actions.RequestOptions): Promise<void>;
+    deleteAction(referenceId: string, requestOptions?: Actions.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }