@rippling/rippling-sdk 0.2.0-alpha.31 → 0.2.0-alpha.32

package/src/resources/earnings-inputs.ts

@@ -0,0 +1,93 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * External earnings inputs for the company
+ */
+export class EarningsInputs extends APIResource {
+  /**
+   * A list of earnings-inputs.
+   *
+   * - Requires: `Payroll API`
+   */
+  list(
+    options?: RequestOptions,
+  ): PagePromise<EarningsInputListResponsesPageCursorURL, EarningsInputListResponse> {
+    return this._client.getAPIList('/earnings-inputs/', PageCursorURL<EarningsInputListResponse>, options);
+  }
+}
+
+export type EarningsInputListResponsesPageCursorURL = PageCursorURL<EarningsInputListResponse>;
+
+/**
+ * V2 DTO representing an external earnings input record.
+ *
+ *     Used by:
+ *       - GET /earnings-inputs/  (list)
+ */
+export interface EarningsInputListResponse {
+  /**
+   * Unique identifier for the earnings input.
+   */
+  id?: string;
+
+  /**
+   * Earning amount as a string-encoded decimal.
+   */
+  amount?: string;
+
+  /**
+   * How the earning is assigned (e.g. BY_PAY_PERIOD).
+   */
+  assignment_type?: string;
+
+  /**
+   * Code identifying the earning type (e.g. regular_salary).
+   */
+  earning_code?: string;
+
+  /**
+   * External reference identifier for this earning.
+   */
+  external_id?: string;
+
+  /**
+   * Hours associated with this earning as a string-encoded decimal.
+   */
+  hours?: string;
+
+  /**
+   * The pay period basis date for this earning.
+   */
+  pay_period_basis_date?: string;
+
+  /**
+   * Identifier of the payroll run this earning is assigned to, if any.
+   */
+  run_id?: string;
+
+  /**
+   * Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED).
+   */
+  status?: string;
+
+  /**
+   * Time tracking labels associated with this earning.
+   */
+  time_labels?: Array<string>;
+
+  /**
+   * Identifier of the worker (role ID).
+   */
+  worker_id?: string;
+}
+
+export declare namespace EarningsInputs {
+  export {
+    type EarningsInputListResponse as EarningsInputListResponse,
+    type EarningsInputListResponsesPageCursorURL as EarningsInputListResponsesPageCursorURL,
+  };
+}

package/src/resources/index.ts

@@ -109,6 +109,11 @@ export {
   type EarningTypeListResponse,
   type EarningTypeListResponsesPageCursorURL,
 } from './earning-types';
+export {
+  EarningsInputs,
+  type EarningsInputListResponse,
+  type EarningsInputListResponsesPageCursorURL,
+} from './earnings-inputs';
 export {
   EmploymentTypes,
   type CompanyEmploymentType,

package/src/resources/job-codes.ts

@@ -147,6 +147,12 @@ export interface JobCode {
    */
   group_id?: string;
 
+  /**
+   * Whether this job code is archived. Set to true via PATCH to archive. Archiving
+   * is irreversible via this API.
+   */
+  is_archived?: boolean;
+
   /**
    * The job dimension this job code belongs to.
    *
@@ -222,6 +228,12 @@ export interface JobCodeRequest {
    */
   external_id?: string;
 
+  /**
+   * Whether this job code is archived. Set to true via PATCH to archive. Archiving
+   * is irreversible via this API.
+   */
+  is_archived?: boolean;
+
   /**
    * The pay rate for this job code. Only applicable if the associated job dimension
    * includes the 'PAY_RATE' organizational attribute.
@@ -332,6 +344,12 @@ export interface JobCodeCreateParams {
    */
   external_id?: string;
 
+  /**
+   * Whether this job code is archived. Set to true via PATCH to archive. Archiving
+   * is irreversible via this API.
+   */
+  is_archived?: boolean;
+
   /**
    * The pay rate for this job code. Only applicable if the associated job dimension
    * includes the 'PAY_RATE' organizational attribute.
@@ -431,6 +449,12 @@ export interface JobCodeUpdateParams {
    */
   external_id?: string;
 
+  /**
+   * Whether this job code is archived. Set to true via PATCH to archive. Archiving
+   * is irreversible via this API.
+   */
+  is_archived?: boolean;
+
   /**
    * The pay rate for this job code. Only applicable if the associated job dimension
    * includes the 'PAY_RATE' organizational attribute.