@openrouter/sdk 0.10.2 → 0.12.0

package/esm/models/responsesrequest.d.ts

@@ -0,0 +1,217 @@
+import * as z from "zod/v4";
+import { OpenEnum } from "../types/enums.js";
+import { ApplyPatchServerTool, ApplyPatchServerTool$Outbound } from "./applypatchservertool.js";
+import { AutoRouterPlugin, AutoRouterPlugin$Outbound } from "./autorouterplugin.js";
+import { CodeInterpreterServerTool, CodeInterpreterServerTool$Outbound } from "./codeinterpreterservertool.js";
+import { CodexLocalShellTool, CodexLocalShellTool$Outbound } from "./codexlocalshelltool.js";
+import { ComputerUseServerTool, ComputerUseServerTool$Outbound } from "./computeruseservertool.js";
+import { ContextCompressionPlugin, ContextCompressionPlugin$Outbound } from "./contextcompressionplugin.js";
+import { CustomTool, CustomTool$Outbound } from "./customtool.js";
+import { DatetimeServerTool, DatetimeServerTool$Outbound } from "./datetimeservertool.js";
+import { FileParserPlugin, FileParserPlugin$Outbound } from "./fileparserplugin.js";
+import { FileSearchServerTool, FileSearchServerTool$Outbound } from "./filesearchservertool.js";
+import { ImageGenerationServerTool, ImageGenerationServerTool$Outbound } from "./imagegenerationservertool.js";
+import { InputsUnion, InputsUnion$Outbound } from "./inputsunion.js";
+import { LegacyWebSearchServerTool, LegacyWebSearchServerTool$Outbound } from "./legacywebsearchservertool.js";
+import { McpServerTool, McpServerTool$Outbound } from "./mcpservertool.js";
+import { ModerationPlugin, ModerationPlugin$Outbound } from "./moderationplugin.js";
+import { OpenAIResponsesToolChoiceUnion, OpenAIResponsesToolChoiceUnion$Outbound } from "./openairesponsestoolchoiceunion.js";
+import { OpenAIResponsesTruncation } from "./openairesponsestruncation.js";
+import { OutputModalityEnum } from "./outputmodalityenum.js";
+import { Preview20250311WebSearchServerTool, Preview20250311WebSearchServerTool$Outbound } from "./preview20250311websearchservertool.js";
+import { PreviewWebSearchServerTool, PreviewWebSearchServerTool$Outbound } from "./previewwebsearchservertool.js";
+import { ProviderPreferences, ProviderPreferences$Outbound } from "./providerpreferences.js";
+import { ReasoningConfig, ReasoningConfig$Outbound } from "./reasoningconfig.js";
+import { ResponseHealingPlugin, ResponseHealingPlugin$Outbound } from "./responsehealingplugin.js";
+import { ResponseIncludesEnum } from "./responseincludesenum.js";
+import { ShellServerTool, ShellServerTool$Outbound } from "./shellservertool.js";
+import { StoredPromptTemplate, StoredPromptTemplate$Outbound } from "./storedprompttemplate.js";
+import { TextExtendedConfig, TextExtendedConfig$Outbound } from "./textextendedconfig.js";
+import { TraceConfig, TraceConfig$Outbound } from "./traceconfig.js";
+import { WebSearchPlugin, WebSearchPlugin$Outbound } from "./websearchplugin.js";
+import { WebSearchServerTool, WebSearchServerTool$Outbound } from "./websearchservertool.js";
+import { WebSearchServerToolOpenRouter, WebSearchServerToolOpenRouter$Outbound } from "./websearchservertoolopenrouter.js";
+export type ResponsesRequestImageConfig = string | number;
+export type ResponsesRequestPlugin = AutoRouterPlugin | ContextCompressionPlugin | FileParserPlugin | ModerationPlugin | ResponseHealingPlugin | WebSearchPlugin;
+export declare const ResponsesRequestServiceTier: {
+    readonly Auto: "auto";
+    readonly Default: "default";
+    readonly Flex: "flex";
+    readonly Priority: "priority";
+    readonly Scale: "scale";
+};
+export type ResponsesRequestServiceTier = OpenEnum<typeof ResponsesRequestServiceTier>;
+/**
+ * Function tool definition
+ */
+export type ResponsesRequestToolFunction = {
+    description?: string | null | undefined;
+    name: string;
+    parameters: {
+        [k: string]: any | null;
+    } | null;
+    strict?: boolean | null | undefined;
+    type: "function";
+};
+export type ResponsesRequestToolUnion = ResponsesRequestToolFunction | PreviewWebSearchServerTool | Preview20250311WebSearchServerTool | LegacyWebSearchServerTool | WebSearchServerTool | FileSearchServerTool | ComputerUseServerTool | CodeInterpreterServerTool | McpServerTool | ImageGenerationServerTool | CodexLocalShellTool | ShellServerTool | ApplyPatchServerTool | CustomTool | (DatetimeServerTool & {
+    type: "openrouter:datetime";
+}) | WebSearchServerToolOpenRouter;
+/**
+ * Request schema for Responses endpoint
+ */
+export type ResponsesRequest = {
+    background?: boolean | null | undefined;
+    frequencyPenalty?: number | undefined;
+    /**
+     * Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/features/multimodal/image-generation for more details.
+     */
+    imageConfig?: {
+        [k: string]: string | number;
+    } | undefined;
+    include?: Array<ResponseIncludesEnum> | null | undefined;
+    /**
+     * Input for a response request - can be a string or array of items
+     */
+    input?: InputsUnion | undefined;
+    instructions?: string | null | undefined;
+    maxOutputTokens?: number | undefined;
+    maxToolCalls?: number | undefined;
+    /**
+     * Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed.
+     */
+    metadata?: {
+        [k: string]: string;
+    } | null | undefined;
+    /**
+     * Output modalities for the response. Supported values are "text" and "image".
+     */
+    modalities?: Array<OutputModalityEnum> | undefined;
+    model?: string | undefined;
+    models?: Array<string> | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    /**
+     * Plugins you want to enable for this request, including their settings.
+     */
+    plugins?: Array<AutoRouterPlugin | ContextCompressionPlugin | FileParserPlugin | ModerationPlugin | ResponseHealingPlugin | WebSearchPlugin> | undefined;
+    presencePenalty?: number | undefined;
+    previousResponseId?: string | null | undefined;
+    prompt?: StoredPromptTemplate | null | undefined;
+    promptCacheKey?: string | null | undefined;
+    /**
+     * When multiple model providers are available, optionally indicate your routing preference.
+     */
+    provider?: ProviderPreferences | null | undefined;
+    /**
+     * Configuration for reasoning mode in the response
+     */
+    reasoning?: ReasoningConfig | null | undefined;
+    safetyIdentifier?: string | null | undefined;
+    serviceTier?: ResponsesRequestServiceTier | null | undefined;
+    /**
+     * A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters.
+     */
+    sessionId?: string | undefined;
+    store?: false | undefined;
+    stream?: boolean | undefined;
+    temperature?: number | undefined;
+    /**
+     * Text output configuration including format and verbosity
+     */
+    text?: TextExtendedConfig | undefined;
+    toolChoice?: OpenAIResponsesToolChoiceUnion | undefined;
+    tools?: Array<ResponsesRequestToolFunction | PreviewWebSearchServerTool | Preview20250311WebSearchServerTool | LegacyWebSearchServerTool | WebSearchServerTool | FileSearchServerTool | ComputerUseServerTool | CodeInterpreterServerTool | McpServerTool | ImageGenerationServerTool | CodexLocalShellTool | ShellServerTool | ApplyPatchServerTool | CustomTool | (DatetimeServerTool & {
+        type: "openrouter:datetime";
+    }) | WebSearchServerToolOpenRouter> | undefined;
+    topK?: number | undefined;
+    topLogprobs?: number | undefined;
+    topP?: number | undefined;
+    /**
+     * Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.
+     */
+    trace?: TraceConfig | undefined;
+    truncation?: OpenAIResponsesTruncation | null | undefined;
+    /**
+     * A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters.
+     */
+    user?: string | undefined;
+};
+/** @internal */
+export type ResponsesRequestImageConfig$Outbound = string | number;
+/** @internal */
+export declare const ResponsesRequestImageConfig$outboundSchema: z.ZodType<ResponsesRequestImageConfig$Outbound, ResponsesRequestImageConfig>;
+export declare function responsesRequestImageConfigToJSON(responsesRequestImageConfig: ResponsesRequestImageConfig): string;
+/** @internal */
+export type ResponsesRequestPlugin$Outbound = AutoRouterPlugin$Outbound | ContextCompressionPlugin$Outbound | FileParserPlugin$Outbound | ModerationPlugin$Outbound | ResponseHealingPlugin$Outbound | WebSearchPlugin$Outbound;
+/** @internal */
+export declare const ResponsesRequestPlugin$outboundSchema: z.ZodType<ResponsesRequestPlugin$Outbound, ResponsesRequestPlugin>;
+export declare function responsesRequestPluginToJSON(responsesRequestPlugin: ResponsesRequestPlugin): string;
+/** @internal */
+export declare const ResponsesRequestServiceTier$outboundSchema: z.ZodType<string, ResponsesRequestServiceTier>;
+/** @internal */
+export type ResponsesRequestToolFunction$Outbound = {
+    description?: string | null | undefined;
+    name: string;
+    parameters: {
+        [k: string]: any | null;
+    } | null;
+    strict?: boolean | null | undefined;
+    type: "function";
+};
+/** @internal */
+export declare const ResponsesRequestToolFunction$outboundSchema: z.ZodType<ResponsesRequestToolFunction$Outbound, ResponsesRequestToolFunction>;
+export declare function responsesRequestToolFunctionToJSON(responsesRequestToolFunction: ResponsesRequestToolFunction): string;
+/** @internal */
+export type ResponsesRequestToolUnion$Outbound = ResponsesRequestToolFunction$Outbound | PreviewWebSearchServerTool$Outbound | Preview20250311WebSearchServerTool$Outbound | LegacyWebSearchServerTool$Outbound | WebSearchServerTool$Outbound | FileSearchServerTool$Outbound | ComputerUseServerTool$Outbound | CodeInterpreterServerTool$Outbound | McpServerTool$Outbound | ImageGenerationServerTool$Outbound | CodexLocalShellTool$Outbound | ShellServerTool$Outbound | ApplyPatchServerTool$Outbound | CustomTool$Outbound | (DatetimeServerTool$Outbound & {
+    type: "openrouter:datetime";
+}) | WebSearchServerToolOpenRouter$Outbound;
+/** @internal */
+export declare const ResponsesRequestToolUnion$outboundSchema: z.ZodType<ResponsesRequestToolUnion$Outbound, ResponsesRequestToolUnion>;
+export declare function responsesRequestToolUnionToJSON(responsesRequestToolUnion: ResponsesRequestToolUnion): string;
+/** @internal */
+export type ResponsesRequest$Outbound = {
+    background?: boolean | null | undefined;
+    frequency_penalty?: number | undefined;
+    image_config?: {
+        [k: string]: string | number;
+    } | undefined;
+    include?: Array<string> | null | undefined;
+    input?: InputsUnion$Outbound | undefined;
+    instructions?: string | null | undefined;
+    max_output_tokens?: number | undefined;
+    max_tool_calls?: number | undefined;
+    metadata?: {
+        [k: string]: string;
+    } | null | undefined;
+    modalities?: Array<string> | undefined;
+    model?: string | undefined;
+    models?: Array<string> | undefined;
+    parallel_tool_calls?: boolean | null | undefined;
+    plugins?: Array<AutoRouterPlugin$Outbound | ContextCompressionPlugin$Outbound | FileParserPlugin$Outbound | ModerationPlugin$Outbound | ResponseHealingPlugin$Outbound | WebSearchPlugin$Outbound> | undefined;
+    presence_penalty?: number | undefined;
+    previous_response_id?: string | null | undefined;
+    prompt?: StoredPromptTemplate$Outbound | null | undefined;
+    prompt_cache_key?: string | null | undefined;
+    provider?: ProviderPreferences$Outbound | null | undefined;
+    reasoning?: ReasoningConfig$Outbound | null | undefined;
+    safety_identifier?: string | null | undefined;
+    service_tier: string | null;
+    session_id?: string | undefined;
+    store: false;
+    stream: boolean;
+    temperature?: number | undefined;
+    text?: TextExtendedConfig$Outbound | undefined;
+    tool_choice?: OpenAIResponsesToolChoiceUnion$Outbound | undefined;
+    tools?: Array<ResponsesRequestToolFunction$Outbound | PreviewWebSearchServerTool$Outbound | Preview20250311WebSearchServerTool$Outbound | LegacyWebSearchServerTool$Outbound | WebSearchServerTool$Outbound | FileSearchServerTool$Outbound | ComputerUseServerTool$Outbound | CodeInterpreterServerTool$Outbound | McpServerTool$Outbound | ImageGenerationServerTool$Outbound | CodexLocalShellTool$Outbound | ShellServerTool$Outbound | ApplyPatchServerTool$Outbound | CustomTool$Outbound | (DatetimeServerTool$Outbound & {
+        type: "openrouter:datetime";
+    }) | WebSearchServerToolOpenRouter$Outbound> | undefined;
+    top_k?: number | undefined;
+    top_logprobs?: number | undefined;
+    top_p?: number | undefined;
+    trace?: TraceConfig$Outbound | undefined;
+    truncation?: string | null | undefined;
+    user?: string | undefined;
+};
+/** @internal */
+export declare const ResponsesRequest$outboundSchema: z.ZodType<ResponsesRequest$Outbound, ResponsesRequest>;
+export declare function responsesRequestToJSON(responsesRequest: ResponsesRequest): string;
+//# sourceMappingURL=responsesrequest.d.ts.map

