@nocobase/plugin-ai 2.1.7 → 2.1.8

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

@@ -0,0 +1,157 @@
+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;
+    /**
+     * Adds a user to the project. Users must already be members of the organization to
+     * be added to a project.
+     *
+     * @example
+     * ```ts
+     * const projectUser =
+     *   await client.admin.organization.projects.users.create(
+     *     'project_id',
+     *     { role: 'role' },
+     *   );
+     * ```
+     */
+    create(projectID: string, body: UserCreateParams, options?: RequestOptions): APIPromise<ProjectUser>;
+    /**
+     * Retrieves a user in the project.
+     *
+     * @example
+     * ```ts
+     * const projectUser =
+     *   await client.admin.organization.projects.users.retrieve(
+     *     'user_id',
+     *     { project_id: 'project_id' },
+     *   );
+     * ```
+     */
+    retrieve(userID: string, params: UserRetrieveParams, options?: RequestOptions): APIPromise<ProjectUser>;
+    /**
+     * Modifies a user's role in the project.
+     *
+     * @example
+     * ```ts
+     * const projectUser =
+     *   await client.admin.organization.projects.users.update(
+     *     'user_id',
+     *     { project_id: 'project_id' },
+     *   );
+     * ```
+     */
+    update(userID: string, params: UserUpdateParams, options?: RequestOptions): APIPromise<ProjectUser>;
+    /**
+     * Returns a list of users in the project.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const projectUser of client.admin.organization.projects.users.list(
+     *   'project_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(projectID: string, query?: UserListParams | null | undefined, options?: RequestOptions): PagePromise<ProjectUsersPage, ProjectUser>;
+    /**
+     * Deletes a user from the project.
+     *
+     * Returns confirmation of project user deletion, or an error if the project is
+     * archived (archived projects have no users).
+     *
+     * @example
+     * ```ts
+     * const user =
+     *   await client.admin.organization.projects.users.delete(
+     *     'user_id',
+     *     { project_id: 'project_id' },
+     *   );
+     * ```
+     */
+    delete(userID: string, params: UserDeleteParams, options?: RequestOptions): APIPromise<UserDeleteResponse>;
+}
+export type ProjectUsersPage = ConversationCursorPage<ProjectUser>;
+/**
+ * Represents an individual user in a project.
+ */
+export interface ProjectUser {
+    /**
+     * The identifier, which can be referenced in API endpoints
+     */
+    id: string;
+    /**
+     * The Unix timestamp (in seconds) of when the project was added.
+     */
+    added_at: number;
+    /**
+     * The object type, which is always `organization.project.user`
+     */
+    object: 'organization.project.user';
+    /**
+     * `owner` or `member`
+     */
+    role: string;
+    /**
+     * The email address of the user
+     */
+    email?: string | null;
+    /**
+     * The name of the user
+     */
+    name?: string | null;
+}
+export interface UserDeleteResponse {
+    id: string;
+    deleted: boolean;
+    object: 'organization.project.user.deleted';
+}
+export interface UserCreateParams {
+    /**
+     * `owner` or `member`
+     */
+    role: string;
+    /**
+     * Email of the user to add.
+     */
+    email?: string | null;
+    /**
+     * The ID of the user.
+     */
+    user_id?: string | null;
+}
+export interface UserRetrieveParams {
+    /**
+     * The ID of the project.
+     */
+    project_id: string;
+}
+export interface UserUpdateParams {
+    /**
+     * Path param: The ID of the project.
+     */
+    project_id: string;
+    /**
+     * Body param: `owner` or `member`
+     */
+    role?: string | null;
+}
+export interface UserListParams extends ConversationCursorPageParams {
+}
+export interface UserDeleteParams {
+    /**
+     * The ID of the project.
+     */
+    project_id: string;
+}
+export declare namespace Users {
+    export { type ProjectUser as ProjectUser, type UserDeleteResponse as UserDeleteResponse, type ProjectUsersPage as ProjectUsersPage, type UserCreateParams as UserCreateParams, type UserRetrieveParams as UserRetrieveParams, type UserUpdateParams as UserUpdateParams, type UserListParams as UserListParams, type UserDeleteParams as UserDeleteParams, };
+    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/projects/users/users.d.ts

@@ -0,0 +1,157 @@
+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;
+    /**
+     * Adds a user to the project. Users must already be members of the organization to
+     * be added to a project.
+     *
+     * @example
+     * ```ts
+     * const projectUser =
+     *   await client.admin.organization.projects.users.create(
+     *     'project_id',
+     *     { role: 'role' },
+     *   );
+     * ```
+     */
+    create(projectID: string, body: UserCreateParams, options?: RequestOptions): APIPromise<ProjectUser>;
+    /**
+     * Retrieves a user in the project.
+     *
+     * @example
+     * ```ts
+     * const projectUser =
+     *   await client.admin.organization.projects.users.retrieve(
+     *     'user_id',
+     *     { project_id: 'project_id' },
+     *   );
+     * ```
+     */
+    retrieve(userID: string, params: UserRetrieveParams, options?: RequestOptions): APIPromise<ProjectUser>;
+    /**
+     * Modifies a user's role in the project.
+     *
+     * @example
+     * ```ts
+     * const projectUser =
+     *   await client.admin.organization.projects.users.update(
+     *     'user_id',
+     *     { project_id: 'project_id' },
+     *   );
+     * ```
+     */
+    update(userID: string, params: UserUpdateParams, options?: RequestOptions): APIPromise<ProjectUser>;
+    /**
+     * Returns a list of users in the project.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const projectUser of client.admin.organization.projects.users.list(
+     *   'project_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(projectID: string, query?: UserListParams | null | undefined, options?: RequestOptions): PagePromise<ProjectUsersPage, ProjectUser>;
+    /**
+     * Deletes a user from the project.
+     *
+     * Returns confirmation of project user deletion, or an error if the project is
+     * archived (archived projects have no users).
+     *
+     * @example
+     * ```ts
+     * const user =
+     *   await client.admin.organization.projects.users.delete(
+     *     'user_id',
+     *     { project_id: 'project_id' },
+     *   );
+     * ```
+     */
+    delete(userID: string, params: UserDeleteParams, options?: RequestOptions): APIPromise<UserDeleteResponse>;
+}
+export type ProjectUsersPage = ConversationCursorPage<ProjectUser>;
+/**
+ * Represents an individual user in a project.
+ */
+export interface ProjectUser {
+    /**
+     * The identifier, which can be referenced in API endpoints
+     */
+    id: string;
+    /**
+     * The Unix timestamp (in seconds) of when the project was added.
+     */
+    added_at: number;
+    /**
+     * The object type, which is always `organization.project.user`
+     */
+    object: 'organization.project.user';
+    /**
+     * `owner` or `member`
+     */
+    role: string;
+    /**
+     * The email address of the user
+     */
+    email?: string | null;
+    /**
+     * The name of the user
+     */
+    name?: string | null;
+}
+export interface UserDeleteResponse {
+    id: string;
+    deleted: boolean;
+    object: 'organization.project.user.deleted';
+}
+export interface UserCreateParams {
+    /**
+     * `owner` or `member`
+     */
+    role: string;
+    /**
+     * Email of the user to add.
+     */
+    email?: string | null;
+    /**
+     * The ID of the user.
+     */
+    user_id?: string | null;
+}
+export interface UserRetrieveParams {
+    /**
+     * The ID of the project.
+     */
+    project_id: string;
+}
+export interface UserUpdateParams {
+    /**
+     * Path param: The ID of the project.
+     */
+    project_id: string;
+    /**
+     * Body param: `owner` or `member`
+     */
+    role?: string | null;
+}
+export interface UserListParams extends ConversationCursorPageParams {
+}
+export interface UserDeleteParams {
+    /**
+     * The ID of the project.
+     */
+    project_id: string;
+}
+export declare namespace Users {
+    export { type ProjectUser as ProjectUser, type UserDeleteResponse as UserDeleteResponse, type ProjectUsersPage as ProjectUsersPage, type UserCreateParams as UserCreateParams, type UserRetrieveParams as UserRetrieveParams, type UserUpdateParams as UserUpdateParams, type UserListParams as UserListParams, type UserDeleteParams as UserDeleteParams, };
+    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

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

@@ -0,0 +1,116 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Users = void 0;
+const tslib_1 = require("../../../../../internal/tslib.js");
+const resource_1 = require("../../../../../core/resource.js");
+const RolesAPI = tslib_1.__importStar(require("./roles.js"));
+const roles_1 = require("./roles.js");
+const pagination_1 = require("../../../../../core/pagination.js");
+const path_1 = require("../../../../../internal/utils/path.js");
+class Users extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.roles = new RolesAPI.Roles(this._client);
+    }
+    /**
+     * Adds a user to the project. Users must already be members of the organization to
+     * be added to a project.
+     *
+     * @example
+     * ```ts
+     * const projectUser =
+     *   await client.admin.organization.projects.users.create(
+     *     'project_id',
+     *     { role: 'role' },
+     *   );
+     * ```
+     */
+    create(projectID, body, options) {
+        return this._client.post((0, path_1.path) `/organization/projects/${projectID}/users`, {
+            body,
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+    /**
+     * Retrieves a user in the project.
+     *
+     * @example
+     * ```ts
+     * const projectUser =
+     *   await client.admin.organization.projects.users.retrieve(
+     *     'user_id',
+     *     { project_id: 'project_id' },
+     *   );
+     * ```
+     */
+    retrieve(userID, params, options) {
+        const { project_id } = params;
+        return this._client.get((0, path_1.path) `/organization/projects/${project_id}/users/${userID}`, {
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+    /**
+     * Modifies a user's role in the project.
+     *
+     * @example
+     * ```ts
+     * const projectUser =
+     *   await client.admin.organization.projects.users.update(
+     *     'user_id',
+     *     { project_id: 'project_id' },
+     *   );
+     * ```
+     */
+    update(userID, params, options) {
+        const { project_id, ...body } = params;
+        return this._client.post((0, path_1.path) `/organization/projects/${project_id}/users/${userID}`, {
+            body,
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+    /**
+     * Returns a list of users in the project.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const projectUser of client.admin.organization.projects.users.list(
+     *   'project_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(projectID, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/organization/projects/${projectID}/users`, (pagination_1.ConversationCursorPage), { query, ...options, __security: { adminAPIKeyAuth: true } });
+    }
+    /**
+     * Deletes a user from the project.
+     *
+     * Returns confirmation of project user deletion, or an error if the project is
+     * archived (archived projects have no users).
+     *
+     * @example
+     * ```ts
+     * const user =
+     *   await client.admin.organization.projects.users.delete(
+     *     'user_id',
+     *     { project_id: 'project_id' },
+     *   );
+     * ```
+     */
+    delete(userID, params, options) {
+        const { project_id } = params;
+        return this._client.delete((0, path_1.path) `/organization/projects/${project_id}/users/${userID}`, {
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+}
+exports.Users = Users;
+Users.Roles = roles_1.Roles;
+//# sourceMappingURL=users.js.map

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

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

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

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

package/dist/node_modules/openai/resources/admin/organization/projects/users.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("./users/index.js"), exports);
+//# sourceMappingURL=users.js.map

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

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

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

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

package/dist/node_modules/openai/resources/admin/organization/projects.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("./projects/index.js"), exports);
+//# sourceMappingURL=projects.js.map

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

@@ -0,0 +1,153 @@
+import { APIResource } from "../../../core/resource.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { NextCursorPage, type NextCursorPageParams, PagePromise } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Roles extends APIResource {
+    /**
+     * Creates a custom role for the organization.
+     *
+     * @example
+     * ```ts
+     * const role = await client.admin.organization.roles.create({
+     *   permissions: ['string'],
+     *   role_name: 'role_name',
+     * });
+     * ```
+     */
+    create(body: RoleCreateParams, options?: RequestOptions): APIPromise<Role>;
+    /**
+     * Retrieves an organization role.
+     *
+     * @example
+     * ```ts
+     * const role = await client.admin.organization.roles.retrieve(
+     *   'role_id',
+     * );
+     * ```
+     */
+    retrieve(roleID: string, options?: RequestOptions): APIPromise<Role>;
+    /**
+     * Updates an existing organization role.
+     *
+     * @example
+     * ```ts
+     * const role = await client.admin.organization.roles.update(
+     *   'role_id',
+     * );
+     * ```
+     */
+    update(roleID: string, body: RoleUpdateParams, options?: RequestOptions): APIPromise<Role>;
+    /**
+     * Lists the roles configured for the organization.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const role of client.admin.organization.roles.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: RoleListParams | null | undefined, options?: RequestOptions): PagePromise<RolesPage, Role>;
+    /**
+     * Deletes a custom role from the organization.
+     *
+     * @example
+     * ```ts
+     * const role = await client.admin.organization.roles.delete(
+     *   'role_id',
+     * );
+     * ```
+     */
+    delete(roleID: string, options?: RequestOptions): APIPromise<RoleDeleteResponse>;
+}
+export type RolesPage = NextCursorPage<Role>;
+/**
+ * Details about a role that can be assigned through the public Roles API.
+ */
+export interface Role {
+    /**
+     * Identifier for the role.
+     */
+    id: string;
+    /**
+     * Optional description of the role.
+     */
+    description: string | null;
+    /**
+     * Unique name for the role.
+     */
+    name: string;
+    /**
+     * Always `role`.
+     */
+    object: 'role';
+    /**
+     * Permissions granted by the role.
+     */
+    permissions: Array<string>;
+    /**
+     * Whether the role is predefined and managed by OpenAI.
+     */
+    predefined_role: boolean;
+    /**
+     * Resource type the role is bound to (for example `api.organization` or
+     * `api.project`).
+     */
+    resource_type: string;
+}
+/**
+ * Confirmation payload returned after deleting a role.
+ */
+export interface RoleDeleteResponse {
+    /**
+     * Identifier of the deleted role.
+     */
+    id: string;
+    /**
+     * Whether the role was deleted.
+     */
+    deleted: boolean;
+    /**
+     * Always `role.deleted`.
+     */
+    object: 'role.deleted';
+}
+export interface RoleCreateParams {
+    /**
+     * Permissions to grant to the role.
+     */
+    permissions: Array<string>;
+    /**
+     * Unique name for the role.
+     */
+    role_name: string;
+    /**
+     * Optional description of the role.
+     */
+    description?: string | null;
+}
+export interface RoleUpdateParams {
+    /**
+     * New description for the role.
+     */
+    description?: string | null;
+    /**
+     * Updated set of permissions for the role.
+     */
+    permissions?: Array<string> | null;
+    /**
+     * New name for the role.
+     */
+    role_name?: string | null;
+}
+export interface RoleListParams extends NextCursorPageParams {
+    /**
+     * Sort order for the returned roles.
+     */
+    order?: 'asc' | 'desc';
+}
+export declare namespace Roles {
+    export { type Role as Role, type RoleDeleteResponse as RoleDeleteResponse, type RolesPage as RolesPage, type RoleCreateParams as RoleCreateParams, type RoleUpdateParams as RoleUpdateParams, type RoleListParams as RoleListParams, };
+}
+//# sourceMappingURL=roles.d.mts.map