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

package/src/resources/index.ts

@@ -526,6 +526,11 @@ export {
   type PackageUpdateParams,
   type PackageListResponsesPageCursorURL,
 } from './packages/packages';
+export {
+  PayrollPaymentModeChanges,
+  type PayrollPaymentModeChangeCreateResponse,
+  type PayrollPaymentModeChangeCreateParams,
+} from './payroll-payment-mode-changes';
 export {
   PayrollRuns,
   type PayrollRunListResponse,

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

@@ -0,0 +1,121 @@
+// 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';
+
+/**
+ * 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.
+   *
+   * @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
+   *
+   * {
+   *   "changes": [
+   *     {
+   *       "run_id": "string",
+   *       "worker_id": "string",
+   *       "payment_mode": "DEFAULT"
+   *     }
+   *   ]
+   * }
+   * ```
+   */
+  create(
+    body: PayrollPaymentModeChangeCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PayrollPaymentModeChangeCreateResponse> {
+    return this._client.post('/payroll-payment-mode-changes/', { body, ...options });
+  }
+}
+
+export interface PayrollPaymentModeChangeCreateResponse {
+  /**
+   * Payment mode changes to process. The maximum batch size is 100.
+   */
+  changes: Array<PayrollPaymentModeChangeCreateResponse.Change>;
+}
+
+export namespace PayrollPaymentModeChangeCreateResponse {
+  export 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), and CHECK_PRINTING (Check printing). CHECK_MAILING
+     * is supported when eligible; its customer-facing label is pending confirmation.
+     */
+    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 interface PayrollPaymentModeChangeCreateParams {
+  /**
+   * Payment mode changes to process. The maximum batch size is 100.
+   */
+  changes: Array<PayrollPaymentModeChangeCreateParams.Change>;
+}
+
+export namespace PayrollPaymentModeChangeCreateParams {
+  export 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), and CHECK_PRINTING (Check printing). CHECK_MAILING
+     * is supported when eligible; its customer-facing label is pending confirmation.
+     */
+    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,
+  };
+}

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

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export { OffCycle, type OffCycleCreateResponse, type OffCycleCreateParams } from './off-cycle';
 export {
   PayrollRuns,
   type PayrollRunListResponse,

package/src/resources/payroll-runs/off-cycle.ts

@@ -0,0 +1,372 @@
+// 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';
+
+/**
+ * Payroll runs for the company
+ */
+export 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> {
+    return this._client.post('/payroll-runs/off-cycle/', { body, ...options });
+  }
+}
+
+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 namespace OffCycleCreateResponse {
+  export 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>;
+  }
+
+  export 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>;
+  }
+
+  export namespace Run {
+    /**
+     * Pay period for this run.
+     */
+    export 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.
+     */
+    export 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 namespace OffCycleCreateParams {
+  export 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>;
+  }
+
+  export 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>;
+  }
+
+  export namespace Run {
+    /**
+     * Pay period for this run.
+     */
+    export 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.
+     */
+    export 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,
+  };
+}

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

@@ -2,6 +2,8 @@
 
 import { APIResource } from '../../core/resource';
 import * as BusinessPartnersAPI from '../business-partners';
