primitive-admin 1.0.49 → 1.0.51

package/dist/src/lib/api-client.d.ts

@@ -0,0 +1,1229 @@
+export declare class ApiError extends Error {
+    statusCode: number;
+    code?: string;
+    /**
+     * Structured `details` payload from `corsErrorResponse`.
+     *
+     * The server's error envelope can emit `details` as either:
+     *   - an array of validation issues (e.g. `[{ path, message }, ...]`) —
+     *     this is what most legacy endpoints produce, and what sync.ts walks
+     *     via `Array.isArray(err.details)` / `for (const detail of ...)`.
+     *   - a record of structured offender fields (e.g. `{ refs, operations,
+     *     opCount, line, column, ... }`) — emitted by the issue #666 schema
+     *     gate and consumed by the typed exception subclasses below.
+     *
+     * Callers must narrow before use: `Array.isArray(err.details)` for the
+     * legacy shape, otherwise treat as `Record<string, any>`.
+     */
+    details?: unknown[] | Record<string, any>;
+    constructor(message: string, statusCode: number, code?: string, details?: unknown[] | Record<string, any>);
+}
+export declare class ConflictError extends ApiError {
+    serverModifiedAt: string;
+    expectedModifiedAt: string;
+    constructor(message: string, serverModifiedAt: string, expectedModifiedAt: string, details?: Record<string, any>);
+}
+/**
+ * Parsed shape of a non-OK HTTP response body.
+ *
+ * The server's standard error envelope (corsErrorResponse, `src/utils.ts:348`)
+ * writes the message to `error`. A handful of bespoke endpoints (ConflictError,
+ * integrations proxy) use `message`. This helper reads both fields so all CLI
+ * call sites surface the real server message instead of `HTTP <status>`.
+ *
+ * `htmlNotFound` is set when the body looks like an HTML 404 page (typically
+ * served when an API path is wrong); callers can use it to throw a clearer
+ * "API endpoint not found" message regardless of the original status code.
+ *
+ * `details` can be either an array (legacy validation-issue list) or a
+ * structured record (issue #666 schema gate); the schema-feature errors
+ * below need the record shape, while the legacy `for (const detail of ...)`
+ * walkers in sync.ts assume the array shape.
+ */
+export interface ParsedErrorResponse {
+    message: string;
+    code?: string;
+    details?: unknown[] | Record<string, any>;
+    /** True when the response body is an HTML error page (e.g. wrong API path). */
+    htmlNotFound?: boolean;
+    /** Raw parsed JSON envelope (or `undefined` for non-JSON bodies). */
+    raw?: any;
+}
+/**
+ * Extract a human-readable error message + structured fields from a non-OK
+ * HTTP response body. Single source of truth used by every error-handler call
+ * site in this file (see issue #684).
+ */
+export declare function parseErrorResponse(response: {
+    status: number;
+}, text: string, path?: string): ParsedErrorResponse;
+/**
+ * Typed exception classes for the database-schema feature (issue #666).
+ * Each maps 1:1 to a server `code` value emitted from the op-edit or
+ * schema-edit gate. They all extend ApiError so existing catch-all paths
+ * continue to work; specialized catch blocks can branch on `instanceof`.
+ *
+ * Per round-2 addendum A1, `details` is always preserved so callers can
+ * extract structured offender lists (refs[], operations[], etc.).
+ */
+export declare class SchemaRequiredError extends ApiError {
+    constructor(message: string, details?: Record<string, any>);
+}
+export declare class OperationRefError extends ApiError {
+    constructor(message: string, details?: Record<string, any>);
+    get refs(): Array<{
+        ref: string;
+        location: string;
+    }>;
+}
+export declare class SchemaBreaksOpsError extends ApiError {
+    constructor(message: string, details?: Record<string, any>);
+    get operations(): Array<{
+        operation: string;
+        refs: Array<{
+            ref: string;
+            location: string;
+        }>;
+    }>;
+}
+export declare class SchemaHasUncheckableOpsError extends ApiError {
+    constructor(message: string, details?: Record<string, any>);
+    get operations(): Array<{
+        operation: string;
+        locations: string[];
+    }>;
+}
+export declare class TomlParseError extends ApiError {
+    constructor(message: string, details?: Record<string, any>);
+    get line(): number | undefined;
+    get column(): number | undefined;
+}
+export declare class OpsExistError extends ApiError {
+    constructor(message: string, details?: Record<string, any>);
+    get opCount(): number;
+}
+interface EmailTemplateSummary {
+    emailType: string;
+    label: string;
+    description: string;
+    hasOverride: boolean;
+    modifiedAt: string | null;
+}
+interface EmailTemplateDetail {
+    emailType: string;
+    label: string;
+    description: string;
+    hasOverride: boolean;
+    override: {
+        templateId: string;
+        subject: string;
+        htmlBody: string;
+        textBody: string;
+        createdAt: string;
+        modifiedAt: string;
+    } | null;
+    default: {
+        subject: string;
+        htmlBody: string;
+        textBody: string;
+    };
+    variables: {
+        name: string;
+        required: boolean;
+        description: string;
+    }[];
+}
+interface EmailTemplateUpsertResult {
+    emailType: string;
+    templateId: string;
+    subject: string;
+    htmlBody: string;
+    textBody: string;
+    createdAt: string;
+    modifiedAt: string;
+    warnings: string[];
+}
+interface AnalyticsTiming {
+    total_ms: number;
+    wae_queries: number[];
+}
+interface AnalyticsMetricResponse {
+    value: number;
+    previous: number;
+    deltaPct: number;
+    _timing: AnalyticsTiming;
+}
+interface AnalyticsGrowthResponse {
+    window_days: number;
+    retained_users: number;
+    new_users: number;
+    reactivated_users: number;
+    churned_users: number;
+    current_active: number;
+    previous_active: number;
+    deltaPct: number;
+    _timing: AnalyticsTiming;
+}
+interface AnalyticsDailyActivePoint {
+    day_ts: number;
+    day_label: string;
+    active_users: number;
+}
+interface AnalyticsDailyActiveResponse {
+    window_days: number;
+    rows: AnalyticsDailyActivePoint[];
+    _timing: AnalyticsTiming;
+}
+interface AnalyticsCohortRow {
+    signup_week: number;
+    signup_week_label: string;
+    cohort_size: number;
+    retention: (number | null)[];
+}
+interface AnalyticsCohortResponse {
+    weeks: number[];
+    rows: AnalyticsCohortRow[];
+    averages: (number | null)[];
+    _timing: AnalyticsTiming;
+}
+interface AnalyticsUserSummary {
+    userUlid: string;
+    email: string | null;
+    name: string | null;
+    firstSeen: string;
+    lastSeen: string;
+    eventCount: number;
+}
+interface AnalyticsTopUsersResponse {
+    windowDays: number;
+    limit: number;
+    results: AnalyticsUserSummary[];
+    _timing: AnalyticsTiming;
+}
+interface AnalyticsUserSearchResponse {
+    query: string;
+    limit: number;
+    results: AnalyticsUserSummary[];
+}
+interface AnalyticsUserDetailResponse {
+    user: {
+        user_ulid: string;
+        email: string | null;
+        name: string | null;
+    };
+    stats: {
+        first_seen: string | null;
+        last_active: string | null;
+        total_events: number;
+        days_active: number;
+    };
+    events_by_action: Array<{
+        action: string;
+        event_count: number;
+        last_occurred: string;
+    }>;
+    events_by_feature: Array<{
+        feature: string;
+        event_count: number;
+        pct: number;
+    }>;
+    _timing: AnalyticsTiming;
+}
+interface AnalyticsUserSnapshotResponse {
+    snapshot: {
+        timestamp: string;
+        values: unknown;
+    } | null;
+    _timing: AnalyticsTiming;
+}
+interface AnalyticsEventRow {
+    timestamp: string;
+    user_ulid: string;
+    action: string;
+    feature: string;
+    route: string;
+    country: string;
+}
+interface AnalyticsEventsResponse {
+    page: number;
+    page_size: number;
+    total_rows: number;
+    rows: AnalyticsEventRow[];
+    _timing: AnalyticsTiming;
+}
+interface AnalyticsGroupedRow {
+    group_value: string;
+    raw_group_value: string;
+    events: number;
+    unique_users: number;
+}
+interface AnalyticsEventsGroupedResponse {
+    group_by: string;
+    rows: AnalyticsGroupedRow[];
+    _timing: AnalyticsTiming;
+}
+interface AnalyticsIntegrationMetric {
+    integrationKey: string;
+    invocations: number;
+    errorRate: number;
+    medianDurationMs: number;
+    p95DurationMs: number;
+}
+interface AnalyticsIntegrationMetricsResponse {
+    windowDays: number;
+    integrations: AnalyticsIntegrationMetric[];
+    _timing: AnalyticsTiming;
+}
+interface WorkflowAnalyticsSummary {
+    workflowKey: string;
+    runs: number;
+    successRate: number;
+    medianDurationMs: number;
+    p95: number;
+    totalTokens: number;
+}
+interface TopWorkflowsResponse {
+    windowDays: number;
+    limit: number;
+    workflows: WorkflowAnalyticsSummary[];
+    _timing: AnalyticsTiming;
+}
+interface PromptAnalyticsSummary {
+    promptKey: string;
+    executions: number;
+    medianDurationMs: number;
+    p95DurationMs: number;
+    totalTokens: number;
+}
+interface TopPromptsResponse {
+    windowDays: number;
+    limit: number;
+    prompts: PromptAnalyticsSummary[];
+    _timing: AnalyticsTiming;
+}
+export declare class ApiClient {
+    private credentials;
+    constructor();
+    private ensureAuthenticated;
+    private refreshToken;
+    request<T = any>(path: string, options?: RequestInit): Promise<T>;
+    get<T = any>(path: string, params?: Record<string, any>): Promise<T>;
+    post<T = any>(path: string, body?: any): Promise<T>;
+    put<T = any>(path: string, body?: any): Promise<T>;
+    patch<T = any>(path: string, body?: any): Promise<T>;
+    delete<T = any>(path: string): Promise<T>;
+    listApps(): Promise<{
+        apps: Array<{
+            id: string;
+            name: string;
+            role?: string;
+        }>;
+    }>;
+    createApp(data: {
+        name: string;
+        initialAdminEmail?: string;
+    }): Promise<any>;
+    getApp(appId: string): Promise<{
+        id: string;
+        name: string;
+    }>;
+    deleteApp(appId: string): Promise<void>;
+    getAppSettings(appId: string): Promise<any>;
+    updateAppSettings(appId: string, settings: any): Promise<any>;
+    addUserByEmail(appId: string, data: {
+        email: string;
+        role?: string;
+    }): Promise<any>;
+    mintTestJwt(appId: string, userId: string, role?: string): Promise<any>;
+    rebuildUserSearchText(appId: string): Promise<{
+        count: number;
+    }>;
+    listUsers(appId: string, params?: {
+        name?: string;
+        email?: string;
+        userId?: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        nextCursor?: string | null;
+    }>;
+    removeUser(appId: string, userId: string): Promise<void>;
+    updateUserRole(appId: string, userId: string, role: "admin" | "member"): Promise<any>;
+    transferOwnership(appId: string, newOwnerEmail: string): Promise<void>;
+    transferAdminOwnership(appId: string, adminId: string): Promise<any>;
+    listAppAdmins(appId: string): Promise<any[]>;
+    addAppAdmin(appId: string, data: {
+        adminEmail: string;
+        role?: string;
+        sendEmail?: boolean;
+        loginUrl?: string;
+    }): Promise<any>;
+    removeAppAdmin(appId: string, adminId: string): Promise<any>;
+    listAppAdminInvitations(appId: string): Promise<any[]>;
+    deleteAppAdminInvitation(appId: string, invitationId: string): Promise<any>;
+    transferDocumentOwnership(appId: string, documentId: string, newOwnerId: string): Promise<void>;
+    listInvitations(appId: string, params?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        cursor?: string;
+    }>;
+    createInvitation(appId: string, data: {
+        email: string;
+        role: "admin" | "member";
+        expiresInDays?: number;
+        sendEmail?: boolean;
+        note?: string;
+    }): Promise<any>;
+    deleteInvitation(appId: string, invitationId: string): Promise<void>;
+    listWaitlist(appId: string): Promise<any[]>;
+    inviteWaitlistEntry(appId: string, waitlistId: string, options?: {
+        sendEmail?: boolean;
+        signupUrl?: string;
+    }): Promise<any>;
+    bulkInviteWaitlist(appId: string, payload: {
+        waitlistIds?: string[];
+        count?: number;
+        sendEmail?: boolean;
+        signupUrl?: string;
+    }): Promise<any>;
+    removeWaitlistEntry(appId: string, waitlistId: string): Promise<void>;
+    listDeferredGrants(appId: string, params?: {
+        type?: string;
+        email?: string;
+        limit?: number;
+    }): Promise<{
+        grants: any[];
+        nextCursor?: string | null;
+    }>;
+    revokeDeferredGrant(appId: string, deferredId: string, type: string): Promise<any>;
+    listIntegrations(appId: string, params?: {
+        status?: string;
+        cursor?: string;
+        limit?: number;
+    }): Promise<{
+        items: any[];
+        nextCursor?: string | null;
+    }>;
+    getIntegration(appId: string, integrationId: string): Promise<any>;
+    createIntegration(appId: string, payload: any): Promise<any>;
+    updateIntegration(appId: string, integrationId: string, payload: any, expectedModifiedAt?: string): Promise<any>;
+    deleteIntegration(appId: string, integrationId: string, hard?: boolean): Promise<void>;
+    testIntegration(appId: string, integrationId: string, payload: any): Promise<any>;
+    listIntegrationLogs(appId: string, integrationId: string, params?: {
+        limit?: number;
+        status?: string;
+        from?: string;
+        to?: string;
+        source?: "user" | "admin" | "test" | "workflow";
+    }): Promise<any[]>;
+    listWorkflowRunIntegrationLogs(appId: string, runId: string, params?: {
+        limit?: number;
+    }): Promise<any[]>;
+    listIntegrationSecrets(appId: string, integrationId: string, params?: {
+        limit?: number;
+    }): Promise<any[]>;
+    addIntegrationSecret(appId: string, integrationId: string, payload: {
+        secretData: any;
+        secretSummary?: string;
+    }): Promise<any>;
+    archiveIntegrationSecret(appId: string, integrationId: string, secretId: string): Promise<any>;
+    listAppSecrets(appId: string): Promise<any[]>;
+    createAppSecret(appId: string, payload: {
+        key: string;
+        value: string;
+        summary?: string;
+    }): Promise<any>;
+    updateAppSecret(appId: string, secretId: string, payload: {
+        value?: string;
+        summary?: string;
+    }): Promise<any>;
+    upsertAppSecret(appId: string, key: string, payload: {
+        value: string;
+        summary?: string;
+    }): Promise<any>;
+    deleteAppSecret(appId: string, secretId: string): Promise<any>;
+    listWebhooks(appId: string, params?: {
+        status?: string;
+        cursor?: string;
+        limit?: number;
+    }): Promise<{
+        items: any[];
+        nextCursor?: string | null;
+    }>;
+    getWebhook(appId: string, webhookId: string): Promise<any>;
+    createWebhook(appId: string, payload: any): Promise<any>;
+    updateWebhook(appId: string, webhookId: string, payload: any, expectedModifiedAt?: string): Promise<any>;
+    deleteWebhook(appId: string, webhookId: string): Promise<void>;
+    rotateWebhookSecret(appId: string, webhookId: string, payload: {
+        signingSecret: string;
+    }): Promise<any>;
+    listWebhookEvents(appId: string, webhookId: string, params?: {
+        limit?: number;
+    }): Promise<any>;
+    testWebhook(appId: string, webhookId: string, payload?: any): Promise<any>;
+    listCronTriggers(appId: string): Promise<{
+        items: any[];
+    }>;
+    getCronTrigger(appId: string, triggerId: string): Promise<any>;
+    createCronTrigger(appId: string, payload: any): Promise<any>;
+    updateCronTrigger(appId: string, triggerId: string, payload: any): Promise<any>;
+    deleteCronTrigger(appId: string, triggerId: string): Promise<any>;
+    pauseCronTrigger(appId: string, triggerId: string): Promise<any>;
+    resumeCronTrigger(appId: string, triggerId: string): Promise<any>;
+    testCronTrigger(appId: string, triggerId: string): Promise<any>;
+    listPrompts(appId: string, params?: {
+        status?: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        nextCursor?: string | null;
+    }>;
+    getPrompt(appId: string, promptId: string): Promise<any>;
+    createPrompt(appId: string, payload: any): Promise<any>;
+    updatePrompt(appId: string, promptId: string, payload: any, expectedModifiedAt?: string): Promise<any>;
+    deletePrompt(appId: string, promptId: string, hard?: boolean): Promise<void>;
+    executePrompt(appId: string, promptId: string, payload: {
+        variables: Record<string, any>;
+        modelOverride?: string;
+        configId?: string;
+    }): Promise<any>;
+    previewPrompt(appId: string, promptId: string, payload: {
+        variables: Record<string, any>;
+        configId?: string;
+    }): Promise<any>;
+    listPromptConfigs(appId: string, promptId: string): Promise<{
+        items: any[];
+    }>;
+    getPromptConfig(appId: string, promptId: string, configId: string): Promise<any>;
+    createPromptConfig(appId: string, promptId: string, payload: any): Promise<any>;
+    updatePromptConfig(appId: string, promptId: string, configId: string, payload: any): Promise<any>;
+    activatePromptConfig(appId: string, promptId: string, configId: string): Promise<any>;
+    duplicatePromptConfig(appId: string, promptId: string, configId: string, payload?: {
+        configName?: string;
+        description?: string;
+    }): Promise<any>;
+    listScripts(appId: string): Promise<{
+        items: any[];
+    }>;
+    getScript(appId: string, scriptId: string): Promise<any>;
+    createScript(appId: string, payload: {
+        name: string;
+        body: string;
+        description?: string;
+    }): Promise<any>;
+    /**
+     * Push a new body for an existing script by creating a new `ScriptConfig`
+     * and activating it (the prompt-model "edit → activate" flow). Referencing
+     * workflows pick up the new body on their next run with no fan-out. The
+     * config name is unique per script, so we mint a timestamped name.
+     */
+    pushScriptBody(appId: string, scriptId: string, body: string): Promise<any>;
+    deleteScript(appId: string, scriptId: string): Promise<void>;
+    getPromptSchema(appId: string, promptId: string): Promise<{
+        promptId: string;
+        promptKey: string;
+        displayName: string;
+        inputSchema: any;
+        inputVariables: string[];
+        outputSchema: any;
+        activeConfigId: string | null;
+        activeConfigName: string | null;
+    }>;
+    listTestCases(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string): Promise<{
+        items: any[];
+    }>;
+    getTestCase(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, testCaseId: string): Promise<any>;
+    createTestCase(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, payload: {
+        name: string;
+        inputVariables: Record<string, any>;
+        expectedOutputPattern?: string;
+        expectedOutputContains?: string[];
+        expectedJsonSubset?: Record<string, any>;
+        configId?: string;
+        evaluatorPromptId?: string;
+        evaluatorConfigId?: string;
+    }): Promise<any>;
+    updateTestCase(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, testCaseId: string, payload: {
+        name?: string;
+        inputVariables?: Record<string, any>;
+        expectedOutputPattern?: string | null;
+        expectedOutputContains?: string[] | null;
+        expectedJsonSubset?: Record<string, any> | null;
+        configId?: string | null;
+        evaluatorPromptId?: string | null;
+        evaluatorConfigId?: string | null;
+    }): Promise<any>;
+    deleteTestCase(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, testCaseId: string): Promise<void>;
+    listTestCaseAttachments(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, testCaseId: string): Promise<{
+        attachments: Array<{
+            filename: string;
+            contentType: string;
+            size: number;
+            r2Key: string;
+        }>;
+    }>;
+    uploadTestCaseAttachment(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, testCaseId: string, filename: string, data: Buffer, contentType: string): Promise<{
+        success: boolean;
+        attachment: {
+            filename: string;
+            contentType: string;
+            size: number;
+            r2Key: string;
+        };
+    }>;
+    downloadTestCaseAttachment(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, testCaseId: string, filename: string): Promise<{
+        data: Buffer;
+        contentType: string;
+    }>;
+    deleteTestCaseAttachment(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, testCaseId: string, filename: string): Promise<{
+        success: boolean;
+        deleted: boolean;
+    }>;
+    executeBlockTest(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, payload: {
+        variables?: Record<string, any>;
+        testCaseId?: string;
+        configId?: string;
+        comparisonGroup?: string;
+    }): Promise<any>;
+    runAllTestCases(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, payload?: {
+        overrideConfigId?: string;
+        comparisonGroup?: string;
+        testCaseIds?: string[];
+    }): Promise<any>;
+    listTestRuns(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, params?: {
+        limit?: number;
+        comparisonGroup?: string;
+    }): Promise<{
+        items: any[];
+    }>;
+    listWorkflows(appId: string, params?: {
+        status?: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        nextCursor?: string | null;
+    }>;
+    getWorkflow(appId: string, workflowId: string): Promise<any>;
+    createWorkflow(appId: string, payload: any): Promise<any>;
+    updateWorkflow(appId: string, workflowId: string, payload: any, expectedModifiedAt?: string): Promise<any>;
+    deleteWorkflow(appId: string, workflowId: string): Promise<void>;
+    updateWorkflowDraft(appId: string, workflowId: string, payload: any): Promise<any>;
+    publishWorkflow(appId: string, workflowId: string): Promise<any>;
+    previewWorkflow(appId: string, workflowId: string, payload: {
+        rootInput?: object;
+        meta?: object;
+        configId?: string;
+        useDraft?: boolean;
+        preferActive?: boolean;
+    }): Promise<{
+        instanceId: string;
+        usingDraft?: boolean;
+        source?: "config" | "active" | "draft" | null;
+        configName?: string | null;
+        configId?: string | null;
+        warning?: string;
+    }>;
+    getPreviewStatus(appId: string, workflowId: string, instanceId: string): Promise<any>;
+    listWorkflowRuns(appId: string, workflowId: string, params?: {
+        status?: string;
+        limit?: number;
+        cursor?: string;
+        forward?: boolean;
+    }): Promise<{
+        items: any[];
+        cursor?: string | null;
+    }>;
+    getWorkflowRunStatus(appId: string, workflowId: string, runId: string): Promise<any>;
+    getWorkflowStepRuns(appId: string, workflowId: string, runId: string): Promise<{
+        items: any[];
+    }>;
+    getWorkflowAnalytics(appId: string, params?: {
+        windowDays?: number;
+    }): Promise<any>;
+    getTopWorkflows(appId: string, params?: {
+        windowDays?: number;
+        limit?: number;
+    }): Promise<any>;
+    listWorkflowConfigs(appId: string, workflowId: string): Promise<{
+        items: any[];
+    }>;
+    getWorkflowConfig(appId: string, workflowId: string, configId: string): Promise<any>;
+    createWorkflowConfig(appId: string, workflowId: string, payload: {
+        configName: string;
+        description?: string;
+        steps: any[];
+    }): Promise<any>;
+    updateWorkflowConfig(appId: string, workflowId: string, configId: string, payload: {
+        configName?: string;
+        description?: string;
+        steps?: any[];
+        status?: string;
+    }): Promise<any>;
+    archiveWorkflowConfig(appId: string, workflowId: string, configId: string): Promise<any>;
+    activateWorkflowConfig(appId: string, workflowId: string, configId: string): Promise<any>;
+    duplicateWorkflowConfig(appId: string, workflowId: string, configId: string, payload?: {
+        configName?: string;
+    }): Promise<any>;
+    getAnalyticsTopUsers(appId: string, params?: {
+        windowDays?: number;
+        limit?: number;
+    }): Promise<AnalyticsTopUsersResponse>;
+    getAnalyticsIntegrationMetrics(appId: string, params?: {
+        windowDays?: number;
+    }): Promise<AnalyticsIntegrationMetricsResponse>;
+    getAnalyticsOverviewDau(appId: string): Promise<AnalyticsMetricResponse>;
+    getAnalyticsOverviewWau(appId: string): Promise<AnalyticsMetricResponse>;
+    getAnalyticsOverviewMau(appId: string): Promise<AnalyticsMetricResponse>;
+    getAnalyticsOverviewGrowth(appId: string, params?: {
+        windowDays?: number;
+    }): Promise<AnalyticsGrowthResponse>;
+    getAnalyticsDailyActive(appId: string, params?: {
+        windowDays?: number;
+    }): Promise<AnalyticsDailyActiveResponse>;
+    getAnalyticsRollingActive(appId: string, params?: {
+        windowDays?: number;
+    }): Promise<AnalyticsDailyActiveResponse>;
+    getAnalyticsCohortRetention(appId: string): Promise<AnalyticsCohortResponse>;
+    getAnalyticsUserSearch(appId: string, params: {
+        q: string;
+        limit?: number;
+    }): Promise<AnalyticsUserSearchResponse>;
+    getAnalyticsUserDetail(appId: string, userUlid: string): Promise<AnalyticsUserDetailResponse>;
+    getAnalyticsUserSnapshot(appId: string, userUlid: string): Promise<AnalyticsUserSnapshotResponse>;
+    getAnalyticsEvents(appId: string, params?: {
+        windowDays?: number;
+        page?: number;
+        [key: string]: any;
+    }): Promise<AnalyticsEventsResponse>;
+    getAnalyticsEventsGrouped(appId: string, params?: {
+        groupBy?: string;
+        windowDays?: number;
+        [key: string]: any;
+    }): Promise<AnalyticsEventsGroupedResponse>;
+    getAnalyticsTopWorkflows(appId: string, params?: {
+        windowDays?: number;
+        limit?: number;
+    }): Promise<TopWorkflowsResponse>;
+    getAnalyticsTopPrompts(appId: string, params?: {
+        windowDays?: number;
+        limit?: number;
+    }): Promise<TopPromptsResponse>;
+    listAllAdmins(params?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<any>;
+    searchAdminByEmail(email: string): Promise<any>;
+    getAdminApps(email: string): Promise<any>;
+    updateAdminSettings(adminId: string, data: {
+        appCreationLimit?: number;
+        disabled?: boolean;
+        role?: "admin" | "super-admin";
+    }): Promise<any>;
+    reindexAdmin(adminId: string): Promise<void>;
+    listAllAdminInvitations(): Promise<any[]>;
+    createGlobalAdminInvitation(data: {
+        email: string;
+        appCreationLimit?: number;
+        expiresInDays?: number;
+    }): Promise<any>;
+    deleteGlobalAdminInvitation(invitationId: string): Promise<void>;
+    listPromptCatalog(params?: {
+        status?: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<any>;
+    getPromptCatalogItem(catalogId: string): Promise<any>;
+    createPromptCatalogItem(payload: any): Promise<any>;
+    updatePromptCatalogItem(catalogId: string, payload: any): Promise<any>;
+    deletePromptCatalogItem(catalogId: string): Promise<void>;
+    listIntegrationCatalog(params?: {
+        status?: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<any>;
+    getIntegrationCatalogItem(catalogId: string): Promise<any>;
+    createIntegrationCatalogItem(payload: any): Promise<any>;
+    updateIntegrationCatalogItem(catalogId: string, payload: any): Promise<any>;
+    deleteIntegrationCatalogItem(catalogId: string): Promise<void>;
+    listLlmModels(provider?: string): Promise<{
+        models: Array<{
+            id: string;
+            name: string;
+            context_length?: number;
+            pricing?: any;
+        }>;
+        defaultModel?: string;
+        cachedAt?: string;
+    }>;
+    generatePrompt(payload: {
+        description: string;
+        generateOutputSchema?: boolean;
+    }): Promise<any>;
+    generateEvaluator(payload: {
+        appId: string;
+        promptId: string;
+    }): Promise<any>;
+    generateWorkflowEvaluator(payload: {
+        appId: string;
+        workflowId: string;
+    }): Promise<any>;
+    startBatchTests(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, payload?: {
+        comparisonGroup?: string;
+        overrideConfigId?: string;
+        testCaseIds?: string[];
+    }): Promise<{
+        batchId: string;
+        totalTests: number;
+        instanceIds: string[];
+        errors?: any[];
+    }>;
+    getBatchTestStatus(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, batchId: string): Promise<{
+        status: string;
+        batchId: string;
+        completed: number;
+        passed: number;
+        failed: number;
+        results: Array<{
+            testCaseId: string;
+            runId: string;
+            status: string;
+            verificationPassed: boolean;
+            durationMs?: number;
+            verificationDetails?: any;
+            startedAt?: string;
+            endedAt?: string;
+        }>;
+    }>;
+    cancelBatchTests(appId: string, blockType: "prompt" | "integration" | "workflow", blockId: string, batchId: string, instanceIds: string[]): Promise<{
+        batchId: string;
+        terminated: string[];
+        errors?: any[];
+    }>;
+    getComparisonGroup(appId: string, group: string): Promise<{
+        comparisonGroup: string;
+        runs: any[];
+    }>;
+    listEmailTemplates(appId: string): Promise<{
+        templates: EmailTemplateSummary[];
+    }>;
+    getEmailTemplate(appId: string, emailType: string): Promise<EmailTemplateDetail>;
+    upsertEmailTemplate(appId: string, emailType: string, payload: {
+        subject: string;
+        htmlBody: string;
+        textBody: string;
+    }): Promise<EmailTemplateUpsertResult>;
+    deleteEmailTemplate(appId: string, emailType: string): Promise<{
+        success: boolean;
+    }>;
+    testEmailTemplate(appId: string, emailType: string, payload?: {
+        subject: string;
+        htmlBody: string;
+        textBody: string;
+    }): Promise<{
+        success: boolean;
+        sentTo: string;
+        error?: string;
+    }>;
+    createToken(appId: string, data: {
+        name: string;
+        ttl?: string;
+        userId?: string;
+    }): Promise<{
+        token: string;
+        tokenId: string;
+        name: string;
+        expiresAt: string | null;
+        createdAt: string;
+        warning: string;
+    }>;
+    listTokens(appId: string, params?: {
+        userId?: string;
+    }): Promise<Array<{
+        tokenId: string;
+        name: string;
+        userId: string;
+        expiresAt: string | null;
+        lastUsedAt: string | null;
+        createdAt: string;
+        createdBy: string;
+    }>>;
+    getToken(appId: string, tokenId: string): Promise<{
+        tokenId: string;
+        name: string;
+        userId: string;
+        expiresAt: string | null;
+        lastUsedAt: string | null;
+        createdAt: string;
+        createdBy: string;
+        revokedAt: string | null;
+    }>;
+    revokeToken(appId: string, tokenId: string): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    listDatabases(appId: string): Promise<any[]>;
+    createDatabase(appId: string, data: {
+        title: string;
+        databaseType?: string;
+        metadata?: Record<string, any> | string;
+    }): Promise<any>;
+    getDatabase(appId: string, databaseId: string): Promise<any>;
+    updateDatabase(appId: string, databaseId: string, data: Record<string, any>): Promise<any>;
+    deleteDatabase(appId: string, databaseId: string): Promise<void>;
+    /**
+     * Read a database's CEL context dict.
+     *
+     * The HTTP path stays `/metadata` because the wire field name is still
+     * `metadata`; only the client/CLI-facing helper names were reframed.
+     */
+    getDatabaseCelContext(appId: string, databaseId: string): Promise<any>;
+    /** Update a database's CEL context dict (merge with existing). */
+    updateDatabaseCelContext(appId: string, databaseId: string, celContext: Record<string, any>): Promise<any>;
+    /** @deprecated Use {@link getDatabaseCelContext} instead. */
+    getDatabaseMetadata(appId: string, databaseId: string): Promise<any>;
+    /** @deprecated Use {@link updateDatabaseCelContext} instead. */
+    updateDatabaseMetadata(appId: string, databaseId: string, metadata: Record<string, any>): Promise<any>;
+    listDatabasePermissions(appId: string, databaseId: string): Promise<any[]>;
+    addDatabaseManager(appId: string, databaseId: string, userId: string): Promise<any>;
+    removeDatabaseManager(appId: string, databaseId: string, userId: string): Promise<any>;
+    /** @deprecated Use {@link addDatabaseManager} instead. */
+    grantDatabasePermission(appId: string, databaseId: string, data: {
+        userId: string;
+        permission: "manager";
+    }): Promise<any>;
+    /** @deprecated Use {@link removeDatabaseManager} instead. */
+    revokeDatabasePermission(appId: string, databaseId: string, userId: string): Promise<any>;
+    listDatabaseModels(appId: string, databaseId: string): Promise<any>;
+    describeDatabaseModel(appId: string, databaseId: string, modelName: string): Promise<any>;
+    queryDatabaseRecords(appId: string, databaseId: string, modelName: string, queryOptions?: {
+        filter?: Record<string, any>;
+        limit?: number;
+        cursor?: string;
+    }): Promise<any>;
+    listDatabaseOperations(appId: string, databaseId: string): Promise<any[]>;
+    executeDatabaseOperation(appId: string, databaseId: string, operationName: string, data?: {
+        params?: Record<string, any>;
+        limit?: number;
+        cursor?: string;
+        direction?: number;
+    }, token?: string, options?: {
+        timing?: boolean;
+    }): Promise<any>;
+    /**
+     * Execute a registered batch (bulk) database operation. Posts a chunk of
+     * items to the canonical `operations/:name/batch` endpoint (the same one the
+     * client library's `executeBatch` uses — NOT the deprecated `import-bulk`
+     * alias). Used by `databases import-csv`.
+     *
+     * @returns `{ imported, failed }` — DO-level write outcome counts. Per-item
+     *   validation/access failures abort the whole chunk with a 4xx (thrown).
+     */
+    executeBatch(appId: string, databaseId: string, operationName: string, batch: Array<{
+        params: Record<string, any>;
+    }>): Promise<{
+        imported: number;
+        failed: number;
+    }>;
+    /**
+     * Make a request using a specific JWT token instead of the CLI's credentials.
+     * Used for executing operations as a different user.
+     */
+    requestWithToken<T = any>(path: string, token: string, options?: RequestInit): Promise<T>;
+    listDatabaseIndexes(appId: string, databaseId: string, modelName?: string): Promise<any>;
+    registerDatabaseIndex(appId: string, databaseId: string, data: {
+        modelName: string;
+        fieldName: string;
+        fieldType: string;
+        unique?: boolean;
+    }): Promise<any>;
+    dropDatabaseIndex(appId: string, databaseId: string, data: {
+        modelName: string;
+        fieldName: string;
+    }): Promise<any>;
+    /**
+     * Issue #974: back-provision an existing database instance's schema-declared
+     * unique indexes by reading its type schema and registering any declared-but-
+     * missing unique index. Idempotent.
+     */
+    reindexDatabaseFromSchema(appId: string, databaseId: string): Promise<{
+        ok: boolean;
+        registered: number;
+        skipped?: boolean;
+        reason?: string;
+        databaseType?: string;
+    }>;
+    listDatabaseTypeConfigs(appId: string): Promise<any[]>;
+    getDatabaseTypeConfig(appId: string, databaseType: string): Promise<any>;
+    createDatabaseTypeConfig(appId: string, data: {
+        databaseType: string;
+        ruleSetId?: string | null;
+        triggers?: Record<string, any> | null;
+        metadataAccess?: string | null;
+        defaultAccess?: string | null;
+        autoPopulatedFields?: Record<string, any> | null;
+        timestamps?: Record<string, any> | null;
+        schema?: string | null;
+    }): Promise<any>;
+    updateDatabaseTypeConfig(appId: string, databaseType: string, data: {
+        ruleSetId?: string | null;
+        triggers?: Record<string, any> | null;
+        metadataAccess?: string | null;
+        defaultAccess?: string | null;
+        autoPopulatedFields?: Record<string, any> | null;
+        timestamps?: Record<string, any> | null;
+        schema?: string | null;
+        pendingOpDeletes?: string[];
+        finalOpNames?: string[];
+    }, expectedModifiedAt?: string, options?: {
+        dryRun?: boolean;
+        acceptWarnings?: boolean;
+    }): Promise<any>;
+    deleteDatabaseTypeConfig(appId: string, databaseType: string): Promise<any>;
+    /**
+     * Issue #666 Phase 3: ask the server to scaffold a TOML schema from
+     * existing ops + DO field introspection. Read-only — does NOT persist.
+     */
+    scaffoldDatabaseTypeSchema(appId: string, databaseType: string): Promise<{
+        schema: string;
+    }>;
+    listDatabaseTypeOperations(appId: string, databaseType: string): Promise<any[]>;
+    getDatabaseTypeOperation(appId: string, databaseType: string, name: string): Promise<any>;
+    createDatabaseTypeOperation(appId: string, databaseType: string, data: {
+        name: string;
+        type: string;
+        modelName: string;
+        access?: string | null;
+        definition: Record<string, any>;
+        params?: Record<string, any> | null;
+    }, options?: {
+        dryRun?: boolean;
+        schemaOverride?: string | null;
+        defaultAccess?: string | null;
+    }): Promise<any>;
+    updateDatabaseTypeOperation(appId: string, databaseType: string, name: string, data: Record<string, any>, expectedModifiedAt?: string, options?: {
+        dryRun?: boolean;
+        schemaOverride?: string | null;
+    }): Promise<any>;
+    deleteDatabaseTypeOperation(appId: string, databaseType: string, name: string): Promise<any>;
+    listDatabaseTypeSubscriptions(appId: string, databaseType: string): Promise<any[]>;
+    getDatabaseTypeSubscription(appId: string, databaseType: string, subscriptionKey: string): Promise<any>;
+    createDatabaseTypeSubscription(appId: string, databaseType: string, data: {
+        subscriptionKey: string;
+        displayName: string;
+        modelName: string;
+        filter: string;
+        access: string;
+        description?: string | null;
+        select?: string[] | null;
+        emit?: string[] | null;
+        params?: Record<string, any> | null;
+        status?: string;
+    }): Promise<any>;
+    updateDatabaseTypeSubscription(appId: string, databaseType: string, subscriptionKey: string, data: Record<string, any>): Promise<any>;
+    deleteDatabaseTypeSubscription(appId: string, databaseType: string, subscriptionKey: string): Promise<any>;
+    listGroups(appId: string, params?: {
+        type?: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        cursor?: string;
+    }>;
+    createGroup(appId: string, data: {
+        groupType: string;
+        groupId: string;
+        name: string;
+        description?: string;
+    }): Promise<any>;
+    getGroup(appId: string, groupType: string, groupId: string): Promise<any>;
+    updateGroup(appId: string, groupType: string, groupId: string, data: {
+        name?: string;
+        description?: string;
+    }): Promise<any>;
+    deleteGroup(appId: string, groupType: string, groupId: string): Promise<any>;
+    listGroupMembers(appId: string, groupType: string, groupId: string): Promise<{
+        items: any[];
+        cursor?: string;
+    }>;
+    addGroupMember(appId: string, groupType: string, groupId: string, data: {
+        userId: string;
+    }): Promise<any>;
+    removeGroupMember(appId: string, groupType: string, groupId: string, userId: string): Promise<any>;
+    listGroupDocuments(appId: string, groupType: string, groupId: string): Promise<any[]>;
+    listUserMemberships(appId: string, userId: string): Promise<any[]>;
+    listDocumentGroupPermissions(appId: string, documentId: string): Promise<any[]>;
+    grantDocumentGroupPermission(appId: string, documentId: string, data: {
+        groupType: string;
+        groupId: string;
+        permission: string;
+    }): Promise<any>;
+    revokeDocumentGroupPermission(appId: string, documentId: string, groupType: string, groupId: string): Promise<any>;
+    listCollections(appId: string, params?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        nextCursor?: string | null;
+    }>;
+    listAllCollections(appId: string, params?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        nextCursor?: string | null;
+    }>;
+    createCollection(appId: string, data: {
+        name: string;
+        description?: string;
+    }): Promise<any>;
+    getCollection(appId: string, collectionId: string): Promise<any>;
+    updateCollection(appId: string, collectionId: string, data: {
+        name?: string;
+        description?: string;
+    }): Promise<any>;
+    deleteCollection(appId: string, collectionId: string): Promise<any>;
+    listCollectionDocuments(appId: string, collectionId: string, params?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        nextCursor?: string | null;
+    }>;
+    addCollectionDocument(appId: string, collectionId: string, data: {
+        documentId: string;
+    }): Promise<any>;
+    removeCollectionDocument(appId: string, collectionId: string, documentId: string): Promise<any>;
+    listCollectionsForDocument(appId: string, documentId: string, params?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        nextCursor?: string | null;
+    }>;
+    getCollectionAccess(appId: string, collectionId: string): Promise<any>;
+    grantCollectionGroupPermission(appId: string, collectionId: string, data: {
+        groupType: string;
+        groupId: string;
+        permission: string;
+    }): Promise<any>;
+    revokeCollectionGroupPermission(appId: string, collectionId: string, groupType: string, groupId: string): Promise<any>;
+    addCollectionMember(appId: string, collectionId: string, data: {
+        userId: string;
+        permission: string;
+    }): Promise<any>;
+    removeCollectionMember(appId: string, collectionId: string, userId: string): Promise<any>;
+    listCollectionTypeConfigs(appId: string): Promise<any[]>;
+    getCollectionTypeConfig(appId: string, collectionType: string): Promise<any>;
+    createCollectionTypeConfig(appId: string, data: {
+        collectionType: string;
+        ruleSetId?: string;
+    }): Promise<any>;
+    updateCollectionTypeConfig(appId: string, collectionType: string, data: {
+        ruleSetId?: string | null;
+    }, expectedModifiedAt?: string): Promise<any>;
+    deleteCollectionTypeConfig(appId: string, collectionType: string): Promise<any>;
+    listRuleSets(appId: string, params?: {
+        resourceType?: string;
+    }): Promise<any[]>;
+    createRuleSet(appId: string, data: {
+        name: string;
+        resourceType: string;
+        rules: Record<string, any>;
+        description?: string;
+    }): Promise<any>;
+    getRuleSet(appId: string, ruleSetId: string): Promise<any>;
+    updateRuleSet(appId: string, ruleSetId: string, data: {
+        name?: string;
+        description?: string;
+        rules?: Record<string, any>;
+    }, expectedModifiedAt?: string): Promise<any>;
+    deleteRuleSet(appId: string, ruleSetId: string): Promise<any>;
+    getRuleSetSchema(appId: string): Promise<any>;
+    testRuleSet(appId: string, ruleSetId: string, data: any): Promise<any>;
+    debugRuleSet(appId: string, data: any): Promise<any>;
+    listGroupTypeConfigs(appId: string): Promise<any[]>;
+    getGroupTypeConfig(appId: string, groupType: string): Promise<any>;
+    createGroupTypeConfig(appId: string, data: {
+        groupType: string;
+        ruleSetId?: string;
+        autoAddCreator?: boolean;
+    }): Promise<any>;
+    updateGroupTypeConfig(appId: string, groupType: string, data: {
+        ruleSetId?: string | null;
+        autoAddCreator?: boolean;
+    }, expectedModifiedAt?: string): Promise<any>;
+    deleteGroupTypeConfig(appId: string, groupType: string): Promise<any>;
+    exportDocumentState(appId: string, documentId: string): Promise<{
+        state: string;
+        byteLength: number;
+        documentId: string;
+    }>;
+    importDocumentState(appId: string, documentId: string, stateBase64: string): Promise<any>;
+    getDocument(appId: string, documentId: string): Promise<any>;
+    createDocument(appId: string, data: {
+        title: string;
+        documentId?: string;
+        tags?: string[];
+        createdBy?: string;
+    }): Promise<any>;
+    listDocumentPermissions(appId: string, documentId: string): Promise<any[]>;
+    grantDocumentPermission(appId: string, documentId: string, permissions: Array<{
+        userId: string;
+        permission: string;
+    }>): Promise<any>;
+    listDocumentInvitations(appId: string, documentId: string): Promise<any[]>;
+    listDocumentBlobs(appId: string, documentId: string): Promise<any[]>;
+    downloadBlob(appId: string, documentId: string, blobId: string): Promise<Buffer>;
+    uploadBlob(appId: string, documentId: string, blobId: string, data: Buffer, meta: {
+        filename: string;
+        contentType: string;
+        sha256: string;
+    }): Promise<any>;
+    listDocumentAliases(appId: string, documentId: string): Promise<any[]>;
+    setDocumentAlias(appId: string, aliasScope: string, aliasKey: string, documentId: string, ownerUserId?: string, mustNotExist?: boolean): Promise<any>;
+    findUserByEmail(appId: string, email: string): Promise<any | null>;
+    listAdminDocuments(appId: string, userId: string): Promise<any[]>;
+    saveDatabaseRecord(appId: string, databaseId: string, modelName: string, id: string, data: any): Promise<any>;
+    batchDatabaseRecords(appId: string, databaseId: string, operations: any[]): Promise<any>;
+    deleteDatabaseRecord(appId: string, databaseId: string, modelName: string, id: string): Promise<any>;
+    batchDeleteDatabaseRecords(appId: string, databaseId: string, operations: {
+        op: "delete";
+        modelName: string;
+        id: string;
+    }[]): Promise<any>;
+    listDatabaseUniqueConstraints(appId: string, databaseId: string): Promise<any[]>;
+    registerDatabaseUniqueConstraint(appId: string, databaseId: string, constraint: {
+        modelName: string;
+        constraintName: string;
+        fields: string[];
+    }): Promise<any>;
+    listBlobBuckets(appId: string): Promise<{
+        items: any[];
+    }>;
+    createBlobBucket(appId: string, payload: any): Promise<any>;
+    getBlobBucket(appId: string, bucketIdOrKey: string): Promise<any>;
+    updateBlobBucket(appId: string, bucketIdOrKey: string, payload: any): Promise<any>;
+    deleteBlobBucket(appId: string, bucketIdOrKey: string): Promise<any>;
+    listBucketBlobs(appId: string, bucketIdOrKey: string, params?: {
+        cursor?: string;
+        limit?: number;
+    }): Promise<{
+        items: any[];
+        cursor?: string;
+    }>;
+    uploadBucketBlob(appId: string, bucketIdOrKey: string, data: Buffer, meta: {
+        filename: string;
+        contentType: string;
+        tags?: string[];
+    }): Promise<any>;
+    downloadBucketBlob(appId: string, bucketIdOrKey: string, blobId: string): Promise<Buffer>;
+    deleteBucketBlob(appId: string, bucketIdOrKey: string, blobId: string): Promise<any>;
+    getBucketBlobSignedUrl(appId: string, bucketIdOrKey: string, blobId: string, expiresInSeconds?: number): Promise<any>;
+}
+export declare const apiClient: ApiClient;
+export {};