@remoteoss/remote-flows 1.55.0 → 1.56.0

package/dist/types.gen-ClcXnZQX.d.ts

@@ -1,3676 +0,0 @@
-/**
- * CostCalculatorEstimateCSVResponse
- */
-type CostCalculatorEstimateCsvResponse = {
-    data: {
-        content: GenericFile;
-    };
-};
-/**
- * CreatePreOnboardingDocumentResponse
- *
- * Returns the slug of the found-or-created pre-onboarding document.
- */
-type CreatePreOnboardingDocumentResponse = {
-    data: {
-        pre_onboarding_document: {
-            id: UuidSlug;
-        };
-    };
-};
-/**
- * DateTime
- *
- * UTC date time in YYYY-MM-DDTHH:mm:ss format
- */
-type DateTime = string;
-/**
- * MinimalRegion
- */
-type MinimalRegion = {
-    child_regions?: Array<MinimalRegion>;
-    code?: string | null;
-    name: string;
-    slug: string;
-    status?: RegionStatus;
-};
-/**
- * TerminationOffboarding
- *
- * An offboarding request initiated by the employer to terminate an employment. Includes termination details, risk assessment, and status tracking through Remote's review process.
- */
-type TerminationOffboarding = {
-    /**
-     * Additional comments or context about the termination provided by the employer.
-     */
-    additional_comments: string | null;
-    /**
-     * Whether the employer agreed with the employee's PTO balance at the time of the termination request.
-     */
-    agrees_to_pto_amount?: boolean;
-    /**
-     * Whether this offboarding request is confidential. Confidential requests are only visible to the user who authorized the token or integration; non-confidential requests are visible to all company admins.
-     */
-    confidential: boolean;
-    /**
-     * Details about whether and when the employee was informed about their termination. Only present if the employee was informed before the offboarding request was submitted.
-     */
-    employee_awareness?: {
-        /**
-         * The date when the employee was told about the termination.
-         */
-        date?: string | null;
-        /**
-         * Notes about how the termination was communicated to the employee.
-         */
-        note?: string | null;
-    };
-    /**
-     * The unique identifier (UUID) of the employment being terminated.
-     */
-    employment_id: string;
-    /**
-     * The unique identifier (UUID) of the offboarding request.
-     */
-    id: string;
-    /**
-     * The unique identifier (UUID) of the offboarding record. When present, this can be used
-     * to query `GET /api/eor/v2/offboardings/{id}` for the v2 offboarding shape.
-     *
-     */
-    offboarding_id?: string | null;
-    /**
-     * Remote will use this email address for post-termination communication.
-     * If it is not provided, this field will be derived from the employment record. Therefore, it is important to ensure that it is not a company email.
-     *
-     */
-    personal_email?: string;
-    /**
-     * The employer's proposed termination date. The actual termination date may differ based on local labor laws and notice period requirements.
-     */
-    proposed_termination_date: string;
-    /**
-     * A detailed description of the circumstances leading to the termination.
-     */
-    reason_description: string;
-    /**
-     * The unique identifier (UUID) of the company admin who submitted the termination request.
-     */
-    requested_by: string;
-    /**
-     * Reasons that may increase the legal risk of this termination (e.g., the employee is pregnant, on family leave, etc.).
-     */
-    risk_assessment_reasons: Array<'caring_responsibilities' | 'disabled_or_health_condition' | 'family_leave' | 'member_of_union_or_works_council' | 'none_of_these' | 'pregnant_or_breastfeeding' | 'reported_concerns_with_workplace' | 'requested_medical_or_family_leave' | 'sick_leave'>;
-    /**
-     * The current status of the offboarding request.
-     *
-     * - `submitted`: The request has been submitted and is awaiting review by Remote.
-     * - `in_review`: Remote is reviewing the request for legal compliance and risks.
-     * - `done`: The offboarding has been completed and the employment is terminated.
-     * - `canceled`: The offboarding request was canceled before completion.
-     *
-     */
-    status: 'submitted' | 'in_review' | 'done' | 'canceled';
-    /**
-     * The timestamp when the offboarding request was submitted.
-     */
-    submitted_at: string;
-    /**
-     * Most updated termination date for the offboarding. This date is subject to change through the offboarding process even after it is finalized.
-     */
-    termination_date: string | null;
-    /**
-     * The reason for the termination, as submitted by the employer.
-     */
-    termination_reason: 'cancellation_before_start_date' | 'compliance_issue' | 'conversion_to_contractor' | 'dissatisfaction_with_remote_service' | 'end_of_fixed_term_contract_compliance_issue' | 'end_of_fixed_term_contract_incapacity_to_perform_inherent_duties' | 'end_of_fixed_term_contract_local_regulations_max_term_reached' | 'end_of_fixed_term_contract_misconduct' | 'end_of_fixed_term_contract_operational_reasons' | 'end_of_fixed_term_contract_other' | 'end_of_fixed_term_contract_performance' | 'end_of_fixed_term_contract_redundancy' | 'end_of_fixed_term_contract_values' | 'gross_misconduct' | 'incapacity_to_perform_inherent_duties' | 'job_abandonment' | 'mutual_agreement' | 'other' | 'performance' | 'values' | 'workforce_reduction';
-    /**
-     * The type of offboarding. Always `"termination"` for employer-initiated terminations.
-     */
-    type: 'termination';
-    /**
-     * Whether the employer believes the employee is likely to challenge their termination.
-     */
-    will_challenge_termination: boolean;
-    /**
-     * Additional details about why the employee may challenge the termination, if applicable.
-     */
-    will_challenge_termination_description?: string;
-};
-/**
- * Unified.Employment.UpsertBenefitOffersRequest
- *
- * Upsert benefit offers request. As its properties may vary depending on the employment,
- * you must query the [Show benefit offers schema](#tag/benefits/operation/get_show_benefit_offer) endpoint
- * passing the employment id
- */
-type UnifiedEmploymentUpsertBenefitOffersRequest = {
-    [key: string]: unknown;
-};
-/**
- * ConvertCurrency
- *
- * The response from the currency converter
- */
-type ConvertCurrency = {
-    /**
-     * The exchange rate used to convert the amount
-     */
-    exchange_rate: number;
-    /**
-     * The amount in cents in the source currency
-     */
-    source_amount: number;
-    source_currency: CurrencyDefinition;
-    /**
-     * The amount in cents in the target currency
-     */
-    target_amount: number;
-    target_currency: CurrencyDefinition;
-};
-/**
- * SignatoryType
- *
- * The role of this signatory in the contract signing process
- */
-type SignatoryType = 'company' | 'employee' | 'admin' | 'external' | 'unknown';
-/**
- * SignatoryStatus
- *
- * Current signing status of this signatory
- */
-type SignatoryStatus = 'pending' | 'signed' | 'unassigned';
-/**
- * ResignationOrTerminationOffboarding
- */
-type ResignationOrTerminationOffboarding = ResignationOffboarding | TerminationOffboarding;
-/**
- * CycleFrequency
- *
- * The frequency at which the payroll calendar is run.
- */
-type CycleFrequency = 'monthly' | 'bi_monthly' | 'bi_weekly' | 'weekly';
-/**
- * MinimalCountry
- *
- * A lightweight country representation with basic identification fields.
- */
-type MinimalCountry = {
-    /**
-     * The ISO 3166-1 alpha-2 country code (e.g., "PT", "US", "GB").
-     */
-    alpha_2_code: string;
-    /**
-     * The ISO 3166-1 alpha-3 country code (e.g., "PRT", "USA", "GBR"). This is the primary code used across the Remote API.
-     */
-    code: string;
-    /**
-     * Feature flags indicating which Remote services are available in this country.
-     */
-    features?: Array<string>;
-    /**
-     * The country's full English name.
-     */
-    name: string;
-    /**
-     * A unique URL-friendly identifier for the country.
-     */
-    slug: string;
-};
-/**
- * Employment
- *
- * Complete information of an employment, including all onboarding task statuses, country-specific form data (address, contract, administrative, etc.), and contractor-specific settings where applicable.
- */
-type Employment = {
-    /**
-     * Personal details information. Its properties may vary depending on the country.
-     */
-    personal_details: {
-        [key: string]: unknown;
-    };
-    short_id?: ShortId;
-    /**
-     * Name of related department, if any. Otherwise, null.
-     */
-    department?: string | null;
-    /**
-     * The email address of the employee's manager. Null if no manager is assigned.
-     */
-    manager_email: string | null;
-    provisional_start_date?: ProvisionalStartDate;
-    /**
-     * Home address information. Its properties may vary depending on the country.
-     */
-    address_details: {
-        [key: string]: unknown;
-    };
-    pricing_plan_details: PricingPlanDetails;
-    /**
-     * The employee's full name.
-     */
-    full_name: string;
-    /**
-     * A reference code for the employment record in the calling integration's own system.
-     * Private to that integration — no other integration can read or overwrite it.
-     * Null when the integration has not set one.
-     *
-     */
-    partner_external_id?: string | null;
-    /**
-     * For the employment types `contractor`, `global_payroll_employee` and `direct_employee`, only [List employments](#operation/get_index_employment) and
-     * [Show employment](#operation/get_show_employment) operations are available.
-     *
-     */
-    type: 'employee' | 'contractor' | 'direct_employee' | 'global_payroll_employee';
-    /**
-     * Contractor-specific settings. Only present for contractor employments.
-     */
-    contractor_settings?: {
-        /**
-         * Whether the contractor requires work confirmation before submitting invoices.
-         */
-        requires_work_confirmation?: boolean;
-    } | null;
-    employment_lifecycle_stage: EmploymentLifecycleStage;
-    /**
-     * Administrative information. Its properties may vary depending on the country.
-     */
-    administrative_details: {
-        [key: string]: unknown;
-    };
-    /**
-     * Type of contractor product. Only present for contractor employments. 'standard' for Contractor Standard, 'cor' for Contractor of Record, 'plus' for Contractor Plus.
-     */
-    contractor_type?: 'standard' | 'cor' | 'plus';
-    /**
-     * Contractor compensation rate details. Only present for contractor employments when rate is configured.
-     */
-    contractor_rate?: {
-        amount?: {
-            /**
-             * Rate amount as decimal
-             */
-            amount?: number;
-            currency?: {
-                /**
-                 * Currency code (e.g., USD, EUR)
-                 */
-                code?: string;
-            };
-        };
-        /**
-         * Payment frequency cadence
-         */
-        pay_frequency?: 'weekly' | 'bi_weekly' | 'semi_monthly' | 'monthly';
-        /**
-         * Unique identifier for the contractor rate
-         */
-        slug?: string;
-        /**
-         * Rate type indicating billing frequency
-         */
-        type?: 'hourly' | 'daily' | 'weekly' | 'monthly' | 'one_off';
-    } | null;
-    /**
-     * The unique identifier (UUID) of the company this employment belongs to.
-     */
-    company_id: string;
-    /**
-     * The planned service end date for contractor of record (COR) employments.
-     *
-     * For signed COR contractors, this date is stored on the contract record (not in `contract_details`).
-     * It is `null` for employee employments or unsigned contractor agreements.
-     *
-     * Date format is ISO 8601 without the time component (e.g. "2024-12-31").
-     *
-     */
-    expiration_date?: string | null;
-    /**
-     * Work address information. Its properties may vary depending on the country.
-     */
-    work_address_details: {
-        [key: string]: unknown;
-    };
-    /**
-     * BillToLegalEntityID
-     *
-     * The unique identifier (UUID) of the legal entity that is billed for this employment.
-     */
-    bill_to_legal_entity_id?: string | null;
-    /**
-     * The employee's work email address, typically provided by the employer.
-     */
-    work_email: string;
-    status: EmploymentStatus;
-    /**
-     * The timestamp when this employment record was last updated.
-     */
-    updated_at: string;
-    /**
-     * Employment basic information. Its properties may vary depending on the country.
-     *
-     * When present, `login_email` indicates which address the employee logs in with:
-     * `"personal"` or `"work"`.
-     *
-     */
-    basic_information?: {
-        [key: string]: unknown;
-    };
-    /**
-     * The employee's job title. May be null if not yet set.
-     */
-    job_title: string | null;
-    /**
-     * The unique identifier (UUID) of the employment.
-     */
-    id: string;
-    /**
-     * The date when the employee's probation period ends, if applicable.
-     */
-    probation_period_end_date?: string;
-    /**
-     * DepartmentID
-     *
-     * Unique ID of related department, if any. Otherwise, null.
-     */
-    department_id?: string | null;
-    /**
-     * The full name of the employee's manager.
-     */
-    manager?: string;
-    /**
-     * The email address the employee uses to log in to the Remote platform.
-     */
-    login_email: string;
-    /**
-     * A unique reference code for the employment record in a non-Remote system. While uniqueness is recommended, it is not strictly enforced within Remote's system.
-     */
-    external_id?: string | null;
-    /**
-     * For the employment models `peo` and `global_payroll`, only [List employments](#operation/get_index_employment) and
-     * [Show employment](#operation/get_show_employment) operations are available.
-     *
-     */
-    employment_model: 'global_payroll' | 'peo' | 'eor';
-    /**
-     * The employee's personal email address, used for account-related communications.
-     */
-    personal_email: string;
-    country: NullableCountry;
-    user_status?: UserStatus;
-    seniority_date?: EmploymentSeniorityDate;
-    bank_account_details: Array<{
-        [key: string]: unknown;
-    }>;
-    /**
-     * Documents associated with this employment (e.g., contracts, tax forms, identity documents).
-     */
-    files: Array<File>;
-    /**
-     * The unique identifier (UUID) of the currently active contract for this employment.
-     */
-    active_contract_id?: string;
-    /**
-     * EngagedByLegalEntityID
-     *
-     * The unique identifier (UUID) of the legal entity that engaged this employment.
-     */
-    engaged_by_legal_entity_id?: string | null;
-    /**
-     * Billing address information. Its properties may vary depending on the country.
-     */
-    billing_address_details: {
-        [key: string]: unknown;
-    };
-    onboarding_tasks: OnboardingTasks;
-    /**
-     * Contract information. Its properties may vary depending on the country.
-     */
-    contract_details: {
-        [key: string]: unknown;
-    };
-    /**
-     * Emergency contact information. Its properties may vary depending on the country.
-     */
-    emergency_contact_details: {
-        [key: string]: unknown;
-    };
-    /**
-     * Whether this employment can still be cancelled during the onboarding process. Once the employment is active, this will be false.
-     */
-    eligible_for_onboarding_cancellation: boolean;
-    /**
-     * The employment ID of the employee's manager on Remote, if the manager is also managed through Remote. Null otherwise.
-     */
-    manager_employment_id: string | null;
-    /**
-     * The timestamp when this employment record was created.
-     */
-    created_at: string;
-};
-/**
- * CurrencyCode
- *
- * Currency code of the SWIFT fee. Only present when processing_fee is set.
- */
-type CurrencyCode = string | null;
-/**
- * Step
- */
-type Step = {
-    completed_at?: string | null;
-    description?: string | null;
-    /**
-     * Unique identifier for this step instance
-     */
-    id: string;
-    /**
-     * Human-readable step name
-     */
-    label: string;
-    started_at?: string | null;
-    /**
-     * Step status
-     */
-    status: 'not_started' | 'in_progress' | 'completed' | 'failed';
-    /**
-     * Ordered list of substeps for this step
-     */
-    sub_steps: Array<SubStep>;
-    /**
-     * Step type identifier
-     */
-    type: string;
-};
-/**
- * CreatePreOnboardingAcknowledgementResponse
- *
- * Returns the slug of the recorded pre-onboarding acknowledgement.
- */
-type CreatePreOnboardingAcknowledgementResponse = {
-    data: {
-        pre_onboarding_acknowledgement: {
-            id: UuidSlug;
-        };
-    };
-};
-/**
- * CostCalculatorEstimatePDFResponse
- */
-type CostCalculatorEstimatePdfResponse = {
-    data: {
-        content: GenericFile;
-    };
-};
-/**
- * ActionError
- */
-type ActionError = {
-    /**
-     * The action that lead to the error message.
-     */
-    action: string;
-    /**
-     * An error code that describes the nature of the error.
-     */
-    code: string;
-    /**
-     * A developer friendly error message that gives details on what the error was and how it may be remedied.
-     */
-    message: string;
-};
-/**
- * EmploymentShowResponse
- *
- * Response containing the full employment record, including the termination date if the employment has an active offboarding.
- */
-type EmploymentShowResponse = {
-    data: {
-        employment?: Employment & {
-            /**
-             * Most updated termination date for the offboarding. This date is subject to change through the offboarding process even after it is finalized.
-             */
-            termination_date?: string | null;
-        };
-    };
-};
-/**
- * ConflictErrorResponse
- */
-type ConflictErrorResponse = ValidationError | MessageResponse;
-/**
- * CostCalculatorDiscountResponse
- *
- * The discount applied to a cost estimate, showing the annual and monthly savings.
- */
-type CostCalculatorDiscountResponse = {
-    /**
-     * The annual discount amount in cents.
-     */
-    annual_amount: number;
-    /**
-     * The monthly discount amount in cents.
-     */
-    monthly_amount: number;
-    /**
-     * The number of months the discount applies to.
-     */
-    months: number;
-    /**
-     * A human-readable label for the discount.
-     */
-    text: string;
-};
-/**
- * EmploymentBasicResponse
- *
- * A lightweight employment representation returned after creation. Contains basic identification, country, and status fields but not the full onboarding details or country-specific form data.
- */
-type EmploymentBasicResponse = {
-    /**
-     * Employment basic information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `basic_information` as path parameters.
-     *
-     * When present, `login_email` indicates which address the employee logs in with: `"personal"` or
-     * `"work"`.
-     */
-    basic_information?: {
-        [key: string]: unknown;
-    };
-    /**
-     * The unique identifier (UUID) of the company.
-     */
-    company_id?: string;
-    /**
-     * The ISO 3166-1 3-letter country code for this employment.
-     */
-    country_code?: string;
-    /**
-     * When this employment was created.
-     */
-    created_at?: string;
-    employment_lifecycle_stage?: EmploymentLifecycleStage;
-    /**
-     * The employee's full name.
-     */
-    full_name?: string;
-    id?: UuidSlug;
-    /**
-     * The employee's job title. May be null if not yet set.
-     */
-    job_title?: string | null;
-    /**
-     * The email the employee uses to log in to Remote.
-     */
-    login_email?: string;
-    /**
-     * A reference code for the employment record in the calling integration's own system.
-     * Private to that integration — no other integration can read or overwrite it.
-     * Null when the integration has not set one.
-     *
-     */
-    partner_external_id?: string | null;
-    /**
-     * The employee's personal email address.
-     */
-    personal_email?: string;
-    /**
-     * Required for employees, optional for contractors
-     */
-    provisional_start_date?: string;
-    /**
-     * The type of employment.
-     */
-    type?: 'employee' | 'contractor';
-    /**
-     * When this employment was last updated.
-     */
-    updated_at?: string;
-};
-/**
- * NullableDateTime
- *
- * Optional UTC date time in YYYY-MM-DDTHH:mm:ss format
- */
-type NullableDateTime = string | null;
-/**
- * ClientCredentialsResponse
- */
-type ClientCredentialsResponse = BaseTokenResponse;
-/**
- * AuthorizationCodeResponse
- */
-type AuthorizationCodeResponse = BaseTokenResponse & {
-    /**
-     * The ID of the connected company.
-     */
-    company_id?: string;
-    /**
-     * The refresh token. This token must be stored and used for issuing new access tokens for managing the company's resources.
-     */
-    refresh_token?: string;
-    /**
-     * The ID of the user who connected the company.
-     */
-    user_id?: string;
-};
-/**
- * CompanyAlreadyExistsErrorResponse
- *
- * Error returned when a company with matching criteria already exists
- */
-type CompanyAlreadyExistsErrorResponse = {
-    code?: string;
-    message?: string;
-    resource_id?: string;
-    resource_type?: string;
-};
-/**
- * CostCalculatorEmploymentParam
- *
- * Parameters for a single employment to include in the cost estimate. Provide the region and salary (or total cost) — the calculator will compute all employer costs, contributions, and benefits.
- */
-type CostCalculatorEmploymentParam = {
-    /**
-     * The employee's age. Used in some countries to calculate age-dependent benefits or contributions.
-     */
-    age?: number;
-    /**
-     * The annual gross salary in the region's local currency, in cents. Provide this OR `annual_total_cost`, not both.
-     */
-    annual_gross_salary?: number;
-    /**
-     * The annual gross salary in the employer's preferred currency, in cents. Used when you want to specify salary in a different currency than the region's.
-     */
-    annual_gross_salary_in_employer_currency?: number;
-    /**
-     * The target total annual cost (salary + all employer costs) in the region's local currency, in cents. The calculator will derive the gross salary. Provide this OR `annual_gross_salary`, not both.
-     */
-    annual_total_cost?: number;
-    /**
-     * The target total annual cost in the employer's preferred currency, in cents.
-     */
-    annual_total_cost_in_employer_currency?: number;
-    /**
-     * Specific benefit selections to include in the estimate.
-     */
-    benefits?: Array<CostCalculatorBenefitParam>;
-    discount?: CostCalculatorDiscount;
-    employment_term?: EmploymentTermType;
-    /**
-     * The unique identifier (slug) of the region/country for this employment. Required.
-     */
-    region_slug: string;
-    /**
-     * A custom exchange rate from the regional currency to the employer currency. If not provided, the current market rate is used.
-     */
-    regional_to_employer_exchange_rate?: string;
-    /**
-     * An optional label for this employment in the estimate (e.g., the job title or role name).
-     */
-    title?: string;
-};
-/**
- * UnlimitedDaysandHoursResponse
- */
-type UnlimitedDaysandHoursResponse = {
-    type: 'unlimited';
-};
-/**
- * LimitedDaysandHoursResponse
- *
- * Includes requested timeoffs (not approved) in the past or in the future.
- */
-type LimitedDaysandHoursResponse = {
-    days: number;
-    hours: number;
-    type: 'limited';
-};
-/**
- * Country
- *
- * A supported country on Remote
- */
-type Country = {
-    /**
-     * The ISO 3166-1 alpha-2 country code (e.g., "PT").
-     */
-    alpha_2_code: string;
-    /**
-     * The ISO 3166-1 alpha-3 country code (e.g., "PRT"). This is the primary code used across the Remote API.
-     */
-    code: string;
-    /**
-     * Contractor product names available for this country
-     */
-    contractor_products_available?: Array<'standard' | 'plus' | 'cor'>;
-    /**
-     * Administrative subdivisions of the country (e.g., states, provinces, districts). Null if the country has no subdivisions relevant to Remote's services.
-     */
-    country_subdivisions?: Array<CountrySubdivision> | null;
-    /**
-     * Whether an Employment Agreement preview is available for this country.
-     */
-    employment_agreement_preview_available?: boolean;
-    /**
-     * Whether EOR (Employer of Record) onboarding is available in this country.
-     */
-    eor_onboarding?: boolean;
-    /**
-     * When benefit plan selections become locked for this country (e.g., "after_first_hire" means benefits cannot be changed after the first employee is hired).
-     */
-    locked_benefits?: string;
-    /**
-     * The country's full English name.
-     */
-    name: string;
-    /**
-     * The geographic region the country belongs to (e.g., "Europe", "Asia", "Americas").
-     */
-    region?: string;
-    /**
-     * The geographic subregion (e.g., "Southern Europe", "Southeast Asia"). Null for some countries.
-     */
-    subregion?: string | null;
-    /**
-     * The list of JSON schema form names available for this country (e.g., "address_details", "contract_details"). Use these with the Show form schema endpoint to get country-specific field requirements.
-     */
-    supported_json_schemas?: Array<string>;
-};
-/**
- * CreateOffboardingParams
- */
-type CreateOffboardingParams = {
-    /**
-     * The unique identifier (UUID) of the employment to be terminated.
-     */
-    employment_id: string;
-    termination_details: TerminationDetailsParams;
-    /**
-     * The type of the offboarding request. For now, only `termination` is allowed.
-     */
-    type: 'termination';
-};
-/**
- * UserStatus
- *
- * The status of the user account associated with this employment.
- *
- * - `active`: The user account is active and the user can log in.
- * - `created`: The user account has been created but not yet activated.
- * - `initiated`: The user has been invited but has not completed registration.
- * - `cancelled`: The user account was cancelled before activation.
- * - `inactive`: The user account has been deactivated (e.g., after offboarding).
- * - `deleted`: The user account has been deleted.
- *
- */
-type UserStatus = 'active' | 'created' | 'initiated' | 'cancelled' | 'inactive' | 'deleted';
-/**
- * CompanyCreationResponse
- */
-type CompanyCreationResponse = {
-    data?: CompanyResponse | CompanyWithTokensResponse;
-};
-/**
- * ContractorContractDocumentStatus
- *
- * The signing status of a contract document.
- *
- * - `draft`: The document is being prepared and has not been sent for signing.
- * - `awaiting_signatures`: The document has been sent and is waiting for one or more parties to sign.
- * - `deadline_passed`: The signing deadline passed before all required signatures were collected.
- * - `finished`: All required signatures have been collected and the contract is fully executed.
- *
- */
-type ContractorContractDocumentStatus = 'draft' | 'awaiting_signatures' | 'deadline_passed' | 'finished';
-/**
- * CostCalculatorEstimateParams
- *
- * Parameters for generating a cost estimate for one or more employments across different countries/regions.
- */
-type CostCalculatorEstimateParams = {
-    /**
-     * The company name, used for labeling in PDF/CSV exports.
-     */
-    company_name?: string;
-    /**
-     * The ISO 4217 currency code for the employer's preferred currency (e.g., "USD"). All costs will be converted to this currency.
-     */
-    employer_currency_slug: string;
-    /**
-     * One or more employments to estimate costs for.
-     */
-    employments: Array<CostCalculatorEmploymentParam>;
-    global_discount?: CostCalculatorDiscount;
-    /**
-     * Whether to include benefit costs in the estimate. Defaults to false if not provided.
-     */
-    include_benefits?: boolean;
-    /**
-     * Whether to include detailed cost breakdowns (individual contributions, benefits, etc.) in the response.
-     */
-    include_cost_breakdowns?: boolean;
-    /**
-     * Whether to include Remote's management fee in the total cost calculation.
-     */
-    include_management_fee?: boolean;
-    /**
-     * Whether to include premium benefit options in the estimate.
-     */
-    include_premium_benefits?: boolean;
-};
-/**
- * Offboarding
- *
- * A wrapper containing an offboarding record, which can be either a termination (employer-initiated) or a resignation (employee-initiated).
- */
-type Offboarding = {
-    offboarding?: ResignationOrTerminationOffboarding;
-};
-/**
- * NotFoundResponse
- *
- * Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
- */
-type NotFoundResponse = {
-    /**
-     * A message indicating which resource was not found.
-     */
-    message?: string;
-};
-/**
- * CostCalculatorEstimateResponse
- */
-type CostCalculatorEstimateResponse = {
-    data: {
-        employments?: Array<CostCalculatorEmployment>;
-    };
-};
-/**
- * SubmitEligibilityQuestionnaireRequest
- *
- * Request body for submitting an eligibility questionnaire
- */
-type SubmitEligibilityQuestionnaireRequest = {
-    /**
-     * The slug/ID of the employment
-     */
-    employment_slug: string;
-    /**
-     * Responses to the questionnaire questions
-     */
-    responses: {
-        [key: string]: string;
-    };
-    type: 'contractor_of_record';
-};
-/**
- * Timezone
- *
- * [TZ identifier](https://www.iana.org/time-zones)
- */
-type Timezone = string;
-/**
- * ResignationOffboarding
- *
- * An offboarding request initiated by the employee (a resignation). Includes the employee's proposed last working day, reason, and status tracking through Remote's process.
- */
-type ResignationOffboarding = {
-    /**
-     * Additional comments or context about the resignation.
-     */
-    additional_comments?: string | null;
-    /**
-     * Whether the employer agrees with the employee's PTO balance.
-     */
-    agrees_to_pto_amount?: boolean;
-    /**
-     * A description of how and when the employer was made aware of the resignation.
-     */
-    employer_awareness?: string;
-    /**
-     * The unique identifier (UUID) of the employment being resigned from.
-     */
-    employment_id: string;
-    /**
-     * The unique identifier (UUID) of the offboarding request.
-     */
-    id: string;
-    /**
-     * The unique identifier (UUID) of the offboarding record. When present, this can be used
-     * to query `GET /api/eor/v2/offboardings/{id}` for the v2 offboarding shape.
-     *
-     */
-    offboarding_id?: string | null;
-    /**
-     * The employee's proposed last working day. The actual last day may differ based on notice period requirements.
-     */
-    proposed_last_working_day: string;
-    /**
-     * A detailed description of the employee's reason for resigning.
-     */
-    reason_description?: string;
-    /**
-     * The unique identifier (UUID) of the employee who submitted the resignation.
-     */
-    requested_by: string;
-    /**
-     * The reason the employee gave for their resignation.
-     */
-    resignation_reason: 'cancellation_before_start_date' | 'company_culture_or_values' | 'conversion_to_contractor' | 'conversion_to_global_payroll' | 'conversion_to_peo' | 'dissatisfaction_with_remote_service' | 'incapacity_to_perform_inherent_duties' | 'infrastructure_challenges' | 'lack_of_recognition' | 'leadership' | 'mutual_agreement' | 'other' | 'other_job_opportunity' | 'personal_reasons' | 'position_does_not_meet_expectations' | 'relationship_with_coworkers' | 'relocation_from_entity_to_entity_by_employee' | 'relocation_leaving_remote' | 'remuneration_and_benefits' | 'retirement' | 'transfer_and_relocation_new_customer_and_new_country' | 'transfer_between_remote_customer' | 'transfer_from_remote_to_customer' | 'transfer_from_remote_to_other_eor';
-    /**
-     * The current status of the offboarding request.
-     *
-     * - `submitted`: The resignation has been submitted and is awaiting review.
-     * - `in_review`: Remote is processing the resignation.
-     * - `done`: The offboarding has been completed.
-     * - `canceled`: The resignation was withdrawn or canceled.
-     *
-     */
-    status: 'submitted' | 'in_review' | 'done' | 'canceled';
-    /**
-     * The timestamp when the resignation was submitted.
-     */
-    submitted_at: string;
-    /**
-     * Most updated termination date for the offboarding. This date is subject to change through the offboarding process even after it is finalized.
-     */
-    termination_date: string | null;
-    /**
-     * The type of offboarding. Always `"resignation"` for employee-initiated resignations.
-     */
-    type: 'resignation';
-};
-/**
- * ContractorInvoiceSchedule
- *
- * Contractor Invoice Schedule.
- */
-type ContractorInvoiceSchedule = {
-    currency: CurrencyCode;
-    custom_days?: ContractorInvoiceScheduleCustomDays;
-    /**
-     * Employment identifier.
-     */
-    employment_id: string;
-    /**
-     * ScheduleID
-     *
-     * Schedule identifier.
-     */
-    id: string;
-    /**
-     * List of invoice items that composes the overall invoice amount.
-     */
-    items: Array<ContractorInvoiceScheduleItem>;
-    /**
-     * Date time which next invoice will be generated.
-     */
-    next_invoice_at?: string | null;
-    /**
-     * Custom defined note.
-     */
-    note?: string | null;
-    /**
-     * Count of remaining invoices that should be generated.
-     */
-    nr_occurrences?: number | null;
-    /**
-     * Invoice identifier.
-     */
-    number?: string | null;
-    periodicity: ContractorInvoiceSchedulePeriodicity;
-    /**
-     * Date which invoices generation will start.
-     */
-    start_date: string;
-    status: ContractorInvoiceScheduleStatus;
-    /**
-     * Overall amount that is calculated by summing all invoice items.
-     */
-    total_amount: number;
-};
-/**
- * File
- *
- * A file associated with an employment, such as a contract, tax document, or identity document.
- */
-type File = {
-    /**
-     * The unique identifier (UUID) of the file.
-     */
-    id: string;
-    inserted_at: DateTimeIso8601;
-    /**
-     * The file name including extension (e.g., "id.pdf", "contract.pdf").
-     */
-    name: string;
-    /**
-     * A more specific classification of the file within its type (e.g., "personal_id" within type "id", or "ir_35" within type "contract"). Null if no sub-type applies.
-     */
-    sub_type?: string | null;
-    /**
-     * The broad category of the file (e.g., "id", "contract", "tax_document").
-     */
-    type: string;
-};
-/**
- * OffboardingResponse
- *
- * Response containing a single offboarding record with full details.
- */
-type OffboardingResponse = {
-    data?: Offboarding;
-};
-/**
- * ShortId
- *
- * Unique short identifier for the employment, automatically generated and visible in select areas of the Remote platform. Not intended as a replacement for the employment `id` field.
- */
-type ShortId = string;
-/**
- * NullableApproverId
- *
- * The field matches the `id` of a user in the
- * Remote Platform that has permission to approve time off
- * requests. [Available users][] can be found fetching
- * the [List Company Manager][] endpoint.
- *
- * [Available users]: https://support.remote.com/hc/en-us/articles/360054668651-Approving-Declining-time-off-requests#h_01G0014GZKZ3EMN6P7C99HAK55
- * [List Company Manager]: https://gateway.remote.com/v1/docs/openapi.html#tag/Company-Managers
- *
- */
-type NullableApproverId = string | null;
-/**
- * EmploymentFullParams
- *
- * Description of the basic required and onboarding tasks params to create an employment.
- * You do not need to include all onboarding tasks when creating or updating an employment.
- *
- */
-type EmploymentFullParams = {
-    /**
-     * Home address information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `address_details` as path parameters.
-     */
-    address_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Administrative information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `administrative_details` as path parameters.
-     */
-    administrative_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Bank account information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `bank_account_details` as path parameters.
-     */
-    bank_account_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Employment basic information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `employment_basic_information` as path parameters.
-     */
-    basic_information?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Billing address information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `billing_address_details` as path parameters.
-     */
-    billing_address_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * The unique identifier (UUID) of the company. Optional when updating.
-     */
-    company_id?: string;
-    /**
-     * Contract information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `contract_details` as path parameters.
-     */
-    contract_details?: {
-        [key: string]: unknown;
-    };
-    country?: Country;
-    /**
-     * The ISO 3166-1 3-letter country code for this employment.
-     */
-    country_code?: string;
-    /**
-     * The department of the employment. The department must belong to the same company as the employment.
-     * When set to `null`, the employment will be unassigned from a department.
-     *
-     */
-    department_id?: string | null;
-    /**
-     * Emergency contact information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `emergency_contact_details` as path parameters.
-     */
-    emergency_contact_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * A unique reference code for the employment record in a non-Remote system. This optional field links to external data sources. If not provided, it defaults to `null`. While uniqueness is recommended, it is not strictly enforced within Remote's system.
-     */
-    external_id?: string;
-    /**
-     * The user id of the manager, who should have an `admin`, `owner` or `people_manager` role.
-     * You can find these users by querying the [Company Managers endpoint](#operation/get_index_company_manager).
-     * **Update of this field is only available for active employments.**
-     *
-     */
-    manager_id?: string;
-    /**
-     * A reference code for the employment record in the calling integration's own system.
-     * Private to that integration — no other integration can read or overwrite it.
-     * Omit the field to leave the value unchanged; send `null` to clear it. Surrounding
-     * whitespace is trimmed off. It can be set at any employment status, and the same
-     * value may be used on several employments (for example a rehire).
-     *
-     */
-    partner_external_id?: string | null;
-    /**
-     * Personal details information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `personal_details` as path parameters.
-     */
-    personal_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Pricing plan details information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `pricing_plan_details` as path parameters.
-     */
-    pricing_plan_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * If not provided, it will default to `employee`.
-     */
-    type?: 'employee' | 'contractor';
-    /**
-     * The work email of the employment.
-     */
-    work_email?: string;
-};
-/**
- * OffboardingFile
- */
-type OffboardingFile = {
-    /**
-     * The content in base64 encoding
-     */
-    content: Blob | File;
-    /**
-     * The file name
-     */
-    name: string;
-};
-/**
- * RefreshTokenResponse
- */
-type RefreshTokenResponse = BaseTokenResponse & {
-    /**
-     * The refresh token
-     */
-    refresh_token?: string;
-};
-/**
- * UnprocessableEntityResponse
- */
-type UnprocessableEntityResponse = {
-    errors: {
-        [key: string]: unknown;
-    };
-} | {
-    message: string | ParameterError | Array<ParameterError> | ActionError | Array<ActionError>;
-};
-/**
- * EmploymentTermType
- */
-type EmploymentTermType = 'fixed' | 'indefinite';
-/**
- * ListContractorInvoiceSchedulesResponse
- *
- * Paginated response schema listing all Contractor Invoice Schedules.
- */
-type ListContractorInvoiceSchedulesResponse = {
-    data?: {
-        contractor_invoice_schedules?: Array<ContractorInvoiceSchedule>;
-        /**
-         * The current page among all of the total_pages
-         */
-        current_page?: number;
-        /**
-         * The total number of records in the result
-         */
-        total_count?: number;
-        /**
-         * The total number of pages the user can go through
-         */
-        total_pages?: number;
-    };
-};
-/**
- * Currency
- *
- * The type of money in general use in a particular country
- */
-type Currency = {
-    code: string;
-    name?: string;
-    slug: string;
-    symbol: string;
-};
-/**
- * PayrollCalendarEOR
- */
-type PayrollCalendarEor = {
-    country: Country;
-    cycle_frequency: CycleFrequency;
-    cycles: Array<Cycle>;
-    id: string;
-};
-/**
- * EmploymentSeniorityDate
- *
- * The date the employee first started working for your company. If you don’t include a seniority date,
- * the employee’s start date with Remote will be deemed as the start of the employee’s seniority.
- *
- * **Example**: Your employee started working for your company on Feb 1, 2022.
- * On Aug 1, 2022, you transferred the employee to Remote and started managing them on the platform.
- * Feb 1, 2022 would be their seniority date. Aug 1, 2022 would be their starting date.
- *
- */
-type EmploymentSeniorityDate = string;
-/**
- * RegionStatus
- */
-type RegionStatus = 'active' | 'inactive';
-/**
- * CostCalculatorCost
- *
- * A single cost line item within a cost breakdown (e.g., a specific employer contribution, benefit, or statutory payment).
- */
-type CostCalculatorCost = {
-    /**
-     * The cost amount in cents.
-     */
-    amount: number;
-    /**
-     * A human-readable explanation of how this cost is calculated or what it covers.
-     */
-    description: string | null;
-    /**
-     * The name of this cost item (e.g., "Health Insurance", "Social Security").
-     */
-    name: string;
-    /**
-     * The ID of the related help article, if available.
-     */
-    zendesk_article_id: string | null;
-    /**
-     * A link to a help article with more information about this cost, if available.
-     */
-    zendesk_article_url: string | null;
-};
-/**
- * OAuth2Tokens
- */
-type OAuth2Tokens = AuthorizationCodeResponse | ClientCredentialsResponse | RefreshTokenResponse;
-/**
- * CostCalculatorCosts
- */
-type CostCalculatorCosts = {
-    /**
-     * The list of all annual benefit costs
-     */
-    annual_benefits_breakdown?: Array<CostCalculatorCost>;
-    /**
-     * The annual benefits total that a company must pay for this employment
-     */
-    annual_benefits_total?: number;
-    /**
-     * The list of all annual employer contribution costs
-     */
-    annual_contributions_breakdown?: Array<CostCalculatorCost>;
-    /**
-     * The annual contributions that a company must pay for this employment
-     */
-    annual_contributions_total: number;
-    /**
-     * The annual gross salary that the employee is going to earn
-     */
-    annual_gross_salary: number;
-    /**
-     * The annual indirect tax that a company must pay for this employment
-     */
-    annual_indirect_tax?: number;
-    /**
-     * The annual management fees
-     */
-    annual_management_fee?: number;
-    /**
-     * The annual gross salary + annual contributions + annual fee (monthly fee * 12) + extra statutory payments if applicable
-     */
-    annual_total: number;
-    currency: Currency;
-    discount?: CostCalculatorDiscountResponse;
-    /**
-     * The list of all annual extra statutory payment costs
-     */
-    extra_statutory_payments_breakdown?: Array<CostCalculatorCost>;
-    /**
-     * 13th month salary, this happens for countries such as Philippines
-     */
-    extra_statutory_payments_total: number;
-    /**
-     * The list of all annual fringe benefits tax costs
-     */
-    fringe_benefits_tax_breakdown?: Array<CostCalculatorCost>;
-    /**
-     * Estimated tax on employer-paid benefit premiums (e.g. New Zealand FBT)
-     */
-    fringe_benefits_tax_total?: number;
-    /**
-     * The list of all monthly benefit costs
-     */
-    monthly_benefits_breakdown?: Array<CostCalculatorCost>;
-    /**
-     * The benefits total that the company pays monthly
-     */
-    monthly_benefits_total?: number;
-    /**
-     * The list of all monthly employer contribution costs
-     */
-    monthly_contributions_breakdown?: Array<CostCalculatorCost>;
-    /**
-     * The contributions that the company pays monthly
-     */
-    monthly_contributions_total: number;
-    /**
-     * The list of all monthly fringe benefits tax costs
-     */
-    monthly_fringe_benefits_tax_breakdown?: Array<CostCalculatorCost>;
-    /**
-     * Monthly estimated tax on employer-paid benefit premiums (e.g. New Zealand FBT)
-     */
-    monthly_fringe_benefits_tax_total?: number;
-    /**
-     * The gross monthly salary for the Employee
-     */
-    monthly_gross_salary: number;
-    /**
-     * The monthly indirect tax that a company must pay for this employment
-     */
-    monthly_indirect_tax?: number;
-    /**
-     * The monthly management fees
-     */
-    monthly_management_fee?: number;
-    /**
-     * Monthly gross salary + monthly contributions  (doesn't include fee)
-     */
-    monthly_tce: number;
-    /**
-     * Monthly gross salary + monthly contributions + monthly fee
-     */
-    monthly_total: number;
-};
-/**
- * Product
- *
- * A Remote product offering (e.g., EOR, Contractor Management) with its tier and billing frequency.
- */
-type Product = {
-    /**
-     * A description of the product.
-     */
-    description?: string;
-    /**
-     * Features included in this product tier.
-     */
-    features?: Array<string>;
-    /**
-     * The billing frequency (e.g., "monthly", "annually").
-     */
-    frequency: string;
-    /**
-     * A unique machine-readable identifier for this product.
-     */
-    identifier?: string;
-    /**
-     * The full product name (e.g., "EOR Monthly").
-     */
-    name: string;
-    /**
-     * A short display name for the product (e.g., "EOR").
-     */
-    short_name?: string;
-    /**
-     * The product tier (e.g., "standard", "premium").
-     */
-    tier: string;
-};
-/**
- * CompanyResponse
- *
- * Shows a company
- */
-type CompanyResponse = {
-    data: {
-        company?: Company;
-    };
-};
-/**
- * CompanyWithTokensResponse
- *
- * Shows a company with its refresh and access tokens. Please contact Remote if you need the tokens when creating a company.
- */
-type CompanyWithTokensResponse = {
-    company?: Company;
-    tokens?: OAuth2Tokens;
-};
-/**
- * ListLeavePoliciesSummaryResponse
- *
- * Response schema for listing leave policies summary
- */
-type ListLeavePoliciesSummaryResponse = {
-    data: Array<LeavePolicySummary>;
-};
-/**
- * RiskReserveProofOfPaymentResponse
- */
-type RiskReserveProofOfPaymentResponse = {
-    data?: {
-        /**
-         * Proof of payment ID
-         */
-        slug?: string;
-        /**
-         * Current status of the proof of payment
-         */
-        status?: 'pending' | 'auto_approve' | 'manual_review' | 'approved' | 'rejected';
-    };
-};
-/**
- * ContractorInvoiceScheduleStatus
- *
- * Current record state.
- *
- * - `active`: Once an invoice is generated, and a withdrawal method has been set, then it's set to active.
- * - `processing`: Ephemeral status indicating that we are currently attempting to generate a contractor invoice from the scheduled contractor invoice.
- * - `pending_company_action`: Company needs to trigger some actions related to payment configuration.
- * - `pending_contractor_action`: When schedule is blocked by contractor onboarding or invoice generation failed due to withdrawal methods issues that needs contractor action.
- * - `generation_failed_unrelated_to_withdrawal_method`: Generation failed for any other reason.
- * - `completed`: Number of generated contractor invoices has been reached.
- * - `inactive`: Does not create any further contractor invoices but it's still possible for the employer to activate it again.
- * - `deleted`: The schedule was cancelled and will not generate any further contractor invoices.
- *
- */
-type ContractorInvoiceScheduleStatus = 'inactive' | 'deleted' | 'completed' | 'active' | 'processing' | 'pending_company_action' | 'pending_contractor_action' | 'generation_failed_unrelated_to_withdrawal_method';
-/**
- * EngagementAgreementDetailsFileParams
- *
- * A file attached to the engagement agreement details.
- *
- * To upload a new file, send its `name` and its base64-encoded `content`. To keep a file uploaded
- * previously, send back the `name` and `id` returned by the show endpoint instead. Every entry
- * must do one or the other — an entry carrying neither is rejected, and an `id` that does not
- * belong to this record is rejected too. Files that are not included in the payload are deleted.
- *
- * Only the properties below are accepted; any other one is rejected. In particular a file's
- * `sub_type` is derived from the field it is attached to and cannot be set by the caller.
- *
- */
-type EngagementAgreementDetailsFileParams = {
-    /**
-     * The file content, Base64 encoded. Required when uploading a new file. The decoded content must match the extension given in `name`. Requests are capped at 25MB in total, which leaves room for a file of roughly 18MB once Base64 encoded.
-     */
-    content?: string;
-    /**
-     * ID of a file uploaded previously, as returned by the show endpoint. Send it to keep that file.
-     */
-    id?: string;
-    /**
-     * The file name, including its extension.
-     */
-    name: string;
-    /**
-     * The file size in bytes, before Base64 encoding.
-     */
-    size?: number;
-    /**
-     * The file's media type.
-     */
-    type?: string;
-};
-/**
- * RequestDetails
- *
- * The details of the requested changes for the contract amendment.
- */
-type RequestDetails = {
-    additional_comments?: string | null;
-    effective_date?: string;
-    reason_for_change?: 'annual_pay_adjustment' | 'country_rule_change' | 'error_correction' | 'job_change_reevaluation' | 'promotion' | 'other';
-    /**
-     * This is filled when the reason_for_change is 'other'.
-     */
-    reason_for_change_description?: string | null;
-    salary_decrease_details?: SalaryDecreaseDetails;
-};
-/**
- * EligibilityQuestionnaireResponse
- */
-type EligibilityQuestionnaireResponse = {
-    data: EligibilityQuestionnaire;
-};
-/**
- * ConvertCurrencyParams
- *
- * The parameters for the currency conversion
- */
-type ConvertCurrencyParams = {
-    /**
-     * The amount to convert in cents
-     */
-    amount: number;
-    /**
-     * The currency code to convert from
-     */
-    source_currency: string;
-    /**
-     * The currency code to convert to
-     */
-    target_currency: string;
-};
-/**
- * ProvisionalStartDate
- *
- * Indicates the expected start date of the employee or contractor.
- *
- * Required for employees, but optional for contractors. Date format is in ISO8601 without the time component.
- *
- * See the **Date and Time Format** documentation for more details on how the Remote API works with dates.
- *
- */
-type ProvisionalStartDate = string;
-/**
- * ContractAmendment
- *
- * A full contract amendment record, including the requested changes with their previous and current values.
- */
-type ContractAmendment = {
-    /**
-     * The unique identifier of the contract being amended. Null if no specific contract was targeted.
-     */
-    amendment_contract_id: string | null;
-    /**
-     * Describes all the changes requested for the contract and contract details with all their previous and current values.
-     */
-    changes: {
-        [key: string]: unknown;
-    };
-    /**
-     * The unique identifier (UUID) of the employment.
-     */
-    employment_id: string;
-    /**
-     * The unique identifier (UUID) of the contract amendment.
-     */
-    id: string;
-    request_details: RequestDetails;
-    /**
-     * The unique identifier (UUID) of the user who submitted the amendment.
-     */
-    requested_by: string;
-    status: ContractAmendmentStatus;
-    /**
-     * The timestamp when the amendment was submitted.
-     */
-    submitted_at: string;
-    /**
-     * A link to the support ticket associated with this amendment, if one was created. Null otherwise.
-     */
-    zendesk_ticket_url: string | null;
-};
-/**
- * ContractDocumentItem
- *
- * Contract document item in list response
- */
-type ContractDocumentItem = {
-    /**
-     * Contract document slug/ID
-     */
-    id: string;
-    /**
-     * Created timestamp
-     */
-    inserted_at: string;
-    /**
-     * Contract document name
-     */
-    name: string | null;
-    /**
-     * List of signatories for this contract document
-     */
-    signatories: Array<ListSignatory>;
-    status: ContractorContractDocumentStatus;
-    /**
-     * Contract document type
-     */
-    type: string;
-    /**
-     * Last updated timestamp
-     */
-    updated_at: string | null;
-};
-/**
- * TaskDescription
- *
- * Description and status of an onboarding task.
- */
-type TaskDescription = {
-    /**
-     * A human-readable description of what this onboarding task requires.
-     */
-    description?: string;
-    /**
-     * TaskStatus
-     *
-     * The status of the task
-     */
-    status?: 'completed' | 'pending';
-};
-/**
- * CountrySubdivision
- *
- * A subdivision of a supported country on Remote
- */
-type CountrySubdivision = {
-    /**
-     * The ISO 3166-2 subdivision code (e.g., "PT-11" for Lisboa).
-     */
-    code?: string;
-    /**
-     * The subdivision's name (e.g., "Lisboa", "California").
-     */
-    name: string;
-    /**
-     * The type of subdivision (e.g., "District", "State", "Province").
-     */
-    subdivision_type?: string;
-};
-/**
- * ListTimeoffResponse
- *
- * Response schema listing many timeoffs
- */
-type ListTimeoffResponse = {
-    data?: {
-        /**
-         * The current page among all of the total_pages
-         */
-        current_page?: number;
-        timeoffs?: Array<Timeoff>;
-        /**
-         * The total number of records in the result
-         */
-        total_count?: number;
-        /**
-         * The total number of pages the user can go through
-         */
-        total_pages?: number;
-    };
-};
-/**
- * MagicLinkResponse
- */
-type MagicLinkResponse = {
-    data: {
-        url: string;
-    };
-};
-/**
- * EmploymentLifecycleStage
- *
- * The stage of employment lifecycle. When it's `onboarded` means the employee is ready to commence or has already commenced.
- */
-type EmploymentLifecycleStage = 'employment_creation' | 'employee_self_enrollment' | 'right_to_work_check' | 'contract_signing' | 'remote_enrollment' | 'onboarded' | 'offboarded';
-/**
- * CreateContractDocument
- *
- * Parameters for creating a contract document
- */
-type CreateContractDocument = {
-    /**
-     *   Contract document parameters. Its properties may vary depending on the country.
-     *
-     */
-    contract_document: {
-        [key: string]: unknown;
-    };
-    /**
-     * When true, skips AI-based compliance checks (e.g. services and deliverables classification). Defaults to false.
-     */
-    skip_ai_checks?: boolean;
-};
-/**
- * ResponseTimeoffType
- *
- * The type of leave a time off record or leave policy represents.
- *
- * Responses may return any of these values. The set is a superset of the values
- * accepted when creating or updating a time off record (see `TimeoffType`): employments on the newer leave-type model can hold leave types that are not bookable by name.
- *
- */
-type ResponseTimeoffType = 'time_off' | 'sick_leave' | 'public_holiday' | 'unpaid_leave' | 'extended_leave' | 'in_lieu_time' | 'maternity_leave' | 'paternity_leave' | 'parental_leave' | 'bereavement' | 'military_leave' | 'other' | 'paid_time_off' | 'custom_company_leave' | 'rtt' | 'casual_leave' | 'rol' | 'ex_festivita' | 'civic_duty' | 'adoption' | 'caregiver' | 'transfer' | 'exam' | 'monkhood' | 'marriage' | 'sterilization' | 'celebration' | 'blood_donation' | 'health_day' | 'special' | 'career' | 'study' | 'voluntary' | 'adv' | 'public_duties' | 'force_majeure' | 'medical_visits' | 'marriage_child' | 'breastfeeding' | 'maternity_paid' | 'maternity_unpaid' | 'paternity_paid' | 'paternity_unpaid' | 'pregnancy_leave' | 'business_trip_eu' | 'business_trip_non_eu' | 'training' | 'sustainable_employability';
-/**
- * ValidationError
- */
-type ValidationError = {
-    errors: {
-        [key: string]: unknown;
-    };
-};
-/**
- * ContractAmendmentAutomatableResponse
- *
- * Contract Amendment Automatable response
- */
-type ContractAmendmentAutomatableResponse = {
-    data?: {
-        /**
-         * If true, it means that the contract amendment request is automatable.
-         */
-        automatable?: boolean;
-        /**
-         * The message to explain how the contract amendment request will be processed depending if it is automatable or not.
-         */
-        message?: string;
-    };
-};
-/**
- * Signatory
- *
- * A signatory on a contract document. For company and employee signatories, `user_id` is provided. For other signatory types, `user_id` is null.
- */
-type Signatory = {
-    /**
-     * Email address of the signatory
-     */
-    email?: string | null;
-    /**
-     * Full name of the signatory
-     */
-    name?: string | null;
-    /**
-     * Signature image as a data URI (e.g. `data:image/png;base64,...`), null if not yet signed
-     */
-    signature?: string | null;
-    /**
-     * Signing method used by this signatory
-     */
-    signature_method?: 'in_platform' | 'docusign';
-    /**
-     * Legal signature level applied when signing
-     */
-    signature_type?: 'standard' | 'qes' | 'aes' | 'ses';
-    /**
-     * Timestamp when the signatory signed the document, null if not yet signed
-     */
-    signed_at?: string | null;
-    status: SignatoryStatus;
-    type: SignatoryType;
-    /**
-     * User identifier for internal signatories, null for external signatories
-     */
-    user_id?: string | null;
-};
-/**
- * NullableCountry
- *
- * A supported country on Remote
- */
-type NullableCountry = {
-    /**
-     * The ISO 3166-1 alpha-2 country code (e.g., "PT").
-     */
-    alpha_2_code: string;
-    /**
-     * The ISO 3166-1 alpha-3 country code (e.g., "PRT"). This is the primary code used across the Remote API.
-     */
-    code: string;
-    /**
-     * Contractor product names available for this country
-     */
-    contractor_products_available?: Array<'standard' | 'plus' | 'cor'>;
-    /**
-     * Administrative subdivisions of the country (e.g., states, provinces, districts). Null if the country has no subdivisions relevant to Remote's services.
-     */
-    country_subdivisions?: Array<CountrySubdivision> | null;
-    /**
-     * Whether an Employment Agreement preview is available for this country.
-     */
-    employment_agreement_preview_available?: boolean;
-    /**
-     * Whether EOR (Employer of Record) onboarding is available in this country.
-     */
-    eor_onboarding?: boolean;
-    /**
-     * When benefit plan selections become locked for this country (e.g., "after_first_hire" means benefits cannot be changed after the first employee is hired).
-     */
-    locked_benefits?: string;
-    /**
-     * The country's full English name.
-     */
-    name: string;
-    /**
-     * The geographic region the country belongs to (e.g., "Europe", "Asia", "Americas").
-     */
-    region?: string;
-    /**
-     * The geographic subregion (e.g., "Southern Europe", "Southeast Asia"). Null for some countries.
-     */
-    subregion?: string | null;
-    /**
-     * The list of JSON schema form names available for this country (e.g., "address_details", "contract_details"). Use these with the Show form schema endpoint to get country-specific field requirements.
-     */
-    supported_json_schemas?: Array<string>;
-} | null;
-/**
- * OnboardingTasks
- *
- * All tasks that need to be completed before marking the employment as ready
- */
-type OnboardingTasks = {
-    address_details: TaskDescription;
-    administrative_details: TaskDescription;
-    bank_account_details: TaskDescription;
-    billing_address_details: TaskDescription;
-    contract_details: TaskDescription;
-    emergency_contact_details: TaskDescription;
-    employment_document_details: TaskDescription;
-    personal_details: TaskDescription;
-    pricing_plan_details: TaskDescription;
-};
-/**
- * FileParams
- *
- * Parameters to upload a file
- */
-type FileParams = {
-    /**
-     * The unique identifier (UUID) of the employment to attach this file to.
-     */
-    employment_id: string;
-    /**
-     * The file content, base64-encoded.
-     */
-    file: Blob | File;
-    /**
-     * A more specific classification within the type (e.g., "ir_35" for a UK contractor tax determination).
-     */
-    sub_type?: string;
-    /**
-     * The broad category of the file (e.g., "contract", "id", "tax_document").
-     */
-    type?: string;
-};
-/**
- * LeavePolicySummary
- *
- * Leave Policy Summary
- */
-type LeavePolicySummary = {
-    /**
-     * The annual balance represents the balance for the current entitlement period.
-     * Unlike the regular balance, it does not account for accrued value and only considers the annual entitlement as the basis for calculations.
-     *
-     */
-    annual_balance: UnlimitedDaysandHoursResponse | LimitedDaysandHoursResponse;
-    /**
-     * The annual entitlement represents what an employee is entitled to in the current entitlement period.
-     * It does not account for any accrued value.
-     *
-     */
-    annual_entitlement: UnlimitedDaysandHoursResponse | LimitedDaysandHoursResponse;
-    /**
-     * The balance is the entitlement minus the taken timeoff (i.e 10 entitlement - 3 taken = 7 balance)
-     */
-    balance: UnlimitedDaysandHoursResponse | LimitedDaysandHoursResponse;
-    /**
-     * LimitedDaysandHoursResponse
-     *
-     * Includes all upcoming requested time off.
-     */
-    booked: {
-        days: number;
-        hours: number;
-        type: 'limited';
-    };
-    /**
-     * The current entitlement is the accrued time entitled for the employee plus any other extra entitlements (such as carryover).
-     */
-    current_entitlement: UnlimitedDaysandHoursResponse | LimitedDaysandHoursResponse;
-    leave_policy: EmployeeLeavePolicy;
-    /**
-     * LimitedDaysandHoursResponse
-     *
-     * Includes requested timeoffs (not approved) in the past or in the future.
-     */
-    pending_approval: {
-        days: number;
-        hours: number;
-        type: 'limited';
-    };
-    /**
-     * LimitedDaysandHoursResponse
-     *
-     * Includes all time off (past and future, pending or approved).
-     */
-    taken: {
-        days: number;
-        hours: number;
-        type: 'limited';
-    };
-    /**
-     * LimitedDaysandHoursResponse
-     *
-     * Includes all upcoming approved time off.
-     */
-    upcoming_approved: {
-        days: number;
-        hours: number;
-        type: 'limited';
-    };
-    /**
-     * LimitedDaysandHoursResponse
-     *
-     * Includes all upcoming requested time off.
-     */
-    upcoming_requested: {
-        days: number;
-        hours: number;
-        type: 'limited';
-    };
-    /**
-     * LimitedDaysandHoursResponse
-     *
-     * Includes only approved time off in the past.
-     */
-    used: {
-        days: number;
-        hours: number;
-        type: 'limited';
-    };
-    working_hours_per_day: number;
-};
-/**
- * EmploymentCreationResponse
- */
-type EmploymentCreationResponse = {
-    data?: {
-        employment?: EmploymentBasicResponse;
-    };
-};
-/**
- * EmploymentStatus
- *
- * The current status of the employment record.
- *
- * - `active`: The employee is fully onboarded and actively working.
- * - `created`: The employment has been created but onboarding has not started.
- * - `pre_hire`: A pre-hire employment record, created before formal onboarding begins.
- * - `created_awaiting_reserve`: The employment is created but waiting for a risk reserve deposit to be paid.
- * - `created_reserve_paid`: The risk reserve has been paid and the employment can proceed with onboarding.
- * - `initiated`: Onboarding has been started by the employer.
- * - `invited`: The employee has been invited to complete their self-enrollment on Remote.
- * - `pending`: The employment is pending review or further action before it can become active.
- * - `review`: The employment is under review by Remote (e.g., contract or compliance review).
- * - `archived`: The employment has been terminated or offboarded.
- * - `deleted`: The employment record has been deleted.
- *
- */
-type EmploymentStatus = 'active' | 'created' | 'pre_hire' | 'created_awaiting_reserve' | 'created_reserve_paid' | 'initiated' | 'invited' | 'pending' | 'review' | 'job_title_review' | 'pending_post_self_enrollment_actions' | 'offboarding' | 'archived' | 'deleted';
-/**
- * CostCalculatorEmployment
- *
- * A cost estimate for a single employment, including costs in both the regional (local) currency and the employer's preferred currency.
- */
-type CostCalculatorEmployment = {
-    country: MinimalCountry;
-    /**
-     * A link to Remote's guide on benefits available in this country. Null if not available.
-     */
-    country_benefits_details_url: string | null;
-    /**
-     * A link to Remote's country hiring guide. Null if not available.
-     */
-    country_guide_url: string | null;
-    employer_currency_costs: CostCalculatorCosts;
-    /**
-     * Whether this country has extra statutory payments (e.g., 13th month salary in the Philippines).
-     */
-    has_extra_statutory_payment: boolean;
-    /**
-     * Whether this country has a fringe benefits tax on employer-paid benefit premiums (e.g. New Zealand).
-     */
-    has_fringe_benefits_tax?: boolean;
-    /**
-     * The minimum number of business days required to onboard an employee in this country. Null if not determined.
-     */
-    minimum_onboarding_time: number | null;
-    region: MinimalRegion;
-    regional_currency_costs: CostCalculatorCosts;
-};
-/**
- * CreateCompanyParams
- */
-type CreateCompanyParams = {
-    /**
-     * Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country).
-     * Use the desired country and `address_details` as the form name for the placeholders.
-     * The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification.
-     *
-     */
-    address_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country).
-     * Use the desired country and `bank_account_details` as the form name for the placeholders.
-     * The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification.
-     *
-     */
-    bank_account_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * The company owner email.
-     *
-     * This value cannot be changed once set.
-     *
-     */
-    company_owner_email: string;
-    /**
-     * The company owner name.
-     *
-     * This value cannot be changed from the Remote API once set.
-     *
-     */
-    company_owner_name: string;
-    /**
-     * 3-letter country code of the country the company address is located in.
-     *
-     * For a list of countries supported through the Remote API, make a call to the [list countries endpoint](#tag/Countries/operation/get_supported_country). This endpoint will also include the 3-letter country codes you can use for this field.
-     *
-     */
-    country_code: string;
-    /**
-     * Desired currency for invoicing and displaying converted salaries in Remote UI regardless of the employee's country.
-     */
-    desired_currency: 'AUD' | 'CAD' | 'CHF' | 'DKK' | 'EUR' | 'GBP' | 'JPY' | 'NOK' | 'NZD' | 'SEK' | 'SGD' | 'USD';
-    /**
-     * The domain of the company. Use this field to specify the company domain name when it's different from the domain in the company owner's email.
-     */
-    email_domain?: string;
-    /**
-     * Id of the company as represented in the external partner system.
-     */
-    external_id?: string;
-    /**
-     * The company name
-     */
-    name: string;
-    /**
-     * A phone number the company can be contacted with.
-     */
-    phone_number?: string;
-    /**
-     * The company registration number. This field or `tax_number` (but not both) should be submitted.
-     */
-    registration_number?: string;
-    /**
-     * The tax identifier of the company. This field or `registration_number` (but not both) should be submitted.
-     */
-    tax_number?: string;
-    /**
-     * Date and time the Terms of Service were accepted. To ensure users read the most recent version of Remote's Terms of Service, their action cannot have been done more than fifteen minutes ago. The UTC offset must be included in the ISO 8601 format: `YYYY-MM-DD HOURS:MINUTES:SECONDSZ`
-     */
-    terms_of_service_accepted_at: string;
-};
-/**
- * ContractorInvoiceScheduleResponse
- *
- * Response schema to show a Contractor Invoice Schedule
- */
-type ContractorInvoiceScheduleResponse = {
-    data: {
-        contractor_invoice_schedule: ContractorInvoiceSchedule;
-    };
-};
-/**
- * EngagementAgreementDetailsFile
- *
- * A file attached to the engagement agreement details.
- */
-type EngagementAgreementDetailsFile = {
-    /**
-     * ID of the file. Send it back when upserting to keep the file.
-     */
-    id: string;
-    /**
-     * The file name, including its extension.
-     */
-    name: string;
-};
-/**
- * UuidSlug
- *
- * Identifier of the employment being terminated.
- */
-type UuidSlug = string;
-/**
- * BaseTokenResponse
- */
-type BaseTokenResponse = {
-    /**
-     * A JWT token.
-     */
-    access_token?: string;
-    /**
-     * Number of seconds until token is expired.
-     */
-    expires_in?: number;
-    /**
-     * The type of the token. For now, always `Bearer`.
-     */
-    token_type?: string;
-};
-/**
- * SubStep
- */
-type SubStep = {
-    completed_at?: string | null;
-    /**
-     * Unique identifier for this substep
-     */
-    id: string;
-    /**
-     * Human-readable substep name
-     */
-    label: string;
-    /**
-     * Whether this substep is optional
-     */
-    optional: boolean;
-    started_at?: string | null;
-    /**
-     * Substep status
-     */
-    status: 'not_started' | 'in_progress' | 'completed' | 'failed';
-    /**
-     * Optional UI tag
-     */
-    tag?: string | null;
-    /**
-     * Substep type identifier
-     */
-    type: string;
-};
-/**
- * SuccessResponse
- *
- * A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
- */
-type SuccessResponse = {
-    data: {
-        /**
-         * The result status. Always `"ok"` for successful operations.
-         */
-        status?: string;
-    };
-};
-/**
- * ManageContractorPlusSubscriptionOperationsParams
- *
- * Defines the operation that must be executed: upgrade or downgrade
- */
-type ManageContractorPlusSubscriptionOperationsParams = {
-    operation: 'upgrade' | 'downgrade';
-};
-/**
- * EmployeeLeavePolicy
- *
- * Leave Policy abstraction representation for the employee
- */
-type EmployeeLeavePolicy = {
-    description: string | null;
-    /**
-     * The ID of the leave policy variant
-     */
-    leave_policy_variant_id: string | 'time_off' | 'sick_leave' | 'public_holiday' | 'unpaid_leave' | 'extended_leave' | 'in_lieu_time' | 'maternity_leave' | 'paternity_leave' | 'parental_leave' | 'bereavement' | 'military_leave' | 'other' | 'paid_time_off' | 'custom_company_leave' | 'rtt' | 'casual_leave' | 'rol' | 'ex_festivita' | 'civic_duty' | 'adoption' | 'caregiver' | 'transfer' | 'exam' | 'monkhood' | 'marriage' | 'sterilization' | 'celebration' | 'blood_donation' | 'health_day' | 'special' | 'career' | 'study' | 'voluntary' | 'adv' | 'public_duties' | 'force_majeure' | 'medical_visits' | 'marriage_child' | 'breastfeeding' | 'maternity_paid' | 'maternity_unpaid' | 'paternity_paid' | 'paternity_unpaid' | 'pregnancy_leave' | 'business_trip_eu' | 'business_trip_non_eu' | 'training' | 'sustainable_employability';
-    leave_type: ResponseTimeoffType;
-    name: string;
-    unit: 'days' | 'hours' | 'unlimited';
-};
-/**
- * MagicLinkParams
- *
- * Magic link params
- */
-type MagicLinkParams = {
-    /**
-     * The path to which the user will be redirected to after login. This field has a max length of 2000 characters.
-     *
-     * If not specified, `/dashboard` will be used by default.
-     *
-     * Must begin with a forward slash (`/`) and, at least one path segment is required  (`/dashboard` e.g.).
-     * An ending forward slash (`/`) is not allowed and path segments can only include alphanumeric characters, underscore (`_`) and hyphen (`-`).
-     *
-     * An optional query string can be specified too. If present, the query string must start with a question mark (`?`)
-     * and must include at least one key value pair. Both, keys and values, can only include
-     * alphanumeric characters, underscore (`_`), hyphen (`-`) or percent encoded values such as `%20` (space character).
-     * Additional key value pairs are allowed using ampersand (`&`).
-     *
-     * Query keys require at least one alphanumeric, underscore (`_`), hyphen (`-`) or valid percent encoded.
-     * Query values are optional, the actual value may be empty and the equals sign (`=`) may be missing too.
-     *
-     * Some **Valid** examples for `path`:
-     * - o `/dashboard`
-     * - o `/dashboard/people/new/full_time/663e0b79-c893-45ff-a1b2-f6dcabc098b5`
-     * - o `/dashboard/people/hiring?filters%5B0%5D%5Bid%5D=status&filters%5B0%5D%5Bvalue%5D=active`
-     * - o `/dashboard?key=value&foo=bar`
-     *
-     * Some **Invalid** examples for `path`:
-     * - x `missing_forward_slash`
-     * - x `/invalid//path`
-     * - x `//some`
-     * - x `/?key=value`
-     * - x `/some/i.n:valid*`
-     * - x `/invalid/end/slash/`
-     * - x `/some?malformed_percent_encoded_key%1=value`
-     *
-     */
-    path?: string;
-    user_id: UuidSlug;
-} | {
-    employment_id: UuidSlug;
-    /**
-     * The path to which the user will be redirected to after login. This field has a max length of 2000 characters.
-     *
-     * If not specified, `/dashboard` will be used by default.
-     *
-     * Must begin with a forward slash (`/`) and, at least one path segment is required  (`/dashboard` e.g.).
-     * An ending forward slash (`/`) is not allowed and path segments can only include alphanumeric characters, underscore (`_`) and hyphen (`-`).
-     *
-     * An optional query string can be specified too. If present, the query string must start with a question mark (`?`)
-     * and must include at least one key value pair. Both, keys and values, can only include
-     * alphanumeric characters, underscore (`_`), hyphen (`-`) or percent encoded values such as `%20` (space character).
-     * Additional key value pairs are allowed using ampersand (`&`).
-     *
-     * Query keys require at least one alphanumeric, underscore (`_`), hyphen (`-`) or valid percent encoded.
-     * Query values are optional, the actual value may be empty and the equals sign (`=`) may be missing too.
-     *
-     * Some **Valid** examples for `path`:
-     * - o `/dashboard`
-     * - o `/dashboard/people/new/full_time/663e0b79-c893-45ff-a1b2-f6dcabc098b5`
-     * - o `/dashboard/people/hiring?filters%5B0%5D%5Bid%5D=status&filters%5B0%5D%5Bvalue%5D=active`
-     * - o `/dashboard?key=value&foo=bar`
-     *
-     * Some **Invalid** examples for `path`:
-     * - x `missing_forward_slash`
-     * - x `/invalid//path`
-     * - x `//some`
-     * - x `/?key=value`
-     * - x `/some/i.n:valid*`
-     * - x `/invalid/end/slash/`
-     * - x `/some?malformed_percent_encoded_key%1=value`
-     *
-     */
-    path?: string;
-};
-/**
- * CostCalculatorDiscount
- *
- * Configuration for applying a discount to a cost estimate. Provide either an `amount` or `percent` — not both.
- */
-type CostCalculatorDiscount = {
-    /**
-     * The fixed discount amount in cents. Mutually exclusive with `percent`.
-     */
-    amount?: number;
-    /**
-     * The number of months the discount applies to (1-12). Defaults to 12.
-     */
-    months?: number;
-    /**
-     * The discount as a decimal fraction (e.g., 0.1 for 10%). Mutually exclusive with `amount`.
-     */
-    percent?: number;
-    /**
-     * The originally quoted amount before discount, in cents.
-     */
-    quoted_amount?: number;
-    /**
-     * A human-readable label for the discount (e.g., "10% Discount").
-     */
-    text: string;
-};
-/**
- * LeavePolicy
- *
- * The leave policy associated with a time off request. Policies define the rules and entitlements for specific types of leave.
- */
-type LeavePolicy = {
-    /**
-     * The unique identifier (slug) of the specific policy variant.
-     */
-    leave_policy_variant_slug: string;
-    leave_type: ResponseTimeoffType;
-    /**
-     * The display name of the leave policy (e.g., "Self-Care", "Annual Leave").
-     */
-    name: string;
-};
-/**
- * CompanyLegalEntity
- */
-type CompanyLegalEntity = {
-    /**
-     * ISO 3166-1 alpha-3 country code (e.g., 'USA', 'GBR', 'DEU')
-     */
-    country_code?: string | null;
-    /**
-     * Whether Global Payroll services are enabled for this legal entity.
-     */
-    global_payroll_enabled: boolean;
-    /**
-     * Company slug
-     */
-    id: string;
-    /**
-     * Indicates if this is the default legal entity for the company
-     */
-    is_default?: boolean;
-    /**
-     * The registered name of the legal entity.
-     */
-    name: string;
-};
-/**
- * Company
- */
-type Company = {
-    /**
-     * Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country).
-     * Use the desired country and `address_details` as the form name for the placeholders.
-     * The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification.
-     *
-     */
-    address_details: {
-        [key: string]: unknown;
-    };
-    /**
-     * Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country).
-     * Use the desired country and `bank_account_details` as the form name for the placeholders.
-     * The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification.
-     *
-     */
-    bank_account_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * The email address of the company owner who administers the Remote account.
-     */
-    company_owner_email: string;
-    /**
-     * The full name of the company owner. Cannot be changed after company creation.
-     */
-    company_owner_name?: string;
-    /**
-     * The unique identifier (UUID) of the company owner's user account on Remote.
-     */
-    company_owner_user_id: string;
-    /**
-     * The ISO 3166-1 3-letter country code where the company is registered.
-     */
-    country_code: string;
-    /**
-     * The timestamp when the company was created on Remote.
-     */
-    created_at: string;
-    /**
-     * The credit risk status of the company default legal entity.
-     * - `not_started`: The credit risk assessment has not started yet.
-     * - `ready`: The credit risk assessment is ready to be started.
-     * - `in_progress`: The automated credit risk assessment is in progress.
-     * - `referred`: The credit risk assessment has been referred to a human reviewer.
-     * - `fail`: The credit risk assessment has failed and the company will be archived.
-     * - `deposit_required`: The company default legal entity requires a deposit before onboarding new employees.
-     * - `no_deposit_required`: The company default legal entity does not require a deposit before onboarding new employees.
-     *
-     */
-    default_legal_entity_credit_risk_status: 'not_started' | 'ready' | 'in_progress' | 'referred' | 'fail' | 'deposit_required' | 'no_deposit_required';
-    /**
-     * The ISO 4217 currency code the company prefers for billing and invoicing (e.g., "USD", "EUR").
-     */
-    desired_currency: string;
-    /**
-     * A unique reference code for this company in a non-Remote system. Null if not set.
-     */
-    external_id?: string | null;
-    /**
-     * The unique identifier (UUID) of the company.
-     */
-    id: string;
-    /**
-     * The company's registered name. Can only be changed while the company is in `pending` status.
-     */
-    name: string;
-    /**
-     * The company's contact phone number.
-     */
-    phone_number?: string;
-    /**
-     * The company's business registration number. Null if not provided. Can only be set while the company is in `pending` status.
-     */
-    registration_number?: string | null;
-    /**
-     * The company status determines what a company is allowed to do:
-     * - `pending`: The company has been created and the company owner invited. Remote is waiting for the company owner to complete onboarding.
-     * - `review`: The company is under review. In rare occasions, a company may not automatically get created in `active` status because Remote needs to
-     * manually review the company that was created. The company will become `active` once the review is completed and no further action is necessary
-     * through the Remote API.
-     * - `active`: The company owner has completed onboarding and the company is ready to employ.
-     * - `archived`: The company is no longer active on the Remote platform and no changes can be made to the company.
-     *
-     */
-    status: 'pending' | 'review' | 'active' | 'archived';
-    /**
-     * The company's tax identification number. Null if not provided. Can only be set while the company is in `pending` status.
-     */
-    tax_number?: string | null;
-    /**
-     * The timestamp when the company owner accepted Remote's Terms of Service.
-     */
-    terms_of_service_accepted_at: string;
-    /**
-     * The timestamp when the company record was last updated.
-     */
-    updated_at: string;
-};
-/**
- * PreOnboardingRequirement
- *
- * A pre-onboarding requirement (document or acknowledgement) that must be fulfilled before an employee can be onboarded.
- */
-type PreOnboardingRequirement = {
-    /**
-     * The requirement that must be fulfilled before this one becomes available (if any).
-     */
-    depends_on_requirement: PreOnboardingRequirement | null;
-    /**
-     * Human-readable description; rich HTML for acknowledgement requirements.
-     */
-    description: string;
-    /**
-     * Whether the employment data is frozen because this requirement is finished.
-     */
-    freeze_employment_data: boolean | null;
-    /**
-     * Human-readable name of the requirement.
-     */
-    name: string;
-    /**
-     * Email address to contact for help with redlining (document requirements only).
-     */
-    redlining_help_email: string | null;
-    slug: UuidSlug;
-    /**
-     * Current status of this requirement for the given employment.
-     */
-    status: 'blocked' | 'awaiting' | 'finished' | 'revised';
-    /**
-     * Whether the requirement supports redlining (document requirements only).
-     */
-    supports_redlining: boolean | null;
-    /**
-     * The requirement type.
-     */
-    type: 'document' | 'acknowledgement';
-};
-/**
- * ContractorSubscriptions.Summary
- */
-type ContractorSubscriptionsSummary = {
-    company_product: {
-        slug?: UuidSlug;
-    };
-    company_product_discount: {
-        expiration_date?: Date;
-        percent?: Decimal;
-    };
-    currency: Currency;
-    eligibility_questionnaire?: EligibilityQuestionnaire;
-    is_termination_fees_enabled?: boolean;
-    price: {
-        amount?: number;
-        /**
-         * The price after applying the company discount, in cents
-         */
-        final_amount?: number;
-    };
-    product: Product;
-    total_amount: number | null;
-    total_discount?: number;
-    total_in_advance?: number;
-    total_prorated?: number;
-};
-/**
- * TooManyRequestsResponse
- *
- * Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the `Retry-After` response header for the recommended wait time.
- */
-type TooManyRequestsResponse = {
-    message?: string;
-};
-/**
- * EligibilityQuestionnaire
- */
-type EligibilityQuestionnaire = {
-    /**
-     * Whether the questionnaire blocks further progress if failed
-     */
-    is_blocking: boolean;
-    /**
-     * The questions in the questionnaire
-     */
-    questions: {
-        [key: string]: unknown;
-    };
-    /**
-     * The responses to the questionnaire
-     */
-    responses: {
-        [key: string]: unknown;
-    };
-    slug: UuidSlug;
-    submitted_at: DateTime;
-    type: 'contractor_of_record';
-};
-/**
- * UploadFileResponse
- *
- * Response returned after successfully uploading a file.
- */
-type UploadFileResponse = {
-    data?: {
-        file: File;
-    };
-};
-/**
- * ConflictResponse
- *
- * Returned when the request conflicts with the current state of a resource (HTTP 409). For example, trying to create a resource that already exists or performing an action that requires the resource to be in a different state.
- */
-type ConflictResponse = {
-    /**
-     * A human-readable message describing the conflict and the expected state.
-     */
-    message?: string;
-};
-/**
- * CurrencyDefinition
- *
- * Currency object without a UUID identifier
- */
-type CurrencyDefinition = {
-    code: string;
-    name: string;
-    symbol: string;
-};
-/**
- * ListSignatory
- *
- * A signatory on a contract document. For company and employee signatories, `user_id` is provided. For other signatory types, `user_id` is null.
- */
-type ListSignatory = {
-    /**
-     * Email address of the signatory
-     */
-    email?: string | null;
-    /**
-     * Full name of the signatory
-     */
-    name?: string | null;
-    /**
-     * Signing method used by this signatory
-     */
-    signature_method?: 'in_platform' | 'docusign';
-    /**
-     * Legal signature level applied when signing
-     */
-    signature_type?: 'standard' | 'qes' | 'aes' | 'ses';
-    /**
-     * Timestamp when the signatory signed the document, null if not yet signed
-     */
-    signed_at?: string | null;
-    status: SignatoryStatus;
-    type: SignatoryType;
-    /**
-     * User identifier for internal signatories, null for external signatories
-     */
-    user_id?: string | null;
-};
-/**
- * TimeoffDay
- *
- * A single day within a time off request, specifying the date and the number of hours taken off that day.
- */
-type TimeoffDay = {
-    day: Date;
-    /**
-     * The number of hours taken off on this day (e.g., 8 for a full day, 4 for a half day). For minute-precision durations (e.g., 7 hours 30 minutes), use `minutes`.
-     */
-    hours: number;
-    /**
-     * The number of minutes taken off on this day (e.g., 480 for a full 8-hour day, 450 for 7 hours 30 minutes). Minute-precision counterpart of `hours`.
-     */
-    minutes: number;
-};
-/**
- * BadRequestResponse
- *
- * Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed message.
- */
-type BadRequestResponse = {
-    /**
-     * A human-readable error message describing what was wrong with the request.
-     */
-    message: string;
-} | {
-    message?: {
-        code: string;
-        message: string;
-    };
-};
-/**
- * UnauthorizedResponse
- *
- * Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorization header.
- */
-type UnauthorizedResponse = {
-    message: string;
-};
-/**
- * CompanyAction
- *
- * A pending company-level action (e.g. for Contractor Management Review-step banners).
- */
-type CompanyAction = {
-    /**
-     * The legal entity that needs Remote Payments setup. Present only for setup_remote_payments actions.
-     */
-    legal_entity_id?: string | null;
-    /**
-     * Whether the action must be completed.
-     */
-    required: boolean;
-    /**
-     * The action the company still needs to complete.
-     */
-    type: 'verify_company' | 'setup_remote_payments';
-};
-/**
- * PricingPlanDetails
- *
- * Selected type of payment.
- */
-type PricingPlanDetails = {
-    /**
-     * How often Remote bills the employer for management fees. Annual billing typically offers a discount.
-     */
-    frequency: 'annually' | 'monthly';
-};
-/**
- * UpdateCompanyParams
- */
-type UpdateCompanyParams = {
-    /**
-     * Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country).
-     * Use the desired country and `address_details` as the form name for the placeholders.
-     * The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification.
-     *
-     */
-    address_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country).
-     * Use the desired country and `bank_account_details` as the form name for the placeholders.
-     * The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification.
-     *
-     */
-    bank_account_details?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Country of company address
-     */
-    country_code?: string;
-    /**
-     * Desired currency for invoicing and displaying converted salaries in Remote UI regardless of the employee's country.
-     *
-     * This field is only accepted if company is in status `pending`. Please contact Remote if you wish to update it.
-     *
-     */
-    desired_currency?: 'AUD' | 'CAD' | 'CHF' | 'DKK' | 'EUR' | 'GBP' | 'JPY' | 'NOK' | 'NZD' | 'SEK' | 'SGD' | 'USD';
-    /**
-     * This field is only accepted if company is in status `pending`. Please contact Remote if you wish to update it.
-     *
-     */
-    name?: string;
-    /**
-     * A phone number the company can be contacted with.
-     */
-    phone_number?: string;
-    /**
-     * The company registration number. This field or tax_number (but not both) should be submitted.
-     *
-     * This field is only accepted if company is in status `pending`.
-     *
-     */
-    registration_number?: string;
-    /**
-     *   The tax identifier of the company. This field or registration_number (but not both) should be submitted.
-     *
-     * This field is only accepted if company is in status `pending`.
-     *
-     */
-    tax_number?: string;
-};
-/**
- * BulkContractorInvoiceScheduleCreateResponse
- *
- * Response containing the lists of succeeded and failed schedules.
- */
-type BulkContractorInvoiceScheduleCreateResponse = {
-    data: {
-        failures: Array<ContractorInvoiceScheduleCreateResponseFailure>;
-        successes: Array<ContractorInvoiceScheduleCreateResponseSuccess>;
-    };
-};
-/**
- * ContractorInvoiceScheduleCreateResponseFailure
- *
- * Set of invoice schedule attributes with failed validation.
- */
-type ContractorInvoiceScheduleCreateResponseFailure = {
-    currency: CurrencyCode;
-    custom_days?: ContractorInvoiceScheduleCustomDays;
-    /**
-     * Employment identifier
-     */
-    employment_id: string;
-    errors: {
-        currency?: Array<string>;
-        custom_days?: Array<string>;
-        employment_id?: Array<string>;
-        items?: Array<{
-            amount?: Array<string>;
-            description?: Array<string>;
-        }>;
-        note?: Array<string>;
-        nr_occurrences?: Array<string>;
-        number?: Array<string>;
-        periodicity?: Array<string>;
-        start_date?: Array<string>;
-    };
-    /**
-     * List of invoice items that composes the overall invoice amount.
-     */
-    items: Array<ContractorInvoiceScheduleItem>;
-    /**
-     * Custom defined note.
-     */
-    note?: string;
-    /**
-     * Count of invoices that should be generated during schedule lifetime. Omit for a
-     * schedule that repeats indefinitely.
-     *
-     * A one-off invoice is expressed as `nr_occurrences: 1` — there is no `one_time`
-     * periodicity. Pair it with any `periodicity` (`monthly` is conventional); the schedule
-     * completes after its single invoice, so the cadence never applies.
-     *
-     */
-    nr_occurrences?: number;
-    /**
-     * Invoice identifier.
-     */
-    number?: string;
-    periodicity: ContractorInvoiceSchedulePeriodicity;
-    /**
-     * Date of the first contractor invoice generation.
-     */
-    start_date: string;
-};
-/**
- * SignContractDocument
- *
- * SignContractDocument schema
- */
-type SignContractDocument = {
-    /**
-     * The signer's full legal name as their electronic signature.
-     */
-    signature: string;
-};
-/**
- * ContractAmendmentStatus
- *
- * The current status of a contract amendment request.
- *
- * - `submitted`: The amendment has been submitted and is awaiting Remote's review.
- * - `in_review`: Remote is reviewing the amendment for compliance and feasibility.
- * - `done`: The amendment has been approved and applied to the contract.
- * - `canceled`: The amendment request was canceled before completion.
- * - `deleted`: The amendment request was deleted.
- *
- */
-type ContractAmendmentStatus = 'submitted' | 'in_review' | 'done' | 'canceled' | 'deleted';
-/**
- * ContractorInvoiceSchedulePeriodicity
- *
- * Defines how often contractor invoices will be generated.
- *
- * - `bi_weekly`: Invoices will be generated every other week, on the given day of the week based on the start date.
- * - `monthly`: Invoices will be generated once a month.
- * - `semi_monthly`: Invoices will be generated at fixed dates twice a month (with 14 days of difference between each other), depending on the start date.
- * In months with just 30 days, if `start_date` is set to the 31st day, then generation occurs in the last of day of the month.
- * - `weekly`: Invoices will be generated each week.
- *
- */
-type ContractorInvoiceSchedulePeriodicity = 'bi_weekly' | 'monthly' | 'semi_monthly' | 'weekly';
-/**
- * DateTimeIso8601
- *
- * UTC date time in [ISO 8601][] format.
- *
- * [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
- *
- */
-type DateTimeIso8601 = string;
-/**
- * CostCalculatorBenefitParam
- */
-type CostCalculatorBenefitParam = {
-    /**
-     * The unique identifier (slug) of the benefit group to include in the estimate.
-     */
-    benefit_group_slug: string;
-    /**
-     * The unique identifier (slug) of the benefit tier within the group. Determines the level of coverage and cost.
-     */
-    benefit_tier_slug: string;
-};
-/**
- * TerminationDetailsParams
- */
-type TerminationDetailsParams = {
-    /**
-     * Whether the employer acknowledges and agrees to follow Remote's termination procedure for this jurisdiction.
-     */
-    acknowledge_termination_procedure?: boolean | null;
-    /**
-     * Additional details regarding the termination process.
-     */
-    additional_comments?: string | null;
-    /**
-     * Whether the employer agrees with the employee's current paid time off balance. If false, you may provide a timesheet file documenting any discrepancies.
-     */
-    agrees_to_pto_amount?: boolean | null;
-    /**
-     * Additional notes about the PTO balance, especially if there are discrepancies.
-     */
-    agrees_to_pto_amount_notes?: string | null;
-    /**
-     * Confidential requests are visible for who authorized the token or integration. Non-confidential requests are visible to all admins in the company.
-     */
-    confidential: boolean;
-    /**
-     * Whether the employer has already informed the employee about the termination. Remote advises not informing the employee until the request has been reviewed for legal risks.
-     */
-    customer_informed_employee?: boolean | null;
-    /**
-     * Remote advises not to inform the employee of their termination until we review your request for legal risks. When we approve your request, you can inform the employee and we’ll take it from there. This field is only required if employee was informed before creating the offboarding request.
-     */
-    employee_awareness?: {
-        /**
-         * When the employee was told about the termination.
-         */
-        date?: string | null;
-        /**
-         * Notes describing how the termination was shared with the employee. Remote advises being as specific as possible, and include details about the employee’s response, if applicable.
-         */
-        note?: string | null;
-    };
-    /**
-     * Remote will use this email address for post-termination communication.
-     * If it is not provided, this field will be derived from the employment record. Therefore, it is important to ensure that it is not a company email.
-     *
-     */
-    personal_email?: string;
-    /**
-     * In most cases, employee needs to be notified before termination. The required notice period depends on local labor laws, the employment agreement, and other factors. Remote will use those factors to determine the required notice period. Please note that we cannot commit to a termination date until we conduct a full review of the information you submit.
-     */
-    proposed_termination_date: string;
-    /**
-     * Description of the reason for termination
-     */
-    reason_description: string;
-    /**
-     * Possible reasons for offboarding risk assessment
-     */
-    risk_assessment_reasons: Array<'caring_responsibilities' | 'disabled_or_health_condition' | 'family_leave' | 'member_of_union_or_works_council' | 'none_of_these' | 'pregnant_or_breastfeeding' | 'reported_concerns_with_workplace' | 'requested_medical_or_family_leave' | 'sick_leave'>;
-    /**
-     * Choose an accurate termination reason to avoid unfair or unlawful dismissal claims.
-     *
-     * If the termination is created before the employee's start date, this field
-     * will be set to `cancellation_before_start_date`.
-     *
-     */
-    termination_reason: 'cancellation_before_start_date' | 'compliance_issue' | 'conversion_to_contractor' | 'dissatisfaction_with_remote_service' | 'end_of_fixed_term_contract_compliance_issue' | 'end_of_fixed_term_contract_incapacity_to_perform_inherent_duties' | 'end_of_fixed_term_contract_local_regulations_max_term_reached' | 'end_of_fixed_term_contract_misconduct' | 'end_of_fixed_term_contract_operational_reasons' | 'end_of_fixed_term_contract_other' | 'end_of_fixed_term_contract_performance' | 'end_of_fixed_term_contract_redundancy' | 'end_of_fixed_term_contract_values' | 'gross_misconduct' | 'incapacity_to_perform_inherent_duties' | 'job_abandonment' | 'mutual_agreement' | 'other' | 'performance' | 'values' | 'workforce_reduction';
-    /**
-     * Any supporting documents regarding the termination reason
-     */
-    termination_reason_files?: Array<OffboardingFile>;
-    /**
-     * Paid time off accuracy
-     *
-     * Typically, any vacation pay accrued and unpaid at the time
-     * of termination must be paid out to the employee. To avoid overpaying or underpaying,
-     * please make sure we have an accurate account of their paid time off by querying the
-     * [Show Time Off Balance](#operation/get_show_timeoff_balance) endpoint,
-     * filtering by the `employment_id`.
-     * This optional document should be sent in case of any discrepancies.
-     *
-     */
-    timesheet_file?: OffboardingFile;
-    /**
-     * Whether is it likely or not that the employee will challenge their termination
-     */
-    will_challenge_termination: boolean;
-    /**
-     * If it is likely that the employee will challenge their termination, please provide additional details explaining the risk
-     */
-    will_challenge_termination_description?: string;
-};
-/**
- * Date
- *
- * UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
- */
-type Date = string;
-/**
- * Cycle
- */
-type Cycle = {
-    employee_inclusion_cutoff_date?: string;
-    end_date?: string;
-    input_cutoff_date?: string;
-    payment_date?: string;
-    start_date?: string;
-};
-/**
- * ParameterError
- */
-type ParameterError = {
-    /**
-     * An error code that describes the nature of the error.
-     */
-    code: string;
-    /**
-     * A developer friendly error message that gives details on what the error was and how it may be remedied.
-     */
-    message: string;
-    /**
-     * The parameter that lead to the error message.
-     */
-    param: string;
-};
-/**
- * GenericFile
- *
- * A file represented as a base64-encoded string.
- */
-type GenericFile = Blob | File;
-/**
- * CreateContractEligibilityParams
- */
-type CreateContractEligibilityParams = {
-    /**
-     * type of employment eligibility to work in residing country
-     */
-    eligible_to_work_in_residing_country: 'citizen' | 'permanent_resident' | 'temporary_resident';
-    /**
-     * whether the employer or work restrictions apply
-     */
-    employer_or_work_restrictions: boolean;
-};
-/**
- * TimeoffType
- *
- * The type of leave accepted when creating or updating a time off record.
- */
-type TimeoffType = 'time_off' | 'sick_leave' | 'public_holiday' | 'unpaid_leave' | 'extended_leave' | 'in_lieu_time' | 'maternity_leave' | 'paternity_leave' | 'parental_leave' | 'bereavement' | 'military_leave' | 'other' | 'paid_time_off' | 'custom_company_leave' | 'rtt' | 'casual_leave' | 'rol' | 'ex_festivita';
-/**
- * ContractorInvoicePreviewResponse
- *
- * Returns a base64 encoded Contractor Invoice preview document.
- */
-type ContractorInvoicePreviewResponse = {
-    data: {
-        contractor_invoice_preview: {
-            content: Blob | File;
-            name: string;
-        };
-    };
-};
-/**
- * Decimal
- *
- * A decimal number represented as a string to preserve precision. Supports negative values and fractional digits.
- */
-type Decimal = string;
-/**
- * MessageResponse
- */
-type MessageResponse = {
-    message: string;
-};
-/**
- * CompanyNotEligibleForCreationErrorResponse
- *
- * Error returned when the company already have employees in countries supported by the integration.
- */
-type CompanyNotEligibleForCreationErrorResponse = {
-    code?: string;
-    message?: string;
-    resource_id?: string;
-    resource_type?: string;
-};
-/**
- * ContractorInvoiceScheduleCustomDays
- *
- * The two calendar days of the month on which invoices are generated. Only applies when
- * `periodicity` is `semi_monthly`; must be omitted (or `null`) for every other periodicity.
- *
- * When omitted for a `semi_monthly` schedule, the two days are derived from `start_date`:
- * the start day and the day 14 days apart from it. Supply this field only to pick a cycle
- * other than that default.
- *
- * One of the two days must be the day of `start_date`, the days must be distinct, and they
- * cannot resolve to the same day within a month.
- *
- */
-type ContractorInvoiceScheduleCustomDays = [number, number] | null;
-/**
- * SalaryDecreaseDetails
- *
- * The details of the salary decrease request if there is one
- */
-type SalaryDecreaseDetails = {
-    salary_decrease_reason?: 'change_in_working_hours' | 'trade_salary_for_equity' | 'error_in_initial_salary' | 'role_change_or_demotion' | 'compensation_restructure' | 'other';
-    salary_decrease_reason_description?: string | null;
-    was_employee_informed?: string;
-} | null;
-/**
- * ConvertCurrencyResponse
- *
- * The response from the currency converter
- */
-type ConvertCurrencyResponse = {
-    data: {
-        conversion_data: ConvertCurrency;
-    };
-};
-/**
- * RequestError
- */
-type RequestError = {
-    errors: {
-        /**
-         * An error code that describes the nature of the error.
-         */
-        code: string;
-        /**
-         * A developer friendly error message that gives details on what the error was and how it may be remedied.
-         */
-        message: string;
-    };
-};
-/**
- * Timeoff
- *
- * A time off record for an employee, representing a period of leave (e.g., vacation, sick leave, parental leave).
- */
-type Timeoff = {
-    /**
-     * The timestamp when the time off was approved. Null if not yet approved.
-     */
-    approved_at?: string | null;
-    approver_id?: NullableApproverId;
-    /**
-     * Whether this time off was automatically created by the system (e.g., public holidays) rather than requested by the employee.
-     */
-    automatic?: boolean;
-    /**
-     * The reason provided when the time off was cancelled. Null if not cancelled.
-     */
-    cancel_reason?: string | null;
-    cancelled_at?: NullableDateTime;
-    document?: File;
-    /**
-     * The unique identifier (UUID) of the employment this time off belongs to.
-     */
-    employment_id: string;
-    /**
-     * The last day of the time off period (ISO 8601 date).
-     */
-    end_date: string;
-    /**
-     * The unique identifier (UUID) of the time off record.
-     */
-    id: string;
-    leave_policy: LeavePolicy;
-    /**
-     * Identifier of the leave policy this time off was booked against. For employments on the leave-type model this is the leave type's UUID, the same value `GET /leave-policies/details/{employment_id}` returns and `POST /timeoff` accepts. Otherwise it is the UUID of the custom company leave policy variant, and is null for standard leave types.
-     */
-    leave_policy_variant_id?: string | null;
-    /**
-     * Optional notes provided by the employee when requesting the time off.
-     */
-    notes?: string | null;
-    /**
-     * The first day of the time off period (ISO 8601 date).
-     */
-    start_date: string;
-    /**
-     * The current status of a time off request.
-     *
-     * - `requested`: The employee has submitted a time off request and it is awaiting approval.
-     * - `approved`: The time off request has been approved by a manager.
-     * - `cancelled`: The time off request was cancelled by the employee or an admin.
-     * - `declined`: The time off request was declined by a manager.
-     * - `taken`: The approved time off has been taken (the dates have passed).
-     * - `cancel_requested`: The employee has requested cancellation of a previously approved time off, pending manager approval.
-     *
-     */
-    status: 'requested' | 'approved' | 'cancelled' | 'declined' | 'taken' | 'cancel_requested';
-    /**
-     * The individual days and hours within this time off period.
-     */
-    timeoff_days: Array<TimeoffDay>;
-    timeoff_type: ResponseTimeoffType;
-    timezone: Timezone;
-    /**
-     * The total number of minutes taken off across all `timeoff_days`. Always equals the sum of the per-day `minutes` values.
-     */
-    total_minutes: number;
-};
-/**
- * EmploymentCreateParams
- *
- * Description of the basic required and onboarding tasks params to create an employment.
- * You do not need to include all onboarding tasks when creating or updating an employment.
- *
- */
-type EmploymentCreateParams = {
-    /**
-     * Employment basic information. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint
-     * passing the country code and `employment_basic_information` as path parameters.
-     */
-    basic_information: {
-        [key: string]: unknown;
-    };
-    /**
-     * Id of the legal entity that should be billed for the employment. If omitted, falls back to `engaged_by_legal_entity_id`. For EOR and Contractor employments this may differ from `engaged_by_legal_entity_id`. For Global Payroll and Direct (HRIS) employments it must match `engaged_by_legal_entity_id`.
-     */
-    bill_to_legal_entity_id?: string;
-    /**
-     * This optional field is deprecated.
-     */
-    company_id?: string;
-    /**
-     * The ISO 3166-1 3-letter country code where the employee will be based (e.g., `AUS`, `GBR`, `USA`).
-     */
-    country_code: string;
-    /**
-     * Deprecated alias for `engaged_by_legal_entity_id`. Use `engaged_by_legal_entity_id` instead.
-     *
-     * @deprecated
-     */
-    engaged_by_entity_slug?: string;
-    /**
-     * Id of the legal entity that engages the employee or contractor. Required for Global Payroll employees. For EOR and Contractor employments this may differ from `bill_to_legal_entity_id`. For Global Payroll and Direct (HRIS) employments it must match `bill_to_legal_entity_id`.
-     */
-    engaged_by_legal_entity_id?: string;
-    /**
-     * A unique reference code for the employment record in a non-Remote system. This optional field links to external data sources. If not provided, it defaults to `null`. While uniqueness is recommended, it is not strictly enforced within Remote's system.
-     */
-    external_id?: string;
-    /**
-     * A reference code for the employment record in the calling integration's own system.
-     * Private to that integration — no other integration can read or overwrite it.
-     * Omit the field to leave the value unchanged; send `null` to clear it. Surrounding
-     * whitespace is trimmed off. It can be set at any employment status, and the same
-     * value may be used on several employments (for example a rehire).
-     *
-     */
-    partner_external_id?: string | null;
-    /**
-     * If not provided, it will default to `employee`.
-     */
-    type?: 'employee' | 'contractor' | 'global_payroll_employee' | 'hris';
-};
-/**
- * EmploymentEngagementAgreementDetailsParams
- *
- * Engagement agreement details schema compatible params.
- *
- */
-type EmploymentEngagementAgreementDetailsParams = {
-    /**
-     * EngagementAgreementDetailsParamsDEU
-     *
-     * Engagement agreement details params. As its properties may vary depending on the country,
-     * you must query the [Show form schema](#tag/Countries/operation/get_v1_countries_country_code_form) endpoint
-     * passing the country code and the `engagement_agreement_details` form name.
-     *
-     */
-    engagement_agreement_details: {
-        allowances_details?: Array<string> | null;
-        available_pto?: number | null;
-        break_time_per_day?: number | null;
-        business_expenses?: string | null;
-        cba?: string | null;
-        cba_document?: Array<EngagementAgreementDetailsFileParams> | null;
-        covenants?: Array<string> | null;
-        has_allowances?: string | null;
-        has_bonus?: string | null;
-        has_business_expenses?: string | null;
-        has_business_presence?: string;
-        has_cba?: string | null;
-        has_commissions?: string | null;
-        has_covenants?: string | null;
-        has_illness_remuneration?: string | null;
-        has_overtime_compensation?: string | null;
-        has_pension_scheme?: string | null;
-        has_signing_bonus?: string | null;
-        has_similar_roles?: string;
-        has_similar_work_conditions?: string | null;
-        illness_remuneration_details?: string | null;
-        max_annual_gross_salary?: number | null;
-        min_annual_gross_salary?: number | null;
-        overtime_compensation_begins?: number | null;
-        overtime_compensation_type?: string | null;
-        overtime_pay_percentage?: number | null;
-        pension_scheme?: string | null;
-        similar_roles?: string | null;
-        similar_work_conditions_details?: string | null;
-        work_hours_per_week?: number | null;
-        working_days?: Array<string> | null;
-    };
-};
-/**
- * TimeoffStatus
- *
- * The current status of a time off request.
- *
- * - `requested`: The employee has submitted a time off request and it is awaiting approval.
- * - `approved`: The time off request has been approved by a manager.
- * - `cancelled`: The time off request was cancelled by the employee or an admin.
- * - `declined`: The time off request was declined by a manager.
- * - `taken`: The approved time off has been taken (the dates have passed).
- * - `cancel_requested`: The employee has requested cancellation of a previously approved time off, pending manager approval.
- *
- */
-type TimeoffStatus = 'approved' | 'cancelled' | 'declined' | 'requested' | 'taken' | 'cancel_requested';
-/**
- * ContractorInvoiceScheduleItem
- *
- * Line Item schema for a Contractor Invoice Schedule
- */
-type ContractorInvoiceScheduleItem = {
-    /**
-     * Amount, in cents.
-     */
-    amount: number;
-    /**
-     * Describes invoice item intent.
-     */
-    description: string;
-};
-/**
- * ForbiddenResponse
- *
- * Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and that the user has the necessary role.
- */
-type ForbiddenResponse = {
-    message: string;
-};
-/**
- * HelpCenterArticle
- *
- * Help Center Article
- */
-type HelpCenterArticle = {
-    /**
-     * Body of the article
-     */
-    body: string;
-    /**
-     * HTML URL of the article
-     */
-    html_url: string;
-    /**
-     * Title of the article
-     */
-    title: string;
-    /**
-     * Zendesk ID of the article
-     */
-    zendesk_id: number;
-};
-/**
- * CompanyCreationConflictErrorResponse
- */
-type CompanyCreationConflictErrorResponse = {
-    message?: CompanyAlreadyExistsErrorResponse | CompanyNotEligibleForCreationErrorResponse;
-};
-/**
- * EmploymentDetailsOnlyResponse
- *
- * Response containing only the updated details struct plus base employment fields (id, status, type, updated_at, user_status). Exactly one of the details properties is present per response.
- */
-type EmploymentDetailsOnlyResponse = {
-    data: {
-        employment?: {
-            /**
-             * Home address information. Its properties may vary depending on the country. Null if the employee has not submitted their address yet.
-             */
-            address_details?: {
-                [key: string]: unknown;
-            } | null;
-            /**
-             * Administrative information. Its properties may vary depending on the country.
-             */
-            administrative_details?: {
-                [key: string]: unknown;
-            };
-            bank_account_details?: Array<{
-                [key: string]: unknown;
-            }>;
-            /**
-             * Basic information. Its properties may vary depending on the country.
-             *
-             * When present, `login_email` indicates which address the employee logs in with:
-             * `"personal"` or `"work"`.
-             *
-             */
-            basic_information?: {
-                [key: string]: unknown;
-            };
-            /**
-             * Billing address information. Its properties may vary depending on the country.
-             */
-            billing_address_details?: {
-                [key: string]: unknown;
-            };
-            /**
-             * Contract details information. Its properties may vary depending on the country.
-             */
-            contract_details?: {
-                [key: string]: unknown;
-            };
-            /**
-             * Origin of the employment contract. Returned by the basic information endpoint.
-             */
-            contract_origin?: 'remote_contract' | 'custom_remote_contract' | 'provided_by_customer';
-            /**
-             * Emergency contact information. Its properties may vary depending on the country. Null if the employee has not submitted their emergency contact yet.
-             */
-            emergency_contact_details?: {
-                [key: string]: unknown;
-            } | null;
-            /**
-             * The unique identifier (UUID) of the employment.
-             */
-            id: string;
-            /**
-             * Personal details information. Its properties may vary depending on the country. Null if the employee has not submitted their personal details yet.
-             */
-            personal_details?: {
-                [key: string]: unknown;
-            } | null;
-            /**
-             * Pricing plan information.
-             */
-            pricing_plan_details?: {
-                [key: string]: unknown;
-            };
-            status: EmploymentStatus;
-            /**
-             * The type of employment.
-             */
-            type: 'employee' | 'contractor' | 'direct_employee' | 'global_payroll_employee';
-            /**
-             * The timestamp when this employment record was last updated.
-             */
-            updated_at: string;
-            user_status: UserStatus;
-        };
-    };
-};
-/**
- * EmploymentResponse
- *
- * Response containing the full employment record after an update operation.
- */
-type EmploymentResponse = {
-    data: {
-        employment?: Employment;
-    };
-};
-/**
- * ContractDocument
- *
- * A contract document for a contractor employment, tracking its signing status.
- */
-type ContractDocument = {
-    /**
-     * The unique identifier (UUID) of the contract document.
-     */
-    id: string;
-    status: ContractorContractDocumentStatus;
-};
-/**
- * ContractAmendmentResponse
- *
- * Contract Amendment response
- */
-type ContractAmendmentResponse = {
-    data?: {
-        contract_amendment: ContractAmendment;
-    };
-};
-/**
- * CreateContractDocumentResponse
- *
- * Contract document response
- */
-type CreateContractDocumentResponse = {
-    data: {
-        contract_document: ContractDocument;
-    };
-};
-/**
- * ContractorInvoiceScheduleCreateResponseSuccess
- *
- * Set of invoice schedule attributes that were successfully created.
- */
-type ContractorInvoiceScheduleCreateResponseSuccess = {
-    currency: CurrencyCode;
-    custom_days?: ContractorInvoiceScheduleCustomDays;
-    /**
-     * Employment identifier
-     */
-    employment_id: string;
-    id: UuidSlug;
-    /**
-     * List of invoice items that composes the overall invoice amount.
-     */
-    items: Array<ContractorInvoiceScheduleItem>;
-    /**
-     * Custom defined note.
-     */
-    note?: string;
-    /**
-     * Count of invoices that should be generated during schedule lifetime. Omit for a
-     * schedule that repeats indefinitely.
-     *
-     * A one-off invoice is expressed as `nr_occurrences: 1` — there is no `one_time`
-     * periodicity. Pair it with any `periodicity` (`monthly` is conventional); the schedule
-     * completes after its single invoice, so the cadence never applies.
-     *
-     */
-    nr_occurrences?: number;
-    /**
-     * Invoice identifier.
-     */
-    number?: string;
-    periodicity: ContractorInvoiceSchedulePeriodicity;
-    /**
-     * Date of the first contractor invoice generation.
-     */
-    start_date: string;
-};
-type PostV1CostCalculatorEstimationErrors = {
-    /**
-     * Not Found
-     */
-    404: NotFoundResponse;
-    /**
-     * Unprocessable Entity
-     */
-    422: UnprocessableEntityResponse;
-};
-type PostV1CostCalculatorEstimationError = PostV1CostCalculatorEstimationErrors[keyof PostV1CostCalculatorEstimationErrors];
-type PostV1ContractAmendmentsErrors = {
-    /**
-     * Unauthorized
-     */
-    401: UnauthorizedResponse;
-    /**
-     * Not Found
-     */
-    404: NotFoundResponse;
-    /**
-     * Unprocessable Entity
-     */
-    422: UnprocessableEntityResponse;
-};
-type PostV1ContractAmendmentsError = PostV1ContractAmendmentsErrors[keyof PostV1ContractAmendmentsErrors];
-type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingRequirementsRequirementSlugDocumentsData = {
-    body?: never;
-    path: {
-        /**
-         * Employment ID
-         */
-        employment_id: string;
-        /**
-         * Pre-onboarding requirement slug
-         */
-        requirement_slug: string;
-    };
-    query?: {
-        /**
-         * When `true`, skips the email that asks the company signatory to sign the
-         * newly created document. Signature reminders are still sent while the
-         * document remains unsigned.
-         *
-         * The company signatory is the authenticated user when they are allowed to
-         * sign, otherwise the company's legal representative or owner. This parameter
-         * only takes effect when the signatory is the authenticated user, who is about
-         * to sign the document themselves. When the signatory is someone else, they
-         * are emailed right away as usual, since they still need to know about the
-         * document.
-         *
-         */
-        skip_initial_signature_email?: boolean;
-    };
-    url: '/v1/onboarding/employments/{employment_id}/pre-onboarding-requirements/{requirement_slug}/documents';
-};
-type GetV1EmploymentsEmploymentIdResponses = {
-    /**
-     * Success
-     */
-    200: EmploymentShowResponse;
-};
-type GetV1EmploymentsEmploymentIdResponse = GetV1EmploymentsEmploymentIdResponses[keyof GetV1EmploymentsEmploymentIdResponses];
-type PostV1EmploymentsEmploymentIdContractOriginData = {
-    /**
-     * Contract origin parameters
-     */
-    body: {
-        contract_origin: 'remote_contract' | 'custom_remote_contract' | 'provided_by_customer';
-        /**
-         * Required when contract_origin is remote_contract or custom_remote_contract, ignored when provided_by_customer
-         */
-        template_type: 'contractor_agreement' | 'contractor_services_agreement' | 'contractor_statement_of_work' | 'custom_contractor_agreement' | 'custom_contractor_agreement_v2';
-    };
-    path: {
-        /**
-         * Employment ID
-         */
-        employment_id: string;
-    };
-    query?: never;
-    url: '/v1/employments/{employment_id}/contract-origin';
-};
-type PostV1ContractAmendmentsAutomatableErrors = {
-    /**
-     * Unauthorized
-     */
-    401: UnauthorizedResponse;
-    /**
-     * Not Found
-     */
-    404: NotFoundResponse;
-    /**
-     * Unprocessable Entity
-     */
-    422: UnprocessableEntityResponse;
-};
-type PostV1ContractAmendmentsAutomatableError = PostV1ContractAmendmentsAutomatableErrors[keyof PostV1ContractAmendmentsAutomatableErrors];
-
-export type { SignContractDocument as $, UpdateCompanyParams as A, BadRequestResponse as B, ContractAmendmentAutomatableResponse as C, BulkContractorInvoiceScheduleCreateResponse as D, Employment as E, ForbiddenResponse as F, ConflictResponse as G, File as H, EmploymentDetailsOnlyResponse as I, TerminationDetailsParams as J, Step as K, SubStep as L, MinimalCountry as M, NotFoundResponse as N, OffboardingResponse as O, PreOnboardingRequirement as P, CreateOffboardingParams as Q, RequestError as R, SuccessResponse as S, TooManyRequestsResponse as T, UnprocessableEntityResponse as U, ValidationError as V, ListLeavePoliciesSummaryResponse as W, ListTimeoffResponse as X, TimeoffStatus as Y, TimeoffType as Z, CreateContractDocumentResponse as _, UnauthorizedResponse as a, PayrollCalendarEor as a0, HelpCenterArticle as a1, MagicLinkResponse as a2, MagicLinkParams as a3, GetV1EmploymentsEmploymentIdResponse as a4, RiskReserveProofOfPaymentResponse as a5, Company as a6, Currency as a7, UploadFileResponse as a8, FileParams as a9, ListContractorInvoiceSchedulesResponse as aa, ContractorInvoicePreviewResponse as ab, CompanyAction as ac, Country as ad, ContractorSubscriptionsSummary as ae, CreateContractDocument as af, DateTimeIso8601 as ag, EligibilityQuestionnaireResponse as ah, ConflictErrorResponse as ai, SubmitEligibilityQuestionnaireRequest as aj, ManageContractorPlusSubscriptionOperationsParams as ak, PostV1EmploymentsEmploymentIdContractOriginData as al, CreatePreOnboardingAcknowledgementResponse as am, ConvertCurrencyResponse as an, ConvertCurrencyParams as ao, EmploymentCreateParams as ap, CreatePreOnboardingDocumentResponse as aq, PostV1OnboardingEmploymentsEmploymentIdPreOnboardingRequirementsRequirementSlugDocumentsData as ar, EngagementAgreementDetailsFile as as, UnifiedEmploymentUpsertBenefitOffersRequest as at, EmploymentFullParams as au, EmploymentEngagementAgreementDetailsParams as av, CreateContractEligibilityParams as aw, ContractAmendmentResponse as b, ContractDocumentItem as c, PostV1ContractAmendmentsError as d, PostV1ContractAmendmentsAutomatableError as e, EmploymentCreationResponse as f, ContractorInvoiceSchedule as g, ContractorInvoiceScheduleResponse as h, EmploymentResponse as i, ContractorInvoiceScheduleCreateResponseFailure as j, ContractorInvoiceScheduleCreateResponseSuccess as k, Signatory as l, ContractorContractDocumentStatus as m, CompanyLegalEntity as n, CostCalculatorEstimateResponse as o, EmploymentTermType as p, CostCalculatorEmployment as q, PostV1CostCalculatorEstimationError as r, MinimalRegion as s, CostCalculatorEstimateParams as t, CostCalculatorEstimateCsvResponse as u, CostCalculatorEstimatePdfResponse as v, CompanyCreationResponse as w, CompanyCreationConflictErrorResponse as x, CreateCompanyParams as y, CompanyResponse as z };