Class AlertsClient

Index

Constructors

Methods

createAlert getAlert listAlerts listAlertsIter trashAlert updateAlert

Constructors

constructor

new AlertsClient(options: ClientOptions): AlertsClient
Parameters
- options: ClientOptions
Returns AlertsClient
- Defined in v2/client.ts:54

Methods

createAlert

createAlert(req: CreateAlertRequest, options?: CallOptions): Promise<Alert>
Create Alert
Parameters
- req: CreateAlertRequest
- Optionaloptions: CallOptions
Returns Promise<Alert>
- Defined in v2/client.ts:70

getAlert

getAlert(req: GetAlertRequest, options?: CallOptions): Promise<Alert>
Gets an alert.
Parameters
- req: GetAlertRequest
- Optionaloptions: CallOptions
Returns Promise<Alert>
- Defined in v2/client.ts:100

listAlerts

listAlerts(
req: ListAlertsRequest,
options?: CallOptions,
): Promise<ListAlertsResponse>
Gets a list of alerts accessible to the user, ordered by creation time.
Parameters
- req: ListAlertsRequest
- Optionaloptions: CallOptions
Returns Promise<ListAlertsResponse>
- Defined in v2/client.ts:126

listAlertsIter

listAlertsIter(
req: ListAlertsRequest,
options?: CallOptions,
): AsyncGenerator<Alert>
Parameters
- req: ListAlertsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Alert>
- Defined in v2/client.ts:163

trashAlert

trashAlert(req: TrashAlertRequest, options?: CallOptions): Promise<Empty>
Moves an alert to the trash. Trashed alerts immediately disappear from list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days.
Parameters
- req: TrashAlertRequest
- Optionaloptions: CallOptions
Returns Promise<Empty>
- Defined in v2/client.ts:181

updateAlert

updateAlert(req: UpdateAlertRequest, options?: CallOptions): Promise<Alert>
Update alert
Parameters
- req: UpdateAlertRequest
- Optionaloptions: CallOptions
Returns Promise<Alert>
- Defined in v2/client.ts:216