@arbium/enterprise-agent-connect-client 0.0.0-stage → 0.1.2-dev.75145ef

package/lib/index.d.ts

@@ -0,0 +1,1274 @@
+import { type AppLive } from "./steps.js";
+import type { Agent, CheckOutcome, Connection, Connector, EventSubscriptionInput, EventTriggerInput, Limits, SiteAccess, TeamsTriggerInput } from "./types.js";
+export * from "./steps.js";
+export type * from "./types.js";
+/** A refusal the admin should read (4xx with an `error`): bad input, a failed connection
+ *  check, a name in use. A 5xx or an answer without an `error` throws a plain Error. */
+export declare class AgentConnectError extends Error {
+    readonly status: number;
+    constructor(message: string, status: number);
+}
+export type ClientOptions = {
+    /** Where the service answers, e.g. http://agent-connect:3000. */
+    baseUrl: string;
+    /** The admin token (AGENT_CONNECT_ADMIN_TOKEN). */
+    token: string;
+    /** Connecting Microsoft retries while its approval settles (up to ~20s). Default 45s. */
+    timeoutMs?: number;
+    /** Default: the global fetch at the time of each call. */
+    fetch?: typeof fetch;
+};
+export type AgentConnectClient = ReturnType<typeof createClient>;
+/** The admin API (v1), server to server: the token must never reach a browser. */
+export declare function createClient(options: ClientOptions): {
+    checkedSites: (o: string, a: string) => Promise<SiteAccess[] | null>;
+    /** The read-only live check of each app of its own that is on, for warnings no stored
+     *  status holds (e.g. an app can see nothing yet). Null for an app whose check could not
+     *  run. */
+    appChecks(o: string, connectors: Connector[], connections: Connection[]): Promise<Record<string, CheckOutcome | null>>;
+    /** Each provider app's live state for its steps (`appState`), read only: its own check
+     *  and its sites while on, the organization's Claude key where a capability needs one,
+     *  and its chosen steps' own live checks (none while those steps are not chosen, so no
+     *  vendor call). An app's page, its provider's page and the Integrations tab all read it
+     *  here, so they agree. The Claude key and the step checks are read once for all apps. */
+    appStates(o: string, connectors: Connector[], connections: Connection[]): Promise<Record<string, AppLive>>;
+    organizations: {
+        list: () => Promise<{
+            id: string;
+            name: string | null;
+            createdAt: string;
+        }[]>;
+        get: (id: string) => Promise<{
+            id: string;
+            name: string | null;
+            createdAt: string;
+        } | null>;
+        /** Makes the organization with this id if missing; `name` replaces the kept one. */
+        ensure: (id: string, name?: string) => Promise<{
+            id: string;
+            name: string | null;
+            createdAt: string;
+        }>;
+        create: (name: string) => Promise<{
+            id: string;
+            name: string | null;
+            createdAt: string;
+        }>;
+    };
+    branding: () => Promise<{
+        productName: string;
+        logoUrl?: string;
+        resourcePrefix: string;
+        microsoft: {
+            appName: string;
+            mailboxGroup: string;
+            mailboxGroupAlias: string;
+            botRole: string;
+        };
+        teams: {
+            resourceGroup: string;
+            developer?: {
+                name: string;
+                websiteUrl: string;
+                privacyUrl: string;
+                termsOfUseUrl: string;
+            };
+        };
+    }>;
+    connectors: () => Promise<{
+        id: string;
+        name: string;
+        description: string;
+        logo: string;
+        identity: string;
+        signsInAs?: "agentBot";
+        provider?: string;
+        order?: number;
+        connectionKind: "guided";
+        accountKey: string;
+        scopes?: string[];
+        setup: {
+            title: string;
+            body: string;
+            link?: {
+                label: string;
+                href: string;
+            };
+            copy?: string[];
+            shell?: "bash" | "powershell";
+            permissions?: boolean;
+            certificate?: boolean;
+            click?: string[];
+            clickUnavailable?: true;
+            siteRole?: "read" | "write";
+            agentCheck?: boolean;
+            confirm?: string;
+            live?: string;
+            settings?: {
+                id: string;
+                label: string;
+                help?: string;
+                placeholder?: string;
+                pattern: string;
+            }[];
+            option?: {
+                field: string;
+                value: string;
+            };
+            capabilities?: string[];
+        }[];
+        afterConnect: {
+            title: string;
+            body: string;
+            link?: {
+                label: string;
+                href: string;
+            };
+            copy?: string[];
+            shell?: "bash" | "powershell";
+            permissions?: boolean;
+            certificate?: boolean;
+            click?: string[];
+            clickUnavailable?: true;
+            siteRole?: "read" | "write";
+            agentCheck?: boolean;
+            confirm?: string;
+            live?: string;
+            settings?: {
+                id: string;
+                label: string;
+                help?: string;
+                placeholder?: string;
+                pattern: string;
+            }[];
+            option?: {
+                field: string;
+                value: string;
+            };
+            capabilities?: string[];
+        }[];
+        fields: {
+            id: string;
+            label: string;
+            help?: string;
+            placeholder?: string;
+            secret: boolean;
+            options?: {
+                value: string;
+                label: string;
+                description: string;
+                scopes?: string[];
+            }[];
+            requires?: {
+                field: string;
+                value: string;
+            };
+            optional: boolean;
+        }[];
+        capabilities: {
+            id: string;
+            label: string;
+            description: string;
+            required: boolean;
+            destructive: boolean;
+            costs?: boolean;
+            scopes: string[];
+            roles?: string[];
+            permissions: string[];
+            fill?: {
+                [key: string]: string;
+            };
+            note?: string;
+            forbidden?: string;
+            claudeKey?: boolean;
+            tools: string[];
+        }[];
+        limits: {
+            id: string;
+            label: string;
+            help: string;
+            kind: "list" | "text" | "map";
+            required: boolean;
+            pattern?: string;
+            keys?: string;
+        }[];
+        siteAccess?: {
+            grant: {
+                title: string;
+                body: string;
+                link?: {
+                    label: string;
+                    href: string;
+                };
+                copy?: string[];
+                shell?: "bash" | "powershell";
+                permissions?: boolean;
+                certificate?: boolean;
+                click?: string[];
+                clickUnavailable?: true;
+                siteRole?: "read" | "write";
+                agentCheck?: boolean;
+                confirm?: string;
+                live?: string;
+                settings?: {
+                    id: string;
+                    label: string;
+                    help?: string;
+                    placeholder?: string;
+                    pattern: string;
+                }[];
+                option?: {
+                    field: string;
+                    value: string;
+                };
+            }[];
+            request: string;
+            write: string[];
+        };
+        agentAccess?: {
+            limit: string;
+            label: string;
+            path: string & (unknown & unknown);
+            granted: string;
+            notGranted: string;
+            notFound: string;
+            probes: {
+                [key: string]: {
+                    method: "GET" | "POST" | "PATCH";
+                    path: string & (unknown & unknown);
+                    body?: unknown;
+                    allowed: number[];
+                };
+            };
+            missing?: string;
+        };
+        verify: {
+            method: "GET" | "POST";
+            path: string;
+            label: string;
+            show: string;
+            name?: string;
+            match?: {
+                [key: string]: string | number | boolean;
+            };
+            body?: {
+                [key: string]: unknown;
+            };
+            ifEmpty?: string;
+        } | {
+            label: string;
+            check: string;
+            ifEmpty?: string;
+        };
+        discover?: {
+            method: "GET" | "POST";
+            path: string;
+            label: string;
+            show: string;
+            name?: string;
+            match?: {
+                [key: string]: string | number | boolean;
+            };
+            body?: {
+                [key: string]: unknown;
+            };
+            ifEmpty?: string;
+        } | {
+            label: string;
+            check: string;
+            ifEmpty?: string;
+        };
+        revoke: string;
+        http?: {
+            baseUrl: string;
+            auth: {
+                type: "header";
+                header: string;
+                value: string;
+                prefix?: string;
+            } | {
+                type: "bearer";
+                token: string;
+            } | {
+                type: "basic";
+                username: string;
+                password: string;
+            } | {
+                type: "oauth2";
+                tokenUrl: string;
+                clientId: string;
+                clientSecret: string;
+                scope?: string;
+            } | {
+                type: "query";
+                param: string;
+                value: string;
+            };
+            headers: {
+                [key: string]: string;
+            };
+            tools: {
+                name: string;
+                description: string;
+                method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+                path: string;
+                params: {
+                    [key: string]: {
+                        type: "string" | "number" | "integer" | "boolean" | "array";
+                        description: string;
+                        in: "path" | "query" | "body";
+                        name?: string;
+                        required: boolean;
+                        default?: (string | number | boolean) | (string | number | boolean)[];
+                        enum?: (string | number | boolean)[];
+                        items?: "string" | "number" | "integer" | "boolean";
+                        join?: string;
+                        limit?: string;
+                    };
+                };
+                destructive: boolean;
+                answerLimits: {
+                    field: string;
+                    limit: string;
+                }[];
+                result?: {
+                    items?: string;
+                    fields?: string[];
+                };
+                paging?: {
+                    param: string;
+                    body: string;
+                } | {
+                    param: string;
+                    header: string;
+                } | {
+                    param: string;
+                    link: true;
+                };
+            }[];
+            allowInsecureHttp: boolean;
+        };
+        soap?: {
+            endpoint: string;
+            version: "1.1" | "1.2";
+            namespaces: {
+                [key: string]: string;
+            };
+            auth?: {
+                type: "header";
+                header: string;
+                value: string;
+                prefix?: string;
+            } | {
+                type: "bearer";
+                token: string;
+            } | {
+                type: "basic";
+                username: string;
+                password: string;
+            };
+            wsSecurity?: {
+                username: string;
+                password: string;
+                digest: boolean;
+            };
+            verify?: {
+                tool: string;
+                args: {
+                    [key: string]: string | number | boolean;
+                };
+                show: string;
+            };
+            tools: {
+                name: string;
+                description: string;
+                operation: string;
+                soapAction?: string;
+                body: string;
+                params: {
+                    [key: string]: {
+                        type: "string" | "number" | "integer" | "boolean";
+                        description: string;
+                        required: boolean;
+                        limit?: string;
+                    };
+                };
+                result?: string;
+                fields?: string[];
+                readOnly: boolean;
+                destructive: boolean;
+                answerLimits: {
+                    field: string;
+                    limit: string;
+                }[];
+            }[];
+            allowInsecureHttp: boolean;
+        };
+        odata?: {
+            serviceRoot: string;
+            version: "2" | "4";
+            auth: {
+                type: "header";
+                header: string;
+                value: string;
+                prefix?: string;
+            } | {
+                type: "bearer";
+                token: string;
+            } | {
+                type: "basic";
+                username: string;
+                password: string;
+            } | {
+                type: "oauth2";
+                tokenUrl: string;
+                clientId: string;
+                clientSecret: string;
+                scope?: string;
+            } | {
+                type: "query";
+                param: string;
+                value: string;
+            };
+            headers: {
+                [key: string]: string;
+            };
+            csrf: boolean;
+            paging: "skip" | "server";
+            tools: {
+                name: string;
+                description: string;
+                kind: "list" | "get" | "create" | "update" | "function" | "action";
+                entitySet?: string;
+                function?: string;
+                key: {
+                    [key: string]: {
+                        type: "string" | "integer" | "number" | "decimal" | "boolean" | "guid" | "datetime" | "datetimeoffset";
+                        description: string;
+                        property?: string;
+                        required?: boolean;
+                        limit?: string;
+                    };
+                };
+                filters: {
+                    [key: string]: {
+                        type: "string" | "integer" | "number" | "decimal" | "boolean" | "guid" | "datetime" | "datetimeoffset";
+                        description: string;
+                        property?: string;
+                        required?: boolean;
+                        limit?: string;
+                        op: "eq" | "ne" | "gt" | "ge" | "lt" | "le" | "contains" | "startswith";
+                    };
+                };
+                fields: {
+                    [key: string]: {
+                        type: "string" | "integer" | "number" | "decimal" | "boolean" | "guid" | "datetime" | "datetimeoffset";
+                        description: string;
+                        property?: string;
+                        required?: boolean;
+                        limit?: string;
+                    };
+                };
+                params: {
+                    [key: string]: {
+                        type: "string" | "integer" | "number" | "decimal" | "boolean" | "guid" | "datetime" | "datetimeoffset";
+                        description: string;
+                        property?: string;
+                        required?: boolean;
+                        limit?: string;
+                    };
+                };
+                select: string[];
+                orderBy?: string;
+                top: number;
+                destructive: boolean;
+                answerLimits: {
+                    field: string;
+                    limit: string;
+                }[];
+            }[];
+            allowInsecureHttp: boolean;
+        };
+        sql?: {
+            engine: "postgres" | "sqlserver" | "mysql" | "oracle";
+            host: string;
+            port?: number;
+            database: string;
+            auth: {
+                user: string;
+                password: string;
+            };
+            tls: "verify" | "insecure" | "off";
+            timeoutSeconds: number;
+            maxRows: number;
+            tools: {
+                name: string;
+                description: string;
+                sql: string;
+                params: {
+                    [key: string]: {
+                        type: "string" | "number" | "integer" | "boolean";
+                        description: string;
+                        required: boolean;
+                        limit?: string;
+                    };
+                };
+                write: boolean;
+                destructive: boolean;
+                answerLimits: {
+                    column: string;
+                    limit: string;
+                }[];
+            }[];
+        };
+        events?: {
+            types: {
+                id: string;
+                label: string;
+            }[];
+            fields: {
+                [key: string]: string;
+            };
+            limits: {
+                [key: string]: string;
+            };
+            webhook?: {
+                verify: {
+                    type: "hmac-sha256";
+                    header: string;
+                    prefix: string;
+                } | {
+                    type: "token";
+                    header: string;
+                } | {
+                    type: "none";
+                };
+                allowInsecure: boolean;
+                type: {
+                    field: string;
+                } | {
+                    header: string;
+                };
+                deliveryId?: {
+                    field: string;
+                } | {
+                    header: string;
+                };
+                timestamp?: {
+                    at: {
+                        field: string;
+                    } | {
+                        header: string;
+                    };
+                    unit: "s" | "ms" | "iso";
+                    toleranceSeconds: number;
+                };
+                setup: {
+                    title: string;
+                    body: string;
+                    link?: {
+                        label: string;
+                        href: string;
+                    };
+                    copy?: string[];
+                    shell?: "bash" | "powershell";
+                    permissions?: boolean;
+                    certificate?: boolean;
+                    click?: string[];
+                    clickUnavailable?: true;
+                    siteRole?: "read" | "write";
+                    agentCheck?: boolean;
+                    confirm?: string;
+                    live?: string;
+                    settings?: {
+                        id: string;
+                        label: string;
+                        help?: string;
+                        placeholder?: string;
+                        pattern: string;
+                    }[];
+                    option?: {
+                        field: string;
+                        value: string;
+                    };
+                }[];
+                register?: {
+                    method: "GET" | "POST" | "PUT";
+                    path: string;
+                    body?: unknown;
+                    location: string;
+                };
+            };
+            self?: {
+                request: {
+                    method: "GET" | "POST" | "PUT";
+                    path: string;
+                    body?: unknown;
+                };
+                id: string;
+                fields: string[];
+            };
+            poll?: {
+                request: {
+                    method: "GET" | "POST" | "PUT";
+                    path: string;
+                    body?: unknown;
+                };
+                filter?: string;
+                items: string;
+                wrap?: string;
+                cursor: string;
+                deliveryId: string[];
+                types: {
+                    type: string;
+                    since?: string;
+                }[];
+            };
+        };
+    }[]>;
+    providers: () => Promise<{
+        id: string;
+        name: string;
+        logo: string;
+        identity: string;
+        sharedIdentity?: string;
+        accountKey: string;
+        principalKeys: string[];
+        certificate: boolean;
+        setup: {
+            title: string;
+            body: string;
+            link?: {
+                label: string;
+                href: string;
+            };
+            copy?: string[];
+            shell?: "bash" | "powershell";
+            permissions?: boolean;
+            certificate?: boolean;
+            click?: string[];
+            clickUnavailable?: true;
+            siteRole?: "read" | "write";
+            agentCheck?: boolean;
+            confirm?: string;
+            live?: string;
+            settings?: {
+                id: string;
+                label: string;
+                help?: string;
+                placeholder?: string;
+                pattern: string;
+            }[];
+            option?: {
+                field: string;
+                value: string;
+            };
+        }[];
+        fields: {
+            id: string;
+            label: string;
+            help?: string;
+            placeholder?: string;
+            secret: boolean;
+            options?: {
+                value: string;
+                label: string;
+                description: string;
+                scopes?: string[];
+            }[];
+            requires?: {
+                field: string;
+                value: string;
+            };
+            optional: boolean;
+        }[];
+        addAgent: {
+            title: string;
+            body: string;
+            link?: {
+                label: string;
+                href: string;
+            };
+            copy?: string[];
+            shell?: "bash" | "powershell";
+            permissions?: boolean;
+            certificate?: boolean;
+            click?: string[];
+            clickUnavailable?: true;
+            siteRole?: "read" | "write";
+            agentCheck?: boolean;
+            confirm?: string;
+            live?: string;
+            settings?: {
+                id: string;
+                label: string;
+                help?: string;
+                placeholder?: string;
+                pattern: string;
+            }[];
+            option?: {
+                field: string;
+                value: string;
+            };
+            apps: string[];
+        }[];
+        revoke: string;
+        approval: boolean;
+    }[]>;
+    providerConnections: (o: string) => Promise<{
+        id: string;
+        organizationId: string;
+        provider: string;
+        status: "pending" | "connected" | "needs_reconnect";
+        config: {
+            [key: string]: string;
+        };
+        accountLabel: string | null;
+        connectedBy: string | null;
+        connectedAt: string;
+        checkedAt: string;
+        certificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        nextCertificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        apps: string[];
+    }[]>;
+    connectProvider: (o: string, p: string, body: {
+        fields: Record<string, string>;
+        connectedBy: string;
+    }) => Promise<{
+        id: string;
+        organizationId: string;
+        provider: string;
+        status: "pending" | "connected" | "needs_reconnect";
+        config: {
+            [key: string]: string;
+        };
+        accountLabel: string | null;
+        connectedBy: string | null;
+        connectedAt: string;
+        checkedAt: string;
+        certificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        nextCertificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        apps: string[];
+    }>;
+    checkProvider: (o: string, p: string) => Promise<{
+        ok: true;
+    } | {
+        ok: false;
+        error: string;
+    }>;
+    /** Before connecting, the certificate to upload; after, one to rotate to. */
+    newCertificate: (o: string, p: string, by: string) => Promise<{
+        id: string;
+        organizationId: string;
+        provider: string;
+        status: "pending" | "connected" | "needs_reconnect";
+        config: {
+            [key: string]: string;
+        };
+        accountLabel: string | null;
+        connectedBy: string | null;
+        connectedAt: string;
+        checkedAt: string;
+        certificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        nextCertificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        apps: string[];
+    }>;
+    /** Signs in with the new certificate and, if that works, switches to it. */
+    activateCertificate: (o: string, p: string, by: string) => Promise<{
+        id: string;
+        organizationId: string;
+        provider: string;
+        status: "pending" | "connected" | "needs_reconnect";
+        config: {
+            [key: string]: string;
+        };
+        accountLabel: string | null;
+        connectedBy: string | null;
+        connectedAt: string;
+        checkedAt: string;
+        certificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        nextCertificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        apps: string[];
+    }>;
+    /** Disconnects the provider and every app signing in through it. */
+    disconnectProvider: (o: string, p: string, by: string) => Promise<void>;
+    /** Values an app's steps ask for, kept on the provider connection. */
+    setProviderSettings: (o: string, p: string, values: Record<string, string>, by: string) => Promise<{
+        settings: {
+            [key: string]: string;
+        };
+    }>;
+    connections: (o: string) => Promise<{
+        id: string;
+        organizationId: string;
+        connectorId: string;
+        providerId: string | null;
+        capabilities: string[];
+        config: {
+            [key: string]: string;
+        };
+        status: "connected" | "needs_reconnect";
+        accountLabel: string | null;
+        connectedBy: string | null;
+        connectedAt: string;
+        checkedAt: string;
+    }[]>;
+    connect: (o: string, a: string, body: {
+        capabilities: string[];
+        fields: Record<string, string>;
+        connectedBy: string;
+    }) => Promise<{
+        connection: import("./schema.js").components["schemas"]["Connection"];
+        checks: import("./schema.js").components["schemas"]["Check"][];
+    }>;
+    startConsent: (o: string, a: string, body: {
+        capabilities: string[];
+        redirectUri: string;
+    }) => Promise<{
+        url: string;
+        nonce: string;
+    }>;
+    /** `redirect`: the approval came back; the admin signs in to that organization next.
+     *  `provider`: the approval connected the provider; the app still needs its own settings. */
+    finishConsent: (o: string, a: string, body: {
+        state: string;
+        nonce: string;
+        params: Record<string, string>;
+        connectedBy: string;
+    }) => Promise<{
+        connection: import("./schema.js").components["schemas"]["Connection"];
+        checks: import("./schema.js").components["schemas"]["Check"][];
+    } | {
+        redirect: string;
+    } | {
+        provider: import("./schema.js").components["schemas"]["ProviderConnection"];
+    }>;
+    setCeiling: (o: string, a: string, capabilities: string[], by: string) => Promise<void>;
+    /** Recorded: a failure marks the app as needing reconnecting, so it names the admin. */
+    check: (o: string, a: string, by: string) => Promise<{
+        ok: true;
+        checks: import("./schema.js").components["schemas"]["Check"][];
+    } | {
+        ok: false;
+        error: string;
+    }>;
+    /** The same checks, read only: a failure here does not mark the app. */
+    peek: (o: string, a: string) => Promise<{
+        ok: true;
+        checks: import("./schema.js").components["schemas"]["Check"][];
+    } | {
+        ok: false;
+        error: string;
+    }>;
+    /** The sites added to an app, the whole list at once. */
+    setSites: (o: string, a: string, sites: string[], by: string) => Promise<{
+        sites: string[];
+    }>;
+    /** Whether the app can open each added site, or just `site`. */
+    checkSites: (o: string, a: string, site?: string) => Promise<{
+        sites: import("./schema.js").components["schemas"]["SiteAccess"][];
+    }>;
+    /** Whether the app can reach one agent's own address (its mailbox) yet. */
+    agentAccess: (o: string, a: string, value: string, by: string) => Promise<{
+        value: string;
+        status: "granted" | "not_granted" | "not_found" | "failed";
+        message: string;
+    }>;
+    disconnect: (o: string, a: string, by: string) => Promise<void>;
+    agents: (o: string) => Promise<{
+        id: string;
+        organizationId: string;
+        name: string;
+        status: "active" | "disabled";
+        createdBy: string | null;
+        createdAt: string;
+        lastUsedAt: string | null;
+        grants: import("./schema.js").components["schemas"]["Grant"][];
+    }[]>;
+    createAgent: (o: string, body: {
+        name: string;
+        createdBy: string;
+    }) => Promise<{
+        agent: import("./schema.js").components["schemas"]["NewAgent"];
+        key: string;
+    }>;
+    setAgentStatus: (o: string, id: string, status: Agent["status"], by: string) => Promise<void>;
+    newKey: (o: string, id: string, by: string) => Promise<{
+        key: string;
+    }>;
+    deleteAgent: (o: string, id: string, by: string) => Promise<void>;
+    setGrant: (o: string, id: string, a: string, capabilities: string[], limits: Limits, by: string) => Promise<void>;
+    removeGrant: (o: string, id: string, a: string, by: string) => Promise<void>;
+    /** Recent requests, newest first, of one key (`agent`), one app, or both. */
+    audit: (o: string, filter: {
+        agent?: string;
+        app?: string;
+    }, limit?: number) => Promise<{
+        at: string;
+        agentId: string | null;
+        agentName: string | null;
+        connectorId: string;
+        tool: string;
+        target: string | null;
+        decision: "allowed" | "denied" | "failed";
+        reason: string | null;
+        vendorStatus: number | null;
+    }[]>;
+    confirmed: (o: string) => Promise<string[]>;
+    setConfirmed: (o: string, step: string, on: boolean, by: string) => Promise<void>;
+    teamsBots: (o: string) => Promise<{
+        id: string;
+        organizationId: string;
+        agentId: string;
+        botAppId: string | null;
+        teamsAppId: string;
+        tenantId: string;
+        displayName: string;
+        manifestVersion: number;
+        status: "awaiting_setup" | "connected" | "needs_reconnect";
+        createdBy: string | null;
+        createdAt: string;
+        lastRefusedAt: string | null;
+        lastRefusedReason: string | null;
+        certificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        nextCertificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        madeByService: boolean;
+        publishedVersion: string | null;
+        packageVersion: string;
+        messagingEndpoint: string | null;
+        mcpUrl: string | null;
+        installedIn: import("./schema.js").components["schemas"]["TeamsPlace"][];
+    }[]>;
+    createTeamsBot: (o: string, id: string, displayName: string, by: string) => Promise<{
+        id: string;
+        organizationId: string;
+        agentId: string;
+        botAppId: string | null;
+        teamsAppId: string;
+        tenantId: string;
+        displayName: string;
+        manifestVersion: number;
+        status: "awaiting_setup" | "connected" | "needs_reconnect";
+        createdBy: string | null;
+        createdAt: string;
+        lastRefusedAt: string | null;
+        lastRefusedReason: string | null;
+        certificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        nextCertificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        madeByService: boolean;
+        publishedVersion: string | null;
+        packageVersion: string;
+    }>;
+    /** Proves the application ID the setup script printed by signing in as it. */
+    connectTeamsBot: (o: string, id: string, botAppId: string, by: string) => Promise<{
+        id: string;
+        organizationId: string;
+        agentId: string;
+        botAppId: string | null;
+        teamsAppId: string;
+        tenantId: string;
+        displayName: string;
+        manifestVersion: number;
+        status: "awaiting_setup" | "connected" | "needs_reconnect";
+        createdBy: string | null;
+        createdAt: string;
+        lastRefusedAt: string | null;
+        lastRefusedReason: string | null;
+        certificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        nextCertificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        madeByService: boolean;
+        publishedVersion: string | null;
+        packageVersion: string;
+    }>;
+    checkTeamsBot: (o: string, id: string) => Promise<{
+        ok: true;
+    } | {
+        ok: false;
+        error: string;
+    }>;
+    teamsTest: (o: string, id: string, conversationId: string, by: string) => Promise<{
+        ok: true;
+    }>;
+    /** Forgets the bot. What Add to Teams made is deleted (`failed`: what could not be);
+     *  `removal` is the commands for the rest. */
+    removeTeamsBot: (o: string, id: string, by: string) => Promise<{
+        removal: string;
+        failed: string[];
+    }>;
+    newTeamsCertificate: (o: string, id: string, by: string) => Promise<{
+        bot: import("./schema.js").components["schemas"]["TeamsBotRecord"];
+        command: string | null;
+        certificate: string;
+    }>;
+    activateTeamsCertificate: (o: string, id: string, by: string) => Promise<{
+        id: string;
+        organizationId: string;
+        agentId: string;
+        botAppId: string | null;
+        teamsAppId: string;
+        tenantId: string;
+        displayName: string;
+        manifestVersion: number;
+        status: "awaiting_setup" | "connected" | "needs_reconnect";
+        createdBy: string | null;
+        createdAt: string;
+        lastRefusedAt: string | null;
+        lastRefusedReason: string | null;
+        certificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        nextCertificate: import("./schema.js").components["schemas"]["CertificateInfo"] | null;
+        madeByService: boolean;
+        publishedVersion: string | null;
+        packageVersion: string;
+    }>;
+    /** The Teams page's set-up-once steps, checked live. */
+    teamsSetupState: (o: string) => Promise<{
+        [key: string]: {
+            state: "done" | "failing" | "todo";
+            message: string;
+        };
+    }>;
+    /** Makes the agent's bot in the tenant, each part only if missing. */
+    addToTeams: (o: string, id: string, displayName: string, by: string) => Promise<{
+        steps: import("./schema.js").components["schemas"]["AddStep"][];
+        bot: import("./schema.js").components["schemas"]["TeamsBotRecord"];
+    }>;
+    startTeamsPublish: (o: string, id: string, redirectUri: string) => Promise<{
+        url: string;
+        nonce: string;
+    }>;
+    finishTeamsPublish: (o: string, body: {
+        state: string;
+        nonce: string;
+        params: Record<string, string>;
+        by: string;
+    }) => Promise<{
+        agentId: string;
+        version: string;
+        changed: boolean;
+    }>;
+    teamsTargets: (o: string, id: string, kind: "team" | "person", q: string) => Promise<{
+        id: string;
+        name: string;
+        detail: string | null;
+    }[]>;
+    installTeamsBot: (o: string, id: string, kind: "team" | "chat" | "person", target: string, by: string) => Promise<{
+        result: "added" | "already";
+    }>;
+    /** A file the service makes (the setup script, certificate or Teams app package), as is. */
+    teamsFile: (o: string, id: string, file: "kit" | "package" | "certificate") => Promise<Response>;
+    teamsTrigger: (o: string, id: string) => Promise<{
+        agentId: string;
+        enabled: boolean;
+        runner: string;
+        settings: {
+            [key: string]: unknown;
+        };
+        hasSigningSecret: boolean;
+        managedAgentId: string | null;
+        environmentId: string | null;
+        vaultIds: string[];
+        budgetCents: number;
+        maxRunsPerHour: number;
+        maxCentsPerDay: number;
+        maxConcurrent: number;
+        replyMode: "mentions" | "all";
+        allowedTeams: string[];
+        allowedPeople: string[];
+        anyoneInOrganization: boolean;
+        updatedBy: string | null;
+        updatedAt: string;
+    } | null>;
+    setTeamsTrigger: (o: string, id: string, body: TeamsTriggerInput) => Promise<{
+        agentId: string;
+        enabled: boolean;
+        runner: string;
+        settings: {
+            [key: string]: unknown;
+        };
+        hasSigningSecret: boolean;
+        managedAgentId: string | null;
+        environmentId: string | null;
+        vaultIds: string[];
+        budgetCents: number;
+        maxRunsPerHour: number;
+        maxCentsPerDay: number;
+        maxConcurrent: number;
+        replyMode: "mentions" | "all";
+        allowedTeams: string[];
+        allowedPeople: string[];
+        anyoneInOrganization: boolean;
+        updatedBy: string | null;
+        updatedAt: string;
+    }>;
+    teamsRuns: (o: string, id: string, limit?: number) => Promise<{
+        id: string;
+        agentId: string;
+        botId: string;
+        conversationId: string;
+        threadId: string;
+        triggerActivityId: string;
+        runner: string;
+        sessionId: string | null;
+        state: "starting" | "running" | "idle" | "ended" | "failed" | "no_reply";
+        error: string | null;
+        note: string | null;
+        requestedBy: string | null;
+        replyCount: number;
+        repliedAt: string | null;
+        costCents: number | null;
+        turns: number;
+        startedAt: string;
+        finishedAt: string | null;
+        replyTokenAt: string;
+    }[]>;
+    eventSubscriptions: (o: string) => Promise<{
+        id: string;
+        connectorId: string;
+        source: "webhook" | "poll";
+        filter: string;
+        intervalSeconds: number;
+        cursor: string | null;
+        polledAt: string | null;
+        lastError: string | null;
+        registered: string | null;
+        url: string | null;
+        createdBy: string;
+        createdAt: string;
+    }[]>;
+    subscribeEvents: (o: string, body: EventSubscriptionInput) => Promise<{
+        subscription: import("./schema.js").components["schemas"]["EventSubscription"];
+        secret: string | null;
+        setup: {
+            title: string;
+            body: string;
+            link?: {
+                label: string;
+                href: string;
+            };
+            copy?: string[];
+            shell?: "bash" | "powershell";
+            permissions?: boolean;
+            certificate?: boolean;
+            click?: string[];
+            clickUnavailable?: true;
+            siteRole?: "read" | "write";
+            agentCheck?: boolean;
+            confirm?: string;
+            live?: string;
+            settings?: {
+                id: string;
+                label: string;
+                help?: string;
+                placeholder?: string;
+                pattern: string;
+            }[];
+            option?: {
+                field: string;
+                value: string;
+            };
+        }[];
+        registration: {
+            ok: boolean;
+            message: string;
+        } | null;
+    }>;
+    rotateEventSecret: (o: string, id: string, by: string) => Promise<{
+        subscription: import("./schema.js").components["schemas"]["EventSubscription"];
+        secret: string;
+    }>;
+    unsubscribeEvents: (o: string, id: string, by: string) => Promise<void>;
+    eventTriggers: (o: string, id: string) => Promise<{
+        id: string;
+        agentId: string;
+        connectorId: string;
+        enabled: boolean;
+        eventTypes: string[];
+        conditions: ({
+            field: string;
+            in: string[];
+        } | {
+            field: string;
+            notIn: string[];
+        })[];
+        prompt: string;
+        runner: string;
+        settings: {
+            [key: string]: unknown;
+        };
+        hasSigningSecret: boolean;
+        managedAgentId: string | null;
+        environmentId: string | null;
+        vaultIds: string[];
+        budgetCents: number;
+        maxRunsPerHour: number;
+        maxCentsPerDay: number;
+        maxConcurrent: number;
+        updatedBy: string | null;
+        updatedAt: string;
+    }[]>;
+    setEventTrigger: (o: string, id: string, a: string, body: EventTriggerInput) => Promise<{
+        id: string;
+        agentId: string;
+        connectorId: string;
+        enabled: boolean;
+        eventTypes: string[];
+        conditions: ({
+            field: string;
+            in: string[];
+        } | {
+            field: string;
+            notIn: string[];
+        })[];
+        prompt: string;
+        runner: string;
+        settings: {
+            [key: string]: unknown;
+        };
+        hasSigningSecret: boolean;
+        managedAgentId: string | null;
+        environmentId: string | null;
+        vaultIds: string[];
+        budgetCents: number;
+        maxRunsPerHour: number;
+        maxCentsPerDay: number;
+        maxConcurrent: number;
+        updatedBy: string | null;
+        updatedAt: string;
+    }>;
+    removeEventTrigger: (o: string, id: string, a: string, by: string) => Promise<void>;
+    eventRuns: (o: string, id: string, limit?: number) => Promise<{
+        id: string;
+        agentId: string;
+        triggerId: string;
+        connectorId: string;
+        eventType: string;
+        deliveryId: string;
+        runner: string;
+        sessionId: string | null;
+        state: "starting" | "running" | "ended" | "failed";
+        error: string | null;
+        costCents: number | null;
+        startedAt: string;
+        finishedAt: string | null;
+    }[]>;
+    claudeKey: (o: string) => Promise<{
+        set: false;
+    } | {
+        set: true;
+        ending: string;
+        by: string | null;
+        at: string;
+    }>;
+    setClaudeKey: (o: string, apiKey: string, by: string) => Promise<{
+        set: true;
+        ending: string;
+        by: string | null;
+        at: string;
+        agents: import("./schema.js").components["schemas"]["ClaudeAgent"][];
+    }>;
+    removeClaudeKey: (o: string, by: string) => Promise<void>;
+    claudeAgents: (o: string) => Promise<{
+        id: string;
+        name: string;
+    }[]>;
+};