stackit-automation 0.1.0__py3-none-any.whl

stackit/automation/configuration.py

@@ -0,0 +1,163 @@
+# 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 sys
+from typing import Dict, List, Optional, TypedDict
+
+from typing_extensions import NotRequired
+
+import os
+
+ServerVariablesT = Dict[str, str]
+
+
+class HostSettingVariable(TypedDict):
+    description: str
+    default_value: str
+    enum_values: List[str]
+
+
+class HostSetting(TypedDict):
+    url: str
+    description: str
+    variables: NotRequired[Dict[str, HostSettingVariable]]
+
+
+class HostConfiguration:
+    def __init__(
+        self,
+        region=None,
+        server_index=None,
+        server_variables=None,
+        server_operation_index=None,
+        server_operation_variables=None,
+        ignore_operation_servers=False,
+    ) -> None:
+        print(
+            "WARNING: STACKIT will move to a new way of specifying regions, where the region is provided\n",
+            "as a function argument instead of being set in the client configuration.\n"
+            "Once all services have migrated, the methods to specify the region in the client configuration "
+            "will be removed.",
+            file=sys.stderr,
+        )
+        """Constructor
+        """
+        self._base_path = "https://automation-service.api.stackit.cloud"
+        """Default Base url
+        """
+        self.server_index = 0 if server_index is None else server_index
+        self.server_operation_index = server_operation_index or {}
+        """Default server index
+        """
+        self.server_variables = server_variables or {}
+        if region:
+            self.server_variables["region"] = "{}.".format(region)
+        self.server_operation_variables = server_operation_variables or {}
+        """Default server variables
+        """
+        self.ignore_operation_servers = ignore_operation_servers
+        """Ignore operation servers
+        """
+
+    def get_host_settings(self) -> List[HostSetting]:
+        """Gets an array of host settings
+
+        :return: An array of host settings
+        """
+        return [
+            {
+                "url": "https://automation-service.api.stackit.cloud",
+                "description": "No description provided",
+                "variables": {
+                    "region": {
+                        "description": "No description provided",
+                        "default_value": "global",
+                    }
+                },
+            }
+        ]
+
+    def get_host_from_settings(
+        self,
+        index: Optional[int],
+        variables: Optional[ServerVariablesT] = None,
+        servers: Optional[List[HostSetting]] = None,
+    ) -> str:
+        """Gets host URL based on the index and variables
+        :param index: array index of the host settings
+        :param variables: hash of variable and the corresponding value
+        :param servers: an array of host settings or None
+        :error: if a region is given for a global url
+        :return: URL based on host settings
+        """
+        if index is None:
+            return self._base_path
+
+        variables = {} if variables is None else variables
+        servers = self.get_host_settings() if servers is None else servers
+
+        try:
+            server = servers[index]
+        except IndexError:
+            raise ValueError(
+                "Invalid index {0} when selecting the host settings. "
+                "Must be less than {1}".format(index, len(servers))
+            )
+
+        url = server["url"]
+
+        # check if environment variable was provided for region
+        # if nothing was set this is None
+        region_env = os.environ.get("STACKIT_REGION")
+
+        # go through variables and replace placeholders
+        for variable_name, variable in server.get("variables", {}).items():
+            # If a region is provided by the user for a global url
+            # return an error (except for providing via environment variable).
+            # The region is provided as a function argument instead of being set in the client configuration.
+            if (
+                variable_name == "region"
+                and (variable["default_value"] == "global" or variable["default_value"] == "")
+                and region_env is None
+                and variables.get(variable_name) is not None
+            ):
+                raise ValueError(
+                    "this API does not support setting a region in the client configuration, "
+                    "please check if the region can be specified as a function parameter"
+                )
+            used_value = variables.get(variable_name, variable["default_value"])
+
+            if "enum_values" in variable and used_value not in variable["enum_values"]:
+                given_value = variables[variable_name].replace(".", "")
+                valid_values = [v.replace(".", "") for v in variable["enum_values"]]
+                raise ValueError(
+                    "The variable `{0}` in the host URL has invalid value '{1}'. Must be '{2}'.".format(
+                        variable_name, given_value, valid_values
+                    )
+                )
+
+            url = url.replace("{" + variable_name + "}", used_value)
+
+        return url
+
+    @property
+    def host(self) -> str:
+        """Return generated host."""
+        return self.get_host_from_settings(self.server_index, variables=self.server_variables)
+
+    @host.setter
+    def host(self, value: str) -> None:
+        """Fix base path."""
+        self._base_path = value
+        self.server_index = None

stackit/automation/exceptions.py

