@rippling/rippling-sdk 0.2.0-alpha.53 → 0.2.0-alpha.55

package/src/resources/break-types.ts

@@ -0,0 +1,120 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Break types configured by the company for time tracking
+ */
+export class BreakTypes extends APIResource {
+  /**
+   * A list of break types.
+   *
+   * - Requires: `API Tier 2`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: BreakTypeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BreakTypeListResponsesPageCursorURL, BreakTypeListResponse> {
+    return this._client.getAPIList('/break-types/', PageCursorURL<BreakTypeListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific break type
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<BreakTypeRetrieveResponse> {
+    return this._client.get(path`/break-types/${id}/`, options);
+  }
+}
+
+export type BreakTypeListResponsesPageCursorURL = PageCursorURL<BreakTypeListResponse>;
+
+export interface BreakTypeListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the break type.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The break category. One of: MEAL, REST, or OTHER.
+   */
+  break_category?: 'MEAL' | 'REST' | 'OTHER';
+
+  /**
+   * Whether this is a paid break (true) or unpaid (false).
+   */
+  is_paid?: boolean;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface BreakTypeRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the break type.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The break category. One of: MEAL, REST, or OTHER.
+   */
+  break_category?: 'MEAL' | 'REST' | 'OTHER';
+
+  /**
+   * Whether this is a paid break (true) or unpaid (false).
+   */
+  is_paid?: boolean;
+}
+
+export interface BreakTypeListParams {
+  cursor?: string;
+
+  order_by?: string;
+}
+
+export declare namespace BreakTypes {
+  export {
+    type BreakTypeListResponse as BreakTypeListResponse,
+    type BreakTypeRetrieveResponse as BreakTypeRetrieveResponse,
+    type BreakTypeListResponsesPageCursorURL as BreakTypeListResponsesPageCursorURL,
+    type BreakTypeListParams as BreakTypeListParams,
+  };
+}

package/src/resources/earnings-inputs.ts

