@rippling/rippling-sdk 0.2.0-alpha.24 → 0.2.0-alpha.26

package/src/resources/job-requisitions-write.ts

@@ -0,0 +1,327 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class JobRequisitionsWrite extends APIResource {
+  /**
+   * Create a new job requisition
+   */
+  create(
+    body: JobRequisitionsWriteCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<JobRequisitionsWriteCreateResponse> {
+    return this._client.post('/job-requisitions-write', { body, ...options });
+  }
+}
+
+/**
+ * DTO for creating JobRequisitions via the Platform API.
+ *     Maps to the existing ATS JobRequisitionDTO for use with create_from_DTO service.
+ */
+export interface JobRequisitionsWriteCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Title/name of the job requisition
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Whether this requisition is confidential
+   */
+  confidential?: boolean;
+
+  /**
+   * List of role IDs allowed to view confidential requisition
+   */
+  confidential_whitelist?: Array<string>;
+
+  /**
+   * Coordinator role ID
+   */
+  coordinator_id?: string;
+
+  /**
+   * Whether to default to private invites
+   */
+  default_private_invites?: boolean;
+
+  /**
+   * List of department IDs
+   */
+  departments?: Array<string>;
+
+  /**
+   * Job description
+   */
+  description?: string;
+
+  /**
+   * Company employment type ID
+   */
+  employment_type_id?: string;
+
+  /**
+   * Hiring manager role ID
+   */
+  hiring_manager_id?: string;
+
+  /**
+   * Whether this is an evergreen requisition
+   */
+  is_evergreen?: boolean;
+
+  /**
+   * List of level IDs
+   */
+  levels?: Array<string>;
+
+  /**
+   * Pipeline plan ID to use for this requisition
+   */
+  pipeline_plan_id?: string;
+
+  /**
+   * Primary recruiter role ID
+   */
+  recruiter_id?: string;
+
+  /**
+   * Customer-defined requisition ID. Auto-generated if not provided.
+   */
+  requisition_id?: string;
+
+  /**
+   * Salary currency code
+   */
+  salary_currency?: string;
+
+  /**
+   * Salary amount per unit
+   */
+  salary_per_unit?: number;
+
+  /**
+   * Salary range upper bound
+   */
+  salary_per_unit_high?: number;
+
+  /**
+   * Salary range lower bound
+   */
+  salary_per_unit_low?: number;
+
+  /**
+   * Salary type
+   */
+  salary_type?: string;
+
+  /**
+   * Salary unit (HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD)
+   */
+  salary_unit?: string;
+
+  /**
+   * List of secondary recruiter role IDs
+   */
+  secondary_recruiters?: Array<string>;
+
+  /**
+   * Sourcer role ID
+   */
+  sourcer_id?: string;
+
+  /**
+   * Job requisition status (e.g., DRAFT, OPEN, CLOSED)
+   */
+  status?: string;
+
+  /**
+   * Target close date
+   */
+  target_close?: string;
+
+  /**
+   * Target employee start date
+   */
+  target_employee_start_date?: string;
+
+  /**
+   * List of team IDs
+   */
+  teams?: Array<string>;
+
+  /**
+   * Internal employee title
+   */
+  title?: string;
+
+  /**
+   * List of work location IDs
+   */
+  work_locations?: Array<string>;
+}
+
+export interface JobRequisitionsWriteCreateParams {
+  /**
+   * Title/name of the job requisition
+   */
+  name: string;
+
+  /**
+   * Whether this requisition is confidential
+   */
+  confidential?: boolean;
+
+  /**
+   * List of role IDs allowed to view confidential requisition
+   */
+  confidential_whitelist?: Array<string>;
+
+  /**
+   * Coordinator role ID
+   */
+  coordinator_id?: string;
+
+  /**
+   * Whether to default to private invites
+   */
+  default_private_invites?: boolean;
+
+  /**
+   * List of department IDs
+   */
+  departments?: Array<string>;
+
+  /**
+   * Job description
+   */
+  description?: string;
+
+  /**
+   * Company employment type ID
+   */
+  employment_type_id?: string;
+
+  /**
+   * Hiring manager role ID
+   */
+  hiring_manager_id?: string;
+
+  /**
+   * Whether this is an evergreen requisition
+   */
+  is_evergreen?: boolean;
+
+  /**
+   * List of level IDs
+   */
+  levels?: Array<string>;
+
+  /**
+   * Pipeline plan ID to use for this requisition
+   */
+  pipeline_plan_id?: string;
+
+  /**
+   * Primary recruiter role ID
+   */
+  recruiter_id?: string;
+
+  /**
+   * Customer-defined requisition ID. Auto-generated if not provided.
+   */
+  requisition_id?: string;
+
+  /**
+   * Salary currency code
+   */
+  salary_currency?: string;
+
+  /**
+   * Salary amount per unit
+   */
+  salary_per_unit?: number;
+
+  /**
+   * Salary range upper bound
+   */
+  salary_per_unit_high?: number;
+
+  /**
+   * Salary range lower bound
+   */
+  salary_per_unit_low?: number;
+
+  /**
+   * Salary type
+   */
+  salary_type?: string;
+
+  /**
+   * Salary unit (HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD)
+   */
+  salary_unit?: string;
+
+  /**
+   * List of secondary recruiter role IDs
+   */
+  secondary_recruiters?: Array<string>;
+
+  /**
+   * Sourcer role ID
+   */
+  sourcer_id?: string;
+
+  /**
+   * Job requisition status (e.g., DRAFT, OPEN, CLOSED)
+   */
+  status?: string;
+
+  /**
+   * Target close date
+   */
+  target_close?: string;
+
+  /**
+   * Target employee start date
+   */
+  target_employee_start_date?: string;
+
+  /**
+   * List of team IDs
+   */
+  teams?: Array<string>;
+
+  /**
+   * Internal employee title
+   */
+  title?: string;
+
+  /**
+   * List of work location IDs
+   */
+  work_locations?: Array<string>;
+}
+
+export declare namespace JobRequisitionsWrite {
+  export {
+    type JobRequisitionsWriteCreateResponse as JobRequisitionsWriteCreateResponse,
+    type JobRequisitionsWriteCreateParams as JobRequisitionsWriteCreateParams,
+  };
+}

