@rippling/rippling-sdk 0.2.0-alpha.20

package/src/client.ts

@@ -0,0 +1,1518 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import type { RequestInit, RequestInfo, BodyInit } from './internal/builtin-types';
+import type { HTTPMethod, PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from './internal/types';
+import { uuid4 } from './internal/utils/uuid';
+import { validatePositiveInteger, isAbsoluteURL, safeJSON } from './internal/utils/values';
+import { sleep } from './internal/utils/sleep';
+export type { Logger, LogLevel } from './internal/utils/log';
+import { castToError, isAbortError } from './internal/errors';
+import type { APIResponseProps } from './internal/parse';
+import { getPlatformHeaders } from './internal/detect-platform';
+import * as Shims from './internal/shims';
+import * as Opts from './internal/request-options';
+import { VERSION } from './version';
+import * as Errors from './core/error';
+import * as Pagination from './core/pagination';
+import { AbstractPage, PageCursorURLResponse } from './core/pagination';
+import * as Uploads from './core/uploads';
+import * as API from './resources/index';
+import { APIPromise } from './core/api-promise';
+import {
+  BusinessPartnerGroup,
+  BusinessPartnerGroupCreateParams,
+  BusinessPartnerGroupListParams,
+  BusinessPartnerGroupRetrieveParams,
+  BusinessPartnerGroupRetrieveResponse,
+  BusinessPartnerGroups,
+  BusinessPartnerGroupsPageCursorURL,
+} from './resources/business-partner-groups';
+import {
+  BusinessPartner,
+  BusinessPartnerCreateParams,
+  BusinessPartnerListParams,
+  BusinessPartnerRetrieveParams,
+  BusinessPartnerRetrieveResponse,
+  BusinessPartners,
+  BusinessPartnersPageCursorURL,
+  Meta,
+} from './resources/business-partners';
+import {
+  CandidateApplicationListParams,
+  CandidateApplicationListResponse,
+  CandidateApplicationListResponsesPageCursorURL,
+  CandidateApplications,
+} from './resources/candidate-applications';
+import {
+  CandidateListParams,
+  CandidateListResponse,
+  CandidateListResponsesPageCursorURL,
+  Candidates,
+} from './resources/candidates';
+import { Companies, CompaniesPageCursorURL, Company, CompanyListParams } from './resources/companies';
+import {
+  Compensation,
+  CompensationListParams,
+  CompensationRetrieveParams,
+  CompensationRetrieveResponse,
+  Compensations,
+  CompensationsPageCursorURL,
+} from './resources/compensations';
+import {
+  CustomFieldListParams,
+  CustomFieldListResponse,
+  CustomFieldListResponsesPageCursorURL,
+  CustomFields,
+} from './resources/custom-fields';
+import {
+  Department,
+  DepartmentListParams,
+  DepartmentRetrieveParams,
+  DepartmentRetrieveResponse,
+  Departments,
+  DepartmentsPageCursorURL,
+} from './resources/departments';
+import {
+  CompanyEmploymentType,
+  CompanyEmploymentTypesPageCursorURL,
+  EmploymentTypeListParams,
+  EmploymentTypeRetrieveResponse,
+  EmploymentTypes,
+} from './resources/employment-types';
+import {
+  EntitlementListResponse,
+  EntitlementListResponsesPageCursorURL,
+  Entitlements,
+} from './resources/entitlements';
+import {
+  HeadcountPositionListParams,
+  HeadcountPositionListResponse,
+  HeadcountPositionListResponsesPageCursorURL,
+  HeadcountPositionRetrieveParams,
+  HeadcountPositionRetrieveResponse,
+  HeadcountPositions,
+} from './resources/headcount-positions';
+import {
+  HeadcountPriorities,
+  HeadcountPriorityListParams,
+  HeadcountPriorityListResponse,
+  HeadcountPriorityListResponsesPageCursorURL,
+  HeadcountPriorityRetrieveResponse,
+} from './resources/headcount-priorities';
+import {
+  AttributeChangeDetails,
+  AttributeChangeDetailsPageCursorURL,
+  JobAssignment,
+  JobAssignmentListChangeLogParams,
+  JobAssignmentListParams,
+  JobAssignmentRetrieveParams,
+  JobAssignmentRetrieveResponse,
+  JobAssignments,
+  JobAssignmentsPageCursorURL,
+} from './resources/job-assignments';
+import {
+  JobCode,
+  JobCodeCreateParams,
+  JobCodeListChangeLogParams,
+  JobCodeListParams,
+  JobCodeRequest,
+  JobCodeRetrieveParams,
+  JobCodeRetrieveResponse,
+  JobCodeUpdateParams,
+  JobCodes,
+  JobCodesPageCursorURL,
+} from './resources/job-codes';
+import {
+  JobDimension,
+  JobDimensionCreateParams,
+  JobDimensionListParams,
+  JobDimensionRequest,
+  JobDimensionRetrieveResponse,
+  JobDimensionUpdateParams,
+  JobDimensions,
+  JobDimensionsPageCursorURL,
+} from './resources/job-dimensions';
+import {
+  JobFunctionListParams,
+  JobFunctionListResponse,
+  JobFunctionListResponsesPageCursorURL,
+  JobFunctionRetrieveResponse,
+  JobFunctions,
+} from './resources/job-functions';
+import {
+  JobPayRateException,
+  JobPayRateExceptionListChangeLogParams,
+  JobPayRateExceptionListParams,
+  JobPayRateExceptionRetrieveParams,
+  JobPayRateExceptionRetrieveResponse,
+  JobPayRateExceptions,
+  JobPayRateExceptionsPageCursorURL,
+} from './resources/job-pay-rate-exceptions';
+import {
+  JobRequisition,
+  JobRequisitionListParams,
+  JobRequisitions,
+  JobRequisitionsPageCursorURL,
+} from './resources/job-requisitions';
+import {
+  KioskBadgeCreateParams,
+  KioskBadgeCreateResponse,
+  KioskBadgeListParams,
+  KioskBadgeListResponse,
+  KioskBadgeListResponsesPageCursorURL,
+  KioskBadgeRetrieveParams,
+  KioskBadgeRetrieveResponse,
+  KioskBadgeUpdateParams,
+  KioskBadgeUpdateResponse,
+  KioskBadges,
+  TimeKioskBadge,
+} from './resources/kiosk-badges';
+import {
+  LeaveBalance,
+  LeaveBalanceListParams,
+  LeaveBalanceRetrieveParams,
+  LeaveBalanceRetrieveResponse,
+  LeaveBalances,
+  LeaveBalancesPageCursorURL,
+} from './resources/leave-balances';
+import {
+  LeaveRequest,
+  LeaveRequestCreateParams,
+  LeaveRequestCreateResponse,
+  LeaveRequestListParams,
+  LeaveRequestListResponse,
+  LeaveRequestListResponsesPageCursorURL,
+  LeaveRequestRetrieveParams,
+  LeaveRequestRetrieveResponse,
+  LeaveRequestUpdateParams,
+  LeaveRequestUpdateResponse,
+  LeaveRequests,
+} from './resources/leave-requests';
+import {
+  LeaveType,
+  LeaveTypeListParams,
+  LeaveTypeRetrieveResponse,
+  LeaveTypes,
+  LeaveTypesPageCursorURL,
+} from './resources/leave-types';
+import {
+  LegalEntities,
+  LegalEntitiesPageCursorURL,
+  LegalEntity,
+  LegalEntityListParams,
+  LegalEntityRetrieveParams,
+  LegalEntityRetrieveResponse,
+} from './resources/legal-entities';
+import {
+  Level,
+  LevelListParams,
+  LevelRetrieveParams,
+  LevelRetrieveResponse,
+  Levels,
+  LevelsPageCursorURL,
+} from './resources/levels';
+import {
+  LocationFactorListParams,
+  LocationFactorListResponse,
+  LocationFactorListResponsesPageCursorURL,
+  LocationFactorRetrieveResponse,
+  LocationFactors,
+} from './resources/location-factors';
+import {
+  ObjectCategories,
+  ObjectCategoriesPageCursorURL,
+  ObjectCategory,
+  ObjectCategoryCreateParams,
+  ObjectCategoryUpdateParams,
+} from './resources/object-categories';
+import {
+  ScheduleListParams,
+  ScheduleListResponse,
+  ScheduleListResponsesPageCursorURL,
+  ScheduleRetrieveParams,
+  ScheduleRetrieveResponse,
+  Schedules,
+} from './resources/schedules';
+import {
+  ShiftInput,
+  ShiftInputCreateParams,
+  ShiftInputCreateResponse,
+  ShiftInputListParams,
+  ShiftInputListResponse,
+  ShiftInputListResponsesPageCursorURL,
+  ShiftInputRetrieveParams,
+  ShiftInputRetrieveResponse,
+  ShiftInputUpdateParams,
+  ShiftInputUpdateResponse,
+  ShiftInputs,
+} from './resources/shift-inputs';
+import {
+  ShiftassignmentListParams,
+  ShiftassignmentListResponse,
+  ShiftassignmentListResponsesPageCursorURL,
+  ShiftassignmentRetrieveParams,
+  ShiftassignmentRetrieveResponse,
+  Shiftassignments,
+} from './resources/shiftassignments';
+import { SSOMe, SSOMeResource, SSOMeRetrieveParams } from './resources/sso-me';
+import {
+  Team,
+  TeamListParams,
+  TeamRetrieveParams,
+  TeamRetrieveResponse,
+  Teams,
+  TeamsPageCursorURL,
+} from './resources/teams';
+import {
+  PayPeriod,
+  TimeCard,
+  TimeCardListParams,
+  TimeCardRetrieveParams,
+  TimeCardRetrieveResponse,
+  TimeCards,
+  TimeCardsPageCursorURL,
+} from './resources/time-cards';
+import {
+  TimeEntries,
+  TimeEntry,
+  TimeEntryCreateParams,
+  TimeEntryCreateResponse,
+  TimeEntryListParams,
+  TimeEntryListResponse,
+  TimeEntryListResponsesPageCursorURL,
+  TimeEntryRetrieveParams,
+  TimeEntryRetrieveResponse,
+  TimeEntryUpdateParams,
+  TimeEntryUpdateResponse,
+} from './resources/time-entries';
+import {
+  Track,
+  TrackListParams,
+  TrackRetrieveResponse,
+  Tracks,
+  TracksPageCursorURL,
+} from './resources/tracks';
+import { User, UserListParams, UserRetrieveResponse, Users, UsersPageCursorURL } from './resources/users';
+import {
+  WorkLocation,
+  WorkLocationListParams,
+  WorkLocationRetrieveResponse,
+  WorkLocations,
+  WorkLocationsPageCursorURL,
+} from './resources/work-locations';
+import {
+  Worker,
+  WorkerListParams,
+  WorkerRetrieveParams,
+  WorkerRetrieveResponse,
+  Workers,
+  WorkersPageCursorURL,
+} from './resources/workers';
+import {
+  CustomObject,
+  CustomObjectCreateParams,
+  CustomObjectUpdateParams,
+  CustomObjects,
+  CustomObjectsPageCursorURL,
+} from './resources/custom-objects/custom-objects';
+import {
+  Function,
+  FunctionCreateDevBundleResponse,
+  FunctionCreateParams,
+  FunctionListParams,
+  FunctionUpdateParams,
+  Functions,
+  FunctionsPageCursorURL,
+} from './resources/functions/functions';
+import {
+  Supergroup,
+  SupergroupListParams,
+  SupergroupRetrieveResponse,
+  Supergroups,
+  SupergroupsPageCursorURL,
+} from './resources/supergroups/supergroups';
+import { type Fetch } from './internal/builtin-types';
+import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
+import { FinalRequestOptions, RequestOptions } from './internal/request-options';
+import { readEnv } from './internal/utils/env';
+import {
+  type LogLevel,
+  type Logger,
+  formatRequestDetails,
+  loggerFor,
+  parseLogLevel,
+} from './internal/utils/log';
+import { isEmptyObj } from './internal/utils/values';
+
+export interface ClientOptions {
+  /**
+   * Bearer token for authorization
+   */
+  bearerToken?: string | undefined;
+
+  /**
+   * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+   *
+   * Defaults to process.env['RIPPLING_SDK_BASE_URL'].
+   */
+  baseURL?: string | null | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
+   * much longer than this timeout before the promise succeeds or fails.
+   *
+   * @unit milliseconds
+   */
+  timeout?: number | undefined;
+  /**
+   * Additional `RequestInit` options to be passed to `fetch` calls.
+   * Properties will be overridden by per-request `fetchOptions`.
+   */
+  fetchOptions?: MergedRequestInit | undefined;
+
+  /**
+   * Specify a custom `fetch` function implementation.
+   *
+   * If not provided, we expect that `fetch` is defined globally.
+   */
+  fetch?: Fetch | undefined;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
+  maxRetries?: number | undefined;
+
+  /**
+   * Default headers to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * header to `null` in request options.
+   */
+  defaultHeaders?: HeadersLike | undefined;
+
+  /**
+   * Default query parameters to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * param to `undefined` in request options.
+   */
+  defaultQuery?: Record<string, string | undefined> | undefined;
+
+  /**
+   * Set the log level.
+   *
+   * Defaults to process.env['RIPPLING_SDK_LOG'] or 'warn' if it isn't set.
+   */
+  logLevel?: LogLevel | undefined;
+
+  /**
+   * Set the logger.
+   *
+   * Defaults to globalThis.console.
+   */
+  logger?: Logger | undefined;
+}
+
+/**
+ * API Client for interfacing with the Rippling SDK API.
+ */
+export class RipplingSDK {
+  bearerToken: string;
+
+  baseURL: string;
+  maxRetries: number;
+  timeout: number;
+  logger: Logger | undefined;
+  logLevel: LogLevel | undefined;
+  fetchOptions: MergedRequestInit | undefined;
+
+  private fetch: Fetch;
+  #encoder: Opts.RequestEncoder;
+  protected idempotencyHeader?: string;
+  private _options: ClientOptions;
+
+  /**
+   * API Client for interfacing with the Rippling SDK API.
+   *
+   * @param {string | undefined} [opts.bearerToken=process.env['BEARER_TOKEN_PRODUCTION'] ?? undefined]
+   * @param {string} [opts.baseURL=process.env['RIPPLING_SDK_BASE_URL'] ?? https://rest.ripplingapis.com] - Override the default base URL for the API.
+   * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+   * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
+   * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+   * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
+   * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
+   */
+  constructor({
+    baseURL = readEnv('RIPPLING_SDK_BASE_URL'),
+    bearerToken = readEnv('BEARER_TOKEN_PRODUCTION'),
+    ...opts
+  }: ClientOptions = {}) {
+    if (bearerToken === undefined) {
+      throw new Errors.RipplingSDKError(
+        "The BEARER_TOKEN_PRODUCTION environment variable is missing or empty; either provide it, or instantiate the RipplingSDK client with an bearerToken option, like new RipplingSDK({ bearerToken: 'My Bearer Token' }).",
+      );
+    }
+
+    const options: ClientOptions = {
+      bearerToken,
+      ...opts,
+      baseURL: baseURL || `https://rest.ripplingapis.com`,
+    };
+
+    this.baseURL = options.baseURL!;
+    this.timeout = options.timeout ?? RipplingSDK.DEFAULT_TIMEOUT /* 1 minute */;
+    this.logger = options.logger ?? console;
+    const defaultLogLevel = 'warn';
+    // Set default logLevel early so that we can log a warning in parseLogLevel.
+    this.logLevel = defaultLogLevel;
+    this.logLevel =
+      parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ??
+      parseLogLevel(readEnv('RIPPLING_SDK_LOG'), "process.env['RIPPLING_SDK_LOG']", this) ??
+      defaultLogLevel;
+    this.fetchOptions = options.fetchOptions;
+    this.maxRetries = options.maxRetries ?? 2;
+    this.fetch = options.fetch ?? Shims.getDefaultFetch();
+    this.#encoder = Opts.FallbackEncoder;
+
+    this._options = options;
+
+    this.bearerToken = bearerToken;
+  }
+
+  /**
+   * Create a new client instance re-using the same options given to the current client with optional overriding.
+   */
+  withOptions(options: Partial<ClientOptions>): this {
+    const client = new (this.constructor as any as new (props: ClientOptions) => typeof this)({
+      ...this._options,
+      baseURL: this.baseURL,
+      maxRetries: this.maxRetries,
+      timeout: this.timeout,
+      logger: this.logger,
+      logLevel: this.logLevel,
+      fetch: this.fetch,
+      fetchOptions: this.fetchOptions,
+      bearerToken: this.bearerToken,
+      ...options,
+    });
+    return client;
+  }
+
+  /**
+   * Check whether the base URL is set to its default.
+   */
+  #baseURLOverridden(): boolean {
+    return this.baseURL !== 'https://rest.ripplingapis.com';
+  }
+
+  protected defaultQuery(): Record<string, string | undefined> | undefined {
+    return this._options.defaultQuery;
+  }
+
+  protected validateHeaders({ values, nulls }: NullableHeaders) {
+    return;
+  }
+
+  protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
+    return buildHeaders([await this.bearerTokenProductionAuth(opts), await this.oAuth2ProductionAuth(opts)]);
+  }
+
+  protected async bearerTokenProductionAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
+    return buildHeaders([{ Authorization: `Bearer ${this.bearerToken}` }]);
+  }
+
+  protected async oAuth2ProductionAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
+    return undefined;
+  }
+
+  /**
+   * Basic re-implementation of `qs.stringify` for primitive types.
+   */
+  protected stringifyQuery(query: Record<string, unknown>): string {
+    return Object.entries(query)
+      .filter(([_, value]) => typeof value !== 'undefined')
+      .map(([key, value]) => {
+        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+        }
+        if (value === null) {
+          return `${encodeURIComponent(key)}=`;
+        }
+        throw new Errors.RipplingSDKError(
+          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
+        );
+      })
+      .join('&');
+  }
+
+  private getUserAgent(): string {
+    return `${this.constructor.name}/JS ${VERSION}`;
+  }
+
+  protected defaultIdempotencyKey(): string {
+    return `stainless-node-retry-${uuid4()}`;
+  }
+
+  protected makeStatusError(
+    status: number,
+    error: Object,
+    message: string | undefined,
+    headers: Headers,
+  ): Errors.APIError {
+    return Errors.APIError.generate(status, error, message, headers);
+  }
+
+  buildURL(
+    path: string,
+    query: Record<string, unknown> | null | undefined,
+    defaultBaseURL?: string | undefined,
+  ): string {
+    const baseURL = (!this.#baseURLOverridden() && defaultBaseURL) || this.baseURL;
+    const url =
+      isAbsoluteURL(path) ?
+        new URL(path)
+      : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
+
+    const defaultQuery = this.defaultQuery();
+    if (!isEmptyObj(defaultQuery)) {
+      query = { ...defaultQuery, ...query };
+    }
+
+    if (typeof query === 'object' && query && !Array.isArray(query)) {
+      url.search = this.stringifyQuery(query as Record<string, unknown>);
+    }
+
+    return url.toString();
+  }
+
+  /**
+   * Used as a callback for mutating the given `FinalRequestOptions` object.
+   */
+  protected async prepareOptions(options: FinalRequestOptions): Promise<void> {}
+
+  /**
+   * Used as a callback for mutating the given `RequestInit` object.
+   *
+   * This is useful for cases where you want to add certain headers based off of
+   * the request properties, e.g. `method` or `url`.
+   */
+  protected async prepareRequest(
+    request: RequestInit,
+    { url, options }: { url: string; options: FinalRequestOptions },
+  ): Promise<void> {}
+
+  get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp> {
+    return this.methodRequest('get', path, opts);
+  }
+
+  post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp> {
+    return this.methodRequest('post', path, opts);
+  }
+
+  patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp> {
+    return this.methodRequest('patch', path, opts);
+  }
+
+  put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp> {
+    return this.methodRequest('put', path, opts);
+  }
+
+  delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp> {
+    return this.methodRequest('delete', path, opts);
+  }
+
+  private methodRequest<Rsp>(
+    method: HTTPMethod,
+    path: string,
+    opts?: PromiseOrValue<RequestOptions>,
+  ): APIPromise<Rsp> {
+    return this.request(
+      Promise.resolve(opts).then((opts) => {
+        return { method, path, ...opts };
+      }),
+    );
+  }
+
+  request<Rsp>(
+    options: PromiseOrValue<FinalRequestOptions>,
+    remainingRetries: number | null = null,
+  ): APIPromise<Rsp> {
+    return new APIPromise(this, this.makeRequest(options, remainingRetries, undefined));
+  }
+
+  private async makeRequest(
+    optionsInput: PromiseOrValue<FinalRequestOptions>,
+    retriesRemaining: number | null,
+    retryOfRequestLogID: string | undefined,
+  ): Promise<APIResponseProps> {
+    const options = await optionsInput;
+    const maxRetries = options.maxRetries ?? this.maxRetries;
+    if (retriesRemaining == null) {
+      retriesRemaining = maxRetries;
+    }
+
+    await this.prepareOptions(options);
+
+    const { req, url, timeout } = await this.buildRequest(options, {
+      retryCount: maxRetries - retriesRemaining,
+    });
+
+    await this.prepareRequest(req, { url, options });
+
+    /** Not an API request ID, just for correlating local log entries. */
+    const requestLogID = 'log_' + ((Math.random() * (1 << 24)) | 0).toString(16).padStart(6, '0');
+    const retryLogStr = retryOfRequestLogID === undefined ? '' : `, retryOf: ${retryOfRequestLogID}`;
+    const startTime = Date.now();
+
+    loggerFor(this).debug(
+      `[${requestLogID}] sending request`,
+      formatRequestDetails({
+        retryOfRequestLogID,
+        method: options.method,
+        url,
+        options,
+        headers: req.headers,
+      }),
+    );
+
+    if (options.signal?.aborted) {
+      throw new Errors.APIUserAbortError();
+    }
+
+    const controller = new AbortController();
+    const response = await this.fetchWithTimeout(url, req, timeout, controller).catch(castToError);
+    const headersTime = Date.now();
+
+    if (response instanceof globalThis.Error) {
+      const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
+      if (options.signal?.aborted) {
+        throw new Errors.APIUserAbortError();
+      }
+      // detect native connection timeout errors
+      // deno throws "TypeError: error sending request for url (https://example/): client error (Connect): tcp connect error: Operation timed out (os error 60): Operation timed out (os error 60)"
+      // undici throws "TypeError: fetch failed" with cause "ConnectTimeoutError: Connect Timeout Error (attempted address: example:443, timeout: 1ms)"
+      // others do not provide enough information to distinguish timeouts from other connection errors
+      const isTimeout =
+        isAbortError(response) ||
+        /timed? ?out/i.test(String(response) + ('cause' in response ? String(response.cause) : ''));
+      if (retriesRemaining) {
+        loggerFor(this).info(
+          `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - ${retryMessage}`,
+        );
+        loggerFor(this).debug(
+          `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (${retryMessage})`,
+          formatRequestDetails({
+            retryOfRequestLogID,
+            url,
+            durationMs: headersTime - startTime,
+            message: response.message,
+          }),
+        );
+        return this.retryRequest(options, retriesRemaining, retryOfRequestLogID ?? requestLogID);
+      }
+      loggerFor(this).info(
+        `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - error; no more retries left`,
+      );
+      loggerFor(this).debug(
+        `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (error; no more retries left)`,
+        formatRequestDetails({
+          retryOfRequestLogID,
+          url,
+          durationMs: headersTime - startTime,
+          message: response.message,
+        }),
+      );
+      if (isTimeout) {
+        throw new Errors.APIConnectionTimeoutError();
+      }
+      throw new Errors.APIConnectionError({ cause: response });
+    }
+
+    const responseInfo = `[${requestLogID}${retryLogStr}] ${req.method} ${url} ${
+      response.ok ? 'succeeded' : 'failed'
+    } with status ${response.status} in ${headersTime - startTime}ms`;
+
+    if (!response.ok) {
+      const shouldRetry = await this.shouldRetry(response);
+      if (retriesRemaining && shouldRetry) {
+        const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
+
+        // We don't need the body of this response.
+        await Shims.CancelReadableStream(response.body);
+        loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
+        loggerFor(this).debug(
+          `[${requestLogID}] response error (${retryMessage})`,
+          formatRequestDetails({
+            retryOfRequestLogID,
+            url: response.url,
+            status: response.status,
+            headers: response.headers,
+            durationMs: headersTime - startTime,
+          }),
+        );
+        return this.retryRequest(
+          options,
+          retriesRemaining,
+          retryOfRequestLogID ?? requestLogID,
+          response.headers,
+        );
+      }
+
+      const retryMessage = shouldRetry ? `error; no more retries left` : `error; not retryable`;
+
+      loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
+
+      const errText = await response.text().catch((err: any) => castToError(err).message);
+      const errJSON = safeJSON(errText);
+      const errMessage = errJSON ? undefined : errText;
+
+      loggerFor(this).debug(
+        `[${requestLogID}] response error (${retryMessage})`,
+        formatRequestDetails({
+          retryOfRequestLogID,
+          url: response.url,
+          status: response.status,
+          headers: response.headers,
+          message: errMessage,
+          durationMs: Date.now() - startTime,
+        }),
+      );
+
+      const err = this.makeStatusError(response.status, errJSON, errMessage, response.headers);
+      throw err;
+    }
+
+    loggerFor(this).info(responseInfo);
+    loggerFor(this).debug(
+      `[${requestLogID}] response start`,
+      formatRequestDetails({
+        retryOfRequestLogID,
+        url: response.url,
+        status: response.status,
+        headers: response.headers,
+        durationMs: headersTime - startTime,
+      }),
+    );
+
+    return { response, options, controller, requestLogID, retryOfRequestLogID, startTime };
+  }
+
+  getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
+    path: string,
+    Page: new (...args: any[]) => PageClass,
+    opts?: RequestOptions,
+  ): Pagination.PagePromise<PageClass, Item> {
+    return this.requestAPIList(Page, { method: 'get', path, ...opts });
+  }
+
+  requestAPIList<
+    Item = unknown,
+    PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
+  >(
+    Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
+    options: FinalRequestOptions,
+  ): Pagination.PagePromise<PageClass, Item> {
+    const request = this.makeRequest(options, null, undefined);
+    return new Pagination.PagePromise<PageClass, Item>(this as any as RipplingSDK, request, Page);
+  }
+
+  async fetchWithTimeout(
+    url: RequestInfo,
+    init: RequestInit | undefined,
+    ms: number,
+    controller: AbortController,
+  ): Promise<Response> {
+    const { signal, method, ...options } = init || {};
+    if (signal) signal.addEventListener('abort', () => controller.abort());
+
+    const timeout = setTimeout(() => controller.abort(), ms);
+
+    const isReadableBody =
+      ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
+      (typeof options.body === 'object' && options.body !== null && Symbol.asyncIterator in options.body);
+
+    const fetchOptions: RequestInit = {
+      signal: controller.signal as any,
+      ...(isReadableBody ? { duplex: 'half' } : {}),
+      method: 'GET',
+      ...options,
+    };
+    if (method) {
+      // Custom methods like 'patch' need to be uppercased
+      // See https://github.com/nodejs/undici/issues/2294
+      fetchOptions.method = method.toUpperCase();
+    }
+
+    try {
+      // use undefined this binding; fetch errors if bound to something else in browser/cloudflare
+      return await this.fetch.call(undefined, url, fetchOptions);
+    } finally {
+      clearTimeout(timeout);
+    }
+  }
+
+  private async shouldRetry(response: Response): Promise<boolean> {
+    // Note this is not a standard header.
+    const shouldRetryHeader = response.headers.get('x-should-retry');
+
+    // If the server explicitly says whether or not to retry, obey.
+    if (shouldRetryHeader === 'true') return true;
+    if (shouldRetryHeader === 'false') return false;
+
+    // Retry on request timeouts.
+    if (response.status === 408) return true;
+
+    // Retry on lock timeouts.
+    if (response.status === 409) return true;
+
+    // Retry on rate limits.
+    if (response.status === 429) return true;
+
+    // Retry internal errors.
+    if (response.status >= 500) return true;
+
+    return false;
+  }
+
+  private async retryRequest(
+    options: FinalRequestOptions,
+    retriesRemaining: number,
+    requestLogID: string,
+    responseHeaders?: Headers | undefined,
+  ): Promise<APIResponseProps> {
+    let timeoutMillis: number | undefined;
+
+    // Note the `retry-after-ms` header may not be standard, but is a good idea and we'd like proactive support for it.
+    const retryAfterMillisHeader = responseHeaders?.get('retry-after-ms');
+    if (retryAfterMillisHeader) {
+      const timeoutMs = parseFloat(retryAfterMillisHeader);
+      if (!Number.isNaN(timeoutMs)) {
+        timeoutMillis = timeoutMs;
+      }
+    }
+
+    // About the Retry-After header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
+    const retryAfterHeader = responseHeaders?.get('retry-after');
+    if (retryAfterHeader && !timeoutMillis) {
+      const timeoutSeconds = parseFloat(retryAfterHeader);
+      if (!Number.isNaN(timeoutSeconds)) {
+        timeoutMillis = timeoutSeconds * 1000;
+      } else {
+        timeoutMillis = Date.parse(retryAfterHeader) - Date.now();
+      }
+    }
+
+    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
+    // just do what it says, but otherwise calculate a default
+    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+      const maxRetries = options.maxRetries ?? this.maxRetries;
+      timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
+    }
+    await sleep(timeoutMillis);
+
+    return this.makeRequest(options, retriesRemaining - 1, requestLogID);
+  }
+
+  private calculateDefaultRetryTimeoutMillis(retriesRemaining: number, maxRetries: number): number {
+    const initialRetryDelay = 0.5;
+    const maxRetryDelay = 8.0;
+
+    const numRetries = maxRetries - retriesRemaining;
+
+    // Apply exponential backoff, but not more than the max.
+    const sleepSeconds = Math.min(initialRetryDelay * Math.pow(2, numRetries), maxRetryDelay);
+
+    // Apply some jitter, take up to at most 25 percent of the retry time.
+    const jitter = 1 - Math.random() * 0.25;
+
+    return sleepSeconds * jitter * 1000;
+  }
+
+  async buildRequest(
+    inputOptions: FinalRequestOptions,
+    { retryCount = 0 }: { retryCount?: number } = {},
+  ): Promise<{ req: FinalizedRequestInit; url: string; timeout: number }> {
+    const options = { ...inputOptions };
+    const { method, path, query, defaultBaseURL } = options;
+
+    const url = this.buildURL(path!, query as Record<string, unknown>, defaultBaseURL);
+    if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
+    options.timeout = options.timeout ?? this.timeout;
+    const { bodyHeaders, body } = this.buildBody({ options });
+    const reqHeaders = await this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
+
+    const req: FinalizedRequestInit = {
+      method,
+      headers: reqHeaders,
+      ...(options.signal && { signal: options.signal }),
+      ...((globalThis as any).ReadableStream &&
+        body instanceof (globalThis as any).ReadableStream && { duplex: 'half' }),
+      ...(body && { body }),
+      ...((this.fetchOptions as any) ?? {}),
+      ...((options.fetchOptions as any) ?? {}),
+    };
+
+    return { req, url, timeout: options.timeout };
+  }
+
+  private async buildHeaders({
+    options,
+    method,
+    bodyHeaders,
+    retryCount,
+  }: {
+    options: FinalRequestOptions;
+    method: HTTPMethod;
+    bodyHeaders: HeadersLike;
+    retryCount: number;
+  }): Promise<Headers> {
+    let idempotencyHeaders: HeadersLike = {};
+    if (this.idempotencyHeader && method !== 'get') {
+      if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
+      idempotencyHeaders[this.idempotencyHeader] = options.idempotencyKey;
+    }
+
+    const headers = buildHeaders([
+      idempotencyHeaders,
+      {
+        Accept: 'application/json',
+        'User-Agent': this.getUserAgent(),
+        'X-Stainless-Retry-Count': String(retryCount),
+        ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}),
+        ...getPlatformHeaders(),
+      },
+      await this.authHeaders(options),
+      this._options.defaultHeaders,
+      bodyHeaders,
+      options.headers,
+    ]);
+
+    this.validateHeaders(headers);
+
+    return headers.values;
+  }
+
+  private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
+    bodyHeaders: HeadersLike;
+    body: BodyInit | undefined;
+  } {
+    if (!body) {
+      return { bodyHeaders: undefined, body: undefined };
+    }
+    const headers = buildHeaders([rawHeaders]);
+    if (
+      // Pass raw type verbatim
+      ArrayBuffer.isView(body) ||
+      body instanceof ArrayBuffer ||
+      body instanceof DataView ||
+      (typeof body === 'string' &&
+        // Preserve legacy string encoding behavior for now
+        headers.values.has('content-type')) ||
+      // `Blob` is superset of `File`
+      ((globalThis as any).Blob && body instanceof (globalThis as any).Blob) ||
+      // `FormData` -> `multipart/form-data`
+      body instanceof FormData ||
+      // `URLSearchParams` -> `application/x-www-form-urlencoded`
+      body instanceof URLSearchParams ||
+      // Send chunked stream (each chunk has own `length`)
+      ((globalThis as any).ReadableStream && body instanceof (globalThis as any).ReadableStream)
+    ) {
+      return { bodyHeaders: undefined, body: body as BodyInit };
+    } else if (
+      typeof body === 'object' &&
+      (Symbol.asyncIterator in body ||
+        (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
+    ) {
+      return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else {
+      return this.#encoder({ body, headers });
+    }
+  }
+
+  static RipplingSDK = this;
+  static DEFAULT_TIMEOUT = 60000; // 1 minute
+
+  static RipplingSDKError = Errors.RipplingSDKError;
+  static APIError = Errors.APIError;
+  static APIConnectionError = Errors.APIConnectionError;
+  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+  static APIUserAbortError = Errors.APIUserAbortError;
+  static NotFoundError = Errors.NotFoundError;
+  static ConflictError = Errors.ConflictError;
+  static RateLimitError = Errors.RateLimitError;
+  static BadRequestError = Errors.BadRequestError;
+  static AuthenticationError = Errors.AuthenticationError;
+  static InternalServerError = Errors.InternalServerError;
+  static PermissionDeniedError = Errors.PermissionDeniedError;
+  static UnprocessableEntityError = Errors.UnprocessableEntityError;
+
+  static toFile = Uploads.toFile;
+
+  candidates: API.Candidates = new API.Candidates(this);
+  candidateApplications: API.CandidateApplications = new API.CandidateApplications(this);
+  companies: API.Companies = new API.Companies(this);
+  compensations: API.Compensations = new API.Compensations(this);
+  customFields: API.CustomFields = new API.CustomFields(this);
+  customObjects: API.CustomObjects = new API.CustomObjects(this);
+  departments: API.Departments = new API.Departments(this);
+  employmentTypes: API.EmploymentTypes = new API.EmploymentTypes(this);
+  entitlements: API.Entitlements = new API.Entitlements(this);
+  jobCodes: API.JobCodes = new API.JobCodes(this);
+  jobDimensions: API.JobDimensions = new API.JobDimensions(this);
+  jobRequisitions: API.JobRequisitions = new API.JobRequisitions(this);
+  kioskBadges: API.KioskBadges = new API.KioskBadges(this);
+  leaveBalances: API.LeaveBalances = new API.LeaveBalances(this);
+  leaveRequests: API.LeaveRequests = new API.LeaveRequests(this);
+  leaveTypes: API.LeaveTypes = new API.LeaveTypes(this);
+  legalEntities: API.LegalEntities = new API.LegalEntities(this);
+  levels: API.Levels = new API.Levels(this);
+  objectCategories: API.ObjectCategories = new API.ObjectCategories(this);
+  shiftInputs: API.ShiftInputs = new API.ShiftInputs(this);
+  ssoMe: API.SSOMeResource = new API.SSOMeResource(this);
+  supergroups: API.Supergroups = new API.Supergroups(this);
+  teams: API.Teams = new API.Teams(this);
+  timeCards: API.TimeCards = new API.TimeCards(this);
+  timeEntries: API.TimeEntries = new API.TimeEntries(this);
+  tracks: API.Tracks = new API.Tracks(this);
+  users: API.Users = new API.Users(this);
+  workLocations: API.WorkLocations = new API.WorkLocations(this);
+  workers: API.Workers = new API.Workers(this);
+  businessPartners: API.BusinessPartners = new API.BusinessPartners(this);
+  businessPartnerGroups: API.BusinessPartnerGroups = new API.BusinessPartnerGroups(this);
+  functions: API.Functions = new API.Functions(this);
+  jobAssignments: API.JobAssignments = new API.JobAssignments(this);
+  jobPayRateExceptions: API.JobPayRateExceptions = new API.JobPayRateExceptions(this);
+  schedules: API.Schedules = new API.Schedules(this);
+  headcountPositions: API.HeadcountPositions = new API.HeadcountPositions(this);
+  shiftassignments: API.Shiftassignments = new API.Shiftassignments(this);
+  headcountPriorities: API.HeadcountPriorities = new API.HeadcountPriorities(this);
+  jobFunctions: API.JobFunctions = new API.JobFunctions(this);
+  locationFactors: API.LocationFactors = new API.LocationFactors(this);
+}
+
+RipplingSDK.Candidates = Candidates;
+RipplingSDK.CandidateApplications = CandidateApplications;
+RipplingSDK.Companies = Companies;
+RipplingSDK.Compensations = Compensations;
+RipplingSDK.CustomFields = CustomFields;
+RipplingSDK.CustomObjects = CustomObjects;
+RipplingSDK.Departments = Departments;
+RipplingSDK.EmploymentTypes = EmploymentTypes;
+RipplingSDK.Entitlements = Entitlements;
+RipplingSDK.JobCodes = JobCodes;
+RipplingSDK.JobDimensions = JobDimensions;
+RipplingSDK.JobRequisitions = JobRequisitions;
+RipplingSDK.KioskBadges = KioskBadges;
+RipplingSDK.LeaveBalances = LeaveBalances;
+RipplingSDK.LeaveRequests = LeaveRequests;
+RipplingSDK.LeaveTypes = LeaveTypes;
+RipplingSDK.LegalEntities = LegalEntities;
+RipplingSDK.Levels = Levels;
+RipplingSDK.ObjectCategories = ObjectCategories;
+RipplingSDK.ShiftInputs = ShiftInputs;
+RipplingSDK.SSOMeResource = SSOMeResource;
+RipplingSDK.Supergroups = Supergroups;
+RipplingSDK.Teams = Teams;
+RipplingSDK.TimeCards = TimeCards;
+RipplingSDK.TimeEntries = TimeEntries;
+RipplingSDK.Tracks = Tracks;
+RipplingSDK.Users = Users;
+RipplingSDK.WorkLocations = WorkLocations;
+RipplingSDK.Workers = Workers;
+RipplingSDK.BusinessPartners = BusinessPartners;
+RipplingSDK.BusinessPartnerGroups = BusinessPartnerGroups;
+RipplingSDK.Functions = Functions;
+RipplingSDK.JobAssignments = JobAssignments;
+RipplingSDK.JobPayRateExceptions = JobPayRateExceptions;
+RipplingSDK.Schedules = Schedules;
+RipplingSDK.HeadcountPositions = HeadcountPositions;
+RipplingSDK.Shiftassignments = Shiftassignments;
+RipplingSDK.HeadcountPriorities = HeadcountPriorities;
+RipplingSDK.JobFunctions = JobFunctions;
+RipplingSDK.LocationFactors = LocationFactors;
+
+export declare namespace RipplingSDK {
+  export type RequestOptions = Opts.RequestOptions;
+
+  export import PageCursorURL = Pagination.PageCursorURL;
+  export { type PageCursorURLResponse as PageCursorURLResponse };
+
+  export {
+    Candidates as Candidates,
+    type CandidateListResponse as CandidateListResponse,
+    type CandidateListResponsesPageCursorURL as CandidateListResponsesPageCursorURL,
+    type CandidateListParams as CandidateListParams,
+  };
+
+  export {
+    CandidateApplications as CandidateApplications,
+    type CandidateApplicationListResponse as CandidateApplicationListResponse,
+    type CandidateApplicationListResponsesPageCursorURL as CandidateApplicationListResponsesPageCursorURL,
+    type CandidateApplicationListParams as CandidateApplicationListParams,
+  };
+
+  export {
+    Companies as Companies,
+    type Company as Company,
+    type CompaniesPageCursorURL as CompaniesPageCursorURL,
+    type CompanyListParams as CompanyListParams,
+  };
+
+  export {
+    Compensations as Compensations,
+    type Compensation as Compensation,
+    type CompensationRetrieveResponse as CompensationRetrieveResponse,
+    type CompensationsPageCursorURL as CompensationsPageCursorURL,
+    type CompensationRetrieveParams as CompensationRetrieveParams,
+    type CompensationListParams as CompensationListParams,
+  };
+
+  export {
+    CustomFields as CustomFields,
+    type CustomFieldListResponse as CustomFieldListResponse,
+    type CustomFieldListResponsesPageCursorURL as CustomFieldListResponsesPageCursorURL,
+    type CustomFieldListParams as CustomFieldListParams,
+  };
+
+  export {
+    CustomObjects as CustomObjects,
+    type CustomObject as CustomObject,
+    type CustomObjectsPageCursorURL as CustomObjectsPageCursorURL,
+    type CustomObjectCreateParams as CustomObjectCreateParams,
+    type CustomObjectUpdateParams as CustomObjectUpdateParams,
+  };
+
+  export {
+    Departments as Departments,
+    type Department as Department,
+    type DepartmentRetrieveResponse as DepartmentRetrieveResponse,
+    type DepartmentsPageCursorURL as DepartmentsPageCursorURL,
+    type DepartmentRetrieveParams as DepartmentRetrieveParams,
+    type DepartmentListParams as DepartmentListParams,
+  };
+
+  export {
+    EmploymentTypes as EmploymentTypes,
+    type CompanyEmploymentType as CompanyEmploymentType,
+    type EmploymentTypeRetrieveResponse as EmploymentTypeRetrieveResponse,
+    type CompanyEmploymentTypesPageCursorURL as CompanyEmploymentTypesPageCursorURL,
+    type EmploymentTypeListParams as EmploymentTypeListParams,
+  };
+
+  export {
+    Entitlements as Entitlements,
+    type EntitlementListResponse as EntitlementListResponse,
+    type EntitlementListResponsesPageCursorURL as EntitlementListResponsesPageCursorURL,
+  };
+
+  export {
+    JobCodes as JobCodes,
+    type JobCode as JobCode,
+    type JobCodeRequest as JobCodeRequest,
+    type JobCodeRetrieveResponse as JobCodeRetrieveResponse,
+    type JobCodesPageCursorURL as JobCodesPageCursorURL,
+    type JobCodeCreateParams as JobCodeCreateParams,
+    type JobCodeRetrieveParams as JobCodeRetrieveParams,
+    type JobCodeUpdateParams as JobCodeUpdateParams,
+    type JobCodeListParams as JobCodeListParams,
+    type JobCodeListChangeLogParams as JobCodeListChangeLogParams,
+  };
+
+  export {
+    JobDimensions as JobDimensions,
+    type JobDimension as JobDimension,
+    type JobDimensionRequest as JobDimensionRequest,
+    type JobDimensionRetrieveResponse as JobDimensionRetrieveResponse,
+    type JobDimensionsPageCursorURL as JobDimensionsPageCursorURL,
+    type JobDimensionCreateParams as JobDimensionCreateParams,
+    type JobDimensionUpdateParams as JobDimensionUpdateParams,
+    type JobDimensionListParams as JobDimensionListParams,
+  };
+
+  export {
+    JobRequisitions as JobRequisitions,
+    type JobRequisition as JobRequisition,
+    type JobRequisitionsPageCursorURL as JobRequisitionsPageCursorURL,
+    type JobRequisitionListParams as JobRequisitionListParams,
+  };
+
+  export {
+    KioskBadges as KioskBadges,
+    type TimeKioskBadge as TimeKioskBadge,
+    type KioskBadgeCreateResponse as KioskBadgeCreateResponse,
+    type KioskBadgeRetrieveResponse as KioskBadgeRetrieveResponse,
+    type KioskBadgeUpdateResponse as KioskBadgeUpdateResponse,
+    type KioskBadgeListResponse as KioskBadgeListResponse,
+    type KioskBadgeListResponsesPageCursorURL as KioskBadgeListResponsesPageCursorURL,
+    type KioskBadgeCreateParams as KioskBadgeCreateParams,
+    type KioskBadgeRetrieveParams as KioskBadgeRetrieveParams,
+    type KioskBadgeUpdateParams as KioskBadgeUpdateParams,
+    type KioskBadgeListParams as KioskBadgeListParams,
+  };
+
+  export {
+    LeaveBalances as LeaveBalances,
+    type LeaveBalance as LeaveBalance,
+    type LeaveBalanceRetrieveResponse as LeaveBalanceRetrieveResponse,
+    type LeaveBalancesPageCursorURL as LeaveBalancesPageCursorURL,
+    type LeaveBalanceRetrieveParams as LeaveBalanceRetrieveParams,
+    type LeaveBalanceListParams as LeaveBalanceListParams,
+  };
+
+  export {
+    LeaveRequests as LeaveRequests,
+    type LeaveRequest as LeaveRequest,
+    type LeaveRequestCreateResponse as LeaveRequestCreateResponse,
+    type LeaveRequestRetrieveResponse as LeaveRequestRetrieveResponse,
+    type LeaveRequestUpdateResponse as LeaveRequestUpdateResponse,
+    type LeaveRequestListResponse as LeaveRequestListResponse,
+    type LeaveRequestListResponsesPageCursorURL as LeaveRequestListResponsesPageCursorURL,
+    type LeaveRequestCreateParams as LeaveRequestCreateParams,
+    type LeaveRequestRetrieveParams as LeaveRequestRetrieveParams,
+    type LeaveRequestUpdateParams as LeaveRequestUpdateParams,
+    type LeaveRequestListParams as LeaveRequestListParams,
+  };
+
+  export {
+    LeaveTypes as LeaveTypes,
+    type LeaveType as LeaveType,
+    type LeaveTypeRetrieveResponse as LeaveTypeRetrieveResponse,
+    type LeaveTypesPageCursorURL as LeaveTypesPageCursorURL,
+    type LeaveTypeListParams as LeaveTypeListParams,
+  };
+
+  export {
+    LegalEntities as LegalEntities,
+    type LegalEntity as LegalEntity,
+    type LegalEntityRetrieveResponse as LegalEntityRetrieveResponse,
+    type LegalEntitiesPageCursorURL as LegalEntitiesPageCursorURL,
+    type LegalEntityRetrieveParams as LegalEntityRetrieveParams,
+    type LegalEntityListParams as LegalEntityListParams,
+  };
+
+  export {
+    Levels as Levels,
+    type Level as Level,
+    type LevelRetrieveResponse as LevelRetrieveResponse,
+    type LevelsPageCursorURL as LevelsPageCursorURL,
+    type LevelRetrieveParams as LevelRetrieveParams,
+    type LevelListParams as LevelListParams,
+  };
+
+  export {
+    ObjectCategories as ObjectCategories,
+    type ObjectCategory as ObjectCategory,
+    type ObjectCategoriesPageCursorURL as ObjectCategoriesPageCursorURL,
+    type ObjectCategoryCreateParams as ObjectCategoryCreateParams,
+    type ObjectCategoryUpdateParams as ObjectCategoryUpdateParams,
+  };
+
+  export {
+    ShiftInputs as ShiftInputs,
+    type ShiftInput as ShiftInput,
+    type ShiftInputCreateResponse as ShiftInputCreateResponse,
+    type ShiftInputRetrieveResponse as ShiftInputRetrieveResponse,
+    type ShiftInputUpdateResponse as ShiftInputUpdateResponse,
+    type ShiftInputListResponse as ShiftInputListResponse,
+    type ShiftInputListResponsesPageCursorURL as ShiftInputListResponsesPageCursorURL,
+    type ShiftInputCreateParams as ShiftInputCreateParams,
+    type ShiftInputRetrieveParams as ShiftInputRetrieveParams,
+    type ShiftInputUpdateParams as ShiftInputUpdateParams,
+    type ShiftInputListParams as ShiftInputListParams,
+  };
+
+  export {
+    SSOMeResource as SSOMeResource,
+    type SSOMe as SSOMe,
+    type SSOMeRetrieveParams as SSOMeRetrieveParams,
+  };
+
+  export {
+    Supergroups as Supergroups,
+    type Supergroup as Supergroup,
+    type SupergroupRetrieveResponse as SupergroupRetrieveResponse,
+    type SupergroupsPageCursorURL as SupergroupsPageCursorURL,
+    type SupergroupListParams as SupergroupListParams,
+  };
+
+  export {
+    Teams as Teams,
+    type Team as Team,
+    type TeamRetrieveResponse as TeamRetrieveResponse,
+    type TeamsPageCursorURL as TeamsPageCursorURL,
+    type TeamRetrieveParams as TeamRetrieveParams,
+    type TeamListParams as TeamListParams,
+  };
+
+  export {
+    TimeCards as TimeCards,
+    type PayPeriod as PayPeriod,
+    type TimeCard as TimeCard,
+    type TimeCardRetrieveResponse as TimeCardRetrieveResponse,
+    type TimeCardsPageCursorURL as TimeCardsPageCursorURL,
+    type TimeCardRetrieveParams as TimeCardRetrieveParams,
+    type TimeCardListParams as TimeCardListParams,
+  };
+
+  export {
+    TimeEntries as TimeEntries,
+    type TimeEntry as TimeEntry,
+    type TimeEntryCreateResponse as TimeEntryCreateResponse,
+    type TimeEntryRetrieveResponse as TimeEntryRetrieveResponse,
+    type TimeEntryUpdateResponse as TimeEntryUpdateResponse,
+    type TimeEntryListResponse as TimeEntryListResponse,
+    type TimeEntryListResponsesPageCursorURL as TimeEntryListResponsesPageCursorURL,
+    type TimeEntryCreateParams as TimeEntryCreateParams,
+    type TimeEntryRetrieveParams as TimeEntryRetrieveParams,
+    type TimeEntryUpdateParams as TimeEntryUpdateParams,
+    type TimeEntryListParams as TimeEntryListParams,
+  };
+
+  export {
+    Tracks as Tracks,
+    type Track as Track,
+    type TrackRetrieveResponse as TrackRetrieveResponse,
+    type TracksPageCursorURL as TracksPageCursorURL,
+    type TrackListParams as TrackListParams,
+  };
+
+  export {
+    Users as Users,
+    type User as User,
+    type UserRetrieveResponse as UserRetrieveResponse,
+    type UsersPageCursorURL as UsersPageCursorURL,
+    type UserListParams as UserListParams,
+  };
+
+  export {
+    WorkLocations as WorkLocations,
+    type WorkLocation as WorkLocation,
+    type WorkLocationRetrieveResponse as WorkLocationRetrieveResponse,
+    type WorkLocationsPageCursorURL as WorkLocationsPageCursorURL,
+    type WorkLocationListParams as WorkLocationListParams,
+  };
+
+  export {
+    Workers as Workers,
+    type Worker as Worker,
+    type WorkerRetrieveResponse as WorkerRetrieveResponse,
+    type WorkersPageCursorURL as WorkersPageCursorURL,
+    type WorkerRetrieveParams as WorkerRetrieveParams,
+    type WorkerListParams as WorkerListParams,
+  };
+
+  export {
+    BusinessPartners as BusinessPartners,
+    type BusinessPartner as BusinessPartner,
+    type Meta as Meta,
+    type BusinessPartnerRetrieveResponse as BusinessPartnerRetrieveResponse,
+    type BusinessPartnersPageCursorURL as BusinessPartnersPageCursorURL,
+    type BusinessPartnerCreateParams as BusinessPartnerCreateParams,
+    type BusinessPartnerRetrieveParams as BusinessPartnerRetrieveParams,
+    type BusinessPartnerListParams as BusinessPartnerListParams,
+  };
+
+  export {
+    BusinessPartnerGroups as BusinessPartnerGroups,
+    type BusinessPartnerGroup as BusinessPartnerGroup,
+    type BusinessPartnerGroupRetrieveResponse as BusinessPartnerGroupRetrieveResponse,
+    type BusinessPartnerGroupsPageCursorURL as BusinessPartnerGroupsPageCursorURL,
+    type BusinessPartnerGroupCreateParams as BusinessPartnerGroupCreateParams,
+    type BusinessPartnerGroupRetrieveParams as BusinessPartnerGroupRetrieveParams,
+    type BusinessPartnerGroupListParams as BusinessPartnerGroupListParams,
+  };
+
+  export {
+    Functions as Functions,
+    type Function as Function,
+    type FunctionCreateDevBundleResponse as FunctionCreateDevBundleResponse,
+    type FunctionsPageCursorURL as FunctionsPageCursorURL,
+    type FunctionCreateParams as FunctionCreateParams,
+    type FunctionUpdateParams as FunctionUpdateParams,
+    type FunctionListParams as FunctionListParams,
+  };
+
+  export {
+    JobAssignments as JobAssignments,
+    type AttributeChangeDetails as AttributeChangeDetails,
+    type JobAssignment as JobAssignment,
+    type JobAssignmentRetrieveResponse as JobAssignmentRetrieveResponse,
+    type JobAssignmentsPageCursorURL as JobAssignmentsPageCursorURL,
+    type AttributeChangeDetailsPageCursorURL as AttributeChangeDetailsPageCursorURL,
+    type JobAssignmentRetrieveParams as JobAssignmentRetrieveParams,
+    type JobAssignmentListParams as JobAssignmentListParams,
+    type JobAssignmentListChangeLogParams as JobAssignmentListChangeLogParams,
+  };
+
+  export {
+    JobPayRateExceptions as JobPayRateExceptions,
+    type JobPayRateException as JobPayRateException,
+    type JobPayRateExceptionRetrieveResponse as JobPayRateExceptionRetrieveResponse,
+    type JobPayRateExceptionsPageCursorURL as JobPayRateExceptionsPageCursorURL,
+    type JobPayRateExceptionRetrieveParams as JobPayRateExceptionRetrieveParams,
+    type JobPayRateExceptionListParams as JobPayRateExceptionListParams,
+    type JobPayRateExceptionListChangeLogParams as JobPayRateExceptionListChangeLogParams,
+  };
+
+  export {
+    Schedules as Schedules,
+    type ScheduleRetrieveResponse as ScheduleRetrieveResponse,
+    type ScheduleListResponse as ScheduleListResponse,
+    type ScheduleListResponsesPageCursorURL as ScheduleListResponsesPageCursorURL,
+    type ScheduleRetrieveParams as ScheduleRetrieveParams,
+    type ScheduleListParams as ScheduleListParams,
+  };
+
+  export {
+    HeadcountPositions as HeadcountPositions,
+    type HeadcountPositionRetrieveResponse as HeadcountPositionRetrieveResponse,
+    type HeadcountPositionListResponse as HeadcountPositionListResponse,
+    type HeadcountPositionListResponsesPageCursorURL as HeadcountPositionListResponsesPageCursorURL,
+    type HeadcountPositionRetrieveParams as HeadcountPositionRetrieveParams,
+    type HeadcountPositionListParams as HeadcountPositionListParams,
+  };
+
+  export {
+    Shiftassignments as Shiftassignments,
+    type ShiftassignmentRetrieveResponse as ShiftassignmentRetrieveResponse,
+    type ShiftassignmentListResponse as ShiftassignmentListResponse,
+    type ShiftassignmentListResponsesPageCursorURL as ShiftassignmentListResponsesPageCursorURL,
+    type ShiftassignmentRetrieveParams as ShiftassignmentRetrieveParams,
+    type ShiftassignmentListParams as ShiftassignmentListParams,
+  };
+
+  export {
+    HeadcountPriorities as HeadcountPriorities,
+    type HeadcountPriorityRetrieveResponse as HeadcountPriorityRetrieveResponse,
+    type HeadcountPriorityListResponse as HeadcountPriorityListResponse,
+    type HeadcountPriorityListResponsesPageCursorURL as HeadcountPriorityListResponsesPageCursorURL,
+    type HeadcountPriorityListParams as HeadcountPriorityListParams,
+  };
+
+  export {
+    JobFunctions as JobFunctions,
+    type JobFunctionRetrieveResponse as JobFunctionRetrieveResponse,
+    type JobFunctionListResponse as JobFunctionListResponse,
+    type JobFunctionListResponsesPageCursorURL as JobFunctionListResponsesPageCursorURL,
+    type JobFunctionListParams as JobFunctionListParams,
+  };
+
+  export {
+    LocationFactors as LocationFactors,
+    type LocationFactorRetrieveResponse as LocationFactorRetrieveResponse,
+    type LocationFactorListResponse as LocationFactorListResponse,
+    type LocationFactorListResponsesPageCursorURL as LocationFactorListResponsesPageCursorURL,
+    type LocationFactorListParams as LocationFactorListParams,
+  };
+
+  export type Address = API.Address;
+  export type CountryCode = API.CountryCode;
+  export type RedactedFields = API.RedactedFields;
+}