mavenagi 0.0.0-alpha.2 → 0.0.0-alpha.4

package/Client.d.ts

@@ -3,8 +3,11 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
+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";
 export declare namespace MavenAGIClient {
     interface Options {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
@@ -23,8 +26,14 @@ export declare namespace MavenAGIClient {
 export declare class MavenAGIClient {
     protected readonly _options: MavenAGIClient.Options;
     constructor(_options: MavenAGIClient.Options);
+    protected _actions: Actions | undefined;
+    get actions(): Actions;
     protected _conversation: Conversation | undefined;
     get conversation(): Conversation;
     protected _knowledge: Knowledge | undefined;
     get knowledge(): Knowledge;
+    protected _triggers: Triggers | undefined;
+    get triggers(): Triggers;
+    protected _user: User | undefined;
+    get user(): User;
 }

package/Client.js

@@ -1,12 +1,19 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+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";
 export class MavenAGIClient {
     constructor(_options) {
         this._options = _options;
     }
+    get actions() {
+        var _a;
+        return ((_a = this._actions) !== null && _a !== void 0 ? _a : (this._actions = new Actions(this._options)));
+    }
     get conversation() {
         var _a;
         return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Conversation(this._options)));
@@ -15,4 +22,12 @@ export class MavenAGIClient {
         var _a;
         return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Knowledge(this._options)));
     }
+    get triggers() {
+        var _a;
+        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Triggers(this._options)));
+    }
+    get user() {
+        var _a;
+        return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new User(this._options)));
+    }
 }

package/README.md

@@ -16,18 +16,18 @@ npm i -s mavenagi
 Instantiate and use the client with the following:
 
 ```typescript
+import * as environments from "../src/environments";
 import { MavenAGIClient } from "mavenagi";
 
-const mavenAgi = new MavenAGIClient({
+const client = new MavenAGIClient({
     appId: "YOUR_APP_ID",
     appSecret: "YOUR_APP_SECRET",
     organizationId: "YOUR_ORGANIZATION_ID",
     agentId: "YOUR_AGENT_ID",
 });
-await mavenAgi.conversation.initialize({
-    messages: [{}],
+await client.actions.createActionSet({
     id: "string",
-    context: {},
+    name: "string",
 });
 ```
 
@@ -37,10 +37,10 @@ When the API returns a non-success status code (4xx or 5xx response), a subclass
 will be thrown.
 
 ```typescript
-import { MavenAGIError } from 'mavenagi';
+import { MavenAGIError } from "mavenagi";
 
 try {
-    await mavenAgi.initialize(...);
+    await client.createActionSet(...);
 } catch (err) {
     if (err instanceof MavenAGIError) {
         console.log(err.statusCode);
@@ -50,43 +50,13 @@ try {
 }
 ```
 
-## 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 mavenAgi.initialize(..., {
-    maxRetries: 0 // override maxRetries at the request level
-});
-```
-
-## Timeouts
-
-The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
-
-```typescript
-const response = await mavenAgi.initialize(..., {
-    timeoutInSeconds: 30 // override timeout to 30s
-});
-```
-
 ## Aborting Requests
 
 The SDK allows users to abort requests at any point by passing in an abort signal.
 
 ```typescript
 const controller = new AbortController();
-const response = await mavenAgi.initialize(..., {
+const response = await client.createActionSet(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -110,14 +80,68 @@ The SDK provides a way for your to customize the underlying HTTP client / Fetch
 unsupported environment, this provides a way for you to break glass and ensure the SDK works.
 
 ```typescript
-import { MavenAGIClient } from 'mavenagi';
+import { MavenAGIClient } from "mavenagi";
 
-const mavenAgi = new MavenAGIClient({
+const client = new MavenAGIClient({
     ...
     fetcher: // provide your implementation here
 });
 ```
 
+## 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(..., {
+    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(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.createActionSet(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
 ## Contributing
 
 While we value open-source contributions to this SDK, this library is generated programmatically.

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

@@ -0,0 +1,123 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as MavenAGI from "../../../index";
+export declare namespace Actions {
+    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>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+        abortSignal?: AbortSignal;
+    }
+}
+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 {Actions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @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: [{}]
+     *     })
+     */
+    registerAction(request: MavenAGI.Action, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.Action>;
+    /**
+     * Get an action by its supplied ID
+     *
+     * @param {string} actionId - The ID of the action 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.getAction("string")
+     */
+    getAction(actionId: string, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.Action>;
+    /**
+     * Delete an action
+     *
+     * @param {string} actionId - The ID of the action 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.deleteAction("string")
+     */
+    deleteAction(actionId: string, requestOptions?: Actions.RequestOptions): Promise<void>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}