@openrouter/sdk 0.0.0-beta.0

package/src/lib/security.ts

@@ -0,0 +1,271 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as models from "../models/index.js";
+import { env } from "./env.js";
+
+type OAuth2PasswordFlow = {
+  username: string;
+  password: string;
+  clientID?: string | undefined;
+  clientSecret?: string | undefined;
+  tokenURL: string;
+};
+
+export enum SecurityErrorCode {
+  Incomplete = "incomplete",
+  UnrecognisedSecurityType = "unrecognized_security_type",
+}
+
+export class SecurityError extends Error {
+  constructor(
+    public code: SecurityErrorCode,
+    message: string,
+  ) {
+    super(message);
+    this.name = "SecurityError";
+  }
+
+  static incomplete(): SecurityError {
+    return new SecurityError(
+      SecurityErrorCode.Incomplete,
+      "Security requirements not met in order to perform the operation",
+    );
+  }
+  static unrecognizedType(type: string): SecurityError {
+    return new SecurityError(
+      SecurityErrorCode.UnrecognisedSecurityType,
+      `Unrecognised security type: ${type}`,
+    );
+  }
+}
+
+export type SecurityState = {
+  basic: { username?: string | undefined; password?: string | undefined };
+  headers: Record<string, string>;
+  queryParams: Record<string, string>;
+  cookies: Record<string, string>;
+  oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" };
+};
+
+type SecurityInputBasic = {
+  type: "http:basic";
+  value:
+    | { username?: string | undefined; password?: string | undefined }
+    | null
+    | undefined;
+};
+
+type SecurityInputBearer = {
+  type: "http:bearer";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputAPIKey = {
+  type: "apiKey:header" | "apiKey:query" | "apiKey:cookie";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOIDC = {
+  type: "openIdConnect";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOAuth2 = {
+  type: "oauth2";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOAuth2ClientCredentials = {
+  type: "oauth2:client_credentials";
+  value:
+    | {
+      clientID?: string | undefined;
+      clientSecret?: string | undefined;
+    }
+    | null
+    | string
+    | undefined;
+  fieldName?: string;
+};
+
+type SecurityInputOAuth2PasswordCredentials = {
+  type: "oauth2:password";
+  value:
+    | string
+    | null
+    | undefined;
+  fieldName?: string;
+};
+
+type SecurityInputCustom = {
+  type: "http:custom";
+  value: any | null | undefined;
+  fieldName?: string;
+};
+
+export type SecurityInput =
+  | SecurityInputBasic
+  | SecurityInputBearer
+  | SecurityInputAPIKey
+  | SecurityInputOAuth2
+  | SecurityInputOAuth2ClientCredentials
+  | SecurityInputOAuth2PasswordCredentials
+  | SecurityInputOIDC
+  | SecurityInputCustom;
+
+export function resolveSecurity(
+  ...options: SecurityInput[][]
+): SecurityState | null {
+  const state: SecurityState = {
+    basic: {},
+    headers: {},
+    queryParams: {},
+    cookies: {},
+    oauth2: { type: "none" },
+  };
+
+  const option = options.find((opts) => {
+    return opts.every((o) => {
+      if (o.value == null) {
+        return false;
+      } else if (o.type === "http:basic") {
+        return o.value.username != null || o.value.password != null;
+      } else if (o.type === "http:custom") {
+        return null;
+      } else if (o.type === "oauth2:password") {
+        return (
+          typeof o.value === "string" && !!o.value
+        );
+      } else if (o.type === "oauth2:client_credentials") {
+        if (typeof o.value == "string") {
+          return !!o.value;
+        }
+        return o.value.clientID != null || o.value.clientSecret != null;
+      } else if (typeof o.value === "string") {
+        return !!o.value;
+      } else {
+        throw new Error(
+          `Unrecognized security type: ${o.type} (value type: ${typeof o
+            .value})`,
+        );
+      }
+    });
+  });
+  if (option == null) {
+    return null;
+  }
+
+  option.forEach((spec) => {
+    if (spec.value == null) {
+      return;
+    }
+
+    const { type } = spec;
+
+    switch (type) {
+      case "apiKey:header":
+        state.headers[spec.fieldName] = spec.value;
+        break;
+      case "apiKey:query":
+        state.queryParams[spec.fieldName] = spec.value;
+        break;
+      case "apiKey:cookie":
+        state.cookies[spec.fieldName] = spec.value;
+        break;
+      case "http:basic":
+        applyBasic(state, spec);
+        break;
+      case "http:custom":
+        break;
+      case "http:bearer":
+        applyBearer(state, spec);
+        break;
+      case "oauth2":
+        applyBearer(state, spec);
+        break;
+      case "oauth2:password":
+        applyBearer(state, spec);
+        break;
+      case "oauth2:client_credentials":
+        break;
+      case "openIdConnect":
+        applyBearer(state, spec);
+        break;
+      default:
+        spec satisfies never;
+        throw SecurityError.unrecognizedType(type);
+    }
+  });
+
+  return state;
+}
+
+function applyBasic(
+  state: SecurityState,
+  spec: SecurityInputBasic,
+) {
+  if (spec.value == null) {
+    return;
+  }
+
+  state.basic = spec.value;
+}
+
+function applyBearer(
+  state: SecurityState,
+  spec:
+    | SecurityInputBearer
+    | SecurityInputOAuth2
+    | SecurityInputOIDC
+    | SecurityInputOAuth2PasswordCredentials,
+) {
+  if (typeof spec.value !== "string" || !spec.value) {
+    return;
+  }
+
+  let value = spec.value;
+  if (value.slice(0, 7).toLowerCase() !== "bearer ") {
+    value = `Bearer ${value}`;
+  }
+
+  if (spec.fieldName !== undefined) {
+    state.headers[spec.fieldName] = value;
+  }
+}
+
+export function resolveGlobalSecurity(
+  security: Partial<models.Security> | null | undefined,
+): SecurityState | null {
+  return resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "apiKey:header",
+        value: security?.apiKeyAuth ?? env().OPENROUTER_API_KEY_AUTH,
+      },
+    ],
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.bearer ?? env().OPENROUTER_BEARER,
+      },
+    ],
+  );
+}
+
+export async function extractSecurity<
+  T extends string | Record<string, unknown>,
+>(sec: T | (() => Promise<T>) | undefined): Promise<T | undefined> {
+  if (sec == null) {
+    return;
+  }
+
+  return typeof sec === "function" ? sec() : sec;
+}

