backd-js 0.1.15 → 0.2.0

package/types/admin.d.ts

@@ -0,0 +1,709 @@
+import { Job } from './functions.js';
+export type Client = import('./client.js').Client;
+export type RequestOptions = import('./client.js').RequestOptions;
+export type AdminUser = {
+    id: string;
+    email: string;
+    email_verified: boolean;
+    locale: string;
+    roles: string[];
+    disabled: boolean;
+    /**
+     * CIDR networks the user's admin requests must come from; empty: no own restriction.
+     */
+    admin_networks: string[];
+    /**
+     * CIDR networks the user's login and session must be used from; empty: anywhere.
+     */
+    login_networks: string[];
+    created_at: string;
+    updated_at: string;
+    /**
+     * When the user was erased; a tombstone keeps only its id (and a placeholder email).
+     */
+    erased_at: string | null;
+};
+export type UserPage = {
+    items: AdminUser[];
+    limit: number;
+    skip: number;
+    has_more: boolean;
+};
+export type Invitation = {
+    id: string;
+    /**
+     * Only this email may use it; null for anyone.
+     */
+    email: string | null;
+    created_by: string;
+    created_at: string;
+    expires_at: string;
+};
+export type OwnedReport = {
+    user: {
+        id: string;
+        status: 'active' | 'deactivated' | 'erased';
+    };
+    /**
+     *   `owned` counts the documents the user owns; `pull` and `unset` count, per field, the documents that hold the user.
+     */
+    collections: Array<{
+        database: string;
+        collection: string;
+        action: 'delete' | 'anonymize' | null;
+        owned: number;
+        remove?: string[];
+        replace?: string[];
+        pull?: Record<string, number>;
+        unset?: Record<string, number>;
+    }>;
+    /**
+     * `<database>.<collection>` of the collections an erase leaves alone.
+     */
+    without_policy: string[];
+};
+export type NewInvitation = Invitation & {
+    token: string;
+};
+export type SentInvitation = Invitation & {
+    sent: true;
+};
+export type APIKeyInfo = {
+    name: string;
+    role: 'data' | 'admin';
+    /**
+     * First characters of the key.
+     */
+    prefix: string;
+    /**
+     * Where it may be used from; empty: anywhere.
+     */
+    networks: string[];
+    created_at: string;
+    last_used_at: string | null;
+    expires_at: string | null;
+};
+export type NewAPIKey = APIKeyInfo & {
+    key: string;
+};
+export type AuditRecord = {
+    id: string;
+    at: string;
+    /**
+     * Such as `user.create`, `role.add`, `apikey.create`, `admin.login`.
+     */
+    action: string;
+    /**
+     * `user:<id>`, `key:<name>`, `anonymous`, `config:realm.yaml` or `cli:bootstrap`.
+     */
+    actor: string;
+    /**
+     * `user:<id>`, `key:<name>`, `invitation:<id>`, or null.
+     */
+    target: string | null;
+    details: Record<string, unknown>;
+    request_id: string | null;
+    client_ip: string | null;
+};
+export type SecretInfo = {
+    /**
+     * Its database scope; empty means the realm scope.
+     */
+    database: string;
+    name: string;
+    created_at: string;
+    updated_at: string;
+    /**
+     * Who last set it, such as `user:<id>` or `key:<name>`.
+     */
+    updated_by: string;
+};
+export type InvocationRecord = {
+    id: string;
+    at: string;
+    /**
+     * `<database>/<name>`.
+     */
+    function: string;
+    /**
+     * `user:<id>`, `key:<name>`, `anonymous`, ...
+     */
+    actor: string;
+    /**
+     * `sync` or `async`.
+     */
+    mode: string;
+    /**
+     * `ok`, `function_error`, `timeout`, `memory`, `cpu`, `crash`, `output_too_large`, `busy` or `bundle`.
+     */
+    status: string;
+    /**
+     * The function's own error code.
+     */
+    code: string | null;
+    duration_ms: number;
+    request_id: string | null;
+    /**
+     * The async job this call ran for.
+     */
+    job_id: string | null;
+    /**
+     * The invocation that called this one with `ctx.call`.
+     */
+    parent_id: string | null;
+    /**
+     * `http`, `function`, `cron`, `admin` or `backd:<event>`.
+     */
+    origin: string | null;
+    logs: {
+        level: string;
+        line: string;
+    }[];
+};
+export type InvocationsPage = {
+    /**
+     * Newest first.
+     */
+    items: InvocationRecord[];
+    limit: number;
+    skip: number;
+    has_more: boolean;
+};
+export type AuditPage = {
+    /**
+     * Newest first.
+     */
+    items: AuditRecord[];
+    limit: number;
+    skip: number;
+    has_more: boolean;
+};
+export type JobSummary = {
+    /**
+     * For cron runs, `cron_<database>_<function>_<yyyymmddhhmm>` (UTC).
+     */
+    id: string;
+    /**
+     * `<database>/<name>`.
+     */
+    function: string;
+    status: 'queued' | 'running' | 'done';
+    /**
+     * True for a cron run.
+     */
+    scheduled: boolean;
+    /**
+     * More than 1 after a worker was lost mid-run.
+     */
+    attempts: number;
+    created_at: string;
+    completed_at: string | null;
+    /**
+     * Null until `done`.
+     */
+    result: {
+        status: string;
+        code: string | null;
+        duration_ms: number;
+    } | null;
+};
+export type JobsPage = {
+    /**
+     * Newest first.
+     */
+    items: JobSummary[];
+    limit: number;
+    skip: number;
+    has_more: boolean;
+};
+/**
+ * @typedef {import('./client.js').Client} Client
+ * @typedef {import('./client.js').RequestOptions} RequestOptions
+ */
+/**
+ * A user as the admin API shows it.
+ * @typedef {object} AdminUser
+ * @property {string} id
+ * @property {string} email
+ * @property {boolean} email_verified
+ * @property {string} locale
+ * @property {string[]} roles
+ * @property {boolean} disabled
+ * @property {string[]} admin_networks  CIDR networks the user's admin requests must come from; empty: no own restriction.
+ * @property {string[]} login_networks  CIDR networks the user's login and session must be used from; empty: anywhere.
+ * @property {string} created_at
+ * @property {string} updated_at
+ * @property {string | null} erased_at   When the user was erased; a tombstone keeps only its id (and a placeholder email).
+ */
+/**
+ * @typedef {object} UserPage
+ * @property {AdminUser[]} items
+ * @property {number} limit
+ * @property {number} skip
+ * @property {boolean} has_more
+ */
+/**
+ * @typedef {object} Invitation
+ * @property {string} id
+ * @property {string | null} email    Only this email may use it; null for anyone.
+ * @property {string} created_by
+ * @property {string} created_at
+ * @property {string} expires_at
+ */
+/**
+ * What erasing a user would do, for the collections that declare a policy
+ * (`collection.yaml`); the others are only named in `without_policy`.
+ * @typedef {object} OwnedReport
+ * @property {{ id: string, status: 'active' | 'deactivated' | 'erased' }} user
+ * @property {Array<{ database: string, collection: string, action: 'delete' | 'anonymize' | null, owned: number, remove?: string[], replace?: string[], pull?: Record<string, number>, unset?: Record<string, number> }>} collections
+ *   `owned` counts the documents the user owns; `pull` and `unset` count, per field, the documents that hold the user.
+ * @property {string[]} without_policy  `<database>.<collection>` of the collections an erase leaves alone.
+ */
+/**
+ * @typedef {Invitation & { token: string }} NewInvitation
+ * `token` (`bdi_…`) is returned only when the invitation is created.
+ */
+/**
+ * @typedef {Invitation & { sent: true }} SentInvitation
+ * An invitation that was emailed: nobody holds its token.
+ */
+/**
+ * An API key as the admin API lists it (never the key itself).
+ * @typedef {object} APIKeyInfo
+ * @property {string} name
+ * @property {'data' | 'admin'} role
+ * @property {string} prefix          First characters of the key.
+ * @property {string[]} networks      Where it may be used from; empty: anywhere.
+ * @property {string} created_at
+ * @property {string | null} last_used_at
+ * @property {string | null} expires_at
+ */
+/**
+ * @typedef {APIKeyInfo & { key: string }} NewAPIKey
+ * `key` (`bdk_…`) is returned only when the key is created.
+ */
+/**
+ * One entry of the realm's audit trail. Never holds secrets or emails.
+ * @typedef {object} AuditRecord
+ * @property {string} id
+ * @property {string} at
+ * @property {string} action          Such as `user.create`, `role.add`, `apikey.create`, `admin.login`.
+ * @property {string} actor           `user:<id>`, `key:<name>`, `anonymous`, `config:realm.yaml` or `cli:bootstrap`.
+ * @property {string | null} target   `user:<id>`, `key:<name>`, `invitation:<id>`, or null.
+ * @property {Record<string, unknown>} details
+ * @property {string | null} request_id
+ * @property {string | null} client_ip
+ */
+/**
+ * A function secret's metadata, as listed: never its value.
+ * @typedef {object} SecretInfo
+ * @property {string} database     Its database scope; empty means the realm scope.
+ * @property {string} name
+ * @property {string} created_at
+ * @property {string} updated_at
+ * @property {string} updated_by   Who last set it, such as `user:<id>` or `key:<name>`.
+ */
+/**
+ * One function call in the invocation history: what happened and the
+ * function's own console lines, never its input or output.
+ * @typedef {object} InvocationRecord
+ * @property {string} id
+ * @property {string} at
+ * @property {string} function            `<database>/<name>`.
+ * @property {string} actor               `user:<id>`, `key:<name>`, `anonymous`, ...
+ * @property {string} mode                `sync` or `async`.
+ * @property {string} status              `ok`, `function_error`, `timeout`, `memory`, `cpu`, `crash`, `output_too_large`, `busy` or `bundle`.
+ * @property {string | null} code         The function's own error code.
+ * @property {number} duration_ms
+ * @property {string | null} request_id
+ * @property {string | null} job_id       The async job this call ran for.
+ * @property {string | null} parent_id    The invocation that called this one with `ctx.call`.
+ * @property {string | null} origin       `http`, `function`, `cron`, `admin` or `backd:<event>`.
+ * @property {{ level: string, line: string }[]} logs
+ */
+/**
+ * @typedef {object} InvocationsPage
+ * @property {InvocationRecord[]} items   Newest first.
+ * @property {number} limit
+ * @property {number} skip
+ * @property {boolean} has_more
+ */
+/**
+ * @typedef {object} AuditPage
+ * @property {AuditRecord[]} items    Newest first.
+ * @property {number} limit
+ * @property {number} skip
+ * @property {boolean} has_more
+ */
+/**
+ * An async or scheduled job as the admin listing shows it: its state and
+ * how it ended, never its input or output.
+ * @typedef {object} JobSummary
+ * @property {string} id                     For cron runs, `cron_<database>_<function>_<yyyymmddhhmm>` (UTC).
+ * @property {string} function               `<database>/<name>`.
+ * @property {'queued' | 'running' | 'done'} status
+ * @property {boolean} scheduled             True for a cron run.
+ * @property {number} attempts               More than 1 after a worker was lost mid-run.
+ * @property {string} created_at
+ * @property {string | null} completed_at
+ * @property {{ status: string, code: string | null, duration_ms: number } | null} result   Null until `done`.
+ */
+/**
+ * @typedef {object} JobsPage
+ * @property {JobSummary[]} items    Newest first.
+ * @property {number} limit
+ * @property {number} skip
+ * @property {boolean} has_more
+ */
+/**
+ * The admin API: `client.admin`. Needs a client created with an admin API
+ * key, or signed in as a user holding one of the realm's admin roles.
+ */
+export declare class Admin {
+    /** @internal */
+    client: import("./client.js").Client;
+    /** Users and their roles. */
+    users: AdminUsers;
+    /** Invitations for realms with `signup: invite`. */
+    invitations: AdminInvitations;
+    /** The realm's API keys. */
+    apiKeys: AdminAPIKeys;
+    /** The realm's audit trail (read-only). */
+    audit: AdminAudit;
+    /** The realm's async and scheduled jobs (read-only). */
+    jobs: AdminJobs;
+    /** Function secrets: set and delete their values, list their metadata. */
+    secrets: AdminSecrets;
+    /** The realm's function invocation history (read-only). */
+    invocations: AdminInvocations;
+    /** @param {Client} client */
+    constructor(client: Client);
+    /**
+     * Runs a function by hand, internal ones included: to re-run a clean-up
+     * that failed, or to test a scheduled function. `function` is
+     * `<database>/<name>`. With `as` (a user's email) the function runs with
+     * that user as `ctx.user`; without it there is no user. Returns the
+     * output of a `sync` function, and a `Job` handle for an `async` one,
+     * like `db.fn()`. The function's `invoke` rule and `rate_limit` don't
+     * apply; every run is audited.
+     * @param {string} fn
+     * @param {{ input?: unknown, as?: string, idempotencyKey?: string }} [params]
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<unknown | Job>}
+     */
+    invokeFunction(fn: string, { input, as, idempotencyKey }?: {
+        input?: unknown;
+        as?: string;
+        idempotencyKey?: string;
+    }, opts?: RequestOptions): Promise<unknown | Job>;
+    /**
+     * @internal
+     * @param {import('./client.js').RequestInit} req
+     */
+    _request(req: import('./client.js').RequestInit): Promise<import("./client.js").RawResponse>;
+}
+declare class AdminUsers {
+    /** @internal */
+    admin: Admin;
+    /** @param {Admin} admin */
+    constructor(admin: Admin);
+    /**
+     * A page of users, sorted by email.
+     * @param {{ limit?: number, skip?: number }} [params]
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<UserPage>}
+     */
+    list(params?: {
+        limit?: number;
+        skip?: number;
+    }, opts?: RequestOptions): Promise<UserPage>;
+    /**
+     * The user with this email (case-insensitive), or null.
+     * @param {string} email
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<AdminUser | null>}
+     */
+    find(email: string, opts?: RequestOptions): Promise<AdminUser | null>;
+    /**
+     * @param {string} id
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<AdminUser>}
+     */
+    get(id: string, opts?: RequestOptions): Promise<AdminUser>;
+    /**
+     * Creates a user. Without a password they can't sign in until one is set.
+     * @param {{ email: string, password?: string }} input
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<AdminUser>}
+     */
+    create({ email, password }: {
+        email: string;
+        password?: string;
+    }, opts?: RequestOptions): Promise<AdminUser>;
+    /**
+     * Changes a user's flags. Disabling ends all their sessions. Emails can't change.
+     * @param {string} id
+     * @param {{ emailVerified?: boolean, disabled?: boolean }} changes
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<AdminUser>}
+     */
+    update(id: string, { emailVerified, disabled }: {
+        emailVerified?: boolean;
+        disabled?: boolean;
+    }, opts?: RequestOptions): Promise<AdminUser>;
+    /**
+     * Erases a user. **Irreversible.** The user becomes a tombstone at once (the
+     * id stays, the email becomes `erased-<id>@erased.invalid`, and their
+     * sessions, sign-in methods and email tokens are deleted); a worker then
+     * applies the `collection.yaml` policy of every collection that declares one.
+     * Resolves with the erase job (`origin: backd:account.erase` in
+     * `admin.jobs.list()`); the counts land in the audit trail as `user.erased`.
+     * To keep the data, deactivate with `update(id, { disabled: true })`.
+     * @param {string} id
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<{ id: string, status: 'queued' | 'running' | 'done' }>}
+     */
+    delete(id: string, opts?: RequestOptions): Promise<{
+        id: string;
+        status: 'queued' | 'running' | 'done';
+    }>;
+    /**
+     * Sets a user's password and ends all their sessions.
+     * @param {string} id
+     * @param {string} password
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<void>}
+     */
+    setPassword(id: string, password: string, opts?: RequestOptions): Promise<void>;
+    /**
+     * What erasing a user would do: counts per collection that declares a policy,
+     * and the collections an erase leaves alone. No document content.
+     * @param {string} id
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<OwnedReport>}
+     */
+    owned(id: string, opts?: RequestOptions): Promise<OwnedReport>;
+    /**
+     * Changes a user's email address at once, in a realm with `email`: the new
+     * address counts as verified, the user's sessions end, the old address is
+     * sent a link to undo the change and the new one is told.
+     * @param {string} id
+     * @param {string} email
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<AdminUser>}
+     */
+    changeEmail(id: string, email: string, opts?: RequestOptions): Promise<AdminUser>;
+    /**
+     * Assigns a role declared in realm.yaml.
+     * @param {string} id
+     * @param {string} role
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<AdminUser>}
+     */
+    addRole(id: string, role: string, opts?: RequestOptions): Promise<AdminUser>;
+    /**
+     * Takes a role away.
+     * @param {string} id
+     * @param {string} role
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<AdminUser>}
+     */
+    removeRole(id: string, role: string, opts?: RequestOptions): Promise<AdminUser>;
+    /**
+     * Replaces the user's network restrictions (IP addresses or CIDR
+     * networks); empty lists remove them. Settings in realm.yaml win at the
+     * next startup.
+     * @param {string} id
+     * @param {{ adminNetworks?: string[], loginNetworks?: string[] }} networks
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<AdminUser>}
+     */
+    setNetworks(id: string, { adminNetworks, loginNetworks }: {
+        adminNetworks?: string[];
+        loginNetworks?: string[];
+    }, opts?: RequestOptions): Promise<AdminUser>;
+}
+declare class AdminAPIKeys {
+    /** @internal */
+    admin: Admin;
+    /** @param {Admin} admin */
+    constructor(admin: Admin);
+    /**
+     * The realm's API keys, by name; never the keys themselves.
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<APIKeyInfo[]>}
+     */
+    list(opts?: RequestOptions): Promise<APIKeyInfo[]>;
+    /**
+     * Creates a key; store its `key` now, it is never shown again.
+     * @param {{ name: string, role?: 'data' | 'admin', expiresIn?: string, networks?: string[] }} input
+     *   `role` defaults to data; `expiresIn`: days (`90d`) or Go durations (`12h`).
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<NewAPIKey>}
+     */
+    create({ name, role, expiresIn, networks }: {
+        name: string;
+        role?: 'data' | 'admin';
+        expiresIn?: string;
+        networks?: string[];
+    }, opts?: RequestOptions): Promise<NewAPIKey>;
+    /**
+     * Revokes a key: it stops working at once.
+     * @param {string} name
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<void>}
+     */
+    revoke(name: string, opts?: RequestOptions): Promise<void>;
+}
+declare class AdminAudit {
+    /** @internal */
+    admin: Admin;
+    /** @param {Admin} admin */
+    constructor(admin: Admin);
+    /**
+     * A page of the audit trail, newest first. `since` and `until` are dates
+     * or RFC 3339 strings.
+     * @param {{ action?: string, actor?: string, target?: string, since?: Date | string, until?: Date | string, limit?: number, skip?: number }} [params]
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<AuditPage>}
+     */
+    list(params?: {
+        action?: string;
+        actor?: string;
+        target?: string;
+        since?: Date | string;
+        until?: Date | string;
+        limit?: number;
+        skip?: number;
+    }, opts?: RequestOptions): Promise<AuditPage>;
+}
+declare class AdminSecrets {
+    /** @internal */
+    admin: Admin;
+    /** @param {Admin} admin */
+    constructor(admin: Admin);
+    /**
+     * The realm's secrets: scope, name and who last changed them. Values are
+     * write-only and never returned.
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<SecretInfo[]>}
+     */
+    list(opts?: RequestOptions): Promise<SecretInfo[]>;
+    /**
+     * Creates a secret or replaces its value; functions read it as
+     * `ctx.secrets` within about a minute. Without `database` it is the
+     * realm's secret (`realm.NAME` in function.yaml); with it, that
+     * database's (`NAME`).
+     * @param {string} name   Upper-case letters, digits and `_`.
+     * @param {string} value
+     * @param {{ database?: string }} [scope]
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<void>}
+     */
+    set(name: string, value: string, { database }?: {
+        database?: string;
+    }, opts?: RequestOptions): Promise<void>;
+    /**
+     * Removes a secret's value: a function that declares it answers
+     * `secret_missing` again.
+     * @param {string} name
+     * @param {{ database?: string }} [scope]
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<void>}
+     */
+    delete(name: string, { database }?: {
+        database?: string;
+    }, opts?: RequestOptions): Promise<void>;
+}
+declare class AdminInvocations {
+    /** @internal */
+    admin: Admin;
+    /** @param {Admin} admin */
+    constructor(admin: Admin);
+    /**
+     * A page of the function invocation history, newest first. `function` is
+     * `<database>/<name>`; `since` and `until` are dates or RFC 3339 strings.
+     * @param {{ function?: string, requestId?: string, since?: Date | string, until?: Date | string, limit?: number, skip?: number }} [params]
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<InvocationsPage>}
+     */
+    list(params?: {
+        function?: string;
+        requestId?: string;
+        since?: Date | string;
+        until?: Date | string;
+        limit?: number;
+        skip?: number;
+    }, opts?: RequestOptions): Promise<InvocationsPage>;
+}
+declare class AdminJobs {
+    /** @internal */
+    admin: Admin;
+    /** @param {Admin} admin */
+    constructor(admin: Admin);
+    /**
+     * A page of jobs, newest first: their state and outcome, never their
+     * input or output (read one job in full with `Job.status()`/`wait()`).
+     * `function` is `<database>/<name>`; `since` and `until` are dates or
+     * RFC 3339 strings, on the job's creation time.
+     * @param {{ function?: string, status?: 'queued' | 'running' | 'done', scheduled?: boolean, since?: Date | string, until?: Date | string, limit?: number, skip?: number }} [params]
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<JobsPage>}
+     */
+    list(params?: {
+        function?: string;
+        status?: 'queued' | 'running' | 'done';
+        scheduled?: boolean;
+        since?: Date | string;
+        until?: Date | string;
+        limit?: number;
+        skip?: number;
+    }, opts?: RequestOptions): Promise<JobsPage>;
+}
+declare class AdminInvitations {
+    /** @internal */
+    admin: Admin;
+    /** @param {Admin} admin */
+    constructor(admin: Admin);
+    /**
+     * Creates an invitation; deliver its `token` to the invitee.
+     * @param {{ email?: string, expiresIn?: string }} [input] `expiresIn`: days (`7d`) or Go durations (`12h`).
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<NewInvitation>}
+     */
+    create({ email, expiresIn }?: {
+        email?: string;
+        expiresIn?: string;
+    }, opts?: RequestOptions): Promise<NewInvitation>;
+    /**
+     * Creates an invitation and has `backd` email it to `email` (needs `email`
+     * in the realm's `realm.yaml`): the link opens a page where the person
+     * chooses a password, or your own page with `email.links.invitation` (see
+     * `auth.acceptInvitation`). There is no token to deliver. `redirectTo` is
+     * where the page after accepting may send them (within
+     * `email.allowed_redirects`); `locale` is the language of the email.
+     * @param {{ email: string, expiresIn?: string, redirectTo?: string, locale?: string }} input
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<SentInvitation>}
+     */
+    send({ email, expiresIn, redirectTo, locale }: {
+        email: string;
+        expiresIn?: string;
+        redirectTo?: string;
+        locale?: string;
+    }, opts?: RequestOptions): Promise<SentInvitation>;
+    /**
+     * Unused, unexpired invitations, newest first. Tokens are never listed.
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<Invitation[]>}
+     */
+    list(opts?: RequestOptions): Promise<Invitation[]>;
+    /**
+     * Revokes an invitation.
+     * @param {string} id
+     * @param {RequestOptions} [opts]
+     * @returns {Promise<void>}
+     */
+    revoke(id: string, opts?: RequestOptions): Promise<void>;
+}
+export {};