@rippling/rippling-sdk 0.2.0-alpha.100

package/resources/agents/source-revisions.d.ts

@@ -0,0 +1,195 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { PageCursorURL, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Agents defined by the company
+ */
+export declare class SourceRevisions extends APIResource {
+    /**
+     * A list of source revisions for an agent.
+     */
+    list(agentID: string, query?: SourceRevisionListParams | null | undefined, options?: RequestOptions): PagePromise<SourceRevisionListResponsesPageCursorURL, SourceRevisionListResponse>;
+    /**
+     * Create a source revision for an agent.
+     */
+    create(agentID: string, body: SourceRevisionCreateParams, options?: RequestOptions): APIPromise<SourceRevisionCreateResponse>;
+    /**
+     * Retrieve a source revision for an agent.
+     */
+    retrieve(agentID: string, sourceRevisionID: string, options?: RequestOptions): APIPromise<SourceRevisionRetrieveResponse>;
+}
+export type SourceRevisionListResponsesPageCursorURL = PageCursorURL<SourceRevisionListResponse>;
+/**
+ * List representation of an agent source revision without source contents.
+ */
+export interface SourceRevisionListResponse {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * Skill IDs used by the agent
+     */
+    skill_ids?: Array<string>;
+    /**
+     * The digest of the source revision
+     */
+    source_digest?: string;
+    /**
+     * The version number of the source revision
+     */
+    version?: number;
+}
+export interface SourceRevisionCreateResponse {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * The entrypoint file
+     */
+    entrypoint: string;
+    /**
+     * The files in the source revision
+     */
+    files: Array<SourceRevisionCreateResponse.File>;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * Skill IDs used by the agent
+     */
+    skill_ids?: Array<string>;
+    /**
+     * The digest of the source revision
+     */
+    source_digest?: string;
+    /**
+     * The version number of the source revision
+     */
+    version?: number;
+}
+export declare namespace SourceRevisionCreateResponse {
+    interface File {
+        /**
+         * The contents of the source file
+         */
+        content: string;
+        /**
+         * The source file language or format
+         */
+        kind: string;
+        /**
+         * The path of the source file
+         */
+        path: string;
+    }
+}
+export interface SourceRevisionRetrieveResponse {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * The entrypoint file
+     */
+    entrypoint: string;
+    /**
+     * The files in the source revision
+     */
+    files: Array<SourceRevisionRetrieveResponse.File>;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * Skill IDs used by the agent
+     */
+    skill_ids?: Array<string>;
+    /**
+     * The digest of the source revision
+     */
+    source_digest?: string;
+    /**
+     * The version number of the source revision
+     */
+    version?: number;
+}
+export declare namespace SourceRevisionRetrieveResponse {
+    interface File {
+        /**
+         * The contents of the source file
+         */
+        content: string;
+        /**
+         * The source file language or format
+         */
+        kind: string;
+        /**
+         * The path of the source file
+         */
+        path: string;
+    }
+}
+export interface SourceRevisionListParams {
+    /**
+     * The cursor from a previous next_link.
+     */
+    cursor?: string;
+    /**
+     * The maximum number of results to return.
+     */
+    limit?: number;
+}
+export interface SourceRevisionCreateParams {
+    /**
+     * The entrypoint file
+     */
+    entrypoint: string;
+    /**
+     * The files in the source revision
+     */
+    files: Array<SourceRevisionCreateParams.File>;
+    /**
+     * Skill IDs used by the agent
+     */
+    skill_ids?: Array<string>;
+}
+export declare namespace SourceRevisionCreateParams {
+    interface File {
+        /**
+         * The contents of the source file
+         */
+        content: string;
+        /**
+         * The source file language or format
+         */
+        kind: string;
+        /**
+         * The path of the source file
+         */
+        path: string;
+    }
+}
+export declare namespace SourceRevisions {
+    export { type SourceRevisionListResponse as SourceRevisionListResponse, type SourceRevisionCreateResponse as SourceRevisionCreateResponse, type SourceRevisionRetrieveResponse as SourceRevisionRetrieveResponse, type SourceRevisionListResponsesPageCursorURL as SourceRevisionListResponsesPageCursorURL, type SourceRevisionListParams as SourceRevisionListParams, type SourceRevisionCreateParams as SourceRevisionCreateParams, };
+}
+//# sourceMappingURL=source-revisions.d.ts.map

package/resources/agents/source-revisions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-revisions.d.ts","sourceRoot":"","sources":["../../src/resources/agents/source-revisions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,iCAA8B;AACnE,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;OAEG;IACH,IAAI,CACF,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,wCAAwC,EAAE,0BAA0B,CAAC;IAQpF;;OAEG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;OAEG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,MAAM,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED,MAAM,MAAM,wCAAwC,GAAG,aAAa,CAAC,0BAA0B,CAAC,CAAC;AAEjG;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAEhD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC;IAE9C;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/agents/source-revisions.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.SourceRevisions = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Agents defined by the company
+ */
+class SourceRevisions extends resource_1.APIResource {
+    /**
+     * A list of source revisions for an agent.
+     */
+    list(agentID, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/agents/${agentID}/source-revisions/`, (pagination_1.PageCursorURL), { query, ...options });
+    }
+    /**
+     * Create a source revision for an agent.
+     */
+    create(agentID, body, options) {
+        return this._client.post((0, path_1.path) `/agents/${agentID}/source-revisions/`, { body, ...options });
+    }
+    /**
+     * Retrieve a source revision for an agent.
+     */
+    retrieve(agentID, sourceRevisionID, options) {
+        return this._client.get((0, path_1.path) `/agents/${agentID}/source-revisions/${sourceRevisionID}/`, options);
+    }
+}
+exports.SourceRevisions = SourceRevisions;
+//# sourceMappingURL=source-revisions.js.map

package/resources/agents/source-revisions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-revisions.js","sourceRoot":"","sources":["../../src/resources/agents/source-revisions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAmE;AAEnE,uDAAiD;AAEjD;;GAEG;AACH,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;OAEG;IACH,IAAI,CACF,OAAe,EACf,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,WAAW,OAAO,oBAAoB,EAC1C,CAAA,0BAAyC,CAAA,EACzC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,OAAe,EACf,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,OAAe,EACf,gBAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,qBAAqB,gBAAgB,GAAG,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;CACF;AArCD,0CAqCC"}

package/resources/agents/source-revisions.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";
+/**
+ * Agents defined by the company
+ */
+export class SourceRevisions extends APIResource {
+    /**
+     * A list of source revisions for an agent.
+     */
+    list(agentID, query = {}, options) {
+        return this._client.getAPIList(path `/agents/${agentID}/source-revisions/`, (PageCursorURL), { query, ...options });
+    }
+    /**
+     * Create a source revision for an agent.
+     */
+    create(agentID, body, options) {
+        return this._client.post(path `/agents/${agentID}/source-revisions/`, { body, ...options });
+    }
+    /**
+     * Retrieve a source revision for an agent.
+     */
+    retrieve(agentID, sourceRevisionID, options) {
+        return this._client.get(path `/agents/${agentID}/source-revisions/${sourceRevisionID}/`, options);
+    }
+}
+//# sourceMappingURL=source-revisions.mjs.map

package/resources/agents/source-revisions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-revisions.mjs","sourceRoot":"","sources":["../../src/resources/agents/source-revisions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,aAAa,EAAe,kCAA8B;AAEnE,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;OAEG;IACH,IAAI,CACF,OAAe,EACf,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,WAAW,OAAO,oBAAoB,EAC1C,CAAA,aAAyC,CAAA,EACzC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,OAAe,EACf,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,WAAW,OAAO,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,OAAe,EACf,gBAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,qBAAqB,gBAAgB,GAAG,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;CACF"}

package/resources/agents.d.mts

@@ -0,0 +1,2 @@
+export * from "./agents/index.mjs";
+//# sourceMappingURL=agents.d.mts.map

package/resources/agents.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agents.d.mts","sourceRoot":"","sources":["../src/resources/agents.ts"],"names":[],"mappings":"AAEA,mCAA+B"}

package/resources/agents.d.ts

@@ -0,0 +1,2 @@
+export * from "./agents/index.js";
+//# sourceMappingURL=agents.d.ts.map

package/resources/agents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../src/resources/agents.ts"],"names":[],"mappings":"AAEA,kCAA+B"}

package/resources/agents.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./agents/index.js"), exports);
+//# sourceMappingURL=agents.js.map

package/resources/agents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agents.js","sourceRoot":"","sources":["../src/resources/agents.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4DAA+B"}

package/resources/agents.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./agents/index.mjs";
+//# sourceMappingURL=agents.mjs.map

package/resources/agents.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"agents.mjs","sourceRoot":"","sources":["../src/resources/agents.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,mCAA+B"}

package/resources/app-users.d.mts

@@ -0,0 +1,190 @@
+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";
+/**
+ * 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;
+    /**
+     * The maximum number of results to return. Defaults to 50. Maximum is 100.
+     */
+    limit?: number;
+    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.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"app-users.d.mts","sourceRoot":"","sources":["../src/resources/app-users.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,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;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,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"}