python3-core-api-client 0.1__py3-none-any.whl

cyberfusion/CoreApiClient/resources/url_redirects.py

@@ -0,0 +1,79 @@
+from cyberfusion.CoreApiClient import models
+from typing import Optional, List
+
+from cyberfusion.CoreApiClient.interfaces import Resource
+
+
+class URLRedirects(Resource):
+    def create_url_redirect(
+        self,
+        request: models.URLRedirectCreateRequest,
+    ) -> models.URLRedirectResource:
+        return models.URLRedirectResource.construct(
+            **self.api_connector.send_or_fail(
+                "POST",
+                "/api/v1/url-redirects",
+                data=request.dict(),
+                query_parameters={},
+            ).json
+        )
+
+    def list_url_redirects(
+        self,
+        *,
+        skip: Optional[int] = None,
+        limit: Optional[int] = None,
+        filter_: Optional[List[str]] = None,
+        sort: Optional[List[str]] = None,
+    ) -> list[models.URLRedirectResource]:
+        return [
+            models.URLRedirectResource.construct(**model)
+            for model in self.api_connector.send_or_fail(
+                "GET",
+                "/api/v1/url-redirects",
+                data=None,
+                query_parameters={
+                    "skip": skip,
+                    "limit": limit,
+                    "filter": filter_,
+                    "sort": sort,
+                },
+            ).json
+        ]
+
+    def read_url_redirect(
+        self,
+        *,
+        id_: int,
+    ) -> models.URLRedirectResource:
+        return models.URLRedirectResource.construct(
+            **self.api_connector.send_or_fail(
+                "GET", f"/api/v1/url-redirects/{id_}", data=None, query_parameters={}
+            ).json
+        )
+
+    def update_url_redirect(
+        self,
+        request: models.URLRedirectUpdateRequest,
+        *,
+        id_: int,
+    ) -> models.URLRedirectResource:
+        return models.URLRedirectResource.construct(
+            **self.api_connector.send_or_fail(
+                "PATCH",
+                f"/api/v1/url-redirects/{id_}",
+                data=request.dict(exclude_unset=True),
+                query_parameters={},
+            ).json
+        )
+
+    def delete_url_redirect(
+        self,
+        *,
+        id_: int,
+    ) -> models.DetailMessage:
+        return models.DetailMessage.construct(
+            **self.api_connector.send_or_fail(
+                "DELETE", f"/api/v1/url-redirects/{id_}", data=None, query_parameters={}
+            ).json
+        )

cyberfusion/CoreApiClient/resources/virtual_hosts.py

@@ -0,0 +1,120 @@
+from cyberfusion.CoreApiClient import models
+from typing import Optional, List
+
+from cyberfusion.CoreApiClient.interfaces import Resource
+
+
+class VirtualHosts(Resource):
+    def create_virtual_host(
+        self,
+        request: models.VirtualHostCreateRequest,
+    ) -> models.VirtualHostResource:
+        return models.VirtualHostResource.construct(
+            **self.api_connector.send_or_fail(
+                "POST",
+                "/api/v1/virtual-hosts",
+                data=request.dict(),
+                query_parameters={},
+            ).json
+        )
+
+    def list_virtual_hosts(
+        self,
+        *,
+        skip: Optional[int] = None,
+        limit: Optional[int] = None,
+        filter_: Optional[List[str]] = None,
+        sort: Optional[List[str]] = None,
+    ) -> list[models.VirtualHostResource]:
+        return [
+            models.VirtualHostResource.construct(**model)
+            for model in self.api_connector.send_or_fail(
+                "GET",
+                "/api/v1/virtual-hosts",
+                data=None,
+                query_parameters={
+                    "skip": skip,
+                    "limit": limit,
+                    "filter": filter_,
+                    "sort": sort,
+                },
+            ).json
+        ]
+
+    def read_virtual_host(
+        self,
+        *,
+        id_: int,
+    ) -> models.VirtualHostResource:
+        return models.VirtualHostResource.construct(
+            **self.api_connector.send_or_fail(
+                "GET", f"/api/v1/virtual-hosts/{id_}", data=None, query_parameters={}
+            ).json
+        )
+
+    def update_virtual_host(
+        self,
+        request: models.VirtualHostUpdateRequest,
+        *,
+        id_: int,
+    ) -> models.VirtualHostResource:
+        return models.VirtualHostResource.construct(
+            **self.api_connector.send_or_fail(
+                "PATCH",
+                f"/api/v1/virtual-hosts/{id_}",
+                data=request.dict(exclude_unset=True),
+                query_parameters={},
+            ).json
+        )
+
+    def delete_virtual_host(
+        self,
+        *,
+        id_: int,
+        delete_on_cluster: Optional[bool] = None,
+    ) -> models.DetailMessage:
+        return models.DetailMessage.construct(
+            **self.api_connector.send_or_fail(
+                "DELETE",
+                f"/api/v1/virtual-hosts/{id_}",
+                data=None,
+                query_parameters={
+                    "delete_on_cluster": delete_on_cluster,
+                },
+            ).json
+        )
+
+    def get_virtual_host_document_root(
+        self,
+        *,
+        id_: int,
+    ) -> models.VirtualHostDocumentRoot:
+        return models.VirtualHostDocumentRoot.construct(
+            **self.api_connector.send_or_fail(
+                "GET",
+                f"/api/v1/virtual-hosts/{id_}/document-root",
+                data=None,
+                query_parameters={},
+            ).json
+        )
+
+    def sync_domain_roots_of_virtual_hosts(
+        self,
+        *,
+        left_virtual_host_id: int,
+        right_virtual_host_id: int,
+        callback_url: Optional[str] = None,
+        exclude_paths: Optional[List[str]] = None,
+    ) -> models.TaskCollectionResource:
+        return models.TaskCollectionResource.construct(
+            **self.api_connector.send_or_fail(
+                "POST",
+                f"/api/v1/virtual-hosts/{left_virtual_host_id}/domain-root/sync",
+                data=None,
+                query_parameters={
+                    "callback_url": callback_url,
+                    "right_virtual_host_id": right_virtual_host_id,
+                    "exclude_paths": exclude_paths,
+                },
+            ).json
+        )

