miro_api.models.get_metrics_total200_response

  1# coding: utf-8
  2
  3"""
  4Miro Developer Platform
  5
  6<img src=\"https://content.pstmn.io/47449ea6-0ef7-4af2-bac1-e58a70e61c58/aW1hZ2UucG5n\" width=\"1685\" height=\"593\">  ### Miro Developer Platform concepts  - New to the Miro Developer Platform? Interested in learning more about platform concepts?? [Read our introduction page](https://beta.developers.miro.com/docs/introduction) and familiarize yourself with the Miro Developer Platform capabilities in a few minutes.   ### Getting started with the Miro REST API  - [Quickstart (video):](https://beta.developers.miro.com/docs/try-out-the-rest-api-in-less-than-3-minutes) try the REST API in less than 3 minutes. - [Quickstart (article):](https://beta.developers.miro.com/docs/build-your-first-hello-world-app-1) get started and try the REST API in less than 3 minutes.   ### Miro REST API tutorials  Check out our how-to articles with step-by-step instructions and code examples so you can:  - [Get started with OAuth 2.0 and Miro](https://beta.developers.miro.com/docs/getting-started-with-oauth)   ### Miro App Examples  Clone our [Miro App Examples repository](https://github.com/miroapp/app-examples) to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.
  7
  8The version of the OpenAPI document: v2.0
  9Generated by OpenAPI Generator (https://openapi-generator.tech)
 10
 11Do not edit the class manually.
 12"""  # noqa: E501
 13
 14
 15from __future__ import annotations
 16import pprint
 17import re  # noqa: F401
 18import json
 19
 20from pydantic import BaseModel, Field, StrictInt
 21from typing import Any, ClassVar, Dict, List, Optional
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class GetMetricsTotal200Response(BaseModel):
 27    """
 28    GetMetricsTotal200Response
 29    """  # noqa: E501
 30
 31    unique_users: Optional[StrictInt] = Field(
 32        default=None,
 33        description="Number of unique users who performed at least one activity in the application.",
 34        alias="uniqueUsers",
 35    )
 36    unique_recurring_users: Optional[StrictInt] = Field(
 37        default=None,
 38        description="Number of unique users who have been active for more than one day over the past 30 days.",
 39        alias="uniqueRecurringUsers",
 40    )
 41    unique_organizations: Optional[StrictInt] = Field(
 42        default=None,
 43        description="Number of unique company accounts that have installed the application.",
 44        alias="uniqueOrganizations",
 45    )
 46    installations: Optional[StrictInt] = Field(
 47        default=None, description="Number of application installations for a team."
 48    )
 49    uninstallations: Optional[StrictInt] = Field(
 50        default=None, description="Number of application uninstallations for a team."
 51    )
 52    additional_properties: Dict[str, Any] = {}
 53    __properties: ClassVar[List[str]] = [
 54        "uniqueUsers",
 55        "uniqueRecurringUsers",
 56        "uniqueOrganizations",
 57        "installations",
 58        "uninstallations",
 59    ]
 60
 61    model_config = {
 62        "populate_by_name": True,
 63        "validate_assignment": True,
 64        "protected_namespaces": (),
 65    }
 66
 67    def to_str(self) -> str:
 68        """Returns the string representation of the model using alias"""
 69        return pprint.pformat(self.model_dump(by_alias=True))
 70
 71    def to_json(self) -> str:
 72        """Returns the JSON representation of the model using alias"""
 73        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 74        return json.dumps(self.to_dict())
 75
 76    @classmethod
 77    def from_json(cls, json_str: str) -> Optional[Self]:
 78        """Create an instance of GetMetricsTotal200Response from a JSON string"""
 79        return cls.from_dict(json.loads(json_str))
 80
 81    def to_dict(self) -> Dict[str, Any]:
 82        """Return the dictionary representation of the model using alias.
 83
 84        This has the following differences from calling pydantic's
 85        `self.model_dump(by_alias=True)`:
 86
 87        * `None` is only added to the output dict for nullable fields that
 88          were set at model initialization. Other fields with value `None`
 89          are ignored.
 90        * Fields in `self.additional_properties` are added to the output dict.
 91        """
 92        excluded_fields: Set[str] = set(
 93            [
 94                "additional_properties",
 95            ]
 96        )
 97
 98        _dict = self.model_dump(
 99            by_alias=True,
100            exclude=excluded_fields,
101            exclude_none=True,
102        )
103        # puts key-value pairs in additional_properties in the top level
104        if self.additional_properties is not None:
105            for _key, _value in self.additional_properties.items():
106                _dict[_key] = _value
107
108        return _dict
109
110    @classmethod
111    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
112        """Create an instance of GetMetricsTotal200Response from a dict"""
113        if obj is None:
114            return None
115
116        if not isinstance(obj, dict):
117            return cls.model_validate(obj)
118
119        _obj = cls.model_validate(
120            {
121                "uniqueUsers": obj.get("uniqueUsers"),
122                "uniqueRecurringUsers": obj.get("uniqueRecurringUsers"),
123                "uniqueOrganizations": obj.get("uniqueOrganizations"),
124                "installations": obj.get("installations"),
125                "uninstallations": obj.get("uninstallations"),
126            }
127        )
128        # store additional fields in additional_properties
129        for _key in obj.keys():
130            if _key not in cls.__properties:
131                _obj.additional_properties[_key] = obj.get(_key)
132
133        return _obj