@unkey/api 2.1.0 → 2.1.2

package/src/models/components/v2ratelimitmultilimitresponsebody.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
+import {
+  V2RatelimitMultiLimitResponseData,
+  V2RatelimitMultiLimitResponseData$inboundSchema,
+  V2RatelimitMultiLimitResponseData$Outbound,
+  V2RatelimitMultiLimitResponseData$outboundSchema,
+} from "./v2ratelimitmultilimitresponsedata.js";
+
+export type V2RatelimitMultiLimitResponseBody = {
+  /**
+   * Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
+   */
+  meta: Meta;
+  /**
+   * Container for multi-limit rate limit check results
+   */
+  data: V2RatelimitMultiLimitResponseData;
+};
+
+/** @internal */
+export const V2RatelimitMultiLimitResponseBody$inboundSchema: z.ZodType<
+  V2RatelimitMultiLimitResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: V2RatelimitMultiLimitResponseData$inboundSchema,
+});
+/** @internal */
+export type V2RatelimitMultiLimitResponseBody$Outbound = {
+  meta: Meta$Outbound;
+  data: V2RatelimitMultiLimitResponseData$Outbound;
+};
+
+/** @internal */
+export const V2RatelimitMultiLimitResponseBody$outboundSchema: z.ZodType<
+  V2RatelimitMultiLimitResponseBody$Outbound,
+  z.ZodTypeDef,
+  V2RatelimitMultiLimitResponseBody
+> = z.object({
+  meta: Meta$outboundSchema,
+  data: V2RatelimitMultiLimitResponseData$outboundSchema,
+});
+
+export function v2RatelimitMultiLimitResponseBodyToJSON(
+  v2RatelimitMultiLimitResponseBody: V2RatelimitMultiLimitResponseBody,
+): string {
+  return JSON.stringify(
+    V2RatelimitMultiLimitResponseBody$outboundSchema.parse(
+      v2RatelimitMultiLimitResponseBody,
+    ),
+  );
+}
+export function v2RatelimitMultiLimitResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2RatelimitMultiLimitResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2RatelimitMultiLimitResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2RatelimitMultiLimitResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2ratelimitmultilimitresponsedata.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  V2RatelimitMultiLimitCheck,
+  V2RatelimitMultiLimitCheck$inboundSchema,
+  V2RatelimitMultiLimitCheck$Outbound,
+  V2RatelimitMultiLimitCheck$outboundSchema,
+} from "./v2ratelimitmultilimitcheck.js";
+
+/**
+ * Container for multi-limit rate limit check results
+ */
+export type V2RatelimitMultiLimitResponseData = {
+  /**
+   * Overall success indicator for all rate limit checks. This is true if ALL individual rate limit checks passed (all have success: true), and false if ANY check failed.
+   *
+   * @remarks
+   *
+   * Use this as a quick indicator to determine if the request should proceed.
+   */
+  passed: boolean;
+  /**
+   * Array of individual rate limit check results, one for each rate limit check in the request
+   */
+  limits: Array<V2RatelimitMultiLimitCheck>;
+};
+
+/** @internal */
+export const V2RatelimitMultiLimitResponseData$inboundSchema: z.ZodType<
+  V2RatelimitMultiLimitResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  passed: z.boolean(),
+  limits: z.array(V2RatelimitMultiLimitCheck$inboundSchema),
+});
+/** @internal */
+export type V2RatelimitMultiLimitResponseData$Outbound = {
+  passed: boolean;
+  limits: Array<V2RatelimitMultiLimitCheck$Outbound>;
+};
+
+/** @internal */
+export const V2RatelimitMultiLimitResponseData$outboundSchema: z.ZodType<
+  V2RatelimitMultiLimitResponseData$Outbound,
+  z.ZodTypeDef,
+  V2RatelimitMultiLimitResponseData
+> = z.object({
+  passed: z.boolean(),
+  limits: z.array(V2RatelimitMultiLimitCheck$outboundSchema),
+});
+
+export function v2RatelimitMultiLimitResponseDataToJSON(
+  v2RatelimitMultiLimitResponseData: V2RatelimitMultiLimitResponseData,
+): string {
+  return JSON.stringify(
+    V2RatelimitMultiLimitResponseData$outboundSchema.parse(
+      v2RatelimitMultiLimitResponseData,
+    ),
+  );
+}
+export function v2RatelimitMultiLimitResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<V2RatelimitMultiLimitResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2RatelimitMultiLimitResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2RatelimitMultiLimitResponseData' from JSON`,
+  );
+}

package/src/sdk/keys.ts

@@ -7,6 +7,7 @@ import { keysAddRoles } from "../funcs/keysAddRoles.js";
 import { keysCreateKey } from "../funcs/keysCreateKey.js";
 import { keysDeleteKey } from "../funcs/keysDeleteKey.js";
 import { keysGetKey } from "../funcs/keysGetKey.js";
+import { keysMigrateKeys } from "../funcs/keysMigrateKeys.js";
 import { keysRemovePermissions } from "../funcs/keysRemovePermissions.js";
 import { keysRemoveRoles } from "../funcs/keysRemoveRoles.js";
 import { keysRerollKey } from "../funcs/keysRerollKey.js";
@@ -172,6 +173,28 @@ export class Keys extends ClientSDK {
     ));
   }
 