package/esm/models/responsesrequest.js

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 39799702f982
+ */
+import * as z from "zod/v4";
+import { remap as remap$ } from "../lib/primitives.js";
+import * as openEnums from "../types/enums.js";
+import { ApplyPatchServerTool$outboundSchema, } from "./applypatchservertool.js";
+import { AutoRouterPlugin$outboundSchema, } from "./autorouterplugin.js";
+import { CodeInterpreterServerTool$outboundSchema, } from "./codeinterpreterservertool.js";
+import { CodexLocalShellTool$outboundSchema, } from "./codexlocalshelltool.js";
+import { ComputerUseServerTool$outboundSchema, } from "./computeruseservertool.js";
+import { ContextCompressionPlugin$outboundSchema, } from "./contextcompressionplugin.js";
+import { CustomTool$outboundSchema, } from "./customtool.js";
+import { DatetimeServerTool$outboundSchema, } from "./datetimeservertool.js";
+import { FileParserPlugin$outboundSchema, } from "./fileparserplugin.js";
+import { FileSearchServerTool$outboundSchema, } from "./filesearchservertool.js";
+import { ImageGenerationServerTool$outboundSchema, } from "./imagegenerationservertool.js";
+import { InputsUnion$outboundSchema, } from "./inputsunion.js";
+import { LegacyWebSearchServerTool$outboundSchema, } from "./legacywebsearchservertool.js";
+import { McpServerTool$outboundSchema, } from "./mcpservertool.js";
+import { ModerationPlugin$outboundSchema, } from "./moderationplugin.js";
+import { OpenAIResponsesToolChoiceUnion$outboundSchema, } from "./openairesponsestoolchoiceunion.js";
+import { OpenAIResponsesTruncation$outboundSchema, } from "./openairesponsestruncation.js";
+import { OutputModalityEnum$outboundSchema, } from "./outputmodalityenum.js";
+import { Preview20250311WebSearchServerTool$outboundSchema, } from "./preview20250311websearchservertool.js";
+import { PreviewWebSearchServerTool$outboundSchema, } from "./previewwebsearchservertool.js";
+import { ProviderPreferences$outboundSchema, } from "./providerpreferences.js";
+import { ReasoningConfig$outboundSchema, } from "./reasoningconfig.js";
+import { ResponseHealingPlugin$outboundSchema, } from "./responsehealingplugin.js";
+import { ResponseIncludesEnum$outboundSchema, } from "./responseincludesenum.js";
+import { ShellServerTool$outboundSchema, } from "./shellservertool.js";
+import { StoredPromptTemplate$outboundSchema, } from "./storedprompttemplate.js";
+import { TextExtendedConfig$outboundSchema, } from "./textextendedconfig.js";
+import { TraceConfig$outboundSchema, } from "./traceconfig.js";
+import { WebSearchPlugin$outboundSchema, } from "./websearchplugin.js";
+import { WebSearchServerTool$outboundSchema, } from "./websearchservertool.js";
+import { WebSearchServerToolOpenRouter$outboundSchema, } from "./websearchservertoolopenrouter.js";
+export const ResponsesRequestServiceTier = {
+    Auto: "auto",
+    Default: "default",
+    Flex: "flex",
+    Priority: "priority",
+    Scale: "scale",
+};
+/** @internal */
+export const ResponsesRequestImageConfig$outboundSchema = z.union([z.string(), z.number()]);
+export function responsesRequestImageConfigToJSON(responsesRequestImageConfig) {
+    return JSON.stringify(ResponsesRequestImageConfig$outboundSchema.parse(responsesRequestImageConfig));
+}
+/** @internal */
+export const ResponsesRequestPlugin$outboundSchema = z.union([
+    AutoRouterPlugin$outboundSchema,
+    ContextCompressionPlugin$outboundSchema,
+    FileParserPlugin$outboundSchema,
+    ModerationPlugin$outboundSchema,
+    ResponseHealingPlugin$outboundSchema,
+    WebSearchPlugin$outboundSchema,
+]);
+export function responsesRequestPluginToJSON(responsesRequestPlugin) {
+    return JSON.stringify(ResponsesRequestPlugin$outboundSchema.parse(responsesRequestPlugin));
+}
+/** @internal */
+export const ResponsesRequestServiceTier$outboundSchema = openEnums.outboundSchema(ResponsesRequestServiceTier);
+/** @internal */
+export const ResponsesRequestToolFunction$outboundSchema = z.object({
+    description: z.nullable(z.string()).optional(),
+    name: z.string(),
+    parameters: z.nullable(z.record(z.string(), z.nullable(z.any()))),
+    strict: z.nullable(z.boolean()).optional(),
+    type: z.literal("function"),
+});
+export function responsesRequestToolFunctionToJSON(responsesRequestToolFunction) {
+    return JSON.stringify(ResponsesRequestToolFunction$outboundSchema.parse(responsesRequestToolFunction));
+}
+/** @internal */
+export const ResponsesRequestToolUnion$outboundSchema = z.union([
+    z.lazy(() => ResponsesRequestToolFunction$outboundSchema),
+    PreviewWebSearchServerTool$outboundSchema,
+    Preview20250311WebSearchServerTool$outboundSchema,
+    LegacyWebSearchServerTool$outboundSchema,
+    WebSearchServerTool$outboundSchema,
+    FileSearchServerTool$outboundSchema,
+    ComputerUseServerTool$outboundSchema,
+    CodeInterpreterServerTool$outboundSchema,
+    McpServerTool$outboundSchema,
+    ImageGenerationServerTool$outboundSchema,
+    CodexLocalShellTool$outboundSchema,
+    ShellServerTool$outboundSchema,
+    ApplyPatchServerTool$outboundSchema,
+    CustomTool$outboundSchema,
+    DatetimeServerTool$outboundSchema.and(z.object({ type: z.literal("openrouter:datetime") })),
+    WebSearchServerToolOpenRouter$outboundSchema,
+]);
+export function responsesRequestToolUnionToJSON(responsesRequestToolUnion) {
+    return JSON.stringify(ResponsesRequestToolUnion$outboundSchema.parse(responsesRequestToolUnion));
+}
+/** @internal */
+export const ResponsesRequest$outboundSchema = z.object({
+    background: z.nullable(z.boolean()).optional(),
+    frequencyPenalty: z.number().optional(),
+    imageConfig: z.record(z.string(), z.union([z.string(), z.number()]))
+        .optional(),
+    include: z.nullable(z.array(ResponseIncludesEnum$outboundSchema)).optional(),
+    input: InputsUnion$outboundSchema.optional(),
+    instructions: z.nullable(z.string()).optional(),
+    maxOutputTokens: z.int().optional(),
+    maxToolCalls: z.int().optional(),
+    metadata: z.nullable(z.record(z.string(), z.string())).optional(),
+    modalities: z.array(OutputModalityEnum$outboundSchema).optional(),
+    model: z.string().optional(),
+    models: z.array(z.string()).optional(),
+    parallelToolCalls: z.nullable(z.boolean()).optional(),
+    plugins: z.array(z.union([
+        AutoRouterPlugin$outboundSchema,
+        ContextCompressionPlugin$outboundSchema,
+        FileParserPlugin$outboundSchema,
+        ModerationPlugin$outboundSchema,
+        ResponseHealingPlugin$outboundSchema,
+        WebSearchPlugin$outboundSchema,
+    ])).optional(),
+    presencePenalty: z.number().optional(),
+    previousResponseId: z.nullable(z.string()).optional(),
+    prompt: z.nullable(StoredPromptTemplate$outboundSchema).optional(),
+    promptCacheKey: z.nullable(z.string()).optional(),
+    provider: z.nullable(ProviderPreferences$outboundSchema).optional(),
+    reasoning: z.nullable(ReasoningConfig$outboundSchema).optional(),
+    safetyIdentifier: z.nullable(z.string()).optional(),
+    serviceTier: z.nullable(ResponsesRequestServiceTier$outboundSchema.default("auto")),
+    sessionId: z.string().optional(),
+    store: z.literal(false).default(false),
+    stream: z.boolean().default(false),
+    temperature: z.number().optional(),
+    text: TextExtendedConfig$outboundSchema.optional(),
+    toolChoice: OpenAIResponsesToolChoiceUnion$outboundSchema.optional(),
+    tools: z.array(z.union([
+        z.lazy(() => ResponsesRequestToolFunction$outboundSchema),
+        PreviewWebSearchServerTool$outboundSchema,
+        Preview20250311WebSearchServerTool$outboundSchema,
+        LegacyWebSearchServerTool$outboundSchema,
+        WebSearchServerTool$outboundSchema,
+        FileSearchServerTool$outboundSchema,
+        ComputerUseServerTool$outboundSchema,
+        CodeInterpreterServerTool$outboundSchema,
+        McpServerTool$outboundSchema,
+        ImageGenerationServerTool$outboundSchema,
+        CodexLocalShellTool$outboundSchema,
+        ShellServerTool$outboundSchema,
+        ApplyPatchServerTool$outboundSchema,
+        CustomTool$outboundSchema,
+        DatetimeServerTool$outboundSchema.and(z.object({ type: z.literal("openrouter:datetime") })),
+        WebSearchServerToolOpenRouter$outboundSchema,
+    ])).optional(),
+    topK: z.int().optional(),
+    topLogprobs: z.int().optional(),
+    topP: z.number().optional(),
+    trace: TraceConfig$outboundSchema.optional(),
+    truncation: z.nullable(OpenAIResponsesTruncation$outboundSchema).optional(),
+    user: z.string().optional(),
+}).transform((v) => {
+    return remap$(v, {
+        frequencyPenalty: "frequency_penalty",
+        imageConfig: "image_config",
+        maxOutputTokens: "max_output_tokens",
+        maxToolCalls: "max_tool_calls",
+        parallelToolCalls: "parallel_tool_calls",
+        presencePenalty: "presence_penalty",
+        previousResponseId: "previous_response_id",
+        promptCacheKey: "prompt_cache_key",
+        safetyIdentifier: "safety_identifier",
+        serviceTier: "service_tier",
+        sessionId: "session_id",
+        toolChoice: "tool_choice",
+        topK: "top_k",
+        topLogprobs: "top_logprobs",
+        topP: "top_p",
+    });
+});
+export function responsesRequestToJSON(responsesRequest) {
+    return JSON.stringify(ResponsesRequest$outboundSchema.parse(responsesRequest));
+}
+//# sourceMappingURL=responsesrequest.js.map

