@rippling/rippling-sdk 0.2.0-alpha.105 → 0.2.0-alpha.107

package/resources/payroll-payment-mode-changes.d.ts

@@ -0,0 +1,150 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Payroll runs for the company
+ */
+export declare class PayrollPaymentModeChanges extends APIResource {
+    /**
+     * Update payment modes for workers in one or more draft Global Payroll runs. The
+     * endpoint returns an item-level result for each requested change. When a request
+     * contains the same run and worker more than once, only the first change is
+     * evaluated; later entries are rejected as duplicates. Repeating the same run,
+     * worker, and payment mode is a safe no-op, so callers can retry it without an
+     * idempotency key. Request validation returns every detected error in an errors
+     * array before any payment mode is written. The errors array is the deliberate
+     * batch-validation contract for this pre-GA endpoint so callers can correct
+     * multiple issues at once; permission-denied responses use the same envelope for
+     * consistency.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /payroll-payment-mode-changes/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "changes": [
+     *     {
+     *       "payment_mode": "DEFAULT",
+     *       "run_id": "run_id",
+     *       "worker_id": "worker_id"
+     *     }
+     *   ]
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "run_id": "string",
+     *       "worker_id": "string",
+     *       "payment_mode": "DEFAULT",
+     *       "status": "UPDATED",
+     *       "error": {
+     *         "code": "DUPLICATE_NO_OP",
+     *         "message": "string"
+     *       }
+     *     }
+     *   ],
+     *   "write_status": "COMPLETED"
+     * }
+     * ```
+     */
+    create(body: PayrollPaymentModeChangeCreateParams, options?: RequestOptions): APIPromise<PayrollPaymentModeChangeCreateResponse>;
+}
+export interface PayrollPaymentModeChangeCreateResponse {
+    /**
+     * Item-level results for the requested payment mode changes. Each item is either
+     * updated or rejected so callers can retry failed items independently.
+     */
+    results?: Array<PayrollPaymentModeChangeCreateResponse.Result>;
+    /**
+     * Completion status for this synchronous request. This is currently always
+     * COMPLETED; the field is reserved for future status values if processing becomes
+     * asynchronous. It describes the overall request, while each result status
+     * describes an individual item.
+     */
+    write_status?: 'COMPLETED';
+}
+export declare namespace PayrollPaymentModeChangeCreateResponse {
+    interface Result {
+        /**
+         * Structured error when the item was rejected. This field is omitted for UPDATED
+         * items and is present for REJECTED items.
+         */
+        error?: Result.Error;
+        /**
+         * Requested Global Payroll payment mode code.
+         */
+        payment_mode?: 'DEFAULT' | 'BANK_FILE' | 'MANUAL' | 'SAME_DAY_ACH' | 'CHECK_PRINTING' | 'CHECK_MAILING';
+        /**
+         * ID of the requested payroll run.
+         */
+        run_id?: string;
+        /**
+         * Item result: UPDATED or REJECTED.
+         */
+        status?: 'UPDATED' | 'REJECTED';
+        /**
+         * ID of the requested worker.
+         */
+        worker_id?: string;
+    }
+    namespace Result {
+        /**
+         * Structured error when the item was rejected. This field is omitted for UPDATED
+         * items and is present for REJECTED items.
+         */
+        interface Error {
+            /**
+             * Machine-readable error code for a rejected item. DUPLICATE_NO_OP means the
+             * requested change was already requested and no retry is needed;
+             * DUPLICATE_TARGET_CONFLICT, OUT_OF_SCOPE, RUN_NOT_FOUND, WORKER_NOT_IN_RUN, and
+             * PAYMENT_MODE_NOT_SUPPORTED are terminal request errors that require changing the
+             * request or authorization; RUN_NOT_WRITABLE may be retried when the run becomes
+             * writable; PAYMENT_MODE_UPDATE_FAILED is retryable after the underlying update
+             * failure is resolved.
+             */
+            code?: 'DUPLICATE_NO_OP' | 'DUPLICATE_TARGET_CONFLICT' | 'OUT_OF_SCOPE' | 'RUN_NOT_FOUND' | 'RUN_NOT_WRITABLE' | 'WORKER_NOT_IN_RUN' | 'PAYMENT_MODE_NOT_SUPPORTED' | 'PAYMENT_MODE_UPDATE_FAILED';
+            /**
+             * Human-readable error message.
+             */
+            message?: string;
+        }
+    }
+}
+export interface PayrollPaymentModeChangeCreateParams {
+    /**
+     * Payment mode changes to process. The maximum batch size is 100.
+     */
+    changes: Array<PayrollPaymentModeChangeCreateParams.Change>;
+}
+export declare namespace PayrollPaymentModeChangeCreateParams {
+    interface Change {
+        /**
+         * Canonical Global Payroll payment mode code to apply to the worker in the run.
+         * Known labels are DEFAULT (Default), BANK_FILE (Bank file), MANUAL (Manual),
+         * SAME_DAY_ACH (Same-day ACH), CHECK_PRINTING (Check printing), and CHECK_MAILING
+         * (Check mailing).
+         */
+        payment_mode: 'DEFAULT' | 'BANK_FILE' | 'MANUAL' | 'SAME_DAY_ACH' | 'CHECK_PRINTING' | 'CHECK_MAILING';
+        /**
+         * ID of the draft Global Payroll run to update.
+         */
+        run_id: string;
+        /**
+         * ID of the worker whose payment mode will be updated.
+         */
+        worker_id: string;
+    }
+}
+export declare namespace PayrollPaymentModeChanges {
+    export { type PayrollPaymentModeChangeCreateResponse as PayrollPaymentModeChangeCreateResponse, type PayrollPaymentModeChangeCreateParams as PayrollPaymentModeChangeCreateParams, };
+}
+//# sourceMappingURL=payroll-payment-mode-changes.d.ts.map

