import * as z from "zod/v3";
import { ClosedEnum } from "../../types/enums.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import { HTTPMetadata } from "../components/httpmetadata.js";
import { Payroll } from "../components/payroll.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
/**
 * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
 */
export declare const GetV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion: {
    readonly TwoThousandAndTwentyFiveMinus06Minus15: "2025-06-15";
};
/**
 * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
 */
export type GetV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion = ClosedEnum<typeof GetV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion>;
export declare const ProcessingStatuses: {
    readonly Processed: "processed";
    readonly Unprocessed: "unprocessed";
};
export type ProcessingStatuses = ClosedEnum<typeof ProcessingStatuses>;
export declare const QueryParamPayrollTypes: {
    readonly Regular: "regular";
    readonly OffCycle: "off_cycle";
    readonly External: "external";
};
export type QueryParamPayrollTypes = ClosedEnum<typeof QueryParamPayrollTypes>;
export declare const GetV1CompaniesCompanyIdPayrollsQueryParamInclude: {
    readonly Taxes: "taxes";
    readonly PayrollStatusMeta: "payroll_status_meta";
    readonly Totals: "totals";
    readonly RiskBlockers: "risk_blockers";
    readonly Reversals: "reversals";
};
export type GetV1CompaniesCompanyIdPayrollsQueryParamInclude = ClosedEnum<typeof GetV1CompaniesCompanyIdPayrollsQueryParamInclude>;
/**
 * Specifies which date field to use when filtering payrolls with start_date and end_date. This field applies only to regular processed payrolls and defaults to pay period if not provided.
 */
export declare const DateFilterBy: {
    readonly CheckDate: "check_date";
};
/**
 * Specifies which date field to use when filtering payrolls with start_date and end_date. This field applies only to regular processed payrolls and defaults to pay period if not provided.
 */
export type DateFilterBy = ClosedEnum<typeof DateFilterBy>;
/**
 * A string indicating whether to sort resulting events in ascending (asc) or descending (desc) chronological order. Events are sorted by their `timestamp`. Defaults to asc if left empty.
 */
export declare const SortOrder: {
    readonly Asc: "asc";
    readonly Desc: "desc";
};
/**
 * A string indicating whether to sort resulting events in ascending (asc) or descending (desc) chronological order. Events are sorted by their `timestamp`. Defaults to asc if left empty.
 */
export type SortOrder = ClosedEnum<typeof SortOrder>;
export type GetV1CompaniesCompanyIdPayrollsRequest = {
    /**
     * The UUID of the company
     */
    companyId: string;
    /**
     * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
     */
    xGustoAPIVersion?: GetV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion | undefined;
    /**
     * Whether to include processed and/or unprocessed payrolls in the response, defaults to processed, for multiple attributes comma separate the values, i.e. `?processing_statuses=processed,unprocessed`
     */
    processingStatuses?: Array<ProcessingStatuses> | undefined;
    /**
     * Whether to include regular and/or off_cycle payrolls in the response, defaults to regular, for multiple attributes comma separate the values, i.e. `?payroll_types=regular,off_cycle`
     */
    payrollTypes?: Array<QueryParamPayrollTypes> | undefined;
    /**
     * Whether to return processed or unprocessed payrolls
     */
    processed?: boolean | undefined;
    /**
     * Whether to include off cycle payrolls in the response
     */
    includeOffCycle?: boolean | undefined;
    /**
     * Include the requested attribute in the response, for multiple attributes comma separate the values, i.e. `?include=benefits,deductions,taxes`
     */
    include?: Array<GetV1CompaniesCompanyIdPayrollsQueryParamInclude> | undefined;
    /**
     * Return payrolls whose pay period is after the start date
     */
    startDate?: string | undefined;
    /**
     * Return payrolls whose pay period is before the end date. If left empty, defaults to today's date.
     */
    endDate?: string | undefined;
    /**
     * Specifies which date field to use when filtering payrolls with start_date and end_date. This field applies only to regular processed payrolls and defaults to pay period if not provided.
     */
    dateFilterBy?: DateFilterBy | undefined;
    /**
     * The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
     */
    page?: number | undefined;
    /**
     * Number of objects per page. For majority of endpoints will default to 25
     */
    per?: number | undefined;
    /**
     * A string indicating whether to sort resulting events in ascending (asc) or descending (desc) chronological order. Events are sorted by their `timestamp`. Defaults to asc if left empty.
     */
    sortOrder?: SortOrder | undefined;
};
export type GetV1CompaniesCompanyIdPayrollsResponse = {
    httpMeta: HTTPMetadata;
    /**
     * Successful
     */
    payrollList?: Array<Payroll> | undefined;
};
/** @internal */
export declare const GetV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion$outboundSchema: z.ZodNativeEnum<typeof GetV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion>;
/** @internal */
export declare const ProcessingStatuses$outboundSchema: z.ZodNativeEnum<typeof ProcessingStatuses>;
/** @internal */
export declare const QueryParamPayrollTypes$outboundSchema: z.ZodNativeEnum<typeof QueryParamPayrollTypes>;
/** @internal */
export declare const GetV1CompaniesCompanyIdPayrollsQueryParamInclude$outboundSchema: z.ZodNativeEnum<typeof GetV1CompaniesCompanyIdPayrollsQueryParamInclude>;
/** @internal */
export declare const DateFilterBy$outboundSchema: z.ZodNativeEnum<typeof DateFilterBy>;
/** @internal */
export declare const SortOrder$outboundSchema: z.ZodNativeEnum<typeof SortOrder>;
/** @internal */
export type GetV1CompaniesCompanyIdPayrollsRequest$Outbound = {
    company_id: string;
    "X-Gusto-API-Version": string;
    processing_statuses?: Array<string> | undefined;
    payroll_types?: Array<string> | undefined;
    processed?: boolean | undefined;
    include_off_cycle?: boolean | undefined;
    include?: Array<string> | undefined;
    start_date?: string | undefined;
    end_date?: string | undefined;
    date_filter_by?: string | undefined;
    page?: number | undefined;
    per?: number | undefined;
    sort_order?: string | undefined;
};
/** @internal */
export declare const GetV1CompaniesCompanyIdPayrollsRequest$outboundSchema: z.ZodType<GetV1CompaniesCompanyIdPayrollsRequest$Outbound, z.ZodTypeDef, GetV1CompaniesCompanyIdPayrollsRequest>;
export declare function getV1CompaniesCompanyIdPayrollsRequestToJSON(getV1CompaniesCompanyIdPayrollsRequest: GetV1CompaniesCompanyIdPayrollsRequest): string;
/** @internal */
export declare const GetV1CompaniesCompanyIdPayrollsResponse$inboundSchema: z.ZodType<GetV1CompaniesCompanyIdPayrollsResponse, z.ZodTypeDef, unknown>;
export declare function getV1CompaniesCompanyIdPayrollsResponseFromJSON(jsonString: string): SafeParseResult<GetV1CompaniesCompanyIdPayrollsResponse, SDKValidationError>;
//# sourceMappingURL=getv1companiescompanyidpayrolls.d.ts.map