Files
headphones/lib/slskd_api/apis/users.py
2024-05-26 09:47:43 +05:30

79 lines
2.7 KiB
Python

# Copyright (C) 2023 bigoulours
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from .base import *
class UsersApi(BaseApi):
"""
This class contains the methods to interact with the Users API.
"""
def address(self, username: str) -> dict:
"""
Retrieves the address of the specified username.
"""
url = self.api_url + f'/users/{quote(username)}/endpoint'
response = self.session.get(url)
return response.json()
def browse(self, username: str) -> dict:
"""
Retrieves the files shared by the specified username.
"""
url = self.api_url + f'/users/{quote(username)}/browse'
response = self.session.get(url)
return response.json()
def browsing_status(self, username: str) -> dict:
"""
Retrieves the status of the current browse operation for the specified username, if any.
Will return error 404 if called after the browsing operation has ended.
Best called asynchronously while :py:func:`browse` is still running.
"""
url = self.api_url + f'/users/{quote(username)}/browse/status'
response = self.session.get(url)
return response.json()
def directory(self, username: str, directory: str) -> dict:
"""
Retrieves the files from the specified directory from the specified username.
"""
url = self.api_url + f'/users/{quote(username)}/directory'
data = {
"directory": directory
}
response = self.session.post(url, json=data)
return response.json()
def info(self, username: str) -> dict:
"""
Retrieves information about the specified username.
"""
url = self.api_url + f'/users/{quote(username)}/info'
response = self.session.get(url)
return response.json()
def status(self, username: str) -> dict:
"""
Retrieves status for the specified username.
"""
url = self.api_url + f'/users/{quote(username)}/status'
response = self.session.get(url)
return response.json()