@openrouter/sdk 0.0.0-beta.37 → 0.0.0-beta.39

package/src/models/updateapikeydata.ts

@@ -0,0 +1,222 @@
+/*
+ * 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";
+
+/**
+ * The updated API key information
+ */
+export type UpdateAPIKeyData = {
+  /**
+   * Unique hash identifier for the API key
+   */
+  hash: string;
+  /**
+   * Name of the API key
+   */
+  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;
+  /**
+   * 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;
+  /**
+   * 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;
+  /**
+   * 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;
+};
+
+/** @internal */
+export const UpdateAPIKeyData$inboundSchema: z.ZodType<
+  UpdateAPIKeyData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  hash: z.string(),
+  name: z.string(),
+  label: z.string(),
+  disabled: z.boolean(),
+  limit: z.nullable(z.number()),
+  limit_remaining: z.nullable(z.number()),
+  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, {
+    "limit_remaining": "limitRemaining",
+    "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 UpdateAPIKeyData$Outbound = {
+  hash: string;
+  name: string;
+  label: string;
+  disabled: boolean;
+  limit: number | null;
+  limit_remaining: number | null;
+  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 */
+export const UpdateAPIKeyData$outboundSchema: z.ZodType<
+  UpdateAPIKeyData$Outbound,
+  z.ZodTypeDef,
+  UpdateAPIKeyData
+> = z.object({
+  hash: z.string(),
+  name: z.string(),
+  label: z.string(),
+  disabled: z.boolean(),
+  limit: z.nullable(z.number()),
+  limitRemaining: z.nullable(z.number()),
+  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, {
+    limitRemaining: "limit_remaining",
+    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",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateAPIKeyData$ {
+  /** @deprecated use `UpdateAPIKeyData$inboundSchema` instead. */
+  export const inboundSchema = UpdateAPIKeyData$inboundSchema;
+  /** @deprecated use `UpdateAPIKeyData$outboundSchema` instead. */
+  export const outboundSchema = UpdateAPIKeyData$outboundSchema;
+  /** @deprecated use `UpdateAPIKeyData$Outbound` instead. */
+  export type Outbound = UpdateAPIKeyData$Outbound;
+}
+
+export function updateAPIKeyDataToJSON(
+  updateAPIKeyData: UpdateAPIKeyData,
+): string {
+  return JSON.stringify(
+    UpdateAPIKeyData$outboundSchema.parse(updateAPIKeyData),
+  );
+}
+
+export function updateAPIKeyDataFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateAPIKeyData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateAPIKeyData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateAPIKeyData' from JSON`,
+  );
+}

package/src/sdk/oauth.ts

@@ -7,8 +7,68 @@ import { oAuthExchangeAuthorizationCode } from "../funcs/oAuthExchangeAuthorizat
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
+// #region imports
+import {
+  CreateAuthorizationUrlRequest,
+  oAuthCreateAuthorizationUrl,
+} from "../funcs/custom/oAuthCreateAuthorizationUrl.js";
+import {
+  CreateSHA256CodeChallengeRequest,
+  CreateSHA256CodeChallengeResponse,
+  oAuthCreateSHA256CodeChallenge,
+} from "../funcs/custom/oAuthCreateSHA256CodeChallenge.js";
+// #endregion imports
 
 export class OAuth extends ClientSDK {
+  // #region sdk-class-body
+  /**
+   * Generate a OAuth2 authorization URL
+   *
+   * @remarks
+   * Generates a URL to redirect users to for authorizing your application. The
+   * URL includes the provided callback URL and, if applicable, the code
+   * challenge parameters for PKCE.
+   *
+   * @see {@link https://openrouter.ai/docs/use-cases/oauth-pkce}
+   */
+  async createAuthorizationUrl(
+    request: CreateAuthorizationUrlRequest,
+  ): Promise<string> {
+    const result = oAuthCreateAuthorizationUrl(this, request);
+
+    if (!result.ok) {
+      throw result.error;
+    }
+
+    return result.value;
+  }
+
+  /**
+   * Generate a SHA-256 code challenge for PKCE
+   *
+   * @remarks
+   * Generates a SHA-256 code challenge and corresponding code verifier for use
+   * in the PKCE extension to OAuth2. If no code verifier is provided, a random
+   * one will be generated according to RFC 7636 (32 random bytes, base64url
+   * encoded). If a code verifier is provided, it must be 43-128 characters and
+   * contain only unreserved characters [A-Za-z0-9-._~].
+   *
+   * @see {@link https://openrouter.ai/docs/use-cases/oauth-pkce}
+   * @see {@link https://datatracker.ietf.org/doc/html/rfc7636}
+   */
+  async createSHA256CodeChallenge(
+    request: CreateSHA256CodeChallengeRequest = {},
+  ): Promise<CreateSHA256CodeChallengeResponse> {
+    const result = await oAuthCreateSHA256CodeChallenge(request);
+
+    if (!result.ok) {
+      throw result.error;
+    }
+
+    return result.value;
+  }
+  // #endregion sdk-class-body
+
   /**
    * Exchange authorization code for API key
    *

package/src/sdk/responses.ts

@@ -5,8 +5,8 @@
 import { betaResponsesSend } from "../funcs/betaResponsesSend.js";
 import { EventStream } from "../lib/event-streams.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
-import type { ResponsesNonStreamingResponse } from "../models/responsesnonstreamingresponse.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Responses extends ClientSDK {
@@ -21,7 +21,7 @@ export class Responses extends ClientSDK {
       stream?: false | undefined;
     },
     options?: RequestOptions,
-  ): Promise<ResponsesNonStreamingResponse>;
+  ): Promise<models.ResponsesNonStreamingResponse>;
   async send(
     request: operations.SendResponsesRequestRequest & { stream: true },
     options?: RequestOptions,