@unkey/api 0.34.0 → 2.0.0-alpha.2

package/src/models/components/v2ratelimitlimitresponsebody.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V2RatelimitLimitResponseBody = {
+  /**
+   * The maximum number of requests allowed.
+   */
+  limit: number;
+  /**
+   * The number of requests remaining in the current window.
+   */
+  remaining: number;
+  /**
+   * The time in milliseconds when the rate limit will reset.
+   */
+  reset: number;
+  /**
+   * Whether the request passed the ratelimit. If false, the request must be blocked.
+   */
+  success: boolean;
+  /**
+   * The override that was used. May be empty
+   */
+  overrideId?: string | undefined;
+};
+
+/** @internal */
+export const V2RatelimitLimitResponseBody$inboundSchema: z.ZodType<
+  V2RatelimitLimitResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  limit: z.number().int(),
+  remaining: z.number().int(),
+  reset: z.number().int(),
+  success: z.boolean(),
+  overrideId: z.string().optional(),
+});
+
+/** @internal */
+export type V2RatelimitLimitResponseBody$Outbound = {
+  limit: number;
+  remaining: number;
+  reset: number;
+  success: boolean;
+  overrideId?: string | undefined;
+};
+
+/** @internal */
+export const V2RatelimitLimitResponseBody$outboundSchema: z.ZodType<
+  V2RatelimitLimitResponseBody$Outbound,
+  z.ZodTypeDef,
+  V2RatelimitLimitResponseBody
+> = z.object({
+  limit: z.number().int(),
+  remaining: z.number().int(),
+  reset: z.number().int(),
+  success: z.boolean(),
+  overrideId: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2RatelimitLimitResponseBody$ {
+  /** @deprecated use `V2RatelimitLimitResponseBody$inboundSchema` instead. */
+  export const inboundSchema = V2RatelimitLimitResponseBody$inboundSchema;
+  /** @deprecated use `V2RatelimitLimitResponseBody$outboundSchema` instead. */
+  export const outboundSchema = V2RatelimitLimitResponseBody$outboundSchema;
+  /** @deprecated use `V2RatelimitLimitResponseBody$Outbound` instead. */
+  export type Outbound = V2RatelimitLimitResponseBody$Outbound;
+}
+
+export function v2RatelimitLimitResponseBodyToJSON(
+  v2RatelimitLimitResponseBody: V2RatelimitLimitResponseBody,
+): string {
+  return JSON.stringify(
+    V2RatelimitLimitResponseBody$outboundSchema.parse(
+      v2RatelimitLimitResponseBody,
+    ),
+  );
+}
+
+export function v2RatelimitLimitResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2RatelimitLimitResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2RatelimitLimitResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2RatelimitLimitResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2ratelimitsetoverriderequestbody.ts

@@ -0,0 +1,103 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Sets a new or overwrites an existing override.
+ */
+export type V2RatelimitSetOverrideRequestBody = {
+  /**
+   * The id of the namespace. Either namespaceId or namespaceName must be provided
+   */
+  namespaceId?: string | undefined;
+  /**
+   * The name of the namespace. Either namespaceId or namespaceName must be provided
+   */
+  namespaceName?: string | undefined;
+  /**
+   * The duration in milliseconds for the rate limit window.
+   */
+  duration: number;
+  /**
+   * Identifier of your user, this can be their userId, an email, an ip or anything else. Wildcards ( * ) can be used to match multiple identifiers, More info can be found at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules
+   */
+  identifier: string;
+  /**
+   * The maximum number of requests allowed.
+   */
+  limit: number;
+};
+
+/** @internal */
+export const V2RatelimitSetOverrideRequestBody$inboundSchema: z.ZodType<
+  V2RatelimitSetOverrideRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  namespaceId: z.string().optional(),
+  namespaceName: z.string().optional(),
+  duration: z.number().int(),
+  identifier: z.string(),
+  limit: z.number().int(),
+});
+
+/** @internal */
+export type V2RatelimitSetOverrideRequestBody$Outbound = {
+  namespaceId?: string | undefined;
+  namespaceName?: string | undefined;
+  duration: number;
+  identifier: string;
+  limit: number;
+};
+
+/** @internal */
+export const V2RatelimitSetOverrideRequestBody$outboundSchema: z.ZodType<
+  V2RatelimitSetOverrideRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2RatelimitSetOverrideRequestBody
+> = z.object({
+  namespaceId: z.string().optional(),
+  namespaceName: z.string().optional(),
+  duration: z.number().int(),
+  identifier: z.string(),
+  limit: z.number().int(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2RatelimitSetOverrideRequestBody$ {
+  /** @deprecated use `V2RatelimitSetOverrideRequestBody$inboundSchema` instead. */
+  export const inboundSchema = V2RatelimitSetOverrideRequestBody$inboundSchema;
+  /** @deprecated use `V2RatelimitSetOverrideRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    V2RatelimitSetOverrideRequestBody$outboundSchema;
+  /** @deprecated use `V2RatelimitSetOverrideRequestBody$Outbound` instead. */
+  export type Outbound = V2RatelimitSetOverrideRequestBody$Outbound;
+}
+
+export function v2RatelimitSetOverrideRequestBodyToJSON(
+  v2RatelimitSetOverrideRequestBody: V2RatelimitSetOverrideRequestBody,
+): string {
+  return JSON.stringify(
+    V2RatelimitSetOverrideRequestBody$outboundSchema.parse(
+      v2RatelimitSetOverrideRequestBody,
+    ),
+  );
+}
+
+export function v2RatelimitSetOverrideRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2RatelimitSetOverrideRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2RatelimitSetOverrideRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2RatelimitSetOverrideRequestBody' from JSON`,
+  );
+}

package/src/models/components/v2ratelimitsetoverrideresponsebody.ts

@@ -0,0 +1,73 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V2RatelimitSetOverrideResponseBody = {
+  /**
+   * The id of the override. This is used internally.
+   */
+  overrideId: string;
+};
+
+/** @internal */
+export const V2RatelimitSetOverrideResponseBody$inboundSchema: z.ZodType<
+  V2RatelimitSetOverrideResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  overrideId: z.string(),
+});
+
+/** @internal */
+export type V2RatelimitSetOverrideResponseBody$Outbound = {
+  overrideId: string;
+};
+
+/** @internal */
+export const V2RatelimitSetOverrideResponseBody$outboundSchema: z.ZodType<
+  V2RatelimitSetOverrideResponseBody$Outbound,
+  z.ZodTypeDef,
+  V2RatelimitSetOverrideResponseBody
+> = z.object({
+  overrideId: 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 V2RatelimitSetOverrideResponseBody$ {
+  /** @deprecated use `V2RatelimitSetOverrideResponseBody$inboundSchema` instead. */
+  export const inboundSchema = V2RatelimitSetOverrideResponseBody$inboundSchema;
+  /** @deprecated use `V2RatelimitSetOverrideResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    V2RatelimitSetOverrideResponseBody$outboundSchema;
+  /** @deprecated use `V2RatelimitSetOverrideResponseBody$Outbound` instead. */
+  export type Outbound = V2RatelimitSetOverrideResponseBody$Outbound;
+}
+
+export function v2RatelimitSetOverrideResponseBodyToJSON(
+  v2RatelimitSetOverrideResponseBody: V2RatelimitSetOverrideResponseBody,
+): string {
+  return JSON.stringify(
+    V2RatelimitSetOverrideResponseBody$outboundSchema.parse(
+      v2RatelimitSetOverrideResponseBody,
+    ),
+  );
+}
+
+export function v2RatelimitSetOverrideResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2RatelimitSetOverrideResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V2RatelimitSetOverrideResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2RatelimitSetOverrideResponseBody' from JSON`,
+  );
+}

