cheshirecat-python-sdk 1.7.3__py3-none-any.whl → 1.7.4__py3-none-any.whl

cheshirecat_python_sdk/client.py

@@ -2,6 +2,7 @@ from cheshirecat_python_sdk.clients import HttpClient, WSClient
 from cheshirecat_python_sdk.configuration import Configuration
 from cheshirecat_python_sdk.endpoints import (
     AdminsEndpoint,
+    AuthEndpoint,
     AuthHandlerEndpoint,
     ChunkerEndpoint,
     ConversationEndpoint,
@@ -55,6 +56,10 @@ class CheshireCatClient:
     def admins(self):
         return AdminsEndpoint(self)
 
+    @property
+    def auth(self):
+        return AuthEndpoint(self)
+
     @property
     def auth_handler(self):
         return AuthHandlerEndpoint(self)

cheshirecat_python_sdk/clients/http_client.py

@@ -40,19 +40,19 @@ class HttpClient:
         if self.apikey:
             self.headers["Authorization"] = f"Bearer {self.apikey}"
         if self.agent_id:
-            self.headers["agent_id"] = self.agent_id
+            self.headers["X-Agent-ID"] = self.agent_id
         if self.user_id:
-            self.headers["user_id"] = self.user_id
+            self.headers["X-User-ID"] = self.user_id
         if self.chat_id:
-            self.headers["chat_id"] = self.chat_id
+            self.headers["X-Chat-ID"] = self.chat_id
 
     def __before_jwt_request(self):
         if self.token:
             self.headers["Authorization"] = f"Bearer {self.token}"
         if self.agent_id:
-            self.headers["agent_id"] = self.agent_id
+            self.headers["X-Agent-ID"] = self.agent_id
         if self.chat_id:
-            self.headers["chat_id"] = self.chat_id
+            self.headers["X-Chat-ID"] = self.chat_id
 
     def get_client(
         self,

cheshirecat_python_sdk/endpoints/__init__.py

@@ -1,4 +1,5 @@
 from cheshirecat_python_sdk.endpoints.admins import AdminsEndpoint
+from cheshirecat_python_sdk.endpoints.auth import AuthEndpoint
 from cheshirecat_python_sdk.endpoints.auth_handler import AuthHandlerEndpoint
 from cheshirecat_python_sdk.endpoints.chunker import ChunkerEndpoint
 from cheshirecat_python_sdk.endpoints.conversation import ConversationEndpoint

cheshirecat_python_sdk/endpoints/admins.py

@@ -1,4 +1,4 @@
-from typing import List, Any
+from typing import List
 
 from cheshirecat_python_sdk.endpoints.base import AbstractEndpoint, MultipartPayload
 from cheshirecat_python_sdk.models.api.admins import (
@@ -10,7 +10,6 @@ from cheshirecat_python_sdk.models.api.admins import (
 )
 from cheshirecat_python_sdk.models.api.nested.plugins import PluginSettingsOutput
 from cheshirecat_python_sdk.models.api.plugins import PluginCollectionOutput, PluginsSettingsOutput, PluginToggleOutput
-from cheshirecat_python_sdk.models.api.tokens import TokenOutput
 from cheshirecat_python_sdk.utils import deserialize, file_attributes
 
 
@@ -19,35 +18,6 @@ class AdminsEndpoint(AbstractEndpoint):
         super().__init__(client)
         self.prefix = "/admins"
 
-    def token(self, username: str, password: str) -> TokenOutput:
-        """
-        This endpoint is used to get a token for the user. The token is used to authenticate the user in the system.
-        When the token expires, the user must request a new token.
-        :param username: The username of the user.
-        :param password: The password of the user.
-        :return: TokenOutput, the token of the user.
-        """
-        response = self.get_http_session().post(
-            self.format_url("/auth/token"),
-            json={"username": username, "password": password},
-        )
-        response.raise_for_status()
-
-        result = deserialize(response.json(), TokenOutput)
-        self.client.add_token(result.access_token)
-        return result
-
-    def get_available_permissions(self) -> dict[int | str, Any]:
-        """
-        This endpoint is used to get a list of available permissions in the system. The permissions are used to define
-        the access rights of the users in the system. The permissions are defined by the system administrator.
-        :return array<int|string, Any>, the available permissions
-        """
-        response = self.get_http_client().get(self.format_url("/auth/available-permissions"))
-        response.raise_for_status()
-
-        return response.json()
-
     def post_admin(self, username: str, password: str, permissions: dict | None = None) -> AdminOutput:
         """
         Create a new admin user.

cheshirecat_python_sdk/endpoints/auth.py

@@ -0,0 +1,42 @@
+from typing import Any
+
+from cheshirecat_python_sdk.endpoints.base import AbstractEndpoint
+from cheshirecat_python_sdk.models.api.tokens import TokenOutput
+from cheshirecat_python_sdk.utils import deserialize
+
+
+class AuthEndpoint(AbstractEndpoint):
+    def __init__(self, client: "CheshireCatClient"):
+        super().__init__(client)
+        self.prefix = "/auth"
+
+    def token(self, username: str, password: str, agent_id: str | None = None) -> TokenOutput:
+        """
+        This endpoint is used to get a token for the user. The token is used to authenticate the user in the system. When
+        the token expires, the user must request a new token.
+        """
+        response = self.get_http_session().post(
+            self.format_url("/token"),
+            json={
+                "username": username,
+                "password": password,
+            },
+            headers={"X-Agent-ID": agent_id} if agent_id else None,
+        )
+        response.raise_for_status()
+
+        result = deserialize(response.json(), TokenOutput)
+        self.client.add_token(result.access_token)
+
+        return result
+
+    def get_available_permissions(self) -> dict[int | str, Any]:
+        """
+        This endpoint is used to get a list of available permissions in the system. The permissions are used to define
+        the access rights of the users in the system. The permissions are defined by the system administrator.
+        :return array<int|string, Any>, the available permissions
+        """
+        response = self.get_http_client().get(self.format_url("/available-permissions"))
+        response.raise_for_status()
+
+        return response.json()

cheshirecat_python_sdk/endpoints/users.py

@@ -1,7 +1,6 @@
 from typing import Any, List, Dict
 
 from cheshirecat_python_sdk.endpoints.base import AbstractEndpoint
-from cheshirecat_python_sdk.models.api.tokens import TokenOutput
 from cheshirecat_python_sdk.models.api.users import UserOutput
 from cheshirecat_python_sdk.utils import deserialize
 
@@ -11,33 +10,6 @@ class UsersEndpoint(AbstractEndpoint):
         super().__init__(client)
         self.prefix = "/users"
 
-    def token(self, username: str, password: str) -> TokenOutput:
-        """
-        This endpoint is used to get a token for the user. The token is used to authenticate the user in the system. When
-        the token expires, the user must request a new token.
-        """
-        response = self.get_http_session().post("/auth/token", json={
-            "username": username,
-            "password": password,
-        })
-        response.raise_for_status()
-
-        result = deserialize(response.json(), TokenOutput)
-        self.client.add_token(result.access_token)
-
-        return result
-
-    def get_available_permissions(self) -> dict[int | str, Any]:
-        """
-        This endpoint is used to get a list of available permissions in the system. The permissions are used to define
-        the access rights of the users in the system. The permissions are defined by the system administrator.
-        :return array<int|string, Any>, the available permissions
-        """
-        response = self.get_http_client().get("/auth/available-permissions")
-        response.raise_for_status()
-
-        return response.json()
-
     def post_user(
         self, agent_id: str, username: str, password: str, permissions: dict[str, Any] | None = None
     ) -> UserOutput:

{cheshirecat_python_sdk-1.7.3.dist-info → cheshirecat_python_sdk-1.7.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cheshirecat-python-sdk
-Version: 1.7.3
+Version: 1.7.4
 Summary: Python SDK for the Cloud-ready fork of the Cheshire Cat
 Project-URL: Repository, https://github.com/matteocacciola/cheshirecat-python-sdk
 Project-URL: Documentation, https://github.com/matteocacciola/cheshirecat-python-sdk#README

{cheshirecat_python_sdk-1.7.3.dist-info → cheshirecat_python_sdk-1.7.4.dist-info}/RECORD

@@ -1,5 +1,5 @@
 cheshirecat_python_sdk/__init__.py,sha256=59esRUsh_6xPlfoCz-gQYQdDgp2xbaINYWyDcTJlvys,284
-cheshirecat_python_sdk/client.py,sha256=s5mPA9U67lcTrKZ2pKnuFd9yJKj8mOSaSNL4JUuO2ZA,2752
+cheshirecat_python_sdk/client.py,sha256=J8C8j9q-Lz3cGKyYbd9w19Ayh9muMa8s3N_gYpmLI-E,2839
 cheshirecat_python_sdk/configuration.py,sha256=7uXebZGzCuJdpgOeN5l1YXkWVIrTk4apxvjPKZFcJTE,283
 cheshirecat_python_sdk/enums.py,sha256=qJyhl5D_oDMHqNcIivr9pTxNrZY6XkX7lGgGydk22TY,665
 cheshirecat_python_sdk/utils.py,sha256=2pcSCREOuIAUi5El5ou2rCm-VtmzyGVd3YHcKrFHgBM,458
@@ -9,10 +9,11 @@ cheshirecat_python_sdk/builders/memory.py,sha256=vIoQADNZF51mMjPoJ-xW6DFWgUeAufi
 cheshirecat_python_sdk/builders/settings_input.py,sha256=EvaCDmmYOtHWUwCgG-nWonkY6UF6g1blytBwAmH477I,762
 cheshirecat_python_sdk/builders/why.py,sha256=liwellCzZ6EyzWcL3lNgBy9SU76zAqGufxiaZ_o3ZT4,1008
 cheshirecat_python_sdk/clients/__init__.py,sha256=i4Hqux9vihFRbXVK48yJ1k9gm4JeCHnfPgosizQZv-g,135
-cheshirecat_python_sdk/clients/http_client.py,sha256=mDClvl-B7KTkHK35Gd7nkOOpkAF9vKxwlqlgmE3vDg4,2309
+cheshirecat_python_sdk/clients/http_client.py,sha256=LnP0kr-kHRCwC-BZiysj1Zg-T3b3yuLd81wOctfcBTg,2319
 cheshirecat_python_sdk/clients/websocket_client.py,sha256=xNjkLSEZhpHzRqIZL21V0oG3srAGFaqYveMqlma2gvI,1932
-cheshirecat_python_sdk/endpoints/__init__.py,sha256=ViB3JVpc9-H2-TrjNCSN42TuGDf6qyzDzWh4N7vQuGc,1184
-cheshirecat_python_sdk/endpoints/admins.py,sha256=-SNwYKENanA7eM9voPG27KCElG42asEVyDQTRfVT9g8,8407
+cheshirecat_python_sdk/endpoints/__init__.py,sha256=uQPclok3DdKTibR7ywDVM67eqtxEMwx_iuza37Wqkr8,1247
+cheshirecat_python_sdk/endpoints/admins.py,sha256=rc6jEhYF8KTTWFXLinm3xPV7Rj87iKT8Kp0zHn1qUO4,7024
+cheshirecat_python_sdk/endpoints/auth.py,sha256=GcmN90uZIgeRqc_NjBhZx7bxYRSpfKL6ZOLHLom1aKQ,1658
 cheshirecat_python_sdk/endpoints/auth_handler.py,sha256=Jfi7E7L3SIzJyECbJnUenIyl6xxkJlyC31AHpAlmqSs,2117
 cheshirecat_python_sdk/endpoints/base.py,sha256=ldayH0QxQfzD5bYqlMBH1JVBOTd11RYDWxf-6kl0fng,4003
 cheshirecat_python_sdk/endpoints/chunker.py,sha256=bgp-2gQpKt7W_B46eEb-KFRkd4eZJH0euwsf3N0jfC8,1979
@@ -26,7 +27,7 @@ cheshirecat_python_sdk/endpoints/memory.py,sha256=dEnQ2Hb_VG907p7T9oQgPCWWFHAUwk
 cheshirecat_python_sdk/endpoints/message.py,sha256=QTUSUJcj52VhfnX9hdjsD2aLeFC43O4eU8ld5lRvITU,2607
 cheshirecat_python_sdk/endpoints/plugins.py,sha256=FasjwNY2UVv7zfg9lvXEj2ATefPDOPQpJXzQ2BbQIYI,3474
 cheshirecat_python_sdk/endpoints/rabbit_hole.py,sha256=DH5KGpk0Ur8RPi1fZIO9D925mc2D0GHQpsOeIKIa1G0,7213
-cheshirecat_python_sdk/endpoints/users.py,sha256=Pc_Od5pNMiyEAbxs_-en4YAZOfIPa1vZOcjScsJFh04,6559
+cheshirecat_python_sdk/endpoints/users.py,sha256=PXlPPobLoWpiuAzi0k89YUyqSp24Sc5DEcDQYGRXRBA,5369
 cheshirecat_python_sdk/endpoints/utils.py,sha256=UhhWCC4h9c7lbPxAaV3nHjLYwod4z0tHzrE-2tuKs8M,2328
 cheshirecat_python_sdk/endpoints/vector_database.py,sha256=Xu6zcopjZgcFVVmyN547piiqFcaTUtF35X0QxQHycXQ,2149
 cheshirecat_python_sdk/models/dtos.py,sha256=yK6CfCGdwLvZtYFPoImDEgpV5eyHB2iwji2t6dh6gxc,668
@@ -42,7 +43,7 @@ cheshirecat_python_sdk/models/api/tokens.py,sha256=5vzQqmcYWg593U1cTnnmLPZMNkgNN
 cheshirecat_python_sdk/models/api/users.py,sha256=2l86y6ol0R0823gGl4bmc1TzGP4ZyvTm9AR8riKiatA,160
 cheshirecat_python_sdk/models/api/nested/memories.py,sha256=ddGDsmZa2refElM0sGz9QfKHGk50wsTpkwN5qDC5bF4,946
 cheshirecat_python_sdk/models/api/nested/plugins.py,sha256=7vrwgXh0csaUn11YKY_OWnGEnD8Fu_ewKxt024VOBEs,738
-cheshirecat_python_sdk-1.7.3.dist-info/METADATA,sha256=dTIDOlGA3_ZxozOkspAz0wqxRNIvJFlBbtqyb_kP4gc,44136
-cheshirecat_python_sdk-1.7.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-cheshirecat_python_sdk-1.7.3.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-cheshirecat_python_sdk-1.7.3.dist-info/RECORD,,
+cheshirecat_python_sdk-1.7.4.dist-info/METADATA,sha256=R1wHR1rsC5gYTtJFJ-zM02uo_qY2S2yJa-i8Bh5i4eM,44136
+cheshirecat_python_sdk-1.7.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+cheshirecat_python_sdk-1.7.4.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+cheshirecat_python_sdk-1.7.4.dist-info/RECORD,,