python3-core-api-client 2.4.1__tar.gz → 2.6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/PKG-INFO +18 -1
  2. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/README.md +17 -0
  3. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/pyproject.toml +1 -1
  4. python3_core_api_client-2.6/src/cyberfusion/CoreApiClient/_helpers.py +12 -0
  5. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/models.py +91 -102
  6. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/basic_authentication_realms.py +6 -4
  7. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/borg_archives.py +9 -4
  8. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/borg_repositories.py +6 -4
  9. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/certificate_managers.py +6 -4
  10. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/certificates.py +9 -4
  11. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/clusters.py +102 -77
  12. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/cmses.py +9 -4
  13. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/crons.py +9 -4
  14. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/custom_config_snippets.py +6 -4
  15. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/custom_configs.py +9 -4
  16. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/customers.py +9 -4
  17. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/daemons.py +9 -4
  18. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/database_user_grants.py +4 -3
  19. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/database_users.py +9 -4
  20. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/databases.py +12 -5
  21. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/domain_routers.py +4 -3
  22. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/firewall_groups.py +9 -4
  23. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/firewall_rules.py +9 -4
  24. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/fpm_pools.py +9 -4
  25. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/ftp_users.py +9 -4
  26. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/haproxy_listens.py +9 -4
  27. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/haproxy_listens_to_nodes.py +6 -4
  28. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/hosts_entries.py +9 -4
  29. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/htpasswd_files.py +9 -4
  30. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/htpasswd_users.py +9 -4
  31. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/logs.py +7 -6
  32. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/mail_accounts.py +12 -5
  33. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/mail_aliases.py +9 -4
  34. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/mail_domains.py +8 -4
  35. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/mail_hostnames.py +9 -4
  36. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/malwares.py +4 -3
  37. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/mariadb_encryption_keys.py +6 -4
  38. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/node_add_ons.py +9 -4
  39. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/nodes.py +9 -4
  40. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/passenger_apps.py +9 -4
  41. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/redis_instances.py +9 -4
  42. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/regions.py +4 -3
  43. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/root_ssh_keys.py +9 -4
  44. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/security_txt_policies.py +6 -4
  45. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/ssh_keys.py +9 -4
  46. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/task_collections.py +4 -1
  47. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/tombstones.py +4 -3
  48. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/unix_users.py +12 -5
  49. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/url_redirects.py +9 -4
  50. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/virtual_hosts.py +9 -4
  51. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/python3_core_api_client.egg-info/PKG-INFO +18 -1
  52. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/python3_core_api_client.egg-info/SOURCES.txt +1 -0
  53. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/setup.cfg +0 -0
  54. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/__init__.py +0 -0
  55. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/_encoders.py +0 -0
  56. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/connector.py +0 -0
  57. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/exceptions.py +0 -0
  58. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/http.py +0 -0
  59. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/interfaces.py +0 -0
  60. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/__init__.py +0 -0
  61. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/health.py +0 -0
  62. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/cyberfusion/CoreApiClient/resources/login.py +0 -0
  63. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/python3_core_api_client.egg-info/dependency_links.txt +0 -0
  64. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/python3_core_api_client.egg-info/requires.txt +0 -0
  65. {python3_core_api_client-2.4.1 → python3_core_api_client-2.6}/src/python3_core_api_client.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: python3-core-api-client
3
- Version: 2.4.1
3
+ Version: 2.6
4
4
  Summary: Python client for Core API.
5
5
  Author-email: Cyberfusion <support@cyberfusion.io>
6
6
  Project-URL: Source, https://github.com/CyberfusionIO/python3-core-api-client
@@ -74,6 +74,23 @@ response = connector.virtual_hosts.list_virtual_hosts()
74
74
  virtual_hosts = response.dto
75
75
  ```
76
76
 
77
+ By default, no objects are included. You can manually specify which objects you wish to include, for example:
78
+
79
+ ```python
80
+ from cyberfusion.CoreApiClient.connector import CoreApiConnector
81
+
82
+ connector = CoreApiConnector(
83
+ username='username', password='password'
84
+ )
85
+
86
+ response = connector.virtual_hosts.read_virtual_host(includes=["unix_user,cluster.region"])
87
+
88
+ virtual_host = response.dto
89
+
90
+ unix_user = virtual_host.includes.unix_user
91
+ region = virtual_host.includes.cluster.includes.region
92
+ ```
93
+
77
94
  ## Authentication
78
95
 
79
96
  This client takes care of authentication.
@@ -63,6 +63,23 @@ response = connector.virtual_hosts.list_virtual_hosts()
63
63
  virtual_hosts = response.dto
64
64
  ```
65
65
 
