@openrouter/sdk 0.0.0-beta.9 → 0.0.1-beta.0

package/src/models/operations/getgeneration.ts

@@ -5,9 +5,14 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
+import {
+  catchUnrecognizedEnum,
+  OpenEnum,
+  Unrecognized,
+} from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as models from "../index.js";
 
 export type GetGenerationRequest = {
   id: string;
@@ -23,7 +28,7 @@ export const ApiType = {
 /**
  * Type of API used for the generation
  */
-export type ApiType = ClosedEnum<typeof ApiType>;
+export type ApiType = OpenEnum<typeof ApiType>;
 
 /**
  * Generation data
@@ -121,6 +126,10 @@ export type GetGenerationData = {
    * 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
    */
@@ -156,15 +165,19 @@ export type GetGenerationData = {
 };
 
 /**
- * Returns the request metadata for this generation
+ * Generation response
  */
-export type GetGenerationResponse = {
+export type GetGenerationResponseBody = {
   /**
    * Generation data
    */
   data: GetGenerationData;
 };
 
+export type GetGenerationResponse =
+  | GetGenerationResponseBody
+  | models.ErrorResponse;
+
 /** @internal */
 export const GetGenerationRequest$inboundSchema: z.ZodType<
   GetGenerationRequest,
@@ -220,12 +233,19 @@ export function getGenerationRequestFromJSON(
 }
 
 /** @internal */
-export const ApiType$inboundSchema: z.ZodNativeEnum<typeof ApiType> = z
-  .nativeEnum(ApiType);
+export const ApiType$inboundSchema: z.ZodType<ApiType, z.ZodTypeDef, unknown> =
+  z
+    .union([
+      z.nativeEnum(ApiType),
+      z.string().transform(catchUnrecognizedEnum),
+    ]);
 
 /** @internal */
-export const ApiType$outboundSchema: z.ZodNativeEnum<typeof ApiType> =
-  ApiType$inboundSchema;
+export const ApiType$outboundSchema: z.ZodType<ApiType, z.ZodTypeDef, ApiType> =
+  z.union([
+    z.nativeEnum(ApiType),
+    z.string().and(z.custom<Unrecognized<string>>()),
+  ]);
 
 /**
  * @internal
@@ -267,6 +287,7 @@ export const GetGenerationData$inboundSchema: z.ZodType<
   native_tokens_reasoning: z.nullable(z.number()),
   native_tokens_cached: z.nullable(z.number()),
   num_media_prompt: z.nullable(z.number()),
+  num_input_audio_prompt: z.nullable(z.number()),
   num_media_completion: z.nullable(z.number()),
   num_search_results: z.nullable(z.number()),
   origin: z.string(),
@@ -295,6 +316,7 @@ export const GetGenerationData$inboundSchema: z.ZodType<
     "native_tokens_reasoning": "nativeTokensReasoning",
     "native_tokens_cached": "nativeTokensCached",
     "num_media_prompt": "numMediaPrompt",
+    "num_input_audio_prompt": "numInputAudioPrompt",
     "num_media_completion": "numMediaCompletion",
     "num_search_results": "numSearchResults",
     "is_byok": "isByok",
@@ -329,6 +351,7 @@ export type GetGenerationData$Outbound = {
   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;
@@ -368,6 +391,7 @@ export const GetGenerationData$outboundSchema: z.ZodType<
   nativeTokensReasoning: z.nullable(z.number()),
   nativeTokensCached: z.nullable(z.number()),
   numMediaPrompt: z.nullable(z.number()),
+  numInputAudioPrompt: z.nullable(z.number()),
   numMediaCompletion: z.nullable(z.number()),
   numSearchResults: z.nullable(z.number()),
   origin: z.string(),
@@ -396,6 +420,7 @@ export const GetGenerationData$outboundSchema: z.ZodType<
     nativeTokensReasoning: "native_tokens_reasoning",
     nativeTokensCached: "native_tokens_cached",
     numMediaPrompt: "num_media_prompt",
+    numInputAudioPrompt: "num_input_audio_prompt",
     numMediaCompletion: "num_media_completion",
     numSearchResults: "num_search_results",
     isByok: "is_byok",
@@ -437,8 +462,8 @@ export function getGenerationDataFromJSON(
 }
 
 /** @internal */
-export const GetGenerationResponse$inboundSchema: z.ZodType<
-  GetGenerationResponse,
+export const GetGenerationResponseBody$inboundSchema: z.ZodType<
+  GetGenerationResponseBody,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -446,19 +471,75 @@ export const GetGenerationResponse$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type GetGenerationResponse$Outbound = {
+export type GetGenerationResponseBody$Outbound = {
   data: GetGenerationData$Outbound;
 };
 
 /** @internal */
-export const GetGenerationResponse$outboundSchema: z.ZodType<
-  GetGenerationResponse$Outbound,
+export const GetGenerationResponseBody$outboundSchema: z.ZodType<
+  GetGenerationResponseBody$Outbound,
   z.ZodTypeDef,
-  GetGenerationResponse
+  GetGenerationResponseBody
 > = z.object({
   data: z.lazy(() => GetGenerationData$outboundSchema),
 });
 
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetGenerationResponseBody$ {
+  /** @deprecated use `GetGenerationResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetGenerationResponseBody$inboundSchema;
+  /** @deprecated use `GetGenerationResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetGenerationResponseBody$outboundSchema;
+  /** @deprecated use `GetGenerationResponseBody$Outbound` instead. */
+  export type Outbound = GetGenerationResponseBody$Outbound;
+}
+
+export function getGenerationResponseBodyToJSON(
+  getGenerationResponseBody: GetGenerationResponseBody,
+): string {
+  return JSON.stringify(
+    GetGenerationResponseBody$outboundSchema.parse(getGenerationResponseBody),
+  );
+}
+
+export function getGenerationResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGenerationResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetGenerationResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGenerationResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetGenerationResponse$inboundSchema: z.ZodType<
+  GetGenerationResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => GetGenerationResponseBody$inboundSchema),
+  models.ErrorResponse$inboundSchema,
+]);
+
+/** @internal */
+export type GetGenerationResponse$Outbound =
+  | GetGenerationResponseBody$Outbound
+  | models.ErrorResponse$Outbound;
+
+/** @internal */
+export const GetGenerationResponse$outboundSchema: z.ZodType<
+  GetGenerationResponse$Outbound,
+  z.ZodTypeDef,
+  GetGenerationResponse
+> = z.union([
+  z.lazy(() => GetGenerationResponseBody$outboundSchema),
+  models.ErrorResponse$outboundSchema,
+]);
+
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.

package/src/models/operations/getkey.ts

@@ -7,128 +7,149 @@ 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";
+import * as models from "../index.js";
+
+export type GetKeyRequest = {
+  hash: string;
+};
 
 /**
- * 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.
+ * The API key information
  */
-export type GetKeyRateLimit = {
-  /**
-   * Number of requests allowed per interval
-   */
-  requests: number;
+export type GetKeyData = {
   /**
-   * Rate limit interval
+   * Unique hash identifier for the API key
    */
-  interval: string;
+  hash: string;
   /**
-   * Note about the rate limit
+   * Name of the API key
    */
-  note: string;
-};
-
-/**
- * Current API key information
- */
-export type GetKeyData = {
+  name: string;
   /**
    * Human-readable label for the API key
    */
   label: string;
+  /**
+   * Whether the API key is disabled
+   */
+  disabled: boolean;
   /**
    * Spending limit for the API key in USD
    */
   limit: number | null;
   /**
-   * Current usage of the API key in USD
+   * 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;
+  /**
+   * Total OpenRouter credit usage (in USD) for the API key
    */
   usage: number;
   /**
-   * Whether this is a free tier API key
+   * OpenRouter credit usage (in USD) for the current UTC day
    */
-  isFreeTier: boolean;
+  usageDaily: number;
   /**
-   * Whether this is a provisioning key
+   * OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday)
    */
-  isProvisioningKey: boolean;
+  usageWeekly: number;
   /**
-   * Remaining spending limit in USD
+   * OpenRouter credit usage (in USD) for the current UTC month
    */
-  limitRemaining: number | null;
+  usageMonthly: number;
+  /**
+   * Total external BYOK usage (in USD) for the API key
+   */
+  byokUsage: number;
   /**
-   * 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.
+   * External BYOK usage (in USD) for the current UTC day
    */
-  rateLimit: GetKeyRateLimit;
+  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;
+  /**
+   * ISO 8601 timestamp of when the API key was created
+   */
+  createdAt: string;
+  /**
+   * ISO 8601 timestamp of when the API key was last updated
+   */
+  updatedAt: string | null;
 };
 
 /**
  * API key details
  */
-export type GetKeyResponse = {
+export type GetKeyResponseBody = {
   /**
-   * Current API key information
+   * The API key information
    */
   data: GetKeyData;
 };
 
+export type GetKeyResponse = GetKeyResponseBody | models.ErrorResponse;
+
 /** @internal */
-export const GetKeyRateLimit$inboundSchema: z.ZodType<
-  GetKeyRateLimit,
+export const GetKeyRequest$inboundSchema: z.ZodType<
+  GetKeyRequest,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  requests: z.number(),
-  interval: z.string(),
-  note: z.string(),
+  hash: z.string(),
 });
 
 /** @internal */
-export type GetKeyRateLimit$Outbound = {
-  requests: number;
-  interval: string;
-  note: string;
+export type GetKeyRequest$Outbound = {
+  hash: string;
 };
 
 /** @internal */
-export const GetKeyRateLimit$outboundSchema: z.ZodType<
-  GetKeyRateLimit$Outbound,
+export const GetKeyRequest$outboundSchema: z.ZodType<
+  GetKeyRequest$Outbound,
   z.ZodTypeDef,
-  GetKeyRateLimit
+  GetKeyRequest
 > = z.object({
-  requests: z.number(),
-  interval: z.string(),
-  note: z.string(),
+  hash: 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 GetKeyRateLimit$ {
-  /** @deprecated use `GetKeyRateLimit$inboundSchema` instead. */
-  export const inboundSchema = GetKeyRateLimit$inboundSchema;
-  /** @deprecated use `GetKeyRateLimit$outboundSchema` instead. */
-  export const outboundSchema = GetKeyRateLimit$outboundSchema;
-  /** @deprecated use `GetKeyRateLimit$Outbound` instead. */
-  export type Outbound = GetKeyRateLimit$Outbound;
+export namespace GetKeyRequest$ {
+  /** @deprecated use `GetKeyRequest$inboundSchema` instead. */
+  export const inboundSchema = GetKeyRequest$inboundSchema;
+  /** @deprecated use `GetKeyRequest$outboundSchema` instead. */
+  export const outboundSchema = GetKeyRequest$outboundSchema;
+  /** @deprecated use `GetKeyRequest$Outbound` instead. */
+  export type Outbound = GetKeyRequest$Outbound;
 }
 
-export function getKeyRateLimitToJSON(
-  getKeyRateLimit: GetKeyRateLimit,
-): string {
-  return JSON.stringify(GetKeyRateLimit$outboundSchema.parse(getKeyRateLimit));
+export function getKeyRequestToJSON(getKeyRequest: GetKeyRequest): string {
+  return JSON.stringify(GetKeyRequest$outboundSchema.parse(getKeyRequest));
 }
 
-export function getKeyRateLimitFromJSON(
+export function getKeyRequestFromJSON(
   jsonString: string,
-): SafeParseResult<GetKeyRateLimit, SDKValidationError> {
+): SafeParseResult<GetKeyRequest, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => GetKeyRateLimit$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetKeyRateLimit' from JSON`,
+    (x) => GetKeyRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetKeyRequest' from JSON`,
   );
 }
 
@@ -138,31 +159,61 @@ export const GetKeyData$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  hash: z.string(),
+  name: z.string(),
   label: z.string(),
+  disabled: z.boolean(),
   limit: z.nullable(z.number()),
-  usage: z.number(),
-  is_free_tier: z.boolean(),
-  is_provisioning_key: z.boolean(),
   limit_remaining: z.nullable(z.number()),
-  rate_limit: z.lazy(() => GetKeyRateLimit$inboundSchema),
+  limit_reset: z.nullable(z.string()),
+  include_byok_in_limit: z.boolean(),
+  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(),
+  created_at: z.string(),
+  updated_at: z.nullable(z.string()),
 }).transform((v) => {
   return remap$(v, {
-    "is_free_tier": "isFreeTier",
-    "is_provisioning_key": "isProvisioningKey",
     "limit_remaining": "limitRemaining",
-    "rate_limit": "rateLimit",
+    "limit_reset": "limitReset",
+    "include_byok_in_limit": "includeByokInLimit",
+    "usage_daily": "usageDaily",
+    "usage_weekly": "usageWeekly",
+    "usage_monthly": "usageMonthly",
+    "byok_usage": "byokUsage",
+    "byok_usage_daily": "byokUsageDaily",
+    "byok_usage_weekly": "byokUsageWeekly",
+    "byok_usage_monthly": "byokUsageMonthly",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
   });
 });
 
 /** @internal */
 export type GetKeyData$Outbound = {
+  hash: string;
+  name: string;
   label: string;
+  disabled: boolean;
   limit: number | null;
-  usage: number;
-  is_free_tier: boolean;
-  is_provisioning_key: boolean;
   limit_remaining: number | null;
-  rate_limit: GetKeyRateLimit$Outbound;
+  limit_reset: string | null;
+  include_byok_in_limit: boolean;
+  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;
+  created_at: string;
+  updated_at: string | null;
 };
 
 /** @internal */
@@ -171,19 +222,38 @@ export const GetKeyData$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetKeyData
 > = z.object({
+  hash: z.string(),
+  name: z.string(),
   label: z.string(),
+  disabled: z.boolean(),
   limit: z.nullable(z.number()),
-  usage: z.number(),
-  isFreeTier: z.boolean(),
-  isProvisioningKey: z.boolean(),
   limitRemaining: z.nullable(z.number()),
-  rateLimit: z.lazy(() => GetKeyRateLimit$outboundSchema),
+  limitReset: z.nullable(z.string()),
+  includeByokInLimit: z.boolean(),
+  usage: z.number(),
+  usageDaily: z.number(),
+  usageWeekly: z.number(),
+  usageMonthly: z.number(),
+  byokUsage: z.number(),
+  byokUsageDaily: z.number(),
+  byokUsageWeekly: z.number(),
+  byokUsageMonthly: z.number(),
+  createdAt: z.string(),
+  updatedAt: z.nullable(z.string()),
 }).transform((v) => {
   return remap$(v, {
-    isFreeTier: "is_free_tier",
-    isProvisioningKey: "is_provisioning_key",
     limitRemaining: "limit_remaining",
-    rateLimit: "rate_limit",
+    limitReset: "limit_reset",
+    includeByokInLimit: "include_byok_in_limit",
+    usageDaily: "usage_daily",
+    usageWeekly: "usage_weekly",
+    usageMonthly: "usage_monthly",
+    byokUsage: "byok_usage",
+    byokUsageDaily: "byok_usage_daily",
+    byokUsageWeekly: "byok_usage_weekly",
+    byokUsageMonthly: "byok_usage_monthly",
+    createdAt: "created_at",
+    updatedAt: "updated_at",
   });
 });
 
@@ -215,8 +285,8 @@ export function getKeyDataFromJSON(
 }
 
 /** @internal */
-export const GetKeyResponse$inboundSchema: z.ZodType<
-  GetKeyResponse,
+export const GetKeyResponseBody$inboundSchema: z.ZodType<
+  GetKeyResponseBody,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -224,19 +294,75 @@ export const GetKeyResponse$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type GetKeyResponse$Outbound = {
+export type GetKeyResponseBody$Outbound = {
   data: GetKeyData$Outbound;
 };
 
 /** @internal */
-export const GetKeyResponse$outboundSchema: z.ZodType<
-  GetKeyResponse$Outbound,
+export const GetKeyResponseBody$outboundSchema: z.ZodType<
+  GetKeyResponseBody$Outbound,
   z.ZodTypeDef,
-  GetKeyResponse
+  GetKeyResponseBody
 > = z.object({
   data: z.lazy(() => GetKeyData$outboundSchema),
 });
 
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetKeyResponseBody$ {
+  /** @deprecated use `GetKeyResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetKeyResponseBody$inboundSchema;
+  /** @deprecated use `GetKeyResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetKeyResponseBody$outboundSchema;
+  /** @deprecated use `GetKeyResponseBody$Outbound` instead. */
+  export type Outbound = GetKeyResponseBody$Outbound;
+}
+
+export function getKeyResponseBodyToJSON(
+  getKeyResponseBody: GetKeyResponseBody,
+): string {
+  return JSON.stringify(
+    GetKeyResponseBody$outboundSchema.parse(getKeyResponseBody),
+  );
+}
+
+export function getKeyResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetKeyResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetKeyResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetKeyResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetKeyResponse$inboundSchema: z.ZodType<
+  GetKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => GetKeyResponseBody$inboundSchema),
+  models.ErrorResponse$inboundSchema,
+]);
+
+/** @internal */
+export type GetKeyResponse$Outbound =
+  | GetKeyResponseBody$Outbound
+  | models.ErrorResponse$Outbound;
+
+/** @internal */
+export const GetKeyResponse$outboundSchema: z.ZodType<
+  GetKeyResponse$Outbound,
+  z.ZodTypeDef,
+  GetKeyResponse
+> = z.union([
+  z.lazy(() => GetKeyResponseBody$outboundSchema),
+  models.ErrorResponse$outboundSchema,
+]);
+
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.