miro_api.models.group_list_response_resources_inner

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.group_list_response_resources_inner_members_inner import (
 22    GroupListResponseResourcesInnerMembersInner,
 23)
 24from miro_api.models.group_list_response_resources_inner_meta import GroupListResponseResourcesInnerMeta
 25from typing import Optional, Set
 26from typing_extensions import Self
 27
 28
 29class GroupListResponseResourcesInner(BaseModel):
 30    """
 31    GroupListResponseResourcesInner
 32    """  # noqa: E501
 33
 34    schemas: Optional[List[StrictStr]] = Field(
 35        default=None,
 36        description="Identifies which schema(s) this resource uses. In this case it is the SCIM core Groups schema.",
 37    )
 38    id: Optional[StrictStr] = Field(
 39        default=None, description="A server-assigned, unique identifier for this Group (team)."
 40    )
 41    display_name: Optional[StrictStr] = Field(
 42        default=None, description="A human readable name for the Group (team).", alias="displayName"
 43    )
 44    members: Optional[List[GroupListResponseResourcesInnerMembersInner]] = Field(
 45        default=None, description="A list of all members that are part of the Group (team)."
 46    )
 47    meta: Optional[GroupListResponseResourcesInnerMeta] = None
 48    additional_properties: Dict[str, Any] = {}
 49    __properties: ClassVar[List[str]] = ["schemas", "id", "displayName", "members", "meta"]
 50
 51    model_config = {
 52        "populate_by_name": True,
 53        "validate_assignment": True,
 54        "protected_namespaces": (),
 55    }
 56
 57    def to_str(self) -> str:
 58        """Returns the string representation of the model using alias"""
 59        return pprint.pformat(self.model_dump(by_alias=True))
 60
 61    def to_json(self) -> str:
 62        """Returns the JSON representation of the model using alias"""
 63        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 64        return json.dumps(self.to_dict())
 65
 66    @classmethod
 67    def from_json(cls, json_str: str) -> Optional[Self]:
 68        """Create an instance of GroupListResponseResourcesInner from a JSON string"""
 69        return cls.from_dict(json.loads(json_str))
 70
 71    def to_dict(self) -> Dict[str, Any]:
 72        """Return the dictionary representation of the model using alias.
 73
 74        This has the following differences from calling pydantic's
 75        `self.model_dump(by_alias=True)`:
 76
 77        * `None` is only added to the output dict for nullable fields that
 78          were set at model initialization. Other fields with value `None`
 79          are ignored.
 80        * Fields in `self.additional_properties` are added to the output dict.
 81        """
 82        excluded_fields: Set[str] = set(
 83            [
 84                "additional_properties",
 85            ]
 86        )
 87
 88        _dict = self.model_dump(
 89            by_alias=True,
 90            exclude=excluded_fields,
 91            exclude_none=True,
 92        )
 93        # override the default output from pydantic by calling `to_dict()` of each item in members (list)
 94        _items = []
 95        if self.members:
 96            for _item in self.members:
 97                if _item:
 98                    _items.append(_item.to_dict())
 99            _dict["members"] = _items
