python3-core-api-client 2.5__tar.gz → 2.7__tar.gz

{python3_core_api_client-2.5 → python3_core_api_client-2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python3-core-api-client
-Version: 2.5
+Version: 2.7
 Summary: Python client for Core API.
 Author-email: Cyberfusion <support@cyberfusion.io>
 Project-URL: Source, https://github.com/CyberfusionIO/python3-core-api-client
@@ -13,7 +13,7 @@ Requires-Dist: pydantic[dotenv,email]==1.10.4
 
 Python client for Core API.
 
-This client was built for and tested on the **1.252** version of the API.
+This client was built for and tested on the **1.256** version of the API.
 
 ## Support
 
@@ -74,6 +74,23 @@ response = connector.virtual_hosts.list_virtual_hosts()
 virtual_hosts = response.dto
 ```
 
+By default, no objects are included. You can manually specify which objects you wish to include, for example:
+
+```python
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+connector = CoreApiConnector(
+    username='username', password='password'
+)
+
+response = connector.virtual_hosts.read_virtual_host(includes=["unix_user,cluster.region"])
+
+virtual_host = response.dto
+
+unix_user = virtual_host.includes.unix_user
+region = virtual_host.includes.cluster.includes.region
+```
+
 ## Authentication
 
 This client takes care of authentication.

{python3_core_api_client-2.5 → python3_core_api_client-2.7}/README.md

@@ -2,7 +2,7 @@
 
 Python client for Core API.
 
-This client was built for and tested on the **1.252** version of the API.
+This client was built for and tested on the **1.256** version of the API.
 
 ## Support
 
@@ -63,6 +63,23 @@ response = connector.virtual_hosts.list_virtual_hosts()
 virtual_hosts = response.dto
 ```
 
+By default, no objects are included. You can manually specify which objects you wish to include, for example:
+
+```python
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+connector = CoreApiConnector(
+    username='username', password='password'
+)
+
+response = connector.virtual_hosts.read_virtual_host(includes=["unix_user,cluster.region"])
+
+virtual_host = response.dto
+
+unix_user = virtual_host.includes.unix_user
+region = virtual_host.includes.cluster.includes.region
+```
+
 ## Authentication
 
 This client takes care of authentication.

{python3_core_api_client-2.5 → python3_core_api_client-2.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python3-core-api-client"
-version = "2.5"
+version = "2.7"
 description = "Python client for Core API."
 readme = "README.md"
 authors = [

python3_core_api_client-2.7/src/cyberfusion/CoreApiClient/_helpers.py

@@ -0,0 +1,12 @@
+from typing import Literal
+
+
+def construct_includes_query_parameter(
+    includes: list[str] | None,
+) -> dict[Literal["includes"], str]:
+    if includes is None:
+        return {}
+
+    return {
+        "includes": ",".join(includes),
+    }