cheshirecat-python-sdk 1.7.2__tar.gz → 1.7.4__tar.gz

{cheshirecat_python_sdk-1.7.2 → cheshirecat_python_sdk-1.7.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cheshirecat-python-sdk
-Version: 1.7.2
+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.2 → cheshirecat_python_sdk-1.7.4}/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-1.7.2 → cheshirecat_python_sdk-1.7.4}/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-1.7.2 → cheshirecat_python_sdk-1.7.4}/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-1.7.2 → cheshirecat_python_sdk-1.7.4}/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-1.7.4/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-1.7.4/cheshirecat_python_sdk/endpoints/health_check.py

@@ -0,0 +1,22 @@
+from cheshirecat_python_sdk.endpoints.base import AbstractEndpoint
+
+class HealthCheckEndpoint(AbstractEndpoint):
+    def liveness(self):
+        """
+        This endpoint is used to check if the server is running.
+        :return: dict, the status of the server.
+        """
+        response = self.get_http_session().get("/health/liveness")
+        response.raise_for_status()
+
+        return response.json()
+
+    def readiness(self):
+        """
+        This endpoint is used to check if the server is running.
+        :return: dict, the status of the server.
+        """
+        response = self.get_http_session().get("/health/readiness")
+        response.raise_for_status()
+
+        return response.json()

{cheshirecat_python_sdk-1.7.2 → cheshirecat_python_sdk-1.7.4}/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.2 → cheshirecat_python_sdk-1.7.4}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "cheshirecat-python-sdk"
 description = "Python SDK for the Cloud-ready fork of the Cheshire Cat"
-version = "1.7.2"
+version = "1.7.4"
 requires-python = ">=3.10"
 license = { file = "LICENSE" }
 authors = [

cheshirecat_python_sdk-1.7.2/cheshirecat_python_sdk/endpoints/health_check.py

@@ -1,12 +0,0 @@
-from cheshirecat_python_sdk.endpoints.base import AbstractEndpoint
-
-class HealthCheckEndpoint(AbstractEndpoint):
-    def home(self):
-        """
-        This endpoint is used to check if the server is running.
-        :return: dict, the status of the server.
-        """
-        response = self.get_http_session().get("/")
-        response.raise_for_status()
-
-        return response.json()