Merge branch 'main' into official-api

Author: Jegarde

README.md

@@ -1,5 +1,5 @@
 # RecNetPy
-> **RecNetPy** is an API wrapper built in Python for pulling data from [RecNet](https://rec.net/). **RecNetPy** aims to be easy to use yet powerful. It's the same wrapper used to power [RecNetBot](https://github.com/RecNetBot-Development/RecNetBot)!
+> **RecNetPy** is a [Rec Room](https://devportal.rec.net/) API wrapper built in Python. **RecNetPy** aims to be easy to use yet powerful. It's the same wrapper used to power [RecNetBot](https://github.com/RecNetBot-Development/RecNetBot)!
 
 [![NPM Version][pip-image]][pip-url]
 [![Downloads Stats][pip-downloads]][pip-url]

requirements.txt

@@ -1,3 +1,3 @@
-aiohttp==3.8.5
+aiohttp==3.9.2
 sphinx==5.2.3
 python-dateutil==2.8.2

src/recnetpy/__init__.py

@@ -1 +1,3 @@
-from .client import Client
+from .client import Client
+from .managers.room_manager import RoomInclude
+from .dataclasses import *

src/recnetpy/dataclasses/account.py

@@ -7,7 +7,7 @@
 
 if TYPE_CHECKING:
     from . import Event, Image, Room
-    from ..misc.api_responses import AccountResponse, ProgressionResponse, BioResponse, RoomResponse
+    from ..misc.api_responses import AccountResponse, ProgressionResponse, BioResponse
     from ..rest import Response
 
 
@@ -17,7 +17,7 @@
 
 class Account(BaseDataClass['AccountResponse']):
     """
-    This dataclass represents a RecNet account. 
+    This dataclass represents a Rec Room account. 
     """
 
     #: This is an account's unique identifier

src/recnetpy/managers/room_manager.py

@@ -1,5 +1,6 @@
 from typing import TYPE_CHECKING, List, Optional
 
+from enum import Enum
 from . import BaseManager
 from ..dataclasses import Room
 from ..misc import stringify_bulk
@@ -8,12 +9,35 @@
     from ..misc.api_responses import RoomResponse, RoomSearchResponse
     from ..rest import Response
 
+class RoomInclude(Enum):
+    """
+    Enum which corresponds to the room include parameter values
+    """
+    SUBROOMS = 2
+    ROLES = 4
+    TAGS = 8
+    PROMO_CONTENT = 32
+    SCORES = 64
+    LOADING_SCREENS = 256 
+
+def sum_enum_list(enums: List[Enum]) -> int:
+    """
+    Sums a list of integer enums
+
+    :param enums: A list of enums that have integer values
+    :return: Sum of the enums' values
+    """
+    sum = 0
+    for i in enums:
+        sum += i.value
+    return sum
+
 class RoomManager(BaseManager['Room', 'RoomResponse']):
     """
     This is a factory object for creating room objects. Its the
     main interface for fetching room related data.
     """
-    async def get(self, name: str, include: int = 0) -> 'Room':
+    async def get(self, name: str, include: int | List[RoomInclude] = 0) -> 'Room':
         """
         Gets room data by their name, and returns it as an room object.
         Returns nothing if the room doesn't exist or is private.
@@ -44,7 +68,7 @@ async def get(self, name: str, include: int = 0) -> 'Room':
             return self.create_dataclass(room_data, room_data)
         return None
 
-    async def fetch(self, id: int, include: int = 0) -> 'Room':
+    async def fetch(self, id: int, include: int | List[RoomInclude] = 0) -> 'Room':
         """
         Gets room data by their id, and returns it as an room object.
         Returns nothing if the room doesn't exist or is private.