@nocobase/plugin-ai 2.1.7 → 2.1.8

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

@@ -0,0 +1,232 @@
+// 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 { NextCursorPage, type NextCursorPageParams, PagePromise } from '../../../../core/pagination';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+export class Users extends APIResource {
+  /**
+   * Adds a user to a group.
+   *
+   * @example
+   * ```ts
+   * const user =
+   *   await client.admin.organization.groups.users.create(
+   *     'group_id',
+   *     { user_id: 'user_id' },
+   *   );
+   * ```
+   */
+  create(groupID: string, body: UserCreateParams, options?: RequestOptions): APIPromise<UserCreateResponse> {
+    return this._client.post(path`/organization/groups/${groupID}/users`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Retrieves a user in a group.
+   *
+   * @example
+   * ```ts
+   * const user =
+   *   await client.admin.organization.groups.users.retrieve(
+   *     'user_id',
+   *     { group_id: 'group_id' },
+   *   );
+   * ```
+   */
+  retrieve(
+    userID: string,
+    params: UserRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<UserRetrieveResponse> {
+    const { group_id } = params;
+    return this._client.get(path`/organization/groups/${group_id}/users/${userID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Lists the users assigned to a group.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const organizationGroupUser of client.admin.organization.groups.users.list(
+   *   'group_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    groupID: string,
+    query: UserListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<OrganizationGroupUsersPage, OrganizationGroupUser> {
+    return this._client.getAPIList(
+      path`/organization/groups/${groupID}/users`,
+      NextCursorPage<OrganizationGroupUser>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Removes a user from a group.
+   *
+   * @example
+   * ```ts
+   * const user =
+   *   await client.admin.organization.groups.users.delete(
+   *     'user_id',
+   *     { group_id: 'group_id' },
+   *   );
+   * ```
+   */
+  delete(userID: string, params: UserDeleteParams, options?: RequestOptions): APIPromise<UserDeleteResponse> {
+    const { group_id } = params;
+    return this._client.delete(path`/organization/groups/${group_id}/users/${userID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type OrganizationGroupUsersPage = NextCursorPage<OrganizationGroupUser>;
+
+/**
+ * Represents an individual user returned when inspecting group membership.
+ */
+export interface OrganizationGroupUser {
+  /**
+   * The identifier, which can be referenced in API endpoints
+   */
+  id: string;
+
+  /**
+   * The email address of the user.
+   */
+  email: string | null;
+
+  /**
+   * The name of the user.
+   */
+  name: string;
+}
+
+/**
+ * Confirmation payload returned after adding a user to a group.
+ */
+export interface UserCreateResponse {
+  /**
+   * Identifier of the group the user was added to.
+   */
+  group_id: string;
+
+  /**
+   * Always `group.user`.
+   */
+  object: 'group.user';
+
+  /**
+   * Identifier of the user that was added.
+   */
+  user_id: string;
+}
+
+/**
+ * Details about a user returned from an organization group membership lookup.
+ */
+export interface UserRetrieveResponse {
+  /**
+   * Identifier for the user.
+   */
+  id: string;
+
+  /**
+   * Email address of the user, or `null` for users without an email.
+   */
+  email: string | null;
+
+  /**
+   * Whether the user is a service account.
+   */
+  is_service_account: boolean | null;
+
+  /**
+   * Display name of the user.
+   */
+  name: string;
+
+  /**
+   * URL of the user's profile picture, if available.
+   */
+  picture: string | null;
+
+  /**
+   * The type of user.
+   */
+  user_type: 'user' | 'tenant_user';
+}
+
+/**
+ * Confirmation payload returned after removing a user from a group.
+ */
+export interface UserDeleteResponse {
+  /**
+   * Whether the group membership was removed.
+   */
+  deleted: boolean;
+
+  /**
+   * Always `group.user.deleted`.
+   */
+  object: 'group.user.deleted';
+}
+
+export interface UserCreateParams {
+  /**
+   * Identifier of the user to add to the group.
+   */
+  user_id: string;
+}
+
+export interface UserRetrieveParams {
+  /**
+   * The ID of the group to inspect.
+   */
+  group_id: string;
+}
+
+export interface UserListParams extends NextCursorPageParams {
+  /**
+   * Specifies the sort order of users in the list.
+   */
+  order?: 'asc' | 'desc';
+}
+
+export interface UserDeleteParams {
+  /**
+   * The ID of the group to update.
+   */
+  group_id: string;
+}
+
+export declare namespace Users {
+  export {
+    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,
+  };
+}

package/dist/node_modules/openai/src/resources/admin/organization/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/index.ts

@@ -0,0 +1,117 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  AdminAPIKeys,
+  type AdminAPIKey,
+  type AdminAPIKeyCreateResponse,
+  type AdminAPIKeyDeleteResponse,
+  type AdminAPIKeyCreateParams,
+  type AdminAPIKeyListParams,
+  type AdminAPIKeysPage,
+} from './admin-api-keys';
+export {
+  AuditLogs,
+  type AuditLogListResponse,
+  type AuditLogListParams,
+  type AuditLogListResponsesPage,
+} from './audit-logs';
+export {
+  Certificates,
+  type Certificate,
+  type CertificateListResponse,
+  type CertificateDeleteResponse,
+  type CertificateActivateResponse,
+  type CertificateDeactivateResponse,
+  type CertificateCreateParams,
+  type CertificateRetrieveParams,
+  type CertificateUpdateParams,
+  type CertificateListParams,
+  type CertificateActivateParams,
+  type CertificateDeactivateParams,
+  type CertificateListResponsesPage,
+  type CertificateActivateResponsesPage,
+  type CertificateDeactivateResponsesPage,
+} from './certificates';
+export {
+  DataRetention,
+  type OrganizationDataRetention,
+  type DataRetentionUpdateParams,
+} from './data-retention';
+export {
+  Groups,
+  type Group,
+  type GroupUpdateResponse,
+  type GroupDeleteResponse,
+  type GroupCreateParams,
+  type GroupUpdateParams,
+  type GroupListParams,
+  type GroupsPage,
+} from './groups/index';
+export {
+  Invites,
+  type Invite,
+  type InviteDeleteResponse,
+  type InviteCreateParams,
+  type InviteListParams,
+  type InvitesPage,
+} from './invites';
+export { Organization } from './organization';
+export {
+  Projects,
+  type Project,
+  type ProjectCreateParams,
+  type ProjectUpdateParams,
+  type ProjectListParams,
+  type ProjectsPage,
+} from './projects/index';
+export {
+  Roles,
+  type Role,
+  type RoleDeleteResponse,
+  type RoleCreateParams,
+  type RoleUpdateParams,
+  type RoleListParams,
+  type RolesPage,
+} from './roles';
+export {
+  SpendAlerts,
+  type OrganizationSpendAlert,
+  type OrganizationSpendAlertDeleted,
+  type SpendAlertCreateParams,
+  type SpendAlertUpdateParams,
+  type SpendAlertListParams,
+  type OrganizationSpendAlertsPage,
+} from './spend-alerts';
+export {
+  Usage,
+  type UsageAudioSpeechesResponse,
+  type UsageAudioTranscriptionsResponse,
+  type UsageCodeInterpreterSessionsResponse,
+  type UsageCompletionsResponse,
+  type UsageCostsResponse,
+  type UsageEmbeddingsResponse,
+  type UsageFileSearchCallsResponse,
+  type UsageImagesResponse,
+  type UsageModerationsResponse,
+  type UsageVectorStoresResponse,
+  type UsageWebSearchCallsResponse,
+  type UsageAudioSpeechesParams,
+  type UsageAudioTranscriptionsParams,
+  type UsageCodeInterpreterSessionsParams,
+  type UsageCompletionsParams,
+  type UsageCostsParams,
+  type UsageEmbeddingsParams,
+  type UsageFileSearchCallsParams,
+  type UsageImagesParams,
+  type UsageModerationsParams,
+  type UsageVectorStoresParams,
+  type UsageWebSearchCallsParams,
+} from './usage';
+export {
+  Users,
+  type OrganizationUser,
+  type UserDeleteResponse,
+  type UserUpdateParams,
+  type UserListParams,
+  type OrganizationUsersPage,
+} from './users/index';

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

@@ -0,0 +1,215 @@
+// 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 {
+  ConversationCursorPage,
+  type ConversationCursorPageParams,
+  PagePromise,
+} from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Invites extends APIResource {
+  /**
+   * Create an invite for a user to the organization. The invite must be accepted by
+   * the user before they have access to the organization.
+   *
+   * @example
+   * ```ts
+   * const invite =
+   *   await client.admin.organization.invites.create({
+   *     email: 'email',
+   *     role: 'reader',
+   *   });
+   * ```
+   */
+  create(body: InviteCreateParams, options?: RequestOptions): APIPromise<Invite> {
+    return this._client.post('/organization/invites', {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Retrieves an invite.
+   *
+   * @example
+   * ```ts
+   * const invite =
+   *   await client.admin.organization.invites.retrieve(
+   *     'invite_id',
+   *   );
+   * ```
+   */
+  retrieve(inviteID: string, options?: RequestOptions): APIPromise<Invite> {
+    return this._client.get(path`/organization/invites/${inviteID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Returns a list of invites in the organization.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const invite of client.admin.organization.invites.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: InviteListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<InvitesPage, Invite> {
+    return this._client.getAPIList('/organization/invites', ConversationCursorPage<Invite>, {
+      query,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Delete an invite. If the invite has already been accepted, it cannot be deleted.
+   *
+   * @example
+   * ```ts
+   * const invite =
+   *   await client.admin.organization.invites.delete(
+   *     'invite_id',
+   *   );
+   * ```
+   */
+  delete(inviteID: string, options?: RequestOptions): APIPromise<InviteDeleteResponse> {
+    return this._client.delete(path`/organization/invites/${inviteID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type InvitesPage = ConversationCursorPage<Invite>;
+
+/**
+ * Represents an individual `invite` to the organization.
+ */
+export interface Invite {
+  /**
+   * The identifier, which can be referenced in API endpoints
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) of when the invite was sent.
+   */
+  created_at: number;
+
+  /**
+   * The email address of the individual to whom the invite was sent
+   */
+  email: string;
+
+  /**
+   * The object type, which is always `organization.invite`
+   */
+  object: 'organization.invite';
+
+  /**
+   * The projects that were granted membership upon acceptance of the invite.
+   */
+  projects: Array<Invite.Project>;
+
+  /**
+   * `owner` or `reader`
+   */
+  role: 'owner' | 'reader';
+
+  /**
+   * `accepted`,`expired`, or `pending`
+   */
+  status: 'accepted' | 'expired' | 'pending';
+
+  /**
+   * The Unix timestamp (in seconds) of when the invite was accepted.
+   */
+  accepted_at?: number | null;
+
+  /**
+   * The Unix timestamp (in seconds) of when the invite expires.
+   */
+  expires_at?: number | null;
+}
+
+export namespace Invite {
+  export interface Project {
+    /**
+     * Project's public ID
+     */
+    id: string;
+
+    /**
+     * Project membership role
+     */
+    role: 'member' | 'owner';
+  }
+}
+
+export interface InviteDeleteResponse {
+  id: string;
+
+  deleted: boolean;
+
+  /**
+   * The object type, which is always `organization.invite.deleted`
+   */
+  object: 'organization.invite.deleted';
+}
+
+export interface InviteCreateParams {
+  /**
+   * Send an email to this address
+   */
+  email: string;
+
+  /**
+   * `owner` or `reader`
+   */
+  role: 'reader' | 'owner';
+
+  /**
+   * An array of projects to which membership is granted at the same time the org
+   * invite is accepted. If omitted, the user will be invited to the default project
+   * for compatibility with legacy behavior. If empty list is passed, the user will
+   * not be invited to any projects, including the default one.
+   */
+  projects?: Array<InviteCreateParams.Project>;
+}
+
+export namespace InviteCreateParams {
+  export interface Project {
+    /**
+     * Project's public ID
+     */
+    id: string;
+
+    /**
+     * Project membership role
+     */
+    role: 'member' | 'owner';
+  }
+}
+
+export interface InviteListParams extends ConversationCursorPageParams {}
+
+export declare namespace Invites {
+  export {
+    type Invite as Invite,
+    type InviteDeleteResponse as InviteDeleteResponse,
+    type InvitesPage as InvitesPage,
+    type InviteCreateParams as InviteCreateParams,
+    type InviteListParams as InviteListParams,
+  };
+}