@rippling/rippling-sdk 0.2.0-alpha.25 → 0.2.0-alpha.27

package/src/resources/job-assignments.ts

@@ -7,9 +7,13 @@ import * as JobPayRateExceptionsAPI from './job-pay-rate-exceptions';
 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 JobAssignments extends APIResource {
   /**
    * A List of job assignments
@@ -26,6 +30,13 @@ export class JobAssignments extends APIResource {
     return this._client.getAPIList('/job-assignments', PageCursorURL<JobAssignment>, { query, ...options });
   }
 
+  /**
+   * Create a new job assignment
+   */
+  create(body: JobAssignmentCreateParams, options?: RequestOptions): APIPromise<JobAssignment> {
+    return this._client.post('/job-assignments', { body, ...options });
+  }
+
   /**
    * Retrieve a specific job assignment
    */
@@ -37,6 +48,23 @@ export class JobAssignments extends APIResource {
     return this._client.get(path`/job-assignments/${id}`, { query, ...options });
   }
 
+  /**
+   * Updated a specific job assignment
+   */
+  update(id: string, body: JobAssignmentUpdateParams, options?: RequestOptions): APIPromise<JobAssignment> {
+    return this._client.patch(path`/job-assignments/${id}`, { body, ...options });
+  }
+
+  /**
+   * Delete a job assignment
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/job-assignments/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * A List of attribute change logs
    *
@@ -140,12 +168,6 @@ export interface JobAssignment {
    */
   job_code_id: string;
 
-  /**
-   * The pay rate for job assigned to worker. This can be different from the job's
-   * standard pay rate and can be overriden for a worker.
-   */
-  job_pay_rate: number;
-
   /**
    * Record update date
    */
@@ -168,6 +190,12 @@ export interface JobAssignment {
    */
   job_code?: JobCodesAPI.JobCode;
 
+  /**
+   * The pay rate for job assigned to worker. This can be different from the job's
+   * standard pay rate and can be overriden for a worker.
+   */
+  job_pay_rate?: number;
+
   /**
    * Pay rate exceptions applicable for the worker based on certain exception
    * dimension values.
@@ -205,10 +233,72 @@ export interface JobAssignmentListParams {
   order_by?: string;
 }
 
+export interface JobAssignmentCreateParams {
+  /**
+   * Identifier of job that is assigned to worker
+   */
+  job_code_id: string;
+
+  /**
+   * Identifier of worker to whom job is assigned.
+   */
+  worker_id: string;
+
+  /**
+   * The pay rate for job assigned to worker. This can be different from the job's
+   * standard pay rate and can be overriden for a worker.
+   */
+  job_pay_rate?: number;
+
+  /**
+   * Reason for setting, updating, or resetting the pay rate for the job assigned to
+   * the worker.
+   */
+  job_pay_rate_change_reason?: string;
+
+  /**
+   * Date and time the pay rate becomes effective (ISO 8601 format
+   * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
+   * current time in UTC if not provided.
+   */
+  job_pay_rate_effective_from?: string;
+}
+
 export interface JobAssignmentRetrieveParams {
   expand?: string;
 }
 
+export interface JobAssignmentUpdateParams {
+  /**
+   * Identifier of job that is assigned to worker
+   */
+  job_code_id: string;
+
+  /**
+   * Identifier of worker to whom job is assigned.
+   */
+  worker_id: string;
+
+  /**
+   * The pay rate for job assigned to worker. This can be different from the job's
+   * standard pay rate and can be overriden for a worker.
+   */
+  job_pay_rate?: number;
+
+  /**
+   * Reason for setting, updating, or resetting the pay rate for the job assigned to
+   * the worker.
+   */
+  job_pay_rate_change_reason?: string;
+
+  /**
+   * Date and time the pay rate becomes effective (ISO 8601 format
+   * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
+   * current time in UTC if not provided.
+   */
+  job_pay_rate_effective_from?: string;
+}
+
 export interface JobAssignmentListChangeLogParams {
   cursor?: string;
 
@@ -225,7 +315,9 @@ export declare namespace JobAssignments {
     type JobAssignmentsPageCursorURL as JobAssignmentsPageCursorURL,
     type AttributeChangeDetailsPageCursorURL as AttributeChangeDetailsPageCursorURL,
     type JobAssignmentListParams as JobAssignmentListParams,
+    type JobAssignmentCreateParams as JobAssignmentCreateParams,
     type JobAssignmentRetrieveParams as JobAssignmentRetrieveParams,
+    type JobAssignmentUpdateParams as JobAssignmentUpdateParams,
     type JobAssignmentListChangeLogParams as JobAssignmentListChangeLogParams,
   };
 }

package/src/resources/job-codes.ts

@@ -15,6 +15,9 @@ 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 JobCodes extends APIResource {
   /**
    * A List of job codes
@@ -152,7 +155,8 @@ export interface JobCode {
   job_dimension?: JobDimensionsAPI.JobDimension;
 
   /**
-   * The pay rate for job, if job code is associated with pay rate.
+   * The pay rate for this job code. Only applicable if the associated job dimension
+   * includes the 'PAY_RATE' organizational attribute.
    */
   pay_rate?: number;
 
@@ -217,6 +221,24 @@ export interface JobCodeRequest {
    * The unique identifier of the job code in an outside system.
    */
   external_id?: string;
+
+  /**
+   * The pay rate for this job code. Only applicable if the associated job dimension
+   * includes the 'PAY_RATE' organizational attribute.
+   */
+  pay_rate?: number;
+
+  /**
+   * Reason for setting, updating, or resetting the pay rate on this job code.
+   */
+  pay_rate_change_reason?: string;
+
+  /**
+   * Date and time the pay rate becomes effective (ISO 8601 format
+   * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
+   * current time in UTC if not provided.
+   */
+  pay_rate_effective_from?: string;
 }
 
 export namespace JobCodeRequest {
@@ -309,6 +331,24 @@ export interface JobCodeCreateParams {
    * The unique identifier of the job code in an outside system.
    */
   external_id?: string;
+
+  /**
+   * The pay rate for this job code. Only applicable if the associated job dimension
+   * includes the 'PAY_RATE' organizational attribute.
+   */
+  pay_rate?: number;
+
+  /**
+   * Reason for setting, updating, or resetting the pay rate on this job code.
+   */
+  pay_rate_change_reason?: string;
+
+  /**
+   * Date and time the pay rate becomes effective (ISO 8601 format
+   * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
+   * current time in UTC if not provided.
+   */
+  pay_rate_effective_from?: string;
 }
 
 export namespace JobCodeCreateParams {
@@ -390,6 +430,24 @@ export interface JobCodeUpdateParams {
    * The unique identifier of the job code in an outside system.
    */
   external_id?: string;
+
+  /**
+   * The pay rate for this job code. Only applicable if the associated job dimension
+   * includes the 'PAY_RATE' organizational attribute.
+   */
+  pay_rate?: number;
+
+  /**
+   * Reason for setting, updating, or resetting the pay rate on this job code.
+   */
+  pay_rate_change_reason?: string;
+
+  /**
+   * Date and time the pay rate becomes effective (ISO 8601 format
+   * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
+   * current time in UTC if not provided.
+   */
+  pay_rate_effective_from?: string;
 }
 
 export namespace JobCodeUpdateParams {

package/src/resources/job-dimensions.ts

@@ -8,6 +8,9 @@ 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 JobDimensions extends APIResource {
   /**
    * A List of job dimensions
@@ -94,6 +97,12 @@ export interface JobDimension {
    */
   includes_custom_location?: boolean;
 
+  /**
+   * Organizational attributes associated with the job dimension. Only 'PAY_RATE' can
+   * be set or modified using POST or PATCH requests.
+   */
+  org_attribute_associations?: Array<'DEPARTMENT' | 'WORK_LOCATION' | 'PAY_RATE' | 'ENTITY'>;
+
   /**
    * The roster type of the dimension. PER_DIMENSION means that there is a group on
    * the dimension level and employees within that group have access to all job codes
@@ -119,6 +128,12 @@ export interface JobDimensionRequest {
    */
   includes_custom_location?: boolean;
 
+  /**
+   * Organizational attributes associated with the job dimension. Only 'PAY_RATE' can
+   * be set or modified using POST or PATCH requests.
+   */
+  org_attribute_associations?: Array<'DEPARTMENT' | 'WORK_LOCATION' | 'PAY_RATE' | 'ENTITY'>;
+
   /**
    * The roster type of the dimension. PER_DIMENSION means that there is a group on
    * the dimension level and employees within that group have access to all job codes
@@ -157,6 +172,12 @@ export interface JobDimensionCreateParams {
    */
   includes_custom_location?: boolean;
 
+  /**
+   * Organizational attributes associated with the job dimension. Only 'PAY_RATE' can
+   * be set or modified using POST or PATCH requests.
+   */
+  org_attribute_associations?: Array<'DEPARTMENT' | 'WORK_LOCATION' | 'PAY_RATE' | 'ENTITY'>;
+
   /**
    * The roster type of the dimension. PER_DIMENSION means that there is a group on
    * the dimension level and employees within that group have access to all job codes
@@ -182,6 +203,12 @@ export interface JobDimensionUpdateParams {
    */
   includes_custom_location?: boolean;
 
+  /**
+   * Organizational attributes associated with the job dimension. Only 'PAY_RATE' can
+   * be set or modified using POST or PATCH requests.
+   */
+  org_attribute_associations?: Array<'DEPARTMENT' | 'WORK_LOCATION' | 'PAY_RATE' | 'ENTITY'>;
+
   /**
    * The roster type of the dimension. PER_DIMENSION means that there is a group on
    * the dimension level and employees within that group have access to all job codes

package/src/resources/job-functions.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Organizational job categories that group similar roles and responsibilities within a company
+ */
 export class JobFunctions extends APIResource {
   /**
    * A List of job functions

package/src/resources/job-pay-rate-exceptions.ts

@@ -10,6 +10,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job related information for the company
+ */
 export class JobPayRateExceptions extends APIResource {
   /**
    * A List of job pay rate exceptions

package/src/resources/job-requisitions-write.ts

@@ -0,0 +1,330 @@
+// 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';
+
+/**
+ * A request for a job to be filled by a candidate
+ */
+export class JobRequisitionsWrite extends APIResource {
+  /**
+   * Create a new job requisition
+   */
+  create(
+    body: JobRequisitionsWriteCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<JobRequisitionsWriteCreateResponse> {
+    return this._client.post('/job-requisitions-write', { body, ...options });
+  }
+}
+
+/**
+ * DTO for creating JobRequisitions via the Platform API.
+ *     Maps to the existing ATS JobRequisitionDTO for use with create_from_DTO service.
+ */
+export interface JobRequisitionsWriteCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Title/name of the job requisition
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Whether this requisition is confidential
+   */
+  confidential?: boolean;
+
+  /**
+   * List of role IDs allowed to view confidential requisition
+   */
+  confidential_whitelist?: Array<string>;
+
+  /**
+   * Coordinator role ID
+   */
+  coordinator_id?: string;
+
+  /**
+   * Whether to default to private invites
+   */
+  default_private_invites?: boolean;
+
+  /**
+   * List of department IDs
+   */
+  departments?: Array<string>;
+
+  /**
+   * Job description
+   */
+  description?: string;
+
+  /**
+   * Company employment type ID
+   */
+  employment_type_id?: string;
+
+  /**
+   * Hiring manager role ID
+   */
+  hiring_manager_id?: string;
+
+  /**
+   * Whether this is an evergreen requisition
+   */
+  is_evergreen?: boolean;
+
+  /**
+   * List of level IDs
+   */
+  levels?: Array<string>;
+
+  /**
+   * Pipeline plan ID to use for this requisition
+   */
+  pipeline_plan_id?: string;
+
+  /**
+   * Primary recruiter role ID
+   */
+  recruiter_id?: string;
+
+  /**
+   * Customer-defined requisition ID. Auto-generated if not provided.
+   */
+  requisition_id?: string;
+
+  /**
+   * Salary currency code
+   */
+  salary_currency?: string;
+
+  /**
+   * Salary amount per unit
+   */
+  salary_per_unit?: number;
+
+  /**
+   * Salary range upper bound
+   */
+  salary_per_unit_high?: number;
+
+  /**
+   * Salary range lower bound
+   */
+  salary_per_unit_low?: number;
+
+  /**
+   * Salary type
+   */
+  salary_type?: string;
+
+  /**
+   * Salary unit (HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD)
+   */
+  salary_unit?: string;
+
+  /**
+   * List of secondary recruiter role IDs
+   */
+  secondary_recruiters?: Array<string>;
+
+  /**
+   * Sourcer role ID
+   */
+  sourcer_id?: string;
+
+  /**
+   * Job requisition status (e.g., DRAFT, OPEN, CLOSED)
+   */
+  status?: string;
+
+  /**
+   * Target close date
+   */
+  target_close?: string;
+
+  /**
+   * Target employee start date
+   */
+  target_employee_start_date?: string;
+
+  /**
+   * List of team IDs
+   */
+  teams?: Array<string>;
+
+  /**
+   * Internal employee title
+   */
+  title?: string;
+
+  /**
+   * List of work location IDs
+   */
+  work_locations?: Array<string>;
+}
+
+export interface JobRequisitionsWriteCreateParams {
+  /**
+   * Title/name of the job requisition
+   */
+  name: string;
+
+  /**
+   * Whether this requisition is confidential
+   */
+  confidential?: boolean;
+
+  /**
+   * List of role IDs allowed to view confidential requisition
+   */
+  confidential_whitelist?: Array<string>;
+
+  /**
+   * Coordinator role ID
+   */
+  coordinator_id?: string;
+
+  /**
+   * Whether to default to private invites
+   */
+  default_private_invites?: boolean;
+
+  /**
+   * List of department IDs
+   */
+  departments?: Array<string>;
+
+  /**
+   * Job description
+   */
+  description?: string;
+
+  /**
+   * Company employment type ID
+   */
+  employment_type_id?: string;
+
+  /**
+   * Hiring manager role ID
+   */
+  hiring_manager_id?: string;
+
+  /**
+   * Whether this is an evergreen requisition
+   */
+  is_evergreen?: boolean;
+
+  /**
+   * List of level IDs
+   */
+  levels?: Array<string>;
+
+  /**
+   * Pipeline plan ID to use for this requisition
+   */
+  pipeline_plan_id?: string;
+
+  /**
+   * Primary recruiter role ID
+   */
+  recruiter_id?: string;
+
+  /**
+   * Customer-defined requisition ID. Auto-generated if not provided.
+   */
+  requisition_id?: string;
+
+  /**
+   * Salary currency code
+   */
+  salary_currency?: string;
+
+  /**
+   * Salary amount per unit
+   */
+  salary_per_unit?: number;
+
+  /**
+   * Salary range upper bound
+   */
+  salary_per_unit_high?: number;
+
+  /**
+   * Salary range lower bound
+   */
+  salary_per_unit_low?: number;
+
+  /**
+   * Salary type
+   */
+  salary_type?: string;
+
+  /**
+   * Salary unit (HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD)
+   */
+  salary_unit?: string;
+
+  /**
+   * List of secondary recruiter role IDs
+   */
+  secondary_recruiters?: Array<string>;
+
+  /**
+   * Sourcer role ID
+   */
+  sourcer_id?: string;
+
+  /**
+   * Job requisition status (e.g., DRAFT, OPEN, CLOSED)
+   */
+  status?: string;
+
+  /**
+   * Target close date
+   */
+  target_close?: string;
+
+  /**
+   * Target employee start date
+   */
+  target_employee_start_date?: string;
+
+  /**
+   * List of team IDs
+   */
+  teams?: Array<string>;
+
+  /**
+   * Internal employee title
+   */
+  title?: string;
+
+  /**
+   * List of work location IDs
+   */
+  work_locations?: Array<string>;
+}
+
+export declare namespace JobRequisitionsWrite {
+  export {
+    type JobRequisitionsWriteCreateResponse as JobRequisitionsWriteCreateResponse,
+    type JobRequisitionsWriteCreateParams as JobRequisitionsWriteCreateParams,
+  };
+}

package/src/resources/job-requisitions.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * A request for a job to be filled by a candidate
+ */
 export class JobRequisitions extends APIResource {
   /**
    * A List of job requisitions

package/src/resources/kiosk-badges.ts

@@ -9,6 +9,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Badge information used with Timeclock Kiosk
+ */
 export class KioskBadges extends APIResource {
   /**
    * A List of kiosk badges