@unkey/api 0.38.0 → 2.0.0-alpha.11

package/src/models/errors/unauthorizederrorresponse.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import * as components from "../components/index.js";
+import { UnkeyError } from "./unkeyerror.js";
+
+/**
+ * Error response when authentication has failed or credentials are missing. This occurs when:
+ *
+ * @remarks
+ * - No authentication token is provided in the request
+ * - The provided token is invalid, expired, or malformed
+ * - The token format doesn't match expected patterns
+ *
+ * To resolve this error, ensure you're including a valid root key in the Authorization header.
+ */
+export type UnauthorizedErrorResponseData = {
+  /**
+   * 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 authentication has failed or credentials are missing. This occurs when:
+ *
+ * @remarks
+ * - No authentication token is provided in the request
+ * - The provided token is invalid, expired, or malformed
+ * - The token format doesn't match expected patterns
+ *
+ * To resolve this error, ensure you're including a valid root key in the Authorization header.
+ */
+export class UnauthorizedErrorResponse 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$: UnauthorizedErrorResponseData;
+
+  constructor(
+    err: UnauthorizedErrorResponseData,
+    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 = "UnauthorizedErrorResponse";
+  }
+}
+
+/** @internal */
+export const UnauthorizedErrorResponse$inboundSchema: z.ZodType<
+  UnauthorizedErrorResponse,
+  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 UnauthorizedErrorResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type UnauthorizedErrorResponse$Outbound = {
+  meta: components.Meta$Outbound;
+  error: components.BaseError$Outbound;
+};
+
+/** @internal */
+export const UnauthorizedErrorResponse$outboundSchema: z.ZodType<
+  UnauthorizedErrorResponse$Outbound,
+  z.ZodTypeDef,
+  UnauthorizedErrorResponse
+> = z.instanceof(UnauthorizedErrorResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    meta: components.Meta$outboundSchema,
+    error: components.BaseError$outboundSchema,
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UnauthorizedErrorResponse$ {
+  /** @deprecated use `UnauthorizedErrorResponse$inboundSchema` instead. */
+  export const inboundSchema = UnauthorizedErrorResponse$inboundSchema;
+  /** @deprecated use `UnauthorizedErrorResponse$outboundSchema` instead. */
+  export const outboundSchema = UnauthorizedErrorResponse$outboundSchema;
+  /** @deprecated use `UnauthorizedErrorResponse$Outbound` instead. */
+  export type Outbound = UnauthorizedErrorResponse$Outbound;
+}

package/src/models/errors/unkeyerror.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class UnkeyError extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "UnkeyError";
+  }
+}

