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
 14from __future__ import annotations
 15import pprint
 16import re  # noqa: F401
 17import json
 18
 19from pydantic import BaseModel, Field, StrictInt
 20from typing import Any, ClassVar, Dict, List, Optional
 21from typing import Optional, Set
 22from typing_extensions import Self
 23
 24
 25class GetMetricsTotal200Response(BaseModel):
 26    """
 27    GetMetricsTotal200Response
 28    """  # noqa: E501
 29
 30    unique_users: Optional[StrictInt] = Field(
 31        default=None,
 32        description="Number of unique users who performed at least one activity in the application.",
 33        alias="uniqueUsers",
 34    )
 35    unique_recurring_users: Optional[StrictInt] = Field(
 36        default=None,
 37        description="Number of unique users who have been active for more than one day over the past 30 days.",
 38        alias="uniqueRecurringUsers",
 39    )
 40    unique_organizations: Optional[StrictInt] = Field(
 41        default=None,
 42        description="Number of unique company accounts that have installed the application.",
 43        alias="uniqueOrganizations",
 44    )
 45    installations: Optional[StrictInt] = Field(
 46        default=None, description="Number of application installations for a team."
 47    )
 48    uninstallations: Optional[StrictInt] = Field(
 49        default=None, description="Number of application uninstallations for a team."
 50    )
 51    additional_properties: Dict[str, Any] = {}
 52    __properties: ClassVar[List[str]] = [
 53        "uniqueUsers",
 54        "uniqueRecurringUsers",
 55        "uniqueOrganizations",
 56        "installations",
 57        "uninstallations",
 58    ]
 59
 60    model_config = {
 61        "populate_by_name": True,
 62        "validate_assignment": True,
 63        "protected_namespaces": (),
 64    }
 65
 66    def to_str(self) -> str:
 67        """Returns the string representation of the model using alias"""
 68        return pprint.pformat(self.model_dump(by_alias=True))
 69
 70    def to_json(self) -> str:
 71        """Returns the JSON representation of the model using alias"""
 72        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 73        return json.dumps(self.to_dict())
 74
 75    @classmethod
 76    def from_json(cls, json_str: str) -> Optional[Self]:
 77        """Create an instance of GetMetricsTotal200Response from a JSON string"""
 78        return cls.from_dict(json.loads(json_str))
 79
 80    def to_dict(self) -> Dict[str, Any]:
 81        """Return the dictionary representation of the model using alias.
 82
 83        This has the following differences from calling pydantic's
 84        `self.model_dump(by_alias=True)`:
 85
 86        * `None` is only added to the output dict for nullable fields that
 87          were set at model initialization. Other fields with value `None`
 88          are ignored.
 89        * Fields in `self.additional_properties` are added to the output dict.
 90        """
 91        excluded_fields: Set[str] = set(
 92            [
 93                "additional_properties",
 94            ]
 95        )
 96
 97        _dict = self.model_dump(
 98            by_alias=True,
 99            exclude=excluded_fields,
100            exclude_none=True,
101        )
102        # puts key-value pairs in additional_properties in the top level
103        if self.additional_properties is not None:
104            for _key, _value in self.additional_properties.items():
105                _dict[_key] = _value
106
107        return _dict
108
109    @classmethod
110    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
111        """Create an instance of GetMetricsTotal200Response from a dict"""
112        if obj is None:
113            return None
114
115        if not isinstance(obj, dict):
116            return cls.model_validate(obj)
117
118        _obj = cls.model_validate(
119            {
120                "uniqueUsers": obj.get("uniqueUsers"),
121                "uniqueRecurringUsers": obj.get("uniqueRecurringUsers"),
122                "uniqueOrganizations": obj.get("uniqueOrganizations"),
123                "installations": obj.get("installations"),
124                "uninstallations": obj.get("uninstallations"),
125            }
126        )
127        # store additional fields in additional_properties
128        for _key in obj.keys():
129            if _key not in cls.__properties:
130                _obj.additional_properties[_key] = obj.get(_key)
131
132        return _obj