@unkey/api 0.38.0 → 2.0.0-alpha.11

package/src/mcp-server/tools/ratelimitSetOverride.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ratelimitSetOverride } from "../../funcs/ratelimitSetOverride.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.V2RatelimitSetOverrideRequestBody$inboundSchema,
+};
+
+export const tool$ratelimitSetOverride: ToolDefinition<typeof args> = {
+  name: "ratelimit-set-override",
+  description: `Set ratelimit override
+
+Create or update a custom rate limit for specific identifiers, bypassing the namespace default.
+
+Use this to create premium tiers with higher limits, apply stricter limits to specific users, or implement emergency throttling.
+
+**Important:** Overrides take effect immediately and completely replace the default limit for matching identifiers. Use wildcard patterns (e.g., \`premium_*\`) to match multiple identifiers.
+
+**Permissions:** Requires \`ratelimit.*.set_override\` or \`ratelimit.<namespace_id>.set_override\`
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await ratelimitSetOverride(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools.ts

@@ -0,0 +1,129 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { objectOutputType, ZodRawShape, ZodTypeAny } from "zod";
+import { UnkeyCore } from "../core.js";
+import { ConsoleLogger } from "./console-logger.js";
+import { MCPScope } from "./scopes.js";
+import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
+
+export type ToolDefinition<Args extends undefined | ZodRawShape = undefined> =
+  Args extends ZodRawShape ? {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args: Args;
+      tool: (
+        client: UnkeyCore,
+        args: objectOutputType<Args, ZodTypeAny>,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    }
+    : {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args?: undefined;
+      tool: (
+        client: UnkeyCore,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    };
+
+// Optional function to assist with formatting tool results
+export async function formatResult(
+  value: unknown,
+  init: { response?: Response | undefined },
+): Promise<CallToolResult> {
+  if (typeof value === "undefined") {
+    return { content: [] };
+  }
+
+  const { response } = init;
+  const contentType = response?.headers.get("content-type") ?? "";
+  let content: CallToolResult["content"] = [];
+
+  if (contentType.search(/\bjson\b/g)) {
+    content = [{ type: "text", text: JSON.stringify(value) }];
+  } else if (
+    contentType.startsWith("text/event-stream")
+    && isAsyncIterable(value)
+  ) {
+    content = await consumeSSE(value);
+  } else if (contentType.startsWith("text/") && typeof value === "string") {
+    content = [{ type: "text", text: value }];
+  } else if (isBinaryData(value) && contentType.startsWith("image/")) {
+    const data = await valueToBase64(value);
+    content = data == null
+      ? []
+      : [{ type: "image", data, mimeType: contentType }];
+  } else {
+    return {
+      content: [{
+        type: "text",
+        text: `Unsupported content type: "${contentType}"`,
+      }],
+      isError: true,
+    };
+  }
+
+  return { content };
+}
+
+async function consumeSSE(
+  value: AsyncIterable<unknown>,
+): Promise<CallToolResult["content"]> {
+  const content: CallToolResult["content"] = [];
+
+  for await (const chunk of value) {
+    if (typeof chunk === "string") {
+      content.push({ type: "text", text: chunk });
+    } else {
+      content.push({ type: "text", text: JSON.stringify(chunk) });
+    }
+  }
+
+  return content;
+}
+
+export function createRegisterTool(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: UnkeyCore,
+  allowedScopes: Set<MCPScope>,
+  allowedTools?: Set<string>,
+): <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>) => void {
+  return <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>): void => {
+    if (allowedTools && !allowedTools.has(tool.name)) {
+      return;
+    }
+
+    const scopes = tool.scopes ?? [];
+    if (allowedScopes.size > 0 && scopes.length === 0) {
+      return;
+    }
+
+    if (
+      allowedScopes.size > 0
+      && !scopes.every((s: MCPScope) => allowedScopes.has(s))
+    ) {
+      return;
+    }
+
+    if (tool.args) {
+      server.tool(tool.name, tool.description, tool.args, async (args, ctx) => {
+        return tool.tool(sdk, args, ctx);
+      });
+    } else {
+      server.tool(tool.name, tool.description, async (ctx) => {
+        return tool.tool(sdk, ctx);
+      });
+    }
+
+    logger.debug("Registered tool", { name: tool.name });
+  };
+}

package/src/models/components/badrequesterrordetails.ts

@@ -0,0 +1,106 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ValidationError,
+  ValidationError$inboundSchema,
+  ValidationError$Outbound,
+  ValidationError$outboundSchema,
+} from "./validationerror.js";
+
+/**
+ * Extended error details specifically for bad request (400) errors. This builds on the BaseError structure by adding an array of individual validation errors, making it easy to identify and fix multiple issues at once.
+ */
+export type BadRequestErrorDetails = {
+  /**
+   * A human-readable explanation specific to this occurrence of the problem. This provides detailed information about what went wrong and potential remediation steps. The message is intended to be helpful for developers troubleshooting the issue.
+   */
+  detail: string;
+  /**
+   * HTTP status code that corresponds to this error. This will match the status code in the HTTP response. Common codes include `400` (Bad Request), `401` (Unauthorized), `403` (Forbidden), `404` (Not Found), `409` (Conflict), and `500` (Internal Server Error).
+   */
+  status: number;
+  /**
+   * A short, human-readable summary of the problem type. This remains constant from occurrence to occurrence of the same problem and should be used for programmatic handling.
+   */
+  title: string;
+  /**
+   * A URI reference that identifies the problem type. This provides a stable identifier for the error that can be used for documentation lookups and programmatic error handling. When followed, this URI should provide human-readable documentation for the problem type.
+   */
+  type: string;
+  /**
+   * List of individual validation errors that occurred in the request. Each error provides specific details about what failed validation, where the error occurred in the request, and suggestions for fixing it. This granular information helps developers quickly identify and resolve multiple issues in a single request without having to make repeated API calls.
+   */
+  errors: Array<ValidationError>;
+};
+
+/** @internal */
+export const BadRequestErrorDetails$inboundSchema: z.ZodType<
+  BadRequestErrorDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  detail: z.string(),
+  status: z.number().int(),
+  title: z.string(),
+  type: z.string(),
+  errors: z.array(ValidationError$inboundSchema),
+});
+
+/** @internal */
+export type BadRequestErrorDetails$Outbound = {
+  detail: string;
+  status: number;
+  title: string;
+  type: string;
+  errors: Array<ValidationError$Outbound>;
+};
+
+/** @internal */
+export const BadRequestErrorDetails$outboundSchema: z.ZodType<
+  BadRequestErrorDetails$Outbound,
+  z.ZodTypeDef,
+  BadRequestErrorDetails
+> = z.object({
+  detail: z.string(),
+  status: z.number().int(),
+  title: z.string(),
+  type: z.string(),
+  errors: z.array(ValidationError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BadRequestErrorDetails$ {
+  /** @deprecated use `BadRequestErrorDetails$inboundSchema` instead. */
+  export const inboundSchema = BadRequestErrorDetails$inboundSchema;
+  /** @deprecated use `BadRequestErrorDetails$outboundSchema` instead. */
+  export const outboundSchema = BadRequestErrorDetails$outboundSchema;
+  /** @deprecated use `BadRequestErrorDetails$Outbound` instead. */
+  export type Outbound = BadRequestErrorDetails$Outbound;
+}
+
+export function badRequestErrorDetailsToJSON(
+  badRequestErrorDetails: BadRequestErrorDetails,
+): string {
+  return JSON.stringify(
+    BadRequestErrorDetails$outboundSchema.parse(badRequestErrorDetails),
+  );
+}
+
+export function badRequestErrorDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<BadRequestErrorDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BadRequestErrorDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BadRequestErrorDetails' from JSON`,
+  );
+}

