miro_api.models.board_data_classification_label

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
 14
 15from __future__ import annotations
 16import pprint
 17import re  # noqa: F401
 18import json
 19
 20from pydantic import BaseModel, Field, StrictStr
 21from typing import Any, ClassVar, Dict, List, Optional
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class BoardDataClassificationLabel(BaseModel):
 27    """
 28    BoardDataClassificationLabel
 29    """  # noqa: E501
 30
 31    color: Optional[StrictStr] = Field(default=None, description="Label color.")
 32    description: Optional[StrictStr] = Field(default=None, description="Label description.")
 33    id: Optional[StrictStr] = Field(default=None, description="Label id.")
 34    name: Optional[StrictStr] = Field(default=None, description="Label name.")
 35    sharing_recommendation: Optional[StrictStr] = Field(
 36        default=None,
 37        description="Sharing Recommendation (one of NO_SHARING_RESTRICTIONS, ONLY_WITHIN_ORGANIZATION, ONLY_WITHIN_TEAM or ONLY_WITH_AUTHORIZED_TEAM_MEMBERS ).",
 38        alias="sharingRecommendation",
 39    )
 40    guideline_url: Optional[StrictStr] = Field(
 41        default=None,
 42        description="Indicates the URL for the board classification label guidelines.",
 43        alias="guidelineUrl",
 44    )
 45    type: Optional[StrictStr] = Field(
 46        default="board-data-classification-label", description="Type of the object returned."
 47    )
 48    additional_properties: Dict[str, Any] = {}
 49    __properties: ClassVar[List[str]] = [
 50        "color",
 51        "description",
 52        "id",
 53        "name",
 54        "sharingRecommendation",
 55        "guidelineUrl",
 56        "type",
 57    ]
 58
 59    model_config = {
 60        "populate_by_name": True,
 61        "validate_assignment": True,
 62        "protected_namespaces": (),
 63    }
 64
 65    def to_str(self) -> str:
 66        """Returns the string representation of the model using alias"""
 67        return pprint.pformat(self.model_dump(by_alias=True))
 68
 69    def to_json(self) -> str:
 70        """Returns the JSON representation of the model using alias"""
 71        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 72        return json.dumps(self.to_dict())
 73
 74    @classmethod
 75    def from_json(cls, json_str: str) -> Optional[Self]:
 76        """Create an instance of BoardDataClassificationLabel from a JSON string"""
 77        return cls.from_dict(json.loads(json_str))
 78
 79    def to_dict(self) -> Dict[str, Any]:
 80        """Return the dictionary representation of the model using alias.
 81
 82        This has the following differences from calling pydantic's
 83        `self.model_dump(by_alias=True)`:
 84
 85        * `None` is only added to the output dict for nullable fields that
 86          were set at model initialization. Other fields with value `None`
 87          are ignored.
 88        * Fields in `self.additional_properties` are added to the output dict.
 89        """
 90        excluded_fields: Set[str] = set(
 91            [
 92                "additional_properties",
 93            ]
 94        )
 95
 96        _dict = self.model_dump(
 97            by_alias=True,
 98            exclude=excluded_fields,
 99            exclude_none=True,
100        )
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 BoardDataClassificationLabel 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                "color": obj.get("color"),
120                "description": obj.get("description"),
121                "id": obj.get("id"),
122                "name": obj.get("name"),
123                "sharingRecommendation": obj.get("sharingRecommendation"),
124                "guidelineUrl": obj.get("guidelineUrl"),
125                "type": obj.get("type") if obj.get("type") is not None else "board-data-classification-label",
126            }
127        )
128        # store additional fields in additional_properties
129        for _key in obj.keys():
130            if _key not in cls.__properties:
131                _obj.additional_properties[_key] = obj.get(_key)
132
133        return _obj

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

 27class BoardDataClassificationLabel(BaseModel):
 28    """
 29    BoardDataClassificationLabel
 30    """  # noqa: E501
 31
 32    color: Optional[StrictStr] = Field(default=None, description="Label color.")
 33    description: Optional[StrictStr] = Field(default=None, description="Label description.")
 34    id: Optional[StrictStr] = Field(default=None, description="Label id.")
 35    name: Optional[StrictStr] = Field(default=None, description="Label name.")
 36    sharing_recommendation: Optional[StrictStr] = Field(
 37        default=None,
 38        description="Sharing Recommendation (one of NO_SHARING_RESTRICTIONS, ONLY_WITHIN_ORGANIZATION, ONLY_WITHIN_TEAM or ONLY_WITH_AUTHORIZED_TEAM_MEMBERS ).",
 39        alias="sharingRecommendation",
 40    )
 41    guideline_url: Optional[StrictStr] = Field(
 42        default=None,
 43        description="Indicates the URL for the board classification label guidelines.",
 44        alias="guidelineUrl",
 45    )
 46    type: Optional[StrictStr] = Field(
 47        default="board-data-classification-label", description="Type of the object returned."
 48    )
 49    additional_properties: Dict[str, Any] = {}
 50    __properties: ClassVar[List[str]] = [
 51        "color",
 52        "description",
 53        "id",
 54        "name",
 55        "sharingRecommendation",
 56        "guidelineUrl",
 57        "type",
 58    ]
 59
 60    model_config = {
 61        "populate_by_name": True,
 62        "validate_assignment": True,
 63        "protected_namespaces": (),
 64    }
 65
 66    def to_str(self) -> str:
 67        """Returns the string representation of the model using alias"""
 68        return pprint.pformat(self.model_dump(by_alias=True))
 69
 70    def to_json(self) -> str:
 71        """Returns the JSON representation of the model using alias"""
 72        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 73        return json.dumps(self.to_dict())
 74
 75    @classmethod
 76    def from_json(cls, json_str: str) -> Optional[Self]:
 77        """Create an instance of BoardDataClassificationLabel from a JSON string"""
 78        return cls.from_dict(json.loads(json_str))
 79
 80    def to_dict(self) -> Dict[str, Any]:
 81        """Return the dictionary representation of the model using alias.
 82
 83        This has the following differences from calling pydantic's
 84        `self.model_dump(by_alias=True)`:
 85
 86        * `None` is only added to the output dict for nullable fields that
 87          were set at model initialization. Other fields with value `None`
 88          are ignored.
 89        * Fields in `self.additional_properties` are added to the output dict.
 90        """
 91        excluded_fields: Set[str] = set(
 92            [
 93                "additional_properties",
 94            ]
 95        )
 96
 97        _dict = self.model_dump(
 98            by_alias=True,
 99            exclude=excluded_fields,
100            exclude_none=True,
101        )
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 BoardDataClassificationLabel 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                "color": obj.get("color"),
121                "description": obj.get("description"),
122                "id": obj.get("id"),
123                "name": obj.get("name"),
124                "sharingRecommendation": obj.get("sharingRecommendation"),
125                "guidelineUrl": obj.get("guidelineUrl"),
126                "type": obj.get("type") if obj.get("type") is not None else "board-data-classification-label",
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

