@unkey/api 2.2.0 → 2.3.0

package/src/models/components/v2deploycreatedeploymentresponsebody.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Meta, Meta$inboundSchema } from "./meta.js";
+import {
+  V2DeployCreateDeploymentResponseData,
+  V2DeployCreateDeploymentResponseData$inboundSchema,
+} from "./v2deploycreatedeploymentresponsedata.js";
+
+export type V2DeployCreateDeploymentResponseBody = {
+  /**
+   * 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: V2DeployCreateDeploymentResponseData;
+};
+
+/** @internal */
+export const V2DeployCreateDeploymentResponseBody$inboundSchema: z.ZodType<
+  V2DeployCreateDeploymentResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: V2DeployCreateDeploymentResponseData$inboundSchema,
+});
+
+export function v2DeployCreateDeploymentResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2DeployCreateDeploymentResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V2DeployCreateDeploymentResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2DeployCreateDeploymentResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2deploycreatedeploymentresponsedata.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V2DeployCreateDeploymentResponseData = {
+  /**
+   * Unique deployment identifier
+   */
+  deploymentId: string;
+};
+
+/** @internal */
+export const V2DeployCreateDeploymentResponseData$inboundSchema: z.ZodType<
+  V2DeployCreateDeploymentResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  deploymentId: z.string(),
+});
+
+export function v2DeployCreateDeploymentResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<V2DeployCreateDeploymentResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V2DeployCreateDeploymentResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2DeployCreateDeploymentResponseData' from JSON`,
+  );
+}

package/src/models/components/v2deploydeploymentstep.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V2DeployDeploymentStep = {
+  /**
+   * Step status
+   */
+  status?: string | undefined;
+  /**
+   * Step message
+   */
+  message?: string | undefined;
+  /**
+   * Error message if step failed
+   */
+  errorMessage?: string | undefined;
+  /**
+   * Unix timestamp in milliseconds
+   */
+  createdAt?: number | undefined;
+};
+
+/** @internal */
+export const V2DeployDeploymentStep$inboundSchema: z.ZodType<
+  V2DeployDeploymentStep,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: z.string().optional(),
+  message: z.string().optional(),
+  errorMessage: z.string().optional(),
+  createdAt: z.number().int().optional(),
+});
+
+export function v2DeployDeploymentStepFromJSON(
+  jsonString: string,
+): SafeParseResult<V2DeployDeploymentStep, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2DeployDeploymentStep$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2DeployDeploymentStep' from JSON`,
+  );
+}

package/src/models/components/v2deploygetdeploymentrequestbody.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type V2DeployGetDeploymentRequestBody = {
+  /**
+   * Unique deployment identifier to retrieve
+   */
+  deploymentId: string;
+};
+
+/** @internal */
+export type V2DeployGetDeploymentRequestBody$Outbound = {
+  deploymentId: string;
+};
+
+/** @internal */
+export const V2DeployGetDeploymentRequestBody$outboundSchema: z.ZodType<
+  V2DeployGetDeploymentRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2DeployGetDeploymentRequestBody
+> = z.object({
+  deploymentId: z.string(),
+});
+
+export function v2DeployGetDeploymentRequestBodyToJSON(
+  v2DeployGetDeploymentRequestBody: V2DeployGetDeploymentRequestBody,
+): string {
+  return JSON.stringify(
+    V2DeployGetDeploymentRequestBody$outboundSchema.parse(
+      v2DeployGetDeploymentRequestBody,
+    ),
+  );
+}

