miro_api.models.audit_event

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 datetime import datetime
 20from pydantic import BaseModel, Field, StrictStr
 21from typing import Any, ClassVar, Dict, List, Optional
 22from miro_api.models.audit_context import AuditContext
 23from miro_api.models.audit_created_by import AuditCreatedBy
 24from miro_api.models.audit_object import AuditObject
 25from typing import Optional, Set
 26from typing_extensions import Self
 27
 28
 29class AuditEvent(BaseModel):
 30    """
 31    AuditEvent
 32    """  # noqa: E501
 33
 34    id: Optional[StrictStr] = Field(default=None, description="Audit event id")
 35    context: Optional[AuditContext] = None
 36    object: Optional[AuditObject] = None
 37    created_at: Optional[datetime] = Field(
 38        default=None, description="Time when the audit event has been created", alias="createdAt"
 39    )
 40    details: Optional[Dict[str, Any]] = Field(default=None, description="Details json related to the audit event")
 41    created_by: Optional[AuditCreatedBy] = Field(default=None, alias="createdBy")
 42    event: Optional[StrictStr] = Field(default=None, description="Event type of the audit event")
 43    category: Optional[StrictStr] = Field(default=None, description="Event category of the audit event.")
 44    additional_properties: Dict[str, Any] = {}
 45    __properties: ClassVar[List[str]] = [
 46        "id",
 47        "context",
 48        "object",
 49        "createdAt",
 50        "details",
 51        "createdBy",
 52        "event",
 53        "category",
 54    ]
 55
 56    model_config = {
 57        "populate_by_name": True,
 58        "validate_assignment": True,
 59        "protected_namespaces": (),
 60    }
 61
 62    def to_str(self) -> str:
 63        """Returns the string representation of the model using alias"""
 64        return pprint.pformat(self.model_dump(by_alias=True))
 65
 66    def to_json(self) -> str:
 67        """Returns the JSON representation of the model using alias"""
 68        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 69        return json.dumps(self.to_dict())
 70
 71    @classmethod
 72    def from_json(cls, json_str: str) -> Optional[Self]:
 73        """Create an instance of AuditEvent from a JSON string"""
 74        return cls.from_dict(json.loads(json_str))
 75
 76    def to_dict(self) -> Dict[str, Any]:
 77        """Return the dictionary representation of the model using alias.
 78
 79        This has the following differences from calling pydantic's
 80        `self.model_dump(by_alias=True)`:
 81
 82        * `None` is only added to the output dict for nullable fields that
 83          were set at model initialization. Other fields with value `None`
 84          are ignored.
 85        * Fields in `self.additional_properties` are added to the output dict.
 86        """
 87        excluded_fields: Set[str] = set(
 88            [
 89                "additional_properties",
 90            ]
 91        )
 92
 93        _dict = self.model_dump(
 94            by_alias=True,
 95            exclude=excluded_fields,
 96            exclude_none=True,
 97        )
 98        # override the default output from pydantic by calling `to_dict()` of context
 99        if self.context:
