/* * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ import { MutationKey, useMutation, UseMutationResult, } from "@tanstack/react-query"; import { GustoEmbeddedCore } from "../core.js"; import { reportsPostV1BulkReports } from "../funcs/reportsPostV1BulkReports.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 { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { UnprocessableEntityError } from "../models/errors/unprocessableentityerror.js"; import { PostV1BulkReportsRequest, PostV1BulkReportsResponse, PostV1BulkReportsSecurity, } from "../models/operations/postv1bulkreports.js"; import { unwrapAsync } from "../types/fp.js"; import { useGustoEmbeddedContext } from "./_context.js"; import { MutationHookOptions } from "./_types.js"; export type ReportsPostV1BulkReportsMutationVariables = { security: PostV1BulkReportsSecurity; request: PostV1BulkReportsRequest; options?: RequestOptions; }; export type ReportsPostV1BulkReportsMutationData = PostV1BulkReportsResponse; export type ReportsPostV1BulkReportsMutationError = | UnprocessableEntityError | GustoEmbeddedError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError; /** * Create a bulk report batch * * @remarks * Triggers asynchronous generation of up to 25 reports across companies the partner is mapped to. Each `batch` item is a `custom_report` (same parameters as [create a custom report](https://docs.gusto.com/embedded-payroll/reference/post-companies-company_uuid-reports)) or a `general_ledger` report (same parameters as [create a general ledger report](https://docs.gusto.com/embedded-payroll/reference/post-payrolls-payroll_uuid-reports-general_ledger)), keyed by `company_uuid` and `report_type`. Items are validated synchronously; if any is invalid, the entire batch is rejected. * * Poll the [bulk report GET endpoint](https://docs.gusto.com/embedded-payroll/reference/get-v1-bulk_reports-request_uuid) with the returned `uuid` for status and the report URL, which is valid for 10 minutes. * * 📘 System Access Authentication * * This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access) * * scope: `company_reports:write` */ export function useReportsPostV1BulkReportsMutation( options?: MutationHookOptions< ReportsPostV1BulkReportsMutationData, ReportsPostV1BulkReportsMutationError, ReportsPostV1BulkReportsMutationVariables >, ): UseMutationResult< ReportsPostV1BulkReportsMutationData, ReportsPostV1BulkReportsMutationError, ReportsPostV1BulkReportsMutationVariables > { const client = useGustoEmbeddedContext(); return useMutation({ ...buildReportsPostV1BulkReportsMutation(client, options), ...options, }); } export function mutationKeyReportsPostV1BulkReports(): MutationKey { return ["@gusto/embedded-api-v-2026-06-15", "Reports", "postV1BulkReports"]; } export function buildReportsPostV1BulkReportsMutation( client$: GustoEmbeddedCore, hookOptions?: RequestOptions, ): { mutationKey: MutationKey; mutationFn: ( variables: ReportsPostV1BulkReportsMutationVariables, ) => Promise; } { return { mutationKey: mutationKeyReportsPostV1BulkReports(), mutationFn: function reportsPostV1BulkReportsMutationFn({ security, request, options, }): Promise { const mergedOptions = { ...hookOptions, ...options, fetchOptions: { ...hookOptions?.fetchOptions, ...options?.fetchOptions, signal: combineSignals( hookOptions?.fetchOptions?.signal, options?.fetchOptions?.signal, ), }, }; return unwrapAsync(reportsPostV1BulkReports( client$, security, request, mergedOptions, )); }, }; }