miro_api.models.group_resource

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

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

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

GroupResource

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

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

meta: Optional[miro_api.models.group_resource_meta.GroupResourceMeta]

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

members: Optional[List[miro_api.models.group_resource_members_inner.GroupResourceMembersInner]]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

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

Create an instance of GroupResource from a JSON string

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

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

109    @classmethod
110    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
111        """Create an instance of GroupResource from a dict"""
112        if obj is None:
113            return None
114
115        if not isinstance(obj, dict):
116            return cls.model_validate(obj)
117
118        _obj = cls.model_validate(
119            {
120                "schemas": obj.get("schemas"),
121                "id": obj.get("id"),
122                "meta": GroupResourceMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None,
123                "displayName": obj.get("displayName"),
124                "members": (
125                    [GroupResourceMembersInner.from_dict(_item) for _item in obj["members"]]
126                    if obj.get("members") is not None
127                    else None
128                ),
129            }
130        )
131        # store additional fields in additional_properties
132        for _key in obj.keys():
133            if _key not in cls.__properties:
134                _obj.additional_properties[_key] = obj.get(_key)
135
136        return _obj

Create an instance of GroupResource 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).'), 'meta': FieldInfo(annotation=Union[GroupResourceMeta, NoneType], required=False), '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_resource_members_inner.GroupResourceMembersInner], NoneType], required=False, description='A list of all members that are part of the Group (team).'), '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