openai 6.35.0 → 6.36.0

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

@@ -0,0 +1,226 @@
+// 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 },
+    });
+  }
+
+  /**
+   * 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 RoleListResponse {
+  /**
+   * Identifier for the role.
+   */
+  id: string;
+
+  /**
+   * 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;
+}
+
+/**
+ * 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 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 RoleListResponse as RoleListResponse,
+    type RoleDeleteResponse as RoleDeleteResponse,
+    type RoleListResponsesPage as RoleListResponsesPage,
+    type RoleCreateParams as RoleCreateParams,
+    type RoleListParams as RoleListParams,
+    type RoleDeleteParams as RoleDeleteParams,
+  };
+}

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

@@ -0,0 +1,252 @@
+// 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,
+  Roles,
+} from './roles';
+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 Users extends APIResource {
+  roles: RolesAPI.Roles = new RolesAPI.Roles(this._client);
+
+  /**
+   * Adds a user to the project. Users must already be members of the organization to
+   * be added to a project.
+   *
+   * @example
+   * ```ts
+   * const projectUser =
+   *   await client.admin.organization.projects.users.create(
+   *     'project_id',
+   *     { role: 'role' },
+   *   );
+   * ```
+   */
+  create(projectID: string, body: UserCreateParams, options?: RequestOptions): APIPromise<ProjectUser> {
+    return this._client.post(path`/organization/projects/${projectID}/users`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Retrieves a user in the project.
+   *
+   * @example
+   * ```ts
+   * const projectUser =
+   *   await client.admin.organization.projects.users.retrieve(
+   *     'user_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  retrieve(userID: string, params: UserRetrieveParams, options?: RequestOptions): APIPromise<ProjectUser> {
+    const { project_id } = params;
+    return this._client.get(path`/organization/projects/${project_id}/users/${userID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Modifies a user's role in the project.
+   *
+   * @example
+   * ```ts
+   * const projectUser =
+   *   await client.admin.organization.projects.users.update(
+   *     'user_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  update(userID: string, params: UserUpdateParams, options?: RequestOptions): APIPromise<ProjectUser> {
+    const { project_id, ...body } = params;
+    return this._client.post(path`/organization/projects/${project_id}/users/${userID}`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Returns a list of users in the project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const projectUser of client.admin.organization.projects.users.list(
+   *   'project_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    projectID: string,
+    query: UserListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProjectUsersPage, ProjectUser> {
+    return this._client.getAPIList(
+      path`/organization/projects/${projectID}/users`,
+      ConversationCursorPage<ProjectUser>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Deletes a user from the project.
+   *
+   * Returns confirmation of project user deletion, or an error if the project is
+   * archived (archived projects have no users).
+   *
+   * @example
+   * ```ts
+   * const user =
+   *   await client.admin.organization.projects.users.delete(
+   *     'user_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  delete(userID: string, params: UserDeleteParams, options?: RequestOptions): APIPromise<UserDeleteResponse> {
+    const { project_id } = params;
+    return this._client.delete(path`/organization/projects/${project_id}/users/${userID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type ProjectUsersPage = ConversationCursorPage<ProjectUser>;
+
+/**
+ * Represents an individual user in a project.
+ */
+export interface ProjectUser {
+  /**
+   * The identifier, which can be referenced in API endpoints
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) of when the project was added.
+   */
+  added_at: number;
+
+  /**
+   * The object type, which is always `organization.project.user`
+   */
+  object: 'organization.project.user';
+
+  /**
+   * `owner` or `member`
+   */
+  role: string;
+
+  /**
+   * The email address of the user
+   */
+  email?: string | null;
+
+  /**
+   * The name of the user
+   */
+  name?: string | null;
+}
+
+export interface UserDeleteResponse {
+  id: string;
+
+  deleted: boolean;
+
+  object: 'organization.project.user.deleted';
+}
+
+export interface UserCreateParams {
+  /**
+   * `owner` or `member`
+   */
+  role: string;
+
+  /**
+   * Email of the user to add.
+   */
+  email?: string | null;
+
+  /**
+   * The ID of the user.
+   */
+  user_id?: string | null;
+}
+
+export interface UserRetrieveParams {
+  /**
+   * The ID of the project.
+   */
+  project_id: string;
+}
+
+export interface UserUpdateParams {
+  /**
+   * Path param: The ID of the project.
+   */
+  project_id: string;
+
+  /**
+   * Body param: `owner` or `member`
+   */
+  role?: string | null;
+}
+
+export interface UserListParams extends ConversationCursorPageParams {}
+
+export interface UserDeleteParams {
+  /**
+   * The ID of the project.
+   */
+  project_id: string;
+}
+
+Users.Roles = Roles;
+
+export declare namespace Users {
+  export {
+    type ProjectUser as ProjectUser,
+    type UserDeleteResponse as UserDeleteResponse,
+    type ProjectUsersPage as ProjectUsersPage,
+    type UserCreateParams as UserCreateParams,
+    type UserRetrieveParams as UserRetrieveParams,
+    type UserUpdateParams as UserUpdateParams,
+    type UserListParams as UserListParams,
+    type UserDeleteParams as UserDeleteParams,
+  };
+
+  export {
+    Roles as Roles,
+    type RoleCreateResponse as RoleCreateResponse,
+    type RoleListResponse as RoleListResponse,
+    type RoleDeleteResponse as RoleDeleteResponse,
+    type RoleListResponsesPage as RoleListResponsesPage,
+    type RoleCreateParams as RoleCreateParams,
+    type RoleListParams as RoleListParams,
+    type RoleDeleteParams as RoleDeleteParams,
+  };
+}

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

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './users/index';

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

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './projects/index';

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

@@ -0,0 +1,200 @@
+// 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 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> {
+    return this._client.post('/organization/roles', {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * 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> {
+    return this._client.post(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: RoleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RolesPage, Role> {
+    return this._client.getAPIList('/organization/roles', NextCursorPage<Role>, {
+      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: string, options?: RequestOptions): APIPromise<RoleDeleteResponse> {
+    return this._client.delete(path`/organization/roles/${roleID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+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,
+  };
+}