@rippling/rippling-sdk 0.2.0-alpha.24 → 0.2.0-alpha.26

package/src/client.ts

@@ -50,6 +50,14 @@ import {
   Candidates,
 } from './resources/candidates';
 import { Companies, CompaniesPageCursorURL, Company, CompanyListParams } from './resources/companies';
+import {
+  CompensationBandsDetailListParams,
+  CompensationBandsDetailListResponse,
+  CompensationBandsDetailListResponsesPageCursorURL,
+  CompensationBandsDetailRetrieveParams,
+  CompensationBandsDetailRetrieveResponse,
+  CompensationBandsDetails,
+} from './resources/compensation-bands-details';
 import {
   Compensation,
   CompensationListParams,
@@ -64,11 +72,24 @@ import {
   CustomFieldListResponsesPageCursorURL,
   CustomFields,
 } from './resources/custom-fields';
+import {
+  CustomSettingCreateParams,
+  CustomSettingCreateResponse,
+  CustomSettingListParams,
+  CustomSettingListResponse,
+  CustomSettingListResponsesPageCursorURL,
+  CustomSettingRetrieveResponse,
+  CustomSettingUpdateParams,
+  CustomSettingUpdateResponse,
+  CustomSettings,
+} from './resources/custom-settings';
 import {
   Department,
+  DepartmentCreateParams,
   DepartmentListParams,
   DepartmentRetrieveParams,
   DepartmentRetrieveResponse,
+  DepartmentUpdateParams,
   Departments,
   DepartmentsPageCursorURL,
 } from './resources/departments';
@@ -104,10 +125,12 @@ import {
   AttributeChangeDetails,
   AttributeChangeDetailsPageCursorURL,
   JobAssignment,
+  JobAssignmentCreateParams,
   JobAssignmentListChangeLogParams,
   JobAssignmentListParams,
   JobAssignmentRetrieveParams,
   JobAssignmentRetrieveResponse,
+  JobAssignmentUpdateParams,
   JobAssignments,
   JobAssignmentsPageCursorURL,
 } from './resources/job-assignments';
@@ -155,6 +178,11 @@ import {
   JobRequisitions,
   JobRequisitionsPageCursorURL,
 } from './resources/job-requisitions';
+import {
+  JobRequisitionsWrite,
+  JobRequisitionsWriteCreateParams,
+  JobRequisitionsWriteCreateResponse,
+} from './resources/job-requisitions-write';
 import {
   KioskBadgeCreateParams,
   KioskBadgeCreateResponse,
@@ -171,6 +199,9 @@ import {
 import {
   LeaveAccrualCreateParams,
   LeaveAccrualCreateResponse,
+  LeaveAccrualListParams,
+  LeaveAccrualListResponse,
+  LeaveAccrualListResponsesPageCursorURL,
   LeaveAccrualRetrieveParams,
   LeaveAccrualRetrieveResponse,
   LeaveAccruals,
@@ -233,6 +264,12 @@ import {
   ObjectCategoryCreateParams,
   ObjectCategoryUpdateParams,
 } from './resources/object-categories';
+import {
+  ReportRunCreateParams,
+  ReportRunCreateResponse,
+  ReportRunRetrieveResponse,
+  ReportRuns,
+} from './resources/report-runs';
 import {
   ScheduleCreateParams,
   ScheduleCreateResponse,
@@ -245,6 +282,11 @@ import {
   ScheduleUpdateResponse,
   Schedules,
 } from './resources/schedules';
+import {
+  ShiftAssignmentUpdateCustomfieldsParams,
+  ShiftAssignmentUpdateCustomfieldsResponse,
+  ShiftAssignments,
+} from './resources/shift-assignments';
 import {
   ShiftInput,
   ShiftInputCreateParams,
@@ -301,6 +343,17 @@ import {
   TimeEntryUpdateParams,
   TimeEntryUpdateResponse,
 } from './resources/time-entries';
+import {
+  TitleCreateParams,
+  TitleCreateResponse,
+  TitleListParams,
+  TitleListResponse,
+  TitleListResponsesPageCursorURL,
+  TitleRetrieveResponse,
+  TitleUpdateParams,
+  TitleUpdateResponse,
+  Titles,
+} from './resources/titles';
 import {
   Track,
   TrackListParams,
@@ -309,18 +362,31 @@ import {
   TracksPageCursorURL,
 } from './resources/tracks';
 import {
+  UnassignedShiftAssignParams,
+  UnassignedShiftAssignResponse,
+  UnassignedShiftUpdateCustomfieldsParams,
+  UnassignedShiftUpdateCustomfieldsResponse,
+  UnassignedShifts,
+} from './resources/unassigned-shifts';
+import {
+  UnassignedshiftCreateParams,
+  UnassignedshiftCreateResponse,
   UnassignedshiftListParams,
   UnassignedshiftListResponse,
   UnassignedshiftListResponsesPageCursorURL,
   UnassignedshiftRetrieveParams,
   UnassignedshiftRetrieveResponse,
+  UnassignedshiftUpdateParams,
+  UnassignedshiftUpdateResponse,
   Unassignedshifts,
 } from './resources/unassignedshifts';
 import { User, UserListParams, UserRetrieveResponse, Users, UsersPageCursorURL } from './resources/users';
 import {
   WorkLocation,
+  WorkLocationCreateParams,
   WorkLocationListParams,
   WorkLocationRetrieveResponse,
+  WorkLocationUpdateParams,
   WorkLocations,
   WorkLocationsPageCursorURL,
 } from './resources/work-locations';
@@ -452,7 +518,7 @@ export class RipplingSDK {
   baseURL: string;
   maxRetries: number;
   timeout: number;
-  logger: Logger | undefined;
+  logger: Logger;
   logLevel: LogLevel | undefined;
   fetchOptions: MergedRequestInit | undefined;
 
@@ -1104,17 +1170,24 @@ export class RipplingSDK {
   jobPayRateExceptions: API.JobPayRateExceptions = new API.JobPayRateExceptions(this);
   candidates: API.Candidates = new API.Candidates(this);
   candidateApplications: API.CandidateApplications = new API.CandidateApplications(this);
+  compensationBandsDetails: API.CompensationBandsDetails = new API.CompensationBandsDetails(this);
   customFields: API.CustomFields = new API.CustomFields(this);
+  customSettings: API.CustomSettings = new API.CustomSettings(this);
   draftHires: API.DraftHires = new API.DraftHires(this);
   entitlements: API.Entitlements = new API.Entitlements(this);
   headcountPositions: API.HeadcountPositions = new API.HeadcountPositions(this);
   headcountPriorities: API.HeadcountPriorities = new API.HeadcountPriorities(this);
   jobFunctions: API.JobFunctions = new API.JobFunctions(this);
+  jobRequisitionsWrite: API.JobRequisitionsWrite = new API.JobRequisitionsWrite(this);
   leaveAccruals: API.LeaveAccruals = new API.LeaveAccruals(this);
   locationFactors: API.LocationFactors = new API.LocationFactors(this);
+  reportRuns: API.ReportRuns = new API.ReportRuns(this);
   schedules: API.Schedules = new API.Schedules(this);
   shiftassignments: API.Shiftassignments = new API.Shiftassignments(this);
+  titles: API.Titles = new API.Titles(this);
   unassignedshifts: API.Unassignedshifts = new API.Unassignedshifts(this);
+  shiftAssignments: API.ShiftAssignments = new API.ShiftAssignments(this);
+  unassignedShifts: API.UnassignedShifts = new API.UnassignedShifts(this);
 }
 
 RipplingSDK.Companies = Companies;
@@ -1149,17 +1222,24 @@ RipplingSDK.JobAssignments = JobAssignments;
 RipplingSDK.JobPayRateExceptions = JobPayRateExceptions;
 RipplingSDK.Candidates = Candidates;
 RipplingSDK.CandidateApplications = CandidateApplications;
+RipplingSDK.CompensationBandsDetails = CompensationBandsDetails;
 RipplingSDK.CustomFields = CustomFields;
+RipplingSDK.CustomSettings = CustomSettings;
 RipplingSDK.DraftHires = DraftHires;
 RipplingSDK.Entitlements = Entitlements;
 RipplingSDK.HeadcountPositions = HeadcountPositions;
 RipplingSDK.HeadcountPriorities = HeadcountPriorities;
 RipplingSDK.JobFunctions = JobFunctions;
+RipplingSDK.JobRequisitionsWrite = JobRequisitionsWrite;
 RipplingSDK.LeaveAccruals = LeaveAccruals;
 RipplingSDK.LocationFactors = LocationFactors;
+RipplingSDK.ReportRuns = ReportRuns;
 RipplingSDK.Schedules = Schedules;
 RipplingSDK.Shiftassignments = Shiftassignments;
+RipplingSDK.Titles = Titles;
 RipplingSDK.Unassignedshifts = Unassignedshifts;
+RipplingSDK.ShiftAssignments = ShiftAssignments;
+RipplingSDK.UnassignedShifts = UnassignedShifts;
 
 export declare namespace RipplingSDK {
   export type RequestOptions = Opts.RequestOptions;
@@ -1197,7 +1277,9 @@ export declare namespace RipplingSDK {
     type DepartmentRetrieveResponse as DepartmentRetrieveResponse,
     type DepartmentsPageCursorURL as DepartmentsPageCursorURL,
     type DepartmentListParams as DepartmentListParams,
+    type DepartmentCreateParams as DepartmentCreateParams,
     type DepartmentRetrieveParams as DepartmentRetrieveParams,
+    type DepartmentUpdateParams as DepartmentUpdateParams,
   };
 
   export {
@@ -1393,6 +1475,8 @@ export declare namespace RipplingSDK {
     type WorkLocationRetrieveResponse as WorkLocationRetrieveResponse,
     type WorkLocationsPageCursorURL as WorkLocationsPageCursorURL,
     type WorkLocationListParams as WorkLocationListParams,
+    type WorkLocationCreateParams as WorkLocationCreateParams,
+    type WorkLocationUpdateParams as WorkLocationUpdateParams,
   };
 
   export {
@@ -1443,7 +1527,9 @@ export declare namespace RipplingSDK {
     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,
   };
 
@@ -1471,6 +1557,15 @@ export declare namespace RipplingSDK {
     type CandidateApplicationListParams as CandidateApplicationListParams,
   };
 
+  export {
+    CompensationBandsDetails as CompensationBandsDetails,
+    type CompensationBandsDetailListResponse as CompensationBandsDetailListResponse,
+    type CompensationBandsDetailRetrieveResponse as CompensationBandsDetailRetrieveResponse,
+    type CompensationBandsDetailListResponsesPageCursorURL as CompensationBandsDetailListResponsesPageCursorURL,
+    type CompensationBandsDetailListParams as CompensationBandsDetailListParams,
+    type CompensationBandsDetailRetrieveParams as CompensationBandsDetailRetrieveParams,
+  };
+
   export {
     CustomFields as CustomFields,
     type CustomFieldListResponse as CustomFieldListResponse,
@@ -1478,6 +1573,18 @@ export declare namespace RipplingSDK {
     type CustomFieldListParams as CustomFieldListParams,
   };
 
+  export {
+    CustomSettings as CustomSettings,
+    type CustomSettingListResponse as CustomSettingListResponse,
+    type CustomSettingCreateResponse as CustomSettingCreateResponse,
+    type CustomSettingRetrieveResponse as CustomSettingRetrieveResponse,
+    type CustomSettingUpdateResponse as CustomSettingUpdateResponse,
+    type CustomSettingListResponsesPageCursorURL as CustomSettingListResponsesPageCursorURL,
+    type CustomSettingListParams as CustomSettingListParams,
+    type CustomSettingCreateParams as CustomSettingCreateParams,
+    type CustomSettingUpdateParams as CustomSettingUpdateParams,
+  };
+
   export {
     DraftHires as DraftHires,
     type DraftHireCreateResponse as DraftHireCreateResponse,
@@ -1515,12 +1622,21 @@ export declare namespace RipplingSDK {
     type JobFunctionListParams as JobFunctionListParams,
   };
 
+  export {
+    JobRequisitionsWrite as JobRequisitionsWrite,
+    type JobRequisitionsWriteCreateResponse as JobRequisitionsWriteCreateResponse,
+    type JobRequisitionsWriteCreateParams as JobRequisitionsWriteCreateParams,
+  };
+
   export {
     LeaveAccruals as LeaveAccruals,
-    type LeaveAccrualRetrieveResponse as LeaveAccrualRetrieveResponse,
+    type LeaveAccrualListResponse as LeaveAccrualListResponse,
     type LeaveAccrualCreateResponse as LeaveAccrualCreateResponse,
-    type LeaveAccrualRetrieveParams as LeaveAccrualRetrieveParams,
+    type LeaveAccrualRetrieveResponse as LeaveAccrualRetrieveResponse,
+    type LeaveAccrualListResponsesPageCursorURL as LeaveAccrualListResponsesPageCursorURL,
+    type LeaveAccrualListParams as LeaveAccrualListParams,
     type LeaveAccrualCreateParams as LeaveAccrualCreateParams,
+    type LeaveAccrualRetrieveParams as LeaveAccrualRetrieveParams,
   };
 
   export {
@@ -1531,6 +1647,13 @@ export declare namespace RipplingSDK {
     type LocationFactorListParams as LocationFactorListParams,
   };
 
+  export {
+    ReportRuns as ReportRuns,
+    type ReportRunCreateResponse as ReportRunCreateResponse,
+    type ReportRunRetrieveResponse as ReportRunRetrieveResponse,
+    type ReportRunCreateParams as ReportRunCreateParams,
+  };
+
   export {
     Schedules as Schedules,
     type ScheduleListResponse as ScheduleListResponse,
@@ -1557,16 +1680,47 @@ export declare namespace RipplingSDK {
     type ShiftassignmentUpdateParams as ShiftassignmentUpdateParams,
   };
 
+  export {
+    Titles as Titles,
+    type TitleListResponse as TitleListResponse,
+    type TitleCreateResponse as TitleCreateResponse,
+    type TitleRetrieveResponse as TitleRetrieveResponse,
+    type TitleUpdateResponse as TitleUpdateResponse,
+    type TitleListResponsesPageCursorURL as TitleListResponsesPageCursorURL,
+    type TitleListParams as TitleListParams,
+    type TitleCreateParams as TitleCreateParams,
+    type TitleUpdateParams as TitleUpdateParams,
+  };
+
   export {
     Unassignedshifts as Unassignedshifts,
     type UnassignedshiftListResponse as UnassignedshiftListResponse,
+    type UnassignedshiftCreateResponse as UnassignedshiftCreateResponse,
     type UnassignedshiftRetrieveResponse as UnassignedshiftRetrieveResponse,
+    type UnassignedshiftUpdateResponse as UnassignedshiftUpdateResponse,
     type UnassignedshiftListResponsesPageCursorURL as UnassignedshiftListResponsesPageCursorURL,
     type UnassignedshiftListParams as UnassignedshiftListParams,
+    type UnassignedshiftCreateParams as UnassignedshiftCreateParams,
     type UnassignedshiftRetrieveParams as UnassignedshiftRetrieveParams,
+    type UnassignedshiftUpdateParams as UnassignedshiftUpdateParams,
+  };
+
+  export {
+    ShiftAssignments as ShiftAssignments,
+    type ShiftAssignmentUpdateCustomfieldsResponse as ShiftAssignmentUpdateCustomfieldsResponse,
+    type ShiftAssignmentUpdateCustomfieldsParams as ShiftAssignmentUpdateCustomfieldsParams,
+  };
+
+  export {
+    UnassignedShifts as UnassignedShifts,
+    type UnassignedShiftUpdateCustomfieldsResponse as UnassignedShiftUpdateCustomfieldsResponse,
+    type UnassignedShiftAssignResponse as UnassignedShiftAssignResponse,
+    type UnassignedShiftUpdateCustomfieldsParams as UnassignedShiftUpdateCustomfieldsParams,
+    type UnassignedShiftAssignParams as UnassignedShiftAssignParams,
   };
 
   export type Address = API.Address;
   export type CountryCode = API.CountryCode;
+  export type GroupMember = API.GroupMember;
   export type RedactedFields = API.RedactedFields;
 }

package/src/functions.ts

@@ -24,6 +24,12 @@ export class FunctionResponse {
 
 export type FunctionEvent = Record<string, any>;
 export interface FunctionContext {
+  env: {
+    // Set to the Rippling user's bearer token when the function is triggered by a user.
+    // Prefer using this token when available; otherwise, fall back to the Settings Manager
+    // or a hard-coded token if necessary.
+    rippling_user_bearer_token: string | undefined;
+  };
   function: {
     company_id: string;
     function_id: string;
@@ -112,3 +118,17 @@ export interface DataBridgeRequest {
     connectionId: string;
   };
 }
+
+export class DataBridgeRateLimitError extends Error {
+  waitTimeInSeconds: number;
+  constructor(message: string, waitTimeInSeconds: number) {
+    const jsonMessage = JSON.stringify({
+      message,
+      waitTimeInSeconds,
+    });
+
+    super(jsonMessage);
+    this.name = 'RateLimitError';
+    this.waitTimeInSeconds = waitTimeInSeconds;
+  }
+}

package/src/resources/compensation-bands-details.ts

@@ -0,0 +1,140 @@
+// 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 WorkersAPI from './workers';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class CompensationBandsDetails extends APIResource {
+  /**
+   * A List of compensation bands details
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `created_at`, `updated_at`, `internal_job_code`,
+   *   `worker_id`
+   * - Expandable fields: `worker`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: CompensationBandsDetailListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CompensationBandsDetailListResponsesPageCursorURL, CompensationBandsDetailListResponse> {
+    return this._client.getAPIList(
+      '/compensation-bands-details',
+      PageCursorURL<CompensationBandsDetailListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Retrieve a specific compensation bands detail
+   */
+  retrieve(
+    id: string,
+    query: CompensationBandsDetailRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CompensationBandsDetailRetrieveResponse> {
+    return this._client.get(path`/compensation-bands-details/${id}`, { query, ...options });
+  }
+}
+
+export type CompensationBandsDetailListResponsesPageCursorURL =
+  PageCursorURL<CompensationBandsDetailListResponse>;
+
+export interface CompensationBandsDetailListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Internal job code
+   */
+  internal_job_code?: string;
+
+  /**
+   * The worker associated with compensation bands
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * ID of the worker associated with compensation bands
+   */
+  worker_id?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface CompensationBandsDetailRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Internal job code
+   */
+  internal_job_code?: string;
+
+  /**
+   * The worker associated with compensation bands
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * ID of the worker associated with compensation bands
+   */
+  worker_id?: string;
+}
+
+export interface CompensationBandsDetailListParams {
+  cursor?: string;
+
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface CompensationBandsDetailRetrieveParams {
+  expand?: string;
+}
+
+export declare namespace CompensationBandsDetails {
+  export {
+    type CompensationBandsDetailListResponse as CompensationBandsDetailListResponse,
+    type CompensationBandsDetailRetrieveResponse as CompensationBandsDetailRetrieveResponse,
+    type CompensationBandsDetailListResponsesPageCursorURL as CompensationBandsDetailListResponsesPageCursorURL,
+    type CompensationBandsDetailListParams as CompensationBandsDetailListParams,
+    type CompensationBandsDetailRetrieveParams as CompensationBandsDetailRetrieveParams,
+  };
+}