package/src/models/components/v2deploygetdeploymentresponsebody.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Meta, Meta$inboundSchema } from "./meta.js";
+import {
+  V2DeployGetDeploymentResponseData,
+  V2DeployGetDeploymentResponseData$inboundSchema,
+} from "./v2deploygetdeploymentresponsedata.js";
+
+export type V2DeployGetDeploymentResponseBody = {
+  /**
+   * 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: V2DeployGetDeploymentResponseData;
+};
+
+/** @internal */
+export const V2DeployGetDeploymentResponseBody$inboundSchema: z.ZodType<
+  V2DeployGetDeploymentResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: V2DeployGetDeploymentResponseData$inboundSchema,
+});
+
+export function v2DeployGetDeploymentResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2DeployGetDeploymentResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2DeployGetDeploymentResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2DeployGetDeploymentResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2deploygetdeploymentresponsedata.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  V2DeployDeploymentStep,
+  V2DeployDeploymentStep$inboundSchema,
+} from "./v2deploydeploymentstep.js";
+
+/**
+ * Current deployment status
+ */
+export const Status = {
+  Unspecified: "UNSPECIFIED",
+  Pending: "PENDING",
+  Building: "BUILDING",
+  Deploying: "DEPLOYING",
+  Network: "NETWORK",
+  Ready: "READY",
+  Failed: "FAILED",
+} as const;
+/**
+ * Current deployment status
+ */
+export type Status = OpenEnum<typeof Status>;
+
+export type V2DeployGetDeploymentResponseData = {
+  /**
+   * Unique deployment identifier
+   */
+  id: string;
+  /**
+   * Current deployment status
+   */
+  status: Status;
+  /**
+   * Error message if deployment failed
+   */
+  errorMessage?: string | undefined;
+  /**
+   * Hostnames associated with this deployment
+   */
+  hostnames?: Array<string> | undefined;
+  /**
+   * Deployment steps with status and messages
+   */
+  steps?: Array<V2DeployDeploymentStep> | undefined;
+};
+
+/** @internal */
+export const Status$inboundSchema: z.ZodType<Status, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Status);
+
+/** @internal */
+export const V2DeployGetDeploymentResponseData$inboundSchema: z.ZodType<
+  V2DeployGetDeploymentResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  status: Status$inboundSchema,
+  errorMessage: z.string().optional(),
+  hostnames: z.array(z.string()).optional(),
+  steps: z.array(V2DeployDeploymentStep$inboundSchema).optional(),
+});
+
+export function v2DeployGetDeploymentResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<V2DeployGetDeploymentResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2DeployGetDeploymentResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2DeployGetDeploymentResponseData' from JSON`,
+  );
+}

package/src/models/components/v2deploygitcommit.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Optional git commit information
+ */
+export type V2DeployGitCommit = {
+  /**
+   * Git commit SHA
+   */
+  commitSha?: string | undefined;
+  /**
+   * Git commit message
+   */
+  commitMessage?: string | undefined;
+  /**
+   * Git author handle/username
+   */
+  authorHandle?: string | undefined;
+  /**
+   * Git author avatar URL
+   */
+  authorAvatarUrl?: string | undefined;
+  /**
+   * Commit timestamp in milliseconds
+   */
+  timestamp?: number | undefined;
+};
+
+/** @internal */
+export type V2DeployGitCommit$Outbound = {
+  commitSha?: string | undefined;
+  commitMessage?: string | undefined;
+  authorHandle?: string | undefined;
+  authorAvatarUrl?: string | undefined;
+  timestamp?: number | undefined;
+};
+
+/** @internal */
+export const V2DeployGitCommit$outboundSchema: z.ZodType<
+  V2DeployGitCommit$Outbound,
+  z.ZodTypeDef,
+  V2DeployGitCommit
+> = z.object({
+  commitSha: z.string().optional(),
+  commitMessage: z.string().optional(),
+  authorHandle: z.string().optional(),
+  authorAvatarUrl: z.string().optional(),
+  timestamp: z.number().int().optional(),
+});
+
+export function v2DeployGitCommitToJSON(
+  v2DeployGitCommit: V2DeployGitCommit,
+): string {
+  return JSON.stringify(
+    V2DeployGitCommit$outboundSchema.parse(v2DeployGitCommit),
+  );
+}

package/src/models/components/v2keysupdatecreditsrequestbody.ts

