fix(python): expose user_agent on the config (generated)

algolia/api-clients-automation#4141

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>

Author: algolia-bot

algoliasearch/abtesting/client.py

@@ -132,6 +132,10 @@ async def set_client_api_key(self, api_key: str) -> None:
         """Sets a new API key to authenticate requests."""
         self._transporter.config.set_client_api_key(api_key)
 
+    async def add_user_agent(self, segment: str, version: Optional[str] = None) -> None:
+        """adds a segment to the default user agent, and update the headers sent with each requests as well"""
+        self._transporter.config.add_user_agent(segment, version)
+
     async def add_ab_tests_with_http_info(
         self,
         add_ab_tests_request: Union[AddABTestsRequest, dict[str, Any]],
@@ -977,6 +981,10 @@ def set_client_api_key(self, api_key: str) -> None:
         """Sets a new API key to authenticate requests."""
         self._transporter.config.set_client_api_key(api_key)
 
+    def add_user_agent(self, segment: str, version: Optional[str] = None) -> None:
+        """adds a segment to the default user agent, and update the headers sent with each requests as well"""
+        self._transporter.config.add_user_agent(segment, version)
+
     def add_ab_tests_with_http_info(
         self,
         add_ab_tests_request: Union[AddABTestsRequest, dict[str, Any]],

algoliasearch/abtesting/config.py

@@ -1,6 +1,7 @@
 from os import environ
 from typing import Optional
 
+from algoliasearch import __version__
 from algoliasearch.http.base_config import BaseConfig
 from algoliasearch.http.hosts import Host, HostsCollection
 from algoliasearch.http.user_agent import UserAgent
@@ -15,7 +16,8 @@ def __init__(
     ) -> None:
         super().__init__(app_id, api_key)
 
-        user_agent = UserAgent().add("Abtesting")
+        self._user_agent = UserAgent()
+        self.add_user_agent("Abtesting", __version__)
 
         if app_id is None or not app_id:
             raise ValueError("`app_id` is missing.")
@@ -26,7 +28,7 @@ def __init__(
         self.headers = {
             "x-algolia-application-id": app_id,
             "x-algolia-api-key": api_key,
-            "user-agent": user_agent.get(),
+            "user-agent": self._user_agent.get(),
             "content-type": "application/json",
         }
 

algoliasearch/analytics/client.py

@@ -172,6 +172,10 @@ async def set_client_api_key(self, api_key: str) -> None:
         """Sets a new API key to authenticate requests."""
         self._transporter.config.set_client_api_key(api_key)
 
+    async def add_user_agent(self, segment: str, version: Optional[str] = None) -> None:
+        """adds a segment to the default user agent, and update the headers sent with each requests as well"""
+        self._transporter.config.add_user_agent(segment, version)
+
     async def custom_delete_with_http_info(
         self,
         path: Annotated[
@@ -3207,6 +3211,10 @@ def set_client_api_key(self, api_key: str) -> None:
         """Sets a new API key to authenticate requests."""
         self._transporter.config.set_client_api_key(api_key)
 
+    def add_user_agent(self, segment: str, version: Optional[str] = None) -> None:
+        """adds a segment to the default user agent, and update the headers sent with each requests as well"""
+        self._transporter.config.add_user_agent(segment, version)
+
     def custom_delete_with_http_info(
         self,
         path: Annotated[

algoliasearch/analytics/config.py

@@ -1,6 +1,7 @@
 from os import environ
 from typing import Optional
 
+from algoliasearch import __version__
 from algoliasearch.http.base_config import BaseConfig
 from algoliasearch.http.hosts import Host, HostsCollection
 from algoliasearch.http.user_agent import UserAgent
@@ -15,7 +16,8 @@ def __init__(
     ) -> None:
         super().__init__(app_id, api_key)
 
-        user_agent = UserAgent().add("Analytics")
+        self._user_agent = UserAgent()
+        self.add_user_agent("Analytics", __version__)
 
         if app_id is None or not app_id:
             raise ValueError("`app_id` is missing.")
@@ -26,7 +28,7 @@ def __init__(
         self.headers = {
             "x-algolia-application-id": app_id,
             "x-algolia-api-key": api_key,
-            "user-agent": user_agent.get(),
+            "user-agent": self._user_agent.get(),
             "content-type": "application/json",
         }
 

algoliasearch/http/base_config.py

@@ -2,6 +2,7 @@
 from typing import Dict, Optional
 
 from algoliasearch.http.hosts import HostsCollection
+from algoliasearch.http.user_agent import UserAgent
 
 
 class BaseConfig:
@@ -27,9 +28,18 @@ def __init__(self, app_id: Optional[str] = None, api_key: Optional[str] = None):
         self.proxies: Optional[Dict[str, str]] = None
         self.hosts: Optional[HostsCollection] = None
 
+        self._user_agent: UserAgent = UserAgent()
+
     def set_client_api_key(self, api_key: str) -> None:
         """Sets a new API key to authenticate requests."""
         self.api_key = api_key
         if self.headers is None:
             self.headers = {}
         self.headers["x-algolia-api-key"] = api_key
+
+    def add_user_agent(self, segment: str, version: Optional[str] = None) -> None:
+        """adds a segment to the default user agent, and update the headers sent with each requests as well"""
+        self._user_agent = self._user_agent.add(segment, version)
+
+        if self.headers is not None:
+            self.headers["user-agent"] = self._user_agent.get()

algoliasearch/http/user_agent.py

@@ -19,6 +19,10 @@ def __init__(self) -> None:
     def get(self) -> str:
         return self.value
 
-    def add(self, segment: str, version: Optional[str] = __version__) -> Self:
-        self.value += "; {} ({})".format(segment, version)
+    def add(self, segment: str, version: Optional[str] = None) -> Self:
+        self.value += "; {}".format(segment)
+
+        if version is not None:
+            self.value += " ({})".format(version)
+
         return self

algoliasearch/ingestion/client.py

@@ -209,6 +209,10 @@ async def set_client_api_key(self, api_key: str) -> None:
         """Sets a new API key to authenticate requests."""
         self._transporter.config.set_client_api_key(api_key)
 
+    async def add_user_agent(self, segment: str, version: Optional[str] = None) -> None:
+        """adds a segment to the default user agent, and update the headers sent with each requests as well"""
+        self._transporter.config.add_user_agent(segment, version)
+
     async def create_authentication_with_http_info(
         self,
         authentication_create: Union[AuthenticationCreate, dict[str, Any]],
@@ -4933,6 +4937,10 @@ def set_client_api_key(self, api_key: str) -> None:
         """Sets a new API key to authenticate requests."""
         self._transporter.config.set_client_api_key(api_key)
 
+    def add_user_agent(self, segment: str, version: Optional[str] = None) -> None:
+        """adds a segment to the default user agent, and update the headers sent with each requests as well"""
+        self._transporter.config.add_user_agent(segment, version)
+
     def create_authentication_with_http_info(
         self,
         authentication_create: Union[AuthenticationCreate, dict[str, Any]],

algoliasearch/ingestion/config.py

@@ -1,6 +1,7 @@
 from os import environ
 from typing import Optional
 
+from algoliasearch import __version__
 from algoliasearch.http.base_config import BaseConfig
 from algoliasearch.http.hosts import Host, HostsCollection
 from algoliasearch.http.user_agent import UserAgent
@@ -12,7 +13,8 @@ def __init__(
     ) -> None:
         super().__init__(app_id, api_key)
 
-        user_agent = UserAgent().add("Ingestion")
+        self._user_agent = UserAgent()
+        self.add_user_agent("Ingestion", __version__)
 
         if app_id is None or not app_id:
             raise ValueError("`app_id` is missing.")
@@ -23,7 +25,7 @@ def __init__(
         self.headers = {
             "x-algolia-application-id": app_id,
             "x-algolia-api-key": api_key,
-            "user-agent": user_agent.get(),
+            "user-agent": self._user_agent.get(),
             "content-type": "application/json",
         }
 

algoliasearch/insights/client.py

@@ -118,6 +118,10 @@ async def set_client_api_key(self, api_key: str) -> None:
         """Sets a new API key to authenticate requests."""
         self._transporter.config.set_client_api_key(api_key)
 
+    async def add_user_agent(self, segment: str, version: Optional[str] = None) -> None:
+        """adds a segment to the default user agent, and update the headers sent with each requests as well"""
+        self._transporter.config.add_user_agent(segment, version)
+
     async def custom_delete_with_http_info(
         self,
         path: Annotated[
@@ -653,6 +657,10 @@ def set_client_api_key(self, api_key: str) -> None:
         """Sets a new API key to authenticate requests."""
         self._transporter.config.set_client_api_key(api_key)
 
+    def add_user_agent(self, segment: str, version: Optional[str] = None) -> None:
+        """adds a segment to the default user agent, and update the headers sent with each requests as well"""
+        self._transporter.config.add_user_agent(segment, version)
+
     def custom_delete_with_http_info(
         self,
         path: Annotated[

algoliasearch/insights/config.py

@@ -1,6 +1,7 @@
 from os import environ
 from typing import Optional
 
+from algoliasearch import __version__
 from algoliasearch.http.base_config import BaseConfig
 from algoliasearch.http.hosts import Host, HostsCollection
 from algoliasearch.http.user_agent import UserAgent
@@ -15,7 +16,8 @@ def __init__(
     ) -> None:
         super().__init__(app_id, api_key)
 
-        user_agent = UserAgent().add("Insights")
+        self._user_agent = UserAgent()
+        self.add_user_agent("Insights", __version__)
 
         if app_id is None or not app_id:
             raise ValueError("`app_id` is missing.")
@@ -26,7 +28,7 @@ def __init__(
         self.headers = {
             "x-algolia-application-id": app_id,
             "x-algolia-api-key": api_key,
-            "user-agent": user_agent.get(),
+            "user-agent": self._user_agent.get(),
             "content-type": "application/json",
         }