100            _dict["context"] = self.context.to_dict()
101        # override the default output from pydantic by calling `to_dict()` of object
102        if self.object:
103            _dict["object"] = self.object.to_dict()
104        # override the default output from pydantic by calling `to_dict()` of created_by
105        if self.created_by:
106            _dict["createdBy"] = self.created_by.to_dict()
107        # puts key-value pairs in additional_properties in the top level
108        if self.additional_properties is not None:
109            for _key, _value in self.additional_properties.items():
110                _dict[_key] = _value
111
112        return _dict
113
114    @classmethod
115    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
116        """Create an instance of AuditEvent from a dict"""
117        if obj is None:
118            return None
119
120        if not isinstance(obj, dict):
121            return cls.model_validate(obj)
122
123        _obj = cls.model_validate(
124            {
125                "id": obj.get("id"),
126                "context": AuditContext.from_dict(obj["context"]) if obj.get("context") is not None else None,
127                "object": AuditObject.from_dict(obj["object"]) if obj.get("object") is not None else None,
128                "createdAt": obj.get("createdAt"),
129                "details": obj.get("details"),
130                "createdBy": AuditCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
131                "event": obj.get("event"),
132                "category": obj.get("category"),
133            }
134        )
135        # store additional fields in additional_properties
136        for _key in obj.keys():
137            if _key not in cls.__properties:
138                _obj.additional_properties[_key] = obj.get(_key)
139
140        return _obj

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

 30class AuditEvent(BaseModel):
 31    """
 32    AuditEvent
 33    """  # noqa: E501
 34
 35    id: Optional[StrictStr] = Field(default=None, description="Audit event id")
 36    context: Optional[AuditContext] = None
 37    object: Optional[AuditObject] = None
 38    created_at: Optional[datetime] = Field(
 39        default=None, description="Time when the audit event has been created", alias="createdAt"
 40    )
 41    details: Optional[Dict[str, Any]] = Field(default=None, description="Details json related to the audit event")
 42    created_by: Optional[AuditCreatedBy] = Field(default=None, alias="createdBy")
 43    event: Optional[StrictStr] = Field(default=None, description="Event type of the audit event")
 44    category: Optional[StrictStr] = Field(default=None, description="Event category of the audit event.")
 45    additional_properties: Dict[str, Any] = {}
 46    __properties: ClassVar[List[str]] = [
 47        "id",
 48        "context",
 49        "object",
 50        "createdAt",
 51        "details",
 52        "createdBy",
 53        "event",
 54        "category",
 55    ]
 56
 57    model_config = {
 58        "populate_by_name": True,
 59        "validate_assignment": True,
 60        "protected_namespaces": (),
 61    }
 62
 63    def to_str(self) -> str:
 64        """Returns the string representation of the model using alias"""
 65        return pprint.pformat(self.model_dump(by_alias=True))
 66
 67    def to_json(self) -> str:
 68        """Returns the JSON representation of the model using alias"""
 69        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 70        return json.dumps(self.to_dict())
 71
 72    @classmethod
 73    def from_json(cls, json_str: str) -> Optional[Self]:
 74        """Create an instance of AuditEvent from a JSON string"""
 75        return cls.from_dict(json.loads(json_str))
 76
 77    def to_dict(self) -> Dict[str, Any]:
 78        """Return the dictionary representation of the model using alias.
 79
 80        This has the following differences from calling pydantic's
 81        `self.model_dump(by_alias=True)`:
 82
 83        * `None` is only added to the output dict for nullable fields that
 84          were set at model initialization. Other fields with value `None`
 85          are ignored.
 86        * Fields in `self.additional_properties` are added to the output dict.
 87        """
 88        excluded_fields: Set[str] = set(
 89            [
 90                "additional_properties",
 91            ]
 92        )
 93
 94        _dict = self.model_dump(
 95            by_alias=True,
 96            exclude=excluded_fields,
 97            exclude_none=True,
 98        )
 99        # override the default output from pydantic by calling `to_dict()` of context
100        if self.context:
101            _dict["context"] = self.context.to_dict()
102        # override the default output from pydantic by calling `to_dict()` of object
103        if self.object:
104            _dict["object"] = self.object.to_dict()
105        # override the default output from pydantic by calling `to_dict()` of created_by
106        if self.created_by:
107            _dict["createdBy"] = self.created_by.to_dict()
108        # puts key-value pairs in additional_properties in the top level
109        if self.additional_properties is not None:
110            for _key, _value in self.additional_properties.items():
111                _dict[_key] = _value
112
113        return _dict
114
115    @classmethod
116    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
117        """Create an instance of AuditEvent from a dict"""
118        if obj is None:
119            return None
120
121        if not isinstance(obj, dict):
122            return cls.model_validate(obj)
123
124        _obj = cls.model_validate(
125            {
126                "id": obj.get("id"),
127                "context": AuditContext.from_dict(obj["context"]) if obj.get("context") is not None else None,
128                "object": AuditObject.from_dict(obj["object"]) if obj.get("object") is not None else None,
129                "createdAt": obj.get("createdAt"),
130                "details": obj.get("details"),
131                "createdBy": AuditCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
132                "event": obj.get("event"),
133                "category": obj.get("category"),
134            }
135        )
136        # store additional fields in additional_properties
137        for _key in obj.keys():
138            if _key not in cls.__properties:
139                _obj.additional_properties[_key] = obj.get(_key)
140
141        return _obj

