@rippling/rippling-sdk 0.2.0-alpha.62 → 0.2.0-alpha.64

package/src/resources/devices.ts

@@ -0,0 +1,496 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import * as WorkersAPI from './workers';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Devices (laptops, desktops, phones, tablets) managed by Rippling
+ */
+export class Devices extends APIResource {
+  /**
+   * A list of devices.
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `worker_id`, `serial_number`, `lifecycle_state`,
+   *   `enrollment_status`
+   * - Expandable fields: `worker`, `pending_actions`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: DeviceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DeviceListResponsesPageCursorURL, DeviceListResponse> {
+    return this._client.getAPIList('/devices/', PageCursorURL<DeviceListResponse>, { query, ...options });
+  }
+
+  /**
+   * Retrieve a specific device
+   */
+  retrieve(
+    id: string,
+    query: DeviceRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DeviceRetrieveResponse> {
+    return this._client.get(path`/devices/${id}/`, { query, ...options });
+  }
+}
+
+export type DeviceListResponsesPageCursorURL = PageCursorURL<DeviceListResponse>;
+
+export interface DeviceListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR,
+   * etc.
+   */
+  enrollment_status?: 'ENROLLED' | 'WAITING_FOR_CONNECTION' | 'ERROR' | 'UNENROLLED';
+
+  /**
+   * Whether the device's disk is encrypted (FileVault on macOS, BitLocker on
+   * Windows).
+   */
+  is_encrypted?: boolean;
+
+  /**
+   * Whether the device is managed via MDM.
+   */
+  is_managed?: boolean;
+
+  /**
+   * When the Rippling agent last checked in from this device.
+   */
+  last_checkin_at?: string;
+
+  /**
+   * When the device last synced with MDM.
+   */
+  last_mdm_sync_at?: string;
+
+  /**
+   * The device lifecycle state (e.g. ACTIVE, READY, LOCKED, LOST, DECOMMISSIONED).
+   */
+  lifecycle_state?:
+    | 'INIT'
+    | 'ACTIVE'
+    | 'ACTIVATING'
+    | 'LOCKED'
+    | 'LOCKING'
+    | 'INACTIVE'
+    | 'PENDING_MDM'
+    | 'CLEANING'
+    | 'READY'
+    | 'DECOMMISSIONING'
+    | 'DECOMMISSIONED'
+    | 'FULL_WIPING'
+    | 'FULL_WIPED'
+    | 'E_CYCLED'
+    | 'MDM_LOCKED'
+    | 'LOST'
+    | 'LOST_PLAYING_SOUND';
+
+  /**
+   * The MDM provider currently recorded on the device (RIPPLING, JAMFCLOUD, INTUNE,
+   * KANDJI, etc.). Null when the device is not currently MDM-managed (typical for
+   * unenrolled or recently-reset devices).
+   */
+  mdm_provider?:
+    | 'RIPPLING'
+    | 'JUMPCLOUD'
+    | 'JAMFCLOUD'
+    | 'FLEETSMITH'
+    | 'HEXNODE'
+    | 'MICROMDM'
+    | 'MERAKI'
+    | 'SOTI'
+    | 'ADDIGY'
+    | 'FLEETDM'
+    | 'KANDJI'
+    | 'ZOHO'
+    | 'INTUNE'
+    | 'OTHER';
+
+  /**
+   * The device hardware model identifier as reported by MDM (e.g. 'MacBookPro18,3',
+   * 'iPhone15,2').
+   */
+  model?: string;
+
+  /**
+   * The device operating system name.
+   */
+  os_name?: string;
+
+  /**
+   * The device operating system version.
+   */
+  os_version?: string;
+
+  /**
+   * Actions currently queued against the device (not yet completed). Expandable.
+   *
+   * Expandable field
+   */
+  pending_actions?: Array<DeviceListResponse.PendingAction>;
+
+  /**
+   * The IDs of actions currently queued against the device (not yet completed).
+   */
+  pending_actions_id?: Array<string>;
+
+  /**
+   * The OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS.
+   */
+  platform?: 'MACOS' | 'WINDOWS' | 'IOS' | 'IPADOS';
+
+  /**
+   * The device's hardware serial number.
+   */
+  serial_number?: string;
+
+  /**
+   * The worker this device is currently assigned to.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The ID of the worker this device is currently assigned to. Null if unassigned.
+   */
+  worker_id?: string;
+}
+
+export namespace DeviceListResponse {
+  export interface PendingAction {
+    /**
+     * Identifier field
+     */
+    id: string;
+
+    /**
+     * Record creation date
+     */
+    created_at: string;
+
+    /**
+     * Record update date
+     */
+    updated_at: string;
+
+    /**
+     * The type of the pending device action (e.g. LOCK_DEVICE, RESET_PASSWORD).
+     */
+    action_type?:
+      | 'ADD_USER_TO_FILEVAULT'
+      | 'ASSIGN_DEVICE'
+      | 'AUTHENTICATE_AGENT'
+      | 'CHANGE_FILEVAULT_RECOVERY_KEY'
+      | 'CHANGE_PASSWORD'
+      | 'CLEAR_PASSCODE'
+      | 'CREATE_RIPPLING_ADMIN'
+      | 'DELETE_LOCAL_ACCOUNT'
+      | 'DEMOTE_ACCOUNT_PERMISSION'
+      | 'DISABLE_FIND_MY'
+      | 'DISABLE_LOST_MODE'
+      | 'DISABLE_REMOTE_DESKTOP'
+      | 'ENABLE_LOST_MODE'
+      | 'ENABLE_REMOTE_DESKTOP'
+      | 'ENFORCE_PASSWORD_POLICY'
+      | 'FORCE_CHECK_IN'
+      | 'FULL_WIPE'
+      | 'GRANT_SECURE_TOKEN'
+      | 'INSTALL_ENROLLMENT_PROFILE'
+      | 'LOCK_DEVICE'
+      | 'LOCK_USER_ACCOUNT'
+      | 'LOST_MODE_GET_LOCATION'
+      | 'LOST_MODE_PLAY_SOUND'
+      | 'PROMOTE_ACCOUNT_PERMISSION'
+      | 'RECOVER_AGENT_VIA_MDM'
+      | 'REINSTALL_AGENT'
+      | 'REINSTALL_ENROLLMENT_PROFILE'
+      | 'REMOVE_OTHER_ENROLLMENT_PROFILES'
+      | 'RESET_PASSWORD'
+      | 'RESTART_DEVICE'
+      | 'ROTATE_FILEVAULT_KEY'
+      | 'SHUTDOWN_DEVICE'
+      | 'SOFT_WIPE'
+      | 'TURN_ON_FILEVAULT'
+      | 'UNASSIGN_DEVICE'
+      | 'UNINSTALL_AGENT'
+      | 'UNINSTALL_ANTIVIRUS'
+      | 'UNINSTALL_MDM'
+      | 'UNLOCK_DEVICE'
+      | 'UNLOCK_USER_ACCOUNT'
+      | 'UPDATE_OS'
+      | 'UNKNOWN';
+
+    /**
+     * When the action was queued.
+     */
+    queued_at?: string;
+
+    /**
+     * The current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION).
+     */
+    state?: string;
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface DeviceRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR,
+   * etc.
+   */
+  enrollment_status?: 'ENROLLED' | 'WAITING_FOR_CONNECTION' | 'ERROR' | 'UNENROLLED';
+
+  /**
+   * Whether the device's disk is encrypted (FileVault on macOS, BitLocker on
+   * Windows).
+   */
+  is_encrypted?: boolean;
+
+  /**
+   * Whether the device is managed via MDM.
+   */
+  is_managed?: boolean;
+
+  /**
+   * When the Rippling agent last checked in from this device.
+   */
+  last_checkin_at?: string;
+
+  /**
+   * When the device last synced with MDM.
+   */
+  last_mdm_sync_at?: string;
+
+  /**
+   * The device lifecycle state (e.g. ACTIVE, READY, LOCKED, LOST, DECOMMISSIONED).
+   */
+  lifecycle_state?:
+    | 'INIT'
+    | 'ACTIVE'
+    | 'ACTIVATING'
+    | 'LOCKED'
+    | 'LOCKING'
+    | 'INACTIVE'
+    | 'PENDING_MDM'
+    | 'CLEANING'
+    | 'READY'
+    | 'DECOMMISSIONING'
+    | 'DECOMMISSIONED'
+    | 'FULL_WIPING'
+    | 'FULL_WIPED'
+    | 'E_CYCLED'
+    | 'MDM_LOCKED'
+    | 'LOST'
+    | 'LOST_PLAYING_SOUND';
+
+  /**
+   * The MDM provider currently recorded on the device (RIPPLING, JAMFCLOUD, INTUNE,
+   * KANDJI, etc.). Null when the device is not currently MDM-managed (typical for
+   * unenrolled or recently-reset devices).
+   */
+  mdm_provider?:
+    | 'RIPPLING'
+    | 'JUMPCLOUD'
+    | 'JAMFCLOUD'
+    | 'FLEETSMITH'
+    | 'HEXNODE'
+    | 'MICROMDM'
+    | 'MERAKI'
+    | 'SOTI'
+    | 'ADDIGY'
+    | 'FLEETDM'
+    | 'KANDJI'
+    | 'ZOHO'
+    | 'INTUNE'
+    | 'OTHER';
+
+  /**
+   * The device hardware model identifier as reported by MDM (e.g. 'MacBookPro18,3',
+   * 'iPhone15,2').
+   */
+  model?: string;
+
+  /**
+   * The device operating system name.
+   */
+  os_name?: string;
+
+  /**
+   * The device operating system version.
+   */
+  os_version?: string;
+
+  /**
+   * Actions currently queued against the device (not yet completed). Expandable.
+   *
+   * Expandable field
+   */
+  pending_actions?: Array<DeviceRetrieveResponse.PendingAction>;
+
+  /**
+   * The IDs of actions currently queued against the device (not yet completed).
+   */
+  pending_actions_id?: Array<string>;
+
+  /**
+   * The OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS.
+   */
+  platform?: 'MACOS' | 'WINDOWS' | 'IOS' | 'IPADOS';
+
+  /**
+   * The device's hardware serial number.
+   */
+  serial_number?: string;
+
+  /**
+   * The worker this device is currently assigned to.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The ID of the worker this device is currently assigned to. Null if unassigned.
+   */
+  worker_id?: string;
+}
+
+export namespace DeviceRetrieveResponse {
+  export interface PendingAction {
+    /**
+     * Identifier field
+     */
+    id: string;
+
+    /**
+     * Record creation date
+     */
+    created_at: string;
+
+    /**
+     * Record update date
+     */
+    updated_at: string;
+
+    /**
+     * The type of the pending device action (e.g. LOCK_DEVICE, RESET_PASSWORD).
+     */
+    action_type?:
+      | 'ADD_USER_TO_FILEVAULT'
+      | 'ASSIGN_DEVICE'
+      | 'AUTHENTICATE_AGENT'
+      | 'CHANGE_FILEVAULT_RECOVERY_KEY'
+      | 'CHANGE_PASSWORD'
+      | 'CLEAR_PASSCODE'
+      | 'CREATE_RIPPLING_ADMIN'
+      | 'DELETE_LOCAL_ACCOUNT'
+      | 'DEMOTE_ACCOUNT_PERMISSION'
+      | 'DISABLE_FIND_MY'
+      | 'DISABLE_LOST_MODE'
+      | 'DISABLE_REMOTE_DESKTOP'
+      | 'ENABLE_LOST_MODE'
+      | 'ENABLE_REMOTE_DESKTOP'
+      | 'ENFORCE_PASSWORD_POLICY'
+      | 'FORCE_CHECK_IN'
+      | 'FULL_WIPE'
+      | 'GRANT_SECURE_TOKEN'
+      | 'INSTALL_ENROLLMENT_PROFILE'
+      | 'LOCK_DEVICE'
+      | 'LOCK_USER_ACCOUNT'
+      | 'LOST_MODE_GET_LOCATION'
+      | 'LOST_MODE_PLAY_SOUND'
+      | 'PROMOTE_ACCOUNT_PERMISSION'
+      | 'RECOVER_AGENT_VIA_MDM'
+      | 'REINSTALL_AGENT'
+      | 'REINSTALL_ENROLLMENT_PROFILE'
+      | 'REMOVE_OTHER_ENROLLMENT_PROFILES'
+      | 'RESET_PASSWORD'
+      | 'RESTART_DEVICE'
+      | 'ROTATE_FILEVAULT_KEY'
+      | 'SHUTDOWN_DEVICE'
+      | 'SOFT_WIPE'
+      | 'TURN_ON_FILEVAULT'
+      | 'UNASSIGN_DEVICE'
+      | 'UNINSTALL_AGENT'
+      | 'UNINSTALL_ANTIVIRUS'
+      | 'UNINSTALL_MDM'
+      | 'UNLOCK_DEVICE'
+      | 'UNLOCK_USER_ACCOUNT'
+      | 'UPDATE_OS'
+      | 'UNKNOWN';
+
+    /**
+     * When the action was queued.
+     */
+    queued_at?: string;
+
+    /**
+     * The current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION).
+     */
+    state?: string;
+  }
+}
+
+export interface DeviceListParams {
+  cursor?: string;
+
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface DeviceRetrieveParams {
+  expand?: string;
+}
+
+export declare namespace Devices {
+  export {
+    type DeviceListResponse as DeviceListResponse,
+    type DeviceRetrieveResponse as DeviceRetrieveResponse,
+    type DeviceListResponsesPageCursorURL as DeviceListResponsesPageCursorURL,
+    type DeviceListParams as DeviceListParams,
+    type DeviceRetrieveParams as DeviceRetrieveParams,
+  };
+}

package/src/resources/functions/deployments.ts

@@ -112,6 +112,11 @@ export interface FunctionDeployment {
    */
   function_version_id?: string;
 
+  /**
+   * Input and output JSON Schema contracts for the deployment
+   */
+  io_contract?: unknown;
+
   /**
    * Additional, runtime-specific options for the deployment
    */
@@ -181,6 +186,11 @@ export interface DeploymentCreateParams {
    */
   dependencies?: unknown;
 
+  /**
+   * Input and output JSON Schema contracts for the deployment
+   */
+  io_contract?: unknown;
+
   /**
    * Additional, runtime-specific options for the deployment
    */

package/src/resources/index.ts

@@ -1,6 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
+export {
+  AppUsers,
+  type AppUserListResponse,
+  type AppUserRetrieveResponse,
+  type AppUserListParams,
+  type AppUserRetrieveParams,
+  type AppUserListResponsesPageCursorURL,
+} from './app-users';
 export {
   BreakPolicies,
   type BreakPolicyListResponse,
@@ -148,6 +156,14 @@ export {
   type DeviceOrderRetrieveParams,
   type DeviceOrderListResponsesPageCursorURL,
 } from './device-orders';
+export {
+  Devices,
+  type DeviceListResponse,
+  type DeviceRetrieveResponse,
+  type DeviceListParams,
+  type DeviceRetrieveParams,
+  type DeviceListResponsesPageCursorURL,
+} from './devices';
 export { DraftHires, type DraftHireCreateResponse, type DraftHireCreateParams } from './draft-hires';
 export {
   EarningTypes,
@@ -519,19 +535,6 @@ export {
   type WorkLocationUpdateParams,
   type WorkLocationsPageCursorURL,
 } from './work-locations';
-export {
-  WorkerChangeFields,
-  type WorkerChangeFieldListResponse,
-  type WorkerChangeFieldListResponsesPageCursorURL,
-} from './worker-change-fields';
-export {
-  WorkerChanges,
-  type WorkerChangeListResponse,
-  type WorkerChangeRetrieveResponse,
-  type WorkerChangeListParams,
-  type WorkerChangeRetrieveParams,
-  type WorkerChangeListResponsesPageCursorURL,
-} from './worker-changes';
 export {
   WorkerTimeSplits,
   type WorkerTimeSplitListResponse,

package/src/resources/workers.ts

@@ -822,6 +822,11 @@ export namespace Worker {
      */
     ca?: CountryFields.Ca;
 
+    /**
+     * Country-wise regional fields for New Zealand
+     */
+    nz?: CountryFields.Nz;
+
     /**
      * Country-wise regional fields for USA
      */
@@ -839,6 +844,16 @@ export namespace Worker {
       sin?: string;
     }
 
+    /**
+     * Country-wise regional fields for New Zealand
+     */
+    export interface Nz {
+      /**
+       * Inland Revenue Department (IRD) number for New Zealand employees.
+       */
+      ird_number?: string;
+    }
+
     /**
      * Country-wise regional fields for USA
      */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.62'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.64'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.62";
+export declare const VERSION = "0.2.0-alpha.64";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.62";
+export declare const VERSION = "0.2.0-alpha.64";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0-alpha.62'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.64'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0-alpha.62'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.64'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/resources/worker-change-fields.d.mts

@@ -1,45 +0,0 @@
-import { APIResource } from "../core/resource.mjs";
-import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
-import { RequestOptions } from "../internal/request-options.mjs";
-/**
- * Historical changes to worker data over time
- */
-export declare class WorkerChangeFields extends APIResource {
-    /**
-     * A list of worker change fields.
-     *
-     * - Requires: `API Tier 2`
-     */
-    list(options?: RequestOptions): PagePromise<WorkerChangeFieldListResponsesPageCursorURL, WorkerChangeFieldListResponse>;
-}
-export type WorkerChangeFieldListResponsesPageCursorURL = PageCursorURL<WorkerChangeFieldListResponse>;
-export interface WorkerChangeFieldListResponse {
-    /**
-     * High-level grouping for the field.
-     */
-    category: 'PERSONAL' | 'JOB' | 'COMPENSATION' | 'BENEFITS' | 'CUSTOM' | 'COUNTRY_SPECIFIC';
-    /**
-     * UI label for the field (English).
-     */
-    field_display_name: string;
-    /**
-     * Field key in snake_case. Use directly in ?filter=field_key eq '...' on GET
-     * /worker-changes. Naming convention: public DTO fields use the DTO field name
-     * verbatim (work_email, title); nested fields use dot notation
-     * (compensation.base_salary); custom fields use custom_fields.<custom_field_id>;
-     * country-specific fields use the ISO country prefix (us.eeo.race). Filter
-     * semantics: filtering GET /worker-changes by field_key returns events that
-     * contain at least one change to this field, but the changes[] array on those
-     * events is NOT pruned — consumers receive the full event payload including
-     * changes to other fields.
-     */
-    field_key: string;
-    /**
-     * Value type of the field.
-     */
-    value_type: 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'CURRENCY' | 'ENUM' | 'REFERENCE';
-}
-export declare namespace WorkerChangeFields {
-    export { type WorkerChangeFieldListResponse as WorkerChangeFieldListResponse, type WorkerChangeFieldListResponsesPageCursorURL as WorkerChangeFieldListResponsesPageCursorURL, };
-}
-//# sourceMappingURL=worker-change-fields.d.mts.map

package/resources/worker-change-fields.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"worker-change-fields.d.mts","sourceRoot":"","sources":["../src/resources/worker-change-fields.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;IACjD;;;;OAIG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2CAA2C,EAAE,6BAA6B,CAAC;CAO3F;AAED,MAAM,MAAM,2CAA2C,GAAG,aAAa,CAAC,6BAA6B,CAAC,CAAC;AAEvG,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,EAAE,UAAU,GAAG,KAAK,GAAG,cAAc,GAAG,UAAU,GAAG,QAAQ,GAAG,kBAAkB,CAAC;IAE3F;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;OAUG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,WAAW,CAAC;CACvG;AAED,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2CAA2C,IAAI,2CAA2C,GAChG,CAAC;CACH"}