@gleanwork/api-client 0.16.1 → 0.17.1

package/src/__tests__/findings.test.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5c813049d90a
+ */
+
+import { assert, expect, it, test } from "vitest";
+import { Glean } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Findings Listfindingsexports", async () => {
+  const testHttpClient = createTestHTTPClient("listfindingsexports");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.client.governance.data.findings.list();
+  expect(result).toBeDefined();
+});
+
+it.skip("Findings Downloadfindingsexport", async () => {
+  assert.fail(
+    "incomplete test found please make sure to address the following errors: [`workflow step downloadfindingsexport.test contains criterion simple with invalid condition`, `workflow step downloadfindingsexport.test does not contain $contentType successCriteria and required for response body assertion`]",
+  );
+});

package/src/__tests__/search.test.ts

@@ -2050,3 +2050,35 @@ test("Search Search", async () => {
   });
   expect(result).toBeDefined();
 });
+
+test("Search Platform Search", async () => {
+  const testHttpClient = createTestHTTPClient("platform-search");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.search.query({
+    query: "quarterly planning 2026",
+    datasources: [
+      "confluence",
+      "google_drive",
+    ],
+    datasource_instances: [
+      "slack_acme",
+      "slack_eu",
+    ],
+    filters: [
+      {
+        field: "type",
+        values: [
+          "spreadsheet",
+          "presentation",
+        ],
+      },
+    ],
+  });
+  expect(result).toBeDefined();
+});

package/src/__tests__/summarize.test.ts

@@ -19,11 +19,11 @@ test("Summarize Summarize", async () => {
   const result = await glean.client.documents.summarize({
     documentSpecs: [
       {
-        ugcType: "CHATS",
-        contentId: 207037,
+        ugcType: "COLLECTIONS",
+        contentId: 993975,
       },
       {
-        url: "https://angelic-exhaust.com",
+        id: "<id>",
       },
     ],
   });

package/src/__tests__/tools.test.ts

@@ -50,7 +50,7 @@ test("Tools Get Action Pack Auth Status", async () => {
     apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
-  const result = await glean.tools.getActionPackAuthStatus("<id>");
+  const result = await glean.client.tools.retrieveActionPackAuthStatus("<id>");
   expect(result).toBeDefined();
 });
 
@@ -63,7 +63,7 @@ test("Tools Authorize Action Pack", async () => {
     apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
-  const result = await glean.tools.authorizeActionPack({
+  const result = await glean.client.tools.authorizeActionPack({
     returnUrl: "https://merry-allocation.org/",
   }, "<id>");
   expect(result).toBeDefined();

package/src/__tests__/x-glean.test.ts

@@ -1,5 +1,9 @@
 import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import { XGlean } from "../hooks/x-glean.js";
+import {
+  XGlean,
+  EXCLUDE_DEPRECATED_AFTER_HEADER,
+  INCLUDE_EXPERIMENTAL_HEADER,
+} from "../hooks/x-glean.js";
 import { BeforeRequestContext } from "../hooks/types.js";
 import { SDKOptions } from "../lib/config.js";
 import { XGleanOptions } from "../hooks/x-glean-options.js";
@@ -46,10 +50,10 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.has("X-Glean-Exclude-Deprecated-After")).toBe(
+      expect(result.headers.has(EXCLUDE_DEPRECATED_AFTER_HEADER)).toBe(
         false,
       );
-      expect(result.headers.has("X-Glean-Experimental")).toBe(false);
+      expect(result.headers.has(INCLUDE_EXPERIMENTAL_HEADER)).toBe(false);
     });
   });
 
@@ -63,12 +67,12 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.get("X-Glean-Exclude-Deprecated-After")).toBe(
+      expect(result.headers.get(EXCLUDE_DEPRECATED_AFTER_HEADER)).toBe(
         "2026-10-15",
       );
     });
 