package/src/lib/url.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+const hasOwn = Object.prototype.hasOwnProperty;
+
+export type Params = Partial<Record<string, string | number>>;
+
+export function pathToFunc(
+  pathPattern: string,
+  options?: { charEncoding?: "percent" | "none" },
+): (params?: Params) => string {
+  const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
+
+  return function buildURLPath(params: Record<string, unknown> = {}): string {
+    return pathPattern.replace(paramRE, function (_, placeholder) {
+      if (!hasOwn.call(params, placeholder)) {
+        throw new Error(`Parameter '${placeholder}' is required`);
+      }
+
+      const value = params[placeholder];
+      if (typeof value !== "string" && typeof value !== "number") {
+        throw new Error(
+          `Parameter '${placeholder}' must be a string or number`,
+        );
+      }
+
+      return options?.charEncoding === "percent"
+        ? encodeURIComponent(`${value}`)
+        : `${value}`;
+    });
+  };
+}

package/src/models/activityitem.ts

@@ -0,0 +1,156 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type ActivityItem = {
+  /**
+   * Date of the activity (YYYY-MM-DD format)
+   */
+  date: string;
+  /**
+   * Model slug (e.g., "openai/gpt-4.1")
+   */
+  model: string;
+  /**
+   * Model permaslug (e.g., "openai/gpt-4.1-2025-04-14")
+   */
+  modelPermaslug: string;
+  /**
+   * Unique identifier for the endpoint
+   */
+  endpointId: string;
+  /**
+   * Name of the provider serving this endpoint
+   */
+  providerName: string;
+  /**
+   * Total cost in USD (OpenRouter credits spent)
+   */
+  usage: number;
+  /**
+   * BYOK inference cost in USD (external credits spent)
+   */
+  byokUsageInference: number;
+  /**
+   * Number of requests made
+   */
+  requests: number;
+  /**
+   * Total prompt tokens used
+   */
+  promptTokens: number;
+  /**
+   * Total completion tokens generated
+   */
+  completionTokens: number;
+  /**
+   * Total reasoning tokens used
+   */
+  reasoningTokens: number;
+};
+
+/** @internal */
+export const ActivityItem$inboundSchema: z.ZodType<
+  ActivityItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  date: z.string(),
+  model: z.string(),
+  model_permaslug: z.string(),
+  endpoint_id: z.string(),
+  provider_name: z.string(),
+  usage: z.number(),
+  byok_usage_inference: z.number(),
+  requests: z.number(),
+  prompt_tokens: z.number(),
+  completion_tokens: z.number(),
+  reasoning_tokens: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "model_permaslug": "modelPermaslug",
+    "endpoint_id": "endpointId",
+    "provider_name": "providerName",
+    "byok_usage_inference": "byokUsageInference",
+    "prompt_tokens": "promptTokens",
+    "completion_tokens": "completionTokens",
+    "reasoning_tokens": "reasoningTokens",
+  });
+});
+
+/** @internal */
+export type ActivityItem$Outbound = {
+  date: string;
+  model: string;
+  model_permaslug: string;
+  endpoint_id: string;
+  provider_name: string;
+  usage: number;
+  byok_usage_inference: number;
+  requests: number;
+  prompt_tokens: number;
+  completion_tokens: number;
+  reasoning_tokens: number;
+};
+
+/** @internal */
+export const ActivityItem$outboundSchema: z.ZodType<
+  ActivityItem$Outbound,
+  z.ZodTypeDef,
+  ActivityItem
+> = z.object({
+  date: z.string(),
+  model: z.string(),
+  modelPermaslug: z.string(),
+  endpointId: z.string(),
+  providerName: z.string(),
+  usage: z.number(),
+  byokUsageInference: z.number(),
+  requests: z.number(),
+  promptTokens: z.number(),
+  completionTokens: z.number(),
+  reasoningTokens: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    modelPermaslug: "model_permaslug",
+    endpointId: "endpoint_id",
+    providerName: "provider_name",
+    byokUsageInference: "byok_usage_inference",
+    promptTokens: "prompt_tokens",
+    completionTokens: "completion_tokens",
+    reasoningTokens: "reasoning_tokens",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ActivityItem$ {
+  /** @deprecated use `ActivityItem$inboundSchema` instead. */
+  export const inboundSchema = ActivityItem$inboundSchema;
+  /** @deprecated use `ActivityItem$outboundSchema` instead. */
+  export const outboundSchema = ActivityItem$outboundSchema;
+  /** @deprecated use `ActivityItem$Outbound` instead. */
+  export type Outbound = ActivityItem$Outbound;
+}
+
+export function activityItemToJSON(activityItem: ActivityItem): string {
+  return JSON.stringify(ActivityItem$outboundSchema.parse(activityItem));
+}
+
+export function activityItemFromJSON(
+  jsonString: string,
+): SafeParseResult<ActivityItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ActivityItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ActivityItem' from JSON`,
+  );
+}

