qlik-saas-api/dist/modules/ReportTemplate.d.ts

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
export interface IReportTemplate {
    /**
     * The template ID
     */
    id: string;
    /**
     * Template name
     */
    name: string;
    /**
     * The user that this template is scoped to
     */
    ownerId: string;
    /**
     * The data and time when the template was created
     */
    createdAt: string;
    /**
     * The id of the user who created the template
     */
    createdBy: string;
    /**
     * The date and time when the template was last updated
     */
    updatedAt: string;
    /**
     * The id of the user who last updated the template
     */
    updatedBy: string;
    /**
     * Template description
     */
    description: string;
    /**
     * The id of the app that this template is using as data source
     */
    sourceAppId: string;
    /**
     * The name of the app that this template is using as data source
     */
    sourceAppName: string;
    /**
     * THe template metadata version
     */
    metadataVersion: number;
}
export interface IReportTemplatePatch {
    op: string;
    from: string;
    path: string;
    value: {};
}
export interface IReportTemplateUpdate {
    /**
     * Template name
     */
    name?: string;
    /**
     * Template description
     */
    description?: string;
    /**
     * The ID of a previous uploaded temporary content file
     */
    temporaryContentId: string;
}
export declare class ReportTemplate {
    #private;
    details: IReportTemplate;
    constructor(saasClient: QlikSaaSClient, id: string, details?: IReportTemplate);
    init(arg?: {
        force: boolean;
    }): Promise<void>;
    remove(): Promise<number>;
    download(): Promise<any>;
    patch(arg: IReportTemplatePatch[]): Promise<number>;
    update(arg: IReportTemplateUpdate): Promise<number>;
}