mavenagi 0.0.0-alpha.11 → 0.0.0-alpha.12

package/Client.d.ts

@@ -13,14 +13,23 @@ export declare namespace MavenAGIClient {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
         organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
     }
 }
 export declare class MavenAGIClient {

package/README.md

@@ -16,7 +16,6 @@ npm i -s mavenagi
 Instantiate and use the client with the following:
 
 ```typescript
-import * as environments from "../src/environments";
 import { MavenAGIClient, MavenAGI } from "mavenagi";
 
 const client = new MavenAGIClient({
@@ -48,7 +47,7 @@ will be thrown.
 import { MavenAGIError } from "mavenagi";
 
 try {
-    await client.initialize(...);
+    await client.conversation.initialize(...);
 } catch (err) {
     if (err instanceof MavenAGIError) {
         console.log(err.statusCode);
@@ -113,7 +112,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.initialize(..., {
+const response = await client.conversation.initialize(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -123,11 +122,49 @@ const response = await client.initialize(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.initialize(..., {
+const response = await client.conversation.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 client.conversation.initialize(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Runtime Compatibility
+
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
+runtimes:
+
+-   Node.js 18+
+-   Vercel
+-   Cloudflare Workers
+-   Deno v1.25+
+-   Bun 1.0+
+-   React Native
+
+### Customizing Fetch Client
+
+The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+
+```typescript
+import { MavenAGIClient } from "mavenagi";
+
+const client = new MavenAGIClient({
+    ...
+    fetcher: // provide your implementation here
+});
+```
+
 ## Contributing
 
 While we value open-source contributions to this SDK, this library is generated programmatically.

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

@@ -9,14 +9,23 @@ export declare namespace Actions {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
         organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
     }
 }
 export declare class Actions {

package/api/resources/actions/client/Client.js

@@ -56,18 +56,19 @@ export class Actions {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.11",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
-                body: yield serializers.ActionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                requestType: "json",
+                body: serializers.ActionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.ActionResponse.parseOrThrow(_response.body, {
+                return serializers.ActionResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -77,21 +78,21 @@ export class Actions {
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 404:
-                        throw new MavenAGI.NotFoundError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 400:
-                        throw new MavenAGI.BadRequestError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 500:
-                        throw new MavenAGI.ServerError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -144,17 +145,18 @@ export class Actions {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.11",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
+                requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.ActionResponse.parseOrThrow(_response.body, {
+                return serializers.ActionResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -164,21 +166,21 @@ export class Actions {
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 404:
-                        throw new MavenAGI.NotFoundError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 400:
-                        throw new MavenAGI.BadRequestError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 500:
-                        throw new MavenAGI.ServerError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -231,11 +233,12 @@ export class Actions {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.11",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
+                requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -246,21 +249,21 @@ export class Actions {
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 404:
-                        throw new MavenAGI.NotFoundError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 400:
-                        throw new MavenAGI.BadRequestError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 500:
-                        throw new MavenAGI.ServerError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,

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

@@ -1,7 +1,7 @@
 /**
  * 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 type EntityType = "CONVERSATION" | "CONVERSATION_MESSAGE" | "KNOWLEDGE_BASE" | "KNOWLEDGE_DOCUMENT" | "ACTION" | "USER" | "USER_EVENT" | "EVENT_TRIGGER" | "USER_PROFILE" | "FEEDBACK";
 export declare const EntityType: {
     readonly Conversation: "CONVERSATION";
     readonly ConversationMessage: "CONVERSATION_MESSAGE";
@@ -12,4 +12,5 @@ export declare const EntityType: {
     readonly UserEvent: "USER_EVENT";
     readonly EventTrigger: "EVENT_TRIGGER";
     readonly UserProfile: "USER_PROFILE";
+    readonly Feedback: "FEEDBACK";
 };

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

@@ -11,4 +11,5 @@ export const EntityType = {
     UserEvent: "USER_EVENT",
     EventTrigger: "EVENT_TRIGGER",
     UserProfile: "USER_PROFILE",
+    Feedback: "FEEDBACK",
 };

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface FeedbackBase {
+    /** The type of feedback */
+    type: MavenAGI.FeedbackType;
+    /** The feedback text */
+    text?: string;
+}

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

@@ -3,8 +3,8 @@ export * from "./EntityType";
 export * from "./EntityIdBase";
 export * from "./EntityId";
 export * from "./User";
+export * from "./FeedbackBase";
 export * from "./FeedbackType";
-export * from "./Feedback";
 export * from "./AppUserIdentification";
 export * from "./AppUserIdentifier";
 export * from "./AppUserIdentifyingPropertyType";

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

@@ -3,8 +3,8 @@ export * from "./EntityType";
 export * from "./EntityIdBase";
 export * from "./EntityId";
 export * from "./User";
+export * from "./FeedbackBase";
 export * from "./FeedbackType";
-export * from "./Feedback";
 export * from "./AppUserIdentification";
 export * from "./AppUserIdentifier";
 export * from "./AppUserIdentifyingPropertyType";

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

@@ -9,14 +9,23 @@ export declare namespace Conversation {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
         organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
     }
 }
 export declare class Conversation {
@@ -140,9 +149,15 @@ export declare class Conversation {
      *
      * @example
      *     await client.conversation.createFeedback({
-     *         id: "string",
-     *         conversationId: "string",
-     *         conversationMessageId: "string",
+     *         feedbackId: {
+     *             referenceId: "string"
+     *         },
+     *         conversationId: {
+     *             referenceId: "string"
+     *         },
+     *         conversationMessageId: {
+     *             referenceId: "string"
+     *         },
      *         type: MavenAGI.FeedbackType.ThumbsUp,
      *         text: "string"
      *     })