ha-sdk-python 1.0.10__py3-none-any.whl

ha_sdk_python/models/backup_item.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    HostAfricaApi
+
+    HostAfrica API
+
+    The version of the OpenAPI document: 2026-01-01
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BackupItem(BaseModel):
+    """
+    Individual backup item
+    """ # noqa: E501
+    id: StrictInt = Field(description="Backup ID")
+    size: StrictStr = Field(description="Backup size in human-readable format")
+    create_date: StrictStr = Field(description="Backup creation date and time")
+    format: StrictStr = Field(description="Backup format (e.g., vma, vma.lzo)")
+    protected: StrictBool = Field(description="Whether the backup is protected from deletion")
+    __properties: ClassVar[List[str]] = ["id", "size", "create_date", "format", "protected"]
+
+    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 BackupItem 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 BackupItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "size": obj.get("size"),
+            "create_date": obj.get("create_date"),
+            "format": obj.get("format"),
+            "protected": obj.get("protected")
+        })
+        return _obj
+
+

ha_sdk_python/models/backup_mode.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    HostAfricaApi
+
+    HostAfrica API
+
+    The version of the OpenAPI document: 2026-01-01
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BackupMode(BaseModel):
+    """
+    Backup mode option
+    """ # noqa: E501
+    value: StrictStr = Field(description="Backup mode value")
+    label: StrictStr = Field(description="Human-readable label for the backup mode")
+    __properties: ClassVar[List[str]] = ["value", "label"]
+
+    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 BackupMode 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 BackupMode from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "value": obj.get("value"),
+            "label": obj.get("label")
+        })
+        return _obj
+
+

ha_sdk_python/models/backup_mode_type.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    HostAfricaApi
+
+    HostAfrica API
+
+    The version of the OpenAPI document: 2026-01-01
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class BackupModeType(str, Enum):
+    """
+    Backup mode enum - controls how the VM is handled during backup
+    """
+
+    """
+    allowed enum values
+    """
+    SNAPSHOT = 'snapshot'
+    SUSPEND = 'suspend'
+    STOP = 'stop'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BackupModeType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ha_sdk_python/models/backup_schedule.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    HostAfricaApi
+
+    HostAfrica API
+
+    The version of the OpenAPI document: 2026-01-01
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from ha_sdk_python.models.compression_type import CompressionType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BackupSchedule(BaseModel):
+    """
+    Individual backup schedule item
+    """ # noqa: E501
+    id: StrictStr = Field(description="Schedule ID")
+    starttime: StrictStr = Field(description="Start time for backup (HH:MM format)")
+    dow: StrictStr = Field(description="Days of week (comma-separated)")
+    compress: CompressionType
+    mode: StrictStr = Field(description="Backup mode")
+    mailto: Optional[StrictStr] = Field(default=None, description="Email address for notifications (null if not set)")
+    __properties: ClassVar[List[str]] = ["id", "starttime", "dow", "compress", "mode", "mailto"]
+
+    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 BackupSchedule 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 BackupSchedule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "starttime": obj.get("starttime"),
+            "dow": obj.get("dow"),
+            "compress": obj.get("compress"),
+            "mode": obj.get("mode"),
+            "mailto": obj.get("mailto")
+        })
+        return _obj
+
+

ha_sdk_python/models/backup_schedule_list_response_data.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    HostAfricaApi
+
+    HostAfrica API
+
+    The version of the OpenAPI document: 2026-01-01
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from ha_sdk_python.models.backup_schedule import BackupSchedule
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BackupScheduleListResponseData(BaseModel):
+    """
+    Response data for backup schedule list operation
+    """ # noqa: E501
+    message: StrictStr = Field(description="Status message indicating the result")
+    schedules: List[BackupSchedule] = Field(description="List of backup schedules")
+    __properties: ClassVar[List[str]] = ["message", "schedules"]
+
+    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 BackupScheduleListResponseData 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 schedules (list)
+        _items = []
+        if self.schedules:
+            for _item_schedules in self.schedules:
+                if _item_schedules:
+                    _items.append(_item_schedules.to_dict())
+            _dict['schedules'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BackupScheduleListResponseData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "message": obj.get("message"),
+            "schedules": [BackupSchedule.from_dict(_item) for _item in obj["schedules"]] if obj.get("schedules") is not None else None
+        })
+        return _obj
+
+

ha_sdk_python/models/bad_request_error_response_content.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    HostAfricaApi
+
+    HostAfrica API
+
+    The version of the OpenAPI document: 2026-01-01
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BadRequestErrorResponseContent(BaseModel):
+    """
+    BadRequestErrorResponseContent
+    """ # noqa: E501
+    message: StrictStr
+    data: Dict[str, Any] = Field(description="Empty object for operations that don't return data")
+    __properties: ClassVar[List[str]] = ["message", "data"]
+
+    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 BadRequestErrorResponseContent 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 BadRequestErrorResponseContent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "message": obj.get("message"),
+            "data": obj.get("data")
+        })
+        return _obj
+
+

ha_sdk_python/models/billing_cycle.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+    HostAfricaApi
+
+    HostAfrica API
+
+    The version of the OpenAPI document: 2026-01-01
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class BillingCycle(str, Enum):
+    """
+    Billing cycle enum
+    """
+
+    """
+    allowed enum values
+    """
+    MONTHLY = 'monthly'
+    ANNUALLY = 'annually'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BillingCycle from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ha_sdk_python/models/cancel_vps_request_content.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    HostAfricaApi
+
+    HostAfrica API
+
+    The version of the OpenAPI document: 2026-01-01
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from ha_sdk_python.models.vps_cancel_type import VpsCancelType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CancelVpsRequestContent(BaseModel):
+    """
+    CancelVpsRequestContent
+    """ # noqa: E501
+    service_id: StrictStr = Field(description="Service ID - must be sent as a string")
+    type: Optional[VpsCancelType] = None
+    __properties: ClassVar[List[str]] = ["service_id", "type"]
+
+    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 CancelVpsRequestContent 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 CancelVpsRequestContent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "service_id": obj.get("service_id"),
+            "type": obj.get("type")
+        })
+        return _obj
+
+