report_data.py

# coding: utf-8

"""
STACKIT Cost API

The cost API provides detailed reports on the costs for a customer or project over a certain amount of time

The version of the OpenAPI document: 3.0
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
"""  # noqa: E501

from __future__ import annotations

import json
import pprint
from typing import Any, ClassVar, Dict, List, Optional, Set, Union

from pydantic import (
    BaseModel,
    ConfigDict,
    Field,
    StrictFloat,
    StrictInt,
    StrictStr,
)
from pydantic_core import to_jsonable_python
from typing_extensions import Self

from stackit.cost.models.report_data_time_period import ReportDataTimePeriod


class ReportData(BaseModel):
    """
    Costs report for a certain period of time
    """  # noqa: E501

    charge: Union[StrictFloat, StrictInt] = Field(description="Charge, value in cents")
    discount: Union[StrictFloat, StrictInt] = Field(description="Discount, value in cents")
    quantity: StrictInt = Field(description="Quantity")
    quantity_decimal: StrictStr = Field(
        description="Quantity in decimal format, returned as string to preserve precision. NOTE: This field will be removed in future versions and `totalQuantity` will become a decimal. ",
        alias="quantityDecimal",
    )
    time_period: ReportDataTimePeriod = Field(alias="timePeriod")
    __properties: ClassVar[List[str]] = ["charge", "discount", "quantity", "quantityDecimal", "timePeriod"]

    model_config = ConfigDict(
        validate_by_name=True,
        validate_by_alias=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"""
        return json.dumps(to_jsonable_python(self.to_dict()))

    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of ReportData 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 time_period
        if self.time_period:
            _dict["timePeriod"] = self.time_period.to_dict()
        return _dict

    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of ReportData from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate(
            {
                "charge": obj.get("charge"),
                "discount": obj.get("discount"),
                "quantity": obj.get("quantity"),
                "quantityDecimal": obj.get("quantityDecimal"),
                "timePeriod": (
                    ReportDataTimePeriod.from_dict(obj["timePeriod"]) if obj.get("timePeriod") is not None else None
                ),
            }
        )
        return _obj