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

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
import { CollectionItem, ICollectionItem } from "./CollectionItem";
export interface ICollectionUpdate {
    name: string;
    description?: string;
}
export interface ICollection {
    createdAt: string;
    creatorId: string;
    description: string;
    id: string;
    itemCount: number;
    links: {
        items: {
            href: string;
        };
        self: {
            href: string;
        };
    };
    meta: {
        items: {
            data: ICollectionItem[];
            links: {
                collection: {
                    href: string;
                };
                next: {
                    href: string;
                };
                prev: {
                    href: string;
                };
                self: {
                    href: string;
                };
            };
        };
    };
    name: string;
    tenantId: string;
    type: "public" | "private" | "favorite" | string;
    updatedAt: string;
    updaterId: string;
}
export declare class Collection {
    #private;
    details: ICollection;
    constructor(saasClient: QlikSaaSClient, id: string, details?: ICollection);
    init(arg?: {
        force: boolean;
    }): Promise<void>;
    remove(): Promise<number>;
    update(arg: ICollectionUpdate): Promise<number>;
    items(): Promise<any>;
    addItem(arg: {
        id: string;
    }): Promise<CollectionItem>;
}