package/src/models/components/baseerror.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * 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.
+ */
+export type BaseError = {
+  /**
+   * A human-readable explanation specific to this occurrence of the problem. This provides detailed information about what went wrong and potential remediation steps. The message is intended to be helpful for developers troubleshooting the issue.
+   */
+  detail: string;
+  /**
+   * HTTP status code that corresponds to this error. This will match the status code in the HTTP response. Common codes include `400` (Bad Request), `401` (Unauthorized), `403` (Forbidden), `404` (Not Found), `409` (Conflict), and `500` (Internal Server Error).
+   */
+  status: number;
+  /**
+   * A short, human-readable summary of the problem type. This remains constant from occurrence to occurrence of the same problem and should be used for programmatic handling.
+   */
+  title: string;
+  /**
+   * A URI reference that identifies the problem type. This provides a stable identifier for the error that can be used for documentation lookups and programmatic error handling. When followed, this URI should provide human-readable documentation for the problem type.
+   */
+  type: string;
+};
+
+/** @internal */
+export const BaseError$inboundSchema: z.ZodType<
+  BaseError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  detail: z.string(),
+  status: z.number().int(),
+  title: z.string(),
+  type: z.string(),
+});
+
+/** @internal */
+export type BaseError$Outbound = {
+  detail: string;
+  status: number;
+  title: string;
+  type: string;
+};
+
+/** @internal */
+export const BaseError$outboundSchema: z.ZodType<
+  BaseError$Outbound,
+  z.ZodTypeDef,
+  BaseError
+> = z.object({
+  detail: z.string(),
+  status: z.number().int(),
+  title: z.string(),
+  type: 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 BaseError$ {
+  /** @deprecated use `BaseError$inboundSchema` instead. */
+  export const inboundSchema = BaseError$inboundSchema;
+  /** @deprecated use `BaseError$outboundSchema` instead. */
+  export const outboundSchema = BaseError$outboundSchema;
+  /** @deprecated use `BaseError$Outbound` instead. */
+  export type Outbound = BaseError$Outbound;
+}
+
+export function baseErrorToJSON(baseError: BaseError): string {
+  return JSON.stringify(BaseError$outboundSchema.parse(baseError));
+}
+
+export function baseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<BaseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BaseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BaseError' from JSON`,
+  );
+}

