stackit-cost 0.1.0__py3-none-any.whl

src/stackit/cost/models/report_data.py

@@ -0,0 +1,104 @@
+# 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,
+)
+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")
+    time_period: ReportDataTimePeriod = Field(alias="timePeriod")
+    __properties: ClassVar[List[str]] = ["charge", "discount", "quantity", "timePeriod"]
+
+    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 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"),
+                "timePeriod": (
+                    ReportDataTimePeriod.from_dict(obj["timePeriod"]) if obj.get("timePeriod") is not None else None
+                ),
+            }
+        )
+        return _obj

src/stackit/cost/models/report_data_time_period.py

@@ -0,0 +1,83 @@
+# 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 datetime import date
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict
+from typing_extensions import Self
+
+
+class ReportDataTimePeriod(BaseModel):
+    """
+    Time period according to desired granularity
+    """  # noqa: E501
+
+    end: Optional[date] = None
+    start: Optional[date] = None
+    __properties: ClassVar[List[str]] = ["end", "start"]
+
+    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 ReportDataTimePeriod 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 ReportDataTimePeriod from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"end": obj.get("end"), "start": obj.get("start")})
+        return _obj

src/stackit/cost/models/summarized_project_cost.py

@@ -0,0 +1,113 @@
+# 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
+
+
+class SummarizedProjectCost(BaseModel):
+    """
+    Summarized 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")
+    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",
+        "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 SummarizedProjectCost 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 SummarizedProjectCost 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"),
+                "totalCharge": obj.get("totalCharge"),
+                "totalDiscount": obj.get("totalDiscount"),
+            }
+        )
+        return _obj

src/stackit/cost/models/summarized_service_cost.py

@@ -0,0 +1,113 @@
+# 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
+
+
+class SummarizedServiceCost(BaseModel):
+    """
+    Summarized 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")
+    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",
+        "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 SummarizedServiceCost 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 SummarizedServiceCost 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"),
+                "totalCharge": obj.get("totalCharge"),
+                "totalDiscount": obj.get("totalDiscount"),
+            }
+        )
+        return _obj

src/stackit/cost/rest.py

