@unkey/api 0.34.0 → 2.0.0-alpha.1

package/src/models/errors/internalservererror.ts

@@ -0,0 +1,135 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type InternalServerErrorData = {
+  /**
+   * A unique id for this request. Please always provide this to support.
+   */
+  requestId: string;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail: string;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.
+   */
+  instance?: string | undefined;
+  /**
+   * HTTP status code
+   */
+  status: number;
+  /**
+   * A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
+   */
+  title: string;
+  /**
+   * A URI reference to human-readable documentation for the error.
+   */
+  type: string;
+};
+
+export class InternalServerError extends Error {
+  /**
+   * A unique id for this request. Please always provide this to support.
+   */
+  requestId: string;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail: string;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.
+   */
+  instance?: string | undefined;
+  /**
+   * HTTP status code
+   */
+  status: number;
+  /**
+   * A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
+   */
+  title: string;
+  /**
+   * A URI reference to human-readable documentation for the error.
+   */
+  type: string;
+
+  /** 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;
+
+    this.requestId = err.requestId;
+    this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    this.status = err.status;
+    this.title = err.title;
+    this.type = err.type;
+
+    this.name = "InternalServerError";
+  }
+}
+
+/** @internal */
+export const InternalServerError$inboundSchema: z.ZodType<
+  InternalServerError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  requestId: z.string(),
+  detail: z.string(),
+  instance: z.string().optional(),
+  status: z.number().int(),
+  title: z.string(),
+  type: z.string(),
+})
+  .transform((v) => {
+    return new InternalServerError(v);
+  });
+
+/** @internal */
+export type InternalServerError$Outbound = {
+  requestId: string;
+  detail: string;
+  instance?: string | undefined;
+  status: number;
+  title: string;
+  type: string;
+};
+
+/** @internal */
+export const InternalServerError$outboundSchema: z.ZodType<
+  InternalServerError$Outbound,
+  z.ZodTypeDef,
+  InternalServerError
+> = z.instanceof(InternalServerError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    requestId: z.string(),
+    detail: z.string(),
+    instance: z.string().optional(),
+    status: z.number().int(),
+    title: z.string(),
+    type: z.string(),
+  }));
+
+/**
+ * @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,135 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type NotFoundErrorData = {
+  /**
+   * A unique id for this request. Please always provide this to support.
+   */
+  requestId: string;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail: string;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.
+   */
+  instance?: string | undefined;
+  /**
+   * HTTP status code
+   */
+  status: number;
+  /**
+   * A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
+   */
+  title: string;
+  /**
+   * A URI reference to human-readable documentation for the error.
+   */
+  type: string;
+};
+
+export class NotFoundError extends Error {
+  /**
+   * A unique id for this request. Please always provide this to support.
+   */
+  requestId: string;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail: string;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.
+   */
+  instance?: string | undefined;
+  /**
+   * HTTP status code
+   */
+  status: number;
+  /**
+   * A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
+   */
+  title: string;
+  /**
+   * A URI reference to human-readable documentation for the error.
+   */
+  type: string;
+
+  /** 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;
+
+    this.requestId = err.requestId;
+    this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    this.status = err.status;
+    this.title = err.title;
+    this.type = err.type;
+
+    this.name = "NotFoundError";
+  }
+}
+
+/** @internal */
+export const NotFoundError$inboundSchema: z.ZodType<
+  NotFoundError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  requestId: z.string(),
+  detail: z.string(),
+  instance: z.string().optional(),
+  status: z.number().int(),
+  title: z.string(),
+  type: z.string(),
+})
+  .transform((v) => {
+    return new NotFoundError(v);
+  });
+
+/** @internal */
+export type NotFoundError$Outbound = {
+  requestId: string;
+  detail: string;
+  instance?: string | undefined;
+  status: number;
+  title: string;
+  type: string;
+};
+
+/** @internal */
+export const NotFoundError$outboundSchema: z.ZodType<
+  NotFoundError$Outbound,
+  z.ZodTypeDef,
+  NotFoundError
+> = z.instanceof(NotFoundError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    requestId: z.string(),
+    detail: z.string(),
+    instance: z.string().optional(),
+    status: z.number().int(),
+    title: z.string(),
+    type: z.string(),
+  }));
+
+/**
+ * @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/preconditionfailederror.ts

@@ -0,0 +1,135 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type PreconditionFailedErrorData = {
+  /**
+   * A unique id for this request. Please always provide this to support.
+   */
+  requestId: string;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail: string;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.
+   */
+  instance?: string | undefined;
+  /**
+   * HTTP status code
+   */
+  status: number;
+  /**
+   * A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
+   */
+  title: string;
+  /**
+   * A URI reference to human-readable documentation for the error.
+   */
+  type: string;
+};
+
+export class PreconditionFailedError extends Error {
+  /**
+   * A unique id for this request. Please always provide this to support.
+   */
+  requestId: string;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail: string;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.
+   */
+  instance?: string | undefined;
+  /**
+   * HTTP status code
+   */
+  status: number;
+  /**
+   * A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
+   */
+  title: string;
+  /**
+   * A URI reference to human-readable documentation for the error.
+   */
+  type: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: PreconditionFailedErrorData;
+
+  constructor(err: PreconditionFailedErrorData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.requestId = err.requestId;
+    this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    this.status = err.status;
+    this.title = err.title;
+    this.type = err.type;
+
+    this.name = "PreconditionFailedError";
+  }
+}
+
+/** @internal */
+export const PreconditionFailedError$inboundSchema: z.ZodType<
+  PreconditionFailedError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  requestId: z.string(),
+  detail: z.string(),
+  instance: z.string().optional(),
+  status: z.number().int(),
+  title: z.string(),
+  type: z.string(),
+})
+  .transform((v) => {
+    return new PreconditionFailedError(v);
+  });
+
+/** @internal */
+export type PreconditionFailedError$Outbound = {
+  requestId: string;
+  detail: string;
+  instance?: string | undefined;
+  status: number;
+  title: string;
+  type: string;
+};
+
+/** @internal */
+export const PreconditionFailedError$outboundSchema: z.ZodType<
+  PreconditionFailedError$Outbound,
+  z.ZodTypeDef,
+  PreconditionFailedError
+> = z.instanceof(PreconditionFailedError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    requestId: z.string(),
+    detail: z.string(),
+    instance: z.string().optional(),
+    status: z.number().int(),
+    title: z.string(),
+    type: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PreconditionFailedError$ {
+  /** @deprecated use `PreconditionFailedError$inboundSchema` instead. */
+  export const inboundSchema = PreconditionFailedError$inboundSchema;
+  /** @deprecated use `PreconditionFailedError$outboundSchema` instead. */
+  export const outboundSchema = PreconditionFailedError$outboundSchema;
+  /** @deprecated use `PreconditionFailedError$Outbound` instead. */
+  export type Outbound = PreconditionFailedError$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/unauthorizederror.ts

@@ -0,0 +1,135 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type UnauthorizedErrorData = {
+  /**
+   * A unique id for this request. Please always provide this to support.
+   */
+  requestId: string;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail: string;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.
+   */
+  instance?: string | undefined;
+  /**
+   * HTTP status code
+   */
+  status: number;
+  /**
+   * A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
+   */
+  title: string;
+  /**
+   * A URI reference to human-readable documentation for the error.
+   */
+  type: string;
+};
+
+export class UnauthorizedError extends Error {
+  /**
+   * A unique id for this request. Please always provide this to support.
+   */
+  requestId: string;
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail: string;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.
+   */
+  instance?: string | undefined;
+  /**
+   * HTTP status code
+   */
+  status: number;
+  /**
+   * A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
+   */
+  title: string;
+  /**
+   * A URI reference to human-readable documentation for the error.
+   */
+  type: string;
+
+  /** 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;
+
+    this.requestId = err.requestId;
+    this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    this.status = err.status;
+    this.title = err.title;
+    this.type = err.type;
+
+    this.name = "UnauthorizedError";
+  }
+}
+
+/** @internal */
+export const UnauthorizedError$inboundSchema: z.ZodType<
+  UnauthorizedError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  requestId: z.string(),
+  detail: z.string(),
+  instance: z.string().optional(),
+  status: z.number().int(),
+  title: z.string(),
+  type: z.string(),
+})
+  .transform((v) => {
+    return new UnauthorizedError(v);
+  });
+
+/** @internal */
+export type UnauthorizedError$Outbound = {
+  requestId: string;
+  detail: string;
+  instance?: string | undefined;
+  status: number;
+  title: string;
+  type: string;
+};
+
+/** @internal */
+export const UnauthorizedError$outboundSchema: z.ZodType<
+  UnauthorizedError$Outbound,
+  z.ZodTypeDef,
+  UnauthorizedError
+> = z.instanceof(UnauthorizedError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    requestId: z.string(),
+    detail: z.string(),
+    instance: z.string().optional(),
+    status: z.number().int(),
+    title: z.string(),
+    type: z.string(),
+  }));
+
+/**
+ * @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;
+}

package/src/models/operations/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./liveness.js";
+export * from "./ratelimitdeleteoverride.js";
+export * from "./ratelimitgetoverride.js";
+export * from "./ratelimitsetoverride.js";
+export * from "./v1ratelimitlimit.js";