@gusto/embedded-react-sdk 0.4.1 → 0.6.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { Actions } from './Actions';
 import { BodyParams as BodyParams_2 } from '../typeHelpers';
 import { components } from '../types/schema';
 import { components as components_3 } from '../../types/schema';
@@ -6,11 +7,13 @@ import { default as default_2 } from 'openapi-fetch';
 import { default as default_3 } from 'react';
 import { DocumentList } from './DocumentList';
 import { DocumentListHead } from './DocumentListHead';
+import { Employee as Employee_2 } from '@gusto/embedded-api/models/components/employee.js';
 import { FallbackProps } from 'react-error-boundary';
 import { FederalForm } from './FederalForm';
 import { FederalHead } from './FederalHead';
 import { FetchOptions } from 'openapi-fetch';
 import { FetchResponse } from 'openapi-fetch';
+import { Form } from './Form';
 import { Head } from './Head';
 import { HTMLAttributes } from 'react';
 import { i18n } from 'i18next';
@@ -18,6 +21,7 @@ import { JSX } from 'react/jsx-runtime';
 import { JSX as JSX_2 } from 'react';
 import { List } from './List';
 import { ManageSignatories } from './ManageSignatories';
+import { Preview } from './Preview';
 import { QueryClient } from '@tanstack/react-query';
 import { ReactElement } from 'react';
 import { ReactNode } from 'react';
@@ -133,8 +137,12 @@ declare namespace Company {
         Industry,
         AssignSignatory,
         DocumentList_2 as DocumentList,
+        SignatureForm_2 as SignatureForm,
+        DocumentSignerFlow,
         OnboardingSummary_3 as OnboardingSummary,
-        OnboardingSummaryContextual_2 as OnboardingSummaryContextual
+        OnboardingSummaryContextual_2 as OnboardingSummaryContextual,
+        LocationsFlow,
+        PaySchedule
     }
 }
 export { Company }
