@rippling/rippling-sdk 0.2.0-alpha.73 → 0.2.0-alpha.74

package/resources/worker-changes.d.mts

@@ -0,0 +1,267 @@
+import { APIResource } from "../core/resource.mjs";
+import * as BusinessPartnersAPI from "./business-partners.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";
+/**
+ * Historical changes to worker data over time
+ */
+export declare class WorkerChanges extends APIResource {
+    /**
+     * A list of worker changes.
+     *
+     * - Requires: `Worker Changes API`
+     * - 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>;
+    /**
+     * Retrieve a specific worker change
+     */
+    retrieve(id: string, query?: WorkerChangeRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<WorkerChangeRetrieveResponse>;
+}
+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 declare namespace WorkerChangeListResponse {
+    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.
+         */
+        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.
+         */
+        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 declare namespace WorkerChangeRetrieveResponse {
+    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.
+         */
+        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.
+         */
+        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, };
+}
+//# sourceMappingURL=worker-changes.d.mts.map

package/resources/worker-changes.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-changes.d.mts","sourceRoot":"","sources":["../src/resources/worker-changes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sCAAsC,EAAE,wBAAwB,CAAC;IAOhF;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED,MAAM,MAAM,sCAAsC,GAAG,aAAa,CAAC,wBAAwB,CAAC,CAAC;AAE7F,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,OAAO,EAAE,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAEhD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,EACN,MAAM,GACN,QAAQ,GACR,kBAAkB,GAClB,UAAU,GACV,oBAAoB,GACpB,QAAQ,GACR,MAAM,GACN,0BAA0B,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAEvC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;CAC5B;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,MAAM;QACrB;;;;WAIG;QACH,YAAY,EAAE,SAAS,GAAG,UAAU,CAAC;QAErC;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,WAAW,CAAC;QAEtG;;;;;WAKG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,mBAAmB,CAAC,IAAI;IAC5E;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,OAAO,EAAE,KAAK,CAAC,4BAA4B,CAAC,MAAM,CAAC,CAAC;IAEpD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,EACN,MAAM,GACN,QAAQ,GACR,kBAAkB,GAClB,UAAU,GACV,oBAAoB,GACpB,QAAQ,GACR,MAAM,GACN,0BAA0B,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAEvC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;CAC5B;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,MAAM;QACrB;;;;WAIG;QACH,YAAY,EAAE,SAAS,GAAG,UAAU,CAAC;QAErC;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,WAAW,CAAC;QAEtG;;;;;WAKG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/worker-changes.d.ts

@@ -0,0 +1,267 @@
+import { APIResource } from "../core/resource.js";
+import * as BusinessPartnersAPI from "./business-partners.js";
+import * as WorkersAPI from "./workers.js";
+import { APIPromise } from "../core/api-promise.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Historical changes to worker data over time
+ */
+export declare class WorkerChanges extends APIResource {
+    /**
+     * A list of worker changes.
+     *
+     * - Requires: `Worker Changes API`
+     * - 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>;
+    /**
+     * Retrieve a specific worker change
+     */
+    retrieve(id: string, query?: WorkerChangeRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<WorkerChangeRetrieveResponse>;
+}
+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 declare namespace WorkerChangeListResponse {
+    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.
+         */
+        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.
+         */
+        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 declare namespace WorkerChangeRetrieveResponse {
+    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.
+         */
+        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.
+         */
+        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, };
+}
+//# sourceMappingURL=worker-changes.d.ts.map

package/resources/worker-changes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-changes.d.ts","sourceRoot":"","sources":["../src/resources/worker-changes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sCAAsC,EAAE,wBAAwB,CAAC;IAOhF;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED,MAAM,MAAM,sCAAsC,GAAG,aAAa,CAAC,wBAAwB,CAAC,CAAC;AAE7F,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,OAAO,EAAE,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAEhD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,EACN,MAAM,GACN,QAAQ,GACR,kBAAkB,GAClB,UAAU,GACV,oBAAoB,GACpB,QAAQ,GACR,MAAM,GACN,0BAA0B,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAEvC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;CAC5B;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,MAAM;QACrB;;;;WAIG;QACH,YAAY,EAAE,SAAS,GAAG,UAAU,CAAC;QAErC;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,WAAW,CAAC;QAEtG;;;;;WAKG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,mBAAmB,CAAC,IAAI;IAC5E;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,OAAO,EAAE,KAAK,CAAC,4BAA4B,CAAC,MAAM,CAAC,CAAC;IAEpD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,EACN,MAAM,GACN,QAAQ,GACR,kBAAkB,GAClB,UAAU,GACV,oBAAoB,GACpB,QAAQ,GACR,MAAM,GACN,0BAA0B,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAEvC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;CAC5B;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,MAAM;QACrB;;;;WAIG;QACH,YAAY,EAAE,SAAS,GAAG,UAAU,CAAC;QAErC;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,WAAW,CAAC;QAEtG;;;;;WAKG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/worker-changes.js

@@ -0,0 +1,36 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkerChanges = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Historical changes to worker data over time
+ */
+class WorkerChanges extends resource_1.APIResource {
+    /**
+     * A list of worker changes.
+     *
+     * - Requires: `Worker Changes API`
+     * - 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 = {}, options) {
+        return this._client.getAPIList('/worker-changes/', (pagination_1.PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve a specific worker change
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/worker-changes/${id}/`, { query, ...options });
+    }
+}
+exports.WorkerChanges = WorkerChanges;
+//# sourceMappingURL=worker-changes.js.map

package/resources/worker-changes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-changes.js","sourceRoot":"","sources":["../src/resources/worker-changes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;OASG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,0BAAuC,CAAA,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AA/BD,sCA+BC"}

package/resources/worker-changes.mjs

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { PageCursorURL } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * Historical changes to worker data over time
+ */
+export class WorkerChanges extends APIResource {
+    /**
+     * A list of worker changes.
+     *
+     * - Requires: `Worker Changes API`
+     * - 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 = {}, options) {
+        return this._client.getAPIList('/worker-changes/', (PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve a specific worker change
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get(path `/worker-changes/${id}/`, { query, ...options });
+    }
+}
+//# sourceMappingURL=worker-changes.mjs.map

package/resources/worker-changes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-changes.mjs","sourceRoot":"","sources":["../src/resources/worker-changes.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;OASG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,aAAuC,CAAA,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}