@rippling/rippling-sdk 0.2.0-alpha.56 → 0.2.0-alpha.58

package/src/resources/break-types.ts

@@ -15,6 +15,8 @@ export class BreakTypes extends APIResource {
    * A list of break types.
    *
    * - Requires: `API Tier 2`
+   * - Filterable fields: `policy_id`
+   * - Expandable fields: `policy`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(
@@ -30,8 +32,12 @@ export class BreakTypes extends APIResource {
   /**
    * Retrieve a specific break type
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<BreakTypeRetrieveResponse> {
-    return this._client.get(path`/break-types/${id}/`, options);
+  retrieve(
+    id: string,
+    query: BreakTypeRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BreakTypeRetrieveResponse> {
+    return this._client.get(path`/break-types/${id}/`, { query, ...options });
   }
 }
 
@@ -67,6 +73,62 @@ export interface BreakTypeListResponse {
    * Whether this is a paid break (true) or unpaid (false).
    */
   is_paid?: boolean;
+
+  /**
+   * The break policy this break type belongs to. Use ?expand=policy to inline the
+   * full policy object.
+   *
+   * Expandable field
+   */
+  policy?: BreakTypeListResponse.Policy;
+
+  /**
+   * The ID of the break policy this break type belongs to.
+   */
+  policy_id?: string;
+}
+
+export namespace BreakTypeListResponse {
+  /**
+   * The break policy this break type belongs to. Use ?expand=policy to inline the
+   * full policy object.
+   *
+   * Expandable field
+   */
+  export interface Policy {
+    /**
+     * Identifier field
+     */
+    id: string;
+
+    /**
+     * Record creation date
+     */
+    created_at: string;
+
+    /**
+     * The display name of the break policy. For default policies this is the
+     * system-generated label (e.g. 'Default Break policy: All Workers | California');
+     * for custom policies this is the admin-provided description.
+     */
+    name: string;
+
+    /**
+     * Record update date
+     */
+    updated_at: string;
+
+    /**
+     * ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
+     */
+    country_code?: string;
+
+    /**
+     * Whether this is a system-seeded default policy (true) or a custom policy created
+     * by an admin (false).
+     */
+    is_default?: boolean;
+  }
 }
 
 /**
@@ -102,19 +164,84 @@ export interface BreakTypeRetrieveResponse extends BusinessPartnersAPI.Meta {
    * Whether this is a paid break (true) or unpaid (false).
    */
   is_paid?: boolean;
+
+  /**
+   * The break policy this break type belongs to. Use ?expand=policy to inline the
+   * full policy object.
+   *
+   * Expandable field
+   */
+  policy?: BreakTypeRetrieveResponse.Policy;
+
+  /**
+   * The ID of the break policy this break type belongs to.
+   */
+  policy_id?: string;
+}
+
+export namespace BreakTypeRetrieveResponse {
+  /**
+   * The break policy this break type belongs to. Use ?expand=policy to inline the
+   * full policy object.
+   *
+   * Expandable field
+   */
+  export interface Policy {
+    /**
+     * Identifier field
+     */
+    id: string;
+
+    /**
+     * Record creation date
+     */
+    created_at: string;
+
+    /**
+     * The display name of the break policy. For default policies this is the
+     * system-generated label (e.g. 'Default Break policy: All Workers | California');
+     * for custom policies this is the admin-provided description.
+     */
+    name: string;
+
+    /**
+     * Record update date
+     */
+    updated_at: string;
+
+    /**
+     * ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
+     */
+    country_code?: string;
+
+    /**
+     * Whether this is a system-seeded default policy (true) or a custom policy created
+     * by an admin (false).
+     */
+    is_default?: boolean;
+  }
 }
 
 export interface BreakTypeListParams {
   cursor?: string;
 
+  expand?: string;
+
+  filter?: string;
+
   order_by?: string;
 }
 
+export interface BreakTypeRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace BreakTypes {
   export {
     type BreakTypeListResponse as BreakTypeListResponse,
     type BreakTypeRetrieveResponse as BreakTypeRetrieveResponse,
     type BreakTypeListResponsesPageCursorURL as BreakTypeListResponsesPageCursorURL,
     type BreakTypeListParams as BreakTypeListParams,
+    type BreakTypeRetrieveParams as BreakTypeRetrieveParams,
   };
 }

package/src/resources/candidate-applications.ts

@@ -17,7 +17,7 @@ export class CandidateApplications extends APIResource {
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(
-    query: CandidateApplicationListParams | null | undefined = {},
+    query: CandidateApplicationListParams,
     options?: RequestOptions,
   ): PagePromise<CandidateApplicationListResponsesPageCursorURL, CandidateApplicationListResponse> {
     return this._client.getAPIList(
@@ -80,6 +80,11 @@ export interface CandidateApplicationListResponse {
 }
 
 export interface CandidateApplicationListParams {
+  /**
+   * The unique identifier of the candidate whose applications to list.
+   */
+  candidate_id: string;
+
   cursor?: string;
 
   expand?: string;

package/src/resources/employee-documents.ts

@@ -0,0 +1,179 @@
+// 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';
+
+/**
+ * Documents attached to existing employees
+ */
+export class EmployeeDocuments extends APIResource {
+  /**
+   * Create a new employee document
+   */
+  create(
+    body: EmployeeDocumentCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<EmployeeDocumentCreateResponse> {
+    return this._client.post('/employee-documents/', { body, ...options });
+  }
+}
+
+/**
+ * Top-level request body for `POST /employee-documents/`.
+ */
+export interface EmployeeDocumentCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * List of role/document items to process. No limit on number of items; total
+   * documents across all items must not exceed 250.
+   */
+  items: Array<EmployeeDocumentCreateResponse.Item>;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+}
+
+export namespace EmployeeDocumentCreateResponse {
+  /**
+   * A single item: attach `documents` to the worker identified by `worker_id`.
+   */
+  export interface Item {
+    /**
+     * Documents to attach to the role. At least one required. Each entry references a
+     * FileUploadTracker by file_id.
+     */
+    documents: Array<Item.Document>;
+
+    /**
+     * Id of the worker to attach documents to.
+     */
+    worker_id: string;
+
+    /**
+     * Optional ObjectId of the destination sub-folder on the worker's documents
+     * profile. When omitted, documents land at the root of the worker's profile
+     * (current default behavior). When supplied, the folder must exist, be in an
+     * active state, be provisioned for the target worker, and the caller must have
+     * UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.
+     */
+    folder_id?: string;
+
+    /**
+     * Fallback behavior when `folder_id` is supplied but inaccessible. 'fail'
+     * (default) rejects each affected document with FOLDER_ACCESS_ERROR.
+     * 'fallback_to_root' uploads to the worker's root profile instead and attaches a
+     * FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is
+     * omitted.
+     */
+    on_invalid_folder?: 'fail' | 'fallback_to_root';
+  }
+
+  export namespace Item {
+    /**
+     * A document to attach to a draft hire, referencing a pre-uploaded file.
+     */
+    export interface Document {
+      /**
+       * Id of a FileUploadTracker in ACTIVE status whose file should become a document
+       * on the hire
+       */
+      file_id: string;
+
+      /**
+       * Document name. Defaults to the uploaded file name when omitted.
+       */
+      name?: string;
+
+      /**
+       * Signature date in YYYY-MM-DD format.
+       */
+      signature_date?: string;
+    }
+  }
+}
+
+export interface EmployeeDocumentCreateParams {
+  /**
+   * List of role/document items to process. No limit on number of items; total
+   * documents across all items must not exceed 250.
+   */
+  items: Array<EmployeeDocumentCreateParams.Item>;
+}
+
+export namespace EmployeeDocumentCreateParams {
+  /**
+   * A single item: attach `documents` to the worker identified by `worker_id`.
+   */
+  export interface Item {
+    /**
+     * Documents to attach to the role. At least one required. Each entry references a
+     * FileUploadTracker by file_id.
+     */
+    documents: Array<Item.Document>;
+
+    /**
+     * Id of the worker to attach documents to.
+     */
+    worker_id: string;
+
+    /**
+     * Optional ObjectId of the destination sub-folder on the worker's documents
+     * profile. When omitted, documents land at the root of the worker's profile
+     * (current default behavior). When supplied, the folder must exist, be in an
+     * active state, be provisioned for the target worker, and the caller must have
+     * UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.
+     */
+    folder_id?: string;
+
+    /**
+     * Fallback behavior when `folder_id` is supplied but inaccessible. 'fail'
+     * (default) rejects each affected document with FOLDER_ACCESS_ERROR.
+     * 'fallback_to_root' uploads to the worker's root profile instead and attaches a
+     * FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is
+     * omitted.
+     */
+    on_invalid_folder?: 'fail' | 'fallback_to_root';
+  }
+
+  export namespace Item {
+    /**
+     * A document to attach to a draft hire, referencing a pre-uploaded file.
+     */
+    export interface Document {
+      /**
+       * Id of a FileUploadTracker in ACTIVE status whose file should become a document
+       * on the hire
+       */
+      file_id: string;
+
+      /**
+       * Document name. Defaults to the uploaded file name when omitted.
+       */
+      name?: string;
+
+      /**
+       * Signature date in YYYY-MM-DD format.
+       */
+      signature_date?: string;
+    }
+  }
+}
+
+export declare namespace EmployeeDocuments {
+  export {
+    type EmployeeDocumentCreateResponse as EmployeeDocumentCreateResponse,
+    type EmployeeDocumentCreateParams as EmployeeDocumentCreateParams,
+  };
+}

package/src/resources/index.ts

@@ -1,11 +1,19 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
+export {
+  BreakPolicies,
+  type BreakPolicyListResponse,
+  type BreakPolicyRetrieveResponse,
+  type BreakPolicyListParams,
+  type BreakPolicyListResponsesPageCursorURL,
+} from './break-policies';
 export {
   BreakTypes,
   type BreakTypeListResponse,
   type BreakTypeRetrieveResponse,
   type BreakTypeListParams,
+  type BreakTypeRetrieveParams,
   type BreakTypeListResponsesPageCursorURL,
 } from './break-types';
 export {
@@ -137,6 +145,11 @@ export {
   type EarningsInputCreateParams,
   type EarningsInputListResponsesPageCursorURL,
 } from './earnings-inputs';
+export {
+  EmployeeDocuments,
+  type EmployeeDocumentCreateResponse,
+  type EmployeeDocumentCreateParams,
+} from './employee-documents';
 export {
   EmploymentTypes,
   type CompanyEmploymentType,
@@ -184,6 +197,7 @@ export {
   type JobAssignmentCreateParams,
   type JobAssignmentRetrieveParams,
   type JobAssignmentUpdateParams,
+  type JobAssignmentDeleteParams,
   type JobAssignmentListChangeLogParams,
   type AttributeChangeDetailsPageCursorURL,
   type JobAssignmentsPageCursorURL,
@@ -311,11 +325,6 @@ export {
   type LocationFactorListParams,
   type LocationFactorListResponsesPageCursorURL,
 } from './location-factors';
-export {
-  Metadata,
-  type MetadataListResponse,
-  type MetadataListResponsesPageCursorURL,
-} from './metadata/metadata';
 export {
   ObjectCategories,
   type ObjectCategory,
@@ -494,6 +503,19 @@ export {
   type WorkLocationUpdateParams,
   type WorkLocationsPageCursorURL,
 } from './work-locations';
+export {
+  WorkerChangeFields,
+  type WorkerChangeFieldListResponse,
+  type WorkerChangeFieldListResponsesPageCursorURL,
+} from './worker-change-fields';
+export {
+  WorkerChanges,
+  type WorkerChangeListResponse,
+  type WorkerChangeRetrieveResponse,
+  type WorkerChangeListParams,
+  type WorkerChangeRetrieveParams,
+  type WorkerChangeListResponsesPageCursorURL,
+} from './worker-changes';
 export {
   WorkerTimeSplits,
   type WorkerTimeSplitListResponse,

package/src/resources/job-assignments.ts

@@ -58,8 +58,13 @@ export class JobAssignments extends APIResource {
   /**
    * Delete a job assignment
    */
-  delete(id: string, options?: RequestOptions): APIPromise<void> {
+  delete(
+    id: string,
+    body: JobAssignmentDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
     return this._client.delete(path`/job-assignments/${id}/`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -244,6 +249,17 @@ export interface JobAssignmentCreateParams {
    */
   worker_id: string;
 
+  /**
+   * Reason recorded on the change (e.g., the reason for scheduling an unassignment).
+   */
+  change_reason?: string;
+
+  /**
+   * Date and time the change becomes effective (ISO 8601 format, e.g.,
+   * 2025-11-07T17:00:00.000+00:00).
+   */
+  effective_from?: string;
+
   /**
    * The pay rate for job assigned to worker. This can be different from the job's
    * standard pay rate and can be overriden for a worker.
@@ -279,6 +295,17 @@ export interface JobAssignmentUpdateParams {
    */
   worker_id: string;
 
+  /**
+   * Reason recorded on the change (e.g., the reason for scheduling an unassignment).
+   */
+  change_reason?: string;
+
+  /**
+   * Date and time the change becomes effective (ISO 8601 format, e.g.,
+   * 2025-11-07T17:00:00.000+00:00).
+   */
+  effective_from?: string;
+
   /**
    * The pay rate for job assigned to worker. This can be different from the job's
    * standard pay rate and can be overriden for a worker.
@@ -299,6 +326,20 @@ export interface JobAssignmentUpdateParams {
   job_pay_rate_effective_from?: string;
 }
 
+export interface JobAssignmentDeleteParams {
+  /**
+   * Reason recorded on the scheduled unassignment.
+   */
+  change_reason?: string;
+
+  /**
+   * Date and time the unassignment becomes effective (ISO 8601 format, e.g.,
+   * 2025-11-07T17:00:00.000+00:00). When provided, schedules a future unassignment
+   * instead of deleting the job assignment immediately.
+   */
+  effective_from?: string;
+}
+
 export interface JobAssignmentListChangeLogParams {
   cursor?: string;
 
@@ -318,6 +359,7 @@ export declare namespace JobAssignments {
     type JobAssignmentCreateParams as JobAssignmentCreateParams,
     type JobAssignmentRetrieveParams as JobAssignmentRetrieveParams,
     type JobAssignmentUpdateParams as JobAssignmentUpdateParams,
+    type JobAssignmentDeleteParams as JobAssignmentDeleteParams,
     type JobAssignmentListChangeLogParams as JobAssignmentListChangeLogParams,
   };
 }

package/src/resources/scheduled-job-assignments.ts

@@ -51,7 +51,7 @@ export type ScheduledJobAssignmentListResponsesPageCursorURL =
   PageCursorURL<ScheduledJobAssignmentListResponse>;
 
 /**
- * Platform API DTO for a scheduled change targeting an EmployeeTimeTrackingJob.
+ * Platform API DTO for a scheduled job assignment or unassignment change.
  */
 export interface ScheduledJobAssignmentListResponse {
   /**
@@ -70,9 +70,9 @@ export interface ScheduledJobAssignmentListResponse {
   updated_at: string;
 
   /**
-   * Type of scheduled change: UNASSIGN or PAY_RATE_UPDATE.
+   * Type of scheduled change: ASSIGN or UNASSIGN.
    */
-  change_type?: 'UNASSIGN' | 'PAY_RATE_UPDATE';
+  change_type?: 'ASSIGN' | 'UNASSIGN';
 
   /**
    * The ID of the role that created this scheduled change.
@@ -85,12 +85,7 @@ export interface ScheduledJobAssignmentListResponse {
   effective_from?: string;
 
   /**
-   * The ID of the job assignment (ETTJ) this scheduled change targets.
-   */
-  job_assignment_id?: string;
-
-  /**
-   * The ID of the job code assigned.
+   * The ID of the job code.
    */
   job_code_id?: string;
 
@@ -100,7 +95,7 @@ export interface ScheduledJobAssignmentListResponse {
   job_code_name?: string;
 
   /**
-   * The ID of the job dimension the job code belongs to.
+   * The ID of the job dimension.
    */
   job_dimension_id?: string;
 
@@ -110,7 +105,7 @@ export interface ScheduledJobAssignmentListResponse {
   job_dimension_name?: string;
 
   /**
-   * New pay rate value, if the change modifies pay_rate.
+   * New pay rate value, if the change includes a pay rate.
    */
   pay_rate?: number;
 
@@ -120,7 +115,7 @@ export interface ScheduledJobAssignmentListResponse {
   reason?: string;
 
   /**
-   * The ID of the worker (role) the job assignment belongs to.
+   * The ID of the worker (role) the scheduled changes target.
    */
   worker_id?: string;
 }
@@ -145,9 +140,9 @@ export interface ScheduledJobAssignmentRetrieveResponse extends BusinessPartners
   updated_at: string;
 
   /**
-   * Type of scheduled change: UNASSIGN or PAY_RATE_UPDATE.
+   * Type of scheduled change: ASSIGN or UNASSIGN.
    */
-  change_type?: 'UNASSIGN' | 'PAY_RATE_UPDATE';
+  change_type?: 'ASSIGN' | 'UNASSIGN';
 
   /**
    * The ID of the role that created this scheduled change.
@@ -160,12 +155,7 @@ export interface ScheduledJobAssignmentRetrieveResponse extends BusinessPartners
   effective_from?: string;
 
   /**
-   * The ID of the job assignment (ETTJ) this scheduled change targets.
-   */
-  job_assignment_id?: string;
-
-  /**
-   * The ID of the job code assigned.
+   * The ID of the job code.
    */
   job_code_id?: string;
 
@@ -175,7 +165,7 @@ export interface ScheduledJobAssignmentRetrieveResponse extends BusinessPartners
   job_code_name?: string;
 
   /**
-   * The ID of the job dimension the job code belongs to.
+   * The ID of the job dimension.
    */
   job_dimension_id?: string;
 
@@ -185,7 +175,7 @@ export interface ScheduledJobAssignmentRetrieveResponse extends BusinessPartners
   job_dimension_name?: string;
 
   /**
-   * New pay rate value, if the change modifies pay_rate.
+   * New pay rate value, if the change includes a pay rate.
    */
   pay_rate?: number;
 
@@ -195,7 +185,7 @@ export interface ScheduledJobAssignmentRetrieveResponse extends BusinessPartners
   reason?: string;
 
   /**
-   * The ID of the worker (role) the job assignment belongs to.
+   * The ID of the worker (role) the scheduled changes target.
    */
   worker_id?: string;
 }

package/src/resources/worker-change-fields.ts

@@ -0,0 +1,64 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Historical changes to worker data over time
+ */
+export class WorkerChangeFields extends APIResource {
+  /**
+   * A list of worker change fields.
+   *
+   * - Requires: `API Tier 2`
+   */
+  list(
+    options?: RequestOptions,
+  ): PagePromise<WorkerChangeFieldListResponsesPageCursorURL, WorkerChangeFieldListResponse> {
+    return this._client.getAPIList(
+      '/worker-change-fields/',
+      PageCursorURL<WorkerChangeFieldListResponse>,
+      options,
+    );
+  }
+}
+
+export type WorkerChangeFieldListResponsesPageCursorURL = PageCursorURL<WorkerChangeFieldListResponse>;
+
+export interface WorkerChangeFieldListResponse {
+  /**
+   * High-level grouping for the field.
+   */
+  category: 'PERSONAL' | 'JOB' | 'COMPENSATION' | 'BENEFITS' | 'CUSTOM' | 'COUNTRY_SPECIFIC';
+
+  /**
+   * UI label for the field (English).
+   */
+  field_display_name: string;
+
+  /**
+   * Field key in snake_case. Use directly in ?filter=field_key eq '...' on GET
+   * /worker-changes. Naming convention: public DTO fields use the DTO field name
+   * verbatim (work_email, title); nested fields use dot notation
+   * (compensation.base_salary); custom fields use custom_fields.<custom_field_id>;
+   * country-specific fields use the ISO country prefix (us.eeo.race). Filter
+   * semantics: filtering GET /worker-changes by field_key returns events that
+   * contain at least one change to this field, but the changes[] array on those
+   * events is NOT pruned — consumers receive the full event payload including
+   * changes to other fields.
+   */
+  field_key: string;
+
+  /**
+   * Value type of the field.
+   */
+  value_type: 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'CURRENCY' | 'ENUM' | 'REFERENCE';
+}
+
+export declare namespace WorkerChangeFields {
+  export {
+    type WorkerChangeFieldListResponse as WorkerChangeFieldListResponse,
+    type WorkerChangeFieldListResponsesPageCursorURL as WorkerChangeFieldListResponsesPageCursorURL,
+  };
+}