package/src/models/operations/identitieslistidentities.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type IdentitiesListIdentitiesResponse = {
+  result: components.V2IdentitiesListIdentitiesResponseBody;
+};
+
+/** @internal */
+export const IdentitiesListIdentitiesResponse$inboundSchema: z.ZodType<
+  IdentitiesListIdentitiesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: components.V2IdentitiesListIdentitiesResponseBody$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type IdentitiesListIdentitiesResponse$Outbound = {
+  Result: components.V2IdentitiesListIdentitiesResponseBody$Outbound;
+};
+
+/** @internal */
+export const IdentitiesListIdentitiesResponse$outboundSchema: z.ZodType<
+  IdentitiesListIdentitiesResponse$Outbound,
+  z.ZodTypeDef,
+  IdentitiesListIdentitiesResponse
+> = z.object({
+  result: components.V2IdentitiesListIdentitiesResponseBody$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    result: "Result",
+  });
+});
+
+/**
+ * @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 {
+  return JSON.stringify(
+    IdentitiesListIdentitiesResponse$outboundSchema.parse(
+      identitiesListIdentitiesResponse,
+    ),
+  );
+}
+
+export function identitiesListIdentitiesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<IdentitiesListIdentitiesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IdentitiesListIdentitiesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IdentitiesListIdentitiesResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./identitieslistidentities.js";

package/src/sdk/apis.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { apisCreateApi } from "../funcs/apisCreateApi.js";
+import { apisDeleteApi } from "../funcs/apisDeleteApi.js";
+import { apisGetApi } from "../funcs/apisGetApi.js";
+import { apisListKeys } from "../funcs/apisListKeys.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Apis extends ClientSDK {
+  /**
+   * Create API namespace
+   *
+   * @remarks
+   * Create an API namespace for organizing keys by environment, service, or product.
+   *
+   * Use this to separate production from development keys, isolate different services, or manage multiple products. Each API gets a unique identifier and dedicated infrastructure for secure key operations.
+   *
+   * **Important**: API names must be unique within your workspace and cannot be changed after creation.
+   *
+   * **Required Permissions**
+   *
+   * Your root key must have one of the following permissions:
+   * - `api.*.create_api` (to create APIs in any workspace)
+   */
+  async createApi(
+    request: components.V2ApisCreateApiRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2ApisCreateApiResponseBody> {
+    return unwrapAsync(apisCreateApi(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete API namespace
+   *
+   * @remarks
+   * Permanently delete an API namespace and immediately invalidate all associated keys.
+   *
+   * Use this for cleaning up development environments, retiring deprecated services, or removing unused resources. All keys in the namespace are immediately marked as deleted and will fail verification with `code=NOT_FOUND`.
+   *
+   * **Important**: This operation is immediate and permanent. Verify you have the correct API ID before deletion. If delete protection is enabled, disable it first through the dashboard or API configuration.
+   *
+   * **Required Permissions**
+   *
+   * Your root key must have one of the following permissions:
+   * - `api.*.delete_api` (to delete any API)
+   * - `api.<api_id>.delete_api` (to delete a specific API)
+   */
+  async deleteApi(
+    request: components.V2ApisDeleteApiRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2ApisDeleteApiResponseBody> {
+    return unwrapAsync(apisDeleteApi(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get API namespace
+   *
+   * @remarks
+   * Retrieve basic information about an API namespace including its ID and name.
+   *
+   * Use this to verify an API exists before performing operations, get the human-readable name when you only have the API ID, or confirm access to a specific namespace. For detailed key information, use the `listKeys` endpoint instead.
+   *
+   * **Required Permissions**
+   *
+   * Your root key must have one of the following permissions:
+   * - `api.*.read_api` (to read any API)
+   * - `api.<api_id>.read_api` (to read a specific API)
+   */
+  async getApi(
+    request: components.V2ApisGetApiRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2ApisGetApiResponseBody> {
+    return unwrapAsync(apisGetApi(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List API keys
+   *
+   * @remarks
+   * Retrieve a paginated list of API keys for dashboard and administrative interfaces.
+   *
+   * Use this to build key management dashboards, filter keys by user with `externalId`, or retrieve key details for administrative purposes. Each key includes status, metadata, permissions, and usage limits.
+   *
+   * **Important**: Set `decrypt: true` only in secure contexts to retrieve plaintext key values from recoverable keys.
+   *
+   * **Required Permissions**
+   *
+   * Your root key must have one of the following permissions for basic key listing:
+   * - `api.*.read_key` (to read keys from any API)
+   * - `api.<api_id>.read_key` (to read keys from a specific API)
+   *
+   * Additionally, you need read access to the API itself:
+   * - `api.*.read_api` or `api.<api_id>.read_api`
+   *
+   * Additional permission required for decrypt functionality:
+   * - `api.*.decrypt_key` or `api.<api_id>.decrypt_key`
+   */
+  async listKeys(
+    request: components.V2ApisListKeysRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2ApisListKeysResponseBody> {
+    return unwrapAsync(apisListKeys(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/chproxy.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { chproxyChproxyMetrics } from "../funcs/chproxyChproxyMetrics.js";
+import { chproxyChproxyRatelimits } from "../funcs/chproxyChproxyRatelimits.js";
+import { chproxyChproxyVerifications } from "../funcs/chproxyChproxyVerifications.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Chproxy extends ClientSDK {
+  /**
+   * Internal ClickHouse proxy for API request metrics
+   *
+   * @remarks
+   * Internal endpoint for batching API request metric events to ClickHouse. This endpoint is used internally by the API to efficiently store request/response data for analytics and should not be used by external clients.
+   *
+   * This endpoint bypasses normal authentication and validation as it's intended for internal use only.
+   */
+  async chproxyMetrics(
+    request: Array<{ [k: string]: any }>,
+    options?: RequestOptions,
+  ): Promise<components.ChproxyMetricsResponseBody> {
+    return unwrapAsync(chproxyChproxyMetrics(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Internal ClickHouse proxy for ratelimit events
+   *
+   * @remarks
+   * Internal endpoint for batching ratelimit events to ClickHouse. This endpoint is used internally by the API to efficiently store ratelimit data and should not be used by external clients.
+   *
+   * This endpoint bypasses normal authentication and validation as it's intended for internal use only.
+   */
+  async chproxyRatelimits(
+    request: Array<{ [k: string]: any }>,
+    options?: RequestOptions,
+  ): Promise<components.ChproxyRatelimitsResponseBody> {
+    return unwrapAsync(chproxyChproxyRatelimits(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Internal ClickHouse proxy for verification events
+   *
+   * @remarks
+   * Internal endpoint for batching key verification events to ClickHouse. This endpoint is used internally by the API to efficiently store verification data and should not be used by external clients.
+   *
+   * This endpoint bypasses normal authentication and validation as it's intended for internal use only. External clients should use the standard key verification endpoints instead.
+   */
+  async chproxyVerifications(
+    request: Array<{ [k: string]: any }>,
+    options?: RequestOptions,
+  ): Promise<components.ChproxyVerificationsResponseBody> {
+    return unwrapAsync(chproxyChproxyVerifications(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/identities.ts

@@ -0,0 +1,134 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { identitiesCreateIdentity } from "../funcs/identitiesCreateIdentity.js";
+import { identitiesDeleteIdentity } from "../funcs/identitiesDeleteIdentity.js";
+import { identitiesGetIdentity } from "../funcs/identitiesGetIdentity.js";
+import { identitiesListIdentities } from "../funcs/identitiesListIdentities.js";
+import { identitiesUpdateIdentity } from "../funcs/identitiesUpdateIdentity.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class Identities extends ClientSDK {
+  /**
+   * Create Identity
+   *
+   * @remarks
+   * Create an identity to group multiple API keys under a single entity. Identities enable shared rate limits and metadata across all associated keys.
+   *
+   * Perfect for users with multiple devices, organizations with multiple API keys, or when you need unified rate limiting across different services.
+   *
+   * > **Important**
+   * > Requires `identity.*.create_identity` permission
+   */
+  async createIdentity(
+    request: components.V2IdentitiesCreateIdentityRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2IdentitiesCreateIdentityResponseBody> {
+    return unwrapAsync(identitiesCreateIdentity(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete Identity
+   *
+   * @remarks
+   * Permanently delete an identity. This operation cannot be undone.
+   *
+   * Use this for data cleanup, compliance requirements, or when removing entities from your system.
+   *
+   * > **Important**
+   * > Requires `identity.*.delete_identity` permission
+   * > Associated API keys remain functional but lose shared resources
+   * > External ID becomes available for reuse immediately
+   */
+  async deleteIdentity(
+    request: components.V2IdentitiesDeleteIdentityRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2IdentitiesDeleteIdentityResponseBody> {
+    return unwrapAsync(identitiesDeleteIdentity(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Identity
+   *
+   * @remarks
+   * Retrieve an identity by external ID. Returns metadata, rate limits, and other associated data.
+   *
+   * Use this to check if an identity exists, view configurations, or build management dashboards.
+   *
+   * > **Important**
+   * > Requires `identity.*.read_identity` permission
+   */
+  async getIdentity(
+    request: components.V2IdentitiesGetIdentityRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2IdentitiesGetIdentityResponseBody> {
+    return unwrapAsync(identitiesGetIdentity(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List Identities
+   *
+   * @remarks
+   * Get a paginated list of all identities in your workspace. Returns metadata and rate limit configurations.
+   *
+   * Perfect for building management dashboards, auditing configurations, or browsing your identities.
+   *
+   * > **Important**
+   * > Requires `identity.*.read_identity` permission
+   */
+  async listIdentities(
+    request: components.V2IdentitiesListIdentitiesRequestBody,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.IdentitiesListIdentitiesResponse,
+      { cursor: string }
+    >
+  > {
+    return unwrapResultIterator(identitiesListIdentities(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update Identity
+   *
+   * @remarks
+   * Update an identity's metadata and rate limits. Only specified fields are modified - others remain unchanged.
+   *
+   * Perfect for subscription changes, plan upgrades, or updating user information. Changes take effect immediately.
+   *
+   * > **Important**
+   * > Requires `identity.*.update_identity` permission
+   * > Rate limit changes propagate within 30 seconds
+   */
+  async updateIdentity(
+    request: components.V2IdentitiesUpdateIdentityRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2IdentitiesUpdateIdentityResponseBody> {
+    return unwrapAsync(identitiesUpdateIdentity(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/index.ts

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk.js";