blocket-api 0.3.6__tar.gz → 0.3.7__tar.gz

{blocket_api-0.3.6 → blocket_api-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.3.6
+Version: 0.3.7
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -16,7 +16,7 @@ Requires-Dist: mkdocs>=1.6.1
 Requires-Dist: mkdocs-material>=9.6.21
 Requires-Dist: mkdocs-swagger-ui-tag>=0.7.2
 Requires-Dist: websockets>=15.0.1
-Requires-Dist: ruff>=0.14.4
+Requires-Dist: ruff>=0.14.5
 Dynamic: license-file
 
 <p align="center">
@@ -83,6 +83,7 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`api.get_saved_ads()`](#get_saved_ads)  | 🔐 Yes | - | List all saved ads. 
 | [`api.get_threads()`](#get_threads)  | 🔐 Yes | - | List all threads (messages).
 | [`api.get_messages_from_thread()`](#get_messages_from_thread)  | 🔐 Yes | - | Get all messages from a thread. 
+| [`api.unread_messages_count()`](#unread_messages_count)  | 🔐 Yes | Yes | Get the total count of unread messages.
 
 
 ## 🤓 Detailed usage
@@ -422,6 +423,17 @@ Returns all of your messages from an existing thread/conversation.
 }
 ```
 
+### unread_messages_count
+Returns the count of unread messages.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.unread_messages_count()
+{
+   "unread_count": 5
+}
+```
+
 
 
 ## 🔐 Blocket API token

{blocket_api-0.3.6 → blocket_api-0.3.7}/README.md

@@ -62,6 +62,7 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`api.get_saved_ads()`](#get_saved_ads)  | 🔐 Yes | - | List all saved ads. 
 | [`api.get_threads()`](#get_threads)  | 🔐 Yes | - | List all threads (messages).
 | [`api.get_messages_from_thread()`](#get_messages_from_thread)  | 🔐 Yes | - | Get all messages from a thread. 
+| [`api.unread_messages_count()`](#unread_messages_count)  | 🔐 Yes | Yes | Get the total count of unread messages.
 
 
 ## 🤓 Detailed usage
@@ -401,6 +402,17 @@ Returns all of your messages from an existing thread/conversation.
 }
 ```
 
+### unread_messages_count
+Returns the count of unread messages.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.unread_messages_count()
+{
+   "unread_count": 5
+}
+```
+
 
 
 ## 🔐 Blocket API token

{blocket_api-0.3.6 → blocket_api-0.3.7}/blocket_api/blocket.py

@@ -17,6 +17,7 @@ from blocket_api.models import (
     SavedSearchResponse,
     StoreListings,
     StoreSearchResults,
+    UnreadMessagesCount,
 )
 from blocket_api.qasa import HOME_SEARCH_ORDERING, HomeType, OrderBy, Qasa
 
@@ -609,3 +610,22 @@ class BlocketAPI:
         assert self.token
         sendbird = Sendbird.generate(self.token)
         return sendbird.get_messages_from_thread(channel_id)
+
+    @overload
+    def unread_messages_count(
+        self, *, as_objects: Literal[True]
+    ) -> UnreadMessagesCount: ...
+
+    @overload
+    def unread_messages_count(self, *, as_objects: Literal[False] = False) -> dict: ...
+
+    @auth_token
+    def unread_messages_count(
+        self, as_objects: bool = False
+    ) -> dict | UnreadMessagesCount:
+        """
+        Returns the total count of unread messages.
+        """
+        assert self.token
+        response = Sendbird.generate(self.token).unread_messages_count()
+        return UnreadMessagesCount.model_validate(response) if as_objects else response

{blocket_api-0.3.6 → blocket_api-0.3.7}/blocket_api/models.py

@@ -612,3 +612,10 @@ class SavedSearch(_BaseModel):
 
 class SavedSearchResponse(_BaseModel):
     searches: list[SavedSearch]
+
+
+## UnreadMessagesCount ##
+
+
+class UnreadMessagesCount(_BaseModel):
+    unread_count: int

{blocket_api-0.3.6 → blocket_api-0.3.7}/blocket_api/sendbird.py

@@ -175,3 +175,16 @@ class Sendbird:
         )
         response.raise_for_status()
         return response.json()
+
+    def unread_messages_count(self) -> dict:
+        sendbird = SendbirdResponse.model_validate_json(self.sendbird_client.get_data())
+        response = httpx.get(
+            f"{SENDBIRD_URL}/v3/users/{self.sendbird_client.user_id}/unread_message_count",
+            params={"super_mode": "all", "include_feed_channel": False},
+            headers={
+                "Session-Key": sendbird.session_key,
+                "Access-Token": self.sendbird_client.access_token,
+            },
+        )
+        response.raise_for_status()
+        return response.json()

{blocket_api-0.3.6 → blocket_api-0.3.7}/blocket_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.3.6
+Version: 0.3.7
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -16,7 +16,7 @@ Requires-Dist: mkdocs>=1.6.1
 Requires-Dist: mkdocs-material>=9.6.21
 Requires-Dist: mkdocs-swagger-ui-tag>=0.7.2
 Requires-Dist: websockets>=15.0.1
-Requires-Dist: ruff>=0.14.4
+Requires-Dist: ruff>=0.14.5
 Dynamic: license-file
 
 <p align="center">
@@ -83,6 +83,7 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`api.get_saved_ads()`](#get_saved_ads)  | 🔐 Yes | - | List all saved ads. 
 | [`api.get_threads()`](#get_threads)  | 🔐 Yes | - | List all threads (messages).
 | [`api.get_messages_from_thread()`](#get_messages_from_thread)  | 🔐 Yes | - | Get all messages from a thread. 
+| [`api.unread_messages_count()`](#unread_messages_count)  | 🔐 Yes | Yes | Get the total count of unread messages.
 
 
 ## 🤓 Detailed usage
@@ -422,6 +423,17 @@ Returns all of your messages from an existing thread/conversation.
 }
 ```
 
+### unread_messages_count
+Returns the count of unread messages.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.unread_messages_count()
+{
+   "unread_count": 5
+}
+```
+
 
 
 ## 🔐 Blocket API token

{blocket_api-0.3.6 → blocket_api-0.3.7}/blocket_api.egg-info/requires.txt

@@ -8,4 +8,4 @@ mkdocs>=1.6.1
 mkdocs-material>=9.6.21
 mkdocs-swagger-ui-tag>=0.7.2
 websockets>=15.0.1
-ruff>=0.14.4
+ruff>=0.14.5

{blocket_api-0.3.6 → blocket_api-0.3.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "blocket_api"
-version = "0.3.6"
+version = "0.3.7"
 description = "A python API wrapper for blocket.se"
 authors = [{name = "dunderrrrrr", email = "emil.bjorkroth@gmail.com"}]
 readme = "README.md"
@@ -16,7 +16,7 @@ dependencies = [
     "mkdocs-material>=9.6.21",
     "mkdocs-swagger-ui-tag>=0.7.2",
     "websockets>=15.0.1",
-    "ruff>=0.14.4",
+    "ruff>=0.14.5",
 ]