@gleanwork/api-client 0.16.1 → 0.17.1

package/src/react-query/clientToolsRetrieveActionPackAuthStatus.ts

@@ -0,0 +1,152 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 52f40f93c161
+ */
+
+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 {
+  buildClientToolsRetrieveActionPackAuthStatusQuery,
+  ClientToolsRetrieveActionPackAuthStatusQueryData,
+  prefetchClientToolsRetrieveActionPackAuthStatus,
+  queryKeyClientToolsRetrieveActionPackAuthStatus,
+} from "./clientToolsRetrieveActionPackAuthStatus.core.js";
+export {
+  buildClientToolsRetrieveActionPackAuthStatusQuery,
+  type ClientToolsRetrieveActionPackAuthStatusQueryData,
+  prefetchClientToolsRetrieveActionPackAuthStatus,
+  queryKeyClientToolsRetrieveActionPackAuthStatus,
+};
+
+export type ClientToolsRetrieveActionPackAuthStatusQueryError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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 useClientToolsRetrieveActionPackAuthStatus(
+  actionPackId: string,
+  options?: QueryHookOptions<
+    ClientToolsRetrieveActionPackAuthStatusQueryData,
+    ClientToolsRetrieveActionPackAuthStatusQueryError
+  >,
+): UseQueryResult<
+  ClientToolsRetrieveActionPackAuthStatusQueryData,
+  ClientToolsRetrieveActionPackAuthStatusQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildClientToolsRetrieveActionPackAuthStatusQuery(
+      client,
+      actionPackId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * 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 useClientToolsRetrieveActionPackAuthStatusSuspense(
+  actionPackId: string,
+  options?: SuspenseQueryHookOptions<
+    ClientToolsRetrieveActionPackAuthStatusQueryData,
+    ClientToolsRetrieveActionPackAuthStatusQueryError
+  >,
+): UseSuspenseQueryResult<
+  ClientToolsRetrieveActionPackAuthStatusQueryData,
+  ClientToolsRetrieveActionPackAuthStatusQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildClientToolsRetrieveActionPackAuthStatusQuery(
+      client,
+      actionPackId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setClientToolsRetrieveActionPackAuthStatusData(
+  client: QueryClient,
+  queryKeyBase: [actionPackId: string],
+  data: ClientToolsRetrieveActionPackAuthStatusQueryData,
+): ClientToolsRetrieveActionPackAuthStatusQueryData | undefined {
+  const key = queryKeyClientToolsRetrieveActionPackAuthStatus(...queryKeyBase);
+
+  return client.setQueryData<ClientToolsRetrieveActionPackAuthStatusQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateClientToolsRetrieveActionPackAuthStatus(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[actionPackId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "tools",
+      "retrieveActionPackAuthStatus",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllClientToolsRetrieveActionPackAuthStatus(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "tools",
+      "retrieveActionPackAuthStatus",
+    ],
+  });
+}

package/src/react-query/index.ts

@@ -6,17 +6,19 @@
 export { GleanProvider, useGleanContext } from "./_context.js";
 export * from "./_types.js";
 
-export * from "./agentsCreateAgent.js";
-export * from "./agentsEditAgent.js";
-export * from "./authenticationCheckdatasourceauth.js";
-export * from "./chatGetChatFile.js";
+export * from "./agentsCreateRun.js";
+export * from "./agentsGet.js";
+export * from "./agentsGetSchemas.js";
+export * from "./agentsSearch.js";
 export * from "./clientActivityFeedback.js";
 export * from "./clientActivityReport.js";
+export * from "./clientAgentsCreate.js";
 export * from "./clientAgentsList.js";
 export * from "./clientAgentsRetrieve.js";
 export * from "./clientAgentsRetrieveSchemas.js";
 export * from "./clientAgentsRun.js";
 export * from "./clientAgentsRunStream.js";
+export * from "./clientAgentsUpdate.js";
 export * from "./clientAnnouncementsCreate.js";
 export * from "./clientAnnouncementsDelete.js";
 export * from "./clientAnnouncementsUpdate.js";
@@ -25,6 +27,7 @@ export * from "./clientAnswersDelete.js";
 export * from "./clientAnswersList.js";
 export * from "./clientAnswersRetrieve.js";
 export * from "./clientAnswersUpdate.js";
+export * from "./clientAuthenticationCheckDatasourceAuth.js";
 export * from "./clientAuthenticationCreateToken.js";
 export * from "./clientChatCreate.js";
 export * from "./clientChatCreateStream.js";
@@ -34,6 +37,7 @@ export * from "./clientChatDeleteFiles.js";
 export * from "./clientChatList.js";
 export * from "./clientChatRetrieve.js";
 export * from "./clientChatRetrieveApplication.js";
+export * from "./clientChatRetrieveFile.js";
 export * from "./clientChatRetrieveFiles.js";
 export * from "./clientChatUploadFiles.js";
 export * from "./clientCollectionsAddItems.js";
@@ -44,12 +48,21 @@ export * from "./clientCollectionsList.js";
 export * from "./clientCollectionsRetrieve.js";
 export * from "./clientCollectionsUpdate.js";
 export * from "./clientCollectionsUpdateItem.js";
+export * from "./clientDatasourcesRetrieveConfiguration.js";
+export * from "./clientDatasourcesRetrieveCredentialStatus.js";
+export * from "./clientDatasourcesRotateCredentials.js";
+export * from "./clientDatasourcesUpdateConfiguration.js";
 export * from "./clientDocumentsRetrieve.js";
 export * from "./clientDocumentsRetrieveByFacets.js";
 export * from "./clientDocumentsRetrievePermissions.js";
 export * from "./clientDocumentsSummarize.js";
 export * from "./clientEntitiesList.js";
 export * from "./clientEntitiesReadPeople.js";
+export * from "./clientEntitiesRetrievePersonPhoto.js";
+export * from "./clientGovernanceDataFindingsCreate.js";
+export * from "./clientGovernanceDataFindingsDelete.js";
+export * from "./clientGovernanceDataFindingsDownload.js";
+export * from "./clientGovernanceDataFindingsList.js";
 export * from "./clientGovernanceDataPoliciesCreate.js";
 export * from "./clientGovernanceDataPoliciesDownload.js";
 export * from "./clientGovernanceDataPoliciesList.js";
@@ -77,20 +90,13 @@ export * from "./clientShortcutsDelete.js";
 export * from "./clientShortcutsList.js";
 export * from "./clientShortcutsRetrieve.js";
 export * from "./clientShortcutsUpdate.js";
+export * from "./clientToolsAuthorizeActionPack.js";
 export * from "./clientToolsList.js";
+export * from "./clientToolsRetrieveActionPackAuthStatus.js";
 export * from "./clientToolsRun.js";
 export * from "./clientVerificationAddReminder.js";
 export * from "./clientVerificationList.js";
 export * from "./clientVerificationVerify.js";
-export * from "./datasourcesGetDatasourceCredentialStatus.js";
-export * from "./datasourcesGetDatasourceInstanceConfiguration.js";
-export * from "./datasourcesRotateDatasourceCredentials.js";
-export * from "./datasourcesUpdateDatasourceInstanceConfiguration.js";
-export * from "./entitiesGetPersonPhoto.js";
-export * from "./governanceCreatefindingsexport.js";
-export * from "./governanceDeletefindingsexport.js";
-export * from "./governanceDownloadfindingsexport.js";
-export * from "./governanceListfindingsexports.js";
 export * from "./indexingAuthenticationRotateToken.js";
 export * from "./indexingCustomMetadataDelete.js";
 export * from "./indexingCustomMetadataDeleteSchema.js";
@@ -105,6 +111,7 @@ export * from "./indexingDocumentsBulkIndex.js";
 export * from "./indexingDocumentsCheckAccess.js";
 export * from "./indexingDocumentsCount.js";
 export * from "./indexingDocumentsDebug.js";
+export * from "./indexingDocumentsDebugEvents.js";
 export * from "./indexingDocumentsDebugMany.js";
 export * from "./indexingDocumentsDelete.js";
 export * from "./indexingDocumentsIndex.js";
@@ -133,6 +140,4 @@ export * from "./indexingPermissionsProcessMemberships.js";
 export * from "./indexingPermissionsUpdatePermissions.js";
 export * from "./indexingShortcutsBulkIndex.js";
 export * from "./indexingShortcutsUpload.js";
-export * from "./toolsAuthorizeActionPack.js";
-export * from "./toolsGetActionPackAuthStatus.js";
-export * from "./troubleshootingPostApiIndexV1DebugDatasourceDocumentEvents.js";
+export * from "./searchQuery.js";

package/src/react-query/indexingDocumentsDebugEvents.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a35a22a5a14c
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingDocumentsDebugEvents } from "../funcs/indexingDocumentsDebugEvents.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 { 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 IndexingDocumentsDebugEventsMutationVariables = {
+  debugDocumentLifecycleRequest: components.DebugDocumentLifecycleRequest;
+  datasource: string;
+  options?: RequestOptions;
+};
+
+export type IndexingDocumentsDebugEventsMutationData =
+  components.DebugDocumentLifecycleResponse;
+
+export type IndexingDocumentsDebugEventsMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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 useIndexingDocumentsDebugEventsMutation(
+  options?: MutationHookOptions<
+    IndexingDocumentsDebugEventsMutationData,
+    IndexingDocumentsDebugEventsMutationError,
+    IndexingDocumentsDebugEventsMutationVariables
+  >,
+): UseMutationResult<
+  IndexingDocumentsDebugEventsMutationData,
+  IndexingDocumentsDebugEventsMutationError,
+  IndexingDocumentsDebugEventsMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingDocumentsDebugEventsMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingDocumentsDebugEvents(): MutationKey {
+  return ["@gleanwork/api-client", "documents", "debugEvents"];
+}
+
+export function buildIndexingDocumentsDebugEventsMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingDocumentsDebugEventsMutationVariables,
+  ) => Promise<IndexingDocumentsDebugEventsMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingDocumentsDebugEvents(),
+    mutationFn: function indexingDocumentsDebugEventsMutationFn({
+      debugDocumentLifecycleRequest,
+      datasource,
+      options,
+    }): Promise<IndexingDocumentsDebugEventsMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingDocumentsDebugEvents(
+        client$,
+        debugDocumentLifecycleRequest,
+        datasource,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/searchQuery.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a67629da8040
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { searchQuery } from "../funcs/searchQuery.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 SearchQueryMutationVariables = {
+  request: components.PlatformSearchRequest;
+  options?: RequestOptions;
+};
+
+export type SearchQueryMutationData = components.PlatformSearchResponse;
+
+export type SearchQueryMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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 useSearchQueryMutation(
+  options?: MutationHookOptions<
+    SearchQueryMutationData,
+    SearchQueryMutationError,
+    SearchQueryMutationVariables
+  >,
+): UseMutationResult<
+  SearchQueryMutationData,
+  SearchQueryMutationError,
+  SearchQueryMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSearchQueryMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySearchQuery(): MutationKey {
+  return ["@gleanwork/api-client", "search", "query"];
+}
+
+export function buildSearchQueryMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SearchQueryMutationVariables,
+  ) => Promise<SearchQueryMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySearchQuery(),
+    mutationFn: function searchQueryMutationFn({
+      request,
+      options,
+    }): Promise<SearchQueryMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(searchQuery(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/sdk/agents.ts

@@ -3,53 +3,89 @@
  * @generated-id: a103cd018c9b
  */
 
-import { agentsCreateAgent } from "../funcs/agentsCreateAgent.js";
-import { agentsEditAgent } from "../funcs/agentsEditAgent.js";
+import {
+  agentsCreateRun,
+  CreateRunAcceptEnum,
+} from "../funcs/agentsCreateRun.js";
+import { agentsGet } from "../funcs/agentsGet.js";
+import { agentsGetSchemas } from "../funcs/agentsGetSchemas.js";
+import { agentsSearch } from "../funcs/agentsSearch.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
+export { CreateRunAcceptEnum } from "../funcs/agentsCreateRun.js";
+
 export class Agents extends ClientSDK {
   /**
-   * Create an agent
+   * Search agents
+   *
+   * @remarks
+   * Search agents available to the authenticated user by agent name.
+   */
+  async search(
+    request: components.PlatformAgentsSearchRequest,
+    options?: RequestOptions,
+  ): Promise<components.PlatformAgentsSearchResponse> {
+    return unwrapAsync(agentsSearch(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get agent
    *
    * @remarks
-   * Create an agent.
+   * Retrieve details for an agent available to the authenticated user.
    */
-  async createAgent(
-    createWorkflowRequest: components.CreateWorkflowRequest,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
+  async get(
+    agentId: string,
     options?: RequestOptions,
-  ): Promise<components.WorkflowResult> {
-    return unwrapAsync(agentsCreateAgent(
+  ): Promise<components.PlatformAgentGetResponse> {
+    return unwrapAsync(agentsGet(
       this,
-      createWorkflowRequest,
-      locale,
-      timezoneOffset,
+      agentId,
       options,
     ));
   }
 
   /**
-   * Edit an agent
+   * Get agent schemas
    *
    * @remarks
-   * Creates a draft or publishes an [agent](https://developers.glean.com/agents/agents-api). Use `isDraft=true` to save a draft, or `isDraft=false` (or omit) to publish immediately. Only draft and publish modes are supported.
+   * Retrieve an agent's input and output JSON schemas.
    */
-  async editAgent(
-    editWorkflowRequest: components.EditWorkflowRequest,
+  async getSchemas(
     agentId: string,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
+    includeTools?: boolean | undefined,
     options?: RequestOptions,
-  ): Promise<void> {
-    return unwrapAsync(agentsEditAgent(
+  ): Promise<components.PlatformAgentSchemasResponse> {
+    return unwrapAsync(agentsGetSchemas(
+      this,
+      agentId,
+      includeTools,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async createRun(
+    platformAgentRunCreateRequest: components.PlatformAgentRunCreateRequest,
+    agentId: string,
+    options?: RequestOptions & { acceptHeaderOverride?: CreateRunAcceptEnum },
+  ): Promise<operations.PlatformAgentsCreateRunResponse> {
+    return unwrapAsync(agentsCreateRun(
       this,
-      editWorkflowRequest,
+      platformAgentRunCreateRequest,
       agentId,
-      locale,
-      timezoneOffset,
       options,
     ));
   }