Merge pull request #145 from GetStream/chore/agent-header

tbarbugli · web-flow · commit 913a75f9daa0 · 2025-09-29T22:37:06.000+02:00
[AI-148] Expose the user agent
diff --git a/getstream/base.py b/getstream/base.py
@@ -118,12 +118,14 @@ def __init__(
         base_url=None,
         token=None,
         timeout=None,
+        user_agent=None,
     ):
         super().__init__(
             api_key=api_key,
             base_url=base_url,
             token=token,
             timeout=timeout,
+            user_agent=user_agent,
         )
         self.client = httpx.Client(
             base_url=self.base_url,
@@ -280,12 +282,14 @@ def __init__(
         base_url=None,
         token=None,
         timeout=None,
+        user_agent=None,
     ):
         super().__init__(
             api_key=api_key,
             base_url=base_url,
             token=token,
             timeout=timeout,
+            user_agent=user_agent,
         )
         self.client = httpx.AsyncClient(
             base_url=self.base_url,
diff --git a/getstream/chat/async_client.py b/getstream/chat/async_client.py
@@ -3,9 +3,13 @@
 
 
 class ChatClient(ChatRestClient):
-    def __init__(self, api_key: str, base_url, token, timeout, stream):
+    def __init__(self, api_key: str, base_url, token, timeout, stream, user_agent=None):
         super().__init__(
-            api_key=api_key, base_url=base_url, token=token, timeout=timeout
+            api_key=api_key,
+            base_url=base_url,
+            token=token,
+            timeout=timeout,
+            user_agent=user_agent,
         )
         self.stream = stream
 
diff --git a/getstream/chat/async_rest_client.py b/getstream/chat/async_rest_client.py
@@ -7,19 +7,28 @@
 
 
 class ChatRestClient(AsyncBaseClient):
-    def __init__(self, api_key: str, base_url: str, timeout: float, token: str):
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        timeout: float,
+        token: str,
+        user_agent: str = None,
+    ):
         """
         Initializes ChatClient with BaseClient instance
         :param api_key: A string representing the client's API key
         :param base_url: A string representing the base uniform resource locator
         :param timeout: A number representing the time limit for a request
         :param token: A string instance representing the client's token
+        :param user_agent: Optional custom user agent string
         """
         super().__init__(
             api_key=api_key,
             base_url=base_url,
             timeout=timeout,
             token=token,
+            user_agent=user_agent,
         )
 
     @telemetry.operation_name("getstream.api.chat.query_campaigns")
diff --git a/getstream/chat/client.py b/getstream/chat/client.py
@@ -3,9 +3,13 @@
 
 
 class ChatClient(ChatRestClient):
-    def __init__(self, api_key: str, base_url, token, timeout, stream):
+    def __init__(self, api_key: str, base_url, token, timeout, stream, user_agent=None):
         super().__init__(
-            api_key=api_key, base_url=base_url, token=token, timeout=timeout
+            api_key=api_key,
+            base_url=base_url,
+            token=token,
+            timeout=timeout,
+            user_agent=user_agent,
         )
         self.stream = stream
 
diff --git a/getstream/chat/rest_client.py b/getstream/chat/rest_client.py
@@ -7,19 +7,28 @@
 
 
 class ChatRestClient(BaseClient):
-    def __init__(self, api_key: str, base_url: str, timeout: float, token: str):
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        timeout: float,
+        token: str,
+        user_agent: str = None,
+    ):
         """
         Initializes ChatClient with BaseClient instance
         :param api_key: A string representing the client's API key
         :param base_url: A string representing the base uniform resource locator
         :param timeout: A number representing the time limit for a request
         :param token: A string instance representing the client's token
+        :param user_agent: Optional custom user agent string
         """
         super().__init__(
             api_key=api_key,
             base_url=base_url,
             timeout=timeout,
             token=token,
+            user_agent=user_agent,
         )
 
     @telemetry.operation_name("getstream.api.chat.query_campaigns")