package/esm/models/searchcontextsizeenum.d.ts

@@ -0,0 +1,19 @@
+import * as z from "zod/v4";
+import { OpenEnum } from "../types/enums.js";
+/**
+ * Size of the search context for web search tools
+ */
+export declare const SearchContextSizeEnum: {
+    readonly Low: "low";
+    readonly Medium: "medium";
+    readonly High: "high";
+};
+/**
+ * Size of the search context for web search tools
+ */
+export type SearchContextSizeEnum = OpenEnum<typeof SearchContextSizeEnum>;
+/** @internal */
+export declare const SearchContextSizeEnum$inboundSchema: z.ZodType<SearchContextSizeEnum, unknown>;
+/** @internal */
+export declare const SearchContextSizeEnum$outboundSchema: z.ZodType<string, SearchContextSizeEnum>;
+//# sourceMappingURL=searchcontextsizeenum.d.ts.map

package/esm/models/searchcontextsizeenum.js

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d76263d711fe
+ */
+import * as openEnums from "../types/enums.js";
+/**
+ * Size of the search context for web search tools
+ */
+export const SearchContextSizeEnum = {
+    Low: "low",
+    Medium: "medium",
+    High: "high",
+};
+/** @internal */
+export const SearchContextSizeEnum$inboundSchema = openEnums.inboundSchema(SearchContextSizeEnum);
+/** @internal */
+export const SearchContextSizeEnum$outboundSchema = openEnums.outboundSchema(SearchContextSizeEnum);
+//# sourceMappingURL=searchcontextsizeenum.js.map

