Class ReportsApi

ReportsApi - object-oriented interface

export

Hierarchy

BaseAPI
- ReportsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ReportsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): ReportsApi

Inherited from BaseAPI.constructor
- Defined in base.ts:50
Parameters
- Optional configuration: Configuration
- Default value basePath: string = BASE_PATH
- Default value axios: AxiosInstance = globalAxios
Returns ReportsApi

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

deleteReport

deleteReport(id: string, options?: any): Promise<AxiosResponse<Report>>

- Defined in api.ts:3489
summary

Delete a published report

throws

{RequiredError}

memberof

ReportsApi

Parameters
- id: string
- Optional options: any
Returns Promise<AxiosResponse<Report>>

getReport

getReport(id: string, options?: any): Promise<AxiosResponse<Report>>

- Defined in api.ts:3501
summary

Get a published report

throws

{RequiredError}

memberof

ReportsApi

Parameters
- id: string
- Optional options: any
Returns Promise<AxiosResponse<Report>>

getReports

getReports(pageNum?: number, perPage?: number, orderBy?: "title" | "createdAt", order?: "asc" | "desc", tagId?: string, reportTaskId?: string, options?: any): Promise<AxiosResponse<InlineResponse2003>>

- Defined in api.ts:3518
summary

List reports

throws

{RequiredError}

memberof

ReportsApi

Parameters
- Optional pageNum: number
- Optional perPage: number
- Optional orderBy: "title" | "createdAt"
- Optional order: "asc" | "desc"
- Optional tagId: string
- Optional reportTaskId: string
- Optional options: any
Returns Promise<AxiosResponse<InlineResponse2003>>

renderReport

renderReport(id: string, format: "pdf" | "pptx" | "xlsx" | "csv", options?: any): Promise<AxiosResponse<Job>>

- Defined in api.ts:3531
summary

Render a published report

throws

{RequiredError}

memberof

ReportsApi

Parameters
- id: string
- format: "pdf" | "pptx" | "xlsx" | "csv"
- Optional options: any
Returns Promise<AxiosResponse<Job>>

Generated using TypeDoc