diff --git a/getstream/common/async_client.py b/getstream/common/async_client.py
@@ -2,7 +2,11 @@
 
 
 class CommonClient(CommonRestClient):
-    def __init__(self, api_key: str, base_url, token, timeout):
+    def __init__(self, api_key: str, base_url, token, timeout, user_agent=None):
         super().__init__(
-            api_key=api_key, base_url=base_url, token=token, timeout=timeout
+            api_key=api_key,
+            base_url=base_url,
+            token=token,
+            timeout=timeout,
+            user_agent=user_agent,
         )
diff --git a/getstream/common/async_rest_client.py b/getstream/common/async_rest_client.py
@@ -7,19 +7,28 @@
 
 
 class CommonRestClient(AsyncBaseClient):
-    def __init__(self, api_key: str, base_url: str, timeout: float, token: str):
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        timeout: float,
+        token: str,
+        user_agent: str = None,
+    ):
         """
         Initializes CommonClient with BaseClient instance
         :param api_key: A string representing the client's API key
         :param base_url: A string representing the base uniform resource locator
         :param timeout: A number representing the time limit for a request
         :param token: A string instance representing the client's token
+        :param user_agent: Optional custom user agent string
         """
         super().__init__(
             api_key=api_key,
             base_url=base_url,
             timeout=timeout,
             token=token,
+            user_agent=user_agent,
         )
 
     @telemetry.operation_name("getstream.api.common.get_app")
diff --git a/getstream/common/client.py b/getstream/common/client.py
@@ -2,7 +2,11 @@
 
 
 class CommonClient(CommonRestClient):
-    def __init__(self, api_key: str, base_url, token, timeout):
+    def __init__(self, api_key: str, base_url, token, timeout, user_agent=None):
         super().__init__(
-            api_key=api_key, base_url=base_url, token=token, timeout=timeout
+            api_key=api_key,
+            base_url=base_url,
+            token=token,
+            timeout=timeout,
+            user_agent=user_agent,
         )
diff --git a/getstream/common/rest_client.py b/getstream/common/rest_client.py
@@ -7,19 +7,28 @@
 
 
 class CommonRestClient(BaseClient):
-    def __init__(self, api_key: str, base_url: str, timeout: float, token: str):
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        timeout: float,
+        token: str,
+        user_agent: str = None,
+    ):
         """
         Initializes CommonClient with BaseClient instance
         :param api_key: A string representing the client's API key
         :param base_url: A string representing the base uniform resource locator
         :param timeout: A number representing the time limit for a request
         :param token: A string instance representing the client's token
+        :param user_agent: Optional custom user agent string
         """
         super().__init__(
             api_key=api_key,
             base_url=base_url,
             timeout=timeout,
             token=token,
+            user_agent=user_agent,
         )
 
     @telemetry.operation_name("getstream.api.common.get_app")
diff --git a/getstream/feeds/client.py b/getstream/feeds/client.py
@@ -4,9 +4,13 @@
 
 
 class FeedsClient(FeedsRestClient):
-    def __init__(self, api_key: str, base_url, token, timeout, stream):
+    def __init__(self, api_key: str, base_url, token, timeout, stream, user_agent=None):
         super().__init__(
-            api_key=api_key, base_url=base_url, token=token, timeout=timeout
+            api_key=api_key,
+            base_url=base_url,
+            token=token,
+            timeout=timeout,
+            user_agent=user_agent,
         )
         self.stream = stream
 
diff --git a/getstream/feeds/rest_client.py b/getstream/feeds/rest_client.py
@@ -6,19 +6,28 @@
 
 
 class FeedsRestClient(BaseClient):
