python3-core-api-client 4.0__py3-none-any.whl → 6.0__py3-none-any.whl

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()
 

cyberfusion/CoreApiClient/http.py

@@ -32,20 +32,28 @@ 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 = []
+
+        for response in responses:
+            items = response.json
+
+            if isinstance(items, list):
+                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,
+            requests_responses=[r.requests_response for r in responses],
             dto=dto,
         )

cyberfusion/CoreApiClient/models.py

@@ -287,7 +287,7 @@ class CronCreateRequest(BaseCoreApiModel):
     node_id: Optional[int]
     name: constr(pattern=r"^[a-z0-9-_]+$", min_length=1, max_length=64)
     unix_user_id: int
-    command: constr(pattern=r"^[ -~]+$", min_length=1, max_length=65535)
+    command: constr(pattern=r"^[!-~](?:[ -~]*[!-~])?$", min_length=1, max_length=65535)
     email_address: Optional[EmailStr]
     schedule: str
     error_count: int = 1
@@ -300,9 +300,9 @@ class CronCreateRequest(BaseCoreApiModel):
 
 
 class CronUpdateRequest(BaseCoreApiModel):
-    command: Optional[constr(pattern=r"^[ -~]+$", min_length=1, max_length=65535)] = (
-        None
-    )
+    command: Optional[
+        constr(pattern=r"^[!-~](?:[ -~]*[!-~])?$", min_length=1, max_length=65535)
+    ] = None
     email_address: Optional[EmailStr] = None
     schedule: Optional[str] = None
     error_count: Optional[int] = None
@@ -322,6 +322,9 @@ class CustomConfigServerSoftwareNameEnum(StrEnum):
 class CustomConfigSnippetTemplateNameEnum(StrEnum):
     LARAVEL = "Laravel"
     COMPRESSION = "Compression"
+    BLITZ = "Blitz"
+    WORDPRESS = "WordPress"
+    CRAFT = "Craft"
 
 
 class CustomConfigSnippetUpdateRequest(BaseCoreApiModel):
@@ -364,16 +367,16 @@ class CustomerResource(BaseCoreApiModel):
 class DaemonCreateRequest(BaseCoreApiModel):
     name: constr(pattern=r"^[a-z0-9-_]+$", min_length=1, max_length=64)
     unix_user_id: int
-    command: constr(pattern=r"^[ -~]+$", min_length=1, max_length=65535)
+    command: constr(pattern=r"^[!-~](?:[ -~]*[!-~])?$", min_length=1, max_length=65535)
     nodes_ids: List[int]
     memory_limit: Optional[conint(ge=256)] = None
     cpu_limit: Optional[int] = None
 
 
 class DaemonUpdateRequest(BaseCoreApiModel):
-    command: Optional[constr(pattern=r"^[ -~]+$", min_length=1, max_length=65535)] = (
-        None
-    )
+    command: Optional[
+        constr(pattern=r"^[!-~](?:[ -~]*[!-~])?$", min_length=1, max_length=65535)
+    ] = None
     nodes_ids: Optional[List[int]] = None
     memory_limit: Optional[conint(ge=256)] = None
     cpu_limit: Optional[int] = None
@@ -557,6 +560,258 @@ class HttpRetryProperties(BaseCoreApiModel):
     conditions: List[HttpRetryConditionEnum]
 
 
+class Iso3166Alpha2CountryCodeEnum(StrEnum):
+    AF = "AF"
+    AX = "AX"
+    AL = "AL"
+    DZ = "DZ"
+    AS = "AS"
+    AD = "AD"
+    AO = "AO"
+    AI = "AI"
+    AQ = "AQ"
+    AG = "AG"
+    AR = "AR"
+    AM = "AM"
+    AW = "AW"
+    AU = "AU"
+    AT = "AT"
+    AZ = "AZ"
+    BS = "BS"
+    BH = "BH"
+    BD = "BD"
+    BB = "BB"
+    BY = "BY"
+    BE = "BE"
+    BZ = "BZ"
+    BJ = "BJ"
+    BM = "BM"
+    BT = "BT"
+    BO = "BO"
+    BQ = "BQ"
+    BA = "BA"
+    BW = "BW"
+    BV = "BV"
+    BR = "BR"
+    IO = "IO"
+    BN = "BN"
+    BG = "BG"
+    BF = "BF"
+    BI = "BI"
+    CV = "CV"
+    KH = "KH"
+    CM = "CM"
+    CA = "CA"
+    KY = "KY"
+    CF = "CF"
+    TD = "TD"
+    CL = "CL"
+    CN = "CN"
+    CX = "CX"
+    CC = "CC"
+    CO = "CO"
+    KM = "KM"
+    CG = "CG"
+    CD = "CD"
+    CK = "CK"
+    CR = "CR"
+    CI = "CI"
+    HR = "HR"
+    CU = "CU"
+    CW = "CW"
+    CY = "CY"
+    CZ = "CZ"
+    DK = "DK"
+    DJ = "DJ"
+    DM = "DM"
+    DO = "DO"
+    EC = "EC"
+    EG = "EG"
+    SV = "SV"
+    GQ = "GQ"
+    ER = "ER"
+    EE = "EE"
+    SZ = "SZ"
+    ET = "ET"
+    FK = "FK"
+    FO = "FO"
+    FJ = "FJ"
+    FI = "FI"
+    FR = "FR"
+    GF = "GF"
+    PF = "PF"
+    TF = "TF"
+    GA = "GA"
+    GM = "GM"
+    GE = "GE"
+    DE = "DE"
+    GH = "GH"
+    GI = "GI"
+    GR = "GR"
+    GL = "GL"
+    GD = "GD"
+    GP = "GP"
+    GU = "GU"
+    GT = "GT"
+    GG = "GG"
+    GN = "GN"
+    GW = "GW"
+    GY = "GY"
+    HT = "HT"
+    HM = "HM"
+    VA = "VA"
+    HN = "HN"
+    HK = "HK"
+    HU = "HU"
+    IS = "IS"
+    IN = "IN"
+    ID = "ID"
+    IR = "IR"
+    IQ = "IQ"
+    IE = "IE"
+    IM = "IM"
+    IL = "IL"
+    IT = "IT"
+    JM = "JM"
+    JP = "JP"
+    JE = "JE"
+    JO = "JO"
+    KZ = "KZ"
+    KE = "KE"
+    KI = "KI"
+    KP = "KP"
+    KR = "KR"
+    KW = "KW"
+    KG = "KG"
+    LA = "LA"
+    LV = "LV"
+    LB = "LB"
+    LS = "LS"
+    LR = "LR"
+    LY = "LY"
+    LI = "LI"
+    LT = "LT"
+    LU = "LU"
+    MO = "MO"
+    MG = "MG"
+    MW = "MW"
+    MY = "MY"
+    MV = "MV"
+    ML = "ML"
+    MT = "MT"
+    MH = "MH"
+    MQ = "MQ"
+    MR = "MR"
+    MU = "MU"
+    YT = "YT"
+    MX = "MX"
+    FM = "FM"
+    MD = "MD"
+    MC = "MC"
+    MN = "MN"
+    ME = "ME"
+    MS = "MS"
+    MA = "MA"
+    MZ = "MZ"
+    MM = "MM"
+    NA = "NA"
+    NR = "NR"
+    NP = "NP"
+    NL = "NL"
+    NC = "NC"
+    NZ = "NZ"
+    NI = "NI"
+    NE = "NE"
+    NG = "NG"
+    NU = "NU"
+    NF = "NF"
+    MK = "MK"
+    MP = "MP"
+    NO = "NO"
+    OM = "OM"
+    PK = "PK"
+    PW = "PW"
+    PS = "PS"
+    PA = "PA"
+    PG = "PG"
+    PY = "PY"
+    PE = "PE"
+    PH = "PH"
+    PN = "PN"
+    PL = "PL"
+    PT = "PT"
+    PR = "PR"
+    QA = "QA"
+    RE = "RE"
+    RO = "RO"
+    RU = "RU"
+    RW = "RW"
+    BL = "BL"
+    SH = "SH"
+    KN = "KN"
+    LC = "LC"
+    MF = "MF"
+    PM = "PM"
+    VC = "VC"
+    WS = "WS"
+    SM = "SM"
+    ST = "ST"
+    SA = "SA"
+    SN = "SN"
+    RS = "RS"
+    SC = "SC"
+    SL = "SL"
+    SG = "SG"
+    SX = "SX"
+    SK = "SK"
+    SI = "SI"
+    SB = "SB"
+    SO = "SO"
+    ZA = "ZA"
+    GS = "GS"
+    SS = "SS"
+    ES = "ES"
+    LK = "LK"
+    SD = "SD"
+    SR = "SR"
+    SJ = "SJ"
+    SE = "SE"
+    CH = "CH"
+    SY = "SY"
+    TW = "TW"
+    TJ = "TJ"
+    TZ = "TZ"
+    TH = "TH"
+    TL = "TL"
+    TG = "TG"
+    TK = "TK"
+    TO = "TO"
+    TT = "TT"
+    TN = "TN"
+    TR = "TR"
+    TM = "TM"
+    TC = "TC"
+    TV = "TV"
+    UG = "UG"
+    UA = "UA"
+    AE = "AE"
+    GB = "GB"
+    US = "US"
+    UM = "UM"
+    UY = "UY"
+    UZ = "UZ"
+    VU = "VU"
+    VE = "VE"
+    VN = "VN"
+    VG = "VG"
+    VI = "VI"
+    WF = "WF"
+    EH = "EH"
+    YE = "YE"
+    ZM = "ZM"
+    ZW = "ZW"
+
+
 class HealthStatusEnum(StrEnum):
     UP = "up"
     MAINTENANCE = "maintenance"
@@ -840,6 +1095,8 @@ class ObjectModelNameEnum(StrEnum):
     CLUSTERS_LOAD_BALANCING_PROPERTIES = "ClustersLoadBalancingProperties"
     CLUSTERS_FIREWALL_PROPERTIES = "ClustersFirewallProperties"
     CLUSTERS_OS_PROPERTIES = "ClustersOsProperties"
+    PROJECT = "Project"
+    PROJECT_ENVIRONMENT = "ProjectEnvironment"
 
 
 class PhpExtensionEnum(StrEnum):
@@ -991,7 +1248,9 @@ class SshKeyCreatePublicRequest(BaseCoreApiModel):
 
 
 class SecurityTxtPolicyCreateRequest(BaseCoreApiModel):
+    name: constr(pattern=r"^[a-zA-Z0-9-_ ]+$", min_length=1, max_length=32)
     cluster_id: int
+    is_default: bool
     expires_timestamp: datetime
     email_contacts: List[EmailStr]
     url_contacts: List[AnyUrl]
@@ -1013,6 +1272,8 @@ class SecurityTxtPolicyCreateRequest(BaseCoreApiModel):
 
 
 class SecurityTxtPolicyUpdateRequest(BaseCoreApiModel):
+    name: constr(pattern=r"^[a-zA-Z0-9-_ ]+$", min_length=1, max_length=32)
+    is_default: Optional[bool] = None
     expires_timestamp: Optional[datetime] = None
     email_contacts: Optional[List[EmailStr]] = None
     url_contacts: Optional[List[AnyUrl]] = None
@@ -1046,6 +1307,7 @@ class RegionIncludes(BaseCoreApiModel):
 class RegionResource(BaseCoreApiModel):
     id: int
     name: constr(pattern=r"^[A-Z0-9-]+$", min_length=1, max_length=32)
+    iso_3166_alpha_2_country_code: Iso3166Alpha2CountryCodeEnum
     includes: RegionIncludes
 
 
@@ -1211,6 +1473,7 @@ class VirtualHostServerSoftwareNameEnum(StrEnum):
 
 
 class VirtualHostUpdateRequest(BaseCoreApiModel):
+    domain: Optional[str] = None
     server_aliases: Optional[List[str]] = None
     document_root: Optional[str] = None
     fpm_pool_id: Optional[int] = None
@@ -1390,6 +1653,7 @@ class DatabaseResource(BaseCoreApiModel):
     optimizing_enabled: bool
     backups_enabled: bool
     deployment_status: DeploymentStatusEnum
+    project_environment_id: int | None
     includes: DatabaseIncludes
 
 
@@ -1632,6 +1896,7 @@ class RedisInstanceResource(BaseCoreApiModel):
     max_databases: int
     eviction_policy: RedisEvictionPolicyEnum
     deployment_status: DeploymentStatusEnum
+    project_environment_id: int | None
     includes: RedisInstanceIncludes
 
 
@@ -1660,6 +1925,8 @@ class SecurityTxtPolicyResource(BaseCoreApiModel):
     created_at: datetime
     updated_at: datetime
     cluster_id: int
+    name: constr(pattern=r"^[a-zA-Z0-9-_ ]+$", min_length=1, max_length=32)
+    is_default: bool
     expires_timestamp: datetime
     email_contacts: List[EmailStr]
     url_contacts: List[AnyUrl]
@@ -1685,6 +1952,7 @@ class TaskCollectionResource(BaseCoreApiModel):
     uuid: UUID4
     description: constr(pattern=r"^[ -~]+$", min_length=1, max_length=65535)
     collection_type: TaskCollectionTypeEnum
+    request_id: UUID4 | None
     cluster_id: Optional[int]
     reference: constr(pattern=r"^[a-zA-Z0-9-_ ]+$", min_length=1, max_length=255)
     includes: TaskCollectionIncludes
@@ -1838,7 +2106,7 @@ class CronResource(BaseCoreApiModel):
     node_id: int
     name: constr(pattern=r"^[a-z0-9-_]+$", min_length=1, max_length=64)
     unix_user_id: int
-    command: constr(pattern=r"^[ -~]+$", min_length=1, max_length=65535)
+    command: constr(pattern=r"^[!-~](?:[ -~]*[!-~])?$", min_length=1, max_length=65535)
     email_address: Optional[EmailStr]
     schedule: str
     error_count: int
@@ -1864,7 +2132,7 @@ class DaemonResource(BaseCoreApiModel):
     cluster_id: int
     name: constr(pattern=r"^[a-z0-9-_]+$", min_length=1, max_length=64)
     unix_user_id: int
-    command: constr(pattern=r"^[ -~]+$", min_length=1, max_length=65535)
+    command: constr(pattern=r"^[!-~](?:[ -~]*[!-~])?$", min_length=1, max_length=65535)
     nodes_ids: List[int]
     memory_limit: Optional[conint(ge=256)]
     cpu_limit: Optional[int]
@@ -2285,6 +2553,7 @@ class DomainRouterResource(BaseCoreApiModel):
     domain: str
     virtual_host_id: Optional[int]
     url_redirect_id: Optional[int]
+    n8n_instance_id: Optional[int]
     category: DomainRouterCategoryEnum
     cluster_id: int
     node_id: Optional[int]
@@ -2387,7 +2656,7 @@ class RequestLogResource(BaseCoreApiModel):
 
 
 class ObjectLogIncludes(BaseCoreApiModel):
-    customer: Optional[CustomerResource]
+    pass
 
 
 class ObjectLogResource(BaseCoreApiModel):
@@ -3012,6 +3281,7 @@ class SpecificationNameEnum(StrEnum):
     CLUSTER_SUPPORTS_UNIX_USER_BORG_REPOSITORIES = (
         "Cluster supports UNIX user Borg repositories"
     )
+    CLUSTER_SUPPORTS_PROJECTS = "Cluster supports projects"
 
 
 class TableInnodbDataLengths(BaseCoreApiModel):
@@ -3209,6 +3479,7 @@ class DomainRoutersSearchRequest(BaseCoreApiModel):
     domain: Optional[str] = None
     virtual_host_id: Optional[int] = None
     url_redirect_id: Optional[int] = None
+    n8n_instance_id: Optional[int] = None
     category: Optional[DomainRouterCategoryEnum] = None
     cluster_id: Optional[int] = None
     node_id: Optional[int] = None
@@ -3348,6 +3619,7 @@ class N8nInstanceResource(BaseCoreApiModel):
     domain: str
     name: constr(pattern=r"^[a-z0-9-_]+$", min_length=1, max_length=64)
     cluster_id: int
+    deployment_status: DeploymentStatusEnum
     includes: N8nInstanceIncludes
 
 
@@ -3360,6 +3632,7 @@ class RedisInstancesSearchRequest(BaseCoreApiModel):
 
 class RegionsSearchRequest(BaseCoreApiModel):
     name: Optional[str] = None
+    iso_3166_alpha_2_country_code: Iso3166Alpha2CountryCodeEnum | None = None
 
 
 class RequestLogsSearchRequest(BaseCoreApiModel):

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)

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)