miro_api.models.audit_page

  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, StrictStr
 21from typing import Any, ClassVar, Dict, List, Optional
 22from miro_api.models.audit_event import AuditEvent
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class AuditPage(BaseModel):
 28    """
 29    AuditPage
 30    """  # noqa: E501
 31
 32    type: Optional[StrictStr] = Field(
 33        default=None, description="Type of the response, in this case it's always 'cursor-list'"
 34    )
 35    limit: Optional[StrictInt] = Field(default=None, description="Page limit")
 36    size: Optional[StrictInt] = Field(default=None, description="Item count in current page")
 37    cursor: Optional[StrictStr] = Field(
 38        default=None, description="The key that should be used as the cursor request parameter to fetch the next page"
 39    )
 40    data: Optional[List[AuditEvent]] = Field(default=None, description="Audit events list")
 41    additional_properties: Dict[str, Any] = {}
 42    __properties: ClassVar[List[str]] = ["type", "limit", "size", "cursor", "data"]
 43
 44    model_config = {
 45        "populate_by_name": True,
 46        "validate_assignment": True,
 47        "protected_namespaces": (),
 48    }
 49
 50    def to_str(self) -> str:
 51        """Returns the string representation of the model using alias"""
 52        return pprint.pformat(self.model_dump(by_alias=True))
 53
 54    def to_json(self) -> str:
 55        """Returns the JSON representation of the model using alias"""
 56        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 57        return json.dumps(self.to_dict())
 58
 59    @classmethod
 60    def from_json(cls, json_str: str) -> Optional[Self]:
 61        """Create an instance of AuditPage from a JSON string"""
 62        return cls.from_dict(json.loads(json_str))
 63
 64    def to_dict(self) -> Dict[str, Any]:
 65        """Return the dictionary representation of the model using alias.
 66
 67        This has the following differences from calling pydantic's
 68        `self.model_dump(by_alias=True)`:
 69
 70        * `None` is only added to the output dict for nullable fields that
 71          were set at model initialization. Other fields with value `None`
 72          are ignored.
 73        * Fields in `self.additional_properties` are added to the output dict.
 74        """
 75        excluded_fields: Set[str] = set(
 76            [
 77                "additional_properties",
 78            ]
 79        )
 80
 81        _dict = self.model_dump(
 82            by_alias=True,
 83            exclude=excluded_fields,
 84            exclude_none=True,
 85        )
 86        # override the default output from pydantic by calling `to_dict()` of each item in data (list)
 87        _items = []
 88        if self.data:
 89            for _item in self.data:
 90                if _item:
 91                    _items.append(_item.to_dict())
 92            _dict["data"] = _items
 93        # puts key-value pairs in additional_properties in the top level
 94        if self.additional_properties is not None:
 95            for _key, _value in self.additional_properties.items():
 96                _dict[_key] = _value
 97
 98        return _dict
 99
100    @classmethod
101    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
102        """Create an instance of AuditPage from a dict"""
103        if obj is None:
104            return None
105
106        if not isinstance(obj, dict):
107            return cls.model_validate(obj)
108
109        _obj = cls.model_validate(
110            {
111                "type": obj.get("type"),
112                "limit": obj.get("limit"),
113                "size": obj.get("size"),
114                "cursor": obj.get("cursor"),
115                "data": [AuditEvent.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
116            }
117        )
118        # store additional fields in additional_properties
119        for _key in obj.keys():
120            if _key not in cls.__properties:
121                _obj.additional_properties[_key] = obj.get(_key)
122
123        return _obj