Class HeartbeatManager

Index

Constructors

Properties

Methods

create delete get getAll update

Constructors

constructor

new HeartbeatManager(__namedParameters): HeartbeatManager
Parameters
- __namedParameters: BetterUptime
Returns HeartbeatManager
- Defined in heartbeats/HeartbeatManager.ts:8

Properties

`Private` apiClient

apiClient: AxiosInstance

Methods

create

create(newHeartbeat): Promise<any>
Returns either a newly created heartbeat, or validation errors.
Parameters
- newHeartbeat: any
Returns Promise<any>
- Defined in heartbeats/HeartbeatManager.ts:51

delete

delete(heartbeat_id): Promise<boolean>
Permanently deletes an existing heartbeat.
Parameters
- heartbeat_id: string
  Heartbeat ID you want to remove
Returns Promise<boolean>
True if success
- Defined in heartbeats/HeartbeatManager.ts:93

get

get(heartbeat_id): Promise<any>
Returns a single heartbeat by ID.
Parameters
- heartbeat_id: string
Returns Promise<any>
- Defined in heartbeats/HeartbeatManager.ts:33

getAll

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

update

update(heartbeat_id, newHeartbeat): Promise<any>
Update the attributes of an existing heartbeat. Send only the parameters you wish to change
Parameters
- heartbeat_id: string
  Heartbeat ID you want to change
- newHeartbeat: Partial<any>
Returns Promise<any>
- Defined in heartbeats/HeartbeatManager.ts:70

Generated using TypeDoc