@hg8496/gridvis-client/dist/events/EventsEndpoint.d.ts

A library to access all GridVis data

import { AxiosInstance } from "axios";
import { IDevice } from "../device";
import { IProject } from "../project";
import { EventTypes, IEvent } from "./IEvent";
export declare class EventsEndpoint {
    private client;
    constructor(client: AxiosInstance);
    /**
     * Returns all events in the specified timeframe of the given types.
     * @param project The name or the instance of a project.
     * @param device The id or the instance of a device.
     * @param types A list of {@link EventTypes} to fetch from server.
     * @param start The start time in format of the GridVis REST interface. For Example ```NAMED_Today```
     * @param end The end time in format of the GridVis REST interface.
     * @param timezone Supports all Java timezones
     */
    getEvents(project: string | IProject, device: number | IDevice, types: EventTypes[], start: string, end: string, timezone?: string): Promise<IEvent[]>;
}