Interface KitsasOfficeInterface

Interface to office, role and bookshelf management

You get KitsasOfficeInterface from KitsasConnectionInterface.getOffice

interface KitsasOfficeInterface {
    addBookshelf(name: string, parentId?: string): Promise<Bookshelf>;
    addRole(name: LanguageString, rights: string[]): Promise<OfficeRole>;
    addUser(name: string, email: string, mode:
        | PRO
        | CUSTOMER
        | WEBUSER
        | AUDITOR, invite: boolean): Promise<UserListItem>;
    changePlan(bookId: string, planId: number): Promise<void>;
    deleteBookshelf(id: string): Promise<void>;
    deleteRole(id: string): Promise<void>;
    deleteUser(id: string): Promise<void>;
    editRole(id: string, name: LanguageString, rights: string[]): Promise<OfficeRole>;
    getBooks(bookshelfId?: string): Promise<BookListItem[]>;
    getBookshelves(): Bookshelf[];
    getBusinessId(): undefined | string;
    getCertificateInformation(): CertificateStatusInformation;
    getContactPersons(): OfficeContactPerson[];
    getCustomization(): undefined | OfficeCustomization;
    getId(): string;
    getName(): string;
    getRoles(): OfficeRole[];
    getType(): OfficeType;
    getUsers(): Promise<UserListItem[]>;
    installCertificate(transferId: string, password: string): Promise<CertificateFetchResult>;
    moveBook(bookId: string, bookshelfId: string): Promise<void>;
    moveBookShelf(id: string, newParentId: string): Promise<Bookshelf>;
    refresh(): Promise<void>;
    removeCertificate(): Promise<void>;
    renameBookshelf(id: string, name: string): Promise<Bookshelf>;
}

Methods

  • Move book to another bookshelf

    Parameters

    • bookId: string

      Book id

    • bookshelfId: string

      Destination bookshelf id

    Returns Promise<void>