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

ha_sdk_python/models/create_backup_response_content.py

@@ -0,0 +1,94 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from ha_sdk_python.models.backup_create_response_data import BackupCreateResponseData
+from ha_sdk_python.models.operation_status import OperationStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateBackupResponseContent(BaseModel):
+    """
+    CreateBackupResponseContent
+    """ # noqa: E501
+    status: OperationStatus
+    data: BackupCreateResponseData
+    __properties: ClassVar[List[str]] = ["status", "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 CreateBackupResponseContent 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 data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateBackupResponseContent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status"),
+            "data": BackupCreateResponseData.from_dict(obj["data"]) if obj.get("data") is not None else None
+        })
+        return _obj
+
+

ha_sdk_python/models/create_backup_schedule_request_content.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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from ha_sdk_python.models.backup_mode_type import BackupModeType
+from ha_sdk_python.models.compression_type import CompressionType
+from ha_sdk_python.models.day_of_week import DayOfWeek
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateBackupScheduleRequestContent(BaseModel):
+    """
+    CreateBackupScheduleRequestContent
+    """ # noqa: E501
+    service_id: StrictStr = Field(description="Service ID - must be sent as a string")
+    starttime: Annotated[str, Field(strict=True)] = Field(description="Time in HH:MM format (e.g., '03:00'). Hours must be between 00-23, minutes must be between 00-59")
+    dow: List[DayOfWeek] = Field(description="Days of week when backup should run")
+    compress: CompressionType
+    mode: BackupModeType
+    mailto: Optional[StrictBool] = Field(default=None, description="Email notification setting. Set to true to send notifications to client's email, false or omit to disable")
+    __properties: ClassVar[List[str]] = ["service_id", "starttime", "dow", "compress", "mode", "mailto"]
+
+    @field_validator('starttime')
+    def starttime_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^([01]?[0-9]|2[0-3]):[0-5][0-9]$", value):
+            raise ValueError(r"must validate the regular expression /^([01]?[0-9]|2[0-3]):[0-5][0-9]$/")
+        return value
+
+    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 CreateBackupScheduleRequestContent 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 CreateBackupScheduleRequestContent 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"),
+            "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/create_backup_schedule_response_content.py

@@ -0,0 +1,94 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from ha_sdk_python.models.operation_status import OperationStatus
+from ha_sdk_python.models.vps_simple_action_response_data import VpsSimpleActionResponseData
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateBackupScheduleResponseContent(BaseModel):
+    """
+    CreateBackupScheduleResponseContent
+    """ # noqa: E501
+    status: OperationStatus
+    data: VpsSimpleActionResponseData
+    __properties: ClassVar[List[str]] = ["status", "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 CreateBackupScheduleResponseContent 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 data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateBackupScheduleResponseContent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status"),
+            "data": VpsSimpleActionResponseData.from_dict(obj["data"]) if obj.get("data") is not None else None
+        })
+        return _obj
+
+

ha_sdk_python/models/create_firewall_rule_request_content.py

