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

ha_sdk_python/models/notification.py

@@ -0,0 +1,105 @@
+# 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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Notification(BaseModel):
+    """
+    Individual notification item
+    """ # noqa: E501
+    id: StrictInt = Field(description="Notification ID")
+    hosting_id: StrictInt = Field(description="Hosting/service ID")
+    name: StrictStr = Field(description="Notification name/title")
+    condition_key: StrictStr = Field(description="Condition key (cpu_usage, memory_usage, network_traffic, disk_read, disk_write)")
+    threshold: StrictInt = Field(description="Threshold value")
+    period: StrictInt = Field(description="Period in minutes")
+    timeframe: StrictInt = Field(description="Timeframe in minutes")
+    enabled: Optional[StrictBool] = Field(default=None, description="Whether the notification is enabled")
+    created_at: Optional[StrictStr] = Field(default=None, description="Creation timestamp")
+    updated_at: Optional[StrictStr] = Field(default=None, description="Last updated timestamp")
+    __properties: ClassVar[List[str]] = ["id", "hosting_id", "name", "condition_key", "threshold", "period", "timeframe", "enabled", "created_at", "updated_at"]
+
+    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 Notification 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 Notification 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"),
+            "hosting_id": obj.get("hosting_id"),
+            "name": obj.get("name"),
+            "condition_key": obj.get("condition_key"),
+            "threshold": obj.get("threshold"),
+            "period": obj.get("period"),
+            "timeframe": obj.get("timeframe"),
+            "enabled": obj.get("enabled"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at")
+        })
+        return _obj
+
+

ha_sdk_python/models/notification_create_response_data.py

@@ -0,0 +1,93 @@
+# 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.notification import Notification
+from typing import Optional, Set
+from typing_extensions import Self
+
+class NotificationCreateResponseData(BaseModel):
+    """
+    Response data for notification creation operation
+    """ # noqa: E501
+    message: StrictStr = Field(description="Status message indicating the result")
+    notification: Notification
+    __properties: ClassVar[List[str]] = ["message", "notification"]
+
+    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 NotificationCreateResponseData 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 notification
+        if self.notification:
+            _dict['notification'] = self.notification.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of NotificationCreateResponseData 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"),
+            "notification": Notification.from_dict(obj["notification"]) if obj.get("notification") is not None else None
+        })
+        return _obj
+
+

ha_sdk_python/models/notification_dialog_rules.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class NotificationDialogRules(BaseModel):
+    """
+    Dialog rules for notification creation/editing
+    """ # noqa: E501
+    required_on_create: List[StrictStr] = Field(description="Fields required when creating a new notification")
+    condition_keys: List[StrictStr] = Field(description="Valid condition key values")
+    threshold_range: List[StrictInt] = Field(description="Threshold value range [min, max]")
+    period_min: StrictInt = Field(description="Minimum period value in minutes")
+    timeframe_min: StrictInt = Field(description="Minimum timeframe value in minutes")
+    __properties: ClassVar[List[str]] = ["required_on_create", "condition_keys", "threshold_range", "period_min", "timeframe_min"]
+
+    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 NotificationDialogRules 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 NotificationDialogRules from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "required_on_create": obj.get("required_on_create"),
+            "condition_keys": obj.get("condition_keys"),
+            "threshold_range": obj.get("threshold_range"),
+            "period_min": obj.get("period_min"),
+            "timeframe_min": obj.get("timeframe_min")
+        })
+        return _obj
+
+

ha_sdk_python/models/notification_list_response_data.py

@@ -0,0 +1,103 @@
+# 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.notification import Notification
+from ha_sdk_python.models.notification_dialog_rules import NotificationDialogRules
+from typing import Optional, Set
+from typing_extensions import Self
+
+class NotificationListResponseData(BaseModel):
+    """
+    Response data for listing notifications
+    """ # noqa: E501
+    message: StrictStr = Field(description="Status message indicating the result")
+    notifications: List[Notification] = Field(description="List of notifications")
+    dialog_rules: NotificationDialogRules
+    __properties: ClassVar[List[str]] = ["message", "notifications", "dialog_rules"]
+
+    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 NotificationListResponseData 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 notifications (list)
+        _items = []
+        if self.notifications:
+            for _item_notifications in self.notifications:
+                if _item_notifications:
+                    _items.append(_item_notifications.to_dict())
+            _dict['notifications'] = _items
+        # override the default output from pydantic by calling `to_dict()` of dialog_rules
+        if self.dialog_rules:
+            _dict['dialog_rules'] = self.dialog_rules.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of NotificationListResponseData 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"),
+            "notifications": [Notification.from_dict(_item) for _item in obj["notifications"]] if obj.get("notifications") is not None else None,
+            "dialog_rules": NotificationDialogRules.from_dict(obj["dialog_rules"]) if obj.get("dialog_rules") is not None else None
+        })
+        return _obj
+
+