package/src/models/components/validationerror.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ValidationError = {
+  /**
+   * Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
+   */
+  location: string;
+  /**
+   * Error message text
+   */
+  message: string;
+  /**
+   * A human-readable message describing how to fix the error.
+   */
+  fix?: string | undefined;
+};
+
+/** @internal */
+export const ValidationError$inboundSchema: z.ZodType<
+  ValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  location: z.string(),
+  message: z.string(),
+  fix: z.string().optional(),
+});
+
+/** @internal */
+export type ValidationError$Outbound = {
+  location: string;
+  message: string;
+  fix?: string | undefined;
+};
+
+/** @internal */
+export const ValidationError$outboundSchema: z.ZodType<
+  ValidationError$Outbound,
+  z.ZodTypeDef,
+  ValidationError
+> = z.object({
+  location: z.string(),
+  message: z.string(),
+  fix: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ValidationError$ {
+  /** @deprecated use `ValidationError$inboundSchema` instead. */
+  export const inboundSchema = ValidationError$inboundSchema;
+  /** @deprecated use `ValidationError$outboundSchema` instead. */
+  export const outboundSchema = ValidationError$outboundSchema;
+  /** @deprecated use `ValidationError$Outbound` instead. */
+  export type Outbound = ValidationError$Outbound;
+}
+
+export function validationErrorToJSON(
+  validationError: ValidationError,
+): string {
+  return JSON.stringify(ValidationError$outboundSchema.parse(validationError));
+}
+
+export function validationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ValidationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ValidationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ValidationError' from JSON`,
+  );
+}

