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

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
import { Brand } from "./Brand";
export interface IBrandCreate {
    /**
     * The path and name of a JPG or PNG file that will be adjusted to fit in a 'box'
     * measuring 109px in width and 62 px in height while maintaining aspect ratio.
     * Maximum size of 300 KB, but smaller is recommended.
     */
    logo?: string;
    /**
     * Name of the brand.
     */
    name: string;
    /**
     * @NOT_OPERATIONAL
     *
     *
     * The path and name of a JSON file to define brand style settings.
     * Maximum size is 100 KB. This property is not currently operational.
     *
     */
    styles?: string;
    /**
     * The path and name of a properly formatted ICO file. Maximum size is 100 KB.
     */
    favIcon?: string;
    /**
     * Description of the brand.
     */
    description?: string;
}
export declare class Brands {
    #private;
    constructor(saasClient: QlikSaaSClient);
    /**
     * Get specific brand (by brand ID)
     */
    get(arg: {
        id: string;
    }): Promise<Brand>;
    /**
     * Get all existing brands
     */
    getAll(): Promise<any>;
    getFilter(arg: {
        filter: string;
    }): Promise<Brand[]>;
    removeFilter(arg: {
        filter: string;
    }): Promise<{
        id: string;
        status: number;
    }[]>;
    /**
     * Create new brand
     */
    create(arg: IBrandCreate): Promise<Brand>;
}