openai 6.35.0 → 6.37.0

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

@@ -0,0 +1,20 @@
+// 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 OrganizationUser,
+  type UserDeleteResponse,
+  type UserUpdateParams,
+  type UserListParams,
+  type OrganizationUsersPage,
+} from './users';

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

@@ -0,0 +1,208 @@
+// 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';
+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 user within the organization.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.users.roles.create(
+   *     'user_id',
+   *     { role_id: 'role_id' },
+   *   );
+   * ```
+   */
+  create(userID: string, body: RoleCreateParams, options?: RequestOptions): APIPromise<RoleCreateResponse> {
+    return this._client.post(path`/organization/users/${userID}/roles`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Lists the organization roles assigned to a user within the organization.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const roleListResponse of client.admin.organization.users.roles.list(
+   *   'user_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    userID: string,
+    query: RoleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RoleListResponsesPage, RoleListResponse> {
+    return this._client.getAPIList(
+      path`/organization/users/${userID}/roles`,
+      NextCursorPage<RoleListResponse>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Unassigns an organization role from a user within the organization.
+   *
+   * @example
+   * ```ts
+   * const role =
+   *   await client.admin.organization.users.roles.delete(
+   *     'role_id',
+   *     { user_id: 'user_id' },
+   *   );
+   * ```
+   */
+  delete(roleID: string, params: RoleDeleteParams, options?: RequestOptions): APIPromise<RoleDeleteResponse> {
+    const { user_id } = params;
+    return this._client.delete(path`/organization/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 {
+  /**
+   * 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 user to modify.
+   */
+  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/users/users.ts

@@ -0,0 +1,287 @@
+// 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);
+
+  /**
+   * Retrieves a user by their identifier.
+   *
+   * @example
+   * ```ts
+   * const organizationUser =
+   *   await client.admin.organization.users.retrieve('user_id');
+   * ```
+   */
+  retrieve(userID: string, options?: RequestOptions): APIPromise<OrganizationUser> {
+    return this._client.get(path`/organization/users/${userID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Modifies a user's role in the organization.
+   *
+   * @example
+   * ```ts
+   * const organizationUser =
+   *   await client.admin.organization.users.update('user_id');
+   * ```
+   */
+  update(userID: string, body: UserUpdateParams, options?: RequestOptions): APIPromise<OrganizationUser> {
+    return this._client.post(path`/organization/users/${userID}`, {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Lists all of the users in the organization.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const organizationUser of client.admin.organization.users.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: UserListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<OrganizationUsersPage, OrganizationUser> {
+    return this._client.getAPIList('/organization/users', ConversationCursorPage<OrganizationUser>, {
+      query,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Deletes a user from the organization.
+   *
+   * @example
+   * ```ts
+   * const user = await client.admin.organization.users.delete(
+   *   'user_id',
+   * );
+   * ```
+   */
+  delete(userID: string, options?: RequestOptions): APIPromise<UserDeleteResponse> {
+    return this._client.delete(path`/organization/users/${userID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type OrganizationUsersPage = ConversationCursorPage<OrganizationUser>;
+
+/**
+ * Represents an individual `user` within an organization.
+ */
+export interface OrganizationUser {
+  /**
+   * The identifier, which can be referenced in API endpoints
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) of when the user was added.
+   */
+  added_at: number;
+
+  /**
+   * The object type, which is always `organization.user`
+   */
+  object: 'organization.user';
+
+  /**
+   * The Unix timestamp (in seconds) of the user's last API key usage.
+   */
+  api_key_last_used_at?: number | null;
+
+  /**
+   * The Unix timestamp (in seconds) of when the user was created.
+   */
+  created?: number;
+
+  /**
+   * The developer persona metadata for the user.
+   */
+  developer_persona?: string | null;
+
+  /**
+   * The email address of the user
+   */
+  email?: string | null;
+
+  /**
+   * Whether this is the organization's default user.
+   */
+  is_default?: boolean;
+
+  /**
+   * Whether the user is an authorized purchaser for Scale Tier.
+   */
+  is_scale_tier_authorized_purchaser?: boolean | null;
+
+  /**
+   * Whether the user is managed through SCIM.
+   */
+  is_scim_managed?: boolean;
+
+  /**
+   * Whether the user is a service account.
+   */
+  is_service_account?: boolean;
+
+  /**
+   * The name of the user
+   */
+  name?: string | null;
+
+  /**
+   * Projects associated with the user, if included.
+   */
+  projects?: OrganizationUser.Projects | null;
+
+  /**
+   * `owner` or `reader`
+   */
+  role?: string | null;
+
+  /**
+   * The technical level metadata for the user.
+   */
+  technical_level?: string | null;
+
+  /**
+   * Nested user details.
+   */
+  user?: OrganizationUser.User;
+}
+
+export namespace OrganizationUser {
+  /**
+   * Projects associated with the user, if included.
+   */
+  export interface Projects {
+    data: Array<Projects.Data>;
+
+    object: 'list';
+  }
+
+  export namespace Projects {
+    export interface Data {
+      id?: string | null;
+
+      name?: string | null;
+
+      role?: string | null;
+    }
+  }
+
+  /**
+   * Nested user details.
+   */
+  export interface User {
+    id: string;
+
+    object: 'user';
+
+    banned?: boolean | null;
+
+    banned_at?: number | null;
+
+    email?: string | null;
+
+    enabled?: boolean | null;
+
+    name?: string | null;
+
+    picture?: string | null;
+  }
+}
+
+export interface UserDeleteResponse {
+  id: string;
+
+  deleted: boolean;
+
+  object: 'organization.user.deleted';
+}
+
+export interface UserUpdateParams {
+  /**
+   * Developer persona metadata.
+   */
+  developer_persona?: string | null;
+
+  /**
+   * `owner` or `reader`
+   */
+  role?: string | null;
+
+  /**
+   * Role ID to assign to the user.
+   */
+  role_id?: string | null;
+
+  /**
+   * Technical level metadata.
+   */
+  technical_level?: string | null;
+}
+
+export interface UserListParams extends ConversationCursorPageParams {
+  /**
+   * Filter by the email address of users.
+   */
+  emails?: Array<string>;
+}
+
+Users.Roles = Roles;
+
+export declare namespace Users {
+  export {
+    type OrganizationUser as OrganizationUser,
+    type UserDeleteResponse as UserDeleteResponse,
+    type OrganizationUsersPage as OrganizationUsersPage,
+    type UserUpdateParams as UserUpdateParams,
+    type UserListParams as UserListParams,
+  };
+
+  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/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.ts

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

package/src/resources/admin.ts

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

package/src/resources/audio/speech.ts

@@ -31,6 +31,7 @@ export class Speech extends APIResource {
       body,
       ...options,
       headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
+      __security: { bearerAuth: true },
       __binaryResponse: true,
     });
   }

package/src/resources/audio/transcriptions.ts

@@ -61,6 +61,7 @@ export class Transcriptions extends APIResource {
           ...options,
           stream: body.stream ?? false,
           __metadata: { model: body.model },
+          __security: { bearerAuth: true },
         },
         this._client,
       ),

package/src/resources/audio/translations.ts

@@ -39,7 +39,10 @@ export class Translations extends APIResource {
   ): APIPromise<TranslationCreateResponse | string> {
     return this._client.post(
       '/audio/translations',
-      multipartFormRequestOptions({ body, ...options, __metadata: { model: body.model } }, this._client),
+      multipartFormRequestOptions(
+        { body, ...options, __metadata: { model: body.model }, __security: { bearerAuth: true } },
+        this._client,
+      ),
     );
   }
 }

package/src/resources/batches.ts

@@ -16,14 +16,14 @@ export class Batches extends APIResource {
    * Creates and executes a batch from an uploaded file of requests
    */
   create(body: BatchCreateParams, options?: RequestOptions): APIPromise<Batch> {
-    return this._client.post('/batches', { body, ...options });
+    return this._client.post('/batches', { body, ...options, __security: { bearerAuth: true } });
   }
 
   /**
    * Retrieves a batch.
    */
   retrieve(batchID: string, options?: RequestOptions): APIPromise<Batch> {
-    return this._client.get(path`/batches/${batchID}`, options);
+    return this._client.get(path`/batches/${batchID}`, { ...options, __security: { bearerAuth: true } });
   }
 
   /**
@@ -33,7 +33,11 @@ export class Batches extends APIResource {
     query: BatchListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<BatchesPage, Batch> {
-    return this._client.getAPIList('/batches', CursorPage<Batch>, { query, ...options });
+    return this._client.getAPIList('/batches', CursorPage<Batch>, {
+      query,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 
   /**
@@ -42,7 +46,10 @@ export class Batches extends APIResource {
    * (if any) available in the output file.
    */
   cancel(batchID: string, options?: RequestOptions): APIPromise<Batch> {
-    return this._client.post(path`/batches/${batchID}/cancel`, options);
+    return this._client.post(path`/batches/${batchID}/cancel`, {
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 

package/src/resources/beta/assistants.ts

@@ -27,6 +27,7 @@ export class Assistants extends APIResource {
       body,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -39,6 +40,7 @@ export class Assistants extends APIResource {
     return this._client.get(path`/assistants/${assistantID}`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -52,6 +54,7 @@ export class Assistants extends APIResource {
       body,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -68,6 +71,7 @@ export class Assistants extends APIResource {
       query,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -80,6 +84,7 @@ export class Assistants extends APIResource {
     return this._client.delete(path`/assistants/${assistantID}`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 }

package/src/resources/beta/chatkit/sessions.ts

@@ -25,6 +25,7 @@ export class Sessions extends APIResource {
       body,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'chatkit_beta=v1' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -43,6 +44,7 @@ export class Sessions extends APIResource {
     return this._client.post(path`/chatkit/sessions/${sessionID}/cancel`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'chatkit_beta=v1' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 }

package/src/resources/beta/chatkit/threads.ts

@@ -26,6 +26,7 @@ export class Threads extends APIResource {
     return this._client.get(path`/chatkit/threads/${threadID}`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'chatkit_beta=v1' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -48,6 +49,7 @@ export class Threads extends APIResource {
       query,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'chatkit_beta=v1' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -65,6 +67,7 @@ export class Threads extends APIResource {
     return this._client.delete(path`/chatkit/threads/${threadID}`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'chatkit_beta=v1' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -104,7 +107,12 @@ export class Threads extends APIResource {
         | ChatKitThreadItemList.ChatKitTask
         | ChatKitThreadItemList.ChatKitTaskGroup
       >,
-      { query, ...options, headers: buildHeaders([{ 'OpenAI-Beta': 'chatkit_beta=v1' }, options?.headers]) },
+      {
+        query,
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'chatkit_beta=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      },
     );
   }
 }

package/src/resources/beta/realtime/sessions.ts

@@ -26,6 +26,7 @@ export class Sessions extends APIResource {
       body,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 }