@rippling/rippling-sdk 0.2.0-alpha.55 → 0.2.0-alpha.57

package/src/resources/employee-documents.ts

@@ -0,0 +1,141 @@
+// 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. Max 1 per request.
+   */
+  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. Max 50 per role item. Each entry references a
+     * FileUploadTracker by file_id.
+     */
+    documents: Array<Item.Document>;
+
+    /**
+     * Id of the worker to attach documents to.
+     */
+    worker_id: string;
+  }
+
+  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. Max 1 per request.
+   */
+  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. Max 50 per role item. Each entry references a
+     * FileUploadTracker by file_id.
+     */
+    documents: Array<Item.Document>;
+
+    /**
+     * Id of the worker to attach documents to.
+     */
+    worker_id: string;
+  }
+
+  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

@@ -137,6 +137,11 @@ export {
   type EarningsInputCreateParams,
   type EarningsInputListResponsesPageCursorURL,
 } from './earnings-inputs';
+export {
+  EmployeeDocuments,
+  type EmployeeDocumentCreateResponse,
+  type EmployeeDocumentCreateParams,
+} from './employee-documents';
 export {
   EmploymentTypes,
   type CompanyEmploymentType,
@@ -494,6 +499,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

@@ -244,6 +244,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 +290,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.

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,
+  };
+}

package/src/resources/worker-changes.ts

