Class StatusPageSectionManager

Index

Constructors

Properties

Methods

create delete get getAll update

Constructors

constructor

new StatusPageSectionManager(__namedParameters): StatusPageSectionManager
Parameters
- __namedParameters: BetterUptime
Returns StatusPageSectionManager
- Defined in status-page-sections/StatusPageSectionManager.ts:8

Properties

`Private` apiClient

apiClient: AxiosInstance

Methods

create

create(status_page_id, newSection): Promise<any>
Returns a newly created status page section.
Parameters
- status_page_id: string
- newSection: any
Returns Promise<any>
- Defined in status-page-sections/StatusPageSectionManager.ts:47

delete

delete(status_page_id, section_id): Promise<boolean>
Permanently deletes an existing section.
Parameters
- status_page_id: string
- section_id: string
  Section ID you want to remove
Returns Promise<boolean>
True if success
- Defined in status-page-sections/StatusPageSectionManager.ts:96

get

get(status_page_id, section_id): Promise<any>
Returns a single status page section.
Parameters
- status_page_id: string
- section_id: string
Returns Promise<any>
- Defined in status-page-sections/StatusPageSectionManager.ts:27

getAll

getAll(status_page_id): Promise<any>
Returns a list of the sections of your status page.
Parameters
- status_page_id: string
Returns Promise<any>
- Defined in status-page-sections/StatusPageSectionManager.ts:15

update

update(status_page_id, section_id, updatedSection): Promise<any>
Update an existing status page section. Send only the parameters you wish to change
Parameters
- status_page_id: string
- section_id: string
  Section ID you want to change
- updatedSection: string
Returns Promise<any>
- Defined in status-page-sections/StatusPageSectionManager.ts:69

Generated using TypeDoc