package/resources/payroll-payment-mode-changes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-payment-mode-changes.d.ts","sourceRoot":"","sources":["../src/resources/payroll-payment-mode-changes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,WAAW;IACxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CACJ,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sCAAsC,CAAC;CAGtD;AAED,MAAM,WAAW,sCAAsC;IACrD;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,sCAAsC,CAAC,MAAM,CAAC,CAAC;IAE/D;;;;;OAKG;IACH,YAAY,CAAC,EAAE,WAAW,CAAC;CAC5B;AAED,yBAAiB,sCAAsC,CAAC;IACtD,UAAiB,MAAM;QACrB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC;QAErB;;WAEG;QACH,YAAY,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,cAAc,GAAG,gBAAgB,GAAG,eAAe,CAAC;QAExG;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;QAEhC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,MAAM,CAAC;QACtB;;;WAGG;QACH,UAAiB,KAAK;YACpB;;;;;;;;eAQG;YACH,IAAI,CAAC,EACD,iBAAiB,GACjB,2BAA2B,GAC3B,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,4BAA4B,GAC5B,4BAA4B,CAAC;YAEjC;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,oCAAoC,CAAC,MAAM,CAAC,CAAC;CAC7D;AAED,yBAAiB,oCAAoC,CAAC;IACpD,UAAiB,MAAM;QACrB;;;;;WAKG;QACH,YAAY,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,cAAc,GAAG,gBAAgB,GAAG,eAAe,CAAC;QAEvG;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,yBAAyB,CAAC;IACjD,OAAO,EACL,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,oCAAoC,IAAI,oCAAoC,GAClF,CAAC;CACH"}

package/resources/payroll-payment-mode-changes.js

