@rippling/rippling-sdk 0.2.0-alpha.102 → 0.2.0-alpha.104

package/src/resources/departments.ts

@@ -231,9 +231,7 @@ export class Departments extends APIResource {
    * Accept: application/json
    * Rippling-Api-Version: 2024-08-01
    *
-   * {
-   *   "name": "name"
-   * }
+   * {}
    *
    * HTTP/1.1 200 OK
    * Content-Type: application/json
@@ -327,7 +325,11 @@ export class Departments extends APIResource {
    * }
    * ```
    */
-  update(id: string, body: DepartmentUpdateParams, options?: RequestOptions): APIPromise<Department> {
+  update(
+    id: string,
+    body: DepartmentUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Department> {
     return this._client.patch(path`/departments/${id}/`, { body, ...options });
   }
 }
@@ -430,7 +432,7 @@ export interface DepartmentUpdateParams {
   /**
    * The name of the department.
    */
-  name: string;
+  name?: string;
 
   /**
    * The parent department.

package/src/resources/hires.ts

@@ -10,8 +10,9 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Hires extends APIResource {
   /**
-   * Create or resume hire records for admin review. Idempotency-Key and
-   * requirements_version are required. First milestone is US and CA direct hire.
+   * Create or resume hire records for admin review. Idempotency-Key is required. GET
+   * /hire-requirements/ is optional discovery. First milestone is US and CA direct
+   * hire.
    *
    * @example HTTP
    * Representative request and response shapes.
@@ -44,8 +45,7 @@ export class Hires extends APIResource {
    *         "country_code": "country_code"
    *       }
    *     }
-   *   ],
-   *   "requirements_version": "requirements_version"
+   *   ]
    * }
    *
    * HTTP/1.1 200 OK
@@ -181,11 +181,6 @@ export interface HireCreateParams {
    */
   hires: Array<HireCreateParams.Hire>;
 
-  /**
-   * Body param: Requirements version returned by GET /hire-requirements/. Required.
-   */
-  requirements_version: string;
-
   /**
    * Header param: Caller-generated key used to deduplicate retried create requests.
    */

package/src/resources/job-assignments.ts

@@ -373,10 +373,7 @@ export class JobAssignments extends APIResource {
    * Accept: application/json
    * Rippling-Api-Version: 2024-08-01
    *
-   * {
-   *   "job_code_id": "job_code_id",
-   *   "worker_id": "worker_id"
-   * }
+   * {}
    *
    * HTTP/1.1 200 OK
    * Content-Type: application/json
@@ -548,7 +545,11 @@ export class JobAssignments extends APIResource {
    * }
    * ```
    */
-  update(id: string, body: JobAssignmentUpdateParams, options?: RequestOptions): APIPromise<JobAssignment> {
+  update(
+    id: string,
+    body: JobAssignmentUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<JobAssignment> {
     return this._client.patch(path`/job-assignments/${id}/`, { body, ...options });
   }
 
@@ -886,16 +887,6 @@ export interface JobAssignmentRetrieveParams {
 }
 
 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;
-
   /**
    * Reason recorded on the change (e.g., the reason for scheduling an unassignment).
    */
@@ -908,6 +899,11 @@ export interface JobAssignmentUpdateParams {
    */
   effective_from?: string;
 
+  /**
+   * Identifier of job that is assigned to worker
+   */
+  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.
@@ -925,6 +921,11 @@ export interface JobAssignmentUpdateParams {
    * effective_from field instead.
    */
   job_pay_rate_effective_from?: string;
+
+  /**
+   * Identifier of worker to whom job is assigned.
+   */
+  worker_id?: string;
 }
 
 export interface JobAssignmentDeleteParams {

package/src/resources/job-codes.ts

@@ -315,10 +315,7 @@ export class JobCodes extends APIResource {
    * Accept: application/json
    * Rippling-Api-Version: 2024-08-01
    *
-   * {
-   *   "job_dimension_id": "job_dimension_id",
-   *   "name": "name"
-   * }
+   * {}
    *
    * HTTP/1.1 200 OK
    * Content-Type: application/json
@@ -459,7 +456,11 @@ export class JobCodes extends APIResource {
    * }
    * ```
    */
-  update(id: string, body: JobCodeUpdateParams, options?: RequestOptions): APIPromise<JobCode> {
+  update(
+    id: string,
+    body: JobCodeUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<JobCode> {
     return this._client.patch(path`/job-codes/${id}/`, { body, ...options });
   }
 
@@ -931,16 +932,6 @@ export interface JobCodeRetrieveParams {
 }
 
 export interface JobCodeUpdateParams {
-  /**
-   * The ID of the job dimension this job code belongs to.
-   */
-  job_dimension_id: string;
-
-  /**
-   * The name of the job dimension.
-   */
-  name: string;
-
   /**
    * The custom location of the job code. This location will be used for tax
    * calculation purposes if using US Payroll when an employee is working at this job
@@ -959,6 +950,16 @@ export interface JobCodeUpdateParams {
    */
   is_archived?: boolean;
 
+  /**
+   * The ID of the job dimension this job code belongs to.
+   */
+  job_dimension_id?: string;
+
+  /**
+   * The name of the job dimension.
+   */
+  name?: string;
+
   /**
    * The pay rate for this job code. Only applicable if the associated job dimension
    * includes the 'PAY_RATE' organizational attribute.

package/src/resources/job-dimensions.ts

@@ -142,9 +142,7 @@ export class JobDimensions extends APIResource {
    * Accept: application/json
    * Rippling-Api-Version: 2024-08-01
    *
-   * {
-   *   "name": "name"
-   * }
+   * {}
    *
    * HTTP/1.1 200 OK
    * Content-Type: application/json
@@ -164,7 +162,11 @@ export class JobDimensions extends APIResource {
    * }
    * ```
    */
-  update(id: string, body: JobDimensionUpdateParams, options?: RequestOptions): APIPromise<JobDimension> {
+  update(
+    id: string,
+    body: JobDimensionUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<JobDimension> {
     return this._client.patch(path`/job-dimensions/${id}/`, { body, ...options });
   }
 
@@ -323,11 +325,6 @@ export interface JobDimensionCreateParams {
 }
 
 export interface JobDimensionUpdateParams {
-  /**
-   * The name of the job dimension
-   */
-  name: string;
-
   /**
    * The unique identifier of the job dimension in a third party system
    */
@@ -339,6 +336,11 @@ export interface JobDimensionUpdateParams {
    */
   includes_custom_location?: boolean;
 
+  /**
+   * The name of the job dimension
+   */
+  name?: string;
+
   /**
    * Organizational attributes associated with the job dimension. Only 'PAY_RATE' can
    * be set or modified using POST or PATCH requests.

package/src/resources/kiosk-badges.ts

@@ -356,9 +356,7 @@ export class KioskBadges extends APIResource {
    * Accept: application/json
    * Rippling-Api-Version: 2024-08-01
    *
-   * {
-   *   "badge_id": "badge_id"
-   * }
+   * {}
    *
    * HTTP/1.1 200 OK
    * Content-Type: application/json
@@ -540,7 +538,7 @@ export class KioskBadges extends APIResource {
    */
   update(
     id: string,
-    body: KioskBadgeUpdateParams,
+    body: KioskBadgeUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<KioskBadgeUpdateResponse> {
     return this._client.patch(path`/kiosk-badges/${id}/`, { body, ...options });
@@ -815,7 +813,7 @@ export interface KioskBadgeUpdateParams {
   /**
    * The ID associated with the badge. Not to be confused with the record's ID.
    */
-  badge_id: string;
+  badge_id?: string;
 
   /**
    * Whether this badge can be used with the Kiosk app.

package/src/resources/leave-accruals.ts

@@ -474,7 +474,8 @@ export interface LeaveAccrualListResponse {
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
     | 'HOURS_WORKED_TANDA'
-    | 'TENURE_MILESTONE';
+    | 'TENURE_MILESTONE'
+    | 'FR_COP_FRACTIONNEMENT';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a
@@ -585,7 +586,8 @@ export interface LeaveAccrualCreateResponse {
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
     | 'HOURS_WORKED_TANDA'
-    | 'TENURE_MILESTONE';
+    | 'TENURE_MILESTONE'
+    | 'FR_COP_FRACTIONNEMENT';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a
@@ -693,7 +695,8 @@ export interface LeaveAccrualRetrieveResponse extends BusinessPartnersAPI.Meta {
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
     | 'HOURS_WORKED_TANDA'
-    | 'TENURE_MILESTONE';
+    | 'TENURE_MILESTONE'
+    | 'FR_COP_FRACTIONNEMENT';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a
@@ -798,7 +801,8 @@ export interface LeaveAccrualCreateParams {
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
     | 'HOURS_WORKED_TANDA'
-    | 'TENURE_MILESTONE';
+    | 'TENURE_MILESTONE'
+    | 'FR_COP_FRACTIONNEMENT';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a

package/src/resources/leave-requests.ts

@@ -436,12 +436,7 @@ export class LeaveRequests extends APIResource {
    * Accept: application/json
    * Rippling-Api-Version: 2024-08-01
    *
-   * {
-   *   "end_date": "end_date",
-   *   "start_date": "start_date",
-   *   "status": "PENDING",
-   *   "worker_id": "worker_id"
-   * }
+   * {}
    *
    * HTTP/1.1 200 OK
    * Content-Type: application/json
@@ -627,7 +622,7 @@ export class LeaveRequests extends APIResource {
    */
   update(
     id: string,
-    body: LeaveRequestUpdateParams,
+    body: LeaveRequestUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<LeaveRequestUpdateResponse> {
     return this._client.patch(path`/leave-requests/${id}/`, { body, ...options });
@@ -1412,29 +1407,14 @@ export interface LeaveRequestRetrieveParams {
 
 export interface LeaveRequestUpdateParams {
   /**
-   * The end date of the leave request.
-   */
-  end_date: string;
-
-  /**
-   * The start date of the leave request.
-   */
-  start_date: string;
-
-  /**
-   * The status of the leave request.
-   */
-  status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED';
-
-  /**
-   * The ID of the worker associated with the leave request.
+   * The comments associated with the leave request.
    */
-  worker_id: string;
+  comments?: string;
 
   /**
-   * The comments associated with the leave request.
+   * The end date of the leave request.
    */
-  comments?: string;
+  end_date?: string;
 
   /**
    * The number of hours to take off on the end date.
@@ -1483,6 +1463,11 @@ export interface LeaveRequestUpdateParams {
    */
   reviewer_id?: string;
 
+  /**
+   * The start date of the leave request.
+   */
+  start_date?: string;
+
   /**
    * The number of hours to take off on the start date.
    */
@@ -1492,6 +1477,16 @@ export interface LeaveRequestUpdateParams {
    * The start time of the leave request.
    */
   start_time?: string;
+
+  /**
+   * The status of the leave request.
+   */
+  status?: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED';
+
+  /**
+   * The ID of the worker associated with the leave request.
+   */
+  worker_id?: string;
 }
 
 export declare namespace LeaveRequests {

package/src/resources/packages/packages.ts

@@ -70,7 +70,7 @@ export class Packages extends APIResource {
    *       "package_key": "string",
    *       "package_display_name": "string",
    *       "description": "string",
-   *       "package_type": "string",
+   *       "package_type": "MANAGED",
    *       "latest_version_id": "string",
    *       "latest_version_number": "string"
    *     }
@@ -101,7 +101,7 @@ export class Packages extends APIResource {
    * {
    *   "package_display_name": "package_display_name",
    *   "package_key": "package_key",
-   *   "package_type": "package_type"
+   *   "package_type": "MANAGED"
    * }
    *
    * HTTP/1.1 200 OK
@@ -114,7 +114,7 @@ export class Packages extends APIResource {
    *   "package_key": "string",
    *   "package_display_name": "string",
    *   "description": "string",
-   *   "package_type": "string",
+   *   "package_type": "MANAGED",
    *   "latest_version_id": "string",
    *   "latest_version_number": "string"
    * }
@@ -166,7 +166,7 @@ export class Packages extends APIResource {
    * {
    *   "package_display_name": "package_display_name",
    *   "package_key": "package_key",
-   *   "package_type": "package_type"
+   *   "package_type": "MANAGED"
    * }
    *
    * HTTP/1.1 200 OK
@@ -179,7 +179,7 @@ export class Packages extends APIResource {
    *   "package_key": "string",
    *   "package_display_name": "string",
    *   "description": "string",
-   *   "package_type": "string",
+   *   "package_type": "MANAGED",
    *   "latest_version_id": "string",
    *   "latest_version_number": "string"
    * }
@@ -238,9 +238,9 @@ export interface PackageListResponse {
   package_key: string;
 
   /**
-   * The package type (for example MANAGED or UNMANAGED)
+   * The package type
    */
-  package_type: string;
+  package_type: 'MANAGED' | 'UNMANAGED';
 
   /**
    * Record update date
@@ -285,9 +285,9 @@ export interface PackageCreateResponse {
   package_key: string;
 
   /**
-   * The package type (for example MANAGED or UNMANAGED)
+   * The package type
    */
-  package_type: string;
+  package_type: 'MANAGED' | 'UNMANAGED';
 
   /**
    * Record update date
@@ -335,9 +335,9 @@ export interface PackageRetrieveResponse extends BusinessPartnersAPI.Meta {
   package_key: string;
 
   /**
-   * The package type (for example MANAGED or UNMANAGED)
+   * The package type
    */
-  package_type: string;
+  package_type: 'MANAGED' | 'UNMANAGED';
 
   /**
    * Record update date
@@ -382,9 +382,9 @@ export interface PackageUpdateResponse {
   package_key: string;
 
   /**
-   * The package type (for example MANAGED or UNMANAGED)
+   * The package type
    */
-  package_type: string;
+  package_type: 'MANAGED' | 'UNMANAGED';
 
   /**
    * Record update date
@@ -432,9 +432,9 @@ export interface PackageCreateParams {
   package_key: string;
 
   /**
-   * The package type (for example MANAGED or UNMANAGED)
+   * The package type
    */
-  package_type: string;
+  package_type: 'MANAGED' | 'UNMANAGED';
 
   /**
    * The description of the package
@@ -454,9 +454,9 @@ export interface PackageUpdateParams {
   package_key: string;
 
   /**
-   * The package type (for example MANAGED or UNMANAGED)
+   * The package type
    */
-  package_type: string;
+  package_type: 'MANAGED' | 'UNMANAGED';
 
   /**
    * The description of the package

package/src/resources/sandboxes.ts

@@ -181,7 +181,9 @@ export class Sandboxes extends APIResource {
   }
 
   /**
-   * Delete a sandbox
+   * 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.
    *
    * @example HTTP
    * Representative request and response shapes.
@@ -331,7 +333,7 @@ export namespace SandboxListResponse {
       /**
        * Seed company size for the developer sandbox.
        */
-      company_size: 'SMALL' | 'MID' | 'XL';
+      company_size: 'SMALL' | 'MID';
     }
 
     /**
@@ -584,7 +586,7 @@ export namespace SandboxCreateResponse {
       /**
        * Seed company size for the developer sandbox.
        */
-      company_size: 'SMALL' | 'MID' | 'XL';
+      company_size: 'SMALL' | 'MID';
     }
 
     /**
@@ -840,7 +842,7 @@ export namespace SandboxRetrieveResponse {
       /**
        * Seed company size for the developer sandbox.
        */
-      company_size: 'SMALL' | 'MID' | 'XL';
+      company_size: 'SMALL' | 'MID';
     }
 
     /**
@@ -1096,7 +1098,7 @@ export namespace SandboxCreateParams {
       /**
        * Seed company size for the developer sandbox.
        */
-      company_size: 'SMALL' | 'MID' | 'XL';
+      company_size: 'SMALL' | 'MID';
     }
 
     /**

package/src/resources/shift-assignments.ts

@@ -20,7 +20,9 @@ export class ShiftAssignments extends APIResource {
    * @example SDK usage
    * ```ts
    * const response =
-   *   await client.shiftAssignments.updateCustomfields('id');
+   *   await client.shiftAssignments.updateCustomfields('id', {
+   *     body: { FieldName1: 'bar', FieldName2: 'bar' },
+   *   });
    * ```
    *
    * @example HTTP
@@ -33,7 +35,8 @@ export class ShiftAssignments extends APIResource {
    * Rippling-Api-Version: 2024-08-01
    *
    * {
-   *   "FieldName1": "value1"
+   *   "FieldName1": "value1",
+   *   "FieldName2": "value2"
    * }
    *
    * HTTP/1.1 200 OK
@@ -50,10 +53,11 @@ export class ShiftAssignments extends APIResource {
    */
   updateCustomfields(
     id: string,
-    body: ShiftAssignmentUpdateCustomfieldsParams,
+    params: ShiftAssignmentUpdateCustomfieldsParams,
     options?: RequestOptions,
   ): APIPromise<ShiftAssignmentUpdateCustomfieldsResponse> {
-    return this._client.patch(path`/shiftassignments/${id}/customfields/`, { body, ...options });
+    const { body } = params;
+    return this._client.patch(path`/shiftassignments/${id}/customfields/`, { body: body, ...options });
   }
 }
 
@@ -375,11 +379,10 @@ export namespace ShiftAssignmentUpdateCustomfieldsResponse {
 
 export interface ShiftAssignmentUpdateCustomfieldsParams {
   /**
-   * Example custom field name. Replace with your actual custom field names.
+   * Dictionary mapping custom field names to their values. Field names are dynamic
+   * and depend on your company's custom field configuration.
    */
-  FieldName1?: string;
-
-  [k: string]: unknown;
+  body: { [key: string]: unknown };
 }
 
 export declare namespace ShiftAssignments {

package/src/resources/shift-inputs.ts

@@ -362,12 +362,7 @@ export class ShiftInputs extends APIResource {
    * Accept: application/json
    * Rippling-Api-Version: 2024-08-01
    *
-   * {
-   *   "country_code": "country_code",
-   *   "name": "name",
-   *   "prompt": "prompt",
-   *   "type": "type"
-   * }
+   * {}
    *
    * HTTP/1.1 200 OK
    * Content-Type: application/json
@@ -550,7 +545,7 @@ export class ShiftInputs extends APIResource {
    */
   update(
     id: string,
-    body: ShiftInputUpdateParams,
+    body: ShiftInputUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ShiftInputUpdateResponse> {
     return this._client.patch(path`/shift-inputs/${id}/`, { body, ...options });
@@ -875,27 +870,27 @@ export interface ShiftInputUpdateParams {
   /**
    * Two letter string designating country code which the shift input is associated.
    */
-  country_code: string;
+  country_code?: string;
 
   /**
-   * Name of the shift unit.
+   * The creator id associated with the shift input.
    */
-  name: string;
+  creator_id?: string;
 
   /**
-   * Prompt for the shift unit.
+   * Name of the shift unit.
    */
-  prompt: string;
+  name?: string;
 
   /**
-   * Type of shift unit.
+   * Prompt for the shift unit.
    */
-  type: string;
+  prompt?: string;
 
   /**
-   * The creator id associated with the shift input.
+   * Type of shift unit.
    */
-  creator_id?: string;
+  type?: string;
 }
 
 export declare namespace ShiftInputs {