miro_api.models.legal_hold_request_scope_users

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

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

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

LegalHoldRequestScopeUsers

users: Optional[List[miro_api.models.legal_hold_request_scope_users_users_inner.LegalHoldRequestScopeUsersUsersInner]]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

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

Create an instance of LegalHoldRequestScopeUsers from a JSON string

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

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

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

Create an instance of LegalHoldRequestScopeUsers 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 = {'users': FieldInfo(annotation=Union[List[miro_api.models.legal_hold_request_scope_users_users_inner.LegalHoldRequestScopeUsersUsersInner], 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