Class TemplatesApi

TemplatesApi - object-oriented interface

export

Hierarchy

BaseAPI
- TemplatesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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 TemplatesApi

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

createTemplate

createTemplate(template: Template, options?: any): Promise<AxiosResponse<Template>>

- Defined in api.ts:3759
summary

Create report template by ID

throws

{RequiredError}

memberof

TemplatesApi

Parameters
- template: Template
- Optional options: any
Returns Promise<AxiosResponse<Template>>

deleteTemplate

deleteTemplate(id: string, options?: any): Promise<AxiosResponse<Template>>

- Defined in api.ts:3771
Delete a report template by its ID

summary

Delete report template

throws

{RequiredError}

memberof

TemplatesApi

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

duplicateTemplate

duplicateTemplate(id: string, options?: any): Promise<AxiosResponse<Template>>

- Defined in api.ts:3783
Duplicate a report template by its ID

summary

Duplicate a report template

throws

{RequiredError}

memberof

TemplatesApi

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

exportTemplate

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

- Defined in api.ts:3795
Export a report template to a .CRPT file

summary

Export a report template

throws

{RequiredError}

memberof

TemplatesApi

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

getTemplate

getTemplate(id: string, options?: any): Promise<AxiosResponse<Template>>

- Defined in api.ts:3807
Read a report template by its ID

summary

Read report template

throws

{RequiredError}

memberof

TemplatesApi

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

getTemplates

getTemplates(pageNum?: number, options?: any): Promise<AxiosResponse<InlineResponse2004>>

- Defined in api.ts:3819
summary

List report templates

throws

{RequiredError}

memberof

TemplatesApi

Parameters
- Optional pageNum: number
- Optional options: any
Returns Promise<AxiosResponse<InlineResponse2004>>

importTemplate

importTemplate(template?: any, options?: any): Promise<AxiosResponse<Template>>

- Defined in api.ts:3831
Imports an exported .CRPT file

summary

Import a template

throws

{RequiredError}

memberof

TemplatesApi

Parameters
- Optional template: any
- Optional options: any
Returns Promise<AxiosResponse<Template>>

renderTemplate

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

- Defined in api.ts:3844
Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.

summary

Render a report template

throws

{RequiredError}

memberof

TemplatesApi

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

updateTemplate

updateTemplate(id: string, template: Template, options?: any): Promise<AxiosResponse<Template>>

- Defined in api.ts:3857
Accepts partial updates

summary

Update report template by ID

throws

{RequiredError}

memberof

TemplatesApi

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

Generated using TypeDoc