python3-core-api-client 1.2__tar.gz → 2.0__tar.gz

{python3_core_api_client-1.2 → python3_core_api_client-2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python3-core-api-client
-Version: 1.2
+Version: 2.0
 Summary: Python client for Core API.
 Author-email: Cyberfusion <support@cyberfusion.io>
 Project-URL: Source, https://github.com/CyberfusionIO/python3-core-api-client
@@ -9,7 +9,7 @@ Requires-Dist: certifi==2022.9.24
 Requires-Dist: requests==2.28.1
 Requires-Dist: pydantic[dotenv,email]==1.10.4
 
-# python3-core-api-client
+ # python3-core-api-client
 
 Python client for Core API.
 
@@ -69,7 +69,9 @@ connector = CoreApiConnector(
     api_key='api_key'
 )
 
-virtual_hosts = connector.virtual_hosts.list_virtual_hosts()
+response = connector.virtual_hosts.list_virtual_hosts()
+
+virtual_hosts = response.dto
 ```
 
 ## Authentication
@@ -168,7 +170,7 @@ for error in errors:
 
 ### Get model from response
 
-Calling an endpoint returns the resource model.
+Calling an endpoint returns a response model (`DtoResponse`) containing the resource model (in the `dto` variable).
 
 Code example:
 
@@ -181,7 +183,7 @@ connector = CoreApiConnector(
     username='username', password='password'
 )
 
-mail_domain_resource = connector.mail_domains.create_mail_domain(
+response = connector.mail_domains.create_mail_domain(
     MailDomainCreateRequest(
         domain='cyberfusion.io',
         unix_user_id=1,
@@ -189,9 +191,46 @@ mail_domain_resource = connector.mail_domains.create_mail_domain(
         catch_all_forward_email_addresses=[],
     )
 )
+
+mail_domain_resource = response.dto
 # mail_domain_resource is a model representing the API resource
 ```
 
+### Get other information from response
+
+The response model also contains the response status code, body (in both string and JSON format), headers and a failed boolean.
+
+Need even more? Access the raw response object in `requests_response`.
+
+Code example:
+
+```python
+import requests_cache
+
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+from cyberfusion.CoreApiClient.models import MailAliasCreateRequest
+
+connector = CoreApiConnector(
+    username='username', password='password', requests_session=requests_cache.CachedSession()
+)
+
+response = connector.mail_aliases.create_mail_alias(
+    MailAliasCreateRequest(
+        local_part='&^@$#^&@$#^&',
+        mail_domain_id=1,
+    )
+)
+
+if response.failed:
+    print("HTTP request failed with status code: ", response.status_code)
+
+if response.requests_response.from_cache:
+    print("Cached response body: ", response.body)
+
+    json_body = response.json
+```
+
 ### Throw exception on failure
 
 If a request returns an unexpected HTTP status code, `cyberfusion.CoreApiClient.exceptions.CallException` is thrown.
@@ -236,12 +275,6 @@ 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` instead of `send`. It takes the same parameters.

{python3_core_api_client-1.2 → python3_core_api_client-2.0}/README.md

@@ -1,4 +1,4 @@
-# python3-core-api-client
+ # python3-core-api-client
 
 Python client for Core API.
 
@@ -58,7 +58,9 @@ connector = CoreApiConnector(
     api_key='api_key'
 )
 
-virtual_hosts = connector.virtual_hosts.list_virtual_hosts()
+response = connector.virtual_hosts.list_virtual_hosts()
+
+virtual_hosts = response.dto
 ```
 
 ## Authentication
@@ -157,7 +159,7 @@ for error in errors:
 
 ### Get model from response
 
-Calling an endpoint returns the resource model.
+Calling an endpoint returns a response model (`DtoResponse`) containing the resource model (in the `dto` variable).
 
 Code example:
 
@@ -170,7 +172,7 @@ connector = CoreApiConnector(
     username='username', password='password'
 )
 
-mail_domain_resource = connector.mail_domains.create_mail_domain(
+response = connector.mail_domains.create_mail_domain(
     MailDomainCreateRequest(
         domain='cyberfusion.io',
         unix_user_id=1,
@@ -178,9 +180,46 @@ mail_domain_resource = connector.mail_domains.create_mail_domain(
         catch_all_forward_email_addresses=[],
     )
 )
+
+mail_domain_resource = response.dto
 # mail_domain_resource is a model representing the API resource
 ```
 
+### Get other information from response
+
+The response model also contains the response status code, body (in both string and JSON format), headers and a failed boolean.
+
+Need even more? Access the raw response object in `requests_response`.
+
+Code example:
+
+```python
+import requests_cache
+
+from cyberfusion.CoreApiClient.connector import CoreApiConnector
+
+from cyberfusion.CoreApiClient.models import MailAliasCreateRequest
+
+connector = CoreApiConnector(
+    username='username', password='password', requests_session=requests_cache.CachedSession()
+)
+
+response = connector.mail_aliases.create_mail_alias(
+    MailAliasCreateRequest(
+        local_part='&^@$#^&@$#^&',
+        mail_domain_id=1,
+    )
+)
+
+if response.failed:
+    print("HTTP request failed with status code: ", response.status_code)
+
+if response.requests_response.from_cache:
+    print("Cached response body: ", response.body)
+
+    json_body = response.json
+```
+
 ### Throw exception on failure
 
 If a request returns an unexpected HTTP status code, `cyberfusion.CoreApiClient.exceptions.CallException` is thrown.
@@ -225,12 +264,6 @@ 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` instead of `send`. It takes the same parameters.

{python3_core_api_client-1.2 → python3_core_api_client-2.0}/pyproject.toml

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

{python3_core_api_client-1.2 → python3_core_api_client-2.0}/src/cyberfusion/CoreApiClient/connector.py

@@ -131,6 +131,7 @@ class CoreApiClient:
             status_code=requests_response.status_code,
             body=requests_response.text,
             headers=requests_response.headers,
+            requests_response=requests_response,
         )
 
         return local_response

python3_core_api_client-2.0/src/cyberfusion/CoreApiClient/http.py

@@ -0,0 +1,50 @@
+import json
+from dataclasses import dataclass
+from http import HTTPStatus
+from typing import Any, TypeVar, Generic
+
+from requests.structures import CaseInsensitiveDict
+
+from cyberfusion.CoreApiClient.models import CoreApiModel
+
+from requests.models import Response as RequestsResponse
+
+
+ModelType = TypeVar("ModelType", bound=CoreApiModel)
+DtoType = TypeVar("DtoType", CoreApiModel, list[CoreApiModel])
+
+
+@dataclass
+class Response:
+    status_code: int
+    body: str
+    headers: CaseInsensitiveDict
+    requests_response: RequestsResponse
+
+    @property
+    def failed(self) -> bool:
+        return self.status_code >= HTTPStatus.BAD_REQUEST
+
+    @property
+    def json(self) -> Any:
+        return json.loads(self.body)
+
+
+@dataclass
+class DtoResponse(Generic[DtoType], Response):
+    dto: DtoType
+
+    @classmethod
+    def from_response(cls, response: Response, model: type[ModelType]) -> "DtoResponse":
+        if isinstance(response.json, list):
+            dto = [model.parse_obj(object_) for object_ in response.json]
+        else:
+            dto = model.parse_obj(response.json)
+
+        return cls(
+            status_code=response.status_code,
+            body=response.body,
+            headers=response.headers,
+            requests_response=response.requests_response,
+            dto=dto,
+        )

python3_core_api_client-2.0/src/cyberfusion/CoreApiClient/resources/basic_authentication_realms.py

@@ -0,0 +1,94 @@
+from cyberfusion.CoreApiClient import models
+from typing import Optional, List
+
+from cyberfusion.CoreApiClient.http import DtoResponse
+from cyberfusion.CoreApiClient.interfaces import Resource
+
+
+class BasicAuthenticationRealms(Resource):
+    def create_basic_authentication_realm(
+        self,
+        request: models.BasicAuthenticationRealmCreateRequest,
+    ) -> DtoResponse[models.BasicAuthenticationRealmResource]:
+        local_response = self.api_connector.send_or_fail(
+            "POST",
+            "/api/v1/basic-authentication-realms",
+            data=request.dict(exclude_unset=True),
+            query_parameters={},
+        )
+
+        return DtoResponse.from_response(
+            local_response, models.BasicAuthenticationRealmResource
+        )
+
+    def list_basic_authentication_realms(
+        self,
+        *,
+        skip: Optional[int] = None,
+        limit: Optional[int] = None,
+        filter_: Optional[List[str]] = None,
+        sort: Optional[List[str]] = None,
+    ) -> DtoResponse[list[models.BasicAuthenticationRealmResource]]:
+        local_response = self.api_connector.send_or_fail(
+            "GET",
+            "/api/v1/basic-authentication-realms",
+            data=None,
+            query_parameters={
+                "skip": skip,
+                "limit": limit,
+                "filter": filter_,
+                "sort": sort,
+            },
+        )
+
+        return DtoResponse.from_response(
+            local_response, models.BasicAuthenticationRealmResource
+        )
+
+    def read_basic_authentication_realm(
+        self,
+        *,
+        id_: int,
+    ) -> DtoResponse[models.BasicAuthenticationRealmResource]:
+        local_response = self.api_connector.send_or_fail(
+            "GET",
+            f"/api/v1/basic-authentication-realms/{id_}",
+            data=None,
+            query_parameters={},
+        )
+
+        return DtoResponse.from_response(
+            local_response,
+            models.BasicAuthenticationRealmResource,
+        )
+
+    def update_basic_authentication_realm(
+        self,
+        request: models.BasicAuthenticationRealmUpdateRequest,
+        *,
+        id_: int,
+    ) -> DtoResponse[models.BasicAuthenticationRealmResource]:
+        local_response = self.api_connector.send_or_fail(
+            "PATCH",
+            f"/api/v1/basic-authentication-realms/{id_}",
+            data=request.dict(exclude_unset=True),
+            query_parameters={},
+        )
+
+        return DtoResponse.from_response(
+            local_response, models.BasicAuthenticationRealmResource
+        )
+
+    def delete_basic_authentication_realm(
+        self,
+        *,
+        id_: int,
+    ) -> DtoResponse[models.DetailMessage]:
+        local_response = self.api_connector.send_or_fail(
+            "DELETE",
+            f"/api/v1/basic-authentication-realms/{id_}",
+            data=None,
+            query_parameters={},
+        )
+
+        return DtoResponse.from_response(local_response, models.DetailMessage)

python3_core_api_client-2.0/src/cyberfusion/CoreApiClient/resources/borg_archives.py

@@ -0,0 +1,143 @@
+from cyberfusion.CoreApiClient import models
+from typing import Optional, List
+
+from cyberfusion.CoreApiClient.http import DtoResponse
+from cyberfusion.CoreApiClient.interfaces import Resource
+
+
+class BorgArchives(Resource):
+    def create_borg_archive_for_database(
+        self,
+        request: models.BorgArchiveCreateDatabaseRequest,
+        *,
+        callback_url: Optional[str] = None,
+    ) -> DtoResponse[models.TaskCollectionResource]:
+        local_response = self.api_connector.send_or_fail(
+            "POST",
+            "/api/v1/borg-archives/database",
+            data=request.dict(exclude_unset=True),
+            query_parameters={
+                "callback_url": callback_url,
+            },
+        )
+
+        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+
+    def create_borg_archive_for_unix_user(
+        self,
+        request: models.BorgArchiveCreateUNIXUserRequest,
+        *,
+        callback_url: Optional[str] = None,
+    ) -> DtoResponse[models.TaskCollectionResource]:
+        local_response = self.api_connector.send_or_fail(
+            "POST",
+            "/api/v1/borg-archives/unix-user",
+            data=request.dict(exclude_unset=True),
+            query_parameters={
+                "callback_url": callback_url,
+            },
+        )
+
+        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+
+    def list_borg_archives(
+        self,
+        *,
+        skip: Optional[int] = None,
+        limit: Optional[int] = None,
+        filter_: Optional[List[str]] = None,
+        sort: Optional[List[str]] = None,
+    ) -> DtoResponse[list[models.BorgArchiveResource]]:
+        local_response = self.api_connector.send_or_fail(
+            "GET",
+            "/api/v1/borg-archives",
+            data=None,
+            query_parameters={
+                "skip": skip,
+                "limit": limit,
+                "filter": filter_,
+                "sort": sort,
+            },
+        )
+
+        return DtoResponse.from_response(local_response, models.BorgArchiveResource)
+
+    def read_borg_archive(
+        self,
+        *,
+        id_: int,
+    ) -> DtoResponse[models.BorgArchiveResource]:
+        local_response = self.api_connector.send_or_fail(
+            "GET", f"/api/v1/borg-archives/{id_}", data=None, query_parameters={}
+        )
+
+        return DtoResponse.from_response(local_response, models.BorgArchiveResource)
+
+    def get_borg_archive_metadata(
+        self,
+        *,
+        id_: int,
+    ) -> DtoResponse[models.BorgArchiveMetadata]:
+        local_response = self.api_connector.send_or_fail(
+            "GET",
+            f"/api/v1/borg-archives/{id_}/metadata",
+            data=None,
+            query_parameters={},
+        )
+
+        return DtoResponse.from_response(local_response, models.BorgArchiveMetadata)
+
+    def restore_borg_archive(
+        self,
+        *,
+        id_: int,
+        callback_url: Optional[str] = None,
+        path: Optional[str] = None,
+    ) -> DtoResponse[models.TaskCollectionResource]:
+        local_response = self.api_connector.send_or_fail(
+            "POST",
+            f"/api/v1/borg-archives/{id_}/restore",
+            data=None,
+            query_parameters={
+                "callback_url": callback_url,
+                "path": path,
+            },
+        )
+
+        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+
+    def list_borg_archive_contents(
+        self,
+        *,
+        id_: int,
+        path: Optional[str] = None,
+    ) -> DtoResponse[list[models.BorgArchiveContent]]:
+        local_response = self.api_connector.send_or_fail(
+            "GET",
+            f"/api/v1/borg-archives/{id_}/contents",
+            data=None,
+            query_parameters={
+                "path": path,
+            },
+        )
+
+        return DtoResponse.from_response(local_response, models.BorgArchiveContent)
+
+    def download_borg_archive(
+        self,
+        *,
+        id_: int,
+        callback_url: Optional[str] = None,
+        path: Optional[str] = None,
+    ) -> DtoResponse[models.TaskCollectionResource]:
+        local_response = self.api_connector.send_or_fail(
+            "POST",
+            f"/api/v1/borg-archives/{id_}/download",
+            data=None,
+            query_parameters={
+                "callback_url": callback_url,
+                "path": path,
+            },
+        )
+
+        return DtoResponse.from_response(local_response, models.TaskCollectionResource)

python3_core_api_client-2.0/src/cyberfusion/CoreApiClient/resources/borg_repositories.py

@@ -0,0 +1,133 @@
+from cyberfusion.CoreApiClient import models
+from typing import Optional, List
+
+from cyberfusion.CoreApiClient.http import DtoResponse
+from cyberfusion.CoreApiClient.interfaces import Resource
+
+
+class BorgRepositories(Resource):
+    def create_borg_repository(
+        self,
+        request: models.BorgRepositoryCreateRequest,
+    ) -> DtoResponse[models.BorgRepositoryResource]:
+        local_response = self.api_connector.send_or_fail(
+            "POST",
+            "/api/v1/borg-repositories",
+            data=request.dict(exclude_unset=True),
+            query_parameters={},
+        )
+
+        return DtoResponse.from_response(local_response, models.BorgRepositoryResource)
+
+    def list_borg_repositories(
+        self,
+        *,
+        skip: Optional[int] = None,
+        limit: Optional[int] = None,
+        filter_: Optional[List[str]] = None,
+        sort: Optional[List[str]] = None,
+    ) -> DtoResponse[list[models.BorgRepositoryResource]]:
+        local_response = self.api_connector.send_or_fail(
+            "GET",
+            "/api/v1/borg-repositories",
+            data=None,
+            query_parameters={
+                "skip": skip,
+                "limit": limit,
+                "filter": filter_,
+                "sort": sort,
+            },
+        )
+
+        return DtoResponse.from_response(local_response, models.BorgRepositoryResource)
+
+    def read_borg_repository(
+        self,
+        *,
+        id_: int,
+    ) -> DtoResponse[models.BorgRepositoryResource]:
+        local_response = self.api_connector.send_or_fail(
+            "GET",
+            f"/api/v1/borg-repositories/{id_}",
+            data=None,
+            query_parameters={},
+        )
+
+        return DtoResponse.from_response(local_response, models.BorgRepositoryResource)
+
+    def update_borg_repository(
+        self,
+        request: models.BorgRepositoryUpdateRequest,
+        *,
+        id_: int,
+    ) -> DtoResponse[models.BorgRepositoryResource]:
+        local_response = self.api_connector.send_or_fail(
+            "PATCH",
+            f"/api/v1/borg-repositories/{id_}",
+            data=request.dict(exclude_unset=True),
+            query_parameters={},
+        )
+
+        return DtoResponse.from_response(local_response, models.BorgRepositoryResource)
+
+    def delete_borg_repository(
+        self,
+        *,
+        id_: int,
+    ) -> DtoResponse[models.DetailMessage]:
+        local_response = self.api_connector.send_or_fail(
+            "DELETE",
+            f"/api/v1/borg-repositories/{id_}",
+            data=None,
+            query_parameters={},
+        )
+
+        return DtoResponse.from_response(local_response, models.DetailMessage)
+
+    def prune_borg_repository(
+        self,
+        *,
+        id_: int,
+        callback_url: Optional[str] = None,
+    ) -> DtoResponse[models.TaskCollectionResource]:
+        local_response = self.api_connector.send_or_fail(
+            "POST",
+            f"/api/v1/borg-repositories/{id_}/prune",
+            data=None,
+            query_parameters={
+                "callback_url": callback_url,
+            },
+        )
+
+        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+
+    def check_borg_repository(
+        self,
+        *,
+        id_: int,
+        callback_url: Optional[str] = None,
+    ) -> DtoResponse[models.TaskCollectionResource]:
+        local_response = self.api_connector.send_or_fail(
+            "POST",
+            f"/api/v1/borg-repositories/{id_}/check",
+            data=None,
+            query_parameters={
+                "callback_url": callback_url,
+            },
+        )
+
+        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+
+    def get_borg_archives_metadata(
+        self,
+        *,
+        id_: int,
+    ) -> DtoResponse[list[models.BorgArchiveMetadata]]:
+        local_response = self.api_connector.send_or_fail(
+            "GET",
+            f"/api/v1/borg-repositories/{id_}/archives-metadata",
+            data=None,
+            query_parameters={},
+        )
+
+        return DtoResponse.from_response(local_response, models.BorgArchiveMetadata)