@rippling/rippling-sdk 0.2.0-alpha.21 → 0.2.0-alpha.23

package/resources/draft-hires.d.mts

@@ -0,0 +1,415 @@
+import { APIResource } from "../core/resource.mjs";
+import * as Shared from "./shared.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class DraftHires extends APIResource {
+    /**
+     * Create bulk draft hire
+     */
+    create(body: DraftHireCreateParams, options?: RequestOptions): APIPromise<DraftHireCreateResponse>;
+}
+/**
+ * Response model for bulk draft hire creation.
+ */
+export interface DraftHireCreateResponse {
+    /**
+     * List of invalid draft hire requests
+     */
+    invalid_items?: Array<DraftHireCreateResponse.InvalidItem>;
+    /**
+     * Detailed results for each draft hire item
+     */
+    successful_results?: Array<DraftHireCreateResponse.SuccessfulResult>;
+}
+export declare namespace DraftHireCreateResponse {
+    /**
+     * Result for an individual draft hire creation.
+     */
+    interface InvalidItem {
+        /**
+         * Status of the creation (success, error, warning)
+         */
+        status: string;
+        /**
+         * Generated draft hire ID if successful
+         */
+        draft_hire_id?: string;
+        /**
+         * List of validation errors if any
+         */
+        errors?: Array<string>;
+        /**
+         * Success or error message
+         */
+        message?: string;
+    }
+    /**
+     * Result for an individual draft hire creation.
+     */
+    interface SuccessfulResult {
+        /**
+         * Status of the creation (success, error, warning)
+         */
+        status: string;
+        /**
+         * Generated draft hire ID if successful
+         */
+        draft_hire_id?: string;
+        /**
+         * List of validation errors if any
+         */
+        errors?: Array<string>;
+        /**
+         * Success or error message
+         */
+        message?: string;
+    }
+}
+export interface DraftHireCreateParams {
+    /**
+     * List of draft hires
+     */
+    draft_hires: Array<DraftHireCreateParams.DraftHire>;
+}
+export declare namespace DraftHireCreateParams {
+    /**
+     * A draft hire represents a candidate who has been offered a position but hasn't started yet.
+     *
+     *     This class provides Platform API access to draft hire data stored as RoleWithCompany instances
+     *     in a candidate state, allowing external systems to create and manage draft hires.
+     */
+    interface DraftHire {
+        /**
+         * Employment information for the draft hire position
+         */
+        employment_info: DraftHire.EmploymentInfo;
+        /**
+         * Personal information for the draft hire candidate
+         */
+        personal_info: DraftHire.PersonalInfo;
+        /**
+         * Work location information
+         */
+        work_location_info: DraftHire.WorkLocationInfo;
+        /**
+         * Custom fields for the draft hire
+         */
+        custom_fields?: Array<DraftHire.CustomField>;
+    }
+    namespace DraftHire {
+        /**
+         * Employment information for the draft hire position
+         */
+        interface EmploymentInfo {
+            /**
+             * Employment type ID
+             */
+            employment_type_id: string;
+            /**
+             * Title
+             */
+            title: string;
+            /**
+             * Contract end date
+             */
+            contract_end_date?: string;
+            /**
+             * Currency
+             */
+            currency?: string;
+            /**
+             * Department ID
+             */
+            department_id?: string;
+            /**
+             * Duties
+             */
+            duties?: string;
+            /**
+             * Equity number of shares
+             */
+            equity_num_shares?: number;
+            /**
+             * Equity value
+             */
+            equity_value?: number;
+            /**
+             * Equity vesting schedule
+             */
+            equity_vesting_schedule?: EmploymentInfo.EquityVestingSchedule;
+            /**
+             * Job title
+             */
+            job_title?: string;
+            /**
+             * Legal entity ID
+             */
+            legal_entity_id?: string;
+            /**
+             * Level ID
+             */
+            level_id?: string;
+            /**
+             * Manager ID
+             */
+            manager_id?: string;
+            /**
+             * Offer expiration date
+             */
+            offer_expiration_date?: string;
+            /**
+             * On target commission
+             */
+            on_target_commission?: number;
+            /**
+             * Overtime exemption
+             */
+            overtime_exemption?: 'exempt' | 'non-exempt';
+            /**
+             * Probation end date
+             */
+            probation_end_date?: string;
+            /**
+             * Relocation reimbursement
+             */
+            relocation_reimbursement?: number;
+            /**
+             * Salary per unit
+             */
+            salary_per_unit?: number;
+            /**
+             * Salary unit
+             */
+            salary_unit?: string;
+            /**
+             * Signing bonus
+             */
+            signing_bonus?: number;
+            /**
+             * Start date
+             */
+            start_date?: string;
+            /**
+             * Target annual bonus
+             */
+            target_annual_bonus?: number;
+            /**
+             * Teams IDs
+             */
+            teams_ids?: Array<string>;
+            /**
+             * Weekly hours
+             */
+            weekly_hours?: number;
+            /**
+             * Work email
+             */
+            work_email?: string;
+        }
+        namespace EmploymentInfo {
+            /**
+             * Equity vesting schedule
+             */
+            interface EquityVestingSchedule {
+                /**
+                 * Required company ID for the vesting schedule
+                 */
+                company_id: string;
+                /**
+                 * Name of the vesting schedule
+                 */
+                _name?: string;
+                /**
+                 * Number of cliff months before vesting begins
+                 */
+                cliffMonths?: number;
+                /**
+                 * Number of continuous vesting months
+                 */
+                continuousVestingMonths?: number;
+                /**
+                 * Percentage of initial vesting as decimal
+                 */
+                percentageInitialVesting?: number;
+                /**
+                 * Spoke ID for the vesting schedule
+                 */
+                spokeId?: string;
+                /**
+                 * Total number of vesting months
+                 */
+                totalVestingMonths?: number;
+                /**
+                 * Total number of vesting years
+                 */
+                totalVestingYears?: number;
+                /**
+                 * Type of vesting schedule
+                 */
+                vestingType?: string;
+            }
+        }
+        /**
+         * Personal information for the draft hire candidate
+         */
+        interface PersonalInfo {
+            /**
+             * Invite email of the candidate
+             */
+            invite_email: string;
+            /**
+             * Name of the candidate
+             */
+            name: PersonalInfo.Name;
+            /**
+             * Citizenship of the candidate
+             */
+            citizenship?: string;
+            /**
+             * Date of birth
+             */
+            date_of_birth?: string;
+            /**
+             * Emergency contact name
+             */
+            emergency_contact_name?: string;
+            /**
+             * Emergency contact phone
+             */
+            emergency_contact_phone?: PersonalInfo.EmergencyContactPhone;
+            /**
+             * Ethnicity of the candidate
+             */
+            ethnicity?: string;
+            /**
+             * Gender of the candidate
+             */
+            gender?: string;
+            /**
+             * Home address of the candidate
+             */
+            home_address?: Shared.Address;
+            /**
+             * Locale of the candidate
+             */
+            locale?: PersonalInfo.Locale;
+            /**
+             * Race of the candidate
+             */
+            race?: string;
+            /**
+             * Social security number of the candidate
+             */
+            ssn?: string;
+        }
+        namespace PersonalInfo {
+            /**
+             * Name of the candidate
+             */
+            interface Name {
+                /**
+                 * First name or given name
+                 */
+                first?: string;
+                /**
+                 * Last name or family name
+                 */
+                last?: string;
+                /**
+                 * Middle name(s)
+                 */
+                middle?: string;
+                /**
+                 * Preferred nickname or informal name
+                 */
+                nickname?: string;
+                /**
+                 * Name suffix (e.g., Jr., Sr., III)
+                 */
+                suffix?: string;
+                /**
+                 * Title or honorific (e.g., Mr., Ms., Dr.)
+                 */
+                title?: string;
+            }
+            /**
+             * Emergency contact phone
+             */
+            interface EmergencyContactPhone {
+                /**
+                 * Country code for the phone number
+                 */
+                country_code?: string;
+                /**
+                 * Phone number extension
+                 */
+                extension?: string;
+                /**
+                 * National phone number without country code
+                 */
+                national_number?: string;
+            }
+            /**
+             * Locale of the candidate
+             */
+            interface Locale {
+                /**
+                 * The primary language code
+                 */
+                language_code?: string;
+                /**
+                 * Additional language inspection data
+                 */
+                language_inspection?: Array<string>;
+                /**
+                 * The locale code for formatting
+                 */
+                locale_code?: string;
+                /**
+                 * The region code
+                 */
+                region_code?: string;
+                /**
+                 * The user's timezone
+                 */
+                timezone?: string;
+            }
+        }
+        /**
+         * Work location information
+         */
+        interface WorkLocationInfo {
+            /**
+             * Country code of the work location
+             */
+            country_code?: string;
+            /**
+             * Whether the work location is remote
+             */
+            is_remote?: boolean;
+            /**
+             * Work location ID
+             */
+            location_id?: string;
+        }
+        /**
+         * Custom field information for a draft hire.
+         *
+         *     Custom fields are associated with RoleWithCompany model.
+         */
+        interface CustomField {
+            /**
+             * Name of the custom field
+             */
+            field_name: string;
+            /**
+             * Value of the custom field
+             */
+            field_value: unknown;
+        }
+    }
+}
+export declare namespace DraftHires {
+    export { type DraftHireCreateResponse as DraftHireCreateResponse, type DraftHireCreateParams as DraftHireCreateParams, };
+}
+//# sourceMappingURL=draft-hires.d.mts.map

