@remoteoss/remote-flows 0.2.2 → 0.4.0-alpha.0

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

@@ -0,0 +1,947 @@
+type MinimalRegion = {
+    child_regions?: Array<MinimalRegion>;
+    code?: string | null;
+    name: string;
+    slug: string;
+    status?: RegionStatus;
+};
+type TerminationOffboarding = {
+    additional_comments: string;
+    agrees_to_pto_amount?: string;
+    confidential: boolean;
+    employee_awareness?: {
+        date?: string | null;
+        note?: string | null;
+    };
+    employment_id: string;
+    id: string;
+    proposed_termination_date: string;
+    reason_description: string;
+    requested_by: string;
+    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'>;
+    status: 'submitted' | 'in_review' | 'done' | 'canceled';
+    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;
+    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';
+    type: 'termination';
+    will_challenge_termination: boolean;
+    will_challenge_termination_description?: string;
+};
+type MinimalCountry = {
+    alpha_2_code: string;
+    code: string;
+    features?: Array<string>;
+    name: string;
+    slug: string;
+};
+/**
+ * Complete information of an employment
+ */
+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;
+    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;
+    full_name: string;
+    /**
+     * 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';
+    employment_lifecycle_stage: EmploymentLifecycleStage;
+    /**
+     * Administrative information. Its properties may vary depending on the country.
+     */
+    administrative_details: {
+        [key: string]: unknown;
+    };
+    company_id: string;
+    work_email: string;
+    status: EmploymentStatus;
+    updated_at: string;
+    /**
+     * Employment basic information. Its properties may vary depending on the country.
+     *
+     */
+    basic_information?: {
+        [key: string]: unknown;
+    };
+    job_title: string;
+    id: string;
+    probation_period_end_date?: string;
+    /**
+     * Unique ID of related department, if any. Otherwise, null.
+     */
+    department_id?: string | null;
+    manager?: 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;
+    personal_email: string;
+    country: Country;
+    user_status?: UserStatus;
+    seniority_date?: EmploymentSeniorityDate;
+    bank_account_details: Array<{
+        [key: string]: unknown;
+    }>;
+    files: Array<File>;
+    active_contract_id?: string;
+    /**
+     * 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;
+    };
+    eligible_for_onboarding_cancellation: boolean;
+    manager_employment_id: string | null;
+    created_at: string;
+};
+type CostCalculatorEstimatePdfResponse = {
+    data: {
+        content: GenericFile;
+    };
+};
+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;
+};
+/**
+ * Complete information of an employment
+ */
+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;
+        };
+    };
+};
+/**
+ * Complete information of an employment
+ */
+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.
+     */
+    basic_information?: {
+        [key: string]: unknown;
+    };
+    company_id?: string;
+    country_code?: string;
+    created_at?: string;
+    employment_lifecycle_stage?: EmploymentLifecycleStage;
+    full_name?: string;
+    id?: UuidSlug;
+    job_title?: string;
+    personal_email?: string;
+    /**
+     * Required for employees, optional for contractors
+     */
+    provisional_start_date?: string;
+    type?: 'employee' | 'contractor';
+    updated_at?: string;
+};
+/**
+ * Optional UTC date time in YYYY-MM-DDTHH:mm:ss format
+ */
+type NullableDateTime = string | null;
+type CostCalculatorEmploymentParam = {
+    age?: number;
+    annual_gross_salary?: number;
+    annual_gross_salary_in_employer_currency?: number;
+    benefits?: Array<CostCalculatorBenefitParam>;
+    employment_term?: EmploymentTermType;
+    region_slug: string;
+    regional_to_employer_exchange_rate?: string;
+    title?: string;
+};
+/**
+ * A supported country on Remote
+ */
+type Country = {
+    alpha_2_code: string;
+    code: string;
+    country_subdivisions?: Array<CountrySubdivision> | null;
+    eor_onboarding?: boolean;
+    locked_benefits?: string;
+    name: string;
+    region?: string;
+    subregion?: string | null;
+    supported_json_schemas?: Array<string>;
+};
+/**
+ * The status of the user
+ */
+type UserStatus = 'active' | 'created' | 'initiated' | 'cancelled' | 'inactive' | 'deleted';
+type CostCalculatorEstimateParams = {
+    /**
+     * Currency Slug
+     */
+    employer_currency_slug: string;
+    employments: Array<CostCalculatorEmploymentParam>;
+    include_benefits?: boolean;
+    include_cost_breakdowns?: boolean;
+    include_premium_benefits?: boolean;
+};
+/**
+ * Offboarding
+ */
+type Offboarding = {
+    offboarding?: ResignationOffboarding | TerminationOffboarding;
+};
+type NotFoundResponse = {
+    message?: string;
+};
+type CostCalculatorEstimateResponse = {
+    data: {
+        employments?: Array<CostCalculatorEmployment>;
+    };
+};
+/**
+ * [TZ identifier](https://www.iana.org/time-zones)
+ */
+type Timezone = string;
+type ResignationOffboarding = {
+    additional_comments?: string;
+    employer_awareness?: string;
+    employment_id: string;
+    id: string;
+    proposed_last_working_day: string;
+    reason_description?: string;
+    requested_by: string;
+    resignation_reason: 'cancellation_before_start_date' | 'company_culture_or_values' | 'conversion_to_contractor' | 'conversion_to_global_payroll' | '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';
+    status: 'submitted' | 'in_review' | 'done' | 'canceled';
+    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;
+    type: 'resignation';
+};
+/**
+ * A supported file
+ */
+type File = {
+    id: string;
+    inserted_at: DateTimeIso8601;
+    name: string;
+    sub_type?: string | null;
+    type: string;
+};
+/**
+ * Offboarding response
+ */
+type OffboardingResponse = {
+    data?: Offboarding;
+};
+/**
+ * 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;
+/**
+ * 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;
+type OffboardingFile = {
+    /**
+     * The content in base64 encoding
+     */
+    content: Blob | File;
+    /**
+     * The file name
+     */
+    name: string;
+};
+type UnprocessableEntityResponse = {
+    errors: {
+        [key: string]: unknown;
+    };
+} | {
+    message: string | ParameterError | Array<ParameterError> | ActionError | Array<ActionError>;
+};
+type EmploymentTermType = 'fixed' | 'indefinite';
+/**
+ * The type of money in general use in a particular country
+ */
+type Currency = {
+    code: string;
+    name?: string;
+    slug: string;
+    symbol: string;
+};
+/**
+ * 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;
+type RegionStatus = 'active' | 'inactive';
+type CostCalculatorCost = {
+    amount: number;
+    description: string | null;
+    name: string;
+    zendesk_article_url: string | null;
+};
+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;
+    annual_indirect_tax?: number;
+    /**
+     * The annual gross salary + annual contributions + annual fee (monthly fee * 12) + extra statutory payments if applicable
+     */
+    annual_total: number;
+    currency: Currency;
+    /**
+     * 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 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 gross monthly salary for the Employee
+     */
+    monthly_gross_salary: number;
+    monthly_indirect_tax?: number;
+    /**
+     * Monthly gross salary + monthly contributions  (doesn't include fee)
+     */
+    monthly_tce: number;
+    /**
+     * Monthly gross salary + monthly contributions + monthly fee
+     */
+    monthly_total: number;
+};
+/**
+ * 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;
+};
+/**
+ * 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;
+/**
+ * Contract Amendment
+ */
+type ContractAmendment = {
+    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;
+    };
+    employment_id: string;
+    id: string;
+    request_details: RequestDetails;
+    requested_by: string;
+    status: ContractAmendmentStatus;
+    submitted_at: string;
+    zendesk_ticket_url: string | null;
+};
+/**
+ * Description and status of an onboarding task.
+ */
+type TaskDescription = {
+    description?: string;
+    /**
+     * The status of the task
+     */
+    status?: 'completed' | 'pending';
+};
+/**
+ * A subdivision of a supported country on Remote
+ */
+type CountrySubdivision = {
+    code?: string;
+    name: string;
+    subdivision_type?: string;
+};
+/**
+ * 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;
+    };
+};
+/**
+ * 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';
+/**
+ * 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;
+    };
+};
+/**
+ * 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;
+};
+type EmploymentCreationResponse = {
+    data?: {
+        employment?: EmploymentBasicResponse;
+    };
+};
+/**
+ * The status of employment
+ */
+type EmploymentStatus = 'active' | 'created' | 'created_awaiting_reserve' | 'created_reserve_paid' | 'initiated' | 'invited' | 'pending' | 'review' | 'archived' | 'deleted';
+type CostCalculatorEmployment = {
+    country: MinimalCountry;
+    employer_currency_costs: CostCalculatorCosts;
+    has_extra_statutory_payment: boolean;
+    region: MinimalRegion;
+    regional_currency_costs: CostCalculatorCosts;
+};
+type UuidSlug = string;
+type SuccessResponse = {
+    data: {
+        status?: string;
+    };
+};
+type LeavePolicy = {
+    leave_policy_variant_slug: string;
+    leave_type: TimeoffType;
+    name: string;
+};
+type TooManyRequestsResponse = {
+    message?: string;
+};
+type ConflictResponse = {
+    message?: string;
+};
+/**
+ * TimeoffDay schema
+ */
+type TimeoffDay = {
+    day: _Date;
+    hours: number;
+};
+type BadRequestResponse = {
+    message: string;
+} | {
+    message?: {
+        code: string;
+        message: string;
+    };
+};
+type UnauthorizedResponse = {
+    message: string;
+};
+/**
+ * Selected type of payment.
+ */
+type PricingPlanDetails = {
+    frequency: 'annually' | 'monthly';
+};
+type ContractAmendmentStatus = 'submitted' | 'in_review' | 'done' | 'canceled' | 'deleted';
+/**
+ * UTC date time in [ISO 8601][] format.
+ *
+ * [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
+ *
+ */
+type DateTimeIso8601 = string;
+type CostCalculatorBenefitParam = {
+    /**
+     * Benefit Group Slug
+     */
+    benefit_group_slug: string;
+    /**
+     * Benefit Tier Slug
+     */
+    benefit_tier_slug: string;
+};
+type TerminationDetailsParams = {
+    acknowledge_termination_procedure?: boolean | null;
+    /**
+     * Additional details regarding the termination process.
+     */
+    additional_comments?: string;
+    agrees_to_pto_amount?: boolean | null;
+    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;
+    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;
+};
+/**
+ * UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
+ */
+type _Date = string;
+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;
+};
+type GenericFile = Blob | File;
+type TimeoffType = 'paid_time_off' | 'sick_leave' | 'public_holiday' | 'unpaid_leave' | 'extended_leave' | 'in_lieu_time' | 'maternity_leave' | 'paternity_leave' | 'parental_leave' | 'bereavement' | 'military_leave' | 'other';
+/**
+ * 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;
+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;
+    };
+};
+type Timeoff = {
+    approved_at?: string | null;
+    approver_id?: NullableApproverId;
+    automatic?: boolean;
+    cancel_reason?: string | null;
+    cancelled_at?: NullableDateTime;
+    document?: File;
+    employment_id: string;
+    end_date: string;
+    id: string;
+    leave_policy: LeavePolicy;
+    notes?: string | null;
+    start_date: string;
+    status: 'requested' | 'approved' | 'cancelled' | 'declined' | 'taken' | 'cancel_requested';
+    timeoff_days: Array<TimeoffDay>;
+    timeoff_type: TimeoffType;
+    timezone: Timezone;
+};
+/**
+ * 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;
+    };
+    /**
+     * This optional field is deprecated.
+     */
+    company_id?: string;
+    country_code: 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;
+    /**
+     * If not provided, it will default to `employee`.
+     */
+    type?: 'employee' | 'contractor';
+};
+type TimeoffStatus = 'approved' | 'cancelled' | 'declined' | 'requested' | 'taken' | 'cancel_requested';
+type ForbiddenResponse = {
+    message: string;
+};
+/**
+ * Complete information of an employment
+ */
+type EmploymentResponse = {
+    data: {
+        employment?: Employment;
+    };
+};
+/**
+ * Contract Amendment response
+ */
+type ContractAmendmentResponse = {
+    data?: {
+        contract_amendment: ContractAmendment;
+    };
+};
+type PostCreateOffboardingErrors = {
+    /**
+     * Bad Request
+     */
+    400: BadRequestResponse;
+    /**
+     * Unauthorized
+     */
+    401: UnauthorizedResponse;
+    /**
+     * Not Found
+     */
+    404: NotFoundResponse;
+    /**
+     * Unprocessable Entity
+     */
+    422: UnprocessableEntityResponse;
+    /**
+     * Too many requests
+     */
+    429: TooManyRequestsResponse;
+    /**
+     * Internal Server Error
+     */
+    500: RequestError;
+};
+type PostCreateOffboardingError = PostCreateOffboardingErrors[keyof PostCreateOffboardingErrors];
+type PostCreateEmployment2Errors = {
+    /**
+     * Bad Request
+     */
+    400: BadRequestResponse;
+    /**
+     * Unauthorized
+     */
+    401: UnauthorizedResponse;
+    /**
+     * Not Found
+     */
+    404: NotFoundResponse;
+    /**
+     * Unprocessable Entity
+     */
+    422: UnprocessableEntityResponse;
+    /**
+     * Too many requests
+     */
+    429: TooManyRequestsResponse;
+};
+type PostCreateEmployment2Error = PostCreateEmployment2Errors[keyof PostCreateEmployment2Errors];
+type PostCreateEstimationErrors = {
+    /**
+     * Not Found
+     */
+    404: NotFoundResponse;
+    /**
+     * Unprocessable Entity
+     */
+    422: UnprocessableEntityResponse;
+};
+type PostCreateEstimationError = PostCreateEstimationErrors[keyof PostCreateEstimationErrors];
+type PutUpdateBenefitOfferErrors = {
+    /**
+     * Unauthorized
+     */
+    401: UnauthorizedResponse;
+    /**
+     * Forbidden
+     */
+    403: ForbiddenResponse;
+    /**
+     * Not Found
+     */
+    404: NotFoundResponse;
+    /**
+     * Unprocessable Entity
+     */
+    422: UnprocessableEntityResponse;
+};
+type PutUpdateBenefitOfferError = PutUpdateBenefitOfferErrors[keyof PutUpdateBenefitOfferErrors];
+type PostCreateEstimationPdfErrors = {
+    /**
+     * Not Found
+     */
+    404: NotFoundResponse;
+    /**
+     * Unprocessable Entity
+     */
+    422: UnprocessableEntityResponse;
+};
+type PostCreateEstimationPdfError = PostCreateEstimationPdfErrors[keyof PostCreateEstimationPdfErrors];
+type PostCreateContractAmendmentErrors = {
+    /**
+     * Unauthorized
+     */
+    401: UnauthorizedResponse;
+    /**
+     * Not Found
+     */
+    404: NotFoundResponse;
+    /**
+     * Unprocessable Entity
+     */
+    422: UnprocessableEntityResponse;
+};
+type PostCreateContractAmendmentError = PostCreateContractAmendmentErrors[keyof PostCreateContractAmendmentErrors];
+type PatchUpdateEmployment2Errors = {
+    /**
+     * Bad Request
+     */
+    400: BadRequestResponse;
+    /**
+     * Unauthorized
+     */
+    401: UnauthorizedResponse;
+    /**
+     * Not Found
+     */
+    404: NotFoundResponse;
+    /**
+     * Conflict
+     */
+    409: ConflictResponse;
+    /**
+     * Unprocessable Entity
+     */
+    422: UnprocessableEntityResponse;
+    /**
+     * Too many requests
+     */
+    429: TooManyRequestsResponse;
+};
+type PatchUpdateEmployment2Error = PatchUpdateEmployment2Errors[keyof PatchUpdateEmployment2Errors];
+type PostAutomatableContractAmendmentErrors = {
+    /**
+     * Unauthorized
+     */
+    401: UnauthorizedResponse;
+    /**
+     * Not Found
+     */
+    404: NotFoundResponse;
+    /**
+     * Unprocessable Entity
+     */
+    422: UnprocessableEntityResponse;
+};
+type PostAutomatableContractAmendmentError = PostAutomatableContractAmendmentErrors[keyof PostAutomatableContractAmendmentErrors];
+type PostInviteEmploymentInvitationErrors = {
+    /**
+     * Bad Request
+     */
+    400: BadRequestResponse;
+    /**
+     * Conflict
+     */
+    409: ConflictResponse;
+    /**
+     * Unprocessable Entity
+     */
+    422: UnprocessableEntityResponse;
+    /**
+     * Unprocessable Entity
+     */
+    429: TooManyRequestsResponse;
+};
+type PostInviteEmploymentInvitationError = PostInviteEmploymentInvitationErrors[keyof PostInviteEmploymentInvitationErrors];
+
+export type { ContractAmendmentAutomatableResponse as C, EmploymentShowResponse as E, ListTimeoffResponse as L, OffboardingResponse as O, PostAutomatableContractAmendmentError as P, SuccessResponse as S, TerminationDetailsParams as T, ContractAmendmentResponse as a, PostCreateContractAmendmentError as b, CostCalculatorEstimateResponse as c, PostCreateEstimationError as d, CostCalculatorEstimatePdfResponse as e, PostCreateEstimationPdfError as f, CostCalculatorEstimateParams as g, EmploymentTermType as h, PostCreateOffboardingError as i, EmploymentCreationResponse as j, PostCreateEmployment2Error as k, EmploymentResponse as l, PatchUpdateEmployment2Error as m, PutUpdateBenefitOfferError as n, PostInviteEmploymentInvitationError as o, EmploymentCreateParams as p, TimeoffStatus as q };