stackit-automation 0.1.0__py3-none-any.whl

stackit/automation/models/volume_output.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+STACKIT Automation Service API
+
+API endpoints for automation management .
+
+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
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict
+from pydantic_core import to_jsonable_python
+from typing_extensions import Self
+
+from stackit.automation.models.volume_output_step import VolumeOutputStep
+
+
+class VolumeOutput(BaseModel):
+    """
+    VolumeOutput
+    """  # noqa: E501
+
+    steps: Optional[List[VolumeOutputStep]] = None
+    __properties: ClassVar[List[str]] = ["steps"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VolumeOutput 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 steps (list)
+        _items = []
+        if self.steps:
+            for _item_steps in self.steps:
+                if _item_steps:
+                    _items.append(_item_steps.to_dict())
+            _dict["steps"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VolumeOutput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "steps": (
+                    [VolumeOutputStep.from_dict(_item) for _item in obj["steps"]]
+                    if obj.get("steps") is not None
+                    else None
+                )
+            }
+        )
+        return _obj

stackit/automation/models/volume_output_step.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+STACKIT Automation Service API
+
+API endpoints for automation management .
+
+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
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic_core import to_jsonable_python
+from typing_extensions import Self
+
+from stackit.automation.models.volume_output_step_result import VolumeOutputStepResult
+
+
+class VolumeOutputStep(BaseModel):
+    """
+    VolumeOutputStep
+    """  # noqa: E501
+
+    name: StrictStr
+    result: Optional[VolumeOutputStepResult] = None
+    __properties: ClassVar[List[str]] = ["name", "result"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VolumeOutputStep 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 result
+        if self.result:
+            _dict["result"] = self.result.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VolumeOutputStep from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "name": obj.get("name"),
+                "result": VolumeOutputStepResult.from_dict(obj["result"]) if obj.get("result") is not None else None,
+            }
+        )
+        return _obj

stackit/automation/models/volume_output_step_result.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+STACKIT Automation Service API
+
+API endpoints for automation management .
+
+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
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic_core import to_jsonable_python
+from typing_extensions import Self
+
+
+class VolumeOutputStepResult(BaseModel):
+    """
+    VolumeOutputStepResult
+    """  # noqa: E501
+
+    kind: StrictStr
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["kind"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VolumeOutputStepResult 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VolumeOutputStepResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"kind": obj.get("kind")})
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

stackit/automation/models/volume_recovery_point_management_input.py

@@ -0,0 +1,118 @@
+# coding: utf-8
+
+"""
+STACKIT Automation Service API
+
+API endpoints for automation management .
+
+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
+
+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 pydantic_core import to_jsonable_python
+from typing_extensions import Self
+
+from stackit.automation.models.snapshot_retention_policy import SnapshotRetentionPolicy
+
+
+class VolumeRecoveryPointManagementInput(BaseModel):
+    """
+    VolumeRecoveryPointManagementInput
+    """  # noqa: E501
+
+    inherit_volume_labels: Optional[StrictBool] = Field(default=False, alias="inheritVolumeLabels")
+    kind: StrictStr
+    recovery_point_labels: Optional[Dict[str, StrictStr]] = Field(default=None, alias="recoveryPointLabels")
+    snapshot_retention_policy: SnapshotRetentionPolicy = Field(alias="snapshotRetentionPolicy")
+    volume_label_selector: Optional[StrictStr] = Field(default=None, alias="volumeLabelSelector")
+    __properties: ClassVar[List[str]] = [
+        "inheritVolumeLabels",
+        "kind",
+        "recoveryPointLabels",
+        "snapshotRetentionPolicy",
+        "volumeLabelSelector",
+    ]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VolumeRecoveryPointManagementInput 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 snapshot_retention_policy
+        if self.snapshot_retention_policy:
+            _dict["snapshotRetentionPolicy"] = self.snapshot_retention_policy.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VolumeRecoveryPointManagementInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "inheritVolumeLabels": (
+                    obj.get("inheritVolumeLabels") if obj.get("inheritVolumeLabels") is not None else False
+                ),
+                "kind": obj.get("kind"),
+                "recoveryPointLabels": obj.get("recoveryPointLabels"),
+                "snapshotRetentionPolicy": (
+                    SnapshotRetentionPolicy.from_dict(obj["snapshotRetentionPolicy"])
+                    if obj.get("snapshotRetentionPolicy") is not None
+                    else None
+                ),
+                "volumeLabelSelector": obj.get("volumeLabelSelector"),
+            }
+        )
+        return _obj

stackit/automation/models/volume_template_automation_input.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+STACKIT Automation Service API
+
+API endpoints for automation management .
+
+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
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from pydantic_core import to_jsonable_python
+from typing_extensions import Self
+
+
+class VolumeTemplateAutomationInput(BaseModel):
+    """
+    VolumeTemplateAutomationInput
+    """  # noqa: E501
+
+    kind: StrictStr
+    __properties: ClassVar[List[str]] = ["kind"]
+
+    @field_validator("kind")
+    def kind_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["VolumeRecoveryPointManagement"]):
+            raise ValueError("must be one of enum values ('VolumeRecoveryPointManagement')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VolumeTemplateAutomationInput 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 VolumeTemplateAutomationInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"kind": obj.get("kind")})
+        return _obj

stackit/automation/rest.py

@@ -0,0 +1,164 @@
+# coding: utf-8
+
+"""
+STACKIT Automation Service API
+
+API endpoints for automation management .
+
+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
+
+import io
+import json
+import re
+
+import requests
+from stackit.core.authorization import Authorization
+from stackit.core.configuration import Configuration
+
+from stackit.automation.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
+
+    @property
+    def headers(self):
+        """Returns a dictionary of response headers."""
+        return self.response.headers
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers; use ``headers`` instead."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header; use ``headers.get()`` instead."""
+        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,
+                        timeout=_request_timeout,
+                    )
+                elif content_type == "application/x-www-form-urlencoded":
+                    r = self.session.request(
+                        method,
+                        url,
+                        params=post_params,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                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,
+                        timeout=_request_timeout,
+                    )
+                # 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,
+                        timeout=_request_timeout,
+                    )
+                elif headers["Content-Type"].startswith("text/") and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=request_body,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                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,
+                    timeout=_request_timeout,
+                )
+        except requests.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)