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

ha_sdk_python/models/vps_cancel_type.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 VpsCancelType(str, Enum):
+    """
+    Cancel type enum - controls when a VPS service cancellation takes effect
+    """
+
+    """
+    allowed enum values
+    """
+    IMMEDIATE = 'immediate'
+    END_OF_BILLING_PERIOD = 'end_of_billing_period'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of VpsCancelType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ha_sdk_python/models/vps_config_response_data.py

@@ -0,0 +1,108 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VpsConfigResponseData(BaseModel):
+    """
+    Response data for VPS configuration retrieval
+    """ # noqa: E501
+    message: StrictStr = Field(description="Status message indicating the result")
+    hostname: Optional[StrictStr] = Field(default=None, description="Hostname of the VPS")
+    is_kvm: Optional[StrictBool] = Field(default=None, description="Whether the VPS uses KVM virtualisation")
+    sshkeys_enabled: Optional[StrictBool] = Field(default=None, description="Whether SSH key management is enabled for this VPS")
+    available_boot_order: Optional[Any] = Field(default=None, description="Available boot order options keyed by device identifier")
+    boot_order0: Optional[StrictStr] = Field(default=None, description="Primary boot order slot (device identifier, or null)", alias="bootOrder0")
+    boot_order1: Optional[StrictStr] = Field(default=None, description="Secondary boot order slot (device identifier, or null)", alias="bootOrder1")
+    boot_order2: Optional[StrictStr] = Field(default=None, description="Tertiary boot order slot (device identifier, or null)", alias="bootOrder2")
+    sshkeys: Optional[StrictStr] = Field(default=None, description="Current SSH key(s) configured on the VPS (cloud-init)")
+    __properties: ClassVar[List[str]] = ["message", "hostname", "is_kvm", "sshkeys_enabled", "available_boot_order", "bootOrder0", "bootOrder1", "bootOrder2", "sshkeys"]
+
+    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 VpsConfigResponseData 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,
+        )
+        # set to None if available_boot_order (nullable) is None
+        # and model_fields_set contains the field
+        if self.available_boot_order is None and "available_boot_order" in self.model_fields_set:
+            _dict['available_boot_order'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VpsConfigResponseData 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"),
+            "hostname": obj.get("hostname"),
+            "is_kvm": obj.get("is_kvm"),
+            "sshkeys_enabled": obj.get("sshkeys_enabled"),
+            "available_boot_order": obj.get("available_boot_order"),
+            "bootOrder0": obj.get("bootOrder0"),
+            "bootOrder1": obj.get("bootOrder1"),
+            "bootOrder2": obj.get("bootOrder2"),
+            "sshkeys": obj.get("sshkeys")
+        })
+        return _obj
+
+

ha_sdk_python/models/vps_cpu_info.py

@@ -0,0 +1,92 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VpsCpuInfo(BaseModel):
+    """
+    CPU usage information
+    """ # noqa: E501
+    usage_ratio: Optional[Union[Annotated[float, Field(le=1, strict=True, ge=0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=None, description="CPU usage ratio (0.0 to 1.0)")
+    percent: Optional[Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]]] = Field(default=None, description="CPU usage percentage")
+    cores: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="Number of CPU cores")
+    __properties: ClassVar[List[str]] = ["usage_ratio", "percent", "cores"]
+
+    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 VpsCpuInfo 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 VpsCpuInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "usage_ratio": obj.get("usage_ratio"),
+            "percent": obj.get("percent"),
+            "cores": obj.get("cores")
+        })
+        return _obj
+
+

ha_sdk_python/models/vps_credentials.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 VpsCredentials(BaseModel):
+    """
+    VPS credentials
+    """ # noqa: E501
+    username: StrictStr = Field(description="Username for VPS access")
+    password: StrictStr = Field(description="Password for VPS access")
+    __properties: ClassVar[List[str]] = ["username", "password"]
+
+    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 VpsCredentials 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 VpsCredentials from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "username": obj.get("username"),
+            "password": obj.get("password")
+        })
+        return _obj
+
+

ha_sdk_python/models/vps_details_response.py

