Merge pull request #6 from RecNetBot-Development/official-api

Merge official API implementation to main

Author: Jegarde

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "recnetpy"
-version = "0.1.51"
+version = "0.2.75"
 authors = [
     { name="RecNetBot Development"}
 ]

src/recnetpy/dataclasses/account.py

@@ -3,14 +3,15 @@
 from .base import BaseDataClass
 from .progression import Progression
 from ..misc import date_to_unix, bitmask_decode
+from ..rest.exceptions import RateLimited
 
 if TYPE_CHECKING:
     from . import Event, Image, Room
     from ..misc.api_responses import AccountResponse, ProgressionResponse, BioResponse
     from ..rest import Response
 
 
-PLATFORM_LIST: List[str] = ['Steam', 'Meta', 'PlayStation', 'Xbox', 'HeadlessBot', 'iOS', 'Android', 'Standalone', 'Pico']
+PLATFORM_LIST: List[str] = ['Steam', 'Meta', 'PlayStation', 'Xbox', 'RecNet', 'iOS', 'Android', 'Standalone', 'Pico', 'Nintendo']
 PERSONAL_PRONOUNS_LIST: List[str] = ['She / her', 'He / him', 'They / them', 'Ze / hir', 'Ze / zir', 'Xe / xem']
 IDENTITY_FLAGS_LIST: List[str] = ['LGBTQIA', 'Transgender', 'Bisexual', 'Lesbian', 'Pansexual', 'Asexual', 'Intersex', 'Genderqueer', 'Nonbinary', 'Aromantic']
 
@@ -25,10 +26,12 @@ class Account(BaseDataClass['AccountResponse']):
     username: str
     #: This is what appears in bold above the username on an account's page on RecNet. The display name is not unique unlike the username.
     display_name: str
+    #: This is the RR+ exclusive display emoji.
+    display_emoji: Optional[str] = None
     #: This is the file name of an account's profile picture.  
     profile_image: str
     #: This is true if the account is a junior account, false if the account is a non-junior account. 
-    is_junior: bool
+    # is_junior: bool DEPRECATED
     #: This is a list of platforms a user plays on. It has these possible values ``['Steam', 'Meta', 'PlayStation', 'Xbox', 'RecNet', 'iOS', 'Android', 'Standalone']``.   
     platforms: List[str]
     #: This is the list of pronouns a user goes by. It has these possible values ``['She / her', 'He / him', 'They / them', 'Ze / hir', 'Ze / zir', 'Xe / xem']``.  
@@ -73,11 +76,12 @@ def patch_data(self, data: 'AccountResponse') -> None:
         self.display_name = data['displayName']
         self.profile_image = data['profileImage']
         self.banner_image = data.get("bannerImage", None)
-        self.is_junior = bool(data['isJunior'])
+        self.display_emoji = data.get("displayEmoji", None)
+        #self.is_junior = bool(data['isJunior'])
         self.platforms = bitmask_decode(data['platforms'], PLATFORM_LIST)
         self.personal_pronouns = bitmask_decode(data['personalPronouns'], PERSONAL_PRONOUNS_LIST)
         self.identity_flags = bitmask_decode(data['identityFlags'], IDENTITY_FLAGS_LIST)
-        self.created_at = date_to_unix(data['createdAt'])
+        self.created_at = date_to_unix(data['createdAt'], new=False)
 
     async def get_events(self, take: int = 16, skip: int = 0, force: bool = False) -> List['Event']:
         """
@@ -167,8 +171,11 @@ async def get_bio(self, force: bool = False) -> str:
         :return: The player's bio.
         """
         if self.bio is None or force:
-            data: 'Response[BioResponse]' = await self.rec_net.accounts(self.id).bio.make_request('get')
-            self.bio = data.data['bio']
+            try:
+                data: 'Response[BioResponse]' = await self.rec_net.accounts(self.id).bio.make_request('get')
+                self.bio = data.data['bio']
+            except RateLimited:
+                self.bio = "Unable to fetch bio!"
         return self.bio
 
     async def get_level(self, force: bool = False) -> 'Progression':
