@gleanwork/api-client 0.14.19 → 0.15.0

package/src/react-query/agentsEditAgent.ts

@@ -0,0 +1,120 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3b25e9fb1e70
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { agentsEditAgent } from "../funcs/agentsEditAgent.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 AgentsEditAgentMutationVariables = {
+  editWorkflowRequest: components.EditWorkflowRequest;
+  agentId: string;
+  locale?: string | undefined;
+  timezoneOffset?: number | undefined;
+  options?: RequestOptions;
+};
+
+export type AgentsEditAgentMutationData = void;
+
+export type AgentsEditAgentMutationError =
+  | errors.ErrorResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Edit an agent
+ *
+ * @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.
+ */
+export function useAgentsEditAgentMutation(
+  options?: MutationHookOptions<
+    AgentsEditAgentMutationData,
+    AgentsEditAgentMutationError,
+    AgentsEditAgentMutationVariables
+  >,
+): UseMutationResult<
+  AgentsEditAgentMutationData,
+  AgentsEditAgentMutationError,
+  AgentsEditAgentMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildAgentsEditAgentMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyAgentsEditAgent(): MutationKey {
+  return ["@gleanwork/api-client", "Agents", "editAgent"];
+}
+
+export function buildAgentsEditAgentMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: AgentsEditAgentMutationVariables,
+  ) => Promise<AgentsEditAgentMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyAgentsEditAgent(),
+    mutationFn: function agentsEditAgentMutationFn({
+      editWorkflowRequest,
+      agentId,
+      locale,
+      timezoneOffset,
+      options,
+    }): Promise<AgentsEditAgentMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(agentsEditAgent(
+        client$,
+        editWorkflowRequest,
+        agentId,
+        locale,
+        timezoneOffset,
+        mergedOptions,
+      ));
+    },
+  };
+}

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

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4f2f16467589
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { chatGetChatFile } from "../funcs/chatGetChatFile.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+export type ChatGetChatFileQueryData = ReadableStream<Uint8Array>;
+
+export function prefetchChatGetChatFile(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  fileId: string,
+  preview?: boolean | undefined,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildChatGetChatFileQuery(
+      client$,
+      fileId,
+      preview,
+      options,
+    ),
+  });
+}
+
+export function buildChatGetChatFileQuery(
+  client$: GleanCore,
+  fileId: string,
+  preview?: boolean | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<ChatGetChatFileQueryData>;
+} {
+  return {
+    queryKey: queryKeyChatGetChatFile(fileId, { preview }),
+    queryFn: async function chatGetChatFileQueryFn(
+      ctx,
+    ): Promise<ChatGetChatFileQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(chatGetChatFile(
+        client$,
+        fileId,
+        preview,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyChatGetChatFile(
+  fileId: string,
+  parameters: { preview?: boolean | undefined },
+): QueryKey {
+  return ["@gleanwork/api-client", "Chat", "getChatFile", fileId, parameters];
+}

package/src/react-query/chatGetChatFile.ts

@@ -0,0 +1,136 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0b11cd5244ab
+ */
+
+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 {
+  buildChatGetChatFileQuery,
+  ChatGetChatFileQueryData,
+  prefetchChatGetChatFile,
+  queryKeyChatGetChatFile,
+} from "./chatGetChatFile.core.js";
+export {
+  buildChatGetChatFileQuery,
+  type ChatGetChatFileQueryData,
+  prefetchChatGetChatFile,
+  queryKeyChatGetChatFile,
+};
+
+export type ChatGetChatFileQueryError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Download a chat file
+ *
+ * @remarks
+ * Download the raw content of a file generated or uploaded during a chat session (for example, an image produced by the assistant). Returns the file bytes with a Content-Type header matching the file's MIME type.
+ */
+export function useChatGetChatFile(
+  fileId: string,
+  preview?: boolean | undefined,
+  options?: QueryHookOptions<
+    ChatGetChatFileQueryData,
+    ChatGetChatFileQueryError
+  >,
+): UseQueryResult<ChatGetChatFileQueryData, ChatGetChatFileQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildChatGetChatFileQuery(
+      client,
+      fileId,
+      preview,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Download a chat file
+ *
+ * @remarks
+ * Download the raw content of a file generated or uploaded during a chat session (for example, an image produced by the assistant). Returns the file bytes with a Content-Type header matching the file's MIME type.
+ */
+export function useChatGetChatFileSuspense(
+  fileId: string,
+  preview?: boolean | undefined,
+  options?: SuspenseQueryHookOptions<
+    ChatGetChatFileQueryData,
+    ChatGetChatFileQueryError
+  >,
+): UseSuspenseQueryResult<ChatGetChatFileQueryData, ChatGetChatFileQueryError> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildChatGetChatFileQuery(
+      client,
+      fileId,
+      preview,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setChatGetChatFileData(
+  client: QueryClient,
+  queryKeyBase: [fileId: string, parameters: { preview?: boolean | undefined }],
+  data: ChatGetChatFileQueryData,
+): ChatGetChatFileQueryData | undefined {
+  const key = queryKeyChatGetChatFile(...queryKeyBase);
+
+  return client.setQueryData<ChatGetChatFileQueryData>(key, data);
+}
+
+export function invalidateChatGetChatFile(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [fileId: string, parameters: { preview?: boolean | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "Chat", "getChatFile", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllChatGetChatFile(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "Chat", "getChatFile"],
+  });
+}

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

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 8b0b17f93827
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { datasourcesGetDatasourceCredentialStatus } from "../funcs/datasourcesGetDatasourceCredentialStatus.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type DatasourcesGetDatasourceCredentialStatusQueryData =
+  components.DatasourceCredentialStatusResponse;
+
+export function prefetchDatasourcesGetDatasourceCredentialStatus(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  datasourceInstanceId: string,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildDatasourcesGetDatasourceCredentialStatusQuery(
+      client$,
+      datasourceInstanceId,
+      options,
+    ),
+  });
+}
+
+export function buildDatasourcesGetDatasourceCredentialStatusQuery(
+  client$: GleanCore,
+  datasourceInstanceId: string,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<DatasourcesGetDatasourceCredentialStatusQueryData>;
+} {
+  return {
+    queryKey: queryKeyDatasourcesGetDatasourceCredentialStatus(
+      datasourceInstanceId,
+    ),
+    queryFn: async function datasourcesGetDatasourceCredentialStatusQueryFn(
+      ctx,
+    ): Promise<DatasourcesGetDatasourceCredentialStatusQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(datasourcesGetDatasourceCredentialStatus(
+        client$,
+        datasourceInstanceId,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyDatasourcesGetDatasourceCredentialStatus(
+  datasourceInstanceId: string,
+): QueryKey {
+  return [
+    "@gleanwork/api-client",
+    "Datasources",
+    "getDatasourceCredentialStatus",
+    datasourceInstanceId,
+  ];
+}

package/src/react-query/datasourcesGetDatasourceCredentialStatus.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 389e75cf9af7
+ */
+
+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 {
+  buildDatasourcesGetDatasourceCredentialStatusQuery,
+  DatasourcesGetDatasourceCredentialStatusQueryData,
+  prefetchDatasourcesGetDatasourceCredentialStatus,
+  queryKeyDatasourcesGetDatasourceCredentialStatus,
+} from "./datasourcesGetDatasourceCredentialStatus.core.js";
+export {
+  buildDatasourcesGetDatasourceCredentialStatusQuery,
+  type DatasourcesGetDatasourceCredentialStatusQueryData,
+  prefetchDatasourcesGetDatasourceCredentialStatus,
+  queryKeyDatasourcesGetDatasourceCredentialStatus,
+};
+
+export type DatasourcesGetDatasourceCredentialStatusQueryError =
+  | errors.ErrorResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get datasource instance credential status
+ *
+ * @remarks
+ * Returns the current credential status for a datasource instance. Access is limited to callers with the ADMIN scope; the handler enforces this check.
+ */
+export function useDatasourcesGetDatasourceCredentialStatus(
+  datasourceInstanceId: string,
+  options?: QueryHookOptions<
+    DatasourcesGetDatasourceCredentialStatusQueryData,
+    DatasourcesGetDatasourceCredentialStatusQueryError
+  >,
+): UseQueryResult<
+  DatasourcesGetDatasourceCredentialStatusQueryData,
+  DatasourcesGetDatasourceCredentialStatusQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildDatasourcesGetDatasourceCredentialStatusQuery(
+      client,
+      datasourceInstanceId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get datasource instance credential status
+ *
+ * @remarks
+ * Returns the current credential status for a datasource instance. Access is limited to callers with the ADMIN scope; the handler enforces this check.
+ */
+export function useDatasourcesGetDatasourceCredentialStatusSuspense(
+  datasourceInstanceId: string,
+  options?: SuspenseQueryHookOptions<
+    DatasourcesGetDatasourceCredentialStatusQueryData,
+    DatasourcesGetDatasourceCredentialStatusQueryError
+  >,
+): UseSuspenseQueryResult<
+  DatasourcesGetDatasourceCredentialStatusQueryData,
+  DatasourcesGetDatasourceCredentialStatusQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildDatasourcesGetDatasourceCredentialStatusQuery(
+      client,
+      datasourceInstanceId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setDatasourcesGetDatasourceCredentialStatusData(
+  client: QueryClient,
+  queryKeyBase: [datasourceInstanceId: string],
+  data: DatasourcesGetDatasourceCredentialStatusQueryData,
+): DatasourcesGetDatasourceCredentialStatusQueryData | undefined {
+  const key = queryKeyDatasourcesGetDatasourceCredentialStatus(...queryKeyBase);
+
+  return client.setQueryData<DatasourcesGetDatasourceCredentialStatusQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateDatasourcesGetDatasourceCredentialStatus(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[datasourceInstanceId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "Datasources",
+      "getDatasourceCredentialStatus",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllDatasourcesGetDatasourceCredentialStatus(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "Datasources",
+      "getDatasourceCredentialStatus",
+    ],
+  });
+}

package/src/react-query/datasourcesRotateDatasourceCredentials.ts

@@ -0,0 +1,121 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c212153c2287
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { datasourcesRotateDatasourceCredentials } from "../funcs/datasourcesRotateDatasourceCredentials.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 DatasourcesRotateDatasourceCredentialsMutationVariables = {
+  rotateDatasourceCredentialsRequest:
+    components.RotateDatasourceCredentialsRequest;
+  datasourceInstanceId: string;
+  options?: RequestOptions;
+};
+
+export type DatasourcesRotateDatasourceCredentialsMutationData =
+  components.DatasourceCredentialStatusResponse;
+
+export type DatasourcesRotateDatasourceCredentialsMutationError =
+  | errors.ErrorResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Rotate datasource instance credentials
+ *
+ * @remarks
+ * Rotates the credentials that a datasource instance uses to connect to its upstream system. Replaces the active credential material with the supplied values and returns the credential status after rotation. Access is limited to callers with the ADMIN scope; the handler enforces this check.
+ * Only keys recognized as credential material for the datasource type may be set in `credentials.values` (e.g. `clientSecret`, `apiToken`, `privateKey`, depending on the configured auth method). Unrecognized keys, or keys that correspond to non-credential configuration, cause a 400; other instance configuration must be updated via PATCH /configure/datasources/{datasourceId}/instances/{instanceId}.
+ */
+export function useDatasourcesRotateDatasourceCredentialsMutation(
+  options?: MutationHookOptions<
+    DatasourcesRotateDatasourceCredentialsMutationData,
+    DatasourcesRotateDatasourceCredentialsMutationError,
+    DatasourcesRotateDatasourceCredentialsMutationVariables
+  >,
+): UseMutationResult<
+  DatasourcesRotateDatasourceCredentialsMutationData,
+  DatasourcesRotateDatasourceCredentialsMutationError,
+  DatasourcesRotateDatasourceCredentialsMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildDatasourcesRotateDatasourceCredentialsMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyDatasourcesRotateDatasourceCredentials(): MutationKey {
+  return [
+    "@gleanwork/api-client",
+    "Datasources",
+    "rotateDatasourceCredentials",
+  ];
+}
+
+export function buildDatasourcesRotateDatasourceCredentialsMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: DatasourcesRotateDatasourceCredentialsMutationVariables,
+  ) => Promise<DatasourcesRotateDatasourceCredentialsMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyDatasourcesRotateDatasourceCredentials(),
+    mutationFn: function datasourcesRotateDatasourceCredentialsMutationFn({
+      rotateDatasourceCredentialsRequest,
+      datasourceInstanceId,
+      options,
+    }): Promise<DatasourcesRotateDatasourceCredentialsMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(datasourcesRotateDatasourceCredentials(
+        client$,
+        rotateDatasourceCredentialsRequest,
+        datasourceInstanceId,
+        mergedOptions,
+      ));
+    },
+  };
+}