/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import {
  InvalidateQueryFilters,
  QueryClient,
  useQuery,
  UseQueryResult,
  useSuspenseQuery,
  UseSuspenseQueryResult,
} from "@tanstack/react-query";
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 { SDKError } from "../models/errors/sdkerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import * as operations from "../models/operations/index.js";
import { useSDKContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildSandboxDownloadFileQuery,
  prefetchSandboxDownloadFile,
  queryKeySandboxDownloadFile,
  SandboxDownloadFileQueryData,
} from "./sandboxDownloadFile.core.js";
export {
  buildSandboxDownloadFileQuery,
  prefetchSandboxDownloadFile,
  queryKeySandboxDownloadFile,
  type SandboxDownloadFileQueryData,
};

export type SandboxDownloadFileQueryError =
  | errors.HTTPValidationError
  | SDKError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Download Workspace File
 *
 * @remarks
 * Download raw bytes from a file in the session workspace.
 */
export function useSandboxDownloadFile(
  request: operations.DownloadWorkspaceFileRequest,
  options?: QueryHookOptions<
    SandboxDownloadFileQueryData,
    SandboxDownloadFileQueryError
  >,
): UseQueryResult<SandboxDownloadFileQueryData, SandboxDownloadFileQueryError> {
  const client = useSDKContext();
  return useQuery({
    ...buildSandboxDownloadFileQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Download Workspace File
 *
 * @remarks
 * Download raw bytes from a file in the session workspace.
 */
export function useSandboxDownloadFileSuspense(
  request: operations.DownloadWorkspaceFileRequest,
  options?: SuspenseQueryHookOptions<
    SandboxDownloadFileQueryData,
    SandboxDownloadFileQueryError
  >,
): UseSuspenseQueryResult<
  SandboxDownloadFileQueryData,
  SandboxDownloadFileQueryError
> {
  const client = useSDKContext();
  return useSuspenseQuery({
    ...buildSandboxDownloadFileQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setSandboxDownloadFileData(
  client: QueryClient,
  queryKeyBase: [
    sessionId: string,
    filePath: string,
    parameters: {
      sessionToken?: string | null | undefined;
      xOnBehalfOf?: string | undefined;
    },
  ],
  data: SandboxDownloadFileQueryData,
): SandboxDownloadFileQueryData | undefined {
  const key = queryKeySandboxDownloadFile(...queryKeyBase);

  return client.setQueryData<SandboxDownloadFileQueryData>(key, data);
}

export function invalidateSandboxDownloadFile(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      sessionId: string,
      filePath: string,
      parameters: {
        sessionToken?: string | null | undefined;
        xOnBehalfOf?: string | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@meetkai/mka1", "sandbox", "downloadFile", ...queryKeyBase],
  });
}

export function invalidateAllSandboxDownloadFile(
  client: QueryClient,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@meetkai/mka1", "sandbox", "downloadFile"],
  });
}