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

ha_sdk_python/models/firewall_move_direction.py

@@ -0,0 +1,39 @@
+# 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 FirewallMoveDirection(str, Enum):
+    """
+    Firewall rule move direction enum
+    """
+
+    """
+    allowed enum values
+    """
+    UP = 'up'
+    DOWN = 'down'
+    TOP = 'top'
+    BOTTOM = 'bottom'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FirewallMoveDirection from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ha_sdk_python/models/firewall_move_response_data.py

@@ -0,0 +1,91 @@
+# 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 FirewallMoveResponseData(BaseModel):
+    """
+    Response data for firewall move operation
+    """ # noqa: E501
+    message: StrictStr = Field(description="Status message indicating the result")
+    from_pos: StrictInt = Field(description="Original position of the rule")
+    target_pos: StrictInt = Field(description="New position of the rule")
+    __properties: ClassVar[List[str]] = ["message", "from_pos", "target_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 FirewallMoveResponseData 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 FirewallMoveResponseData 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"),
+            "from_pos": obj.get("from_pos"),
+            "target_pos": obj.get("target_pos")
+        })
+        return _obj
+
+

ha_sdk_python/models/firewall_option.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 FirewallOption(BaseModel):
+    """
+    Option structure for interfaces, macros, and protocols
+    """ # noqa: E501
+    value: StrictStr = Field(description="Option value")
+    label: StrictStr = Field(description="Human-readable label")
+    __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 FirewallOption 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 FirewallOption 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/firewall_rule.py

@@ -0,0 +1,113 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class FirewallRule(BaseModel):
+    """
+    Firewall rule structure
+    """ # noqa: E501
+    digest: StrictStr = Field(description="SHA1 digest of the rule")
+    pos: StrictInt = Field(description="Position/priority of the rule")
+    type: StrictStr = Field(description="Rule type (in, out)")
+    action: StrictStr = Field(description="Action to perform (ACCEPT, REJECT, DROP)")
+    iface: StrictStr = Field(description="Network interface name")
+    enable: StrictInt = Field(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)")
+    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")
+    log: Optional[StrictStr] = Field(default=None, description="Log level")
+    __properties: ClassVar[List[str]] = ["digest", "pos", "type", "action", "iface", "enable", "comment", "source", "dest", "proto", "dport", "sport", "macro", "log"]
+
+    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 FirewallRule 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 FirewallRule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "digest": obj.get("digest"),
+            "pos": obj.get("pos"),
+            "type": obj.get("type"),
+            "action": obj.get("action"),
+            "iface": obj.get("iface"),
+            "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"),
+            "log": obj.get("log")
+        })
+        return _obj
+
+

ha_sdk_python/models/firewall_rule_action.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 FirewallRuleAction(str, Enum):
+    """
+    Firewall rule action enum
+    """
+
+    """
+    allowed enum values
+    """
+    ACCEPT = 'ACCEPT'
+    DROP = 'DROP'
+    REJECT = 'REJECT'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FirewallRuleAction from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ha_sdk_python/models/firewall_rule_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 FirewallRuleType(str, Enum):
+    """
+    Firewall rule type enum
+    """
+
+    """
+    allowed enum values
+    """
+    IN = 'in'
+    OUT = 'out'
+    GROUP = 'group'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FirewallRuleType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ha_sdk_python/models/forbidden_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 ForbiddenErrorResponseContent(BaseModel):
+    """
+    ForbiddenErrorResponseContent
+    """ # 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 ForbiddenErrorResponseContent 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 ForbiddenErrorResponseContent 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/get_catalogue_request_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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetCatalogueRequestContent(BaseModel):
+    """
+    GetCatalogueRequestContent
+    """ # noqa: E501
+    group_id: Optional[StrictStr] = Field(default=None, description="Optional group identifier to filter catalogue results")
+    product_id: Optional[StrictStr] = Field(default=None, description="Optional product identifier to filter catalogue results")
+    __properties: ClassVar[List[str]] = ["group_id", "product_id"]
+
+    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 GetCatalogueRequestContent 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 GetCatalogueRequestContent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "group_id": obj.get("group_id"),
+            "product_id": obj.get("product_id")
+        })
+        return _obj
+
+

ha_sdk_python/models/get_catalogue_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.catalogue_data import CatalogueData
+from ha_sdk_python.models.operation_status import OperationStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetCatalogueResponseContent(BaseModel):
+    """
+    GetCatalogueResponseContent
+    """ # noqa: E501
+    status: OperationStatus
+    data: CatalogueData
+    __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 GetCatalogueResponseContent 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 GetCatalogueResponseContent 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": CatalogueData.from_dict(obj["data"]) if obj.get("data") is not None else None
+        })
+        return _obj
+
+