python3-core-api-client 5.0__tar.gz → 6.0.1__tar.gz

{python3_core_api_client-5.0 → python3_core_api_client-6.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python3-core-api-client
-Version: 5.0
+Version: 6.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

{python3_core_api_client-5.0 → python3_core_api_client-6.0.1}/pyproject.toml

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

{python3_core_api_client-5.0 → python3_core_api_client-6.0.1}/src/cyberfusion/CoreApiClient/connector.py

@@ -15,6 +15,8 @@ import datetime
 import importlib.metadata
 from cyberfusion.CoreApiClient.http import Response
 
+DEFAULT_PER_PAGE = 50
+
 
 class CoreApiClient:
     def __init__(
@@ -154,6 +156,39 @@ class CoreApiClient:
 
         return local_response
 
+    def send_or_fail_with_auto_pagination(
+        self,
+        method: str,
+        path: str,
+        data: Optional[dict] = None,
+        query_parameters: Optional[dict] = None,
+        *,
+        per_page: int = DEFAULT_PER_PAGE,
+        content_type: str = "application/json",
+    ) -> list[Response]:
+        query_parameters = dict(query_parameters) if query_parameters else {}
+
+        query_parameters["per_page"] = per_page
+
+        responses: list[Response] = []
+        page = 1
+
+        while True:
+            query_parameters["page"] = page
+
+            response = self.send_or_fail(
+                method, path, data, query_parameters, content_type=content_type
+            )
+
+            responses.append(response)
+
+            if "next" not in response.requests_response.links:
+                break
+
+            page += 1
+
+        return responses
+
     def get_default_requests_session(self) -> requests.sessions.Session:
         session = requests.Session()
 

{python3_core_api_client-5.0 → python3_core_api_client-6.0.1}/src/cyberfusion/CoreApiClient/http.py

@@ -32,20 +32,32 @@ class Response:
 
 
 @dataclass
-class DtoResponse(Generic[DtoType], Response):
+class DtoResponse(Generic[DtoType]):
+    requests_responses: list[RequestsResponse]
     dto: DtoType
 
     @classmethod
-    def from_response(cls, response: Response, model: type[ModelType]) -> "DtoResponse":
-        if isinstance(response.json, list):
-            dto = [model.model_validate(object_) for object_ in response.json]
-        else:
-            dto = model.model_validate(response.json)
+    def from_responses(
+        cls, responses: Response | list[Response], model: type[ModelType]
+    ) -> "DtoResponse":
+        if isinstance(responses, Response):
+            responses = [responses]
+
+        dto: list = []
+
+        is_list_response = False
+
+        for response in responses:
+            items = response.json
+
+            if isinstance(items, list):
+                is_list_response = True
+
+                dto.extend(model.model_validate(object_) for object_ in items)
+            else:
+                dto.append(model.model_validate(items))
 
         return cls(
-            status_code=response.status_code,
-            body=response.body,
-            headers=response.headers,
-            requests_response=response.requests_response,
-            dto=dto,
+            requests_responses=[r.requests_response for r in responses],
+            dto=dto if is_list_response else dto[0],
         )

{python3_core_api_client-5.0 → python3_core_api_client-6.0.1}/src/cyberfusion/CoreApiClient/resources/basic_authentication_realms.py

@@ -17,27 +17,21 @@ class BasicAuthenticationRealms(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(
+        return DtoResponse.from_responses(
             local_response, models.BasicAuthenticationRealmResource
         )
 
     def list_basic_authentication_realms(
         self,
         *,
-        page: int = 1,
-        per_page: int = 50,
         include_filters: models.BasicAuthenticationRealmsSearchRequest | None = None,
         includes: list[str] | None = None,
     ) -> DtoResponse[list[models.BasicAuthenticationRealmResource]]:
-        local_response = self.api_connector.send_or_fail(
+        local_responses = self.api_connector.send_or_fail_with_auto_pagination(
             "GET",
             "/api/v1/basic-authentication-realms",
             data=None,
-            query_parameters={
-                "page": page,
-                "per_page": per_page,
-            }
-            | (
+            query_parameters=(
                 include_filters.model_dump(exclude_unset=True)
                 if include_filters
                 else {}
@@ -45,8 +39,8 @@ class BasicAuthenticationRealms(Resource):
             | construct_includes_query_parameter(includes),
         )
 
-        return DtoResponse.from_response(
-            local_response, models.BasicAuthenticationRealmResource
+        return DtoResponse.from_responses(
+            local_responses, models.BasicAuthenticationRealmResource
         )
 
     def read_basic_authentication_realm(
@@ -62,7 +56,7 @@ class BasicAuthenticationRealms(Resource):
             query_parameters=construct_includes_query_parameter(includes),
         )
 
-        return DtoResponse.from_response(
+        return DtoResponse.from_responses(
             local_response,
             models.BasicAuthenticationRealmResource,
         )
@@ -80,7 +74,7 @@ class BasicAuthenticationRealms(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(
+        return DtoResponse.from_responses(
             local_response, models.BasicAuthenticationRealmResource
         )
 
@@ -96,4 +90,4 @@ class BasicAuthenticationRealms(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(local_response, models.DetailMessage)
+        return DtoResponse.from_responses(local_response, models.DetailMessage)

{python3_core_api_client-5.0 → python3_core_api_client-6.0.1}/src/cyberfusion/CoreApiClient/resources/borg_archives.py

@@ -22,25 +22,19 @@ class BorgArchives(Resource):
             },
         )
 
-        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+        return DtoResponse.from_responses(local_response, models.TaskCollectionResource)
 
     def list_borg_archives(
         self,
         *,
-        page: int = 1,
-        per_page: int = 50,
         include_filters: models.BorgArchivesSearchRequest | None = None,
         includes: list[str] | None = None,
     ) -> DtoResponse[list[models.BorgArchiveResource]]:
-        local_response = self.api_connector.send_or_fail(
+        local_responses = self.api_connector.send_or_fail_with_auto_pagination(
             "GET",
             "/api/v1/borg-archives",
             data=None,
-            query_parameters={
-                "page": page,
-                "per_page": per_page,
-            }
-            | (
+            query_parameters=(
                 include_filters.model_dump(exclude_unset=True)
                 if include_filters
                 else {}
@@ -48,7 +42,7 @@ class BorgArchives(Resource):
             | construct_includes_query_parameter(includes),
         )
 
-        return DtoResponse.from_response(local_response, models.BorgArchiveResource)
+        return DtoResponse.from_responses(local_responses, models.BorgArchiveResource)
 
     def read_borg_archive(
         self,
@@ -63,7 +57,7 @@ class BorgArchives(Resource):
             query_parameters=construct_includes_query_parameter(includes),
         )
 
-        return DtoResponse.from_response(local_response, models.BorgArchiveResource)
+        return DtoResponse.from_responses(local_response, models.BorgArchiveResource)
 
     def get_borg_archive_metadata(
         self,
@@ -77,7 +71,7 @@ class BorgArchives(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(local_response, models.BorgArchiveMetadata)
+        return DtoResponse.from_responses(local_response, models.BorgArchiveMetadata)
 
     def restore_borg_archive(
         self,
@@ -96,7 +90,7 @@ class BorgArchives(Resource):
             },
         )
 
-        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+        return DtoResponse.from_responses(local_response, models.TaskCollectionResource)
 
     def list_borg_archive_contents(
         self,
@@ -113,7 +107,7 @@ class BorgArchives(Resource):
             },
         )
 
-        return DtoResponse.from_response(local_response, models.BorgArchiveContent)
+        return DtoResponse.from_responses(local_response, models.BorgArchiveContent)
 
     def download_borg_archive(
         self,
@@ -132,4 +126,4 @@ class BorgArchives(Resource):
             },
         )
 
-        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+        return DtoResponse.from_responses(local_response, models.TaskCollectionResource)

{python3_core_api_client-5.0 → python3_core_api_client-6.0.1}/src/cyberfusion/CoreApiClient/resources/borg_repositories.py

@@ -18,25 +18,19 @@ class BorgRepositories(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(local_response, models.BorgRepositoryResource)
+        return DtoResponse.from_responses(local_response, models.BorgRepositoryResource)
 
     def list_borg_repositories(
         self,
         *,
-        page: int = 1,
-        per_page: int = 50,
         include_filters: models.BorgRepositoriesSearchRequest | None = None,
         includes: list[str] | None = None,
     ) -> DtoResponse[list[models.BorgRepositoryResource]]:
-        local_response = self.api_connector.send_or_fail(
+        local_responses = self.api_connector.send_or_fail_with_auto_pagination(
             "GET",
             "/api/v1/borg-repositories",
             data=None,
-            query_parameters={
-                "page": page,
-                "per_page": per_page,
-            }
-            | (
+            query_parameters=(
                 include_filters.model_dump(exclude_unset=True)
                 if include_filters
                 else {}
@@ -44,7 +38,9 @@ class BorgRepositories(Resource):
             | construct_includes_query_parameter(includes),
         )
 
-        return DtoResponse.from_response(local_response, models.BorgRepositoryResource)
+        return DtoResponse.from_responses(
+            local_responses, models.BorgRepositoryResource
+        )
 
     def read_borg_repository(
         self,
@@ -59,7 +55,7 @@ class BorgRepositories(Resource):
             query_parameters=construct_includes_query_parameter(includes),
         )
 
-        return DtoResponse.from_response(local_response, models.BorgRepositoryResource)
+        return DtoResponse.from_responses(local_response, models.BorgRepositoryResource)
 
     def update_borg_repository(
         self,
@@ -74,7 +70,7 @@ class BorgRepositories(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(local_response, models.BorgRepositoryResource)
+        return DtoResponse.from_responses(local_response, models.BorgRepositoryResource)
 
     def delete_borg_repository(
         self,
@@ -88,7 +84,7 @@ class BorgRepositories(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(local_response, models.DetailMessage)
+        return DtoResponse.from_responses(local_response, models.DetailMessage)
 
     def prune_borg_repository(
         self,
@@ -105,7 +101,7 @@ class BorgRepositories(Resource):
             },
         )
 
-        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+        return DtoResponse.from_responses(local_response, models.TaskCollectionResource)
 
     def check_borg_repository(
         self,
@@ -122,7 +118,7 @@ class BorgRepositories(Resource):
             },
         )
 
-        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+        return DtoResponse.from_responses(local_response, models.TaskCollectionResource)
 
     def get_borg_archives_metadata(
         self,
@@ -136,4 +132,4 @@ class BorgRepositories(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(local_response, models.BorgArchiveMetadata)
+        return DtoResponse.from_responses(local_response, models.BorgArchiveMetadata)

{python3_core_api_client-5.0 → python3_core_api_client-6.0.1}/src/cyberfusion/CoreApiClient/resources/certificate_managers.py

@@ -17,27 +17,21 @@ class CertificateManagers(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(
+        return DtoResponse.from_responses(
             local_response, models.CertificateManagerResource
         )
 
     def list_certificate_managers(
         self,
         *,
-        page: int = 1,
-        per_page: int = 50,
         include_filters: models.CertificateManagersSearchRequest | None = None,
         includes: list[str] | None = None,
     ) -> DtoResponse[list[models.CertificateManagerResource]]:
-        local_response = self.api_connector.send_or_fail(
+        local_responses = self.api_connector.send_or_fail_with_auto_pagination(
             "GET",
             "/api/v1/certificate-managers",
             data=None,
-            query_parameters={
-                "page": page,
-                "per_page": per_page,
-            }
-            | (
+            query_parameters=(
                 include_filters.model_dump(exclude_unset=True)
                 if include_filters
                 else {}
@@ -45,8 +39,8 @@ class CertificateManagers(Resource):
             | construct_includes_query_parameter(includes),
         )
 
-        return DtoResponse.from_response(
-            local_response, models.CertificateManagerResource
+        return DtoResponse.from_responses(
+            local_responses, models.CertificateManagerResource
         )
 
     def read_certificate_manager(
@@ -62,7 +56,7 @@ class CertificateManagers(Resource):
             query_parameters=construct_includes_query_parameter(includes),
         )
 
-        return DtoResponse.from_response(
+        return DtoResponse.from_responses(
             local_response, models.CertificateManagerResource
         )
 
@@ -79,7 +73,7 @@ class CertificateManagers(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(
+        return DtoResponse.from_responses(
             local_response, models.CertificateManagerResource
         )
 
@@ -95,7 +89,7 @@ class CertificateManagers(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(local_response, models.DetailMessage)
+        return DtoResponse.from_responses(local_response, models.DetailMessage)
 
     def request_certificate(
         self,
@@ -109,4 +103,4 @@ class CertificateManagers(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(local_response, models.TaskCollectionResource)
+        return DtoResponse.from_responses(local_response, models.TaskCollectionResource)

{python3_core_api_client-5.0 → python3_core_api_client-6.0.1}/src/cyberfusion/CoreApiClient/resources/certificates.py

@@ -17,25 +17,19 @@ class Certificates(Resource):
             query_parameters={},
         )
 
-        return DtoResponse.from_response(local_response, models.CertificateResource)
+        return DtoResponse.from_responses(local_response, models.CertificateResource)
 
     def list_certificates(
         self,
         *,
-        page: int = 1,
-        per_page: int = 50,
         include_filters: models.CertificatesSearchRequest | None = None,
         includes: list[str] | None = None,
     ) -> DtoResponse[list[models.CertificateResource]]:
-        local_response = self.api_connector.send_or_fail(
+        local_responses = self.api_connector.send_or_fail_with_auto_pagination(
             "GET",
             "/api/v1/certificates",
             data=None,
-            query_parameters={
-                "page": page,
-                "per_page": per_page,
-            }
-            | (
+            query_parameters=(
                 include_filters.model_dump(exclude_unset=True)
                 if include_filters
                 else {}
@@ -43,7 +37,7 @@ class Certificates(Resource):
             | construct_includes_query_parameter(includes),
         )
 
-        return DtoResponse.from_response(local_response, models.CertificateResource)
+        return DtoResponse.from_responses(local_responses, models.CertificateResource)
 
     def read_certificate(
         self,
@@ -58,7 +52,7 @@ class Certificates(Resource):
             query_parameters=construct_includes_query_parameter(includes),
         )
 
-        return DtoResponse.from_response(local_response, models.CertificateResource)
+        return DtoResponse.from_responses(local_response, models.CertificateResource)
 
     def delete_certificate(
         self,
@@ -69,4 +63,4 @@ class Certificates(Resource):
             "DELETE", f"/api/v1/certificates/{id_}", data=None, query_parameters={}
         )
 
-        return DtoResponse.from_response(local_response, models.DetailMessage)
+        return DtoResponse.from_responses(local_response, models.DetailMessage)