Interface KitsasOfficeInterface
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
addBookshelf
- addBookshelf(name, parentId?): Promise<Bookshelf>
Parameters
- name: string
Optional
parentId: string
changePlan
- changePlan(bookId, planId): Promise<void>
Parameters
- bookId: string
- planId: number
Returns Promise<void>
deleteBookshelf
- deleteBookshelf(id): Promise<void>
Returns Promise<void>
deleteRole
- deleteRole(id): Promise<void>
Returns Promise<void>
deleteUser
- deleteUser(id): Promise<void>
Returns Promise<void>
getBooks
- getBooks(bookshelfId?): Promise<BookListItem[]>
Parameters
Optional
bookshelfId: string
getBusinessId
- getBusinessId(): undefined | string
Returns undefined | string
getCertificateInformation
getId
- getId(): string
Returns string
getName
- getName(): string
Returns string
installCertificate
- installCertificate(transferId, password): Promise<CertificateFetchResult>
Parameters
- transferId: string
- password: string
moveBook
- moveBook(bookId, bookshelfId): Promise<void>
Parameters
- bookId: string
- bookshelfId: string
Returns Promise<void>
moveBookShelf
- moveBookShelf(id, newParentId): Promise<Bookshelf>
Parameters
- id: string
- newParentId: string
refresh
- refresh(): Promise<void>
Returns Promise<void>
removeCertificate
- removeCertificate(): Promise<void>
Returns Promise<void>
renameBookshelf
- renameBookshelf(id, name): Promise<Bookshelf>
Interface to office, role and bookshelf management
You get KitsasOfficeInterface from KitsasConnectionInterface.getOffice