@rippling/rippling-sdk 0.2.0-alpha.100

package/client.mjs

@@ -0,0 +1,1079 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var _RipplingSDK_instances, _a, _RipplingSDK_encoder, _RipplingSDK_baseURLOverridden;
+import { __classPrivateFieldGet, __classPrivateFieldSet } from "./internal/tslib.mjs";
+import { uuid4 } from "./internal/utils/uuid.mjs";
+import { validatePositiveInteger, isAbsoluteURL, safeJSON } from "./internal/utils/values.mjs";
+import { sleep } from "./internal/utils/sleep.mjs";
+import { castToError, isAbortError } from "./internal/errors.mjs";
+import { getPlatformHeaders } from "./internal/detect-platform.mjs";
+import * as Shims from "./internal/shims.mjs";
+import * as Opts from "./internal/request-options.mjs";
+import { stringifyQuery } from "./internal/utils/query.mjs";
+import { VERSION } from "./version.mjs";
+import * as Errors from "./core/error.mjs";
+import * as Pagination from "./core/pagination.mjs";
+import * as Uploads from "./core/uploads.mjs";
+import * as API from "./resources/index.mjs";
+import { APIPromise } from "./core/api-promise.mjs";
+import { AppUsers, } from "./resources/app-users.mjs";
+import { BackgroundCheckCandidates, } from "./resources/background-check-candidates.mjs";
+import { BreakPolicies, } from "./resources/break-policies.mjs";
+import { BreakTypes, } from "./resources/break-types.mjs";
+import { BusinessPartnerGroups, } from "./resources/business-partner-groups.mjs";
+import { BusinessPartners, } from "./resources/business-partners.mjs";
+import { BusinessStructurePaths, } from "./resources/business-structure-paths.mjs";
+import { CandidateApplications, } from "./resources/candidate-applications.mjs";
+import { Candidates, } from "./resources/candidates.mjs";
+import { Companies } from "./resources/companies.mjs";
+import { CompanyLegalEntities, } from "./resources/company-legal-entities.mjs";
+import { CompanyLegalEntityWorkers, } from "./resources/company-legal-entity-workers.mjs";
+import { CompensationBandsDetails, } from "./resources/compensation-bands-details.mjs";
+import { Compensations, } from "./resources/compensations.mjs";
+import { CustomApps, } from "./resources/custom-apps.mjs";
+import { CustomFields, } from "./resources/custom-fields.mjs";
+import { CustomPages, } from "./resources/custom-pages.mjs";
+import { CustomSettings, } from "./resources/custom-settings.mjs";
+import { Departments, } from "./resources/departments.mjs";
+import { DeveloperProgramApplication, } from "./resources/developer-program-application.mjs";
+import { DeveloperUsers, } from "./resources/developer-users.mjs";
+import { DeviceOrders, } from "./resources/device-orders.mjs";
+import { Devices, } from "./resources/devices.mjs";
+import { DraftHires } from "./resources/draft-hires.mjs";
+import { DraftTransitions, } from "./resources/draft-transitions.mjs";
+import { EarningTypes, } from "./resources/earning-types.mjs";
+import { EarningsInputs, } from "./resources/earnings-inputs.mjs";
+import { EmployeeDocuments, } from "./resources/employee-documents.mjs";
+import { EmploymentTypes, } from "./resources/employment-types.mjs";
+import { Entitlements, } from "./resources/entitlements.mjs";
+import { Files } from "./resources/files.mjs";
+import { HeadcountPositions, } from "./resources/headcount-positions.mjs";
+import { HeadcountPriorities, } from "./resources/headcount-priorities.mjs";
+import { HireRequirements, } from "./resources/hire-requirements.mjs";
+import { Hires } from "./resources/hires.mjs";
+import { JobAssignments, } from "./resources/job-assignments.mjs";
+import { JobCodes, } from "./resources/job-codes.mjs";
+import { JobDimensions, } from "./resources/job-dimensions.mjs";
+import { JobFunctions, } from "./resources/job-functions.mjs";
+import { JobPayRateExceptions, } from "./resources/job-pay-rate-exceptions.mjs";
+import { JobRequisitions, } from "./resources/job-requisitions.mjs";
+import { JobRequisitionsWrite, } from "./resources/job-requisitions-write.mjs";
+import { KioskBadges, } from "./resources/kiosk-badges.mjs";
+import { LeaveAccruals, } from "./resources/leave-accruals.mjs";
+import { LeaveBalances, } from "./resources/leave-balances.mjs";
+import { LeaveProgramEvaluations, } from "./resources/leave-program-evaluations.mjs";
+import { LeaveRequests, } from "./resources/leave-requests.mjs";
+import { LeaveTypes, } from "./resources/leave-types.mjs";
+import { LegalEntities, } from "./resources/legal-entities.mjs";
+import { Levels, } from "./resources/levels.mjs";
+import { Listing, } from "./resources/listing.mjs";
+import { ListingSubmissions, } from "./resources/listing-submissions.mjs";
+import { ListingTransitions, } from "./resources/listing-transitions.mjs";
+import { LocationFactors, } from "./resources/location-factors.mjs";
+import { ObjectCategories, } from "./resources/object-categories.mjs";
+import { PackageInstalls, } from "./resources/package-installs.mjs";
+import { PackageManagedInstalls, } from "./resources/package-managed-installs.mjs";
+import { PackageSandboxLinks, } from "./resources/package-sandbox-links.mjs";
+import { PackageUninstalls, } from "./resources/package-uninstalls.mjs";
+import { PackageUpgrades, } from "./resources/package-upgrades.mjs";
+import { PackageVersionComponentUpdates, } from "./resources/package-version-component-updates.mjs";
+import { PlatformCapabilities, } from "./resources/platform-capabilities.mjs";
+import { ReportRuns, } from "./resources/report-runs.mjs";
+import { Sandboxes, } from "./resources/sandboxes.mjs";
+import { ScheduledJobAssignments, } from "./resources/scheduled-job-assignments.mjs";
+import { Schedules, } from "./resources/schedules.mjs";
+import { ShiftAssignments, } from "./resources/shift-assignments.mjs";
+import { ShiftInputs, } from "./resources/shift-inputs.mjs";
+import { Shiftassignments, } from "./resources/shiftassignments.mjs";
+import { Sites, } from "./resources/sites.mjs";
+import { SoftwareDeployments, } from "./resources/software-deployments.mjs";
+import { SSOMeResource } from "./resources/sso-me.mjs";
+import { Teams, } from "./resources/teams.mjs";
+import { TimeCards, } from "./resources/time-cards.mjs";
+import { TimeEntries, } from "./resources/time-entries.mjs";
+import { Titles, } from "./resources/titles.mjs";
+import { Tracks, } from "./resources/tracks.mjs";
+import { UnassignedShifts, } from "./resources/unassigned-shifts.mjs";
+import { Unassignedshifts, } from "./resources/unassignedshifts.mjs";
+import { Users } from "./resources/users.mjs";
+import { VariableCompensationPayoutLabels, } from "./resources/variable-compensation-payout-labels.mjs";
+import { VariableCompensationPayoutTypes, } from "./resources/variable-compensation-payout-types.mjs";
+import { VariableCompensationPayoutWrites, } from "./resources/variable-compensation-payout-writes.mjs";
+import { VariableCompensationPayouts, } from "./resources/variable-compensation-payouts.mjs";
+import { WorkLocations, } from "./resources/work-locations.mjs";
+import { WorkerChangeFields, } from "./resources/worker-change-fields.mjs";
+import { WorkerChanges, } from "./resources/worker-changes.mjs";
+import { WorkerTimeSplits, } from "./resources/worker-time-splits.mjs";
+import { Workers, } from "./resources/workers.mjs";
+import { WorkflowActionExecutions, } from "./resources/workflow-action-executions.mjs";
+import { Workflows, } from "./resources/workflows.mjs";
+import { Agents, } from "./resources/agents/agents.mjs";
+import { CustomObjects, } from "./resources/custom-objects/custom-objects.mjs";
+import { Functions, } from "./resources/functions/functions.mjs";
+import { Metadata, } from "./resources/metadata/metadata.mjs";
+import { PackageVersions, } from "./resources/package-versions/package-versions.mjs";
+import { Packages, } from "./resources/packages/packages.mjs";
+import { PayrollRuns, } from "./resources/payroll-runs/payroll-runs.mjs";
+import { Reports } from "./resources/reports/reports.mjs";
+import { Supergroups, } from "./resources/supergroups/supergroups.mjs";
+import { buildHeaders } from "./internal/headers.mjs";
+import { readEnv } from "./internal/utils/env.mjs";
+import { formatRequestDetails, loggerFor, parseLogLevel, } from "./internal/utils/log.mjs";
+import { isEmptyObj } from "./internal/utils/values.mjs";
+/**
+ * API Client for interfacing with the Rippling SDK API.
+ */
+export class RipplingSDK {
+    /**
+     * 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 } = {}) {
+        _RipplingSDK_instances.add(this);
+        _RipplingSDK_encoder.set(this, void 0);
+        /**
+         * Companies on Rippling
+         */
+        this.companies = new API.Companies(this);
+        /**
+         * Compensation associated with workers
+         */
+        this.compensations = new API.Compensations(this);
+        /**
+         * Custom objects defined by the company
+         */
+        this.customObjects = new API.CustomObjects(this);
+        /**
+         * Departments used by the company
+         */
+        this.departments = new API.Departments(this);
+        /**
+         * Employment types used by the company
+         */
+        this.employmentTypes = new API.EmploymentTypes(this);
+        /**
+         * Job related information for the company
+         */
+        this.jobCodes = new API.JobCodes(this);
+        /**
+         * Job related information for the company
+         */
+        this.jobDimensions = new API.JobDimensions(this);
+        /**
+         * A request for a job to be filled by a candidate
+         */
+        this.jobRequisitions = new API.JobRequisitions(this);
+        /**
+         * Badge information used with Timeclock Kiosk
+         */
+        this.kioskBadges = new API.KioskBadges(this);
+        /**
+         * Leave balances for workers
+         */
+        this.leaveBalances = new API.LeaveBalances(this);
+        /**
+         * Leave requests submitted by workers
+         */
+        this.leaveRequests = new API.LeaveRequests(this);
+        /**
+         * Leave types used by the company
+         */
+        this.leaveTypes = new API.LeaveTypes(this);
+        /**
+         * Legal entities registered by the company
+         */
+        this.legalEntities = new API.LegalEntities(this);
+        /**
+         * Levels and tracks used by the company for workers
+         */
+        this.levels = new API.Levels(this);
+        /**
+         * Object Categories defined by the company
+         */
+        this.objectCategories = new API.ObjectCategories(this);
+        /**
+         * Shift inputs used by the company
+         */
+        this.shiftInputs = new API.ShiftInputs(this);
+        /**
+         * Provides the user's SSO information
+         */
+        this.ssoMe = new API.SSOMeResource(this);
+        /**
+         * Supergroups used by the company
+         */
+        this.supergroups = new API.Supergroups(this);
+        /**
+         * Teams at the company
+         */
+        this.teams = new API.Teams(this);
+        /**
+         * Time entries submitted by workers
+         */
+        this.timeCards = new API.TimeCards(this);
+        /**
+         * Time entries submitted by workers
+         */
+        this.timeEntries = new API.TimeEntries(this);
+        /**
+         * Levels and tracks used by the company for workers
+         */
+        this.tracks = new API.Tracks(this);
+        /**
+         * Users of the company
+         */
+        this.users = new API.Users(this);
+        /**
+         * Work locations used by the company
+         */
+        this.workLocations = new API.WorkLocations(this);
+        /**
+         * Workers who work or have worked at the company
+         */
+        this.workers = new API.Workers(this);
+        /**
+         * Business partners of the company
+         */
+        this.businessPartners = new API.BusinessPartners(this);
+        /**
+         * Business partners of the company
+         */
+        this.businessPartnerGroups = new API.BusinessPartnerGroups(this);
+        /**
+         * Functions defined by the company
+         */
+        this.functions = new API.Functions(this);
+        /**
+         * Job related information for the company
+         */
+        this.jobAssignments = new API.JobAssignments(this);
+        /**
+         * Job related information for the company
+         */
+        this.jobPayRateExceptions = new API.JobPayRateExceptions(this);
+        /**
+         * Agents defined by the company
+         */
+        this.agents = new API.Agents(this);
+        /**
+         * Mappings between Rippling workers and their user accounts in third-party apps
+         */
+        this.appUsers = new API.AppUsers(this);
+        /**
+         * Candidates who have been submitted for background check screening
+         */
+        this.backgroundCheckCandidates = new API.BackgroundCheckCandidates(this);
+        /**
+         * Break types configured by the company for time tracking
+         */
+        this.breakPolicies = new API.BreakPolicies(this);
+        /**
+         * Break types configured by the company for time tracking
+         */
+        this.breakTypes = new API.BreakTypes(this);
+        /**
+         * Business structure used for defining hierarchy of company's org attributes
+         */
+        this.businessStructurePaths = new API.BusinessStructurePaths(this);
+        /**
+         * Someone who applies to a job requisition opened by the company
+         */
+        this.candidates = new API.Candidates(this);
+        /**
+         * An application by a candidate to a specific job requisition
+         */
+        this.candidateApplications = new API.CandidateApplications(this);
+        /**
+         * Legal entities registered by the company
+         */
+        this.companyLegalEntities = new API.CompanyLegalEntities(this);
+        /**
+         * Workers who work or have worked at the company
+         */
+        this.companyLegalEntityWorkers = new API.CompanyLegalEntityWorkers(this);
+        /**
+         * Compensation bands details associated with workers
+         */
+        this.compensationBandsDetails = new API.CompensationBandsDetails(this);
+        this.customApps = new API.CustomApps(this);
+        /**
+         * Custom fields defined by the company
+         */
+        this.customFields = new API.CustomFields(this);
+        this.customPages = new API.CustomPages(this);
+        this.customSettings = new API.CustomSettings(this);
+        /**
+         * Developer Platform account and team management
+         */
+        this.developerProgramApplication = new API.DeveloperProgramApplication(this);
+        /**
+         * Developer Platform account and team management
+         */
+        this.developerUsers = new API.DeveloperUsers(this);
+        /**
+         * Devices (laptops, desktops, phones, tablets) managed by Rippling
+         */
+        this.devices = new API.Devices(this);
+        /**
+         * Device orders (new device shipments, retrievals, etc.) for company workers
+         */
+        this.deviceOrders = new API.DeviceOrders(this);
+        /**
+         * Candidates who have not yet started work at the company
+         */
+        this.draftHires = new API.DraftHires(this);
+        /**
+         * Proposed changes to existing workers that can be reviewed in Rippling
+         */
+        this.draftTransitions = new API.DraftTransitions(this);
+        /**
+         * Earning types configured for the company
+         */
+        this.earningTypes = new API.EarningTypes(this);
+        /**
+         * External earnings inputs for the company
+         */
+        this.earningsInputs = new API.EarningsInputs(this);
+        /**
+         * Documents attached to existing employees
+         */
+        this.employeeDocuments = new API.EmployeeDocuments(this);
+        /**
+         * Availability of API features to the company or Partners.
+         */
+        this.entitlements = new API.Entitlements(this);
+        /**
+         * Generate presigned URLs to upload files to Rippling storage
+         */
+        this.files = new API.Files(this);
+        /**
+         * Headcount allocations for the company
+         */
+        this.headcountPositions = new API.HeadcountPositions(this);
+        /**
+         * Organizational classifications used to categorize hiring needs based on business urgency and strategic importance
+         */
+        this.headcountPriorities = new API.HeadcountPriorities(this);
+        /**
+         * Hiring intent submitted for admin review in Rippling
+         */
+        this.hires = new API.Hires(this);
+        /**
+         * Baseline required fields for submitting hires by country and hire type
+         */
+        this.hireRequirements = new API.HireRequirements(this);
+        /**
+         * Organizational job categories that group similar roles and responsibilities within a company
+         */
+        this.jobFunctions = new API.JobFunctions(this);
+        /**
+         * A request for a job to be filled by a candidate
+         */
+        this.jobRequisitionsWrite = new API.JobRequisitionsWrite(this);
+        /**
+         * Leave accruals for workers
+         */
+        this.leaveAccruals = new API.LeaveAccruals(this);
+        /**
+         * Leave program evaluations produced by the leave rules engine
+         */
+        this.leaveProgramEvaluations = new API.LeaveProgramEvaluations(this);
+        /**
+         * Developer Platform account and team management
+         */
+        this.listing = new API.Listing(this);
+        /**
+         * Developer Platform account and team management
+         */
+        this.listingSubmissions = new API.ListingSubmissions(this);
+        /**
+         * Developer Platform account and team management
+         */
+        this.listingTransitions = new API.ListingTransitions(this);
+        /**
+         * Geographic compensation adjustment factors that modify base compensation based on location-specific market conditions and cost of living
+         */
+        this.locationFactors = new API.LocationFactors(this);
+        /**
+         * Author, publish, and install Unity Packages V2 packages
+         */
+        this.packages = new API.Packages(this);
+        /**
+         * Author, publish, and install Unity Packages V2 packages
+         */
+        this.packageInstalls = new API.PackageInstalls(this);
+        /**
+         * Author, publish, and install Unity Packages V2 packages
+         */
+        this.packageManagedInstalls = new API.PackageManagedInstalls(this);
+        /**
+         * Author, publish, and install Unity Packages V2 packages
+         */
+        this.packageSandboxLinks = new API.PackageSandboxLinks(this);
+        /**
+         * Author, publish, and install Unity Packages V2 packages
+         */
+        this.packageUninstalls = new API.PackageUninstalls(this);
+        /**
+         * Author, publish, and install Unity Packages V2 packages
+         */
+        this.packageUpgrades = new API.PackageUpgrades(this);
+        /**
+         * Author, publish, and install Unity Packages V2 packages
+         */
+        this.packageVersions = new API.PackageVersions(this);
+        /**
+         * Author, publish, and install Unity Packages V2 packages
+         */
+        this.packageVersionComponentUpdates = new API.PackageVersionComponentUpdates(this);
+        /**
+         * Payroll runs for the company
+         */
+        this.payrollRuns = new API.PayrollRuns(this);
+        /**
+         * Custom objects defined by the company
+         */
+        this.platformCapabilities = new API.PlatformCapabilities(this);
+        /**
+         * Report data for company
+         */
+        this.reports = new API.Reports(this);
+        /**
+         * Report data for company
+         */
+        this.reportRuns = new API.ReportRuns(this);
+        /**
+         * Isolated environments used for development and testing
+         */
+        this.sandboxes = new API.Sandboxes(this);
+        /**
+         * Schedules used by the company
+         */
+        this.schedules = new API.Schedules(this);
+        /**
+         * Job related information for the company
+         */
+        this.scheduledJobAssignments = new API.ScheduledJobAssignments(this);
+        /**
+         * Shift assignments assigned to workers
+         */
+        this.shiftassignments = new API.Shiftassignments(this);
+        /**
+         * Custom sites hosted on Rippling
+         */
+        this.sites = new API.Sites(this);
+        /**
+         * Software deployed to company devices
+         */
+        this.softwareDeployments = new API.SoftwareDeployments(this);
+        /**
+         * Job titles used by the company
+         */
+        this.titles = new API.Titles(this);
+        /**
+         * Unassigned shifts that are part of a schedule
+         */
+        this.unassignedshifts = new API.Unassignedshifts(this);
+        /**
+         * Compensation associated with workers
+         */
+        this.variableCompensationPayouts = new API.VariableCompensationPayouts(this);
+        /**
+         * Compensation associated with workers
+         */
+        this.variableCompensationPayoutLabels = new API.VariableCompensationPayoutLabels(this);
+        /**
+         * Compensation associated with workers
+         */
+        this.variableCompensationPayoutTypes = new API.VariableCompensationPayoutTypes(this);
+        /**
+         * Compensation associated with workers
+         */
+        this.variableCompensationPayoutWrites = new API.VariableCompensationPayoutWrites(this);
+        /**
+         * Historical changes to worker data over time
+         */
+        this.workerChanges = new API.WorkerChanges(this);
+        /**
+         * Historical changes to worker data over time
+         */
+        this.workerChangeFields = new API.WorkerChangeFields(this);
+        /**
+         * Job related information for the company
+         */
+        this.workerTimeSplits = new API.WorkerTimeSplits(this);
+        /**
+         * Execute workflow actions like sending emails, Slack messages, and notifications
+         */
+        this.workflows = new API.Workflows(this);
+        /**
+         * Execute workflow actions like sending emails, Slack messages, and notifications
+         */
+        this.workflowActionExecutions = new API.WorkflowActionExecutions(this);
+        /**
+         * Shift assignments assigned to workers
+         */
+        this.shiftAssignments = new API.ShiftAssignments(this);
+        /**
+         * Unassigned shifts that are part of a schedule
+         */
+        this.unassignedShifts = new API.UnassignedShifts(this);
+        /**
+         * Custom objects defined by the company
+         */
+        this.metadata = new API.Metadata(this);
+        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 = {
+            bearerToken,
+            ...opts,
+            baseURL: baseURL || `https://rest.ripplingapis.com`,
+        };
+        this.baseURL = options.baseURL;
+        this.timeout = options.timeout ?? _a.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();
+        __classPrivateFieldSet(this, _RipplingSDK_encoder, Opts.FallbackEncoder, "f");
+        const customHeadersEnv = readEnv('RIPPLING_SDK_CUSTOM_HEADERS');
+        if (customHeadersEnv) {
+            const parsed = {};
+            for (const line of customHeadersEnv.split('\n')) {
+                const colon = line.indexOf(':');
+                if (colon >= 0) {
+                    parsed[line.substring(0, colon).trim()] = line.substring(colon + 1).trim();
+                }
+            }
+            options.defaultHeaders = { ...parsed, ...options.defaultHeaders };
+        }
+        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) {
+        const client = new this.constructor({
+            ...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;
+    }
+    defaultQuery() {
+        return this._options.defaultQuery;
+    }
+    validateHeaders({ values, nulls }) {
+        return;
+    }
+    async authHeaders(opts) {
+        return buildHeaders([{ Authorization: `Bearer ${this.bearerToken}` }]);
+    }
+    /**
+     * Basic re-implementation of `qs.stringify` for primitive types.
+     */
+    stringifyQuery(query) {
+        return stringifyQuery(query);
+    }
+    getUserAgent() {
+        return `${this.constructor.name}/JS ${VERSION}`;
+    }
+    defaultIdempotencyKey() {
+        return `stainless-node-retry-${uuid4()}`;
+    }
+    makeStatusError(status, error, message, headers) {
+        return Errors.APIError.generate(status, error, message, headers);
+    }
+    buildURL(path, query, defaultBaseURL) {
+        const baseURL = (!__classPrivateFieldGet(this, _RipplingSDK_instances, "m", _RipplingSDK_baseURLOverridden).call(this) && 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();
+        const pathQuery = Object.fromEntries(url.searchParams);
+        if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+            query = { ...pathQuery, ...defaultQuery, ...query };
+        }
+        if (typeof query === 'object' && query && !Array.isArray(query)) {
+            url.search = this.stringifyQuery(query);
+        }
+        return url.toString();
+    }
+    /**
+     * Used as a callback for mutating the given `FinalRequestOptions` object.
+     */
+    async prepareOptions(options) { }
+    /**
+     * 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`.
+     */
+    async prepareRequest(request, { url, options }) { }
+    get(path, opts) {
+        return this.methodRequest('get', path, opts);
+    }
+    post(path, opts) {
+        return this.methodRequest('post', path, opts);
+    }
+    patch(path, opts) {
+        return this.methodRequest('patch', path, opts);
+    }
+    put(path, opts) {
+        return this.methodRequest('put', path, opts);
+    }
+    delete(path, opts) {
+        return this.methodRequest('delete', path, opts);
+    }
+    methodRequest(method, path, opts) {
+        return this.request(Promise.resolve(opts).then((opts) => {
+            return { method, path, ...opts };
+        }));
+    }
+    request(options, remainingRetries = null) {
+        return new APIPromise(this, this.makeRequest(options, remainingRetries, undefined));
+    }
+    async makeRequest(optionsInput, retriesRemaining, retryOfRequestLogID) {
+        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) => 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(path, Page, opts) {
+        return this.requestAPIList(Page, opts && 'then' in opts ?
+            opts.then((opts) => ({ method: 'get', path, ...opts }))
+            : { method: 'get', path, ...opts });
+    }
+    requestAPIList(Page, options) {
+        const request = this.makeRequest(options, null, undefined);
+        return new Pagination.PagePromise(this, request, Page);
+    }
+    async fetchWithTimeout(url, init, ms, controller) {
+        const { signal, method, ...options } = init || {};
+        const abort = this._makeAbort(controller);
+        if (signal)
+            signal.addEventListener('abort', abort, { once: true });
+        const timeout = setTimeout(abort, ms);
+        const isReadableBody = (globalThis.ReadableStream && options.body instanceof globalThis.ReadableStream) ||
+            (typeof options.body === 'object' && options.body !== null && Symbol.asyncIterator in options.body);
+        const fetchOptions = {
+            signal: controller.signal,
+            ...(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);
+        }
+    }
+    async shouldRetry(response) {
+        // 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;
+    }
+    async retryRequest(options, retriesRemaining, requestLogID, responseHeaders) {
+        let timeoutMillis;
+        // 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, just do what it
+        // says, but otherwise calculate a default
+        if (timeoutMillis === undefined) {
+            const maxRetries = options.maxRetries ?? this.maxRetries;
+            timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
+        }
+        await sleep(timeoutMillis);
+        return this.makeRequest(options, retriesRemaining - 1, requestLogID);
+    }
+    calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries) {
+        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, { retryCount = 0 } = {}) {
+        const options = { ...inputOptions };
+        const { method, path, query, defaultBaseURL } = options;
+        const url = this.buildURL(path, query, 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 = {
+            method,
+            headers: reqHeaders,
+            ...(options.signal && { signal: options.signal }),
+            ...(globalThis.ReadableStream &&
+                body instanceof globalThis.ReadableStream && { duplex: 'half' }),
+            ...(body && { body }),
+            ...(this.fetchOptions ?? {}),
+            ...(options.fetchOptions ?? {}),
+        };
+        return { req, url, timeout: options.timeout };
+    }
+    async buildHeaders({ options, method, bodyHeaders, retryCount, }) {
+        let idempotencyHeaders = {};
+        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(),
+                'Rippling-Api-Version': '2024-08-01',
+            },
+            await this.authHeaders(options),
+            this._options.defaultHeaders,
+            bodyHeaders,
+            options.headers,
+        ]);
+        this.validateHeaders(headers);
+        return headers.values;
+    }
+    _makeAbort(controller) {
+        // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+        //       would capture all request options, and cause a memory leak.
+        return () => controller.abort();
+    }
+    buildBody({ options }) {
+        const { body, headers: rawHeaders } = options;
+        if (!body) {
+            // A resource method always passes a `body` key when its operation defines a
+            // request body, even if the caller omitted an optional body param. Keep the
+            // content-type for those, and only elide it for operations with no body at
+            // all (e.g. GET/DELETE).
+            if (body == null && 'body' in options) {
+                return __classPrivateFieldGet(this, _RipplingSDK_encoder, "f").call(this, { body, headers: buildHeaders([rawHeaders]) });
+            }
+            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.Blob && body instanceof globalThis.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.ReadableStream && body instanceof globalThis.ReadableStream)) {
+            return { bodyHeaders: undefined, body: body };
+        }
+        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) };
+        }
+        else if (typeof body === 'object' &&
+            headers.values.get('content-type') === 'application/x-www-form-urlencoded') {
+            return {
+                bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+                body: this.stringifyQuery(body),
+            };
+        }
+        else {
+            return __classPrivateFieldGet(this, _RipplingSDK_encoder, "f").call(this, { body, headers });
+        }
+    }
+}
+_a = RipplingSDK, _RipplingSDK_encoder = new WeakMap(), _RipplingSDK_instances = new WeakSet(), _RipplingSDK_baseURLOverridden = function _RipplingSDK_baseURLOverridden() {
+    return this.baseURL !== 'https://rest.ripplingapis.com';
+};
+RipplingSDK.RipplingSDK = _a;
+RipplingSDK.DEFAULT_TIMEOUT = 60000; // 1 minute
+RipplingSDK.RipplingSDKError = Errors.RipplingSDKError;
+RipplingSDK.APIError = Errors.APIError;
+RipplingSDK.APIConnectionError = Errors.APIConnectionError;
+RipplingSDK.APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+RipplingSDK.APIUserAbortError = Errors.APIUserAbortError;
+RipplingSDK.NotFoundError = Errors.NotFoundError;
+RipplingSDK.ConflictError = Errors.ConflictError;
+RipplingSDK.RateLimitError = Errors.RateLimitError;
+RipplingSDK.BadRequestError = Errors.BadRequestError;
+RipplingSDK.AuthenticationError = Errors.AuthenticationError;
+RipplingSDK.InternalServerError = Errors.InternalServerError;
+RipplingSDK.PermissionDeniedError = Errors.PermissionDeniedError;
+RipplingSDK.UnprocessableEntityError = Errors.UnprocessableEntityError;
+RipplingSDK.toFile = Uploads.toFile;
+RipplingSDK.Companies = Companies;
+RipplingSDK.Compensations = Compensations;
+RipplingSDK.CustomObjects = CustomObjects;
+RipplingSDK.Departments = Departments;
+RipplingSDK.EmploymentTypes = EmploymentTypes;
+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.Agents = Agents;
+RipplingSDK.AppUsers = AppUsers;
+RipplingSDK.BackgroundCheckCandidates = BackgroundCheckCandidates;
+RipplingSDK.BreakPolicies = BreakPolicies;
+RipplingSDK.BreakTypes = BreakTypes;
+RipplingSDK.BusinessStructurePaths = BusinessStructurePaths;
+RipplingSDK.Candidates = Candidates;
+RipplingSDK.CandidateApplications = CandidateApplications;
+RipplingSDK.CompanyLegalEntities = CompanyLegalEntities;
+RipplingSDK.CompanyLegalEntityWorkers = CompanyLegalEntityWorkers;
+RipplingSDK.CompensationBandsDetails = CompensationBandsDetails;
+RipplingSDK.CustomApps = CustomApps;
+RipplingSDK.CustomFields = CustomFields;
+RipplingSDK.CustomPages = CustomPages;
+RipplingSDK.CustomSettings = CustomSettings;
+RipplingSDK.DeveloperProgramApplication = DeveloperProgramApplication;
+RipplingSDK.DeveloperUsers = DeveloperUsers;
+RipplingSDK.Devices = Devices;
+RipplingSDK.DeviceOrders = DeviceOrders;
+RipplingSDK.DraftHires = DraftHires;
+RipplingSDK.DraftTransitions = DraftTransitions;
+RipplingSDK.EarningTypes = EarningTypes;
+RipplingSDK.EarningsInputs = EarningsInputs;
+RipplingSDK.EmployeeDocuments = EmployeeDocuments;
+RipplingSDK.Entitlements = Entitlements;
+RipplingSDK.Files = Files;
+RipplingSDK.HeadcountPositions = HeadcountPositions;
+RipplingSDK.HeadcountPriorities = HeadcountPriorities;
+RipplingSDK.Hires = Hires;
+RipplingSDK.HireRequirements = HireRequirements;
+RipplingSDK.JobFunctions = JobFunctions;
+RipplingSDK.JobRequisitionsWrite = JobRequisitionsWrite;
+RipplingSDK.LeaveAccruals = LeaveAccruals;
+RipplingSDK.LeaveProgramEvaluations = LeaveProgramEvaluations;
+RipplingSDK.Listing = Listing;
+RipplingSDK.ListingSubmissions = ListingSubmissions;
+RipplingSDK.ListingTransitions = ListingTransitions;
+RipplingSDK.LocationFactors = LocationFactors;
+RipplingSDK.Packages = Packages;
+RipplingSDK.PackageInstalls = PackageInstalls;
+RipplingSDK.PackageManagedInstalls = PackageManagedInstalls;
+RipplingSDK.PackageSandboxLinks = PackageSandboxLinks;
+RipplingSDK.PackageUninstalls = PackageUninstalls;
+RipplingSDK.PackageUpgrades = PackageUpgrades;
+RipplingSDK.PackageVersions = PackageVersions;
+RipplingSDK.PackageVersionComponentUpdates = PackageVersionComponentUpdates;
+RipplingSDK.PayrollRuns = PayrollRuns;
+RipplingSDK.PlatformCapabilities = PlatformCapabilities;
+RipplingSDK.Reports = Reports;
+RipplingSDK.ReportRuns = ReportRuns;
+RipplingSDK.Sandboxes = Sandboxes;
+RipplingSDK.Schedules = Schedules;
+RipplingSDK.ScheduledJobAssignments = ScheduledJobAssignments;
+RipplingSDK.Shiftassignments = Shiftassignments;
+RipplingSDK.Sites = Sites;
+RipplingSDK.SoftwareDeployments = SoftwareDeployments;
+RipplingSDK.Titles = Titles;
+RipplingSDK.Unassignedshifts = Unassignedshifts;
+RipplingSDK.VariableCompensationPayouts = VariableCompensationPayouts;
+RipplingSDK.VariableCompensationPayoutLabels = VariableCompensationPayoutLabels;
+RipplingSDK.VariableCompensationPayoutTypes = VariableCompensationPayoutTypes;
+RipplingSDK.VariableCompensationPayoutWrites = VariableCompensationPayoutWrites;
+RipplingSDK.WorkerChanges = WorkerChanges;
+RipplingSDK.WorkerChangeFields = WorkerChangeFields;
+RipplingSDK.WorkerTimeSplits = WorkerTimeSplits;
+RipplingSDK.Workflows = Workflows;
+RipplingSDK.WorkflowActionExecutions = WorkflowActionExecutions;
+RipplingSDK.ShiftAssignments = ShiftAssignments;
+RipplingSDK.UnassignedShifts = UnassignedShifts;
+RipplingSDK.Metadata = Metadata;
+//# sourceMappingURL=client.mjs.map