miro_api.models.patch_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, field_validator
 20from typing import Any, ClassVar, Dict, List
 21from miro_api.models.patch_group_resource_operations_inner import PatchGroupResourceOperationsInner
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class PatchGroupResource(BaseModel):
 27    """
 28    PatchGroupResource
 29    """  # noqa: E501
 30
 31    schemas: List[StrictStr] = Field(
 32        description="Identifies which schema(s) this resource uses. In this case it is the PatchOp schema."
 33    )
 34    operations: List[PatchGroupResourceOperationsInner] = Field(
 35        description='A list of patch operations. <br><br> Multiple users can be added or removed from the group (team) in one request. use the array to add or remove multiple users.<br><br> For updating security group name: <br> "op"="replace", "value"={"id":"13266533725732", "displayName":"New group name"} must be provided in the Operations array.',
 36        alias="Operations",
 37    )
 38    additional_properties: Dict[str, Any] = {}
 39    __properties: ClassVar[List[str]] = ["schemas", "Operations"]
 40
 41    @field_validator("schemas")
 42    def schemas_validate_enum(cls, value):
 43        """Validates the enum"""
 44        for i in value:
 45            if i not in set([]):
 46                raise ValueError("each list item must be one of ()")
 47        return value
 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 PatchGroupResource 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 each item in operations (list)
 92        _items = []
 93        if self.operations:
 94            for _item in self.operations:
 95                if _item:
 96                    _items.append(_item.to_dict())
 97            _dict["Operations"] = _items
 98        # puts key-value pairs in additional_properties in the top level
 99        if self.additional_properties is not None:
100            for _key, _value in self.additional_properties.items():
101                _dict[_key] = _value
102
103        return _dict
104
105    @classmethod
106    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
107        """Create an instance of PatchGroupResource from a dict"""
108        if obj is None:
109            return None
110
111        if not isinstance(obj, dict):
112            return cls.model_validate(obj)
113
114        _obj = cls.model_validate(
115            {
116                "schemas": obj.get("schemas"),
117                "Operations": (
118                    [PatchGroupResourceOperationsInner.from_dict(_item) for _item in obj["Operations"]]
119                    if obj.get("Operations") is not None
120                    else None
121                ),
122            }
123        )
124        # store additional fields in additional_properties
125        for _key in obj.keys():
126            if _key not in cls.__properties:
127                _obj.additional_properties[_key] = obj.get(_key)
128
129        return _obj

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

 27class PatchGroupResource(BaseModel):
 28    """
 29    PatchGroupResource
 30    """  # noqa: E501
 31
 32    schemas: List[StrictStr] = Field(
 33        description="Identifies which schema(s) this resource uses. In this case it is the PatchOp schema."
 34    )
 35    operations: List[PatchGroupResourceOperationsInner] = Field(
 36        description='A list of patch operations. <br><br> Multiple users can be added or removed from the group (team) in one request. use the array to add or remove multiple users.<br><br> For updating security group name: <br> "op"="replace", "value"={"id":"13266533725732", "displayName":"New group name"} must be provided in the Operations array.',
 37        alias="Operations",
 38    )
 39    additional_properties: Dict[str, Any] = {}
 40    __properties: ClassVar[List[str]] = ["schemas", "Operations"]
 41
 42    @field_validator("schemas")
 43    def schemas_validate_enum(cls, value):
 44        """Validates the enum"""
 45        for i in value:
 46            if i not in set([]):
 47                raise ValueError("each list item must be one of ()")
 48        return value
 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 PatchGroupResource 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 each item in operations (list)
 93        _items = []
 94        if self.operations:
 95            for _item in self.operations:
 96                if _item:
 97                    _items.append(_item.to_dict())
 98            _dict["Operations"] = _items
 99        # puts key-value pairs in additional_properties in the top level
100        if self.additional_properties is not None:
101            for _key, _value in self.additional_properties.items():
102                _dict[_key] = _value
103
104        return _dict
105
106    @classmethod
107    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
108        """Create an instance of PatchGroupResource from a dict"""
109        if obj is None:
110            return None
111
112        if not isinstance(obj, dict):
113            return cls.model_validate(obj)
114
115        _obj = cls.model_validate(
116            {
117                "schemas": obj.get("schemas"),
118                "Operations": (
119                    [PatchGroupResourceOperationsInner.from_dict(_item) for _item in obj["Operations"]]
120                    if obj.get("Operations") is not None
121                    else None
122                ),
123            }
124        )
125        # store additional fields in additional_properties
126        for _key in obj.keys():
127            if _key not in cls.__properties:
128                _obj.additional_properties[_key] = obj.get(_key)
129
130        return _obj

PatchGroupResource

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

operations: List[miro_api.models.patch_group_resource_operations_inner.PatchGroupResourceOperationsInner]

additional_properties: Dict[str, Any]

@field_validator('schemas')

def schemas_validate_enum(cls, value): View Source

42    @field_validator("schemas")
43    def schemas_validate_enum(cls, value):
44        """Validates the enum"""
45        for i in value:
46            if i not in set([]):
47                raise ValueError("each list item must be one of ()")
48        return value

Validates the enum

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 PatchGroupResource from a JSON string"""
68        return cls.from_dict(json.loads(json_str))

Create an instance of PatchGroupResource 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 each item in operations (list)
 93        _items = []
 94        if self.operations:
 95            for _item in self.operations:
 96                if _item:
 97                    _items.append(_item.to_dict())
 98            _dict["Operations"] = _items
 99        # puts key-value pairs in additional_properties in the top level
100        if self.additional_properties is not None:
101            for _key, _value in self.additional_properties.items():
102                _dict[_key] = _value
103
104        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

106    @classmethod
107    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
108        """Create an instance of PatchGroupResource from a dict"""
109        if obj is None:
110            return None
111
112        if not isinstance(obj, dict):
113            return cls.model_validate(obj)
114
115        _obj = cls.model_validate(
116            {
117                "schemas": obj.get("schemas"),
118                "Operations": (
119                    [PatchGroupResourceOperationsInner.from_dict(_item) for _item in obj["Operations"]]
120                    if obj.get("Operations") is not None
121                    else None
122                ),
123            }
124        )
125        # store additional fields in additional_properties
126        for _key in obj.keys():
127            if _key not in cls.__properties:
128                _obj.additional_properties[_key] = obj.get(_key)
129
130        return _obj

Create an instance of PatchGroupResource 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=List[Annotated[str, Strict(strict=True)]], required=True, description='Identifies which schema(s) this resource uses. In this case it is the PatchOp schema.'), 'operations': FieldInfo(annotation=List[miro_api.models.patch_group_resource_operations_inner.PatchGroupResourceOperationsInner], required=True, alias='Operations', alias_priority=2, description='A list of patch operations. Multiple users can be added or removed from the group (team) in one request. use the array to add or remove multiple users. For updating security group name: "op"="replace", "value"={"id":"13266533725732", "displayName":"New group name"} must be provided in the Operations array.'), '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