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

package/src/models/components/baseerror.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 BaseError = {
+  /**
+   * 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;
+};
+
+/** @internal */
+export const BaseError$inboundSchema: z.ZodType<
+  BaseError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  detail: z.string(),
+  instance: z.string().optional(),
+  status: z.number().int(),
+  title: z.string(),
+  type: z.string(),
+});
+
+/** @internal */
+export type BaseError$Outbound = {
+  detail: string;
+  instance?: string | undefined;
+  status: number;
+  title: string;
+  type: string;
+};
+
+/** @internal */
+export const BaseError$outboundSchema: z.ZodType<
+  BaseError$Outbound,
+  z.ZodTypeDef,
+  BaseError
+> = z.object({
+  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;
+}
+
+export function baseErrorToJSON(baseError: BaseError): string {
+  return JSON.stringify(BaseError$outboundSchema.parse(baseError));
+}
+
+export function baseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<BaseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BaseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BaseError' from JSON`,
+  );
+}

package/src/models/components/identitiescreateidentityresponsedata.ts

@@ -0,0 +1,74 @@
+/*
+ * 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 IdentitiesCreateIdentityResponseData = {
+  /**
+   * The id of the identity. Used internally, you do not need to store this.
+   */
+  identityId: string;
+};
+
+/** @internal */
+export const IdentitiesCreateIdentityResponseData$inboundSchema: z.ZodType<
+  IdentitiesCreateIdentityResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identityId: z.string(),
+});
+
+/** @internal */
+export type IdentitiesCreateIdentityResponseData$Outbound = {
+  identityId: string;
+};
+
+/** @internal */
+export const IdentitiesCreateIdentityResponseData$outboundSchema: z.ZodType<
+  IdentitiesCreateIdentityResponseData$Outbound,
+  z.ZodTypeDef,
+  IdentitiesCreateIdentityResponseData
+> = z.object({
+  identityId: 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 IdentitiesCreateIdentityResponseData$ {
+  /** @deprecated use `IdentitiesCreateIdentityResponseData$inboundSchema` instead. */
+  export const inboundSchema =
+    IdentitiesCreateIdentityResponseData$inboundSchema;
+  /** @deprecated use `IdentitiesCreateIdentityResponseData$outboundSchema` instead. */
+  export const outboundSchema =
+    IdentitiesCreateIdentityResponseData$outboundSchema;
+  /** @deprecated use `IdentitiesCreateIdentityResponseData$Outbound` instead. */
+  export type Outbound = IdentitiesCreateIdentityResponseData$Outbound;
+}
+
+export function identitiesCreateIdentityResponseDataToJSON(
+  identitiesCreateIdentityResponseData: IdentitiesCreateIdentityResponseData,
+): string {
+  return JSON.stringify(
+    IdentitiesCreateIdentityResponseData$outboundSchema.parse(
+      identitiesCreateIdentityResponseData,
+    ),
+  );
+}
+
+export function identitiesCreateIdentityResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<IdentitiesCreateIdentityResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      IdentitiesCreateIdentityResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IdentitiesCreateIdentityResponseData' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -2,14 +2,32 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./apiscreateapiresponsedata.js";
+export * from "./badrequesterrordetails.js";
+export * from "./baseerror.js";
+export * from "./identitiescreateidentityresponsedata.js";
+export * from "./livenessresponsedata.js";
+export * from "./meta.js";
+export * from "./pagination.js";
+export * from "./ratelimitdeleteoverrideresponsedata.js";
+export * from "./ratelimitlimitresponsedata.js";
+export * from "./ratelimitoverride.js";
+export * from "./ratelimitsetoverrideresponsedata.js";
 export * from "./security.js";
+export * from "./v2apiscreateapirequestbody.js";
+export * from "./v2apiscreateapiresponsebody.js";
+export * from "./v2identitiescreateidentityrequestbody.js";
+export * from "./v2identitiescreateidentityresponsebody.js";
 export * from "./v2livenessresponsebody.js";
+export * from "./v2ratelimit.js";
 export * from "./v2ratelimitdeleteoverriderequestbody.js";
 export * from "./v2ratelimitdeleteoverrideresponsebody.js";
 export * from "./v2ratelimitgetoverriderequestbody.js";
 export * from "./v2ratelimitgetoverrideresponsebody.js";
 export * from "./v2ratelimitlimitrequestbody.js";
 export * from "./v2ratelimitlimitresponsebody.js";
+export * from "./v2ratelimitlistoverridesrequestbody.js";
+export * from "./v2ratelimitlistoverridesresponsebody.js";
 export * from "./v2ratelimitsetoverriderequestbody.js";
 export * from "./v2ratelimitsetoverrideresponsebody.js";
 export * from "./validationerror.js";

package/src/models/components/livenessresponsedata.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 LivenessResponseData = {
+  /**
+   * Whether we're alive or not
+   */
+  message: string;
+};
+
+/** @internal */
+export const LivenessResponseData$inboundSchema: z.ZodType<
+  LivenessResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+});
+
+/** @internal */
+export type LivenessResponseData$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const LivenessResponseData$outboundSchema: z.ZodType<
+  LivenessResponseData$Outbound,
+  z.ZodTypeDef,
+  LivenessResponseData
+> = z.object({
+  message: 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 LivenessResponseData$ {
+  /** @deprecated use `LivenessResponseData$inboundSchema` instead. */
+  export const inboundSchema = LivenessResponseData$inboundSchema;
+  /** @deprecated use `LivenessResponseData$outboundSchema` instead. */
+  export const outboundSchema = LivenessResponseData$outboundSchema;
+  /** @deprecated use `LivenessResponseData$Outbound` instead. */
+  export type Outbound = LivenessResponseData$Outbound;
+}
+
+export function livenessResponseDataToJSON(
+  livenessResponseData: LivenessResponseData,
+): string {
+  return JSON.stringify(
+    LivenessResponseData$outboundSchema.parse(livenessResponseData),
+  );
+}
+
+export function livenessResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<LivenessResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LivenessResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LivenessResponseData' from JSON`,
+  );
+}

package/src/models/components/meta.ts

@@ -0,0 +1,59 @@
+/*
+ * 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 Meta = {
+  /**
+   * A unique id for this request. Please always provide this to support.
+   */
+  requestId: string;
+};
+
+/** @internal */
+export const Meta$inboundSchema: z.ZodType<Meta, z.ZodTypeDef, unknown> = z
+  .object({
+    requestId: z.string(),
+  });
+
+/** @internal */
+export type Meta$Outbound = {
+  requestId: string;
+};
+
+/** @internal */
+export const Meta$outboundSchema: z.ZodType<Meta$Outbound, z.ZodTypeDef, Meta> =
+  z.object({
+    requestId: 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 Meta$ {
+  /** @deprecated use `Meta$inboundSchema` instead. */
+  export const inboundSchema = Meta$inboundSchema;
+  /** @deprecated use `Meta$outboundSchema` instead. */
+  export const outboundSchema = Meta$outboundSchema;
+  /** @deprecated use `Meta$Outbound` instead. */
+  export type Outbound = Meta$Outbound;
+}
+
+export function metaToJSON(meta: Meta): string {
+  return JSON.stringify(Meta$outboundSchema.parse(meta));
+}
+
+export function metaFromJSON(
+  jsonString: string,
+): SafeParseResult<Meta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Meta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Meta' from JSON`,
+  );
+}

package/src/models/components/pagination.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 Pagination = {
+  /**
+   * Opaque token for retrieving the next set of results
+   */
+  cursor?: string | undefined;
+  /**
+   * Indicates if more results exist beyond this page
+   */
+  hasMore?: boolean | undefined;
+};
+
+/** @internal */
+export const Pagination$inboundSchema: z.ZodType<
+  Pagination,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cursor: z.string().optional(),
+  hasMore: z.boolean().optional(),
+});
+
+/** @internal */
+export type Pagination$Outbound = {
+  cursor?: string | undefined;
+  hasMore?: boolean | undefined;
+};
+
+/** @internal */
+export const Pagination$outboundSchema: z.ZodType<
+  Pagination$Outbound,
+  z.ZodTypeDef,
+  Pagination
+> = z.object({
+  cursor: z.string().optional(),
+  hasMore: z.boolean().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Pagination$ {
+  /** @deprecated use `Pagination$inboundSchema` instead. */
+  export const inboundSchema = Pagination$inboundSchema;
+  /** @deprecated use `Pagination$outboundSchema` instead. */
+  export const outboundSchema = Pagination$outboundSchema;
+  /** @deprecated use `Pagination$Outbound` instead. */
+  export type Outbound = Pagination$Outbound;
+}
+
+export function paginationToJSON(pagination: Pagination): string {
+  return JSON.stringify(Pagination$outboundSchema.parse(pagination));
+}
+
+export function paginationFromJSON(
+  jsonString: string,
+): SafeParseResult<Pagination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Pagination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Pagination' from JSON`,
+  );
+}

