Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplatesApi

TemplatesApi - object-oriented interface

export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • 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>>
  • 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>>

  • 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>>

  • 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>>

  • 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>>

  • 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>>
  • 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>>

  • 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>>

  • 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>>

  • 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