@nocobase/plugin-ai 2.1.7 → 2.1.8

package/dist/node_modules/openai/src/resources/admin/organization/projects/groups/roles.ts

@@ -0,0 +1,386 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import * as RolesAPI from '../../roles';
+import { APIPromise } from '../../../../../core/api-promise';
+import { NextCursorPage, type NextCursorPageParams, PagePromise } from '../../../../../core/pagination';
+import { RequestOptions } from '../../../../../internal/request-options';
+import { path } from '../../../../../internal/utils/path';
+
+export class Roles extends APIResource {
+  /**
+   * Assigns a project role to a group within a project.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.projects.groups.roles.create(
+   *     'group_id',
+   *     { project_id: 'project_id', role_id: 'role_id' },
+   *   );
+   * ```
+   */
+  create(
+    groupID: string,
+    params: RoleCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<RoleCreateResponse> {
+    const { project_id, ...body } = params;
+    return this._client.post(path`/projects/${project_id}/groups/${groupID}/roles`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Retrieves a project role assigned to a group.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.projects.groups.roles.retrieve(
+   *     'role_id',
+   *     { project_id: 'project_id', group_id: 'group_id' },
+   *   );
+   * ```
+   */
+  retrieve(
+    roleID: string,
+    params: RoleRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<RoleRetrieveResponse> {
+    const { project_id, group_id } = params;
+    return this._client.get(path`/projects/${project_id}/groups/${group_id}/roles/${roleID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Lists the project roles assigned to a group within a project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const roleListResponse of client.admin.organization.projects.groups.roles.list(
+   *   'group_id',
+   *   { project_id: 'project_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    groupID: string,
+    params: RoleListParams,
+    options?: RequestOptions,
+  ): PagePromise<RoleListResponsesPage, RoleListResponse> {
+    const { project_id, ...query } = params;
+    return this._client.getAPIList(
+      path`/projects/${project_id}/groups/${groupID}/roles`,
+      NextCursorPage<RoleListResponse>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Unassigns a project role from a group within a project.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.projects.groups.roles.delete(
+   *     'role_id',
+   *     { project_id: 'project_id', group_id: 'group_id' },
+   *   );
+   * ```
+   */
+  delete(roleID: string, params: RoleDeleteParams, options?: RequestOptions): APIPromise<RoleDeleteResponse> {
+    const { project_id, group_id } = params;
+    return this._client.delete(path`/projects/${project_id}/groups/${group_id}/roles/${roleID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type RoleListResponsesPage = NextCursorPage<RoleListResponse>;
+
+/**
+ * Role assignment linking a group to a role.
+ */
+export interface RoleCreateResponse {
+  /**
+   * Summary information about a group returned in role assignment responses.
+   */
+  group: RoleCreateResponse.Group;
+
+  /**
+   * Always `group.role`.
+   */
+  object: 'group.role';
+
+  /**
+   * Details about a role that can be assigned through the public Roles API.
+   */
+  role: RolesAPI.Role;
+}
+
+export namespace RoleCreateResponse {
+  /**
+   * Summary information about a group returned in role assignment responses.
+   */
+  export interface Group {
+    /**
+     * Identifier for the group.
+     */
+    id: string;
+
+    /**
+     * Unix timestamp (in seconds) when the group was created.
+     */
+    created_at: number;
+
+    /**
+     * Display name of the group.
+     */
+    name: string;
+
+    /**
+     * Always `group`.
+     */
+    object: 'group';
+
+    /**
+     * Whether the group is managed through SCIM.
+     */
+    scim_managed: boolean;
+  }
+}
+
+/**
+ * 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 namespace RoleRetrieveResponse {
+  export 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 namespace RoleListResponse {
+  export 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 {
+  /**
+   * Path param: The ID of the project to update.
+   */
+  project_id: string;
+
+  /**
+   * Body param: Identifier of the role to assign.
+   */
+  role_id: string;
+}
+
+export interface RoleRetrieveParams {
+  /**
+   * The ID of the project to inspect.
+   */
+  project_id: string;
+
+  /**
+   * The ID of the group to inspect.
+   */
+  group_id: string;
+}
+
+export interface RoleListParams extends NextCursorPageParams {
+  /**
+   * Path param: The ID of the project to inspect.
+   */
+  project_id: string;
+
+  /**
+   * Query param: Sort order for the returned project roles.
+   */
+  order?: 'asc' | 'desc';
+}
+
+export interface RoleDeleteParams {
+  /**
+   * The ID of the project to modify.
+   */
+  project_id: string;
+
+  /**
+   * The ID of the group whose project role assignment should be removed.
+   */
+  group_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,
+  };
+}

package/dist/node_modules/openai/src/resources/admin/organization/projects/groups.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './groups/index';

package/dist/node_modules/openai/src/resources/admin/organization/projects/hosted-tool-permissions.ts

@@ -0,0 +1,217 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import { APIPromise } from '../../../../core/api-promise';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+export class HostedToolPermissions extends APIResource {
+  /**
+   * Returns hosted tool permissions for a project.
+   *
+   * @example
+   * ```ts
+   * const projectHostedToolPermissions =
+   *   await client.admin.organization.projects.hostedToolPermissions.retrieve(
+   *     'project_id',
+   *   );
+   * ```
+   */
+  retrieve(projectID: string, options?: RequestOptions): APIPromise<ProjectHostedToolPermissions> {
+    return this._client.get(path`/organization/projects/${projectID}/hosted_tool_permissions`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Updates hosted tool permissions for a project.
+   *
+   * @example
+   * ```ts
+   * const projectHostedToolPermissions =
+   *   await client.admin.organization.projects.hostedToolPermissions.update(
+   *     'project_id',
+   *   );
+   * ```
+   */
+  update(
+    projectID: string,
+    body: HostedToolPermissionUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ProjectHostedToolPermissions> {
+    return this._client.post(path`/organization/projects/${projectID}/hosted_tool_permissions`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+/**
+ * Represents hosted tool permissions for a project.
+ */
+export interface ProjectHostedToolPermissions {
+  /**
+   * Permission state for a single hosted tool on a project.
+   */
+  code_interpreter: ProjectHostedToolPermissions.CodeInterpreter;
+
+  /**
+   * Permission state for a single hosted tool on a project.
+   */
+  file_search: ProjectHostedToolPermissions.FileSearch;
+
+  /**
+   * Permission state for a single hosted tool on a project.
+   */
+  image_generation: ProjectHostedToolPermissions.ImageGeneration;
+
+  /**
+   * Permission state for a single hosted tool on a project.
+   */
+  mcp: ProjectHostedToolPermissions.Mcp;
+
+  /**
+   * Permission state for a single hosted tool on a project.
+   */
+  web_search: ProjectHostedToolPermissions.WebSearch;
+}
+
+export namespace ProjectHostedToolPermissions {
+  /**
+   * Permission state for a single hosted tool on a project.
+   */
+  export interface CodeInterpreter {
+    /**
+     * Whether the hosted tool is enabled for the project.
+     */
+    enabled: boolean;
+  }
+
+  /**
+   * Permission state for a single hosted tool on a project.
+   */
+  export interface FileSearch {
+    /**
+     * Whether the hosted tool is enabled for the project.
+     */
+    enabled: boolean;
+  }
+
+  /**
+   * Permission state for a single hosted tool on a project.
+   */
+  export interface ImageGeneration {
+    /**
+     * Whether the hosted tool is enabled for the project.
+     */
+    enabled: boolean;
+  }
+
+  /**
+   * Permission state for a single hosted tool on a project.
+   */
+  export interface Mcp {
+    /**
+     * Whether the hosted tool is enabled for the project.
+     */
+    enabled: boolean;
+  }
+
+  /**
+   * Permission state for a single hosted tool on a project.
+   */
+  export interface WebSearch {
+    /**
+     * Whether the hosted tool is enabled for the project.
+     */
+    enabled: boolean;
+  }
+}
+
+export interface HostedToolPermissionUpdateParams {
+  /**
+   * The code interpreter permission update.
+   */
+  code_interpreter?: HostedToolPermissionUpdateParams.CodeInterpreter | null;
+
+  /**
+   * The file search permission update.
+   */
+  file_search?: HostedToolPermissionUpdateParams.FileSearch | null;
+
+  /**
+   * The image generation permission update.
+   */
+  image_generation?: HostedToolPermissionUpdateParams.ImageGeneration | null;
+
+  /**
+   * The MCP permission update.
+   */
+  mcp?: HostedToolPermissionUpdateParams.Mcp | null;
+
+  /**
+   * The web search permission update.
+   */
+  web_search?: HostedToolPermissionUpdateParams.WebSearch | null;
+}
+
+export namespace HostedToolPermissionUpdateParams {
+  /**
+   * The code interpreter permission update.
+   */
+  export interface CodeInterpreter {
+    /**
+     * Whether to enable the hosted tool for the project.
+     */
+    enabled: boolean;
+  }
+
+  /**
+   * The file search permission update.
+   */
+  export interface FileSearch {
+    /**
+     * Whether to enable the hosted tool for the project.
+     */
+    enabled: boolean;
+  }
+
+  /**
+   * The image generation permission update.
+   */
+  export interface ImageGeneration {
+    /**
+     * Whether to enable the hosted tool for the project.
+     */
+    enabled: boolean;
+  }
+
+  /**
+   * The MCP permission update.
+   */
+  export interface Mcp {
+    /**
+     * Whether to enable the hosted tool for the project.
+     */
+    enabled: boolean;
+  }
+
+  /**
+   * The web search permission update.
+   */
+  export interface WebSearch {
+    /**
+     * Whether to enable the hosted tool for the project.
+     */
+    enabled: boolean;
+  }
+}
+
+export declare namespace HostedToolPermissions {
+  export {
+    type ProjectHostedToolPermissions as ProjectHostedToolPermissions,
+    type HostedToolPermissionUpdateParams as HostedToolPermissionUpdateParams,
+  };
+}

package/dist/node_modules/openai/src/resources/admin/organization/projects/index.ts

@@ -0,0 +1,102 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  APIKeys,
+  type ProjectAPIKey,
+  type APIKeyDeleteResponse,
+  type APIKeyRetrieveParams,
+  type APIKeyListParams,
+  type APIKeyDeleteParams,
+  type ProjectAPIKeysPage,
+} from './api-keys';
+export {
+  Certificates,
+  type CertificateListResponse,
+  type CertificateActivateResponse,
+  type CertificateDeactivateResponse,
+  type CertificateListParams,
+  type CertificateActivateParams,
+  type CertificateDeactivateParams,
+  type CertificateListResponsesPage,
+  type CertificateActivateResponsesPage,
+  type CertificateDeactivateResponsesPage,
+} from './certificates';
+export { DataRetention, type ProjectDataRetention, type DataRetentionUpdateParams } from './data-retention';
+export {
+  Groups,
+  type ProjectGroup,
+  type GroupDeleteResponse,
+  type GroupCreateParams,
+  type GroupRetrieveParams,
+  type GroupListParams,
+  type GroupDeleteParams,
+  type ProjectGroupsPage,
+} from './groups/index';
+export {
+  HostedToolPermissions,
+  type ProjectHostedToolPermissions,
+  type HostedToolPermissionUpdateParams,
+} from './hosted-tool-permissions';
+export {
+  ModelPermissions,
+  type ProjectModelPermissions,
+  type ProjectModelPermissionsDeleted,
+  type ModelPermissionUpdateParams,
+} from './model-permissions';
+export {
+  Projects,
+  type Project,
+  type ProjectCreateParams,
+  type ProjectUpdateParams,
+  type ProjectListParams,
+  type ProjectsPage,
+} from './projects';
+export {
+  RateLimits,
+  type ProjectRateLimit,
+  type RateLimitListRateLimitsParams,
+  type RateLimitUpdateRateLimitParams,
+  type ProjectRateLimitsPage,
+} from './rate-limits';
+export {
+  Roles,
+  type RoleDeleteResponse,
+  type RoleCreateParams,
+  type RoleRetrieveParams,
+  type RoleUpdateParams,
+  type RoleListParams,
+  type RoleDeleteParams,
+} from './roles';
+export {
+  ServiceAccounts,
+  type ProjectServiceAccount,
+  type ServiceAccountCreateResponse,
+  type ServiceAccountDeleteResponse,
+  type ServiceAccountCreateParams,
+  type ServiceAccountRetrieveParams,
+  type ServiceAccountUpdateParams,
+  type ServiceAccountListParams,
+  type ServiceAccountDeleteParams,
+  type ProjectServiceAccountsPage,
+} from './service-accounts';
+export {
+  SpendAlerts,
+  type ProjectSpendAlert,
+  type ProjectSpendAlertDeleted,
+  type SpendAlertCreateParams,
+  type SpendAlertUpdateParams,
+  type SpendAlertListParams,
+  type SpendAlertDeleteParams,
+  type ProjectSpendAlertsPage,
+} from './spend-alerts';
+export {
+  Users,
+  type ProjectUser,
+  type UserDeleteResponse,
+  type UserCreateParams,
+  type UserRetrieveParams,
+  type UserUpdateParams,
+  type UserListParams,
+  type UserDeleteParams,
+  type ProjectUsersPage,
+} from './users/index';