@gleanwork/api-client 0.10.5 → 0.11.1

package/docs/sdks/visibilityoverrides/README.md

@@ -14,6 +14,7 @@ Fetches the visibility override status of the documents passed.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getdocvisibility" method="get" path="/rest/api/v1/governance/documents/visibilityoverrides" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -24,7 +25,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.documents.visibilityoverrides.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -47,15 +47,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDocumentsVisibilityoverridesList(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDocumentsVisibilityoverridesList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -114,6 +111,7 @@ Sets the visibility-override state of the documents specified, effectively hidin
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="setdocvisibility" method="post" path="/rest/api/v1/governance/documents/visibilityoverrides" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -124,7 +122,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.documents.visibilityoverrides.create({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -147,15 +144,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDocumentsVisibilityoverridesCreate(glean, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDocumentsVisibilityoverridesCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/examples/README.md

@@ -1,29 +1,31 @@
-# Examples
+# @gleanwork/api-client Examples
 
-## Run an example
+This directory contains example scripts demonstrating how to use the @gleanwork/api-client SDK.
 
-```bash
-# 1. cd into the root of the repo
-cd api-client-typescript 
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
 
-# 2. Install dependencies
-npm install
+## Setup
 
-# 3. Build the project
-npm run build
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
 
-# 4. cd into the examples directory
-cd examples/
+2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
 
-# 5. Fill in the .env file
-cp .env.example .env
+## Running the Examples
 
-# 6. Install dependencies
-npm install
+To run an example file from the examples directory:
 
-# 7. Run the script
-npm run script -- ./src/example.ts
+```bash
+npm run build && npx tsx example.ts
 ```
 
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
 
 

package/examples/clientChatCreate.example.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import dotenv from "dotenv";
+dotenv.config();
+/**
+ * Example usage of the @gleanwork/api-client SDK
+ *
+ * To run this example from the examples directory:
+ * npm run build && npx tsx clientChatCreate.example.ts
+ */
+
+import { Glean } from "@gleanwork/api-client";
+
+const glean = new Glean({
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+});
+
+async function main() {
+  const result = await glean.client.chat.create({
+    messages: [
+      {
+        fragments: [
+          {
+            text: "What are the company holidays this year?",
+          },
+        ],
+      },
+    ],
+  });
+
+  console.log(result);
+}
+
+main().catch(console.error);

package/examples/package-lock.json

@@ -1,25 +1,27 @@
 {
-  "name": "examples",
+  "name": "@gleanwork/api-client-examples",
   "version": "1.0.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
-      "name": "examples",
+      "name": "@gleanwork/api-client-examples",
       "version": "1.0.0",
-      "license": "ISC",
       "dependencies": {
-        "@gleanwork/api-client": "file:../",
-        "dotenv": "^16.4.7"
+        "@gleanwork/api-client": "file:.."
       },
       "devDependencies": {
-        "@types/node": "^20.11.4",
+        "@types/node": "^20.0.0",
+        "dotenv": "^16.4.5",
         "tsx": "^4.19.2"
       }
     },
     "..": {
       "name": "@gleanwork/api-client",
-      "version": "0.1.0-beta",
+      "version": "0.11.1",
+      "dependencies": {
+        "zod": "^3.20.0"
+      },
       "devDependencies": {
         "@eslint/js": "^9.19.0",
         "@tanstack/react-query": "^5.61.4",
@@ -28,16 +30,14 @@
         "eslint": "^9.19.0",
         "globals": "^15.14.0",
         "tshy": "^2.0.0",
-        "typescript": "^5.4.5",
-        "typescript-eslint": "^8.22.0",
-        "vitest": "^3.0.2",
-        "zod": "^3.23.4"
+        "typescript": "~5.8.3",
+        "typescript-eslint": "^8.26.0",
+        "vitest": "^3.0.2"
       },
       "peerDependencies": {
         "@tanstack/react-query": "^5",
         "react": "^18 || ^19",
-        "react-dom": "^18 || ^19",
-        "zod": ">= 3"
+        "react-dom": "^18 || ^19"
       },
       "peerDependenciesMeta": {
         "@tanstack/react-query": {
@@ -452,6 +452,7 @@
       "version": "16.4.7",
       "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.4.7.tgz",
       "integrity": "sha512-47qPchRCykZC03FhkYAhrvwU4xDBFIj1QPqaarj6mdM/hgUzfPHcpkHJOn3mJAufFeeAxAzeGsr5X0M4k6fLZQ==",
+      "dev": true,
       "engines": {
         "node": ">=12"
       },

package/examples/package.json

@@ -1,22 +1,18 @@
 {
-  "name": "examples",
+  "name": "@gleanwork/api-client-examples",
   "version": "1.0.0",
-  "description": "",
-  "type": "module",
-  "main": "main.js",
+  "private": true,
   "scripts": {
-    "script": "tsx",
-    "start": "npm run script -- ./src/example.ts"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "dotenv": "^16.4.7",
-    "@gleanwork/api-client": "file:../"
+    "build:parent": "cd .. && npm i && npm run build && cd -",
+    "build:examples": "npm i",
+    "build": "npm run build:parent && npm run build:examples"
   },
   "devDependencies": {
-    "@types/node": "^20.11.4",
+    "@types/node": "^20.0.0",
+    "dotenv": "^16.4.5",
     "tsx": "^4.19.2"
+  },
+  "dependencies": {
+    "@gleanwork/api-client": "file:.."
   }
-}
+}

package/jsr.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gleanwork/api-client",
-  "version": "0.10.5",
+  "version": "0.11.1",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {
@@ -34,8 +34,7 @@
   "peerDependencies": {
     "@tanstack/react-query": "^5",
     "react": "^18 || ^19",
-    "react-dom": "^18 || ^19",
-    "zod": ">= 3"
+    "react-dom": "^18 || ^19"
   },
   "peerDependenciesMeta": {
     "@tanstack/react-query": {
@@ -56,12 +55,13 @@
     "eslint": "^9.19.0",
     "globals": "^15.14.0",
     "tshy": "^2.0.0",
-    "typescript": "^5.4.5",
-    "typescript-eslint": "^8.22.0",
-    "vitest": "^3.0.2",
-    "zod": "^3.25.17"
+    "typescript": "~5.8.3",
+    "typescript-eslint": "^8.26.0",
+    "vitest": "^3.0.2"
+  },
+  "dependencies": {
+    "zod": "^3.20.0"
   },
-  "dependencies": {},
   "exports": {
     ".": {
       "import": {

package/src/__tests__/agents.test.ts

@@ -58,7 +58,7 @@ it.skip("Agents Search Agents", async () => {
 
 it.skip("Agents Create And Stream Run", async () => {
   assert.fail(
-    "incomplete test found please make sure to address the following errors: [`workflow step createAndStreamRun.test referencing operation createAndStreamRun is not currently supported`]",
+    "incomplete test found please make sure to address the following errors: [`workflow step createAndStreamRun.test referencing operation createAndStreamRun is missing required request body`]",
   );
 });
 

package/src/__tests__/summarize.test.ts

@@ -18,10 +18,12 @@ test("Summarize Summarize", async () => {
   const result = await glean.client.documents.summarize({
     documentSpecs: [
       {
-        url: "https://vivid-bourgeoisie.com/",
+        ugcType: "SHORTCUTS",
+        contentId: 602763,
       },
       {
-        url: "https://sorrowful-hutch.name",
+        ugcType: "SHORTCUTS",
+        contentId: 602763,
       },
     ],
   });

package/src/funcs/clientActivityFeedback.ts

@@ -12,7 +12,7 @@ import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
 import * as components from "../models/components/index.js";
-import { GleanError } from "../models/errors/gleanerror.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -20,6 +20,7 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
@@ -39,13 +40,14 @@ export function clientActivityFeedback(
 ): APIPromise<
   Result<
     void,
-    | GleanError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >
 > {
   return new APIPromise($do(
@@ -65,13 +67,14 @@ async function $do(
   [
     Result<
       void,
-      | GleanError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
       | RequestAbortedError
       | RequestTimeoutError
-      | ConnectionError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
     >,
     APICall,
   ]
@@ -108,6 +111,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "feedback",
     oAuth2Scopes: [],
@@ -129,6 +133,7 @@ async function $do(
     headers: headers,
     query: query,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -149,18 +154,19 @@ async function $do(
 
   const [result] = await M.match<
     void,
-    | GleanError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >(
     M.nil(200, z.void()),
     M.fail([400, 401, 429, "4XX"]),
     M.fail("5XX"),
-  )(response);
+  )(response, req);
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/clientActivityReport.ts

@@ -12,7 +12,7 @@ import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
 import * as components from "../models/components/index.js";
-import { GleanError } from "../models/errors/gleanerror.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -20,6 +20,7 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
@@ -37,13 +38,14 @@ export function clientActivityReport(
 ): APIPromise<
   Result<
     void,
-    | GleanError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >
 > {
   return new APIPromise($do(
@@ -61,13 +63,14 @@ async function $do(
   [
     Result<
       void,
-      | GleanError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
       | RequestAbortedError
       | RequestTimeoutError
-      | ConnectionError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
     >,
     APICall,
   ]
@@ -95,6 +98,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "activity",
     oAuth2Scopes: [],
@@ -115,6 +119,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -135,18 +140,19 @@ async function $do(
 
   const [result] = await M.match<
     void,
-    | GleanError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >(
     M.nil(200, z.void()),
     M.fail([400, 401, 429, "4XX"]),
     M.fail("5XX"),
-  )(response);
+  )(response, req);
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/clientAgentsList.ts

@@ -11,7 +11,7 @@ import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
 import * as components from "../models/components/index.js";
-import { GleanError } from "../models/errors/gleanerror.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -19,6 +19,7 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
@@ -36,13 +37,14 @@ export function clientAgentsList(
 ): APIPromise<
   Result<
     components.SearchAgentsResponse,
-    | GleanError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >
 > {
   return new APIPromise($do(
@@ -60,13 +62,14 @@ async function $do(
   [
     Result<
       components.SearchAgentsResponse,
-      | GleanError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
       | RequestAbortedError
       | RequestTimeoutError
-      | ConnectionError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
     >,
     APICall,
   ]
@@ -94,6 +97,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "searchAgents",
     oAuth2Scopes: [],
@@ -114,6 +118,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -134,18 +139,19 @@ async function $do(
 
   const [result] = await M.match<
     components.SearchAgentsResponse,
-    | GleanError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >(
     M.json(200, components.SearchAgentsResponse$inboundSchema),
     M.fail([400, 403, 404, 422, "4XX"]),
     M.fail([500, "5XX"]),
-  )(response);
+  )(response, req);
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }