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

ha_sdk_python/models/catalogue_plan.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CataloguePlan(BaseModel):
+    """
+    A plan (size tier) available for a product
+    """ # noqa: E501
+    id: StrictInt = Field(description="Plan identifier")
+    name: StrictStr = Field(description="Plan display name (e.g. C1, C2)")
+    cpu: StrictInt = Field(description="Number of vCPUs")
+    ram: StrictInt = Field(description="RAM in GB")
+    disk: StrictInt = Field(description="Disk size in GB")
+    bandwidth: StrictInt = Field(description="Bandwidth allowance in GB")
+    backups: StrictInt = Field(description="Number of included backup slots")
+    snapshots: StrictInt = Field(description="Number of included snapshot slots")
+    pricing: Optional[Any] = Field(description="Per-cycle pricing for this plan")
+    __properties: ClassVar[List[str]] = ["id", "name", "cpu", "ram", "disk", "bandwidth", "backups", "snapshots", "pricing"]
+
+    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 CataloguePlan 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 pricing (nullable) is None
+        # and model_fields_set contains the field
+        if self.pricing is None and "pricing" in self.model_fields_set:
+            _dict['pricing'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CataloguePlan 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"),
+            "name": obj.get("name"),
+            "cpu": obj.get("cpu"),
+            "ram": obj.get("ram"),
+            "disk": obj.get("disk"),
+            "bandwidth": obj.get("bandwidth"),
+            "backups": obj.get("backups"),
+            "snapshots": obj.get("snapshots"),
+            "pricing": obj.get("pricing")
+        })
+        return _obj
+
+

ha_sdk_python/models/catalogue_product.py

@@ -0,0 +1,131 @@
+# 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 ha_sdk_python.models.catalogue_config_option import CatalogueConfigOption
+from ha_sdk_python.models.catalogue_plan import CataloguePlan
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CatalogueProduct(BaseModel):
+    """
+    A product entry within a catalogue group
+    """ # noqa: E501
+    id: StrictInt = Field(description="WHMCS product identifier")
+    name: StrictStr = Field(description="Product display name")
+    type: StrictStr = Field(description="Product type (e.g. server)")
+    requires_hostname: StrictBool = Field(description="Whether the product requires a hostname at order time")
+    billing_cycles: List[StrictStr] = Field(description="Billing cycles available for this product")
+    pricing: Optional[Any] = Field(description="Base per-cycle pricing for the product (before plan selection)")
+    use_plans: StrictBool = Field(description="Whether this product uses plan-based sizing")
+    plans: List[CataloguePlan] = Field(description="Available plans (size tiers) for this product")
+    config_options: List[CatalogueConfigOption] = Field(description="Configurable add-on options for this product")
+    additional_information: Optional[Any] = Field(description="Additional product information fields")
+    __properties: ClassVar[List[str]] = ["id", "name", "type", "requires_hostname", "billing_cycles", "pricing", "use_plans", "plans", "config_options", "additional_information"]
+
+    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 CatalogueProduct 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 plans (list)
+        _items = []
+        if self.plans:
+            for _item_plans in self.plans:
+                if _item_plans:
+                    _items.append(_item_plans.to_dict())
+            _dict['plans'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in config_options (list)
+        _items = []
+        if self.config_options:
+            for _item_config_options in self.config_options:
+                if _item_config_options:
+                    _items.append(_item_config_options.to_dict())
+            _dict['config_options'] = _items
+        # set to None if pricing (nullable) is None
+        # and model_fields_set contains the field
+        if self.pricing is None and "pricing" in self.model_fields_set:
+            _dict['pricing'] = None
+
+        # set to None if additional_information (nullable) is None
+        # and model_fields_set contains the field
+        if self.additional_information is None and "additional_information" in self.model_fields_set:
+            _dict['additional_information'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CatalogueProduct 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"),
+            "name": obj.get("name"),
+            "type": obj.get("type"),
+            "requires_hostname": obj.get("requires_hostname"),
+            "billing_cycles": obj.get("billing_cycles"),
+            "pricing": obj.get("pricing"),
+            "use_plans": obj.get("use_plans"),
+            "plans": [CataloguePlan.from_dict(_item) for _item in obj["plans"]] if obj.get("plans") is not None else None,
+            "config_options": [CatalogueConfigOption.from_dict(_item) for _item in obj["config_options"]] if obj.get("config_options") is not None else None,
+            "additional_information": obj.get("additional_information")
+        })
+        return _obj
+
+

ha_sdk_python/models/change_password_request_content.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    HostAfricaApi
+
+    HostAfrica API
+
+    The version of the OpenAPI document: 2026-01-01
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ChangePasswordRequestContent(BaseModel):
+    """
+    ChangePasswordRequestContent
+    """ # noqa: E501
+    service_id: StrictStr = Field(description="Service ID - must be sent as a string")
+    password: Annotated[str, Field(min_length=16, strict=True, max_length=128)] = Field(description="New root password for the VPS")
+    __properties: ClassVar[List[str]] = ["service_id", "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 ChangePasswordRequestContent 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 ChangePasswordRequestContent 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"),
+            "password": obj.get("password")
+        })
+        return _obj
+
+

ha_sdk_python/models/change_password_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 ChangePasswordResponseContent(BaseModel):
+    """
+    ChangePasswordResponseContent
+    """ # 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 ChangePasswordResponseContent 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 ChangePasswordResponseContent 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/compression_method.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 CompressionMethod(BaseModel):
+    """
+    Compression method option
+    """ # noqa: E501
+    value: StrictStr = Field(description="Compression method value")
+    label: StrictStr = Field(description="Human-readable label for the compression method")
+    __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 CompressionMethod 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 CompressionMethod 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/compression_type.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 CompressionType(str, Enum):
+    """
+    Backup compression type enum
+    """
+
+    """
+    allowed enum values
+    """
+    ENUM_0 = '0'
+    LZO = 'lzo'
+    GZIP = 'gzip'
+    ZSTD = 'zstd'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CompressionType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ha_sdk_python/models/create_backup_request_content.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 ha_sdk_python.models.backup_mode_type import BackupModeType
+from ha_sdk_python.models.compression_type import CompressionType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateBackupRequestContent(BaseModel):
+    """
+    CreateBackupRequestContent
+    """ # noqa: E501
+    service_id: StrictStr = Field(description="Service ID - must be sent as a string")
+    compress: Optional[CompressionType] = None
+    mode: Optional[BackupModeType] = None
+    __properties: ClassVar[List[str]] = ["service_id", "compress", "mode"]
+
+    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 CreateBackupRequestContent 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 CreateBackupRequestContent 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"),
+            "compress": obj.get("compress"),
+            "mode": obj.get("mode")
+        })
+        return _obj
+
+