@nocobase/plugin-ai 2.1.7 → 2.1.9

package/dist/node_modules/openai/resources/admin/organization/users/roles.d.ts

@@ -0,0 +1,249 @@
+import { APIResource } from "../../../../core/resource.js";
+import * as RolesAPI from "../roles.js";
+import * as UsersAPI from "./users.js";
+import { APIPromise } from "../../../../core/api-promise.js";
+import { NextCursorPage, type NextCursorPageParams, PagePromise } from "../../../../core/pagination.js";
+import { RequestOptions } from "../../../../internal/request-options.js";
+export declare class Roles extends APIResource {
+    /**
+     * Assigns an organization role to a user within the organization.
+     *
+     * @example
+     * ```ts
+     * const role =
+     *   await client.admin.organization.users.roles.create(
+     *     'user_id',
+     *     { role_id: 'role_id' },
+     *   );
+     * ```
+     */
+    create(userID: string, body: RoleCreateParams, options?: RequestOptions): APIPromise<RoleCreateResponse>;
+    /**
+     * Retrieves an organization role assigned to a user.
+     *
+     * @example
+     * ```ts
+     * const role =
+     *   await client.admin.organization.users.roles.retrieve(
+     *     'role_id',
+     *     { user_id: 'user_id' },
+     *   );
+     * ```
+     */
+    retrieve(roleID: string, params: RoleRetrieveParams, options?: RequestOptions): APIPromise<RoleRetrieveResponse>;
+    /**
+     * Lists the organization roles assigned to a user within the organization.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const roleListResponse of client.admin.organization.users.roles.list(
+     *   'user_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(userID: string, query?: RoleListParams | null | undefined, options?: RequestOptions): PagePromise<RoleListResponsesPage, RoleListResponse>;
+    /**
+     * Unassigns an organization role from a user within the organization.
+     *
+     * @example
+     * ```ts
+     * const role =
+     *   await client.admin.organization.users.roles.delete(
+     *     'role_id',
+     *     { user_id: 'user_id' },
+     *   );
+     * ```
+     */
+    delete(roleID: string, params: RoleDeleteParams, options?: RequestOptions): APIPromise<RoleDeleteResponse>;
+}
+export type RoleListResponsesPage = NextCursorPage<RoleListResponse>;
+/**
+ * Role assignment linking a user to a role.
+ */
+export interface RoleCreateResponse {
+    /**
+     * Always `user.role`.
+     */
+    object: 'user.role';
+    /**
+     * Details about a role that can be assigned through the public Roles API.
+     */
+    role: RolesAPI.Role;
+    /**
+     * Represents an individual `user` within an organization.
+     */
+    user: UsersAPI.OrganizationUser;
+}
+/**
+ * Detailed information about a role assignment entry returned when listing
+ * assignments.
+ */
+export interface RoleRetrieveResponse {
+    /**
+     * Identifier for the role.
+     */
+    id: string;
+    /**
+     * Principals from which the role assignment is inherited, when available.
+     */
+    assignment_sources: Array<RoleRetrieveResponse.AssignmentSource> | null;
+    /**
+     * When the role was created.
+     */
+    created_at: number | null;
+    /**
+     * Identifier of the actor who created the role.
+     */
+    created_by: string | null;
+    /**
+     * User details for the actor that created the role, when available.
+     */
+    created_by_user_obj: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Description of the role.
+     */
+    description: string | null;
+    /**
+     * Arbitrary metadata stored on the role.
+     */
+    metadata: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Name of the role.
+     */
+    name: string;
+    /**
+     * Permissions associated with the role.
+     */
+    permissions: Array<string>;
+    /**
+     * Whether the role is predefined by OpenAI.
+     */
+    predefined_role: boolean;
+    /**
+     * Resource type the role applies to.
+     */
+    resource_type: string;
+    /**
+     * When the role was last updated.
+     */
+    updated_at: number | null;
+}
+export declare namespace RoleRetrieveResponse {
+    interface AssignmentSource {
+        principal_id: string;
+        principal_type: string;
+    }
+}
+/**
+ * Detailed information about a role assignment entry returned when listing
+ * assignments.
+ */
+export interface RoleListResponse {
+    /**
+     * Identifier for the role.
+     */
+    id: string;
+    /**
+     * Principals from which the role assignment is inherited, when available.
+     */
+    assignment_sources: Array<RoleListResponse.AssignmentSource> | null;
+    /**
+     * When the role was created.
+     */
+    created_at: number | null;
+    /**
+     * Identifier of the actor who created the role.
+     */
+    created_by: string | null;
+    /**
+     * User details for the actor that created the role, when available.
+     */
+    created_by_user_obj: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Description of the role.
+     */
+    description: string | null;
+    /**
+     * Arbitrary metadata stored on the role.
+     */
+    metadata: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Name of the role.
+     */
+    name: string;
+    /**
+     * Permissions associated with the role.
+     */
+    permissions: Array<string>;
+    /**
+     * Whether the role is predefined by OpenAI.
+     */
+    predefined_role: boolean;
+    /**
+     * Resource type the role applies to.
+     */
+    resource_type: string;
+    /**
+     * When the role was last updated.
+     */
+    updated_at: number | null;
+}
+export declare namespace RoleListResponse {
+    interface AssignmentSource {
+        principal_id: string;
+        principal_type: string;
+    }
+}
+/**
+ * Confirmation payload returned after unassigning a role.
+ */
+export interface RoleDeleteResponse {
+    /**
+     * Whether the assignment was removed.
+     */
+    deleted: boolean;
+    /**
+     * Identifier for the deleted assignment, such as `group.role.deleted` or
+     * `user.role.deleted`.
+     */
+    object: string;
+}
+export interface RoleCreateParams {
+    /**
+     * Identifier of the role to assign.
+     */
+    role_id: string;
+}
+export interface RoleRetrieveParams {
+    /**
+     * The ID of the user to inspect.
+     */
+    user_id: string;
+}
+export interface RoleListParams extends NextCursorPageParams {
+    /**
+     * Sort order for the returned organization roles.
+     */
+    order?: 'asc' | 'desc';
+}
+export interface RoleDeleteParams {
+    /**
+     * The ID of the user to modify.
+     */
+    user_id: string;
+}
+export declare namespace Roles {
+    export { type RoleCreateResponse as RoleCreateResponse, type RoleRetrieveResponse as RoleRetrieveResponse, type RoleListResponse as RoleListResponse, type RoleDeleteResponse as RoleDeleteResponse, type RoleListResponsesPage as RoleListResponsesPage, type RoleCreateParams as RoleCreateParams, type RoleRetrieveParams as RoleRetrieveParams, type RoleListParams as RoleListParams, type RoleDeleteParams as RoleDeleteParams, };
+}
+//# sourceMappingURL=roles.d.ts.map

