miro_api.models.board_export_job

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 datetime import datetime
 20from pydantic import BaseModel, Field, StrictStr
 21from typing import Any, ClassVar, Dict, List, Optional
 22from miro_api.models.board_export_job_creator import BoardExportJobCreator
 23from miro_api.models.board_export_job_tasks_count import BoardExportJobTasksCount
 24from miro_api.models.board_format import BoardFormat
 25from typing import Optional, Set
 26from typing_extensions import Self
 27
 28
 29class BoardExportJob(BaseModel):
 30    """
 31    Board export job.
 32    """  # noqa: E501
 33
 34    id: Optional[StrictStr] = Field(default=None, description="Unique identifier of the board export job.")
 35    name: Optional[StrictStr] = Field(default=None, description="Board export job name.")
 36    board_format: Optional[BoardFormat] = Field(default=None, alias="boardFormat")
 37    status: Optional[StrictStr] = Field(
 38        default=None,
 39        description="Indicates the current state of the board export job. Possible values: `created`: the job has been created but not yet started. Retry the status call after some time. `in_progress`: the job is in progress, and the results are not ready yet. Retry the status call after some time. `cancelled`: the job has been cancelled and will not produce any more results. `finished`: the job is complete. You can now get results for the board export job.",
 40    )
 41    created_at: Optional[datetime] = Field(default=None, alias="createdAt")
 42    modified_at: Optional[datetime] = Field(default=None, alias="modifiedAt")
 43    tasks_count: Optional[BoardExportJobTasksCount] = Field(default=None, alias="tasksCount")
 44    creator: Optional[BoardExportJobCreator] = None
 45    additional_properties: Dict[str, Any] = {}
 46    __properties: ClassVar[List[str]] = [
 47        "id",
 48        "name",
 49        "boardFormat",
 50        "status",
 51        "createdAt",
 52        "modifiedAt",
 53        "tasksCount",
 54        "creator",
 55    ]
 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 BoardExportJob 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 tasks_count
100        if self.tasks_count:
101            _dict["tasksCount"] = self.tasks_count.to_dict()
102        # override the default output from pydantic by calling `to_dict()` of creator
103        if self.creator:
104            _dict["creator"] = self.creator.to_dict()
105        # puts key-value pairs in additional_properties in the top level
106        if self.additional_properties is not None:
107            for _key, _value in self.additional_properties.items():
108                _dict[_key] = _value
109
110        return _dict
111
112    @classmethod
113    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
114        """Create an instance of BoardExportJob from a dict"""
115        if obj is None:
116            return None
117
118        if not isinstance(obj, dict):
119            return cls.model_validate(obj)
120
121        _obj = cls.model_validate(
122            {
123                "id": obj.get("id"),
124                "name": obj.get("name"),
125                "boardFormat": obj.get("boardFormat"),
126                "status": obj.get("status"),
127                "createdAt": obj.get("createdAt"),
128                "modifiedAt": obj.get("modifiedAt"),
129                "tasksCount": (
130                    BoardExportJobTasksCount.from_dict(obj["tasksCount"]) if obj.get("tasksCount") is not None else None
131                ),
132                "creator": BoardExportJobCreator.from_dict(obj["creator"]) if obj.get("creator") is not None else None,
133            }
134        )
135        # store additional fields in additional_properties
136        for _key in obj.keys():
137            if _key not in cls.__properties:
138                _obj.additional_properties[_key] = obj.get(_key)
139
140        return _obj

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

 30class BoardExportJob(BaseModel):
 31    """
 32    Board export job.
 33    """  # noqa: E501
 34
 35    id: Optional[StrictStr] = Field(default=None, description="Unique identifier of the board export job.")
 36    name: Optional[StrictStr] = Field(default=None, description="Board export job name.")
 37    board_format: Optional[BoardFormat] = Field(default=None, alias="boardFormat")
 38    status: Optional[StrictStr] = Field(
 39        default=None,
 40        description="Indicates the current state of the board export job. Possible values: `created`: the job has been created but not yet started. Retry the status call after some time. `in_progress`: the job is in progress, and the results are not ready yet. Retry the status call after some time. `cancelled`: the job has been cancelled and will not produce any more results. `finished`: the job is complete. You can now get results for the board export job.",
 41    )
 42    created_at: Optional[datetime] = Field(default=None, alias="createdAt")
 43    modified_at: Optional[datetime] = Field(default=None, alias="modifiedAt")
 44    tasks_count: Optional[BoardExportJobTasksCount] = Field(default=None, alias="tasksCount")
 45    creator: Optional[BoardExportJobCreator] = None
 46    additional_properties: Dict[str, Any] = {}
 47    __properties: ClassVar[List[str]] = [
 48        "id",
 49        "name",
 50        "boardFormat",
 51        "status",
 52        "createdAt",
 53        "modifiedAt",
 54        "tasksCount",
 55        "creator",
 56    ]
 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 BoardExportJob 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 tasks_count