BoardDataClassificationLabel

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

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

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

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

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

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

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

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

75    @classmethod
76    def from_json(cls, json_str: str) -> Optional[Self]:
77        """Create an instance of BoardDataClassificationLabel from a JSON string"""
78        return cls.from_dict(json.loads(json_str))

Create an instance of BoardDataClassificationLabel from a JSON string

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

 80    def to_dict(self) -> Dict[str, Any]:
 81        """Return the dictionary representation of the model using alias.
 82
 83        This has the following differences from calling pydantic's
 84        `self.model_dump(by_alias=True)`:
 85
 86        * `None` is only added to the output dict for nullable fields that
 87          were set at model initialization. Other fields with value `None`
 88          are ignored.
 89        * Fields in `self.additional_properties` are added to the output dict.
 90        """
 91        excluded_fields: Set[str] = set(
 92            [
 93                "additional_properties",
 94            ]
 95        )
 96
 97        _dict = self.model_dump(
 98            by_alias=True,
 99            exclude=excluded_fields,
100            exclude_none=True,
101        )
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 BoardDataClassificationLabel 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                "color": obj.get("color"),
121                "description": obj.get("description"),
122                "id": obj.get("id"),
123                "name": obj.get("name"),
124                "sharingRecommendation": obj.get("sharingRecommendation"),
125                "guidelineUrl": obj.get("guidelineUrl"),
126                "type": obj.get("type") if obj.get("type") is not None else "board-data-classification-label",
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

Create an instance of BoardDataClassificationLabel 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 = {'color': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Label color.'), 'description': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Label description.'), 'id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Label id.'), 'name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Label name.'), 'sharing_recommendation': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='sharingRecommendation', alias_priority=2, description='Sharing Recommendation (one of NO_SHARING_RESTRICTIONS, ONLY_WITHIN_ORGANIZATION, ONLY_WITHIN_TEAM or ONLY_WITH_AUTHORIZED_TEAM_MEMBERS ).'), 'guideline_url': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='guidelineUrl', alias_priority=2, description='Indicates the URL for the board classification label guidelines.'), 'type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='board-data-classification-label', description='Type of the object returned.'), '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