Class RecipientsAPI

Index

Constructors

Methods

addRecipient deleteRecipient getRecipients setApiUrl

Constructors

constructor

new RecipientsAPI(apiClient: APIClient): RecipientsAPI
Parameters
- apiClient: APIClient
Returns RecipientsAPI
- Defined in api/RecipientsAPI.ts:10

Methods

addRecipient

addRecipient(options: RecipientOptions): Promise<Recipient>
Add a new recipient.
Parameters
- options: RecipientOptions
Returns Promise<Recipient>
- Defined in api/RecipientsAPI.ts:15

deleteRecipient

deleteRecipient(id: string): Promise<Deleted>
Delete a recipient.
Parameters
- id: string
Returns Promise<Deleted>
- Defined in api/RecipientsAPI.ts:22

getRecipients

getRecipients(): Promise<Recipient[]>
List all possible alert recipients/channels on your account.

Returns Promise<Recipient[]>
- Defined in api/RecipientsAPI.ts:29

setApiUrl

setApiUrl(newURL: string): void
Set a new API URL.
Parameters
- newURL: string
  The new API url
Returns void
- Defined in api/RecipientsAPI.ts:39