@@ -180,7 +187,7 @@ async def get_level(self, force: bool = False) -> 'Progression':
         :return: This player's level.
         """
         if self.level is None or force:
-            data: 'Response[List[ProgressionResponse]]' = await self.rec_net.api.players.v2.progression.bulk.make_request('post', body = {'id': [self.id]})
+            data: 'Response[List[ProgressionResponse]]' = await self.rec_net.apim.players.progression.bulk.make_request('post', body = {'id': [self.id]})
             self.level = Progression(data.data[0])
         return self.level
 
@@ -193,8 +200,12 @@ async def get_subscriber_count(self, force: bool = False) -> int:
         :return: This player's subscriber count.
         """
         if self.subscriber_count is None or force:
+            #try:
             data: 'Response[int]' = await self.rec_net.clubs.subscription.subscribercount(self.id).make_request('get')
             self.subscriber_count = data.data
+            #except:
+            #    self.subscriber_count = -1
+
         return self.subscriber_count
 
     async def get_is_influencer(self, force: bool = False) -> bool:
@@ -206,6 +217,6 @@ async def get_is_influencer(self, force: bool = False) -> bool:
         :return: This player's subscriber count.
         """
         if self.is_influencer is None or force:
-            data: 'Response[bool]' = await self.rec_net.api.influencerpartnerprogram.isinfluencer.make_request('get', params = {'accountId': self.id})
+            data: 'Response[bool]' = await self.rec_net.apim.influencerpartnerprogram.isinfluencer.make_request('get', params = {'accountId': self.id})
             self.is_influencer = data.data
         return self.is_influencer 

src/recnetpy/dataclasses/event.py

@@ -2,7 +2,7 @@
 
 from .base import BaseDataClass
 from .event_response import EventInteraction
-from ..misc import date_to_unix
+from ..misc import date_to_unix, list_chunks
 from ..misc.constants import ACCESSIBILITY_DICT
 
 if TYPE_CHECKING:
@@ -74,18 +74,18 @@ def patch_data(self, data: 'EventResponse') -> None:
         self.creator_player_id = data['CreatorPlayerId']
         self.image_name = data['ImageName']
         self.room_id = data['RoomId']
-        self.subroom_id = data['SubRoomId']
+        #self.subroom_id = data['SubRoomId']
         self.club = data['ClubId']
         self.name = data['Name']
         self.description = data['Description']
-        self.start_time = date_to_unix(data['StartTime'])
-        self.end_time = date_to_unix(data['EndTime'])
+        self.start_time = date_to_unix(data['StartTime'], new=False)
+        self.end_time = date_to_unix(data['EndTime'], new=False)
         self.attendee_count = data['AttendeeCount']
-        self.accessibility = ACCESSIBILITY_DICT.get(data['Accessibility'], "Unknown")
-        self.is_multi_instance = data['IsMultiInstance']
-        self.support_multi_instance_room_chat = data['SupportMultiInstanceRoomChat']
-        self.default_broadcast_permissions = BROADCAST_PERMISSION_DICT.get(data['DefaultBroadcastPermissions'], "Unknown")
-        self.can_request_broadcast_permissions = BROADCAST_PERMISSION_DICT.get(data['CanRequestBroadcastPermissions'], "Unkown")
+        #self.accessibility = ACCESSIBILITY_DICT.get(data['Accessibility'], "Unknown")
+        #self.is_multi_instance = data['IsMultiInstance']
+        #self.support_multi_instance_room_chat = data['SupportMultiInstanceRoomChat']
+        #self.default_broadcast_permissions = BROADCAST_PERMISSION_DICT.get(data['DefaultBroadcastPermissions'], "Unknown")
+        #self.can_request_broadcast_permissions = BROADCAST_PERMISSION_DICT.get(data['CanRequestBroadcastPermissions'], "Unkown")
 
     async def get_images(self, take: int = 16, skip: int = 0, force: bool = False) -> List['Image']:
         """