66
+ By default, no objects are included. You can manually specify which objects you wish to include, for example:
67
+
68
+ ```python
69
+ from cyberfusion.CoreApiClient.connector import CoreApiConnector
70
+
71
+ connector = CoreApiConnector(
72
+ username='username', password='password'
73
+ )
74
+
75
+ response = connector.virtual_hosts.read_virtual_host(includes=["unix_user,cluster.region"])
76
+
77
+ virtual_host = response.dto
78
+
79
+ unix_user = virtual_host.includes.unix_user
80
+ region = virtual_host.includes.cluster.includes.region
81
+ ```
82
+
66
83
  ## Authentication
67
84
 
68
85
  This client takes care of authentication.
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "python3-core-api-client"
7
- version = "2.4.1"
7
+ version = "2.6"
8
8
  description = "Python client for Core API."
9
9
  readme = "README.md"
10
10
  authors = [
@@ -0,0 +1,12 @@
1
+ from typing import Literal
2
+
3
+
4
+ def construct_includes_query_parameter(
5
+ includes: list[str] | None,
6
+ ) -> dict[Literal["includes"], str]:
7
+ if includes is None:
8
+ return {}
9
+
10
+ return {
11
+ "includes": ",".join(includes),
12
+ }
@@ -798,24 +798,24 @@ class ObjectModelNameEnum(StrEnum):
798
798
  SERVICE_ACCOUNT = "ServiceAccount"
799
799
  SERVICE_ACCOUNT_SERVER = "ServiceAccountServer"
800
800
  CUSTOM_CONFIG = "CustomConfig"
801
- CLUSTERS_PHP_PROPERTIES = "clusters_php_properties"
802
- CLUSTERS_NODEJS_PROPERTIES = "clusters_nodejs_properties"
803
- CLUSTERS_BORG_PROPERTIES = "clusters_borg_properties"
804
- CLUSTERS_KERNELCARE_PROPERTIES = "clusters_kernelcare_properties"
805
- CLUSTERS_NEW_RELIC_PROPERTIES = "clusters_new_relic_properties"
806
- CLUSTERS_REDIS_PROPERTIES = "clusters_redis_properties"
807
- CLUSTERS_POSTGRESQL_PROPERTIES = "clusters_postgresql_properties"
808
- CLUSTERS_MARIADB_PROPERTIES = "clusters_mariadb_properties"
809
- CLUSTERS_MEILISEARCH_PROPERTIES = "clusters_meilisearch_properties"
810
- CLUSTERS_GRAFANA_PROPERTIES = "clusters_grafana_properties"
811
- CLUSTERS_SINGLESTORE_PROPERTIES = "clusters_singlestore_properties"
812
- CLUSTERS_ELASTICSEARCH_PROPERTIES = "clusters_elasticsearch_properties"
813
- CLUSTERS_RABBITMQ_PROPERTIES = "clusters_rabbitmq_properties"
814
- CLUSTERS_METABASE_PROPERTIES = "clusters_metabase_properties"
815
- CLUSTERS_UNIX_USERS_PROPERTIES = "clusters_unix_users_properties"
816
- CLUSTERS_LOAD_BALANCING_PROPERTIES = "clusters_load_balancing_properties"
817
- CLUSTERS_FIREWALL_PROPERTIES = "clusters_firewall_properties"
818
- CLUSTERS_OS_PROPERTIES = "clusters_os_properties"
801
+ CLUSTERS_PHP_PROPERTIES = "ClustersPhpProperties"
802
+ CLUSTERS_NODEJS_PROPERTIES = "ClustersNodejsProperties"
803
+ CLUSTERS_BORG_PROPERTIES = "ClustersBorgProperties"
804
+ CLUSTERS_KERNELCARE_PROPERTIES = "ClustersKernelcareProperties"
805
+ CLUSTERS_NEW_RELIC_PROPERTIES = "ClustersNewRelicProperties"
806
+ CLUSTERS_REDIS_PROPERTIES = "ClustersRedisProperties"
807
+ CLUSTERS_POSTGRESQL_PROPERTIES = "ClustersPostgresqlProperties"
808
+ CLUSTERS_MARIADB_PROPERTIES = "ClustersMariadbProperties"
809
+ CLUSTERS_MEILISEARCH_PROPERTIES = "ClustersMeilisearchProperties"
810
+ CLUSTERS_GRAFANA_PROPERTIES = "ClustersGrafanaProperties"
811
+ CLUSTERS_SINGLESTORE_PROPERTIES = "ClustersSinglestoreProperties"
812
+ CLUSTERS_ELASTICSEARCH_PROPERTIES = "ClustersElasticsearchProperties"
813
+ CLUSTERS_RABBITMQ_PROPERTIES = "ClustersRabbitmqProperties"
814
+ CLUSTERS_METABASE_PROPERTIES = "ClustersMetabaseProperties"
815
+ CLUSTERS_UNIX_USERS_PROPERTIES = "ClustersUnixUsersProperties"
816
+ CLUSTERS_LOAD_BALANCING_PROPERTIES = "ClustersLoadBalancingProperties"
817
+ CLUSTERS_FIREWALL_PROPERTIES = "ClustersFirewallProperties"
818
+ CLUSTERS_OS_PROPERTIES = "ClustersOsProperties"
819
819
 
820
820
 
821
821
  class PHPExtensionEnum(StrEnum):
@@ -1070,6 +1070,7 @@ class UNIXUserUpdateRequest(CoreApiModel):
1070
1070
  description: Optional[
1071
1071
  constr(regex=r"^[a-zA-Z0-9-_ ]+$", min_length=1, max_length=255)
1072
1072
  ] = None
1073
+ shell_is_namespaced: Optional[bool] = None
1073
1074
 
1074
1075
 
1075
1076
  class UNIXUserUsageFile(CoreApiModel):
@@ -1211,8 +1212,8 @@ class ClusterIPAddressCreateRequest(CoreApiModel):
1211
1212
 
1212
1213
 
1213
1214
  class ClusterIncludes(CoreApiModel):
1214
- region: RegionResource
1215
- customer: CustomerResource
1215
+ region: Optional[RegionResource]
1216
+ customer: Optional[CustomerResource]
1216
1217
 
1217
1218
 
1218
1219
  class ClusterResource(CoreApiModel):
@@ -1253,7 +1254,7 @@ class CustomConfigCreateRequest(CoreApiModel):
1253
1254
 
1254
1255
 
1255
1256
  class CustomConfigIncludes(CoreApiModel):
1256
- cluster: ClusterResource
1257
+ cluster: Optional[ClusterResource]
1257
1258
 
1258
1259
 
1259
1260
  class CustomConfigResource(CoreApiModel):
@@ -1284,7 +1285,7 @@ class CustomConfigSnippetCreateFromTemplateRequest(CoreApiModel):
1284
1285
 
1285
1286
 
1286
1287
  class CustomConfigSnippetIncludes(CoreApiModel):
1287
- cluster: ClusterResource
1288
+ cluster: Optional[ClusterResource]
1288
1289
 
1289
1290
 
1290
1291
  class CustomConfigSnippetResource(CoreApiModel):
@@ -1314,7 +1315,7 @@ class DatabaseCreateRequest(CoreApiModel):
1314
1315
 
1315
1316
 
1316
1317
  class DatabaseIncludes(CoreApiModel):
1317
- cluster: ClusterResource
1318
+ cluster: Optional[ClusterResource]
1318
1319
 
1319
1320
 
1320
1321
  class DatabaseResource(CoreApiModel):
@@ -1346,7 +1347,7 @@ class DatabaseUserGrantCreateRequest(CoreApiModel):
1346
1347
 
1347
1348
 
1348
1349
  class DatabaseUserIncludes(CoreApiModel):
1349
- cluster: ClusterResource
1350
+ cluster: Optional[ClusterResource]
1350
1351
 
1351
1352
 
1352
1353
  class DatabaseUserResource(CoreApiModel):
@@ -1363,7 +1364,7 @@ class DatabaseUserResource(CoreApiModel):
1363
1364
 
1364
1365
 
1365
1366
  class FirewallGroupIncludes(CoreApiModel):
1366
- cluster: ClusterResource
1367
+ cluster: Optional[ClusterResource]
1367
1368
 
1368
1369
 
1369
1370
  class FirewallGroupResource(CoreApiModel):
@@ -1403,8 +1404,8 @@ class HAProxyListenCreateRequest(CoreApiModel):
1403
1404
 
1404
1405
 
1405
1406
  class HAProxyListenIncludes(CoreApiModel):
1406
- destination_cluster: ClusterResource
1407
- cluster: ClusterResource
1407
+ destination_cluster: Optional[ClusterResource]
1408
+ cluster: Optional[ClusterResource]
1408
1409
 
1409
1410
 
1410
1411
  class HAProxyListenResource(CoreApiModel):
@@ -1461,7 +1462,7 @@ class WebServerLogErrorResource(CoreApiModel):
1461
1462
 
1462
1463
 
1463
1464
  class MariaDBEncryptionKeyIncludes(CoreApiModel):
1464
- cluster: ClusterResource
1465
+ cluster: Optional[ClusterResource]
1465
1466
 
1466
1467
 
1467
1468
  class MariaDBEncryptionKeyResource(CoreApiModel):
@@ -1488,7 +1489,7 @@ class NodeGroupsProperties(CoreApiModel):
1488
1489
 
1489
1490
 
1490
1491
  class NodeIncludes(CoreApiModel):
1491
- cluster: ClusterResource
1492
+ cluster: Optional[ClusterResource]
1492
1493
 
1493
1494
 
1494
1495
  class NodeResource(CoreApiModel):
@@ -1551,7 +1552,7 @@ class PassengerAppUpdateRequest(CoreApiModel):
1551
1552
 
1552
1553
 
1553
1554
  class RedisInstanceIncludes(CoreApiModel):
1554
- cluster: ClusterResource
1555
+ cluster: Optional[ClusterResource]
1555
1556
 
1556
1557
 
1557
1558
  class RedisInstanceResource(CoreApiModel):
@@ -1569,7 +1570,7 @@ class RedisInstanceResource(CoreApiModel):
1569
1570
 
1570
1571
 
1571
1572
  class RootSSHKeyIncludes(CoreApiModel):
1572
- cluster: ClusterResource
1573
+ cluster: Optional[ClusterResource]
1573
1574
 
1574
1575
 
1575
1576
  class RootSSHKeyResource(CoreApiModel):
@@ -1584,7 +1585,7 @@ class RootSSHKeyResource(CoreApiModel):
1584
1585
 
1585
1586
 
1586
1587
  class SecurityTXTPolicyIncludes(CoreApiModel):
1587
- cluster: ClusterResource
1588
+ cluster: Optional[ClusterResource]
1588
1589
 
1589
1590
 
1590
1591
  class SecurityTXTPolicyResource(CoreApiModel):
@@ -1643,7 +1644,7 @@ class TokenResource(CoreApiModel):
1643
1644
 
1644
1645
 
1645
1646
  class UNIXUserIncludes(CoreApiModel):
1646
- cluster: ClusterResource
1647
+ cluster: Optional[ClusterResource] = None
1647
1648
 
1648
1649
 
1649
1650
  class UNIXUserResource(CoreApiModel):
@@ -1670,7 +1671,7 @@ class UNIXUserResource(CoreApiModel):
1670
1671
 
1671
1672
 
1672
1673
  class URLRedirectIncludes(CoreApiModel):
1673
- cluster: ClusterResource
1674
+ cluster: Optional[ClusterResource]
1674
1675
 
1675
1676
 
1676
1677
  class URLRedirectResource(CoreApiModel):
@@ -1713,7 +1714,7 @@ class VirtualHostCreateRequest(CoreApiModel):
1713
1714
  class BorgRepositoryIncludes(CoreApiModel):
1714
1715
  unix_user: Optional[UNIXUserResource]
1715
1716
  database: Optional[DatabaseResource]
1716
- cluster: ClusterResource
1717
+ cluster: Optional[ClusterResource]
1717
1718
 
1718
1719
 
1719
1720
  class BorgRepositoryResource(CoreApiModel):
@@ -1738,7 +1739,7 @@ class BorgRepositoryResource(CoreApiModel):
1738
1739
 
1739
1740
 
1740
1741
  class CertificateIncludes(CoreApiModel):
1741
- cluster: ClusterResource
1742
+ cluster: Optional[ClusterResource]
1742
1743
 
1743
1744
 
1744
1745
  class CertificateResource(CoreApiModel):
@@ -1767,9 +1768,9 @@ class ClusterDeploymentResults(CoreApiModel):
1767
1768
 
1768
1769
 
1769
1770
  class CronIncludes(CoreApiModel):
1770
- cluster: ClusterResource
1771
- unix_user: UNIXUserResource
1772
- node: NodeResource
1771
+ cluster: Optional[ClusterResource]
1772
+ unix_user: Optional[UNIXUserResource]
1773
+ node: Optional[NodeResource]
1773
1774
 
1774
1775
 
1775
1776
  class CronResource(CoreApiModel):
@@ -1794,8 +1795,8 @@ class CronResource(CoreApiModel):
1794
1795
 
1795
1796
 
1796
1797
  class DaemonIncludes(CoreApiModel):
1797
- unix_user: UNIXUserResource
1798
- cluster: ClusterResource
1798
+ unix_user: Optional[UNIXUserResource]
1799
+ cluster: Optional[ClusterResource]
1799
1800
 
1800
1801
 
1801
1802
  class DaemonResource(CoreApiModel):
@@ -1813,9 +1814,9 @@ class DaemonResource(CoreApiModel):
1813
1814
 
1814
1815
 
1815
1816
  class DatabaseUserGrantIncludes(CoreApiModel):
1816
- cluster: ClusterResource
1817
- database: DatabaseResource
1818
- database_user: DatabaseUserResource
1817
+ cluster: Optional[ClusterResource]
1818
+ database: Optional[DatabaseResource]
1819
+ database_user: Optional[DatabaseUserResource]
1819
1820
 
1820
1821
 
1821
1822
  class DatabaseUserGrantResource(CoreApiModel):
@@ -1831,8 +1832,8 @@ class DatabaseUserGrantResource(CoreApiModel):
1831
1832
 
1832
1833
 
1833
1834
  class FPMPoolIncludes(CoreApiModel):
1834
- unix_user: UNIXUserResource
1835
- cluster: ClusterResource
1835
+ unix_user: Optional[UNIXUserResource]
1836
+ cluster: Optional[ClusterResource]
1836
1837
 
1837
1838
 
1838
1839
  class FPMPoolResource(CoreApiModel):
@@ -1854,8 +1855,8 @@ class FPMPoolResource(CoreApiModel):
1854
1855
 
1855
1856
 
1856
1857
  class FTPUserIncludes(CoreApiModel):
1857
- unix_user: UNIXUserResource
1858
- cluster: ClusterResource
1858
+ unix_user: Optional[UNIXUserResource]
1859
+ cluster: Optional[ClusterResource]
1859
1860
 
1860
1861
 
1861
1862
  class FTPUserResource(CoreApiModel):
@@ -1871,10 +1872,10 @@ class FTPUserResource(CoreApiModel):
1871
1872
 
1872
1873
 
1873
1874
  class FirewallRuleIncludes(CoreApiModel):
1874
- node: NodeResource
1875
+ node: Optional[NodeResource]
1875
1876
  firewall_group: Optional[FirewallGroupResource]
1876
1877
  haproxy_listen: Optional[HAProxyListenResource]
1877
- cluster: ClusterResource
1878
+ cluster: Optional[ClusterResource]
1878
1879
 
1879
1880
 
1880
1881
  class FirewallRuleResource(CoreApiModel):
@@ -1892,9 +1893,9 @@ class FirewallRuleResource(CoreApiModel):
1892
1893
 
1893
1894
 
1894
1895
  class HAProxyListenToNodeIncludes(CoreApiModel):
1895
- haproxy_listen: HAProxyListenResource
1896
- node: NodeResource
1897
- cluster: ClusterResource
1896
+ haproxy_listen: Optional[HAProxyListenResource]
1897
+ node: Optional[NodeResource]
1898
+ cluster: Optional[ClusterResource]
1898
1899
 
1899
1900
 
1900
1901
  class HAProxyListenToNodeResource(CoreApiModel):
@@ -1908,8 +1909,8 @@ class HAProxyListenToNodeResource(CoreApiModel):
1908
1909
 
1909
1910
 
1910
1911
  class HostsEntryIncludes(CoreApiModel):
1911
- node: NodeResource
1912
- cluster: ClusterResource
1912
+ node: Optional[NodeResource]
1913
+ cluster: Optional[ClusterResource]
1913
1914
 
1914
1915
 
1915
1916
  class HostsEntryResource(CoreApiModel):
@@ -1923,8 +1924,8 @@ class HostsEntryResource(CoreApiModel):
1923
1924
 
1924
1925
 
1925
1926
  class HtpasswdFileIncludes(CoreApiModel):
1926
- unix_user: UNIXUserResource
1927
- cluster: ClusterResource
1927
+ unix_user: Optional[UNIXUserResource]
1928
+ cluster: Optional[ClusterResource]
1928
1929
 
1929
1930
 
1930
1931
  class HtpasswdFileResource(CoreApiModel):
@@ -1937,8 +1938,8 @@ class HtpasswdFileResource(CoreApiModel):
1937
1938
 
1938
1939
 
1939
1940
  class HtpasswdUserIncludes(CoreApiModel):
1940
- htpasswd_file: HtpasswdFileResource
1941
- cluster: ClusterResource
1941
+ htpasswd_file: Optional[HtpasswdFileResource]
1942
+ cluster: Optional[ClusterResource]
1942
1943
 
1943
1944
 
1944
1945
  class HtpasswdUserResource(CoreApiModel):
@@ -1953,8 +1954,8 @@ class HtpasswdUserResource(CoreApiModel):
1953
1954
 
1954
1955
 
1955
1956
  class MailDomainIncludes(CoreApiModel):
1956
- unix_user: UNIXUserResource
1957
- cluster: ClusterResource
1957
+ unix_user: Optional[UNIXUserResource]
1958
+ cluster: Optional[ClusterResource]
1958
1959
 
1959
1960
 
1960
1961
  class MailDomainResource(CoreApiModel):
@@ -1970,8 +1971,8 @@ class MailDomainResource(CoreApiModel):
1970
1971
 
1971
1972
 
1972
1973
  class MailHostnameIncludes(CoreApiModel):
1973
- certificate: CertificateResource
1974
- cluster: ClusterResource
1974
+ certificate: Optional[CertificateResource]
1975
+ cluster: Optional[ClusterResource]
1975
1976
 
1976
1977
 
1977
1978
  class MailHostnameResource(CoreApiModel):
@@ -1985,8 +1986,8 @@ class MailHostnameResource(CoreApiModel):
1985
1986
 
1986
1987
 
1987
1988
  class MalwareIncludes(CoreApiModel):
1988
- unix_user: UNIXUserResource
1989
- cluster: ClusterResource
1989
+ unix_user: Optional[UNIXUserResource]
1990
+ cluster: Optional[ClusterResource]
1990
1991
 
1991
1992
 
1992
1993
  class MalwareResource(CoreApiModel):
@@ -2002,8 +2003,8 @@ class MalwareResource(CoreApiModel):
2002
2003
 
2003
2004
 
2004
2005
  class NodeAddOnIncludes(CoreApiModel):
2005
- node: NodeResource
2006
- cluster: ClusterResource
2006
+ node: Optional[NodeResource]
2007
+ cluster: Optional[ClusterResource]
2007
2008
 
2008
2009
 
2009
2010
  class NodeAddOnResource(CoreApiModel):
@@ -2050,8 +2051,8 @@ class NodeHostsEntryDependency(CoreApiModel):
2050
2051
 
2051
2052
 
2052
2053
  class PassengerAppIncludes(CoreApiModel):
2053
- unix_user: UNIXUserResource
2054
- cluster: ClusterResource
2054
+ unix_user: Optional[UNIXUserResource]
2055
+ cluster: Optional[ClusterResource]
2055
2056
 
2056
2057
 
2057
2058
  class PassengerAppResource(CoreApiModel):
@@ -2079,8 +2080,8 @@ class PassengerAppResource(CoreApiModel):
2079
2080
 
2080
2081
 
2081
2082
  class SSHKeyIncludes(CoreApiModel):
2082
- unix_user: UNIXUserResource
2083
- cluster: ClusterResource
2083
+ unix_user: Optional[UNIXUserResource]
2084
+ cluster: Optional[ClusterResource]
2084
2085
 
2085
2086
 
2086
2087
  class SSHKeyResource(CoreApiModel):
@@ -2097,8 +2098,8 @@ class SSHKeyResource(CoreApiModel):
2097
2098
 
2098
2099
 
2099
2100
  class VirtualHostIncludes(CoreApiModel):
2100
- cluster: ClusterResource
2101
- unix_user: UNIXUserResource
2101
+ cluster: Optional[ClusterResource]
2102
+ unix_user: Optional[UNIXUserResource]
2102
2103
  fpm_pool: Optional[FPMPoolResource]
2103
2104
  passenger_app: Optional[PassengerAppResource]
2104
2105
 
@@ -2127,9 +2128,9 @@ class VirtualHostResource(CoreApiModel):
2127
2128
 
2128
2129
 
2129
2130
  class BasicAuthenticationRealmIncludes(CoreApiModel):
2130
- htpasswd_file: HtpasswdFileResource
2131
- virtual_host: VirtualHostResource
2132
- cluster: ClusterResource
2131
+ htpasswd_file: Optional[HtpasswdFileResource]
2132
+ virtual_host: Optional[VirtualHostResource]
2133
+ cluster: Optional[ClusterResource]
2133
2134
 
2134
2135
 
2135
2136
  class BasicAuthenticationRealmResource(CoreApiModel):
@@ -2145,8 +2146,8 @@ class BasicAuthenticationRealmResource(CoreApiModel):
2145
2146
 
2146
2147
 
2147
2148
  class BorgArchiveIncludes(CoreApiModel):
2148
- borg_repository: BorgRepositoryResource
2149
- cluster: ClusterResource
2149
+ borg_repository: Optional[BorgRepositoryResource]
2150
+ cluster: Optional[ClusterResource]
2150
2151
 
2151
2152
 
2152
2153
  class BorgArchiveResource(CoreApiModel):
@@ -2160,8 +2161,8 @@ class BorgArchiveResource(CoreApiModel):
2160
2161
 
2161
2162
 
2162
2163
  class CMSIncludes(CoreApiModel):
2163
- virtual_host: VirtualHostResource
2164
- cluster: ClusterResource
2164
+ virtual_host: Optional[VirtualHostResource]
2165
+ cluster: Optional[ClusterResource]
2165
2166
 
2166
2167
 
2167
2168
  class CMSResource(CoreApiModel):
@@ -2177,7 +2178,7 @@ class CMSResource(CoreApiModel):
2177
2178
 
2178
2179
  class CertificateManagerIncludes(CoreApiModel):
2179
2180
  certificate: Optional[CertificateResource]
2180
- cluster: ClusterResource
2181
+ cluster: Optional[ClusterResource]
2181
2182
 
2182
2183
 
2183
2184
  class CertificateManagerResource(CoreApiModel):
@@ -2204,7 +2205,7 @@ class DomainRouterIncludes(CoreApiModel):
2204
2205
  node: Optional[NodeResource]
2205
2206
  certificate: Optional[CertificateResource]
2206
2207
  security_txt_policy: Optional[SecurityTXTPolicyResource]
2207
- cluster: ClusterResource
2208
+ cluster: Optional[ClusterResource]
2208
2209
 
2209
2210
 
2210
2211
  class DomainRouterResource(CoreApiModel):
@@ -2225,8 +2226,8 @@ class DomainRouterResource(CoreApiModel):
2225
2226
 
2226
2227
 
2227
2228
  class MailAccountIncludes(CoreApiModel):
2228
- mail_domain: MailDomainResource
2229
- cluster: ClusterResource
2229
+ mail_domain: Optional[MailDomainResource]
2230
+ cluster: Optional[ClusterResource]
2230
2231
 
2231
2232
 
2232
2233
  class MailAccountResource(CoreApiModel):
@@ -2242,8 +2243,8 @@ class MailAccountResource(CoreApiModel):
2242
2243
 
2243
2244
 
2244
2245
  class MailAliasIncludes(CoreApiModel):
2245
- mail_domain: MailDomainResource
2246
- cluster: ClusterResource
2246
+ mail_domain: Optional[MailDomainResource]
2247
+ cluster: Optional[ClusterResource]
2247
2248
 
2248
2249
 
2249
2250
  class MailAliasResource(CoreApiModel):
@@ -2511,7 +2512,7 @@ class TombstoneDataCustomConfig(CoreApiModel):
2511
2512
 
2512
2513
 
2513
2514
  class TombstoneIncludes(CoreApiModel):
2514
- cluster: ClusterResource
2515
+ cluster: Optional[ClusterResource]
2515
2516
 
2516
2517
 
2517
2518
  class TombstoneResource(CoreApiModel):
@@ -2824,9 +2825,6 @@ class ClusterMetabasePropertiesResource(CoreApiModel):
2824
2825
 
2825
2826
  class ClusterMetabasePropertiesUpdateRequest(CoreApiModel):
2826
2827
  metabase_domain: Optional[str] = None
2827
- metabase_database_password: Optional[
2828
- constr(regex=r"^[ -~]+$", min_length=24, max_length=255)
2829
- ] = None
2830
2828
 
2831
2829
 
2832
2830
  class ClusterNewRelicPropertiesCreateRequest(CoreApiModel):
@@ -2874,7 +2872,6 @@ class ClusterNodejsPropertiesCreateRequest(CoreApiModel):
2874
2872
  ...,
2875
2873
  unique_items=True,
2876
2874
  )
