miro_api.models.audit_context

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

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

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

Audit context

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

team: Optional[miro_api.models.audit_team.AuditTeam]

organization: Optional[miro_api.models.audit_organization.AuditOrganization]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

54    @classmethod
55    def from_json(cls, json_str: str) -> Optional[Self]:
56        """Create an instance of AuditContext from a JSON string"""
57        return cls.from_dict(json.loads(json_str))

Create an instance of AuditContext from a JSON string

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

59    def to_dict(self) -> Dict[str, Any]:
60        """Return the dictionary representation of the model using alias.
61
62        This has the following differences from calling pydantic's
63        `self.model_dump(by_alias=True)`:
64
65        * `None` is only added to the output dict for nullable fields that
66          were set at model initialization. Other fields with value `None`
67          are ignored.
68        * Fields in `self.additional_properties` are added to the output dict.
69        """
70        excluded_fields: Set[str] = set(
71            [
72                "additional_properties",
73            ]
74        )
75
76        _dict = self.model_dump(
77            by_alias=True,
78            exclude=excluded_fields,
79            exclude_none=True,
80        )
81        # override the default output from pydantic by calling `to_dict()` of team
82        if self.team:
83            _dict["team"] = self.team.to_dict()
84        # override the default output from pydantic by calling `to_dict()` of organization
85        if self.organization:
86            _dict["organization"] = self.organization.to_dict()
87        # puts key-value pairs in additional_properties in the top level
88        if self.additional_properties is not None:
89            for _key, _value in self.additional_properties.items():
90                _dict[_key] = _value
91
92        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

 94    @classmethod
 95    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 96        """Create an instance of AuditContext from a dict"""
 97        if obj is None:
 98            return None
 99
100        if not isinstance(obj, dict):
101            return cls.model_validate(obj)
102
103        _obj = cls.model_validate(
104            {
105                "ip": obj.get("ip"),
106                "team": AuditTeam.from_dict(obj["team"]) if obj.get("team") is not None else None,
107                "organization": (
108                    AuditOrganization.from_dict(obj["organization"]) if obj.get("organization") is not None else None
109                ),
110            }
111        )
112        # store additional fields in additional_properties
113        for _key in obj.keys():
114            if _key not in cls.__properties:
115                _obj.additional_properties[_key] = obj.get(_key)
116
117        return _obj

Create an instance of AuditContext 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 = {'ip': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Ip address associated with the audit context'), 'team': FieldInfo(annotation=Union[AuditTeam, NoneType], required=False), 'organization': FieldInfo(annotation=Union[AuditOrganization, NoneType], required=False), '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