@unkey/api 2.0.0-alpha.5 → 2.0.0-alpha.7

package/src/models/components/v2ratelimitgetoverrideresponsebody.ts

@@ -6,28 +6,22 @@ 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";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
+import {
+  RatelimitOverride,
+  RatelimitOverride$inboundSchema,
+  RatelimitOverride$Outbound,
+  RatelimitOverride$outboundSchema,
+} from "./ratelimitoverride.js";
 
 export type V2RatelimitGetOverrideResponseBody = {
-  /**
-   * The id of the namespace.
-   */
-  namespaceId: string;
-  /**
-   * The id of the override.
-   */
-  overrideId: string;
-  /**
-   * 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;
+  meta: Meta;
+  data: RatelimitOverride;
 };
 
 /** @internal */
@@ -36,20 +30,14 @@ export const V2RatelimitGetOverrideResponseBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  namespaceId: z.string(),
-  overrideId: z.string(),
-  duration: z.number().int(),
-  identifier: z.string(),
-  limit: z.number().int(),
+  meta: Meta$inboundSchema,
+  data: RatelimitOverride$inboundSchema,
 });
 
 /** @internal */
 export type V2RatelimitGetOverrideResponseBody$Outbound = {
-  namespaceId: string;
-  overrideId: string;
-  duration: number;
-  identifier: string;
-  limit: number;
+  meta: Meta$Outbound;
+  data: RatelimitOverride$Outbound;
 };
 
 /** @internal */
@@ -58,11 +46,8 @@ export const V2RatelimitGetOverrideResponseBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   V2RatelimitGetOverrideResponseBody
 > = z.object({
-  namespaceId: z.string(),
-  overrideId: z.string(),
-  duration: z.number().int(),
-  identifier: z.string(),
-  limit: z.number().int(),
+  meta: Meta$outboundSchema,
+  data: RatelimitOverride$outboundSchema,
 });
 
 /**

package/src/models/components/v2ratelimitlimitresponsebody.ts

@@ -6,28 +6,22 @@ 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";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
+import {
+  RatelimitLimitResponseData,
+  RatelimitLimitResponseData$inboundSchema,
+  RatelimitLimitResponseData$Outbound,
+  RatelimitLimitResponseData$outboundSchema,
+} from "./ratelimitlimitresponsedata.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;
+  meta: Meta;
+  data: RatelimitLimitResponseData;
 };
 
 /** @internal */
@@ -36,20 +30,14 @@ export const V2RatelimitLimitResponseBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  limit: z.number().int(),
-  remaining: z.number().int(),
-  reset: z.number().int(),
-  success: z.boolean(),
-  overrideId: z.string().optional(),
+  meta: Meta$inboundSchema,
+  data: RatelimitLimitResponseData$inboundSchema,
 });
 
 /** @internal */
 export type V2RatelimitLimitResponseBody$Outbound = {
-  limit: number;
-  remaining: number;
-  reset: number;
-  success: boolean;
-  overrideId?: string | undefined;
+  meta: Meta$Outbound;
+  data: RatelimitLimitResponseData$Outbound;
 };
 
 /** @internal */
@@ -58,11 +46,8 @@ export const V2RatelimitLimitResponseBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   V2RatelimitLimitResponseBody
 > = z.object({
-  limit: z.number().int(),
-  remaining: z.number().int(),
-  reset: z.number().int(),
-  success: z.boolean(),
-  overrideId: z.string().optional(),
+  meta: Meta$outboundSchema,
+  data: RatelimitLimitResponseData$outboundSchema,
 });
 
 /**

package/src/models/components/v2ratelimitlistoverridesrequestbody.ts

@@ -0,0 +1,95 @@
+/*
+ * 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 V2RatelimitListOverridesRequestBody = {
+  /**
+   * The id of the namespace to list overrides for.
+   */
+  namespaceId?: string | undefined;
+  /**
+   * The name of the namespace to list overrides for.
+   */
+  namespaceName?: string | undefined;
+  /**
+   * Pagination cursor from a previous response
+   */
+  cursor?: string | undefined;
+  /**
+   * Maximum number of results to return
+   */
+  limit?: number | undefined;
+};
+
+/** @internal */
+export const V2RatelimitListOverridesRequestBody$inboundSchema: z.ZodType<
+  V2RatelimitListOverridesRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  namespaceId: z.string().optional(),
+  namespaceName: z.string().optional(),
+  cursor: z.string().optional(),
+  limit: z.number().int().default(10),
+});
+
+/** @internal */
+export type V2RatelimitListOverridesRequestBody$Outbound = {
+  namespaceId?: string | undefined;
+  namespaceName?: string | undefined;
+  cursor?: string | undefined;
+  limit: number;
+};
+
+/** @internal */
+export const V2RatelimitListOverridesRequestBody$outboundSchema: z.ZodType<
+  V2RatelimitListOverridesRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2RatelimitListOverridesRequestBody
+> = z.object({
+  namespaceId: z.string().optional(),
+  namespaceName: z.string().optional(),
+  cursor: z.string().optional(),
+  limit: z.number().int().default(10),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2RatelimitListOverridesRequestBody$ {
+  /** @deprecated use `V2RatelimitListOverridesRequestBody$inboundSchema` instead. */
+  export const inboundSchema =
+    V2RatelimitListOverridesRequestBody$inboundSchema;
+  /** @deprecated use `V2RatelimitListOverridesRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    V2RatelimitListOverridesRequestBody$outboundSchema;
+  /** @deprecated use `V2RatelimitListOverridesRequestBody$Outbound` instead. */
+  export type Outbound = V2RatelimitListOverridesRequestBody$Outbound;
+}
+
+export function v2RatelimitListOverridesRequestBodyToJSON(
+  v2RatelimitListOverridesRequestBody: V2RatelimitListOverridesRequestBody,
+): string {
+  return JSON.stringify(
+    V2RatelimitListOverridesRequestBody$outboundSchema.parse(
+      v2RatelimitListOverridesRequestBody,
+    ),
+  );
+}
+
+export function v2RatelimitListOverridesRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2RatelimitListOverridesRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V2RatelimitListOverridesRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2RatelimitListOverridesRequestBody' from JSON`,
+  );
+}

package/src/models/components/v2ratelimitlistoverridesresponsebody.ts

@@ -0,0 +1,97 @@
+/*
+ * 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";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
+import {
+  Pagination,
+  Pagination$inboundSchema,
+  Pagination$Outbound,
+  Pagination$outboundSchema,
+} from "./pagination.js";
+import {
+  RatelimitOverride,
+  RatelimitOverride$inboundSchema,
+  RatelimitOverride$Outbound,
+  RatelimitOverride$outboundSchema,
+} from "./ratelimitoverride.js";
+
+export type V2RatelimitListOverridesResponseBody = {
+  meta: Meta;
+  data: Array<RatelimitOverride>;
+  pagination?: Pagination | undefined;
+};
+
+/** @internal */
+export const V2RatelimitListOverridesResponseBody$inboundSchema: z.ZodType<
+  V2RatelimitListOverridesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: z.array(RatelimitOverride$inboundSchema),
+  pagination: Pagination$inboundSchema.optional(),
+});
+
+/** @internal */
+export type V2RatelimitListOverridesResponseBody$Outbound = {
+  meta: Meta$Outbound;
+  data: Array<RatelimitOverride$Outbound>;
+  pagination?: Pagination$Outbound | undefined;
+};
+
+/** @internal */
+export const V2RatelimitListOverridesResponseBody$outboundSchema: z.ZodType<
+  V2RatelimitListOverridesResponseBody$Outbound,
+  z.ZodTypeDef,
+  V2RatelimitListOverridesResponseBody
+> = z.object({
+  meta: Meta$outboundSchema,
+  data: z.array(RatelimitOverride$outboundSchema),
+  pagination: Pagination$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2RatelimitListOverridesResponseBody$ {
+  /** @deprecated use `V2RatelimitListOverridesResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    V2RatelimitListOverridesResponseBody$inboundSchema;
+  /** @deprecated use `V2RatelimitListOverridesResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    V2RatelimitListOverridesResponseBody$outboundSchema;
+  /** @deprecated use `V2RatelimitListOverridesResponseBody$Outbound` instead. */
+  export type Outbound = V2RatelimitListOverridesResponseBody$Outbound;
+}
+
+export function v2RatelimitListOverridesResponseBodyToJSON(
+  v2RatelimitListOverridesResponseBody: V2RatelimitListOverridesResponseBody,
+): string {
+  return JSON.stringify(
+    V2RatelimitListOverridesResponseBody$outboundSchema.parse(
+      v2RatelimitListOverridesResponseBody,
+    ),
+  );
+}
+
+export function v2RatelimitListOverridesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2RatelimitListOverridesResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V2RatelimitListOverridesResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2RatelimitListOverridesResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2ratelimitsetoverrideresponsebody.ts

@@ -6,12 +6,22 @@ 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";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
+import {
+  RatelimitSetOverrideResponseData,
+  RatelimitSetOverrideResponseData$inboundSchema,
+  RatelimitSetOverrideResponseData$Outbound,
+  RatelimitSetOverrideResponseData$outboundSchema,
+} from "./ratelimitsetoverrideresponsedata.js";
 
 export type V2RatelimitSetOverrideResponseBody = {
-  /**
-   * The id of the override. This is used internally.
-   */
-  overrideId: string;
+  meta: Meta;
+  data: RatelimitSetOverrideResponseData;
 };
 
 /** @internal */
@@ -20,12 +30,14 @@ export const V2RatelimitSetOverrideResponseBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  overrideId: z.string(),
+  meta: Meta$inboundSchema,
+  data: RatelimitSetOverrideResponseData$inboundSchema,
 });
 
 /** @internal */
 export type V2RatelimitSetOverrideResponseBody$Outbound = {
-  overrideId: string;
+  meta: Meta$Outbound;
+  data: RatelimitSetOverrideResponseData$Outbound;
 };
 
 /** @internal */
@@ -34,7 +46,8 @@ export const V2RatelimitSetOverrideResponseBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   V2RatelimitSetOverrideResponseBody
 > = z.object({
-  overrideId: z.string(),
+  meta: Meta$outboundSchema,
+  data: RatelimitSetOverrideResponseData$outboundSchema,
 });
 
 /**

package/src/models/errors/badrequesterrorresponse.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import * as components from "../components/index.js";
+
+export type BadRequestErrorResponseData = {
+  meta: components.Meta;
+  error: components.BadRequestErrorDetails;
+};
+
+export class BadRequestErrorResponse extends Error {
+  meta: components.Meta;
+  error: components.BadRequestErrorDetails;
+
+  /** The original data that was passed to this error instance. */
+  data$: BadRequestErrorResponseData;
+
+  constructor(err: BadRequestErrorResponseData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.meta = err.meta;
+    this.error = err.error;
+
+    this.name = "BadRequestErrorResponse";
+  }
+}
+
+/** @internal */
+export const BadRequestErrorResponse$inboundSchema: z.ZodType<
+  BadRequestErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: components.Meta$inboundSchema,
+  error: components.BadRequestErrorDetails$inboundSchema,
+})
+  .transform((v) => {
+    return new BadRequestErrorResponse(v);
+  });
+
+/** @internal */
+export type BadRequestErrorResponse$Outbound = {
+  meta: components.Meta$Outbound;
+  error: components.BadRequestErrorDetails$Outbound;
+};
+
+/** @internal */
+export const BadRequestErrorResponse$outboundSchema: z.ZodType<
+  BadRequestErrorResponse$Outbound,
+  z.ZodTypeDef,
+  BadRequestErrorResponse
+> = z.instanceof(BadRequestErrorResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    meta: components.Meta$outboundSchema,
+    error: components.BadRequestErrorDetails$outboundSchema,
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BadRequestErrorResponse$ {
+  /** @deprecated use `BadRequestErrorResponse$inboundSchema` instead. */
+  export const inboundSchema = BadRequestErrorResponse$inboundSchema;
+  /** @deprecated use `BadRequestErrorResponse$outboundSchema` instead. */
+  export const outboundSchema = BadRequestErrorResponse$outboundSchema;
+  /** @deprecated use `BadRequestErrorResponse$Outbound` instead. */
+  export type Outbound = BadRequestErrorResponse$Outbound;
+}

package/src/models/errors/conflicterrorresponse.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import * as components from "../components/index.js";
+
+export type ConflictErrorResponseData = {
+  meta: components.Meta;
+  error: components.BaseError;
+};
+
+export class ConflictErrorResponse extends Error {
+  meta: components.Meta;
+  error: components.BaseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: ConflictErrorResponseData;
+
+  constructor(err: ConflictErrorResponseData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.meta = err.meta;
+    this.error = err.error;
+
+    this.name = "ConflictErrorResponse";
+  }
+}
+
+/** @internal */
+export const ConflictErrorResponse$inboundSchema: z.ZodType<
+  ConflictErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: components.Meta$inboundSchema,
+  error: components.BaseError$inboundSchema,
+})
+  .transform((v) => {
+    return new ConflictErrorResponse(v);
+  });
+
+/** @internal */
+export type ConflictErrorResponse$Outbound = {
+  meta: components.Meta$Outbound;
+  error: components.BaseError$Outbound;
+};
+
+/** @internal */
+export const ConflictErrorResponse$outboundSchema: z.ZodType<
+  ConflictErrorResponse$Outbound,
+  z.ZodTypeDef,
+  ConflictErrorResponse
+> = z.instanceof(ConflictErrorResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    meta: components.Meta$outboundSchema,
+    error: components.BaseError$outboundSchema,
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ConflictErrorResponse$ {
+  /** @deprecated use `ConflictErrorResponse$inboundSchema` instead. */
+  export const inboundSchema = ConflictErrorResponse$inboundSchema;
+  /** @deprecated use `ConflictErrorResponse$outboundSchema` instead. */
+  export const outboundSchema = ConflictErrorResponse$outboundSchema;
+  /** @deprecated use `ConflictErrorResponse$Outbound` instead. */
+  export type Outbound = ConflictErrorResponse$Outbound;
+}

package/src/models/errors/forbiddenerrorresponse.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import * as components from "../components/index.js";
+
+export type ForbiddenErrorResponseData = {
+  meta: components.Meta;
+  error: components.BaseError;
+};
+
+export class ForbiddenErrorResponse extends Error {
+  meta: components.Meta;
+  error: components.BaseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: ForbiddenErrorResponseData;
+
+  constructor(err: ForbiddenErrorResponseData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.meta = err.meta;
+    this.error = err.error;
+
+    this.name = "ForbiddenErrorResponse";
+  }
+}
+
+/** @internal */
+export const ForbiddenErrorResponse$inboundSchema: z.ZodType<
+  ForbiddenErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: components.Meta$inboundSchema,
+  error: components.BaseError$inboundSchema,
+})
+  .transform((v) => {
+    return new ForbiddenErrorResponse(v);
+  });
+
+/** @internal */
+export type ForbiddenErrorResponse$Outbound = {
+  meta: components.Meta$Outbound;
+  error: components.BaseError$Outbound;
+};
+
+/** @internal */
+export const ForbiddenErrorResponse$outboundSchema: z.ZodType<
+  ForbiddenErrorResponse$Outbound,
+  z.ZodTypeDef,
+  ForbiddenErrorResponse
+> = z.instanceof(ForbiddenErrorResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    meta: components.Meta$outboundSchema,
+    error: components.BaseError$outboundSchema,
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ForbiddenErrorResponse$ {
+  /** @deprecated use `ForbiddenErrorResponse$inboundSchema` instead. */
+  export const inboundSchema = ForbiddenErrorResponse$inboundSchema;
+  /** @deprecated use `ForbiddenErrorResponse$outboundSchema` instead. */
+  export const outboundSchema = ForbiddenErrorResponse$outboundSchema;
+  /** @deprecated use `ForbiddenErrorResponse$Outbound` instead. */
+  export type Outbound = ForbiddenErrorResponse$Outbound;
+}

package/src/models/errors/index.ts

@@ -3,7 +3,12 @@
  */
 
 export * from "./apierror.js";
-export * from "./badrequesterror.js";
-export * from "./baseerror.js";
+export * from "./badrequesterrorresponse.js";
+export * from "./conflicterrorresponse.js";
+export * from "./forbiddenerrorresponse.js";
 export * from "./httpclienterrors.js";
+export * from "./internalservererrorresponse.js";
+export * from "./notfounderrorresponse.js";
+export * from "./preconditionfailederrorresponse.js";
 export * from "./sdkvalidationerror.js";
+export * from "./unauthorizederrorresponse.js";