@gusto/embedded-react-sdk 0.0.5 → 0.0.6

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { CustomTypeOptions } from 'i18next';
 import { default as default_2 } from 'openapi-fetch';
 import { default as default_3 } from 'react';
 import { FallbackProps } from 'react-error-boundary';
@@ -6,7 +7,6 @@ import { FetchResponse } from 'openapi-fetch';
 import { i18n } from 'i18next';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { ReactNode } from 'react';
-import { Resource } from 'i18next';
 import { useMutation } from '@tanstack/react-query';
 import { UseMutationResult } from '@tanstack/react-query';
 import { UseQueryResult } from '@tanstack/react-query';
@@ -137,11 +137,11 @@ declare interface CompensationProps extends CommonComponentInterface {
 
 declare const CompensationSchema: v.IntersectSchema<[v.ObjectSchema<{
     readonly job_title: v.SchemaWithPipe<[v.StringSchema<undefined>, v.NonEmptyAction<string, undefined>]>;
-    readonly rate: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>, v.TransformAction<any, string>]>;
+    readonly rate: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 1, undefined>, v.TransformAction<any, string>]>;
 }, undefined>, v.VariantSchema<"flsa_status", [v.SchemaWithPipe<[v.ObjectSchema<{
     readonly flsa_status: v.UnionSchema<[v.LiteralSchema<"Exempt", undefined>, v.LiteralSchema<"Salaried Nonexempt", undefined>, v.LiteralSchema<"Nonexempt", undefined>], undefined>;
     readonly payment_unit: v.UnionSchema<[v.LiteralSchema<"Hour", undefined>, v.LiteralSchema<"Week", undefined>, v.LiteralSchema<"Month", undefined>, v.LiteralSchema<"Year", undefined>], undefined>;
-    readonly rate: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>, v.TransformAction<any, string>]>;
+    readonly rate: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 1, undefined>, v.TransformAction<any, string>]>;
 }, undefined>, v.BaseValidation<{
     rate: string;
     flsa_status: "Exempt" | "Salaried Nonexempt" | "Nonexempt";
@@ -204,8 +204,8 @@ declare const componentEvents: {
     readonly EMPLOYEE_JOB_CREATED: "employee/job/created";
     readonly EMPLOYEE_JOB_UPDATED: "employee/job/updated";
     readonly EMPLOYEE_SUMMARY_VIEW: "employee/summary";
-    readonly EMPLOYEE_FILE_NEW_HIRE_REPORT: "employee/newHireReport";
     readonly EMPLOYEES_LIST: "company/employees";
+    readonly EMPLOYEE_SELF_ONBOARDING_START: "employee/selfOnboarding/start";
     readonly SUCCESS: "SUCCESS";
     readonly ERROR: "ERROR";
     readonly CANCEL: "CANCEL";
@@ -4475,6 +4475,14 @@ declare interface DeductionsProps extends CommonComponentInterface {
     employeeId: string;
 }
 
+declare type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? DeepPartial<U>[] : T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+
+export declare type Dictionary = Record<string, Partial<{
+    [K in keyof Resources]: DeepPartial<Resources[K]>;
+}>>;
+
 declare namespace Employee {
     export {
         EmployeeList,
@@ -4504,7 +4512,8 @@ declare namespace Employee {
         usePaymentMethod,
         CombinedSchemaInputs,
         CombinedSchemaOutputs,
-        PaymentMethodContextual
+        PaymentMethodContextual,
+        Landing
     }
 }
 export { Employee }
@@ -4518,7 +4527,7 @@ declare namespace EmployeeList {
 
 declare type EmployeeListContextType = {
     handleEdit: (uuid: string) => void;
-    handleDelete: (uuid: string) => void;
+    handleDelete: (uuid: string) => Promise<void>;
     handleNew: () => void;
     employees: Schemas['Employee'][];
 };
@@ -4717,7 +4726,7 @@ export declare function GustoApiContextProvider({ children, context, }: {
 
 export declare interface GustoApiProps {
     config?: APIConfig;
-    dictionary?: Resource;
+    dictionary?: Dictionary;
     lng?: string;
     locale?: string;
     currency?: string;
@@ -4764,6 +4773,55 @@ export declare class GustoClient {
     }, {
     params: {};
     }, `${string}/${string}`>>;
+    getCompany(company_id: string): Promise<{
+        readonly ein?: string;
+        readonly entity_type?: "C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit";
+        readonly tier?: "simple" | "plus" | "premium" | "core" | "complete" | "concierge" | "contractor_only" | "basic" | null;
+        is_suspended?: boolean;
+        readonly company_status?: "Approved" | "Not Approved" | "Suspended";
+        readonly uuid: string;
+        readonly name?: string;
+        readonly slug?: string;
+        readonly trade_name?: string;
+        readonly is_partner_managed?: boolean;
+        readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
+        readonly join_date?: string;
+        funding_type?: "ach" | "reverse_wire" | "wire_in" | "brex";
+        readonly locations?: components["schemas"]["Company-Address"][];
+        readonly compensations?: {
+            readonly hourly?: {
+                readonly name?: string;
+                readonly multiple?: number;
+            }[];
+            readonly fixed?: {
+                name?: string;
+            }[];
+            readonly paid_time_off?: {
+                readonly name?: string;
+            }[];
+        };
+        readonly primary_signatory?: {
+            readonly first_name?: string;
+            readonly middle_initial?: string;
+            readonly last_name?: string;
+            readonly phone?: string;
+            readonly email?: string;
+            readonly home_address?: {
+                readonly street_1?: string;
+                readonly street_2?: string | null;
+                readonly city?: string;
+                readonly state?: string;
+                readonly zip?: string;
+                readonly country?: string;
+            };
+        };
+        primary_payroll_admin?: {
+            readonly first_name?: string;
+            readonly last_name?: string;
+            readonly phone?: string;
+            readonly email?: string;
+        };
+    }>;
     getCompanyOnboardingStatus(company_uuid: string): Promise<FetchResponse<    {
     parameters: {
     query?: never;
@@ -5755,29 +5813,18 @@ export declare class GustoClient {
     } | undefined;
     };
     }, `${string}/${string}`>>;
-    getEmployeeFederalTaxes(employee_uuid: string): Promise<FetchResponse<    {
-    parameters: {
-    query?: never;
-    header?: {
-    "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
-    };
-    path: {
-    employee_uuid: components["parameters"]["employee_uuid"];
-    };
-    cookie?: never;
-    };
-    requestBody?: never;
-    responses: {
-    200: components["responses"]["Employee-Federal-Tax-Object"];
-    404: components["responses"]["Not-Found-Error-Object"];
-    };
-    }, {
-    params: {
-    path: {
-    employee_uuid: string;
-    };
-    };
-    }, `${string}/${string}`>>;
+    getEmployeeFederalTaxes(employee_uuid: string): 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;
+    }>;
     updateEmployeeFederalTaxes(employee_uuid: string, body: BodyParams<'/v1/employees/{employee_uuid}/federal_taxes', 'PUT'>): Promise<{
         version?: string;
         filing_status?: string;
@@ -6110,12 +6157,18 @@ declare const IncludeDeductionsSchema: v.ObjectSchema<{
     readonly includeDeductions: v.PicklistSchema<["Yes", "No"], undefined>;
 }, undefined>;
 
+declare type InferResponse<T, S> = T extends string ? Awaited<ReturnType<typeof handleResponse<S>>> : null;
+
+declare function Landing(props: SummaryProps_2 & BaseComponentInterface): JSX_2.Element;
+
 declare type MODE = 'ADD' | 'LIST' | 'INITIAL' | 'EDIT';
 
 declare type MODE_2 = 'LIST' | 'EDIT' | 'ADD' | 'SINGLE' | 'PROCEED';
 
 declare type MODE_3 = 'ADD' | 'LIST' | 'SPLIT' | 'INITIAL';
 
+declare type OnboardingFlow = 'self' | 'admin'
+
 declare function OnboardingSummary(props: SummaryProps & BaseComponentInterface): JSX_2.Element;
 
 declare const OnboardingSummaryContextual: () => JSX_2.Element;
@@ -17312,14 +17365,19 @@ declare function Profile(props: ProfileProps & BaseComponentInterface): JSX_2.El
 declare namespace Profile {
     var Head: () => JSX_2.Element;
     var Actions: () => JSX_2.Element;
-    var PersonalDetails: () => JSX_2.Element;
+    var AdminPersonalDetails: () => JSX_2.Element | null;
+    var SelfPersonalDetails: () => JSX_2.Element | null;
+    var HomeAddress: () => JSX_2.Element;
+    var WorkAddress: WorkAddress;
 }
 
 declare type ProfileContextType = {
     companyLocations: Schemas['Location'][];
+    workAddresses: Schemas['Employee-Work-Address'][] | null;
     employee?: Schemas['Employee'];
     isPending: boolean;
     handleCancel: () => void;
+    flow: OnboardingFlow;
 };
 
 declare const ProfileContextual: () => JSX_2.Element;
@@ -17343,6 +17401,7 @@ declare interface ProfileProps extends CommonComponentInterface {
             zip?: string;
         };
     };
+    flow?: OnboardingFlow;
 }
 
 declare type QueryParams<Path extends keyof paths> = _QueryParams<Path> extends {
@@ -17353,6 +17412,8 @@ declare type QueryParams<Path extends keyof paths> = _QueryParams<Path> extends
 
 declare type _QueryParams<Path extends keyof paths> = Parameters<ReturnType<typeof default_2<Pick<paths, Path>>>['GET']>['1'];
 
+declare type Resources = CustomTypeOptions['resources'];
+
 declare type RGB = `rgb(${string})`
 
 declare type RGBA = `rgba(${string})`
@@ -17366,6 +17427,12 @@ export declare const SDKI18next: i18n;
 
 declare interface SummaryProps extends CommonComponentInterface {
     employeeId: string;
+    flow?: OnboardingFlow;
+}
+
+declare interface SummaryProps_2 extends CommonComponentInterface {
+    employeeId: string;
+    companyId: string;
 }
 
 declare function Taxes(props: TaxesProps & BaseComponentInterface): JSX_2.Element;
@@ -17800,6 +17867,56 @@ declare const useEmployeeList: () => EmployeeListContextType;
 
 export declare function useFlow<C extends FlowContextInterface>(): C;
 
+export declare function useGetCompany(company_id: string): UseSuspenseQueryResult<    {
+readonly ein?: string;
+readonly entity_type?: "C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit";
+readonly tier?: "simple" | "plus" | "premium" | "core" | "complete" | "concierge" | "contractor_only" | "basic" | null;
+is_suspended?: boolean;
+readonly company_status?: "Approved" | "Not Approved" | "Suspended";
+readonly uuid: string;
+readonly name?: string;
+readonly slug?: string;
+readonly trade_name?: string;
+readonly is_partner_managed?: boolean;
+readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
+readonly join_date?: string;
+funding_type?: "ach" | "reverse_wire" | "wire_in" | "brex";
+readonly locations?: components["schemas"]["Company-Address"][];
+readonly compensations?: {
+readonly hourly?: {
+readonly name?: string;
+readonly multiple?: number;
+}[];
+readonly fixed?: {
+name?: string;
+}[];
+readonly paid_time_off?: {
+readonly name?: string;
+}[];
+};
+readonly primary_signatory?: {
+readonly first_name?: string;
+readonly middle_initial?: string;
+readonly last_name?: string;
+readonly phone?: string;
+readonly email?: string;
+readonly home_address?: {
+readonly street_1?: string;
+readonly street_2?: string | null;
+readonly city?: string;
+readonly state?: string;
+readonly zip?: string;
+readonly country?: string;
+};
+};
+primary_payroll_admin?: {
+readonly first_name?: string;
+readonly last_name?: string;
+readonly phone?: string;
+readonly email?: string;
+};
+}, Error>;
+
 export declare function useGetCompanyAddresses(company_id: string): UseSuspenseQueryResult<    {
 readonly uuid: string;
 version?: string;
@@ -17884,170 +18001,143 @@ requirements?: string[];
 }[];
 }, Error>;
 
-export declare function useGetDeduction(garnishment_id: string): UseSuspenseQueryResult<    {
-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;
+export declare function useGetDeduction(garnishment_id: string): UseSuspenseQueryResult<{
+    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;
 }, Error>;
 
-export declare function useGetEmployee(employee_id: string): UseSuspenseQueryResult<    {
-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?: components["schemas"]["Job"][];
-eligible_paid_time_off?: components["schemas"]["Paid-Time-Off"][];
-terminations?: components["schemas"]["Termination"][];
-garnishments?: components["schemas"]["Garnishment"][];
-custom_fields?: 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;
-}, Error>;
+export declare function useGetEmployee<T extends string | undefined>(employee_id: T): UseSuspenseQueryResult<InferResponse<T, Schemas["Employee"]>>;
 
-export declare function useGetEmployeeBankAccounts(employee_id: string): UseSuspenseQueryResult<    {
-uuid: string;
-employee_uuid?: string;
-account_type?: "Checking" | "Savings";
-name?: string;
-routing_number?: string;
-hidden_account_number?: string;
+export declare function useGetEmployeeBankAccounts(employee_id: string): UseSuspenseQueryResult<{
+    uuid: string;
+    employee_uuid?: string;
+    account_type?: "Checking" | "Savings";
+    name?: string;
+    routing_number?: string;
+    hidden_account_number?: string;
 }[], Error>;
 
-export declare function useGetEmployeeDeductions(employee_id: string): UseSuspenseQueryResult<    {
-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;
+export declare function useGetEmployeeDeductions(employee_id: string): UseSuspenseQueryResult<{
+    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;
 }[], Error>;
 
-export declare function useGetEmployeeFederalTaxes(employee_id: string): UseSuspenseQueryResult<    {
-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;
+export declare function useGetEmployeeFederalTaxes(employee_id: string): UseSuspenseQueryResult<{
+    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;
 }, Error>;
 
 export declare function useGetEmployeeHomeAddress(home_address_uuid: string): UseSuspenseQueryResult<NonNullable<{
-version?: string;
+    version?: string;
 } & {
-street_1?: string;
-street_2?: string | null;
-city?: string;
-state?: string;
-zip?: string;
-country: string;
-readonly active?: boolean;
+    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;
+    uuid?: string;
+    employee_uuid?: string;
+    effective_date?: string;
+    courtesy_withholding?: boolean;
 }>, Error>;
 
-export declare function useGetEmployeeHomeAddresses(employee_id: string): UseSuspenseQueryResult<({
-version?: string;
+export declare function useGetEmployeeHomeAddresses(employee_id: string | undefined): UseSuspenseQueryResult<({
+    version?: string;
 } & {
-street_1?: string;
-street_2?: string | null;
-city?: string;
-state?: string;
-zip?: string;
-country: string;
-readonly active?: boolean;
+    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;
-})[], Error>;
+    uuid?: string;
+    employee_uuid?: string;
+    effective_date?: string;
+    courtesy_withholding?: boolean;
+})[] | null, Error>;
 
-export declare function useGetEmployeeJob(job_id: string): UseSuspenseQueryResult<    {
-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?: components["schemas"]["Compensation"][];
+export declare function useGetEmployeeJob(job_id: string): UseSuspenseQueryResult<{
+    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?: components["schemas"]["Compensation"][];
 }, Error>;
 
-export declare function useGetEmployeeJobs(employee_id: string): UseSuspenseQueryResult<    {
-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?: components["schemas"]["Compensation"][];
+export declare function useGetEmployeeJobs(employee_id: string): UseSuspenseQueryResult<{
+    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?: components["schemas"]["Compensation"][];
 }[], Error>;
 
-export declare function useGetEmployeeOnboardingStatus(employee_id: string): UseSuspenseQueryResult<    {
-uuid: string;
-onboarding_status?: string;
-onboarding_steps?: {
-title?: string;
-id?: string;
-required?: boolean;
-completed?: boolean;
-requirements?: string[];
-}[];
+export declare function useGetEmployeeOnboardingStatus(employee_id: string): UseSuspenseQueryResult<{
+    uuid: string;
+    onboarding_status?: string;
+    onboarding_steps?: {
+        title?: string;
+        id?: string;
+        required?: boolean;
+        completed?: boolean;
+        requirements?: string[];
+    }[];
 }, Error>;
 
-export declare function useGetEmployeePaymentMethod(employee_id: string): UseSuspenseQueryResult<    {
-version?: string;
-type?: "Direct Deposit" | "Check";
-split_by?: "Amount" | "Percentage" | null;
-splits?: components["schemas"]["Payment-Method-Bank-Account"][] | null;
+export declare function useGetEmployeePaymentMethod(employee_id: string): UseSuspenseQueryResult<{
+    version?: string;
+    type?: "Direct Deposit" | "Check";
+    split_by?: "Amount" | "Percentage" | null;
+    splits?: components["schemas"]["Payment-Method-Bank-Account"][] | null;
 }, Error>;
 
 export declare function useGetEmployeesByCompany(company_id: string): UseSuspenseQueryResult<    {
@@ -18079,43 +18169,43 @@ work_email?: string | null;
 readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
 }[], Error>;
 
-export declare function useGetEmployeeStateTaxes(employee_id: string): UseSuspenseQueryResult<    {
-employee_uuid: string;
-state: string;
-file_new_hire_report?: boolean;
-is_work_state?: boolean;
-questions: components["schemas"]["Employee-State-Tax-Question"][];
+export declare function useGetEmployeeStateTaxes(employee_id: string): UseSuspenseQueryResult<{
+    employee_uuid: string;
+    state: string;
+    file_new_hire_report?: boolean;
+    is_work_state?: boolean;
+    questions: components["schemas"]["Employee-State-Tax-Question"][];
 }[], Error>;
 
-export declare function useGetEmployeeWorkAddress(work_address_uuid: string): UseSuspenseQueryResult<    {
-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;
+export declare function useGetEmployeeWorkAddress(work_address_uuid: string): UseSuspenseQueryResult<{
+    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;
 }[], Error>;
 
-export declare function useGetEmployeeWorkAddresses(employee_id: string): UseSuspenseQueryResult<    {
-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;
-}[], Error>;
+export declare function useGetEmployeeWorkAddresses(employee_id: string | undefined): UseSuspenseQueryResult<{
+    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;
+}[] | null, Error>;
 
 export declare function useGetHistoricalPayrolls(companyId: string, startDate: Date, endDate: Date): UseSuspenseQueryResult<Payroll[], Error>;
 
@@ -18525,7 +18615,7 @@ uuid?: string;
 }, `${string}/${string}`>>>[1];
 }, unknown>;
 
-export declare function useUpdateEmployeeFederalTaxes(opts?: Omit<Parameters<typeof useMutation>[0], 'mutationFn'>): UseMutationResult<    {
+export declare function useUpdateEmployeeFederalTaxes(employeeId: string, opts?: Omit<Parameters<typeof useMutation>[0], 'mutationFn'>): UseMutationResult<    {
 version?: string;
 filing_status?: string;
 extra_withholding?: string;
@@ -18537,7 +18627,6 @@ w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
 federal_withholding_allowance?: number;
 additional_withholding?: boolean;
 }, Error, {
-employeeId: string;
 body: Parameters<(employee_uuid: string, body: BodyParams<"/v1/employees/{employee_uuid}/federal_taxes", "PUT">) => Promise<{
 version?: string;
 filing_status?: string;
@@ -18683,17 +18772,551 @@ readonly country: string;
 
 declare type VAR = `var(${string})`
 
+declare function WorkAddress(): JSX_2.Element | null;
+
 export { }
 
+declare namespace _default {
+    function process(): {
+        code: string;
+    };
+}
+
+declare namespace _default {
+    function process(sourceText: any, sourcePath: any): {
+        code: string;
+    };
+}
+
 
 
 declare module 'i18next' {
-  interface CustomTypeOptions {
-    defaultNS: 'common'
-    resources: typeof Resources
-  }
+    export interface CompanyAddBank{
+"title":string;
+"intro":string;
+"entry_selection_question":string;
+"manual_entry":string;
+"plaid_entry":string;
+"routing_number_label":string;
+"account_number_label":string;
+"account_type_label":string;
+"account_type_checking":string;
+"account_type_savings":string;
+"submit":string;
+};
+export interface CompanyAddresses{
+"title":string;
+"description":string;
+"mailingLabel":string;
+"filingLabel":string;
+"editCta":string;
+"addCta":string;
+"continueCta":string;
+};
+export interface CompanyFederalTaxes{
+"pageTitle":string;
+"entity_type_and_legal_name_intro":string;
+"federal_ein_label":string;
+"federal_ein_description":string;
+"taxpayer_type_label":string;
+"taxpayer_type_options":string;
+"federal_filing_form_label":string;
+"federal_filing_form_description":string;
+"form_941_label":string;
+"form_944_label":string;
+"legal_entity_name_label":string;
+"legal_entity_name_tip":string;
+"c_corporation":string;
+"s_corporation":string;
+"sole_proprietor":string;
+"llc":string;
+"llp":string;
+"limited_partnership":string;
+"co_ownership":string;
+"association":string;
+"trusteeship":string;
+"general_partnership":string;
+"joint_venture":string;
+"non_profit":string;
+"cancelCta":string;
+};
+export interface CompanyIndustry{
+"pageTitle":string;
+"sectionTitle":string;
+"desc":string;
+"placeholder":string;
+"cancelCta":string;
+"continueCta":string;
+};
+export interface EmployeeBankAccount{
+"accountNumberLabel":string;
+"accountTypeChecking":string;
+"accountTypeLabel":string;
+"accountTypeSavings":string;
+"accountTypeSelect":string;
+"cancelCta":string;
+"checkImageAlt":string;
+"description":string;
+"nameLabel":string;
+"routingNumberLabel":string;
+"routingNumberDescription":string;
+"submitCta":string;
+"title":string;
+"validations":{
+"accountType":string;
+}
+};
+export interface EmployeeCompensation{
+"addAnotherJobCta":string;
+"allCompensations":{
+"actionColumn":string;
+"amountColumn":string;
+"deleteCta":string;
+"editCta":string;
+"jobColumn":string;
+"perColumn":string;
+"tableLabel":string;
+"typeColumn":string;
+}
+"amount":string;
+"backCta":string;
+"cancelCta":string;
+"cancelNewJobCta":string;
+"classificationCTA":string;
+"employeeClassification":string;
+"flsaStatusLabels":{
+"Commission Only Exempt":string;
+"Commission Only Nonexempt":string;
+"Exempt":string;
+"Nonexempt":string;
+"Owner":string;
+"Salaried Nonexempt":string;
+}
+"hamburgerTitle":string;
+"jobTitle":string;
+"paymentUnitDescription":string;
+"paymentUnitLabel":string;
+"paymentUnitOptions":{
+"Hour":string;
+"Month":string;
+"Paycheck":string;
+"Week":string;
+"Year":string;
+}
+"saveNewJobCta":string;
+"submitCta":string;
+"title":string;
+"validations":{
+"classificationChangeNotification":string;
+"exemptThreshold":string;
+"paymentUnit":string;
+"rate":string;
+"title":string;
+}
+};
+export interface EmployeeDeductions{
+"pageTitle":string;
+"includeDeductionsFormLabel":string;
+"includeDeductionsDescription":string;
+"includeDeductionsYes":string;
+"includeDeductionsNo":string;
+"continueCta":string;
+"addDeductionTitle":string;
+"editDeductionTitle":string;
+"addDeuctionDescription":string;
+"descriptionLabel":string;
+"frequencyLabel":string;
+"frequencyRecurringOption":string;
+"frequencyOneTimeOption":string;
+"deductionsTableLabel":string;
+"deductionTypeLabel":string;
+"deductionTypePercentageOption":string;
+"deductionTypeFixedAmountOption":string;
+"deductionAmountLabel":string;
+"annualMaxLabel":string;
+"courtOrderedLabel":string;
+"nameColumn":string;
+"frequencyColumn":string;
+"withheldColumn":string;
+"actionsColumn":string;
+"recurringText":string;
+"recurringAmount":string;
+"nonRecurringText":string;
+"emptyListMessage":string;
+"hamburgerTitle":string;
+"editCta":string;
+"deleteCta":string;
+"addDeductionCta":string;
+"cancelCta":string;
+"validations":{
+"description":string;
+"amount":string;
 }
+};
+export interface EmployeeEmployeeList{
+"actionLabel":string;
+"addEmployeeCTA":string;
+"addAnotherCta":string;
+"addressesCta":string;
+"deductionsCta":string;
+"deleteCta":string;
+"editCta":string;
+"employeeListLabel":string;
+"emptyTableDescription":string;
+"emptyTableTitle":string;
+"federalTaxesCta":string;
+"hamburgerTitle":string;
+"nameLabel":string;
+"statusLabel":string;
+"title":string;
+};
+export interface EmployeeHomeAddress{
+"formTitle":string;
+"desc":string;
+"street1":string;
+"street2":string;
+"city":string;
+"state":string;
+"statePlaceholder":string;
+"zip":string;
+"courtesyWithholdingLabel":string;
+"courtesyWhithholdingDescription":string;
+"learnMoreCta":string;
+"withholdingTitle":string;
+"withholdingNote":string;
+"editAddress":string;
+"cancel":string;
+"submit":string;
+"validations":{
+"street1":string;
+"city":string;
+"state":string;
+"zip":string;
+}
+};
+export interface EmployeeLanding{
+"landingSubtitle":string;
+"landingDescription":string;
+"stepsSubtitle":string;
+"steps":{
+"personalInfo":string;
+"taxInfo":string;
+"bankInfo":string;
+}
+"getStartedCta":string;
+"getStartedDescription":string;
+};
+export interface EmployeeOnboardingSummary{
+"subTitle":string;
+"description":string;
+"onboardedAdminSubtitle":string;
+"onboardedAdminDescription":string;
+"onboardedSelfSubtitle":string;
+"onboardedSelfDescription":string;
+"returnToEmployeeListCta":string;
+"addAnotherCta":string;
+"newHireReportCta":string;
+"steps":{
+"personal_details":string;
+"compensation_details":string;
+"add_work_address":string;
+"add_home_address":string;
+"federal_tax_setup":string;
+"state_tax_setup":string;
+"direct_deposit_setup":string;
+"employee_form_signing":string;
+"file_new_hire_report":string;
+}
+};
+export interface EmployeePaySchedules{
+"pageTitle":string;
+"saveAndContinueCta":string;
+"pleaseVerify":string;
+"labels":{
+"frequency":string;
+"firstPayDate":string;
+"deadline":string;
+}
+};
+export interface EmployeePaymentMethod{
+"accountNumberLabel":string;
+"accountTypeColumn":string;
+"accountTypeLabel":string;
+"accountTypeChecking":string;
+"accountTypeSavings":string;
+"allocationColumn":string;
+"actionColumn":string;
+"addAnotherCta":string;
+"addBankAccountCTA":string;
+"bankAccountsListLabel":string;
+"cancelCta":string;
+"saveCta":string;
+"cancelAddCta":string;
+"checkDescription":string;
+"checkLabel":string;
+"deleteBankAccountCTA":string;
+"directDepositDescription":string;
+"directDepositLabel":string;
+"hamburgerTitle":string;
+"nameLabel":string;
+"nicknameColumn":string;
+"paymentFieldsetLegend":string;
+"routingNumberColumn":string;
+"routingNumberLabel":string;
+"routingNumberDescription":string;
+"splitCta":string;
+"submitCta":string;
+"title":string;
+"amountLabel":string;
+"splitDescription":string;
+"draggableListLabel":string;
+"percentageLabel":string;
+"splitAmountLabel":string;
+"splitByLabel":string;
+"priorityLabel":string;
+"remainderLabel":string;
+"splitTitle":string;
+"priority_one":string;
+"priority_two":string;
+"priority_few":string;
+"priority_other":string;
+"validations":{
+"percentageError":string;
+"amountError":string;
+"accountName":string;
+"routingNumber":string;
+"accountNumber":string;
+}
+};
+export interface EmployeeProfile{
+"cancelCta":string;
+"description":string;
+"dobLabel":string;
+"email":string;
+"emailDescription":string;
+"firstName":string;
+"formTitle":string;
+"lastName":string;
+"middleInitial":string;
+"preferredFirstName":string;
+"selfOnboardingLabel":string;
+"ssnLabel":string;
+"ssnMask":string;
+"startDateDescription":string;
+"startDateLabel":string;
+"submitCta":string;
+"title":string;
+"validations":{
+"email":string;
+"firstName":string;
+"lastName":string;
+"startDate":string;
+}
+"workAddress":string;
+"workAddressDescription":string;
+"workAddressPlaceholder":string;
+"workAddressSectionTitle":string;
+"workAddressSectionDescription":string;
+};
+export interface EmployeeSplitPaycheck{
+"amountLabel":string;
+"bankDescription":string;
+"description":string;
+"percentageLabel":string;
+"splitAmountLabel":string;
+"splitByLabel":string;
+"priorityLabel":string;
+"title":string;
+"remainderLabel":string;
+"priority_one":string;
+"priority_two":string;
+"priority_few":string;
+"priority_other":string;
+"validations":{
+"percentageError":string;
+"priorityError":string;
+"amountError":string;
+}
+"cancelCta":string;
+"submitCta":string;
+};
+export interface EmployeeStateTaxes{
+"title":string;
+"filingStatusLabel":string;
+"cancelCta":string;
+"submitCta":string;
+};
+export interface EmployeeTaxes{
+"cancelCta":string;
+"deductions":string;
+"dependentsTotalIfApplicable":string;
+"extraWithholding":string;
+"federalFilingStatus1c":string;
+"federalFillingStatusPlaceholder":string;
+"federalTaxesTitle":string;
+"filingStatusExemptFromWithholding":string;
+"filingStatusHeadOfHousehold":string;
+"filingStatusMarried":string;
+"filingStatusSingle":string;
+"includesSpouseExplanation":string;
+"irs_calculator":string;
+"irsCalculatorOrW4Line":string;
+"multipleJobs2c":string;
+"otherIncome":string;
+"selectWithholdingDescription":string;
+"stateTaxesTitle":string;
+"submitCta":string;
+"twoJobYesLabel":string;
+"twoJobNoLabel":string;
+"validations":{
+"federalFilingStatus":string;
+"federalTwoJobs":string;
+}
+};
+export interface PayrollPayrollHistoryList{
+"period":string;
+"payrollType":string;
+"payrollCancellable":string;
+"checkDate":string;
+"payrollTotal":string;
+};
+export interface PayrollPayrollSchedule{
+"pageTitle":string;
+"helpOne":string;
+"helpTwo":string;
+"helpThree":string;
+"payFrequency":string;
+"payFrequency.weekly":string;
+"payFrequency.biweekly":string;
+"payFrequency.semimonthly":string;
+"payFrequency.semimonthly_custom":string;
+"payFrequency.monthly":string;
+"day_1.label":string;
+"day_2.label":string;
+"anchor_pay_date.label":string;
+"deadline_to_run_payroll.label":string;
+"anchor_end_of_pay_period.label":string;
+"anchor_end_of_pay_period.help":string;
+};
+export interface common{
+"status":{
+"loading":string;
+"requiredField":string;
+"errorEncountered":string;
+}
+"optionalLabel":string;
+"errors":{
+"globalReactError":string;
+"missingParamsOrContext":string;
+"unhandledEvent":string;
+"unknownEventType":string;
+}
+"icons":{
+"selectArrow":string;
+"calendarArrow":string;
+"nextMonth":string;
+"previousMonth":string;
+"magnifyingGlass":string;
+}
+"flows":{
+"employeeOnboarding":{
+"employeeListTitle":string;
+"profileTitle":string;
+"compensationTitle":string;
+"taxesTitle":string;
+"paymentMethodTitle":string;
+"deductionsTitle":string;
+"summaryTitle":string;
+}
+}
+"labels":{
+"draggableLabel":string;
+"draggablePosition":string;
+"back":string;
+"saveContinue":string;
+"submit":string;
+"name":string;
+"yes":string;
+"no":string;
+}
+"onboardingStatus":{
+"undefined":string;
+"onboarding_completed":string;
+"admin_onboarding_incomplete":string;
+"self_onboarding_pending_invite":string;
+"self_onboarding_invited":string;
+"self_onboarding_invited_started":string;
+"self_onboarding_invited_overdue":string;
+"self_onboarding_completed_by_employee":string;
+"self_onboarding_awaiting_admin_review":string;
+}
+"validations":{
+"accountName":string;
+"routingNumber":string;
+"accountNumber":string;
+"ssn":string;
+"location":string;
+"dob":string;
+}
+"statesHash":{
+"AL":string;
+"AK":string;
+"AZ":string;
+"AR":string;
+"CA":string;
+"CO":string;
+"CT":string;
+"DE":string;
+"FL":string;
+"GA":string;
+"HI":string;
+"ID":string;
+"IL":string;
+"IN":string;
+"IA":string;
+"KS":string;
+"KY":string;
+"LA":string;
+"ME":string;
+"MD":string;
+"MA":string;
+"MI":string;
+"MN":string;
+"MS":string;
+"MO":string;
+"MT":string;
+"NE":string;
+"NV":string;
+"NH":string;
+"NJ":string;
+"NM":string;
+"NY":string;
+"NC":string;
+"ND":string;
+"OH":string;
+"OK":string;
+"OR":string;
+"PA":string;
+"RI":string;
+"SC":string;
+"SD":string;
+"TN":string;
+"TX":string;
+"UT":string;
+"VT":string;
+"VA":string;
+"WA":string;
+"WV":string;
+"WI":string;
+"WY":string;
+}
+};
 
+    interface CustomTypeOptions {
+        defaultNS: 'common';
+        resources: { 'Company.AddBank': CompanyAddBank, 'Company.Addresses': CompanyAddresses, 'Company.FederalTaxes': CompanyFederalTaxes, 'Company.Industry': CompanyIndustry, 'Employee.BankAccount': EmployeeBankAccount, 'Employee.Compensation': EmployeeCompensation, 'Employee.Deductions': EmployeeDeductions, 'Employee.EmployeeList': EmployeeEmployeeList, 'Employee.HomeAddress': EmployeeHomeAddress, 'Employee.Landing': EmployeeLanding, 'Employee.OnboardingSummary': EmployeeOnboardingSummary, 'Employee.PaySchedules': EmployeePaySchedules, 'Employee.PaymentMethod': EmployeePaymentMethod, 'Employee.Profile': EmployeeProfile, 'Employee.SplitPaycheck': EmployeeSplitPaycheck, 'Employee.StateTaxes': EmployeeStateTaxes, 'Employee.Taxes': EmployeeTaxes, 'Payroll.PayrollHistoryList': PayrollPayrollHistoryList, 'Payroll.PayrollSchedule': PayrollPayrollSchedule, 'common': common,  }
+    };
+}
 declare module 'robot3' {
   /**
    * TS Helpers