101        if self.tasks_count:
102            _dict["tasksCount"] = self.tasks_count.to_dict()
103        # override the default output from pydantic by calling `to_dict()` of creator
104        if self.creator:
105            _dict["creator"] = self.creator.to_dict()
106        # puts key-value pairs in additional_properties in the top level
107        if self.additional_properties is not None:
108            for _key, _value in self.additional_properties.items():
109                _dict[_key] = _value
110
111        return _dict
112
113    @classmethod
114    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
115        """Create an instance of BoardExportJob from a dict"""
116        if obj is None:
117            return None
118
119        if not isinstance(obj, dict):
120            return cls.model_validate(obj)
121
122        _obj = cls.model_validate(
123            {
124                "id": obj.get("id"),
125                "name": obj.get("name"),
126                "boardFormat": obj.get("boardFormat"),
127                "status": obj.get("status"),
128                "createdAt": obj.get("createdAt"),
129                "modifiedAt": obj.get("modifiedAt"),
130                "tasksCount": (
131                    BoardExportJobTasksCount.from_dict(obj["tasksCount"]) if obj.get("tasksCount") is not None else None
132                ),
133                "creator": BoardExportJobCreator.from_dict(obj["creator"]) if obj.get("creator") is not None else None,
134            }
135        )
136        # store additional fields in additional_properties
137        for _key in obj.keys():
138            if _key not in cls.__properties:
139                _obj.additional_properties[_key] = obj.get(_key)
140
141        return _obj

Board export job.

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

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

board_format: Optional[miro_api.models.board_format.BoardFormat]

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

created_at: Optional[datetime.datetime]

modified_at: Optional[datetime.datetime]

tasks_count: Optional[miro_api.models.board_export_job_tasks_count.BoardExportJobTasksCount]

creator: Optional[miro_api.models.board_export_job_creator.BoardExportJobCreator]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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: View Source

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]: View Source

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

Create an instance of BoardExportJob from a JSON string

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

 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 tasks_count
101        if self.tasks_count:
102            _dict["tasksCount"] = self.tasks_count.to_dict()
103        # override the default output from pydantic by calling `to_dict()` of creator
104        if self.creator:
105            _dict["creator"] = self.creator.to_dict()
106        # puts key-value pairs in additional_properties in the top level
107        if self.additional_properties is not None:
108            for _key, _value in self.additional_properties.items():
109                _dict[_key] = _value
110
111        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

113    @classmethod
114    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
115        """Create an instance of BoardExportJob from a dict"""
116        if obj is None:
117            return None
118
119        if not isinstance(obj, dict):
120            return cls.model_validate(obj)
121
122        _obj = cls.model_validate(
123            {
124                "id": obj.get("id"),
125                "name": obj.get("name"),
126                "boardFormat": obj.get("boardFormat"),
127                "status": obj.get("status"),
128                "createdAt": obj.get("createdAt"),
129                "modifiedAt": obj.get("modifiedAt"),
130                "tasksCount": (
131                    BoardExportJobTasksCount.from_dict(obj["tasksCount"]) if obj.get("tasksCount") is not None else None
132                ),
133                "creator": BoardExportJobCreator.from_dict(obj["creator"]) if obj.get("creator") is not None else None,
134            }
135        )
136        # store additional fields in additional_properties
137        for _key in obj.keys():
138            if _key not in cls.__properties:
139                _obj.additional_properties[_key] = obj.get(_key)
140
141        return _obj

Create an instance of BoardExportJob 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 = {'id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Unique identifier of the board export job.'), 'name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Board export job name.'), 'board_format': FieldInfo(annotation=Union[BoardFormat, NoneType], required=False, alias='boardFormat', alias_priority=2), 'status': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Indicates the current state of the board export job. Possible values: `created`: the job has been created but not yet started. Retry the status call after some time. `in_progress`: the job is in progress, and the results are not ready yet. Retry the status call after some time. `cancelled`: the job has been cancelled and will not produce any more results. `finished`: the job is complete. You can now get results for the board export job.'), 'created_at': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='createdAt', alias_priority=2), 'modified_at': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='modifiedAt', alias_priority=2), 'tasks_count': FieldInfo(annotation=Union[BoardExportJobTasksCount, NoneType], required=False, alias='tasksCount', alias_priority=2), 'creator': FieldInfo(annotation=Union[BoardExportJobCreator, 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