Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "api"

Index

Enumerations

Classes

Interfaces

Functions

Functions

Const BaseTemplatesApiAxiosParamCreator

  • BaseTemplatesApiAxiosParamCreator(configuration?: Configuration): { duplicateBaseTemplate: any; getBaseTemplates: any }

  • BaseTemplatesApi - axios parameter creator

    export

    Parameters

    Returns { duplicateBaseTemplate: any; getBaseTemplates: any }

    • duplicateBaseTemplate: function
      • duplicateBaseTemplate(id: string, options?: any): Promise<RequestArgs>

      • Duplicate a base template by its ID

        summary

        Duplicate a base template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • getBaseTemplates: function
      • getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<RequestArgs>
      • summary

        List base templates

        throws

        {RequiredError}

        Parameters

        • Optional pageNum: number
        • Optional page: number
        • Default value options: any = {}

        Returns Promise<RequestArgs>

Const BaseTemplatesApiFactory

  • BaseTemplatesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { duplicateBaseTemplate: any; getBaseTemplates: any }

  • BaseTemplatesApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { duplicateBaseTemplate: any; getBaseTemplates: any }

    • duplicateBaseTemplate: function
      • duplicateBaseTemplate(id: string, options?: any): AxiosPromise<Template>

      • Duplicate a base template by its ID

        summary

        Duplicate a base template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<Template>

    • getBaseTemplates: function
      • getBaseTemplates(pageNum?: number, page?: number, options?: any): AxiosPromise<InlineResponse200>
      • summary

        List base templates

        throws

        {RequiredError}

        Parameters

        • Optional pageNum: number
        • Optional page: number
        • Optional options: any

        Returns AxiosPromise<InlineResponse200>

Const BaseTemplatesApiFp

  • BaseTemplatesApiFp(configuration?: Configuration): { duplicateBaseTemplate: any; getBaseTemplates: any }

  • BaseTemplatesApi - functional programming interface

    export

    Parameters

    Returns { duplicateBaseTemplate: any; getBaseTemplates: any }

    • duplicateBaseTemplate: function
      • duplicateBaseTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

      • Duplicate a base template by its ID

        summary

        Duplicate a base template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

    • getBaseTemplates: function
      • getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>
      • summary

        List base templates

        throws

        {RequiredError}

        Parameters

        • Optional pageNum: number
        • Optional page: number
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>

Const DocumentsApiAxiosParamCreator

  • DocumentsApiAxiosParamCreator(configuration?: Configuration): { getDocument: any }

  • DocumentsApi - axios parameter creator

    export

    Parameters

    Returns { getDocument: any }

    • getDocument: function
      • getDocument(fileName: string, fileType: "pdf" | "pptx" | "xlsx" | "csv", attachmentName?: string, options?: any): Promise<RequestArgs>
      • summary

        Retrieve a generated document

        throws

        {RequiredError}

        Parameters

        • fileName: string
        • fileType: "pdf" | "pptx" | "xlsx" | "csv"
        • Optional attachmentName: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

Const DocumentsApiFactory

  • DocumentsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getDocument: any }

  • DocumentsApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { getDocument: any }

    • getDocument: function
      • getDocument(fileName: string, fileType: "pdf" | "pptx" | "xlsx" | "csv", attachmentName?: string, options?: any): AxiosPromise<any>
      • summary

        Retrieve a generated document

        throws

        {RequiredError}

        Parameters

        • fileName: string
        • fileType: "pdf" | "pptx" | "xlsx" | "csv"
        • Optional attachmentName: string
        • Optional options: any

        Returns AxiosPromise<any>