AuditEvent

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

context: Optional[miro_api.models.audit_context.AuditContext]

object: Optional[miro_api.models.audit_object.AuditObject]

created_at: Optional[datetime.datetime]

details: Optional[Dict[str, Any]]

created_by: Optional[miro_api.models.audit_created_by.AuditCreatedBy]

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

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

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

63    def to_str(self) -> str:
64        """Returns the string representation of the model using alias"""
65        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

67    def to_json(self) -> str:
68        """Returns the JSON representation of the model using alias"""
69        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
70        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

72    @classmethod
73    def from_json(cls, json_str: str) -> Optional[Self]:
74        """Create an instance of AuditEvent from a JSON string"""
75        return cls.from_dict(json.loads(json_str))

Create an instance of AuditEvent from a JSON string

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

 77    def to_dict(self) -> Dict[str, Any]:
 78        """Return the dictionary representation of the model using alias.
 79
 80        This has the following differences from calling pydantic's
 81        `self.model_dump(by_alias=True)`:
 82
 83        * `None` is only added to the output dict for nullable fields that
 84          were set at model initialization. Other fields with value `None`
 85          are ignored.
 86        * Fields in `self.additional_properties` are added to the output dict.
 87        """
 88        excluded_fields: Set[str] = set(
 89            [
 90                "additional_properties",
 91            ]
 92        )
 93
 94        _dict = self.model_dump(
 95            by_alias=True,
 96            exclude=excluded_fields,
 97            exclude_none=True,
 98        )
 99        # override the default output from pydantic by calling `to_dict()` of context
100        if self.context:
101            _dict["context"] = self.context.to_dict()
102        # override the default output from pydantic by calling `to_dict()` of object
103        if self.object:
104            _dict["object"] = self.object.to_dict()
105        # override the default output from pydantic by calling `to_dict()` of created_by
106        if self.created_by:
107            _dict["createdBy"] = self.created_by.to_dict()
108        # puts key-value pairs in additional_properties in the top level
109        if self.additional_properties is not None:
110            for _key, _value in self.additional_properties.items():
111                _dict[_key] = _value
112
113        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

115    @classmethod
116    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
117        """Create an instance of AuditEvent from a dict"""
118        if obj is None:
119            return None
120
121        if not isinstance(obj, dict):
122            return cls.model_validate(obj)
123
124        _obj = cls.model_validate(
125            {
126                "id": obj.get("id"),
127                "context": AuditContext.from_dict(obj["context"]) if obj.get("context") is not None else None,
128                "object": AuditObject.from_dict(obj["object"]) if obj.get("object") is not None else None,
129                "createdAt": obj.get("createdAt"),
130                "details": obj.get("details"),
131                "createdBy": AuditCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
132                "event": obj.get("event"),
133                "category": obj.get("category"),
134            }
135        )
136        # store additional fields in additional_properties
137        for _key in obj.keys():
138            if _key not in cls.__properties:
139                _obj.additional_properties[_key] = obj.get(_key)
140
141        return _obj

Create an instance of AuditEvent 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 = {'id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Audit event id'), 'context': FieldInfo(annotation=Union[AuditContext, NoneType], required=False), 'object': FieldInfo(annotation=Union[AuditObject, NoneType], required=False), 'created_at': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='createdAt', alias_priority=2, description='Time when the audit event has been created'), 'details': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False, description='Details json related to the audit event'), 'created_by': FieldInfo(annotation=Union[AuditCreatedBy, NoneType], required=False, alias='createdBy', alias_priority=2), 'event': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Event type of the audit event'), 'category': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Event category of the audit event.'), '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