gotipy/README.md
benjamyn 01fdbc4d31 Updated README.md with a new layout
Fixed name of function to better fit the standard (addClient -> createClient)
2018-11-11 20:29:31 +11:00

3.4 KiB

API Wrapper for gotify RESTAPI for python3

Gotify server

Initialize the wrapper with the token you want to use

i.e: gotipy_usr = gotipy.gotipy("user token", "https://URL.TLD")

applications class

Function Arguments Return
getApplications N/A JSON formatted list
createApplication Name, Description JSON formatted list
deleteApplication Application ID HTTP resopnse code
updateApplicationImage Application ID, Image Data HTTP response code

clients class

Function Arguments Return
getClients N/A JSON formatted list
createClient Name JSON formatted list
deleteClient Client ID HTTP response code

msgManager class

Function Arguments Return
getMessagesByApp Application ID JSON formatted list
deleteAllMessagesFromApp Application ID HTTP response code
getAllMesages N/A JSON formatted list
deleteAllMessages N/A HTTP response code
deleteMessagesByID Message ID HTTP response code
getStream N/A JSON formatted list

messages class

Function Arguments Return
sendMessage Title, Message JSON formatted list

users class

Function Arguments Return
getCurrentUser() N/A JSON formatted list
changeUserPassword Password JSON formatted list
getUsers N/A JSON formatted list
createUser Admin, Username, Password JSON formatted list
getUserByID User ID JSON formatted list
updateUserByID User ID, Admin, Username, Password JSON formatted list
deleteUserByID User ID HTTP response code

utils class

Function Arguments Return
getVersion N/A JSON formatted list
basicAuth Username, password JSON formatted list