Const DocumentsApiFp

  • DocumentsApiFp(configuration?: Configuration): { getDocument: any }

  • DocumentsApi - functional programming interface

    export

    Parameters

    Returns { getDocument: any }

    • getDocument: function
      • getDocument(fileName: string, fileType: "pdf" | "pptx" | "xlsx" | "csv", attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
      • summary

        Retrieve a generated document

        throws

        {RequiredError}

        Parameters

        • fileName: string
        • fileType: "pdf" | "pptx" | "xlsx" | "csv"
        • Optional attachmentName: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

Const FilterCyclesApiAxiosParamCreator

  • FilterCyclesApiAxiosParamCreator(configuration?: Configuration): { createFilterCycle: any; deleteFilterCycle: any; disableAllInCycle: any; enableAllInCycle: any; getFilterCycle: any; getFilterCycles: any; updateFilterCycle: any }

  • FilterCyclesApi - axios parameter creator

    export

    Parameters

    Returns { createFilterCycle: any; deleteFilterCycle: any; disableAllInCycle: any; enableAllInCycle: any; getFilterCycle: any; getFilterCycles: any; updateFilterCycle: any }

    • createFilterCycle: function
      • summary

        Create a filter cycle

        throws

        {RequiredError}

        Parameters

        • filterCycle: FilterCycle
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • deleteFilterCycle: function
      • deleteFilterCycle(id: string, options?: any): Promise<RequestArgs>
      • summary

        Delete a filter cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • disableAllInCycle: function
      • disableAllInCycle(id: string, options?: any): Promise<RequestArgs>
      • summary

        Disable all report tasks in a cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • enableAllInCycle: function
      • enableAllInCycle(id: string, options?: any): Promise<RequestArgs>
      • summary

        Enable all report tasks in a cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • getFilterCycle: function
      • getFilterCycle(id: string, options?: any): Promise<RequestArgs>
      • summary

        Get a filter cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • getFilterCycles: function
      • getFilterCycles(templateId: string, options?: any): Promise<RequestArgs>
      • summary

        List filter cycles

        throws

        {RequiredError}

        Parameters

        • templateId: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • updateFilterCycle: function
      • summary

        Update a filter cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • filterCycle: FilterCycle
        • Default value options: any = {}

        Returns Promise<RequestArgs>

Const FilterCyclesApiFactory

  • FilterCyclesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createFilterCycle: any; deleteFilterCycle: any; disableAllInCycle: any; enableAllInCycle: any; getFilterCycle: any; getFilterCycles: any; updateFilterCycle: any }

  • FilterCyclesApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { createFilterCycle: any; deleteFilterCycle: any; disableAllInCycle: any; enableAllInCycle: any; getFilterCycle: any; getFilterCycles: any; updateFilterCycle: any }

    • createFilterCycle: function
      • summary

        Create a filter cycle

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<FilterCycle>

    • deleteFilterCycle: function
      • deleteFilterCycle(id: string, options?: any): AxiosPromise<FilterCycle>
      • summary

        Delete a filter cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<FilterCycle>

    • disableAllInCycle: function
      • disableAllInCycle(id: string, options?: any): AxiosPromise<void>
      • summary

        Disable all report tasks in a cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<void>

    • enableAllInCycle: function
      • enableAllInCycle(id: string, options?: any): AxiosPromise<void>
      • summary

        Enable all report tasks in a cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<void>

    • getFilterCycle: function
      • getFilterCycle(id: string, options?: any): AxiosPromise<FilterCycle>
      • summary

        Get a filter cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<FilterCycle>

    • getFilterCycles: function
      • getFilterCycles(templateId: string, options?: any): AxiosPromise<Array<FilterCycle>>
      • summary

        List filter cycles

        throws

        {RequiredError}

        Parameters

        • templateId: string
        • Optional options: any

        Returns AxiosPromise<Array<FilterCycle>>

    • updateFilterCycle: function
      • summary

        Update a filter cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • filterCycle: FilterCycle
        • Optional options: any

        Returns AxiosPromise<FilterCycle>