+  /**
+   * Migrate API key(s)
+   *
+   * @remarks
+   * Returns HTTP 200 even on partial success; hashes that could not be migrated are listed under `data.failed`.
+   *
+   * **Required Permissions**
+   * Your root key must have one of the following permissions for basic key information:
+   * - `api.*.create_key` (to migrate keys to any API)
+   * - `api.<api_id>.create_key` (to migrate keys to a specific API)
+   */
+  async migrateKeys(
+    request: components.V2KeysMigrateKeysRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2KeysMigrateKeysResponseBody> {
+    return unwrapAsync(keysMigrateKeys(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Remove key permissions
    *

package/src/sdk/ratelimit.ts

@@ -6,6 +6,7 @@ import { ratelimitDeleteOverride } from "../funcs/ratelimitDeleteOverride.js";
 import { ratelimitGetOverride } from "../funcs/ratelimitGetOverride.js";
 import { ratelimitLimit } from "../funcs/ratelimitLimit.js";
 import { ratelimitListOverrides } from "../funcs/ratelimitListOverrides.js";
+import { ratelimitMultiLimit } from "../funcs/ratelimitMultiLimit.js";
 import { ratelimitSetOverride } from "../funcs/ratelimitSetOverride.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -73,10 +74,6 @@ export class Ratelimit extends ClientSDK {
    * Your root key must have one of the following permissions:
    * - `ratelimit.*.limit` (to check limits in any namespace)
    * - `ratelimit.<namespace_id>.limit` (to check limits in a specific namespace)
-   *
-   * **Side Effects**
-   *
-   * Records rate limit metrics for analytics and monitoring, updates rate limit counters with sliding window algorithm, and optionally triggers override matching for custom limits.
    */
   async limit(
     request: components.V2RatelimitLimitRequestBody,
@@ -112,6 +109,33 @@ export class Ratelimit extends ClientSDK {
     ));
   }
 
+  /**
+   * Apply multiple rate limit checks
+   *
+   * @remarks
+   * Check and enforce multiple rate limits in a single request for any identifiers (user IDs, IP addresses, API clients, etc.).
+   *
+   * Use this to efficiently check multiple rate limits at once. Each rate limit check is independent and returns its own result with a top-level `passed` indicator showing if all checks succeeded.
+   *
+   * **Response Codes**: Rate limit checks return HTTP 200 regardless of whether limits are exceeded - check the `passed` field to see if all limits passed, or the `success` field in each individual result. 4xx responses indicate auth, namespace existence/deletion, or validation errors (e.g., 410 Gone for deleted namespaces). 5xx responses indicate server errors.
+   *
+   * **Required Permissions**
+   *
+   * Your root key must have one of the following permissions:
+   * - `ratelimit.*.limit` (to check limits in any namespace)
+   * - `ratelimit.<namespace_id>.limit` (to check limits in all specific namespaces being checked)
+   */
+  async multiLimit(
+    request: Array<components.V2RatelimitLimitRequestBody>,
+    options?: RequestOptions,
+  ): Promise<components.V2RatelimitMultiLimitResponseBody> {
+    return unwrapAsync(ratelimitMultiLimit(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Set ratelimit override
    *

package/src/types/enums.ts

@@ -2,15 +2,64 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import * as z from "zod/v3";
+
 declare const __brand: unique symbol;
 export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+export type ClosedEnum<T extends Readonly<Record<string, string | number>>> =
+  T[keyof T];
+export type OpenEnum<T extends Readonly<Record<string, string | number>>> =
+  | T[keyof T]
+  | Unrecognized<T[keyof T] extends number ? number : string>;
 
-export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
+function unrecognized<T>(value: T): Unrecognized<T> {
+  unrecognizedCount++;
   return value as Unrecognized<T>;
 }
 
-type Prettify<T> = { [K in keyof T]: T[K] } & {};
-export type ClosedEnum<T> = T[keyof T];
-export type OpenEnum<T> =
-  | Prettify<T[keyof T]>
-  | Unrecognized<T[keyof T] extends number ? number : string>;
+let unrecognizedCount = 0;
+let refCount = 0;
+export function unrecognizedCounter() {
+  refCount++;
+  const start = unrecognizedCount;
+  return {
+    count: () => {
+      const count = unrecognizedCount - start;
+      if (--refCount === 0) unrecognizedCount = 0;
+      return count;
+    },
+  };
+}
+
+export function inboundSchema<T extends Record<string, string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  const options = Object.values(enumObj);
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.string().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function inboundSchemaInt<T extends Record<string, number | string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  // For numeric enums, Object.values returns both numbers and string keys
+  const options = Object.values(enumObj).filter(v => typeof v === "number");
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.number().int().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function outboundSchema<T extends Record<string, string>>(
+  _: T,
+): z.ZodType<string, z.ZodTypeDef, OpenEnum<T>> {
+  return z.string() as any;
+}
+
+export function outboundSchemaInt<T extends Record<string, number | string>>(
+  _: T,
+): z.ZodType<number, z.ZodTypeDef, OpenEnum<T>> {
+  return z.number().int() as any;
+}

package/src/types/index.ts

@@ -3,7 +3,6 @@
  */
 
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export { catchUnrecognizedEnum } from "./enums.js";
 export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
 export type { Result } from "./fp.js";
 export type { PageIterator, Paginator } from "./operations.js";