openai 6.46.0 → 6.48.0

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

@@ -0,0 +1,284 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import * as APIKeysAPI from './api-keys';
+import { APIKeyCreateParams, APIKeyCreateResponse, APIKeys } from './api-keys';
+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 {
+  apiKeys: APIKeysAPI.APIKeys = new APIKeysAPI.APIKeys(this._client);
+
+  /**
+   * Creates a new service account in the project. By default, 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 },
+    });
+  }
+
+  /**
+   * Updates a service account in the project.
+   *
+   * @example
+   * ```ts
+   * const projectServiceAccount =
+   *   await client.admin.organization.projects.serviceAccounts.update(
+   *     'service_account_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  update(
+    serviceAccountID: string,
+    params: ServiceAccountUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ProjectServiceAccount> {
+    const { project_id, ...body } = params;
+    return this._client.post(
+      path`/organization/projects/${project_id}/service_accounts/${serviceAccountID}`,
+      { body, ...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`, `member`, or `none`
+   */
+  role: 'owner' | 'member' | 'none';
+}
+
+export interface ServiceAccountCreateResponse {
+  id: string;
+
+  api_key: ServiceAccountCreateResponse.APIKey | null;
+
+  created_at: number;
+
+  name: string;
+
+  object: 'organization.project.service_account';
+
+  /**
+   * Service accounts created with default project membership have role `member`.
+   * Accounts created with `create_service_account_only` have role `none`.
+   */
+  role: 'member' | 'none';
+}
+
+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;
+
+  /**
+   * Create the service account without default roles or an API key.
+   */
+  create_service_account_only?: boolean | null;
+}
+
+export interface ServiceAccountRetrieveParams {
+  /**
+   * The ID of the project.
+   */
+  project_id: string;
+}
+
+export interface ServiceAccountUpdateParams {
+  /**
+   * Path param: The ID of the project.
+   */
+  project_id: string;
+
+  /**
+   * Body param: The updated service account name.
+   */
+  name?: string;
+
+  /**
+   * Body param: The updated service account role.
+   */
+  role?: 'member' | 'owner';
+}
+
+export interface ServiceAccountListParams extends ConversationCursorPageParams {}
+
+export interface ServiceAccountDeleteParams {
+  /**
+   * The ID of the project.
+   */
+  project_id: string;
+}
+
+ServiceAccounts.APIKeys = APIKeys;
+
+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 ServiceAccountUpdateParams as ServiceAccountUpdateParams,
+    type ServiceAccountListParams as ServiceAccountListParams,
+    type ServiceAccountDeleteParams as ServiceAccountDeleteParams,
+  };
+
+  export {
+    APIKeys as APIKeys,
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyCreateParams as APIKeyCreateParams,
+  };
+}

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

@@ -1,266 +1,3 @@
 // 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 },
-    });
-  }
-
-  /**
-   * Updates a service account in the project.
-   *
-   * @example
-   * ```ts
-   * const projectServiceAccount =
-   *   await client.admin.organization.projects.serviceAccounts.update(
-   *     'service_account_id',
-   *     { project_id: 'project_id' },
-   *   );
-   * ```
-   */
-  update(
-    serviceAccountID: string,
-    params: ServiceAccountUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<ProjectServiceAccount> {
-    const { project_id, ...body } = params;
-    return this._client.post(
-      path`/organization/projects/${project_id}/service_accounts/${serviceAccountID}`,
-      { body, ...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 ServiceAccountUpdateParams {
-  /**
-   * Path param: The ID of the project.
-   */
-  project_id: string;
-
-  /**
-   * Body param: The updated service account name.
-   */
-  name?: string;
-
-  /**
-   * Body param: The updated service account role.
-   */
-  role?: 'member' | 'owner';
-}
-
-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 ServiceAccountUpdateParams as ServiceAccountUpdateParams,
-    type ServiceAccountListParams as ServiceAccountListParams,
-    type ServiceAccountDeleteParams as ServiceAccountDeleteParams,
-  };
-}
+export * from './service-accounts/index';