@rippling/rippling-sdk 0.2.0-alpha.36 → 0.2.0-alpha.37

package/resources/payroll-runs/payroll-runs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-runs.d.mts","sourceRoot":"","sources":["../../src/resources/payroll-runs/payroll-runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,KAAK,uBAAuB;OAC5B,EACL,6BAA6B,EAC7B,+BAA+B,EAC/B,6CAA6C,EAC7C,oBAAoB,EACrB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C,oBAAoB,EAAE,uBAAuB,CAAC,oBAAoB,CACD;IAEjE;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,sBAAsB,CAAC;IAO5E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGvF;AAED,MAAM,MAAM,oCAAoC,GAAG,aAAa,CAAC,sBAAsB,CAAC,CAAC;AAEzF;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC;IAE9C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB,CAAC,IAAI;IAC1E;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,0BAA0B,CAAC,SAAS,CAAC;IAElD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,oBAAoB,IAAI,oBAAoB,EAC5C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/payroll-runs/payroll-runs.d.ts

@@ -0,0 +1,199 @@
+import { APIResource } from "../../core/resource.js";
+import * as BusinessPartnersAPI from "../business-partners.js";
+import * as WorkerPayrollRecordsAPI from "./worker-payroll-records.js";
+import { WorkerPayrollRecordListParams, WorkerPayrollRecordListResponse, WorkerPayrollRecordListResponsesPageCursorURL, WorkerPayrollRecords } from "./worker-payroll-records.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { PageCursorURL, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Payroll runs for the company
+ */
+export declare class PayrollRuns extends APIResource {
+    workerPayrollRecords: WorkerPayrollRecordsAPI.WorkerPayrollRecords;
+    /**
+     * A list of payroll-runs.
+     *
+     * - Requires: `Global Payroll`
+     * - Sortable fields: `check_date`
+     */
+    list(query?: PayrollRunListParams | null | undefined, options?: RequestOptions): PagePromise<PayrollRunListResponsesPageCursorURL, PayrollRunListResponse>;
+    /**
+     * Retrieve a specific payroll-run
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<PayrollRunRetrieveResponse>;
+}
+export type PayrollRunListResponsesPageCursorURL = PageCursorURL<PayrollRunListResponse>;
+/**
+ * V2 DTO representing a single payroll run.
+ *
+ *     Used by:
+ *       - GET /payroll-runs/      (list)
+ *       - GET /payroll-runs/{id}  (retrieve)
+ */
+export interface PayrollRunListResponse {
+    /**
+     * Unique identifier for the payroll run.
+     */
+    id?: string;
+    /**
+     * Deadline for approving the payroll run.
+     */
+    approval_deadline?: string;
+    /**
+     * Timestamp when the run was approved.
+     */
+    approved_at?: string;
+    /**
+     * Date the paycheck is issued.
+     */
+    check_date?: string;
+    /**
+     * Identifier linking this payroll run to the company's legal entity in the HRIS
+     * system.
+     */
+    company_entity_id?: string;
+    /**
+     * ISO country code where the payroll run applies.
+     */
+    country_code?: string;
+    /**
+     * Date funds are debited from the company's account.
+     */
+    debit_date?: string;
+    /**
+     * Deadline after which the run is locked for changes.
+     */
+    lock_deadline?: string;
+    /**
+     * Timestamp when the run was marked as paid.
+     */
+    paid_at?: string;
+    /**
+     * Pay period details for this run.
+     */
+    pay_period?: PayrollRunListResponse.PayPeriod;
+    /**
+     * Payment method used (e.g. WIRE, ACH).
+     */
+    payment_type?: string;
+    /**
+     * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+     */
+    run_state?: string;
+    /**
+     * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+     */
+    run_type?: string;
+    /**
+     * Human-readable title of the payroll run.
+     */
+    title?: string;
+}
+export declare namespace PayrollRunListResponse {
+    /**
+     * Pay period details for this run.
+     */
+    interface PayPeriod {
+        /**
+         * End date of the pay period.
+         */
+        end_date?: string;
+        /**
+         * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+         */
+        pay_frequency?: string;
+        /**
+         * Start date of the pay period.
+         */
+        start_date?: string;
+    }
+}
+/**
+ * Meta information for the response.
+ */
+export interface PayrollRunRetrieveResponse extends BusinessPartnersAPI.Meta {
+    /**
+     * Unique identifier for the payroll run.
+     */
+    id?: string;
+    /**
+     * Deadline for approving the payroll run.
+     */
+    approval_deadline?: string;
+    /**
+     * Timestamp when the run was approved.
+     */
+    approved_at?: string;
+    /**
+     * Date the paycheck is issued.
+     */
+    check_date?: string;
+    /**
+     * Identifier linking this payroll run to the company's legal entity in the HRIS
+     * system.
+     */
+    company_entity_id?: string;
+    /**
+     * ISO country code where the payroll run applies.
+     */
+    country_code?: string;
+    /**
+     * Date funds are debited from the company's account.
+     */
+    debit_date?: string;
+    /**
+     * Deadline after which the run is locked for changes.
+     */
+    lock_deadline?: string;
+    /**
+     * Timestamp when the run was marked as paid.
+     */
+    paid_at?: string;
+    /**
+     * Pay period details for this run.
+     */
+    pay_period?: PayrollRunRetrieveResponse.PayPeriod;
+    /**
+     * Payment method used (e.g. WIRE, ACH).
+     */
+    payment_type?: string;
+    /**
+     * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+     */
+    run_state?: string;
+    /**
+     * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+     */
+    run_type?: string;
+    /**
+     * Human-readable title of the payroll run.
+     */
+    title?: string;
+}
+export declare namespace PayrollRunRetrieveResponse {
+    /**
+     * Pay period details for this run.
+     */
+    interface PayPeriod {
+        /**
+         * End date of the pay period.
+         */
+        end_date?: string;
+        /**
+         * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+         */
+        pay_frequency?: string;
+        /**
+         * Start date of the pay period.
+         */
+        start_date?: string;
+    }
+}
+export interface PayrollRunListParams {
+    order_by?: string;
+}
+export declare namespace PayrollRuns {
+    export { type PayrollRunListResponse as PayrollRunListResponse, type PayrollRunRetrieveResponse as PayrollRunRetrieveResponse, type PayrollRunListResponsesPageCursorURL as PayrollRunListResponsesPageCursorURL, type PayrollRunListParams as PayrollRunListParams, };
+    export { WorkerPayrollRecords as WorkerPayrollRecords, type WorkerPayrollRecordListResponse as WorkerPayrollRecordListResponse, type WorkerPayrollRecordListResponsesPageCursorURL as WorkerPayrollRecordListResponsesPageCursorURL, type WorkerPayrollRecordListParams as WorkerPayrollRecordListParams, };
+}
+//# sourceMappingURL=payroll-runs.d.ts.map

package/resources/payroll-runs/payroll-runs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-runs.d.ts","sourceRoot":"","sources":["../../src/resources/payroll-runs/payroll-runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,KAAK,uBAAuB;OAC5B,EACL,6BAA6B,EAC7B,+BAA+B,EAC/B,6CAA6C,EAC7C,oBAAoB,EACrB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C,oBAAoB,EAAE,uBAAuB,CAAC,oBAAoB,CACD;IAEjE;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,sBAAsB,CAAC;IAO5E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGvF;AAED,MAAM,MAAM,oCAAoC,GAAG,aAAa,CAAC,sBAAsB,CAAC,CAAC;AAEzF;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC;IAE9C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB,CAAC,IAAI;IAC1E;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,0BAA0B,CAAC,SAAS,CAAC;IAElD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,oBAAoB,IAAI,oBAAoB,EAC5C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/payroll-runs/payroll-runs.js

@@ -0,0 +1,40 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayrollRuns = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const WorkerPayrollRecordsAPI = tslib_1.__importStar(require("./worker-payroll-records.js"));
+const worker_payroll_records_1 = require("./worker-payroll-records.js");
+const pagination_1 = require("../../core/pagination.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Payroll runs for the company
+ */
+class PayrollRuns extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.workerPayrollRecords = new WorkerPayrollRecordsAPI.WorkerPayrollRecords(this._client);
+    }
+    /**
+     * A list of payroll-runs.
+     *
+     * - Requires: `Global Payroll`
+     * - Sortable fields: `check_date`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/payroll-runs/', (pagination_1.PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve a specific payroll-run
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/payroll-runs/${id}/`, options);
+    }
+}
+exports.PayrollRuns = PayrollRuns;
+PayrollRuns.WorkerPayrollRecords = worker_payroll_records_1.WorkerPayrollRecords;
+//# sourceMappingURL=payroll-runs.js.map

package/resources/payroll-runs/payroll-runs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-runs.js","sourceRoot":"","sources":["../../src/resources/payroll-runs/payroll-runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,6FAAoE;AACpE,wEAKkC;AAElC,yDAAmE;AAEnE,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAA5C;;QACE,yBAAoB,GAClB,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwBnE,CAAC;IAtBC;;;;;OAKG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,0BAAqC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AA1BD,kCA0BC;AAgND,WAAW,CAAC,oBAAoB,GAAG,6CAAoB,CAAC"}

package/resources/payroll-runs/payroll-runs.mjs

@@ -0,0 +1,35 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as WorkerPayrollRecordsAPI from "./worker-payroll-records.mjs";
+import { WorkerPayrollRecords, } from "./worker-payroll-records.mjs";
+import { PageCursorURL } from "../../core/pagination.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Payroll runs for the company
+ */
+export class PayrollRuns extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.workerPayrollRecords = new WorkerPayrollRecordsAPI.WorkerPayrollRecords(this._client);
+    }
+    /**
+     * A list of payroll-runs.
+     *
+     * - Requires: `Global Payroll`
+     * - Sortable fields: `check_date`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/payroll-runs/', (PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve a specific payroll-run
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/payroll-runs/${id}/`, options);
+    }
+}
+PayrollRuns.WorkerPayrollRecords = WorkerPayrollRecords;
+//# sourceMappingURL=payroll-runs.mjs.map

package/resources/payroll-runs/payroll-runs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-runs.mjs","sourceRoot":"","sources":["../../src/resources/payroll-runs/payroll-runs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,uBAAuB;OAC5B,EAIL,oBAAoB,GACrB;OAEM,EAAE,aAAa,EAAe;OAE9B,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAA5C;;QACE,yBAAoB,GAClB,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwBnE,CAAC;IAtBC;;;;;OAKG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,aAAqC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAgND,WAAW,CAAC,oBAAoB,GAAG,oBAAoB,CAAC"}

package/resources/payroll-runs/worker-payroll-records.d.mts

@@ -0,0 +1,200 @@
+import { APIResource } from "../../core/resource.mjs";
+import { PageCursorURL, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Payroll runs for the company
+ */
+export declare class WorkerPayrollRecords extends APIResource {
+    /**
+     * A list of worker-payroll-records for a payroll run. Supports filtering by worker
+     * via `filter=worker_id in ('<id1>', '<id2>')`.
+     *
+     * - Requires: `Global Payroll`
+     */
+    list(runID: string, query?: WorkerPayrollRecordListParams | null | undefined, options?: RequestOptions): PagePromise<WorkerPayrollRecordListResponsesPageCursorURL, WorkerPayrollRecordListResponse>;
+}
+export type WorkerPayrollRecordListResponsesPageCursorURL = PageCursorURL<WorkerPayrollRecordListResponse>;
+/**
+ * V2 DTO representing earnings, deductions, taxes, and garnishments
+ *     for a single worker in a payroll run.
+ *
+ *     Used by:
+ *       - GET /payroll-runs/{run_id}/worker-payroll-records/      (list)
+ *       - GET /payroll-runs/{run_id}/worker-payroll-records/{id}   (retrieve)
+ */
+export interface WorkerPayrollRecordListResponse {
+    /**
+     * Unique identifier for this payroll record (PRE version ID).
+     */
+    id?: string;
+    /**
+     * ISO country code where this payroll record applies.
+     */
+    country_code?: string;
+    /**
+     * ISO currency code for monetary amounts in this record.
+     */
+    currency?: string;
+    /**
+     * List of deduction line items.
+     */
+    deductions?: Array<WorkerPayrollRecordListResponse.Deduction>;
+    /**
+     * List of earning line items.
+     */
+    earnings?: Array<WorkerPayrollRecordListResponse.Earning>;
+    /**
+     * List of garnishment line items.
+     */
+    garnishments?: Array<WorkerPayrollRecordListResponse.Garnishment>;
+    /**
+     * Gross pay amount for the current period.
+     */
+    gross_pay?: string;
+    /**
+     * Net pay amount for the current period.
+     */
+    net_pay?: string;
+    /**
+     * Identifier of the payroll run this record belongs to.
+     */
+    run_id?: string;
+    /**
+     * Aggregate totals for taxes, deductions, and garnishments.
+     */
+    summary?: WorkerPayrollRecordListResponse.Summary;
+    /**
+     * List of tax line items.
+     */
+    taxes?: Array<WorkerPayrollRecordListResponse.Tax>;
+    /**
+     * Identifier of the worker (role ID).
+     */
+    worker_id?: string;
+}
+export declare namespace WorkerPayrollRecordListResponse {
+    /**
+     * A single deduction line item on a worker's payroll record.
+     */
+    interface Deduction {
+        /**
+         * Code identifying the deduction type.
+         */
+        deduction_code?: string;
+        /**
+         * Human-readable name of the deduction.
+         */
+        display_name?: string;
+        /**
+         * Employee contribution amount for the current period.
+         */
+        employee_amount?: string;
+        /**
+         * Employer contribution amount for the current period.
+         */
+        employer_amount?: string;
+    }
+    /**
+     * A single earning line item on a worker's payroll record.
+     */
+    interface Earning {
+        /**
+         * Earning amount for the current period.
+         */
+        amount?: string;
+        /**
+         * Human-readable name of the earning.
+         */
+        display_name?: string;
+        /**
+         * Category of the earning (e.g. SALARY, HOURLY).
+         */
+        earning_category?: string;
+        /**
+         * Code identifying the earning type (e.g. regular_salary).
+         */
+        earning_code?: string;
+        /**
+         * Hours worked for this earning in the current period.
+         */
+        hours?: string;
+        /**
+         * Hourly rate applied to this earning.
+         */
+        rate?: string;
+        /**
+         * Time tracking labels associated with this earning.
+         */
+        time_labels?: Array<string>;
+    }
+    /**
+     * A single garnishment line item on a worker's payroll record.
+     */
+    interface Garnishment {
+        /**
+         * Garnishment amount for the current period.
+         */
+        amount?: string;
+        /**
+         * Code identifying the garnishment.
+         */
+        garnishment_code?: string;
+    }
+    /**
+     * Aggregate totals for taxes, deductions, and garnishments.
+     */
+    interface Summary {
+        /**
+         * Total employee deductions.
+         */
+        employee_deductions?: string;
+        /**
+         * Total employee-paid taxes.
+         */
+        employee_taxes?: string;
+        /**
+         * Total employer contributions (e.g. retirement matching).
+         */
+        employer_contributions?: string;
+        /**
+         * Total employer-paid taxes.
+         */
+        employer_taxes?: string;
+        /**
+         * Total garnishments withheld.
+         */
+        total_garnishments?: string;
+    }
+    /**
+     * A single tax line item on a worker's payroll record.
+     */
+    interface Tax {
+        /**
+         * Tax amount for the current period.
+         */
+        amount?: string;
+        /**
+         * Human-readable name of the tax.
+         */
+        display_name?: string;
+        /**
+         * Who pays this tax: EMPLOYER or EMPLOYEE.
+         */
+        paid_by?: string;
+        /**
+         * Unique code identifying the tax.
+         */
+        tax_code?: string;
+    }
+}
+export interface WorkerPayrollRecordListParams {
+    cursor?: string;
+    /**
+     * OData-style filter. Only `worker_id in ('<id1>', '<id2>', ...)` is supported.
+     */
+    filter?: string;
+}
+export declare namespace WorkerPayrollRecords {
+    export { type WorkerPayrollRecordListResponse as WorkerPayrollRecordListResponse, type WorkerPayrollRecordListResponsesPageCursorURL as WorkerPayrollRecordListResponsesPageCursorURL, type WorkerPayrollRecordListParams as WorkerPayrollRecordListParams, };
+}
+//# sourceMappingURL=worker-payroll-records.d.mts.map

package/resources/payroll-runs/worker-payroll-records.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-payroll-records.d.mts","sourceRoot":"","sources":["../../src/resources/payroll-runs/worker-payroll-records.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;OAKG;IACH,IAAI,CACF,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,+BAA+B,CAAC;CAO/F;AAED,MAAM,MAAM,6CAA6C,GAAG,aAAa,CAAC,+BAA+B,CAAC,CAAC;AAE3G;;;;;;;GAOG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,SAAS,CAAC,CAAC;IAE9D;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IAE1D;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,WAAW,CAAC,CAAC;IAElE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,+BAA+B,CAAC,OAAO,CAAC;IAElD;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,GAAG,CAAC,CAAC;IAEnD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAEhC;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B;IAED;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}