package/esm/models/searchqualitylevel.d.ts

@@ -0,0 +1,17 @@
+import * as z from "zod/v4";
+import { OpenEnum } from "../types/enums.js";
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export declare const SearchQualityLevel: {
+    readonly Low: "low";
+    readonly Medium: "medium";
+    readonly High: "high";
+};
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export type SearchQualityLevel = OpenEnum<typeof SearchQualityLevel>;
+/** @internal */
+export declare const SearchQualityLevel$outboundSchema: z.ZodType<string, SearchQualityLevel>;
+//# sourceMappingURL=searchqualitylevel.d.ts.map

package/esm/models/searchqualitylevel.js

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3f28e436c1e6
+ */
+import * as openEnums from "../types/enums.js";
+/**
+ * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
+ */
+export const SearchQualityLevel = {
+    Low: "low",
+    Medium: "medium",
+    High: "high",
+};
+/** @internal */
+export const SearchQualityLevel$outboundSchema = openEnums.outboundSchema(SearchQualityLevel);
+//# sourceMappingURL=searchqualitylevel.js.map

package/esm/models/shellservertool.d.ts

@@ -0,0 +1,20 @@
+import * as z from "zod/v4";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+/**
+ * Shell tool configuration
+ */
+export type ShellServerTool = {
+    type: "shell";
+};
+/** @internal */
+export declare const ShellServerTool$inboundSchema: z.ZodType<ShellServerTool, unknown>;
+/** @internal */
+export type ShellServerTool$Outbound = {
+    type: "shell";
+};
+/** @internal */
+export declare const ShellServerTool$outboundSchema: z.ZodType<ShellServerTool$Outbound, ShellServerTool>;
+export declare function shellServerToolToJSON(shellServerTool: ShellServerTool): string;
+export declare function shellServerToolFromJSON(jsonString: string): SafeParseResult<ShellServerTool, SDKValidationError>;
+//# sourceMappingURL=shellservertool.d.ts.map