ha_sdk_python/models/notification_status.py

@@ -0,0 +1,43 @@
+# 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 NotificationStatus(str, Enum):
+    """
+    Notification status values
+    """
+
+    """
+    allowed enum values
+    """
+    ON = 'on'
+    OFF = 'off'
+    YES = 'yes'
+    NO = 'no'
+    TRUE = 'true'
+    FALSE = 'false'
+    ENUM_1 = '1'
+    ENUM_0 = '0'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of NotificationStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ha_sdk_python/models/operation_status.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 OperationStatus(str, Enum):
+    """
+    Operation status enum - indicates success or failure of an operation
+    """
+
+    """
+    allowed enum values
+    """
+    SUCCESS = 'success'
+    ERROR = 'error'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of OperationStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ha_sdk_python/models/order.py

@@ -0,0 +1,109 @@
+# 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.order_last_attempt import OrderLastAttempt
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Order(BaseModel):
+    """
+    A single order entry in the list orders response
+    """ # noqa: E501
+    order_id: StrictInt = Field(description="Unique order identifier")
+    order_number: StrictStr = Field(description="Human-readable order reference number")
+    invoice_id: StrictInt = Field(description="Associated invoice identifier")
+    placed_at: StrictStr = Field(description="Timestamp when the order was placed (ISO 8601)")
+    currency: StrictStr = Field(description="ISO currency code (e.g. ZAR)")
+    total: StrictStr = Field(description="Total order amount as a decimal string")
+    balance_due: StrictStr = Field(description="Remaining balance due as a decimal string")
+    invoice_status: StrictStr = Field(description="Invoice status (e.g. Paid, Unpaid)")
+    last_attempt: Optional[OrderLastAttempt] = None
+    payment_status: StrictStr = Field(description="Payment status (e.g. paid, pending, failed)")
+    __properties: ClassVar[List[str]] = ["order_id", "order_number", "invoice_id", "placed_at", "currency", "total", "balance_due", "invoice_status", "last_attempt", "payment_status"]
+
+    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 Order 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 last_attempt
+        if self.last_attempt:
+            _dict['last_attempt'] = self.last_attempt.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Order from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "order_id": obj.get("order_id"),
+            "order_number": obj.get("order_number"),
+            "invoice_id": obj.get("invoice_id"),
+            "placed_at": obj.get("placed_at"),
+            "currency": obj.get("currency"),
+            "total": obj.get("total"),
+            "balance_due": obj.get("balance_due"),
+            "invoice_status": obj.get("invoice_status"),
+            "last_attempt": OrderLastAttempt.from_dict(obj["last_attempt"]) if obj.get("last_attempt") is not None else None,
+            "payment_status": obj.get("payment_status")
+        })
+        return _obj
+
+

ha_sdk_python/models/order_last_attempt.py

@@ -0,0 +1,93 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class OrderLastAttempt(BaseModel):
+    """
+    Details of the most recent payment attempt for an order
+    """ # noqa: E501
+    at: StrictStr = Field(description="Timestamp of the attempt (ISO 8601)")
+    status: StrictStr = Field(description="Attempt status (e.g. paid, failed)")
+    code: Optional[StrictStr] = Field(default=None, description="Error code from the payment provider, if applicable")
+    message: Optional[StrictStr] = Field(default=None, description="Human-readable message from the payment provider, if applicable")
+    __properties: ClassVar[List[str]] = ["at", "status", "code", "message"]
+
+    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 OrderLastAttempt 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 OrderLastAttempt from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "at": obj.get("at"),
+            "status": obj.get("status"),
+            "code": obj.get("code"),
+            "message": obj.get("message")
+        })
+        return _obj
+
+