@@ -0,0 +1,66 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayrollPaymentModeChanges = void 0;
+const resource_1 = require("../core/resource.js");
+/**
+ * Payroll runs for the company
+ */
+class PayrollPaymentModeChanges extends resource_1.APIResource {
+    /**
+     * Update payment modes for workers in one or more draft Global Payroll runs. The
+     * endpoint returns an item-level result for each requested change. When a request
+     * contains the same run and worker more than once, only the first change is
+     * evaluated; later entries are rejected as duplicates. Repeating the same run,
+     * worker, and payment mode is a safe no-op, so callers can retry it without an
+     * idempotency key. Request validation returns every detected error in an errors
+     * array before any payment mode is written. The errors array is the deliberate
+     * batch-validation contract for this pre-GA endpoint so callers can correct
+     * multiple issues at once; permission-denied responses use the same envelope for
+     * consistency.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /payroll-payment-mode-changes/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "changes": [
+     *     {
+     *       "payment_mode": "DEFAULT",
+     *       "run_id": "run_id",
+     *       "worker_id": "worker_id"
+     *     }
+     *   ]
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "run_id": "string",
+     *       "worker_id": "string",
+     *       "payment_mode": "DEFAULT",
+     *       "status": "UPDATED",
+     *       "error": {
+     *         "code": "DUPLICATE_NO_OP",
+     *         "message": "string"
+     *       }
+     *     }
+     *   ],
+     *   "write_status": "COMPLETED"
+     * }
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/payroll-payment-mode-changes/', { body, ...options });
+    }
+}
+exports.PayrollPaymentModeChanges = PayrollPaymentModeChanges;
+//# sourceMappingURL=payroll-payment-mode-changes.js.map

package/resources/payroll-payment-mode-changes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-payment-mode-changes.js","sourceRoot":"","sources":["../src/resources/payroll-payment-mode-changes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,yBAA0B,SAAQ,sBAAW;IACxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CACJ,IAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AA1DD,8DA0DC"}

package/resources/payroll-payment-mode-changes.mjs

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+/**
+ * Payroll runs for the company
+ */
+export class PayrollPaymentModeChanges extends APIResource {
+    /**
+     * Update payment modes for workers in one or more draft Global Payroll runs. The
+     * endpoint returns an item-level result for each requested change. When a request
+     * contains the same run and worker more than once, only the first change is
+     * evaluated; later entries are rejected as duplicates. Repeating the same run,
+     * worker, and payment mode is a safe no-op, so callers can retry it without an
+     * idempotency key. Request validation returns every detected error in an errors
+     * array before any payment mode is written. The errors array is the deliberate
+     * batch-validation contract for this pre-GA endpoint so callers can correct
+     * multiple issues at once; permission-denied responses use the same envelope for
+     * consistency.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /payroll-payment-mode-changes/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "changes": [
+     *     {
+     *       "payment_mode": "DEFAULT",
+     *       "run_id": "run_id",
+     *       "worker_id": "worker_id"
+     *     }
+     *   ]
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "run_id": "string",
+     *       "worker_id": "string",
+     *       "payment_mode": "DEFAULT",
+     *       "status": "UPDATED",
+     *       "error": {
+     *         "code": "DUPLICATE_NO_OP",
+     *         "message": "string"
+     *       }
+     *     }
+     *   ],
+     *   "write_status": "COMPLETED"
+     * }
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/payroll-payment-mode-changes/', { body, ...options });
+    }
+}
+//# sourceMappingURL=payroll-payment-mode-changes.mjs.map

package/resources/payroll-payment-mode-changes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-payment-mode-changes.mjs","sourceRoot":"","sources":["../src/resources/payroll-payment-mode-changes.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,WAAW;IACxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CACJ,IAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF"}

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

@@ -1,3 +1,4 @@
+export { OffCycle, type OffCycleCreateResponse, type OffCycleCreateParams } from "./off-cycle.mjs";
 export { PayrollRuns, type PayrollRunListResponse, type PayrollRunRetrieveResponse, type PayrollRunListParams, type PayrollRunListResponsesPageCursorURL, } from "./payroll-runs.mjs";
 export { WorkerPayrollRecords, type WorkerPayrollRecordListResponse, type WorkerPayrollRecordListParams, type WorkerPayrollRecordListResponsesPageCursorURL, } from "./worker-payroll-records.mjs";
 //# sourceMappingURL=index.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/payroll-runs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EACX,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,oCAAoC,GAC1C,2BAAuB;AACxB,OAAO,EACL,oBAAoB,EACpB,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,EAClC,KAAK,6CAA6C,GACnD,qCAAiC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/payroll-runs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,KAAK,sBAAsB,EAAE,KAAK,oBAAoB,EAAE,wBAAoB;AAC/F,OAAO,EACL,WAAW,EACX,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,oCAAoC,GAC1C,2BAAuB;AACxB,OAAO,EACL,oBAAoB,EACpB,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,EAClC,KAAK,6CAA6C,GACnD,qCAAiC"}

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

@@ -1,3 +1,4 @@
+export { OffCycle, type OffCycleCreateResponse, type OffCycleCreateParams } from "./off-cycle.js";
 export { PayrollRuns, type PayrollRunListResponse, type PayrollRunRetrieveResponse, type PayrollRunListParams, type PayrollRunListResponsesPageCursorURL, } from "./payroll-runs.js";
 export { WorkerPayrollRecords, type WorkerPayrollRecordListResponse, type WorkerPayrollRecordListParams, type WorkerPayrollRecordListResponsesPageCursorURL, } from "./worker-payroll-records.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/payroll-runs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EACX,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,oCAAoC,GAC1C,0BAAuB;AACxB,OAAO,EACL,oBAAoB,EACpB,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,EAClC,KAAK,6CAA6C,GACnD,oCAAiC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/payroll-runs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,KAAK,sBAAsB,EAAE,KAAK,oBAAoB,EAAE,uBAAoB;AAC/F,OAAO,EACL,WAAW,EACX,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,oCAAoC,GAC1C,0BAAuB;AACxB,OAAO,EACL,oBAAoB,EACpB,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,EAClC,KAAK,6CAA6C,GACnD,oCAAiC"}

package/resources/payroll-runs/index.js

@@ -1,7 +1,9 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkerPayrollRecords = exports.PayrollRuns = void 0;
+exports.WorkerPayrollRecords = exports.PayrollRuns = exports.OffCycle = void 0;
+var off_cycle_1 = require("./off-cycle.js");
+Object.defineProperty(exports, "OffCycle", { enumerable: true, get: function () { return off_cycle_1.OffCycle; } });
 var payroll_runs_1 = require("./payroll-runs.js");
 Object.defineProperty(exports, "PayrollRuns", { enumerable: true, get: function () { return payroll_runs_1.PayrollRuns; } });
 var worker_payroll_records_1 = require("./worker-payroll-records.js");

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/payroll-runs/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAMwB;AALtB,2GAAA,WAAW,OAAA;AAMb,sEAKkC;AAJhC,8HAAA,oBAAoB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/payroll-runs/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CAA+F;AAAtF,qGAAA,QAAQ,OAAA;AACjB,kDAMwB;AALtB,2GAAA,WAAW,OAAA;AAMb,sEAKkC;AAJhC,8HAAA,oBAAoB,OAAA"}

package/resources/payroll-runs/index.mjs

@@ -1,4 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { OffCycle } from "./off-cycle.mjs";
 export { PayrollRuns, } from "./payroll-runs.mjs";
 export { WorkerPayrollRecords, } from "./worker-payroll-records.mjs";
 //# sourceMappingURL=index.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/payroll-runs/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,WAAW,GAKZ,2BAAuB;AACxB,OAAO,EACL,oBAAoB,GAIrB,qCAAiC"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/payroll-runs/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,QAAQ,EAA0D,wBAAoB;AAC/F,OAAO,EACL,WAAW,GAKZ,2BAAuB;AACxB,OAAO,EACL,oBAAoB,GAIrB,qCAAiC"}

package/resources/payroll-runs/off-cycle.d.mts

@@ -0,0 +1,322 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Payroll runs for the company
+ */
+export declare class OffCycle extends APIResource {
+    /**
+     * Create draft off-cycle run or runs for Global Payroll workers. Workers may be
+     * split into separate runs by employment type, but every run must belong to the
+     * same payroll entity. All requested workers must be eligible; validation is
+     * all-or-nothing before creation starts. Each validated run is attempted
+     * independently. The response contains status, confirmed runs, and per-run errors.
+     * HTTP 201 may contain PARTIAL_SUCCESS; HTTP 500 with FAILED means no creation was
+     * confirmed. An error does not prove that no run was created; inspect errors and
+     * reconcile before retrying. Idempotency-Key is not supported: each POST creates
+     * new run(s), even for an identical payload or repeated key. A retry after a
+     * timeout may create duplicate draft run(s); reconcile before retrying.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /payroll-runs/off-cycle/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "errors": [
+     *     {
+     *       "code": "RUN_CREATION_OUTCOME_UNKNOWN",
+     *       "company_entity_id": "company_entity_id",
+     *       "employment_split": "employment_split",
+     *       "message": "message",
+     *       "worker_ids": [
+     *         "string"
+     *       ]
+     *     }
+     *   ],
+     *   "runs": [
+     *     {
+     *       "check_date": "check_date",
+     *       "company_entity_id": "company_entity_id",
+     *       "country_code": "country_code",
+     *       "employment_split": "employment_split",
+     *       "pay_period": {
+     *         "end_date": "end_date",
+     *         "start_date": "start_date"
+     *       },
+     *       "run_configuration": {
+     *         "pay_basis": "pay_basis"
+     *       },
+     *       "run_id": "run_id",
+     *       "run_status": "run_status",
+     *       "run_type": "run_type",
+     *       "worker_ids": [
+     *         "string"
+     *       ]
+     *     }
+     *   ],
+     *   "status": "SUCCESS"
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "status": "SUCCESS",
+     *   "runs": [
+     *     {
+     *       "run_id": "string",
+     *       "worker_ids": [
+     *         "string"
+     *       ],
+     *       "company_entity_id": "string",
+     *       "country_code": "string",
+     *       "run_type": "string",
+     *       "run_status": "string",
+     *       "check_date": "string",
+     *       "pay_period": {
+     *         "start_date": "string",
+     *         "end_date": "string"
+     *       },
+     *       "employment_split": "string",
+     *       "run_configuration": {
+     *         "pay_basis": "string"
+     *       }
+     *     }
+     *   ],
+     *   "errors": [
+     *     {
+     *       "worker_ids": [
+     *         "string"
+     *       ],
+     *       "company_entity_id": "string",
+     *       "employment_split": "string",
+     *       "code": "RUN_CREATION_OUTCOME_UNKNOWN",
+     *       "message": "string"
+     *     }
+     *   ]
+     * }
+     * ```
+     */
+    create(body: OffCycleCreateParams, options?: RequestOptions): APIPromise<OffCycleCreateResponse>;
+}
+export interface OffCycleCreateResponse {
+    /**
+     * One error per unconfirmed run creation. Empty on full success; reconcile before
+     * retrying.
+     */
+    errors: Array<OffCycleCreateResponse.Error>;
+    /**
+     * Confirmed created draft runs. Empty when no creation could be confirmed.
+     */
+    runs: Array<OffCycleCreateResponse.Run>;
+    /**
+     * SUCCESS, PARTIAL_SUCCESS, or FAILED. FAILED means no run creation was confirmed.
+     */
+    status: 'SUCCESS' | 'PARTIAL_SUCCESS' | 'FAILED';
+}
+export declare namespace OffCycleCreateResponse {
+    interface Error {
+        /**
+         * Stable error code; an exception does not prove that no run was created.
+         */
+        code: 'RUN_CREATION_OUTCOME_UNKNOWN';
+        /**
+         * Payroll entity for the attempted run.
+         */
+        company_entity_id: string;
+        /**
+         * Employment category for the attempted run.
+         */
+        employment_split: string;
+        /**
+         * Safe description of the unconfirmed creation outcome and retry guidance.
+         */
+        message: string;
+        /**
+         * Role IDs in the run whose creation could not be confirmed.
+         */
+        worker_ids: Array<string>;
+    }
+    interface Run {
+        /**
+         * Payment date selected for this run.
+         */
+        check_date: string;
+        /**
+         * Identifier of the payroll entity that owns this run.
+         */
+        company_entity_id: string;
+        /**
+         * Country code of the payroll entity.
+         */
+        country_code: string;
+        /**
+         * Worker eligibility category used to split this run, such as employees or
+         * contractors.
+         */
+        employment_split: string;
+        /**
+         * Pay period for this run.
+         */
+        pay_period: Run.PayPeriod;
+        /**
+         * Calculation configuration used for this run.
+         */
+        run_configuration: Run.RunConfiguration;
+        /**
+         * Identifier of the created draft payroll run.
+         */
+        run_id: string;
+        /**
+         * Status of the created payroll run.
+         */
+        run_status: string;
+        /**
+         * Type of the created payroll run.
+         */
+        run_type: string;
+        /**
+         * Role IDs included in this run.
+         */
+        worker_ids: Array<string>;
+    }
+    namespace Run {
+        /**
+         * Pay period for this run.
+         */
+        interface PayPeriod {
+            /**
+             * End date of this run's pay period.
+             */
+            end_date: string;
+            /**
+             * Start date of this run's pay period.
+             */
+            start_date: string;
+        }
+        /**
+         * Calculation configuration used for this run.
+         */
+        interface RunConfiguration {
+            /**
+             * Amount basis used by the created run. This API currently creates gross-pay runs.
+             */
+            pay_basis: string;
+        }
+    }
+}
+export interface OffCycleCreateParams {
+    /**
+     * One error per unconfirmed run creation. Empty on full success; reconcile before
+     * retrying.
+     */
+    errors: Array<OffCycleCreateParams.Error>;
+    /**
+     * Confirmed created draft runs. Empty when no creation could be confirmed.
+     */
+    runs: Array<OffCycleCreateParams.Run>;
+    /**
+     * SUCCESS, PARTIAL_SUCCESS, or FAILED. FAILED means no run creation was confirmed.
+     */
+    status: 'SUCCESS' | 'PARTIAL_SUCCESS' | 'FAILED';
+}
+export declare namespace OffCycleCreateParams {
+    interface Error {
+        /**
+         * Stable error code; an exception does not prove that no run was created.
+         */
+        code: 'RUN_CREATION_OUTCOME_UNKNOWN';
+        /**
+         * Payroll entity for the attempted run.
+         */
+        company_entity_id: string;
+        /**
+         * Employment category for the attempted run.
+         */
+        employment_split: string;
+        /**
+         * Safe description of the unconfirmed creation outcome and retry guidance.
+         */
+        message: string;
+        /**
+         * Role IDs in the run whose creation could not be confirmed.
+         */
+        worker_ids: Array<string>;
+    }
+    interface Run {
+        /**
+         * Payment date selected for this run.
+         */
+        check_date: string;
+        /**
+         * Identifier of the payroll entity that owns this run.
+         */
+        company_entity_id: string;
+        /**
+         * Country code of the payroll entity.
+         */
+        country_code: string;
+        /**
+         * Worker eligibility category used to split this run, such as employees or
+         * contractors.
+         */
+        employment_split: string;
+        /**
+         * Pay period for this run.
+         */
+        pay_period: Run.PayPeriod;
+        /**
+         * Calculation configuration used for this run.
+         */
+        run_configuration: Run.RunConfiguration;
+        /**
+         * Identifier of the created draft payroll run.
+         */
+        run_id: string;
+        /**
+         * Status of the created payroll run.
+         */
+        run_status: string;
+        /**
+         * Type of the created payroll run.
+         */
+        run_type: string;
+        /**
+         * Role IDs included in this run.
+         */
+        worker_ids: Array<string>;
+    }
+    namespace Run {
+        /**
+         * Pay period for this run.
+         */
+        interface PayPeriod {
+            /**
+             * End date of this run's pay period.
+             */
+            end_date: string;
+            /**
+             * Start date of this run's pay period.
+             */
+            start_date: string;
+        }
+        /**
+         * Calculation configuration used for this run.
+         */
+        interface RunConfiguration {
+            /**
+             * Amount basis used by the created run. This API currently creates gross-pay runs.
+             */
+            pay_basis: string;
+        }
+    }
+}
+export declare namespace OffCycle {
+    export { type OffCycleCreateResponse as OffCycleCreateResponse, type OffCycleCreateParams as OffCycleCreateParams, };
+}
+//# sourceMappingURL=off-cycle.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"off-cycle.d.mts","sourceRoot":"","sources":["../../src/resources/payroll-runs/off-cycle.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgGG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGjG;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAE5C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,iBAAiB,GAAG,QAAQ,CAAC;CAClD;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,8BAA8B,CAAC;QAErC;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC3B;IAED,UAAiB,GAAG;QAClB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,UAAU,EAAE,GAAG,CAAC,SAAS,CAAC;QAE1B;;WAEG;QACH,iBAAiB,EAAE,GAAG,CAAC,gBAAgB,CAAC;QAExC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC3B;IAED,UAAiB,GAAG,CAAC;QACnB;;WAEG;QACH,UAAiB,SAAS;YACxB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;QAED;;WAEG;QACH,UAAiB,gBAAgB;YAC/B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE1C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,iBAAiB,GAAG,QAAQ,CAAC;CAClD;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,8BAA8B,CAAC;QAErC;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC3B;IAED,UAAiB,GAAG;QAClB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,UAAU,EAAE,GAAG,CAAC,SAAS,CAAC;QAE1B;;WAEG;QACH,iBAAiB,EAAE,GAAG,CAAC,gBAAgB,CAAC;QAExC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC3B;IAED,UAAiB,GAAG,CAAC;QACnB;;WAEG;QACH,UAAiB,SAAS;YACxB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;QAED;;WAEG;QACH,UAAiB,gBAAgB;YAC/B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}