-    it("should set X-Glean-Experimental header when includeExperimental is true", () => {
+    it("should set X-Glean-Include-Experimental header when includeExperimental is true", () => {
       const hook = new XGlean();
       const request = createMockRequest();
       const context = createMockContext({
@@ -77,10 +81,10 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.get("X-Glean-Experimental")).toBe("true");
+      expect(result.headers.get(INCLUDE_EXPERIMENTAL_HEADER)).toBe("true");
     });
 
-    it("should not set X-Glean-Experimental header when includeExperimental is false", () => {
+    it("should not set X-Glean-Include-Experimental header when includeExperimental is false", () => {
       const hook = new XGlean();
       const request = createMockRequest();
       const context = createMockContext({
@@ -89,7 +93,7 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.has("X-Glean-Experimental")).toBe(false);
+      expect(result.headers.has(INCLUDE_EXPERIMENTAL_HEADER)).toBe(false);
     });
 
     it("should set both headers when both options are provided", () => {
@@ -102,10 +106,10 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.get("X-Glean-Exclude-Deprecated-After")).toBe(
+      expect(result.headers.get(EXCLUDE_DEPRECATED_AFTER_HEADER)).toBe(
         "2026-10-15",
       );
-      expect(result.headers.get("X-Glean-Experimental")).toBe("true");
+      expect(result.headers.get(INCLUDE_EXPERIMENTAL_HEADER)).toBe("true");
     });
   });
 
@@ -119,12 +123,12 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.get("X-Glean-Exclude-Deprecated-After")).toBe(
+      expect(result.headers.get(EXCLUDE_DEPRECATED_AFTER_HEADER)).toBe(
         "2027-01-01",
       );
     });
 
-    it("should set X-Glean-Experimental header from environment variable", () => {
+    it("should set X-Glean-Include-Experimental header from environment variable", () => {
       process.env["X_GLEAN_INCLUDE_EXPERIMENTAL"] = "true";
 
       const hook = new XGlean();
@@ -133,7 +137,7 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.get("X-Glean-Experimental")).toBe("true");
+      expect(result.headers.get(INCLUDE_EXPERIMENTAL_HEADER)).toBe("true");
     });
 
     it("should set both headers from environment variables", () => {
@@ -146,13 +150,13 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.get("X-Glean-Exclude-Deprecated-After")).toBe(
+      expect(result.headers.get(EXCLUDE_DEPRECATED_AFTER_HEADER)).toBe(
         "2027-06-15",
       );
-      expect(result.headers.get("X-Glean-Experimental")).toBe("true");
+      expect(result.headers.get(INCLUDE_EXPERIMENTAL_HEADER)).toBe("true");
     });
 
-    it("should not set X-Glean-Experimental header when environment variable is false", () => {
+    it("should not set X-Glean-Include-Experimental header when environment variable is false", () => {
       process.env["X_GLEAN_INCLUDE_EXPERIMENTAL"] = "false";
 
       const hook = new XGlean();
@@ -163,7 +167,7 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.has("X-Glean-Experimental")).toBe(false);
+      expect(result.headers.has(INCLUDE_EXPERIMENTAL_HEADER)).toBe(false);
     });
 
     it("should fall back to SDK options when experimental env var is empty", () => {
@@ -177,7 +181,7 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.get("X-Glean-Experimental")).toBe("true");
+      expect(result.headers.get(INCLUDE_EXPERIMENTAL_HEADER)).toBe("true");
     });
   });
 
@@ -193,7 +197,7 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.get("X-Glean-Exclude-Deprecated-After")).toBe(
+      expect(result.headers.get(EXCLUDE_DEPRECATED_AFTER_HEADER)).toBe(
         "2027-12-31",
       );
     });
@@ -209,7 +213,7 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.get("X-Glean-Experimental")).toBe("true");
+      expect(result.headers.get(INCLUDE_EXPERIMENTAL_HEADER)).toBe("true");
     });
 
     it("should use environment variables for both headers when all are set", () => {
@@ -225,13 +229,13 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.get("X-Glean-Exclude-Deprecated-After")).toBe(
+      expect(result.headers.get(EXCLUDE_DEPRECATED_AFTER_HEADER)).toBe(
         "2028-01-01",
       );
-      expect(result.headers.get("X-Glean-Experimental")).toBe("true");
+      expect(result.headers.get(INCLUDE_EXPERIMENTAL_HEADER)).toBe("true");
     });
 