python3_core_api_client-0.1.dist-info/METADATA

@@ -0,0 +1,236 @@
+Metadata-Version: 2.4
+Name: python3-core-api-client
+Version: 0.1
+Summary: Python client for Core API.
+Author-email: Cyberfusion <support@cyberfusion.io>
+Project-URL: Source, https://github.com/CyberfusionIO/python3-core-api-client
+Description-Content-Type: text/markdown
+Requires-Dist: certifi==2022.9.24
+Requires-Dist: requests==2.28.1
+Requires-Dist: pydantic[email]==1.10.4
+
+# python3-core-api-client
+
+Python client for Core API.
+
+This client was built for and tested on the **1.241** version of the API.
+
+## Support
+
+This client is officially supported by Cyberfusion.
+
+Have questions? Ask your support questions on the [platform](https://platform.cyberfusion.io/). No access to the platform? Send an email to [support@cyberfusion.io](mailto:support@cyberfusion.io). **GitHub issues are not actively monitored.**
+
+# Install
+
+This client can be used in any Python project and with any framework.
+
+This client requires Python 3.11 or higher.
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-core-api-client
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Usage
+
+## API documentation
+
+Refer to the [API documentation](https://core-api.cyberfusion.io/) for information about API requests.
+
+**Enums and Models** are **auto-generated** based on the OpenAPI spec - so the client is completely in line with the Core API. **Requests and Resources** are not auto-generated.
+
+## Getting started
+
+Initialise the `CoreApiConnector` with your username and password **or** API key.
+
+The connector takes care of authentication, and offers several resources (such as `virtual_hosts`) and endpoints (i.e. `list_virtual_hosts`).
+
+```python
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+# Using username and password
+
+connector = CoreApiConnector(
+    username='username', password='password'
+)
+
+# Or using API key
+
+connector = CoreApiConnector(
+    api_key='api_key'
+)
+
+virtual_hosts = connector.virtual_hosts.list_virtual_hosts()
+```
+
+## Authentication
+
+This client takes care of authentication.
+
+If authentication using username and password fails, `cyberfusion.CoreApiClient.exceptions.AuthenticationException` is thrown.
+
+If authentication using API key fails, the regular `CallException` exception fis raised.
+
+Don't have an API user? Contact Cyberfusion.
+
+## Requests
+
+The client uses a fluent interface to build requests.
+
+To view all possible requests:
+
+- Start with the connector
+- Go to the desired resource
+- Call the desired endpoint
+
+Code example:
+
+```python
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+from cyberfusion.CoreApiClient.models import MailDomainCreateRequest
+
+connector = CoreApiConnector(
+    username='username', password='password'
+)
+
+connector.mail_domains.create_mail_domain(
+    MailDomainCreateRequest(
+        domain='cyberfusion.io',
+        unix_user_id=1,
+        is_local=True,
+        catch_all_forward_email_addresses=[],
+    )
+)
+```
+
+Models are validated before sending the request (using [Pydantic](https://docs.pydantic.dev/latest/)). If invalid data is provided, `pydantic.ValidationError` is thrown.
+
+For example:
+
+```python
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+from cyberfusion.CoreApiClient.models import MailAliasCreateRequest
+
+connector = CoreApiConnector(
+    username='username', password='password'
+)
+
+connector.mail_aliases.create_mail_alias(
+    MailAliasCreateRequest(
+        local_part='&^@$#^&@$#^&',
+        mail_domain_id=1,
+    )
+)
+# throw pydantic.ValidationError
+```
+
+The exception will provide more details about the validation errors.
+
+## Responses
+
+### Get model from response
+
+Calling a n endpoint returns the resource model.
+
+For example:
+
+```python
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+from cyberfusion.CoreApiClient.models import MailDomainCreateRequest
+
+connector = CoreApiConnector(
+    username='username', password='password'
+)
+
+mail_domain_resource = connector.mail_domains.create_mail_domain(
+    MailDomainCreateRequest(
+        domain='cyberfusion.io',
+        unix_user_id=1,
+        is_local=True,
+        catch_all_forward_email_addresses=[],
+    )
+)
+# mail_domain_resource is a model representing the API resource
+```
+
+### Throw exception on failure
+
+If a request returns an unexpected HTTP status code, `cyberfusion.CoreApiClient.exceptions.CallException` is thrown.
+
+## Enums
+
+Some properties only accept certain values (enums).
+
+Find these values in `cyberfusion.CoreApiClient.models`.
+
+## Deep dive
+
+### Custom `requests` session
+
+Want to provide your own `requests` session? Pass it to the connector:
+
+```python
+import requests
+
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+connector = CoreApiConnector(
+    ..., requests_session=requests.Session()
+)
+```
+
+Don't pass a custom session? A default one is created, including retries.
+
+### Manual requests
+
+Don't want to use the full SDK, but easily send requests and retrieve responses from the Core API?
+
+Initialise the connector as usual, and call `send`:
+
+```python
+import requests
+
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+connector = CoreApiConnector(...)
+
+response = connector.send(method='GET', path='/foobar', data={}, query_parameters={})
+
+response.status_code
+response.json
+response.body
+response.headers
+response.failed
+```
+
+To raise `cyberfusion.CoreApiClient.exceptions.CallException` in case of an unexpected HTTP status code, use `send_or_fail`.
+
+### Generating models
+
+Auto-generate models as follows:
+
+    datamodel-codegen --input-file-type openapi --input $file --output src/cyberfusion/CoreApiClient/models.py --target-python-version 3.11
+
+Replace `$file` by the path to the OpenAPI spec (JSON).
+
+Note: don't replace `models.py` in full - it contains customisations.
+
+# Test strategy
+
+Tests use a mock server, [Stoplight Prism](https://stoplight.io/open-source/prism).
+
+Prism checks requests' syntactic validity - based on the OpenAPI spec.
+
+Therefore, the resources' test suites solely call methods without asserting specifics: nearly all possible issues - invalid requests, mismatch between resource models and endpoint, etc. - are already caught by having a validating mock server.

python3_core_api_client-0.1.dist-info/RECORD

@@ -0,0 +1,59 @@
+cyberfusion/CoreApiClient/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cyberfusion/CoreApiClient/_encoders.py,sha256=wyYUK_82h_hOPRvdxIzYta7Ek1TSSYMORR1QF1XfcRA,186
+cyberfusion/CoreApiClient/connector.py,sha256=uOUHYxJOnWlyrucneHGWeaPgdcDK6cHzuqK4Wqgau80,12813
+cyberfusion/CoreApiClient/exceptions.py,sha256=fNxPtzVL4SzPiVNZmBTu1l8D57dkCxMxflyIXDPLE4Q,204
+cyberfusion/CoreApiClient/http.py,sha256=z6ZyfQyUnA3QDCmej2BEIw9BOlTYoCE8zvTZ0-u_VoQ,429
+cyberfusion/CoreApiClient/interfaces.py,sha256=P0wCbmSNEpB-eF49PHudc_qXM4blIXm4TsD2AB0z_7Q,269
+cyberfusion/CoreApiClient/models.py,sha256=HXtva3VXmdK-yNFH5muzShepKu5w4MMY-JOIc6zLfow,267433
+cyberfusion/CoreApiClient/resources/__init__.py,sha256=E5VMFXttOmN7TjJt0WeARL_tYVoJcLoRoOnIYkCF748,1881
+cyberfusion/CoreApiClient/resources/basic_authentication_realms.py,sha256=RwGg2e9m0SI-6nECbv2Qa9LoORGx66jD6MI3BqOtPYY,2749
+cyberfusion/CoreApiClient/resources/borg_archives.py,sha256=RhznSuycfcHXsBa9pJmzD-aX8twB6wlmO_Ad7jSWNUs,4362
+cyberfusion/CoreApiClient/resources/borg_repositories.py,sha256=F8tvw286pj0PzoJuXJmYf2DXgKuvZevur-zxagOxtgI,3986
+cyberfusion/CoreApiClient/resources/certificate_managers.py,sha256=f14ieh0hQTzAcEwz20VShuSpHsTnEozo1BKHd0yWxC4,3009
+cyberfusion/CoreApiClient/resources/certificates.py,sha256=fEUGZ0PTbSW5JQAncWm38ttifxSS2Z7dfCbvDMNwHjU,1905
+cyberfusion/CoreApiClient/resources/clusters.py,sha256=aDQJV20ZmIN5RbNGJT0gMOsxxZIJtGbMAlGFs8IclR4,7034
+cyberfusion/CoreApiClient/resources/cmses.py,sha256=a4r8NbSway9HmyW7NTNag6ZWtBuwEn8fsI0irkAS0qw,8400
+cyberfusion/CoreApiClient/resources/crons.py,sha256=1P_sxEMXyAiSW10x8hc-Q9TytWOdRsa1pJTSY04O8U8,2162
+cyberfusion/CoreApiClient/resources/custom_config_snippets.py,sha256=nnXLKjKPbI8t_zvXg5A6oF0aQa4V9FvpM0Sm3QeJ2IQ,2758
+cyberfusion/CoreApiClient/resources/custom_configs.py,sha256=G0fYu9Dq1akF3QpGv1ama4Czblz5FxO11vPUuB4-otY,2438
+cyberfusion/CoreApiClient/resources/customers.py,sha256=lE5Y2txvK4Bi_-UpupYsZrLVBjmrShPwOZx9UdFqTSE,2879
+cyberfusion/CoreApiClient/resources/daemons.py,sha256=ggvRZrGOC6ABVs-B0240xcQa7kPtnfFgzB5McjviHak,2204
+cyberfusion/CoreApiClient/resources/database_user_grants.py,sha256=GcaBDceq6VC3nX3-qhPBpfMqkYJ7qxRBD382Y0qMJfE,2142
+cyberfusion/CoreApiClient/resources/database_users.py,sha256=w80leEEaEUITyz2fW7bsFN8hHPfDGeq-AB7TAL77XNE,2438
+cyberfusion/CoreApiClient/resources/databases.py,sha256=bgC8xBshIubYTxGq0K0vPVJQardPjtbmh1XdCr1Tqjw,4296
+cyberfusion/CoreApiClient/resources/domain_routers.py,sha256=qZl1UEt_0nifEvsmb9zhrOpO0WR1GYewbm6s4c7YWRM,1339
+cyberfusion/CoreApiClient/resources/firewall_groups.py,sha256=giay8c2Ox1EVJdsZJDH1d6PVXlP7cnlx9djKIpGLjmg,2459
+cyberfusion/CoreApiClient/resources/firewall_rules.py,sha256=EDgRJnAVi9YzHwe-d5ayILOfTWu8drNvSxUkvzq4saQ,1979
+cyberfusion/CoreApiClient/resources/fpm_pools.py,sha256=lD2u3YL8sP4GlFJDNAIp-N8aHCnSztg0eBaMly1YlnI,3219
+cyberfusion/CoreApiClient/resources/ftp_users.py,sha256=9TNR8YeZjgYDS07OkrczoQsUWygV5SB5Nb1OetWy1Vc,2661
+cyberfusion/CoreApiClient/resources/haproxy_listens.py,sha256=RWvYFjdU2x9t9wUZikREu0deUQOhP34Gvn6Zh1QL-K0,1995
+cyberfusion/CoreApiClient/resources/haproxy_listens_to_nodes.py,sha256=NIQhUbvviELc9SMV4q0hYZqYYoSVDWtWy08d54wtyrk,2162
+cyberfusion/CoreApiClient/resources/health.py,sha256=x8c_XYbTJuh92xegCQZYNIYPA11QLPjP5nr-UxNA7OU,393
+cyberfusion/CoreApiClient/resources/hosts_entries.py,sha256=cfF9QqIPvsjSnZEkbKbhRWg3TJPMuZxdexUEN05Gn0c,1903
+cyberfusion/CoreApiClient/resources/htpasswd_files.py,sha256=44SipjT7ri_arfGGm8x45mlCYIt4DNoLya9SFcncRDo,1979
+cyberfusion/CoreApiClient/resources/htpasswd_users.py,sha256=rGh9KZpupw_zMbZqouBss21IErpz-iSjS3K8zE4WJsY,2438
+cyberfusion/CoreApiClient/resources/login.py,sha256=VgJIsxgVfLOsMBYm1zbrx2Z0boi0_LS8gVYS_gX2L4I,858
+cyberfusion/CoreApiClient/resources/logs.py,sha256=SGrIm76M0GoPKKwRQ54wip4NJHUgvd64-ILGp-5apDg,1538
+cyberfusion/CoreApiClient/resources/mail_accounts.py,sha256=Q5lNkGufBAx4soRvpzGqBFQ9bQ2g8xlIbD-VycLRpA8,3201
+cyberfusion/CoreApiClient/resources/mail_aliases.py,sha256=Wxqei8EkP1ZhsBWLouDlPccnl7EnHpNwzjZO4VKUjpg,2333
+cyberfusion/CoreApiClient/resources/mail_domains.py,sha256=QTLBnWxR4d56Rr_IFzPaLS83_uojZzUO6RhzJ3blC6o,2347
+cyberfusion/CoreApiClient/resources/mail_hostnames.py,sha256=cuuT1Ao5QsbL2Y4fhu5_SAdpawdCm6RemXFNLsIq6LA,2438
+cyberfusion/CoreApiClient/resources/malwares.py,sha256=FKXmniuK0rccRO6qGhAtS2_MBvZAyKunqcuIlyT_HuM,1601
+cyberfusion/CoreApiClient/resources/mariadb_encryption_keys.py,sha256=UQUSXNh_uIdeIAsx6jbDx-NAAz-AvcgK1VjpZqQV-x8,1779
+cyberfusion/CoreApiClient/resources/node_add_ons.py,sha256=_8E3yuTv8a0370ns_agNuvywoKumxZa4yhcLCrAtaSc,2235
+cyberfusion/CoreApiClient/resources/nodes.py,sha256=C0-eMxqbKKyRUsvqxGlONblmHxGskrXWfMsWAb8GPYg,3220
+cyberfusion/CoreApiClient/resources/passenger_apps.py,sha256=z6zRW8WrjW6eZWFo5Otb_9LIy7RAUCaSfEL6Wj3ipAg,2961
+cyberfusion/CoreApiClient/resources/redis_instances.py,sha256=GNWkPumiPq6w87lp3lew7dq0bqRJdLlS8mnTCWX6s9s,2586
+cyberfusion/CoreApiClient/resources/root_ssh_keys.py,sha256=tPXTOW-jBtPzu48BxVVUcp0kIoFSx-rgfx_pw083sQk,2345
+cyberfusion/CoreApiClient/resources/security_txt_policies.py,sha256=zCsgUkhs5SNF2AwbMGpQhxxulHNb7nj0f5nasS17Thc,2609
+cyberfusion/CoreApiClient/resources/sites.py,sha256=sd548x1d0juD1B4u1iYy_KmdiLvhisnimdoLQ7XOtn0,839
+cyberfusion/CoreApiClient/resources/ssh_keys.py,sha256=-J5W6gbMxaF_OPRPzosf0LpiPqWm1Snkc6CTJyiaknQ,2251
+cyberfusion/CoreApiClient/resources/task_collections.py,sha256=IlMup5_snkhtxtEY0ow73pZconbL9tkPbFaI5vOiRzs,1088
+cyberfusion/CoreApiClient/resources/tombstones.py,sha256=AH7G23dD_I-qqmr98AmzsFDAMMNA_fslv7BE7Z1fo_k,864
+cyberfusion/CoreApiClient/resources/unix_users.py,sha256=moqa5CjNSzueccMGms9mNhtUSDFw1UapWlB8QM6Agjk,3636
+cyberfusion/CoreApiClient/resources/url_redirects.py,sha256=1Y386s9Bge8gBaXucSUBi1npNPPQpMLLVGXqVxA2YFM,2368
+cyberfusion/CoreApiClient/resources/virtual_hosts.py,sha256=SAo6QPQGO-IJJCwW71zEEdA5FGdAn-6ADdn1iuA03wg,3716
+python3_core_api_client-0.1.dist-info/METADATA,sha256=H4bMR1aXuOD6OBz2Vj6fHwzFsmyGtvuGYIBNdrAoEGg,6357
+python3_core_api_client-0.1.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+python3_core_api_client-0.1.dist-info/top_level.txt,sha256=ss011q9S6SL_KIIyq7iujFmIYa0grSjlnInO7cDkeag,12
+python3_core_api_client-0.1.dist-info/RECORD,,

python3_core_api_client-0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (79.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

python3_core_api_client-0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+cyberfusion