package/esm/models/shellservertool.js

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4bd6823cb793
+ */
+import * as z from "zod/v4";
+import { safeParse } from "../lib/schemas.js";
+/** @internal */
+export const ShellServerTool$inboundSchema = z.object({
+    type: z.literal("shell"),
+});
+/** @internal */
+export const ShellServerTool$outboundSchema = z.object({
+    type: z.literal("shell"),
+});
+export function shellServerToolToJSON(shellServerTool) {
+    return JSON.stringify(ShellServerTool$outboundSchema.parse(shellServerTool));
+}
+export function shellServerToolFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => ShellServerTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ShellServerTool' from JSON`);
+}
+//# sourceMappingURL=shellservertool.js.map

package/esm/models/storedprompttemplate.d.ts

@@ -0,0 +1,35 @@
+import * as z from "zod/v4";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { InputFile, InputFile$Outbound } from "./inputfile.js";
+import { InputImage, InputImage$Outbound } from "./inputimage.js";
+import { InputText, InputText$Outbound } from "./inputtext.js";
+export type Variables = InputText | InputImage | InputFile | string;
+export type StoredPromptTemplate = {
+    id: string;
+    variables?: {
+        [k: string]: InputText | InputImage | InputFile | string;
+    } | null | undefined;
+};
+/** @internal */
+export declare const Variables$inboundSchema: z.ZodType<Variables, unknown>;
+/** @internal */
+export type Variables$Outbound = InputText$Outbound | InputImage$Outbound | InputFile$Outbound | string;
+/** @internal */
+export declare const Variables$outboundSchema: z.ZodType<Variables$Outbound, Variables>;
+export declare function variablesToJSON(variables: Variables): string;
+export declare function variablesFromJSON(jsonString: string): SafeParseResult<Variables, SDKValidationError>;
+/** @internal */
+export declare const StoredPromptTemplate$inboundSchema: z.ZodType<StoredPromptTemplate, unknown>;
+/** @internal */
+export type StoredPromptTemplate$Outbound = {
+    id: string;
+    variables?: {
+        [k: string]: InputText$Outbound | InputImage$Outbound | InputFile$Outbound | string;
+    } | null | undefined;
+};
+/** @internal */
+export declare const StoredPromptTemplate$outboundSchema: z.ZodType<StoredPromptTemplate$Outbound, StoredPromptTemplate>;
+export declare function storedPromptTemplateToJSON(storedPromptTemplate: StoredPromptTemplate): string;
+export declare function storedPromptTemplateFromJSON(jsonString: string): SafeParseResult<StoredPromptTemplate, SDKValidationError>;
+//# sourceMappingURL=storedprompttemplate.d.ts.map

