@gleanwork/api-client 0.3.0 → 0.4.1

package/docs/sdks/chat/README.md

@@ -26,7 +26,9 @@ Have a conversation with Glean AI.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -60,7 +62,9 @@ import { clientChatCreate } from "@gleanwork/api-client/funcs/clientChatCreate.j
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -136,7 +140,9 @@ Deletes all saved Chats a user has had and all their contained conversational co
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -159,7 +165,9 @@ import { clientChatDeleteAll } from "@gleanwork/api-client/funcs/clientChatDelet
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -223,15 +231,14 @@ Deletes saved Chats and all their contained conversational content.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   await glean.client.chat.delete({
-    ids: [
-      "<value>",
-      "<value>",
-    ],
+    ids: [],
   });
 
 
@@ -251,15 +258,14 @@ import { clientChatDelete } from "@gleanwork/api-client/funcs/clientChatDelete.j
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const res = await clientChatDelete(glean, {
-    ids: [
-      "<value>",
-      "<value>",
-    ],
+    ids: [],
   });
 
   if (!res.ok) {
@@ -321,7 +327,9 @@ Retrieves the chat history between Glean Assistant and the user for a given Chat
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -347,7 +355,9 @@ import { clientChatRetrieve } from "@gleanwork/api-client/funcs/clientChatRetrie
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -415,7 +425,9 @@ Retrieves all the saved Chats between Glean Assistant and the user. The returned
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -439,7 +451,9 @@ import { clientChatList } from "@gleanwork/api-client/funcs/clientChatList.js";
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -504,7 +518,9 @@ Gets the Chat application details for the specified application ID.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -530,7 +546,9 @@ import { clientChatRetrieveApplication } from "@gleanwork/api-client/funcs/clien
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -596,14 +614,22 @@ Upload files for Chat.
 
 ```typescript
 import { Glean } from "@gleanwork/api-client";
+import { openAsBlob } from "node:fs";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const result = await glean.client.chat.uploadFiles({
-    files: [],
+    files: [
+      {
+        fileName: "example.file",
+        content: await openAsBlob("example.file"),
+      },
+    ],
   });
 
   // Handle the result
@@ -620,16 +646,24 @@ The standalone function version of this method:
 ```typescript
 import { GleanCore } from "@gleanwork/api-client/core.js";
 import { clientChatUploadFiles } from "@gleanwork/api-client/funcs/clientChatUploadFiles.js";
+import { openAsBlob } from "node:fs";
 
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const res = await clientChatUploadFiles(glean, {
-    files: [],
+    files: [
+      {
+        fileName: "example.file",
+        content: await openAsBlob("example.file"),
+      },
+    ],
   });
 
   if (!res.ok) {
@@ -692,12 +726,16 @@ Get files uploaded by a user for Chat.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const result = await glean.client.chat.retrieveFiles({
-    fileIds: [],
+    fileIds: [
+      "<value 1>",
+    ],
   });
 
   // Handle the result
@@ -718,12 +756,16 @@ import { clientChatRetrieveFiles } from "@gleanwork/api-client/funcs/clientChatR
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const res = await clientChatRetrieveFiles(glean, {
-    fileIds: [],
+    fileIds: [
+      "<value 1>",
+    ],
   });
 
   if (!res.ok) {
@@ -786,13 +828,17 @@ Delete files uploaded by a user for Chat.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   await glean.client.chat.deleteFiles({
     fileIds: [
-      "<value>",
+      "<value 1>",
+      "<value 2>",
+      "<value 3>",
     ],
   });
 
@@ -813,13 +859,17 @@ import { clientChatDeleteFiles } from "@gleanwork/api-client/funcs/clientChatDel
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const res = await clientChatDeleteFiles(glean, {
     fileIds: [
-      "<value>",
+      "<value 1>",
+      "<value 2>",
+      "<value 3>",
     ],
   });
 
@@ -882,7 +932,9 @@ Have a conversation with Glean AI.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -916,7 +968,9 @@ import { clientChatCreateStream } from "@gleanwork/api-client/funcs/clientChatCr
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {

package/docs/sdks/clientauthentication/README.md

@@ -17,7 +17,9 @@ Creates an authentication token for the authenticated user.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -41,7 +43,9 @@ import { clientAuthenticationCreateToken } from "@gleanwork/api-client/funcs/cli
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {

package/docs/sdks/clientdocuments/README.md

@@ -20,7 +20,9 @@ Read the emails of all users who have access to the given document.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -44,7 +46,9 @@ import { clientDocumentsRetrievePermissions } from "@gleanwork/api-client/funcs/
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -109,7 +113,9 @@ Read the documents including metadata (does not include enhanced metadata via `/
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -133,7 +139,9 @@ import { clientDocumentsRetrieve } from "@gleanwork/api-client/funcs/clientDocum
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -198,7 +206,9 @@ Read the documents including metadata (does not include enhanced metadata via `/
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -259,7 +269,9 @@ import { clientDocumentsRetrieveByFacets } from "@gleanwork/api-client/funcs/cli
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -361,13 +373,17 @@ Generate an AI summary of the requested documents.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const result = await glean.client.documents.summarize({
     documentSpecs: [
       {},
+      {},
+      {},
     ],
   });
 
@@ -389,13 +405,17 @@ import { clientDocumentsSummarize } from "@gleanwork/api-client/funcs/clientDocu
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const res = await clientDocumentsSummarize(glean, {
     documentSpecs: [
       {},
+      {},
+      {},
     ],
   });