@@ -3,7 +3,8 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../../types/enums.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 
 /**
  * Defines how to modify the key's remaining credits. Use 'set' to replace current credits with a specific value or unlimited usage, 'increment' to add credits for plan upgrades or credit purchases, and 'decrement' to reduce credits for refunds or policy violations.
@@ -20,7 +21,7 @@ export const Operation = {
  *
  * @remarks
  */
-export type Operation = ClosedEnum<typeof Operation>;
+export type Operation = OpenEnum<typeof Operation>;
 
 export type V2KeysUpdateCreditsRequestBody = {
   /**
@@ -32,7 +33,7 @@ export type V2KeysUpdateCreditsRequestBody = {
    *
    * @remarks
    *
-   * Set to null when using 'set' operation to make the key unlimited (removes usage restrictions entirely). When decrementing, if the result would be negative, remaining credits are automatically set to zero. Credits are consumed during successful key verification, and when credits reach zero, verification fails with `code=INSUFFICIENT_CREDITS`.
+   * Set to null when using 'set' operation to make the key unlimited (removes usage restrictions entirely). When decrementing, if the result would be negative, remaining credits are automatically set to zero. Credits are consumed during successful key verification, and when credits reach zero, verification fails with `code=USAGE_EXCEEDED`.
    *
    * Required when using 'increment' or 'decrement' operations. Optional for 'set' operation (null creates unlimited usage).
    */
@@ -46,8 +47,11 @@ export type V2KeysUpdateCreditsRequestBody = {
 };
 
 /** @internal */
-export const Operation$outboundSchema: z.ZodNativeEnum<typeof Operation> = z
-  .nativeEnum(Operation);
+export const Operation$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  Operation
+> = openEnums.outboundSchema(Operation);
 
 /** @internal */
 export type V2KeysUpdateCreditsRequestBody$Outbound = {

package/src/models/components/v2keysverifykeyresponsedata.ts

@@ -4,7 +4,8 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Identity, Identity$inboundSchema } from "./identity.js";
@@ -19,8 +20,7 @@ import {
  * @remarks
  * or failure reason. Values: `VALID` (key is valid and passed all checks), `NOT_FOUND` (key doesn't
  * exist or belongs to wrong API), `FORBIDDEN` (key lacks required permissions), `INSUFFICIENT_PERMISSIONS`
- * (key lacks specific required permissions for this request), `INSUFFICIENT_CREDITS`
- * (key has no remaining credits), `USAGE_EXCEEDED` (key exceeded usage limits), `RATE_LIMITED` (key exceeded rate limits), `DISABLED` (key was explicitly disabled),
+ * (key lacks specific required permissions for this request), `USAGE_EXCEEDED` (key has no remaining credits), `RATE_LIMITED` (key exceeded rate limits), `DISABLED` (key was explicitly disabled),
  * `EXPIRED` (key has passed its expiration date).
  */
 export const Code = {
@@ -28,7 +28,6 @@ export const Code = {
   NotFound: "NOT_FOUND",
   Forbidden: "FORBIDDEN",
   InsufficientPermissions: "INSUFFICIENT_PERMISSIONS",
-  InsufficientCredits: "INSUFFICIENT_CREDITS",
   UsageExceeded: "USAGE_EXCEEDED",
   RateLimited: "RATE_LIMITED",
   Disabled: "DISABLED",
@@ -40,11 +39,10 @@ export const Code = {
  * @remarks
  * or failure reason. Values: `VALID` (key is valid and passed all checks), `NOT_FOUND` (key doesn't
  * exist or belongs to wrong API), `FORBIDDEN` (key lacks required permissions), `INSUFFICIENT_PERMISSIONS`
- * (key lacks specific required permissions for this request), `INSUFFICIENT_CREDITS`
- * (key has no remaining credits), `USAGE_EXCEEDED` (key exceeded usage limits), `RATE_LIMITED` (key exceeded rate limits), `DISABLED` (key was explicitly disabled),
+ * (key lacks specific required permissions for this request), `USAGE_EXCEEDED` (key has no remaining credits), `RATE_LIMITED` (key exceeded rate limits), `DISABLED` (key was explicitly disabled),
  * `EXPIRED` (key has passed its expiration date).
  */
-export type Code = ClosedEnum<typeof Code>;
+export type Code = OpenEnum<typeof Code>;
 
 export type V2KeysVerifyKeyResponseData = {
   /**
@@ -61,8 +59,7 @@ export type V2KeysVerifyKeyResponseData = {
    * @remarks
    * or failure reason. Values: `VALID` (key is valid and passed all checks), `NOT_FOUND` (key doesn't
    * exist or belongs to wrong API), `FORBIDDEN` (key lacks required permissions), `INSUFFICIENT_PERMISSIONS`
-   * (key lacks specific required permissions for this request), `INSUFFICIENT_CREDITS`
-   * (key has no remaining credits), `USAGE_EXCEEDED` (key exceeded usage limits), `RATE_LIMITED` (key exceeded rate limits), `DISABLED` (key was explicitly disabled),
+   * (key lacks specific required permissions for this request), `USAGE_EXCEEDED` (key has no remaining credits), `RATE_LIMITED` (key exceeded rate limits), `DISABLED` (key was explicitly disabled),
    * `EXPIRED` (key has passed its expiration date).
    */
   code: Code;
@@ -139,9 +136,8 @@ export type V2KeysVerifyKeyResponseData = {
 };
 
 /** @internal */
-export const Code$inboundSchema: z.ZodNativeEnum<typeof Code> = z.nativeEnum(
-  Code,
-);
+export const Code$inboundSchema: z.ZodType<Code, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Code);
 
 /** @internal */
 export const V2KeysVerifyKeyResponseData$inboundSchema: z.ZodType<

package/src/sdk/internal.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { internalCreateDeployment } from "../funcs/internalCreateDeployment.js";
+import { internalGetDeployment } from "../funcs/internalGetDeployment.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Internal extends ClientSDK {
+  /**
+   * Create deployment
+   *
+   * @remarks
+   * **INTERNAL** - This endpoint is internal and may change without notice.
+   * Not recommended for production use.
+   *
+   * Creates a new deployment for a project using either a pre-built Docker image or build context.
+   *
+   * **Authentication**: Requires a valid root key with appropriate permissions.
+   */
+  async createDeployment(
+    request: components.V2DeployCreateDeploymentRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2DeployCreateDeploymentResponseBody> {
+    return unwrapAsync(internalCreateDeployment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get deployment
+   *
+   * @remarks
+   * **INTERNAL** - This endpoint is internal and may change without notice.
+   * Not recommended for production use.
+   *
+   * Retrieves deployment information including status, error messages, and steps.
+   *
+   * **Authentication**: Requires a valid root key with appropriate permissions.
+   */
+  async getDeployment(
+    request: components.V2DeployGetDeploymentRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2DeployGetDeploymentResponseBody> {
+    return unwrapAsync(internalGetDeployment(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/keys.ts

@@ -450,7 +450,7 @@ export class Keys extends ClientSDK {
    * - `api.*.verify_key` (verify keys in any API)
    * - `api.<api_id>.verify_key` (verify keys in specific API)
    *
-   * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+   * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
    */
   async verifyKey(
     request: components.V2KeysVerifyKeyRequestBody,

package/src/sdk/sdk.ts

@@ -6,6 +6,7 @@ import { ClientSDK } from "../lib/sdks.js";
 import { Analytics } from "./analytics.js";
 import { Apis } from "./apis.js";
 import { Identities } from "./identities.js";
+import { Internal } from "./internal.js";
 import { Keys } from "./keys.js";
 import { Permissions } from "./permissions.js";
 import { Ratelimit } from "./ratelimit.js";
@@ -21,6 +22,11 @@ export class Unkey extends ClientSDK {
     return (this._apis ??= new Apis(this._options));
   }
 
+  private _internal?: Internal;
+  get internal(): Internal {
+    return (this._internal ??= new Internal(this._options));
+  }
+
   private _identities?: Identities;
   get identities(): Identities {
     return (this._identities ??= new Identities(this._options));