package/dist/node_modules/openai/resources/admin/organization/users/roles.js

@@ -0,0 +1,84 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Roles = void 0;
+const resource_1 = require("../../../../core/resource.js");
+const pagination_1 = require("../../../../core/pagination.js");
+const path_1 = require("../../../../internal/utils/path.js");
+class Roles extends resource_1.APIResource {
+    /**
+     * Assigns an organization role to a user within the organization.
+     *
+     * @example
+     * ```ts
+     * const role =
+     *   await client.admin.organization.users.roles.create(
+     *     'user_id',
+     *     { role_id: 'role_id' },
+     *   );
+     * ```
+     */
+    create(userID, body, options) {
+        return this._client.post((0, path_1.path) `/organization/users/${userID}/roles`, {
+            body,
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+    /**
+     * Retrieves an organization role assigned to a user.
+     *
+     * @example
+     * ```ts
+     * const role =
+     *   await client.admin.organization.users.roles.retrieve(
+     *     'role_id',
+     *     { user_id: 'user_id' },
+     *   );
+     * ```
+     */
+    retrieve(roleID, params, options) {
+        const { user_id } = params;
+        return this._client.get((0, path_1.path) `/organization/users/${user_id}/roles/${roleID}`, {
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+    /**
+     * Lists the organization roles assigned to a user within the organization.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const roleListResponse of client.admin.organization.users.roles.list(
+     *   'user_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(userID, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/organization/users/${userID}/roles`, (pagination_1.NextCursorPage), { query, ...options, __security: { adminAPIKeyAuth: true } });
+    }
+    /**
+     * Unassigns an organization role from a user within the organization.
+     *
+     * @example
+     * ```ts
+     * const role =
+     *   await client.admin.organization.users.roles.delete(
+     *     'role_id',
+     *     { user_id: 'user_id' },
+     *   );
+     * ```
+     */
+    delete(roleID, params, options) {
+        const { user_id } = params;
+        return this._client.delete((0, path_1.path) `/organization/users/${user_id}/roles/${roleID}`, {
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+}
+exports.Roles = Roles;
+//# sourceMappingURL=roles.js.map

package/dist/node_modules/openai/resources/admin/organization/users/users.d.mts

@@ -0,0 +1,185 @@
+import { APIResource } from "../../../../core/resource.mjs";
+import * as RolesAPI from "./roles.mjs";
+import { RoleCreateParams, RoleCreateResponse, RoleDeleteParams, RoleDeleteResponse, RoleListParams, RoleListResponse, RoleListResponsesPage, RoleRetrieveParams, RoleRetrieveResponse, Roles } from "./roles.mjs";
+import { APIPromise } from "../../../../core/api-promise.mjs";
+import { ConversationCursorPage, type ConversationCursorPageParams, PagePromise } from "../../../../core/pagination.mjs";
+import { RequestOptions } from "../../../../internal/request-options.mjs";
+export declare class Users extends APIResource {
+    roles: RolesAPI.Roles;
+    /**
+     * Retrieves a user by their identifier.
+     *
+     * @example
+     * ```ts
+     * const organizationUser =
+     *   await client.admin.organization.users.retrieve('user_id');
+     * ```
+     */
+    retrieve(userID: string, options?: RequestOptions): APIPromise<OrganizationUser>;
+    /**
+     * Modifies a user's role in the organization.
+     *
+     * @example
+     * ```ts
+     * const organizationUser =
+     *   await client.admin.organization.users.update('user_id');
+     * ```
+     */
+    update(userID: string, body: UserUpdateParams, options?: RequestOptions): APIPromise<OrganizationUser>;
+    /**
+     * Lists all of the users in the organization.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const organizationUser of client.admin.organization.users.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: UserListParams | null | undefined, options?: RequestOptions): PagePromise<OrganizationUsersPage, OrganizationUser>;
+    /**
+     * Deletes a user from the organization.
+     *
+     * @example
+     * ```ts
+     * const user = await client.admin.organization.users.delete(
+     *   'user_id',
+     * );
+     * ```
+     */
+    delete(userID: string, options?: RequestOptions): APIPromise<UserDeleteResponse>;
+}
+export type OrganizationUsersPage = ConversationCursorPage<OrganizationUser>;
+/**
+ * Represents an individual `user` within an organization.
+ */
+export interface OrganizationUser {
+    /**
+     * The identifier, which can be referenced in API endpoints
+     */
+    id: string;
+    /**
+     * The Unix timestamp (in seconds) of when the user was added.
+     */
+    added_at: number;
+    /**
+     * The object type, which is always `organization.user`
+     */
+    object: 'organization.user';
+    /**
+     * The Unix timestamp (in seconds) of the user's last API key usage.
+     */
+    api_key_last_used_at?: number | null;
+    /**
+     * The Unix timestamp (in seconds) of when the user was created.
+     */
+    created?: number;
+    /**
+     * The developer persona metadata for the user.
+     */
+    developer_persona?: string | null;
+    /**
+     * The email address of the user
+     */
+    email?: string | null;
+    /**
+     * Whether this is the organization's default user.
+     */
+    is_default?: boolean;
+    /**
+     * Whether the user is an authorized purchaser for Scale Tier.
+     */
+    is_scale_tier_authorized_purchaser?: boolean | null;
+    /**
+     * Whether the user is managed through SCIM.
+     */
+    is_scim_managed?: boolean;
+    /**
+     * Whether the user is a service account.
+     */
+    is_service_account?: boolean;
+    /**
+     * The name of the user
+     */
+    name?: string | null;
+    /**
+     * Projects associated with the user, if included.
+     */
+    projects?: OrganizationUser.Projects | null;
+    /**
+     * `owner` or `reader`
+     */
+    role?: string | null;
+    /**
+     * The technical level metadata for the user.
+     */
+    technical_level?: string | null;
+    /**
+     * Nested user details.
+     */
+    user?: OrganizationUser.User;
+}
+export declare namespace OrganizationUser {
+    /**
+     * Projects associated with the user, if included.
+     */
+    interface Projects {
+        data: Array<Projects.Data>;
+        object: 'list';
+    }
+    namespace Projects {
+        interface Data {
+            id?: string | null;
+            name?: string | null;
+            role?: string | null;
+        }
+    }
+    /**
+     * Nested user details.
+     */
+    interface User {
+        id: string;
+        object: 'user';
+        banned?: boolean | null;
+        banned_at?: number | null;
+        email?: string | null;
+        enabled?: boolean | null;
+        name?: string | null;
+        picture?: string | null;
+    }
+}
+export interface UserDeleteResponse {
+    id: string;
+    deleted: boolean;
+    object: 'organization.user.deleted';
+}
+export interface UserUpdateParams {
+    /**
+     * Developer persona metadata.
+     */
+    developer_persona?: string | null;
+    /**
+     * `owner` or `reader`
+     */
+    role?: string | null;
+    /**
+     * Role ID to assign to the user.
+     */
+    role_id?: string | null;
+    /**
+     * Technical level metadata.
+     */
+    technical_level?: string | null;
+}
+export interface UserListParams extends ConversationCursorPageParams {
+    /**
+     * Filter by the email address of users.
+     */
+    emails?: Array<string>;
+}
+export declare namespace Users {
+    export { type OrganizationUser as OrganizationUser, type UserDeleteResponse as UserDeleteResponse, type OrganizationUsersPage as OrganizationUsersPage, type UserUpdateParams as UserUpdateParams, type UserListParams as UserListParams, };
+    export { Roles as Roles, type RoleCreateResponse as RoleCreateResponse, type RoleRetrieveResponse as RoleRetrieveResponse, type RoleListResponse as RoleListResponse, type RoleDeleteResponse as RoleDeleteResponse, type RoleListResponsesPage as RoleListResponsesPage, type RoleCreateParams as RoleCreateParams, type RoleRetrieveParams as RoleRetrieveParams, type RoleListParams as RoleListParams, type RoleDeleteParams as RoleDeleteParams, };
+}
+//# sourceMappingURL=users.d.mts.map

package/dist/node_modules/openai/resources/admin/organization/users/users.d.ts

@@ -0,0 +1,185 @@
+import { APIResource } from "../../../../core/resource.js";
+import * as RolesAPI from "./roles.js";
+import { RoleCreateParams, RoleCreateResponse, RoleDeleteParams, RoleDeleteResponse, RoleListParams, RoleListResponse, RoleListResponsesPage, RoleRetrieveParams, RoleRetrieveResponse, Roles } from "./roles.js";
+import { APIPromise } from "../../../../core/api-promise.js";
+import { ConversationCursorPage, type ConversationCursorPageParams, PagePromise } from "../../../../core/pagination.js";
+import { RequestOptions } from "../../../../internal/request-options.js";
+export declare class Users extends APIResource {
+    roles: RolesAPI.Roles;
+    /**
+     * Retrieves a user by their identifier.
+     *
+     * @example
+     * ```ts
+     * const organizationUser =
+     *   await client.admin.organization.users.retrieve('user_id');
+     * ```
+     */
+    retrieve(userID: string, options?: RequestOptions): APIPromise<OrganizationUser>;
+    /**
+     * Modifies a user's role in the organization.
+     *
+     * @example
+     * ```ts
+     * const organizationUser =
+     *   await client.admin.organization.users.update('user_id');
+     * ```
+     */
+    update(userID: string, body: UserUpdateParams, options?: RequestOptions): APIPromise<OrganizationUser>;
+    /**
+     * Lists all of the users in the organization.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const organizationUser of client.admin.organization.users.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: UserListParams | null | undefined, options?: RequestOptions): PagePromise<OrganizationUsersPage, OrganizationUser>;
+    /**
+     * Deletes a user from the organization.
+     *
+     * @example
+     * ```ts
+     * const user = await client.admin.organization.users.delete(
+     *   'user_id',
+     * );
+     * ```
+     */
+    delete(userID: string, options?: RequestOptions): APIPromise<UserDeleteResponse>;
+}
+export type OrganizationUsersPage = ConversationCursorPage<OrganizationUser>;
+/**
+ * Represents an individual `user` within an organization.
+ */
+export interface OrganizationUser {
+    /**
+     * The identifier, which can be referenced in API endpoints
+     */
+    id: string;
+    /**
+     * The Unix timestamp (in seconds) of when the user was added.
+     */
+    added_at: number;
+    /**
+     * The object type, which is always `organization.user`
+     */
+    object: 'organization.user';
+    /**
+     * The Unix timestamp (in seconds) of the user's last API key usage.
+     */
+    api_key_last_used_at?: number | null;
+    /**
+     * The Unix timestamp (in seconds) of when the user was created.
+     */
+    created?: number;
+    /**
+     * The developer persona metadata for the user.
+     */
+    developer_persona?: string | null;
+    /**
+     * The email address of the user
+     */
+    email?: string | null;
+    /**
+     * Whether this is the organization's default user.
+     */
+    is_default?: boolean;
+    /**
+     * Whether the user is an authorized purchaser for Scale Tier.
+     */
+    is_scale_tier_authorized_purchaser?: boolean | null;
+    /**
+     * Whether the user is managed through SCIM.
+     */
+    is_scim_managed?: boolean;
+    /**
+     * Whether the user is a service account.
+     */
+    is_service_account?: boolean;
+    /**
+     * The name of the user
+     */
+    name?: string | null;
+    /**
+     * Projects associated with the user, if included.
+     */
+    projects?: OrganizationUser.Projects | null;
+    /**
+     * `owner` or `reader`
+     */
+    role?: string | null;
+    /**
+     * The technical level metadata for the user.
+     */
+    technical_level?: string | null;
+    /**
+     * Nested user details.
+     */
+    user?: OrganizationUser.User;
+}
+export declare namespace OrganizationUser {
+    /**
+     * Projects associated with the user, if included.
+     */
+    interface Projects {
+        data: Array<Projects.Data>;
+        object: 'list';
+    }
+    namespace Projects {
+        interface Data {
+            id?: string | null;
+            name?: string | null;
+            role?: string | null;
+        }
+    }
+    /**
+     * Nested user details.
+     */
+    interface User {
+        id: string;
+        object: 'user';
+        banned?: boolean | null;
+        banned_at?: number | null;
+        email?: string | null;
+        enabled?: boolean | null;
+        name?: string | null;
+        picture?: string | null;
+    }
+}
+export interface UserDeleteResponse {
+    id: string;
+    deleted: boolean;
+    object: 'organization.user.deleted';
+}
+export interface UserUpdateParams {
+    /**
+     * Developer persona metadata.
+     */
+    developer_persona?: string | null;
+    /**
+     * `owner` or `reader`
+     */
+    role?: string | null;
+    /**
+     * Role ID to assign to the user.
+     */
+    role_id?: string | null;
+    /**
+     * Technical level metadata.
+     */
+    technical_level?: string | null;
+}
+export interface UserListParams extends ConversationCursorPageParams {
+    /**
+     * Filter by the email address of users.
+     */
+    emails?: Array<string>;
+}
+export declare namespace Users {
+    export { type OrganizationUser as OrganizationUser, type UserDeleteResponse as UserDeleteResponse, type OrganizationUsersPage as OrganizationUsersPage, type UserUpdateParams as UserUpdateParams, type UserListParams as UserListParams, };
+    export { Roles as Roles, type RoleCreateResponse as RoleCreateResponse, type RoleRetrieveResponse as RoleRetrieveResponse, type RoleListResponse as RoleListResponse, type RoleDeleteResponse as RoleDeleteResponse, type RoleListResponsesPage as RoleListResponsesPage, type RoleCreateParams as RoleCreateParams, type RoleRetrieveParams as RoleRetrieveParams, type RoleListParams as RoleListParams, type RoleDeleteParams as RoleDeleteParams, };
+}
+//# sourceMappingURL=users.d.ts.map