openai 6.35.0 → 6.37.0

package/src/resources/admin/organization/projects/rate-limits.ts

@@ -0,0 +1,173 @@
+// 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 RateLimits extends APIResource {
+  /**
+   * Returns the rate limits per model for a project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const projectRateLimit of client.admin.organization.projects.rateLimits.listRateLimits(
+   *   'project_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  listRateLimits(
+    projectID: string,
+    query: RateLimitListRateLimitsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProjectRateLimitsPage, ProjectRateLimit> {
+    return this._client.getAPIList(
+      path`/organization/projects/${projectID}/rate_limits`,
+      ConversationCursorPage<ProjectRateLimit>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Updates a project rate limit.
+   *
+   * @example
+   * ```ts
+   * const projectRateLimit =
+   *   await client.admin.organization.projects.rateLimits.updateRateLimit(
+   *     'rate_limit_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  updateRateLimit(
+    rateLimitID: string,
+    params: RateLimitUpdateRateLimitParams,
+    options?: RequestOptions,
+  ): APIPromise<ProjectRateLimit> {
+    const { project_id, ...body } = params;
+    return this._client.post(path`/organization/projects/${project_id}/rate_limits/${rateLimitID}`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type ProjectRateLimitsPage = ConversationCursorPage<ProjectRateLimit>;
+
+/**
+ * Represents a project rate limit config.
+ */
+export interface ProjectRateLimit {
+  /**
+   * The identifier, which can be referenced in API endpoints.
+   */
+  id: string;
+
+  /**
+   * The maximum requests per minute.
+   */
+  max_requests_per_1_minute: number;
+
+  /**
+   * The maximum tokens per minute.
+   */
+  max_tokens_per_1_minute: number;
+
+  /**
+   * The model this rate limit applies to.
+   */
+  model: string;
+
+  /**
+   * The object type, which is always `project.rate_limit`
+   */
+  object: 'project.rate_limit';
+
+  /**
+   * The maximum batch input tokens per day. Only present for relevant models.
+   */
+  batch_1_day_max_input_tokens?: number;
+
+  /**
+   * The maximum audio megabytes per minute. Only present for relevant models.
+   */
+  max_audio_megabytes_per_1_minute?: number;
+
+  /**
+   * The maximum images per minute. Only present for relevant models.
+   */
+  max_images_per_1_minute?: number;
+
+  /**
+   * The maximum requests per day. Only present for relevant models.
+   */
+  max_requests_per_1_day?: number;
+}
+
+export interface RateLimitListRateLimitsParams extends ConversationCursorPageParams {
+  /**
+   * A cursor for use in pagination. `before` is an object ID that defines your place
+   * in the list. For instance, if you make a list request and receive 100 objects,
+   * beginning with obj_foo, your subsequent call can include before=obj_foo in order
+   * to fetch the previous page of the list.
+   */
+  before?: string;
+}
+
+export interface RateLimitUpdateRateLimitParams {
+  /**
+   * Path param: The ID of the project.
+   */
+  project_id: string;
+
+  /**
+   * Body param: The maximum batch input tokens per day. Only relevant for certain
+   * models.
+   */
+  batch_1_day_max_input_tokens?: number;
+
+  /**
+   * Body param: The maximum audio megabytes per minute. Only relevant for certain
+   * models.
+   */
+  max_audio_megabytes_per_1_minute?: number;
+
+  /**
+   * Body param: The maximum images per minute. Only relevant for certain models.
+   */
+  max_images_per_1_minute?: number;
+
+  /**
+   * Body param: The maximum requests per day. Only relevant for certain models.
+   */
+  max_requests_per_1_day?: number;
+
+  /**
+   * Body param: The maximum requests per minute.
+   */
+  max_requests_per_1_minute?: number;
+
+  /**
+   * Body param: The maximum tokens per minute.
+   */
+  max_tokens_per_1_minute?: number;
+}
+
+export declare namespace RateLimits {
+  export {
+    type ProjectRateLimit as ProjectRateLimit,
+    type ProjectRateLimitsPage as ProjectRateLimitsPage,
+    type RateLimitListRateLimitsParams as RateLimitListRateLimitsParams,
+    type RateLimitUpdateRateLimitParams as RateLimitUpdateRateLimitParams,
+  };
+}