@@ -0,0 +1,143 @@
+# 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_available_features import VpsAvailableFeatures
+from ha_sdk_python.models.vps_bandwidth_info import VpsBandwidthInfo
+from ha_sdk_python.models.vps_cpu_info import VpsCpuInfo
+from ha_sdk_python.models.vps_credentials import VpsCredentials
+from ha_sdk_python.models.vps_disk_info import VpsDiskInfo
+from ha_sdk_python.models.vps_memory_info import VpsMemoryInfo
+from ha_sdk_python.models.vps_network_rate import VpsNetworkRate
+from ha_sdk_python.models.vps_os_info import VpsOsInfo
+from ha_sdk_python.models.vps_vm_info import VpsVmInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VpsDetailsResponse(BaseModel):
+    """
+    VpsDetailsResponse
+    """ # noqa: E501
+    message: StrictStr = Field(description="Status message")
+    vm_info: VpsVmInfo
+    cpu: VpsCpuInfo
+    memory: VpsMemoryInfo
+    disk: VpsDiskInfo
+    bandwidth: VpsBandwidthInfo
+    network_rate: Optional[VpsNetworkRate] = None
+    ip_addresses: List[StrictStr] = Field(description="List of IP addresses assigned to the VPS")
+    credentials: VpsCredentials
+    available_features: VpsAvailableFeatures
+    os_info: Optional[VpsOsInfo] = None
+    __properties: ClassVar[List[str]] = ["message", "vm_info", "cpu", "memory", "disk", "bandwidth", "network_rate", "ip_addresses", "credentials", "available_features", "os_info"]
+
+    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 VpsDetailsResponse 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 vm_info
+        if self.vm_info:
+            _dict['vm_info'] = self.vm_info.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of cpu
+        if self.cpu:
+            _dict['cpu'] = self.cpu.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of memory
+        if self.memory:
+            _dict['memory'] = self.memory.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of disk
+        if self.disk:
+            _dict['disk'] = self.disk.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of bandwidth
+        if self.bandwidth:
+            _dict['bandwidth'] = self.bandwidth.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of network_rate
+        if self.network_rate:
+            _dict['network_rate'] = self.network_rate.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of credentials
+        if self.credentials:
+            _dict['credentials'] = self.credentials.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of available_features
+        if self.available_features:
+            _dict['available_features'] = self.available_features.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of os_info
+        if self.os_info:
+            _dict['os_info'] = self.os_info.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VpsDetailsResponse 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"),
+            "vm_info": VpsVmInfo.from_dict(obj["vm_info"]) if obj.get("vm_info") is not None else None,
+            "cpu": VpsCpuInfo.from_dict(obj["cpu"]) if obj.get("cpu") is not None else None,
+            "memory": VpsMemoryInfo.from_dict(obj["memory"]) if obj.get("memory") is not None else None,
+            "disk": VpsDiskInfo.from_dict(obj["disk"]) if obj.get("disk") is not None else None,
+            "bandwidth": VpsBandwidthInfo.from_dict(obj["bandwidth"]) if obj.get("bandwidth") is not None else None,
+            "network_rate": VpsNetworkRate.from_dict(obj["network_rate"]) if obj.get("network_rate") is not None else None,
+            "ip_addresses": obj.get("ip_addresses"),
+            "credentials": VpsCredentials.from_dict(obj["credentials"]) if obj.get("credentials") is not None else None,
+            "available_features": VpsAvailableFeatures.from_dict(obj["available_features"]) if obj.get("available_features") is not None else None,
+            "os_info": VpsOsInfo.from_dict(obj["os_info"]) if obj.get("os_info") is not None else None
+        })
+        return _obj
+
+

ha_sdk_python/models/vps_disk_info.py

@@ -0,0 +1,96 @@
+# 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, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VpsDiskInfo(BaseModel):
+    """
+    Disk usage information
+    """ # noqa: E501
+    usage_bytes: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Disk usage in bytes")
+    total_bytes: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Total disk space in bytes")
+    percent: Optional[Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]]] = Field(default=None, description="Disk usage percentage")
+    usage_human: Optional[StrictStr] = Field(default=None, description="Human-readable disk usage (e.g., '50 GB')")
+    total_human: Optional[StrictStr] = Field(default=None, description="Human-readable total disk space (e.g., '100 GB')")
+    __properties: ClassVar[List[str]] = ["usage_bytes", "total_bytes", "percent", "usage_human", "total_human"]
+
+    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 VpsDiskInfo 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 VpsDiskInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "usage_bytes": obj.get("usage_bytes"),
+            "total_bytes": obj.get("total_bytes"),
+            "percent": obj.get("percent"),
+            "usage_human": obj.get("usage_human"),
+            "total_human": obj.get("total_human")
+        })
+        return _obj
+
+

ha_sdk_python/models/vps_memory_info.py

@@ -0,0 +1,96 @@
+# 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, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VpsMemoryInfo(BaseModel):
+    """
+    Memory usage information
+    """ # noqa: E501
+    usage_bytes: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Memory usage in bytes")
+    total_bytes: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Total memory in bytes")
+    percent: Optional[Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]]] = Field(default=None, description="Memory usage percentage")
+    usage_human: Optional[StrictStr] = Field(default=None, description="Human-readable memory usage (e.g., '2.5 GB')")
+    total_human: Optional[StrictStr] = Field(default=None, description="Human-readable total memory (e.g., '8 GB')")
+    __properties: ClassVar[List[str]] = ["usage_bytes", "total_bytes", "percent", "usage_human", "total_human"]
+
+    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 VpsMemoryInfo 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 VpsMemoryInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "usage_bytes": obj.get("usage_bytes"),
+            "total_bytes": obj.get("total_bytes"),
+            "percent": obj.get("percent"),
+            "usage_human": obj.get("usage_human"),
+            "total_human": obj.get("total_human")
+        })
+        return _obj
+
+