package/esm/models/storedprompttemplate.js

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4a3405746141
+ */
+import * as z from "zod/v4";
+import { safeParse } from "../lib/schemas.js";
+import { InputFile$inboundSchema, InputFile$outboundSchema, } from "./inputfile.js";
+import { InputImage$inboundSchema, InputImage$outboundSchema, } from "./inputimage.js";
+import { InputText$inboundSchema, InputText$outboundSchema, } from "./inputtext.js";
+/** @internal */
+export const Variables$inboundSchema = z.union([
+    InputText$inboundSchema,
+    InputImage$inboundSchema,
+    InputFile$inboundSchema,
+    z.string(),
+]);
+/** @internal */
+export const Variables$outboundSchema = z.union([
+    InputText$outboundSchema,
+    InputImage$outboundSchema,
+    InputFile$outboundSchema,
+    z.string(),
+]);
+export function variablesToJSON(variables) {
+    return JSON.stringify(Variables$outboundSchema.parse(variables));
+}
+export function variablesFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Variables$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Variables' from JSON`);
+}
+/** @internal */
+export const StoredPromptTemplate$inboundSchema = z.object({
+    id: z.string(),
+    variables: z.nullable(z.record(z.string(), z.union([
+        InputText$inboundSchema,
+        InputImage$inboundSchema,
+        InputFile$inboundSchema,
+        z.string(),
+    ]))).optional(),
+});
+/** @internal */
+export const StoredPromptTemplate$outboundSchema = z.object({
+    id: z.string(),
+    variables: z.nullable(z.record(z.string(), z.union([
+        InputText$outboundSchema,
+        InputImage$outboundSchema,
+        InputFile$outboundSchema,
+        z.string(),
+    ]))).optional(),
+});
+export function storedPromptTemplateToJSON(storedPromptTemplate) {
+    return JSON.stringify(StoredPromptTemplate$outboundSchema.parse(storedPromptTemplate));
+}
+export function storedPromptTemplateFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => StoredPromptTemplate$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'StoredPromptTemplate' from JSON`);
+}
+//# sourceMappingURL=storedprompttemplate.js.map

package/esm/models/streamevents.d.ts

@@ -0,0 +1,42 @@
+import * as z from "zod/v4";
+import * as discriminatedUnionTypes from "../types/discriminatedUnion.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { AnnotationAddedEvent } from "./annotationaddedevent.js";
+import { ContentPartAddedEvent } from "./contentpartaddedevent.js";
+import { ContentPartDoneEvent } from "./contentpartdoneevent.js";
+import { ErrorEvent } from "./errorevent.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { FunctionCallArgsDeltaEvent } from "./functioncallargsdeltaevent.js";
+import { FunctionCallArgsDoneEvent } from "./functioncallargsdoneevent.js";
+import { ImageGenCallCompletedEvent } from "./imagegencallcompletedevent.js";
+import { ImageGenCallGeneratingEvent } from "./imagegencallgeneratingevent.js";
+import { ImageGenCallInProgressEvent } from "./imagegencallinprogressevent.js";
+import { ImageGenCallPartialImageEvent } from "./imagegencallpartialimageevent.js";
+import { OpenResponsesCreatedEvent } from "./openresponsescreatedevent.js";
+import { OpenResponsesInProgressEvent } from "./openresponsesinprogressevent.js";
+import { ReasoningDeltaEvent } from "./reasoningdeltaevent.js";
+import { ReasoningDoneEvent } from "./reasoningdoneevent.js";
+import { ReasoningSummaryPartAddedEvent } from "./reasoningsummarypartaddedevent.js";
+import { ReasoningSummaryPartDoneEvent } from "./reasoningsummarypartdoneevent.js";
+import { ReasoningSummaryTextDeltaEvent } from "./reasoningsummarytextdeltaevent.js";
+import { ReasoningSummaryTextDoneEvent } from "./reasoningsummarytextdoneevent.js";
+import { RefusalDeltaEvent } from "./refusaldeltaevent.js";
+import { RefusalDoneEvent } from "./refusaldoneevent.js";
+import { StreamEventsResponseCompleted } from "./streameventsresponsecompleted.js";
+import { StreamEventsResponseFailed } from "./streameventsresponsefailed.js";
+import { StreamEventsResponseIncomplete } from "./streameventsresponseincomplete.js";
+import { StreamEventsResponseOutputItemAdded } from "./streameventsresponseoutputitemadded.js";
+import { StreamEventsResponseOutputItemDone } from "./streameventsresponseoutputitemdone.js";
+import { TextDeltaEvent } from "./textdeltaevent.js";
+import { TextDoneEvent } from "./textdoneevent.js";
+import { WebSearchCallCompletedEvent } from "./websearchcallcompletedevent.js";
+import { WebSearchCallInProgressEvent } from "./websearchcallinprogressevent.js";
+import { WebSearchCallSearchingEvent } from "./websearchcallsearchingevent.js";
+/**
+ * Union of all possible event types emitted during response streaming
+ */
+export type StreamEvents = ErrorEvent | StreamEventsResponseCompleted | ContentPartAddedEvent | ContentPartDoneEvent | OpenResponsesCreatedEvent | StreamEventsResponseFailed | FunctionCallArgsDeltaEvent | FunctionCallArgsDoneEvent | ImageGenCallCompletedEvent | ImageGenCallGeneratingEvent | ImageGenCallInProgressEvent | ImageGenCallPartialImageEvent | OpenResponsesInProgressEvent | StreamEventsResponseIncomplete | StreamEventsResponseOutputItemAdded | StreamEventsResponseOutputItemDone | AnnotationAddedEvent | TextDeltaEvent | TextDoneEvent | ReasoningSummaryPartAddedEvent | ReasoningSummaryPartDoneEvent | ReasoningSummaryTextDeltaEvent | ReasoningSummaryTextDoneEvent | ReasoningDeltaEvent | ReasoningDoneEvent | RefusalDeltaEvent | RefusalDoneEvent | WebSearchCallCompletedEvent | WebSearchCallInProgressEvent | WebSearchCallSearchingEvent | discriminatedUnionTypes.Unknown<"type">;
+/** @internal */
+export declare const StreamEvents$inboundSchema: z.ZodType<StreamEvents, unknown>;
+export declare function streamEventsFromJSON(jsonString: string): SafeParseResult<StreamEvents, SDKValidationError>;
+//# sourceMappingURL=streamevents.d.ts.map