openai 7.19.0 → 7.21.0

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

@@ -19,6 +19,13 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+function resolveResourceRequestOptions(
+  options: RequestOptions | undefined,
+  buildOptions: (options: RequestOptions | undefined) => RequestOptions | Promise<RequestOptions>,
+): Promise<RequestOptions> {
+  return Promise.resolve(options).then(buildOptions);
+}
+
 export class Environments extends APIResource {
   files: FilesAPI.Files = new FilesAPI.Files(this._client);
   templates: TemplatesAPI.Templates = new TemplatesAPI.Templates(this._client);
@@ -37,11 +44,14 @@ export class Environments extends APIResource {
    * ```
    */
   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 },
-    });
+    return this._client.get(
+      path`/agents/environments/${environmentID}`,
+      resolveResourceRequestOptions(options, (options) => ({
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      })),
+    );
   }
 }
 

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

@@ -7,6 +7,13 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+function resolveResourceRequestOptions(
+  options: RequestOptions | undefined,
+  buildOptions: (options: RequestOptions | undefined) => RequestOptions | Promise<RequestOptions>,
+): Promise<RequestOptions> {
+  return Promise.resolve(options).then(buildOptions);
+}
+
 export class Files extends APIResource {
   /**
    * Copies inline bytes or a Files API file into a connected execution environment.
@@ -31,12 +38,15 @@ export class Files extends APIResource {
     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 },
-    });
+    return this._client.post(
+      path`/agents/environments/${environmentID}/files`,
+      resolveResourceRequestOptions(options, (options) => ({
+        body,
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      })),
+    );
   }
 
   /**
@@ -62,12 +72,12 @@ export class Files extends APIResource {
     return this._client.getAPIList(
       path`/agents/environments/${environmentID}/files`,
       TokenPage<EnvironmentFile>,
-      {
+      resolveResourceRequestOptions(options, (options) => ({
         query,
         ...options,
         headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
         __security: { bearerAuth: true },
-      },
+      })),
     );
   }
 }

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

@@ -8,6 +8,120 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+function resolveResourceRequestOptions(
+  options: RequestOptions | undefined,
+  buildOptions: (options: RequestOptions | undefined) => RequestOptions | Promise<RequestOptions>,
+): Promise<RequestOptions> {
+  return Promise.resolve(options).then(buildOptions);
+}
+
+// Recognizable options across SDK runtime versions. Keep this independent of
+// private RequestOptions fields so older handwritten runtimes still compile.
+const normalizeRequestOptionsForQueryKeys = new Set([
+  'method',
+  'path',
+  'query',
+  'body',
+  'headers',
+  'maxRetries',
+  'stream',
+  'timeout',
+  'httpAgent',
+  'fetchOptions',
+  'signal',
+  'idempotencyKey',
+  'defaultBaseURL',
+  '__metadata',
+  '__binaryRequest',
+  '__binaryResponse',
+  '__streamClass',
+  '__security',
+  '__synthesizeEventData',
+]);
+
+function normalizeRequestOptionsForQuery(
+  value: unknown,
+  queryKeys: ReadonlyArray<string>,
+  options: RequestOptions | undefined,
+):
+  | ({
+      [K in 'headers' | 'maxRetries' | 'timeout' | 'signal' | 'idempotencyKey' | 'query']?: RequestOptions[K];
+    } & {
+      [
+        K in
+          | 'method'
+          | 'path'
+          | 'body'
+          | 'stream'
+          | 'httpAgent'
+          | 'fetchOptions'
+          | 'defaultBaseURL'
+          | '__metadata'
+          | '__binaryRequest'
+          | '__binaryResponse'
+          | '__streamClass'
+          | '__security'
+          | '__synthesizeEventData'
+      ]?: never;
+    })
+  | undefined {
+  if (typeof value !== 'object' || value === null) return undefined;
+  // Optional never fields can still be explicitly undefined unless consumers
+  // enable exactOptionalPropertyTypes. Snapshot data without invoking getters.
+  const entries = Object.entries(Object.getOwnPropertyDescriptors(value)).filter(
+    ([, descriptor]) => descriptor.enumerable && (!('value' in descriptor) || descriptor.value !== undefined),
+  );
+  const keys = entries.map(([key]) => key);
+  const requestOnly = keys.some(
+    (key) => normalizeRequestOptionsForQueryKeys.has(key) && !queryKeys.includes(key),
+  );
+  if (!requestOnly) return undefined;
+  // Declared query fields, including stream, must use the query argument.
+  // Mixing them with request-only options is ambiguous and could change the return type.
+  if (
+    options !== undefined ||
+    keys.some((key) => !normalizeRequestOptionsForQueryKeys.has(key) || queryKeys.includes(key))
+  ) {
+    throw new TypeError('Query parameters and request options must be passed as separate arguments.');
+  }
+  // The query position must not gain authority to change the request destination
+  // or transport. Those overrides require the explicit request options argument.
+  if (
+    keys.some(
+      (key) => !['headers', 'maxRetries', 'timeout', 'signal', 'idempotencyKey', 'query'].includes(key),
+    )
+  ) {
+    throw new TypeError('Pass transport overrides in the explicit request options argument.');
+  }
+  // Copy only the validated fields. Spreading value would reintroduce undefined
+  // transport overrides, and deleting them would mutate the caller's object.
+  return Object.fromEntries(
+    entries.map(([key, descriptor]) => {
+      if ('value' in descriptor) return [key, descriptor.value];
+      return [key, descriptor.get ? Reflect.apply(descriptor.get, value, []) : undefined];
+    }),
+  ) as {
+    [K in 'headers' | 'maxRetries' | 'timeout' | 'signal' | 'idempotencyKey' | 'query']?: RequestOptions[K];
+  } & {
+    [
+      K in
+        | 'method'
+        | 'path'
+        | 'body'
+        | 'stream'
+        | 'httpAgent'
+        | 'fetchOptions'
+        | 'defaultBaseURL'
+        | '__metadata'
+        | '__binaryRequest'
+        | '__binaryResponse'
+        | '__streamClass'
+        | '__security'
+        | '__synthesizeEventData'
+    ]?: never;
+  };
+}
+
 export class Templates extends APIResource {
   /**
    * Creates reusable environment configuration without returning confidential setup
@@ -24,12 +138,15 @@ export class Templates extends APIResource {
     body: TemplateCreateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<EnvironmentTemplate> {
-    return this._client.post('/agents/environments/templates', {
-      body,
-      ...options,
-      headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
-      __security: { bearerAuth: true },
-    });
+    return this._client.post(
+      '/agents/environments/templates',
+      resolveResourceRequestOptions(options, (options) => ({
+        body,
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      })),
+    );
   }
 
   /**
@@ -46,11 +163,14 @@ export class Templates extends APIResource {
    * ```
    */
   retrieve(environmentTemplateID: string, options?: RequestOptions): APIPromise<EnvironmentTemplate> {
-    return this._client.get(path`/agents/environments/templates/${environmentTemplateID}`, {
-      ...options,
-      headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
-      __security: { bearerAuth: true },
-    });
+    return this._client.get(
+      path`/agents/environments/templates/${environmentTemplateID}`,
+      resolveResourceRequestOptions(options, (options) => ({
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      })),
+    );
   }
 
   /**
@@ -71,12 +191,15 @@ export class Templates extends APIResource {
     body: TemplateUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<EnvironmentTemplate> {
-    return this._client.post(path`/agents/environments/templates/${environmentTemplateID}`, {
-      body,
-      ...options,
-      headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
-      __security: { bearerAuth: true },
-    });
+    return this._client.post(
+      path`/agents/environments/templates/${environmentTemplateID}`,
+      resolveResourceRequestOptions(options, (options) => ({
+        body,
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      })),
+    );
   }
 
   /**
@@ -92,15 +215,111 @@ export class Templates extends APIResource {
    * ```
    */
   list(
-    query: TemplateListParams | null | undefined = {},
+    query?:
+      | (TemplateListParams &
+          (
+            | {
+                [
+                  K in
+                    | 'method'
+                    | 'path'
+                    | 'query'
+                    | 'body'
+                    | 'headers'
+                    | 'maxRetries'
+                    | 'stream'
+                    | 'timeout'
+                    | 'httpAgent'
+                    | 'fetchOptions'
+                    | 'signal'
+                    | 'idempotencyKey'
+                    | 'defaultBaseURL'
+                    | '__metadata'
+                    | '__binaryRequest'
+                    | '__binaryResponse'
+                    | '__streamClass'
+                    | '__security'
+                    | '__synthesizeEventData'
+                ]?: never;
+              }
+            | null
+            | undefined
+          ))
+      | null
+      | undefined,
+    options?: RequestOptions,
+  ): PagePromise<EnvironmentTemplatesPage, EnvironmentTemplate>;
+  list(
+    options?: {
+      [K in 'headers' | 'maxRetries' | 'timeout' | 'signal' | 'idempotencyKey' | 'query']?: RequestOptions[K];
+    } & {
+      [
+        K in
+          | 'method'
+          | 'path'
+          | 'body'
+          | 'stream'
+          | 'httpAgent'
+          | 'fetchOptions'
+          | 'defaultBaseURL'
+          | '__metadata'
+          | '__binaryRequest'
+          | '__binaryResponse'
+          | '__streamClass'
+          | '__security'
+          | '__synthesizeEventData'
+      ]?: never;
+    },
+  ): PagePromise<EnvironmentTemplatesPage, EnvironmentTemplate>;
+  list(
+    query:
+      | TemplateListParams
+      | ({
+          [
+            K in 'headers' | 'maxRetries' | 'timeout' | 'signal' | 'idempotencyKey' | 'query'
+          ]?: RequestOptions[K];
+        } & {
+          [
+            K in
+              | 'method'
+              | 'path'
+              | 'body'
+              | 'stream'
+              | 'httpAgent'
+              | 'fetchOptions'
+              | 'defaultBaseURL'
+              | '__metadata'
+              | '__binaryRequest'
+              | '__binaryResponse'
+              | '__streamClass'
+              | '__security'
+              | '__synthesizeEventData'
+          ]?: never;
+        })
+      | null
+      | undefined = {},
     options?: RequestOptions,
   ): PagePromise<EnvironmentTemplatesPage, EnvironmentTemplate> {
-    return this._client.getAPIList('/agents/environments/templates', CursorPage<EnvironmentTemplate>, {
+    const normalizeRequestOptionsForQueryOptions = normalizeRequestOptionsForQuery(
       query,
-      ...options,
-      headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
-      __security: { bearerAuth: true },
-    });
+      ['after', 'limit', 'order'],
+      options,
+    );
+    if (normalizeRequestOptionsForQueryOptions !== undefined) {
+      options = normalizeRequestOptionsForQueryOptions;
+      query = {};
+    }
+    query = query as TemplateListParams | null | undefined;
+    return this._client.getAPIList(
+      '/agents/environments/templates',
+      CursorPage<EnvironmentTemplate>,
+      resolveResourceRequestOptions(options, (options) => ({
+        query,
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      })),
+    );
   }
 
   /**
@@ -117,11 +336,14 @@ export class Templates extends APIResource {
    * ```
    */
   delete(environmentTemplateID: string, options?: RequestOptions): APIPromise<EnvironmentTemplateDeleted> {
-    return this._client.delete(path`/agents/environments/templates/${environmentTemplateID}`, {
-      ...options,
-      headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
-      __security: { bearerAuth: true },
-    });
+    return this._client.delete(
+      path`/agents/environments/templates/${environmentTemplateID}`,
+      resolveResourceRequestOptions(options, (options) => ({
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      })),
+    );
   }
 }
 
@@ -358,12 +580,13 @@ export interface TemplateCreateParams {
   name?: string | null;
 
   /**
-   * Network access for an OpenAI-hosted environment.
+   * Network access policy for the environment. Defaults to disabled for GA requests
+   * and enabled for alpha/beta requests.
    */
   network?: TemplateCreateParams.Network | null;
 
   /**
-   * Packages to install in an OpenAI-hosted environment.
+   * Packages to install in the environment. Defaults to empty package lists.
    */
   packages?: TemplateCreateParams.Packages | null;
 
@@ -386,7 +609,8 @@ export interface TemplateCreateParams {
 
 export namespace TemplateCreateParams {
   /**
-   * Network access for an OpenAI-hosted environment.
+   * Network access policy for the environment. Defaults to disabled for GA requests
+   * and enabled for alpha/beta requests.
    */
   export interface Network {
     /**
@@ -405,7 +629,7 @@ export namespace TemplateCreateParams {
   }
 
   /**
-   * Packages to install in an OpenAI-hosted environment.
+   * Packages to install in the environment. Defaults to empty package lists.
    */
   export interface Packages {
     /**
@@ -447,12 +671,14 @@ export interface TemplateUpdateParams {
   name?: string | null;
 
   /**
-   * Network access for an OpenAI-hosted environment.
+   * Network access available after setup completes. Omit to preserve the current
+   * policy, or pass `null` to reset to disabled for GA requests or enabled for
+   * alpha/beta requests.
    */
   network?: TemplateUpdateParams.Network | null;
 
   /**
-   * Packages to install in an OpenAI-hosted environment.
+   * Packages installed before the runtime network policy applies.
    */
   packages?: TemplateUpdateParams.Packages | null;
 
@@ -474,7 +700,9 @@ export interface TemplateUpdateParams {
 
 export namespace TemplateUpdateParams {
   /**
-   * Network access for an OpenAI-hosted environment.
+   * Network access available after setup completes. Omit to preserve the current
+   * policy, or pass `null` to reset to disabled for GA requests or enabled for
+   * alpha/beta requests.
    */
   export interface Network {
     /**
@@ -493,7 +721,7 @@ export namespace TemplateUpdateParams {
   }
 
   /**
-   * Packages to install in an OpenAI-hosted environment.
+   * Packages installed before the runtime network policy applies.
    */
   export interface Packages {
     /**

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

@@ -31,6 +31,7 @@ export {
   type AgentSessionEnvironmentFailedEvent,
   type AgentSessionEnvironmentPendingEvent,
   type AgentSessionEnvironmentReadyEvent,
+  type AgentSessionEnvironmentResetEvent,
   type AgentSessionEnvironmentState,
   type AgentSessionErrorEvent,
   type AgentSessionEvent,