@@ -67,6 +67,13 @@ export interface EarningsInputListResponse {
    */
   assignment_type?: string;
 
+  /**
+   * Identifier for the legal entity (company entity relationship) this earning is
+   * associated with. Use this to correlate earnings with a specific legal entity in
+   * a multi-entity company.
+   */
+  company_entity_id?: string;
+
   /**
    * Code identifying the earning type (e.g. regular_salary).
    */
@@ -82,6 +89,12 @@ export interface EarningsInputListResponse {
    */
   hours?: string;
 
+  /**
+   * Whether this earning's amount was manually overridden instead of using the
+   * calculated value. Always false for newly created earnings.
+   */
+  is_overridden?: boolean;
+
   /**
    * The pay period basis date for this earning.
    */
@@ -130,6 +143,13 @@ export interface EarningsInputCreateResponse {
    */
   assignment_type?: string;
 
+  /**
+   * Identifier for the legal entity (company entity relationship) this earning is
+   * associated with. Use this to correlate earnings with a specific legal entity in
+   * a multi-entity company.
+   */
+  company_entity_id?: string;
+
   /**
    * Code identifying the earning type (e.g. regular_salary).
    */
@@ -145,6 +165,12 @@ export interface EarningsInputCreateResponse {
    */
   hours?: string;
 
+  /**
+   * Whether this earning's amount was manually overridden instead of using the
+   * calculated value. Always false for newly created earnings.
+   */
+  is_overridden?: boolean;
+
   /**
    * The pay period basis date for this earning.
    */
@@ -182,6 +208,13 @@ export interface EarningsInputCreateParams {
    */
   assignment_type?: string;
 
+  /**
+   * Identifier for the legal entity (company entity relationship) this earning is
+   * associated with. Use this to correlate earnings with a specific legal entity in
+   * a multi-entity company.
+   */
+  company_entity_id?: string;
+
   /**
    * Code identifying the earning type (e.g. regular_salary).
    */
@@ -197,6 +230,12 @@ export interface EarningsInputCreateParams {
    */
   hours?: string;
 
+  /**
+   * Whether this earning's amount was manually overridden instead of using the
+   * calculated value. Always false for newly created earnings.
+   */
+  is_overridden?: boolean;
+
   /**
    * The pay period basis date for this earning.
    */

package/src/resources/index.ts

@@ -1,6 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
+export {
+  BreakTypes,
+  type BreakTypeListResponse,
+  type BreakTypeRetrieveResponse,
+  type BreakTypeListParams,
+  type BreakTypeListResponsesPageCursorURL,
+} from './break-types';
 export {
   BusinessPartnerGroups,
   type BusinessPartnerGroup,
@@ -336,6 +343,13 @@ export {
 } from './report-runs';
 export { Reports, type ReportRetrieveResponse } from './reports/reports';
 export { SSOMeResource, type SSOMe, type SSOMeListParams } from './sso-me';
+export {
+  ScheduledJobAssignments,
+  type ScheduledJobAssignmentListResponse,
+  type ScheduledJobAssignmentRetrieveResponse,
+  type ScheduledJobAssignmentListParams,
+  type ScheduledJobAssignmentListResponsesPageCursorURL,
+} from './scheduled-job-assignments';
 export {
   Schedules,
   type ScheduleListResponse,
@@ -378,6 +392,18 @@ export {
   type ShiftassignmentUpdateParams,
   type ShiftassignmentListResponsesPageCursorURL,
 } from './shiftassignments';
+export {
+  SoftwareDeployments,
+  type SoftwareDeploymentListResponse,
+  type SoftwareDeploymentCreateResponse,
+  type SoftwareDeploymentRetrieveResponse,
+  type SoftwareDeploymentUpdateResponse,
+  type SoftwareDeploymentListParams,
+  type SoftwareDeploymentCreateParams,
+  type SoftwareDeploymentRetrieveParams,
+  type SoftwareDeploymentUpdateParams,
+  type SoftwareDeploymentListResponsesPageCursorURL,
+} from './software-deployments';
 export {
   Supergroups,
   type Supergroup,
@@ -468,6 +494,18 @@ export {
   type WorkLocationUpdateParams,
   type WorkLocationsPageCursorURL,
 } from './work-locations';
+export {
+  WorkerTimeSplits,
+  type WorkerTimeSplitListResponse,
+  type WorkerTimeSplitCreateResponse,
+  type WorkerTimeSplitRetrieveResponse,
+  type WorkerTimeSplitUpdateResponse,
+  type WorkerTimeSplitListParams,
+  type WorkerTimeSplitCreateParams,
+  type WorkerTimeSplitRetrieveParams,
+  type WorkerTimeSplitUpdateParams,
+  type WorkerTimeSplitListResponsesPageCursorURL,
+} from './worker-time-splits';
 export {
   Workers,
   type Worker,

package/src/resources/scheduled-job-assignments.ts

@@ -0,0 +1,216 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Job related information for the company
+ */
+export class ScheduledJobAssignments extends APIResource {
+  /**
+   * A list of scheduled job assignments.
+   *
+   * - Requires: `API Tier 2`
+   * - Sortable fields: `id`, `created_at`, `updated_at`, `effective_from`
+   */
+  list(
+    query: ScheduledJobAssignmentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ScheduledJobAssignmentListResponsesPageCursorURL, ScheduledJobAssignmentListResponse> {
+    return this._client.getAPIList(
+      '/scheduled-job-assignments/',
+      PageCursorURL<ScheduledJobAssignmentListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Retrieve a specific scheduled job assignment
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<ScheduledJobAssignmentRetrieveResponse> {
+    return this._client.get(path`/scheduled-job-assignments/${id}/`, options);
+  }
+
+  /**
+   * Delete a scheduled job assignment
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/scheduled-job-assignments/${id}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type ScheduledJobAssignmentListResponsesPageCursorURL =
+  PageCursorURL<ScheduledJobAssignmentListResponse>;
+
+/**
+ * Platform API DTO for a scheduled change targeting an EmployeeTimeTrackingJob.
+ */
+export interface ScheduledJobAssignmentListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Type of scheduled change: UNASSIGN or PAY_RATE_UPDATE.
+   */
+  change_type?: 'UNASSIGN' | 'PAY_RATE_UPDATE';
+
+  /**
+   * The ID of the role that created this scheduled change.
+   */
+  changed_by_id?: string;
+
+  /**
+   * When the scheduled change will be applied (ISO 8601).
+   */
+  effective_from?: string;
+
+  /**
+   * The ID of the job assignment (ETTJ) this scheduled change targets.
+   */
+  job_assignment_id?: string;
+
+  /**
+   * The ID of the job code assigned.
+   */
+  job_code_id?: string;
+
+  /**
+   * Display name of the job code.
+   */
+  job_code_name?: string;
+
+  /**
+   * The ID of the job dimension the job code belongs to.
+   */
+  job_dimension_id?: string;
+
+  /**
+   * Display name of the job dimension.
+   */
+  job_dimension_name?: string;
+
+  /**
+   * New pay rate value, if the change modifies pay_rate.
+   */
+  pay_rate?: number;
+
+  /**
+   * Reason provided when the scheduled change was created.
+   */
+  reason?: string;
+
+  /**
+   * The ID of the worker (role) the job assignment belongs to.
+   */
+  worker_id?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface ScheduledJobAssignmentRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Type of scheduled change: UNASSIGN or PAY_RATE_UPDATE.
+   */
+  change_type?: 'UNASSIGN' | 'PAY_RATE_UPDATE';
+
+  /**
+   * The ID of the role that created this scheduled change.
+   */
+  changed_by_id?: string;
+
+  /**
+   * When the scheduled change will be applied (ISO 8601).
+   */
+  effective_from?: string;
+
+  /**
+   * The ID of the job assignment (ETTJ) this scheduled change targets.
+   */
+  job_assignment_id?: string;
+
+  /**
+   * The ID of the job code assigned.
+   */
+  job_code_id?: string;
+
+  /**
+   * Display name of the job code.
+   */
+  job_code_name?: string;
+
+  /**
+   * The ID of the job dimension the job code belongs to.
+   */
+  job_dimension_id?: string;
+
+  /**
+   * Display name of the job dimension.
+   */
+  job_dimension_name?: string;
+
+  /**
+   * New pay rate value, if the change modifies pay_rate.
+   */
+  pay_rate?: number;
+
+  /**
+   * Reason provided when the scheduled change was created.
+   */
+  reason?: string;
+
+  /**
+   * The ID of the worker (role) the job assignment belongs to.
+   */
+  worker_id?: string;
+}
+
+export interface ScheduledJobAssignmentListParams {
+  cursor?: string;
+
+  order_by?: string;
+}
+
+export declare namespace ScheduledJobAssignments {
+  export {
+    type ScheduledJobAssignmentListResponse as ScheduledJobAssignmentListResponse,
+    type ScheduledJobAssignmentRetrieveResponse as ScheduledJobAssignmentRetrieveResponse,
+    type ScheduledJobAssignmentListResponsesPageCursorURL as ScheduledJobAssignmentListResponsesPageCursorURL,
+    type ScheduledJobAssignmentListParams as ScheduledJobAssignmentListParams,
+  };
+}