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

import {
  MutationKey,
  useMutation,
  UseMutationResult,
} from "@tanstack/react-query";
import { GustoEmbeddedCore } from "../core.js";
import { signatoriesInvite } from "../funcs/signatoriesInvite.js";
import { combineSignals } from "../lib/primitives.js";
import { RequestOptions } from "../lib/sdks.js";
import { GustoEmbeddedError } from "../models/errors/gustoembeddederror.js";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import { NotFoundErrorObject } from "../models/errors/notfounderrorobject.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { UnprocessableEntityError } from "../models/errors/unprocessableentityerror.js";
import {
  PostV1CompaniesCompanyUuidSignatoriesInviteRequest,
  PostV1CompaniesCompanyUuidSignatoriesInviteResponse,
} from "../models/operations/postv1companiescompanyuuidsignatoriesinvite.js";
import { unwrapAsync } from "../types/fp.js";
import { useGustoEmbeddedContext } from "./_context.js";
import { MutationHookOptions } from "./_types.js";

export type SignatoriesInviteMutationVariables = {
  request: PostV1CompaniesCompanyUuidSignatoriesInviteRequest;
  options?: RequestOptions;
};

export type SignatoriesInviteMutationData =
  PostV1CompaniesCompanyUuidSignatoriesInviteResponse;

export type SignatoriesInviteMutationError =
  | NotFoundErrorObject
  | UnprocessableEntityError
  | GustoEmbeddedError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Invite a signatory
 *
 * @remarks
 * Creates a signatory with minimal information. This signatory can be invited to provide more information through the [Update a signatory](ref:put-v1-companies-company_uuid-signatories-signatory_uuid) endpoint. This will start the identity verification process and allow the signatory to be verified to sign documents.
 *
 * ## Related guides
 * - [Signatory Events](doc:signatory-events)
 *
 * scope: `signatories:manage`
 */
export function useSignatoriesInviteMutation(
  options?: MutationHookOptions<
    SignatoriesInviteMutationData,
    SignatoriesInviteMutationError,
    SignatoriesInviteMutationVariables
  >,
): UseMutationResult<
  SignatoriesInviteMutationData,
  SignatoriesInviteMutationError,
  SignatoriesInviteMutationVariables
> {
  const client = useGustoEmbeddedContext();
  return useMutation({
    ...buildSignatoriesInviteMutation(client, options),
    ...options,
  });
}

export function mutationKeySignatoriesInvite(): MutationKey {
  return ["@gusto/embedded-api", "Signatories", "invite"];
}

export function buildSignatoriesInviteMutation(
  client$: GustoEmbeddedCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: SignatoriesInviteMutationVariables,
  ) => Promise<SignatoriesInviteMutationData>;
} {
  return {
    mutationKey: mutationKeySignatoriesInvite(),
    mutationFn: function signatoriesInviteMutationFn({
      request,
      options,
    }): Promise<SignatoriesInviteMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(signatoriesInvite(
        client$,
        request,
        mergedOptions,
      ));
    },
  };
}