@gusto/embedded-react-sdk 0.0.1

package/dist/src/api/client.d.ts

@@ -0,0 +1,1361 @@
+import { BodyParams, QueryParams } from './typeHelpers';
+interface APIConfig {
+    baseUrl: string;
+    headers?: Record<string, string | number>;
+}
+declare class GustoClient {
+    config: APIConfig;
+    private client;
+    constructor(config?: APIConfig);
+    getTokenInfo(): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        scope: string;
+                        resource: {
+                            type: string;
+                            uuid: string;
+                        };
+                        resource_owner: {
+                            type: "CompanyAdmin" | "Employee" | "Contractor";
+                            uuid: string;
+                        } | null;
+                    };
+                };
+            };
+        };
+    }, {
+        params: {};
+    }, `${string}/${string}`>>;
+    getCompanyOnboardingStatus(company_uuid: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_uuid: import('../generated/schema').components["parameters"]["company_uuid"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Company-Onboarding-Status-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_uuid: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    getEmployee(employee_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                include?: "all_compensations" | "custom_fields";
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                employee_id: import('../generated/schema').components["parameters"]["employee_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Employee-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                employee_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    createEmployee(company_id: string, body: BodyParams<'/v1/companies/{company_id}/employees', 'POST'>): Promise<{
+        readonly uuid: string;
+        first_name: string;
+        middle_initial?: string | null;
+        last_name: string;
+        email?: string | null;
+        readonly company_uuid?: string;
+        readonly manager_uuid?: string;
+        readonly version?: string;
+        readonly department?: string | null;
+        readonly terminated?: boolean;
+        two_percent_shareholder?: boolean;
+        readonly onboarded?: boolean;
+        readonly onboarding_status?: "onboarding_completed" | "admin_onboarding_incomplete" | "self_onboarding_pending_invite" | "self_onboarding_invited" | "self_onboarding_invited_started" | "self_onboarding_invited_overdue" | "self_onboarding_completed_by_employee" | "self_onboarding_awaiting_admin_review";
+        jobs?: import('../generated/schema').components["schemas"]["Job"][];
+        eligible_paid_time_off?: import('../generated/schema').components["schemas"]["Paid-Time-Off"][];
+        terminations?: import('../generated/schema').components["schemas"]["Termination"][];
+        garnishments?: import('../generated/schema').components["schemas"]["Garnishment"][];
+        custom_fields?: import('../generated/schema').components["schemas"]["Employee-Custom-Field"][];
+        readonly date_of_birth?: string | null;
+        has_ssn?: boolean;
+        ssn?: string;
+        phone?: string;
+        preferred_first_name?: string;
+        payment_method: "Direct Deposit" | "Check";
+        work_email?: string | null;
+        readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
+    }>;
+    getCompanyAddresses(company_id: string): Promise<{
+        readonly uuid: string;
+        version?: string;
+        readonly company_uuid?: string;
+        phone_number?: string;
+        street_1?: string;
+        street_2?: string | null;
+        city?: string;
+        state?: string;
+        zip?: string;
+        country: string;
+        readonly active?: boolean;
+        mailing_address?: boolean | null;
+        filing_address?: boolean | null;
+        created_at?: string;
+        updated_at?: string;
+    }[]>;
+    getCompanyEmployees(company_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                terminated?: boolean;
+                include?: "all_compensations" | "custom_fields";
+                page?: import('../generated/schema').components["parameters"]["pageParam"];
+                per?: import('../generated/schema').components["parameters"]["perParam"];
+                search_term?: import('../generated/schema').components["parameters"]["search_term"];
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": Record<string, never>;
+            };
+        };
+        responses: {
+            200: import('../generated/schema').components["responses"]["Employee-List"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    updateEmployee(employee_id: string, body: BodyParams<'/v1/employees/{employee_id}', 'PUT'>): Promise<{
+        readonly uuid: string;
+        first_name: string;
+        middle_initial?: string | null;
+        last_name: string;
+        email?: string | null;
+        readonly company_uuid?: string;
+        readonly manager_uuid?: string;
+        readonly version?: string;
+        readonly department?: string | null;
+        readonly terminated?: boolean;
+        two_percent_shareholder?: boolean;
+        readonly onboarded?: boolean;
+        readonly onboarding_status?: "onboarding_completed" | "admin_onboarding_incomplete" | "self_onboarding_pending_invite" | "self_onboarding_invited" | "self_onboarding_invited_started" | "self_onboarding_invited_overdue" | "self_onboarding_completed_by_employee" | "self_onboarding_awaiting_admin_review";
+        jobs?: import('../generated/schema').components["schemas"]["Job"][];
+        eligible_paid_time_off?: import('../generated/schema').components["schemas"]["Paid-Time-Off"][];
+        terminations?: import('../generated/schema').components["schemas"]["Termination"][];
+        garnishments?: import('../generated/schema').components["schemas"]["Garnishment"][];
+        custom_fields?: import('../generated/schema').components["schemas"]["Employee-Custom-Field"][];
+        readonly date_of_birth?: string | null;
+        has_ssn?: boolean;
+        ssn?: string;
+        phone?: string;
+        preferred_first_name?: string;
+        payment_method: "Direct Deposit" | "Check";
+        work_email?: string | null;
+        readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
+    }>;
+    deleteEmployee(employee_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                employee_id: import('../generated/schema').components["parameters"]["employee_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+            422: import('../generated/schema').components["responses"]["Unprocessable-Entity-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                employee_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    getEmployeeHomeAddress(home_address_uuid: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                home_address_uuid: import('../generated/schema').components["parameters"]["home_address_uuid"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Employee-Address-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                home_address_uuid: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    getEmployeeHomeAddresses(employee_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                employee_id: import('../generated/schema').components["parameters"]["employee_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Employee-Address-List"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                employee_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    createEmployeeHomeAddress(employee_id: string, body: BodyParams<'/v1/employees/{employee_id}/home_addresses', 'POST'>): Promise<NonNullable<{
+        version?: string;
+    } & {
+        street_1?: string;
+        street_2?: string | null;
+        city?: string;
+        state?: string;
+        zip?: string;
+        country: string;
+        readonly active?: boolean;
+    } & {
+        uuid?: string;
+        employee_uuid?: string;
+        effective_date?: string;
+        courtesy_withholding?: boolean;
+    }>>;
+    deleteEmployeeHomeAddress(home_address_uuid: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                home_address_uuid: import('../generated/schema').components["parameters"]["home_address_uuid"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+            422: import('../generated/schema').components["responses"]["Unprocessable-Entity-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                home_address_uuid: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    updateEmployeeHomeAddress(home_address_uuid: string, body: BodyParams<'/v1/home_addresses/{home_address_uuid}', 'PUT'>): Promise<NonNullable<{
+        version?: string;
+    } & {
+        street_1?: string;
+        street_2?: string | null;
+        city?: string;
+        state?: string;
+        zip?: string;
+        country: string;
+        readonly active?: boolean;
+    } & {
+        uuid?: string;
+        employee_uuid?: string;
+        effective_date?: string;
+        courtesy_withholding?: boolean;
+    }>>;
+    createCompanyLocation(company_id: string, body: BodyParams<'/v1/companies/{company_id}/locations', 'POST'>): Promise<{
+        readonly uuid: string;
+        version?: string;
+        readonly company_uuid?: string;
+        phone_number?: string;
+        street_1?: string;
+        street_2?: string | null;
+        city?: string;
+        state?: string;
+        zip?: string;
+        country: string;
+        readonly active?: boolean;
+        mailing_address?: boolean | null;
+        filing_address?: boolean | null;
+        created_at?: string;
+        updated_at?: string;
+    }>;
+    getCompanyLocations(company_id: string): Promise<{
+        readonly uuid: string;
+        version?: string;
+        readonly company_uuid?: string;
+        phone_number?: string;
+        street_1?: string;
+        street_2?: string | null;
+        city?: string;
+        state?: string;
+        zip?: string;
+        country: string;
+        readonly active?: boolean;
+        mailing_address?: boolean | null;
+        filing_address?: boolean | null;
+        created_at?: string;
+        updated_at?: string;
+    }[]>;
+    getCompanyLocation(location_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                location_id: import('../generated/schema').components["parameters"]["location_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Location-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                location_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    updateCompanyLocation(location_id: string, body: BodyParams<'/v1/locations/{location_id}', 'PUT'>): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                location_id: import('../generated/schema').components["parameters"]["location_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": import('../generated/schema').components["schemas"]["Versionable-Required"] & {
+                    phone_number?: string;
+                    street_1?: string;
+                    street_2?: string | null;
+                    city?: string;
+                    state?: string;
+                    zip?: string;
+                    country?: string;
+                    mailing_address?: boolean;
+                    filing_address?: boolean;
+                };
+            };
+        };
+        responses: {
+            200: import('../generated/schema').components["responses"]["Location-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+            422: import('../generated/schema').components["responses"]["Unprocessable-Entity-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                location_id: string;
+            };
+        };
+        body: ({
+            version: string;
+        } & {
+            phone_number?: string;
+            street_1?: string;
+            street_2?: string | null;
+            city?: string;
+            state?: string;
+            zip?: string;
+            country?: string;
+            mailing_address?: boolean;
+            filing_address?: boolean;
+        }) | undefined;
+    }, `${string}/${string}`>>;
+    getCompanyFederalTaxes(company_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Federal-Tax-Details-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    updateCompanyFederalTaxes(company_id: string, body: BodyParams<'/v1/companies/{company_id}/federal_tax_details', 'PUT'>): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    legal_name?: string;
+                    ein?: string;
+                    tax_payer_type?: "C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit";
+                    filing_form?: string;
+                    taxable_as_scorp?: boolean;
+                    version: string;
+                };
+            };
+        };
+        responses: {
+            200: import('../generated/schema').components["responses"]["Federal-Tax-Details-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+            422: import('../generated/schema').components["responses"]["Unprocessable-Entity-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+        };
+        body: {
+            legal_name?: string;
+            ein?: string;
+            tax_payer_type?: "C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit";
+            filing_form?: string;
+            taxable_as_scorp?: boolean;
+            version: string;
+        } | undefined;
+    }, `${string}/${string}`>>;
+    getEmployeeWorkAddress(work_address_uuid: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                work_address_uuid: import('../generated/schema').components["parameters"]["work_address_uuid"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": import('../generated/schema').components["schemas"]["Employee-Work-Address"];
+                };
+            };
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                work_address_uuid: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    getEmployeeWorkAddresses(employee_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                employee_id: import('../generated/schema').components["parameters"]["employee_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Employee-Work-Address-List"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                employee_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    createEmployeeWorkAddress(employee_id: string, body: BodyParams<'/v1/employees/{employee_id}/work_addresses', 'POST'>): Promise<{
+        readonly uuid: string;
+        effective_date?: string;
+        readonly active?: boolean;
+        location_uuid?: string;
+        employee_uuid?: string;
+        version?: string;
+        readonly street_1?: string;
+        readonly street_2?: string | null;
+        readonly city?: string;
+        readonly state?: string;
+        readonly zip?: string;
+        readonly country: string;
+    }>;
+    deleteEmployeeWorkAddress(work_address_uuid: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                work_address_uuid: import('../generated/schema').components["parameters"]["work_address_uuid"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+            422: import('../generated/schema').components["responses"]["Unprocessable-Entity-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                work_address_uuid: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    updateEmployeeWorkAddress(work_address_uuid: string, body: BodyParams<'/v1/work_addresses/{work_address_uuid}', 'PUT'>): Promise<{
+        readonly uuid: string;
+        effective_date?: string;
+        readonly active?: boolean;
+        location_uuid?: string;
+        employee_uuid?: string;
+        version?: string;
+        readonly street_1?: string;
+        readonly street_2?: string | null;
+        readonly city?: string;
+        readonly state?: string;
+        readonly zip?: string;
+        readonly country: string;
+    }>;
+    createCompanyBankAccount(company_id: string, body: BodyParams<'/v1/companies/{company_id}/bank_accounts', 'POST'>): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    routing_number?: string;
+                    account_number?: string;
+                    account_type?: "Checking" | "Savings";
+                };
+            };
+        };
+        responses: {
+            201: import('../generated/schema').components["responses"]["Company-Bank-Account-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+            422: import('../generated/schema').components["responses"]["Unprocessable-Entity-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+        };
+        body: {
+            routing_number?: string;
+            account_number?: string;
+            account_type?: "Checking" | "Savings";
+        } | undefined;
+    }, `${string}/${string}`>>;
+    getDeduction(garnishment_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                garnishment_id: import('../generated/schema').components["parameters"]["garnishment_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Garnishment-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                garnishment_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    getEmployeeDeductions(employee_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                page?: import('../generated/schema').components["parameters"]["pageParam"];
+                per?: import('../generated/schema').components["parameters"]["perParam"];
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                employee_id: import('../generated/schema').components["parameters"]["employee_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Garnishment-List"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                employee_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    createEmployeeDeduction(employee_id: string, body: BodyParams<'/v1/employees/{employee_id}/garnishments', 'POST'>): Promise<{
+        readonly uuid: string;
+        version?: string;
+        readonly employee_uuid?: string;
+        active: boolean;
+        amount?: string;
+        description?: string;
+        court_ordered?: boolean;
+        times: number | null;
+        recurring: boolean;
+        annual_maximum: string | null;
+        pay_period_maximum: string | null;
+        deduct_as_percentage: boolean;
+    }>;
+    updateDeduction(garnishment_id: string, body: BodyParams<'/v1/garnishments/{garnishment_id}', 'PUT'>): Promise<{
+        readonly uuid: string;
+        version?: string;
+        readonly employee_uuid?: string;
+        active: boolean;
+        amount?: string;
+        description?: string;
+        court_ordered?: boolean;
+        times: number | null;
+        recurring: boolean;
+        annual_maximum: string | null;
+        pay_period_maximum: string | null;
+        deduct_as_percentage: boolean;
+    }>;
+    getEmployeeBankAccounts(employee_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                page?: import('../generated/schema').components["parameters"]["pageParam"];
+                per?: import('../generated/schema').components["parameters"]["perParam"];
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                employee_id: import('../generated/schema').components["parameters"]["employee_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": Record<string, never>;
+            };
+        };
+        responses: {
+            200: import('../generated/schema').components["responses"]["Employee-Bank-Account-List"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                employee_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    createEmployeeBankAccount(employee_id: string, body: BodyParams<'/v1/employees/{employee_id}/bank_accounts', 'POST'>): Promise<{
+        uuid: string;
+        employee_uuid?: string;
+        account_type?: "Checking" | "Savings";
+        name?: string;
+        routing_number?: string;
+        hidden_account_number?: string;
+    }>;
+    deleteEmployeeBankAccount(employee_id: string, bank_account_uuid: string): Promise<never>;
+    getEmployeePaymentMethod(employee_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                employee_id: import('../generated/schema').components["parameters"]["employee_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Employee-Payment-Method-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                employee_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    updateEmployeePaymentMethod(employee_id: string, body: BodyParams<'/v1/employees/{employee_id}/payment_method', 'PUT'>): Promise<{
+        version?: string;
+        type?: "Direct Deposit" | "Check";
+        split_by?: "Amount" | "Percentage" | null;
+        splits?: import('../generated/schema').components["schemas"]["Payment-Method-Bank-Account"][] | null;
+    }>;
+    getEmployeeJobs(employee_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                page?: import('../generated/schema').components["parameters"]["pageParam"];
+                per?: import('../generated/schema').components["parameters"]["perParam"];
+                include?: "all_compensations";
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                employee_id: import('../generated/schema').components["parameters"]["employee_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Job-List"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                employee_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    getEmployeeJob(job_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                include?: "all_compensations";
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                job_id: import('../generated/schema').components["parameters"]["job_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Job-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                job_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    createEmployeeJob(employee_id: string, body: BodyParams<'/v1/employees/{employee_id}/jobs', 'POST'>): Promise<{
+        readonly uuid: string;
+        version?: string;
+        readonly employee_uuid?: string;
+        hire_date?: string;
+        title: string | null;
+        readonly primary?: boolean;
+        readonly rate?: string;
+        readonly payment_unit?: string;
+        readonly current_compensation_uuid?: string;
+        two_percent_shareholder?: boolean;
+        state_wc_covered?: boolean;
+        state_wc_class_code?: string;
+        readonly compensations?: import('../generated/schema').components["schemas"]["Compensation"][];
+    }>;
+    updateEmployeeJob(job_id: string, body: BodyParams<'/v1/jobs/{job_id}', 'PUT'>): Promise<{
+        readonly uuid: string;
+        version?: string;
+        readonly employee_uuid?: string;
+        hire_date?: string;
+        title: string | null;
+        readonly primary?: boolean;
+        readonly rate?: string;
+        readonly payment_unit?: string;
+        readonly current_compensation_uuid?: string;
+        two_percent_shareholder?: boolean;
+        state_wc_covered?: boolean;
+        state_wc_class_code?: string;
+        readonly compensations?: import('../generated/schema').components["schemas"]["Compensation"][];
+    }>;
+    deleteEmployeeJob(job_id: string): Promise<never>;
+    createEmployeeCompensation(job_id: string, body: BodyParams<'/v1/jobs/{job_id}/compensations', 'POST'>): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                job_id: import('../generated/schema').components["parameters"]["job_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    rate?: string;
+                    payment_unit: "Hour" | "Week" | "Month" | "Year" | "Paycheck";
+                    effective_date?: string;
+                    flsa_status: import('../generated/schema').components["schemas"]["Flsa-Status-Type"];
+                    adjust_for_minimum_wage?: boolean;
+                    minimum_wages?: {
+                        uuid?: string;
+                    }[];
+                };
+            };
+        };
+        responses: {
+            201: import('../generated/schema').components["responses"]["Compensation-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+            422: import('../generated/schema').components["responses"]["Unprocessable-Entity-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                job_id: string;
+            };
+        };
+        body: {
+            rate?: string;
+            payment_unit: "Hour" | "Week" | "Month" | "Year" | "Paycheck";
+            effective_date?: string;
+            flsa_status: import('../generated/schema').components["schemas"]["Flsa-Status-Type"];
+            adjust_for_minimum_wage?: boolean;
+            minimum_wages?: {
+                uuid?: string;
+            }[];
+        } | undefined;
+    }, `${string}/${string}`>>;
+    updateEmployeeCompensation(compensation_id: string, body: BodyParams<'/v1/compensations/{compensation_id}', 'PUT'>): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                compensation_id: import('../generated/schema').components["parameters"]["compensation_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    version: string;
+                    rate?: string;
+                    payment_unit?: "Hour" | "Week" | "Month" | "Year" | "Paycheck";
+                    flsa_status?: import('../generated/schema').components["schemas"]["Flsa-Status-Type"];
+                    adjust_for_minimum_wage?: boolean;
+                    minimum_wages?: {
+                        uuid?: string;
+                    }[];
+                };
+            };
+        };
+        responses: {
+            200: import('../generated/schema').components["responses"]["Compensation-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+            422: import('../generated/schema').components["responses"]["Unprocessable-Entity-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                compensation_id: string;
+            };
+        };
+        body: {
+            version: string;
+            rate?: string;
+            payment_unit?: "Hour" | "Week" | "Month" | "Year" | "Paycheck";
+            flsa_status?: import('../generated/schema').components["schemas"]["Flsa-Status-Type"];
+            adjust_for_minimum_wage?: boolean;
+            minimum_wages?: {
+                uuid?: string;
+            }[];
+        } | undefined;
+    }, `${string}/${string}`>>;
+    previewPayScheduleDates(company_id: string, query: QueryParams<'/v1/companies/{company_id}/pay_schedules/preview'>): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                frequency?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
+                anchor_pay_date?: string;
+                anchor_end_of_pay_period?: string;
+                day_1?: number;
+                day_2?: number;
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        pay_periods?: {
+                            check_date?: string;
+                            run_payroll_by?: string;
+                            start_date?: string;
+                            end_date?: string;
+                        }[];
+                        holidays?: string[];
+                    };
+                };
+            };
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+            query: {
+                frequency?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
+                anchor_pay_date?: string;
+                anchor_end_of_pay_period?: string;
+                day_1?: number;
+                day_2?: number;
+            } | undefined;
+        };
+    }, `${string}/${string}`>>;
+    getEmployeeFederalTaxes(employee_uuid: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                employee_uuid: import('../generated/schema').components["parameters"]["employee_uuid"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Employee-Federal-Tax-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                employee_uuid: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    updateEmployeeFederalTaxes(employee_uuid: string, body: BodyParams<'/v1/employees/{employee_uuid}/federal_taxes', 'PUT'>): Promise<{
+        version?: string;
+        filing_status?: string;
+        extra_withholding?: string;
+        two_jobs?: boolean;
+        dependents_amount?: string;
+        other_income?: string;
+        deductions?: string;
+        w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
+        federal_withholding_allowance?: number;
+        additional_withholding?: boolean;
+    }>;
+    getEmployeeStateTaxes(employee_uuid: string): Promise<{
+        employee_uuid: string;
+        state: string;
+        file_new_hire_report?: boolean;
+        is_work_state?: boolean;
+        questions: import('../generated/schema').components["schemas"]["Employee-State-Tax-Question"][];
+    }[]>;
+    updateEmployeeStateTaxes(employee_uuid: string, body: BodyParams<'/v1/employees/{employee_uuid}/state_taxes', 'PUT'>): Promise<{
+        employee_uuid: string;
+        state: string;
+        file_new_hire_report?: boolean;
+        is_work_state?: boolean;
+        questions: import('../generated/schema').components["schemas"]["Employee-State-Tax-Question"][];
+    }[]>;
+    getPendingPayrolls(company_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                processing_statuses?: ("unprocessed" | "processed")[];
+                payroll_types?: ("regular" | "off_cycle" | "external")[];
+                include?: ("totals" | "payroll_status_meta" | "risk_blockers")[];
+                start_date?: string;
+                end_date?: string;
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Payroll-List"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+            query: {
+                processing_statuses: "unprocessed"[];
+                start_date: string;
+                end_date: string;
+                payroll_types: "regular"[];
+            };
+        };
+    }, `${string}/${string}`>>;
+    getHistoricalPayrolls(companyId: string, startDate: Date, endDate: Date): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                processing_statuses?: ("unprocessed" | "processed")[];
+                payroll_types?: ("regular" | "off_cycle" | "external")[];
+                include?: ("totals" | "payroll_status_meta" | "risk_blockers")[];
+                start_date?: string;
+                end_date?: string;
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Payroll-List"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+            query: {
+                processing_statuses: "processed"[];
+                start_date: string;
+                end_date: string;
+                payroll_types: ("regular" | "off_cycle")[];
+                include: ("totals" | "payroll_status_meta")[];
+            };
+        };
+    }, `${string}/${string}`>>;
+    getPayroll(company_id: string, payroll_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+                payroll_id: import('../generated/schema').components["parameters"]["payroll_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Payroll-Show-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, import('openapi-fetch').FetchOptions<{
+        parameters: {
+            query?: {
+                include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+                payroll_id: import('../generated/schema').components["parameters"]["payroll_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Payroll-Show-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }>, `${string}/${string}`>>;
+    getCompanyIndustry(companyId: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Industry-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    updateCompanyIndustry(companyId: string, params: BodyParams<'/v1/companies/{company_id}/industry_selection', 'PUT'>): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    title: string;
+                    naics_code: string;
+                    sic_codes?: string[];
+                };
+            };
+        };
+        responses: {
+            200: import('../generated/schema').components["responses"]["Industry-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+            422: import('../generated/schema').components["responses"]["Unprocessable-Entity-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+        };
+        body: {
+            title: string;
+            naics_code: string;
+            sic_codes?: string[];
+        } | undefined;
+    }, `${string}/${string}`>>;
+    getStateTaxRequirements(company_uuid: string, state: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                scheduling?: boolean;
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_uuid: import('../generated/schema').components["parameters"]["company_uuid"];
+                state: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": import('../generated/schema').components["schemas"]["Tax-Requirements-State"];
+                };
+            };
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_uuid: string;
+                state: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    createPaySchedule(company_id: string, body: BodyParams<'/v1/companies/{company_id}/pay_schedules', 'POST'>): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    frequency: "Every week" | "Every other week" | "Twice per month" | "Monthly";
+                    anchor_pay_date: string;
+                    anchor_end_of_pay_period: string;
+                    day_1?: number | null;
+                    day_2?: number | null;
+                    custom_name?: string;
+                };
+            };
+        };
+        responses: {
+            200: import('../generated/schema').components["responses"]["Pay-Schedule-Object"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+            422: import('../generated/schema').components["responses"]["Unprocessable-Entity-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+        };
+        body: {
+            frequency: "Every week" | "Every other week" | "Twice per month" | "Monthly";
+            anchor_pay_date: string;
+            anchor_end_of_pay_period: string;
+            day_1?: number | null;
+            day_2?: number | null;
+            custom_name?: string;
+        } | undefined;
+    }, `${string}/${string}`>>;
+    getPaySchedules(company_id: string): Promise<import('openapi-fetch').FetchResponse<{
+        parameters: {
+            query?: {
+                page?: import('../generated/schema').components["parameters"]["pageParam"];
+                per?: import('../generated/schema').components["parameters"]["perParam"];
+            };
+            header?: {
+                "X-Gusto-API-Version"?: import('../generated/schema').components["parameters"]["VersionHeader"];
+            };
+            path: {
+                company_id: import('../generated/schema').components["parameters"]["company_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: import('../generated/schema').components["responses"]["Pay-Schedule-List"];
+            404: import('../generated/schema').components["responses"]["Not-Found-Error-Object"];
+        };
+    }, {
+        params: {
+            path: {
+                company_id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    getEmployeeOnboardingStatus(employee_id: string): Promise<{
+        uuid: string;
+        onboarding_status?: string;
+        onboarding_steps?: {
+            title?: string;
+            id?: string;
+            required?: boolean;
+            completed?: boolean;
+            requirements?: string[];
+        }[];
+    }>;
+}
+export type { APIConfig };
+export { GustoClient };