Class StatusPageManager

Index

Constructors

Properties

Methods

create delete get getAll update

Constructors

constructor

new StatusPageManager(__namedParameters): StatusPageManager
Parameters
- __namedParameters: BetterUptime
Returns StatusPageManager
- Defined in status-pages/StatusPageManager.ts:8

Properties

`Private` apiClient

apiClient: AxiosInstance

Methods

create

create(newStatusPage): Promise<any>
Returns either a newly created status page, or validation errors.
Parameters
- newStatusPage: any
Returns Promise<any>
- Defined in status-pages/StatusPageManager.ts:51

delete

delete(status_page_id): Promise<boolean>
Permanently deletes an existing status page.
Parameters
- status_page_id: string
  Status page ID you want to remove
Returns Promise<boolean>
True if success
- Defined in status-pages/StatusPageManager.ts:96

get

get(status_page_id): Promise<any>
Returns a single status page by ID.
Parameters
- status_page_id: string
Returns Promise<any>
- Defined in status-pages/StatusPageManager.ts:33

getAll

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

update

update(status_page_id, newStatusPage): Promise<any>
Update an existing status page. Send only the parameters you wish to change
Parameters
- status_page_id: string
  Status page ID you want to change
- newStatusPage: Partial<any>
Returns Promise<any>
- Defined in status-pages/StatusPageManager.ts:70

Generated using TypeDoc