openai 7.14.0 → 7.16.0

package/src/resources/beta/agents/environments/environments.ts

@@ -0,0 +1,111 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as AgentsAPI from '../agents';
+import * as FilesAPI from './files';
+import { EnvironmentFile, EnvironmentFilesPage, FileCreateParams, FileListParams, Files } from './files';
+import * as TemplatesAPI from './templates';
+import {
+  EnvironmentTemplate,
+  EnvironmentTemplateDeleted,
+  EnvironmentTemplatesPage,
+  TemplateCreateParams,
+  TemplateListParams,
+  TemplateUpdateParams,
+  Templates,
+} from './templates';
+import { APIPromise } from '../../../../core/api-promise';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+export class Environments extends APIResource {
+  files: FilesAPI.Files = new FilesAPI.Files(this._client);
+  templates: TemplatesAPI.Templates = new TemplatesAPI.Templates(this._client);
+
+  /**
+   * Retrieves an execution environment's connection status and safe installed
+   * metadata. See
+   * [environment lifecycle](https://developers.openai.com/api/docs/guides/agents-api/environments/lifecycle).
+   *
+   * @example
+   * ```ts
+   * const environmentInfo =
+   *   await client.beta.agents.environments.retrieve(
+   *     'environment_id',
+   *   );
+   * ```
+   */
+  retrieve(environmentID: string, options?: RequestOptions): APIPromise<EnvironmentInfo> {
+    return this._client.get(path`/agents/environments/${environmentID}`, {
+      ...options,
+      headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+      __security: { bearerAuth: true },
+    });
+  }
+}
+
+/**
+ * Safe metadata for a first-class execution environment.
+ */
+export interface EnvironmentInfo {
+  /**
+   * The ID of the environment.
+   */
+  id: string;
+
+  /**
+   * Files installed in the environment, without their contents.
+   */
+  files: Array<AgentsAPI.HostedEnvironmentFile>;
+
+  /**
+   * The object type. Always `agent.environment`.
+   */
+  object: 'agent.environment';
+
+  /**
+   * Plugins installed in the environment, without their archive contents.
+   */
+  plugins: Array<AgentsAPI.HostedPlugin>;
+
+  /**
+   * Skills installed in the environment, without their archive contents.
+   */
+  skills: Array<AgentsAPI.HostedSkill>;
+
+  /**
+   * The current environment connection status.
+   */
+  status: 'pending' | 'connected' | 'disconnected' | 'expired' | 'failed';
+
+  /**
+   * Whether the environment is hosted by OpenAI or by the application.
+   */
+  type: 'openai_hosted' | 'self_hosted';
+}
+
+Environments.Files = Files;
+Environments.Templates = Templates;
+
+export declare namespace Environments {
+  export { type EnvironmentInfo as EnvironmentInfo };
+
+  export {
+    Files as Files,
+    type EnvironmentFile as EnvironmentFile,
+    type EnvironmentFilesPage as EnvironmentFilesPage,
+    type FileCreateParams as FileCreateParams,
+    type FileListParams as FileListParams,
+  };
+
+  export {
+    Templates as Templates,
+    type EnvironmentTemplate as EnvironmentTemplate,
+    type EnvironmentTemplateDeleted as EnvironmentTemplateDeleted,
+    type EnvironmentTemplatesPage as EnvironmentTemplatesPage,
+    type TemplateCreateParams as TemplateCreateParams,
+    type TemplateUpdateParams as TemplateUpdateParams,
+    type TemplateListParams as TemplateListParams,
+  };
+}

package/src/resources/beta/agents/environments/files.ts

