@rippling/rippling-sdk 0.2.0-alpha.105 → 0.2.0-alpha.106

package/src/resources/hires.ts

@@ -10,9 +10,9 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Hires extends APIResource {
   /**
-   * Create or resume hire records for admin review. Idempotency-Key is required. GET
-   * /hire-requirements/ is optional discovery. First milestone is US and CA direct
-   * hire.
+   * Create or resume hire records for admin review. Idempotency-Key is required.
+   * Direct hire and EOR are supported in AU, CA, CH, CN, DE, ES, FR, GB, HK, IE, IN,
+   * NL, NZ, and US. Use POST /draft-hires/ for the legacy draft-hire write path.
    *
    * @example HTTP
    * Representative request and response shapes.
@@ -33,7 +33,6 @@ export class Hires extends APIResource {
    *       },
    *       "employment": {
    *         "employment_type_id": "employment_type_id",
-   *         "legal_entity_id": "legal_entity_id",
    *         "start_date": "start_date",
    *         "title": "title"
    *       },
@@ -93,7 +92,8 @@ export interface HireCreateResponse {
   ack: boolean;
 
   /**
-   * One result per request hire, in request order.
+   * One result per request hire, in request order. HTTP 200 means the envelope was
+   * accepted; each item's status is the outcome.
    */
   results: Array<HireCreateResponse.Result>;
 }
