@unkey/api 2.0.4 → 2.0.6

package/src/models/errors/goneerrorresponse.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 the requested resource has been soft-deleted and is no longer available. This occurs when:
+ *
+ * @remarks
+ * - The resource has been marked as deleted but still exists in the database
+ * - The resource is intentionally unavailable but could potentially be restored
+ * - The resource cannot be restored through the API or dashboard
+ *
+ * To resolve this error, contact support if you need the resource restored.
+ */
+export type GoneErrorResponseData = {
+  /**
+   * 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 requested resource has been soft-deleted and is no longer available. This occurs when:
+ *
+ * @remarks
+ * - The resource has been marked as deleted but still exists in the database
+ * - The resource is intentionally unavailable but could potentially be restored
+ * - The resource cannot be restored through the API or dashboard
+ *
+ * To resolve this error, contact support if you need the resource restored.
+ */
+export class GoneErrorResponse 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$: GoneErrorResponseData;
+
+  constructor(
+    err: GoneErrorResponseData,
+    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 = "GoneErrorResponse";
+  }
+}
+
+/** @internal */
+export const GoneErrorResponse$inboundSchema: z.ZodType<
+  GoneErrorResponse,
+  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 GoneErrorResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type GoneErrorResponse$Outbound = {
+  meta: components.Meta$Outbound;
+  error: components.BaseError$Outbound;
+};
+
+/** @internal */
+export const GoneErrorResponse$outboundSchema: z.ZodType<
+  GoneErrorResponse$Outbound,
+  z.ZodTypeDef,
+  GoneErrorResponse
+> = z.instanceof(GoneErrorResponse)
+  .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 GoneErrorResponse$ {
+  /** @deprecated use `GoneErrorResponse$inboundSchema` instead. */
+  export const inboundSchema = GoneErrorResponse$inboundSchema;
+  /** @deprecated use `GoneErrorResponse$outboundSchema` instead. */
+  export const outboundSchema = GoneErrorResponse$outboundSchema;
+  /** @deprecated use `GoneErrorResponse$Outbound` instead. */
+  export type Outbound = GoneErrorResponse$Outbound;
+}

package/src/models/errors/index.ts

@@ -6,6 +6,7 @@ export * from "./apierror.js";
 export * from "./badrequesterrorresponse.js";
 export * from "./conflicterrorresponse.js";
 export * from "./forbiddenerrorresponse.js";
+export * from "./goneerrorresponse.js";
 export * from "./httpclienterrors.js";
 export * from "./internalservererrorresponse.js";
 export * from "./notfounderrorresponse.js";
@@ -13,3 +14,4 @@ export * from "./preconditionfailederrorresponse.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
 export * from "./unauthorizederrorresponse.js";
+export * from "./unkeyerror.js";

package/src/sdk/ratelimit.ts

@@ -66,7 +66,7 @@ export class Ratelimit extends ClientSDK {
    *
    * Use this for rate limiting beyond API keys - limit users by ID, IPs by address, or any custom identifier. Supports namespace organization, variable costs, and custom overrides.
    *
-   * **Important**: Always returns HTTP 200. Check the `success` field to determine if the request should proceed.
+   * **Response Codes**: Rate limit checks return HTTP 200 regardless of whether the limit is exceeded - check the `success` field in the response to determine if the request should be allowed. 4xx responses indicate auth, namespace existence/deletion, or validation errors (e.g., 410 Gone for deleted namespaces). 5xx responses indicate server errors.
    *
    * **Required Permissions**
    *

package/docs/sdks/unkey/README.md

@@ -1,82 +0,0 @@
-# Unkey SDK
-
-## Overview
-
-Unkey API: Unkey's API provides programmatic access for all resources within our platform.
-
-
-### Authentication
-#
-This API uses HTTP Bearer authentication with root keys. Most endpoints require specific permissions associated with your root key. When making requests, include your root key in the `Authorization` header:
-```
-Authorization: Bearer unkey_xxxxxxxxxxx
-```
-
-All responses follow a consistent envelope structure that separates operational metadata from actual data. This design provides several benefits:
-- Debugging: Every response includes a unique requestId for tracing issues
-- Consistency: Predictable response format across all endpoints
-- Extensibility: Easy to add new metadata without breaking existing integrations
-- Error Handling: Unified error format with actionable information
-
-### Success Response Format:
-```json
-{
-  "meta": {
-    "requestId": "req_123456"
-  },
-  "data": {
-    // Actual response data here
-  }
-}
-```
-
-The meta object contains operational information:
-- `requestId`: Unique identifier for this request (essential for support)
-
-The data object contains the actual response data specific to each endpoint.
-
-### Paginated Response Format:
-```json
-{
-  "meta": {
-    "requestId": "req_123456"
-  },
-  "data": [
-    // Array of results
-  ],
-  "pagination": {
-    "cursor": "next_page_token",
-    "hasMore": true
-  }
-}
-```
-
-The pagination object appears on list endpoints and contains:
-- `cursor`: Token for requesting the next page
-- `hasMore`: Whether more results are available
-
-### Error Response Format:
-```json
-{
-  "meta": {
-    "requestId": "req_2c9a0jf23l4k567"
-  },
-  "error": {
-    "detail": "The resource you are attempting to modify is protected and cannot be changed",
-    "status": 403,
-    "title": "Forbidden",
-    "type": "https://unkey.com/docs/errors/unkey/application/protected_resource"
-  }
-}
-```
-
-Error responses include comprehensive diagnostic information:
-- `title`: Human-readable error summary
-- `detail`: Specific description of what went wrong
-- `status`: HTTP status code
-- `type`: Link to error documentation
-- `errors`: Array of validation errors (for 400 responses)
-
-This structure ensures you always have the context needed to debug issues and take corrective action.
-
-### Available Operations