@@ -0,0 +1,164 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import { APIPromise } from '../../../../core/api-promise';
+import { PagePromise, TokenPage, type TokenPageParams } from '../../../../core/pagination';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+export class Files extends APIResource {
+  /**
+   * Copies inline bytes or a Files API file into a connected execution environment.
+   * See
+   * [environment files](https://developers.openai.com/api/docs/guides/agents-api/environments/files).
+   *
+   * @example
+   * ```ts
+   * const environmentFile =
+   *   await client.beta.agents.environments.files.create(
+   *     'environment_id',
+   *     {
+   *       type: 'inline',
+   *       path: '/workspace/example.txt',
+   *       data: 'SGVsbG8K',
+   *     },
+   *   );
+   * ```
+   */
+  create(
+    environmentID: string,
+    body: FileCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<EnvironmentFile> {
+    return this._client.post(path`/agents/environments/${environmentID}/files`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+      __security: { bearerAuth: true },
+    });
+  }
+
+  /**
+   * Lists live files on a connected execution environment with optional directory
+   * filtering and opaque cursor pagination. See
+   * [environment files](https://developers.openai.com/api/docs/guides/agents-api/environments/files).
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const environmentFile of client.beta.agents.environments.files.list(
+   *   'environment_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    environmentID: string,
+    query: FileListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<EnvironmentFilesPage, EnvironmentFile> {
+    return this._client.getAPIList(
+      path`/agents/environments/${environmentID}/files`,
+      TokenPage<EnvironmentFile>,
+      {
+        query,
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      },
+    );
+  }
+}
+
+export type EnvironmentFilesPage = TokenPage<EnvironmentFile>;
+
+/**
+ * A live file in an execution environment.
+ */
+export interface EnvironmentFile {
+  /**
+   * The ID of the environment containing this file.
+   */
+  environment_id: string;
+
+  /**
+   * The object type. Always `agent.environment.file`.
+   */
+  object: 'agent.environment.file';
+
+  /**
+   * The absolute file path inside the environment's workspace.
+   */
+  path: string;
+
+  /**
+   * The file size in bytes.
+   */
+  size_bytes: number;
+}
+
+export type FileCreateParams =
+  | FileCreateParams.HostedEnvironmentFileParamFileID
+  | FileCreateParams.HostedEnvironmentFileParamInline;
+
+export declare namespace FileCreateParams {
+  export interface HostedEnvironmentFileParamFileID {
+    /**
+     * The ID of the uploaded file.
+     */
+    file_id: string;
+
+    /**
+     * The absolute destination path inside `/workspace`.
+     */
+    path: string;
+
+    /**
+     * The type of the object. Always `file_id`.
+     */
+    type: 'file_id';
+  }
+
+  export interface HostedEnvironmentFileParamInline {
+    /**
+     * The standard-base64-encoded file contents.
+     */
+    data: string;
+
+    /**
+     * The absolute destination path inside `/workspace`.
+     */
+    path: string;
+
+    /**
+     * The type of the object. Always `inline`.
+     */
+    type: 'inline';
+  }
+}
+
+export interface FileListParams extends TokenPageParams {
+  /**
+   * Sort by case-sensitive path components. Defaults to descending.
+   *
+   * - `asc` - Returns resources in ascending order.
+   * - `desc` - Returns resources in descending order.
+   */
+  order?: 'asc' | 'desc';
+
+  /**
+   * Restrict the listing to this absolute workspace directory.
+   */
+  path?: string | null;
+}
+
+export declare namespace Files {
+  export {
+    type EnvironmentFile as EnvironmentFile,
+    type EnvironmentFilesPage as EnvironmentFilesPage,
+    type FileCreateParams as FileCreateParams,
+    type FileListParams as FileListParams,
+  };
+}

package/src/resources/beta/agents/environments/index.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+export { Environments, type EnvironmentInfo } from './environments';
+export {
+  Files,
+  type EnvironmentFile,
+  type FileCreateParams,
+  type FileListParams,
+  type EnvironmentFilesPage,
+} from './files';
+export {
+  Templates,
+  type EnvironmentTemplate,
+  type EnvironmentTemplateDeleted,
+  type TemplateCreateParams,
+  type TemplateUpdateParams,
+  type TemplateListParams,
+  type EnvironmentTemplatesPage,
+} from './templates';