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

package/resources/app-users.d.ts

@@ -0,0 +1,186 @@
+import { APIResource } from "../core/resource.js";
+import * as BusinessPartnersAPI from "./business-partners.js";
+import * as WorkersAPI from "./workers.js";
+import { APIPromise } from "../core/api-promise.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Mappings between Rippling workers and their user accounts in third-party apps
+ */
+export declare 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>;
+    /**
+     * Retrieve a specific app user
+     */
+    retrieve(id: string, query?: AppUserRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<AppUserRetrieveResponse>;
+}
+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, };
+}
+//# sourceMappingURL=app-users.d.ts.map

package/resources/app-users.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-users.d.ts","sourceRoot":"","sources":["../src/resources/app-users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,mBAAmB,CAAC;IAItE;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC;AAEnF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,UAAU,CAAC,EACP,MAAM,GACN,+BAA+B,GAC/B,gCAAgC,GAChC,gCAAgC,GAChC,gBAAgB,GAChB,kBAAkB,GAClB,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,eAAe,GACf,iBAAiB,GACjB,mBAAmB,GACnB,gBAAgB,CAAC;IAErB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB,CAAC,IAAI;IACvE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,UAAU,CAAC,EACP,MAAM,GACN,+BAA+B,GAC/B,gCAAgC,GAChC,gCAAgC,GAChC,gBAAgB,GAChB,kBAAkB,GAClB,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,eAAe,GACf,iBAAiB,GACjB,mBAAmB,GACnB,gBAAgB,CAAC;IAErB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/app-users.js

@@ -0,0 +1,32 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppUsers = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Mappings between Rippling workers and their user accounts in third-party apps
+ */
+class AppUsers extends resource_1.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 = {}, options) {
+        return this._client.getAPIList('/app-users/', (pagination_1.PageCursorURL), { query, ...options });
+    }
+    /**
+     * Retrieve a specific app user
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/app-users/${id}/`, { query, ...options });
+    }
+}
+exports.AppUsers = AppUsers;
+//# sourceMappingURL=app-users.js.map

package/resources/app-users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-users.js","sourceRoot":"","sources":["../src/resources/app-users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,0BAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AA3BD,4BA2BC"}

package/resources/app-users.mjs

@@ -0,0 +1,28 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { PageCursorURL } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * 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 = {}, options) {
+        return this._client.getAPIList('/app-users/', (PageCursorURL), { query, ...options });
+    }
+    /**
+     * Retrieve a specific app user
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get(path `/app-users/${id}/`, { query, ...options });
+    }
+}
+//# sourceMappingURL=app-users.mjs.map

package/resources/app-users.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-users.mjs","sourceRoot":"","sources":["../src/resources/app-users.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,aAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF"}

package/resources/device-orders.d.mts

@@ -0,0 +1,147 @@
+import { APIResource } from "../core/resource.mjs";
+import * as BusinessPartnersAPI from "./business-partners.mjs";
+import * as WorkersAPI from "./workers.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Device orders (new device shipments, retrievals, etc.) for company workers
+ */
+export declare 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>;
+    /**
+     * Retrieve a specific device order
+     */
+    retrieve(id: string, query?: DeviceOrderRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<DeviceOrderRetrieveResponse>;
+}
+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, };
+}
+//# sourceMappingURL=device-orders.d.mts.map

package/resources/device-orders.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-orders.d.mts","sourceRoot":"","sources":["../src/resources/device-orders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,uBAAuB,CAAC;IAO9E;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;CAG3C;AAED,MAAM,MAAM,qCAAqC,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAE3F,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB,CAAC,IAAI;IAC3E;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/device-orders.d.ts

@@ -0,0 +1,147 @@
+import { APIResource } from "../core/resource.js";
+import * as BusinessPartnersAPI from "./business-partners.js";
+import * as WorkersAPI from "./workers.js";
+import { APIPromise } from "../core/api-promise.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Device orders (new device shipments, retrievals, etc.) for company workers
+ */
+export declare 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>;
+    /**
+     * Retrieve a specific device order
+     */
+    retrieve(id: string, query?: DeviceOrderRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<DeviceOrderRetrieveResponse>;
+}
+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, };
+}
+//# sourceMappingURL=device-orders.d.ts.map

package/resources/device-orders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-orders.d.ts","sourceRoot":"","sources":["../src/resources/device-orders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,uBAAuB,CAAC;IAO9E;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;CAG3C;AAED,MAAM,MAAM,qCAAqC,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAE3F,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB,CAAC,IAAI;IAC3E;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/device-orders.js

@@ -0,0 +1,34 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceOrders = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Device orders (new device shipments, retrievals, etc.) for company workers
+ */
+class DeviceOrders extends resource_1.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 = {}, options) {
+        return this._client.getAPIList('/device-orders/', (pagination_1.PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve a specific device order
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/device-orders/${id}/`, { query, ...options });
+    }
+}
+exports.DeviceOrders = DeviceOrders;
+//# sourceMappingURL=device-orders.js.map

package/resources/device-orders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-orders.js","sourceRoot":"","sources":["../src/resources/device-orders.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;OAOG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,0BAAsC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AA7BD,oCA6BC"}

package/resources/device-orders.mjs

@@ -0,0 +1,30 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { PageCursorURL } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * 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 = {}, options) {
+        return this._client.getAPIList('/device-orders/', (PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve a specific device order
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get(path `/device-orders/${id}/`, { query, ...options });
+    }
+}
+//# sourceMappingURL=device-orders.mjs.map

package/resources/device-orders.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-orders.mjs","sourceRoot":"","sources":["../src/resources/device-orders.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;OAOG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,aAAsC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF"}