Class StatusPageReportManager

Constructors

constructor

Properties

apiClient

Methods

create delete get getAll update

Constructors

constructor

Properties

Private apiClient

apiClient: AxiosInstance

Methods

create

  • create(status_page_id, newReport): Promise<any>

  • Returns a newly created status page report.

    Parameters

    • status_page_id: string
    • newReport: any

    Returns Promise<any>

delete

  • delete(status_page_id, report_id): Promise<boolean>

  • Permanently deletes an existing report.

    Parameters

    • status_page_id: string
    • report_id: string

      Report ID you want to remove

    Returns Promise<boolean>

    True if success

get

  • get(status_page_id, report_id): Promise<any>

  • Returns a single status page report.

    Parameters

    • status_page_id: string
    • report_id: string

    Returns Promise<any>

getAll

  • getAll(status_page_id): Promise<any>

  • Returns a list of the reports of your status page.

    Parameters

    • status_page_id: string

    Returns Promise<any>

update

  • update(status_page_id, report_id, updatedReport): Promise<any>

  • Update an existing status page report. Send only the parameters you wish to change

    Parameters

    • status_page_id: string
    • report_id: string

      Report ID you want to change

    • updatedReport: string

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc