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

import {
  MutationKey,
  useMutation,
  UseMutationResult,
} from "@tanstack/react-query";
import { GleanCore } from "../core.js";
import { indexingDocumentsStatus } from "../funcs/indexingDocumentsStatus.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 IndexingDocumentsStatusMutationVariables = {
  request: components.GetDocumentStatusRequest;
  options?: RequestOptions;
};

export type IndexingDocumentsStatusMutationData =
  components.GetDocumentStatusResponse;

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

/**
 * Get document upload and indexing status
 *
 * @remarks
 * Intended for debugging/validation. Fetches the current upload and indexing status of documents.
 *
 * Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information.
 *
 * @deprecated method: Deprecated on 2026-02-03, removal scheduled for 2026-10-15: Endpoint is deprecated.
 */
export function useIndexingDocumentsStatusMutation(
  options?: MutationHookOptions<
    IndexingDocumentsStatusMutationData,
    IndexingDocumentsStatusMutationError,
    IndexingDocumentsStatusMutationVariables
  >,
): UseMutationResult<
  IndexingDocumentsStatusMutationData,
  IndexingDocumentsStatusMutationError,
  IndexingDocumentsStatusMutationVariables
> {
  const client = useGleanContext();
  return useMutation({
    ...buildIndexingDocumentsStatusMutation(client, options),
    ...options,
  });
}

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

export function buildIndexingDocumentsStatusMutation(
  client$: GleanCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: IndexingDocumentsStatusMutationVariables,
  ) => Promise<IndexingDocumentsStatusMutationData>;
} {
  return {
    mutationKey: mutationKeyIndexingDocumentsStatus(),
    mutationFn: function indexingDocumentsStatusMutationFn({
      request,
      options,
    }): Promise<IndexingDocumentsStatusMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(indexingDocumentsStatus(
        client$,
        request,
        mergedOptions,
      ));
    },
  };
}