package/src/models/assistantmessage.ts

@@ -0,0 +1,163 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  ChatMessageContentItem,
+  ChatMessageContentItem$inboundSchema,
+  ChatMessageContentItem$Outbound,
+  ChatMessageContentItem$outboundSchema,
+} from "./chatmessagecontentitem.js";
+import {
+  ChatMessageToolCall,
+  ChatMessageToolCall$inboundSchema,
+  ChatMessageToolCall$Outbound,
+  ChatMessageToolCall$outboundSchema,
+} from "./chatmessagetoolcall.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type AssistantMessageContent = string | Array<ChatMessageContentItem>;
+
+export type AssistantMessage = {
+  role: "assistant";
+  content?: string | Array<ChatMessageContentItem> | null | undefined;
+  name?: string | undefined;
+  toolCalls?: Array<ChatMessageToolCall> | undefined;
+  refusal?: string | null | undefined;
+  reasoning?: string | null | undefined;
+};
+
+/** @internal */
+export const AssistantMessageContent$inboundSchema: z.ZodType<
+  AssistantMessageContent,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.array(ChatMessageContentItem$inboundSchema)]);
+
+/** @internal */
+export type AssistantMessageContent$Outbound =
+  | string
+  | Array<ChatMessageContentItem$Outbound>;
+
+/** @internal */
+export const AssistantMessageContent$outboundSchema: z.ZodType<
+  AssistantMessageContent$Outbound,
+  z.ZodTypeDef,
+  AssistantMessageContent
+> = z.union([z.string(), z.array(ChatMessageContentItem$outboundSchema)]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AssistantMessageContent$ {
+  /** @deprecated use `AssistantMessageContent$inboundSchema` instead. */
+  export const inboundSchema = AssistantMessageContent$inboundSchema;
+  /** @deprecated use `AssistantMessageContent$outboundSchema` instead. */
+  export const outboundSchema = AssistantMessageContent$outboundSchema;
+  /** @deprecated use `AssistantMessageContent$Outbound` instead. */
+  export type Outbound = AssistantMessageContent$Outbound;
+}
+
+export function assistantMessageContentToJSON(
+  assistantMessageContent: AssistantMessageContent,
+): string {
+  return JSON.stringify(
+    AssistantMessageContent$outboundSchema.parse(assistantMessageContent),
+  );
+}
+
+export function assistantMessageContentFromJSON(
+  jsonString: string,
+): SafeParseResult<AssistantMessageContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssistantMessageContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssistantMessageContent' from JSON`,
+  );
+}
+
+/** @internal */
+export const AssistantMessage$inboundSchema: z.ZodType<
+  AssistantMessage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  role: z.literal("assistant"),
+  content: z.nullable(
+    z.union([z.string(), z.array(ChatMessageContentItem$inboundSchema)]),
+  ).optional(),
+  name: z.string().optional(),
+  tool_calls: z.array(ChatMessageToolCall$inboundSchema).optional(),
+  refusal: z.nullable(z.string()).optional(),
+  reasoning: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "tool_calls": "toolCalls",
+  });
+});
+
+/** @internal */
+export type AssistantMessage$Outbound = {
+  role: "assistant";
+  content?: string | Array<ChatMessageContentItem$Outbound> | null | undefined;
+  name?: string | undefined;
+  tool_calls?: Array<ChatMessageToolCall$Outbound> | undefined;
+  refusal?: string | null | undefined;
+  reasoning?: string | null | undefined;
+};
+
+/** @internal */
+export const AssistantMessage$outboundSchema: z.ZodType<
+  AssistantMessage$Outbound,
+  z.ZodTypeDef,
+  AssistantMessage
+> = z.object({
+  role: z.literal("assistant"),
+  content: z.nullable(
+    z.union([z.string(), z.array(ChatMessageContentItem$outboundSchema)]),
+  ).optional(),
+  name: z.string().optional(),
+  toolCalls: z.array(ChatMessageToolCall$outboundSchema).optional(),
+  refusal: z.nullable(z.string()).optional(),
+  reasoning: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    toolCalls: "tool_calls",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AssistantMessage$ {
+  /** @deprecated use `AssistantMessage$inboundSchema` instead. */
+  export const inboundSchema = AssistantMessage$inboundSchema;
+  /** @deprecated use `AssistantMessage$outboundSchema` instead. */
+  export const outboundSchema = AssistantMessage$outboundSchema;
+  /** @deprecated use `AssistantMessage$Outbound` instead. */
+  export type Outbound = AssistantMessage$Outbound;
+}
+
+export function assistantMessageToJSON(
+  assistantMessage: AssistantMessage,
+): string {
+  return JSON.stringify(
+    AssistantMessage$outboundSchema.parse(assistantMessage),
+  );
+}
+
+export function assistantMessageFromJSON(
+  jsonString: string,
+): SafeParseResult<AssistantMessage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssistantMessage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssistantMessage' from JSON`,
+  );
+}

