@unkey/api 2.0.0-alpha.6 → 2.0.0

package/src/models/components/v2apisdeleteapiresponsebody.ts

@@ -0,0 +1,90 @@
+/*
+ * 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 {
+  EmptyResponse,
+  EmptyResponse$inboundSchema,
+  EmptyResponse$Outbound,
+  EmptyResponse$outboundSchema,
+} from "./emptyresponse.js";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
+
+export type V2ApisDeleteApiResponseBody = {
+  /**
+   * Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
+   */
+  meta: Meta;
+  /**
+   * Empty response object by design. A successful response indicates this operation was successfully executed.
+   */
+  data: EmptyResponse;
+};
+
+/** @internal */
+export const V2ApisDeleteApiResponseBody$inboundSchema: z.ZodType<
+  V2ApisDeleteApiResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: EmptyResponse$inboundSchema,
+});
+
+/** @internal */
+export type V2ApisDeleteApiResponseBody$Outbound = {
+  meta: Meta$Outbound;
+  data: EmptyResponse$Outbound;
+};
+
+/** @internal */
+export const V2ApisDeleteApiResponseBody$outboundSchema: z.ZodType<
+  V2ApisDeleteApiResponseBody$Outbound,
+  z.ZodTypeDef,
+  V2ApisDeleteApiResponseBody
+> = z.object({
+  meta: Meta$outboundSchema,
+  data: EmptyResponse$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2ApisDeleteApiResponseBody$ {
+  /** @deprecated use `V2ApisDeleteApiResponseBody$inboundSchema` instead. */
+  export const inboundSchema = V2ApisDeleteApiResponseBody$inboundSchema;
+  /** @deprecated use `V2ApisDeleteApiResponseBody$outboundSchema` instead. */
+  export const outboundSchema = V2ApisDeleteApiResponseBody$outboundSchema;
+  /** @deprecated use `V2ApisDeleteApiResponseBody$Outbound` instead. */
+  export type Outbound = V2ApisDeleteApiResponseBody$Outbound;
+}
+
+export function v2ApisDeleteApiResponseBodyToJSON(
+  v2ApisDeleteApiResponseBody: V2ApisDeleteApiResponseBody,
+): string {
+  return JSON.stringify(
+    V2ApisDeleteApiResponseBody$outboundSchema.parse(
+      v2ApisDeleteApiResponseBody,
+    ),
+  );
+}
+
+export function v2ApisDeleteApiResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2ApisDeleteApiResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2ApisDeleteApiResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2ApisDeleteApiResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2apisgetapirequestbody.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 V2ApisGetApiRequestBody = {
+  /**
+   * Specifies which API to retrieve by its unique identifier.
+   *
+   * @remarks
+   * Must be a valid API ID that begins with 'api_' and exists within your workspace.
+   */
+  apiId: string;
+};
+
+/** @internal */
+export const V2ApisGetApiRequestBody$inboundSchema: z.ZodType<
+  V2ApisGetApiRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  apiId: z.string(),
+});
+
+/** @internal */
+export type V2ApisGetApiRequestBody$Outbound = {
+  apiId: string;
+};
+
+/** @internal */
+export const V2ApisGetApiRequestBody$outboundSchema: z.ZodType<
+  V2ApisGetApiRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2ApisGetApiRequestBody
+> = z.object({
+  apiId: 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 V2ApisGetApiRequestBody$ {
+  /** @deprecated use `V2ApisGetApiRequestBody$inboundSchema` instead. */
+  export const inboundSchema = V2ApisGetApiRequestBody$inboundSchema;
+  /** @deprecated use `V2ApisGetApiRequestBody$outboundSchema` instead. */
+  export const outboundSchema = V2ApisGetApiRequestBody$outboundSchema;
+  /** @deprecated use `V2ApisGetApiRequestBody$Outbound` instead. */
+  export type Outbound = V2ApisGetApiRequestBody$Outbound;
+}
+
+export function v2ApisGetApiRequestBodyToJSON(
+  v2ApisGetApiRequestBody: V2ApisGetApiRequestBody,
+): string {
+  return JSON.stringify(
+    V2ApisGetApiRequestBody$outboundSchema.parse(v2ApisGetApiRequestBody),
+  );
+}
+
+export function v2ApisGetApiRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2ApisGetApiRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2ApisGetApiRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2ApisGetApiRequestBody' from JSON`,
+  );
+}

package/src/models/components/v2apisgetapiresponsebody.ts

@@ -0,0 +1,85 @@
+/*
+ * 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 {
+  V2ApisGetApiResponseData,
+  V2ApisGetApiResponseData$inboundSchema,
+  V2ApisGetApiResponseData$Outbound,
+  V2ApisGetApiResponseData$outboundSchema,
+} from "./v2apisgetapiresponsedata.js";
+
+export type V2ApisGetApiResponseBody = {
+  /**
+   * Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
+   */
+  meta: Meta;
+  data: V2ApisGetApiResponseData;
+};
+
+/** @internal */
+export const V2ApisGetApiResponseBody$inboundSchema: z.ZodType<
+  V2ApisGetApiResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: V2ApisGetApiResponseData$inboundSchema,
+});
+
+/** @internal */
+export type V2ApisGetApiResponseBody$Outbound = {
+  meta: Meta$Outbound;
+  data: V2ApisGetApiResponseData$Outbound;
+};
+
+/** @internal */
+export const V2ApisGetApiResponseBody$outboundSchema: z.ZodType<
+  V2ApisGetApiResponseBody$Outbound,
+  z.ZodTypeDef,
+  V2ApisGetApiResponseBody
+> = z.object({
+  meta: Meta$outboundSchema,
+  data: V2ApisGetApiResponseData$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2ApisGetApiResponseBody$ {
+  /** @deprecated use `V2ApisGetApiResponseBody$inboundSchema` instead. */
+  export const inboundSchema = V2ApisGetApiResponseBody$inboundSchema;
+  /** @deprecated use `V2ApisGetApiResponseBody$outboundSchema` instead. */
+  export const outboundSchema = V2ApisGetApiResponseBody$outboundSchema;
+  /** @deprecated use `V2ApisGetApiResponseBody$Outbound` instead. */
+  export type Outbound = V2ApisGetApiResponseBody$Outbound;
+}
+
+export function v2ApisGetApiResponseBodyToJSON(
+  v2ApisGetApiResponseBody: V2ApisGetApiResponseBody,
+): string {
+  return JSON.stringify(
+    V2ApisGetApiResponseBody$outboundSchema.parse(v2ApisGetApiResponseBody),
+  );
+}
+
+export function v2ApisGetApiResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2ApisGetApiResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2ApisGetApiResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2ApisGetApiResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2apisgetapiresponsedata.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 V2ApisGetApiResponseData = {
+  /**
+   * The unique identifier of this API within Unkey's system.
+   *
+   * @remarks
+   * Used in all operations related to this API including key creation, verification, and management.
+   * Always begins with 'api_' followed by alphanumeric characters and underscores.
+   * This identifier is permanent and never changes after API creation.
+   */
+  id: string;
+  /**
+   * The internal name of this API as specified during creation.
+   *
+   * @remarks
+   * Used for organization and identification within your workspace.
+   * Helps distinguish between different environments, services, or access tiers.
+   * Not visible to end users - this is purely for administrative purposes.
+   */
+  name: string;
+};
+
+/** @internal */
+export const V2ApisGetApiResponseData$inboundSchema: z.ZodType<
+  V2ApisGetApiResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+});
+
+/** @internal */
+export type V2ApisGetApiResponseData$Outbound = {
+  id: string;
+  name: string;
+};
+
+/** @internal */
+export const V2ApisGetApiResponseData$outboundSchema: z.ZodType<
+  V2ApisGetApiResponseData$Outbound,
+  z.ZodTypeDef,
+  V2ApisGetApiResponseData
+> = z.object({
+  id: z.string(),
+  name: 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 V2ApisGetApiResponseData$ {
+  /** @deprecated use `V2ApisGetApiResponseData$inboundSchema` instead. */
+  export const inboundSchema = V2ApisGetApiResponseData$inboundSchema;
+  /** @deprecated use `V2ApisGetApiResponseData$outboundSchema` instead. */
+  export const outboundSchema = V2ApisGetApiResponseData$outboundSchema;
+  /** @deprecated use `V2ApisGetApiResponseData$Outbound` instead. */
+  export type Outbound = V2ApisGetApiResponseData$Outbound;
+}
+
+export function v2ApisGetApiResponseDataToJSON(
+  v2ApisGetApiResponseData: V2ApisGetApiResponseData,
+): string {
+  return JSON.stringify(
+    V2ApisGetApiResponseData$outboundSchema.parse(v2ApisGetApiResponseData),
+  );
+}
+
+export function v2ApisGetApiResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<V2ApisGetApiResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2ApisGetApiResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2ApisGetApiResponseData' from JSON`,
+  );
+}

package/src/models/components/v2apislistkeysrequestbody.ts

@@ -0,0 +1,130 @@
+/*
+ * 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 V2ApisListKeysRequestBody = {
+  /**
+   * The API namespace whose keys you want to list.
+   *
+   * @remarks
+   * Returns all keys in this API, subject to pagination and filters.
+   */
+  apiId: string;
+  /**
+   * Maximum number of keys to return per request.
+   *
+   * @remarks
+   * Balance between response size and number of pagination calls needed.
+   */
+  limit?: number | undefined;
+  /**
+   * Pagination cursor from previous response to fetch next page.
+   *
+   * @remarks
+   * Use when `hasMore: true` in previous response.
+   */
+  cursor?: string | undefined;
+  /**
+   * Filter keys by external ID to find keys for a specific user or entity.
+   *
+   * @remarks
+   * Must exactly match the externalId set during key creation.
+   */
+  externalId?: string | undefined;
+  /**
+   * When true, attempts to include the plaintext key value in the response. SECURITY WARNING:
+   *
+   * @remarks
+   * - This requires special permissions on the calling root key
+   * - Only works for keys created with 'recoverable: true'
+   * - Exposes sensitive key material in the response
+   * - Should only be used in secure administrative contexts
+   * - Never enable this in user-facing applications
+   */
+  decrypt?: boolean | undefined;
+  /**
+   * EXPERIMENTAL: Skip the cache and fetch the keys directly from the database. This ensures you see the most recent state, including keys created moments ago. Use this when:
+   *
+   * @remarks
+   * - You've just created a key and need to display it immediately
+   * - You need absolute certainty about the current key state
+   * - You're debugging cache consistency issues
+   *
+   * This parameter comes with a performance cost and should be used sparingly.
+   */
+  revalidateKeysCache?: boolean | undefined;
+};
+
+/** @internal */
+export const V2ApisListKeysRequestBody$inboundSchema: z.ZodType<
+  V2ApisListKeysRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  apiId: z.string(),
+  limit: z.number().int().default(100),
+  cursor: z.string().optional(),
+  externalId: z.string().optional(),
+  decrypt: z.boolean().default(false),
+  revalidateKeysCache: z.boolean().default(false),
+});
+
+/** @internal */
+export type V2ApisListKeysRequestBody$Outbound = {
+  apiId: string;
+  limit: number;
+  cursor?: string | undefined;
+  externalId?: string | undefined;
+  decrypt: boolean;
+  revalidateKeysCache: boolean;
+};
+
+/** @internal */
+export const V2ApisListKeysRequestBody$outboundSchema: z.ZodType<
+  V2ApisListKeysRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2ApisListKeysRequestBody
+> = z.object({
+  apiId: z.string(),
+  limit: z.number().int().default(100),
+  cursor: z.string().optional(),
+  externalId: z.string().optional(),
+  decrypt: z.boolean().default(false),
+  revalidateKeysCache: z.boolean().default(false),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2ApisListKeysRequestBody$ {
+  /** @deprecated use `V2ApisListKeysRequestBody$inboundSchema` instead. */
+  export const inboundSchema = V2ApisListKeysRequestBody$inboundSchema;
+  /** @deprecated use `V2ApisListKeysRequestBody$outboundSchema` instead. */
+  export const outboundSchema = V2ApisListKeysRequestBody$outboundSchema;
+  /** @deprecated use `V2ApisListKeysRequestBody$Outbound` instead. */
+  export type Outbound = V2ApisListKeysRequestBody$Outbound;
+}
+
+export function v2ApisListKeysRequestBodyToJSON(
+  v2ApisListKeysRequestBody: V2ApisListKeysRequestBody,
+): string {
+  return JSON.stringify(
+    V2ApisListKeysRequestBody$outboundSchema.parse(v2ApisListKeysRequestBody),
+  );
+}
+
+export function v2ApisListKeysRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2ApisListKeysRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2ApisListKeysRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2ApisListKeysRequestBody' from JSON`,
+  );
+}

