Class IncidentManager

Index

Constructors

Properties

Methods

acknowledge create delete get getAll getTimeline resolve update

Constructors

constructor

new IncidentManager(__namedParameters): IncidentManager
Parameters
- __namedParameters: BetterUptime
Returns IncidentManager
- Defined in incidents/IncidentManager.ts:8

Properties

`Private` apiClient

apiClient: AxiosInstance

Methods

acknowledge

acknowledge(incident_id, __namedParameters?): Promise<any>
This will acknowledge an ongoing incident, preventing further escalations.
Parameters
- incident_id: string
- __namedParameters: {
  acknowledged_by?: string;
  } = {}
  - Optional acknowledged_by?: string
Returns Promise<any>
- Defined in incidents/IncidentManager.ts:89

create

create(newIncident): Promise<any>
Returns either a newly created incident, or validation errors.
Parameters
- newIncident: any
Returns Promise<any>
- Defined in incidents/IncidentManager.ts:71

delete

delete(incident_id): Promise<boolean>
Permanently deletes an existing incident.
Parameters
- incident_id: string
  Incident ID you want to remove
Returns Promise<boolean>
True if success
- Defined in incidents/IncidentManager.ts:165

get

get(incident_id): Promise<any>
Returns a single incident by ID.
Parameters
- incident_id: string
Returns Promise<any>
- Defined in incidents/IncidentManager.ts:33

getAll

getAll(__namedParameters?): Promise<any>
Returns a list of all your incidents.
Parameters
- __namedParameters: {
  page?: number;
  per_page?: number;
  } = {}
  - Optional page?: number
  - Optional per_page?: number
Returns Promise<any>
- Defined in incidents/IncidentManager.ts:15

getTimeline

getTimeline(incident_id): Promise<any>
Returns a list of timeline items for the given incident.
Parameters
- incident_id: string
Returns Promise<any>
- Defined in incidents/IncidentManager.ts:51

resolve

resolve(incident_id, __namedParameters?): Promise<any>
This will resolve an ongoing incident.
Parameters
- incident_id: string
- __namedParameters: {
  resolved_by?: string;
  } = {}
  - Optional resolved_by?: string
Returns Promise<any>
- Defined in incidents/IncidentManager.ts:115

update

update(incident_id, newIncident): Promise<any>
Update the attributes of an existing incident. Send only the parameters you wish to change
Parameters
- incident_id: string
  Incident ID you want to change
- newIncident: Partial<any>
Returns Promise<any>
- Defined in incidents/IncidentManager.ts:142

Generated using TypeDoc