@openrouter/sdk 0.0.1-beta.0 → 0.0.1-beta.10

package/esm/models/operations/getcurrentkey.d.ts

@@ -0,0 +1,186 @@
+import * as z from "zod/v4";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+/**
+ * Legacy rate limit information about a key. Will always return -1.
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export type RateLimit = {
+    /**
+     * Number of requests allowed per interval
+     */
+    requests: number;
+    /**
+     * Rate limit interval
+     */
+    interval: string;
+    /**
+     * Note about the rate limit
+     */
+    note: string;
+};
+/**
+ * Current API key information
+ */
+export type GetCurrentKeyData = {
+    /**
+     * Human-readable label for the API key
+     */
+    label: string;
+    /**
+     * Spending limit for the API key in USD
+     */
+    limit: number | null;
+    /**
+     * Total OpenRouter credit usage (in USD) for the API key
+     */
+    usage: number;
+    /**
+     * OpenRouter credit usage (in USD) for the current UTC day
+     */
+    usageDaily: number;
+    /**
+     * OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday)
+     */
+    usageWeekly: number;
+    /**
+     * OpenRouter credit usage (in USD) for the current UTC month
+     */
+    usageMonthly: number;
+    /**
+     * Total external BYOK usage (in USD) for the API key
+     */
+    byokUsage: number;
+    /**
+     * External BYOK usage (in USD) for the current UTC day
+     */
+    byokUsageDaily: number;
+    /**
+     * External BYOK usage (in USD) for the current UTC week (Monday-Sunday)
+     */
+    byokUsageWeekly: number;
+    /**
+     * External BYOK usage (in USD) for current UTC month
+     */
+    byokUsageMonthly: number;
+    /**
+     * Whether this is a free tier API key
+     */
+    isFreeTier: boolean;
+    /**
+     * Whether this is a provisioning key
+     */
+    isProvisioningKey: boolean;
+    /**
+     * Remaining spending limit in USD
+     */
+    limitRemaining: number | null;
+    /**
+     * Type of limit reset for the API key
+     */
+    limitReset: string | null;
+    /**
+     * Whether to include external BYOK usage in the credit limit
+     */
+    includeByokInLimit: boolean;
+    /**
+     * Legacy rate limit information about a key. Will always return -1.
+     *
+     * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    rateLimit: RateLimit;
+};
+/**
+ * API key details
+ */
+export type GetCurrentKeyResponse = {
+    /**
+     * Current API key information
+     */
+    data: GetCurrentKeyData;
+};
+/** @internal */
+export declare const RateLimit$inboundSchema: z.ZodType<RateLimit, unknown>;
+/** @internal */
+export type RateLimit$Outbound = {
+    requests: number;
+    interval: string;
+    note: string;
+};
+/** @internal */
+export declare const RateLimit$outboundSchema: z.ZodType<RateLimit$Outbound, RateLimit>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace RateLimit$ {
+    /** @deprecated use `RateLimit$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<RateLimit, unknown, z.core.$ZodTypeInternals<RateLimit, unknown>>;
+    /** @deprecated use `RateLimit$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<RateLimit$Outbound, RateLimit, z.core.$ZodTypeInternals<RateLimit$Outbound, RateLimit>>;
+    /** @deprecated use `RateLimit$Outbound` instead. */
+    type Outbound = RateLimit$Outbound;
+}
+export declare function rateLimitToJSON(rateLimit: RateLimit): string;
+export declare function rateLimitFromJSON(jsonString: string): SafeParseResult<RateLimit, SDKValidationError>;
+/** @internal */
+export declare const GetCurrentKeyData$inboundSchema: z.ZodType<GetCurrentKeyData, unknown>;
+/** @internal */
+export type GetCurrentKeyData$Outbound = {
+    label: string;
+    limit: number | null;
+    usage: number;
+    usage_daily: number;
+    usage_weekly: number;
+    usage_monthly: number;
+    byok_usage: number;
+    byok_usage_daily: number;
+    byok_usage_weekly: number;
+    byok_usage_monthly: number;
+    is_free_tier: boolean;
+    is_provisioning_key: boolean;
+    limit_remaining: number | null;
+    limit_reset: string | null;
+    include_byok_in_limit: boolean;
+    rate_limit: RateLimit$Outbound;
+};
+/** @internal */
+export declare const GetCurrentKeyData$outboundSchema: z.ZodType<GetCurrentKeyData$Outbound, GetCurrentKeyData>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetCurrentKeyData$ {
+    /** @deprecated use `GetCurrentKeyData$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetCurrentKeyData, unknown, z.core.$ZodTypeInternals<GetCurrentKeyData, unknown>>;
+    /** @deprecated use `GetCurrentKeyData$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetCurrentKeyData$Outbound, GetCurrentKeyData, z.core.$ZodTypeInternals<GetCurrentKeyData$Outbound, GetCurrentKeyData>>;
+    /** @deprecated use `GetCurrentKeyData$Outbound` instead. */
+    type Outbound = GetCurrentKeyData$Outbound;
+}
+export declare function getCurrentKeyDataToJSON(getCurrentKeyData: GetCurrentKeyData): string;
+export declare function getCurrentKeyDataFromJSON(jsonString: string): SafeParseResult<GetCurrentKeyData, SDKValidationError>;
+/** @internal */
+export declare const GetCurrentKeyResponse$inboundSchema: z.ZodType<GetCurrentKeyResponse, unknown>;
+/** @internal */
+export type GetCurrentKeyResponse$Outbound = {
+    data: GetCurrentKeyData$Outbound;
+};
+/** @internal */
+export declare const GetCurrentKeyResponse$outboundSchema: z.ZodType<GetCurrentKeyResponse$Outbound, GetCurrentKeyResponse>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetCurrentKeyResponse$ {
+    /** @deprecated use `GetCurrentKeyResponse$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetCurrentKeyResponse, unknown, z.core.$ZodTypeInternals<GetCurrentKeyResponse, unknown>>;
+    /** @deprecated use `GetCurrentKeyResponse$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetCurrentKeyResponse$Outbound, GetCurrentKeyResponse, z.core.$ZodTypeInternals<GetCurrentKeyResponse$Outbound, GetCurrentKeyResponse>>;
+    /** @deprecated use `GetCurrentKeyResponse$Outbound` instead. */
+    type Outbound = GetCurrentKeyResponse$Outbound;
+}
+export declare function getCurrentKeyResponseToJSON(getCurrentKeyResponse: GetCurrentKeyResponse): string;
+export declare function getCurrentKeyResponseFromJSON(jsonString: string): SafeParseResult<GetCurrentKeyResponse, SDKValidationError>;
+//# sourceMappingURL=getcurrentkey.d.ts.map

package/esm/models/operations/getcurrentkey.js

@@ -0,0 +1,148 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v4";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+/** @internal */
+export const RateLimit$inboundSchema = z.object({
+    requests: z.number(),
+    interval: z.string(),
+    note: z.string(),
+});
+/** @internal */
+export const RateLimit$outboundSchema = z.object({
+    requests: z.number(),
+    interval: z.string(),
+    note: z.string(),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var RateLimit$;
+(function (RateLimit$) {
+    /** @deprecated use `RateLimit$inboundSchema` instead. */
+    RateLimit$.inboundSchema = RateLimit$inboundSchema;
+    /** @deprecated use `RateLimit$outboundSchema` instead. */
+    RateLimit$.outboundSchema = RateLimit$outboundSchema;
+})(RateLimit$ || (RateLimit$ = {}));
+export function rateLimitToJSON(rateLimit) {
+    return JSON.stringify(RateLimit$outboundSchema.parse(rateLimit));
+}
+export function rateLimitFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => RateLimit$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RateLimit' from JSON`);
+}
+/** @internal */
+export const GetCurrentKeyData$inboundSchema = z.object({
+    label: z.string(),
+    limit: z.nullable(z.number()),
+    usage: z.number(),
+    usage_daily: z.number(),
+    usage_weekly: z.number(),
+    usage_monthly: z.number(),
+    byok_usage: z.number(),
+    byok_usage_daily: z.number(),
+    byok_usage_weekly: z.number(),
+    byok_usage_monthly: z.number(),
+    is_free_tier: z.boolean(),
+    is_provisioning_key: z.boolean(),
+    limit_remaining: z.nullable(z.number()),
+    limit_reset: z.nullable(z.string()),
+    include_byok_in_limit: z.boolean(),
+    rate_limit: z.lazy(() => RateLimit$inboundSchema),
+}).transform((v) => {
+    return remap$(v, {
+        "usage_daily": "usageDaily",
+        "usage_weekly": "usageWeekly",
+        "usage_monthly": "usageMonthly",
+        "byok_usage": "byokUsage",
+        "byok_usage_daily": "byokUsageDaily",
+        "byok_usage_weekly": "byokUsageWeekly",
+        "byok_usage_monthly": "byokUsageMonthly",
+        "is_free_tier": "isFreeTier",
+        "is_provisioning_key": "isProvisioningKey",
+        "limit_remaining": "limitRemaining",
+        "limit_reset": "limitReset",
+        "include_byok_in_limit": "includeByokInLimit",
+        "rate_limit": "rateLimit",
+    });
+});
+/** @internal */
+export const GetCurrentKeyData$outboundSchema = z.object({
+    label: z.string(),
+    limit: z.nullable(z.number()),
+    usage: z.number(),
+    usageDaily: z.number(),
+    usageWeekly: z.number(),
+    usageMonthly: z.number(),
+    byokUsage: z.number(),
+    byokUsageDaily: z.number(),
+    byokUsageWeekly: z.number(),
+    byokUsageMonthly: z.number(),
+    isFreeTier: z.boolean(),
+    isProvisioningKey: z.boolean(),
+    limitRemaining: z.nullable(z.number()),
+    limitReset: z.nullable(z.string()),
+    includeByokInLimit: z.boolean(),
+    rateLimit: z.lazy(() => RateLimit$outboundSchema),
+}).transform((v) => {
+    return remap$(v, {
+        usageDaily: "usage_daily",
+        usageWeekly: "usage_weekly",
+        usageMonthly: "usage_monthly",
+        byokUsage: "byok_usage",
+        byokUsageDaily: "byok_usage_daily",
+        byokUsageWeekly: "byok_usage_weekly",
+        byokUsageMonthly: "byok_usage_monthly",
+        isFreeTier: "is_free_tier",
+        isProvisioningKey: "is_provisioning_key",
+        limitRemaining: "limit_remaining",
+        limitReset: "limit_reset",
+        includeByokInLimit: "include_byok_in_limit",
+        rateLimit: "rate_limit",
+    });
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetCurrentKeyData$;
+(function (GetCurrentKeyData$) {
+    /** @deprecated use `GetCurrentKeyData$inboundSchema` instead. */
+    GetCurrentKeyData$.inboundSchema = GetCurrentKeyData$inboundSchema;
+    /** @deprecated use `GetCurrentKeyData$outboundSchema` instead. */
+    GetCurrentKeyData$.outboundSchema = GetCurrentKeyData$outboundSchema;
+})(GetCurrentKeyData$ || (GetCurrentKeyData$ = {}));
+export function getCurrentKeyDataToJSON(getCurrentKeyData) {
+    return JSON.stringify(GetCurrentKeyData$outboundSchema.parse(getCurrentKeyData));
+}
+export function getCurrentKeyDataFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetCurrentKeyData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetCurrentKeyData' from JSON`);
+}
+/** @internal */
+export const GetCurrentKeyResponse$inboundSchema = z.object({
+    data: z.lazy(() => GetCurrentKeyData$inboundSchema),
+});
+/** @internal */
+export const GetCurrentKeyResponse$outboundSchema = z.object({
+    data: z.lazy(() => GetCurrentKeyData$outboundSchema),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetCurrentKeyResponse$;
+(function (GetCurrentKeyResponse$) {
+    /** @deprecated use `GetCurrentKeyResponse$inboundSchema` instead. */
+    GetCurrentKeyResponse$.inboundSchema = GetCurrentKeyResponse$inboundSchema;
+    /** @deprecated use `GetCurrentKeyResponse$outboundSchema` instead. */
+    GetCurrentKeyResponse$.outboundSchema = GetCurrentKeyResponse$outboundSchema;
+})(GetCurrentKeyResponse$ || (GetCurrentKeyResponse$ = {}));
+export function getCurrentKeyResponseToJSON(getCurrentKeyResponse) {
+    return JSON.stringify(GetCurrentKeyResponse$outboundSchema.parse(getCurrentKeyResponse));
+}
+export function getCurrentKeyResponseFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetCurrentKeyResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetCurrentKeyResponse' from JSON`);
+}
+//# sourceMappingURL=getcurrentkey.js.map

package/esm/models/operations/getgeneration.d.ts

@@ -0,0 +1,272 @@
+import * as z from "zod/v4";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type GetGenerationRequest = {
+    id: string;
+};
+/**
+ * Type of API used for the generation
+ */
+export declare const ApiType: {
+    readonly Completions: "completions";
+    readonly Embeddings: "embeddings";
+};
+/**
+ * Type of API used for the generation
+ */
+export type ApiType = OpenEnum<typeof ApiType>;
+/**
+ * Generation data
+ */
+export type GetGenerationData = {
+    /**
+     * Unique identifier for the generation
+     */
+    id: string;
+    /**
+     * Upstream provider's identifier for this generation
+     */
+    upstreamId: string | null;
+    /**
+     * Total cost of the generation in USD
+     */
+    totalCost: number;
+    /**
+     * Discount applied due to caching
+     */
+    cacheDiscount: number | null;
+    /**
+     * Cost charged by the upstream provider
+     */
+    upstreamInferenceCost: number | null;
+    /**
+     * ISO 8601 timestamp of when the generation was created
+     */
+    createdAt: string;
+    /**
+     * Model used for the generation
+     */
+    model: string;
+    /**
+     * ID of the app that made the request
+     */
+    appId: number | null;
+    /**
+     * Whether the response was streamed
+     */
+    streamed: boolean | null;
+    /**
+     * Whether the generation was cancelled
+     */
+    cancelled: boolean | null;
+    /**
+     * Name of the provider that served the request
+     */
+    providerName: string | null;
+    /**
+     * Total latency in milliseconds
+     */
+    latency: number | null;
+    /**
+     * Moderation latency in milliseconds
+     */
+    moderationLatency: number | null;
+    /**
+     * Time taken for generation in milliseconds
+     */
+    generationTime: number | null;
+    /**
+     * Reason the generation finished
+     */
+    finishReason: string | null;
+    /**
+     * Number of tokens in the prompt
+     */
+    tokensPrompt: number | null;
+    /**
+     * Number of tokens in the completion
+     */
+    tokensCompletion: number | null;
+    /**
+     * Native prompt tokens as reported by provider
+     */
+    nativeTokensPrompt: number | null;
+    /**
+     * Native completion tokens as reported by provider
+     */
+    nativeTokensCompletion: number | null;
+    /**
+     * Native completion image tokens as reported by provider
+     */
+    nativeTokensCompletionImages: number | null;
+    /**
+     * Native reasoning tokens as reported by provider
+     */
+    nativeTokensReasoning: number | null;
+    /**
+     * Native cached tokens as reported by provider
+     */
+    nativeTokensCached: number | null;
+    /**
+     * Number of media items in the prompt
+     */
+    numMediaPrompt: number | null;
+    /**
+     * Number of audio inputs in the prompt
+     */
+    numInputAudioPrompt: number | null;
+    /**
+     * Number of media items in the completion
+     */
+    numMediaCompletion: number | null;
+    /**
+     * Number of search results included
+     */
+    numSearchResults: number | null;
+    /**
+     * Origin URL of the request
+     */
+    origin: string;
+    /**
+     * Usage amount in USD
+     */
+    usage: number;
+    /**
+     * Whether this used bring-your-own-key
+     */
+    isByok: boolean;
+    /**
+     * Native finish reason as reported by provider
+     */
+    nativeFinishReason: string | null;
+    /**
+     * External user identifier
+     */
+    externalUser: string | null;
+    /**
+     * Type of API used for the generation
+     */
+    apiType: ApiType | null;
+};
+/**
+ * Generation response
+ */
+export type GetGenerationResponse = {
+    /**
+     * Generation data
+     */
+    data: GetGenerationData;
+};
+/** @internal */
+export declare const GetGenerationRequest$inboundSchema: z.ZodType<GetGenerationRequest, unknown>;
+/** @internal */
+export type GetGenerationRequest$Outbound = {
+    id: string;
+};
+/** @internal */
+export declare const GetGenerationRequest$outboundSchema: z.ZodType<GetGenerationRequest$Outbound, GetGenerationRequest>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetGenerationRequest$ {
+    /** @deprecated use `GetGenerationRequest$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetGenerationRequest, unknown, z.core.$ZodTypeInternals<GetGenerationRequest, unknown>>;
+    /** @deprecated use `GetGenerationRequest$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetGenerationRequest$Outbound, GetGenerationRequest, z.core.$ZodTypeInternals<GetGenerationRequest$Outbound, GetGenerationRequest>>;
+    /** @deprecated use `GetGenerationRequest$Outbound` instead. */
+    type Outbound = GetGenerationRequest$Outbound;
+}
+export declare function getGenerationRequestToJSON(getGenerationRequest: GetGenerationRequest): string;
+export declare function getGenerationRequestFromJSON(jsonString: string): SafeParseResult<GetGenerationRequest, SDKValidationError>;
+/** @internal */
+export declare const ApiType$inboundSchema: z.ZodType<ApiType, unknown>;
+/** @internal */
+export declare const ApiType$outboundSchema: z.ZodType<ApiType, ApiType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace ApiType$ {
+    /** @deprecated use `ApiType$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<ApiType, unknown, z.core.$ZodTypeInternals<ApiType, unknown>>;
+    /** @deprecated use `ApiType$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<ApiType, ApiType, z.core.$ZodTypeInternals<ApiType, ApiType>>;
+}
+/** @internal */
+export declare const GetGenerationData$inboundSchema: z.ZodType<GetGenerationData, unknown>;
+/** @internal */
+export type GetGenerationData$Outbound = {
+    id: string;
+    upstream_id: string | null;
+    total_cost: number;
+    cache_discount: number | null;
+    upstream_inference_cost: number | null;
+    created_at: string;
+    model: string;
+    app_id: number | null;
+    streamed: boolean | null;
+    cancelled: boolean | null;
+    provider_name: string | null;
+    latency: number | null;
+    moderation_latency: number | null;
+    generation_time: number | null;
+    finish_reason: string | null;
+    tokens_prompt: number | null;
+    tokens_completion: number | null;
+    native_tokens_prompt: number | null;
+    native_tokens_completion: number | null;
+    native_tokens_completion_images: number | null;
+    native_tokens_reasoning: number | null;
+    native_tokens_cached: number | null;
+    num_media_prompt: number | null;
+    num_input_audio_prompt: number | null;
+    num_media_completion: number | null;
+    num_search_results: number | null;
+    origin: string;
+    usage: number;
+    is_byok: boolean;
+    native_finish_reason: string | null;
+    external_user: string | null;
+    api_type: string | null;
+};
+/** @internal */
+export declare const GetGenerationData$outboundSchema: z.ZodType<GetGenerationData$Outbound, GetGenerationData>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetGenerationData$ {
+    /** @deprecated use `GetGenerationData$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetGenerationData, unknown, z.core.$ZodTypeInternals<GetGenerationData, unknown>>;
+    /** @deprecated use `GetGenerationData$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetGenerationData$Outbound, GetGenerationData, z.core.$ZodTypeInternals<GetGenerationData$Outbound, GetGenerationData>>;
+    /** @deprecated use `GetGenerationData$Outbound` instead. */
+    type Outbound = GetGenerationData$Outbound;
+}
+export declare function getGenerationDataToJSON(getGenerationData: GetGenerationData): string;
+export declare function getGenerationDataFromJSON(jsonString: string): SafeParseResult<GetGenerationData, SDKValidationError>;
+/** @internal */
+export declare const GetGenerationResponse$inboundSchema: z.ZodType<GetGenerationResponse, unknown>;
+/** @internal */
+export type GetGenerationResponse$Outbound = {
+    data: GetGenerationData$Outbound;
+};
+/** @internal */
+export declare const GetGenerationResponse$outboundSchema: z.ZodType<GetGenerationResponse$Outbound, GetGenerationResponse>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetGenerationResponse$ {
+    /** @deprecated use `GetGenerationResponse$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetGenerationResponse, unknown, z.core.$ZodTypeInternals<GetGenerationResponse, unknown>>;
+    /** @deprecated use `GetGenerationResponse$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetGenerationResponse$Outbound, GetGenerationResponse, z.core.$ZodTypeInternals<GetGenerationResponse$Outbound, GetGenerationResponse>>;
+    /** @deprecated use `GetGenerationResponse$Outbound` instead. */
+    type Outbound = GetGenerationResponse$Outbound;
+}
+export declare function getGenerationResponseToJSON(getGenerationResponse: GetGenerationResponse): string;
+export declare function getGenerationResponseFromJSON(jsonString: string): SafeParseResult<GetGenerationResponse, SDKValidationError>;
+//# sourceMappingURL=getgeneration.d.ts.map