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

import {
  MutationKey,
  useMutation,
  UseMutationResult,
} from "@tanstack/react-query";
import { GustoEmbeddedCore } from "../core.js";
import { federalTaxDetailsUpdate } from "../funcs/federalTaxDetailsUpdate.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 {
  PutV1CompaniesCompanyIdFederalTaxDetailsRequest,
  PutV1CompaniesCompanyIdFederalTaxDetailsResponse,
} from "../models/operations/putv1companiescompanyidfederaltaxdetails.js";
import { unwrapAsync } from "../types/fp.js";
import { useGustoEmbeddedContext } from "./_context.js";
import { MutationHookOptions } from "./_types.js";

export type FederalTaxDetailsUpdateMutationVariables = {
  request: PutV1CompaniesCompanyIdFederalTaxDetailsRequest;
  options?: RequestOptions;
};

export type FederalTaxDetailsUpdateMutationData =
  PutV1CompaniesCompanyIdFederalTaxDetailsResponse;

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

/**
 * Update a company's federal tax details
 *
 * @remarks
 * Updates a company's federal tax details including EIN, legal name, tax payer type, filing form, and S-Corp
 * taxation status. This information is required to onboard a company for use with Gusto Embedded Payroll.
 *
 * ### Prerequisites
 * Before calling this endpoint, retrieve the current federal tax details and `version` via [GET /v1/companies/{company_id}/federal_tax_details](ref:get-v1-companies-company_id-federal_tax_details)
 *
 * ### Webhooks
 * - `company.updated`: Fires when federal tax details for a company are successfully updated
 *
 * **Setup:** [POST /v1/webhook_subscriptions](ref:post-v1-webhook-subscription) with `subscription_types`: `["Company"]`
 *
 * scope: `company_federal_taxes:write`
 */
export function useFederalTaxDetailsUpdateMutation(
  options?: MutationHookOptions<
    FederalTaxDetailsUpdateMutationData,
    FederalTaxDetailsUpdateMutationError,
    FederalTaxDetailsUpdateMutationVariables
  >,
): UseMutationResult<
  FederalTaxDetailsUpdateMutationData,
  FederalTaxDetailsUpdateMutationError,
  FederalTaxDetailsUpdateMutationVariables
> {
  const client = useGustoEmbeddedContext();
  return useMutation({
    ...buildFederalTaxDetailsUpdateMutation(client, options),
    ...options,
  });
}

export function mutationKeyFederalTaxDetailsUpdate(): MutationKey {
  return ["@gusto/embedded-api", "federalTaxDetails", "update"];
}

export function buildFederalTaxDetailsUpdateMutation(
  client$: GustoEmbeddedCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: FederalTaxDetailsUpdateMutationVariables,
  ) => Promise<FederalTaxDetailsUpdateMutationData>;
} {
  return {
    mutationKey: mutationKeyFederalTaxDetailsUpdate(),
    mutationFn: function federalTaxDetailsUpdateMutationFn({
      request,
      options,
    }): Promise<FederalTaxDetailsUpdateMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(federalTaxDetailsUpdate(
        client$,
        request,
        mergedOptions,
      ));
    },
  };
}