+import * as OffCycleAPI from './off-cycle';
+import { OffCycle, OffCycleCreateParams, OffCycleCreateResponse } from './off-cycle';
 import * as WorkerPayrollRecordsAPI from './worker-payroll-records';
 import {
   WorkerPayrollRecordListParams,
@@ -18,6 +20,7 @@ import { path } from '../../internal/utils/path';
  * Payroll runs for the company
  */
 export class PayrollRuns extends APIResource {
+  offCycle: OffCycleAPI.OffCycle = new OffCycleAPI.OffCycle(this._client);
   workerPayrollRecords: WorkerPayrollRecordsAPI.WorkerPayrollRecords =
     new WorkerPayrollRecordsAPI.WorkerPayrollRecords(this._client);
 
@@ -324,6 +327,7 @@ export interface PayrollRunListParams {
   order_by?: string;
 }
 
+PayrollRuns.OffCycle = OffCycle;
 PayrollRuns.WorkerPayrollRecords = WorkerPayrollRecords;
 
 export declare namespace PayrollRuns {
@@ -334,6 +338,12 @@ export declare namespace PayrollRuns {
     type PayrollRunListParams as PayrollRunListParams,
   };
 
+  export {
+    OffCycle as OffCycle,
+    type OffCycleCreateResponse as OffCycleCreateResponse,
+    type OffCycleCreateParams as OffCycleCreateParams,
+  };
+
   export {
     WorkerPayrollRecords as WorkerPayrollRecords,
     type WorkerPayrollRecordListResponse as WorkerPayrollRecordListResponse,

package/src/resources/sandboxes.ts

@@ -181,9 +181,7 @@ export class Sandboxes extends APIResource {
   }
 
   /**
-   * Delete a sandbox. Deleting a developer sandbox deactivates all linked Unity
-   * package associations, including associations in EDIT mode or with a recent link
-   * operation in progress.
+   * Delete a sandbox
    *
    * @example HTTP
    * Representative request and response shapes.
@@ -331,9 +329,11 @@ export namespace SandboxListResponse {
      */
     export interface Developer {
       /**
-       * Seed company size for the developer sandbox.
+       * Seed company size for the developer sandbox. MEDIUM is the supported value for
+       * new sandboxes. SMALL is retained for existing sandboxes only and is not
+       * supported on create.
        */
-      company_size: 'SMALL' | 'MID';
+      company_size: 'SMALL' | 'MEDIUM';
     }
 
     /**
@@ -584,9 +584,11 @@ export namespace SandboxCreateResponse {
      */
     export interface Developer {
       /**
-       * Seed company size for the developer sandbox.
+       * Seed company size for the developer sandbox. MEDIUM is the supported value for
+       * new sandboxes. SMALL is retained for existing sandboxes only and is not
+       * supported on create.
        */
-      company_size: 'SMALL' | 'MID';
+      company_size: 'SMALL' | 'MEDIUM';
     }
 
     /**
@@ -840,9 +842,11 @@ export namespace SandboxRetrieveResponse {
      */
     export interface Developer {
       /**
-       * Seed company size for the developer sandbox.
+       * Seed company size for the developer sandbox. MEDIUM is the supported value for
+       * new sandboxes. SMALL is retained for existing sandboxes only and is not
+       * supported on create.
        */
-      company_size: 'SMALL' | 'MID';
+      company_size: 'SMALL' | 'MEDIUM';
     }
 
     /**
@@ -1096,9 +1100,11 @@ export namespace SandboxCreateParams {
      */
     export interface Developer {
       /**
-       * Seed company size for the developer sandbox.
+       * Seed company size for the developer sandbox. MEDIUM is the supported value for
+       * new sandboxes. SMALL is retained for existing sandboxes only and is not
+       * supported on create.
        */
-      company_size: 'SMALL' | 'MID';
+      company_size: 'SMALL' | 'MEDIUM';
     }
 
     /**

package/src/resources/variable-compensation-payout-labels.ts

@@ -15,7 +15,7 @@ export class VariableCompensationPayoutLabels extends APIResource {
    * List payout source and group labels. Paginated with limit and cursor. Filters
    * use the documented query parameters only (not OData filter).
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Variable Compensation Scheduled Payouts API`
    *
    * @example HTTP
    * Representative request and response shapes.

package/src/resources/variable-compensation-payout-types.ts

@@ -15,7 +15,7 @@ export class VariableCompensationPayoutTypes extends APIResource {
   /**
    * List system and custom payout types with per-entity earning mappings.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Variable Compensation Scheduled Payouts API`
    *
    * @example HTTP
    * Representative request and response shapes.

package/src/resources/variable-compensation-payouts.ts

@@ -17,7 +17,7 @@ export class VariableCompensationPayouts extends APIResource {
    * admin payout rowset; callers without admin payout visibility receive an empty
    * list. Retrieve returns NotFound for the same rows.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Variable Compensation Scheduled Payouts API`
    *
    * @example HTTP
    * Representative request and response shapes.

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.105";
+export declare const VERSION = "0.2.0-alpha.106";
 //# 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.105'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.106'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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