miro_api.models.board_export_task_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
 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 BoardExportTaskResult(BaseModel):
 26    """
 27    Board export task results.
 28    """  # noqa: E501
 29
 30    board_id: StrictStr = Field(description="Unique identifier of the board.", alias="boardId")
 31    error_message: Optional[StrictStr] = Field(
 32        default=None,
 33        description="Contains the description of the error that occurred during a board export task.",
 34        alias="errorMessage",
 35    )
 36    export_link: Optional[StrictStr] = Field(
 37        default=None, description="URL of the S3 bucket that contains the exported files.", alias="exportLink"
 38    )
 39    status: StrictStr = Field(
 40        description="Indicates the status of the individual board export task. Possible values: `SUCCESS`: the board export task was completed successfully and the results are available. `ERROR`: the board export task encountered an error and failed to complete. The `errorMessage` field provides more information on the error. `CANCELLED`: the board export task was cancelled. `SCHEDULED`: the board export task has been scheduled and is waiting to be processed. `CREATED`: the board export task was created."
 41    )
 42    error_type: Optional[StrictStr] = Field(
 43        default=None,
 44        description="Indicates the type of error encountered during the board export task. Possible values: `TEMPORARY`: the board export task encountered a temporary error. Retry the board export task after some time. `FATAL`: the board export failed and cannot be retried. This export will never succeed due to issues such as board corruption, non-existence, or other unrecoverable errors. Please verify the board's state or contact support if assistance is needed. `UNKNOWN`: the board export task encountered an unexpected exception. Retry the board export task after some time.",
 45        alias="errorType",
 46    )
 47    additional_properties: Dict[str, Any] = {}
 48    __properties: ClassVar[List[str]] = ["boardId", "errorMessage", "exportLink", "status", "errorType"]
 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 BoardExportTaskResult 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        # puts key-value pairs in additional_properties in the top level
 93        if self.additional_properties is not None:
 94            for _key, _value in self.additional_properties.items():
 95                _dict[_key] = _value
 96
 97        return _dict
 98
 99    @classmethod
100    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
101        """Create an instance of BoardExportTaskResult from a dict"""
102        if obj is None:
103            return None
104
105        if not isinstance(obj, dict):
106            return cls.model_validate(obj)
107
108        _obj = cls.model_validate(
109            {
110                "boardId": obj.get("boardId"),
111                "errorMessage": obj.get("errorMessage"),
112                "exportLink": obj.get("exportLink"),
113                "status": obj.get("status"),
114                "errorType": obj.get("errorType"),
115            }
116        )
117        # store additional fields in additional_properties
118        for _key in obj.keys():
119            if _key not in cls.__properties:
120                _obj.additional_properties[_key] = obj.get(_key)
121
122        return _obj

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

 26class BoardExportTaskResult(BaseModel):
 27    """
 28    Board export task results.
 29    """  # noqa: E501
 30
 31    board_id: StrictStr = Field(description="Unique identifier of the board.", alias="boardId")
 32    error_message: Optional[StrictStr] = Field(
 33        default=None,
 34        description="Contains the description of the error that occurred during a board export task.",
 35        alias="errorMessage",
 36    )
 37    export_link: Optional[StrictStr] = Field(
 38        default=None, description="URL of the S3 bucket that contains the exported files.", alias="exportLink"
 39    )
 40    status: StrictStr = Field(
 41        description="Indicates the status of the individual board export task. Possible values: `SUCCESS`: the board export task was completed successfully and the results are available. `ERROR`: the board export task encountered an error and failed to complete. The `errorMessage` field provides more information on the error. `CANCELLED`: the board export task was cancelled. `SCHEDULED`: the board export task has been scheduled and is waiting to be processed. `CREATED`: the board export task was created."
 42    )
 43    error_type: Optional[StrictStr] = Field(
 44        default=None,
 45        description="Indicates the type of error encountered during the board export task. Possible values: `TEMPORARY`: the board export task encountered a temporary error. Retry the board export task after some time. `FATAL`: the board export failed and cannot be retried. This export will never succeed due to issues such as board corruption, non-existence, or other unrecoverable errors. Please verify the board's state or contact support if assistance is needed. `UNKNOWN`: the board export task encountered an unexpected exception. Retry the board export task after some time.",
 46        alias="errorType",
 47    )
 48    additional_properties: Dict[str, Any] = {}
 49    __properties: ClassVar[List[str]] = ["boardId", "errorMessage", "exportLink", "status", "errorType"]
 50
 51    model_config = {
 52        "populate_by_name": True,
 53        "validate_assignment": True,
 54        "protected_namespaces": (),
 55    }
 56
 57    def to_str(self) -> str:
 58        """Returns the string representation of the model using alias"""
 59        return pprint.pformat(self.model_dump(by_alias=True))
 60
 61    def to_json(self) -> str:
 62        """Returns the JSON representation of the model using alias"""
 63        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 64        return json.dumps(self.to_dict())
 65
 66    @classmethod
 67    def from_json(cls, json_str: str) -> Optional[Self]:
 68        """Create an instance of BoardExportTaskResult from a JSON string"""
 69        return cls.from_dict(json.loads(json_str))
 70
 71    def to_dict(self) -> Dict[str, Any]:
 72        """Return the dictionary representation of the model using alias.
 73
 74        This has the following differences from calling pydantic's
 75        `self.model_dump(by_alias=True)`:
 76
 77        * `None` is only added to the output dict for nullable fields that
 78          were set at model initialization. Other fields with value `None`
 79          are ignored.
 80        * Fields in `self.additional_properties` are added to the output dict.
 81        """
 82        excluded_fields: Set[str] = set(
 83            [
 84                "additional_properties",
 85            ]
 86        )
 87
 88        _dict = self.model_dump(
 89            by_alias=True,
 90            exclude=excluded_fields,
 91            exclude_none=True,
 92        )
 93        # puts key-value pairs in additional_properties in the top level
 94        if self.additional_properties is not None:
 95            for _key, _value in self.additional_properties.items():
 96                _dict[_key] = _value
 97
 98        return _dict
 99
