Specify if authorization required in descs

Author: Jegarde

src/recnetpy/managers/account_manager.py

@@ -17,6 +17,8 @@ async def get(self, name: str) -> Optional['Account']:
         Gets user data by their username, and returns it as an account object.
         Returns nothing if the account doesn't exist.
 
+        Authorization required.
+
         :param name: The username of the RecNet user.
         :return: An account object representing the data or nothing if not found. 
         """
@@ -29,6 +31,8 @@ async def fetch(self, id: int) -> Optional['Account']:
         Gets user data by their id, and returns it as an account object.
         Returns nothing if an account with the specified id doesn't exist.
 
+        Authorization required.
+
         :param id: The id of the RecNet user.
         :return: An account object representing the data or nothing if not found. 
         """
@@ -42,6 +46,8 @@ async def get_many(self, names: List[str]) -> List['Account']:
         a list of account object.
         Accounts that couldn't be found will be silently ignored.
 
+        Authorization required.
+
         :param names: A list of username.
         :return: A list of account objects. 
         """
@@ -56,6 +62,8 @@ async def fetch_many(self, ids: List[int]) -> List['Account']:
         a list of account object.
         Accounts that couldn't be found will be silently ignored.
 
+        Authorization required.
+
         :param ids: A list of ids.
         :return: A list of account objects. 
         """
@@ -69,6 +77,8 @@ async def search(self, query: str) -> List['Account']:
         a list of account objects.
         If no account is found, an empty list will be returned.
 
+        Authorization required.
+
         :param query: A search query string.
         :return: A list of account objects.
         """

src/recnetpy/managers/event_manager.py

@@ -17,6 +17,8 @@ async def fetch(self, id: int) -> Optional['Event']:
         Gets event data by their id, and returns it as an event object.
         Returns nothing if the event doesn't exist or is private.
 
+        Authorization required.
+
         :param id: The id of the event.
         :return: An event object representing the data or nothing if not found. 
         """
@@ -31,6 +33,8 @@ async def fetch_many(self, ids: List[int]) -> List['Event']:
         a list of event object.
         Events that couldn't be found will be silently ignored.
 
+        Authorization required.
+
         :param ids: A list of ids.
         :return: A list of event objects. 
         """
@@ -43,6 +47,8 @@ async def search(self, query: str, take: int = 16, skip: int = 0, sort: int = 0)
         a list of event objects.
         If no event is found, an empty list will be returned.
 
+        Authorization required.
+
         :param query: A search query string.
         :param take: The number of results to return.
         :param skip: The number of results to skip.
@@ -63,6 +69,8 @@ async def from_account(self, id: int, take: int = 16, skip: int = 0) -> List['Ev
         Gets a list of events created by a player.
         If no event or the respective account is found, an empty list will be returned.
 
+        Authorization required.
+
         :param id: An account id.
         :param take: The number of results to return.
         :param skip: The number of results to skip.
@@ -80,6 +88,8 @@ async def in_room(self, id: int, take: int = 16, skip: int = 0) -> List['Event']
         Gets a list of events happening in a room.
         If no event or the respective room is found, an empty list will be returned.
 
+        Authorization required.
+
         :param query: A room id.
         :param take: The number of results to return.
         :param skip: The number of results to skip.
@@ -96,6 +106,8 @@ async def get_events(self, take: int = 16, skip: int = 0, sort: int = 0) -> List
         """
         Gets a list of events currently happening.
 
+        Authorization required.
+
         :param take: The number of results to return.
         :param skip: The number of results to skip.
         :param sort: An integer that describes how the results are to be sorted.

src/recnetpy/managers/image_manager.py

@@ -19,6 +19,8 @@ async def get(self, name: str) -> Optional['Image']:
         Only accepts image names of public RecNet posts.
         Returns nothing if the image doesn't exist or is private.
         