package/src/models/components/ratelimitdeleteoverrideresponsedata.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 RatelimitDeleteOverrideResponseData = {};
+
+/** @internal */
+export const RatelimitDeleteOverrideResponseData$inboundSchema: z.ZodType<
+  RatelimitDeleteOverrideResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type RatelimitDeleteOverrideResponseData$Outbound = {};
+
+/** @internal */
+export const RatelimitDeleteOverrideResponseData$outboundSchema: z.ZodType<
+  RatelimitDeleteOverrideResponseData$Outbound,
+  z.ZodTypeDef,
+  RatelimitDeleteOverrideResponseData
+> = 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 RatelimitDeleteOverrideResponseData$ {
+  /** @deprecated use `RatelimitDeleteOverrideResponseData$inboundSchema` instead. */
+  export const inboundSchema =
+    RatelimitDeleteOverrideResponseData$inboundSchema;
+  /** @deprecated use `RatelimitDeleteOverrideResponseData$outboundSchema` instead. */
+  export const outboundSchema =
+    RatelimitDeleteOverrideResponseData$outboundSchema;
+  /** @deprecated use `RatelimitDeleteOverrideResponseData$Outbound` instead. */
+  export type Outbound = RatelimitDeleteOverrideResponseData$Outbound;
+}
+
+export function ratelimitDeleteOverrideResponseDataToJSON(
+  ratelimitDeleteOverrideResponseData: RatelimitDeleteOverrideResponseData,
+): string {
+  return JSON.stringify(
+    RatelimitDeleteOverrideResponseData$outboundSchema.parse(
+      ratelimitDeleteOverrideResponseData,
+    ),
+  );
+}
+
+export function ratelimitDeleteOverrideResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<RatelimitDeleteOverrideResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      RatelimitDeleteOverrideResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RatelimitDeleteOverrideResponseData' from JSON`,
+  );
+}

package/src/models/components/ratelimitlimitresponsedata.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";
+
+export type RatelimitLimitResponseData = {
+  /**
+   * 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 RatelimitLimitResponseData$inboundSchema: z.ZodType<
+  RatelimitLimitResponseData,
+  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 RatelimitLimitResponseData$Outbound = {
+  limit: number;
+  remaining: number;
+  reset: number;
+  success: boolean;
+  overrideId?: string | undefined;
+};
+
+/** @internal */
+export const RatelimitLimitResponseData$outboundSchema: z.ZodType<
+  RatelimitLimitResponseData$Outbound,
+  z.ZodTypeDef,
+  RatelimitLimitResponseData
+> = 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 RatelimitLimitResponseData$ {
+  /** @deprecated use `RatelimitLimitResponseData$inboundSchema` instead. */
+  export const inboundSchema = RatelimitLimitResponseData$inboundSchema;
+  /** @deprecated use `RatelimitLimitResponseData$outboundSchema` instead. */
+  export const outboundSchema = RatelimitLimitResponseData$outboundSchema;
+  /** @deprecated use `RatelimitLimitResponseData$Outbound` instead. */
+  export type Outbound = RatelimitLimitResponseData$Outbound;
+}
+
+export function ratelimitLimitResponseDataToJSON(
+  ratelimitLimitResponseData: RatelimitLimitResponseData,
+): string {
+  return JSON.stringify(
+    RatelimitLimitResponseData$outboundSchema.parse(ratelimitLimitResponseData),
+  );
+}
+
+export function ratelimitLimitResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<RatelimitLimitResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RatelimitLimitResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RatelimitLimitResponseData' from JSON`,
+  );
+}

package/src/models/components/ratelimitoverride.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";
+
+export type RatelimitOverride = {
+  /**
+   * 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;
+};
+
+/** @internal */
+export const RatelimitOverride$inboundSchema: z.ZodType<
+  RatelimitOverride,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  namespaceId: z.string(),
+  overrideId: z.string(),
+  duration: z.number().int(),
+  identifier: z.string(),
+  limit: z.number().int(),
+});
+
+/** @internal */
+export type RatelimitOverride$Outbound = {
+  namespaceId: string;
+  overrideId: string;
+  duration: number;
+  identifier: string;
+  limit: number;
+};
+
+/** @internal */
+export const RatelimitOverride$outboundSchema: z.ZodType<
+  RatelimitOverride$Outbound,
+  z.ZodTypeDef,
+  RatelimitOverride
+> = z.object({
+  namespaceId: z.string(),
+  overrideId: z.string(),
+  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 RatelimitOverride$ {
+  /** @deprecated use `RatelimitOverride$inboundSchema` instead. */
+  export const inboundSchema = RatelimitOverride$inboundSchema;
+  /** @deprecated use `RatelimitOverride$outboundSchema` instead. */
+  export const outboundSchema = RatelimitOverride$outboundSchema;
+  /** @deprecated use `RatelimitOverride$Outbound` instead. */
+  export type Outbound = RatelimitOverride$Outbound;
+}
+
+export function ratelimitOverrideToJSON(
+  ratelimitOverride: RatelimitOverride,
+): string {
+  return JSON.stringify(
+    RatelimitOverride$outboundSchema.parse(ratelimitOverride),
+  );
+}
+
+export function ratelimitOverrideFromJSON(
+  jsonString: string,
+): SafeParseResult<RatelimitOverride, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RatelimitOverride$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RatelimitOverride' from JSON`,
+  );
+}