miro_api.models.board_export_result

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

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

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

BoardExportResult

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

results: Optional[List[miro_api.models.board_export_task_result.BoardExportTaskResult]]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

55    @classmethod
56    def from_json(cls, json_str: str) -> Optional[Self]:
57        """Create an instance of BoardExportResult from a JSON string"""
58        return cls.from_dict(json.loads(json_str))

Create an instance of BoardExportResult from a JSON string

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

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

 96    @classmethod
 97    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 98        """Create an instance of BoardExportResult from a dict"""
 99        if obj is None:
100            return None
101
102        if not isinstance(obj, dict):
103            return cls.model_validate(obj)
104
105        _obj = cls.model_validate(
106            {
107                "jobId": obj.get("jobId"),
108                "results": (
109                    [BoardExportTaskResult.from_dict(_item) for _item in obj["results"]]
110                    if obj.get("results") is not None
111                    else None
112                ),
113            }
114        )
115        # store additional fields in additional_properties
116        for _key in obj.keys():
117            if _key not in cls.__properties:
118                _obj.additional_properties[_key] = obj.get(_key)
119
120        return _obj

Create an instance of BoardExportResult 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 = {'job_id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='jobId', alias_priority=2, description='Unique identifier of the board export job.'), 'results': FieldInfo(annotation=Union[List[miro_api.models.board_export_task_result.BoardExportTaskResult], NoneType], required=False, description='Board export task results.'), '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