Type Alias ReportTemplatesAPI

type ReportTemplatesAPI = {
    clearCache: typeof clearCache;
    createReportTemplate: typeof createReportTemplate;
    deleteReportTemplate: typeof deleteReportTemplate;
    downloadReportTemplate: typeof downloadReportTemplate;
    getReportTemplate: typeof getReportTemplate;
    getReportTemplates: typeof getReportTemplates;
    patchReportTemplate: typeof patchReportTemplate;
    updateReportTemplate: typeof updateReportTemplate;
}
Index

Properties

clearCache createReportTemplate deleteReportTemplate downloadReportTemplate getReportTemplate getReportTemplates patchReportTemplate updateReportTemplate

Properties

clearCache: typeof clearCache

Clears the cache for report-templates api requests.

createReportTemplate: typeof createReportTemplate

Create a new report template.

Param: body

an object with the body content

CreateReportTemplateHttpError

deleteReportTemplate: typeof deleteReportTemplate

Delete the specified report template.

The ID of the report template to delete.

DeleteReportTemplateHttpError

downloadReportTemplate: typeof downloadReportTemplate

Download the template file of the specified report template

The ID of the report template.

DownloadReportTemplateHttpError

getReportTemplate: typeof getReportTemplate

Get descriptive info for the specified report template.

The ID of the report template.

GetReportTemplateHttpError

getReportTemplates: typeof getReportTemplates

Get descriptive info for the specified templates.

an object with query parameters

GetReportTemplatesHttpError

patchReportTemplate: typeof patchReportTemplate

Patch an existing report template.

The ID of the report template to patch.

Param: body

an object with the body content

PatchReportTemplateHttpError

updateReportTemplate: typeof updateReportTemplate

Update an existing report template.

The ID of the report template to update.

Param: body

an object with the body content

UpdateReportTemplateHttpError

Settings

Member Visibility

On This Page

Properties