Class HeartbeatGroupManager

Index

Constructors

Properties

Methods

create delete get getAll update

Constructors

constructor

new HeartbeatGroupManager(__namedParameters): HeartbeatGroupManager
Parameters
- __namedParameters: BetterUptime
Returns HeartbeatGroupManager
- Defined in heartbeat-groups/HeartbeatGroupManager.ts:8

Properties

`Private` apiClient

apiClient: AxiosInstance

Methods

create

create(newHeartbeatGroup): Promise<any>
Returns either a newly created heartbeat group, or validation errors.
Parameters
- newHeartbeatGroup: any
Returns Promise<any>
- Defined in heartbeat-groups/HeartbeatGroupManager.ts:49

delete

delete(heartbeat_group_id): Promise<boolean>
Permanently deletes an existing heartbeat group.
Parameters
- heartbeat_group_id: string
  Heartbeat group ID you want to remove
Returns Promise<boolean>
True if success
- Defined in heartbeat-groups/HeartbeatGroupManager.ts:97

get

get(heartbeat_group_id): Promise<any>
Returns a single heartbeat group by ID.
Parameters
- heartbeat_group_id: string
Returns Promise<any>
- Defined in heartbeat-groups/HeartbeatGroupManager.ts:29

getAll

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

update

update(heartbeat_group_id, newHeartbeatGroup): Promise<any>
Update the attributes of an existing heartbeat group. Send only the parameters you wish to change
Parameters
- heartbeat_group_id: string
  Heartbeat Group ID you want to change
- newHeartbeatGroup: Partial<any>
Returns Promise<any>
- Defined in heartbeat-groups/HeartbeatGroupManager.ts:71

Generated using TypeDoc