miro_api.models.board_export_task_board

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 typing import Optional, Set
22from typing_extensions import Self
23
24
25class BoardExportTaskBoard(BaseModel):
26    """
27    Information about a board in the board export task.
28    """  # noqa: E501
29
30    key: Optional[StrictStr] = Field(default=None, description="Unique identifier of the board.")
31    additional_properties: Dict[str, Any] = {}
32    __properties: ClassVar[List[str]] = ["key"]
33
34    model_config = {
35        "populate_by_name": True,
36        "validate_assignment": True,
37        "protected_namespaces": (),
38    }
39
40    def to_str(self) -> str:
41        """Returns the string representation of the model using alias"""
42        return pprint.pformat(self.model_dump(by_alias=True))
43
44    def to_json(self) -> str:
45        """Returns the JSON representation of the model using alias"""
46        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
47        return json.dumps(self.to_dict())
48
49    @classmethod
50    def from_json(cls, json_str: str) -> Optional[Self]:
51        """Create an instance of BoardExportTaskBoard from a JSON string"""
52        return cls.from_dict(json.loads(json_str))
53
54    def to_dict(self) -> Dict[str, Any]:
55        """Return the dictionary representation of the model using alias.
56
57        This has the following differences from calling pydantic's
58        `self.model_dump(by_alias=True)`:
59
60        * `None` is only added to the output dict for nullable fields that
61          were set at model initialization. Other fields with value `None`
62          are ignored.
63        * Fields in `self.additional_properties` are added to the output dict.
64        """
65        excluded_fields: Set[str] = set(
66            [
67                "additional_properties",
68            ]
69        )
70
71        _dict = self.model_dump(
72            by_alias=True,
73            exclude=excluded_fields,
74            exclude_none=True,
75        )
76        # puts key-value pairs in additional_properties in the top level
77        if self.additional_properties is not None:
78            for _key, _value in self.additional_properties.items():
79                _dict[_key] = _value
80
81        return _dict
82
83    @classmethod
84    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
85        """Create an instance of BoardExportTaskBoard from a dict"""
86        if obj is None:
87            return None
88
89        if not isinstance(obj, dict):
90            return cls.model_validate(obj)
91
92        _obj = cls.model_validate({"key": obj.get("key")})
93        # store additional fields in additional_properties
94        for _key in obj.keys():
95            if _key not in cls.__properties:
96                _obj.additional_properties[_key] = obj.get(_key)
97
98        return _obj

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

26class BoardExportTaskBoard(BaseModel):
27    """
28    Information about a board in the board export task.
29    """  # noqa: E501
30
31    key: Optional[StrictStr] = Field(default=None, description="Unique identifier of the board.")
32    additional_properties: Dict[str, Any] = {}
33    __properties: ClassVar[List[str]] = ["key"]
34
35    model_config = {
36        "populate_by_name": True,
37        "validate_assignment": True,
38        "protected_namespaces": (),
39    }
40
41    def to_str(self) -> str:
42        """Returns the string representation of the model using alias"""
43        return pprint.pformat(self.model_dump(by_alias=True))
44
45    def to_json(self) -> str:
46        """Returns the JSON representation of the model using alias"""
47        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
48        return json.dumps(self.to_dict())
49
50    @classmethod
51    def from_json(cls, json_str: str) -> Optional[Self]:
52        """Create an instance of BoardExportTaskBoard from a JSON string"""
53        return cls.from_dict(json.loads(json_str))
54
55    def to_dict(self) -> Dict[str, Any]:
56        """Return the dictionary representation of the model using alias.
57
58        This has the following differences from calling pydantic's
59        `self.model_dump(by_alias=True)`:
60
61        * `None` is only added to the output dict for nullable fields that
62          were set at model initialization. Other fields with value `None`
63          are ignored.
64        * Fields in `self.additional_properties` are added to the output dict.
65        """
66        excluded_fields: Set[str] = set(
67            [
68                "additional_properties",
69            ]
70        )
71
72        _dict = self.model_dump(
73            by_alias=True,
74            exclude=excluded_fields,
75            exclude_none=True,
76        )
77        # puts key-value pairs in additional_properties in the top level
78        if self.additional_properties is not None:
79            for _key, _value in self.additional_properties.items():
80                _dict[_key] = _value
81
82        return _dict
83
84    @classmethod
85    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
86        """Create an instance of BoardExportTaskBoard from a dict"""
87        if obj is None:
88            return None
89
90        if not isinstance(obj, dict):
91            return cls.model_validate(obj)
92
93        _obj = cls.model_validate({"key": obj.get("key")})
94        # store additional fields in additional_properties
95        for _key in obj.keys():
96            if _key not in cls.__properties:
97                _obj.additional_properties[_key] = obj.get(_key)
98
99        return _obj

Information about a board in the board export task.

key: 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

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

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

50    @classmethod
51    def from_json(cls, json_str: str) -> Optional[Self]:
52        """Create an instance of BoardExportTaskBoard from a JSON string"""
53        return cls.from_dict(json.loads(json_str))

Create an instance of BoardExportTaskBoard from a JSON string

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

55    def to_dict(self) -> Dict[str, Any]:
56        """Return the dictionary representation of the model using alias.
57
58        This has the following differences from calling pydantic's
59        `self.model_dump(by_alias=True)`:
60
61        * `None` is only added to the output dict for nullable fields that
62          were set at model initialization. Other fields with value `None`
63          are ignored.
64        * Fields in `self.additional_properties` are added to the output dict.
65        """
66        excluded_fields: Set[str] = set(
67            [
68                "additional_properties",
69            ]
70        )
71
72        _dict = self.model_dump(
73            by_alias=True,
74            exclude=excluded_fields,
75            exclude_none=True,
76        )
77        # puts key-value pairs in additional_properties in the top level
78        if self.additional_properties is not None:
79            for _key, _value in self.additional_properties.items():
80                _dict[_key] = _value
81
82        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

84    @classmethod
85    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
86        """Create an instance of BoardExportTaskBoard from a dict"""
87        if obj is None:
88            return None
89
90        if not isinstance(obj, dict):
91            return cls.model_validate(obj)
92
93        _obj = cls.model_validate({"key": obj.get("key")})
94        # store additional fields in additional_properties
95        for _key in obj.keys():
96            if _key not in cls.__properties:
97                _obj.additional_properties[_key] = obj.get(_key)
98
99        return _obj

Create an instance of BoardExportTaskBoard 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 = {'key': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Unique identifier of the board.'), '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