@nocobase/plugin-ai 2.1.7 → 2.1.9

package/dist/node_modules/openai/src/resources/admin/organization/projects/spend-alerts.ts

@@ -0,0 +1,332 @@
+// 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 SpendAlerts extends APIResource {
+  /**
+   * Creates a project spend alert.
+   *
+   * @example
+   * ```ts
+   * const projectSpendAlert =
+   *   await client.admin.organization.projects.spendAlerts.create(
+   *     'project_id',
+   *     {
+   *       currency: 'USD',
+   *       interval: 'month',
+   *       notification_channel: {
+   *         recipients: ['string'],
+   *         type: 'email',
+   *       },
+   *       threshold_amount: 0,
+   *     },
+   *   );
+   * ```
+   */
+  create(
+    projectID: string,
+    body: SpendAlertCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ProjectSpendAlert> {
+    return this._client.post(path`/organization/projects/${projectID}/spend_alerts`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Updates a project spend alert.
+   *
+   * @example
+   * ```ts
+   * const projectSpendAlert =
+   *   await client.admin.organization.projects.spendAlerts.update(
+   *     'alert_id',
+   *     {
+   *       project_id: 'project_id',
+   *       currency: 'USD',
+   *       interval: 'month',
+   *       notification_channel: {
+   *         recipients: ['string'],
+   *         type: 'email',
+   *       },
+   *       threshold_amount: 0,
+   *     },
+   *   );
+   * ```
+   */
+  update(
+    alertID: string,
+    params: SpendAlertUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ProjectSpendAlert> {
+    const { project_id, ...body } = params;
+    return this._client.post(path`/organization/projects/${project_id}/spend_alerts/${alertID}`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Lists project spend alerts.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const projectSpendAlert of client.admin.organization.projects.spendAlerts.list(
+   *   'project_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    projectID: string,
+    query: SpendAlertListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProjectSpendAlertsPage, ProjectSpendAlert> {
+    return this._client.getAPIList(
+      path`/organization/projects/${projectID}/spend_alerts`,
+      ConversationCursorPage<ProjectSpendAlert>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Deletes a project spend alert.
+   *
+   * @example
+   * ```ts
+   * const projectSpendAlertDeleted =
+   *   await client.admin.organization.projects.spendAlerts.delete(
+   *     'alert_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  delete(
+    alertID: string,
+    params: SpendAlertDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<ProjectSpendAlertDeleted> {
+    const { project_id } = params;
+    return this._client.delete(path`/organization/projects/${project_id}/spend_alerts/${alertID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type ProjectSpendAlertsPage = ConversationCursorPage<ProjectSpendAlert>;
+
+/**
+ * Represents a spend alert configured at the project level.
+ */
+export interface ProjectSpendAlert {
+  /**
+   * The identifier, which can be referenced in API endpoints.
+   */
+  id: string;
+
+  /**
+   * The currency for the threshold amount.
+   */
+  currency: 'USD';
+
+  /**
+   * The time interval for evaluating spend against the threshold.
+   */
+  interval: 'month';
+
+  /**
+   * Email notification settings for a spend alert.
+   */
+  notification_channel: ProjectSpendAlert.NotificationChannel;
+
+  /**
+   * The object type, which is always `project.spend_alert`.
+   */
+  object: 'project.spend_alert';
+
+  /**
+   * The alert threshold amount, in cents.
+   */
+  threshold_amount: number;
+}
+
+export namespace ProjectSpendAlert {
+  /**
+   * Email notification settings for a spend alert.
+   */
+  export interface NotificationChannel {
+    /**
+     * Email addresses that receive the spend alert notification.
+     */
+    recipients: Array<string>;
+
+    /**
+     * The notification channel type. Currently only `email` is supported.
+     */
+    type: 'email';
+
+    /**
+     * Optional subject prefix for alert emails.
+     */
+    subject_prefix?: string | null;
+  }
+}
+
+/**
+ * Confirmation payload returned after deleting a project spend alert.
+ */
+export interface ProjectSpendAlertDeleted {
+  /**
+   * The deleted spend alert ID.
+   */
+  id: string;
+
+  /**
+   * Whether the spend alert was deleted.
+   */
+  deleted: boolean;
+
+  /**
+   * Always `project.spend_alert.deleted`.
+   */
+  object: 'project.spend_alert.deleted';
+}
+
+export interface SpendAlertCreateParams {
+  /**
+   * The currency for the threshold amount.
+   */
+  currency: 'USD';
+
+  /**
+   * The time interval for evaluating spend against the threshold.
+   */
+  interval: 'month';
+
+  /**
+   * Email notification settings for a spend alert.
+   */
+  notification_channel: SpendAlertCreateParams.NotificationChannel;
+
+  /**
+   * The alert threshold amount, in cents.
+   */
+  threshold_amount: number;
+}
+
+export namespace SpendAlertCreateParams {
+  /**
+   * Email notification settings for a spend alert.
+   */
+  export interface NotificationChannel {
+    /**
+     * Email addresses that receive the spend alert notification.
+     */
+    recipients: Array<string>;
+
+    /**
+     * The notification channel type. Currently only `email` is supported.
+     */
+    type: 'email';
+
+    /**
+     * Optional subject prefix for alert emails.
+     */
+    subject_prefix?: string | null;
+  }
+}
+
+export interface SpendAlertUpdateParams {
+  /**
+   * Path param: The ID of the project to update.
+   */
+  project_id: string;
+
+  /**
+   * Body param: The currency for the threshold amount.
+   */
+  currency: 'USD';
+
+  /**
+   * Body param: The time interval for evaluating spend against the threshold.
+   */
+  interval: 'month';
+
+  /**
+   * Body param: Email notification settings for a spend alert.
+   */
+  notification_channel: SpendAlertUpdateParams.NotificationChannel;
+
+  /**
+   * Body param: The alert threshold amount, in cents.
+   */
+  threshold_amount: number;
+}
+
+export namespace SpendAlertUpdateParams {
+  /**
+   * Email notification settings for a spend alert.
+   */
+  export interface NotificationChannel {
+    /**
+     * Email addresses that receive the spend alert notification.
+     */
+    recipients: Array<string>;
+
+    /**
+     * The notification channel type. Currently only `email` is supported.
+     */
+    type: 'email';
+
+    /**
+     * Optional subject prefix for alert emails.
+     */
+    subject_prefix?: string | null;
+  }
+}
+
+export interface SpendAlertListParams extends ConversationCursorPageParams {
+  /**
+   * Cursor for pagination. Provide the ID of the first spend alert from the previous
+   * response to fetch the previous page.
+   */
+  before?: string;
+
+  /**
+   * Sort order for the returned spend alerts.
+   */
+  order?: 'asc' | 'desc';
+}
+
+export interface SpendAlertDeleteParams {
+  /**
+   * The ID of the project to update.
+   */
+  project_id: string;
+}
+
+export declare namespace SpendAlerts {
+  export {
+    type ProjectSpendAlert as ProjectSpendAlert,
+    type ProjectSpendAlertDeleted as ProjectSpendAlertDeleted,
+    type ProjectSpendAlertsPage as ProjectSpendAlertsPage,
+    type SpendAlertCreateParams as SpendAlertCreateParams,
+    type SpendAlertUpdateParams as SpendAlertUpdateParams,
+    type SpendAlertListParams as SpendAlertListParams,
+    type SpendAlertDeleteParams as SpendAlertDeleteParams,
+  };
+}

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

@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+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 ProjectUser,
+  type UserDeleteResponse,
+  type UserCreateParams,
+  type UserRetrieveParams,
+  type UserUpdateParams,
+  type UserListParams,
+  type UserDeleteParams,
+  type ProjectUsersPage,
+} from './users';

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

@@ -0,0 +1,351 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import * as RolesAPI from '../../roles';
+import * as UsersAPI from '../../users/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 Roles extends APIResource {
+  /**
+   * Assigns a project role to a user within a project.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.projects.users.roles.create(
+   *     'user_id',
+   *     { project_id: 'project_id', role_id: 'role_id' },
+   *   );
+   * ```
+   */
+  create(userID: string, params: RoleCreateParams, options?: RequestOptions): APIPromise<RoleCreateResponse> {
+    const { project_id, ...body } = params;
+    return this._client.post(path`/projects/${project_id}/users/${userID}/roles`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Retrieves a project role assigned to a user.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.projects.users.roles.retrieve(
+   *     'role_id',
+   *     { project_id: 'project_id', user_id: 'user_id' },
+   *   );
+   * ```
+   */
+  retrieve(
+    roleID: string,
+    params: RoleRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<RoleRetrieveResponse> {
+    const { project_id, user_id } = params;
+    return this._client.get(path`/projects/${project_id}/users/${user_id}/roles/${roleID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Lists the project roles assigned to a user within a project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const roleListResponse of client.admin.organization.projects.users.roles.list(
+   *   'user_id',
+   *   { project_id: 'project_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    userID: string,
+    params: RoleListParams,
+    options?: RequestOptions,
+  ): PagePromise<RoleListResponsesPage, RoleListResponse> {
+    const { project_id, ...query } = params;
+    return this._client.getAPIList(
+      path`/projects/${project_id}/users/${userID}/roles`,
+      NextCursorPage<RoleListResponse>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Unassigns a project role from a user within a project.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.projects.users.roles.delete(
+   *     'role_id',
+   *     { project_id: 'project_id', user_id: 'user_id' },
+   *   );
+   * ```
+   */
+  delete(roleID: string, params: RoleDeleteParams, options?: RequestOptions): APIPromise<RoleDeleteResponse> {
+    const { project_id, user_id } = params;
+    return this._client.delete(path`/projects/${project_id}/users/${user_id}/roles/${roleID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+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 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 user to inspect.
+   */
+  user_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 user whose project role assignment should be removed.
+   */
+  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,
+  };
+}