package/src/models/errors/apierror.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export class APIError extends Error {
+  constructor(
+    message: string,
+    public readonly httpMeta: {
+      response: Response;
+      request: Request;
+    },
+  ) {
+    super(
+      `${message}: Status ${httpMeta.response.status} Content-Type ${
+        httpMeta.response.headers.get("content-type") || ""
+      }`,
+    );
+
+    this.name = "APIError";
+  }
+}

package/src/models/errors/badrequesterror.ts

@@ -0,0 +1,148 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import * as components from "../components/index.js";
+
+export type BadRequestErrorData = {
+  /**
+   * 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;
+  /**
+   * Optional list of individual error details
+   */
+  errors: Array<components.ValidationError>;
+};
+
+export class BadRequestError 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;
+  /**
+   * Optional list of individual error details
+   */
+  errors: Array<components.ValidationError>;
+
+  /** The original data that was passed to this error instance. */
+  data$: BadRequestErrorData;
+
+  constructor(err: BadRequestErrorData) {
+    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.errors = err.errors;
+
+    this.name = "BadRequestError";
+  }
+}
+
+/** @internal */
+export const BadRequestError$inboundSchema: z.ZodType<
+  BadRequestError,
+  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(),
+  errors: z.array(components.ValidationError$inboundSchema),
+})
+  .transform((v) => {
+    return new BadRequestError(v);
+  });
+
+/** @internal */
+export type BadRequestError$Outbound = {
+  requestId: string;
+  detail: string;
+  instance?: string | undefined;
+  status: number;
+  title: string;
+  type: string;
+  errors: Array<components.ValidationError$Outbound>;
+};
+
+/** @internal */
+export const BadRequestError$outboundSchema: z.ZodType<
+  BadRequestError$Outbound,
+  z.ZodTypeDef,
+  BadRequestError
+> = z.instanceof(BadRequestError)
+  .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(),
+    errors: z.array(components.ValidationError$outboundSchema),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BadRequestError$ {
+  /** @deprecated use `BadRequestError$inboundSchema` instead. */
+  export const inboundSchema = BadRequestError$inboundSchema;
+  /** @deprecated use `BadRequestError$outboundSchema` instead. */
+  export const outboundSchema = BadRequestError$outboundSchema;
+  /** @deprecated use `BadRequestError$Outbound` instead. */
+  export type Outbound = BadRequestError$Outbound;
+}

package/src/models/errors/baseerror.ts

@@ -0,0 +1,135 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type BaseErrorData = {
+  /**
+   * 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 BaseError 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$: BaseErrorData;
+
+  constructor(err: BaseErrorData) {
+    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 = "BaseError";
+  }
+}
+
+/** @internal */
+export const BaseError$inboundSchema: z.ZodType<
+  BaseError,
+  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 BaseError(v);
+  });
+
+/** @internal */
+export type BaseError$Outbound = {
+  requestId: string;
+  detail: string;
+  instance?: string | undefined;
+  status: number;
+  title: string;
+  type: string;
+};
+
+/** @internal */
+export const BaseError$outboundSchema: z.ZodType<
+  BaseError$Outbound,
+  z.ZodTypeDef,
+  BaseError
+> = z.instanceof(BaseError)
+  .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 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;
+}