tapimo 0.12.0 → 0.14.0

package/dist/apps/management/routes/api-keys.d.ts

@@ -36,6 +36,11 @@ export declare namespace schema {
         orgId: z.ZodMiniString<string>;
         projectId: z.ZodMiniString<string>;
     }, z.core.$strip>;
+    /** Path parameters addressing one organization-level API key. */
+    const OrgKeyParams: z.ZodMiniObject<{
+        keyId: z.ZodMiniString<string>;
+        orgId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
     /** Request body minting a key. The wildcard scope is not issuable here. */
     const CreateApiKeyRequest: z.ZodMiniObject<{
         allowedIps: z.ZodMiniOptional<z.ZodMiniReadonly<z.ZodMiniArray<z.ZodMiniString<string>>>>;
@@ -155,6 +160,28 @@ export declare namespace schema {
             id: z.ZodMiniString<string>;
         }, z.core.$strip>;
     }
+    /** Schemas for the rotateApiKey operation. */
+    namespace rotateApiKey {
+        /** The replacement key plus its one-time token. */
+        const Response: z.ZodMiniObject<{
+            allowedIps: z.ZodMiniReadonly<z.ZodMiniArray<z.ZodMiniString<string>>>;
+            createdAt: z.ZodMiniISODateTime;
+            createdBy: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            environment: z.ZodMiniEnum<{
+                production: "production";
+                sandbox: "sandbox";
+            }>;
+            expiresAt: z.ZodMiniOptional<z.ZodMiniISODateTime>;
+            id: z.ZodMiniString<string>;
+            lastUsedAt: z.ZodMiniOptional<z.ZodMiniISODateTime>;
+            name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            orgId: z.ZodMiniString<string>;
+            projectId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            scopes: z.ZodMiniArray<z.ZodMiniString<string>>;
+            tokenLast4: z.ZodMiniString<string>;
+            token: z.ZodMiniString<string>;
+        }, z.core.$strip>;
+    }
     /** Schemas for the updateApiKey operation. */
     namespace updateApiKey {
         /** Request body replacing or clearing a key's IP allowlist. */
@@ -243,7 +270,7 @@ export declare function apiKeys(options?: apiKeys.Options): import("hono/hono-ba
         } | {
             output: {
                 error: {
-                    code: "param_invalid";
+                    code: "body_invalid";
                     details?: readonly Response.error.Detail[] | undefined;
                     message: string;
                 };
@@ -267,7 +294,7 @@ export declare function apiKeys(options?: apiKeys.Options): import("hono/hono-ba
         } | {
             output: {
                 error: {
-                    code: "body_invalid";
+                    code: "param_invalid";
                     details?: readonly Response.error.Detail[] | undefined;
                     message: string;
                 };
@@ -852,8 +879,8 @@ export declare function apiKeys(options?: apiKeys.Options): import("hono/hono-ba
         };
     };
 } & {
-    "/v1/orgs/:orgId{org_[A-Za-z0-9_-]+}/projects/:projectId{prj_[A-Za-z0-9_-]+}/api-keys/:keyId{key_[A-Za-z0-9_-]+}": {
-        $patch: {
+    "/v1/orgs/:orgId{org_[A-Za-z0-9_-]+}/api-keys/:keyId{key_[A-Za-z0-9_-]+}/rotate": {
+        $post: {
             output: {
                 error: {
                     code: "api_key_malformed";
@@ -868,11 +895,6 @@ export declare function apiKeys(options?: apiKeys.Options): import("hono/hono-ba
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
-                };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
                 };
             };
         } | {
@@ -890,105 +912,142 @@ export declare function apiKeys(options?: apiKeys.Options): import("hono/hono-ba
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
-                };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
                 };
             };
         } | {
             output: {
                 error: {
-                    code: "api_key_forbidden" | "api_key_ip_forbidden";
+                    code: "upstream_error";
                     details?: readonly Response.error.Detail[] | undefined;
                     message: string;
                 };
                 requestId: string;
             };
             outputFormat: "json";
-            status: 403;
+            status: 502;
             input: {
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
-                };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
                 };
             };
         } | {
             output: {
                 error: {
-                    code: "payment_required" | "rate_limit_exceeded";
+                    code: "param_invalid";
                     details?: readonly Response.error.Detail[] | undefined;
                     message: string;
                 };
                 requestId: string;
             };
             outputFormat: "json";
-            status: 429;
+            status: 400;
             input: {
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
-                };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
                 };
             };
         } | {
             output: {
                 error: {
-                    code: "upstream_error";
+                    code: "forbidden";
                     details?: readonly Response.error.Detail[] | undefined;
                     message: string;
                 };
                 requestId: string;
             };
             outputFormat: "json";
-            status: 502;
+            status: 403;
             input: {
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
                 };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_keys_not_enabled";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
                 };
             };
         } | {
             output: {
                 error: {
-                    code: "param_invalid";
+                    code: "scope_not_issuable";
                     details?: readonly Response.error.Detail[] | undefined;
                     message: string;
                 };
                 requestId: string;
             };
             outputFormat: "json";
-            status: 400;
+            status: 403;
             input: {
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
                 };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
                 };
             };
         } | {
+            output: {
+                allowedIps: readonly string[];
+                createdAt: string;
+                createdBy?: string | undefined;
+                environment: "production" | "sandbox";
+                expiresAt?: string | undefined;
+                id: string;
+                lastUsedAt?: string | undefined;
+                name?: string | undefined;
+                orgId: string;
+                projectId?: string | undefined;
+                scopes: string[];
+                tokenLast4: string;
+                token: string;
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                };
+            };
+        };
+    };
+} & {
+    "/v1/orgs/:orgId{org_[A-Za-z0-9_-]+}/api-keys/:keyId{key_[A-Za-z0-9_-]+}": {
+        $delete: {
             output: {
                 error: {
-                    code: "body_invalid";
+                    code: "api_key_malformed";
                     details?: readonly Response.error.Detail[] | undefined;
                     message: string;
                 };
@@ -1000,17 +1059,29 @@ export declare function apiKeys(options?: apiKeys.Options): import("hono/hono-ba
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
                 };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
                 };
             };
         } | {
             output: {
                 error: {
-                    code: "forbidden";
+                    code: "api_key_forbidden" | "api_key_ip_forbidden";
                     details?: readonly Response.error.Detail[] | undefined;
                     message: string;
                 };
@@ -1022,33 +1093,74 @@ export declare function apiKeys(options?: apiKeys.Options): import("hono/hono-ba
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
                 };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
+            };
+        } | {
+            output: {
+                error: {
+                    code: "payment_required" | "rate_limit_exceeded";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 429;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
                 };
             };
         } | {
             output: {
                 error: {
-                    code: "organization_not_found" | "project_not_found";
+                    code: "upstream_error";
                     details?: readonly Response.error.Detail[] | undefined;
                     message: string;
                 };
                 requestId: string;
             };
             outputFormat: "json";
-            status: 404;
+            status: 502;
             input: {
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
                 };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
                 };
             };
         } | {
@@ -1066,11 +1178,6 @@ export declare function apiKeys(options?: apiKeys.Options): import("hono/hono-ba
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
-                };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
                 };
             };
         } | {
@@ -1088,27 +1195,11 @@ export declare function apiKeys(options?: apiKeys.Options): import("hono/hono-ba
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
-                };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
                 };
             };
         } | {
             output: {
-                allowedIps: readonly string[];
-                createdAt: string;
-                createdBy?: string | undefined;
-                environment: "production" | "sandbox";
-                expiresAt?: string | undefined;
                 id: string;
-                lastUsedAt?: string | undefined;
-                name?: string | undefined;
-                orgId: string;
-                projectId?: string | undefined;
-                scopes: string[];
-                tokenLast4: string;
             };
             outputFormat: "json";
             status: 200;
@@ -1116,11 +1207,471 @@ export declare function apiKeys(options?: apiKeys.Options): import("hono/hono-ba
                 param: {
                     keyId: string;
                     orgId: string;
-                    projectId: string;
                 };
-            } & {
-                json: {
-                    allowedIps: readonly string[];
+            };
+        };
+    };
+} & {
+    "/v1/orgs/:orgId{org_[A-Za-z0-9_-]+}/projects/:projectId{prj_[A-Za-z0-9_-]+}/api-keys/:keyId{key_[A-Za-z0-9_-]+}": {
+        $patch: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_forbidden" | "api_key_ip_forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "payment_required" | "rate_limit_exceeded";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 429;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "body_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "organization_not_found" | "project_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_keys_not_enabled";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        } | {
+            output: {
+                allowedIps: readonly string[];
+                createdAt: string;
+                createdBy?: string | undefined;
+                environment: "production" | "sandbox";
+                expiresAt?: string | undefined;
+                id: string;
+                lastUsedAt?: string | undefined;
+                name?: string | undefined;
+                orgId: string;
+                projectId?: string | undefined;
+                scopes: string[];
+                tokenLast4: string;
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            } & {
+                json: {
+                    allowedIps: readonly string[];
+                };
+            };
+        };
+    };
+} & {
+    "/v1/orgs/:orgId{org_[A-Za-z0-9_-]+}/projects/:projectId{prj_[A-Za-z0-9_-]+}/api-keys/:keyId{key_[A-Za-z0-9_-]+}/rotate": {
+        $post: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "organization_not_found" | "project_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_keys_not_enabled";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "scope_not_issuable";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
+                };
+            };
+        } | {
+            output: {
+                allowedIps: readonly string[];
+                createdAt: string;
+                createdBy?: string | undefined;
+                environment: "production" | "sandbox";
+                expiresAt?: string | undefined;
+                id: string;
+                lastUsedAt?: string | undefined;
+                name?: string | undefined;
+                orgId: string;
+                projectId?: string | undefined;
+                scopes: string[];
+                tokenLast4: string;
+                token: string;
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    keyId: string;
+                    orgId: string;
+                    projectId: string;
                 };
             };
         };