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

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,
+  };
+}

package/src/resources/index.ts

@@ -140,6 +140,14 @@ export {
   type DepartmentUpdateParams,
   type DepartmentsPageCursorURL,
 } from './departments';
+export {
+  DeviceOrders,
+  type DeviceOrderListResponse,
+  type DeviceOrderRetrieveResponse,
+  type DeviceOrderListParams,
+  type DeviceOrderRetrieveParams,
+  type DeviceOrderListResponsesPageCursorURL,
+} from './device-orders';
 export { DraftHires, type DraftHireCreateResponse, type DraftHireCreateParams } from './draft-hires';
 export {
   EarningTypes,

package/src/resources/job-assignments.ts

@@ -256,7 +256,8 @@ export interface JobAssignmentCreateParams {
 
   /**
    * Date and time the change becomes effective (ISO 8601 format, e.g.,
-   * 2025-11-07T17:00:00.000+00:00).
+   * 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided.
+   * job_pay_rate_effective_from is ignored if this field is provided.
    */
   effective_from?: string;
 
@@ -267,15 +268,14 @@ export interface JobAssignmentCreateParams {
   job_pay_rate?: number;
 
   /**
-   * Reason for setting, updating, or resetting the pay rate for the job assigned to
-   * the worker.
+   * This field is deprecated and will be removed in a future version, use the new
+   * change_reason field instead.
    */
   job_pay_rate_change_reason?: string;
 
   /**
-   * Date and time the pay rate becomes effective (ISO 8601 format
-   * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
-   * current time in UTC if not provided.
+   * This field is deprecated and will be removed in a future version, use the new
+   * effective_from field instead.
    */
   job_pay_rate_effective_from?: string;
 }
@@ -302,7 +302,8 @@ export interface JobAssignmentUpdateParams {
 
   /**
    * Date and time the change becomes effective (ISO 8601 format, e.g.,
-   * 2025-11-07T17:00:00.000+00:00).
+   * 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided.
+   * job_pay_rate_effective_from is ignored if this field is provided.
    */
   effective_from?: string;
 
@@ -313,15 +314,14 @@ export interface JobAssignmentUpdateParams {
   job_pay_rate?: number;
 
   /**
-   * Reason for setting, updating, or resetting the pay rate for the job assigned to
-   * the worker.
+   * This field is deprecated and will be removed in a future version, use the new
+   * change_reason field instead.
    */
   job_pay_rate_change_reason?: string;
 
   /**
-   * Date and time the pay rate becomes effective (ISO 8601 format
-   * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
-   * current time in UTC if not provided.
+   * This field is deprecated and will be removed in a future version, use the new
+   * effective_from field instead.
    */
   job_pay_rate_effective_from?: string;
 }

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.60";
+export declare const VERSION = "0.2.0-alpha.62";
 //# 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.60'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.62'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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