@unkey/api 2.0.0-alpha.1 → 2.0.0-alpha.2

package/src/funcs/ratelimitDeleteOverride.ts

@@ -33,10 +33,8 @@ export function ratelimitDeleteOverride(
   Result<
     operations.RatelimitDeleteOverrideResponse,
     | errors.BadRequestError
-    | errors.UnauthorizedError
-    | errors.ForbiddenError
-    | errors.NotFoundError
-    | errors.InternalServerError
+    | errors.BaseError
+    | errors.BaseError
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -62,10 +60,8 @@ async function $do(
     Result<
       operations.RatelimitDeleteOverrideResponse,
       | errors.BadRequestError
-      | errors.UnauthorizedError
-      | errors.ForbiddenError
-      | errors.NotFoundError
-      | errors.InternalServerError
+      | errors.BaseError
+      | errors.BaseError
       | APIError
       | SDKValidationError
       | UnexpectedClientError
@@ -105,7 +101,7 @@ async function $do(
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "ratelimit.deleteOverride",
-    oAuth2Scopes: null,
+    oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
@@ -152,20 +148,14 @@ async function $do(
   const response = doResult.value;
 
   const responseFields = {
-    ContentType: response.headers.get("content-type")
-      ?? "application/octet-stream",
-    StatusCode: response.status,
-    RawResponse: response,
-    Headers: {},
+    HttpMeta: { Response: response, Request: req },
   };
 
   const [result] = await M.match<
     operations.RatelimitDeleteOverrideResponse,
     | errors.BadRequestError
-    | errors.UnauthorizedError
-    | errors.ForbiddenError
-    | errors.NotFoundError
-    | errors.InternalServerError
+    | errors.BaseError
+    | errors.BaseError
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -180,21 +170,15 @@ async function $do(
     M.jsonErr(400, errors.BadRequestError$inboundSchema, {
       ctype: "application/problem+json",
     }),
-    M.jsonErr(401, errors.UnauthorizedError$inboundSchema, {
+    M.jsonErr([401, 403, 404], errors.BaseError$inboundSchema, {
       ctype: "application/problem+json",
     }),
-    M.jsonErr(403, errors.ForbiddenError$inboundSchema, {
-      ctype: "application/problem+json",
-    }),
-    M.jsonErr(404, errors.NotFoundError$inboundSchema, {
-      ctype: "application/problem+json",
-    }),
-    M.jsonErr(500, errors.InternalServerError$inboundSchema, {
+    M.jsonErr(500, errors.BaseError$inboundSchema, {
       ctype: "application/problem+json",
     }),
     M.fail("4XX"),
     M.fail("5XX"),
-  )(response, { extraFields: responseFields });
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/ratelimitGetOverride.ts

@@ -33,10 +33,8 @@ export function ratelimitGetOverride(
   Result<
     operations.RatelimitGetOverrideResponse,
     | errors.BadRequestError
-    | errors.UnauthorizedError
-    | errors.ForbiddenError
-    | errors.NotFoundError
-    | errors.InternalServerError
+    | errors.BaseError
+    | errors.BaseError
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -62,10 +60,8 @@ async function $do(
     Result<
       operations.RatelimitGetOverrideResponse,
       | errors.BadRequestError
-      | errors.UnauthorizedError
-      | errors.ForbiddenError
-      | errors.NotFoundError
-      | errors.InternalServerError
+      | errors.BaseError
+      | errors.BaseError
       | APIError
       | SDKValidationError
       | UnexpectedClientError
@@ -103,7 +99,7 @@ async function $do(
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "ratelimit.getOverride",
-    oAuth2Scopes: null,
+    oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
@@ -150,20 +146,14 @@ async function $do(
   const response = doResult.value;
 
   const responseFields = {
-    ContentType: response.headers.get("content-type")
-      ?? "application/octet-stream",
-    StatusCode: response.status,
-    RawResponse: response,
-    Headers: {},
+    HttpMeta: { Response: response, Request: req },
   };
 
   const [result] = await M.match<
     operations.RatelimitGetOverrideResponse,
     | errors.BadRequestError
-    | errors.UnauthorizedError
-    | errors.ForbiddenError
-    | errors.NotFoundError
-    | errors.InternalServerError
+    | errors.BaseError
+    | errors.BaseError
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -178,21 +168,15 @@ async function $do(
     M.jsonErr(400, errors.BadRequestError$inboundSchema, {
       ctype: "application/problem+json",
     }),
-    M.jsonErr(401, errors.UnauthorizedError$inboundSchema, {
+    M.jsonErr([401, 403, 404], errors.BaseError$inboundSchema, {
       ctype: "application/problem+json",
     }),
-    M.jsonErr(403, errors.ForbiddenError$inboundSchema, {
-      ctype: "application/problem+json",
-    }),
-    M.jsonErr(404, errors.NotFoundError$inboundSchema, {
-      ctype: "application/problem+json",
-    }),
-    M.jsonErr(500, errors.InternalServerError$inboundSchema, {
+    M.jsonErr(500, errors.BaseError$inboundSchema, {
       ctype: "application/problem+json",
     }),
     M.fail("4XX"),
     M.fail("5XX"),
-  )(response, { extraFields: responseFields });
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/ratelimitLimit.ts

@@ -36,10 +36,8 @@ export function ratelimitLimit(
   Result<
     operations.V1RatelimitLimitResponse,
     | errors.BadRequestError
-    | errors.UnauthorizedError
-    | errors.ForbiddenError
-    | errors.NotFoundError
-    | errors.InternalServerError
+    | errors.BaseError
+    | errors.BaseError
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -65,10 +63,8 @@ async function $do(
     Result<
       operations.V1RatelimitLimitResponse,
       | errors.BadRequestError
-      | errors.UnauthorizedError
-      | errors.ForbiddenError
-      | errors.NotFoundError
-      | errors.InternalServerError
+      | errors.BaseError
+      | errors.BaseError
       | APIError
       | SDKValidationError
       | UnexpectedClientError
@@ -106,7 +102,7 @@ async function $do(
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "v1.ratelimit.limit",
-    oAuth2Scopes: null,
+    oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
@@ -153,20 +149,14 @@ async function $do(
   const response = doResult.value;
 
   const responseFields = {
-    ContentType: response.headers.get("content-type")
-      ?? "application/octet-stream",
-    StatusCode: response.status,
-    RawResponse: response,
-    Headers: {},
+    HttpMeta: { Response: response, Request: req },
   };
 
   const [result] = await M.match<
     operations.V1RatelimitLimitResponse,
     | errors.BadRequestError
-    | errors.UnauthorizedError
-    | errors.ForbiddenError
-    | errors.NotFoundError
-    | errors.InternalServerError
+    | errors.BaseError
+    | errors.BaseError
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -181,21 +171,15 @@ async function $do(
     M.jsonErr(400, errors.BadRequestError$inboundSchema, {
       ctype: "application/problem+json",
     }),
-    M.jsonErr(401, errors.UnauthorizedError$inboundSchema, {
+    M.jsonErr([401, 403, 404], errors.BaseError$inboundSchema, {
       ctype: "application/problem+json",
     }),
-    M.jsonErr(403, errors.ForbiddenError$inboundSchema, {
-      ctype: "application/problem+json",
-    }),
-    M.jsonErr(404, errors.NotFoundError$inboundSchema, {
-      ctype: "application/problem+json",
-    }),
-    M.jsonErr(500, errors.InternalServerError$inboundSchema, {
+    M.jsonErr(500, errors.BaseError$inboundSchema, {
       ctype: "application/problem+json",
     }),
     M.fail("4XX"),
     M.fail("5XX"),
-  )(response, { extraFields: responseFields });
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/ratelimitSetOverride.ts

@@ -33,10 +33,8 @@ export function ratelimitSetOverride(
   Result<
     operations.RatelimitSetOverrideResponse,
     | errors.BadRequestError
-    | errors.UnauthorizedError
-    | errors.ForbiddenError
-    | errors.NotFoundError
-    | errors.InternalServerError
+    | errors.BaseError
+    | errors.BaseError
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -62,10 +60,8 @@ async function $do(
     Result<
       operations.RatelimitSetOverrideResponse,
       | errors.BadRequestError
-      | errors.UnauthorizedError
-      | errors.ForbiddenError
-      | errors.NotFoundError
-      | errors.InternalServerError
+      | errors.BaseError
+      | errors.BaseError
       | APIError
       | SDKValidationError
       | UnexpectedClientError
@@ -103,7 +99,7 @@ async function $do(
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "ratelimit.setOverride",
-    oAuth2Scopes: null,
+    oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
@@ -150,20 +146,14 @@ async function $do(
   const response = doResult.value;
 
   const responseFields = {
-    ContentType: response.headers.get("content-type")
-      ?? "application/octet-stream",
-    StatusCode: response.status,
-    RawResponse: response,
-    Headers: {},
+    HttpMeta: { Response: response, Request: req },
   };
 
   const [result] = await M.match<
     operations.RatelimitSetOverrideResponse,
     | errors.BadRequestError
-    | errors.UnauthorizedError
-    | errors.ForbiddenError
-    | errors.NotFoundError
-    | errors.InternalServerError
+    | errors.BaseError
+    | errors.BaseError
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -178,21 +168,15 @@ async function $do(
     M.jsonErr(400, errors.BadRequestError$inboundSchema, {
       ctype: "application/problem+json",
     }),
-    M.jsonErr(401, errors.UnauthorizedError$inboundSchema, {
+    M.jsonErr([401, 403, 404], errors.BaseError$inboundSchema, {
       ctype: "application/problem+json",
     }),
-    M.jsonErr(403, errors.ForbiddenError$inboundSchema, {
-      ctype: "application/problem+json",
-    }),
-    M.jsonErr(404, errors.NotFoundError$inboundSchema, {
-      ctype: "application/problem+json",
-    }),
-    M.jsonErr(500, errors.InternalServerError$inboundSchema, {
+    M.jsonErr(500, errors.BaseError$inboundSchema, {
       ctype: "application/problem+json",
     }),
     M.fail("4XX"),
     M.fail("5XX"),
-  )(response, { extraFields: responseFields });
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/lib/config.ts

@@ -54,7 +54,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0.0",
-  sdkVersion: "2.0.0-alpha.1",
-  genVersion: "2.562.2",
-  userAgent: "speakeasy-sdk/typescript 2.0.0-alpha.1 2.562.2 2.0.0 @unkey/api",
+  sdkVersion: "2.0.0-alpha.2",
+  genVersion: "2.564.5",
+  userAgent: "speakeasy-sdk/typescript 2.0.0-alpha.2 2.564.5 2.0.0 @unkey/api",
 } as const;

package/src/lib/matchers.ts

@@ -159,6 +159,7 @@ export type MatchedError<Matchers> = Matchers extends Matcher<any, infer E>[]
   : never;
 export type MatchFunc<T, E> = (
   response: Response,
+  request: Request,
   options?: { resultKey?: string; extraFields?: Record<string, unknown> },
 ) => Promise<[result: Result<T, E>, raw: unknown]>;
 
@@ -167,6 +168,7 @@ export function match<T, E>(
 ): MatchFunc<T, E | APIError | SDKValidationError> {
   return async function matchFunc(
     response: Response,
+    request: Request,
     options?: { resultKey?: string; extraFields?: Record<string, unknown> },
   ): Promise<
     [result: Result<T, E | APIError | SDKValidationError>, raw: unknown]
@@ -188,15 +190,14 @@ export function match<T, E>(
     }
 
     if (!matcher) {
-      const responseBody = await response.text();
+      await discardResponseBody(response);
       return [{
         ok: false,
-        error: new APIError(
-          "Unexpected API response status or content-type",
+        error: new APIError("Unexpected API response status or content-type", {
           response,
-          responseBody,
-        ),
-      }, responseBody];
+          request,
+        }),
+      }, raw];
     }
 
     const encoding = matcher.enc;
@@ -220,7 +221,7 @@ export function match<T, E>(
         raw = await discardResponseBody(response);
         break;
       case "fail":
-        raw = await response.text();
+        raw = await discardResponseBody(response);
         break;
       default:
         encoding satisfies never;
@@ -230,11 +231,7 @@ export function match<T, E>(
     if (matcher.enc === "fail") {
       return [{
         ok: false,
-        error: new APIError(
-          "API error occurred",
-          response,
-          typeof raw === "string" ? raw : "",
-        ),
+        error: new APIError("API error occurred", { response, request }),
       }, raw];
     }
 

package/src/models/components/httpmetadata.ts

@@ -0,0 +1,87 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type HTTPMetadata = {
+  /**
+   * Raw HTTP response; suitable for custom response parsing
+   */
+  response: Response;
+  /**
+   * Raw HTTP request; suitable for debugging
+   */
+  request: Request;
+};
+
+/** @internal */
+export const HTTPMetadata$inboundSchema: z.ZodType<
+  HTTPMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Response: z.instanceof(Response),
+  Request: z.instanceof(Request),
+}).transform((v) => {
+  return remap$(v, {
+    "Response": "response",
+    "Request": "request",
+  });
+});
+
+/** @internal */
+export type HTTPMetadata$Outbound = {
+  Response: never;
+  Request: never;
+};
+
+/** @internal */
+export const HTTPMetadata$outboundSchema: z.ZodType<
+  HTTPMetadata$Outbound,
+  z.ZodTypeDef,
+  HTTPMetadata
+> = z.object({
+  response: z.instanceof(Response).transform(() => {
+    throw new Error("Response cannot be serialized");
+  }),
+  request: z.instanceof(Request).transform(() => {
+    throw new Error("Response cannot be serialized");
+  }),
+}).transform((v) => {
+  return remap$(v, {
+    response: "Response",
+    request: "Request",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace HTTPMetadata$ {
+  /** @deprecated use `HTTPMetadata$inboundSchema` instead. */
+  export const inboundSchema = HTTPMetadata$inboundSchema;
+  /** @deprecated use `HTTPMetadata$outboundSchema` instead. */
+  export const outboundSchema = HTTPMetadata$outboundSchema;
+  /** @deprecated use `HTTPMetadata$Outbound` instead. */
+  export type Outbound = HTTPMetadata$Outbound;
+}
+
+export function httpMetadataToJSON(httpMetadata: HTTPMetadata): string {
+  return JSON.stringify(HTTPMetadata$outboundSchema.parse(httpMetadata));
+}
+
+export function httpMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<HTTPMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HTTPMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HTTPMetadata' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./httpmetadata.js";
 export * from "./security.js";
 export * from "./v2livenessresponsebody.js";
 export * from "./v2ratelimitdeleteoverriderequestbody.js";

package/src/models/errors/apierror.ts

@@ -3,25 +3,19 @@
  */
 
 export class APIError extends Error {
-  public readonly statusCode: number;
-  public readonly contentType: string;
-
   constructor(
     message: string,
-    public readonly rawResponse: Response,
-    public readonly body: string = "",
+    public readonly httpMeta: {
+      response: Response;
+      request: Request;
+    },
   ) {
-    const statusCode = rawResponse.status;
-    const contentType = rawResponse.headers.get("content-type") || "";
-    const bodyString = body.length > 0 ? `\n${body}` : "";
-
     super(
-      `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
+      `${message}: Status ${httpMeta.response.status} Content-Type ${
+        httpMeta.response.headers.get("content-type") || ""
+      }`,
     );
 
-    this.statusCode = statusCode;
-    this.contentType = contentType;
-
     this.name = "APIError";
   }
 }

package/src/models/errors/{notfounderror.ts → baseerror.ts}

@@ -4,7 +4,7 @@
 
 import * as z from "zod";
 
-export type NotFoundErrorData = {
+export type BaseErrorData = {
   /**
    * A unique id for this request. Please always provide this to support.
    */
@@ -31,7 +31,7 @@ export type NotFoundErrorData = {
   type: string;
 };
 
-export class NotFoundError extends Error {
+export class BaseError extends Error {
   /**
    * A unique id for this request. Please always provide this to support.
    */
@@ -58,9 +58,9 @@ export class NotFoundError extends Error {
   type: string;
 
   /** The original data that was passed to this error instance. */
-  data$: NotFoundErrorData;
+  data$: BaseErrorData;
 
-  constructor(err: NotFoundErrorData) {
+  constructor(err: BaseErrorData) {
     const message = "message" in err && typeof err.message === "string"
       ? err.message
       : `API error occurred: ${JSON.stringify(err)}`;
@@ -74,13 +74,13 @@ export class NotFoundError extends Error {
     this.title = err.title;
     this.type = err.type;
 
-    this.name = "NotFoundError";
+    this.name = "BaseError";
   }
 }
 
 /** @internal */
-export const NotFoundError$inboundSchema: z.ZodType<
-  NotFoundError,
+export const BaseError$inboundSchema: z.ZodType<
+  BaseError,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -92,11 +92,11 @@ export const NotFoundError$inboundSchema: z.ZodType<
   type: z.string(),
 })
   .transform((v) => {
-    return new NotFoundError(v);
+    return new BaseError(v);
   });
 
 /** @internal */
-export type NotFoundError$Outbound = {
+export type BaseError$Outbound = {
   requestId: string;
   detail: string;
   instance?: string | undefined;
@@ -106,11 +106,11 @@ export type NotFoundError$Outbound = {
 };
 
 /** @internal */
-export const NotFoundError$outboundSchema: z.ZodType<
-  NotFoundError$Outbound,
+export const BaseError$outboundSchema: z.ZodType<
+  BaseError$Outbound,
   z.ZodTypeDef,
-  NotFoundError
-> = z.instanceof(NotFoundError)
+  BaseError
+> = z.instanceof(BaseError)
   .transform(v => v.data$)
   .pipe(z.object({
     requestId: z.string(),
@@ -125,11 +125,11 @@ export const NotFoundError$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 NotFoundError$ {
-  /** @deprecated use `NotFoundError$inboundSchema` instead. */
-  export const inboundSchema = NotFoundError$inboundSchema;
-  /** @deprecated use `NotFoundError$outboundSchema` instead. */
-  export const outboundSchema = NotFoundError$outboundSchema;
-  /** @deprecated use `NotFoundError$Outbound` instead. */
-  export type Outbound = NotFoundError$Outbound;
+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;
 }

package/src/models/errors/index.ts

@@ -4,10 +4,6 @@
 
 export * from "./apierror.js";
 export * from "./badrequesterror.js";
-export * from "./forbiddenerror.js";
+export * from "./baseerror.js";
 export * from "./httpclienterrors.js";
-export * from "./internalservererror.js";
-export * from "./notfounderror.js";
-export * from "./preconditionfailederror.js";
 export * from "./sdkvalidationerror.js";
-export * from "./unauthorizederror.js";