@axiomhq/js/dist/esm/types/annotations.d.ts

The official javascript bindings for the Axiom API

import HTTPClient from './httpClient.js';
export declare namespace annotations {
    interface Annotation {
        id: string;
        type: string;
        datasets: string[];
        title?: string;
        description?: string;
        url?: string;
        time: string;
        endTime?: string;
    }
    interface ListingQueryParams {
        datasets?: string[];
        start?: string;
        end?: string;
    }
    interface CreateRequest {
        type: string;
        datasets: string[];
        title?: string;
        description?: string;
        url?: string;
        time?: string;
        endTime?: string;
    }
    interface UpdateRequest {
        type?: string;
        datasets?: string[];
        title?: string;
        description?: string;
        url?: string;
        time?: string;
        endTime?: string;
    }
    class Service extends HTTPClient {
        private readonly localPath;
        list: (req?: ListingQueryParams) => Promise<Annotation[]>;
        get: (id: string) => Promise<Annotation>;
        create: (req: CreateRequest) => Promise<Annotation>;
        update: (id: string, req: UpdateRequest) => Promise<Annotation>;
        delete: (id: string) => Promise<Response>;
    }
}
//# sourceMappingURL=annotations.d.ts.map