@linode/api-v4/lib/account/events.d.ts

JavaScript wrapper around the Linode APIv4

import type { Filter, Params, ResourcePage } from '../types';
import type { Event, Notification } from './types';
/**
 * getEvents
 *
 * Retrieve a list of events on your account.
 *
 */
export declare const getEvents: (params?: Params, filter?: Filter) => Promise<ResourcePage<Event>>;
/**
 * getEvent
 *
 * Retrieve details about a single event.
 *
 */
export declare const getEvent: (eventId: number) => Promise<Event>;
/**
 * markEventSeen
 *
 * Marks all events up to and including the referenced event ID as "seen"
 *
 * @param eventId { number } ID of the event to designate as seen
 */
export declare const markEventSeen: (eventId: number) => Promise<{}>;
/**
 * markEventRead
 *
 * Set the "read" property of an event to true
 *
 * @param eventId { number } ID of the event to designate as read
 *
 * @deprecated As of `5/20/2025`, this endpoint is deprecated. It will be sunset on `6/17/2025`.
 *
 * If you depend on using `read`, you may be able to use `markEventSeen` and `seen` instead.
 * Please note that the `seen` endpoint functions differently and will mark all events up to and including the referenced event ID as "seen" rather than individual events.
 */
export declare const markEventRead: (eventId: number) => Promise<{}>;
/**
 * getNotifications
 *
 * Retrieve a list of active notifications on your account.
 *
 */
export declare const getNotifications: (params?: Params, filter?: Filter) => Promise<ResourcePage<Notification>>;
//# sourceMappingURL=events.d.ts.map