@gleanwork/api-client 0.16.1 → 0.17.0

package/src/funcs/clientToolsRetrieveActionPackAuthStatus.ts

@@ -0,0 +1,178 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 005f9b5127d8
+ */
+
+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 { 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 end-user authentication status for an action pack.
+ *
+ * @remarks
+ * Reports whether the calling user is already authenticated against the third-party
+ * tool backing the specified action pack. Intended for headless / server-driven clients
+ * that render an "Authorize" prompt when the user has not yet consented to the tool.
+ */
+export function clientToolsRetrieveActionPackAuthStatus(
+  client: GleanCore,
+  actionPackId: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.ActionPackAuthStatusResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    actionPackId,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  actionPackId: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.ActionPackAuthStatusResponse,
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.GetActionPackAuthStatusRequest = {
+    actionPackId: actionPackId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.GetActionPackAuthStatusRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    actionPackId: encodeSimple("actionPackId", payload.actionPackId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/rest/api/v1/actions/actionpack/{actionPackId}/auth",
+  )(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: "getActionPackAuthStatus",
+    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 [result] = await M.match<
+    components.ActionPackAuthStatusResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.ActionPackAuthStatusResponse$inboundSchema),
+    M.fail([400, 401, 404, 429, "4XX"]),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/indexingDocumentsDebugEvents.ts

@@ -0,0 +1,187 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: cdf90816c99f
+ */
+
+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 { 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";
+
+/**
+ * Beta: Get document lifecycle events
+ *
+ * @remarks
+ * Retrieves lifecycle events for a specific document including upload time, index times and deletions. Rate limited to 1 request per minute per datasource. Currently in beta, might undergo breaking changes without prior notice.
+ */
+export function indexingDocumentsDebugEvents(
+  client: GleanCore,
+  debugDocumentLifecycleRequest: components.DebugDocumentLifecycleRequest,
+  datasource: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.DebugDocumentLifecycleResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    debugDocumentLifecycleRequest,
+    datasource,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  debugDocumentLifecycleRequest: components.DebugDocumentLifecycleRequest,
+  datasource: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.DebugDocumentLifecycleResponse,
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.PostApiIndexV1DebugDatasourceDocumentEventsRequest = {
+    debugDocumentLifecycleRequest: debugDocumentLifecycleRequest,
+    datasource: datasource,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations
+        .PostApiIndexV1DebugDatasourceDocumentEventsRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.DebugDocumentLifecycleRequest, {
+    explode: true,
+  });
+
+  const pathParams = {
+    datasource: encodeSimple("datasource", payload.datasource, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/api/index/v1/debug/{datasource}/document/events")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json; charset=UTF-8",
+  }));
+
+  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: "post_/api/index/v1/debug/{datasource}/document/events",
+    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 [result] = await M.match<
+    components.DebugDocumentLifecycleResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.DebugDocumentLifecycleResponse$inboundSchema, {
+      ctype: "application/json; charset=UTF-8",
+    }),
+    M.fail([400, 401, 429, "4XX"]),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/searchQuery.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: cc6075d2a5d0
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeJSON } 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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Search
+ *
+ * @remarks
+ * Execute a search query and retrieve ranked results. This is the data retrieval variant of the search API and returns only results and pagination state.
+ */
+export function searchQuery(
+  client: GleanCore,
+  request: components.PlatformSearchRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.PlatformSearchResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  request: components.PlatformSearchRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PlatformSearchResponse,
+      | errors.PlatformProblemDetailError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.PlatformSearchRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/api/search")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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-search",
+    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<
+    components.PlatformSearchResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.PlatformSearchResponse$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 }];
+}

package/src/hooks/x-glean.ts

@@ -1,5 +1,8 @@
 import { BeforeRequestContext, BeforeRequestHook } from "./types.js";
 
+export const EXCLUDE_DEPRECATED_AFTER_HEADER = "X-Glean-Exclude-Deprecated-After";
+export const INCLUDE_EXPERIMENTAL_HEADER = "X-Glean-Include-Experimental";
+
 /**
  * Get the first non-empty value from the provided arguments.
  */
