@gleanwork/api-client 0.18.0 → 0.18.1

package/src/funcs/clientToolsGetToolServerTools.ts

@@ -0,0 +1,192 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0cafc7bf1212
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeFormQuery, 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 tool definitions from a tool server.
+ *
+ * @remarks
+ * Returns the name, description and JSON input schema for the named tools on the
+ * specified tool server. Works for both action packs and MCP servers.
+ *
+ * `toolNames` is required. Names that do not exist on the server are returned in
+ * `notFound` rather than failing the request, so a single bad name does not force
+ * callers into one-at-a-time retries. Matching is case-insensitive and treats `-`
+ * and `_` as equivalent.
+ *
+ * Native tools are not served; `serverId=native` returns 404.
+ */
+export function clientToolsGetToolServerTools(
+  client: GleanCore,
+  serverId: string,
+  toolNames: Array<string>,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.ToolDefinitionsResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    serverId,
+    toolNames,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  serverId: string,
+  toolNames: Array<string>,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.ToolDefinitionsResponse,
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.GetToolServerToolsRequest = {
+    serverId: serverId,
+    toolNames: toolNames,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) => operations.GetToolServerToolsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    serverId: encodeSimple("serverId", payload.serverId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/rest/api/v1/tool-servers/{serverId}/tools")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "toolNames": payload.toolNames,
+  }, { explode: false });
+
+  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: "getToolServerTools",
+    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,
+    query: query,
+    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.ToolDefinitionsResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.ToolDefinitionsResponse$inboundSchema),
+    M.fail([400, 401, 404, 429, "4XX"]),
+    M.fail([503, "5XX"]),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/indexingDatasourceStatus.ts

@@ -107,7 +107,7 @@ async function $do(
   );
 
   const headers = new Headers(compactMap({
-    Accept: "application/json; charset=UTF-8",
+    Accept: "application/json",
   }));
 
   const secConfig = await extractSecurity(client._options.apiToken);
@@ -167,9 +167,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.DebugDatasourceStatusResponse$inboundSchema, {
-      ctype: "application/json; charset=UTF-8",
-    }),
+    M.json(200, components.DebugDatasourceStatusResponse$inboundSchema),
     M.fail([400, 401, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/indexingDocumentsDebug.ts

@@ -114,7 +114,7 @@ async function $do(
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
-    Accept: "application/json; charset=UTF-8",
+    Accept: "application/json",
   }));
 
   const secConfig = await extractSecurity(client._options.apiToken);
@@ -174,9 +174,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.DebugDocumentResponse$inboundSchema, {
-      ctype: "application/json; charset=UTF-8",
-    }),
+    M.json(200, components.DebugDocumentResponse$inboundSchema),
     M.fail([400, 401, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/indexingDocumentsDebugEvents.ts

@@ -113,7 +113,7 @@ async function $do(
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
-    Accept: "application/json; charset=UTF-8",
+    Accept: "application/json",
   }));
 
   const secConfig = await extractSecurity(client._options.apiToken);
@@ -173,9 +173,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.DebugDocumentLifecycleResponse$inboundSchema, {
-      ctype: "application/json; charset=UTF-8",
-    }),
+    M.json(200, components.DebugDocumentLifecycleResponse$inboundSchema),
     M.fail([400, 401, 429, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/indexingDocumentsDebugMany.ts

@@ -114,7 +114,7 @@ async function $do(
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
-    Accept: "application/json; charset=UTF-8",
+    Accept: "application/json",
   }));
 
   const secConfig = await extractSecurity(client._options.apiToken);
@@ -174,9 +174,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.DebugDocumentsResponse$inboundSchema, {
-      ctype: "application/json; charset=UTF-8",
-    }),
+    M.json(200, components.DebugDocumentsResponse$inboundSchema),
     M.fail([400, 401, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/indexingPeopleDebug.ts

@@ -111,7 +111,7 @@ async function $do(
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
-    Accept: "application/json; charset=UTF-8",
+    Accept: "application/json",
   }));
 
   const secConfig = await extractSecurity(client._options.apiToken);
@@ -171,9 +171,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.DebugUserResponse$inboundSchema, {
-      ctype: "application/json; charset=UTF-8",
-    }),
+    M.json(200, components.DebugUserResponse$inboundSchema),
     M.fail([400, 401, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/searchListFilters.ts

@@ -0,0 +1,197 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 16efa68fb063
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeFormQuery } 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 { 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";
+
+/**
+ * List search filters
+ *
+ * @remarks
+ * List datasources and common built-in filter fields visible to the authenticated user. This is a best-effort catalog, not an exhaustive list of every filter search accepts.
+ * Without `query`, returns field metadata only and does not run a search. With a nonblank `query`, provide exactly one `datasources` value to request suggested filter values for that query; no documents are returned and this endpoint does not include warning objects. See `FilterFieldInfo.values` for limitations on suggested values. Rate-limited requests return HTTP 429 with `Retry-After`; temporary backend unavailability returns HTTP 503.
+ */
+export function searchListFilters(
+  client: GleanCore,
+  datasources?: Array<string> | undefined,
+  query?: string | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.PlatformSearchFiltersResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    datasources,
+    query,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  datasources?: Array<string> | undefined,
+  query?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.PlatformSearchFiltersResponse,
+      | errors.PlatformProblemDetailError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.PlatformSearchFiltersRequest = {
+    datasources: datasources,
+    query: query,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.PlatformSearchFiltersRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/api/search/filters")();
+
+  const query$ = encodeFormQuery({
+    "datasources": payload.datasources,
+    "query": payload.query,
+  });
+
+  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-search-filters",
+    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,
+    query: query$,
+    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.PlatformSearchFiltersResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.PlatformSearchFiltersResponse$inboundSchema, {
+      hdrs: true,
+      key: "Result",
+    }),
+    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/funcs/searchQuery.ts

@@ -31,7 +31,8 @@ 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.
+ * Search your organization's connected content and return ranked document results with cursor pagination. Use `GET /api/search/filters` to discover datasource identifiers and common filter fields. Built-in filter names are validated; other field names are accepted as custom filters and behavior depends on your Glean configuration and connected sources.
+ * Errors: HTTP 422 `unprocessable_query` returns no `results` or `next_cursor`. See `warnings` on the response for non-blocking issues such as partially available results. Not every query issue produces a warning or error.
  */
 export function searchQuery(
   client: GleanCore,
@@ -161,7 +162,7 @@ async function $do(
   >(
     M.json(200, components.PlatformSearchResponse$inboundSchema),
     M.jsonErr(
-      [400, 401, 403, 404, 408, 413, 429],
+      [400, 401, 403, 404, 408, 413, 422, 429],
       errors.PlatformProblemDetailError$inboundSchema,
       { ctype: "application/problem+json" },
     ),

package/src/funcs/skillsDelete.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7a33b571ce67
+ */
+
+import * as z from "zod/v3";
+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 { 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";
+
+/**
+ * Delete skill
+ *
+ * @remarks
+ * Delete a skill the authenticated caller is allowed to manage. This operation permanently removes all versions of the skill.
+ */
+export function skillsDelete(
+  client: GleanCore,
+  skillId: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    void,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    skillId,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  skillId: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      void,
+      | errors.PlatformProblemDetailError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.PlatformSkillsDeleteRequest = {
+    skill_id: skillId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.PlatformSkillsDeleteRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    skill_id: encodeSimple("skill_id", payload.skill_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/api/skills/{skill_id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/problem+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-skills-delete",
+    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: "DELETE",
+    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<
+    void,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.nil(204, z.void()),
+    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 }];
+}