@unkey/api 2.2.0 → 2.3.0

package/src/funcs/internalGetDeployment.ts

@@ -0,0 +1,201 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { UnkeyCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { UnkeyError } from "../models/errors/unkeyerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function internalGetDeployment(
+  client: UnkeyCore,
+  request: components.V2DeployGetDeploymentRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.V2DeployGetDeploymentResponseBody,
+    | errors.BadRequestErrorResponse
+    | errors.UnauthorizedErrorResponse
+    | errors.ForbiddenErrorResponse
+    | errors.NotFoundErrorResponse
+    | errors.InternalServerErrorResponse
+    | UnkeyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: UnkeyCore,
+  request: components.V2DeployGetDeploymentRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.V2DeployGetDeploymentResponseBody,
+      | errors.BadRequestErrorResponse
+      | errors.UnauthorizedErrorResponse
+      | errors.ForbiddenErrorResponse
+      | errors.NotFoundErrorResponse
+      | errors.InternalServerErrorResponse
+      | UnkeyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.V2DeployGetDeploymentRequestBody$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/deploy.getDeployment")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.rootKey);
+  const securityInput = secConfig == null ? {} : { rootKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "deploy.getDeployment",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.rootKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 50,
+          maxInterval: 1000,
+          exponent: 1.5,
+          maxElapsedTime: 10000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.V2DeployGetDeploymentResponseBody,
+    | errors.BadRequestErrorResponse
+    | errors.UnauthorizedErrorResponse
+    | errors.ForbiddenErrorResponse
+    | errors.NotFoundErrorResponse
+    | errors.InternalServerErrorResponse
+    | UnkeyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.V2DeployGetDeploymentResponseBody$inboundSchema),
+    M.jsonErr(400, errors.BadRequestErrorResponse$inboundSchema),
+    M.jsonErr(401, errors.UnauthorizedErrorResponse$inboundSchema),
+    M.jsonErr(403, errors.ForbiddenErrorResponse$inboundSchema),
+    M.jsonErr(404, errors.NotFoundErrorResponse$inboundSchema),
+    M.jsonErr(500, errors.InternalServerErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/keysAddPermissions.ts

@@ -125,7 +125,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "addPermissions",
+    operationID: "keys.addPermissions",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysAddRoles.ts

@@ -124,7 +124,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "addRoles",
+    operationID: "keys.addRoles",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysCreateKey.ts

@@ -126,7 +126,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "createKey",
+    operationID: "keys.createKey",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysDeleteKey.ts

@@ -121,7 +121,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "deleteKey",
+    operationID: "keys.deleteKey",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysGetKey.ts

@@ -123,7 +123,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getKey",
+    operationID: "keys.getKey",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysMigrateKeys.ts

@@ -116,7 +116,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "migrateKeys",
+    operationID: "keys.migrateKeys",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysRemovePermissions.ts

@@ -125,7 +125,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "removePermissions",
+    operationID: "keys.removePermissions",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysRemoveRoles.ts

@@ -125,7 +125,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "removeRoles",
+    operationID: "keys.removeRoles",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysRerollKey.ts

@@ -142,7 +142,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "rerollKey",
+    operationID: "keys.rerollKey",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysSetPermissions.ts

@@ -125,7 +125,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "setPermissions",
+    operationID: "keys.setPermissions",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysSetRoles.ts

@@ -124,7 +124,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "setRoles",
+    operationID: "keys.setRoles",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysUpdateCredits.ts

@@ -125,7 +125,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "updateCredits",
+    operationID: "keys.updateCredits",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysUpdateKey.ts

@@ -125,7 +125,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "updateKey",
+    operationID: "keys.updateKey",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysVerifyKey.ts

@@ -46,7 +46,7 @@ import { Result } from "../types/fp.js";
  * - `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.
  */
 export function keysVerifyKey(
   client: UnkeyCore,
@@ -128,7 +128,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "verifyKey",
+    operationID: "keys.verifyKey",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/keysWhoami.ts

@@ -118,7 +118,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "whoami",
+    operationID: "keys.whoami",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/permissionsCreatePermission.ts

@@ -122,7 +122,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "createPermission",
+    operationID: "permissions.createPermission",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/permissionsCreateRole.ts

@@ -118,7 +118,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "createRole",
+    operationID: "permissions.createRole",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/permissionsDeletePermission.ts

@@ -120,7 +120,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "deletePermission",
+    operationID: "permissions.deletePermission",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/permissionsDeleteRole.ts

@@ -116,7 +116,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "deleteRole",
+    operationID: "permissions.deleteRole",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/permissionsGetPermission.ts

@@ -118,7 +118,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getPermission",
+    operationID: "permissions.getPermission",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/permissionsGetRole.ts

@@ -116,7 +116,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getRole",
+    operationID: "permissions.getRole",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/permissionsListPermissions.ts

@@ -117,7 +117,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "listPermissions",
+    operationID: "permissions.listPermissions",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/permissionsListRoles.ts

@@ -117,7 +117,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "listRoles",
+    operationID: "permissions.listRoles",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/lib/config.ts

@@ -58,7 +58,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0.0",
-  sdkVersion: "2.2.0",
-  genVersion: "2.768.1",
-  userAgent: "speakeasy-sdk/typescript 2.2.0 2.768.1 2.0.0 @unkey/api",
+  sdkVersion: "2.3.0",
+  genVersion: "2.816.0",
+  userAgent: "speakeasy-sdk/typescript 2.3.0 2.816.0 2.0.0 @unkey/api",
 } as const;

package/src/lib/sdks.ts

@@ -308,9 +308,9 @@ export class ClientSDK {
   }
 }
 
-const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/;
+const jsonLikeContentTypeRE = /^(application|text)\/([^+]+\+)*json.*/;
 const jsonlLikeContentTypeRE =
-  /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/;
+  /^(application|text)\/([^+]+\+)*(jsonl|x-ndjson)\b.*/;
 async function logRequest(logger: Logger | undefined, req: Request) {
   if (!logger) {
     return;

package/src/models/components/index.ts

@@ -33,6 +33,14 @@ export * from "./v2apisgetapiresponsebody.js";
 export * from "./v2apisgetapiresponsedata.js";
 export * from "./v2apislistkeysrequestbody.js";
 export * from "./v2apislistkeysresponsebody.js";
+export * from "./v2deploycreatedeploymentrequestbody.js";
+export * from "./v2deploycreatedeploymentresponsebody.js";
+export * from "./v2deploycreatedeploymentresponsedata.js";
+export * from "./v2deploydeploymentstep.js";
+export * from "./v2deploygetdeploymentrequestbody.js";
+export * from "./v2deploygetdeploymentresponsebody.js";
+export * from "./v2deploygetdeploymentresponsedata.js";
+export * from "./v2deploygitcommit.js";
 export * from "./v2identitiescreateidentityrequestbody.js";
 export * from "./v2identitiescreateidentityresponsebody.js";
 export * from "./v2identitiescreateidentityresponsedata.js";

package/src/models/components/keycreditsrefill.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";
 
@@ -18,7 +19,7 @@ export const KeyCreditsRefillInterval = {
 /**
  * How often credits are automatically refilled.
  */
-export type KeyCreditsRefillInterval = ClosedEnum<
+export type KeyCreditsRefillInterval = OpenEnum<
   typeof KeyCreditsRefillInterval
 >;
 
@@ -45,13 +46,17 @@ export type KeyCreditsRefill = {
 };
 
 /** @internal */
-export const KeyCreditsRefillInterval$inboundSchema: z.ZodNativeEnum<
-  typeof KeyCreditsRefillInterval
-> = z.nativeEnum(KeyCreditsRefillInterval);
+export const KeyCreditsRefillInterval$inboundSchema: z.ZodType<
+  KeyCreditsRefillInterval,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(KeyCreditsRefillInterval);
 /** @internal */
-export const KeyCreditsRefillInterval$outboundSchema: z.ZodNativeEnum<
-  typeof KeyCreditsRefillInterval
-> = KeyCreditsRefillInterval$inboundSchema;
+export const KeyCreditsRefillInterval$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  KeyCreditsRefillInterval
+> = openEnums.outboundSchema(KeyCreditsRefillInterval);
 
 /** @internal */
 export const KeyCreditsRefill$inboundSchema: z.ZodType<

package/src/models/components/updatekeycreditsrefill.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";
 
 /**
  * How often credits are automatically refilled.
@@ -15,7 +16,7 @@ export const UpdateKeyCreditsRefillInterval = {
 /**
  * How often credits are automatically refilled.
  */
-export type UpdateKeyCreditsRefillInterval = ClosedEnum<
+export type UpdateKeyCreditsRefillInterval = OpenEnum<
   typeof UpdateKeyCreditsRefillInterval
 >;
 
@@ -42,9 +43,11 @@ export type UpdateKeyCreditsRefill = {
 };
 
 /** @internal */
-export const UpdateKeyCreditsRefillInterval$outboundSchema: z.ZodNativeEnum<
-  typeof UpdateKeyCreditsRefillInterval
-> = z.nativeEnum(UpdateKeyCreditsRefillInterval);
+export const UpdateKeyCreditsRefillInterval$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  UpdateKeyCreditsRefillInterval
+> = openEnums.outboundSchema(UpdateKeyCreditsRefillInterval);
 
 /** @internal */
 export type UpdateKeyCreditsRefill$Outbound = {

package/src/models/components/v2deploycreatedeploymentrequestbody.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  V2DeployGitCommit,
+  V2DeployGitCommit$Outbound,
+  V2DeployGitCommit$outboundSchema,
+} from "./v2deploygitcommit.js";
+
+/**
+ * Create a deployment from a pre-built Docker image
+ */
+export type V2DeployCreateDeploymentRequestBody = {
+  /**
+   * Unkey project ID
+   */
+  projectId: string;
+  /**
+   * Optional keyspace ID for authentication context
+   */
+  keyspaceId?: string | undefined;
+  /**
+   * Git branch name
+   */
+  branch: string;
+  /**
+   * Environment slug (e.g., "production", "staging")
+   */
+  environmentSlug: string;
+  /**
+   * Docker image reference to deploy
+   */
+  dockerImage: string;
+  /**
+   * Optional git commit information
+   */
+  gitCommit?: V2DeployGitCommit | undefined;
+};
+
+/** @internal */
+export type V2DeployCreateDeploymentRequestBody$Outbound = {
+  projectId: string;
+  keyspaceId?: string | undefined;
+  branch: string;
+  environmentSlug: string;
+  dockerImage: string;
+  gitCommit?: V2DeployGitCommit$Outbound | undefined;
+};
+
+/** @internal */
+export const V2DeployCreateDeploymentRequestBody$outboundSchema: z.ZodType<
+  V2DeployCreateDeploymentRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2DeployCreateDeploymentRequestBody
+> = z.object({
+  projectId: z.string(),
+  keyspaceId: z.string().optional(),
+  branch: z.string(),
+  environmentSlug: z.string(),
+  dockerImage: z.string(),
+  gitCommit: V2DeployGitCommit$outboundSchema.optional(),
+});
+
+export function v2DeployCreateDeploymentRequestBodyToJSON(
+  v2DeployCreateDeploymentRequestBody: V2DeployCreateDeploymentRequestBody,
+): string {
+  return JSON.stringify(
+    V2DeployCreateDeploymentRequestBody$outboundSchema.parse(
+      v2DeployCreateDeploymentRequestBody,
+    ),
+  );
+}