100    @classmethod
101    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
102        """Create an instance of BoardExportTaskResult from a dict"""
103        if obj is None:
104            return None
105
106        if not isinstance(obj, dict):
107            return cls.model_validate(obj)
108
109        _obj = cls.model_validate(
110            {
111                "boardId": obj.get("boardId"),
112                "errorMessage": obj.get("errorMessage"),
113                "exportLink": obj.get("exportLink"),
114                "status": obj.get("status"),
115                "errorType": obj.get("errorType"),
116            }
117        )
118        # store additional fields in additional_properties
119        for _key in obj.keys():
120            if _key not in cls.__properties:
121                _obj.additional_properties[_key] = obj.get(_key)
122
123        return _obj

Board export task results.

board_id: typing.Annotated[str, Strict(strict=True)]

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

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

status: typing.Annotated[str, Strict(strict=True)]

error_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

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

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

66    @classmethod
67    def from_json(cls, json_str: str) -> Optional[Self]:
68        """Create an instance of BoardExportTaskResult from a JSON string"""
69        return cls.from_dict(json.loads(json_str))

Create an instance of BoardExportTaskResult from a JSON string

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

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

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

Create an instance of BoardExportTaskResult 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 = {'board_id': FieldInfo(annotation=str, required=True, alias='boardId', alias_priority=2, description='Unique identifier of the board.', metadata=[Strict(strict=True)]), 'error_message': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='errorMessage', alias_priority=2, description='Contains the description of the error that occurred during a board export task.'), 'export_link': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='exportLink', alias_priority=2, description='URL of the S3 bucket that contains the exported files.'), 'status': FieldInfo(annotation=str, required=True, description='Indicates the status of the individual board export task. Possible values: `SUCCESS`: the board export task was completed successfully and the results are available. `ERROR`: the board export task encountered an error and failed to complete. The `errorMessage` field provides more information on the error. `CANCELLED`: the board export task was cancelled. `SCHEDULED`: the board export task has been scheduled and is waiting to be processed. `CREATED`: the board export task was created.', metadata=[Strict(strict=True)]), 'error_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='errorType', alias_priority=2, description="Indicates the type of error encountered during the board export task. Possible values: `TEMPORARY`: the board export task encountered a temporary error. Retry the board export task after some time. `FATAL`: the board export failed and cannot be retried. This export will never succeed due to issues such as board corruption, non-existence, or other unrecoverable errors. Please verify the board's state or contact support if assistance is needed. `UNKNOWN`: the board export task encountered an unexpected exception. Retry the board export task after some time."), '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