package/src/resources/leave-accruals.ts

@@ -4,19 +4,28 @@ import { APIResource } from '../core/resource';
 import * as BusinessPartnersAPI from './business-partners';
 import * as WorkersAPI from './workers';
 import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class LeaveAccruals extends APIResource {
   /**
-   * Retrieve a specific leave accrual
-   */
-  retrieve(
-    id: string,
-    query: LeaveAccrualRetrieveParams | null | undefined = {},
+   * A List of leave accruals
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `worker_id`, `leave_type_id`, `accrual_date`
+   * - Expandable fields: `worker`, `grantor`
+   * - Sortable fields: `id`, `created_at`, `updated_at`, `accrual_date`,
+   *   `expiration_date`
+   */
+  list(
+    query: LeaveAccrualListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<LeaveAccrualRetrieveResponse> {
-    return this._client.get(path`/leave-accruals/${id}`, { query, ...options });
+  ): PagePromise<LeaveAccrualListResponsesPageCursorURL, LeaveAccrualListResponse> {
+    return this._client.getAPIList('/leave-accruals', PageCursorURL<LeaveAccrualListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -25,12 +34,28 @@ export class LeaveAccruals extends APIResource {
   create(body: LeaveAccrualCreateParams, options?: RequestOptions): APIPromise<LeaveAccrualCreateResponse> {
     return this._client.post('/leave-accruals', { body, ...options });
   }
+
+  /**
+   * Retrieve a specific leave accrual
+   */
+  retrieve(
+    id: string,
+    query: LeaveAccrualRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LeaveAccrualRetrieveResponse> {
+    return this._client.get(path`/leave-accruals/${id}`, { query, ...options });
+  }
 }
 
+export type LeaveAccrualListResponsesPageCursorURL = PageCursorURL<LeaveAccrualListResponse>;
+
 /**
- * Meta information for the response.
+ * Leave accrual resource representing time off credits granted to employees.
+ *
+ *     Leave accruals track the allocation of paid time off (vacation, sick days, etc.)
+ *     to employees based on company policies, manual grants, or other accrual sources.
  */
-export interface LeaveAccrualRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface LeaveAccrualListResponse {
   /**
    * Identifier field
    */
@@ -67,6 +92,30 @@ export interface LeaveAccrualRetrieveResponse extends BusinessPartnersAPI.Meta {
    */
   worker_id: string;
 
+  /**
+   * The type of accrual
+   */
+  accrual_type?:
+    | 'AUTO'
+    | 'CARRYOVER_PENALTY'
+    | 'RESET_PENALTY'
+    | 'RESET_NEGATIVE_PENALTY'
+    | 'BALANCE_PENALTY'
+    | 'LEAVE_GRANT'
+    | 'BALANCE_CORRECTION_ADJUSTMENT'
+    | 'PAID_OUT'
+    | 'SUB_BALANCE_EXPIRATION'
+    | 'TANDA_ACCRUAL_BONUS'
+    | 'TILT_ADJUSTMENT'
+    | 'WORKFLOW_ACTION'
+    | 'EXPIRATION_DEDUCTION'
+    | 'EXPIRATION_PAYOUT'
+    | 'MANUAL_BALANCE_PAYOUT'
+    | 'CARRYOVER_PENALTY_PAYOUT'
+    | 'RESET_PENALTY_PAYOUT'
+    | 'HOLIDAY_ADJUSTMENT'
+    | 'HOURS_WORKED_TANDA';
+
   /**
    * The comment for this accrual. This is required if the leave policy requires a
    * comment on accruals.
@@ -153,6 +202,30 @@ export interface LeaveAccrualCreateResponse {
    */
   worker_id: string;
 
+  /**
+   * The type of accrual
+   */
+  accrual_type?:
+    | 'AUTO'
+    | 'CARRYOVER_PENALTY'
+    | 'RESET_PENALTY'
+    | 'RESET_NEGATIVE_PENALTY'
+    | 'BALANCE_PENALTY'
+    | 'LEAVE_GRANT'
+    | 'BALANCE_CORRECTION_ADJUSTMENT'
+    | 'PAID_OUT'
+    | 'SUB_BALANCE_EXPIRATION'
+    | 'TANDA_ACCRUAL_BONUS'
+    | 'TILT_ADJUSTMENT'
+    | 'WORKFLOW_ACTION'
+    | 'EXPIRATION_DEDUCTION'
+    | 'EXPIRATION_PAYOUT'
+    | 'MANUAL_BALANCE_PAYOUT'
+    | 'CARRYOVER_PENALTY_PAYOUT'
+    | 'RESET_PENALTY_PAYOUT'
+    | 'HOLIDAY_ADJUSTMENT'
+    | 'HOURS_WORKED_TANDA';
+
   /**
    * The comment for this accrual. This is required if the leave policy requires a
    * comment on accruals.
@@ -196,8 +269,121 @@ export interface LeaveAccrualCreateResponse {
   worker?: WorkersAPI.Worker;
 }
 
-export interface LeaveAccrualRetrieveParams {
+/**
+ * Meta information for the response.
+ */
+export interface LeaveAccrualRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The date when this accrual becomes effective
+   */
+  accrual_date: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The ID of the worker who granted this accrual. This is typically the Time Off
+   * admin.
+   */
+  grantor_id: string;
+
+  /**
+   * The company leave type ID associated with this accrual
+   */
+  leave_type_id: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The ID of the worker for whom the accrual is for
+   */
+  worker_id: string;
+
+  /**
+   * The type of accrual
+   */
+  accrual_type?:
+    | 'AUTO'
+    | 'CARRYOVER_PENALTY'
+    | 'RESET_PENALTY'
+    | 'RESET_NEGATIVE_PENALTY'
+    | 'BALANCE_PENALTY'
+    | 'LEAVE_GRANT'
+    | 'BALANCE_CORRECTION_ADJUSTMENT'
+    | 'PAID_OUT'
+    | 'SUB_BALANCE_EXPIRATION'
+    | 'TANDA_ACCRUAL_BONUS'
+    | 'TILT_ADJUSTMENT'
+    | 'WORKFLOW_ACTION'
+    | 'EXPIRATION_DEDUCTION'
+    | 'EXPIRATION_PAYOUT'
+    | 'MANUAL_BALANCE_PAYOUT'
+    | 'CARRYOVER_PENALTY_PAYOUT'
+    | 'RESET_PENALTY_PAYOUT'
+    | 'HOLIDAY_ADJUSTMENT'
+    | 'HOURS_WORKED_TANDA';
+
+  /**
+   * The comment for this accrual. This is required if the leave policy requires a
+   * comment on accruals.
+   */
+  comment?: string;
+
+  /**
+   * The date when this accrual expires (if applicable)
+   */
+  expiration_date?: string;
+
+  /**
+   * The worker who granted this accrual. This is typically the Time Off admin.
+   *
+   * Expandable field
+   */
+  grantor?: WorkersAPI.Worker;
+
+  /**
+   * The monetary value of this accrual (for policies with monetary tracking)
+   */
+  monetary_amount_accrued?: number;
+
+  /**
+   * The number of days accrued. It can be negative for deductions. This is
+   * applicable if the policy tracks in days.
+   */
+  num_days?: number;
+
+  /**
+   * The number of hours accrued. It can be negative for deductions. This is
+   * applicable if the policy tracks in hours.
+   */
+  num_hours?: number;
+
+  /**
+   * The worker for whom the accrual is for
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export interface LeaveAccrualListParams {
+  cursor?: string;
+
   expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
 }
 
 export interface LeaveAccrualCreateParams {
@@ -222,6 +408,30 @@ export interface LeaveAccrualCreateParams {
    */
   worker_id: string;
 
+  /**
+   * The type of accrual
+   */
+  accrual_type?:
+    | 'AUTO'
+    | 'CARRYOVER_PENALTY'
+    | 'RESET_PENALTY'
+    | 'RESET_NEGATIVE_PENALTY'
+    | 'BALANCE_PENALTY'
+    | 'LEAVE_GRANT'
+    | 'BALANCE_CORRECTION_ADJUSTMENT'
+    | 'PAID_OUT'
+    | 'SUB_BALANCE_EXPIRATION'
+    | 'TANDA_ACCRUAL_BONUS'
+    | 'TILT_ADJUSTMENT'
+    | 'WORKFLOW_ACTION'
+    | 'EXPIRATION_DEDUCTION'
+    | 'EXPIRATION_PAYOUT'
+    | 'MANUAL_BALANCE_PAYOUT'
+    | 'CARRYOVER_PENALTY_PAYOUT'
+    | 'RESET_PENALTY_PAYOUT'
+    | 'HOLIDAY_ADJUSTMENT'
+    | 'HOURS_WORKED_TANDA';
+
   /**
    * The comment for this accrual. This is required if the leave policy requires a
    * comment on accruals.
@@ -251,11 +461,18 @@ export interface LeaveAccrualCreateParams {
   num_hours?: number;
 }
 
+export interface LeaveAccrualRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace LeaveAccruals {
   export {
-    type LeaveAccrualRetrieveResponse as LeaveAccrualRetrieveResponse,
+    type LeaveAccrualListResponse as LeaveAccrualListResponse,
     type LeaveAccrualCreateResponse as LeaveAccrualCreateResponse,
-    type LeaveAccrualRetrieveParams as LeaveAccrualRetrieveParams,
+    type LeaveAccrualRetrieveResponse as LeaveAccrualRetrieveResponse,
+    type LeaveAccrualListResponsesPageCursorURL as LeaveAccrualListResponsesPageCursorURL,
+    type LeaveAccrualListParams as LeaveAccrualListParams,
     type LeaveAccrualCreateParams as LeaveAccrualCreateParams,
+    type LeaveAccrualRetrieveParams as LeaveAccrualRetrieveParams,
   };
 }