@unkey/api 2.0.6 → 2.1.1

package/src/models/errors/unprocessableentityerrorresponse.ts

@@ -0,0 +1,107 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+import { UnkeyError } from "./unkeyerror.js";
+
+/**
+ * Error response when the request is syntactically valid but cannot be processed due to semantic constraints or resource limitations. This occurs when:
+ *
+ * @remarks
+ * - A query exceeds execution time limits
+ * - A query uses more memory than allowed
+ * - A query scans too many rows
+ * - A query result exceeds size limits
+ *
+ * The request syntax is correct, but the operation cannot be completed due to business rules or resource constraints. Review the error details for specific limitations and adjust your request accordingly.
+ */
+export type UnprocessableEntityErrorResponseData = {
+  /**
+   * 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: components.Meta;
+  /**
+   * Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
+   */
+  error: components.BaseError;
+};
+
+/**
+ * Error response when the request is syntactically valid but cannot be processed due to semantic constraints or resource limitations. This occurs when:
+ *
+ * @remarks
+ * - A query exceeds execution time limits
+ * - A query uses more memory than allowed
+ * - A query scans too many rows
+ * - A query result exceeds size limits
+ *
+ * The request syntax is correct, but the operation cannot be completed due to business rules or resource constraints. Review the error details for specific limitations and adjust your request accordingly.
+ */
+export class UnprocessableEntityErrorResponse extends UnkeyError {
+  /**
+   * 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: components.Meta;
+  /**
+   * Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
+   */
+  error: components.BaseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: UnprocessableEntityErrorResponseData;
+
+  constructor(
+    err: UnprocessableEntityErrorResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.meta = err.meta;
+    this.error = err.error;
+
+    this.name = "UnprocessableEntityErrorResponse";
+  }
+}
+
+/** @internal */
+export const UnprocessableEntityErrorResponse$inboundSchema: z.ZodType<
+  UnprocessableEntityErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: components.Meta$inboundSchema,
+  error: components.BaseError$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new UnprocessableEntityErrorResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type UnprocessableEntityErrorResponse$Outbound = {
+  meta: components.Meta$Outbound;
+  error: components.BaseError$Outbound;
+};
+
+/** @internal */
+export const UnprocessableEntityErrorResponse$outboundSchema: z.ZodType<
+  UnprocessableEntityErrorResponse$Outbound,
+  z.ZodTypeDef,
+  UnprocessableEntityErrorResponse
+> = z.instanceof(UnprocessableEntityErrorResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    meta: components.Meta$outboundSchema,
+    error: components.BaseError$outboundSchema,
+  }));

package/src/models/operations/identitieslistidentities.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
@@ -25,7 +25,6 @@ export const IdentitiesListIdentitiesResponse$inboundSchema: z.ZodType<
     "Result": "result",
   });
 });
-
 /** @internal */
 export type IdentitiesListIdentitiesResponse$Outbound = {
   Result: components.V2IdentitiesListIdentitiesResponseBody$Outbound;
@@ -44,19 +43,6 @@ export const IdentitiesListIdentitiesResponse$outboundSchema: z.ZodType<
   });
 });
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace IdentitiesListIdentitiesResponse$ {
-  /** @deprecated use `IdentitiesListIdentitiesResponse$inboundSchema` instead. */
-  export const inboundSchema = IdentitiesListIdentitiesResponse$inboundSchema;
-  /** @deprecated use `IdentitiesListIdentitiesResponse$outboundSchema` instead. */
-  export const outboundSchema = IdentitiesListIdentitiesResponse$outboundSchema;
-  /** @deprecated use `IdentitiesListIdentitiesResponse$Outbound` instead. */
-  export type Outbound = IdentitiesListIdentitiesResponse$Outbound;
-}
-
 export function identitiesListIdentitiesResponseToJSON(
   identitiesListIdentitiesResponse: IdentitiesListIdentitiesResponse,
 ): string {
@@ -66,7 +52,6 @@ export function identitiesListIdentitiesResponseToJSON(
     ),
   );
 }
-
 export function identitiesListIdentitiesResponseFromJSON(
   jsonString: string,
 ): SafeParseResult<IdentitiesListIdentitiesResponse, SDKValidationError> {

package/src/sdk/analytics.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { analyticsGetVerifications } from "../funcs/analyticsGetVerifications.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Analytics extends ClientSDK {
+  /**
+   * Query key verification data
+   *
+   * @remarks
+   * Execute custom SQL queries against your key verification analytics.
+   * For complete documentation including available tables, columns, data types, query examples, see the schema reference in the API documentation.
+   */
+  async getVerifications(
+    request: components.V2AnalyticsGetVerificationsRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2AnalyticsGetVerificationsResponseBody> {
+    return unwrapAsync(analyticsGetVerifications(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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/sdk/sdk.ts

@@ -3,6 +3,7 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
+import { Analytics } from "./analytics.js";
 import { Apis } from "./apis.js";
 import { Identities } from "./identities.js";
 import { Keys } from "./keys.js";
@@ -10,6 +11,11 @@ import { Permissions } from "./permissions.js";
 import { Ratelimit } from "./ratelimit.js";
 
 export class Unkey extends ClientSDK {
+  private _analytics?: Analytics;
+  get analytics(): Analytics {
+    return (this._analytics ??= new Analytics(this._options));
+  }
+
   private _apis?: Apis;
   get apis(): Apis {
     return (this._apis ??= new Apis(this._options));

package/src/types/blobs.ts

@@ -2,13 +2,14 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 
-export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
-  z.custom<Blob>(isBlobLike, {
-    message: "expected a Blob, File or Blob-like object",
-    fatal: true,
-  });
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> = z.custom<
+  Blob
+>(isBlobLike, {
+  message: "expected a Blob, File or Blob-like object",
+  fatal: true,
+});
 
 export function isBlobLike(val: unknown): val is Blob {
   if (val instanceof Blob) {

package/src/types/constdatetime.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 
 export function constDateTime(
   val: string,

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";