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

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
import { DataAlert } from "./DataAlert";
import { IDataAlertCreate } from "./DataAlerts.interfaces";
export type TDaysOfWeek = "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY";
export type TFields = "evaluationId" | "triggerTime" | "conditionStatus" | "executionEvaluationStatus" | "evaluation" | "evaluation.endTime" | "evaluation.resultData" | "evaluation.resultData.count" | "evaluation.resultData.headers" | "evaluation.resultData.positive" | "evaluation.resultData.negative" | "evaluation.resultData.dimensions" | "evaluation.resultData.measures";
export interface IGetTaskExecutionsFilter {
    conditionId?: string;
    conditionStatus?: "FINISHED" | "FAILED" | "ALL";
    daysOfMonth?: number[];
    daysOfWeek?: TDaysOfWeek[];
    fields?: TFields[];
    includeEvaluation?: boolean;
    lastEachDay?: boolean;
    limit?: number;
    minimumGapDays?: number;
    next?: string;
    offset?: number;
    prev?: string;
    searchResultsLimit?: number;
    since?: string;
    sort?: "triggertime" | "-triggertime" | "+triggertime";
    timezone?: string;
    triggered?: boolean;
    until?: string;
}
export declare class DataAlerts {
    #private;
    constructor(saasClient: QlikSaaSClient);
    get(arg: {
        id: string;
    }): Promise<DataAlert>;
    getAll(): Promise<any>;
    getFilter(arg: {
        filter: string;
    }): Promise<DataAlert[]>;
    removeFilter(arg: {
        filter: string;
    }): Promise<{
        id: string;
        status: number;
    }[]>;
    create(arg: IDataAlertCreate): Promise<DataAlert>;
    triggerAction(arg: {
        alertingTaskId: string;
    }): Promise<any>;
    getSettings(): Promise<any>;
    updateSettings(arg: {
        enableDataAlerting: boolean;
    }): Promise<number>;
    getTaskIdStats(arg: {
        taskId: string;
    }): Promise<any>;
    getTaskIdExecutions(arg: {
        taskId: string;
        filter?: IGetTaskExecutionsFilter;
    }): Promise<any>;
    getTaskIdExecutionsStats(arg: {
        taskId: string;
        period: string;
    }): Promise<any>;
    getTaskIdExecutionIdEvaluation(arg: {
        taskId: string;
        executionId: string;
    }): Promise<any>;
    validateActions(arg: IDataAlertCreate): Promise<any>;
}