@@ -0,0 +1,115 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from ha_sdk_python.models.firewall_rule_action import FirewallRuleAction
+from ha_sdk_python.models.firewall_rule_type import FirewallRuleType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateFirewallRuleRequestContent(BaseModel):
+    """
+    CreateFirewallRuleRequestContent
+    """ # noqa: E501
+    service_id: StrictStr = Field(description="Service ID - must be sent as a string")
+    type: FirewallRuleType
+    rule_action: FirewallRuleAction
+    enable: Optional[StrictInt] = Field(default=None, description="Whether the rule is enabled (1=enabled, 0=disabled)")
+    comment: Optional[StrictStr] = Field(default=None, description="Comment/description for the rule")
+    source: Optional[StrictStr] = Field(default=None, description="Source address/network")
+    dest: Optional[StrictStr] = Field(default=None, description="Destination address/network")
+    proto: Optional[StrictStr] = Field(default=None, description="Protocol (tcp, udp, icmp, etc). Use '0' or omit for none")
+    dport: Optional[StrictStr] = Field(default=None, description="Destination port")
+    sport: Optional[StrictStr] = Field(default=None, description="Source port")
+    macro: Optional[StrictStr] = Field(default=None, description="Firewall macro name")
+    iface: Optional[StrictStr] = Field(default=None, description="Network interface name")
+    log: Optional[StrictStr] = Field(default=None, description="Log level")
+    pos: Optional[StrictInt] = Field(default=None, description="Position/priority of the rule")
+    __properties: ClassVar[List[str]] = ["service_id", "type", "rule_action", "enable", "comment", "source", "dest", "proto", "dport", "sport", "macro", "iface", "log", "pos"]
+
+    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 CreateFirewallRuleRequestContent 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 CreateFirewallRuleRequestContent 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"),
+            "rule_action": obj.get("rule_action"),
+            "enable": obj.get("enable"),
+            "comment": obj.get("comment"),
+            "source": obj.get("source"),
+            "dest": obj.get("dest"),
+            "proto": obj.get("proto"),
+            "dport": obj.get("dport"),
+            "sport": obj.get("sport"),
+            "macro": obj.get("macro"),
+            "iface": obj.get("iface"),
+            "log": obj.get("log"),
+            "pos": obj.get("pos")
+        })
+        return _obj
+
+

ha_sdk_python/models/create_firewall_rule_response_content.py

@@ -0,0 +1,94 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from ha_sdk_python.models.operation_status import OperationStatus
+from ha_sdk_python.models.vps_simple_action_response_data import VpsSimpleActionResponseData
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateFirewallRuleResponseContent(BaseModel):
+    """
+    CreateFirewallRuleResponseContent
+    """ # noqa: E501
+    status: OperationStatus
+    data: VpsSimpleActionResponseData
+    __properties: ClassVar[List[str]] = ["status", "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 CreateFirewallRuleResponseContent 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 data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateFirewallRuleResponseContent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status"),
+            "data": VpsSimpleActionResponseData.from_dict(obj["data"]) if obj.get("data") is not None else None
+        })
+        return _obj
+
+

ha_sdk_python/models/create_notification_request_content.py

@@ -0,0 +1,111 @@
+# 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_extensions import Annotated
+from ha_sdk_python.models.notification_status import NotificationStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateNotificationRequestContent(BaseModel):
+    """
+    CreateNotificationRequestContent
+    """ # noqa: E501
+    service_id: StrictStr = Field(description="Service ID - must be sent as a string")
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=255)] = Field(description="Name/title for the notification")
+    status: Optional[NotificationStatus] = None
+    notification_interval: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="Notification interval in minutes (must be > 0)")
+    data_timeframe: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="Data timeframe in minutes (must be > 0)")
+    exceed_all: Optional[StrictBool] = Field(default=None, description="Whether all thresholds must be exceeded (true) or any one (false)")
+    email_address: Optional[List[StrictStr]] = Field(default=None, description="Email addresses for notifications (comma-separated string or array)")
+    cpu_usage: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="CPU usage threshold percentage (0-100)")
+    memory_usage: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="Memory usage threshold percentage (0-100)")
+    network_traffic: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="Network traffic threshold percentage (0-100)")
+    disk_read: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="Disk read threshold percentage (0-100)")
+    disk_write: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="Disk write threshold percentage (0-100)")
+    __properties: ClassVar[List[str]] = ["service_id", "name", "status", "notification_interval", "data_timeframe", "exceed_all", "email_address", "cpu_usage", "memory_usage", "network_traffic", "disk_read", "disk_write"]
+
+    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 CreateNotificationRequestContent 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 CreateNotificationRequestContent 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"),
+            "name": obj.get("name"),
+            "status": obj.get("status"),
+            "notification_interval": obj.get("notification_interval"),
+            "data_timeframe": obj.get("data_timeframe"),
+            "exceed_all": obj.get("exceed_all"),
+            "email_address": obj.get("email_address"),
+            "cpu_usage": obj.get("cpu_usage"),
+            "memory_usage": obj.get("memory_usage"),
+            "network_traffic": obj.get("network_traffic"),
+            "disk_read": obj.get("disk_read"),
+            "disk_write": obj.get("disk_write")
+        })
+        return _obj
+
+