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

package/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/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/README.md

@@ -17,17 +17,23 @@ Instantiate and use the client with the following:
 
 ```typescript
 import * as environments from "../src/environments";
-import { MavenAGIClient } from "mavenagi";
+import { MavenAGIClient, MavenAGI } from "mavenagi";
 
 const client = new MavenAGIClient({
     appId: "YOUR_APP_ID",
     appSecret: "YOUR_APP_SECRET",
-    organizationId: "YOUR_ORGANIZATION_ID",
-    agentId: "YOUR_AGENT_ID",
+    xOrganizationId: "YOUR_X_ORGANIZATION_ID",
+    xAgentId: "YOUR_X_AGENT_ID",
 });
-await client.actions.createActionSet({
+await client.conversation.initialize({
+    messages: [{}],
+    context: {},
     id: "string",
-    name: "string",
+    responseConfig: {
+        capabilities: [MavenAGI.Capability.Markdown],
+        isCopilot: true,
+        responseLength: MavenAGI.ResponseLength.Short,
+    },
 });
 ```
 
@@ -40,7 +46,7 @@ will be thrown.
 import { MavenAGIError } from "mavenagi";
 
 try {
-    await client.createActionSet(...);
+    await client.initialize(...);
 } catch (err) {
     if (err instanceof MavenAGIError) {
         console.log(err.statusCode);
@@ -56,7 +62,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.createActionSet(..., {
+const response = await client.initialize(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -105,29 +111,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.createActionSet(..., {
-    maxRetries: 0 // override maxRetries at the request level
-});
-```
-
-## Advanced
-
-### Retries
-
-The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
-as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
-retry limit (default: 2).
-
-A request is deemed retriable when any of the following HTTP status codes is returned:
-
--   [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
--   [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
--   [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
-
-Use the `maxRetries` request option to configure this behavior.
-
-```typescript
-const response = await client.createActionSet(..., {
+const response = await client.initialize(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -137,7 +121,7 @@ const response = await client.createActionSet(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.createActionSet(..., {
+const response = await client.initialize(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```

package/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>;
 }