@nocobase/plugin-ai 2.1.6 → 2.1.8

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

@@ -0,0 +1,153 @@
+import { APIResource } from "../../../core/resource.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { NextCursorPage, type NextCursorPageParams, PagePromise } from "../../../core/pagination.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+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.ts.map

package/dist/node_modules/openai/resources/admin/organization/roles.js

@@ -0,0 +1,96 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Roles = void 0;
+const resource_1 = require("../../../core/resource.js");
+const pagination_1 = require("../../../core/pagination.js");
+const path_1 = require("../../../internal/utils/path.js");
+class Roles extends resource_1.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, options) {
+        return this._client.post('/organization/roles', {
+            body,
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+    /**
+     * Retrieves an organization role.
+     *
+     * @example
+     * ```ts
+     * const role = await client.admin.organization.roles.retrieve(
+     *   'role_id',
+     * );
+     * ```
+     */
+    retrieve(roleID, options) {
+        return this._client.get((0, path_1.path) `/organization/roles/${roleID}`, {
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+    /**
+     * Updates an existing organization role.
+     *
+     * @example
+     * ```ts
+     * const role = await client.admin.organization.roles.update(
+     *   'role_id',
+     * );
+     * ```
+     */
+    update(roleID, body, options) {
+        return this._client.post((0, path_1.path) `/organization/roles/${roleID}`, {
+            body,
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+    /**
+     * 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 = {}, options) {
+        return this._client.getAPIList('/organization/roles', (pagination_1.NextCursorPage), {
+            query,
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+    /**
+     * Deletes a custom role from the organization.
+     *
+     * @example
+     * ```ts
+     * const role = await client.admin.organization.roles.delete(
+     *   'role_id',
+     * );
+     * ```
+     */
+    delete(roleID, options) {
+        return this._client.delete((0, path_1.path) `/organization/roles/${roleID}`, {
+            ...options,
+            __security: { adminAPIKeyAuth: true },
+        });
+    }
+}
+exports.Roles = Roles;
+//# sourceMappingURL=roles.js.map

package/dist/node_modules/openai/resources/admin/organization/spend-alerts.d.mts

@@ -0,0 +1,224 @@
+import { APIResource } from "../../../core/resource.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 SpendAlerts extends APIResource {
+    /**
+     * Creates an organization spend alert.
+     *
+     * @example
+     * ```ts
+     * const organizationSpendAlert =
+     *   await client.admin.organization.spendAlerts.create({
+     *     currency: 'USD',
+     *     interval: 'month',
+     *     notification_channel: {
+     *       recipients: ['string'],
+     *       type: 'email',
+     *     },
+     *     threshold_amount: 0,
+     *   });
+     * ```
+     */
+    create(body: SpendAlertCreateParams, options?: RequestOptions): APIPromise<OrganizationSpendAlert>;
+    /**
+     * Updates an organization spend alert.
+     *
+     * @example
+     * ```ts
+     * const organizationSpendAlert =
+     *   await client.admin.organization.spendAlerts.update(
+     *     'alert_id',
+     *     {
+     *       currency: 'USD',
+     *       interval: 'month',
+     *       notification_channel: {
+     *         recipients: ['string'],
+     *         type: 'email',
+     *       },
+     *       threshold_amount: 0,
+     *     },
+     *   );
+     * ```
+     */
+    update(alertID: string, body: SpendAlertUpdateParams, options?: RequestOptions): APIPromise<OrganizationSpendAlert>;
+    /**
+     * Lists organization spend alerts.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const organizationSpendAlert of client.admin.organization.spendAlerts.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: SpendAlertListParams | null | undefined, options?: RequestOptions): PagePromise<OrganizationSpendAlertsPage, OrganizationSpendAlert>;
+    /**
+     * Deletes an organization spend alert.
+     *
+     * @example
+     * ```ts
+     * const organizationSpendAlertDeleted =
+     *   await client.admin.organization.spendAlerts.delete(
+     *     'alert_id',
+     *   );
+     * ```
+     */
+    delete(alertID: string, options?: RequestOptions): APIPromise<OrganizationSpendAlertDeleted>;
+}
+export type OrganizationSpendAlertsPage = ConversationCursorPage<OrganizationSpendAlert>;
+/**
+ * Represents a spend alert configured at the organization level.
+ */
+export interface OrganizationSpendAlert {
+    /**
+     * 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: OrganizationSpendAlert.NotificationChannel;
+    /**
+     * The object type, which is always `organization.spend_alert`.
+     */
+    object: 'organization.spend_alert';
+    /**
+     * The alert threshold amount, in cents.
+     */
+    threshold_amount: number;
+}
+export declare namespace OrganizationSpendAlert {
+    /**
+     * Email notification settings for a spend alert.
+     */
+    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 an organization spend alert.
+ */
+export interface OrganizationSpendAlertDeleted {
+    /**
+     * The deleted spend alert ID.
+     */
+    id: string;
+    /**
+     * Whether the spend alert was deleted.
+     */
+    deleted: boolean;
+    /**
+     * Always `organization.spend_alert.deleted`.
+     */
+    object: 'organization.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 declare namespace SpendAlertCreateParams {
+    /**
+     * Email notification settings for a spend alert.
+     */
+    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 {
+    /**
+     * 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: SpendAlertUpdateParams.NotificationChannel;
+    /**
+     * The alert threshold amount, in cents.
+     */
+    threshold_amount: number;
+}
+export declare namespace SpendAlertUpdateParams {
+    /**
+     * Email notification settings for a spend alert.
+     */
+    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 declare namespace SpendAlerts {
+    export { type OrganizationSpendAlert as OrganizationSpendAlert, type OrganizationSpendAlertDeleted as OrganizationSpendAlertDeleted, type OrganizationSpendAlertsPage as OrganizationSpendAlertsPage, type SpendAlertCreateParams as SpendAlertCreateParams, type SpendAlertUpdateParams as SpendAlertUpdateParams, type SpendAlertListParams as SpendAlertListParams, };
+}
+//# sourceMappingURL=spend-alerts.d.mts.map

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

@@ -0,0 +1,224 @@
+import { APIResource } from "../../../core/resource.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 SpendAlerts extends APIResource {
+    /**
+     * Creates an organization spend alert.
+     *
+     * @example
+     * ```ts
+     * const organizationSpendAlert =
+     *   await client.admin.organization.spendAlerts.create({
+     *     currency: 'USD',
+     *     interval: 'month',
+     *     notification_channel: {
+     *       recipients: ['string'],
+     *       type: 'email',
+     *     },
+     *     threshold_amount: 0,
+     *   });
+     * ```
+     */
+    create(body: SpendAlertCreateParams, options?: RequestOptions): APIPromise<OrganizationSpendAlert>;
+    /**
+     * Updates an organization spend alert.
+     *
+     * @example
+     * ```ts
+     * const organizationSpendAlert =
+     *   await client.admin.organization.spendAlerts.update(
+     *     'alert_id',
+     *     {
+     *       currency: 'USD',
+     *       interval: 'month',
+     *       notification_channel: {
+     *         recipients: ['string'],
+     *         type: 'email',
+     *       },
+     *       threshold_amount: 0,
+     *     },
+     *   );
+     * ```
+     */
+    update(alertID: string, body: SpendAlertUpdateParams, options?: RequestOptions): APIPromise<OrganizationSpendAlert>;
+    /**
+     * Lists organization spend alerts.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const organizationSpendAlert of client.admin.organization.spendAlerts.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: SpendAlertListParams | null | undefined, options?: RequestOptions): PagePromise<OrganizationSpendAlertsPage, OrganizationSpendAlert>;
+    /**
+     * Deletes an organization spend alert.
+     *
+     * @example
+     * ```ts
+     * const organizationSpendAlertDeleted =
+     *   await client.admin.organization.spendAlerts.delete(
+     *     'alert_id',
+     *   );
+     * ```
+     */
+    delete(alertID: string, options?: RequestOptions): APIPromise<OrganizationSpendAlertDeleted>;
+}
+export type OrganizationSpendAlertsPage = ConversationCursorPage<OrganizationSpendAlert>;
+/**
+ * Represents a spend alert configured at the organization level.
+ */
+export interface OrganizationSpendAlert {
+    /**
+     * 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: OrganizationSpendAlert.NotificationChannel;
+    /**
+     * The object type, which is always `organization.spend_alert`.
+     */
+    object: 'organization.spend_alert';
+    /**
+     * The alert threshold amount, in cents.
+     */
+    threshold_amount: number;
+}
+export declare namespace OrganizationSpendAlert {
+    /**
+     * Email notification settings for a spend alert.
+     */
+    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 an organization spend alert.
+ */
+export interface OrganizationSpendAlertDeleted {
+    /**
+     * The deleted spend alert ID.
+     */
+    id: string;
+    /**
+     * Whether the spend alert was deleted.
+     */
+    deleted: boolean;
+    /**
+     * Always `organization.spend_alert.deleted`.
+     */
+    object: 'organization.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 declare namespace SpendAlertCreateParams {
+    /**
+     * Email notification settings for a spend alert.
+     */
+    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 {
+    /**
+     * 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: SpendAlertUpdateParams.NotificationChannel;
+    /**
+     * The alert threshold amount, in cents.
+     */
+    threshold_amount: number;
+}
+export declare namespace SpendAlertUpdateParams {
+    /**
+     * Email notification settings for a spend alert.
+     */
+    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 declare namespace SpendAlerts {
+    export { type OrganizationSpendAlert as OrganizationSpendAlert, type OrganizationSpendAlertDeleted as OrganizationSpendAlertDeleted, type OrganizationSpendAlertsPage as OrganizationSpendAlertsPage, type SpendAlertCreateParams as SpendAlertCreateParams, type SpendAlertUpdateParams as SpendAlertUpdateParams, type SpendAlertListParams as SpendAlertListParams, };
+}
+//# sourceMappingURL=spend-alerts.d.ts.map