stackit-cost 0.1.0__py3-none-any.whl

src/stackit/cost/models/error_response.py

@@ -0,0 +1,81 @@
+# 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
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing_extensions import Self
+
+
+class ErrorResponse(BaseModel):
+    """
+    ErrorResponse
+    """  # noqa: E501
+
+    msg: StrictStr
+    __properties: ClassVar[List[str]] = ["msg"]
+
+    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 ErrorResponse 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 ErrorResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"msg": obj.get("msg")})
+        return _obj

src/stackit/cost/models/project_cost.py

@@ -0,0 +1,203 @@
+# 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 TYPE_CHECKING, Any, Dict, Optional, Set, Union
+
+from pydantic import (
+    BaseModel,
+    ValidationError,
+    field_validator,
+)
+from typing_extensions import Self
+
+from stackit.cost.models.project_cost_with_detailed_services import (
+    ProjectCostWithDetailedServices,
+)
+from stackit.cost.models.project_cost_with_reports import ProjectCostWithReports
+from stackit.cost.models.project_cost_with_summarized_services import (
+    ProjectCostWithSummarizedServices,
+)
+from stackit.cost.models.summarized_project_cost import SummarizedProjectCost
+
+
+PROJECTCOST_ANY_OF_SCHEMAS = [
+    "ProjectCostWithDetailedServices",
+    "ProjectCostWithReports",
+    "ProjectCostWithSummarizedServices",
+    "SummarizedProjectCost",
+]
+
+
+class ProjectCost(BaseModel):
+    """
+    ProjectCost
+    """
+
+    # data type: SummarizedProjectCost
+    anyof_schema_1_validator: Optional[SummarizedProjectCost] = None
+    # data type: ProjectCostWithReports
+    anyof_schema_2_validator: Optional[ProjectCostWithReports] = None
+    # data type: ProjectCostWithSummarizedServices
+    anyof_schema_3_validator: Optional[ProjectCostWithSummarizedServices] = None
+    # data type: ProjectCostWithDetailedServices
+    anyof_schema_4_validator: Optional[ProjectCostWithDetailedServices] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[
+            Union[
+                ProjectCostWithDetailedServices,
+                ProjectCostWithReports,
+                ProjectCostWithSummarizedServices,
+                SummarizedProjectCost,
+            ]
+        ] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = {
+        "ProjectCostWithDetailedServices",
+        "ProjectCostWithReports",
+        "ProjectCostWithSummarizedServices",
+        "SummarizedProjectCost",
+    }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator("actual_instance")
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = ProjectCost.model_construct()
+        error_messages = []
+        # validate data type: SummarizedProjectCost
+        if not isinstance(v, SummarizedProjectCost):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `SummarizedProjectCost`")
+        else:
+            return v
+
+        # validate data type: ProjectCostWithReports
+        if not isinstance(v, ProjectCostWithReports):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ProjectCostWithReports`")
+        else:
+            return v
+
+        # validate data type: ProjectCostWithSummarizedServices
+        if not isinstance(v, ProjectCostWithSummarizedServices):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ProjectCostWithSummarizedServices`")
+        else:
+            return v
+
+        # validate data type: ProjectCostWithDetailedServices
+        if not isinstance(v, ProjectCostWithDetailedServices):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ProjectCostWithDetailedServices`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError(
+                "No match found when setting the actual_instance in ProjectCost with anyOf schemas: ProjectCostWithDetailedServices, ProjectCostWithReports, ProjectCostWithSummarizedServices, SummarizedProjectCost. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[SummarizedProjectCost] = None
+        try:
+            instance.actual_instance = SummarizedProjectCost.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[ProjectCostWithReports] = None
+        try:
+            instance.actual_instance = ProjectCostWithReports.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[ProjectCostWithSummarizedServices] = None
+        try:
+            instance.actual_instance = ProjectCostWithSummarizedServices.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # anyof_schema_4_validator: Optional[ProjectCostWithDetailedServices] = None
+        try:
+            instance.actual_instance = ProjectCostWithDetailedServices.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into ProjectCost with anyOf schemas: ProjectCostWithDetailedServices, ProjectCostWithReports, ProjectCostWithSummarizedServices, SummarizedProjectCost. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(
+        self,
+    ) -> Optional[
+        Union[
+            Dict[str, Any],
+            ProjectCostWithDetailedServices,
+            ProjectCostWithReports,
+            ProjectCostWithSummarizedServices,
+            SummarizedProjectCost,
+        ]
+    ]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())

src/stackit/cost/models/project_cost_with_detailed_services.py

@@ -0,0 +1,132 @@
+# 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 uuid import UUID
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictFloat,
+    StrictInt,
+    StrictStr,
+)
+from typing_extensions import Self
+
+from stackit.cost.models.detailed_service_cost import DetailedServiceCost
+
+
+class ProjectCostWithDetailedServices(BaseModel):
+    """
+    Detailed costs for a project including service costs
+    """  # noqa: E501
+
+    customer_account_id: UUID = Field(alias="customerAccountId")
+    project_id: UUID = Field(alias="projectId")
+    project_name: StrictStr = Field(alias="projectName")
+    services: Optional[List[DetailedServiceCost]] = Field(
+        default=None,
+        description='Total discount for all services and the whole requested date range (value in cents). Please see "depth" parameter for more details.',
+    )
+    total_charge: Union[StrictFloat, StrictInt] = Field(
+        description="Total charge (including discounts) for all services and the whole requested date range (value in cents)",
+        alias="totalCharge",
+    )
+    total_discount: Union[StrictFloat, StrictInt] = Field(
+        description="Total discount for all services and the whole requested date range (value in cents)",
+        alias="totalDiscount",
+    )
+    __properties: ClassVar[List[str]] = [
+        "customerAccountId",
+        "projectId",
+        "projectName",
+        "services",
+        "totalCharge",
+        "totalDiscount",
+    ]
+
+    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 ProjectCostWithDetailedServices 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 services (list)
+        _items = []
+        if self.services:
+            for _item_services in self.services:
+                if _item_services:
+                    _items.append(_item_services.to_dict())
+            _dict["services"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ProjectCostWithDetailedServices from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "customerAccountId": obj.get("customerAccountId"),
+                "projectId": obj.get("projectId"),
+                "projectName": obj.get("projectName"),
+                "services": (
+                    [DetailedServiceCost.from_dict(_item) for _item in obj["services"]]
+                    if obj.get("services") is not None
+                    else None
+                ),
+                "totalCharge": obj.get("totalCharge"),
+                "totalDiscount": obj.get("totalDiscount"),
+            }
+        )
+        return _obj

src/stackit/cost/models/project_cost_with_reports.py

@@ -0,0 +1,133 @@
+# 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 uuid import UUID
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictFloat,
+    StrictInt,
+    StrictStr,
+)
+from typing_extensions import Self
+
+from stackit.cost.models.report_data import ReportData
+
+
+class ProjectCostWithReports(BaseModel):
+    """
+    Detailed costs for a project
+    """  # noqa: E501
+
+    customer_account_id: UUID = Field(alias="customerAccountId")
+    project_id: UUID = Field(alias="projectId")
+    project_name: StrictStr = Field(alias="projectName")
+    report_data: Optional[List[ReportData]] = Field(
+        default=None,
+        description='Detailed project costs which are ONLY included if granularity is provided AND depth is "project"',
+        alias="reportData",
+    )
+    total_charge: Union[StrictFloat, StrictInt] = Field(
+        description="Total charge (including discounts) for all services and the whole requested date range (value in cents)",
+        alias="totalCharge",
+    )
+    total_discount: Union[StrictFloat, StrictInt] = Field(
+        description="Total discount for all services and the whole requested date range (value in cents)",
+        alias="totalDiscount",
+    )
+    __properties: ClassVar[List[str]] = [
+        "customerAccountId",
+        "projectId",
+        "projectName",
+        "reportData",
+        "totalCharge",
+        "totalDiscount",
+    ]
+
+    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 ProjectCostWithReports 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 report_data (list)
+        _items = []
+        if self.report_data:
+            for _item_report_data in self.report_data:
+                if _item_report_data:
+                    _items.append(_item_report_data.to_dict())
+            _dict["reportData"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ProjectCostWithReports from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "customerAccountId": obj.get("customerAccountId"),
+                "projectId": obj.get("projectId"),
+                "projectName": obj.get("projectName"),
+                "reportData": (
+                    [ReportData.from_dict(_item) for _item in obj["reportData"]]
+                    if obj.get("reportData") is not None
+                    else None
+                ),
+                "totalCharge": obj.get("totalCharge"),
+                "totalDiscount": obj.get("totalDiscount"),
+            }
+        )
+        return _obj

src/stackit/cost/models/project_cost_with_summarized_services.py

@@ -0,0 +1,129 @@
+# 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 uuid import UUID
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictFloat,
+    StrictInt,
+    StrictStr,
+)
+from typing_extensions import Self
+
+from stackit.cost.models.summarized_service_cost import SummarizedServiceCost
+
+
+class ProjectCostWithSummarizedServices(BaseModel):
+    """
+    Costs for a project including summarized service costs
+    """  # noqa: E501
+
+    customer_account_id: UUID = Field(alias="customerAccountId")
+    project_id: UUID = Field(alias="projectId")
+    project_name: StrictStr = Field(alias="projectName")
+    services: Optional[List[SummarizedServiceCost]] = Field(default=None, description="Summarized service costs")
+    total_charge: Union[StrictFloat, StrictInt] = Field(
+        description="Total charge (including discounts) for all services and the whole requested date range (value in cents)",
+        alias="totalCharge",
+    )
+    total_discount: Union[StrictFloat, StrictInt] = Field(
+        description="Total discount for all services and the whole requested date range (value in cents)",
+        alias="totalDiscount",
+    )
+    __properties: ClassVar[List[str]] = [
+        "customerAccountId",
+        "projectId",
+        "projectName",
+        "services",
+        "totalCharge",
+        "totalDiscount",
+    ]
+
+    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 ProjectCostWithSummarizedServices 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 services (list)
+        _items = []
+        if self.services:
+            for _item_services in self.services:
+                if _item_services:
+                    _items.append(_item_services.to_dict())
+            _dict["services"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ProjectCostWithSummarizedServices from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "customerAccountId": obj.get("customerAccountId"),
+                "projectId": obj.get("projectId"),
+                "projectName": obj.get("projectName"),
+                "services": (
+                    [SummarizedServiceCost.from_dict(_item) for _item in obj["services"]]
+                    if obj.get("services") is not None
+                    else None
+                ),
+                "totalCharge": obj.get("totalCharge"),
+                "totalDiscount": obj.get("totalDiscount"),
+            }
+        )
+        return _obj