import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { RFCDate } from "../../types/rfcdate.js"; import { HTTPMetadata } from "../components/httpmetadata.js"; import { PayPeriod } from "../components/payperiod.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 GetV1CompaniesCompanyIdPayPeriodsHeaderXGustoAPIVersion: { 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 GetV1CompaniesCompanyIdPayPeriodsHeaderXGustoAPIVersion = ClosedEnum; /** * Comma-separated list of payroll types to include (regular, transition). Defaults to regular only. */ export declare const PayrollTypes: { readonly Regular: "regular"; readonly Transition: "transition"; readonly RegularTransition: "regular,transition"; }; /** * Comma-separated list of payroll types to include (regular, transition). Defaults to regular only. */ export type PayrollTypes = ClosedEnum; export type GetV1CompaniesCompanyIdPayPeriodsRequest = { /** * 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?: GetV1CompaniesCompanyIdPayPeriodsHeaderXGustoAPIVersion | undefined; /** * The UUID of the company */ companyId: string; /** * Start date (YYYY-MM-DD) for the pay periods range. Defaults to 6 months ago. */ startDate?: RFCDate | undefined; /** * End date (YYYY-MM-DD) for the pay periods range. Cannot be more than 3 months in the future. Defaults to today. */ endDate?: RFCDate | undefined; /** * Comma-separated list of payroll types to include (regular, transition). Defaults to regular only. */ payrollTypes?: PayrollTypes | undefined; }; export type GetV1CompaniesCompanyIdPayPeriodsResponse = { httpMeta: HTTPMetadata; /** * Successful */ payPeriods?: Array | undefined; }; /** @internal */ export declare const GetV1CompaniesCompanyIdPayPeriodsHeaderXGustoAPIVersion$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const PayrollTypes$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GetV1CompaniesCompanyIdPayPeriodsRequest$Outbound = { "X-Gusto-API-Version": string; company_id: string; start_date?: string | undefined; end_date?: string | undefined; payroll_types?: string | undefined; }; /** @internal */ export declare const GetV1CompaniesCompanyIdPayPeriodsRequest$outboundSchema: z.ZodType; export declare function getV1CompaniesCompanyIdPayPeriodsRequestToJSON(getV1CompaniesCompanyIdPayPeriodsRequest: GetV1CompaniesCompanyIdPayPeriodsRequest): string; /** @internal */ export declare const GetV1CompaniesCompanyIdPayPeriodsResponse$inboundSchema: z.ZodType; export declare function getV1CompaniesCompanyIdPayPeriodsResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=getv1companiescompanyidpayperiods.d.ts.map