-    def __init__(self, api_key: str, base_url: str, timeout: float, token: str):
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        timeout: float,
+        token: str,
+        user_agent: str = None,
+    ):
         """
         Initializes FeedsClient with BaseClient instance
         :param api_key: A string representing the client's API key
         :param base_url: A string representing the base uniform resource locator
         :param timeout: A number representing the time limit for a request
         :param token: A string instance representing the client's token
+        :param user_agent: Optional custom user agent string
         """
         super().__init__(
             api_key=api_key,
             base_url=base_url,
             timeout=timeout,
             token=token,
+            user_agent=user_agent,
         )
 
     def add_activity(
diff --git a/getstream/moderation/async_client.py b/getstream/moderation/async_client.py
@@ -2,8 +2,12 @@
 
 
 class ModerationClient(ModerationRestClient):
-    def __init__(self, api_key: str, base_url, token, timeout, stream):
+    def __init__(self, api_key: str, base_url, token, timeout, stream, user_agent=None):
         super().__init__(
-            api_key=api_key, base_url=base_url, token=token, timeout=timeout
+            api_key=api_key,
+            base_url=base_url,
+            token=token,
+            timeout=timeout,
+            user_agent=user_agent,
         )
         self.stream = stream
diff --git a/getstream/moderation/async_rest_client.py b/getstream/moderation/async_rest_client.py
@@ -7,19 +7,28 @@
 
 
 class ModerationRestClient(AsyncBaseClient):
-    def __init__(self, api_key: str, base_url: str, timeout: float, token: str):
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        timeout: float,
+        token: str,
+        user_agent: str = None,
+    ):
         """
         Initializes ModerationClient with BaseClient instance
         :param api_key: A string representing the client's API key
         :param base_url: A string representing the base uniform resource locator
         :param timeout: A number representing the time limit for a request
         :param token: A string instance representing the client's token
+        :param user_agent: Optional custom user agent string
         """
         super().__init__(
             api_key=api_key,
             base_url=base_url,
             timeout=timeout,
             token=token,
+            user_agent=user_agent,
         )
 
     @telemetry.operation_name("getstream.api.moderation.ban")
diff --git a/getstream/moderation/client.py b/getstream/moderation/client.py
@@ -2,8 +2,12 @@
 
 
 class ModerationClient(ModerationRestClient):
-    def __init__(self, api_key: str, base_url, token, timeout, stream):
+    def __init__(self, api_key: str, base_url, token, timeout, stream, user_agent=None):
         super().__init__(
-            api_key=api_key, base_url=base_url, token=token, timeout=timeout
+            api_key=api_key,
+            base_url=base_url,
+            token=token,
+            timeout=timeout,
+            user_agent=user_agent,
         )
         self.stream = stream
diff --git a/getstream/moderation/rest_client.py b/getstream/moderation/rest_client.py
@@ -7,19 +7,28 @@
 
 
 class ModerationRestClient(BaseClient):
-    def __init__(self, api_key: str, base_url: str, timeout: float, token: str):
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        timeout: float,
+        token: str,
+        user_agent: str = None,
+    ):
         """
         Initializes ModerationClient with BaseClient instance
         :param api_key: A string representing the client's API key
         :param base_url: A string representing the base uniform resource locator
         :param timeout: A number representing the time limit for a request
         :param token: A string instance representing the client's token
+        :param user_agent: Optional custom user agent string
         """
         super().__init__(
             api_key=api_key,
             base_url=base_url,
             timeout=timeout,
             token=token,
+            user_agent=user_agent,
         )
 
     @telemetry.operation_name("getstream.api.moderation.ban")
diff --git a/getstream/stream.py b/getstream/stream.py
diff --git a/getstream/video/async_client.py b/getstream/video/async_client.py
diff --git a/getstream/video/async_rest_client.py b/getstream/video/async_rest_client.py
diff --git a/getstream/video/client.py b/getstream/video/client.py
diff --git a/getstream/video/rest_client.py b/getstream/video/rest_client.py
diff --git a/tests/test_user_agent.py b/tests/test_user_agent.py
