miro_api.models.patch_group_resource_operations_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.

  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, Optional
 21from miro_api.models.patch_group_resource_operations_inner_value import PatchGroupResourceOperationsInnerValue
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class PatchGroupResourceOperationsInner(BaseModel):
 27    """
 28    PatchGroupResourceOperationsInner
 29    """  # noqa: E501
 30
 31    op: StrictStr = Field(description="Supported operations for this Patch request.")
 32    path: Optional[StrictStr] = Field(
 33        default=None,
 34        description='The "path" attribute value is a string containing an attribute path describing the target of the operation. The "path" attribute is optional for the "add", and "replace" operations and is required for the "remove" operation. <br><br> ',
 35    )
 36    value: Optional[PatchGroupResourceOperationsInnerValue] = None
 37    additional_properties: Dict[str, Any] = {}
 38    __properties: ClassVar[List[str]] = ["op", "path", "value"]
 39
 40    @field_validator("op")
 41    def op_validate_enum(cls, value):
 42        """Validates the enum"""
 43        if value not in set(["Add", "Remove", "Replace"]):
 44            raise ValueError("must be one of enum values ('Add', 'Remove', 'Replace')")
 45        return value
 46
 47    @field_validator("path")
 48    def path_validate_enum(cls, value):
 49        """Validates the enum"""
 50        if value is None:
 51            return value
 52
 53        if value not in set(["members", "displayName"]):
 54            raise ValueError("must be one of enum values ('members', 'displayName')")
 55        return value
 56
 57    model_config = {
 58        "populate_by_name": True,
 59        "validate_assignment": True,
 60        "protected_namespaces": (),
 61    }
 62
 63    def to_str(self) -> str:
 64        """Returns the string representation of the model using alias"""
 65        return pprint.pformat(self.model_dump(by_alias=True))
 66
 67    def to_json(self) -> str:
 68        """Returns the JSON representation of the model using alias"""
 69        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 70        return json.dumps(self.to_dict())
 71
 72    @classmethod
 73    def from_json(cls, json_str: str) -> Optional[Self]:
 74        """Create an instance of PatchGroupResourceOperationsInner from a JSON string"""
 75        return cls.from_dict(json.loads(json_str))
 76
 77    def to_dict(self) -> Dict[str, Any]:
 78        """Return the dictionary representation of the model using alias.
 79
 80        This has the following differences from calling pydantic's
 81        `self.model_dump(by_alias=True)`:
 82
 83        * `None` is only added to the output dict for nullable fields that
 84          were set at model initialization. Other fields with value `None`
 85          are ignored.
 86        * Fields in `self.additional_properties` are added to the output dict.
 87        """
 88        excluded_fields: Set[str] = set(
 89            [
 90                "additional_properties",
 91            ]
 92        )
 93
 94        _dict = self.model_dump(
 95            by_alias=True,
 96            exclude=excluded_fields,
 97            exclude_none=True,
 98        )
 99        # override the default output from pydantic by calling `to_dict()` of value
100        if self.value:
101            _dict["value"] = self.value.to_dict()
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 PatchGroupResourceOperationsInner 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                "op": obj.get("op"),
121                "path": obj.get("path"),
122                "value": (
123                    PatchGroupResourceOperationsInnerValue.from_dict(obj["value"])
124                    if obj.get("value") is not None
125                    else None
126                ),
127            }
128        )
129        # store additional fields in additional_properties
130        for _key in obj.keys():
131            if _key not in cls.__properties:
132                _obj.additional_properties[_key] = obj.get(_key)
133
134        return _obj
class PatchGroupResourceOperationsInner(pydantic.main.BaseModel): 
 27class PatchGroupResourceOperationsInner(BaseModel):
 28    """
 29    PatchGroupResourceOperationsInner
 30    """  # noqa: E501
 31
 32    op: StrictStr = Field(description="Supported operations for this Patch request.")
 33    path: Optional[StrictStr] = Field(
 34        default=None,
 35        description='The "path" attribute value is a string containing an attribute path describing the target of the operation. The "path" attribute is optional for the "add", and "replace" operations and is required for the "remove" operation. <br><br> ',
 36    )
 37    value: Optional[PatchGroupResourceOperationsInnerValue] = None
 38    additional_properties: Dict[str, Any] = {}
 39    __properties: ClassVar[List[str]] = ["op", "path", "value"]
 40
 41    @field_validator("op")
 42    def op_validate_enum(cls, value):
 43        """Validates the enum"""
 44        if value not in set(["Add", "Remove", "Replace"]):
 45            raise ValueError("must be one of enum values ('Add', 'Remove', 'Replace')")
 46        return value
 47
 48    @field_validator("path")
 49    def path_validate_enum(cls, value):
 50        """Validates the enum"""
 51        if value is None:
 52            return value
 53
 54        if value not in set(["members", "displayName"]):
 55            raise ValueError("must be one of enum values ('members', 'displayName')")
 56        return value
 57
 58    model_config = {
 59        "populate_by_name": True,
 60        "validate_assignment": True,
 61        "protected_namespaces": (),
 62    }
 63
 64    def to_str(self) -> str:
 65        """Returns the string representation of the model using alias"""
 66        return pprint.pformat(self.model_dump(by_alias=True))
 67
 68    def to_json(self) -> str:
 69        """Returns the JSON representation of the model using alias"""
 70        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 71        return json.dumps(self.to_dict())
 72
 73    @classmethod
 74    def from_json(cls, json_str: str) -> Optional[Self]:
 75        """Create an instance of PatchGroupResourceOperationsInner from a JSON string"""
 76        return cls.from_dict(json.loads(json_str))
 77
 78    def to_dict(self) -> Dict[str, Any]:
 79        """Return the dictionary representation of the model using alias.
 80
 81        This has the following differences from calling pydantic's
 82        `self.model_dump(by_alias=True)`:
 83
 84        * `None` is only added to the output dict for nullable fields that
 85          were set at model initialization. Other fields with value `None`
 86          are ignored.
 87        * Fields in `self.additional_properties` are added to the output dict.
 88        """
 89        excluded_fields: Set[str] = set(
 90            [
 91                "additional_properties",
 92            ]
 93        )
 94
 95        _dict = self.model_dump(
 96            by_alias=True,
 97            exclude=excluded_fields,
 98            exclude_none=True,
 99        )