Const FilterCyclesApiFp

  • FilterCyclesApiFp(configuration?: Configuration): { createFilterCycle: any; deleteFilterCycle: any; disableAllInCycle: any; enableAllInCycle: any; getFilterCycle: any; getFilterCycles: any; updateFilterCycle: any }

  • FilterCyclesApi - functional programming interface

    export

    Parameters

    Returns { createFilterCycle: any; deleteFilterCycle: any; disableAllInCycle: any; enableAllInCycle: any; getFilterCycle: any; getFilterCycles: any; updateFilterCycle: any }

    • createFilterCycle: function
      • createFilterCycle(filterCycle: FilterCycle, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>
      • summary

        Create a filter cycle

        throws

        {RequiredError}

        Parameters

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>

    • deleteFilterCycle: function
      • deleteFilterCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>
      • summary

        Delete a filter cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>

    • disableAllInCycle: function
      • disableAllInCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
      • summary

        Disable all report tasks in a cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    • enableAllInCycle: function
      • enableAllInCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
      • summary

        Enable all report tasks in a cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    • getFilterCycle: function
      • getFilterCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>
      • summary

        Get a filter cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>

    • getFilterCycles: function
      • getFilterCycles(templateId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FilterCycle>>>
      • summary

        List filter cycles

        throws

        {RequiredError}

        Parameters

        • templateId: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FilterCycle>>>

    • updateFilterCycle: function
      • updateFilterCycle(id: string, filterCycle: FilterCycle, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>
      • summary

        Update a filter cycle

        throws

        {RequiredError}

        Parameters

        • id: string
        • filterCycle: FilterCycle
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>

Const ImagesApiAxiosParamCreator

  • ImagesApiAxiosParamCreator(configuration?: Configuration): { getImage: any; uploadImage: any }

  • ImagesApi - axios parameter creator

    export

    Parameters

    Returns { getImage: any; uploadImage: any }

    • getImage: function
      • getImage(title: string, options?: any): Promise<RequestArgs>
      • summary

        Retrieves a user uploaded image for use in a template

        throws

        {RequiredError}

        Parameters

        • title: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • uploadImage: function
      • uploadImage(image?: any, options?: any): Promise<RequestArgs>

      • Uploads an image to the server for use in templates

        summary

        Upload an image for use in a template

        throws

        {RequiredError}

        Parameters

        • Optional image: any
        • Default value options: any = {}

        Returns Promise<RequestArgs>

Const ImagesApiFactory

  • ImagesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getImage: any; uploadImage: any }

  • ImagesApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { getImage: any; uploadImage: any }

    • getImage: function
      • getImage(title: string, options?: any): AxiosPromise<any>
      • summary

        Retrieves a user uploaded image for use in a template

        throws

        {RequiredError}

        Parameters

        • title: string
        • Optional options: any

        Returns AxiosPromise<any>

    • uploadImage: function

      • Uploads an image to the server for use in templates

        summary

        Upload an image for use in a template

        throws

        {RequiredError}

        Parameters

        • Optional image: any
        • Optional options: any

        Returns AxiosPromise<InlineResponse2001>

Const ImagesApiFp

  • ImagesApiFp(configuration?: Configuration): { getImage: any; uploadImage: any }

  • ImagesApi - functional programming interface

    export

    Parameters

    Returns { getImage: any; uploadImage: any }

    • getImage: function
      • getImage(title: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
      • summary

        Retrieves a user uploaded image for use in a template

        throws

        {RequiredError}

        Parameters

        • title: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    • uploadImage: function
      • uploadImage(image?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>>

      • Uploads an image to the server for use in templates

        summary

        Upload an image for use in a template

        throws

        {RequiredError}

        Parameters

        • Optional image: any
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>>

Const JobsApiAxiosParamCreator

  • JobsApiAxiosParamCreator(configuration?: Configuration): { getJob: any }

  • JobsApi - axios parameter creator

    export

    Parameters

    Returns { getJob: any }

    • getJob: function
      • getJob(id: string, options?: any): Promise<RequestArgs>

      • Get the status of a queued job, including its status and result if available.

        summary

        Get job

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

Const JobsApiFactory

  • JobsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getJob: any }

  • JobsApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { getJob: any }

    • getJob: function
      • getJob(id: string, options?: any): AxiosPromise<Job>

      • Get the status of a queued job, including its status and result if available.

        summary

        Get job

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<Job>

Const JobsApiFp

  • JobsApi - functional programming interface

    export

    Parameters

    Returns { getJob: any }

    • getJob: function
      • getJob(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>>

      • Get the status of a queued job, including its status and result if available.

        summary

        Get job

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>>

Const ReportTasksApiAxiosParamCreator

  • ReportTasksApiAxiosParamCreator(configuration?: Configuration): { createReportTask: any; deleteReportTask: any; getReportTask: any; getReportTasks: any; runReportTaskNow: any; updateReportTask: any }

  • ReportTasksApi - axios parameter creator

    export

    Parameters

    Returns { createReportTask: any; deleteReportTask: any; getReportTask: any; getReportTasks: any; runReportTaskNow: any; updateReportTask: any }

    • createReportTask: function
      • summary

        Create report task

        throws

        {RequiredError}

        Parameters

        Returns Promise<RequestArgs>

    • deleteReportTask: function
      • deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): Promise<RequestArgs>

      • Delete a report task by its ID

        summary

        Delete report task

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional deleteAssociatedReports: boolean
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • getReportTask: function
      • getReportTask(id: string, options?: any): Promise<RequestArgs>

      • Read a report task by its ID

        summary

        Read report task

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • getReportTasks: function
      • getReportTasks(pageNum?: number, meta?: {}, templateId?: string, perPage?: number, orderBy?: "title" | "startOn" | "endOn" | "enabled" | "username" | "frequency" | "scheduledJobs.lastFinishedAt" | "scheduledJobs.nextRunAt" | "scheduledJobs.lastRunAt" | "averageTimeToGenerate" | "id" | "templateId", order?: "asc" | "desc", filter?: object, options?: any): Promise<RequestArgs>
      • summary

        List report tasks

        throws

        {RequiredError}

        Parameters

        • Optional pageNum: number
        • Optional meta: {}
          • [key: string]: string
        • Optional templateId: string
        • Optional perPage: number
        • Optional orderBy: "title" | "startOn" | "endOn" | "enabled" | "username" | "frequency" | "scheduledJobs.lastFinishedAt" | "scheduledJobs.nextRunAt" | "scheduledJobs.lastRunAt" | "averageTimeToGenerate" | "id" | "templateId"
        • Optional order: "asc" | "desc"
        • Optional filter: object
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • runReportTaskNow: function
      • runReportTaskNow(id: string, options?: any): Promise<RequestArgs>

      • Duplicates the task and runs it as "Once - Now"

        summary

        Run task now

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • updateReportTask: function

      • Accepts partial updates

        summary

        Update report task by ID

        throws

        {RequiredError}

        Parameters

        Returns Promise<RequestArgs>

Const ReportTasksApiFactory

  • ReportTasksApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createReportTask: any; deleteReportTask: any; getReportTask: any; getReportTasks: any; runReportTaskNow: any; updateReportTask: any }

  • ReportTasksApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { createReportTask: any; deleteReportTask: any; getReportTask: any; getReportTasks: any; runReportTaskNow: any; updateReportTask: any }

    • createReportTask: function
      • summary

        Create report task

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<ReportTaskResponse>

    • deleteReportTask: function
      • deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): AxiosPromise<void>

      • Delete a report task by its ID

        summary

        Delete report task

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional deleteAssociatedReports: boolean
        • Optional options: any

        Returns AxiosPromise<void>

    • getReportTask: function

      • Read a report task by its ID

        summary

        Read report task

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<ReportTaskResponse>

    • getReportTasks: function
      • getReportTasks(pageNum?: number, meta?: {}, templateId?: string, perPage?: number, orderBy?: "title" | "startOn" | "endOn" | "enabled" | "username" | "frequency" | "scheduledJobs.lastFinishedAt" | "scheduledJobs.nextRunAt" | "scheduledJobs.lastRunAt" | "averageTimeToGenerate" | "id" | "templateId", order?: "asc" | "desc", filter?: object, options?: any): AxiosPromise<InlineResponse2002>
      • summary

        List report tasks

        throws

        {RequiredError}

        Parameters

        • Optional pageNum: number
        • Optional meta: {}
          • [key: string]: string
        • Optional templateId: string
        • Optional perPage: number
        • Optional orderBy: "title" | "startOn" | "endOn" | "enabled" | "username" | "frequency" | "scheduledJobs.lastFinishedAt" | "scheduledJobs.nextRunAt" | "scheduledJobs.lastRunAt" | "averageTimeToGenerate" | "id" | "templateId"
        • Optional order: "asc" | "desc"
        • Optional filter: object
        • Optional options: any

        Returns AxiosPromise<InlineResponse2002>

    • runReportTaskNow: function

      • Duplicates the task and runs it as "Once - Now"

        summary

        Run task now

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<ReportTaskResponse>

    • updateReportTask: function

      • Accepts partial updates

        summary

        Update report task by ID

        throws

        {RequiredError}

        Parameters

        Returns AxiosPromise<ReportTaskResponse>

Const ReportTasksApiFp

  • ReportTasksApiFp(configuration?: Configuration): { createReportTask: any; deleteReportTask: any; getReportTask: any; getReportTasks: any; runReportTaskNow: any; updateReportTask: any }

  • ReportTasksApi - functional programming interface

    export

    Parameters

    Returns { createReportTask: any; deleteReportTask: any; getReportTask: any; getReportTasks: any; runReportTaskNow: any; updateReportTask: any }

    • createReportTask: function
      • summary

        Create report task

        throws

        {RequiredError}

        Parameters

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>

    • deleteReportTask: function
      • deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Delete a report task by its ID

        summary

        Delete report task

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional deleteAssociatedReports: boolean
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    • getReportTask: function
      • getReportTask(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>

      • Read a report task by its ID

        summary

        Read report task

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>

    • getReportTasks: function
      • getReportTasks(pageNum?: number, meta?: {}, templateId?: string, perPage?: number, orderBy?: "title" | "startOn" | "endOn" | "enabled" | "username" | "frequency" | "scheduledJobs.lastFinishedAt" | "scheduledJobs.nextRunAt" | "scheduledJobs.lastRunAt" | "averageTimeToGenerate" | "id" | "templateId", order?: "asc" | "desc", filter?: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>
      • summary

        List report tasks

        throws

        {RequiredError}

        Parameters

        • Optional pageNum: number
        • Optional meta: {}
          • [key: string]: string
        • Optional templateId: string
        • Optional perPage: number
        • Optional orderBy: "title" | "startOn" | "endOn" | "enabled" | "username" | "frequency" | "scheduledJobs.lastFinishedAt" | "scheduledJobs.nextRunAt" | "scheduledJobs.lastRunAt" | "averageTimeToGenerate" | "id" | "templateId"
        • Optional order: "asc" | "desc"
        • Optional filter: object
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>

    • runReportTaskNow: function
      • runReportTaskNow(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>

      • Duplicates the task and runs it as "Once - Now"

        summary

        Run task now

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>

    • updateReportTask: function

      • Accepts partial updates

        summary

        Update report task by ID

        throws

        {RequiredError}

        Parameters

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>

Const ReportsApiAxiosParamCreator

  • ReportsApiAxiosParamCreator(configuration?: Configuration): { deleteReport: any; getReport: any; getReports: any; renderReport: any }

  • ReportsApi - axios parameter creator

    export

    Parameters

    Returns { deleteReport: any; getReport: any; getReports: any; renderReport: any }

    • deleteReport: function
      • deleteReport(id: string, options?: any): Promise<RequestArgs>
      • summary

        Delete a published report

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • getReport: function
      • getReport(id: string, options?: any): Promise<RequestArgs>
      • summary

        Get a published report

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

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

        List reports

        throws

        {RequiredError}

        Parameters

        • Optional pageNum: number
        • Optional perPage: number
        • Optional orderBy: "title" | "createdAt"
        • Optional order: "asc" | "desc"
        • Optional tagId: string
        • Optional reportTaskId: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • renderReport: function
      • renderReport(id: string, format: "pdf" | "pptx" | "xlsx" | "csv", options?: any): Promise<RequestArgs>
      • summary

        Render a published report

        throws

        {RequiredError}

        Parameters

        • id: string
        • format: "pdf" | "pptx" | "xlsx" | "csv"
        • Default value options: any = {}

        Returns Promise<RequestArgs>

Const ReportsApiFactory

  • ReportsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteReport: any; getReport: any; getReports: any; renderReport: any }

  • ReportsApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { deleteReport: any; getReport: any; getReports: any; renderReport: any }

    • deleteReport: function
      • deleteReport(id: string, options?: any): AxiosPromise<Report>
      • summary

        Delete a published report

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<Report>

    • getReport: function
      • getReport(id: string, options?: any): AxiosPromise<Report>
      • summary

        Get a published report

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<Report>

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

        List reports

        throws

        {RequiredError}

        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 AxiosPromise<InlineResponse2003>

    • renderReport: function
      • renderReport(id: string, format: "pdf" | "pptx" | "xlsx" | "csv", options?: any): AxiosPromise<Job>
      • summary

        Render a published report

        throws

        {RequiredError}

        Parameters

        • id: string
        • format: "pdf" | "pptx" | "xlsx" | "csv"
        • Optional options: any

        Returns AxiosPromise<Job>

Const ReportsApiFp

  • ReportsApiFp(configuration?: Configuration): { deleteReport: any; getReport: any; getReports: any; renderReport: any }

  • ReportsApi - functional programming interface

    export

    Parameters

    Returns { deleteReport: any; getReport: any; getReports: any; renderReport: any }

    • deleteReport: function
      • deleteReport(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Report>>
      • summary

        Delete a published report

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Report>>

    • getReport: function
      • getReport(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Report>>
      • summary

        Get a published report

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Report>>

    • getReports: function
      • getReports(pageNum?: number, perPage?: number, orderBy?: "title" | "createdAt", order?: "asc" | "desc", tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>>
      • summary

        List reports

        throws

        {RequiredError}

        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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>>

    • renderReport: function
      • renderReport(id: string, format: "pdf" | "pptx" | "xlsx" | "csv", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>>
      • summary

        Render a published report

        throws

        {RequiredError}

        Parameters

        • id: string
        • format: "pdf" | "pptx" | "xlsx" | "csv"
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>>

Const TemplatesApiAxiosParamCreator

  • TemplatesApiAxiosParamCreator(configuration?: Configuration): { createTemplate: any; deleteTemplate: any; duplicateTemplate: any; exportTemplate: any; getTemplate: any; getTemplates: any; importTemplate: any; renderTemplate: any; updateTemplate: any }

  • TemplatesApi - axios parameter creator

    export

    Parameters

    Returns { createTemplate: any; deleteTemplate: any; duplicateTemplate: any; exportTemplate: any; getTemplate: any; getTemplates: any; importTemplate: any; renderTemplate: any; updateTemplate: any }

    • createTemplate: function
      • summary

        Create report template by ID

        throws

        {RequiredError}

        Parameters

        • template: Template
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • deleteTemplate: function
      • deleteTemplate(id: string, options?: any): Promise<RequestArgs>

      • Delete a report template by its ID

        summary

        Delete report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • duplicateTemplate: function
      • duplicateTemplate(id: string, options?: any): Promise<RequestArgs>

      • Duplicate a report template by its ID

        summary

        Duplicate a report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • exportTemplate: function
      • exportTemplate(id: string, options?: any): Promise<RequestArgs>

      • Export a report template to a .CRPT file

        summary

        Export a report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • getTemplate: function
      • getTemplate(id: string, options?: any): Promise<RequestArgs>

      • Read a report template by its ID

        summary

        Read report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • getTemplates: function
      • getTemplates(pageNum?: number, options?: any): Promise<RequestArgs>
      • summary

        List report templates

        throws

        {RequiredError}

        Parameters

        • Optional pageNum: number
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • importTemplate: function
      • importTemplate(template?: any, options?: any): Promise<RequestArgs>

      • Imports an exported .CRPT file

        summary

        Import a template

        throws

        {RequiredError}

        Parameters

        • Optional template: any
        • Default value options: any = {}

        Returns Promise<RequestArgs>

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

      • Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.

        summary

        Render a report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • format: "pdf" | "pptx" | "xlsx" | "csv"
        • Default value options: any = {}

        Returns Promise<RequestArgs>

    • updateTemplate: function

      • Accepts partial updates

        summary

        Update report template by ID

        throws

        {RequiredError}

        Parameters

        • id: string
        • template: Template
        • Default value options: any = {}

        Returns Promise<RequestArgs>

Const TemplatesApiFactory

  • TemplatesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createTemplate: any; deleteTemplate: any; duplicateTemplate: any; exportTemplate: any; getTemplate: any; getTemplates: any; importTemplate: any; renderTemplate: any; updateTemplate: any }

  • TemplatesApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { createTemplate: any; deleteTemplate: any; duplicateTemplate: any; exportTemplate: any; getTemplate: any; getTemplates: any; importTemplate: any; renderTemplate: any; updateTemplate: any }

    • createTemplate: function
      • summary

        Create report template by ID

        throws

        {RequiredError}

        Parameters

        • template: Template
        • Optional options: any

        Returns AxiosPromise<Template>

    • deleteTemplate: function
      • deleteTemplate(id: string, options?: any): AxiosPromise<Template>

      • Delete a report template by its ID

        summary

        Delete report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<Template>

    • duplicateTemplate: function
      • duplicateTemplate(id: string, options?: any): AxiosPromise<Template>

      • Duplicate a report template by its ID

        summary

        Duplicate a report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<Template>

    • exportTemplate: function
      • exportTemplate(id: string, options?: any): AxiosPromise<any>

      • Export a report template to a .CRPT file

        summary

        Export a report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<any>

    • getTemplate: function
      • getTemplate(id: string, options?: any): AxiosPromise<Template>

      • Read a report template by its ID

        summary

        Read report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns AxiosPromise<Template>

    • getTemplates: function
      • summary

        List report templates

        throws

        {RequiredError}

        Parameters

        • Optional pageNum: number
        • Optional options: any

        Returns AxiosPromise<InlineResponse2004>

    • importTemplate: function
      • importTemplate(template?: any, options?: any): AxiosPromise<Template>

      • Imports an exported .CRPT file

        summary

        Import a template

        throws

        {RequiredError}

        Parameters

        • Optional template: any
        • Optional options: any

        Returns AxiosPromise<Template>

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

      • Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.

        summary

        Render a report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • format: "pdf" | "pptx" | "xlsx" | "csv"
        • Optional options: any

        Returns AxiosPromise<JobResponse>

    • updateTemplate: function
      • updateTemplate(id: string, template: Template, options?: any): AxiosPromise<Template>

      • Accepts partial updates

        summary

        Update report template by ID

        throws

        {RequiredError}

        Parameters

        • id: string
        • template: Template
        • Optional options: any

        Returns AxiosPromise<Template>

Const TemplatesApiFp

  • TemplatesApiFp(configuration?: Configuration): { createTemplate: any; deleteTemplate: any; duplicateTemplate: any; exportTemplate: any; getTemplate: any; getTemplates: any; importTemplate: any; renderTemplate: any; updateTemplate: any }

  • TemplatesApi - functional programming interface

    export

    Parameters

    Returns { createTemplate: any; deleteTemplate: any; duplicateTemplate: any; exportTemplate: any; getTemplate: any; getTemplates: any; importTemplate: any; renderTemplate: any; updateTemplate: any }

    • createTemplate: function
      • createTemplate(template: Template, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>
      • summary

        Create report template by ID

        throws

        {RequiredError}

        Parameters

        • template: Template
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

    • deleteTemplate: function
      • deleteTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

      • Delete a report template by its ID

        summary

        Delete report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

    • duplicateTemplate: function
      • duplicateTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

      • Duplicate a report template by its ID

        summary

        Duplicate a report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

    • exportTemplate: function
      • exportTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

      • Export a report template to a .CRPT file

        summary

        Export a report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    • getTemplate: function
      • getTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

      • Read a report template by its ID

        summary

        Read report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

    • getTemplates: function
      • getTemplates(pageNum?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>>
      • summary

        List report templates

        throws

        {RequiredError}

        Parameters

        • Optional pageNum: number
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>>

    • importTemplate: function
      • importTemplate(template?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

      • Imports an exported .CRPT file

        summary

        Import a template

        throws

        {RequiredError}

        Parameters

        • Optional template: any
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

    • renderTemplate: function
      • renderTemplate(id: string, format: "pdf" | "pptx" | "xlsx" | "csv", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobResponse>>

      • Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.

        summary

        Render a report template

        throws

        {RequiredError}

        Parameters

        • id: string
        • format: "pdf" | "pptx" | "xlsx" | "csv"
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobResponse>>

    • updateTemplate: function
      • updateTemplate(id: string, template: Template, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

      • Accepts partial updates

        summary

        Update report template by ID

        throws

        {RequiredError}

        Parameters

        • id: string
        • template: Template
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>

Const VisualizationApiAxiosParamCreator

  • VisualizationApiAxiosParamCreator(configuration?: Configuration): { createVisualization: any }

  • VisualizationApi - axios parameter creator

    export

    Parameters

    Returns { createVisualization: any }

    • createVisualization: function
      • summary

        Create an image from a visualization

        throws

        {RequiredError}

        Parameters

        • visualization: Visualization
        • Optional priority: "high" | "low"
        • Default value options: any = {}

        Returns Promise<RequestArgs>

Const VisualizationApiFactory

  • VisualizationApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createVisualization: any }

  • VisualizationApi - factory interface

    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { createVisualization: any }

    • createVisualization: function
      • createVisualization(visualization: Visualization, priority?: "high" | "low", options?: any): AxiosPromise<void>
      • summary

        Create an image from a visualization

        throws

        {RequiredError}

        Parameters

        • visualization: Visualization
        • Optional priority: "high" | "low"
        • Optional options: any

        Returns AxiosPromise<void>

Const VisualizationApiFp

  • VisualizationApiFp(configuration?: Configuration): { createVisualization: any }

  • VisualizationApi - functional programming interface

    export

    Parameters

    Returns { createVisualization: any }

    • createVisualization: function
      • createVisualization(visualization: Visualization, priority?: "high" | "low", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
      • summary

        Create an image from a visualization

        throws

        {RequiredError}

        Parameters

        • visualization: Visualization
        • Optional priority: "high" | "low"
        • Optional options: any

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Generated using TypeDoc