package/src/models/components/chproxymetricsresponsebody.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ChproxyMetricsResponseBody = {
+  /**
+   * Processing status
+   */
+  status: string;
+};
+
+/** @internal */
+export const ChproxyMetricsResponseBody$inboundSchema: z.ZodType<
+  ChproxyMetricsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: z.string(),
+});
+
+/** @internal */
+export type ChproxyMetricsResponseBody$Outbound = {
+  status: string;
+};
+
+/** @internal */
+export const ChproxyMetricsResponseBody$outboundSchema: z.ZodType<
+  ChproxyMetricsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ChproxyMetricsResponseBody
+> = z.object({
+  status: 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 ChproxyMetricsResponseBody$ {
+  /** @deprecated use `ChproxyMetricsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ChproxyMetricsResponseBody$inboundSchema;
+  /** @deprecated use `ChproxyMetricsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ChproxyMetricsResponseBody$outboundSchema;
+  /** @deprecated use `ChproxyMetricsResponseBody$Outbound` instead. */
+  export type Outbound = ChproxyMetricsResponseBody$Outbound;
+}
+
+export function chproxyMetricsResponseBodyToJSON(
+  chproxyMetricsResponseBody: ChproxyMetricsResponseBody,
+): string {
+  return JSON.stringify(
+    ChproxyMetricsResponseBody$outboundSchema.parse(chproxyMetricsResponseBody),
+  );
+}
+
+export function chproxyMetricsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ChproxyMetricsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChproxyMetricsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChproxyMetricsResponseBody' from JSON`,
+  );
+}

package/src/models/components/chproxyratelimitsresponsebody.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ChproxyRatelimitsResponseBody = {
+  /**
+   * Processing status
+   */
+  status: string;
+};
+
+/** @internal */
+export const ChproxyRatelimitsResponseBody$inboundSchema: z.ZodType<
+  ChproxyRatelimitsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: z.string(),
+});
+
+/** @internal */
+export type ChproxyRatelimitsResponseBody$Outbound = {
+  status: string;
+};
+
+/** @internal */
+export const ChproxyRatelimitsResponseBody$outboundSchema: z.ZodType<
+  ChproxyRatelimitsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ChproxyRatelimitsResponseBody
+> = z.object({
+  status: 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 ChproxyRatelimitsResponseBody$ {
+  /** @deprecated use `ChproxyRatelimitsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ChproxyRatelimitsResponseBody$inboundSchema;
+  /** @deprecated use `ChproxyRatelimitsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ChproxyRatelimitsResponseBody$outboundSchema;
+  /** @deprecated use `ChproxyRatelimitsResponseBody$Outbound` instead. */
+  export type Outbound = ChproxyRatelimitsResponseBody$Outbound;
+}
+
+export function chproxyRatelimitsResponseBodyToJSON(
+  chproxyRatelimitsResponseBody: ChproxyRatelimitsResponseBody,
+): string {
+  return JSON.stringify(
+    ChproxyRatelimitsResponseBody$outboundSchema.parse(
+      chproxyRatelimitsResponseBody,
+    ),
+  );
+}
+
+export function chproxyRatelimitsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ChproxyRatelimitsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChproxyRatelimitsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChproxyRatelimitsResponseBody' from JSON`,
+  );
+}

package/src/models/components/chproxyverificationsresponsebody.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ChproxyVerificationsResponseBody = {
+  /**
+   * Processing status
+   */
+  status: string;
+};
+
+/** @internal */
+export const ChproxyVerificationsResponseBody$inboundSchema: z.ZodType<
+  ChproxyVerificationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: z.string(),
+});
+
+/** @internal */
+export type ChproxyVerificationsResponseBody$Outbound = {
+  status: string;
+};
+
+/** @internal */
+export const ChproxyVerificationsResponseBody$outboundSchema: z.ZodType<
+  ChproxyVerificationsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ChproxyVerificationsResponseBody
+> = z.object({
+  status: 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 ChproxyVerificationsResponseBody$ {
+  /** @deprecated use `ChproxyVerificationsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ChproxyVerificationsResponseBody$inboundSchema;
+  /** @deprecated use `ChproxyVerificationsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ChproxyVerificationsResponseBody$outboundSchema;
+  /** @deprecated use `ChproxyVerificationsResponseBody$Outbound` instead. */
+  export type Outbound = ChproxyVerificationsResponseBody$Outbound;
+}
+
+export function chproxyVerificationsResponseBodyToJSON(
+  chproxyVerificationsResponseBody: ChproxyVerificationsResponseBody,
+): string {
+  return JSON.stringify(
+    ChproxyVerificationsResponseBody$outboundSchema.parse(
+      chproxyVerificationsResponseBody,
+    ),
+  );
+}
+
+export function chproxyVerificationsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ChproxyVerificationsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChproxyVerificationsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChproxyVerificationsResponseBody' from JSON`,
+  );
+}

package/src/models/components/emptyresponse.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Empty response object by design. A successful response indicates this operation was successfully executed.
+ */
+export type EmptyResponse = {};
+
+/** @internal */
+export const EmptyResponse$inboundSchema: z.ZodType<
+  EmptyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type EmptyResponse$Outbound = {};
+
+/** @internal */
+export const EmptyResponse$outboundSchema: z.ZodType<
+  EmptyResponse$Outbound,
+  z.ZodTypeDef,
+  EmptyResponse
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EmptyResponse$ {
+  /** @deprecated use `EmptyResponse$inboundSchema` instead. */
+  export const inboundSchema = EmptyResponse$inboundSchema;
+  /** @deprecated use `EmptyResponse$outboundSchema` instead. */
+  export const outboundSchema = EmptyResponse$outboundSchema;
+  /** @deprecated use `EmptyResponse$Outbound` instead. */
+  export type Outbound = EmptyResponse$Outbound;
+}
+
+export function emptyResponseToJSON(emptyResponse: EmptyResponse): string {
+  return JSON.stringify(EmptyResponse$outboundSchema.parse(emptyResponse));
+}
+
+export function emptyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EmptyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmptyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmptyResponse' from JSON`,
+  );
+}