@@ -0,0 +1,218 @@
+# 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 typing import Any, Optional
+
+from typing_extensions import Self
+
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None, key_type=None) -> None:
+        """Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self,
+        status=None,
+        reason=None,
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode("utf-8")
+                except Exception:  # noqa: S110
+                    pass
+            self.headers = http_resp.headers
+
+    @classmethod
+    def from_response(
+        cls,
+        *,
+        http_resp,
+        body: Optional[str],
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n" "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(self.headers)
+
+        if self.data or self.body:
+            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

stackit/automation/models/__init__.py

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+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 models into model package
+from stackit.automation.models.automation_schedule_trigger import (
+    AutomationScheduleTrigger,
+)
+from stackit.automation.models.automation_triggers import AutomationTriggers
+from stackit.automation.models.create_snapshots_result import CreateSnapshotsResult
+from stackit.automation.models.create_volume_automation_payload import (
+    CreateVolumeAutomationPayload,
+)
+from stackit.automation.models.error_info_detail import ErrorInfoDetail
+from stackit.automation.models.error_response import ErrorResponse
+from stackit.automation.models.error_response_content import ErrorResponseContent
+from stackit.automation.models.error_response_content_details import (
+    ErrorResponseContentDetails,
+)
+from stackit.automation.models.event_create_response import EventCreateResponse
+from stackit.automation.models.get_volume_ids_result import GetVolumeIDsResult
+from stackit.automation.models.get_volume_template_response import (
+    GetVolumeTemplateResponse,
+)
+from stackit.automation.models.help_error_detail import HelpErrorDetail
+from stackit.automation.models.list_automations_item import ListAutomationsItem
+from stackit.automation.models.list_automations_response import ListAutomationsResponse
+from stackit.automation.models.list_executions_item import ListExecutionsItem
+from stackit.automation.models.list_executions_response import ListExecutionsResponse
+from stackit.automation.models.list_templates_response import ListTemplatesResponse
+from stackit.automation.models.localized_message_error_detail import (
+    LocalizedMessageErrorDetail,
+)
+from stackit.automation.models.partial_update_volume_automation_payload import (
+    PartialUpdateVolumeAutomationPayload,
+)
+from stackit.automation.models.schedule import Schedule
+from stackit.automation.models.schedule_details import ScheduleDetails
+from stackit.automation.models.schedule_patch_request import SchedulePatchRequest
+from stackit.automation.models.schedule_request import ScheduleRequest
+from stackit.automation.models.snapshot_retention_policy import SnapshotRetentionPolicy
+from stackit.automation.models.template import Template
+from stackit.automation.models.volume_automation import VolumeAutomation
+from stackit.automation.models.volume_automation_input import VolumeAutomationInput
+from stackit.automation.models.volume_execution_automation import (
+    VolumeExecutionAutomation,
+)
+from stackit.automation.models.volume_execution_details import VolumeExecutionDetails
+from stackit.automation.models.volume_execution_output import VolumeExecutionOutput
+from stackit.automation.models.volume_execution_output_step import (
+    VolumeExecutionOutputStep,
+)
+from stackit.automation.models.volume_execution_response import VolumeExecutionResponse
+from stackit.automation.models.volume_output import VolumeOutput
+from stackit.automation.models.volume_output_step import VolumeOutputStep
+from stackit.automation.models.volume_output_step_result import VolumeOutputStepResult
+from stackit.automation.models.volume_recovery_point_management_input import (
+    VolumeRecoveryPointManagementInput,
+)
+from stackit.automation.models.volume_template_automation_input import (
+    VolumeTemplateAutomationInput,
+)

stackit/automation/models/automation_schedule_trigger.py

@@ -0,0 +1,85 @@
+# 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, StrictStr
+from pydantic_core import to_jsonable_python
+from typing_extensions import Self
+
+
+class AutomationScheduleTrigger(BaseModel):
+    """
+    AutomationScheduleTrigger
+    """  # noqa: E501
+
+    rrule: StrictStr = Field(
+        description="An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates"
+    )
+    __properties: ClassVar[List[str]] = ["rrule"]
+
+    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 AutomationScheduleTrigger 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 AutomationScheduleTrigger from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"rrule": obj.get("rrule")})
+        return _obj

stackit/automation/models/automation_triggers.py

@@ -0,0 +1,101 @@
+# 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.automation_schedule_trigger import (
+    AutomationScheduleTrigger,
+)
+
+
+class AutomationTriggers(BaseModel):
+    """
+    AutomationTriggers
+    """  # noqa: E501
+
+    schedule: Optional[AutomationScheduleTrigger] = None
+    __properties: ClassVar[List[str]] = ["schedule"]
+
+    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 AutomationTriggers 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 schedule
+        if self.schedule:
+            _dict["schedule"] = self.schedule.to_dict()
+        # set to None if schedule (nullable) is None
+        # and model_fields_set contains the field
+        if self.schedule is None and "schedule" in self.model_fields_set:
+            _dict["schedule"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AutomationTriggers from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "schedule": (
+                    AutomationScheduleTrigger.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None
+                )
+            }
+        )
+        return _obj