@hookdeck/outpost-sdk 0.0.2

package/src/models/errors/index.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./apierror.js";
+export * from "./badrequesterror.js";
+export * from "./httpclienterrors.js";
+export * from "./internalservererror.js";
+export * from "./notfounderror.js";
+export * from "./ratelimitederror.js";
+export * from "./sdkvalidationerror.js";
+export * from "./timeouterror.js";
+export * from "./unauthorizederror.js";

package/src/models/errors/internalservererror.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { collectExtraKeys as collectExtraKeys$ } from "../../lib/schemas.js";
+
+/**
+ * A collection of status codes that generally mean the server failed in an unexpected way
+ */
+export type InternalServerErrorData = {
+  message?: string | undefined;
+
+  additionalProperties: { [k: string]: any };
+};
+
+/**
+ * A collection of status codes that generally mean the server failed in an unexpected way
+ */
+export class InternalServerError extends Error {
+  additionalProperties: { [k: string]: any } = {};
+
+  /** The original data that was passed to this error instance. */
+  data$: InternalServerErrorData;
+
+  constructor(err: InternalServerErrorData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    if (err.additionalProperties != null) {
+      this.additionalProperties = err.additionalProperties;
+    }
+
+    this.name = "InternalServerError";
+  }
+}
+
+/** @internal */
+export const InternalServerError$inboundSchema: z.ZodType<
+  InternalServerError,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    message: z.string().optional(),
+  })
+    .catchall(z.any()),
+  "additionalProperties",
+  true,
+)
+  .transform((v) => {
+    return new InternalServerError(v);
+  });
+
+/** @internal */
+export type InternalServerError$Outbound = {
+  message?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const InternalServerError$outboundSchema: z.ZodType<
+  InternalServerError$Outbound,
+  z.ZodTypeDef,
+  InternalServerError
+> = z.instanceof(InternalServerError)
+  .transform(v => v.data$)
+  .pipe(
+    z.object({
+      message: z.string().optional(),
+      additionalProperties: z.record(z.any()),
+    }).transform((v) => {
+      return {
+        ...v.additionalProperties,
+        ...remap$(v, {
+          additionalProperties: null,
+        }),
+      };
+    }),
+  );
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InternalServerError$ {
+  /** @deprecated use `InternalServerError$inboundSchema` instead. */
+  export const inboundSchema = InternalServerError$inboundSchema;
+  /** @deprecated use `InternalServerError$outboundSchema` instead. */
+  export const outboundSchema = InternalServerError$outboundSchema;
+  /** @deprecated use `InternalServerError$Outbound` instead. */
+  export type Outbound = InternalServerError$Outbound;
+}

package/src/models/errors/notfounderror.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { collectExtraKeys as collectExtraKeys$ } from "../../lib/schemas.js";
+
+/**
+ * Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing
+ */
+export type NotFoundErrorData = {
+  message?: string | undefined;
+
+  additionalProperties: { [k: string]: any };
+};
+
+/**
+ * Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing
+ */
+export class NotFoundError extends Error {
+  additionalProperties: { [k: string]: any } = {};
+
+  /** The original data that was passed to this error instance. */
+  data$: NotFoundErrorData;
+
+  constructor(err: NotFoundErrorData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    if (err.additionalProperties != null) {
+      this.additionalProperties = err.additionalProperties;
+    }
+
+    this.name = "NotFoundError";
+  }
+}
+
+/** @internal */
+export const NotFoundError$inboundSchema: z.ZodType<
+  NotFoundError,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    message: z.string().optional(),
+  })
+    .catchall(z.any()),
+  "additionalProperties",
+  true,
+)
+  .transform((v) => {
+    return new NotFoundError(v);
+  });
+
+/** @internal */
+export type NotFoundError$Outbound = {
+  message?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const NotFoundError$outboundSchema: z.ZodType<
+  NotFoundError$Outbound,
+  z.ZodTypeDef,
+  NotFoundError
+> = z.instanceof(NotFoundError)
+  .transform(v => v.data$)
+  .pipe(
+    z.object({
+      message: z.string().optional(),
+      additionalProperties: z.record(z.any()),
+    }).transform((v) => {
+      return {
+        ...v.additionalProperties,
+        ...remap$(v, {
+          additionalProperties: null,
+        }),
+      };
+    }),
+  );
+
+/**
+ * @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;
+}

package/src/models/errors/ratelimitederror.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { collectExtraKeys as collectExtraKeys$ } from "../../lib/schemas.js";
+
+/**
+ * Status codes relating to the client being rate limited by the server
+ */
+export type RateLimitedErrorData = {
+  message?: string | undefined;
+
+  additionalProperties: { [k: string]: any };
+};
+
+/**
+ * Status codes relating to the client being rate limited by the server
+ */
+export class RateLimitedError extends Error {
+  additionalProperties: { [k: string]: any } = {};
+
+  /** The original data that was passed to this error instance. */
+  data$: RateLimitedErrorData;
+
+  constructor(err: RateLimitedErrorData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    if (err.additionalProperties != null) {
+      this.additionalProperties = err.additionalProperties;
+    }
+
+    this.name = "RateLimitedError";
+  }
+}
+
+/** @internal */
+export const RateLimitedError$inboundSchema: z.ZodType<
+  RateLimitedError,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    message: z.string().optional(),
+  })
+    .catchall(z.any()),
+  "additionalProperties",
+  true,
+)
+  .transform((v) => {
+    return new RateLimitedError(v);
+  });
+
+/** @internal */
+export type RateLimitedError$Outbound = {
+  message?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const RateLimitedError$outboundSchema: z.ZodType<
+  RateLimitedError$Outbound,
+  z.ZodTypeDef,
+  RateLimitedError
+> = z.instanceof(RateLimitedError)
+  .transform(v => v.data$)
+  .pipe(
+    z.object({
+      message: z.string().optional(),
+      additionalProperties: z.record(z.any()),
+    }).transform((v) => {
+      return {
+        ...v.additionalProperties,
+        ...remap$(v, {
+          additionalProperties: null,
+        }),
+      };
+    }),
+  );
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RateLimitedError$ {
+  /** @deprecated use `RateLimitedError$inboundSchema` instead. */
+  export const inboundSchema = RateLimitedError$inboundSchema;
+  /** @deprecated use `RateLimitedError$outboundSchema` instead. */
+  export const outboundSchema = RateLimitedError$outboundSchema;
+  /** @deprecated use `RateLimitedError$Outbound` instead. */
+  export type Outbound = RateLimitedError$Outbound;
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export class SDKValidationError extends Error {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(message: string, cause: unknown, rawValue: unknown) {
+    super(`${message}: ${cause}`);
+    this.name = "SDKValidationError";
+    this.cause = cause;
+    this.rawValue = rawValue;
+    this.rawMessage = message;
+  }
+
+  /**
+   * 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();
+    }
+  }
+}
+
+export function formatZodError(err: z.ZodError, level = 0): string {
+  let pre = "  ".repeat(level);
+  pre = level > 0 ? `│${pre}` : pre;
+  pre += " ".repeat(level);
+
+  let message = "";
+  const append = (str: string) => (message += `\n${pre}${str}`);
+
+  const len = err.issues.length;
+  const headline = len === 1 ? `${len} issue found` : `${len} issues found`;
+
+  if (len) {
+    append(`┌ ${headline}:`);
+  }
+
+  for (const issue of err.issues) {
+    let path = issue.path.join(".");
+    path = path ? `<root>.${path}` : "<root>";
+    append(`│ • [${path}]: ${issue.message} (${issue.code})`);
+    switch (issue.code) {
+      case "invalid_literal":
+      case "invalid_type": {
+        append(`│     Want: ${issue.expected}`);
+        append(`│      Got: ${issue.received}`);
+        break;
+      }
+      case "unrecognized_keys": {
+        append(`│     Keys: ${issue.keys.join(", ")}`);
+        break;
+      }
+      case "invalid_enum_value": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        append(`│         Got: ${issue.received}`);
+        break;
+      }
+      case "invalid_union_discriminator": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        break;
+      }
+      case "invalid_union": {
+        const len = issue.unionErrors.length;
+        append(
+          `│   ✖︎ Attemped to deserialize into one of ${len} union members:`,
+        );
+        issue.unionErrors.forEach((err, i) => {
+          append(`│   ✖︎ Member ${i + 1} of ${len}`);
+          append(`${formatZodError(err, level + 1)}`);
+        });
+      }
+    }
+  }
+
+  if (err.issues.length) {
+    append(`└─*`);
+  }
+
+  return message.slice(1);
+}

package/src/models/errors/timeouterror.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { collectExtraKeys as collectExtraKeys$ } from "../../lib/schemas.js";
+
+/**
+ * Timeouts occurred with the request
+ */
+export type TimeoutErrorData = {
+  message?: string | undefined;
+
+  additionalProperties: { [k: string]: any };
+};
+
+/**
+ * Timeouts occurred with the request
+ */
+export class TimeoutError extends Error {
+  additionalProperties: { [k: string]: any } = {};
+
+  /** The original data that was passed to this error instance. */
+  data$: TimeoutErrorData;
+
+  constructor(err: TimeoutErrorData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    if (err.additionalProperties != null) {
+      this.additionalProperties = err.additionalProperties;
+    }
+
+    this.name = "TimeoutError";
+  }
+}
+
+/** @internal */
+export const TimeoutError$inboundSchema: z.ZodType<
+  TimeoutError,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    message: z.string().optional(),
+  })
+    .catchall(z.any()),
+  "additionalProperties",
+  true,
+)
+  .transform((v) => {
+    return new TimeoutError(v);
+  });
+
+/** @internal */
+export type TimeoutError$Outbound = {
+  message?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const TimeoutError$outboundSchema: z.ZodType<
+  TimeoutError$Outbound,
+  z.ZodTypeDef,
+  TimeoutError
+> = z.instanceof(TimeoutError)
+  .transform(v => v.data$)
+  .pipe(
+    z.object({
+      message: z.string().optional(),
+      additionalProperties: z.record(z.any()),
+    }).transform((v) => {
+      return {
+        ...v.additionalProperties,
+        ...remap$(v, {
+          additionalProperties: null,
+        }),
+      };
+    }),
+  );
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TimeoutError$ {
+  /** @deprecated use `TimeoutError$inboundSchema` instead. */
+  export const inboundSchema = TimeoutError$inboundSchema;
+  /** @deprecated use `TimeoutError$outboundSchema` instead. */
+  export const outboundSchema = TimeoutError$outboundSchema;
+  /** @deprecated use `TimeoutError$Outbound` instead. */
+  export type Outbound = TimeoutError$Outbound;
+}

package/src/models/errors/unauthorizederror.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { collectExtraKeys as collectExtraKeys$ } from "../../lib/schemas.js";
+
+/**
+ * A collection of codes that generally means the client was not authenticated correctly for the request they want to make
+ */
+export type UnauthorizedErrorData = {
+  message?: string | undefined;
+
+  additionalProperties: { [k: string]: any };
+};
+
+/**
+ * A collection of codes that generally means the client was not authenticated correctly for the request they want to make
+ */
+export class UnauthorizedError extends Error {
+  additionalProperties: { [k: string]: any } = {};
+
+  /** The original data that was passed to this error instance. */
+  data$: UnauthorizedErrorData;
+
+  constructor(err: UnauthorizedErrorData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    if (err.additionalProperties != null) {
+      this.additionalProperties = err.additionalProperties;
+    }
+
+    this.name = "UnauthorizedError";
+  }
+}
+
+/** @internal */
+export const UnauthorizedError$inboundSchema: z.ZodType<
+  UnauthorizedError,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    message: z.string().optional(),
+  })
+    .catchall(z.any()),
+  "additionalProperties",
+  true,
+)
+  .transform((v) => {
+    return new UnauthorizedError(v);
+  });
+
+/** @internal */
+export type UnauthorizedError$Outbound = {
+  message?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const UnauthorizedError$outboundSchema: z.ZodType<
+  UnauthorizedError$Outbound,
+  z.ZodTypeDef,
+  UnauthorizedError
+> = z.instanceof(UnauthorizedError)
+  .transform(v => v.data$)
+  .pipe(
+    z.object({
+      message: z.string().optional(),
+      additionalProperties: z.record(z.any()),
+    }).transform((v) => {
+      return {
+        ...v.additionalProperties,
+        ...remap$(v, {
+          additionalProperties: null,
+        }),
+      };
+    }),
+  );
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UnauthorizedError$ {
+  /** @deprecated use `UnauthorizedError$inboundSchema` instead. */
+  export const inboundSchema = UnauthorizedError$inboundSchema;
+  /** @deprecated use `UnauthorizedError$outboundSchema` instead. */
+  export const outboundSchema = UnauthorizedError$outboundSchema;
+  /** @deprecated use `UnauthorizedError$Outbound` instead. */
+  export type Outbound = UnauthorizedError$Outbound;
+}