@rippling/rippling-sdk 0.2.0-alpha.61 → 0.2.0-alpha.63

package/src/client.ts

@@ -19,6 +19,14 @@ 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 {
+  AppUserListParams,
+  AppUserListResponse,
+  AppUserListResponsesPageCursorURL,
+  AppUserRetrieveParams,
+  AppUserRetrieveResponse,
+  AppUsers,
+} from './resources/app-users';
 import {
   BreakPolicies,
   BreakPolicyListParams,
@@ -151,6 +159,22 @@ import {
   Departments,
   DepartmentsPageCursorURL,
 } from './resources/departments';
+import {
+  DeviceOrderListParams,
+  DeviceOrderListResponse,
+  DeviceOrderListResponsesPageCursorURL,
+  DeviceOrderRetrieveParams,
+  DeviceOrderRetrieveResponse,
+  DeviceOrders,
+} from './resources/device-orders';
+import {
+  DeviceListParams,
+  DeviceListResponse,
+  DeviceListResponsesPageCursorURL,
+  DeviceRetrieveParams,
+  DeviceRetrieveResponse,
+  Devices,
+} from './resources/devices';
 import { DraftHireCreateParams, DraftHireCreateResponse, DraftHires } from './resources/draft-hires';
 import {
   EarningTypeListResponse,
@@ -1426,6 +1450,10 @@ export class RipplingSDK {
    * Job related information for the company
    */
   jobPayRateExceptions: API.JobPayRateExceptions = new API.JobPayRateExceptions(this);
+  /**
+   * Mappings between Rippling workers and their user accounts in third-party apps
+   */
+  appUsers: API.AppUsers = new API.AppUsers(this);
   /**
    * Break types configured by the company for time tracking
    */
@@ -1465,6 +1493,14 @@ export class RipplingSDK {
   customFields: API.CustomFields = new API.CustomFields(this);
   customPages: API.CustomPages = new API.CustomPages(this);
   customSettings: API.CustomSettings = new API.CustomSettings(this);
+  /**
+   * Devices (laptops, desktops, phones, tablets) managed by Rippling
+   */
+  devices: API.Devices = new API.Devices(this);
+  /**
+   * Device orders (new device shipments, retrievals, etc.) for company workers
+   */
+  deviceOrders: API.DeviceOrders = new API.DeviceOrders(this);
   /**
    * Candidates who have not yet started work at the company
    */
@@ -1609,6 +1645,7 @@ RipplingSDK.BusinessPartnerGroups = BusinessPartnerGroups;
 RipplingSDK.Functions = Functions;
 RipplingSDK.JobAssignments = JobAssignments;
 RipplingSDK.JobPayRateExceptions = JobPayRateExceptions;
+RipplingSDK.AppUsers = AppUsers;
 RipplingSDK.BreakPolicies = BreakPolicies;
 RipplingSDK.BreakTypes = BreakTypes;
 RipplingSDK.BusinessStructurePaths = BusinessStructurePaths;
@@ -1621,6 +1658,8 @@ RipplingSDK.CustomApps = CustomApps;
 RipplingSDK.CustomFields = CustomFields;
 RipplingSDK.CustomPages = CustomPages;
 RipplingSDK.CustomSettings = CustomSettings;
+RipplingSDK.Devices = Devices;
+RipplingSDK.DeviceOrders = DeviceOrders;
 RipplingSDK.DraftHires = DraftHires;
 RipplingSDK.EarningTypes = EarningTypes;
 RipplingSDK.EarningsInputs = EarningsInputs;
@@ -1950,6 +1989,15 @@ export declare namespace RipplingSDK {
     type JobPayRateExceptionListChangeLogParams as JobPayRateExceptionListChangeLogParams,
   };
 
+  export {
+    AppUsers as AppUsers,
+    type AppUserListResponse as AppUserListResponse,
+    type AppUserRetrieveResponse as AppUserRetrieveResponse,
+    type AppUserListResponsesPageCursorURL as AppUserListResponsesPageCursorURL,
+    type AppUserListParams as AppUserListParams,
+    type AppUserRetrieveParams as AppUserRetrieveParams,
+  };
+
   export {
     BreakPolicies as BreakPolicies,
     type BreakPolicyListResponse as BreakPolicyListResponse,
@@ -2056,6 +2104,24 @@ export declare namespace RipplingSDK {
     type CustomSettingUpdateParams as CustomSettingUpdateParams,
   };
 
+  export {
+    Devices as Devices,
+    type DeviceListResponse as DeviceListResponse,
+    type DeviceRetrieveResponse as DeviceRetrieveResponse,
+    type DeviceListResponsesPageCursorURL as DeviceListResponsesPageCursorURL,
+    type DeviceListParams as DeviceListParams,
+    type DeviceRetrieveParams as DeviceRetrieveParams,
+  };
+
+  export {
+    DeviceOrders as DeviceOrders,
+    type DeviceOrderListResponse as DeviceOrderListResponse,
+    type DeviceOrderRetrieveResponse as DeviceOrderRetrieveResponse,
+    type DeviceOrderListResponsesPageCursorURL as DeviceOrderListResponsesPageCursorURL,
+    type DeviceOrderListParams as DeviceOrderListParams,
+    type DeviceOrderRetrieveParams as DeviceOrderRetrieveParams,
+  };
+
   export {
     DraftHires as DraftHires,
     type DraftHireCreateResponse as DraftHireCreateResponse,

package/src/lib/manifest/custom-object-page-layout.ts

@@ -108,8 +108,6 @@ interface SerializedHeaderEdits
 
 export type SectionFieldsLayout = 'one_column' | 'two_column' | 'three_column' | 'responsive';
 export type TabLayout = 'vertical' | 'horizontal';
-export type SectionMovementOption = 'static' | 'tab' | 'free';
-export type FieldMovementOption = 'tab' | 'free';
 export type CustomObjectCustomSectionComponentKey = 'attachments' | 'comments';
 
 /** Default value wrapper used by `SectionField.defaultValue`. */
@@ -131,8 +129,6 @@ export interface SectionFieldOptions {
   height?: number;
   /** Whether the layout manager can remove this field. Optional. */
   canBeDeleted?: boolean;
-  /** Controls how the field can be moved in the UI. Optional. */
-  movementOption?: FieldMovementOption;
 }
 
 /** A typed field entry inside a `fields_section`. */
@@ -153,8 +149,6 @@ export interface PageLayoutSectionOptions {
   canBeDeleted?: boolean;
   /** Whether the layout manager can rename this section. Optional. */
   canBeRenamed?: boolean;
-  /** Controls how the section can be moved. Optional. */
-  movementOption?: SectionMovementOption;
   /** Hide the section title. Optional. */
   hideName?: boolean;
 }
@@ -755,7 +749,6 @@ function toSerializedSectionField(
   if (options.defaultValue != null) normalized.defaultValue = options.defaultValue;
   if (options.height != null) normalized.height = options.height;
   if (options.canBeDeleted != null) normalized.canBeDeleted = options.canBeDeleted;
-  if (options.movementOption != null) normalized.movementOption = options.movementOption;
   return normalized;
 }
 
@@ -765,7 +758,6 @@ function copySectionOptions<T extends PageLayoutSectionOptions>(
 ): T {
   if (input.canBeDeleted != null) target.canBeDeleted = input.canBeDeleted;
   if (input.canBeRenamed != null) target.canBeRenamed = input.canBeRenamed;
-  if (input.movementOption != null) target.movementOption = input.movementOption;
   if (input.hideName != null) target.hideName = input.hideName;
   return target;
 }
@@ -892,6 +884,17 @@ function cloneJson<T>(value: T): T {
   return JSON.parse(JSON.stringify(value)) as T;
 }
 
+function stripMovementOptions(value: unknown): void {
+  if (Array.isArray(value)) {
+    for (const item of value) stripMovementOptions(item);
+    return;
+  }
+  if (value == null || typeof value !== 'object') return;
+  const record = value as Record<string, unknown>;
+  delete record['movementOption'];
+  for (const item of Object.values(record)) stripMovementOptions(item);
+}
+
 const HEADER_EDIT_KEYS = new Set([
   'newTitleField',
   'titleFieldDeleted',
@@ -2275,6 +2278,8 @@ export class CustomObjectPageLayout {
    * @returns A plain object with `type: 'CUSTOM_OBJECT_PAGE_LAYOUT'`.
    */
   toDict(): Record<string, any> {
+    const tabEdits = cloneJson(this._tabEdits);
+    stripMovementOptions(tabEdits);
     const d: Record<string, any> = {
       type: CustomObjectPageLayout.componentType,
       layout_id: this._layoutId,
@@ -2283,7 +2288,7 @@ export class CustomObjectPageLayout {
       name: this._name,
       // Packaged layouts are never system-created (backend invariant).
       system_created: false,
-      tab_edits: this._tabEdits,
+      tab_edits: tabEdits,
       header_edits: this._headerEdits,
       visibility_conditions: this._visibilityConditions,
       blueprint_key: this._blueprintKey ?? this._customObjectApiName,

package/src/lib/manifest/index.ts

@@ -52,7 +52,6 @@ export {
   type CustomObjectPageLayoutProps,
   type CustomSection,
   type CustomTab,
-  type FieldMovementOption,
   type FieldRqlName,
   type FieldsSection,
   type HeaderEdits,
@@ -86,7 +85,6 @@ export {
   type SectionFieldRef,
   type SectionFieldsLayout,
   type SectionKey,
-  type SectionMovementOption,
   type SystemHeaderFieldEdit,
   type SystemSectionEdit,
   type SystemTabEdit,

package/src/resources/app-users.ts

@@ -0,0 +1,270 @@
+// 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';
+
+/**
+ * Mappings between Rippling workers and their user accounts in third-party apps
+ */
+export class AppUsers extends APIResource {
+  /**
+   * A list of app users.
+   *
+   * - Requires: `API Tier 1`
+   * - Filterable fields: `worker_id`, `spoke_user_identifier`, `app_handle`,
+   *   `created_at`, `updated_at`
+   * - Expandable fields: `worker`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: AppUserListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AppUserListResponsesPageCursorURL, AppUserListResponse> {
+    return this._client.getAPIList('/app-users/', PageCursorURL<AppUserListResponse>, { query, ...options });
+  }
+
+  /**
+   * Retrieve a specific app user
+   */
+  retrieve(
+    id: string,
+    query: AppUserRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AppUserRetrieveResponse> {
+    return this._client.get(path`/app-users/${id}/`, { query, ...options });
+  }
+}
+
+export type AppUserListResponsesPageCursorURL = PageCursorURL<AppUserListResponse>;
+
+/**
+ * Maps a Rippling worker (if any) to their user account in a third-party
+ *     app (e.g. Slack, Jira, GitHub). Sourced from SpokeUser records.
+ *
+ *     Includes orphan accounts — third-party app accounts with no matching
+ *     Rippling worker (`worker_id=None`, `match_state=NOT_MATCHED`). These are
+ *     the primary signal for IT-admin triage. Uses `BaseResourceDTO` rather
+ *     than `BaseEmployeeResourceDTO` so the platform's role-based auto-filter
+ *     does not silently drop orphans for non-admin tokens. Company scoping is
+ *     enforced explicitly in `AppUsersAPIViewSet.get_queryset`; the `app-users.read`
+ *     scope is the access gate.
+ *
+ *     Resource name aligns with how the product surfaces these in the UI
+ *     ("Slack account", "GitHub account") and matches the equivalent concept
+ *     in Okta's IAM API (AppUser).
+ *
+ *     Designed for point lookups: list endpoint requires at least one filter
+ *     on `worker_id` or `spoke_user_identifier` to prevent bulk enumeration of the
+ *     org's identity graph across connected apps.
+ *
+ *     `spoke_user_identifier` reads `SpokeUser.spokeId` — the user identifier
+ *     stored for the third-party account. Depending on the integration, this may
+ *     be an email, username, account handle, or app-specific user id.
+ */
+export interface AppUserListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Human-readable display name for the third-party app (e.g. 'Slack', 'GitHub').
+   * Sourced from the customer-configured SpokeOwner.app_display_name; falls back to
+   * a title-cased app handle when the customer hasn't set one.
+   */
+  app_display_name?: string;
+
+  /**
+   * Machine-readable identifier for the third-party app (e.g. 'slack', 'jira',
+   * 'asana'). Stable across the App Shop catalog.
+   */
+  app_handle?: string;
+
+  /**
+   * The user's email address in the third-party app, if known. Null when the app
+   * does not expose an email or Rippling did not capture one.
+   */
+  external_email?: string;
+
+  /**
+   * The user's display name in the third-party app, if known. Null when the app does
+   * not surface a separate username.
+   */
+  external_username?: string;
+
+  /**
+   * Whether this third-party account has been matched to a Rippling worker.
+   */
+  match_state?: 'MATCHED' | 'NOT_MATCHED' | 'IGNORED';
+
+  /**
+   * Provisioning lifecycle state of this account in the third-party app.
+   */
+  push_state?:
+    | 'INIT'
+    | 'EMPLOYEE_CONFIRMATION_PENDING'
+    | 'EMPLOYEE_CONFIRMATION_ACCEPTED'
+    | 'EMPLOYEE_CONFIRMATION_REJECTED'
+    | 'INVITE_PENDING'
+    | 'INVITE_CONFIRMED'
+    | 'INVITE_FAILED'
+    | 'CREATE_PENDING'
+    | 'CREATE_CONFIRMED'
+    | 'CREATE_FAILED'
+    | 'DELETE_PENDING'
+    | 'DELETE_CONFIRMED'
+    | 'DELETE_FAILED'
+    | 'SUSPEND_PENDING'
+    | 'SUSPEND_CONFIRMED'
+    | 'SUSPEND_FAILED';
+
+  /**
+   * Identifier for the user's account in the third-party app workspace. Depending on
+   * the integration, this may be an email, username, account handle, or app-specific
+   * user id.
+   */
+  spoke_user_identifier?: string;
+
+  /**
+   * The Rippling worker associated with this external app account. Expanding this
+   * field requires both `app-users.read` and `workers.read` scopes.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * ID of the Rippling worker associated with this external app account.
+   */
+  worker_id?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface AppUserRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Human-readable display name for the third-party app (e.g. 'Slack', 'GitHub').
+   * Sourced from the customer-configured SpokeOwner.app_display_name; falls back to
+   * a title-cased app handle when the customer hasn't set one.
+   */
+  app_display_name?: string;
+
+  /**
+   * Machine-readable identifier for the third-party app (e.g. 'slack', 'jira',
+   * 'asana'). Stable across the App Shop catalog.
+   */
+  app_handle?: string;
+
+  /**
+   * The user's email address in the third-party app, if known. Null when the app
+   * does not expose an email or Rippling did not capture one.
+   */
+  external_email?: string;
+
+  /**
+   * The user's display name in the third-party app, if known. Null when the app does
+   * not surface a separate username.
+   */
+  external_username?: string;
+
+  /**
+   * Whether this third-party account has been matched to a Rippling worker.
+   */
+  match_state?: 'MATCHED' | 'NOT_MATCHED' | 'IGNORED';
+
+  /**
+   * Provisioning lifecycle state of this account in the third-party app.
+   */
+  push_state?:
+    | 'INIT'
+    | 'EMPLOYEE_CONFIRMATION_PENDING'
+    | 'EMPLOYEE_CONFIRMATION_ACCEPTED'
+    | 'EMPLOYEE_CONFIRMATION_REJECTED'
+    | 'INVITE_PENDING'
+    | 'INVITE_CONFIRMED'
+    | 'INVITE_FAILED'
+    | 'CREATE_PENDING'
+    | 'CREATE_CONFIRMED'
+    | 'CREATE_FAILED'
+    | 'DELETE_PENDING'
+    | 'DELETE_CONFIRMED'
+    | 'DELETE_FAILED'
+    | 'SUSPEND_PENDING'
+    | 'SUSPEND_CONFIRMED'
+    | 'SUSPEND_FAILED';
+
+  /**
+   * Identifier for the user's account in the third-party app workspace. Depending on
+   * the integration, this may be an email, username, account handle, or app-specific
+   * user id.
+   */
+  spoke_user_identifier?: string;
+
+  /**
+   * The Rippling worker associated with this external app account. Expanding this
+   * field requires both `app-users.read` and `workers.read` scopes.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * ID of the Rippling worker associated with this external app account.
+   */
+  worker_id?: string;
+}
+
+export interface AppUserListParams {
+  cursor?: string;
+
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface AppUserRetrieveParams {
+  expand?: string;
+}
+
+export declare namespace AppUsers {
+  export {
+    type AppUserListResponse as AppUserListResponse,
+    type AppUserRetrieveResponse as AppUserRetrieveResponse,
+    type AppUserListResponsesPageCursorURL as AppUserListResponsesPageCursorURL,
+    type AppUserListParams as AppUserListParams,
+    type AppUserRetrieveParams as AppUserRetrieveParams,
+  };
+}

package/src/resources/device-orders.ts

@@ -0,0 +1,200 @@
+// 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';
+
+/**
+ * Device orders (new device shipments, retrievals, etc.) for company workers
+ */
+export class DeviceOrders extends APIResource {
+  /**
+   * A list of device orders.
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `worker_id`, `status`
+   * - Expandable fields: `worker`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: DeviceOrderListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DeviceOrderListResponsesPageCursorURL, DeviceOrderListResponse> {
+    return this._client.getAPIList('/device-orders/', PageCursorURL<DeviceOrderListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific device order
+   */
+  retrieve(
+    id: string,
+    query: DeviceOrderRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DeviceOrderRetrieveResponse> {
+    return this._client.get(path`/device-orders/${id}/`, { query, ...options });
+  }
+}
+
+export type DeviceOrderListResponsesPageCursorURL = PageCursorURL<DeviceOrderListResponse>;
+
+export interface DeviceOrderListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * True when a cancellation has been requested but not yet completed.
+   */
+  cancel_requested?: boolean;
+
+  /**
+   * When the order reached a terminal state (COMPLETED, FAILED, or CANCELED).
+   */
+  completed_at?: string;
+
+  /**
+   * The type of hardware order, as reported by the underlying inventory order (for
+   * example: New Device Order, Warehouse Return, Warehouse Order, Add Existing
+   * Device, Assign Device, Empty Order, or Sell Device).
+   */
+  order_type?: string;
+
+  /**
+   * The ID of the role that requested the order (often an IT admin). Null if
+   * system-created.
+   */
+  requested_by_id?: string;
+
+  /**
+   * The order lifecycle state (InventoryFlowState): CREATED, RUNNING, COMPLETED,
+   * FAILED, CANCELING, CANCELED.
+   */
+  status?: string;
+
+  /**
+   * The warehouse / vendor provider servicing the order (e.g. CDW, INGRAMMICRO,
+   * TD_SYNNEX, GROWRK).
+   */
+  warehouse_provider?: string;
+
+  /**
+   * The worker the order is for.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The ID of the worker the order is for (the recipient). Null if unassigned.
+   */
+  worker_id?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface DeviceOrderRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * True when a cancellation has been requested but not yet completed.
+   */
+  cancel_requested?: boolean;
+
+  /**
+   * When the order reached a terminal state (COMPLETED, FAILED, or CANCELED).
+   */
+  completed_at?: string;
+
+  /**
+   * The type of hardware order, as reported by the underlying inventory order (for
+   * example: New Device Order, Warehouse Return, Warehouse Order, Add Existing
+   * Device, Assign Device, Empty Order, or Sell Device).
+   */
+  order_type?: string;
+
+  /**
+   * The ID of the role that requested the order (often an IT admin). Null if
+   * system-created.
+   */
+  requested_by_id?: string;
+
+  /**
+   * The order lifecycle state (InventoryFlowState): CREATED, RUNNING, COMPLETED,
+   * FAILED, CANCELING, CANCELED.
+   */
+  status?: string;
+
+  /**
+   * The warehouse / vendor provider servicing the order (e.g. CDW, INGRAMMICRO,
+   * TD_SYNNEX, GROWRK).
+   */
+  warehouse_provider?: string;
+
+  /**
+   * The worker the order is for.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The ID of the worker the order is for (the recipient). Null if unassigned.
+   */
+  worker_id?: string;
+}
+
+export interface DeviceOrderListParams {
+  cursor?: string;
+
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface DeviceOrderRetrieveParams {
+  expand?: string;
+}
+
+export declare namespace DeviceOrders {
+  export {
+    type DeviceOrderListResponse as DeviceOrderListResponse,
+    type DeviceOrderRetrieveResponse as DeviceOrderRetrieveResponse,
+    type DeviceOrderListResponsesPageCursorURL as DeviceOrderListResponsesPageCursorURL,
+    type DeviceOrderListParams as DeviceOrderListParams,
+    type DeviceOrderRetrieveParams as DeviceOrderRetrieveParams,
+  };
+}