package/src/models/chaterror.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type ChatErrorError = {
+  code: string | null;
+  message: string;
+  param: string | null;
+  type: string;
+};
+
+/** @internal */
+export const ChatErrorError$inboundSchema: z.ZodType<
+  ChatErrorError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.nullable(z.string()),
+  message: z.string(),
+  param: z.nullable(z.string()),
+  type: z.string(),
+});
+
+/** @internal */
+export type ChatErrorError$Outbound = {
+  code: string | null;
+  message: string;
+  param: string | null;
+  type: string;
+};
+
+/** @internal */
+export const ChatErrorError$outboundSchema: z.ZodType<
+  ChatErrorError$Outbound,
+  z.ZodTypeDef,
+  ChatErrorError
+> = z.object({
+  code: z.nullable(z.string()),
+  message: z.string(),
+  param: z.nullable(z.string()),
+  type: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChatErrorError$ {
+  /** @deprecated use `ChatErrorError$inboundSchema` instead. */
+  export const inboundSchema = ChatErrorError$inboundSchema;
+  /** @deprecated use `ChatErrorError$outboundSchema` instead. */
+  export const outboundSchema = ChatErrorError$outboundSchema;
+  /** @deprecated use `ChatErrorError$Outbound` instead. */
+  export type Outbound = ChatErrorError$Outbound;
+}
+
+export function chatErrorErrorToJSON(chatErrorError: ChatErrorError): string {
+  return JSON.stringify(ChatErrorError$outboundSchema.parse(chatErrorError));
+}
+
+export function chatErrorErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ChatErrorError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChatErrorError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChatErrorError' from JSON`,
+  );
+}