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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.3.5
+Version: 0.3.7
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -15,7 +15,8 @@ Requires-Dist: pydantic>=2.11.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: ruff>=0.14.4
+Requires-Dist: websockets>=15.0.1
+Requires-Dist: ruff>=0.14.5
 Dynamic: license-file
 
 <p align="center">
@@ -80,6 +81,9 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`api.get_user_by_id()`](#get_user_by_id)  | 👏 No | Yes | Get user data from id.
 | [`api.save_ad()`](#save_ad)  | 🔐 Yes | - | Save ad to "Saved ads".
 | [`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
@@ -368,6 +372,70 @@ Returns all of your saved ads from `https://www.blocket.se/sparade/annonser`.
 
 ```
 
+### get_threads
+Returns all of your threads/conversations from Blocket. This api requires a token.
+
+- `limit` (`int`, optional) - Number of threads to return, default is 15.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.get_threads()
+{
+   "channels": [
+      {     
+         "channel_url": "sendbird_group_channel_123",
+         "name": "from:user-id,ad:1214281684,to:c1-user-id",
+         "data": {
+            "ad": {
+               "id": "1214281684",
+               "advertiser_name": "Kalle",
+               "subject": "Elsparkcykel",
+               "status": "active",
+               "url": "https://www.blocket.se/annons/1214281684",
+               "price": "2 400 kr"
+            },
+         },
+      },
+      ...
+   ],
+}
+```
+
+
+
+### get_messages_from_thread
+Returns all of your messages from an existing thread/conversation.
+
+- `channel_id` (`str`, required) - The channel id to fetch messages from.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.get_messages_from_thread("sendbird_group_channel_123")
+{
+   "messages": [
+      {
+         "type": "MESG",
+         "message_id": 1354913370,
+         "message": "Hey, is your thing still for sale?",
+         ...
+      },
+   ],
+}
+```
+
+### unread_messages_count
+Returns the count of unread messages.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.unread_messages_count()
+{
+   "unread_count": 5
+}
+```
+
+
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

blocket_api-0.3.5/PKG-INFO → blocket_api-0.3.7/README.md

@@ -1,23 +1,3 @@
-Metadata-Version: 2.4
-Name: blocket_api
-Version: 0.3.5
-Summary: A python API wrapper for blocket.se
-Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: httpx>=0.28.1
-Requires-Dist: pre-commit>=3.7.1
-Requires-Dist: pytest>=8.2.2
-Requires-Dist: respx>=0.21.1
-Requires-Dist: mypy>=1.15.0
-Requires-Dist: pydantic>=2.11.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: ruff>=0.14.4
-Dynamic: license-file
-
 <p align="center">
   <img src="https://blocket-api.se/blocket-api.png" />
 </p>
@@ -80,6 +60,9 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`api.get_user_by_id()`](#get_user_by_id)  | 👏 No | Yes | Get user data from id.
 | [`api.save_ad()`](#save_ad)  | 🔐 Yes | - | Save ad to "Saved ads".
 | [`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
@@ -368,6 +351,70 @@ Returns all of your saved ads from `https://www.blocket.se/sparade/annonser`.
 
 ```
 
+### get_threads
+Returns all of your threads/conversations from Blocket. This api requires a token.
+
+- `limit` (`int`, optional) - Number of threads to return, default is 15.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.get_threads()
+{
+   "channels": [
+      {     
+         "channel_url": "sendbird_group_channel_123",
+         "name": "from:user-id,ad:1214281684,to:c1-user-id",
+         "data": {
+            "ad": {
+               "id": "1214281684",
+               "advertiser_name": "Kalle",
+               "subject": "Elsparkcykel",
+               "status": "active",
+               "url": "https://www.blocket.se/annons/1214281684",
+               "price": "2 400 kr"
+            },
+         },
+      },
+      ...
+   ],
+}
+```
+
+
+
+### get_messages_from_thread
+Returns all of your messages from an existing thread/conversation.
+
+- `channel_id` (`str`, required) - The channel id to fetch messages from.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.get_messages_from_thread("sendbird_group_channel_123")
+{
+   "messages": [
+      {
+         "type": "MESG",
+         "message_id": 1354913370,
+         "message": "Hey, is your thing still for sale?",
+         ...
+      },
+   ],
+}
+```
+
+### unread_messages_count
+Returns the count of unread messages.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.unread_messages_count()
+{
+   "unread_count": 5
+}
+```
+
+
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

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

@@ -17,11 +17,13 @@ from blocket_api.models import (
     SavedSearchResponse,
     StoreListings,
     StoreSearchResults,
+    UnreadMessagesCount,
 )
 from blocket_api.qasa import HOME_SEARCH_ORDERING, HomeType, OrderBy, Qasa
 
 from .constants import BASE_URL, BYTBIL_URL
 from .decorators import auth_token, public_token
+from .sendbird import Sendbird
 
 if TYPE_CHECKING:
     from httpx import Response
@@ -588,3 +590,42 @@ class BlocketAPI:
         url = f"{BASE_URL}/search_bff/v1/saved_content?lim={limit}"
         response = _make_request(url=f"{url}", token=self.token).json()
         return response
+
+    @auth_token
+    def get_threads(self, limit: int = 15) -> dict:
+        """
+        Returns set number of conversations/threads from Blocket, ordered by latest message.
+        """
+        assert self.token
+        sendbird = Sendbird.generate(self.token)
+        return sendbird.get_threads(limit=limit)
+
+    @auth_token
+    def get_messages_from_thread(self, channel_id: str) -> dict:
+        """
+        Returns all messages from a specific channel/thread.
+        Requires a channel_id which can be found by using get_threads().
+        Ex: sendbird_group_channel_12345_abc123abcde
+        """
+        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.5 → blocket_api-0.3.7}/blocket_api/constants.py

@@ -2,3 +2,6 @@ BASE_URL = "https://api.blocket.se"
 SITE_URL = "https://www.blocket.se"
 BYTBIL_URL = "https://api.bytbil.com"
 QASA_URL = "https://api.qasa.se/graphql"
+
+BLOCKET_SENDBIRD_APP_ID = "162ABE1D-86E9-4C2A-866A-EF1034525DAF"
+SENDBIRD_URL = f"https://api-{BLOCKET_SENDBIRD_APP_ID}.sendbird.com"

{blocket_api-0.3.5 → 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.7/blocket_api/sendbird.py

@@ -0,0 +1,190 @@
+from __future__ import annotations
+
+import json
+import time
+import urllib.parse
+from dataclasses import dataclass
+
+import httpx
+from pydantic import BaseModel, ConfigDict
+from websockets.sync.client import connect
+
+from .constants import BASE_URL, BLOCKET_SENDBIRD_APP_ID, SENDBIRD_URL
+
+USER_AGENT = "Mozilla/5.0 (X11; Linux x86_64; rv:144.0) Gecko/20100101 Firefox/144.0"
+
+
+class SendbirdResponse(BaseModel):
+    user_id: str
+    nickname: str
+    profile_url: str
+    ekey: str
+    metadata: dict
+
+    ping_interval: int
+    pong_timeout: int
+    login_ts: int
+
+    key: str  # Session key
+    expires_at: int
+
+    unread_cnt: dict
+    premium_feature_list: list[str]
+    application_attributes: list[str]
+    services: list[str]
+
+    model_config = ConfigDict(extra="ignore")
+
+    @property
+    def session_key(self) -> str:
+        return self.key
+
+
+def get_blocket_tokens(bearer_token: str) -> dict:
+    token_response = httpx.get(
+        f"{BASE_URL}/messaging-sendbird-communication/v1/users/tokens",
+        headers={
+            "Authorization": f"Bearer {bearer_token}",
+        },
+    )
+    token_response.raise_for_status()
+    return token_response.json()
+
+
+class SendbirdClient:
+    def __init__(
+        self,
+        app_id: str,
+        user_id: str,
+        access_token: str,
+    ):
+        self.app_id = app_id
+        self.user_id = user_id
+        self.access_token = access_token
+
+    def _build_wss_url(self) -> str:
+        base_url = f"wss://ws-{self.app_id.lower()}.sendbird.com/"
+        timestamp = str(int(time.time() * 1000))
+
+        params = {
+            "p": "JS",
+            "pv": USER_AGENT,
+            "sv": "4.10.8",
+            "ai": self.app_id,
+            "pmce": "1",
+            "active": "1",
+            "device_token_types": "gcm,huawei,apns",
+            "SB-User-Agent": "JS/c4.10.8///oweb",
+            "SB-SDK-User-Agent": "main_sdk_info=chat/js/4.10.8&device_os_platform=web&os_version=Mozilla/5.0 (X11; Linux x86_64; rv:144.0) Gecko/20100101 Firefox/144.0",
+            "Request-Sent-Timestamp": timestamp,
+            "include_extra_data": "premium_feature_list,file_upload_size_limit,application_attributes,emoji_hash,multiple_file_send_max_size,notifications",
+            "use_local_cache": "0",
+            "include_poll_details": "1",
+            "user_id": self.user_id,
+        }
+
+        return base_url + "?" + urllib.parse.urlencode(params)
+
+    def get_data(self) -> str:
+        with connect(
+            self._build_wss_url(),
+            subprotocols=[urllib.parse.quote(json.dumps({"token": self.access_token}))],  # type: ignore[list-item]
+            additional_headers={
+                "User-Agent": USER_AGENT,
+                "Origin": "https://www.blocket.se",
+            },
+            open_timeout=5,
+        ) as websocket:
+            message: str = websocket.recv(timeout=5)  # type: ignore[assignment]
+            return str(message.split("LOGI")[1])
+
+
+@dataclass(frozen=True)
+class Sendbird:
+    sendbird_client: SendbirdClient
+
+    @classmethod
+    def generate(cls, blocket_token: str) -> Sendbird:
+        tokens = get_blocket_tokens(blocket_token)
+        sb_token = tokens["sb_session_token"]
+        sb_user_id = tokens["sb_user_id"]
+        return cls(
+            sendbird_client=SendbirdClient(
+                app_id=BLOCKET_SENDBIRD_APP_ID,
+                user_id=sb_user_id,
+                access_token=sb_token,
+            )
+        )
+
+    def get_threads(self, limit: int) -> dict:
+        sendbird = SendbirdResponse.model_validate_json(self.sendbird_client.get_data())
+        response = httpx.get(
+            f"{SENDBIRD_URL}/v3/users/{self.sendbird_client.user_id}/my_group_channels",
+            params={
+                "token": "",
+                "limit": limit,
+                "order": "latest_last_message",
+                "show_member": True,
+                "show_read_receipt": True,
+                "show_delivery_receipt": True,
+                "show_empty": False,
+                "member_state_filter": "all",
+                "super_mode": "all",
+                "public_mode": "all",
+                "unread_filter": "all",
+                "name_contains": "",
+                "custom_type_startswith": "",
+                "hidden_mode": "unhidden_only",
+                "show_frozen": True,
+                "show_metadata": True,
+                "include_chat_notification": False,
+                "include_left_channel": False,
+            },
+            headers={
+                "Session-Key": sendbird.session_key,
+                "Access-Token": self.sendbird_client.access_token,
+            },
+        )
+        response.raise_for_status()
+        return response.json()
+
+    def get_messages_from_thread(self, channel_id: str) -> dict:
+        sendbird = SendbirdResponse.model_validate_json(self.sendbird_client.get_data())
+        response = httpx.get(
+            f"{SENDBIRD_URL}/v3/group_channels/{channel_id}/messages",
+            params={
+                "is_sdk": True,
+                "prev_limit": 30,
+                "next_limit": 0,
+                "include": False,
+                "reverse": False,
+                "message_ts": 9007199254740991,
+                "message_type": "",
+                "include_reply_type": "none",
+                "with_sorted_meta_array": False,
+                "include_reactions": False,
+                "include_thread_info": False,
+                "include_parent_message_info": False,
+                "show_subchannel_message_only": False,
+                "include_poll_details": True,
+            },
+            headers={
+                "Session-Key": sendbird.session_key,
+                "Access-Token": self.sendbird_client.access_token,
+            },
+        )
+        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.5/README.md → blocket_api-0.3.7/blocket_api.egg-info/PKG-INFO

@@ -1,3 +1,24 @@
+Metadata-Version: 2.4
+Name: blocket_api
+Version: 0.3.7
+Summary: A python API wrapper for blocket.se
+Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pre-commit>=3.7.1
+Requires-Dist: pytest>=8.2.2
+Requires-Dist: respx>=0.21.1
+Requires-Dist: mypy>=1.15.0
+Requires-Dist: pydantic>=2.11.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.5
+Dynamic: license-file
+
 <p align="center">
   <img src="https://blocket-api.se/blocket-api.png" />
 </p>
@@ -60,6 +81,9 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`api.get_user_by_id()`](#get_user_by_id)  | 👏 No | Yes | Get user data from id.
 | [`api.save_ad()`](#save_ad)  | 🔐 Yes | - | Save ad to "Saved ads".
 | [`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
@@ -348,6 +372,70 @@ Returns all of your saved ads from `https://www.blocket.se/sparade/annonser`.
 
 ```
 
+### get_threads
+Returns all of your threads/conversations from Blocket. This api requires a token.
+
+- `limit` (`int`, optional) - Number of threads to return, default is 15.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.get_threads()
+{
+   "channels": [
+      {     
+         "channel_url": "sendbird_group_channel_123",
+         "name": "from:user-id,ad:1214281684,to:c1-user-id",
+         "data": {
+            "ad": {
+               "id": "1214281684",
+               "advertiser_name": "Kalle",
+               "subject": "Elsparkcykel",
+               "status": "active",
+               "url": "https://www.blocket.se/annons/1214281684",
+               "price": "2 400 kr"
+            },
+         },
+      },
+      ...
+   ],
+}
+```
+
+
+
+### get_messages_from_thread
+Returns all of your messages from an existing thread/conversation.
+
+- `channel_id` (`str`, required) - The channel id to fetch messages from.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.get_messages_from_thread("sendbird_group_channel_123")
+{
+   "messages": [
+      {
+         "type": "MESG",
+         "message_id": 1354913370,
+         "message": "Hey, is your thing still for sale?",
+         ...
+      },
+   ],
+}
+```
+
+### unread_messages_count
+Returns the count of unread messages.
+
+```py
+>>> api = BlocketAPI("YourBlocketTokenHere")
+>>> api.unread_messages_count()
+{
+   "unread_count": 5
+}
+```
+
+
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

{blocket_api-0.3.5 → blocket_api-0.3.7}/blocket_api.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ blocket_api/constants.py
 blocket_api/decorators.py
 blocket_api/models.py
 blocket_api/qasa.py
+blocket_api/sendbird.py
 blocket_api.egg-info/PKG-INFO
 blocket_api.egg-info/SOURCES.txt
 blocket_api.egg-info/dependency_links.txt

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

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

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

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