Class StatusPagesAPI

Index

Constructors

Methods

addStatusPage deleteStatusPage getStatusPages setApiUrl updateStatusPage

Constructors

constructor

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

Methods

addStatusPage

addStatusPage(options: StatusPageOptions): Promise<StatusPage>
Add a new status page.
Parameters
- options: StatusPageOptions
Returns Promise<StatusPage>
- Defined in api/StatusPagesAPI.ts:15

deleteStatusPage

deleteStatusPage(token: string): Promise<Deleted>
Delete a status page.
Parameters
- token: string
Returns Promise<Deleted>
- Defined in api/StatusPagesAPI.ts:22

getStatusPages

getStatusPages(): Promise<StatusPage[]>
List all status pages.

Returns Promise<StatusPage[]>
- Defined in api/StatusPagesAPI.ts:29

setApiUrl

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

updateStatusPage

updateStatusPage(token: string, options: StatusPageOptions): Promise<StatusPage>
Update a status page.
Parameters
- token: string
- options: StatusPageOptions
Returns Promise<StatusPage>
- Defined in api/StatusPagesAPI.ts:44