-    it("should omit X-Glean-Experimental header when env var is false, even if option is true", () => {
+    it("should omit X-Glean-Include-Experimental header when env var is false, even if option is true", () => {
       process.env["X_GLEAN_INCLUDE_EXPERIMENTAL"] = "false";
 
       const hook = new XGlean();
@@ -242,7 +246,7 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.has("X-Glean-Experimental")).toBe(false);
+      expect(result.headers.has(INCLUDE_EXPERIMENTAL_HEADER)).toBe(false);
     });
   });
 
@@ -256,7 +260,7 @@ describe("XGlean hook", () => {
 
       const result = hook.beforeRequest(context, request);
 
-      expect(result.headers.has("X-Glean-Exclude-Deprecated-After")).toBe(false);
+      expect(result.headers.has(EXCLUDE_DEPRECATED_AFTER_HEADER)).toBe(false);
     });
   });
 });

package/src/funcs/agentsCreateRun.ts

@@ -0,0 +1,206 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 806c3e535dd1
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+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 { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.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";
+import { Result } from "../types/fp.js";
+
+export enum CreateRunAcceptEnum {
+  applicationJson = "application/json",
+  textEventStream = "text/event-stream",
+}
+
+/**
+ * Create agent run
+ *
+ * @remarks
+ * Execute an agent run. Set `stream` to true to receive server-sent events; otherwise the response contains the final agent messages.
+ */
+export function agentsCreateRun(
+  client: GleanCore,
+  platformAgentRunCreateRequest: components.PlatformAgentRunCreateRequest,
+  agentId: string,
+  options?: RequestOptions & { acceptHeaderOverride?: CreateRunAcceptEnum },
+): APIPromise<
+  Result<
+    operations.PlatformAgentsCreateRunResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    platformAgentRunCreateRequest,
+    agentId,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  platformAgentRunCreateRequest: components.PlatformAgentRunCreateRequest,
+  agentId: string,
+  options?: RequestOptions & { acceptHeaderOverride?: CreateRunAcceptEnum },
+): Promise<
+  [
+    Result<
+      operations.PlatformAgentsCreateRunResponse,
+      | errors.PlatformProblemDetailError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.PlatformAgentsCreateRunRequest = {
+    platformAgentRunCreateRequest: platformAgentRunCreateRequest,
+    agent_id: agentId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.PlatformAgentsCreateRunRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.PlatformAgentRunCreateRequest, {
+    explode: true,
+  });
+
+  const pathParams = {
+    agent_id: encodeSimple("agent_id", payload.agent_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/api/agents/{agent_id}/runs")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: options?.acceptHeaderOverride
+      || "application/json;q=1, text/event-stream;q=0",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "platform-agents-create-run",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.PlatformAgentsCreateRunResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.PlatformAgentsCreateRunResponse$inboundSchema),
+    M.text(200, operations.PlatformAgentsCreateRunResponse$inboundSchema, {
+      ctype: "text/event-stream",
+    }),
+    M.jsonErr(
+      [400, 401, 403, 404, 408, 409, 413, 429],
+      errors.PlatformProblemDetailError$inboundSchema,
+      { ctype: "application/problem+json" },
+    ),
+    M.jsonErr([500, 503], errors.PlatformProblemDetailError$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/agentsGet.ts

@@ -0,0 +1,189 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ee72478b2e87
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+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 { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.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";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get agent
+ *
+ * @remarks
+ * Retrieve details for an agent available to the authenticated user.
+ */
+export function agentsGet(
+  client: GleanCore,
+  agentId: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.PlatformAgentGetResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    agentId,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  agentId: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PlatformAgentGetResponse,
+      | errors.PlatformProblemDetailError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.PlatformAgentsGetRequest = {
+    agent_id: agentId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) => operations.PlatformAgentsGetRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    agent_id: encodeSimple("agent_id", payload.agent_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/api/agents/{agent_id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "platform-agents-get",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.PlatformAgentGetResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.PlatformAgentGetResponse$inboundSchema),
+    M.jsonErr(
+      [400, 401, 403, 404, 408, 429],
+      errors.PlatformProblemDetailError$inboundSchema,
+      { ctype: "application/problem+json" },
+    ),
+    M.jsonErr([500, 503], errors.PlatformProblemDetailError$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}