@@ -166,7 +174,12 @@ declare type CompensationContextType = {
 
 declare const CompensationContextual: () => JSX.Element;
 
-declare type CompensationDefaultValues = RequireAtLeastOne<Partial<Pick<Schemas['Job'], 'rate' | 'title' | 'payment_unit'>>>;
+declare type CompensationDefaultValues = RequireAtLeastOne<{
+    rate?: Schemas['Job']['rate'];
+    title?: Schemas['Job']['title'];
+    payment_unit?: (typeof PAY_PERIODS)[keyof typeof PAY_PERIODS];
+    flsa_status?: Schemas['Compensation']['flsa_status'];
+}>;
 
 declare type CompensationInputs = v.InferInput<typeof CompensationSchema>;
 
@@ -212,8 +225,12 @@ declare const CompensationSchema: v.IntersectSchema<[v.ObjectSchema<{
 }, undefined>], undefined>], undefined>;
 
 export declare const componentEvents: {
-    readonly COMPANY_ADDRESSES: "company/addresses";
-    readonly COMPANY_ADDRESSE_EDIT: "company/address/edit";
+    readonly PAY_SCHEDULE_CREATE: "paySchedule/create";
+    readonly PAY_SCHEDULE_CREATED: "paySchedule/created";
+    readonly PAY_SCHEDULE_UPDATE: "paySchedule/update";
+    readonly PAY_SCHEDULE_UPDATED: "paySchedule/updated";
+    readonly PAY_SCHEDULE_DELETE: "paySchedule/delete";
+    readonly PAY_SCHEDULE_DELETED: "paySchedule/deleted";
     readonly COMPANY_INDUSTRY: "company/industry";
     readonly COMPANY_INDUSTRY_SELECTED: "company/industry/selected";
     readonly COMPANY_FEDERAL_TAXES_UPDATED: "company/federalTaxes/updated";
@@ -224,8 +241,17 @@ export declare const componentEvents: {
     readonly COMPANY_INVITE_SIGNATORY_DONE: "company/signatory/inviteSignatory/done";
     readonly COMPANY_ASSIGN_SIGNATORY_MODE_UPDATED: "company/signatory/assignSignatory/modeUpdated";
     readonly COMPANY_ASSIGN_SIGNATORY_DONE: "company/signatory/assignSignatory/done";
-    readonly COMPANY_VIEW_FORM_TO_SIGN: "company/forms/view";
     readonly COMPANY_FORM_EDIT_SIGNATORY: "company/forms/editSignatory";
+    readonly COMPANY_FORMS_DONE: "company/forms/done";
+    readonly COMPANY_VIEW_FORM_TO_SIGN: "company/forms/view";
+    readonly COMPANY_SIGN_FORM: "company/forms/sign/signForm";
+    readonly COMPANY_SIGN_FORM_DONE: "company/forms/sign/done";
+    readonly COMPANY_SIGN_FORM_BACK: "company/forms/sign/back";
+    readonly COMPANY_LOCATION_CREATE: "company/location/add";
+    readonly COMPANY_LOCATION_CREATED: "company/location/add/done";
+    readonly COMPANY_LOCATION_EDIT: "company/location/edit";
+    readonly COMPANY_LOCATION_UPDATED: "company/location/edit/done";
+    readonly COMPANY_LOCATION_DONE: "company/location/done";
     readonly EMPLOYEE_CREATE: "employee/create";
     readonly EMPLOYEE_CREATED: "employee/created";
     readonly EMPLOYEE_UPDATE: "employee/update";
@@ -340,7 +366,7 @@ declare interface components_2 {
             /** @description UUID reference to the employee for this work address. */
             employee_uuid?: string;
             /** @description The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field. */
-            version?: string;
+            version: string;
             readonly street_1?: string;
             readonly street_2?: string | null;
             readonly city?: string;
@@ -469,7 +495,7 @@ declare interface components_2 {
                 title?: string;
                 /** @description String identifier for the onboarding step. */
                 id?: string;
-                /** @description When true, this step has been completed. */
+                /** @description When true, this step is required. */
                 required?: boolean;
                 /** @description When true, this step has been completed. */
                 completed?: boolean;
@@ -592,7 +618,7 @@ declare interface components_2 {
              */
             payment_period?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
             /** @description The FIPS code associated with the state or county agency issuing the child support order. Agency data is available in the `GET /v1/garnishments/child_support` API. */
-            readonly fips_code?: string;
+            fips_code?: string;
             /** @description Child Support Enforcement Case Number associated with this child support obligation - required for most states. Agency specific requirements are available in the `GET /v1/garnishments/child_support` API. */
             case_number?: string | null;
             /** @description Order Identifier or Order ID associated with this child support obligation - required for some states. Agency specific requirements are available in the `GET /v1/garnishments/child_support` API. */
@@ -638,6 +664,12 @@ declare interface components_2 {
              * @default null
              */
             annual_maximum: string | null;
+            /**
+             * Format: float
+             * @description A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.
+             * @default null
+             */
+            total_amount: string | null;
             /**
              * Format: float
              * @description The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. "16.00".
@@ -730,7 +762,7 @@ declare interface components_2 {
             /** @description The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field. */
             version?: string;
             /** @description The UUID of the employee to which this termination is attached. */
-            readonly employee_uuid?: number;
+            readonly employee_uuid?: string;
             /** @description Whether the employee's termination has gone into effect. */
             readonly active?: boolean;
             /** @description Whether the employee's termination is cancelable. Cancelable is true if `run_termination_payroll` is false and `effective_date` is in the future. */
@@ -877,6 +909,8 @@ declare interface components_2 {
                 effective_date?: string;
             }[];
         };
+        /** @description The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared. */
+        "Form-Document-Content-Type-Type": string | null;
         /** Form */
         Form: {
             /** @description The UUID of the form */
@@ -895,6 +929,7 @@ declare interface components_2 {
             readonly quarter?: number | null;
             /** @description A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed. */
             readonly requires_signing?: boolean;
+            document_content_type?: components_2["schemas"]["Form-Document-Content-Type-Type"];
         };
         /** Form */
         Form_1099: {
@@ -914,6 +949,7 @@ declare interface components_2 {
             readonly quarter?: number | null;
             /** @description A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed. */
             readonly requires_signing?: boolean;
+            document_content_type?: components_2["schemas"]["Form-Document-Content-Type-Type"];
             /** @description The contractor UUID */
             readonly contractor_uuid?: string;
         };
@@ -922,7 +958,8 @@ declare interface components_2 {
             /** @description the UUID of the form */
             readonly uuid: string;
             /** @description the URL of the form */
-            document_url?: string;
+            document_url?: string | null;
+            document_content_type?: components_2["schemas"]["Form-Document-Content-Type-Type"];
         };
         /** Document */
         Document: {
@@ -2087,6 +2124,8 @@ declare interface components_2 {
         "Company-Benefit-With-Employee-Benefits": {
             /** @description The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field. */
             version?: string;
+            /** @description The UUID of the company. */
+            readonly company_uuid?: string;
             /** @description The UUID of the company benefit. */
             readonly uuid: string;
             /** @description The type of the benefit to which the company benefit belongs (same as benefit_id). */
@@ -2163,6 +2202,10 @@ declare interface components_2 {
         "Company-Benefit": {
             /** @description The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field. */
             version?: string;
+            /** @description The number of employees enrolled in the benefit, only returned when enrollment_count query param is set to true. */
+            readonly enrollment_count?: number;
+            /** @description The UUID of the company. */
+            readonly company_uuid?: string;
             /** @description The UUID of the company benefit. */
             readonly uuid: string;
             /** @description The type of the benefit to which the company benefit belongs. */
@@ -2397,6 +2440,8 @@ declare interface components_2 {
                 readonly job_uuid?: string;
                 /** @description The amount multiplied by the base rate to calculate total compensation per hour worked. */
                 readonly compensation_multiplier?: number;
+                /** @description The FLSA Status of the employee's primary job compensation */
+                readonly flsa_status?: string;
             }[];
             /** @description An array of all paid time off the employee is eligible for this pay period. */
             paid_time_off?: {
@@ -4960,6 +5005,8 @@ declare interface components_2 {
         webhook_subscription_uuid: string;
         /** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
         VersionHeader: "2024-04-01";
+        /** @description Optional header to supply the IP address. This can be used to supply the IP address for signature endpoints instead of the signed_by_ip_address parameter. */
+        IpAddressHeader: string;
         /** @description The notification entity_uuid */
         notification_uuid: string;
         /** @description The month we are calculating the invoice for. Must be in YYYY-MM format */
@@ -5061,6 +5108,7 @@ declare namespace DocumentList_2 {
     var Head: Head;
     var ManageSignatories: ManageSignatories;
     var List: List;
+    var Actions: Actions;
 }
 
 declare interface DocumentListProps {
@@ -5089,11 +5137,18 @@ declare type DocumentSignerContextType = {
     handleContinue: () => void;
     documentListError: Error | null;
     formToSign?: Schemas['Form'];
-    pdfUrl?: string;
+    pdfUrl?: string | null;
     handleBack: () => void;
     handleSubmit: (data: SignatureFormInputs) => void;
 };
 
+declare const DocumentSignerFlow: ({ companyId, signatoryId, onEvent, }: DocumentSignerFlowProps) => JSX.Element;
+
+declare interface DocumentSignerFlowProps extends BaseComponentInterface {
+    companyId: string;
+    signatoryId?: string;
+}
+
 declare interface DocumentSignerProps extends CommonComponentInterface {
     employeeId: string;
 }
@@ -5157,7 +5212,7 @@ declare type EmployeeListContextType = {
     handleItemsPerPageChange: (newCount: number) => void;
     currentPage: number;
     totalPages: number;
-    employees: Schemas['Employee'][];
+    employees: Employee_2[];
 };
 
 /**
@@ -5177,6 +5232,7 @@ export declare interface EmployeeOnboardingContextInterface extends FlowContextI
     startDate?: string;
     paymentMethod?: Schemas['Employee-Payment-Method'];
     defaultValues?: EmployeeOnboardingDefaultValues;
+    isSelfOnboardingEnabled?: boolean;
 }
 
 declare type EmployeeOnboardingDefaultValues = RequireAtLeastOne<{
@@ -5184,11 +5240,12 @@ declare type EmployeeOnboardingDefaultValues = RequireAtLeastOne<{
     compensation?: CompensationDefaultValues;
 }>;
 
-export declare const EmployeeOnboardingFlow: ({ companyId, onEvent, defaultValues, }: EmployeeOnboardingFlowProps) => JSX.Element;
+export declare const EmployeeOnboardingFlow: ({ companyId, onEvent, defaultValues, isSelfOnboardingEnabled, }: EmployeeOnboardingFlowProps) => JSX.Element;
 
 export declare interface EmployeeOnboardingFlowProps extends BaseComponentInterface {
     companyId: string;
     defaultValues?: RequireAtLeastOne<EmployeeOnboardingDefaultValues>;
+    isSelfOnboardingEnabled?: boolean;
 }
 
 declare const EmployeeOnboardingStatus: {
@@ -5237,6 +5294,7 @@ declare interface GTheme {
     radio: GThemeRadio
     checkbox: GThemeCheckbox
     table: GThemeTable
+    calendarDisplay: GThemeCalendarDisplay
     card: GThemeCard
     link: GThemeLink
     badge: GThemeBadge
@@ -5281,11 +5339,21 @@ declare type GThemeButtonVariant = {
     focusColor: ThemeColor
 }
 
+declare interface GThemeCalendarDisplay {
+    primaryHighlight: string
+    warningHighlight: string
+    lightFont: string
+    darkFont: string
+    borderColor: string
+}
+
 declare interface GThemeCard {
     borderColor: string
     dividerColor: string
     headerTextColor: string
     contentTextColor: string
+    columnTitleColor: string
+    columnTitleFontSize: string
 }
 
 declare interface GThemeCheckbox {
@@ -5323,6 +5391,9 @@ declare interface GThemeColors {
         500: ThemeColor
         800: ThemeColor
     }
+    orange: {
+        800: ThemeColor
+    }
 }
 
 declare interface GThemeFocus {
@@ -5422,7 +5493,7 @@ declare interface GThemeTypography {
         medium: string
     }
     fontWeight: {
-        book: number
+        regular: number
         medium: number
     }
     disabledTextColor: ThemeColor
@@ -5445,7 +5516,7 @@ export declare function GustoApiContextProvider({ children, context, queryClient
 }): JSX.Element;
 
 export declare interface GustoApiProps {
-    config?: APIConfig;
+    config: APIConfig;
     dictionary?: Dictionary;
     lng?: string;
     locale?: string;
@@ -5547,7 +5618,9 @@ export declare class GustoClient {
     }>;
     getCompanyOnboardingStatus(company_uuid: string): Promise<FetchResponse<    {
     parameters: {
-    query?: never;
+    query?: {
+    additional_steps?: string;
+    };
     header?: {
     "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
     };
@@ -6101,7 +6174,7 @@ export declare class GustoClient {
         readonly active?: boolean;
         location_uuid?: string;
         employee_uuid?: string;
-        version?: string;
+        version: string;
         readonly street_1?: string;
         readonly street_2?: string | null;
         readonly city?: string;
@@ -6144,7 +6217,7 @@ export declare class GustoClient {
         readonly active?: boolean;
         location_uuid?: string;
         employee_uuid?: string;
-        version?: string;
+        version: string;
         readonly street_1?: string;
         readonly street_2?: string | null;
         readonly city?: string;
@@ -6257,6 +6330,7 @@ export declare class GustoClient {
         times: number | null;
         recurring: boolean;
         annual_maximum: string | null;
+        total_amount: string | null;
         pay_period_maximum: string | null;
         deduct_as_percentage: boolean;
         garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
@@ -6273,6 +6347,7 @@ export declare class GustoClient {
         times: number | null;
         recurring: boolean;
         annual_maximum: string | null;
+        total_amount: string | null;
         pay_period_maximum: string | null;
         deduct_as_percentage: boolean;
         garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
@@ -6566,6 +6641,8 @@ export declare class GustoClient {
     start_date?: string;
     end_date?: string;
     sort_order?: components["parameters"]["sort_order"];
+    page?: components["parameters"]["pageParam"];
+    per?: components["parameters"]["perParam"];
     };
     header?: {
     "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -6602,6 +6679,8 @@ export declare class GustoClient {
     start_date?: string;
     end_date?: string;
     sort_order?: components["parameters"]["sort_order"];
+    page?: components["parameters"]["pageParam"];
+    per?: components["parameters"]["perParam"];
     };
     header?: {
     "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -6783,10 +6862,12 @@ export declare class GustoClient {
         readonly year?: number | null;
         readonly quarter?: number | null;
         readonly requires_signing?: boolean;
+        document_content_type?: components["schemas"]["Form-Document-Content-Type-Type"];
     }[]>;
     getEmployeeFormPdf(employee_id: string, form_id: string): Promise<{
         readonly uuid: string;
-        document_url?: string;
+        document_url?: string | null;
+        document_content_type?: components["schemas"]["Form-Document-Content-Type-Type"];
     }>;
     signEmployeeForm(employee_id: string, form_id: string, body: BodyParams<'/v1/employees/{employee_id}/forms/{form_id}/sign', 'PUT'>): Promise<{
         readonly uuid: string;
@@ -6797,6 +6878,7 @@ export declare class GustoClient {
         readonly year?: number | null;
         readonly quarter?: number | null;
         readonly requires_signing?: boolean;
+        document_content_type?: components["schemas"]["Form-Document-Content-Type-Type"];
     }>;
     getAllCompanyForms(company_id: string): Promise<{
         readonly uuid: string;
@@ -6807,10 +6889,23 @@ export declare class GustoClient {
         readonly year?: number | null;
         readonly quarter?: number | null;
         readonly requires_signing?: boolean;
+        document_content_type?: components["schemas"]["Form-Document-Content-Type-Type"];
     }[]>;
+    getCompanyForm(form_id: string): Promise<{
+        readonly uuid: string;
+        readonly name?: string;
+        readonly title?: string;
+        readonly description?: string;
+        readonly draft?: boolean;
+        readonly year?: number | null;
+        readonly quarter?: number | null;
+        readonly requires_signing?: boolean;
+        document_content_type?: components["schemas"]["Form-Document-Content-Type-Type"];
+    }>;
     getCompanyFormPdf(form_id: string): Promise<{
         readonly uuid: string;
-        document_url?: string;
+        document_url?: string | null;
+        document_content_type?: components["schemas"]["Form-Document-Content-Type-Type"];
     }>;
     signCompanyForm(form_id: string, body: BodyParams<'/v1/forms/{form_id}/sign', 'PUT'>): Promise<{
         readonly uuid: string;
@@ -6821,6 +6916,7 @@ export declare class GustoClient {
         readonly year?: number | null;
         readonly quarter?: number | null;
         readonly requires_signing?: boolean;
+        document_content_type?: components["schemas"]["Form-Document-Content-Type-Type"];
     }>;
     getPaySchedule(pay_schedule_id: string, company_id: string): Promise<{
         uuid: components["schemas"]["Pay-Schedule-Uuid"];
@@ -7028,6 +7124,12 @@ export declare function Landing(): JSX.Element;
 
 declare function Landing_2(props: SummaryProps_2 & BaseComponentInterface): JSX.Element;
 
+declare function LocationsFlow({ companyId, onEvent }: LocationsProps): JSX.Element;
+
+declare interface LocationsProps extends BaseComponentInterface {
+    companyId: string;
+}
+
 declare type MODE = 'ADD' | 'LIST' | 'INITIAL' | 'EDIT';
 
 declare type MODE_2 = 'LIST' | 'ADD_ADDITIONAL_JOB' | 'ADD_INITIAL_JOB' | 'EDIT_ADDITIONAL_JOB' | 'EDIT_INITIAL_JOB' | 'PROCEED';
@@ -7825,7 +7927,10 @@ declare interface operations {
     };
     "get-v1-company-onboarding-status": {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Comma delimited string indicating whether to include any additional steps of onboarding. Currently only supports the value "external_payroll". */
+                additional_steps?: string;
+            };
             header?: {
                 /** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
                 "X-Gusto-API-Version"?: components_2["parameters"]["VersionHeader"];
@@ -10972,6 +11077,8 @@ declare interface operations {
         parameters: {
             query?: never;
             header?: {
+                /** @description Optional header to supply the IP address. This can be used to supply the IP address for signature endpoints instead of the signed_by_ip_address parameter. */
+                "x-gusto-client-ip"?: components_2["parameters"]["IpAddressHeader"];
                 /** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
                 "X-Gusto-API-Version"?: components_2["parameters"]["VersionHeader"];
             };
@@ -10993,8 +11100,8 @@ declare interface operations {
                     }[];
                     /** @description Whether you agree to sign electronically */
                     agree: boolean;
-                    /** @description The IP address of the signatory who signed the form. */
-                    signed_by_ip_address: string;
+                    /** @description The IP address of the signatory who signed the form. You must provide the IP address with either this parameter OR you can leave out this parameter and set the IP address in the request header using the `x-gusto-client-ip` header instead. */
+                    signed_by_ip_address?: string;
                 };
             };
         };
@@ -11249,6 +11356,10 @@ declare interface operations {
                 end_date?: string;
                 /** @description A string indicating whether to sort resulting events in ascending (asc) or descending (desc) chronological order. Events are sorted by their `timestamp`. Defaults to asc if left empty. */
                 sort_order?: components_2["parameters"]["sort_order"];
+                /** @description The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. */
+                page?: components_2["parameters"]["pageParam"];
+                /** @description Number of objects per page. For majority of endpoints will default to 25 */
+                per?: components_2["parameters"]["perParam"];
             };
             header?: {
                 /** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
@@ -12238,6 +12349,8 @@ declare interface operations {
         parameters: {
             query?: never;
             header?: {
+                /** @description Optional header to supply the IP address. This can be used to supply the IP address for signature endpoints instead of the signed_by_ip_address parameter. */
+                "x-gusto-client-ip"?: components_2["parameters"]["IpAddressHeader"];
                 /** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
                 "X-Gusto-API-Version"?: components_2["parameters"]["VersionHeader"];
             };
@@ -12254,8 +12367,8 @@ declare interface operations {
                     signature_text: string;
                     /** @description Whether you agree to sign electronically */
                     agree: boolean;
-                    /** @description The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. */
-                    signed_by_ip_address: string;
+                    /** @description The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. You must provide the IP address with either this parameter OR you can leave out this parameter and set the IP address in the request header using the `x-gusto-client-ip` header instead. */
+                    signed_by_ip_address?: string;
                 };
             };
         };
@@ -12330,6 +12443,8 @@ declare interface operations {
         parameters: {
             query?: never;
             header?: {
+                /** @description Optional header to supply the IP address. This can be used to supply the IP address for signature endpoints instead of the signed_by_ip_address parameter. */
+                "x-gusto-client-ip"?: components_2["parameters"]["IpAddressHeader"];
                 /** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
                 "X-Gusto-API-Version"?: components_2["parameters"]["VersionHeader"];
             };
@@ -12348,8 +12463,8 @@ declare interface operations {
                     signature_text: string;
                     /** @description Whether you agree to sign electronically */
                     agree: boolean;
-                    /** @description The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. */
-                    signed_by_ip_address: string;
+                    /** @description The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. You must provide the IP address with either this parameter OR you can leave out this parameter and set the IP address in the request header using the `x-gusto-client-ip` header instead. */
+                    signed_by_ip_address?: string;
                     /** @description Whether there is a preparer */
                     preparer?: boolean;
                     preparer_first_name?: string;
@@ -12631,6 +12746,8 @@ declare interface operations {
     "get-v1-companies-company_id-company_benefits": {
         parameters: {
             query?: {
+                /** @description Whether the benefit is currently active */
+                active?: boolean;
                 /** @description Whether to return employee enrollment count */
                 enrollment_count?: boolean;
             };
@@ -13662,6 +13779,8 @@ declare interface operations {
         parameters: {
             query?: never;
             header?: {
+                /** @description Optional header to supply the IP address. This can be used to supply the IP address for signature endpoints instead of the signed_by_ip_address parameter. */
+                "x-gusto-client-ip"?: components_2["parameters"]["IpAddressHeader"];
                 /** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
                 "X-Gusto-API-Version"?: components_2["parameters"]["VersionHeader"];
             };
@@ -13678,8 +13797,8 @@ declare interface operations {
                     signature_text: string;
                     /** @description The signer's job title */
                     signer_title: string;
-                    /** @description The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. */
-                    signed_by_ip_address: string;
+                    /** @description The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. You must provide the IP address with either this parameter OR you can leave out this parameter and set the IP address in the request header using the `x-gusto-client-ip` header instead. */
+                    signed_by_ip_address?: string;
                     /** @description Whether you agree to sign electronically */
                     agree: boolean;
                     /** @description Any additional notes */
@@ -19274,6 +19393,14 @@ declare interface paths {
     };
 }
 
+declare const PAY_PERIODS: {
+    readonly HOUR: "Hour";
+    readonly WEEK: "Week";
+    readonly MONTH: "Month";
+    readonly YEAR: "Year";
+    readonly PAYCHECK: "Paycheck";
+};
+
 export declare function PaymentMethod(): JSX.Element;
 
 declare function PaymentMethod_2(props: PaymentMethodProps & BaseComponentInterface): JSX.Element;
@@ -19384,6 +19511,23 @@ declare interface PayrollTotalsConstructor {
     companyDebit?: number;
 }
 
+declare const PaySchedule: {
+    ({ companyId, defaultValues, ...props }: PayScheduleProps & BaseComponentInterface): JSX.Element;
+    Head: () => JSX.Element;
+    List: () => JSX.Element | null;
+    Edit: () => JSX.Element | null;
+    Actions: () => JSX.Element;
+};
+
+declare type PayScheduleDefaultValues = RequireAtLeastOne<Partial<Pick<Schemas['Pay-Schedule'], 'anchor_pay_date' | 'anchor_end_of_pay_period' | 'day_1' | 'day_2' | 'custom_name' | 'auto_pilot'>> & {
+    frequency: 'Every week' | 'Every other week' | 'Twice per month' | 'Monthly';
+}>;
+
+declare interface PayScheduleProps extends CommonComponentInterface {
+    companyId: string;
+    defaultValues?: PayScheduleDefaultValues;
+}
+
 export declare function Profile(): JSX.Element;
 
 declare function Profile_2(props: ProfileProps & BaseComponentInterface): JSX.Element;
@@ -19405,6 +19549,7 @@ declare type ProfileContextType = {
     isPending: boolean;
     isAdmin: boolean;
     handleCancel: () => void;
+    isSelfOnboardingEnabled: boolean;
 };
 
 declare const ProfileContextual: () => JSX.Element;
@@ -19431,6 +19576,7 @@ declare interface ProfileProps extends CommonComponentInterface {
     companyId: string;
     defaultValues?: ProfileDefaultValues;
     isAdmin?: boolean;
+    isSelfOnboardingEnabled?: boolean;
 }
 
 declare type QueryParams<Path extends keyof paths> = _QueryParams<Path> extends {
@@ -19475,8 +19621,24 @@ declare type Schemas = components_2["schemas"];
 /**Creating new i18next instance to avoid global clashing */
 export declare const SDKI18next: i18n;
 
+declare function SignatureForm_2({ formId, companyId, children, className, ...props }: SignatureFormProps & BaseComponentInterface): JSX.Element;
+
+declare namespace SignatureForm_2 {
+    var Head: Head;
+    var Preview: Preview;
+    var Form: Form;
+    var Actions: Actions;
+}
+
 declare type SignatureFormInputs = v.InferInput<typeof SignatureFormSchema>;
 
+declare interface SignatureFormProps {
+    formId: string;
+    companyId: string;
+    children?: ReactNode;
+    className?: string;
+}
+
 declare const SignatureFormSchema: v.ObjectSchema<{
     readonly signature: v.SchemaWithPipe<[v.StringSchema<undefined>, v.NonEmptyAction<string, undefined>]>;
     readonly confirmSignature: v.SchemaWithPipe<[v.ArraySchema<v.LiteralSchema<"agree", undefined>, undefined>, v.MinLengthAction<"agree"[], 1, undefined>]>;
@@ -19563,6 +19725,7 @@ court_ordered?: boolean;
 times: number | null;
 recurring: boolean;
 annual_maximum: string | null;
+total_amount: string | null;
 pay_period_maximum: string | null;
 deduct_as_percentage: boolean;
 garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
@@ -19580,6 +19743,7 @@ court_ordered?: boolean;
 times: number | null;
 recurring: boolean;
 annual_maximum: string | null;
+total_amount: string | null;
 pay_period_maximum: string | null;
 deduct_as_percentage: boolean;
 garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
@@ -19628,7 +19792,7 @@ effective_date?: string;
 readonly active?: boolean;
 location_uuid?: string;
 employee_uuid?: string;
-version?: string;
+version: string;
 readonly street_1?: string;
 readonly street_2?: string | null;
 readonly city?: string;
@@ -19643,7 +19807,7 @@ effective_date?: string;
 readonly active?: boolean;
 location_uuid?: string;
 employee_uuid?: string;
-version?: string;
+version: string;
 readonly street_1?: string;
 readonly street_2?: string | null;
 readonly city?: string;
@@ -19977,6 +20141,7 @@ readonly draft?: boolean;
 readonly year?: number | null;
 readonly quarter?: number | null;
 readonly requires_signing?: boolean;
+document_content_type?: components_3["schemas"]["Form-Document-Content-Type-Type"];
 }[], Error>;
 
 export declare function useGetAllEmployeeForms(employee_id: string): UseSuspenseQueryResult<{
@@ -19988,6 +20153,7 @@ export declare function useGetAllEmployeeForms(employee_id: string): UseSuspense
     readonly year?: number | null;
     readonly quarter?: number | null;
     readonly requires_signing?: boolean;
+    document_content_type?: components_3["schemas"]["Form-Document-Content-Type-Type"];
 }[], Error>;
 
 export declare function useGetAllSignatories(company_id: string): UseSuspenseQueryResult<    {
@@ -20094,9 +20260,22 @@ effective_date?: string;
 deposit_schedule?: string;
 }, Error>;
 
+export declare function useGetCompanyForm(form_id: string): UseSuspenseQueryResult<    {
+readonly uuid: string;
+readonly name?: string;
+readonly title?: string;
+readonly description?: string;
+readonly draft?: boolean;
+readonly year?: number | null;
+readonly quarter?: number | null;
+readonly requires_signing?: boolean;
+document_content_type?: components_3["schemas"]["Form-Document-Content-Type-Type"];
+}, Error>;
+
 export declare function useGetCompanyFormPdf(form_id: string): UseSuspenseQueryResult<    {
 readonly uuid: string;
-document_url?: string;
+document_url?: string | null;
+document_content_type?: components_3["schemas"]["Form-Document-Content-Type-Type"];
 }, Error>;
 
 export declare function useGetCompanyIndustry(company_id: string): UseSuspenseQueryResult<    {
@@ -20166,6 +20345,7 @@ export declare function useGetDeduction(garnishment_id: string): UseSuspenseQuer
     times: number | null;
     recurring: boolean;
     annual_maximum: string | null;
+    total_amount: string | null;
     pay_period_maximum: string | null;
     deduct_as_percentage: boolean;
     garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
@@ -20194,6 +20374,7 @@ export declare function useGetEmployeeDeductions(employee_id: string): UseSuspen
     times: number | null;
     recurring: boolean;
     annual_maximum: string | null;
+    total_amount: string | null;
     pay_period_maximum: string | null;
     deduct_as_percentage: boolean;
     garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
@@ -20215,7 +20396,8 @@ export declare function useGetEmployeeFederalTaxes(employee_id: string): UseSusp
 
 export declare function useGetEmployeeFormPdf(employee_id: string): UseMutationResult<    {
 readonly uuid: string;
-document_url?: string;
+document_url?: string | null;
+document_content_type?: components_3["schemas"]["Form-Document-Content-Type-Type"];
 }, Error, {
 form_id: string;
 }, unknown>;
@@ -20363,7 +20545,7 @@ export declare function useGetEmployeeWorkAddress(work_address_uuid: string): Us
     readonly active?: boolean;
     location_uuid?: string;
     employee_uuid?: string;
-    version?: string;
+    version: string;
     readonly street_1?: string;
     readonly street_2?: string | null;
     readonly city?: string;
@@ -20378,7 +20560,7 @@ export declare function useGetEmployeeWorkAddresses(employee_id: string | undefi
     readonly active?: boolean;
     location_uuid?: string;
     employee_uuid?: string;
-    version?: string;
+    version: string;
     readonly street_1?: string;
     readonly street_2?: string | null;
     readonly city?: string;
@@ -20472,6 +20654,7 @@ readonly draft?: boolean;
 readonly year?: number | null;
 readonly quarter?: number | null;
 readonly requires_signing?: boolean;
+document_content_type?: components_3["schemas"]["Form-Document-Content-Type-Type"];
 }, unknown, {
 form_id: string;
 body: Parameters<(form_id: string, body: BodyParams_2<"/v1/forms/{form_id}/sign", "PUT">) => Promise<{
@@ -20483,6 +20666,7 @@ readonly draft?: boolean;
 readonly year?: number | null;
 readonly quarter?: number | null;
 readonly requires_signing?: boolean;
+document_content_type?: components_3["schemas"]["Form-Document-Content-Type-Type"];
 }>>[1];
 }, unknown>;
 
@@ -20495,6 +20679,7 @@ readonly draft?: boolean;
 readonly year?: number | null;
 readonly quarter?: number | null;
 readonly requires_signing?: boolean;
+document_content_type?: components_3["schemas"]["Form-Document-Content-Type-Type"];
 }, Error, {
 form_id: string;
 body: Parameters<(employee_id: string, form_id: string, body: BodyParams_2<"/v1/employees/{employee_id}/forms/{form_id}/sign", "PUT">) => Promise<{
@@ -20506,6 +20691,7 @@ readonly draft?: boolean;
 readonly year?: number | null;
 readonly quarter?: number | null;
 readonly requires_signing?: boolean;
+document_content_type?: components_3["schemas"]["Form-Document-Content-Type-Type"];
 }>>[2];
 }, unknown>;
 
@@ -20698,6 +20884,7 @@ court_ordered?: boolean;
 times: number | null;
 recurring: boolean;
 annual_maximum: string | null;
+total_amount: string | null;
 pay_period_maximum: string | null;
 deduct_as_percentage: boolean;
 garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
@@ -20715,6 +20902,7 @@ court_ordered?: boolean;
 times: number | null;
 recurring: boolean;
 annual_maximum: string | null;
+total_amount: string | null;
 pay_period_maximum: string | null;
 deduct_as_percentage: boolean;
 garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
@@ -21029,7 +21217,7 @@ effective_date?: string;
 readonly active?: boolean;
 location_uuid?: string;
 employee_uuid?: string;
-version?: string;
+version: string;
 readonly street_1?: string;
 readonly street_2?: string | null;
 readonly city?: string;
@@ -21044,7 +21232,7 @@ effective_date?: string;
 readonly active?: boolean;
 location_uuid?: string;
 employee_uuid?: string;
-version?: string;
+version: string;
 readonly street_1?: string;
 readonly street_2?: string | null;
 readonly city?: string;
@@ -21103,18 +21291,6 @@ declare type VAR = `var(${string})`
 
 export { }
 
-declare namespace _default {
-    function process(): {
-        code: string;
-    };
-}
-
-declare namespace _default {
-    function process(sourceText: any, sourcePath: any): {
-        code: string;
-    };
-}
-
 
 
 declare module 'i18next' {
@@ -21180,8 +21356,8 @@ export interface CompanyAssignSignatory{
 "lastName":string;
 }
 "buttons":{
-"submit":string;
-"invite":string;
+"signDocuments":string;
+"inviteSignatory":string;
 }
 "validations":{
 "dob":string;
@@ -21203,7 +21379,7 @@ export interface CompanyDocumentList{
 "documentListTitle":string;
 "documentListLabel":string;
 "formColumnLabel":string;
-"statusColumnLabel":string;
+"actionColumnLabel":string;
 "selfSignatoryTitle":string;
 "otherSignatoryTitle":string;
 "selfSignatorySubtext":string;
@@ -21216,6 +21392,7 @@ export interface CompanyDocumentList{
 "notSigned":string;
 "documentListError":string;
 "emptyTableTitle":string;
+"continueCta":string;
 };
 export interface CompanyFederalTaxes{
 "pageTitle":string;
@@ -21251,10 +21428,114 @@ export interface CompanyIndustry{
 "placeholder":string;
 "submitCta":string;
 };
+export interface CompanyLocations{
+"locationsListTitle":string;
+"locationsListDescription":string;
+"locationListLabel":string;
+"locationListCol1":string;
+"locationListCol2":string;
+"filingAddress":string;
+"mailingAddress":string;
+"hamburgerTitle":string;
+"editCta":string;
+"emptyTableTitle":string;
+"emptyTableDescription":string;
+"addLocationCta":string;
+"addFirstLicationCta":string;
+"locationFormTitle":string;
+"locationFormDescription":string;
+"street1Label":string;
+"street2Label":string;
+"cityLabel":string;
+"stateLabel":string;
+"statePlaceholder":string;
+"zipLabel":string;
+"phoneNumberLabel":string;
+"addressTypeLabel":string;
+"mailingAddressLabel":string;
+"mailingAddressDescription":string;
+"filingAddressLabel":string;
+"filingAddressDescription":string;
+"saveCta":string;
+"cancelCta":string;
+"continueCta":string;
+"validations":{
+"street1":string;
+"city":string;
+"state":string;
+"zip":string;
+"phone":string;
+}
+};
 export interface CompanyPaySchedule{
+"listDescription":string;
+"listDescription2":string;
+"addAnotherPayScheduleCta":string;
+"saveAndContinueCta":string;
+"pleaseVerify":string;
+"payScheduleList":{
+"name":string;
+"actions":string;
+"active":string;
+"inactive":string;
+"edit":string;
+}
+"headings":{
+"addPaySchedule":string;
+"editPaySchedule":string;
+"pageTitle":string;
+}
+"labels":{
+"payfrequency":string;
+"frequency":string;
+"deadline":string;
+"frequencyOptions":string;
+"firstPayDate":string;
+"firstPayPeriodEndDate":string;
+"firstPayDayOfTheMonth":string;
+"lastPayDayOfTheMonth":string;
+"preview":string;
+"legend":string;
+}
+"loading":string;
+"descriptions":{
+"frequencyOptionsDescription":string;
+"anchorPayDateDescription":string;
+"anchorEndOfPayPeriodDescription":string;
+}
+"payPreview":{
 "payPeriod":string;
 "payday":string;
-"runPayrollBy":string;
+"payrollDeadline":string;
+}
+"actions":{
+"cancel":string;
+"save":string;
+}
+"frequencies":{
+"everyWeek":string;
+"everyOtherWeek":string;
+"twicePerMonth":string;
+"monthly":string;
+}
+"frequencyOptions":{
+"15thAndLast":string;
+"custom":string;
+}
+};
+export interface CompanySignatureForm{
+"signatureFormTitle":string;
+"downloadInstructions":string;
+"viewDocumentCta":string;
+"signatureLabel":string;
+"signatureDescription":string;
+"signatureError":string;
+"confirmationGroupLabel":string;
+"confirmationLabel":string;
+"confirmationError":string;
+"backCta":string;
+"submitCta":string;
+"downloadPrompt":string;
 };
 export interface EmployeeBankAccount{
 "accountNumberLabel":string;
@@ -21372,7 +21653,7 @@ export interface EmployeeDocumentSigner{
 "documentListTitle":string;
 "documentListLabel":string;
 "formColumnLabel":string;
-"statusColumnLabel":string;
+"actionColumnLabel":string;
 "continueCta":string;
 "signDocumentCta":string;
 "signDocumentComplete":string;
@@ -21384,6 +21665,7 @@ export interface EmployeeDocumentSigner{
 "signatureFieldLabel":string;
 "signatureFieldDescription":string;
 "signatureFieldError":string;
+"confirmationGroupLabel":string;
 "confirmSignatureCheckboxLabel":string;
 "confirmSignatureError":string;
 "backCta":string;
@@ -21662,7 +21944,10 @@ export interface common{
 }
 "optionalLabel":string;
 "errors":{
+"errorHeading":string;
 "globalReactError":string;
+"resetGlobalError":string;
+"unknownError":string;
 "missingParamsOrContext":string;
 "unhandledEvent":string;
 "unknownEventType":string;
@@ -21794,7 +22079,7 @@ export interface common{
 
     interface CustomTypeOptions {
         defaultNS: 'common';
-        resources: { 'Company.AddBank': CompanyAddBank, 'Company.Addresses': CompanyAddresses, 'Company.AssignSignatory': CompanyAssignSignatory, 'Company.DocumentList': CompanyDocumentList, 'Company.FederalTaxes': CompanyFederalTaxes, 'Company.Industry': CompanyIndustry, 'Company.PaySchedule': CompanyPaySchedule, 'Employee.BankAccount': EmployeeBankAccount, 'Employee.Compensation': EmployeeCompensation, 'Employee.Deductions': EmployeeDeductions, 'Employee.DocumentSigner': EmployeeDocumentSigner, '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,  }
+        resources: { 'Company.AddBank': CompanyAddBank, 'Company.Addresses': CompanyAddresses, 'Company.AssignSignatory': CompanyAssignSignatory, 'Company.DocumentList': CompanyDocumentList, 'Company.FederalTaxes': CompanyFederalTaxes, 'Company.Industry': CompanyIndustry, 'Company.Locations': CompanyLocations, 'Company.PaySchedule': CompanyPaySchedule, 'Company.SignatureForm': CompanySignatureForm, 'Employee.BankAccount': EmployeeBankAccount, 'Employee.Compensation': EmployeeCompensation, 'Employee.Deductions': EmployeeDeductions, 'Employee.DocumentSigner': EmployeeDocumentSigner, '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' {