2877
- nodejs_version: Optional[int] = None
2878
2875
 
2879
2876
 
2880
2877
  class ClusterNodejsPropertiesIncludes(CoreApiModel):
@@ -2885,7 +2882,6 @@ class ClusterNodejsPropertiesResource(CoreApiModel):
2885
2882
  id: int
2886
2883
  created_at: datetime
2887
2884
  updated_at: datetime
2888
- nodejs_version: Optional[int]
2889
2885
  nodejs_versions: List[NodejsVersion] = Field(
2890
2886
  ...,
2891
2887
  unique_items=True,
@@ -3218,7 +3214,6 @@ class SpecificationNameEnum(StrEnum):
3218
3214
  CLUSTER_SUPPORTS_METABASE_NODES = "Cluster supports Metabase nodes"
3219
3215
  UNIX_USER_SUPPORTS_VIRTUAL_HOSTS = "UNIX user supports virtual hosts"
3220
3216
  UNIX_USER_SUPPORTS_MAIL_DOMAINS = "UNIX user supports mail domains"
3221
- UNIX_USER_SUPPORTS_BORG_REPOSITORIES = "UNIX user supports Borg repositories"
3222
3217
  CLUSTER_SUPPORTS_LOAD_BALANCER_SERVICE_ACCOUNT_SERVICE_ACCOUNT_TO_CLUSTER = (
3223
3218
  "Cluster supports Load Balancer service account service account to cluster"
3224
3219
  )
@@ -3297,7 +3292,6 @@ class ClustersBorgPropertiesSearchRequest(CoreApiModel):
3297
3292
 
3298
3293
 
3299
3294
  class ClustersElasticsearchPropertiesSearchRequest(CoreApiModel):
3300
- elasticsearch_default_users_password: Optional[str] = None
3301
3295
  kibana_domain: Optional[str] = None
3302
3296
  cluster_id: Optional[int] = None
3303
3297
 
@@ -3327,7 +3321,6 @@ class ClustersMariadbPropertiesSearchRequest(CoreApiModel):
3327
3321
 
3328
3322
  class ClustersMetabasePropertiesSearchRequest(CoreApiModel):
3329
3323
  metabase_domain: Optional[str] = None
3330
- metabase_database_password: Optional[str] = None
3331
3324
  cluster_id: Optional[int] = None
3332
3325
 
3333
3326
 
@@ -3336,7 +3329,6 @@ class ClustersNewRelicPropertiesSearchRequest(CoreApiModel):
3336
3329
 
3337
3330
 
3338
3331
  class ClustersNodejsPropertiesSearchRequest(CoreApiModel):
3339
- nodejs_version: Optional[int] = None
3340
3332
  nodejs_versions: Optional[str] = None
3341
3333
  cluster_id: Optional[int] = None
3342
3334
 
@@ -3359,7 +3351,6 @@ class ClustersRabbitmqPropertiesSearchRequest(CoreApiModel):
3359
3351
 
3360
3352
 
3361
3353
  class ClustersRedisPropertiesSearchRequest(CoreApiModel):
3362
- redis_password: Optional[str] = None
3363
3354
  redis_memory_limit: Optional[int] = None
3364
3355
  cluster_id: Optional[int] = None
3365
3356
 
@@ -3374,8 +3365,6 @@ class ClustersSearchRequest(CoreApiModel):
3374
3365
  class ClustersSinglestorePropertiesSearchRequest(CoreApiModel):
3375
3366
  singlestore_studio_domain: Optional[str] = None
3376
3367
  singlestore_api_domain: Optional[str] = None
3377
- singlestore_license_key: Optional[str] = None
3378
- singlestore_root_password: Optional[str] = None
3379
3368
  cluster_id: Optional[int] = None
3380
3369
 
3381
3370
 
@@ -3417,7 +3406,7 @@ class DaemonsSearchRequest(CoreApiModel):
3417
3406
 
3418
3407
 
3419
3408
  class DatabaseUsersSearchRequest(CoreApiModel):
3420
- phpmyadmin_firewall_groups_ids: Optional[int] = None
3409
+ phpmyadmin_firewall_group_id: Optional[int] = None
3421
3410
 
3422
3411
 
3423
3412
  class DatabasesSearchRequest(CoreApiModel):
@@ -3437,7 +3426,7 @@ class DomainRoutersSearchRequest(CoreApiModel):
3437
3426
  node_id: Optional[int] = None
3438
3427
  certificate_id: Optional[int] = None
3439
3428
  security_txt_policy_id: Optional[int] = None
3440
- firewall_groups_ids: Optional[int] = None
3429
+ firewall_group_id: Optional[int] = None
3441
3430
  force_ssl: Optional[bool] = None
3442
3431
 
3443
3432
 
@@ -3506,7 +3495,7 @@ class MailAliasesSearchRequest(CoreApiModel):
3506
3495
  cluster_id: Optional[int] = None
3507
3496
  local_part: Optional[str] = None
3508
3497
  mail_domain_id: Optional[int] = None
3509
- forward_email_addresses: Optional[EmailStr] = None
3498
+ forward_email_address: Optional[EmailStr] = None
3510
3499
 
3511
3500
 
3512
3501
  class MailDomainsSearchRequest(CoreApiModel):
@@ -1,5 +1,6 @@
1
1
  from cyberfusion.CoreApiClient import models
2
2
 
3
+ from cyberfusion.CoreApiClient._helpers import construct_includes_query_parameter
3
4
  from cyberfusion.CoreApiClient.http import DtoResponse
4
5
  from cyberfusion.CoreApiClient.interfaces import Resource
5
6
 
@@ -26,6 +27,7 @@ class BasicAuthenticationRealms(Resource):
26
27
  page: int = 1,
27
28
  per_page: int = 0,
28
29
  include_filters: models.BasicAuthenticationRealmsSearchRequest | None = None,
30
+ includes: list[str] | None = None,
29
31
  ) -> DtoResponse[list[models.BasicAuthenticationRealmResource]]:
30
32
  local_response = self.api_connector.send_or_fail(
31
33
  "GET",
@@ -35,9 +37,8 @@ class BasicAuthenticationRealms(Resource):
35
37
  "page": page,
36
38
  "per_page": per_page,
37
39
  }
38
- | include_filters.dict(exclude_unset=True)
39
- if include_filters
40
- else None,
40
+ | (include_filters.dict(exclude_unset=True) if include_filters else {})
41
+ | construct_includes_query_parameter(includes),
41
42
  )
42
43
 
43
44
  return DtoResponse.from_response(
@@ -48,12 +49,13 @@ class BasicAuthenticationRealms(Resource):
48
49
  self,
49
50
  *,
50
51
  id_: int,
52
+ includes: list[str] | None = None,
51
53
  ) -> DtoResponse[models.BasicAuthenticationRealmResource]:
52
54
  local_response = self.api_connector.send_or_fail(
53
55
  "GET",
54
56
  f"/api/v1/basic-authentication-realms/{id_}",
55
57
  data=None,
56
- query_parameters={},
58
+ query_parameters=construct_includes_query_parameter(includes),
57
59
  )
58
60
 
59
61
  return DtoResponse.from_response(