@@ -0,0 +1,354 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+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';
+
+/**
+ * Historical changes to worker data over time
+ */
+export class WorkerChanges extends APIResource {
+  /**
+   * A list of worker changes.
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `worker_id`, `applied_on`, `effective_on`, `changed_by_id`,
+   *   `reason_code`, `field_key`, `event_type`
+   * - Expandable fields: `worker`, `changed_by`
+   * - Sortable fields: `id`, `created_at`, `updated_at`, `applied_on`,
+   *   `effective_on`
+   */
+  list(
+    query: WorkerChangeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<WorkerChangeListResponsesPageCursorURL, WorkerChangeListResponse> {
+    return this._client.getAPIList('/worker-changes/', PageCursorURL<WorkerChangeListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific worker change
+   */
+  retrieve(
+    id: string,
+    query: WorkerChangeRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WorkerChangeRetrieveResponse> {
+    return this._client.get(path`/worker-changes/${id}/`, { query, ...options });
+  }
+}
+
+export type WorkerChangeListResponsesPageCursorURL = PageCursorURL<WorkerChangeListResponse>;
+
+export interface WorkerChangeListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * When the change was persisted (approval time for changes that went through an
+   * approval workflow). UTC. Monotonically increasing as new commits land; use as
+   * the cursor axis for incremental polling.
+   */
+  applied_on: string;
+
+  /**
+   * Field-level changes captured by this event. Per-field REDACTED entries appear
+   * for fields the caller cannot read so consumers can detect that a change occurred
+   * even when the value is hidden. Events where every changed field is invisible to
+   * the caller — either internal fields not exposed via the public Object Graph, or
+   * fields the caller's role has zero read permission on — are dropped from the
+   * response entirely (they never appear with an all-REDACTED changes array).
+   */
+  changes: Array<WorkerChangeListResponse.Change>;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * When the change is true in the business domain. Can be past, present, or future.
+   * Independent of applied_on. UTC.
+   */
+  effective_on: string;
+
+  /**
+   * The lifecycle event type this change represents. CHANGE is the catch-all for
+   * non-lifecycle field edits.
+   */
+  event_type:
+    | 'HIRE'
+    | 'CHANGE'
+    | 'SCHEDULED_CHANGE'
+    | 'OFFBOARD'
+    | 'SCHEDULED_OFFBOARD'
+    | 'IMPORT'
+    | 'UNDO'
+    | 'EFFECTIVE_DATE_AMENDMENT';
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The worker affected by this change.
+   */
+  worker_id: string;
+
+  /**
+   * The actor as the current Worker DTO. Returned only when expand=changed_by is
+   * requested.
+   *
+   * Expandable field
+   */
+  changed_by?: WorkersAPI.Worker;
+
+  /**
+   * Actor who made the change. Null for system-initiated events.
+   */
+  changed_by_id?: string;
+
+  /**
+   * INITIAL (census import at company onboarding) or HISTORICAL (historical data
+   * imported later). Set only when event_type is IMPORT.
+   */
+  import_type?: 'INITIAL' | 'HISTORICAL';
+
+  /**
+   * Structured transition reason (e.g. 'PROMOTION', 'MARKET_ADJUSTMENT'). Populated
+   * only when the company has configured transition reasons and the change went
+   * through a role transition with one selected. Null for most companies and events.
+   */
+  reason_code?: string;
+
+  /**
+   * For amendments or undos, the id of the worker-change event being modified.
+   */
+  referenced_transaction_id?: string;
+
+  /**
+   * The affected worker as the current Worker DTO. Returned only when expand=worker
+   * is requested. Includes terminated employees.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export namespace WorkerChangeListResponse {
+  export interface Change {
+    /**
+     * VISIBLE or REDACTED. REDACTED means the caller's role lacks permission to read
+     * this field; from_value/to_value are null but the entry still appears so
+     * consumers know a change occurred.
+     */
+    display_type: 'VISIBLE' | 'REDACTED';
+
+    /**
+     * UI label for the field (English).
+     */
+    field_display_name: string;
+
+    /**
+     * Field key in snake_case (see GET /worker-change-fields for the valid set).
+     */
+    field_key: string;
+
+    /**
+     * The underlying value type of this field. Populated regardless of display_type so
+     * consumers can interpret from_value / to_value (or anticipate a future typed
+     * representation) without a separate lookup against GET /worker-change-fields.
+     */
+    value_type: 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'CURRENCY' | 'ENUM' | 'REFERENCE';
+
+    /**
+     * Value before the change, rendered as a display string (locale- and
+     * currency-formatted per the activity-log convention). Null when display_type is
+     * REDACTED. Typed JSON values are tracked as a future addition; consult value_type
+     * to interpret the rendering.
+     */
+    from_value?: string;
+
+    /**
+     * Value after the change, rendered as a display string. Null when display_type is
+     * REDACTED. See from_value for notes on typed-value plans.
+     */
+    to_value?: string;
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface WorkerChangeRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * When the change was persisted (approval time for changes that went through an
+   * approval workflow). UTC. Monotonically increasing as new commits land; use as
+   * the cursor axis for incremental polling.
+   */
+  applied_on: string;
+
+  /**
+   * Field-level changes captured by this event. Per-field REDACTED entries appear
+   * for fields the caller cannot read so consumers can detect that a change occurred
+   * even when the value is hidden. Events where every changed field is invisible to
+   * the caller — either internal fields not exposed via the public Object Graph, or
+   * fields the caller's role has zero read permission on — are dropped from the
+   * response entirely (they never appear with an all-REDACTED changes array).
+   */
+  changes: Array<WorkerChangeRetrieveResponse.Change>;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * When the change is true in the business domain. Can be past, present, or future.
+   * Independent of applied_on. UTC.
+   */
+  effective_on: string;
+
+  /**
+   * The lifecycle event type this change represents. CHANGE is the catch-all for
+   * non-lifecycle field edits.
+   */
+  event_type:
+    | 'HIRE'
+    | 'CHANGE'
+    | 'SCHEDULED_CHANGE'
+    | 'OFFBOARD'
+    | 'SCHEDULED_OFFBOARD'
+    | 'IMPORT'
+    | 'UNDO'
+    | 'EFFECTIVE_DATE_AMENDMENT';
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The worker affected by this change.
+   */
+  worker_id: string;
+
+  /**
+   * The actor as the current Worker DTO. Returned only when expand=changed_by is
+   * requested.
+   *
+   * Expandable field
+   */
+  changed_by?: WorkersAPI.Worker;
+
+  /**
+   * Actor who made the change. Null for system-initiated events.
+   */
+  changed_by_id?: string;
+
+  /**
+   * INITIAL (census import at company onboarding) or HISTORICAL (historical data
+   * imported later). Set only when event_type is IMPORT.
+   */
+  import_type?: 'INITIAL' | 'HISTORICAL';
+
+  /**
+   * Structured transition reason (e.g. 'PROMOTION', 'MARKET_ADJUSTMENT'). Populated
+   * only when the company has configured transition reasons and the change went
+   * through a role transition with one selected. Null for most companies and events.
+   */
+  reason_code?: string;
+
+  /**
+   * For amendments or undos, the id of the worker-change event being modified.
+   */
+  referenced_transaction_id?: string;
+
+  /**
+   * The affected worker as the current Worker DTO. Returned only when expand=worker
+   * is requested. Includes terminated employees.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export namespace WorkerChangeRetrieveResponse {
+  export interface Change {
+    /**
+     * VISIBLE or REDACTED. REDACTED means the caller's role lacks permission to read
+     * this field; from_value/to_value are null but the entry still appears so
+     * consumers know a change occurred.
+     */
+    display_type: 'VISIBLE' | 'REDACTED';
+
+    /**
+     * UI label for the field (English).
+     */
+    field_display_name: string;
+
+    /**
+     * Field key in snake_case (see GET /worker-change-fields for the valid set).
+     */
+    field_key: string;
+
+    /**
+     * The underlying value type of this field. Populated regardless of display_type so
+     * consumers can interpret from_value / to_value (or anticipate a future typed
+     * representation) without a separate lookup against GET /worker-change-fields.
+     */
+    value_type: 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'CURRENCY' | 'ENUM' | 'REFERENCE';
+
+    /**
+     * Value before the change, rendered as a display string (locale- and
+     * currency-formatted per the activity-log convention). Null when display_type is
+     * REDACTED. Typed JSON values are tracked as a future addition; consult value_type
+     * to interpret the rendering.
+     */
+    from_value?: string;
+
+    /**
+     * Value after the change, rendered as a display string. Null when display_type is
+     * REDACTED. See from_value for notes on typed-value plans.
+     */
+    to_value?: string;
+  }
+}
+
+export interface WorkerChangeListParams {
+  cursor?: string;
+
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface WorkerChangeRetrieveParams {
+  expand?: string;
+}
+
+export declare namespace WorkerChanges {
+  export {
+    type WorkerChangeListResponse as WorkerChangeListResponse,
+    type WorkerChangeRetrieveResponse as WorkerChangeRetrieveResponse,
+    type WorkerChangeListResponsesPageCursorURL as WorkerChangeListResponsesPageCursorURL,
+    type WorkerChangeListParams as WorkerChangeListParams,
+    type WorkerChangeRetrieveParams as WorkerChangeRetrieveParams,
+  };
+}

package/src/resources/workflow-action-executions.ts

@@ -462,7 +462,12 @@ export declare namespace WorkflowActionExecutionCreateParams {
     action_type: 'evaluate_rql';
 
     /**
-     * Query and retrieve specific records from Rippling
+     * Query and retrieve records from Rippling. Pick a Query mode: Basic (SELECTION)
+     * returns matching record IDs for a chosen Rippling model via a wizard-built
+     * filter; Advanced (QUERY) evaluates a free-form RQL formula and returns a value
+     * of any RQL type (scalar or list). Always express filtering inside this action
+     * (via the SELECTION filter wizard or the QUERY formula) — do not fetch records
+     * and filter in code downstream.
      */
     payload:
       | EvaluateRqlActionRequest.EvaluateRqlSelectionPayload
@@ -473,7 +478,12 @@ export declare namespace WorkflowActionExecutionCreateParams {
 
   export namespace EvaluateRqlActionRequest {
     /**
-     * Query and retrieve specific records from Rippling
+     * Query and retrieve records from Rippling. Pick a Query mode: Basic (SELECTION)
+     * returns matching record IDs for a chosen Rippling model via a wizard-built
+     * filter; Advanced (QUERY) evaluates a free-form RQL formula and returns a value
+     * of any RQL type (scalar or list). Always express filtering inside this action
+     * (via the SELECTION filter wizard or the QUERY formula) — do not fetch records
+     * and filter in code downstream.
      */
     export interface EvaluateRqlSelectionPayload {
       queryType: 'SELECTION';
@@ -482,7 +492,12 @@ export declare namespace WorkflowActionExecutionCreateParams {
     }
 
     /**
-     * Query and retrieve specific records from Rippling
+     * Query and retrieve records from Rippling. Pick a Query mode: Basic (SELECTION)
+     * returns matching record IDs for a chosen Rippling model via a wizard-built
+     * filter; Advanced (QUERY) evaluates a free-form RQL formula and returns a value
+     * of any RQL type (scalar or list). Always express filtering inside this action
+     * (via the SELECTION filter wizard or the QUERY formula) — do not fetch records
+     * and filter in code downstream.
      */
     export interface EvaluateRqlQueryPayload {
       queryType: 'QUERY';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.55'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.57'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.55";
+export declare const VERSION = "0.2.0-alpha.57";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.55";
+export declare const VERSION = "0.2.0-alpha.57";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0-alpha.55'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.57'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0-alpha.55'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.57'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map