package/src/resources/admin/organization/projects/roles.ts

@@ -0,0 +1,182 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as RolesAPI from '../roles';
+import { RolesPage } 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 {
+  /**
+   * Creates a custom role for a project.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.projects.roles.create(
+   *     'project_id',
+   *     { permissions: ['string'], role_name: 'role_name' },
+   *   );
+   * ```
+   */
+  create(projectID: string, body: RoleCreateParams, options?: RequestOptions): APIPromise<RolesAPI.Role> {
+    return this._client.post(path`/projects/${projectID}/roles`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Updates an existing project role.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.projects.roles.update(
+   *     'role_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  update(roleID: string, params: RoleUpdateParams, options?: RequestOptions): APIPromise<RolesAPI.Role> {
+    const { project_id, ...body } = params;
+    return this._client.post(path`/projects/${project_id}/roles/${roleID}`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Lists the roles configured for a project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const role of client.admin.organization.projects.roles.list(
+   *   'project_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    projectID: string,
+    query: RoleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RolesPage, RolesAPI.Role> {
+    return this._client.getAPIList(path`/projects/${projectID}/roles`, NextCursorPage<RolesAPI.Role>, {
+      query,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Deletes a custom role from a project.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.projects.roles.delete(
+   *     'role_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  delete(roleID: string, params: RoleDeleteParams, options?: RequestOptions): APIPromise<RoleDeleteResponse> {
+    const { project_id } = params;
+    return this._client.delete(path`/projects/${project_id}/roles/${roleID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+/**
+ * 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 {
+  /**
+   * Path param: The ID of the project to update.
+   */
+  project_id: string;
+
+  /**
+   * Body param: New description for the role.
+   */
+  description?: string | null;
+
+  /**
+   * Body param: Updated set of permissions for the role.
+   */
+  permissions?: Array<string> | null;
+
+  /**
+   * Body param: New name for the role.
+   */
+  role_name?: string | null;
+}
+
+export interface RoleListParams extends NextCursorPageParams {
+  /**
+   * Sort order for the returned roles.
+   */
+  order?: 'asc' | 'desc';
+}
+
+export interface RoleDeleteParams {
+  /**
+   * The ID of the project to update.
+   */
+  project_id: string;
+}
+
+export declare namespace Roles {
+  export {
+    type RoleDeleteResponse as RoleDeleteResponse,
+    type RoleCreateParams as RoleCreateParams,
+    type RoleUpdateParams as RoleUpdateParams,
+    type RoleListParams as RoleListParams,
+    type RoleDeleteParams as RoleDeleteParams,
+  };
+}
+
+export { type RolesPage };

package/src/resources/admin/organization/projects/service-accounts.ts

@@ -0,0 +1,224 @@
+// 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 ServiceAccounts extends APIResource {
+  /**
+   * Creates a new service account in the project. This also returns an unredacted
+   * API key for the service account.
+   *
+   * @example
+   * ```ts
+   * const serviceAccount =
+   *   await client.admin.organization.projects.serviceAccounts.create(
+   *     'project_id',
+   *     { name: 'name' },
+   *   );
+   * ```
+   */
+  create(
+    projectID: string,
+    body: ServiceAccountCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ServiceAccountCreateResponse> {
+    return this._client.post(path`/organization/projects/${projectID}/service_accounts`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Retrieves a service account in the project.
+   *
+   * @example
+   * ```ts
+   * const projectServiceAccount =
+   *   await client.admin.organization.projects.serviceAccounts.retrieve(
+   *     'service_account_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  retrieve(
+    serviceAccountID: string,
+    params: ServiceAccountRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ProjectServiceAccount> {
+    const { project_id } = params;
+    return this._client.get(path`/organization/projects/${project_id}/service_accounts/${serviceAccountID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Returns a list of service accounts in the project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const projectServiceAccount of client.admin.organization.projects.serviceAccounts.list(
+   *   'project_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    projectID: string,
+    query: ServiceAccountListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProjectServiceAccountsPage, ProjectServiceAccount> {
+    return this._client.getAPIList(
+      path`/organization/projects/${projectID}/service_accounts`,
+      ConversationCursorPage<ProjectServiceAccount>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Deletes a service account from the project.
+   *
+   * Returns confirmation of service account deletion, or an error if the project is
+   * archived (archived projects have no service accounts).
+   *
+   * @example
+   * ```ts
+   * const serviceAccount =
+   *   await client.admin.organization.projects.serviceAccounts.delete(
+   *     'service_account_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  delete(
+    serviceAccountID: string,
+    params: ServiceAccountDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<ServiceAccountDeleteResponse> {
+    const { project_id } = params;
+    return this._client.delete(
+      path`/organization/projects/${project_id}/service_accounts/${serviceAccountID}`,
+      { ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+}
+
+export type ProjectServiceAccountsPage = ConversationCursorPage<ProjectServiceAccount>;
+
+/**
+ * Represents an individual service account in a project.
+ */
+export interface ProjectServiceAccount {
+  /**
+   * The identifier, which can be referenced in API endpoints
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) of when the service account was created
+   */
+  created_at: number;
+
+  /**
+   * The name of the service account
+   */
+  name: string;
+
+  /**
+   * The object type, which is always `organization.project.service_account`
+   */
+  object: 'organization.project.service_account';
+
+  /**
+   * `owner` or `member`
+   */
+  role: 'owner' | 'member';
+}
+
+export interface ServiceAccountCreateResponse {
+  id: string;
+
+  api_key: ServiceAccountCreateResponse.APIKey | null;
+
+  created_at: number;
+
+  name: string;
+
+  object: 'organization.project.service_account';
+
+  /**
+   * Service accounts can only have one role of type `member`
+   */
+  role: 'member';
+}
+
+export namespace ServiceAccountCreateResponse {
+  export interface APIKey {
+    id: string;
+
+    created_at: number;
+
+    name: string;
+
+    /**
+     * The object type, which is always `organization.project.service_account.api_key`
+     */
+    object: 'organization.project.service_account.api_key';
+
+    value: string;
+  }
+}
+
+export interface ServiceAccountDeleteResponse {
+  id: string;
+
+  deleted: boolean;
+
+  object: 'organization.project.service_account.deleted';
+}
+
+export interface ServiceAccountCreateParams {
+  /**
+   * The name of the service account being created.
+   */
+  name: string;
+}
+
+export interface ServiceAccountRetrieveParams {
+  /**
+   * The ID of the project.
+   */
+  project_id: string;
+}
+
+export interface ServiceAccountListParams extends ConversationCursorPageParams {}
+
+export interface ServiceAccountDeleteParams {
+  /**
+   * The ID of the project.
+   */
+  project_id: string;
+}
+
+export declare namespace ServiceAccounts {
+  export {
+    type ProjectServiceAccount as ProjectServiceAccount,
+    type ServiceAccountCreateResponse as ServiceAccountCreateResponse,
+    type ServiceAccountDeleteResponse as ServiceAccountDeleteResponse,
+    type ProjectServiceAccountsPage as ProjectServiceAccountsPage,
+    type ServiceAccountCreateParams as ServiceAccountCreateParams,
+    type ServiceAccountRetrieveParams as ServiceAccountRetrieveParams,
+    type ServiceAccountListParams as ServiceAccountListParams,
+    type ServiceAccountDeleteParams as ServiceAccountDeleteParams,
+  };
+}

package/src/resources/admin/organization/projects/users/index.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Roles,
+  type RoleCreateResponse,
+  type RoleListResponse,
+  type RoleDeleteResponse,
+  type RoleCreateParams,
+  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';