chill-sharp-py-client 1.2.0__tar.gz → 1.3.0__tar.gz

{chill_sharp_py_client-1.2.0 → chill_sharp_py_client-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chill-sharp-py-client
-Version: 1.2.0
+Version: 1.3.0
 Summary: Python client for generic ChillSharp services
 Author: Andrea Piovesan
 License: AGPL-3.0-or-later
@@ -99,6 +99,20 @@ If the service supports ChillSharp auth endpoints, the client can log in and ref
 Query payloads can include an `Ordering` object with `PropertyName` and `Direction`.
 If you omit `Ordering`, the backend defaults to `Position`. Entity payloads also include `Position`, with default value `0`.
 
+### Command
+
+Use `command()` to execute a registered custom command. The response includes the command's updated parameters.
+
+```python
+result = client.command({
+    "ChillType": "Commands.SendNotification",
+    "Parameters": {
+        "Recipient": "ada@example.com",
+        "Message": "Your report is ready",
+    },
+})
+```
+
 ### Query
 
 Use `query()` when `ChillType` points to a concrete query type such as `Query.PostQuery`.
@@ -404,11 +418,10 @@ token = client.register_auth_account({
     "Password": "Pass123$",
     "DisplayName": "Root",
     "DisplayCultureName": "it-IT",
-    "CreateChillAuthUser": True,
 })
 ```
 
-If `DisplayCultureName` is provided and `CreateChillAuthUser` is `True`, the server presets the linked `AuthUser` with culture-based defaults for `DisplayTimeZone`, `DisplayDateFormat`, and `DisplayNumberFormat`.
+The server always creates the linked `AuthUser`. If `DisplayCultureName` is provided, it presets culture-based defaults for `DisplayTimeZone`, `DisplayDateFormat`, and `DisplayNumberFormat`.
 
 ### Login
 

{chill_sharp_py_client-1.2.0 → chill_sharp_py_client-1.3.0}/README.md

@@ -84,6 +84,20 @@ If the service supports ChillSharp auth endpoints, the client can log in and ref
 Query payloads can include an `Ordering` object with `PropertyName` and `Direction`.
 If you omit `Ordering`, the backend defaults to `Position`. Entity payloads also include `Position`, with default value `0`.
 
+### Command
+
+Use `command()` to execute a registered custom command. The response includes the command's updated parameters.
+
+```python
+result = client.command({
+    "ChillType": "Commands.SendNotification",
+    "Parameters": {
+        "Recipient": "ada@example.com",
+        "Message": "Your report is ready",
+    },
+})
+```
+
 ### Query
 
 Use `query()` when `ChillType` points to a concrete query type such as `Query.PostQuery`.
@@ -389,11 +403,10 @@ token = client.register_auth_account({
     "Password": "Pass123$",
     "DisplayName": "Root",
     "DisplayCultureName": "it-IT",
-    "CreateChillAuthUser": True,
 })
 ```
 
-If `DisplayCultureName` is provided and `CreateChillAuthUser` is `True`, the server presets the linked `AuthUser` with culture-based defaults for `DisplayTimeZone`, `DisplayDateFormat`, and `DisplayNumberFormat`.
+The server always creates the linked `AuthUser`. If `DisplayCultureName` is provided, it presets culture-based defaults for `DisplayTimeZone`, `DisplayDateFormat`, and `DisplayNumberFormat`.
 
 ### Login
 

{chill_sharp_py_client-1.2.0 → chill_sharp_py_client-1.3.0}/chill_sharp_py_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chill-sharp-py-client
-Version: 1.2.0
+Version: 1.3.0
 Summary: Python client for generic ChillSharp services
 Author: Andrea Piovesan
 License: AGPL-3.0-or-later
@@ -99,6 +99,20 @@ If the service supports ChillSharp auth endpoints, the client can log in and ref
 Query payloads can include an `Ordering` object with `PropertyName` and `Direction`.
 If you omit `Ordering`, the backend defaults to `Position`. Entity payloads also include `Position`, with default value `0`.
 
+### Command
+
+Use `command()` to execute a registered custom command. The response includes the command's updated parameters.
+
+```python
+result = client.command({
+    "ChillType": "Commands.SendNotification",
+    "Parameters": {
+        "Recipient": "ada@example.com",
+        "Message": "Your report is ready",
+    },
+})
+```
+
 ### Query
 
 Use `query()` when `ChillType` points to a concrete query type such as `Query.PostQuery`.
@@ -404,11 +418,10 @@ token = client.register_auth_account({
     "Password": "Pass123$",
     "DisplayName": "Root",
     "DisplayCultureName": "it-IT",
-    "CreateChillAuthUser": True,
 })
 ```
 
-If `DisplayCultureName` is provided and `CreateChillAuthUser` is `True`, the server presets the linked `AuthUser` with culture-based defaults for `DisplayTimeZone`, `DisplayDateFormat`, and `DisplayNumberFormat`.
+The server always creates the linked `AuthUser`. If `DisplayCultureName` is provided, it presets culture-based defaults for `DisplayTimeZone`, `DisplayDateFormat`, and `DisplayNumberFormat`.
 
 ### Login
 

{chill_sharp_py_client-1.2.0 → chill_sharp_py_client-1.3.0}/chillsharp_py_client/__init__.py

@@ -17,8 +17,8 @@ You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-from .client import API_BASE_PATH, CHILL_SHARP_PY_CLIENT_VERSION, AutomaticQuery, AutomaticQueryFilter, AutomaticQueryGroup, AutomaticQueryLogicalOperator, AutomaticQueryOperator, ChillDtoQuery, ChillSharpClient, ChillUserPreferences, PermissionAction, PermissionEffect, PermissionScope
+from .client import API_BASE_PATH, CHILL_SHARP_PY_CLIENT_VERSION, AutomaticQuery, AutomaticQueryFilter, AutomaticQueryGroup, AutomaticQueryLogicalOperator, AutomaticQueryOperator, ChillDtoCommand, ChillDtoQuery, ChillSharpClient, ChillUserPreferences, PermissionAction, PermissionEffect, PermissionScope
 from .exceptions import ChillSharpClientError
 
-__all__ = ["API_BASE_PATH", "CHILL_SHARP_PY_CLIENT_VERSION", "AutomaticQuery", "AutomaticQueryFilter", "AutomaticQueryGroup", "AutomaticQueryLogicalOperator", "AutomaticQueryOperator", "ChillDtoQuery", "ChillSharpClient", "ChillSharpClientError", "ChillUserPreferences", "PermissionAction", "PermissionEffect", "PermissionScope"]
+__all__ = ["API_BASE_PATH", "CHILL_SHARP_PY_CLIENT_VERSION", "AutomaticQuery", "AutomaticQueryFilter", "AutomaticQueryGroup", "AutomaticQueryLogicalOperator", "AutomaticQueryOperator", "ChillDtoCommand", "ChillDtoQuery", "ChillSharpClient", "ChillSharpClientError", "ChillUserPreferences", "PermissionAction", "PermissionEffect", "PermissionScope"]
 __version__ = CHILL_SHARP_PY_CLIENT_VERSION

{chill_sharp_py_client-1.2.0 → chill_sharp_py_client-1.3.0}/chillsharp_py_client/client.py

@@ -107,6 +107,13 @@ class ChillDtoQuery(TypedDict, total=False):
     results: list[JsonDict]
 
 
+class ChillDtoCommand(TypedDict, total=False):
+    """Command endpoint payload containing a type and its named parameters."""
+
+    chillType: str
+    parameters: JsonDict
+
+
 class PermissionEffect(IntEnum):
     """Effect applied by a permission rule."""
 
@@ -118,6 +125,7 @@ class PermissionAction(IntEnum):
     """Action controlled by a permission rule."""
 
     FULL_CONTROL = 0
+    COMMAND = 7
     QUERY = 1
     CREATE = 2
     UPDATE = 3
@@ -170,6 +178,10 @@ class ChillSharpClient:
         """Send a query request to the Chill endpoint."""
         return self._send_json("POST", self._build_chill_url("query"), dto_query)
 
+    def command(self, dto_command: ChillDtoCommand) -> ChillDtoCommand:
+        """Execute a custom command using its named parameters."""
+        return self._send_json("POST", self._build_chill_url("command"), dto_command)
+
     def lookup(self, dto_query: JsonDict) -> JsonDict:
         """Send a generic full-text lookup request to the Chill endpoint."""
         return self._send_json("POST", self._build_chill_url("lookup"), dto_query)
@@ -479,6 +491,13 @@ class ChillSharpClient:
         response = self._send_auth_json("GET", f"get-entity-list{suffix}")
         return response if isinstance(response, list) else []
 
+    def get_auth_command_list(self, module: str | None = None) -> list[str]:
+        """Return the distinct command list for an optional auth module."""
+        normalized_module = self._normalize_optional_value(module)
+        suffix = f"?module={quote(normalized_module)}" if normalized_module is not None else ""
+        response = self._send_auth_json("GET", f"get-command-list{suffix}")
+        return response if isinstance(response, list) else []
+
     def get_auth_query_list(self, module: str | None = None) -> list[str]:
         """Return the distinct query list for an optional auth module."""
         normalized_module = self._normalize_optional_value(module)

{chill_sharp_py_client-1.2.0 → chill_sharp_py_client-1.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "chill-sharp-py-client"
-version = "1.2.0"
+version = "1.3.0"
 description = "Python client for generic ChillSharp services"
 readme = "README.md"
 requires-python = ">=3.10"