stackit-serverbackup 0.0.1a0__py3-none-any.whl

stackit/serverbackup/models/get_backups_list_response.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    STACKIT Server Backup Management API
+
+    API endpoints for Server Backup Operations on STACKIT Servers.
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict
+from typing_extensions import Self
+
+from stackit.serverbackup.models.backup import Backup
+
+
+class GetBackupsListResponse(BaseModel):
+    """
+    GetBackupsListResponse
+    """
+
+    items: Optional[List[Backup]] = None
+    __properties: ClassVar[List[str]] = ["items"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GetBackupsListResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in items (list)
+        _items = []
+        if self.items:
+            for _item in self.items:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["items"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetBackupsListResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"items": [Backup.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None}
+        )
+        return _obj

stackit/serverbackup/models/restore_backup_payload.py

@@ -0,0 +1,85 @@
+# coding: utf-8
+
+"""
+    STACKIT Server Backup Management API
+
+    API endpoints for Server Backup Operations on STACKIT Servers.
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing_extensions import Self
+
+
+class RestoreBackupPayload(BaseModel):
+    """
+    RestoreBackupPayload
+    """
+
+    start_server_after_restore: StrictBool = Field(alias="startServerAfterRestore")
+    volume_ids: Optional[List[StrictStr]] = Field(default=None, alias="volumeIds")
+    __properties: ClassVar[List[str]] = ["startServerAfterRestore", "volumeIds"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RestoreBackupPayload from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RestoreBackupPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"startServerAfterRestore": obj.get("startServerAfterRestore"), "volumeIds": obj.get("volumeIds")}
+        )
+        return _obj

stackit/serverbackup/models/restore_volume_backup_payload.py

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+    STACKIT Server Backup Management API
+
+    API endpoints for Server Backup Operations on STACKIT Servers.
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing_extensions import Self
+
+
+class RestoreVolumeBackupPayload(BaseModel):
+    """
+    RestoreVolumeBackupPayload
+    """
+
+    restore_volume_id: StrictStr = Field(alias="restoreVolumeId")
+    __properties: ClassVar[List[str]] = ["restoreVolumeId"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RestoreVolumeBackupPayload from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RestoreVolumeBackupPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"restoreVolumeId": obj.get("restoreVolumeId")})
+        return _obj

stackit/serverbackup/models/update_backup_schedule_payload.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+
+"""
+    STACKIT Server Backup Management API
+
+    API endpoints for Server Backup Operations on STACKIT Servers.
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing_extensions import Self
+
+from stackit.serverbackup.models.backup_properties import BackupProperties
+
+
+class UpdateBackupSchedulePayload(BaseModel):
+    """
+    UpdateBackupSchedulePayload
+    """
+
+    backup_properties: Optional[BackupProperties] = Field(default=None, alias="backupProperties")
+    enabled: StrictBool
+    name: StrictStr = Field(description="Max 255 characters")
+    rrule: StrictStr
+    __properties: ClassVar[List[str]] = ["backupProperties", "enabled", "name", "rrule"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of UpdateBackupSchedulePayload from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of backup_properties
+        if self.backup_properties:
+            _dict["backupProperties"] = self.backup_properties.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateBackupSchedulePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "backupProperties": (
+                    BackupProperties.from_dict(obj["backupProperties"])
+                    if obj.get("backupProperties") is not None
+                    else None
+                ),
+                "enabled": obj.get("enabled"),
+                "name": obj.get("name"),
+                "rrule": obj.get("rrule"),
+            }
+        )
+        return _obj

stackit/serverbackup/rest.py

@@ -0,0 +1,149 @@
+# coding: utf-8
+
+"""
+    STACKIT Server Backup Management API
+
+    API endpoints for Server Backup Operations on STACKIT Servers.
+
+    The version of the OpenAPI document: 1.0
+    Contact: support@stackit.de
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+import io
+import json
+import re
+
+import requests
+from stackit.core.authorization import Authorization
+from stackit.core.configuration import Configuration
+
+from stackit.serverbackup.exceptions import ApiException, ApiValueError
+
+
+RESTResponseType = requests.Response
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status_code
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.content
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+    def __init__(self, config: Configuration) -> None:
+        self.session = config.custom_http_session if config.custom_http_session else requests.Session()
+        authorization = Authorization(config)
+        self.session.auth = authorization.auth_method
+
+    def request(self, method, url, headers=None, body=None, post_params=None, _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        if method not in ["GET", "HEAD", "DELETE", "POST", "PUT", "PATCH", "OPTIONS"]:
+            raise ValueError("Method %s not allowed", method)
+
+        if post_params and body:
+            raise ApiValueError("body parameter cannot be used with post_params parameter.")
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ["POST", "PUT", "PATCH", "OPTIONS", "DELETE"]:
+
+                # no content type provided or payload is json
+                content_type = headers.get("Content-Type")
+                if not content_type or re.search("json", content_type, re.IGNORECASE):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=request_body,
+                        headers=headers,
+                    )
+                elif content_type == "application/x-www-form-urlencoded":
+                    r = self.session.request(
+                        method,
+                        url,
+                        params=post_params,
+                        headers=headers,
+                    )
+                elif content_type == "multipart/form-data":
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers["Content-Type"]
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a, b) for a, b in post_params]
+                    r = self.session.request(
+                        method,
+                        url,
+                        files=post_params,
+                        headers=headers,
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=body,
+                        headers=headers,
+                    )
+                elif headers["Content-Type"] == "text/plain" and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.session.request(method, url, data=request_body, headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.session.request(
+                    method,
+                    url,
+                    params={},
+                    headers=headers,
+                )
+        except requests.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

stackit_serverbackup-0.0.1a0.dist-info/METADATA

@@ -0,0 +1,44 @@
+Metadata-Version: 2.1
+Name: stackit-serverbackup
+Version: 0.0.1a0
+Summary: STACKIT Server Backup Management API
+Author: STACKIT Developer Tools
+Author-email: developer-tools@stackit.cloud
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pydantic (>=2.9.2)
+Requires-Dist: python-dateutil (>=2.9.0.post0)
+Requires-Dist: requests (>=2.32.3)
+Requires-Dist: stackit-core (>=0.0.1a)
+Description-Content-Type: text/markdown
+
+# stackit.serverbackup
+API endpoints for Server Backup Operations on STACKIT Servers.
+
+
+This package is part of the STACKIT Python SDK. For additional information, please visit the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK.
+
+
+## Installation & Usage
+### pip install
+
+```sh
+pip install stackit-serverbackup
+```
+
+Then import the package:
+```python
+import stackit.serverbackup
+```
+
+## Getting Started
+
+[Examples](https://github.com/stackitcloud/stackit-sdk-python/tree/main/examples) for the usage of the package can be found in the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK.

stackit_serverbackup-0.0.1a0.dist-info/RECORD

@@ -0,0 +1,27 @@
+stackit/serverbackup/__init__.py,sha256=flLO2FX-BS47IIBeWOI6vquCnaMsiXvtJWy3cYwdAEY,2127
+stackit/serverbackup/api/__init__.py,sha256=4gnwP89FX1nQYLr9Mg7TDzyxbWvl2JNyavFrb9moimM,107
+stackit/serverbackup/api/default_api.py,sha256=JW4ZaKpmx2TPwu0pTD_SpdWqSxkTg9NvjEHtBjNGsU4,183191
+stackit/serverbackup/api_client.py,sha256=JSxSMcTubxw69Nbk-mucWm1HRjg2oTkdZgz1fqM_cJs,22755
+stackit/serverbackup/api_response.py,sha256=HRYkVqMNIlfODacTQPTbiVj2YdcnutpQrKJdeAoCSpM,642
+stackit/serverbackup/configuration.py,sha256=isWE7YCCuRSuHSw6EL4YOryiL94zGYxpIEgtc-JBWnA,3877
+stackit/serverbackup/exceptions.py,sha256=vjtVdAr-XQTib-d5nUzxA4MHYVghrEZgbUkMQvHwcQg,5964
+stackit/serverbackup/models/__init__.py,sha256=VRbDIeY0XdFYkddneiRjFaDLjvP43pW2u72WG0WZK_4,1651
+stackit/serverbackup/models/backup.py,sha256=KqI1erxHPFUuC85j79y3cdgaHu_6oxUdZb6UJXQdnMU,4655
+stackit/serverbackup/models/backup_job.py,sha256=tSAX7wYFIkFCCO3nm27Mmm5cRtih9RPJCIuOjHignKw,2400
+stackit/serverbackup/models/backup_properties.py,sha256=HrHAzvRx26IKYjgwMgTMFWzdtS-D9NdQ84LTVAJVxgw,2883
+stackit/serverbackup/models/backup_schedule.py,sha256=1SKnNIoK4JCv3JgPAJgpzveiFTjYy-qsq8WKQBZS6NY,3347
+stackit/serverbackup/models/backup_volume_backups_inner.py,sha256=HV593d7EXru7DqqBYyIQIP6wBjT24xiD894ZCYnsy2M,3759
+stackit/serverbackup/models/create_backup_payload.py,sha256=wLj0B-1qFkvbSpMFTvnEDlOgWYEvbIfSXPUSoQyoXFo,2895
+stackit/serverbackup/models/create_backup_schedule_payload.py,sha256=fDAFCwe_K8rh3WG-pHCG1QXVcKnXmZMyPZzLuaHb3sc,3369
+stackit/serverbackup/models/enable_service_payload.py,sha256=y8G95msb_-5JQBWk_cKonoX-RCDvHuShUP8_nGOLe8U,2557
+stackit/serverbackup/models/enable_service_resource_payload.py,sha256=43PUWZoy3d8Ab2cbVWVQCkxF0Jo3T2HJe5_7YljDvX0,2589
+stackit/serverbackup/models/get_backup_schedules_response.py,sha256=vNnmc4WQlXln4XqLt8_vWiwuF27M4M7VFGcCEpl02GI,3083
+stackit/serverbackup/models/get_backups_list_response.py,sha256=ydULDd-a02ujqp-Fe8Cp5ERowoyRHAbSV_GuOfZAcFw,2924
+stackit/serverbackup/models/restore_backup_payload.py,sha256=G-Lvabd0GPlzf8D7sakVrvuNx4gDMgILRLirGW_6aEg,2745
+stackit/serverbackup/models/restore_volume_backup_payload.py,sha256=NSo9b4kx0k4XswnWc1uo4tGTxhJ2qLE79RGnNyJm84M,2562
+stackit/serverbackup/models/update_backup_schedule_payload.py,sha256=C8hsXbzIcGwBir8Xe2TKcOtILRROVSQvSX17i7QhkcY,3369
+stackit/serverbackup/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+stackit/serverbackup/rest.py,sha256=1cYtCnzhaaof-FrtXBjvL0Z01DydPjCvdjaYbDTfn9M,5849
+stackit_serverbackup-0.0.1a0.dist-info/METADATA,sha256=3x_pPg61wsseZsqvzZgmcqL1FGvkliKXO9LcO_mAwO4,1529
+stackit_serverbackup-0.0.1a0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+stackit_serverbackup-0.0.1a0.dist-info/RECORD,,

stackit_serverbackup-0.0.1a0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any