@nocobase/plugin-ai 2.1.6 → 2.1.8

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

@@ -0,0 +1,277 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as RolesAPI from './roles';
+import {
+  RoleCreateParams,
+  RoleCreateResponse,
+  RoleDeleteParams,
+  RoleDeleteResponse,
+  RoleListParams,
+  RoleListResponse,
+  RoleListResponsesPage,
+  RoleRetrieveParams,
+  RoleRetrieveResponse,
+  Roles,
+} from './roles';
+import * as UsersAPI from './users';
+import {
+  OrganizationGroupUser,
+  OrganizationGroupUsersPage,
+  UserCreateParams,
+  UserCreateResponse,
+  UserDeleteParams,
+  UserDeleteResponse,
+  UserListParams,
+  UserRetrieveParams,
+  UserRetrieveResponse,
+  Users,
+} from './users';
+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 Groups extends APIResource {
+  users: UsersAPI.Users = new UsersAPI.Users(this._client);
+  roles: RolesAPI.Roles = new RolesAPI.Roles(this._client);
+
+  /**
+   * Creates a new group in the organization.
+   *
+   * @example
+   * ```ts
+   * const group = await client.admin.organization.groups.create(
+   *   { name: 'x' },
+   * );
+   * ```
+   */
+  create(body: GroupCreateParams, options?: RequestOptions): APIPromise<Group> {
+    return this._client.post('/organization/groups', {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Retrieves a group.
+   *
+   * @example
+   * ```ts
+   * const group =
+   *   await client.admin.organization.groups.retrieve(
+   *     'group_id',
+   *   );
+   * ```
+   */
+  retrieve(groupID: string, options?: RequestOptions): APIPromise<Group> {
+    return this._client.get(path`/organization/groups/${groupID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Updates a group's information.
+   *
+   * @example
+   * ```ts
+   * const group = await client.admin.organization.groups.update(
+   *   'group_id',
+   *   { name: 'x' },
+   * );
+   * ```
+   */
+  update(
+    groupID: string,
+    body: GroupUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<GroupUpdateResponse> {
+    return this._client.post(path`/organization/groups/${groupID}`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Lists all groups in the organization.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const group of client.admin.organization.groups.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: GroupListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<GroupsPage, Group> {
+    return this._client.getAPIList('/organization/groups', NextCursorPage<Group>, {
+      query,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Deletes a group from the organization.
+   *
+   * @example
+   * ```ts
+   * const group = await client.admin.organization.groups.delete(
+   *   'group_id',
+   * );
+   * ```
+   */
+  delete(groupID: string, options?: RequestOptions): APIPromise<GroupDeleteResponse> {
+    return this._client.delete(path`/organization/groups/${groupID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type GroupsPage = NextCursorPage<Group>;
+
+/**
+ * Details about an organization group.
+ */
+export interface Group {
+  /**
+   * Identifier for the group.
+   */
+  id: string;
+
+  /**
+   * Unix timestamp (in seconds) when the group was created.
+   */
+  created_at: number;
+
+  /**
+   * The type of the group.
+   */
+  group_type: 'group' | 'tenant_group';
+
+  /**
+   * Whether the group is managed through SCIM and controlled by your identity
+   * provider.
+   */
+  is_scim_managed: boolean;
+
+  /**
+   * Display name of the group.
+   */
+  name: string;
+}
+
+/**
+ * Response returned after updating a group.
+ */
+export interface GroupUpdateResponse {
+  /**
+   * Identifier for the group.
+   */
+  id: string;
+
+  /**
+   * Unix timestamp (in seconds) when the group was created.
+   */
+  created_at: number;
+
+  /**
+   * Whether the group is managed through SCIM and controlled by your identity
+   * provider.
+   */
+  is_scim_managed: boolean;
+
+  /**
+   * Updated display name for the group.
+   */
+  name: string;
+}
+
+/**
+ * Confirmation payload returned after deleting a group.
+ */
+export interface GroupDeleteResponse {
+  /**
+   * Identifier of the deleted group.
+   */
+  id: string;
+
+  /**
+   * Whether the group was deleted.
+   */
+  deleted: boolean;
+
+  /**
+   * Always `group.deleted`.
+   */
+  object: 'group.deleted';
+}
+
+export interface GroupCreateParams {
+  /**
+   * Human readable name for the group.
+   */
+  name: string;
+}
+
+export interface GroupUpdateParams {
+  /**
+   * New display name for the group.
+   */
+  name: string;
+}
+
+export interface GroupListParams extends NextCursorPageParams {
+  /**
+   * Specifies the sort order of the returned groups.
+   */
+  order?: 'asc' | 'desc';
+}
+
+Groups.Users = Users;
+Groups.Roles = Roles;
+
+export declare namespace Groups {
+  export {
+    type Group as Group,
+    type GroupUpdateResponse as GroupUpdateResponse,
+    type GroupDeleteResponse as GroupDeleteResponse,
+    type GroupsPage as GroupsPage,
+    type GroupCreateParams as GroupCreateParams,
+    type GroupUpdateParams as GroupUpdateParams,
+    type GroupListParams as GroupListParams,
+  };
+
+  export {
+    Users as Users,
+    type OrganizationGroupUser as OrganizationGroupUser,
+    type UserCreateResponse as UserCreateResponse,
+    type UserRetrieveResponse as UserRetrieveResponse,
+    type UserDeleteResponse as UserDeleteResponse,
+    type OrganizationGroupUsersPage as OrganizationGroupUsersPage,
+    type UserCreateParams as UserCreateParams,
+    type UserRetrieveParams as UserRetrieveParams,
+    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,
+  };
+}

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

@@ -0,0 +1,36 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Groups,
+  type Group,
+  type GroupUpdateResponse,
+  type GroupDeleteResponse,
+  type GroupCreateParams,
+  type GroupUpdateParams,
+  type GroupListParams,
+  type GroupsPage,
+} from './groups';
+export {
+  Roles,
+  type RoleCreateResponse,
+  type RoleRetrieveResponse,
+  type RoleListResponse,
+  type RoleDeleteResponse,
+  type RoleCreateParams,
+  type RoleRetrieveParams,
+  type RoleListParams,
+  type RoleDeleteParams,
+  type RoleListResponsesPage,
+} from './roles';
+export {
+  Users,
+  type OrganizationGroupUser,
+  type UserCreateResponse,
+  type UserRetrieveResponse,
+  type UserDeleteResponse,
+  type UserCreateParams,
+  type UserRetrieveParams,
+  type UserListParams,
+  type UserDeleteParams,
+  type OrganizationGroupUsersPage,
+} from './users';

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

@@ -0,0 +1,359 @@
+// 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 an organization role to a group within the organization.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.groups.roles.create(
+   *     'group_id',
+   *     { role_id: 'role_id' },
+   *   );
+   * ```
+   */
+  create(groupID: string, body: RoleCreateParams, options?: RequestOptions): APIPromise<RoleCreateResponse> {
+    return this._client.post(path`/organization/groups/${groupID}/roles`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Retrieves an organization role assigned to a group.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.groups.roles.retrieve(
+   *     'role_id',
+   *     { group_id: 'group_id' },
+   *   );
+   * ```
+   */
+  retrieve(
+    roleID: string,
+    params: RoleRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<RoleRetrieveResponse> {
+    const { group_id } = params;
+    return this._client.get(path`/organization/groups/${group_id}/roles/${roleID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Lists the organization roles assigned to a group within the organization.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const roleListResponse of client.admin.organization.groups.roles.list(
+   *   'group_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    groupID: string,
+    query: RoleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RoleListResponsesPage, RoleListResponse> {
+    return this._client.getAPIList(
+      path`/organization/groups/${groupID}/roles`,
+      NextCursorPage<RoleListResponse>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Unassigns an organization role from a group within the organization.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.groups.roles.delete(
+   *     'role_id',
+   *     { group_id: 'group_id' },
+   *   );
+   * ```
+   */
+  delete(roleID: string, params: RoleDeleteParams, options?: RequestOptions): APIPromise<RoleDeleteResponse> {
+    const { group_id } = params;
+    return this._client.delete(path`/organization/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 {
+  /**
+   * Identifier of the role to assign.
+   */
+  role_id: string;
+}
+
+export interface RoleRetrieveParams {
+  /**
+   * The ID of the group to inspect.
+   */
+  group_id: string;
+}
+
+export interface RoleListParams extends NextCursorPageParams {
+  /**
+   * Sort order for the returned organization roles.
+   */
+  order?: 'asc' | 'desc';
+}
+
+export interface RoleDeleteParams {
+  /**
+   * The ID of the group to modify.
+   */
+  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,
+  };
+}