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

import {
  MutationKey,
  useMutation,
  UseMutationResult,
} from "@tanstack/react-query";
import { GleanCore } from "../core.js";
import { clientDocumentsRetrieve } from "../funcs/clientDocumentsRetrieve.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 ClientDocumentsRetrieveMutationVariables = {
  getDocumentsRequest?: components.GetDocumentsRequest | undefined;
  locale?: string | undefined;
  options?: RequestOptions;
};

export type ClientDocumentsRetrieveMutationData =
  components.GetDocumentsResponse;

export type ClientDocumentsRetrieveMutationError =
  | GleanBaseError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Read documents
 *
 * @remarks
 * Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) for the given list of Glean Document IDs or URLs specified in the request.
 */
export function useClientDocumentsRetrieveMutation(
  options?: MutationHookOptions<
    ClientDocumentsRetrieveMutationData,
    ClientDocumentsRetrieveMutationError,
    ClientDocumentsRetrieveMutationVariables
  >,
): UseMutationResult<
  ClientDocumentsRetrieveMutationData,
  ClientDocumentsRetrieveMutationError,
  ClientDocumentsRetrieveMutationVariables
> {
  const client = useGleanContext();
  return useMutation({
    ...buildClientDocumentsRetrieveMutation(client, options),
    ...options,
  });
}

export function mutationKeyClientDocumentsRetrieve(): MutationKey {
  return ["@gleanwork/api-client", "documents", "retrieve"];
}

export function buildClientDocumentsRetrieveMutation(
  client$: GleanCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: ClientDocumentsRetrieveMutationVariables,
  ) => Promise<ClientDocumentsRetrieveMutationData>;
} {
  return {
    mutationKey: mutationKeyClientDocumentsRetrieve(),
    mutationFn: function clientDocumentsRetrieveMutationFn({
      getDocumentsRequest,
      locale,
      options,
    }): Promise<ClientDocumentsRetrieveMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(clientDocumentsRetrieve(
        client$,
        getDocumentsRequest,
        locale,
        mergedOptions,
      ));
    },
  };
}