Interface KitsasConnectionInterface interface KitsasConnectionInterface { addBook ( bookshelfId : string ,
name : string ,
businessId ?: string ,
trial ?: boolean ,
backend ?: string ,
planId ?: number ) : Promise < AddBookResponse > ; addNotification ( bookId : string ,
type : NotificationType ,
title : LanguageString ,
text : LanguageString ,
category ?: string ) : Promise < void > ; deleteBook ( bookId : string ) : Promise < void > ; deleteNotification ( id : string ) : Promise < void > ; deleteNotifications ( bookId : string ,
category ?: string ) : Promise < void > ; findUserByEmail ( email : string ) : Promise < undefined | UserListItem > ; getAddonCallInfo ( callId : string ) : Promise < AddonCallInfo > ; getAddonInfo ( addonId : string ,
target : string ) : Promise < AddonInfoDto > ; getAddonList ( target : string ) : Promise < AddonListedDto [] > ; getAddonLog ( bookId : string ,
addonId ?: string ) : Promise < AddonLogDto [] > ; getBook ( bookId : string ) : Promise < KitsasBookInterface > ; getBookOpenCounts ( bookId : string ) : Promise < BookOpenCountItem [] > ; getBooks ( ) : Promise < BookListItem [] > ; getData ( bookId : string ,
key : string ) : Promise < object > ; getName ( ) : string ; getNotifications ( bookId : string ,
addonId ?: string ) : Promise < Notification [] > ; getOffice ( id : string ) : Promise < KitsasOfficeInterface > ; getOffices ( ) : Promise < OfficeInList [] > ; getOrganizationStatus ( businessId : string ) : Promise < OrganizationStatusResponse > ; getPermissions ( target : string ) : Promise < PermissionUser [] > ; getUserId ( ) : string ; listData ( ) : Promise < AddonDataListItem [] > ; listRights ( target ?: string ) : Promise < Right [] > ; replaceNotification ( bookId : string ,
type : NotificationType ,
title : LanguageString ,
text : LanguageString ,
category : string ) : Promise < void > ; saveData ( bookId : string ,
key : string ,
data : object ) : Promise < void > ; setPermissions ( permissions : PermissionPatch [] ) : Promise < void > ; writeAddonLog ( bookId : string ,
status : LogStatus ,
message : string ,
data ?: object ) : Promise < void > ; } add add ( bookshelfId , name , businessId ? , trial ? , backend ? , planId ? ) : Promise < AddBookResponse > Parameters bookshelfId : string name : string OptionalbusinessId : string Optionaltrial : boolean Optionalbackend : string OptionalplanId : number add add ( bookId , type , title , text , category ? ) : Promise < void > Returns Promise < void > delete delete ( bookId ) : Promise < void > Returns Promise < void > delete delete ( id ) : Promise < void > Returns Promise < void > delete delete ( bookId , category ? ) : Promise < void > Parameters bookId : string Optionalcategory : string Returns Promise < void > get get ( addonId , target ) : Promise < AddonInfoDto > Parameters addonId : string target : string get get ( bookId , addonId ? ) : Promise < AddonLogDto [] > Parameters bookId : string OptionaladdonId : string get get ( bookId , key ) : Promise < object > Parameters bookId : string key : string Returns Promise < object > get get ( ) : string Returns string User's name
get get ( bookId , addonId ? ) : Promise < Notification [] > Parameters bookId : string OptionaladdonId : string get get ( ) : string Returns string User's uuid
list list ( target ? ) : Promise < Right [] > Returns Promise < Right [] > List of rights
replace replace ( bookId , type , title , text , category ) : Promise < void > Returns Promise < void > save save ( bookId , key , data ) : Promise < void > Parameters bookId : string key : string data : object Returns Promise < void > set set ( permissions ) : Promise < void > Returns Promise < void > write write ( bookId , status , message , data ? ) : Promise < void > Parameters bookId : string status : LogStatus message : string Optionaldata : object Returns Promise < void >
Connection to Kitsas Server
Use KitsasConnection.login to create a new connection
You can get KitsasOfficeInterface from getOffice and KitsasBookInterface from getBook