100        # override the default output from pydantic by calling `to_dict()` of value
101        if self.value:
102            _dict["value"] = self.value.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 PatchGroupResourceOperationsInner 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                "op": obj.get("op"),
122                "path": obj.get("path"),
123                "value": (
124                    PatchGroupResourceOperationsInnerValue.from_dict(obj["value"])
125                    if obj.get("value") 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

PatchGroupResourceOperationsInner

op: typing.Annotated[str, Strict(strict=True)]
path: Optional[Annotated[str, Strict(strict=True)]]
additional_properties: Dict[str, Any]
@field_validator('op')
def op_validate_enum(cls, value): 
41    @field_validator("op")
42    def op_validate_enum(cls, value):
43        """Validates the enum"""
44        if value not in set(["Add", "Remove", "Replace"]):
45            raise ValueError("must be one of enum values ('Add', 'Remove', 'Replace')")
46        return value

Validates the enum

@field_validator('path')
def path_validate_enum(cls, value): 
48    @field_validator("path")
49    def path_validate_enum(cls, value):
50        """Validates the enum"""
51        if value is None:
52            return value
53
54        if value not in set(["members", "displayName"]):
55            raise ValueError("must be one of enum values ('members', 'displayName')")
56        return value

Validates the enum

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}
def to_str(self) -> str: 
64    def to_str(self) -> str:
65        """Returns the string representation of the model using alias"""
66        return pprint.pformat(self.model_dump(by_alias=True))

Returns the string representation of the model using alias

def to_json(self) -> str: 
68    def to_json(self) -> str:
69        """Returns the JSON representation of the model using alias"""
70        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
71        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]: 
73    @classmethod
74    def from_json(cls, json_str: str) -> Optional[Self]:
75        """Create an instance of PatchGroupResourceOperationsInner from a JSON string"""
76        return cls.from_dict(json.loads(json_str))

Create an instance of PatchGroupResourceOperationsInner from a JSON string

def to_dict(self) -> Dict[str, Any]: 
 78    def to_dict(self) -> Dict[str, Any]:
 79        """Return the dictionary representation of the model using alias.
 80
 81        This has the following differences from calling pydantic's
 82        `self.model_dump(by_alias=True)`:
 83
 84        * `None` is only added to the output dict for nullable fields that
 85          were set at model initialization. Other fields with value `None`
 86          are ignored.
 87        * Fields in `self.additional_properties` are added to the output dict.
 88        """
 89        excluded_fields: Set[str] = set(
 90            [
 91                "additional_properties",
 92            ]
 93        )
 94
 95        _dict = self.model_dump(
 96            by_alias=True,
 97            exclude=excluded_fields,
 98            exclude_none=True,
 99        )
100        # override the default output from pydantic by calling `to_dict()` of value
101        if self.value:
102            _dict["value"] = self.value.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

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]: 
110    @classmethod
111    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
112        """Create an instance of PatchGroupResourceOperationsInner 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                "op": obj.get("op"),
122                "path": obj.get("path"),
123                "value": (
124                    PatchGroupResourceOperationsInnerValue.from_dict(obj["value"])
125                    if obj.get("value") 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

Create an instance of PatchGroupResourceOperationsInner from a dict

def model_post_init(self: pydantic.main.BaseModel, __context: Any) -> None: 
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 = {'op': FieldInfo(annotation=str, required=True, description='Supported operations for this Patch request.', metadata=[Strict(strict=True)]), 'path': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='The "path" attribute value is a string containing an attribute path describing the target of the operation. The "path" attribute is optional for the "add", and "replace" operations and is required for the "remove" operation. <br><br> '), 'value': FieldInfo(annotation=Union[PatchGroupResourceOperationsInnerValue, 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