miro_api.models.audit_page

Miro Developer Platform

### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? Read our introduction page and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - Quickstart (video): try the REST API in less than 3 minutes. - Quickstart (article): 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 ### Miro App Examples Clone our Miro App Examples repository to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.

The version of the OpenAPI document: v2.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

View Source

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

class AuditPage(pydantic.main.BaseModel): View Source

 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

AuditPage

type: Optional[Annotated[str, Strict(strict=True)]]

limit: Optional[Annotated[int, Strict(strict=True)]]

size: Optional[Annotated[int, Strict(strict=True)]]

cursor: Optional[Annotated[str, Strict(strict=True)]]

data: Optional[List[miro_api.models.audit_event.AuditEvent]]

additional_properties: Dict[str, Any]

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}

def to_str(self) -> str: View Source

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))

Returns the string representation of the model using alias

def to_json(self) -> str: View Source

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())

Returns the JSON representation of the model using alias

@classmethod

def from_json(cls, json_str: str) -> Optional[typing_extensions.Self]: View Source

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))

Create an instance of AuditPage from a JSON string

def to_dict(self) -> Dict[str, Any]: View Source

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

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.
Fields in self.additional_properties are added to the output dict.

@classmethod

def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[typing_extensions.Self]: View Source

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

Create an instance of AuditPage from a dict

def model_post_init(self: pydantic.main.BaseModel, __context: Any) -> None: View Source

265def init_private_attributes(self: BaseModel, __context: Any) -> None:
266    """This function is meant to behave like a BaseModel method to initialise private attributes.
267
268    It takes context as an argument since that's what pydantic-core passes when calling it.
269
270    Args:
271        self: The BaseModel instance.
272        __context: The context.
273    """
274    if getattr(self, '__pydantic_private__', None) is None:
275        pydantic_private = {}
276        for name, private_attr in self.__private_attributes__.items():
277            default = private_attr.get_default()
278            if default is not PydanticUndefined:
279                pydantic_private[name] = default
280        object_setattr(self, '__pydantic_private__', pydantic_private)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Args: self: The BaseModel instance. __context: The context.

model_fields = {'type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description="Type of the response, in this case it's always 'cursor-list'"), 'limit': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, description='Page limit'), 'size': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, description='Item count in current page'), 'cursor': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='The key that should be used as the cursor request parameter to fetch the next page'), 'data': FieldInfo(annotation=Union[List[miro_api.models.audit_event.AuditEvent], NoneType], required=False, description='Audit events list'), 'additional_properties': FieldInfo(annotation=Dict[str, Any], required=False, default={})}

model_computed_fields = {}

Inherited Members

pydantic.main.BaseModel: BaseModel; model_extra; model_fields_set; model_construct; model_copy; model_dump; model_dump_json; model_json_schema; model_parametrized_name; model_rebuild; model_validate; model_validate_json; model_validate_strings; dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs