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

package/src/models/components/v2identitiescreateidentityrequestbody.ts

@@ -0,0 +1,180 @@
+/*
+ * 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 {
+  V2Ratelimit,
+  V2Ratelimit$inboundSchema,
+  V2Ratelimit$Outbound,
+  V2Ratelimit$outboundSchema,
+} from "./v2ratelimit.js";
+
+/**
+ * Attach metadata to this identity that you need to have access to when verifying a key.
+ *
+ * @remarks
+ *
+ * This will be returned as part of the `verifyKey` response.
+ */
+export type V2IdentitiesCreateIdentityRequestBodyMeta = {};
+
+export type V2IdentitiesCreateIdentityRequestBody = {
+  /**
+   * The id of this identity in your system.
+   *
+   * @remarks
+   *
+   * This usually comes from your authentication provider and could be a userId, organisationId or even an email.
+   * It does not matter what you use, as long as it uniquely identifies something in your application.
+   *
+   * `externalId`s are unique across your workspace and therefore a `CONFLICT` error is returned when you try to create duplicates.
+   */
+  externalId: string;
+  /**
+   * Attach metadata to this identity that you need to have access to when verifying a key.
+   *
+   * @remarks
+   *
+   * This will be returned as part of the `verifyKey` response.
+   */
+  meta?: V2IdentitiesCreateIdentityRequestBodyMeta | undefined;
+  /**
+   * Attach ratelimits to this identity.
+   *
+   * @remarks
+   *
+   * When verifying keys, you can specify which limits you want to use and all keys attached to this identity, will share the limits.
+   */
+  ratelimits?: Array<V2Ratelimit> | undefined;
+};
+
+/** @internal */
+export const V2IdentitiesCreateIdentityRequestBodyMeta$inboundSchema: z.ZodType<
+  V2IdentitiesCreateIdentityRequestBodyMeta,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type V2IdentitiesCreateIdentityRequestBodyMeta$Outbound = {};
+
+/** @internal */
+export const V2IdentitiesCreateIdentityRequestBodyMeta$outboundSchema:
+  z.ZodType<
+    V2IdentitiesCreateIdentityRequestBodyMeta$Outbound,
+    z.ZodTypeDef,
+    V2IdentitiesCreateIdentityRequestBodyMeta
+  > = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2IdentitiesCreateIdentityRequestBodyMeta$ {
+  /** @deprecated use `V2IdentitiesCreateIdentityRequestBodyMeta$inboundSchema` instead. */
+  export const inboundSchema =
+    V2IdentitiesCreateIdentityRequestBodyMeta$inboundSchema;
+  /** @deprecated use `V2IdentitiesCreateIdentityRequestBodyMeta$outboundSchema` instead. */
+  export const outboundSchema =
+    V2IdentitiesCreateIdentityRequestBodyMeta$outboundSchema;
+  /** @deprecated use `V2IdentitiesCreateIdentityRequestBodyMeta$Outbound` instead. */
+  export type Outbound = V2IdentitiesCreateIdentityRequestBodyMeta$Outbound;
+}
+
+export function v2IdentitiesCreateIdentityRequestBodyMetaToJSON(
+  v2IdentitiesCreateIdentityRequestBodyMeta:
+    V2IdentitiesCreateIdentityRequestBodyMeta,
+): string {
+  return JSON.stringify(
+    V2IdentitiesCreateIdentityRequestBodyMeta$outboundSchema.parse(
+      v2IdentitiesCreateIdentityRequestBodyMeta,
+    ),
+  );
+}
+
+export function v2IdentitiesCreateIdentityRequestBodyMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  V2IdentitiesCreateIdentityRequestBodyMeta,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V2IdentitiesCreateIdentityRequestBodyMeta$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'V2IdentitiesCreateIdentityRequestBodyMeta' from JSON`,
+  );
+}
+
+/** @internal */
+export const V2IdentitiesCreateIdentityRequestBody$inboundSchema: z.ZodType<
+  V2IdentitiesCreateIdentityRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  externalId: z.string(),
+  meta: z.lazy(() => V2IdentitiesCreateIdentityRequestBodyMeta$inboundSchema)
+    .optional(),
+  ratelimits: z.array(V2Ratelimit$inboundSchema).optional(),
+});
+
+/** @internal */
+export type V2IdentitiesCreateIdentityRequestBody$Outbound = {
+  externalId: string;
+  meta?: V2IdentitiesCreateIdentityRequestBodyMeta$Outbound | undefined;
+  ratelimits?: Array<V2Ratelimit$Outbound> | undefined;
+};
+
+/** @internal */
+export const V2IdentitiesCreateIdentityRequestBody$outboundSchema: z.ZodType<
+  V2IdentitiesCreateIdentityRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2IdentitiesCreateIdentityRequestBody
+> = z.object({
+  externalId: z.string(),
+  meta: z.lazy(() => V2IdentitiesCreateIdentityRequestBodyMeta$outboundSchema)
+    .optional(),
+  ratelimits: z.array(V2Ratelimit$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 V2IdentitiesCreateIdentityRequestBody$ {
+  /** @deprecated use `V2IdentitiesCreateIdentityRequestBody$inboundSchema` instead. */
+  export const inboundSchema =
+    V2IdentitiesCreateIdentityRequestBody$inboundSchema;
+  /** @deprecated use `V2IdentitiesCreateIdentityRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    V2IdentitiesCreateIdentityRequestBody$outboundSchema;
+  /** @deprecated use `V2IdentitiesCreateIdentityRequestBody$Outbound` instead. */
+  export type Outbound = V2IdentitiesCreateIdentityRequestBody$Outbound;
+}
+
+export function v2IdentitiesCreateIdentityRequestBodyToJSON(
+  v2IdentitiesCreateIdentityRequestBody: V2IdentitiesCreateIdentityRequestBody,
+): string {
+  return JSON.stringify(
+    V2IdentitiesCreateIdentityRequestBody$outboundSchema.parse(
+      v2IdentitiesCreateIdentityRequestBody,
+    ),
+  );
+}
+
+export function v2IdentitiesCreateIdentityRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2IdentitiesCreateIdentityRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V2IdentitiesCreateIdentityRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2IdentitiesCreateIdentityRequestBody' from JSON`,
+  );
+}

package/src/models/components/v2identitiescreateidentityresponsebody.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  IdentitiesCreateIdentityResponseData,
+  IdentitiesCreateIdentityResponseData$inboundSchema,
+  IdentitiesCreateIdentityResponseData$Outbound,
+  IdentitiesCreateIdentityResponseData$outboundSchema,
+} from "./identitiescreateidentityresponsedata.js";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
+
+export type V2IdentitiesCreateIdentityResponseBody = {
+  meta: Meta;
+  data: IdentitiesCreateIdentityResponseData;
+};
+
+/** @internal */
+export const V2IdentitiesCreateIdentityResponseBody$inboundSchema: z.ZodType<
+  V2IdentitiesCreateIdentityResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: IdentitiesCreateIdentityResponseData$inboundSchema,
+});
+
+/** @internal */
+export type V2IdentitiesCreateIdentityResponseBody$Outbound = {
+  meta: Meta$Outbound;
+  data: IdentitiesCreateIdentityResponseData$Outbound;
+};
+
+/** @internal */
+export const V2IdentitiesCreateIdentityResponseBody$outboundSchema: z.ZodType<
+  V2IdentitiesCreateIdentityResponseBody$Outbound,
+  z.ZodTypeDef,
+  V2IdentitiesCreateIdentityResponseBody
+> = z.object({
+  meta: Meta$outboundSchema,
+  data: IdentitiesCreateIdentityResponseData$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2IdentitiesCreateIdentityResponseBody$ {
+  /** @deprecated use `V2IdentitiesCreateIdentityResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    V2IdentitiesCreateIdentityResponseBody$inboundSchema;
+  /** @deprecated use `V2IdentitiesCreateIdentityResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    V2IdentitiesCreateIdentityResponseBody$outboundSchema;
+  /** @deprecated use `V2IdentitiesCreateIdentityResponseBody$Outbound` instead. */
+  export type Outbound = V2IdentitiesCreateIdentityResponseBody$Outbound;
+}
+
+export function v2IdentitiesCreateIdentityResponseBodyToJSON(
+  v2IdentitiesCreateIdentityResponseBody:
+    V2IdentitiesCreateIdentityResponseBody,
+): string {
+  return JSON.stringify(
+    V2IdentitiesCreateIdentityResponseBody$outboundSchema.parse(
+      v2IdentitiesCreateIdentityResponseBody,
+    ),
+  );
+}
+
+export function v2IdentitiesCreateIdentityResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2IdentitiesCreateIdentityResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V2IdentitiesCreateIdentityResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2IdentitiesCreateIdentityResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2livenessresponsebody.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 {
+  LivenessResponseData,
+  LivenessResponseData$inboundSchema,
+  LivenessResponseData$Outbound,
+  LivenessResponseData$outboundSchema,
+} from "./livenessresponsedata.js";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
 
 export type V2LivenessResponseBody = {
-  /**
-   * Whether we're alive or not
-   */
-  message: string;
+  meta: Meta;
+  data: LivenessResponseData;
 };
 
 /** @internal */
@@ -20,12 +30,14 @@ export const V2LivenessResponseBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  message: z.string(),
+  meta: Meta$inboundSchema,
+  data: LivenessResponseData$inboundSchema,
 });
 
 /** @internal */
 export type V2LivenessResponseBody$Outbound = {
-  message: string;
+  meta: Meta$Outbound;
+  data: LivenessResponseData$Outbound;
 };
 
 /** @internal */
@@ -34,7 +46,8 @@ export const V2LivenessResponseBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   V2LivenessResponseBody
 > = z.object({
-  message: z.string(),
+  meta: Meta$outboundSchema,
+  data: LivenessResponseData$outboundSchema,
 });
 
 /**

package/src/models/components/v2ratelimit.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 V2Ratelimit = {
+  /**
+   * The name of this limit. You will need to use this again when verifying a key.
+   */
+  name: string;
+  /**
+   * How many requests may pass within a given window before requests are rejected.
+   */
+  limit: number;
+  /**
+   * The duration for each ratelimit window in milliseconds.
+   */
+  duration: number;
+};
+
+/** @internal */
+export const V2Ratelimit$inboundSchema: z.ZodType<
+  V2Ratelimit,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  limit: z.number().int(),
+  duration: z.number().int(),
+});
+
+/** @internal */
+export type V2Ratelimit$Outbound = {
+  name: string;
+  limit: number;
+  duration: number;
+};
+
+/** @internal */
+export const V2Ratelimit$outboundSchema: z.ZodType<
+  V2Ratelimit$Outbound,
+  z.ZodTypeDef,
+  V2Ratelimit
+> = z.object({
+  name: z.string(),
+  limit: z.number().int(),
+  duration: 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 V2Ratelimit$ {
+  /** @deprecated use `V2Ratelimit$inboundSchema` instead. */
+  export const inboundSchema = V2Ratelimit$inboundSchema;
+  /** @deprecated use `V2Ratelimit$outboundSchema` instead. */
+  export const outboundSchema = V2Ratelimit$outboundSchema;
+  /** @deprecated use `V2Ratelimit$Outbound` instead. */
+  export type Outbound = V2Ratelimit$Outbound;
+}
+
+export function v2RatelimitToJSON(v2Ratelimit: V2Ratelimit): string {
+  return JSON.stringify(V2Ratelimit$outboundSchema.parse(v2Ratelimit));
+}
+
+export function v2RatelimitFromJSON(
+  jsonString: string,
+): SafeParseResult<V2Ratelimit, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2Ratelimit$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2Ratelimit' from JSON`,
+  );
+}

package/src/models/components/v2ratelimitdeleteoverrideresponsebody.ts

@@ -6,25 +6,49 @@ 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 {
+  RatelimitDeleteOverrideResponseData,
+  RatelimitDeleteOverrideResponseData$inboundSchema,
+  RatelimitDeleteOverrideResponseData$Outbound,
+  RatelimitDeleteOverrideResponseData$outboundSchema,
+} from "./ratelimitdeleteoverrideresponsedata.js";
 
-export type V2RatelimitDeleteOverrideResponseBody = {};
+export type V2RatelimitDeleteOverrideResponseBody = {
+  meta: Meta;
+  data: RatelimitDeleteOverrideResponseData;
+};
 
 /** @internal */
 export const V2RatelimitDeleteOverrideResponseBody$inboundSchema: z.ZodType<
   V2RatelimitDeleteOverrideResponseBody,
   z.ZodTypeDef,
   unknown
-> = z.object({});
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: RatelimitDeleteOverrideResponseData$inboundSchema,
+});
 
 /** @internal */
-export type V2RatelimitDeleteOverrideResponseBody$Outbound = {};
+export type V2RatelimitDeleteOverrideResponseBody$Outbound = {
+  meta: Meta$Outbound;
+  data: RatelimitDeleteOverrideResponseData$Outbound;
+};
 
 /** @internal */
 export const V2RatelimitDeleteOverrideResponseBody$outboundSchema: z.ZodType<
   V2RatelimitDeleteOverrideResponseBody$Outbound,
   z.ZodTypeDef,
   V2RatelimitDeleteOverrideResponseBody
-> = z.object({});
+> = z.object({
+  meta: Meta$outboundSchema,
+  data: RatelimitDeleteOverrideResponseData$outboundSchema,
+});
 
 /**
  * @internal

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,
 });
 
 /**