@@ -188,14 +188,18 @@ export interface HireCreateParams {
 }
 
 export namespace HireCreateParams {
+  /**
+   * One hire on POST /hires/. Country-specific employment fields come from GET
+   * /hire-requirements/.
+   */
   export interface Hire {
     /**
-     * Compensation intent for the hire.
+     * Pay for the hire.
      */
     compensation: Hire.Compensation;
 
     /**
-     * Employment information for the hire.
+     * The job: title, hours, and country-specific details.
      */
     employment: Hire.Employment;
 
@@ -210,34 +214,30 @@ export namespace HireCreateParams {
     work_location: Hire.WorkLocation;
 
     /**
-     * US additional employment fields such as tips, SOC, and job classification.
-     */
-    additional_employment_fields?: Hire.AdditionalEmploymentFields;
-
-    /**
-     * Caller-supplied correlation id echoed in the response.
+     * Optional id echoed on that hire's result. Not a hire field.
      */
     client_request_id?: string;
 
     /**
-     * CA vacation, probation, and notice terms. Required for CA direct hire.
+     * Company-specific hiring fields.
      */
-    country_job_fields?: Hire.CountryJobFields;
+    custom_fields?: Array<Hire.CustomField>;
 
     /**
-     * Optional hiring custom fields.
+     * direct_hire or eor. An omitted value defaults to direct_hire.
      */
-    custom_fields?: Array<Hire.CustomField>;
+    hire_type?: string;
 
     /**
-     * Optional rehire, headcount, and ATS correlation context.
+     * Optional links to an ATS applicant, open seat, prior employee, or hire already
+     * in progress.
      */
-    hire_context?: Hire.HireContext;
+    related_records?: Hire.RelatedRecords;
   }
 
   export namespace Hire {
     /**
-     * Compensation intent for the hire.
+     * Pay for the hire.
      */
     export interface Compensation {
       /**
@@ -466,7 +466,7 @@ export namespace HireCreateParams {
     }
 
     /**
-     * Employment information for the hire.
+     * The job: title, hours, and country-specific details.
      */
     export interface Employment {
       /**
@@ -474,11 +474,6 @@ export namespace HireCreateParams {
        */
       employment_type_id: string;
 
-      /**
-       * Legal entity id from GET /legal-entities/. Must be an active entity.
-       */
-      legal_entity_id: string;
-
       /**
        * Start date in YYYY-MM-DD format.
        */
@@ -489,310 +484,967 @@ export namespace HireCreateParams {
        */
       title: string;
 
+      /**
+       * Required for FR EOR. Field of work, such as Engineering.
+       */
+      applicable_fields_of_work?: string;
+
+      /**
+       * Required for AU, CA, IN, and GB EOR. True if this person is authorized to work
+       * in the country.
+       */
+      authorized_to_work?: boolean;
+
+      /**
+       * Required for ES EOR. Collective agreement area.
+       */
+      cba_area?: string;
+
+      /**
+       * Collective bargaining agreement code.
+       */
+      cba_code?: string;
+
+      /**
+       * Collective bargaining agreement group.
+       */
+      cba_group?: string;
+
+      /**
+       * Collective bargaining agreement level.
+       */
+      cba_level?: string;
+
+      /**
+       * Set to true if this person earns tips.
+       */
+      collects_tips?: boolean;
+
+      /**
+       * Required for EOR outside the US. True if this person is moving from another EOR.
+       */
+      coming_from_another_eor?: boolean;
+
+      /**
+       * Date this person first joined the company, if earlier than start_date.
+       */
+      company_start_date?: string;
+
+      /**
+       * Required for FR EOR. Project description for this hire.
+       */
+      consultant_project_description?: string;
+
+      /**
+       * Ongoing or fixed-term employment contract.
+       */
+      contract?: Employment.Contract;
+
+      /**
+       * Country-specific contract subtype.
+       */
+      contract_subtype?: string;
+
+      /**
+       * Required for CN EOR. City used for social contributions, such as SHANGHAI.
+       */
+      contributing_city?: string;
+
+      /**
+       * Social security contribution group.
+       */
+      contribution_group?: string;
+
+      /**
+       * Required for EOR. Must be true. Confirms the EOR cost-review acknowledgement.
+       */
+      cost_review_acknowledgement?: boolean;
+
+      /**
+       * Country job classification, such as MANAGING_DIRECTOR for Germany.
+       */
+      country_job_classification?: string;
+
+      /**
+       * Set to true when an Australian modern award covers this job.
+       */
+      covered_by_modern_award?: boolean;
+
+      /**
+       * Hours for each weekday. Use null for days off. Keys are monday through sunday.
+       */
+      custom_working_hours?: Employment.CustomWorkingHours;
+
+      /**
+       * France days worked each week, such as 5.
+       */
+      days_worked_per_week?: number;
+
+      /**
+       * France days worked each year. Full-time day tracking is usually 218.
+       */
+      days_worked_per_year?: number;
+
       /**
        * Department id from GET /departments/.
        */
       department_id?: string;
 
+      /**
+       * Detailed contract type.
+       */
+      detailed_contract_type?: string;
+
       /**
        * Job duties.
        */
       duties?: string;
 
       /**
-       * Optional job classification for the hire.
+       * Employee pension contribution type and value.
        */
-      job_classification?: string;
+      employee_pension_contribution?: Employment.EmployeePensionContribution;
 
       /**
-       * Job function id from GET /job-functions/.
+       * Required for CH EOR. Qualification for this role, such as Engineer.
        */
-      job_family_id?: string;
+      employee_qualification?: string;
 
       /**
-       * Level id from GET /levels/.
+       * Employer pension contribution type and value.
        */
-      level_id?: string;
+      employer_pension_contribution?: Employment.EmployerPensionContribution;
 
       /**
-       * Manager worker id from GET /workers/.
+       * Required for DE and FR EOR. Germany uses AUG. France uses LABOR_PORTAGE.
        */
-      manager_id?: string;
+      employment_model?: string;
 
       /**
-       * Overtime classification for US FLSA and CA direct hire. Public values are exempt
-       * and non-exempt.
+       * Required for EOR. Must be true. Confirms the EOR eligibility acknowledgement.
        */
-      overtime_exemption?: string;
+      eor_eligibility_acknowledgement?: boolean;
 
       /**
-       * Team ids from GET /teams/.
+       * Required for HK, CH, and NZ EOR. HK and CH must be false. NZ must be true.
        */
-      team_ids?: Array<string>;
+      eor_screenout_answer?: boolean;
 
       /**
-       * Expected weekly hours as a decimal string (for example 40 or 37.5). Required
-       * when Hiring Flow collects exact weekly hours for the country/employment type.
+       * Set if this person is an expatriate.
        */
-      weekly_hours?: string;
+      expat_identifier?: string;
 
       /**
-       * Hiring-owned weekly hours range when a range is collected instead of an exact
-       * value.
+       * Set to true if this person is on an expatriate assignment.
        */
-      weekly_hours_range?: string;
+      expatriate_assignment?: boolean;
 
       /**
-       * Work email for the hire.
+       * Pagos extra. Skip if they are not eligible.
        */
-      work_email?: string;
+      extra_monthly_payments?: unknown;
 
       /**
-       * Optional work pattern template. Use INLINE with working_hours_schedule for a
-       * custom week.
+       * Required for FR EOR. True if this hire should be a fixed-term contract.
        */
-      work_pattern_template?: Employment.WorkPatternTemplate;
+      fixed_term_contract?: boolean;
 
       /**
-       * Working hours schedule. Required when the hiring flow collects work patterns.
+       * Why the contract is fixed-term. Required when contract type is FIXED.
        */
-      working_hours_schedule?: Employment.WorkingHoursSchedule;
-    }
+      fixed_term_justification?: string;
 
-    export namespace Employment {
       /**
-       * Optional work pattern template. Use INLINE with working_hours_schedule for a
-       * custom week.
+       * Reason for a fixed-term contract. Required when contract type is FIXED.
        */
-      export interface WorkPatternTemplate {
-        /**
-         * Work pattern template id, for example US or INLINE.
-         */
-        id: string;
+      fixed_term_reason?: string;
 
-        /**
-         * Template client type. GEO_CONFIG, WORK_PATTERN, or INLINE.
-         */
-        client_type: string;
+      /**
+       * Required for DE EOR. Framework agreement additional benefits.
+       */
+      framework_additional_benefits?: string;
 
-        /**
-         * Optional display name for the template.
-         */
-        readable_name?: string;
-      }
+      /**
+       * Required for DE EOR. Framework agreement continued remuneration.
+       */
+      framework_continued_remuneration?: string;
 
       /**
-       * Working hours schedule. Required when the hiring flow collects work patterns.
+       * Required for DE EOR. Framework agreement monthly gross salary.
        */
-      export interface WorkingHoursSchedule {
-        /**
-         * Repeating week definition for the schedule.
-         */
-        recurrence: WorkingHoursSchedule.Recurrence;
+      framework_monthly_gross_salary?: Employment.FrameworkMonthlyGrossSalary;
 
-        /**
-         * IANA time zone for the schedule, for example America/Los_Angeles.
-         */
-        schedule_time_zone: string;
+      /**
+       * Required for DE EOR. Framework agreement other working conditions.
+       */
+      framework_other_conditions?: string;
 
-        /**
-         * First day of the expansion cycle. Lowercase weekday, for example sunday.
-         */
-        start_day_of_week: string;
+      /**
+       * Required for DE EOR. Framework agreement overtime pay.
+       */
+      framework_overtime_pay?: string;
 
-        /**
-         * Optional work-pattern scope. GENERIC or INLINE.
-         */
-        scope_type?: string;
-      }
+      /**
+       * Required for DE EOR. Framework agreement rest periods.
+       */
+      framework_rest_periods?: string;
 
-      export namespace WorkingHoursSchedule {
-        /**
-         * Repeating week definition for the schedule.
-         */
-        export interface Recurrence {
-          /**
-           * One entry per day in the cycle, length times 7, starting at start_day_of_week.
-           */
-          expansion: Array<Recurrence.Expansion>;
+      /**
+       * Required for DE EOR. Framework agreement shared facilities.
+       */
+      framework_shared_facilities?: string;
 
-          /**
-           * Number of units in the cycle. 1 is a weekly pattern.
-           */
-          length: number;
+      /**
+       * Required for DE EOR. Framework agreement surcharges.
+       */
+      framework_surcharges?: string;
 
-          /**
-           * Recurrence unit. Must be WEEKS.
-           */
-          unit: string;
-        }
+      /**
+       * Required for DE EOR. Framework agreement vacation days.
+       */
+      framework_vacation_days?: number;
 
-        export namespace Recurrence {
-          export interface Expansion {
-            /**
-             * Day duration as a decimal string, for example 8.00. Omit or null for an off day.
-             */
-            duration?: string;
+      /**
+       * Required for DE EOR. Framework agreement variable compensation.
+       */
+      framework_variable_compensation?: string;
 
-            /**
-             * End time as HH:MM:SS. Omit or null for an off day.
-             */
-            end_time?: string;
+      /**
+       * Required for DE EOR. Framework agreement regular weekly hours.
+       */
+      framework_weekly_hours?: number;
 
-            /**
-             * Start time as HH:MM:SS. Omit or null for an off day.
-             */
-            start_time?: string;
-          }
-        }
-      }
-    }
+      /**
+       * Required for DE EOR. Framework agreement work wear.
+       */
+      framework_work_wear?: string;
 
-    /**
-     * Personal information for the hire.
-     */
-    export interface Personal {
       /**
-       * Legal first name of the hire.
+       * Required for GB and IE EOR. True if this hire is from a merger or acquisition.
        */
-      first_name: string;
+      hired_due_to_merger?: boolean;
 
       /**
-       * Legal last name of the hire.
+       * Housing allowance amount.
        */
-      last_name: string;
+      housing_allowance?: Employment.HousingAllowance;
 
       /**
-       * Invite email. Required unless invite_phone is provided.
+       * Required for CN EOR. True if the company works with digital currency.
        */
-      invite_email?: string;
+      involved_in_digital_currency?: boolean;
 
       /**
-       * Invite phone in E.164. Required unless invite_email is provided.
+       * Set to true if this person is an apprentice.
        */
-      invite_phone?: string;
-    }
+      is_apprentice?: boolean;
 
-    /**
-     * Work location for the hire.
-     */
-    export interface WorkLocation {
       /**
-       * ISO 3166-1 alpha-2 country code. Required for on-site and remote. First
-       * milestone accepts US and CA.
+       * Set to true if this person is a cadre dirigeant.
        */
-      country_code: string;
+      is_executive?: boolean;
 
       /**
-       * When true, location_id is omitted.
+       * Set to true if this person works in R&D.
        */
-      is_remote?: boolean;
+      is_rnd_employee?: boolean;
 
       /**
-       * Work location id from GET /work-locations/. Required unless is_remote is true.
+       * Set to true when this person is an Australian shift worker.
        */
-      location_id?: string;
+      is_shift_worker?: boolean;
 
       /**
-       * Optional state or region code for a remote work location.
+       * US EEO-1 job category. Must be a value from GET /hire-requirements/
+       * allowed_values for that country.
        */
-      state_code?: string;
-    }
+      job_classification?: string;
 
-    /**
-     * US additional employment fields such as tips, SOC, and job classification.
-     */
-    export interface AdditionalEmploymentFields {
       /**
-       * Whether the worker collects tips. US catalog field.
+       * Set to true when the German job classification is already known.
        */
-      does_worker_collect_tips: boolean;
+      job_classification_known?: boolean;
 
       /**
-       * US EEOC job classification, for example PROFESSIONALS.
+       * Job function id from GET /job-functions/.
        */
-      job_classification: string;
+      job_function_id?: string;
 
       /**
-       * US SOC occupation code in NN-NNNN form, for example 15-1252.
+       * Required for CN EOR when the contributing city is Shanghai or Beijing.
        */
-      soc_code?: string;
-    }
+      job_technology_focused?: boolean;
 
-    /**
-     * CA vacation, probation, and notice terms. Required for CA direct hire.
-     */
-    export interface CountryJobFields {
       /**
-       * CA employment contract type and optional fixed-term duration. Not collected for
-       * US.
+       * Legal entity id from GET /legal-entities/. Required for direct_hire. Omit for
+       * eor.
        */
-      employment_contract: CountryJobFields.EmploymentContract;
+      legal_entity_id?: string;
 
       /**
-       * CA notice type: STANDARD_NOTICE or CUSTOM_NOTICE.
+       * Level id from GET /levels/.
        */
-      notice_type: string;
+      level_id?: string;
 
       /**
-       * CA probation type: STANDARD_PROBATION, SHORTER_PROBATION, or FORGO_PROBATION.
+       * Unpaid lunch break length in minutes.
        */
-      probation_type: string;
+      lunch_break_minutes?: number;
 
       /**
-       * CA vacation type: STATUTORY_VACATION or CUSTOM_VACATION.
+       * Manager worker id from GET /workers/. Omit or null for no manager.
        */
-      vacation_type: string;
+      manager_id?: string;
 
       /**
-       * Required when notice_type is CUSTOM_NOTICE.
+       * Required for FR EOR when a minimum contract length applies. Example: MONTHS.
        */
-      notice_quantity?: number;
+      minimum_contract_length_unit?: string;
 
       /**
-       * Required when notice_type is CUSTOM_NOTICE.
+       * Required for FR EOR when a minimum contract length applies.
        */
-      notice_unit?: string;
+      minimum_contract_length_value?: number;
 
       /**
-       * Required when probation_type is SHORTER_PROBATION.
+       * Required for FR EOR when a mission applies. Description of the mission or
+       * project.
        */
-      probation_quantity?: number;
+      mission_description?: string;
 
       /**
-       * Required when probation_type is SHORTER_PROBATION.
+       * Modern award that covers this job, if any.
        */
-      probation_unit?: string;
+      modern_award?: string;
 
       /**
-       * Required when vacation_type is CUSTOM_VACATION.
+       * Classification under that modern award.
        */
-      vacation_days?: number;
-    }
+      modern_award_classification?: string;
 
-    export namespace CountryJobFields {
       /**
-       * CA employment contract type and optional fixed-term duration. Not collected for
-       * US.
+       * Sub-level within that modern award classification.
        */
-      export interface EmploymentContract {
-        /**
-         * CA employment contract type: FIXED or INDEFINITE.
-         */
-        type: string;
+      modern_award_sub_level?: string;
 
-        /**
-         * Fixed-term duration unit when type is FIXED: DAYS, WEEKS, MONTHS, or YEARS.
-         * Required by Hiring Flow for FIXED contracts; omit for INDEFINITE.
-         */
-        duration_unit?: string;
+      /**
+       * Months of experience at this level before joining.
+       */
+      months_of_experience_at_level?: number;
 
-        /**
-         * Fixed-term duration length when type is FIXED. Required by Hiring Flow for FIXED
-         * contracts once duration_unit is set; omit for INDEFINITE.
-         */
-        duration_value?: number;
-      }
+      /**
+       * Set to true if they work remotely more than two days a week.
+       */
+      more_than_two_remote_days?: boolean;
+
+      /**
+       * Extra employer MPF contribution, if you offer one.
+       */
+      mpf_voluntary_employer_contribution?: Employment.MpfVoluntaryEmployerContribution;
+
+      /**
+       * Required for FR EOR. ISO country code, such as FR.
+       */
+      nationality?: string;
+
+      /**
+       * Required for AU, CA, IN, and GB EOR. True if a non-compete clause applies.
+       */
+      non_compete?: boolean;
+
+      /**
+       * Required for CH EOR. True if this person is not covered by a collective
+       * agreement.
+       */
+      not_cba_employee?: boolean;
+
+      /**
+       * Standard notice, or a custom notice period.
+       */
+      notice?: Employment.Notice;
+
+      /**
+       * Spanish occupation code (CNO).
+       */
+      occupation_code?: string;
+
+      /**
+       * EXEMPT or NON_EXEMPT. EXEMPT means the job is not eligible for overtime pay.
+       */
+      overtime_exemption?: 'EXEMPT' | 'NON_EXEMPT';
+
+      /**
+       * Required for NL EOR. True if the company has its own entity in the Netherlands.
+       */
+      owns_entity_in_country?: boolean;
+
+      /**
+       * Required for GB EOR. Company-provided paid sick days.
+       */
+      paid_sick_days?: number;
+
+      /**
+       * France PCS occupation code, such as 100X.
+       */
+      pcs_code?: string;
+
+      /**
+       * Pension scheme name.
+       */
+      pension_scheme_name?: string;
+
+      /**
+       * Standard probation, a shorter period, or no probation.
+       */
+      probation?: Employment.Probation;
+
+      /**
+       * Set to true if prior seniority should count.
+       */
+      recognize_seniority?: boolean;
+
+      /**
+       * Required for remote CH EOR. Currency type and value. Use 0 if none.
+       */
+      remote_working_allowance?: Employment.RemoteWorkingAllowance;
+
+      /**
+       * Rent tax deduction rate, if it applies.
+       */
+      rent_tax_deduction_rate?: string;
+
+      /**
+       * Required for FR EOR. Id of an active file upload owned by this company. Upload
+       * with POST /files/ using the documents.read-write scope, PUT the bytes to the
+       * returned URL, then POST /files/{id}/confirm-upload/ before sending this id. PDF
+       * or Word only. A URL is not accepted.
+       */
+      resume_file_id?: string;
+
+      /**
+       * Required for CH EOR. FIXED_SCHEDULE or ROTATING_SHIFT_SCHEDULE.
+       */
+      schedule_type?: string;
+
+      /**
+       * US occupation code, such as 15-1252.
+       */
+      soc_code?: string;
+
+      /**
+       * Required for FR EOR. True if this is a specific mission completing within 18
+       * months.
+       */
+      specific_mission?: boolean;
+
+      /**
+       * Tax bracket.
+       */
+      tax_bracket?: string;
+
+      /**
+       * Tax location.
+       */
+      tax_location?: string;
+
+      /**
+       * Tax status.
+       */
+      tax_status?: string;
+
+      /**
+       * Team ids from GET /teams/.
+       */
+      team_ids?: Array<string>;
+
+      /**
+       * Required for CH EOR. Currency type and value for the 13th month bonus.
+       */
+      thirteenth_month_bonus?: Employment.ThirteenthMonthBonus;
+
+      /**
+       * Set to true when Spain requires training for this job.
+       */
+      training_required?: boolean;
+
+      /**
+       * Transportation allowance amount.
+       */
+      transportation_allowance?: Employment.TransportationAllowance;
+
+      /**
+       * Required for NL EOR. True if a collective agreement applies.
+       */
+      union_activity?: boolean;
+
+      /**
+       * Set to true to start tenure on the start date. False keeps a prior tenure date
+       * unset.
+       */
+      use_default_tenure?: boolean;
+
+      /**
+       * Statutory vacation, or a custom number of days.
+       */
+      vacation?: Employment.Vacation;
+
+      /**
+       * Vacation entitlement for this job.
+       */
+      vacation_entitlement?: string;
+
+      /**
+       * Required for GB EOR. Vacation days that can roll over.
+       */
+      vacation_rollover_days?: number;
+
+      /**
+       * Required for FR EOR when the hire includes a signing bonus, target bonus, or
+       * commission. Same upload sequence as resume_file_id. PDF or Word only. A URL is
+       * not accepted.
+       */
+      variable_compensation_plan_file_id?: string;
+
+      /**
+       * Hours this person is expected to work each week, such as 40. Full-time is
+       * usually 40.
+       */
+      weekly_hours?: string;
+
+      /**
+       * Weekly hours range when a range is collected instead of an exact value.
+       */
+      weekly_hours_range?: string;
+
+      /**
+       * Work center.
+       */
+      work_center?: string;
+
+      /**
+       * Work email for the hire.
+       */
+      work_email?: string;
+
+      /**
+       * Days worked, such as Monday through Friday.
+       */
+      working_days?: Array<string>;
+
+      /**
+       * Workday end time in HH:MM:SS, such as 17:00:00.
+       */
+      working_hours_end?: string;
+
+      /**
+       * Working hours calendar. Omit unless you need day-level hours.
+       */
+      working_hours_schedule?: Employment.WorkingHoursSchedule;
+
+      /**
+       * Workday start time in HH:MM:SS, such as 09:00:00.
+       */
+      working_hours_start?: string;
+
+      /**
+       * IANA timezone for the workday, such as Australia/Sydney.
+       */
+      working_hours_timezone?: string;
+
+      /**
+       * Required for CN EOR. STANDARD_WORKING_HOURS or FLEXIBLE_WORKING_HOURS.
+       */
+      working_hours_type?: string;
+
+      /**
+       * Required for DE EOR. True is rejected. A standard hire is false.
+       */
+      working_in_construction?: boolean;
+
+      /**
+       * France working time unit, DAYS or HOURS.
+       */
+      working_time_tracked_in?: string;
+    }
+
+    export namespace Employment {
+      /**
+       * Ongoing or fixed-term employment contract.
+       */
+      export interface Contract {
+        /**
+         * Ongoing or fixed-term employment contract: FIXED or INDEFINITE.
+         */
+        type: string;
+
+        /**
+         * Fixed-term duration unit when type is FIXED: DAYS, WEEKS, MONTHS, or YEARS.
+         * Required when type is FIXED; omit for INDEFINITE.
+         */
+        duration_unit?: string;
+
+        /**
+         * Fixed-term duration length when type is FIXED. Required when type is FIXED once
+         * duration_unit is set; omit for INDEFINITE.
+         */
+        duration_value?: number;
+      }
+
+      /**
+       * Hours for each weekday. Use null for days off. Keys are monday through sunday.
+       */
+      export interface CustomWorkingHours {
+        /**
+         * Hours worked on Friday.
+         */
+        friday?: string;
+
+        /**
+         * Hours worked on Monday.
+         */
+        monday?: string;
+
+        /**
+         * Hours worked on Saturday.
+         */
+        saturday?: string;
+
+        /**
+         * Hours worked on Sunday.
+         */
+        sunday?: string;
+
+        /**
+         * Hours worked on Thursday.
+         */
+        thursday?: string;
+
+        /**
+         * Hours worked on Tuesday.
+         */
+        tuesday?: string;
+
+        /**
+         * Hours worked on Wednesday.
+         */
+        wednesday?: string;
+      }
+
+      /**
+       * Employee pension contribution type and value.
+       */
+      export interface EmployeePensionContribution {
+        /**
+         * Contribution type.
+         */
+        type?: string;
+
+        /**
+         * Contribution value.
+         */
+        value?: string;
+      }
+
+      /**
+       * Employer pension contribution type and value.
+       */
+      export interface EmployerPensionContribution {
+        /**
+         * Contribution type.
+         */
+        type?: string;
+
+        /**
+         * Contribution value.
+         */
+        value?: string;
+      }
+
+      /**
+       * Required for DE EOR. Framework agreement monthly gross salary.
+       */
+      export interface FrameworkMonthlyGrossSalary {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+      }
+
+      /**
+       * Housing allowance amount.
+       */
+      export interface HousingAllowance {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+      }
+
+      /**
+       * Extra employer MPF contribution, if you offer one.
+       */
+      export interface MpfVoluntaryEmployerContribution {
+        /**
+         * Fixed contribution amount.
+         */
+        fixed_amount?: MpfVoluntaryEmployerContribution.FixedAmount;
+
+        /**
+         * Contribution percent.
+         */
+        percent?: string;
+
+        /**
+         * Contribution type.
+         */
+        type?: string;
+      }
+
+      export namespace MpfVoluntaryEmployerContribution {
+        /**
+         * Fixed contribution amount.
+         */
+        export interface FixedAmount {
+          /**
+           * The currency type, ex: USD, EUR, etc.
+           */
+          currency_type?: string;
+
+          /**
+           * The decimal amount for the currency.
+           */
+          value?: number;
+        }
+      }
+
+      /**
+       * Standard notice, or a custom notice period.
+       */
+      export interface Notice {
+        /**
+         * Standard notice, or a custom notice period.
+         */
+        type: string;
+
+        /**
+         * Length of the custom notice period.
+         */
+        quantity?: number;
+
+        /**
+         * Time unit for custom notice, such as WEEKS.
+         */
+        unit?: string;
+      }
+
+      /**
+       * Standard probation, a shorter period, or no probation.
+       */
+      export interface Probation {
+        /**
+         * Standard probation, a shorter period, or no probation.
+         */
+        type: string;
+
+        /**
+         * Length of a shorter probation.
+         */
+        quantity?: number;
+
+        /**
+         * Time unit for a shorter probation, such as MONTHS.
+         */
+        unit?: string;
+      }
+
+      /**
+       * Required for remote CH EOR. Currency type and value. Use 0 if none.
+       */
+      export interface RemoteWorkingAllowance {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+      }
+
+      /**
+       * Required for CH EOR. Currency type and value for the 13th month bonus.
+       */
+      export interface ThirteenthMonthBonus {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+      }
+
+      /**
+       * Transportation allowance amount.
+       */
+      export interface TransportationAllowance {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+      }
+
+      /**
+       * Statutory vacation, or a custom number of days.
+       */
+      export interface Vacation {
+        /**
+         * Statutory vacation, or a custom number of days.
+         */
+        type: string;
+
+        /**
+         * Vacation days per year. Required when vacation is custom.
+         */
+        days?: number;
+      }
+
+      /**
+       * Working hours calendar. Omit unless you need day-level hours.
+       */
+      export interface WorkingHoursSchedule {
+        /**
+         * Repeating week definition for the schedule.
+         */
+        recurrence: WorkingHoursSchedule.Recurrence;
+
+        /**
+         * IANA time zone for the schedule, for example America/Los_Angeles.
+         */
+        schedule_time_zone: string;
+
+        /**
+         * First day of the expansion cycle. Lowercase weekday, for example sunday.
+         */
+        start_day_of_week: string;
+
+        /**
+         * Optional work-pattern scope. GENERIC or INLINE.
+         */
+        scope_type?: string;
+      }
+
+      export namespace WorkingHoursSchedule {
+        /**
+         * Repeating week definition for the schedule.
+         */
+        export interface Recurrence {
+          /**
+           * One entry per day in the cycle, length times 7, starting at start_day_of_week.
+           */
+          expansion: Array<Recurrence.Expansion>;
+
+          /**
+           * Number of units in the cycle. 1 is a weekly pattern.
+           */
+          length: number;
+
+          /**
+           * Recurrence unit. Must be WEEKS.
+           */
+          unit: string;
+        }
+
+        export namespace Recurrence {
+          export interface Expansion {
+            /**
+             * Day duration as a decimal string, for example 8.00. Omit or null for an off day.
+             */
+            duration?: string;
+
+            /**
+             * End time as HH:MM:SS. Omit or null for an off day.
+             */
+            end_time?: string;
+
+            /**
+             * Start time as HH:MM:SS. Omit or null for an off day.
+             */
+            start_time?: string;
+          }
+        }
+      }
+    }
+
+    /**
+     * Personal information for the hire.
+     */
+    export interface Personal {
+      /**
+       * Legal first name of the hire.
+       */
+      first_name: string;
+
+      /**
+       * Legal last name of the hire.
+       */
+      last_name: string;
+
+      /**
+       * Email used to invite this person. Send an email or a phone number.
+       */
+      invite_email?: string;
+
+      /**
+       * Mobile number used to invite this person, including country code, such as
+       * +14155550123. Send an email or a phone number.
+       */
+      invite_phone?: string;
+    }
+
+    /**
+     * Work location for the hire.
+     */
+    export interface WorkLocation {
+      /**
+       * Country this person works in. Required for office and remote hires.
+       */
+      country_code: string;
+
+      /**
+       * Set to true if this person has no office. You still need the country they work
+       * in.
+       */
+      is_remote?: boolean;
+
+      /**
+       * Office this person will work from. Skip this if they work remotely.
+       */
+      location_id?: string;
+
+      /**
+       * Optional state or region code for a remote work location.
+       */
+      state_code?: string;
     }
 
     export interface CustomField {
@@ -808,31 +1460,32 @@ export namespace HireCreateParams {
     }
 
     /**
-     * Optional rehire, headcount, and ATS correlation context.
+     * Optional links to an ATS applicant, open seat, prior employee, or hire already
+     * in progress.
      */
-    export interface HireContext {
+    export interface RelatedRecords {
       /**
-       * Optional ATS applicant id for correlation.
+       * Applicant id from your ATS, if this hire came from recruiting.
        */
       ats_applicant_id?: string;
 
       /**
-       * Optional existing in-progress hire role id.
+       * Hire already started in Rippling, if you are continuing it.
        */
       existing_role_id?: string;
 
       /**
-       * Optional headcount position id (PID) to hire into.
+       * Open seat this person is filling.
        */
       headcount_position_id?: string;
 
       /**
-       * Required with rehire_role_id. REUSE_EMPLOYEE_DETAILS or NEW_EMPLOYEE_DETAILS.
+       * Reuse their existing details, or collect new details. Required when rehiring.
        */
       rehire_choice?: string;
 
       /**
-       * Prior terminated role id when initiating a rehire.
+       * Prior employee role to rehire.
        */
       rehire_role_id?: string;
     }