Class EscalationPolicyManager

Index

Constructors

Properties

Methods

create delete get getAll update

Constructors

constructor

new EscalationPolicyManager(__namedParameters): EscalationPolicyManager
Parameters
- __namedParameters: BetterUptime
Returns EscalationPolicyManager
- Defined in escalation-policies/EscalationPolicyManager.ts:8

Properties

`Private` apiClient

apiClient: AxiosInstance

Methods

create

create(newEscalationPolicy): Promise<any>
Returns either a newly created escalation policy, or validation errors.
Parameters
- newEscalationPolicy: any
Returns Promise<any>
- Defined in escalation-policies/EscalationPolicyManager.ts:47

delete

delete(policy_id): Promise<boolean>
Permanently deletes an existing escalation policy.
Parameters
- policy_id: string
  Escalation policy ID you want to remove
Returns Promise<boolean>
True if success
- Defined in escalation-policies/EscalationPolicyManager.ts:92

get

get(policy_id): Promise<any>
Returns a single escalation policy by ID.
Parameters
- policy_id: string
Returns Promise<any>
- Defined in escalation-policies/EscalationPolicyManager.ts:29

getAll

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

update

update(policy_id, newEscalationPolicy): Promise<any>
Update the attributes of an existing escalation policy. Send only the parameters you wish to change
Parameters
- policy_id: string
  Escalation policy ID you want to change
- newEscalationPolicy: Partial<any>
Returns Promise<any>
- Defined in escalation-policies/EscalationPolicyManager.ts:66

Generated using TypeDoc