@@ -0,0 +1,164 @@
+# 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
+
+import io
+import json
+import re
+
+import requests
+from stackit.core.authorization import Authorization
+from stackit.core.configuration import Configuration
+
+from stackit.cost.exceptions import ApiException, ApiValueError
+
+
+RESTResponseType = requests.Response
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status_code
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.content
+        return self.data
+
+    @property
+    def headers(self):
+        """Returns a dictionary of response headers."""
+        return self.response.headers
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers; use ``headers`` instead."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header; use ``headers.get()`` instead."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+    def __init__(self, config: Configuration) -> None:
+        self.session = config.custom_http_session if config.custom_http_session else requests.Session()
+        authorization = Authorization(config)
+        self.session.auth = authorization.auth_method
+
+    def request(self, method, url, headers=None, body=None, post_params=None, _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        if method not in ["GET", "HEAD", "DELETE", "POST", "PUT", "PATCH", "OPTIONS"]:
+            raise ValueError("Method %s not allowed", method)
+
+        if post_params and body:
+            raise ApiValueError("body parameter cannot be used with post_params parameter.")
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ["POST", "PUT", "PATCH", "OPTIONS", "DELETE"]:
+
+                # no content type provided or payload is json
+                content_type = headers.get("Content-Type")
+                if not content_type or re.search("json", content_type, re.IGNORECASE):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=request_body,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                elif content_type == "application/x-www-form-urlencoded":
+                    r = self.session.request(
+                        method,
+                        url,
+                        params=post_params,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                elif content_type == "multipart/form-data":
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers["Content-Type"]
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a, b) for a, b in post_params]
+                    r = self.session.request(
+                        method,
+                        url,
+                        files=post_params,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=body,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                elif headers["Content-Type"].startswith("text/") and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=request_body,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.session.request(
+                    method,
+                    url,
+                    params={},
+                    headers=headers,
+                    timeout=_request_timeout,
+                )
+        except requests.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

stackit_cost-0.1.0.dist-info/METADATA

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: stackit-cost
+Version: 0.1.0
+Summary: STACKIT Cost API
+Project-URL: Homepage, https://github.com/stackitcloud/stackit-sdk-python
+Project-URL: Issues, https://github.com/stackitcloud/stackit-sdk-python/issues
+Author-email: STACKIT Developer Tools <developer-tools@stackit.cloud>
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <4.0,>=3.9
+Requires-Dist: pydantic>=2.9.2
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: requests>=2.32.3
+Requires-Dist: stackit-core>=0.0.1a
+Description-Content-Type: text/markdown
+
+# stackit.cost
+The cost API provides detailed reports on the costs for a customer or project over a certain amount of time
+
+
+
+This package is part of the STACKIT Python SDK. For additional information, please visit the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK.
+
+
+## Installation & Usage
+### pip install
+
+```sh
+pip install stackit-cost
+```
+
+Then import the package:
+```python
+import stackit.cost
+```
+
+## Getting Started
+
+[Examples](https://github.com/stackitcloud/stackit-sdk-python/tree/main/examples) for the usage of the package can be found in the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK.

stackit_cost-0.1.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+src/stackit/cost/__init__.py,sha256=DK-gM_pIJrTmK99mZIUzYaTkWnb_wmKKByT861VbpfQ,2850
+src/stackit/cost/api_client.py,sha256=66PhJ28bo883S8vTGmkhQBeTjkPQHEHQxz9kNGw113k,23874
+src/stackit/cost/api_response.py,sha256=HRYkVqMNIlfODacTQPTbiVj2YdcnutpQrKJdeAoCSpM,642
+src/stackit/cost/configuration.py,sha256=DoRSwqsd0PVykPPx_cfZ6tnm0ritVNuw4FQItm4Lfc0,5695
+src/stackit/cost/exceptions.py,sha256=WnMgOMOmsNM_uiKulEwcxQ2LMqXMCQ5iakLvBN8rklU,6426
+src/stackit/cost/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/stackit/cost/rest.py,sha256=iw_nR3SFaDgVhURPSH3kWmOKhwB9mbH1PRhEDXRW_es,6413
+src/stackit/cost/api/__init__.py,sha256=U-N7aodHMDHitoR_l15qjMQqfjwwNbl_DpmFcxN3oBw,99
+src/stackit/cost/api/default_api.py,sha256=ZvqWYBGAe-puyHu94FfhAY50c3m7e2qWk2KGRn9ye28,65621
+src/stackit/cost/models/__init__.py,sha256=lZtLrMSAsEAVZ7UDarbOh5mE3B_OuSy-MYiNmsI7ym4,1229
+src/stackit/cost/models/auth_error_response.py,sha256=48IQVVLs7aOAR-2bLy-4KJQivpC3uxsjAsJF1nNSEOs,3599
+src/stackit/cost/models/detailed_service_cost.py,sha256=FISqR8dENrUqoFWmhH0yyo6n5U3k3xWRZIasBTfrEAE,5012
+src/stackit/cost/models/error_response.py,sha256=030DPLtt1qrWTkwP9Gf5v6-TSVEaOfhf4Ot009rM3cQ,2400
+src/stackit/cost/models/project_cost.py,sha256=cdRPazSfeCVsSFyqNo0MDUABTmJI8NXeYPDTHQq2xpE,7408
+src/stackit/cost/models/project_cost_with_detailed_services.py,sha256=jlTmtqLcR7JglKY3bAZySMJW1XzF86ojE0TldnxiLSQ,4472
+src/stackit/cost/models/project_cost_with_reports.py,sha256=6AOn-YhqNREd5IcXZsyqwAREz10FKtTwgPk1mhgOnq8,4408
+src/stackit/cost/models/project_cost_with_summarized_services.py,sha256=Y11rYm4O5XbAkzS13vIEQ1gEyEnNoARdG40OuiVbJlo,4358
+src/stackit/cost/models/report_data.py,sha256=WQrnXoHR5lS6TL-2_yWIpZk6XnGzySdM5o2El5jj2qw,3378
+src/stackit/cost/models/report_data_time_period.py,sha256=__kVt06jw-3dNP-uE7t3lrHAu1ZJEN5nchAQwTpqG6c,2548
+src/stackit/cost/models/summarized_project_cost.py,sha256=XN33OJqejjOFGmWQs3nQbWm1F8mM5fNK_RkNZM5jI8Y,3525
+src/stackit/cost/models/summarized_service_cost.py,sha256=AI002T2yRWdQx86rhCCKS1RcIJzEldDK4XhwMmAN3k8,3525
+stackit_cost-0.1.0.dist-info/METADATA,sha256=aE-csz-qwfGCN3kWZY2Ekb9lJBHHHh4zcjDqQHIC1qk,1656
+stackit_cost-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+stackit_cost-0.1.0.dist-info/RECORD,,

stackit_cost-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any