package/src/models/components/v2apislistkeysresponsebody.ts

@@ -0,0 +1,101 @@
+/*
+ * 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 {
+  KeyResponseData,
+  KeyResponseData$inboundSchema,
+  KeyResponseData$Outbound,
+  KeyResponseData$outboundSchema,
+} from "./keyresponsedata.js";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
+import {
+  Pagination,
+  Pagination$inboundSchema,
+  Pagination$Outbound,
+  Pagination$outboundSchema,
+} from "./pagination.js";
+
+export type V2ApisListKeysResponseBody = {
+  /**
+   * Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
+   */
+  meta: Meta;
+  /**
+   * Array of API keys with complete configuration and metadata.
+   */
+  data: Array<KeyResponseData>;
+  /**
+   * Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
+   */
+  pagination?: Pagination | undefined;
+};
+
+/** @internal */
+export const V2ApisListKeysResponseBody$inboundSchema: z.ZodType<
+  V2ApisListKeysResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: z.array(KeyResponseData$inboundSchema),
+  pagination: Pagination$inboundSchema.optional(),
+});
+
+/** @internal */
+export type V2ApisListKeysResponseBody$Outbound = {
+  meta: Meta$Outbound;
+  data: Array<KeyResponseData$Outbound>;
+  pagination?: Pagination$Outbound | undefined;
+};
+
+/** @internal */
+export const V2ApisListKeysResponseBody$outboundSchema: z.ZodType<
+  V2ApisListKeysResponseBody$Outbound,
+  z.ZodTypeDef,
+  V2ApisListKeysResponseBody
+> = z.object({
+  meta: Meta$outboundSchema,
+  data: z.array(KeyResponseData$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 V2ApisListKeysResponseBody$ {
+  /** @deprecated use `V2ApisListKeysResponseBody$inboundSchema` instead. */
+  export const inboundSchema = V2ApisListKeysResponseBody$inboundSchema;
+  /** @deprecated use `V2ApisListKeysResponseBody$outboundSchema` instead. */
+  export const outboundSchema = V2ApisListKeysResponseBody$outboundSchema;
+  /** @deprecated use `V2ApisListKeysResponseBody$Outbound` instead. */
+  export type Outbound = V2ApisListKeysResponseBody$Outbound;
+}
+
+export function v2ApisListKeysResponseBodyToJSON(
+  v2ApisListKeysResponseBody: V2ApisListKeysResponseBody,
+): string {
+  return JSON.stringify(
+    V2ApisListKeysResponseBody$outboundSchema.parse(v2ApisListKeysResponseBody),
+  );
+}
+
+export function v2ApisListKeysResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2ApisListKeysResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2ApisListKeysResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2ApisListKeysResponseBody' from JSON`,
+  );
+}