@gleanwork/api-client 0.17.3 → 0.18.1

package/src/react-query/clientToolsGetToolServerTools.ts

@@ -0,0 +1,163 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 59c54074fd52
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+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 { useGleanContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildClientToolsGetToolServerToolsQuery,
+  ClientToolsGetToolServerToolsQueryData,
+  prefetchClientToolsGetToolServerTools,
+  queryKeyClientToolsGetToolServerTools,
+} from "./clientToolsGetToolServerTools.core.js";
+export {
+  buildClientToolsGetToolServerToolsQuery,
+  type ClientToolsGetToolServerToolsQueryData,
+  prefetchClientToolsGetToolServerTools,
+  queryKeyClientToolsGetToolServerTools,
+};
+
+export type ClientToolsGetToolServerToolsQueryError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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 useClientToolsGetToolServerTools(
+  serverId: string,
+  toolNames: Array<string>,
+  options?: QueryHookOptions<
+    ClientToolsGetToolServerToolsQueryData,
+    ClientToolsGetToolServerToolsQueryError
+  >,
+): UseQueryResult<
+  ClientToolsGetToolServerToolsQueryData,
+  ClientToolsGetToolServerToolsQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildClientToolsGetToolServerToolsQuery(
+      client,
+      serverId,
+      toolNames,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * 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 useClientToolsGetToolServerToolsSuspense(
+  serverId: string,
+  toolNames: Array<string>,
+  options?: SuspenseQueryHookOptions<
+    ClientToolsGetToolServerToolsQueryData,
+    ClientToolsGetToolServerToolsQueryError
+  >,
+): UseSuspenseQueryResult<
+  ClientToolsGetToolServerToolsQueryData,
+  ClientToolsGetToolServerToolsQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildClientToolsGetToolServerToolsQuery(
+      client,
+      serverId,
+      toolNames,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setClientToolsGetToolServerToolsData(
+  client: QueryClient,
+  queryKeyBase: [serverId: string, parameters: { toolNames: Array<string> }],
+  data: ClientToolsGetToolServerToolsQueryData,
+): ClientToolsGetToolServerToolsQueryData | undefined {
+  const key = queryKeyClientToolsGetToolServerTools(...queryKeyBase);
+
+  return client.setQueryData<ClientToolsGetToolServerToolsQueryData>(key, data);
+}
+
+export function invalidateClientToolsGetToolServerTools(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [serverId: string, parameters: { toolNames: Array<string> }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "tools",
+      "getToolServerTools",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllClientToolsGetToolServerTools(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "tools", "getToolServerTools"],
+  });
+}

package/src/react-query/index.ts

@@ -10,9 +10,11 @@ export * from "./agentsCreateRun.js";
 export * from "./agentsGet.js";
 export * from "./agentsGetSchemas.js";
 export * from "./agentsSearch.js";
+export * from "./chatCreate.js";
 export * from "./clientActivityFeedback.js";
 export * from "./clientActivityReport.js";
 export * from "./clientAgentsCreate.js";
+export * from "./clientAgentsImport.js";
 export * from "./clientAgentsList.js";
 export * from "./clientAgentsRetrieve.js";
 export * from "./clientAgentsRetrieveSchemas.js";
@@ -92,6 +94,7 @@ export * from "./clientShortcutsRetrieve.js";
 export * from "./clientShortcutsUpdate.js";
 export * from "./clientToolsAuthorizeActionPack.js";
 export * from "./clientToolsAuthorizeToolServer.js";
+export * from "./clientToolsGetToolServerTools.js";
 export * from "./clientToolsList.js";
 export * from "./clientToolsRetrieveActionPackAuthStatus.js";
 export * from "./clientToolsRetrieveToolServerAuthStatus.js";
@@ -107,6 +110,7 @@ export * from "./indexingCustomMetadataUpsert.js";
 export * from "./indexingCustomMetadataUpsertSchema.js";
 export * from "./indexingDatasourcesAdd.js";
 export * from "./indexingDatasourcesRetrieveConfig.js";
+export * from "./indexingDatasourcesSubmit.js";
 export * from "./indexingDatasourceStatus.js";
 export * from "./indexingDocumentsAddOrUpdate.js";
 export * from "./indexingDocumentsBulkIndex.js";
@@ -142,4 +146,19 @@ export * from "./indexingPermissionsProcessMemberships.js";
 export * from "./indexingPermissionsUpdatePermissions.js";
 export * from "./indexingShortcutsBulkIndex.js";
 export * from "./indexingShortcutsUpload.js";
+export * from "./searchListFilters.js";
 export * from "./searchQuery.js";
+export * from "./skillsCreate.js";
+export * from "./skillsCreateVersion.js";
+export * from "./skillsDelete.js";
+export * from "./skillsImport.js";
+export * from "./skillsList.js";
+export * from "./skillsListVersions.js";
+export * from "./skillsPreviewSource.js";
+export * from "./skillsRetrieve.js";
+export * from "./skillsRetrieveContent.js";
+export * from "./skillsRetrieveVersion.js";
+export * from "./skillsRetrieveVersionContent.js";
+export * from "./skillsSync.js";
+export * from "./skillsUpdate.js";
+export * from "./skillsValidate.js";

package/src/react-query/indexingDatasourcesSubmit.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2975f214d3b7
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingDatasourcesSubmit } from "../funcs/indexingDatasourcesSubmit.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type IndexingDatasourcesSubmitMutationVariables = {
+  requestBody: { [k: string]: any };
+  datasourceInstance: string;
+  type: string;
+  options?: RequestOptions;
+};
+
+export type IndexingDatasourcesSubmitMutationData =
+  operations.PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse;
+
+export type IndexingDatasourcesSubmitMutationError =
+  | errors.ErrorInfoResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Submit datasource data
+ *
+ * @remarks
+ * Validates and asynchronously processes a datasource-specific submission.
+ */
+export function useIndexingDatasourcesSubmitMutation(
+  options?: MutationHookOptions<
+    IndexingDatasourcesSubmitMutationData,
+    IndexingDatasourcesSubmitMutationError,
+    IndexingDatasourcesSubmitMutationVariables
+  >,
+): UseMutationResult<
+  IndexingDatasourcesSubmitMutationData,
+  IndexingDatasourcesSubmitMutationError,
+  IndexingDatasourcesSubmitMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingDatasourcesSubmitMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingDatasourcesSubmit(): MutationKey {
+  return ["@gleanwork/api-client", "datasources", "submit"];
+}
+
+export function buildIndexingDatasourcesSubmitMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingDatasourcesSubmitMutationVariables,
+  ) => Promise<IndexingDatasourcesSubmitMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingDatasourcesSubmit(),
+    mutationFn: function indexingDatasourcesSubmitMutationFn({
+      requestBody,
+      datasourceInstance,
+      type,
+      options,
+    }): Promise<IndexingDatasourcesSubmitMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingDatasourcesSubmit(
+        client$,
+        requestBody,
+        datasourceInstance,
+        type,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/searchListFilters.core.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c09038b64f46
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { searchListFilters } from "../funcs/searchListFilters.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type SearchListFiltersQueryData =
+  operations.PlatformSearchFiltersResponse;
+
+export function prefetchSearchListFilters(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  datasources?: Array<string> | undefined,
+  query?: string | undefined,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSearchListFiltersQuery(
+      client$,
+      datasources,
+      query,
+      options,
+    ),
+  });
+}
+
+export function buildSearchListFiltersQuery(
+  client$: GleanCore,
+  datasources?: Array<string> | undefined,
+  query?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<SearchListFiltersQueryData>;
+} {
+  return {
+    queryKey: queryKeySearchListFilters({ datasources, query }),
+    queryFn: async function searchListFiltersQueryFn(
+      ctx,
+    ): Promise<SearchListFiltersQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(searchListFilters(
+        client$,
+        datasources,
+        query,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySearchListFilters(
+  parameters: {
+    datasources?: Array<string> | undefined;
+    query?: string | undefined;
+  },
+): QueryKey {
+  return ["@gleanwork/api-client", "search", "listFilters", parameters];
+}

package/src/react-query/searchListFilters.ts

@@ -0,0 +1,156 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: fb6d3135bc3a
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+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 { useGleanContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildSearchListFiltersQuery,
+  prefetchSearchListFilters,
+  queryKeySearchListFilters,
+  SearchListFiltersQueryData,
+} from "./searchListFilters.core.js";
+export {
+  buildSearchListFiltersQuery,
+  prefetchSearchListFilters,
+  queryKeySearchListFilters,
+  type SearchListFiltersQueryData,
+};
+
+export type SearchListFiltersQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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 useSearchListFilters(
+  datasources?: Array<string> | undefined,
+  query?: string | undefined,
+  options?: QueryHookOptions<
+    SearchListFiltersQueryData,
+    SearchListFiltersQueryError
+  >,
+): UseQueryResult<SearchListFiltersQueryData, SearchListFiltersQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildSearchListFiltersQuery(
+      client,
+      datasources,
+      query,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * 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 useSearchListFiltersSuspense(
+  datasources?: Array<string> | undefined,
+  query?: string | undefined,
+  options?: SuspenseQueryHookOptions<
+    SearchListFiltersQueryData,
+    SearchListFiltersQueryError
+  >,
+): UseSuspenseQueryResult<
+  SearchListFiltersQueryData,
+  SearchListFiltersQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildSearchListFiltersQuery(
+      client,
+      datasources,
+      query,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setSearchListFiltersData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      datasources?: Array<string> | undefined;
+      query?: string | undefined;
+    },
+  ],
+  data: SearchListFiltersQueryData,
+): SearchListFiltersQueryData | undefined {
+  const key = queryKeySearchListFilters(...queryKeyBase);
+
+  return client.setQueryData<SearchListFiltersQueryData>(key, data);
+}
+
+export function invalidateSearchListFilters(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      datasources?: Array<string> | undefined;
+      query?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "search",
+      "listFilters",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllSearchListFilters(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "search", "listFilters"],
+  });
+}

package/src/react-query/searchQuery.ts

@@ -50,7 +50,8 @@ export type SearchQueryMutationError =
  * 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 useSearchQueryMutation(
   options?: MutationHookOptions<

package/src/react-query/skillsCreate.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7726086743dc
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsCreate } from "../funcs/skillsCreate.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type SkillsCreateMutationVariables = {
+  request: components.PlatformSkillCreateRequest;
+  options?: RequestOptions;
+};
+
+export type SkillsCreateMutationData = components.PlatformSkillCreateResponse;
+
+export type SkillsCreateMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Create skill
+ *
+ * @remarks
+ * Create a skill from an uploaded SKILL.md, .zip, or .skill bundle. If the authenticated user already has a skill with the same name, the existing skill is superseded with a new version.
+ */
+export function useSkillsCreateMutation(
+  options?: MutationHookOptions<
+    SkillsCreateMutationData,
+    SkillsCreateMutationError,
+    SkillsCreateMutationVariables
+  >,
+): UseMutationResult<
+  SkillsCreateMutationData,
+  SkillsCreateMutationError,
+  SkillsCreateMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSkillsCreateMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySkillsCreate(): MutationKey {
+  return ["@gleanwork/api-client", "skills", "create"];
+}
+
+export function buildSkillsCreateMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SkillsCreateMutationVariables,
+  ) => Promise<SkillsCreateMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySkillsCreate(),
+    mutationFn: function skillsCreateMutationFn({
+      request,
+      options,
+    }): Promise<SkillsCreateMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(skillsCreate(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}