@gr4vy/sdk 1.0.0-beta.21 → 1.0.0-beta.22

package/src/models/errors/error404.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type Error404Data = {
   /**
@@ -28,7 +29,7 @@ export type Error404Data = {
   details?: Array<components.ErrorDetail> | undefined;
 };
 
-export class Error404 extends Error {
+export class Error404 extends Gr4vyError {
   /**
    * Always `error`.
    */
@@ -49,13 +50,15 @@ export class Error404 extends Error {
   /** The original data that was passed to this error instance. */
   data$: Error404Data;
 
-  constructor(err: Error404Data) {
+  constructor(
+    err: Error404Data,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.type != null) this.type = err.type;
     if (err.code != null) this.code = err.code;
     if (err.status != null) this.status = err.status;
@@ -76,9 +79,16 @@ export const Error404$inboundSchema: z.ZodType<
   status: z.number().int().default(404),
   message: z.string().default("The resource could not be found"),
   details: z.array(components.ErrorDetail$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Error404(v);
+    return new Error404(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/error405.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type Error405Data = {
   /**
@@ -28,7 +29,7 @@ export type Error405Data = {
   details?: Array<components.ErrorDetail> | undefined;
 };
 
-export class Error405 extends Error {
+export class Error405 extends Gr4vyError {
   /**
    * Always `error`.
    */
@@ -49,13 +50,15 @@ export class Error405 extends Error {
   /** The original data that was passed to this error instance. */
   data$: Error405Data;
 
-  constructor(err: Error405Data) {
+  constructor(
+    err: Error405Data,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.type != null) this.type = err.type;
     if (err.code != null) this.code = err.code;
     if (err.status != null) this.status = err.status;
@@ -76,9 +79,16 @@ export const Error405$inboundSchema: z.ZodType<
   status: z.number().int().default(405),
   message: z.string().default("Method Not Allowed"),
   details: z.array(components.ErrorDetail$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Error405(v);
+    return new Error405(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/error409.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type Error409Data = {
   /**
@@ -28,7 +29,7 @@ export type Error409Data = {
   details?: Array<components.ErrorDetail> | undefined;
 };
 
-export class Error409 extends Error {
+export class Error409 extends Gr4vyError {
   /**
    * Always `error`.
    */
@@ -49,13 +50,15 @@ export class Error409 extends Error {
   /** The original data that was passed to this error instance. */
   data$: Error409Data;
 
-  constructor(err: Error409Data) {
+  constructor(
+    err: Error409Data,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.type != null) this.type = err.type;
     if (err.code != null) this.code = err.code;
     if (err.status != null) this.status = err.status;
@@ -76,9 +79,16 @@ export const Error409$inboundSchema: z.ZodType<
   status: z.number().int().default(409),
   message: z.string().default("Generic error"),
   details: z.array(components.ErrorDetail$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Error409(v);
+    return new Error409(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/error425.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type Error425Data = {
   /**
@@ -28,7 +29,7 @@ export type Error425Data = {
   details?: Array<components.ErrorDetail> | undefined;
 };
 
-export class Error425 extends Error {
+export class Error425 extends Gr4vyError {
   /**
    * Always `error`.
    */
@@ -49,13 +50,15 @@ export class Error425 extends Error {
   /** The original data that was passed to this error instance. */
   data$: Error425Data;
 
-  constructor(err: Error425Data) {
+  constructor(
+    err: Error425Data,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.type != null) this.type = err.type;
     if (err.code != null) this.code = err.code;
     if (err.status != null) this.status = err.status;
@@ -76,9 +79,16 @@ export const Error425$inboundSchema: z.ZodType<
   status: z.number().int().default(425),
   message: z.string().default("Generic error"),
   details: z.array(components.ErrorDetail$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Error425(v);
+    return new Error425(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/error429.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type Error429Data = {
   /**
@@ -28,7 +29,7 @@ export type Error429Data = {
   details?: Array<components.ErrorDetail> | undefined;
 };
 
-export class Error429 extends Error {
+export class Error429 extends Gr4vyError {
   /**
    * Always `error`.
    */
@@ -49,13 +50,15 @@ export class Error429 extends Error {
   /** The original data that was passed to this error instance. */
   data$: Error429Data;
 
-  constructor(err: Error429Data) {
+  constructor(
+    err: Error429Data,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.type != null) this.type = err.type;
     if (err.code != null) this.code = err.code;
     if (err.status != null) this.status = err.status;
@@ -76,9 +79,16 @@ export const Error429$inboundSchema: z.ZodType<
   status: z.number().int().default(429),
   message: z.string().default("Generic error"),
   details: z.array(components.ErrorDetail$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Error429(v);
+    return new Error429(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/error500.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type Error500Data = {
   /**
@@ -28,7 +29,7 @@ export type Error500Data = {
   details?: Array<components.ErrorDetail> | undefined;
 };
 
-export class Error500 extends Error {
+export class Error500 extends Gr4vyError {
   /**
    * Always `error`.
    */
@@ -49,13 +50,15 @@ export class Error500 extends Error {
   /** The original data that was passed to this error instance. */
   data$: Error500Data;
 
-  constructor(err: Error500Data) {
+  constructor(
+    err: Error500Data,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.type != null) this.type = err.type;
     if (err.code != null) this.code = err.code;
     if (err.status != null) this.status = err.status;
@@ -76,9 +79,16 @@ export const Error500$inboundSchema: z.ZodType<
   status: z.number().int().default(500),
   message: z.string().default("Request could not be processed"),
   details: z.array(components.ErrorDetail$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Error500(v);
+    return new Error500(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/error502.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type Error502Data = {
   /**
@@ -28,7 +29,7 @@ export type Error502Data = {
   details?: Array<components.ErrorDetail> | undefined;
 };
 
-export class Error502 extends Error {
+export class Error502 extends Gr4vyError {
   /**
    * Always `error`.
    */
@@ -49,13 +50,15 @@ export class Error502 extends Error {
   /** The original data that was passed to this error instance. */
   data$: Error502Data;
 
-  constructor(err: Error502Data) {
+  constructor(
+    err: Error502Data,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.type != null) this.type = err.type;
     if (err.code != null) this.code = err.code;
     if (err.status != null) this.status = err.status;
@@ -76,9 +79,16 @@ export const Error502$inboundSchema: z.ZodType<
   status: z.number().int().default(502),
   message: z.string().default("Request could not be processed"),
   details: z.array(components.ErrorDetail$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Error502(v);
+    return new Error502(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/error504.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type Error504Data = {
   /**
@@ -25,7 +26,7 @@ export type Error504Data = {
   details?: Array<components.ErrorDetail> | undefined;
 };
 
-export class Error504 extends Error {
+export class Error504 extends Gr4vyError {
   /**
    * Always `error`.
    */
@@ -43,13 +44,15 @@ export class Error504 extends Error {
   /** The original data that was passed to this error instance. */
   data$: Error504Data;
 
-  constructor(err: Error504Data) {
+  constructor(
+    err: Error504Data,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.type != null) this.type = err.type;
     if (err.code != null) this.code = err.code;
     if (err.status != null) this.status = err.status;
@@ -70,9 +73,16 @@ export const Error504$inboundSchema: z.ZodType<
   status: z.number().int().default(504),
   message: z.string().default("Request could not be processed"),
   details: z.array(components.ErrorDetail$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Error504(v);
+    return new Error504(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/gr4vyerror.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 Gr4vyError 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 = "Gr4vyError";
+  }
+}

package/src/models/errors/httpvalidationerror.ts

@@ -4,24 +4,27 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type HTTPValidationErrorData = {
   detail?: Array<components.ValidationError> | undefined;
 };
 
-export class HTTPValidationError extends Error {
+export class HTTPValidationError extends Gr4vyError {
   detail?: Array<components.ValidationError> | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: HTTPValidationErrorData;
 
-  constructor(err: HTTPValidationErrorData) {
+  constructor(
+    err: HTTPValidationErrorData,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.detail != null) this.detail = err.detail;
 
     this.name = "HTTPValidationError";
@@ -35,9 +38,16 @@ export const HTTPValidationError$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   detail: z.array(components.ValidationError$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new HTTPValidationError(v);
+    return new HTTPValidationError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/index.ts

@@ -15,5 +15,6 @@ export * from "./error502.js";
 export * from "./error504.js";
 export * from "./httpclienterrors.js";
 export * from "./httpvalidationerror.js";
+export * from "./responsevalidationerror.js";
 export * from "./sdkerror.js";
 export * from "./sdkvalidationerror.js";

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { Gr4vyError } from "./gr4vyerror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends Gr4vyError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkerror.ts

@@ -2,41 +2,33 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export class SDKError extends Error {
-  /**
-   * HTTP status code
-   */
-  public readonly statusCode: number;
-  /**
-   * HTTP content type
-   */
-  public readonly contentType: string;
-  /**
-   * HTTP body
-   */
-  public readonly body: string;
-  /**
-   * Raw response
-   */
-  public readonly rawResponse: Response;
+import { Gr4vyError } from "./gr4vyerror.js";
 
+/** The fallback error class if no more specific error class is matched */
+export class SDKError extends Gr4vyError {
   constructor(
     message: string,
-    rawResponse: Response,
-    body: string = "",
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
   ) {
-    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}`,
-    );
-
-    this.body = body;
-    this.rawResponse = rawResponse;
-    this.statusCode = statusCode;
-    this.contentType = contentType;
-
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : " ";
+    message += `Body ${body}`;
+    message = message.trim();
+    super(message, httpMeta);
     this.name = "SDKError";
   }
 }

package/src/models/errors/sdkvalidationerror.ts

@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";