openai 6.35.0 → 6.36.0

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

@@ -0,0 +1,214 @@
+// 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 Invites extends APIResource {
+  /**
+   * Create an invite for a user to the organization. The invite must be accepted by
+   * the user before they have access to the organization.
+   *
+   * @example
+   * ```ts
+   * const invite =
+   *   await client.admin.organization.invites.create({
+   *     email: 'email',
+   *     role: 'reader',
+   *   });
+   * ```
+   */
+  create(body: InviteCreateParams, options?: RequestOptions): APIPromise<Invite> {
+    return this._client.post('/organization/invites', {
+      body,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Retrieves an invite.
+   *
+   * @example
+   * ```ts
+   * const invite =
+   *   await client.admin.organization.invites.retrieve(
+   *     'invite_id',
+   *   );
+   * ```
+   */
+  retrieve(inviteID: string, options?: RequestOptions): APIPromise<Invite> {
+    return this._client.get(path`/organization/invites/${inviteID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Returns a list of invites in the organization.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const invite of client.admin.organization.invites.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: InviteListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<InvitesPage, Invite> {
+    return this._client.getAPIList('/organization/invites', ConversationCursorPage<Invite>, {
+      query,
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Delete an invite. If the invite has already been accepted, it cannot be deleted.
+   *
+   * @example
+   * ```ts
+   * const invite =
+   *   await client.admin.organization.invites.delete(
+   *     'invite_id',
+   *   );
+   * ```
+   */
+  delete(inviteID: string, options?: RequestOptions): APIPromise<InviteDeleteResponse> {
+    return this._client.delete(path`/organization/invites/${inviteID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type InvitesPage = ConversationCursorPage<Invite>;
+
+/**
+ * Represents an individual `invite` to the organization.
+ */
+export interface Invite {
+  /**
+   * The identifier, which can be referenced in API endpoints
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) of when the invite was sent.
+   */
+  created_at: number;
+
+  /**
+   * The email address of the individual to whom the invite was sent
+   */
+  email: string;
+
+  /**
+   * The object type, which is always `organization.invite`
+   */
+  object: 'organization.invite';
+
+  /**
+   * The projects that were granted membership upon acceptance of the invite.
+   */
+  projects: Array<Invite.Project>;
+
+  /**
+   * `owner` or `reader`
+   */
+  role: 'owner' | 'reader';
+
+  /**
+   * `accepted`,`expired`, or `pending`
+   */
+  status: 'accepted' | 'expired' | 'pending';
+
+  /**
+   * The Unix timestamp (in seconds) of when the invite was accepted.
+   */
+  accepted_at?: number | null;
+
+  /**
+   * The Unix timestamp (in seconds) of when the invite expires.
+   */
+  expires_at?: number | null;
+}
+
+export namespace Invite {
+  export interface Project {
+    /**
+     * Project's public ID
+     */
+    id: string;
+
+    /**
+     * Project membership role
+     */
+    role: 'member' | 'owner';
+  }
+}
+
+export interface InviteDeleteResponse {
+  id: string;
+
+  deleted: boolean;
+
+  /**
+   * The object type, which is always `organization.invite.deleted`
+   */
+  object: 'organization.invite.deleted';
+}
+
+export interface InviteCreateParams {
+  /**
+   * Send an email to this address
+   */
+  email: string;
+
+  /**
+   * `owner` or `reader`
+   */
+  role: 'reader' | 'owner';
+
+  /**
+   * An array of projects to which membership is granted at the same time the org
+   * invite is accepted. If omitted, the user will be invited to the default project
+   * for compatibility with legacy behavior.
+   */
+  projects?: Array<InviteCreateParams.Project>;
+}
+
+export namespace InviteCreateParams {
+  export interface Project {
+    /**
+     * Project's public ID
+     */
+    id: string;
+
+    /**
+     * Project membership role
+     */
+    role: 'member' | 'owner';
+  }
+}
+
+export interface InviteListParams extends ConversationCursorPageParams {}
+
+export declare namespace Invites {
+  export {
+    type Invite as Invite,
+    type InviteDeleteResponse as InviteDeleteResponse,
+    type InvitesPage as InvitesPage,
+    type InviteCreateParams as InviteCreateParams,
+    type InviteListParams as InviteListParams,
+  };
+}

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

@@ -0,0 +1,232 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as AdminAPIKeysAPI from './admin-api-keys';
+import {
+  AdminAPIKey,
+  AdminAPIKeyCreateParams,
+  AdminAPIKeyCreateResponse,
+  AdminAPIKeyDeleteResponse,
+  AdminAPIKeyListParams,
+  AdminAPIKeys,
+  AdminAPIKeysPage,
+} from './admin-api-keys';
+import * as AuditLogsAPI from './audit-logs';
+import { AuditLogListParams, AuditLogListResponse, AuditLogListResponsesPage, AuditLogs } from './audit-logs';
+import * as CertificatesAPI from './certificates';
+import {
+  Certificate,
+  CertificateActivateParams,
+  CertificateActivateResponse,
+  CertificateActivateResponsesPage,
+  CertificateCreateParams,
+  CertificateDeactivateParams,
+  CertificateDeactivateResponse,
+  CertificateDeactivateResponsesPage,
+  CertificateDeleteResponse,
+  CertificateListParams,
+  CertificateListResponse,
+  CertificateListResponsesPage,
+  CertificateRetrieveParams,
+  CertificateUpdateParams,
+  Certificates,
+} from './certificates';
+import * as InvitesAPI from './invites';
+import {
+  Invite,
+  InviteCreateParams,
+  InviteDeleteResponse,
+  InviteListParams,
+  Invites,
+  InvitesPage,
+} from './invites';
+import * as RolesAPI from './roles';
+import {
+  Role,
+  RoleCreateParams,
+  RoleDeleteResponse,
+  RoleListParams,
+  RoleUpdateParams,
+  Roles,
+  RolesPage,
+} from './roles';
+import * as UsageAPI from './usage';
+import {
+  Usage,
+  UsageAudioSpeechesParams,
+  UsageAudioSpeechesResponse,
+  UsageAudioTranscriptionsParams,
+  UsageAudioTranscriptionsResponse,
+  UsageCodeInterpreterSessionsParams,
+  UsageCodeInterpreterSessionsResponse,
+  UsageCompletionsParams,
+  UsageCompletionsResponse,
+  UsageCostsParams,
+  UsageCostsResponse,
+  UsageEmbeddingsParams,
+  UsageEmbeddingsResponse,
+  UsageImagesParams,
+  UsageImagesResponse,
+  UsageModerationsParams,
+  UsageModerationsResponse,
+  UsageVectorStoresParams,
+  UsageVectorStoresResponse,
+} from './usage';
+import * as GroupsAPI from './groups/groups';
+import {
+  Group,
+  GroupCreateParams,
+  GroupDeleteResponse,
+  GroupListParams,
+  GroupUpdateParams,
+  GroupUpdateResponse,
+  Groups,
+  GroupsPage,
+} from './groups/groups';
+import * as ProjectsAPI from './projects/projects';
+import {
+  Project,
+  ProjectCreateParams,
+  ProjectListParams,
+  ProjectUpdateParams,
+  Projects,
+  ProjectsPage,
+} from './projects/projects';
+import * as UsersAPI from './users/users';
+import {
+  OrganizationUser,
+  OrganizationUsersPage,
+  UserDeleteResponse,
+  UserListParams,
+  UserUpdateParams,
+  Users,
+} from './users/users';
+
+export class Organization extends APIResource {
+  auditLogs: AuditLogsAPI.AuditLogs = new AuditLogsAPI.AuditLogs(this._client);
+  adminAPIKeys: AdminAPIKeysAPI.AdminAPIKeys = new AdminAPIKeysAPI.AdminAPIKeys(this._client);
+  usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
+  invites: InvitesAPI.Invites = new InvitesAPI.Invites(this._client);
+  users: UsersAPI.Users = new UsersAPI.Users(this._client);
+  groups: GroupsAPI.Groups = new GroupsAPI.Groups(this._client);
+  roles: RolesAPI.Roles = new RolesAPI.Roles(this._client);
+  certificates: CertificatesAPI.Certificates = new CertificatesAPI.Certificates(this._client);
+  projects: ProjectsAPI.Projects = new ProjectsAPI.Projects(this._client);
+}
+
+Organization.AuditLogs = AuditLogs;
+Organization.AdminAPIKeys = AdminAPIKeys;
+Organization.Usage = Usage;
+Organization.Invites = Invites;
+Organization.Users = Users;
+Organization.Groups = Groups;
+Organization.Roles = Roles;
+Organization.Certificates = Certificates;
+Organization.Projects = Projects;
+
+export declare namespace Organization {
+  export {
+    AuditLogs as AuditLogs,
+    type AuditLogListResponse as AuditLogListResponse,
+    type AuditLogListResponsesPage as AuditLogListResponsesPage,
+    type AuditLogListParams as AuditLogListParams,
+  };
+
+  export {
+    AdminAPIKeys as AdminAPIKeys,
+    type AdminAPIKey as AdminAPIKey,
+    type AdminAPIKeyCreateResponse as AdminAPIKeyCreateResponse,
+    type AdminAPIKeyDeleteResponse as AdminAPIKeyDeleteResponse,
+    type AdminAPIKeysPage as AdminAPIKeysPage,
+    type AdminAPIKeyCreateParams as AdminAPIKeyCreateParams,
+    type AdminAPIKeyListParams as AdminAPIKeyListParams,
+  };
+
+  export {
+    Usage as Usage,
+    type UsageAudioSpeechesResponse as UsageAudioSpeechesResponse,
+    type UsageAudioTranscriptionsResponse as UsageAudioTranscriptionsResponse,
+    type UsageCodeInterpreterSessionsResponse as UsageCodeInterpreterSessionsResponse,
+    type UsageCompletionsResponse as UsageCompletionsResponse,
+    type UsageCostsResponse as UsageCostsResponse,
+    type UsageEmbeddingsResponse as UsageEmbeddingsResponse,
+    type UsageImagesResponse as UsageImagesResponse,
+    type UsageModerationsResponse as UsageModerationsResponse,
+    type UsageVectorStoresResponse as UsageVectorStoresResponse,
+    type UsageAudioSpeechesParams as UsageAudioSpeechesParams,
+    type UsageAudioTranscriptionsParams as UsageAudioTranscriptionsParams,
+    type UsageCodeInterpreterSessionsParams as UsageCodeInterpreterSessionsParams,
+    type UsageCompletionsParams as UsageCompletionsParams,
+    type UsageCostsParams as UsageCostsParams,
+    type UsageEmbeddingsParams as UsageEmbeddingsParams,
+    type UsageImagesParams as UsageImagesParams,
+    type UsageModerationsParams as UsageModerationsParams,
+    type UsageVectorStoresParams as UsageVectorStoresParams,
+  };
+
+  export {
+    Invites as Invites,
+    type Invite as Invite,
+    type InviteDeleteResponse as InviteDeleteResponse,
+    type InvitesPage as InvitesPage,
+    type InviteCreateParams as InviteCreateParams,
+    type InviteListParams as InviteListParams,
+  };
+
+  export {
+    Users as Users,
+    type OrganizationUser as OrganizationUser,
+    type UserDeleteResponse as UserDeleteResponse,
+    type OrganizationUsersPage as OrganizationUsersPage,
+    type UserUpdateParams as UserUpdateParams,
+    type UserListParams as UserListParams,
+  };
+
+  export {
+    Groups as Groups,
+    type Group as Group,
+    type GroupUpdateResponse as GroupUpdateResponse,
+    type GroupDeleteResponse as GroupDeleteResponse,
+    type GroupsPage as GroupsPage,
+    type GroupCreateParams as GroupCreateParams,
+    type GroupUpdateParams as GroupUpdateParams,
+    type GroupListParams as GroupListParams,
+  };
+
+  export {
+    Roles as Roles,
+    type Role as Role,
+    type RoleDeleteResponse as RoleDeleteResponse,
+    type RolesPage as RolesPage,
+    type RoleCreateParams as RoleCreateParams,
+    type RoleUpdateParams as RoleUpdateParams,
+    type RoleListParams as RoleListParams,
+  };
+
+  export {
+    Certificates as Certificates,
+    type Certificate as Certificate,
+    type CertificateListResponse as CertificateListResponse,
+    type CertificateDeleteResponse as CertificateDeleteResponse,
+    type CertificateActivateResponse as CertificateActivateResponse,
+    type CertificateDeactivateResponse as CertificateDeactivateResponse,
+    type CertificateListResponsesPage as CertificateListResponsesPage,
+    type CertificateActivateResponsesPage as CertificateActivateResponsesPage,
+    type CertificateDeactivateResponsesPage as CertificateDeactivateResponsesPage,
+    type CertificateCreateParams as CertificateCreateParams,
+    type CertificateRetrieveParams as CertificateRetrieveParams,
+    type CertificateUpdateParams as CertificateUpdateParams,
+    type CertificateListParams as CertificateListParams,
+    type CertificateActivateParams as CertificateActivateParams,
+    type CertificateDeactivateParams as CertificateDeactivateParams,
+  };
+
+  export {
+    Projects as Projects,
+    type Project as Project,
+    type ProjectsPage as ProjectsPage,
+    type ProjectCreateParams as ProjectCreateParams,
+    type ProjectUpdateParams as ProjectUpdateParams,
+    type ProjectListParams as ProjectListParams,
+  };
+}

package/src/resources/admin/organization/projects/api-keys.ts

@@ -0,0 +1,239 @@
+// 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 APIKeys extends APIResource {
+  /**
+   * Retrieves an API key in the project.
+   *
+   * @example
+   * ```ts
+   * const projectAPIKey =
+   *   await client.admin.organization.projects.apiKeys.retrieve(
+   *     'api_key_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  retrieve(
+    apiKeyID: string,
+    params: APIKeyRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ProjectAPIKey> {
+    const { project_id } = params;
+    return this._client.get(path`/organization/projects/${project_id}/api_keys/${apiKeyID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+
+  /**
+   * Returns a list of API keys in the project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const projectAPIKey of client.admin.organization.projects.apiKeys.list(
+   *   'project_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    projectID: string,
+    query: APIKeyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProjectAPIKeysPage, ProjectAPIKey> {
+    return this._client.getAPIList(
+      path`/organization/projects/${projectID}/api_keys`,
+      ConversationCursorPage<ProjectAPIKey>,
+      { query, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+
+  /**
+   * Deletes an API key from the project.
+   *
+   * Returns confirmation of the key deletion, or an error if the key belonged to a
+   * service account.
+   *
+   * @example
+   * ```ts
+   * const apiKey =
+   *   await client.admin.organization.projects.apiKeys.delete(
+   *     'api_key_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  delete(
+    apiKeyID: string,
+    params: APIKeyDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<APIKeyDeleteResponse> {
+    const { project_id } = params;
+    return this._client.delete(path`/organization/projects/${project_id}/api_keys/${apiKeyID}`, {
+      ...options,
+      __security: { adminAPIKeyAuth: true },
+    });
+  }
+}
+
+export type ProjectAPIKeysPage = ConversationCursorPage<ProjectAPIKey>;
+
+/**
+ * Represents an individual API key in a project.
+ */
+export interface ProjectAPIKey {
+  /**
+   * The identifier, which can be referenced in API endpoints
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) of when the API key was created
+   */
+  created_at: number;
+
+  /**
+   * The Unix timestamp (in seconds) of when the API key was last used.
+   */
+  last_used_at: number | null;
+
+  /**
+   * The name of the API key
+   */
+  name: string;
+
+  /**
+   * The object type, which is always `organization.project.api_key`
+   */
+  object: 'organization.project.api_key';
+
+  owner: ProjectAPIKey.Owner;
+
+  /**
+   * The redacted value of the API key
+   */
+  redacted_value: string;
+}
+
+export namespace ProjectAPIKey {
+  export interface Owner {
+    /**
+     * The service account that owns a project API key.
+     */
+    service_account?: Owner.ServiceAccount;
+
+    /**
+     * `user` or `service_account`
+     */
+    type?: 'user' | 'service_account';
+
+    /**
+     * The user that owns a project API key.
+     */
+    user?: Owner.User;
+  }
+
+  export namespace Owner {
+    /**
+     * The service account that owns a project API key.
+     */
+    export interface ServiceAccount {
+      /**
+       * 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 service account's project role.
+       */
+      role: string;
+    }
+
+    /**
+     * The user that owns a project API key.
+     */
+    export interface User {
+      /**
+       * The identifier, which can be referenced in API endpoints
+       */
+      id: string;
+
+      /**
+       * The Unix timestamp (in seconds) of when the user was created.
+       */
+      created_at: number;
+
+      /**
+       * The email address of the user.
+       */
+      email: string;
+
+      /**
+       * The name of the user.
+       */
+      name: string;
+
+      /**
+       * The user's project role.
+       */
+      role: string;
+    }
+  }
+}
+
+export interface APIKeyDeleteResponse {
+  id: string;
+
+  deleted: boolean;
+
+  object: 'organization.project.api_key.deleted';
+}
+
+export interface APIKeyRetrieveParams {
+  /**
+   * The ID of the project.
+   */
+  project_id: string;
+}
+
+export interface APIKeyListParams extends ConversationCursorPageParams {}
+
+export interface APIKeyDeleteParams {
+  /**
+   * The ID of the project.
+   */
+  project_id: string;
+}
+
+export declare namespace APIKeys {
+  export {
+    type ProjectAPIKey as ProjectAPIKey,
+    type APIKeyDeleteResponse as APIKeyDeleteResponse,
+    type ProjectAPIKeysPage as ProjectAPIKeysPage,
+    type APIKeyRetrieveParams as APIKeyRetrieveParams,
+    type APIKeyListParams as APIKeyListParams,
+    type APIKeyDeleteParams as APIKeyDeleteParams,
+  };
+}