openai 6.35.0 → 6.36.0

package/src/resources/admin/organization/groups/index.ts

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Groups,
+  type Group,
+  type GroupUpdateResponse,
+  type GroupDeleteResponse,
+  type GroupCreateParams,
+  type GroupUpdateParams,
+  type GroupListParams,
+  type GroupsPage,
+} from './groups';
+export {
+  Roles,
+  type RoleCreateResponse,
+  type RoleListResponse,
+  type RoleDeleteResponse,
+  type RoleCreateParams,
+  type RoleListParams,
+  type RoleDeleteParams,
+  type RoleListResponsesPage,
+} from './roles';
+export {
+  Users,
+  type OrganizationGroupUser,
+  type UserCreateResponse,
+  type UserDeleteResponse,
+  type UserCreateParams,
+  type UserListParams,
+  type UserDeleteParams,
+  type OrganizationGroupUsersPage,
+} from './users';

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

@@ -0,0 +1,239 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as RolesAPI 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 {
+  /**
+   * Assigns an organization role to a group within the organization.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.groups.roles.create(
+   *     'group_id',
+   *     { role_id: 'role_id' },
+   *   );
+   * ```
+   */
+  create(groupID: string, body: RoleCreateParams, options?: RequestOptions): APIPromise<RoleCreateResponse> {
+    return this._client.post(path`/organization/groups/${groupID}/roles`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Lists the organization roles assigned to a group within the organization.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const roleListResponse of client.admin.organization.groups.roles.list(
+   *   'group_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    groupID: string,
+    query: RoleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RoleListResponsesPage, RoleListResponse> {
+    return this._client.getAPIList(
+      path`/organization/groups/${groupID}/roles`,
+      NextCursorPage<RoleListResponse>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Unassigns an organization role from a group within the organization.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.groups.roles.delete(
+   *     'role_id',
+   *     { group_id: 'group_id' },
+   *   );
+   * ```
+   */
+  delete(roleID: string, params: RoleDeleteParams, options?: RequestOptions): APIPromise<RoleDeleteResponse> {
+    const { group_id } = params;
+    return this._client.delete(path`/organization/groups/${group_id}/roles/${roleID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type RoleListResponsesPage = NextCursorPage<RoleListResponse>;
+
+/**
+ * Role assignment linking a group to a role.
+ */
+export interface RoleCreateResponse {
+  /**
+   * Summary information about a group returned in role assignment responses.
+   */
+  group: RoleCreateResponse.Group;
+
+  /**
+   * Always `group.role`.
+   */
+  object: 'group.role';
+
+  /**
+   * Details about a role that can be assigned through the public Roles API.
+   */
+  role: RolesAPI.Role;
+}
+
+export namespace RoleCreateResponse {
+  /**
+   * Summary information about a group returned in role assignment responses.
+   */
+  export interface Group {
+    /**
+     * Identifier for the group.
+     */
+    id: string;
+
+    /**
+     * Unix timestamp (in seconds) when the group was created.
+     */
+    created_at: number;
+
+    /**
+     * Display name of the group.
+     */
+    name: string;
+
+    /**
+     * Always `group`.
+     */
+    object: 'group';
+
+    /**
+     * Whether the group is managed through SCIM.
+     */
+    scim_managed: boolean;
+  }
+}
+
+/**
+ * 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 {
+  /**
+   * Identifier of the role to assign.
+   */
+  role_id: string;
+}
+
+export interface RoleListParams extends NextCursorPageParams {
+  /**
+   * Sort order for the returned organization roles.
+   */
+  order?: 'asc' | 'desc';
+}
+
+export interface RoleDeleteParams {
+  /**
+   * The ID of the group to modify.
+   */
+  group_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/groups/users.ts

@@ -0,0 +1,164 @@
+// 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 },
+    });
+  }
+
+  /**
+   * 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;
+}
+
+/**
+ * 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 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 UserDeleteResponse as UserDeleteResponse,
+    type OrganizationGroupUsersPage as OrganizationGroupUsersPage,
+    type UserCreateParams as UserCreateParams,
+    type UserListParams as UserListParams,
+    type UserDeleteParams as UserDeleteParams,
+  };
+}

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

@@ -0,0 +1,99 @@
+// 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 {
+  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 {
+  Usage,
+  type UsageAudioSpeechesResponse,
+  type UsageAudioTranscriptionsResponse,
+  type UsageCodeInterpreterSessionsResponse,
+  type UsageCompletionsResponse,
+  type UsageCostsResponse,
+  type UsageEmbeddingsResponse,
+  type UsageImagesResponse,
+  type UsageModerationsResponse,
+  type UsageVectorStoresResponse,
+  type UsageAudioSpeechesParams,
+  type UsageAudioTranscriptionsParams,
+  type UsageCodeInterpreterSessionsParams,
+  type UsageCompletionsParams,
+  type UsageCostsParams,
+  type UsageEmbeddingsParams,
+  type UsageImagesParams,
+  type UsageModerationsParams,
+  type UsageVectorStoresParams,
+} from './usage';
+export {
+  Users,
+  type OrganizationUser,
+  type UserDeleteResponse,
+  type UserUpdateParams,
+  type UserListParams,
+  type OrganizationUsersPage,
+} from './users/index';