@@ -60,11 +63,11 @@ export class XGlean implements BeforeRequestHook {
     }
 
     if (deprecatedValue) {
-      request.headers.set("X-Glean-Exclude-Deprecated-After", deprecatedValue);
+      request.headers.set(EXCLUDE_DEPRECATED_AFTER_HEADER, deprecatedValue);
     }
 
     if (experimentalValue) {
-      request.headers.set("X-Glean-Experimental", experimentalValue);
+      request.headers.set(INCLUDE_EXPERIMENTAL_HEADER, experimentalValue);
     }
 
     return request;

package/src/lib/config.ts

@@ -73,8 +73,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.9.0",
-  sdkVersion: "0.16.1",
-  genVersion: "2.913.3",
+  sdkVersion: "0.17.0",
+  genVersion: "2.915.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.16.1 2.913.3 0.9.0 @gleanwork/api-client",
+    "speakeasy-sdk/typescript 0.17.0 2.915.0 0.9.0 @gleanwork/api-client",
 } as const;

package/src/models/components/actionsummary.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -16,11 +15,11 @@ export type ActionSummary = {
   /**
    * The unique identifier of the action.
    */
-  toolId: string;
+  tool_id: string;
   /**
    * The display name of the action.
    */
-  displayName: string;
+  display_name: string;
   /**
    * The type of tool - RETRIEVAL for read-only operations, ACTION for operations that modify data.
    */
@@ -28,15 +27,15 @@ export type ActionSummary = {
   /**
    * The authentication type required - OAUTH_USER, OAUTH_ADMIN, API_KEY, BASIC_AUTH, DWD (domain-wide delegation), or NONE.
    */
-  authType?: string | undefined;
+  auth_type?: string | undefined;
   /**
    * For write actions only - REDIRECT (client renders URL) or EXECUTION (external server call).
    */
-  writeActionType?: string | undefined;
+  write_action_type?: string | undefined;
   /**
    * Whether this action has been fully configured and validated.
    */
-  isSetupFinished?: boolean | undefined;
+  is_setup_finished?: boolean | undefined;
   /**
    * Indicates the kind of knowledge a tool would access or modify.
    *
@@ -50,7 +49,7 @@ export type ActionSummary = {
    *   - Native tools that don't access or modify content via APIs (e.g., file analyst, think)
    *   - Platform read or write tools (creator has to determine their knowledge implications)
    */
-  dataSource?: string | undefined;
+  data_source?: string | undefined;
 };
 
 /** @internal */
@@ -66,15 +65,6 @@ export const ActionSummary$inboundSchema: z.ZodType<
   write_action_type: z.string().optional(),
   is_setup_finished: z.boolean().optional(),
   data_source: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "tool_id": "toolId",
-    "display_name": "displayName",
-    "auth_type": "authType",
-    "write_action_type": "writeActionType",
-    "is_setup_finished": "isSetupFinished",
-    "data_source": "dataSource",
-  });
 });
 
 export function actionSummaryFromJSON(

package/src/models/components/agent.ts

@@ -29,11 +29,11 @@ export type AgentCapabilities = {
   /**
    * Whether the agent supports messages as an input. If true, you'll pass `messages` as an input when running the agent.
    */
-  apIoMessages?: boolean | undefined;
+  "ap.io.messages"?: boolean | undefined;
   /**
    * Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming.
    */
-  apIoStreaming?: boolean | undefined;
+  "ap.io.streaming"?: boolean | undefined;
   additionalProperties?: { [k: string]: any } | undefined;
 };
 
@@ -41,7 +41,7 @@ export type Agent = {
   /**
    * The ID of the agent.
    */
-  agentId: string;
+  agent_id: string;
   /**
    * The name of the agent
    */
@@ -96,8 +96,8 @@ export const AgentCapabilities$inboundSchema: z.ZodType<
   true,
 ).transform((v) => {
   return remap$(v, {
-    "ap.io.messages": "apIoMessages",
-    "ap.io.streaming": "apIoStreaming",
+    "ap.io.messages": "ap.io.messages",
+    "ap.io.streaming": "ap.io.streaming",
   });
 });
 
@@ -119,10 +119,6 @@ export const Agent$inboundSchema: z.ZodType<Agent, z.ZodTypeDef, unknown> = z
     description: z.string().optional(),
     metadata: z.lazy(() => AgentMetadata$inboundSchema).optional(),
     capabilities: z.lazy(() => AgentCapabilities$inboundSchema),
-  }).transform((v) => {
-    return remap$(v, {
-      "agent_id": "agentId",
-    });
   });
 
 export function agentFromJSON(