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

package/src/resources/worker-time-splits.ts

@@ -0,0 +1,480 @@
+// 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 * as JobCodesAPI from './job-codes';
+import * as WorkersAPI from './workers';
+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 WorkerTimeSplits extends APIResource {
+  /**
+   * A list of worker time splits.
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `worker_id`, `is_enabled`, `updated_at`
+   * - Expandable fields: `worker`, `job_codes`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: WorkerTimeSplitListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<WorkerTimeSplitListResponsesPageCursorURL, WorkerTimeSplitListResponse> {
+    return this._client.getAPIList('/worker-time-splits/', PageCursorURL<WorkerTimeSplitListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Create a new worker time split
+   */
+  create(
+    body: WorkerTimeSplitCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<WorkerTimeSplitCreateResponse> {
+    return this._client.post('/worker-time-splits/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific worker time split
+   */
+  retrieve(
+    id: string,
+    query: WorkerTimeSplitRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WorkerTimeSplitRetrieveResponse> {
+    return this._client.get(path`/worker-time-splits/${id}/`, { query, ...options });
+  }
+
+  /**
+   * Update a specific worker time split.
+   */
+  update(
+    id: string,
+    body: WorkerTimeSplitUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<WorkerTimeSplitUpdateResponse> {
+    return this._client.patch(path`/worker-time-splits/${id}/`, { body, ...options });
+  }
+
+  /**
+   * Delete a worker time split
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/worker-time-splits/${id}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type WorkerTimeSplitListResponsesPageCursorURL = PageCursorURL<WorkerTimeSplitListResponse>;
+
+/**
+ * Worker time split configuration resource.
+ */
+export interface WorkerTimeSplitListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Identifier of the worker whose time split configuration this represents.
+   */
+  worker_id: string;
+
+  /**
+   * Whether hard-coded time splits are active for this worker.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The job codes referenced in this time split configuration. Use ?expand=job_codes
+   * to populate.
+   *
+   * Expandable field
+   */
+  job_codes?: Array<JobCodesAPI.JobCode>;
+
+  /**
+   * IDs of all unique job codes referenced across all split rows.
+   */
+  job_codes_id?: Array<string>;
+
+  /**
+   * The split rows defining time allocation percentages across job codes. Empty when
+   * is_enabled is false.
+   */
+  splits?: Array<WorkerTimeSplitListResponse.Split>;
+
+  /**
+   * The worker associated with this time split configuration.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export namespace WorkerTimeSplitListResponse {
+  /**
+   * A single split row representing a percentage allocation across one or more job
+   * codes.
+   */
+  export interface Split {
+    /**
+     * IDs of canonical /job-codes/ resources in this split row.
+     */
+    job_code_ids?: Array<string>;
+
+    /**
+     * Percentage allocated to this split row. Decimal string with precision 2; must be
+     * greater than zero per row. All rows must sum to 100.00 when is_enabled is true.
+     */
+    split_percentage?: string;
+  }
+}
+
+/**
+ * Worker time split configuration resource.
+ */
+export interface WorkerTimeSplitCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Identifier of the worker whose time split configuration this represents.
+   */
+  worker_id: string;
+
+  /**
+   * Whether hard-coded time splits are active for this worker.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The job codes referenced in this time split configuration. Use ?expand=job_codes
+   * to populate.
+   *
+   * Expandable field
+   */
+  job_codes?: Array<JobCodesAPI.JobCode>;
+
+  /**
+   * IDs of all unique job codes referenced across all split rows.
+   */
+  job_codes_id?: Array<string>;
+
+  /**
+   * The split rows defining time allocation percentages across job codes. Empty when
+   * is_enabled is false.
+   */
+  splits?: Array<WorkerTimeSplitCreateResponse.Split>;
+
+  /**
+   * The worker associated with this time split configuration.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export namespace WorkerTimeSplitCreateResponse {
+  /**
+   * A single split row representing a percentage allocation across one or more job
+   * codes.
+   */
+  export interface Split {
+    /**
+     * IDs of canonical /job-codes/ resources in this split row.
+     */
+    job_code_ids?: Array<string>;
+
+    /**
+     * Percentage allocated to this split row. Decimal string with precision 2; must be
+     * greater than zero per row. All rows must sum to 100.00 when is_enabled is true.
+     */
+    split_percentage?: string;
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface WorkerTimeSplitRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Identifier of the worker whose time split configuration this represents.
+   */
+  worker_id: string;
+
+  /**
+   * Whether hard-coded time splits are active for this worker.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The job codes referenced in this time split configuration. Use ?expand=job_codes
+   * to populate.
+   *
+   * Expandable field
+   */
+  job_codes?: Array<JobCodesAPI.JobCode>;
+
+  /**
+   * IDs of all unique job codes referenced across all split rows.
+   */
+  job_codes_id?: Array<string>;
+
+  /**
+   * The split rows defining time allocation percentages across job codes. Empty when
+   * is_enabled is false.
+   */
+  splits?: Array<WorkerTimeSplitRetrieveResponse.Split>;
+
+  /**
+   * The worker associated with this time split configuration.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export namespace WorkerTimeSplitRetrieveResponse {
+  /**
+   * A single split row representing a percentage allocation across one or more job
+   * codes.
+   */
+  export interface Split {
+    /**
+     * IDs of canonical /job-codes/ resources in this split row.
+     */
+    job_code_ids?: Array<string>;
+
+    /**
+     * Percentage allocated to this split row. Decimal string with precision 2; must be
+     * greater than zero per row. All rows must sum to 100.00 when is_enabled is true.
+     */
+    split_percentage?: string;
+  }
+}
+
+/**
+ * Worker time split configuration resource.
+ */
+export interface WorkerTimeSplitUpdateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Identifier of the worker whose time split configuration this represents.
+   */
+  worker_id: string;
+
+  /**
+   * Whether hard-coded time splits are active for this worker.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The job codes referenced in this time split configuration. Use ?expand=job_codes
+   * to populate.
+   *
+   * Expandable field
+   */
+  job_codes?: Array<JobCodesAPI.JobCode>;
+
+  /**
+   * IDs of all unique job codes referenced across all split rows.
+   */
+  job_codes_id?: Array<string>;
+
+  /**
+   * The split rows defining time allocation percentages across job codes. Empty when
+   * is_enabled is false.
+   */
+  splits?: Array<WorkerTimeSplitUpdateResponse.Split>;
+
+  /**
+   * The worker associated with this time split configuration.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export namespace WorkerTimeSplitUpdateResponse {
+  /**
+   * A single split row representing a percentage allocation across one or more job
+   * codes.
+   */
+  export interface Split {
+    /**
+     * IDs of canonical /job-codes/ resources in this split row.
+     */
+    job_code_ids?: Array<string>;
+
+    /**
+     * Percentage allocated to this split row. Decimal string with precision 2; must be
+     * greater than zero per row. All rows must sum to 100.00 when is_enabled is true.
+     */
+    split_percentage?: string;
+  }
+}
+
+export interface WorkerTimeSplitListParams {
+  cursor?: string;
+
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface WorkerTimeSplitCreateParams {
+  /**
+   * Identifier of the worker whose time split configuration this represents.
+   */
+  worker_id: string;
+
+  /**
+   * Whether hard-coded time splits are active for this worker.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The split rows defining time allocation percentages across job codes. Empty when
+   * is_enabled is false.
+   */
+  splits?: Array<WorkerTimeSplitCreateParams.Split>;
+}
+
+export namespace WorkerTimeSplitCreateParams {
+  /**
+   * A single split row representing a percentage allocation across one or more job
+   * codes.
+   */
+  export interface Split {
+    /**
+     * IDs of canonical /job-codes/ resources in this split row.
+     */
+    job_code_ids?: Array<string>;
+
+    /**
+     * Percentage allocated to this split row. Decimal string with precision 2; must be
+     * greater than zero per row. All rows must sum to 100.00 when is_enabled is true.
+     */
+    split_percentage?: string;
+  }
+}
+
+export interface WorkerTimeSplitRetrieveParams {
+  expand?: string;
+}
+
+export interface WorkerTimeSplitUpdateParams {
+  /**
+   * Identifier of the worker whose time split configuration this represents.
+   */
+  worker_id: string;
+
+  /**
+   * Whether hard-coded time splits are active for this worker.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The split rows defining time allocation percentages across job codes. Empty when
+   * is_enabled is false.
+   */
+  splits?: Array<WorkerTimeSplitUpdateParams.Split>;
+}
+
+export namespace WorkerTimeSplitUpdateParams {
+  /**
+   * A single split row representing a percentage allocation across one or more job
+   * codes.
+   */
+  export interface Split {
+    /**
+     * IDs of canonical /job-codes/ resources in this split row.
+     */
+    job_code_ids?: Array<string>;
+
+    /**
+     * Percentage allocated to this split row. Decimal string with precision 2; must be
+     * greater than zero per row. All rows must sum to 100.00 when is_enabled is true.
+     */
+    split_percentage?: string;
+  }
+}
+
+export declare namespace WorkerTimeSplits {
+  export {
+    type WorkerTimeSplitListResponse as WorkerTimeSplitListResponse,
+    type WorkerTimeSplitCreateResponse as WorkerTimeSplitCreateResponse,
+    type WorkerTimeSplitRetrieveResponse as WorkerTimeSplitRetrieveResponse,
+    type WorkerTimeSplitUpdateResponse as WorkerTimeSplitUpdateResponse,
+    type WorkerTimeSplitListResponsesPageCursorURL as WorkerTimeSplitListResponsesPageCursorURL,
+    type WorkerTimeSplitListParams as WorkerTimeSplitListParams,
+    type WorkerTimeSplitCreateParams as WorkerTimeSplitCreateParams,
+    type WorkerTimeSplitRetrieveParams as WorkerTimeSplitRetrieveParams,
+    type WorkerTimeSplitUpdateParams as WorkerTimeSplitUpdateParams,
+  };
+}

package/src/resources/workers.ts

@@ -23,7 +23,7 @@ export class Workers extends APIResource {
    *
    * - Requires: `API Tier 1`
    * - Filterable fields: `status`, `work_email`, `user_id`, `created_at`,
-   *   `updated_at`, `department_id`, `manager_id`
+   *   `updated_at`
    * - Expandable fields: `user`, `manager`, `legal_entity`, `employment_type`,
    *   `compensation`, `department`, `teams`, `level`, `custom_fields`,
    *   `business_partners`

package/src/resources/workflow-action-executions.ts

@@ -1097,6 +1097,13 @@ export namespace WorkflowActionExecutionCreateParams {
 
     message: string;
 
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
+
     team_id?: string | null;
   }
 
@@ -1111,6 +1118,13 @@ export namespace WorkflowActionExecutionCreateParams {
     message: string;
 
     recipients?: Array<string> | null;
+
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
   }
 
   /**
@@ -1129,6 +1143,13 @@ export namespace WorkflowActionExecutionCreateParams {
      * Maximum reviewees: 500
      */
     reviewers: Array<string>;
+
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
   }
 
   /**
@@ -1147,6 +1168,13 @@ export namespace WorkflowActionExecutionCreateParams {
      * Maximum reviewees: 500
      */
     reviewers: Array<string>;
+
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
   }
 
   /**
@@ -1210,6 +1238,13 @@ export namespace WorkflowActionExecutionCreateParams {
 
     port?: number | null;
 
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
+
     show_sub_totals?: boolean | null;
 
     /**
@@ -1284,6 +1319,13 @@ export namespace WorkflowActionExecutionCreateParams {
 
     port?: number | null;
 
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
+
     show_sub_totals?: boolean | null;
 
     /**
@@ -1353,6 +1395,13 @@ export namespace WorkflowActionExecutionCreateParams {
 
     port?: number | null;
 
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
+
     show_sub_totals?: boolean | null;
 
     /**
@@ -1427,6 +1476,13 @@ export namespace WorkflowActionExecutionCreateParams {
 
     port?: number | null;
 
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
+
     show_sub_totals?: boolean | null;
 
     /**
@@ -1687,6 +1743,13 @@ export namespace WorkflowActionExecutionCreateParams {
      */
     date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
 
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
+
     show_sub_totals?: boolean | null;
 
     /**
@@ -1846,6 +1909,13 @@ export namespace WorkflowActionExecutionCreateParams {
      */
     date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
 
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
+
     show_sub_totals?: boolean | null;
 
     /**
@@ -1974,6 +2044,13 @@ export namespace WorkflowActionExecutionCreateParams {
      * Maximum recipients: 500
      */
     recipients: Array<string>;
+
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
   }
 
   /**
@@ -1999,6 +2076,13 @@ export namespace WorkflowActionExecutionCreateParams {
     pto_type: 'LEAVE_POLICY';
 
     recipients: Array<string>;
+
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
   }
 
   /**
@@ -2024,6 +2108,13 @@ export namespace WorkflowActionExecutionCreateParams {
     pto_type: 'COMPANY_LEAVE_TYPE';
 
     recipients: Array<string>;
+
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
   }
 
   /**
@@ -2043,6 +2134,13 @@ export namespace WorkflowActionExecutionCreateParams {
     payment_amount: number;
 
     recipients: Array<string>;
+
+    /**
+     * Functions Service run_id. When provided, the request returns 202 and completion
+     * is delivered back to the run via SendRunEvent. When omitted, the action falls
+     * back to synchronous execution.
+     */
+    run_id?: string | null;
   }
 
   export interface RunQueryPayload {

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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