import { GustoEmbeddedCore } from "../core.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 { GetV1PayrollBatchesPayrollBatchUuidRequest, GetV1PayrollBatchesPayrollBatchUuidResponse, GetV1PayrollBatchesPayrollBatchUuidSecurity } from "../models/operations/getv1payrollbatchespayrollbatchuuid.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
 * Get a payroll cancellation batch
 *
 * @remarks
 * Returns the status and per-payroll results of a payroll cancellation batch.
 *
 * Poll this endpoint until the batch `status` reaches a terminal value (`completed` or `failed`). Once terminal, the response includes the `results` array (one entry per authorized payroll, each with its own per-payroll `status` — `success` or `failed`) and the `exclusions` array (one entry per payroll that could not be processed). A cancel is atomic, so a per-payroll result is only ever `success` or `failed` — never `partial_success`.
 *
 * Note that the top-level batch `status` (`pending` / `processing` / `completed` / `failed`) is the request lifecycle, distinct from the per-payroll `status` inside `results[]`. A `completed` batch does not imply every payroll was cancelled — inspect the array for per-payroll outcomes.
 *
 * Results are stored in Redis with a limited TTL after completion. If the partner polls after results have expired, this endpoint returns 410 Gone — partners should re-submit a new batch.
 *
 * 📘 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: `payroll_batches:read`
 */
export declare function payrollCancellationsGetV1PayrollBatchesPayrollBatchUuid(client: GustoEmbeddedCore, security: GetV1PayrollBatchesPayrollBatchUuidSecurity, request: GetV1PayrollBatchesPayrollBatchUuidRequest, options?: RequestOptions): APIPromise<Result<GetV1PayrollBatchesPayrollBatchUuidResponse, NotFoundErrorObject | GustoEmbeddedError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=payrollCancellationsGetV1PayrollBatchesPayrollBatchUuid.d.ts.map