openai 7.28.0 → 7.30.0

package/src/resources/beta/agents/sessions/turns.ts

@@ -1,375 +1,3 @@
 // File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../core/resource';
-import * as AgentsAPI from '../agents';
-import { APIPromise } from '../../../../core/api-promise';
-import { CursorPage, type CursorPageParams, PagePromise } from '../../../../core/pagination';
-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 Turns extends APIResource {
-  /**
-   * Retrieves a turn's current status, timestamps, usage, and error. Returns 404 if
-   * the turn does not belong to the session. See
-   * [session turns](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage#inspect-session-turns).
-   *
-   * @example
-   * ```ts
-   * const turn =
-   *   await client.beta.agents.sessions.turns.retrieve(
-   *     'turn_id',
-   *     { session_id: 'session_id' },
-   *   );
-   * ```
-   */
-  retrieve(turnID: string, params: TurnRetrieveParams, options?: RequestOptions): APIPromise<Turn> {
-    const { session_id } = params;
-    return this._client.get(
-      path`/agents/sessions/${session_id}/turns/${turnID}`,
-      resolveResourceRequestOptions(options, (options) => ({
-        ...options,
-        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
-        __security: { bearerAuth: true },
-      })),
-    );
-  }
-
-  /**
-   * Lists turns by creation time and turn ID. The after cursor is exclusive in the
-   * selected order. See
-   * [session turns](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage#inspect-session-turns).
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const turn of client.beta.agents.sessions.turns.list(
-   *   'session_id',
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    sessionID: string,
-    query?:
-      | (TurnListParams &
-          (
-            | {
-                [
-                  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<TurnsPage, Turn>;
-  list(
-    sessionID: string,
-    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<TurnsPage, Turn>;
-  list(
-    sessionID: string,
-    query:
-      | TurnListParams
-      | ({
-          [
-            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<TurnsPage, Turn> {
-    const normalizeRequestOptionsForQueryOptions = normalizeRequestOptionsForQuery(
-      query,
-      ['after', 'limit', 'order'],
-      options,
-    );
-    if (normalizeRequestOptionsForQueryOptions !== undefined) {
-      options = normalizeRequestOptionsForQueryOptions;
-      query = {};
-    }
-    query = query as TurnListParams | null | undefined;
-    return this._client.getAPIList(
-      path`/agents/sessions/${sessionID}/turns`,
-      CursorPage<Turn>,
-      resolveResourceRequestOptions(options, (options) => ({
-        query,
-        ...options,
-        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
-        __security: { bearerAuth: true },
-      })),
-    );
-  }
-}
-
-export type TurnsPage = CursorPage<Turn>;
-
-/**
- * The canonical public representation of a session turn.
- */
-export interface Turn {
-  /**
-   * The ID of the turn.
-   */
-  id: string;
-
-  /**
-   * The ID of the agent that ran the turn.
-   */
-  agent_id: string;
-
-  /**
-   * The Unix timestamp, in seconds, when the turn reached a terminal state.
-   */
-  completed_at: number | null;
-
-  /**
-   * The Unix timestamp, in seconds, used to order the turn by creation time.
-   * Subagent turns use their start time, falling back to completion time or the
-   * subagent opening time when the preceding timestamps are unavailable.
-   */
-  created_at: number;
-
-  /**
-   * A customer-safe error. Non-null only for a failed turn.
-   */
-  error: AgentsAPI.SessionTurnError | null;
-
-  /**
-   * The object type. Always `agent.session.turn`.
-   */
-  object: 'agent.session.turn';
-
-  /**
-   * The ID of the session that owns the turn.
-   */
-  session_id: string;
-
-  /**
-   * The Unix timestamp, in seconds, when the turn started.
-   */
-  started_at: number | null;
-
-  /**
-   * The current status of the turn.
-   *
-   * - `queued` - The turn is waiting to start.
-   * - `in_progress` - The turn is in progress.
-   * - `waiting` - The turn is waiting for external input.
-   * - `completed` - The turn completed successfully.
-   * - `failed` - The turn failed.
-   * - `cancelled` - The turn was cancelled.
-   */
-  status: 'queued' | 'in_progress' | 'waiting' | 'completed' | 'failed' | 'cancelled';
-
-  /**
-   * The ID of the subagent that ran the turn, if applicable.
-   */
-  subagent_id: string | null;
-
-  /**
-   * Best-effort token usage for the turn, or null if unknown. Recorded usage may
-   * change.
-   */
-  usage: AgentsAPI.TokenUsage | null;
-}
-
-export interface TurnRetrieveParams {
-  /**
-   * The ID of the session that owns the turn.
-   */
-  session_id: string;
-}
-
-export interface TurnListParams extends CursorPageParams {
-  /**
-   * The order in which resources are returned. Defaults to `desc`.
-   *
-   * - `asc` - Returns resources in ascending order.
-   * - `desc` - Returns resources in descending order.
-   */
-  order?: 'asc' | 'desc';
-}
-
-export declare namespace Turns {
-  export {
-    type Turn as Turn,
-    type TurnsPage as TurnsPage,
-    type TurnRetrieveParams as TurnRetrieveParams,
-    type TurnListParams as TurnListParams,
-  };
-}
+export * from './turns/index';

package/src/resources/beta/beta.ts

@@ -352,6 +352,7 @@ import {
   BetaToolChoiceOptions,
   BetaToolChoiceShell,
   BetaToolChoiceTypes,
+  BetaToolSearchOutputNamespaceTool,
   BetaToolSearchTool,
   BetaWebSearchPreviewTool,
   BetaWebSearchTool,
@@ -728,6 +729,7 @@ export declare namespace Beta {
     type BetaToolChoiceOptions as BetaToolChoiceOptions,
     type BetaToolChoiceShell as BetaToolChoiceShell,
     type BetaToolChoiceTypes as BetaToolChoiceTypes,
+    type BetaToolSearchOutputNamespaceTool as BetaToolSearchOutputNamespaceTool,
     type BetaToolSearchTool as BetaToolSearchTool,
     type BetaWebSearchPreviewTool as BetaWebSearchPreviewTool,
     type BetaWebSearchTool as BetaWebSearchTool,

package/src/resources/beta/index.ts

@@ -300,6 +300,7 @@ export {
   type BetaToolChoiceOptions,
   type BetaToolChoiceShell,
   type BetaToolChoiceTypes,
+  type BetaToolSearchOutputNamespaceTool,
   type BetaToolSearchTool,
   type BetaWebSearchPreviewTool,
   type BetaWebSearchTool,

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

@@ -171,6 +171,7 @@ export {
   type BetaToolChoiceOptions,
   type BetaToolChoiceShell,
   type BetaToolChoiceTypes,
+  type BetaToolSearchOutputNamespaceTool,
   type BetaToolSearchTool,
   type BetaWebSearchPreviewTool,
   type BetaWebSearchTool,