+        Authorization required.
+
         :param name: The name of the image.
         :return: An image object representing the data or nothing if not found. 
         """
@@ -35,6 +37,8 @@ async def get_many(self, names: List[str]) -> List['Image']:
         Only accepts image names of public RecNet posts.
         Images that couldn't be found will be silently ignored.
     
+        Authorization required.
+
         :param name: The name of the image.
         :return: A list of image objects. 
         """
@@ -47,6 +51,8 @@ async def fetch(self, id: int) -> Optional['Image']:
         Gets image data by their id, and returns it as an image object.
         Returns nothing if the image doesn't exist or is private.
 
+        Authorization required.
+
         :param id: The id of the image.
         :return: An image object representing the data or nothing if not found. 
         """
@@ -61,6 +67,8 @@ async def fetch_many(self, ids: List[int]) -> List['Image']:
         a list of image object.
         Images that couldn't be found will be silently ignored.
 
+        Authorization required.
+
         :param ids: A list of ids.
         :return: A list of image objects. 
         """
@@ -72,6 +80,8 @@ async def from_account(self, id: int, take: int = 16, skip: int = 0, sort: int =
         Gets a list of images taken by a player.
         If no image or the respective account is found, an empty list will be returned.
 
+        Authorization required.
+
         :param id: A player id.
         :param take: The number of results to return.
         :param skip: The number of results to skip.
@@ -91,6 +101,8 @@ async def player_feed(self, id: int, take: int = 16, skip: int = 0) -> List['Ima
         Gets a list of images taken of a player.
         If no image or the respective account is found, an empty list will be returned.
 
+        Authorization required.
+
         :param id: A player id.
         :param take: The number of results to return.
         :param skip: The number of results to skip.                 
@@ -108,6 +120,8 @@ async def during_event(self, id: int, take: int = 16, skip: int = 0) -> List['Im
         Gets a list of images taken during an event.
         If no image or the respective event is found, an empty list will be returned.
 
+        Authorization required.
+
         :param id: A event id.
         :param take: The number of results to return.
         :param skip: The number of results to skip.
@@ -125,6 +139,8 @@ async def in_room(self, id: int, take: int = 16, skip: int = 0, sort: int = 0) -
         Gets a list of images taken in a room.
         If no image or the respective room is found, an empty list will be returned.
 
+        Authorization required.
+
         :param id: A room id.
         :param take: The number of results to return.
         :param skip: The number of results to skip.
@@ -143,6 +159,8 @@ async def front_page(self, take: int = 16, skip: int = 0) -> List['Image']:
         """
         Gets a list of the most popular images on RecNet.
 
+        Authorization required.
+
         :param take: The number of results to return.
         :param skip: The number of results to skip.
         :return: A list of image objects.

src/recnetpy/managers/invention_manager.py

@@ -17,6 +17,8 @@ async def fetch(self, id: int) -> Optional['Invention']:
         Gets invention data by their id, and returns it as an invention object.
         Returns nothing if the invention doesn't exist or is private.
 
+        Authorization required.
+
         :param id: The id of the invention.
         :return: An invention object representing the data or nothing if not found. 
         """
@@ -31,6 +33,8 @@ async def search(self, query: str, take: int = 16) -> List['Invention']:
         a list of invention objects.
         If no invention is found, an empty list will be returned.
 
+        Authorization required.
+
         :param query: A search query string.
         :return: A list of invention objects.
         """
@@ -45,6 +49,8 @@ async def featured(self, take: int = 16, skip: int = 0) -> List['Invention']:
         """
         Gets a list of the featured inventions on RecNet.
 
+        Authorization required.
+
         :param take: The number of results to return.
         :param skip: The number of results to skip.
         :return: A list of invention objects.
@@ -60,6 +66,8 @@ async def top_today(self) -> List['Invention']:
         """
         Gets a list of the top inventions on RecNet for today.
 
+        Authorization required.
+
         :return: A list of invention objects.
         """
         data: 'Response[List[InventionResponse]]' = await self.rec_net.apim.inventions.v1.toptoday.make_request('get')