package/resources/draft-hires.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"draft-hires.d.mts","sourceRoot":"","sources":["../src/resources/draft-hires.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGnG;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;IAE3D;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;CACtE;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;CACrD;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;;;;OAKG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,eAAe,EAAE,SAAS,CAAC,cAAc,CAAC;QAE1C;;WAEG;QACH,aAAa,EAAE,SAAS,CAAC,YAAY,CAAC;QAEtC;;WAEG;QACH,kBAAkB,EAAE,SAAS,CAAC,gBAAgB,CAAC;QAE/C;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;KAC9C;IAED,UAAiB,SAAS,CAAC;QACzB;;WAEG;QACH,UAAiB,cAAc;YAC7B;;eAEG;YACH,kBAAkB,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,uBAAuB,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;YAE/D;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAE/B;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;eAEG;YACH,kBAAkB,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;YAE7C;;eAEG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B;;eAEG;YACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;YAElC;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE1B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;QAED,UAAiB,cAAc,CAAC;YAC9B;;eAEG;YACH,UAAiB,qBAAqB;gBACpC;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;gBAEjC;;mBAEG;gBACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;gBAElC;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;gBAE5B;;mBAEG;gBACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;gBAE3B;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;aACtB;SACF;QAED;;WAEG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC;YAExB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;YAEhC;;eAEG;YACH,uBAAuB,CAAC,EAAE,YAAY,CAAC,qBAAqB,CAAC;YAE7D;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;YAE9B;;eAEG;YACH,MAAM,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC;YAE7B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,YAAY,CAAC;YAC5B;;eAEG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd;;mBAEG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;YAED;;eAEG;YACH,UAAiB,qBAAqB;gBACpC;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,eAAe,CAAC,EAAE,MAAM,CAAC;aAC1B;YAED;;eAEG;YACH,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,aAAa,CAAC,EAAE,MAAM,CAAC;gBAEvB;;mBAEG;gBACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAEpC;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;aACnB;SACF;QAED;;WAEG;QACH,UAAiB,gBAAgB;YAC/B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,SAAS,CAAC,EAAE,OAAO,CAAC;YAEpB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;QAED;;;;WAIG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,OAAO,CAAC;SACtB;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}