@gleanwork/api-client 0.4.1 → 0.4.3

package/docs/sdks/tools/README.md

@@ -0,0 +1,214 @@
+# Tools
+(*client.tools*)
+
+## Overview
+
+### Available Operations
+
+* [list](#list) - List available tools
+* [run](#run) - Execute the specified tool
+
+## list
+
+Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned.
+
+### Example Usage
+
+```typescript
+import { Glean } from "@gleanwork/api-client";
+
+const glean = new Glean({
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await glean.client.tools.list();
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GleanCore } from "@gleanwork/api-client/core.js";
+import { clientToolsList } from "@gleanwork/api-client/funcs/clientToolsList.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"] ?? "",
+});
+
+async function run() {
+  const res = await clientToolsList(glean);
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useClientToolsList,
+  useClientToolsListSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchClientToolsList,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateClientToolsList,
+  invalidateAllClientToolsList,
+} from "@gleanwork/api-client/react-query/clientToolsList.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `toolNames`                                                                                                                                                                    | *string*[]                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                             | Optional array of tool names to filter by                                                                                                                                      |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.ToolsListResponse](../../models/components/toolslistresponse.md)\>**
+
+### Errors
+
+| Error Type        | Status Code       | Content Type      |
+| ----------------- | ----------------- | ----------------- |
+| errors.GleanError | 4XX, 5XX          | \*/\*             |
+
+## run
+
+Execute the specified tool with provided parameters
+
+### Example Usage
+
+```typescript
+import { Glean } from "@gleanwork/api-client";
+
+const glean = new Glean({
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await glean.client.tools.run({
+    name: "<value>",
+    parameters: {
+      "key": {
+        name: "<value>",
+        value: "<value>",
+      },
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GleanCore } from "@gleanwork/api-client/core.js";
+import { clientToolsRun } from "@gleanwork/api-client/funcs/clientToolsRun.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"] ?? "",
+});
+
+async function run() {
+  const res = await clientToolsRun(glean, {
+    name: "<value>",
+    parameters: {
+      "key": {
+        name: "<value>",
+        value: "<value>",
+      },
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useClientToolsRunMutation
+} from "@gleanwork/api-client/react-query/clientToolsRun.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.ToolsCallRequest](../../models/components/toolscallrequest.md)                                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.ToolsCallResponse](../../models/components/toolscallresponse.md)\>**
+
+### Errors
+
+| Error Type        | Status Code       | Content Type      |
+| ----------------- | ----------------- | ----------------- |
+| errors.GleanError | 4XX, 5XX          | \*/\*             |

package/docs/sdks/verification/README.md

@@ -19,9 +19,7 @@ Creates a verification reminder for the document. Users can create verification
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  security: {
-    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-  },
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -47,9 +45,7 @@ import { clientVerificationAddReminder } 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({
-  security: {
-    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-  },
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -116,9 +112,7 @@ Returns the information to be rendered in verification dashboard. Includes infor
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  security: {
-    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-  },
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -142,9 +136,7 @@ import { clientVerificationList } from "@gleanwork/api-client/funcs/clientVerifi
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  security: {
-    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-  },
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -209,9 +201,7 @@ Verify documents to keep the knowledge up to date within customer corpus.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  security: {
-    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-  },
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -237,9 +227,7 @@ import { clientVerificationVerify } from "@gleanwork/api-client/funcs/clientVeri
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  security: {
-    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-  },
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {

package/docs/sdks/visibilityoverrides/README.md

@@ -18,9 +18,7 @@ Fetches the visibility override status of the documents passed.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  security: {
-    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-  },
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -44,9 +42,7 @@ import { clientGovernanceDocumentsVisibilityoverridesList } from "@gleanwork/api
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  security: {
-    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-  },
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -122,9 +118,7 @@ Sets the visibility-override state of the documents specified, effectively hidin
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  security: {
-    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-  },
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -148,9 +142,7 @@ import { clientGovernanceDocumentsVisibilityoverridesCreate } from "@gleanwork/a
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  security: {
-    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-  },
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@gleanwork/api-client",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gleanwork/api-client",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {
@@ -59,7 +59,7 @@
     "typescript": "^5.4.5",
     "typescript-eslint": "^8.22.0",
     "vitest": "^3.0.2",
-    "zod": "^3.23.4"
+    "zod": "^3.25.17"
   },
   "dependencies": {},
   "exports": {

package/src/__tests__/activity.test.ts

@@ -12,9 +12,7 @@ test("Activity Activity", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   await glean.client.activity.report({
@@ -51,9 +49,7 @@ test("Activity Feedback", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   await glean.client.activity.feedback({

package/src/__tests__/adminsearch.test.ts

@@ -13,9 +13,7 @@ test("Admin Search Adminsearch", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.search.queryAsAdmin({

package/src/__tests__/agents.test.ts

@@ -30,9 +30,7 @@ test("Agents Get Agent", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.agents.retrieve("<id>");
@@ -45,9 +43,7 @@ test("Agents Get Agent Schemas", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.agents.retrieveSchemas("<id>");
@@ -60,9 +56,7 @@ test("Agents Search Agents", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.agents.list({});
@@ -81,9 +75,7 @@ test("Agents Create And Wait Run", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.agents.run({});

package/src/__tests__/announcements.test.ts

@@ -13,9 +13,7 @@ test("Announcements Createannouncement", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.announcements.create({
@@ -1775,9 +1773,7 @@ test("Announcements Deleteannouncement", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   await glean.client.announcements.delete({
@@ -1791,9 +1787,7 @@ test("Announcements Updateannouncement", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.announcements.update({

package/src/__tests__/answers.test.ts

@@ -13,9 +13,7 @@ test("Answers Createanswer", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.answers.create({
@@ -730,9 +728,7 @@ test("Answers Deleteanswer", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   await glean.client.answers.delete({
@@ -747,9 +743,7 @@ test("Answers Editanswer", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.answers.update({
@@ -1544,9 +1538,7 @@ test("Answers Getanswer", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.answers.retrieve({
@@ -1562,9 +1554,7 @@ test("Answers Listanswers", async () => {
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
     httpClient: testHttpClient,
-    security: {
-      apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
-    },
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
   const result = await glean.client.answers.list({});