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

ha_sdk_python/models/validate_pricing_price_range.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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ValidatePricingPriceRange(BaseModel):
+    """
+    Price before and after discount
+    """ # noqa: E501
+    before_discount: StrictStr
+    discount: StrictStr
+    after_discount: StrictStr
+    __properties: ClassVar[List[str]] = ["before_discount", "discount", "after_discount"]
+
+    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 ValidatePricingPriceRange 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 ValidatePricingPriceRange from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "before_discount": obj.get("before_discount"),
+            "discount": obj.get("discount"),
+            "after_discount": obj.get("after_discount")
+        })
+        return _obj
+
+

ha_sdk_python/models/validate_pricing_product.py

@@ -0,0 +1,101 @@
+# 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.billing_cycle import BillingCycle
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ValidatePricingProduct(BaseModel):
+    """
+    A single product line item in a validate pricing request
+    """ # noqa: E501
+    pid: StrictInt = Field(description="WHMCS product ID")
+    billing_cycle: BillingCycle
+    plan_id: StrictInt = Field(description="Plan ID for the selected product configuration")
+    hostname: Optional[StrictStr] = Field(default=None, description="Hostname to assign to the service")
+    config_options: Optional[Any] = Field(description="Configuration options as a free-form map (option_id -> value)")
+    __properties: ClassVar[List[str]] = ["pid", "billing_cycle", "plan_id", "hostname", "config_options"]
+
+    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 ValidatePricingProduct 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 config_options (nullable) is None
+        # and model_fields_set contains the field
+        if self.config_options is None and "config_options" in self.model_fields_set:
+            _dict['config_options'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ValidatePricingProduct from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "pid": obj.get("pid"),
+            "billing_cycle": obj.get("billing_cycle"),
+            "plan_id": obj.get("plan_id"),
+            "hostname": obj.get("hostname"),
+            "config_options": obj.get("config_options")
+        })
+        return _obj
+
+

ha_sdk_python/models/validate_pricing_product_result.py

@@ -0,0 +1,121 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from ha_sdk_python.models.validate_pricing_breakdown import ValidatePricingBreakdown
+from ha_sdk_python.models.validate_pricing_discount import ValidatePricingDiscount
+from ha_sdk_python.models.validate_pricing_price_range import ValidatePricingPriceRange
+from ha_sdk_python.models.validate_pricing_prorata import ValidatePricingProrata
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ValidatePricingProductResult(BaseModel):
+    """
+    Per-product pricing detail in the validate pricing response
+    """ # noqa: E501
+    pid: StrictInt
+    name: StrictStr
+    billing_cycle: StrictStr
+    plan_id: Optional[StrictInt] = None
+    prorata: Optional[ValidatePricingProrata] = None
+    recurring_price: Optional[ValidatePricingPriceRange] = None
+    discount: Optional[ValidatePricingDiscount] = None
+    line_total_before_discount: StrictStr
+    line_total: StrictStr
+    breakdown: Optional[ValidatePricingBreakdown] = None
+    __properties: ClassVar[List[str]] = ["pid", "name", "billing_cycle", "plan_id", "prorata", "recurring_price", "discount", "line_total_before_discount", "line_total", "breakdown"]
+
+    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 ValidatePricingProductResult 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 prorata
+        if self.prorata:
+            _dict['prorata'] = self.prorata.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of recurring_price
+        if self.recurring_price:
+            _dict['recurring_price'] = self.recurring_price.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of discount
+        if self.discount:
+            _dict['discount'] = self.discount.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of breakdown
+        if self.breakdown:
+            _dict['breakdown'] = self.breakdown.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ValidatePricingProductResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "pid": obj.get("pid"),
+            "name": obj.get("name"),
+            "billing_cycle": obj.get("billing_cycle"),
+            "plan_id": obj.get("plan_id"),
+            "prorata": ValidatePricingProrata.from_dict(obj["prorata"]) if obj.get("prorata") is not None else None,
+            "recurring_price": ValidatePricingPriceRange.from_dict(obj["recurring_price"]) if obj.get("recurring_price") is not None else None,
+            "discount": ValidatePricingDiscount.from_dict(obj["discount"]) if obj.get("discount") is not None else None,
+            "line_total_before_discount": obj.get("line_total_before_discount"),
+            "line_total": obj.get("line_total"),
+            "breakdown": ValidatePricingBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None
+        })
+        return _obj
+
+

ha_sdk_python/models/validate_pricing_prorata.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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ValidatePricingProrata(BaseModel):
+    """
+    Prorata charge details for a product
+    """ # noqa: E501
+    applied: StrictBool
+    amount: Optional[StrictStr] = None
+    var_date: Optional[StrictStr] = Field(default=None, alias="date")
+    invoice_date: Optional[StrictStr] = None
+    days: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["applied", "amount", "date", "invoice_date", "days"]
+
+    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 ValidatePricingProrata 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 ValidatePricingProrata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "applied": obj.get("applied"),
+            "amount": obj.get("amount"),
+            "date": obj.get("date"),
+            "invoice_date": obj.get("invoice_date"),
+            "days": obj.get("days")
+        })
+        return _obj
+
+

ha_sdk_python/models/validate_pricing_request_content.py

@@ -0,0 +1,97 @@
+# 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.validate_pricing_product import ValidatePricingProduct
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ValidatePricingRequestContent(BaseModel):
+    """
+    ValidatePricingRequestContent
+    """ # noqa: E501
+    promo: Optional[StrictStr] = Field(default=None, description="Optional promotional code to apply")
+    products: List[ValidatePricingProduct] = Field(description="List of products to validate pricing for")
+    __properties: ClassVar[List[str]] = ["promo", "products"]
+
+    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 ValidatePricingRequestContent 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 products (list)
+        _items = []
+        if self.products:
+            for _item_products in self.products:
+                if _item_products:
+                    _items.append(_item_products.to_dict())
+            _dict['products'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ValidatePricingRequestContent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "promo": obj.get("promo"),
+            "products": [ValidatePricingProduct.from_dict(_item) for _item in obj["products"]] if obj.get("products") is not None else None
+        })
+        return _obj
+
+

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