100        # override the default output from pydantic by calling `to_dict()` of meta
101        if self.meta:
102            _dict["meta"] = self.meta.to_dict()
103        # puts key-value pairs in additional_properties in the top level
104        if self.additional_properties is not None:
105            for _key, _value in self.additional_properties.items():
106                _dict[_key] = _value
107
108        return _dict
109
110    @classmethod
111    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
112        """Create an instance of GroupListResponseResourcesInner from a dict"""
113        if obj is None:
114            return None
115
116        if not isinstance(obj, dict):
117            return cls.model_validate(obj)
118
119        _obj = cls.model_validate(
120            {
121                "schemas": obj.get("schemas"),
122                "id": obj.get("id"),
123                "displayName": obj.get("displayName"),
124                "members": (
125                    [GroupListResponseResourcesInnerMembersInner.from_dict(_item) for _item in obj["members"]]
126                    if obj.get("members") is not None
127                    else None
128                ),
129                "meta": (
130                    GroupListResponseResourcesInnerMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None
131                ),
132            }
133        )
134        # store additional fields in additional_properties
135        for _key in obj.keys():
136            if _key not in cls.__properties:
137                _obj.additional_properties[_key] = obj.get(_key)
138
139        return _obj

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

 30class GroupListResponseResourcesInner(BaseModel):
 31    """
 32    GroupListResponseResourcesInner
 33    """  # noqa: E501
 34
 35    schemas: Optional[List[StrictStr]] = Field(
 36        default=None,
 37        description="Identifies which schema(s) this resource uses. In this case it is the SCIM core Groups schema.",
 38    )
 39    id: Optional[StrictStr] = Field(
 40        default=None, description="A server-assigned, unique identifier for this Group (team)."
 41    )
 42    display_name: Optional[StrictStr] = Field(
 43        default=None, description="A human readable name for the Group (team).", alias="displayName"
 44    )
 45    members: Optional[List[GroupListResponseResourcesInnerMembersInner]] = Field(
 46        default=None, description="A list of all members that are part of the Group (team)."
 47    )
 48    meta: Optional[GroupListResponseResourcesInnerMeta] = None
 49    additional_properties: Dict[str, Any] = {}
 50    __properties: ClassVar[List[str]] = ["schemas", "id", "displayName", "members", "meta"]
 51
 52    model_config = {
 53        "populate_by_name": True,
 54        "validate_assignment": True,
 55        "protected_namespaces": (),
 56    }
 57
 58    def to_str(self) -> str:
 59        """Returns the string representation of the model using alias"""
 60        return pprint.pformat(self.model_dump(by_alias=True))
 61
 62    def to_json(self) -> str:
 63        """Returns the JSON representation of the model using alias"""
 64        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 65        return json.dumps(self.to_dict())
 66
 67    @classmethod
 68    def from_json(cls, json_str: str) -> Optional[Self]:
 69        """Create an instance of GroupListResponseResourcesInner from a JSON string"""
 70        return cls.from_dict(json.loads(json_str))
 71
 72    def to_dict(self) -> Dict[str, Any]:
 73        """Return the dictionary representation of the model using alias.
 74
 75        This has the following differences from calling pydantic's
 76        `self.model_dump(by_alias=True)`:
 77
 78        * `None` is only added to the output dict for nullable fields that
 79          were set at model initialization. Other fields with value `None`
 80          are ignored.
 81        * Fields in `self.additional_properties` are added to the output dict.
 82        """
 83        excluded_fields: Set[str] = set(
 84            [
 85                "additional_properties",
 86            ]
 87        )
 88
 89        _dict = self.model_dump(
 90            by_alias=True,
 91            exclude=excluded_fields,
 92            exclude_none=True,
 93        )
 94        # override the default output from pydantic by calling `to_dict()` of each item in members (list)
 95        _items = []
 96        if self.members:
 97            for _item in self.members:
 98                if _item:
 99                    _items.append(_item.to_dict())
100            _dict["members"] = _items
101        # override the default output from pydantic by calling `to_dict()` of meta
102        if self.meta:
103            _dict["meta"] = self.meta.to_dict()
104        # puts key-value pairs in additional_properties in the top level
105        if self.additional_properties is not None:
106            for _key, _value in self.additional_properties.items():
107                _dict[_key] = _value
108
109        return _dict
110
111    @classmethod
112    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
113        """Create an instance of GroupListResponseResourcesInner from a dict"""
114        if obj is None:
115            return None
116
117        if not isinstance(obj, dict):
118            return cls.model_validate(obj)
119
120        _obj = cls.model_validate(
121            {
122                "schemas": obj.get("schemas"),
123                "id": obj.get("id"),
124                "displayName": obj.get("displayName"),
125                "members": (
126                    [GroupListResponseResourcesInnerMembersInner.from_dict(_item) for _item in obj["members"]]
127                    if obj.get("members") is not None
128                    else None
129                ),
130                "meta": (
131                    GroupListResponseResourcesInnerMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None
132                ),
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

GroupListResponseResourcesInner

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

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

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

members: Optional[List[miro_api.models.group_list_response_resources_inner_members_inner.GroupListResponseResourcesInnerMembersInner]]

meta: Optional[miro_api.models.group_list_response_resources_inner_meta.GroupListResponseResourcesInnerMeta]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

67    @classmethod
68    def from_json(cls, json_str: str) -> Optional[Self]:
69        """Create an instance of GroupListResponseResourcesInner from a JSON string"""
70        return cls.from_dict(json.loads(json_str))

Create an instance of GroupListResponseResourcesInner from a JSON string

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

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

111    @classmethod
112    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
113        """Create an instance of GroupListResponseResourcesInner from a dict"""
114        if obj is None:
115            return None
116
117        if not isinstance(obj, dict):
118            return cls.model_validate(obj)
119
120        _obj = cls.model_validate(
121            {
122                "schemas": obj.get("schemas"),
123                "id": obj.get("id"),
124                "displayName": obj.get("displayName"),
125                "members": (
126                    [GroupListResponseResourcesInnerMembersInner.from_dict(_item) for _item in obj["members"]]
127                    if obj.get("members") is not None
128                    else None
129                ),
130                "meta": (
131                    GroupListResponseResourcesInnerMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None
132                ),
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

Create an instance of GroupListResponseResourcesInner 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 = {'schemas': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, description='Identifies which schema(s) this resource uses. In this case it is the SCIM core Groups schema.'), 'id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='A server-assigned, unique identifier for this Group (team).'), 'display_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='displayName', alias_priority=2, description='A human readable name for the Group (team).'), 'members': FieldInfo(annotation=Union[List[miro_api.models.group_list_response_resources_inner_members_inner.GroupListResponseResourcesInnerMembersInner], NoneType], required=False, description='A list of all members that are part of the Group (team).'), 'meta': FieldInfo(annotation=Union[GroupListResponseResourcesInnerMeta, 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