@@ -149,7 +149,7 @@ async def get_responses(self, force: bool = False) -> List['EventInteraction']:
         :return: A list of event interaction objects.
         """
         if self.responses is None or force:
-            data: Response[List['EventResponseResponse']] = await self.rec_net.api.playerevents.v1(self.id).responses.make_request('get')
+            data: Response[List['EventResponseResponse']] = await self.rec_net.events(self.id).responses.make_request('get')
             self.responses = EventInteraction.create_from_list(data.data)
         return self.responses
 
@@ -170,6 +170,21 @@ async def resolve_responders(self, force: bool = False) -> List['EventInteractio
                 player = self.client.accounts.create_dataclass(response.player_id)
                 response.player = player
                 players[response.player_id] = player
-            data: 'Response[List[AccountResponse]]' = await self.rec_net.accounts.account.bulk.make_request('post', body = {"id": players.keys()})
-            for data_response in data.data: players.get(data_response['accountId']).patch_data(data_response)
+
+            player_ids = list(players.keys())
+            data: List[AccountResponse] = []
+
+            # 750 == roughly 9750 bytes of payload
+            # limit of 10240 bytes in API
+            if len(player_ids) > 750:
+                player_chunks = list_chunks(player_ids, 750)
+                for i in player_chunks:
+                    response: 'Response[List[AccountResponse]]' = await self.rec_net.accounts.bulk.make_request('post', body = {"id": i})
+                    data += response.data
+            else:
+                # Fits in a single payload
+                response: 'Response[List[AccountResponse]]' = await self.rec_net.accounts.bulk.make_request('post', body = {"id": player_ids})
+                data = response.data
+
+            for data_response in data: players.get(data_response['accountId']).patch_data(data_response)
         return self.responses

src/recnetpy/dataclasses/image.py

@@ -29,11 +29,11 @@ class Image(BaseDataClass['ImageResponse']):
     #: This is an image's unique identifier.
     id: int
     #: This is the type of image which has the possible value of ``[None, 'Share Camera', 'Outfit Thumbnail', 'Room Thumbnail', 'Profile Thumbnail', 'Invention Thumbnail', 'Player Event Thumbnail', 'Room Load Screen']``.
-    type: str
+    #type: str
     #: This is the visibilty of the image which has the possible value of ``['Private', 'Public', 'Unlisted']``.
-    accessibility: str
+    #accessibility: str
     #: This is true if the accessiblity of the image is fixed, false if its able to able to be changed.
-    accessibility_locked: bool
+    #accessibility_locked: bool
     #: This is the file name of the image itself.
     image_name: str
     #: This is the description of the image.
@@ -75,16 +75,17 @@ def patch_data(self, data: 'ImageResponse') -> None:
         """
         self.data = data
         self.id = data['Id']
-        self.type = IMAGE_TYPE.get(data['Type'], "Unknown")
-        self.accessibility = ACCESSIBILITY_DICT.get(data['Accessibility'], "Unknown")
-        self.accessibility_locked = data['AccessibilityLocked']
+        #self.type = IMAGE_TYPE.get(data['Type'], "Unknown")
+        #self.accessibility = ACCESSIBILITY_DICT.get(data['Accessibility'], "Unknown")
+        #self.accessibility_locked = data['AccessibilityLocked']
         self.image_name = data['ImageName']
         self.description = data['Description']
         self.player_id = data['PlayerId']
-        self.tagged_player_ids = data['TaggedPlayerIds']
+        #self.tagged_player_ids = data['TaggedPlayerIds']
+        self.tagged_player_ids = []
         self.room_id = data['RoomId']
         self.event_id = data['PlayerEventId']
-        self.created_at = date_to_unix(data['CreatedAt'])
+        self.created_at = date_to_unix(data['CreatedAt'], new=False)
         self.cheer_count = data['CheerCount']
         self.comment_count = data['CommentCount']
 
@@ -162,7 +163,7 @@ async def get_cheers(self, force: bool = False) -> List[int]:
         """        
         if self.cheer_count == 0: return []
         if self.cheer_player_ids is None or force:
-            data: 'Response[List[int]]' = await self.rec_net.api.images.v1(self.id).cheers.make_request('get')
+            data: 'Response[List[int]]' = await self.rec_net.images(self.id).cheers.make_request('get')
             self.cheer_player_ids = data.data           
         return self.cheer_player_ids
 
@@ -176,7 +177,7 @@ async def get_comments(self, force: bool = False) -> List['Comment']:
         """
         if self.comment_count == 0: return []
         if self.comments is None or force:
