@rippling/rippling-sdk 0.2.0-alpha.20

package/resources/headcount-positions.d.mts

@@ -0,0 +1,1059 @@
+import { APIResource } from "../core/resource.mjs";
+import * as BusinessPartnersAPI from "./business-partners.mjs";
+import * as DepartmentsAPI from "./departments.mjs";
+import * as EmploymentTypesAPI from "./employment-types.mjs";
+import * as JobRequisitionsAPI from "./job-requisitions.mjs";
+import * as LevelsAPI from "./levels.mjs";
+import * as TeamsAPI from "./teams.mjs";
+import * as WorkLocationsAPI from "./work-locations.mjs";
+import * as WorkersAPI from "./workers.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class HeadcountPositions extends APIResource {
+    /**
+     * Retrieve a specific headcount position
+     */
+    retrieve(id: string, query?: HeadcountPositionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<HeadcountPositionRetrieveResponse>;
+    /**
+     * A List of headcount positions
+     *
+     * - Requires: `Internal Testing`
+     * - Filterable fields: `created_at`, `position_id`, `position_type`,
+     *   `position_sub_type`, `department_id`, `work_location_id`, `level_id`,
+     *   `teams_id`, `job_requisition_id`, `recruiter_id`, `headcount_owner_id`,
+     *   `worker_id`, `backfill_for_id`, `employment_type_id`, `in_budget`,
+     *   `target_start_date`, `current_start_date`, `job_function_id`, `priority_id`
+     * - Expandable fields: `department`, `work_location`, `level`, `teams`,
+     *   `job_requisition`, `recruiter`, `headcount_owner`, `worker`, `backfill_for`,
+     *   `employment_type`, `priority`, `job_function`, `location_factor`
+     * - Sortable fields: `id`, `created_at`, `updated_at`, `position_id`,
+     *   `position_type`, `position_sub_type`, `department_id`, `work_location_id`,
+     *   `level_id`, `job_requisition_id`, `recruiter_id`, `headcount_owner_id`,
+     *   `worker_id`, `backfill_for_id`, `employment_type_id`, `in_budget`,
+     *   `target_start_date`, `current_start_date`, `priority_id`, `job_function_id`
+     */
+    list(query?: HeadcountPositionListParams | null | undefined, options?: RequestOptions): PagePromise<HeadcountPositionListResponsesPageCursorURL, HeadcountPositionListResponse>;
+}
+export type HeadcountPositionListResponsesPageCursorURL = PageCursorURL<HeadcountPositionListResponse>;
+/**
+ * Meta information for the response.
+ */
+export interface HeadcountPositionRetrieveResponse extends BusinessPartnersAPI.Meta {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * Compensation data synched from worker compensation
+     */
+    actual_compensation?: HeadcountPositionRetrieveResponse.ActualCompensation;
+    /**
+     * Worker for whom this headcount position was requested as a backfill
+     *
+     * Expandable field
+     */
+    backfill_for?: WorkersAPI.Worker;
+    /**
+     * ID of the worker for whom this headcount position was requested as a backfill
+     */
+    backfill_for_id?: string;
+    /**
+     * Compensation data defined through comp band
+     */
+    comp_band_compensation?: HeadcountPositionRetrieveResponse.CompBandCompensation;
+    /**
+     * Most recent start date estimate or the actual hire date if already filled
+     */
+    current_start_date?: string;
+    /**
+     * Department the headcount belongs to
+     *
+     * Expandable field
+     */
+    department?: DepartmentsAPI.Department;
+    /**
+     * ID for the department the headcount belongs to
+     */
+    department_id?: string;
+    /**
+     * Employment type the headcount is assigned to
+     *
+     * Expandable field
+     */
+    employment_type?: EmploymentTypesAPI.CompanyEmploymentType;
+    /**
+     * ID for the employment type the headcount is assigned to
+     */
+    employment_type_id?: string;
+    /**
+     * Targeted end date for the headcount
+     */
+    end_date?: string;
+    /**
+     * Owner of the headcount
+     *
+     * Expandable field
+     */
+    headcount_owner?: WorkersAPI.Worker;
+    /**
+     * ID for the headcount owner
+     */
+    headcount_owner_id?: string;
+    /**
+     * Whether the headcount position is in budget
+     */
+    in_budget?: boolean;
+    /**
+     * Job function assigned to this headcount
+     *
+     * Expandable field
+     */
+    job_function?: HeadcountPositionRetrieveResponse.JobFunction;
+    /**
+     * ID for the job function the headcount is assigned to
+     */
+    job_function_id?: string;
+    /**
+     * Job requisition the headcount is associated with
+     *
+     * Expandable field
+     */
+    job_requisition?: JobRequisitionsAPI.JobRequisition;
+    /**
+     * ID for the job requisition the headcount is associated with
+     */
+    job_requisition_id?: string;
+    /**
+     * Level the headcount is assigned to
+     *
+     * Expandable field
+     */
+    level?: LevelsAPI.Level;
+    /**
+     * ID for the level the headcount is assigned to
+     */
+    level_id?: string;
+    /**
+     * Location factor assigned to this headcount
+     *
+     * Expandable field
+     */
+    location_factor?: HeadcountPositionRetrieveResponse.LocationFactor;
+    /**
+     * ID for the location factor the headcount is assigned to
+     */
+    location_factor_id?: string;
+    /**
+     * Headcount notes
+     */
+    notes?: string;
+    /**
+     * Position name for the headcount, for ex PID100037
+     */
+    position_id?: string;
+    /**
+     * More granular type of headcount position, such as BACKFILL,
+     * FORECASTED_ATTRITION, HIRING_STAGE, etc.
+     */
+    position_sub_type?: string;
+    /**
+     * Type of headcount position, such as ACTIVE or OPEN_HEADCOUNT
+     */
+    position_type?: string;
+    /**
+     * Priority assigned to this headcount
+     *
+     * Expandable field
+     */
+    priority?: HeadcountPositionRetrieveResponse.Priority;
+    /**
+     * ID for the headcount priority
+     */
+    priority_id?: string;
+    /**
+     * Recruiter working on filling the position
+     *
+     * Expandable field
+     */
+    recruiter?: WorkersAPI.Worker;
+    /**
+     * ID for the recruiter working on filling the position
+     */
+    recruiter_id?: string;
+    /**
+     * The estimated start date when the position was first created
+     */
+    target_start_date?: string;
+    /**
+     * Teams the headcount belongs to
+     *
+     * Expandable field
+     */
+    teams?: Array<TeamsAPI.Team>;
+    /**
+     * IDs for the teams the headcount belongs to
+     */
+    teams_id?: Array<string>;
+    /**
+     * Job title for the position. For a vacant headcount position, this can be defined
+     * on creation. Once the position is occupied, it’s synched from the associated
+     * worker’s job title.
+     */
+    title?: string;
+    /**
+     * Work location the headcount is assigned to
+     *
+     * Expandable field
+     */
+    work_location?: WorkLocationsAPI.WorkLocation;
+    /**
+     * ID for the work location the headcount is assigned to
+     */
+    work_location_id?: string;
+    /**
+     * Worker hired into the headcount
+     *
+     * Expandable field
+     */
+    worker?: WorkersAPI.Worker;
+    /**
+     * ID for the worker hired into the headcount
+     */
+    worker_id?: string;
+}
+export declare namespace HeadcountPositionRetrieveResponse {
+    /**
+     * Compensation data synched from worker compensation
+     */
+    interface ActualCompensation {
+        /**
+         * Annual base pay for the headcount position
+         */
+        base_pay?: ActualCompensation.BasePay;
+        /**
+         * Annual bonus for the headcount position
+         */
+        bonus?: ActualCompensation.Bonus;
+        /**
+         * Annual on target commission for the headcount position
+         */
+        commission?: ActualCompensation.Commission;
+        /**
+         * Annual total taxes and benefits compensation for this headcount position
+         */
+        tax_and_benefits?: ActualCompensation.TaxAndBenefits;
+        /**
+         * Annual total cash compensation for the headcount position
+         */
+        total_cash?: ActualCompensation.TotalCash;
+        /**
+         * Annual total equity compensation for the headcount position
+         */
+        total_equity?: ActualCompensation.TotalEquity;
+    }
+    namespace ActualCompensation {
+        /**
+         * Annual base pay for the headcount position
+         */
+        interface BasePay {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual bonus for the headcount position
+         */
+        interface Bonus {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual on target commission for the headcount position
+         */
+        interface Commission {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total taxes and benefits compensation for this headcount position
+         */
+        interface TaxAndBenefits {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total cash compensation for the headcount position
+         */
+        interface TotalCash {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total equity compensation for the headcount position
+         */
+        interface TotalEquity {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+    }
+    /**
+     * Compensation data defined through comp band
+     */
+    interface CompBandCompensation {
+        /**
+         * Annual base pay for the headcount position
+         */
+        base_pay?: CompBandCompensation.BasePay;
+        /**
+         * Annual bonus for the headcount position
+         */
+        bonus?: CompBandCompensation.Bonus;
+        /**
+         * Annual on target commission for the headcount position
+         */
+        commission?: CompBandCompensation.Commission;
+        /**
+         * Annual total taxes and benefits compensation for this headcount position
+         */
+        tax_and_benefits?: CompBandCompensation.TaxAndBenefits;
+        /**
+         * Annual total cash compensation for the headcount position
+         */
+        total_cash?: CompBandCompensation.TotalCash;
+        /**
+         * Annual total equity compensation for the headcount position
+         */
+        total_equity?: CompBandCompensation.TotalEquity;
+    }
+    namespace CompBandCompensation {
+        /**
+         * Annual base pay for the headcount position
+         */
+        interface BasePay {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual bonus for the headcount position
+         */
+        interface Bonus {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual on target commission for the headcount position
+         */
+        interface Commission {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total taxes and benefits compensation for this headcount position
+         */
+        interface TaxAndBenefits {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total cash compensation for the headcount position
+         */
+        interface TotalCash {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total equity compensation for the headcount position
+         */
+        interface TotalEquity {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+    }
+    /**
+     * Job function assigned to this headcount
+     *
+     * Expandable field
+     */
+    interface JobFunction {
+        /**
+         * Identifier field
+         */
+        id: string;
+        /**
+         * Record creation date
+         */
+        created_at: string;
+        /**
+         * Record update date
+         */
+        updated_at: string;
+        /**
+         * Displayed name of the job function
+         */
+        name?: string;
+    }
+    /**
+     * Location factor assigned to this headcount
+     *
+     * Expandable field
+     */
+    interface LocationFactor {
+        /**
+         * Identifier field
+         */
+        id: string;
+        /**
+         * Record creation date
+         */
+        created_at: string;
+        /**
+         * Record update date
+         */
+        updated_at: string;
+        /**
+         * Compensation adjustment percentage
+         */
+        adjustment_factor?: number;
+        /**
+         * Country information set to the country code
+         */
+        country?: LocationFactor.Country;
+        /**
+         * Human-readable name for the location factor
+         */
+        display_name?: string;
+        /**
+         * The labor market category (e.g., "Engineering", "Marketing", "Sales")
+         */
+        labour_bucket?: string;
+    }
+    namespace LocationFactor {
+        /**
+         * Country information set to the country code
+         */
+        interface Country {
+            /**
+             * The code of the country.
+             */
+            code: 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RO' | 'RU' | 'RW' | 'RE' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW';
+        }
+    }
+    /**
+     * Priority assigned to this headcount
+     *
+     * Expandable field
+     */
+    interface Priority {
+        /**
+         * Identifier field
+         */
+        id: string;
+        /**
+         * Record creation date
+         */
+        created_at: string;
+        /**
+         * Record update date
+         */
+        updated_at: string;
+        /**
+         * Display name of the headcount priority
+         */
+        name?: string;
+    }
+}
+export interface HeadcountPositionListResponse {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * Compensation data synched from worker compensation
+     */
+    actual_compensation?: HeadcountPositionListResponse.ActualCompensation;
+    /**
+     * Worker for whom this headcount position was requested as a backfill
+     *
+     * Expandable field
+     */
+    backfill_for?: WorkersAPI.Worker;
+    /**
+     * ID of the worker for whom this headcount position was requested as a backfill
+     */
+    backfill_for_id?: string;
+    /**
+     * Compensation data defined through comp band
+     */
+    comp_band_compensation?: HeadcountPositionListResponse.CompBandCompensation;
+    /**
+     * Most recent start date estimate or the actual hire date if already filled
+     */
+    current_start_date?: string;
+    /**
+     * Department the headcount belongs to
+     *
+     * Expandable field
+     */
+    department?: DepartmentsAPI.Department;
+    /**
+     * ID for the department the headcount belongs to
+     */
+    department_id?: string;
+    /**
+     * Employment type the headcount is assigned to
+     *
+     * Expandable field
+     */
+    employment_type?: EmploymentTypesAPI.CompanyEmploymentType;
+    /**
+     * ID for the employment type the headcount is assigned to
+     */
+    employment_type_id?: string;
+    /**
+     * Targeted end date for the headcount
+     */
+    end_date?: string;
+    /**
+     * Owner of the headcount
+     *
+     * Expandable field
+     */
+    headcount_owner?: WorkersAPI.Worker;
+    /**
+     * ID for the headcount owner
+     */
+    headcount_owner_id?: string;
+    /**
+     * Whether the headcount position is in budget
+     */
+    in_budget?: boolean;
+    /**
+     * Job function assigned to this headcount
+     *
+     * Expandable field
+     */
+    job_function?: HeadcountPositionListResponse.JobFunction;
+    /**
+     * ID for the job function the headcount is assigned to
+     */
+    job_function_id?: string;
+    /**
+     * Job requisition the headcount is associated with
+     *
+     * Expandable field
+     */
+    job_requisition?: JobRequisitionsAPI.JobRequisition;
+    /**
+     * ID for the job requisition the headcount is associated with
+     */
+    job_requisition_id?: string;
+    /**
+     * Level the headcount is assigned to
+     *
+     * Expandable field
+     */
+    level?: LevelsAPI.Level;
+    /**
+     * ID for the level the headcount is assigned to
+     */
+    level_id?: string;
+    /**
+     * Location factor assigned to this headcount
+     *
+     * Expandable field
+     */
+    location_factor?: HeadcountPositionListResponse.LocationFactor;
+    /**
+     * ID for the location factor the headcount is assigned to
+     */
+    location_factor_id?: string;
+    /**
+     * Headcount notes
+     */
+    notes?: string;
+    /**
+     * Position name for the headcount, for ex PID100037
+     */
+    position_id?: string;
+    /**
+     * More granular type of headcount position, such as BACKFILL,
+     * FORECASTED_ATTRITION, HIRING_STAGE, etc.
+     */
+    position_sub_type?: string;
+    /**
+     * Type of headcount position, such as ACTIVE or OPEN_HEADCOUNT
+     */
+    position_type?: string;
+    /**
+     * Priority assigned to this headcount
+     *
+     * Expandable field
+     */
+    priority?: HeadcountPositionListResponse.Priority;
+    /**
+     * ID for the headcount priority
+     */
+    priority_id?: string;
+    /**
+     * Recruiter working on filling the position
+     *
+     * Expandable field
+     */
+    recruiter?: WorkersAPI.Worker;
+    /**
+     * ID for the recruiter working on filling the position
+     */
+    recruiter_id?: string;
+    /**
+     * The estimated start date when the position was first created
+     */
+    target_start_date?: string;
+    /**
+     * Teams the headcount belongs to
+     *
+     * Expandable field
+     */
+    teams?: Array<TeamsAPI.Team>;
+    /**
+     * IDs for the teams the headcount belongs to
+     */
+    teams_id?: Array<string>;
+    /**
+     * Job title for the position. For a vacant headcount position, this can be defined
+     * on creation. Once the position is occupied, it’s synched from the associated
+     * worker’s job title.
+     */
+    title?: string;
+    /**
+     * Work location the headcount is assigned to
+     *
+     * Expandable field
+     */
+    work_location?: WorkLocationsAPI.WorkLocation;
+    /**
+     * ID for the work location the headcount is assigned to
+     */
+    work_location_id?: string;
+    /**
+     * Worker hired into the headcount
+     *
+     * Expandable field
+     */
+    worker?: WorkersAPI.Worker;
+    /**
+     * ID for the worker hired into the headcount
+     */
+    worker_id?: string;
+}
+export declare namespace HeadcountPositionListResponse {
+    /**
+     * Compensation data synched from worker compensation
+     */
+    interface ActualCompensation {
+        /**
+         * Annual base pay for the headcount position
+         */
+        base_pay?: ActualCompensation.BasePay;
+        /**
+         * Annual bonus for the headcount position
+         */
+        bonus?: ActualCompensation.Bonus;
+        /**
+         * Annual on target commission for the headcount position
+         */
+        commission?: ActualCompensation.Commission;
+        /**
+         * Annual total taxes and benefits compensation for this headcount position
+         */
+        tax_and_benefits?: ActualCompensation.TaxAndBenefits;
+        /**
+         * Annual total cash compensation for the headcount position
+         */
+        total_cash?: ActualCompensation.TotalCash;
+        /**
+         * Annual total equity compensation for the headcount position
+         */
+        total_equity?: ActualCompensation.TotalEquity;
+    }
+    namespace ActualCompensation {
+        /**
+         * Annual base pay for the headcount position
+         */
+        interface BasePay {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual bonus for the headcount position
+         */
+        interface Bonus {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual on target commission for the headcount position
+         */
+        interface Commission {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total taxes and benefits compensation for this headcount position
+         */
+        interface TaxAndBenefits {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total cash compensation for the headcount position
+         */
+        interface TotalCash {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total equity compensation for the headcount position
+         */
+        interface TotalEquity {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+    }
+    /**
+     * Compensation data defined through comp band
+     */
+    interface CompBandCompensation {
+        /**
+         * Annual base pay for the headcount position
+         */
+        base_pay?: CompBandCompensation.BasePay;
+        /**
+         * Annual bonus for the headcount position
+         */
+        bonus?: CompBandCompensation.Bonus;
+        /**
+         * Annual on target commission for the headcount position
+         */
+        commission?: CompBandCompensation.Commission;
+        /**
+         * Annual total taxes and benefits compensation for this headcount position
+         */
+        tax_and_benefits?: CompBandCompensation.TaxAndBenefits;
+        /**
+         * Annual total cash compensation for the headcount position
+         */
+        total_cash?: CompBandCompensation.TotalCash;
+        /**
+         * Annual total equity compensation for the headcount position
+         */
+        total_equity?: CompBandCompensation.TotalEquity;
+    }
+    namespace CompBandCompensation {
+        /**
+         * Annual base pay for the headcount position
+         */
+        interface BasePay {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual bonus for the headcount position
+         */
+        interface Bonus {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual on target commission for the headcount position
+         */
+        interface Commission {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total taxes and benefits compensation for this headcount position
+         */
+        interface TaxAndBenefits {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total cash compensation for the headcount position
+         */
+        interface TotalCash {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * Annual total equity compensation for the headcount position
+         */
+        interface TotalEquity {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+    }
+    /**
+     * Job function assigned to this headcount
+     *
+     * Expandable field
+     */
+    interface JobFunction {
+        /**
+         * Identifier field
+         */
+        id: string;
+        /**
+         * Record creation date
+         */
+        created_at: string;
+        /**
+         * Record update date
+         */
+        updated_at: string;
+        /**
+         * Displayed name of the job function
+         */
+        name?: string;
+    }
+    /**
+     * Location factor assigned to this headcount
+     *
+     * Expandable field
+     */
+    interface LocationFactor {
+        /**
+         * Identifier field
+         */
+        id: string;
+        /**
+         * Record creation date
+         */
+        created_at: string;
+        /**
+         * Record update date
+         */
+        updated_at: string;
+        /**
+         * Compensation adjustment percentage
+         */
+        adjustment_factor?: number;
+        /**
+         * Country information set to the country code
+         */
+        country?: LocationFactor.Country;
+        /**
+         * Human-readable name for the location factor
+         */
+        display_name?: string;
+        /**
+         * The labor market category (e.g., "Engineering", "Marketing", "Sales")
+         */
+        labour_bucket?: string;
+    }
+    namespace LocationFactor {
+        /**
+         * Country information set to the country code
+         */
+        interface Country {
+            /**
+             * The code of the country.
+             */
+            code: 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RO' | 'RU' | 'RW' | 'RE' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW';
+        }
+    }
+    /**
+     * Priority assigned to this headcount
+     *
+     * Expandable field
+     */
+    interface Priority {
+        /**
+         * Identifier field
+         */
+        id: string;
+        /**
+         * Record creation date
+         */
+        created_at: string;
+        /**
+         * Record update date
+         */
+        updated_at: string;
+        /**
+         * Display name of the headcount priority
+         */
+        name?: string;
+    }
+}
+export interface HeadcountPositionRetrieveParams {
+    expand?: string;
+}
+export interface HeadcountPositionListParams {
+    expand?: string;
+    filter?: string;
+    order_by?: string;
+}
+export declare namespace HeadcountPositions {
+    export { type HeadcountPositionRetrieveResponse as HeadcountPositionRetrieveResponse, type HeadcountPositionListResponse as HeadcountPositionListResponse, type HeadcountPositionListResponsesPageCursorURL as HeadcountPositionListResponsesPageCursorURL, type HeadcountPositionRetrieveParams as HeadcountPositionRetrieveParams, type HeadcountPositionListParams as HeadcountPositionListParams, };
+}
+//# sourceMappingURL=headcount-positions.d.mts.map