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

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

export type ClientGovernanceDocumentsVisibilityoverridesCreateMutationData =
  components.UpdateDocumentVisibilityOverridesResponse;

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

/**
 * Hide or unhide docs
 *
 * @remarks
 * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.
 */
export function useClientGovernanceDocumentsVisibilityoverridesCreateMutation(
  options?: MutationHookOptions<
    ClientGovernanceDocumentsVisibilityoverridesCreateMutationData,
    ClientGovernanceDocumentsVisibilityoverridesCreateMutationError,
    ClientGovernanceDocumentsVisibilityoverridesCreateMutationVariables
  >,
): UseMutationResult<
  ClientGovernanceDocumentsVisibilityoverridesCreateMutationData,
  ClientGovernanceDocumentsVisibilityoverridesCreateMutationError,
  ClientGovernanceDocumentsVisibilityoverridesCreateMutationVariables
> {
  const client = useGleanContext();
  return useMutation({
    ...buildClientGovernanceDocumentsVisibilityoverridesCreateMutation(
      client,
      options,
    ),
    ...options,
  });
}

export function mutationKeyClientGovernanceDocumentsVisibilityoverridesCreate(): MutationKey {
  return ["@gleanwork/api-client", "visibilityoverrides", "create"];
}

export function buildClientGovernanceDocumentsVisibilityoverridesCreateMutation(
  client$: GleanCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables:
      ClientGovernanceDocumentsVisibilityoverridesCreateMutationVariables,
  ) => Promise<ClientGovernanceDocumentsVisibilityoverridesCreateMutationData>;
} {
  return {
    mutationKey:
      mutationKeyClientGovernanceDocumentsVisibilityoverridesCreate(),
    mutationFn:
      function clientGovernanceDocumentsVisibilityoverridesCreateMutationFn({
        request,
        options,
      }): Promise<
        ClientGovernanceDocumentsVisibilityoverridesCreateMutationData
      > {
        const mergedOptions = {
          ...hookOptions,
          ...options,
          fetchOptions: {
            ...hookOptions?.fetchOptions,
            ...options?.fetchOptions,
            signal: combineSignals(
              hookOptions?.fetchOptions?.signal,
              options?.fetchOptions?.signal,
            ),
          },
        };
        return unwrapAsync(clientGovernanceDocumentsVisibilityoverridesCreate(
          client$,
          request,
          mergedOptions,
        ));
      },
  };
}