-            data: 'Response[List[CommentResponse]]' = await self.rec_net.api.images.v1(self.id).comments.make_request('get')
+            data: 'Response[List[CommentResponse]]' = await self.rec_net.images(self.id).comments.make_request('get')
             self.comments = Comment.create_from_list(data.data)
         return self.comments
 
@@ -211,6 +212,6 @@ async def resolve_commenters(self, force: bool = False) -> List['Comment']:
                 player = self.client.accounts.create_dataclass(comment.player_id)
                 comment.player = player
                 players[comment.player_id] = player
-            data: 'Response[List[AccountResponse]]' = await self.rec_net.accounts.account.bulk.make_request('post', body = {id: players.keys})
+            data: 'Response[List[AccountResponse]]' = await self.rec_net.accounts.bulk.make_request('post', body = {id: players.keys})
             for data_response in data.data: players.get(data_response['accountId']).patch_data(data_response)
         return self.comments

src/recnetpy/dataclasses/role.py

@@ -9,8 +9,9 @@
 ROLE_DICT: Dict[int, str] = {
     0: None,
     1: "Banned",
-    10: "Member",
+    10: "Host",
     20: "Moderator",
+    25: "Contributor",
     30: "Co-Owner",
     31: "Temporary Co-Owner",
     255: "Owner"
@@ -20,11 +21,11 @@ class Role(VariableClass['RoleResponse']):
     """
     This class represents a room's player roles.
     """
-    #: This is the id of the role which has the possible values of ``{0: 'None', 10: 'Member', 20: 'Moderator', 30: 'Co-Owner', 31: 'Temporary Co-Owner', 255: 'Owner'}``.
+    #: This is the id of the role which has the possible values of ``{0: 'None', 10: 'Host', 20: 'Moderator', 30: 'Co-Owner', 31: 'Temporary Co-Owner', 255: 'Owner'}``.
     id: int
     #: This is the id of the player who owns this role.
     account_id: int
-    #: This is the name of the role the player owns which has the possible values of ``['None', 'Member', 'Moderator', 'Co-Owner', 'Temporary Co-Owner', Owner']``
+    #: This is the name of the role the player owns which has the possible values of ``['None', 'Host', 'Moderator', 'Co-Owner', 'Temporary Co-Owner', Owner']``
     name: str
     #: This is the id of the account who updated the player's role.
     last_changed_by_account_id: Optional[int]

src/recnetpy/dataclasses/room.py

@@ -102,6 +102,8 @@ class Room(BaseDataClass['RoomResponse']):
     visitor_count: int
     #: This in the number of times players have joined the room.
     visit_count: int
+    #: This is the amount of boosts the room has.
+    boost_count: int
     #: This is an account object which represents the player who created the room.
     creator_account: Optional['Account'] = None
     #: This a list of subroom objects which represents the room's subrooms.
@@ -133,22 +135,22 @@ def patch_data(self, data: 'RoomResponse') -> None:
         self.data = data
         self.id = data["RoomId"]
         self.is_dorm = data["IsDorm"]
-        self.max_player_calculation_mode = MAX_PLAYER_CALCULATION_MODE.get(data["MaxPlayerCalculationMode"], "Unknown")
+        #self.max_player_calculation_mode = MAX_PLAYER_CALCULATION_MODE.get(data["MaxPlayerCalculationMode"], "Unknown")
         self.max_players = data["MaxPlayers"]
-        self.cloning_allowed = data["CloningAllowed"]
-        self.disable_mic_auto_mute = data["DisableMicAutoMute"]
-        self.disable_room_comments = data["DisableRoomComments"]
-        self.encrypted_voice_chat = data["EncryptVoiceChat"]
-        self.voice_moderated = data["ToxmodEnabled"]
-        self.load_screen_locked = data["LoadScreenLocked"]
+        #self.cloning_allowed = data["CloningAllowed"]
+        #self.disable_mic_auto_mute = data["DisableMicAutoMute"]
+        #self.disable_room_comments = data["DisableRoomComments"]
+        #self.encrypted_voice_chat = data["EncryptVoiceChat"]
+        #self.voice_moderated = data["ToxmodEnabled"]
+        #self.load_screen_locked = data["LoadScreenLocked"]
         self.name = data["Name"]
         self.description = data["Description"]
         self.image_name = data["ImageName"]
         self.warnings = bitmask_decode(data["WarningMask"], WARNING_MASK_LIST)
         self.custom_warning = data["CustomWarning"]
         self.creator_account_id = data["CreatorAccountId"]
-        self.state = ROOM_MODERATION_STATE.get(data["State"], "Unknown")
-        self.accessibility = ACCESSIBILITY_DICT.get(data["Accessibility"], "Unknown")
+        #self.state = ROOM_MODERATION_STATE.get(data["State"], "Unknown")
+        #self.accessibility = ACCESSIBILITY_DICT.get(data["Accessibility"], "Unknown")
         self.supports_level_voting = data["SupportsLevelVoting"]
         self.is_rro = data["IsRRO"]
         self.supports_screens = data["SupportsScreens"]
@@ -164,6 +166,7 @@ def patch_data(self, data: 'RoomResponse') -> None:
         self.favorite_count = data["Stats"]["FavoriteCount"]
         self.visitor_count = data["Stats"]["VisitorCount"]
         self.visit_count = data["Stats"]["VisitCount"]
+        self.boost_count = data["BoostCount"]
         self.subrooms = SubRoom.create_from_list(data.get("SubRooms"))
         self.roles = Role.create_from_list(data.get("Roles"))
         self.tags = Tag.create_from_list(data.get("Tags"))
@@ -221,14 +224,15 @@ async def resolve_role_owners(self) -> Optional[List['Role']]:
 
         :return: A list of role objects, or None if roles is None 
         """
+
         if self.roles is None: return None
         roles = self.roles
         accounts: Dict[int, Account] = {}
         for role in roles:
             account = self.client.accounts.create_dataclass(role.account_id)
             role.account = account
             accounts[role.account_id] = account
-        data: 'Response[List[AccountResponse]]' = await self.rec_net.accounts.account.bulk.make_request('post', body = {"id": accounts.keys()})
+        data: 'Response[List[AccountResponse]]' = await self.rec_net.accounts.bulk.make_request('post', body = {"id": accounts.keys()})
         for data_response in data.data: accounts.get(data_response['accountId']).patch_data(data_response)
 
         # Search for deleted accounts

src/recnetpy/dataclasses/subroom.py

@@ -40,25 +40,19 @@ class SubRoom(VariableClass['SubRoomResponse']):
     description: Optional[str]
 
     def __init__(self, data: 'SubRoomResponse'):
-        if data.get("CurrentSave"):
-            description = data["CurrentSave"].get("Description")
-            saved_at = date_to_unix(data["CurrentSave"]["CreatedAt"])
-            saved_by = data["CurrentSave"].get("SavedByAccountId", 1)
-        else:
-            saved_at, saved_by, description = None, 1, None
-
         self.supports_join_in_progress = data['SupportsJoinInProgress']
         self.use_level_based_matchmaking = data['UseLevelBasedMatchmaking']
         self.use_age_based_matchmaking = data['UseAgeBasedMatchmaking']
         self.use_rec_royale_matchmaking = data['UseRecRoyaleMatchmaking']
         self.subroom_id = data['SubRoomId']
         self.room_id = data['RoomId']
-        self.unity_scene_id = data['UnitySceneId']
+        #self.unity_scene_id = data['UnitySceneId']
+        self.last_moderated_save_moderation_state = data["LastModeratedSaveModerationState"]
         self.name = data['Name']
-        self.data_blob = data.get("DataBlob", None)
-        self.data_saved_at = saved_at
-        self.data_saved_by = saved_by
-        self.description = description
+        #self.data_blob = data.get("DataBlob", None)
+        #self.data_saved_at = saved_at
+        #self.data_saved_by = saved_by
+        #self.description = description
         self.is_sandbox = data['IsSandbox']
         self.max_players = data['MaxPlayers']
         self.accessibility = ACCESSIBILITY_DICT.get(data['Accessibility'])