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

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
import { TransportsActions } from "./TransportsActions";
export interface IEmailConfigGet {
    /**
     * Contains statusCode and statusReason
     */
    status: {
        /**
         * Status code
         */
        statusCode: number;
        /**
         * Status reason
         */
        statusReason: string;
    };
    /**
     * Is the configuration valid
     */
    isValid: boolean;
    /**
     * The tenant Id
     */
    tenantId: string;
    /**
     * user name
     */
    username: string;
    /**
     * smtp listening port
     */
    serverPort: number;
    /**
     * Number of authentication failures
     */
    authFailures: number;
    /**
     * user for SMTP authentication
     */
    emailAddress: string;
    /**
     * one of none, StartTLS or SSL/TLS
     */
    securityType: string;
    /**
     * domain name or IP address of SMTP server
     */
    serverAddress: string;
    /**
     * Indicates if password is defined for smtp config. The password itself is not returned!
     */
    passwordExists: boolean;
    /**
     * Last modification time. Formatter as ISO 8601 string.
     */
    modificationTime: string;
}
export interface IEmailConfigFieldPatch {
    /**
     * The operation to be performed
     */
    op: "add" | "remove" | "replace";
    /**
     * The path for the given resource field to patch
     */
    path: "/username" | "/serverAddress" | "/serverPort" | "/securityType" | "/emailAddress" | "/emailPassword";
    /**
     * The value to be used for this operation
     */
    value: string;
}
export declare class Transports {
    #private;
    _actions: TransportsActions;
    constructor(saasClient: QlikSaaSClient);
    get(): Promise<any>;
    patch(arg: IEmailConfigFieldPatch[]): Promise<number>;
    delete(): Promise<number>;
}