miro_api.models.board_export_task_export_link

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 typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class BoardExportTaskExportLink(BaseModel):
 27    """
 28    Board export task results link.
 29    """  # noqa: E501
 30
 31    status: StrictStr = Field(
 32        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."
 33    )
 34    export_link: Optional[StrictStr] = Field(
 35        default=None, description="URL of the S3 bucket that contains the exported files.", alias="exportLink"
 36    )
 37    artifact_expired_at: Optional[datetime] = Field(
 38        default=None,
 39        description="The date and time when the artifact will no longer be available in the S3 storage. After this time, the link will no longer be valid and the exported files will not be accessible. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 40        alias="artifactExpiredAt",
 41    )
 42    link_expired_at: Optional[datetime] = Field(
 43        default=None,
 44        description="The date and time when the export link will expire. After this time, the link will no longer be valid. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 45        alias="linkExpiredAt",
 46    )
 47    error_message: Optional[StrictStr] = Field(
 48        default=None,
 49        description="Contains the description of the error that occurred during a board export task results link creation.",
 50        alias="errorMessage",
 51    )
 52    error_type: Optional[StrictStr] = Field(
 53        default=None,
 54        description="Indicates the type of error encountered during the board export task results link creation. Possible values: `TEMPORARY`: the board export task encountered a temporary error. Retry the board export task results link creation 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 results link creation after some time.",
 55        alias="errorType",
 56    )
 57    additional_properties: Dict[str, Any] = {}
 58    __properties: ClassVar[List[str]] = [
 59        "status",
 60        "exportLink",
 61        "artifactExpiredAt",
 62        "linkExpiredAt",
 63        "errorMessage",
 64        "errorType",
 65    ]
 66
 67    model_config = {
 68        "populate_by_name": True,
 69        "validate_assignment": True,
 70        "protected_namespaces": (),
 71    }
 72
 73    def to_str(self) -> str:
 74        """Returns the string representation of the model using alias"""
 75        return pprint.pformat(self.model_dump(by_alias=True))
 76
 77    def to_json(self) -> str:
 78        """Returns the JSON representation of the model using alias"""
 79        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 80        return json.dumps(self.to_dict())
 81
 82    @classmethod
 83    def from_json(cls, json_str: str) -> Optional[Self]:
 84        """Create an instance of BoardExportTaskExportLink from a JSON string"""
 85        return cls.from_dict(json.loads(json_str))
 86
 87    def to_dict(self) -> Dict[str, Any]:
 88        """Return the dictionary representation of the model using alias.
 89
 90        This has the following differences from calling pydantic's
 91        `self.model_dump(by_alias=True)`:
 92
 93        * `None` is only added to the output dict for nullable fields that
 94          were set at model initialization. Other fields with value `None`
 95          are ignored.
 96        * Fields in `self.additional_properties` are added to the output dict.
 97        """
 98        excluded_fields: Set[str] = set(
 99            [
100                "additional_properties",
101            ]
102        )
103
104        _dict = self.model_dump(
105            by_alias=True,
106            exclude=excluded_fields,
107            exclude_none=True,
108        )
109        # puts key-value pairs in additional_properties in the top level
110        if self.additional_properties is not None:
111            for _key, _value in self.additional_properties.items():
112                _dict[_key] = _value
113
114        return _dict
115
116    @classmethod
117    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
118        """Create an instance of BoardExportTaskExportLink from a dict"""
119        if obj is None:
120            return None
121
122        if not isinstance(obj, dict):
123            return cls.model_validate(obj)
124
125        _obj = cls.model_validate(
126            {
127                "status": obj.get("status"),
128                "exportLink": obj.get("exportLink"),
129                "artifactExpiredAt": obj.get("artifactExpiredAt"),
130                "linkExpiredAt": obj.get("linkExpiredAt"),
131                "errorMessage": obj.get("errorMessage"),
132                "errorType": obj.get("errorType"),
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 BoardExportTaskExportLink(pydantic.main.BaseModel): View Source

 27class BoardExportTaskExportLink(BaseModel):
 28    """
 29    Board export task results link.
 30    """  # noqa: E501
 31
 32    status: StrictStr = Field(
 33        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."
 34    )
 35    export_link: Optional[StrictStr] = Field(
 36        default=None, description="URL of the S3 bucket that contains the exported files.", alias="exportLink"
 37    )
 38    artifact_expired_at: Optional[datetime] = Field(
 39        default=None,
 40        description="The date and time when the artifact will no longer be available in the S3 storage. After this time, the link will no longer be valid and the exported files will not be accessible. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 41        alias="artifactExpiredAt",
 42    )
 43    link_expired_at: Optional[datetime] = Field(
 44        default=None,
 45        description="The date and time when the export link will expire. After this time, the link will no longer be valid. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 46        alias="linkExpiredAt",
 47    )
 48    error_message: Optional[StrictStr] = Field(
 49        default=None,
 50        description="Contains the description of the error that occurred during a board export task results link creation.",
 51        alias="errorMessage",
 52    )
 53    error_type: Optional[StrictStr] = Field(
 54        default=None,
 55        description="Indicates the type of error encountered during the board export task results link creation. Possible values: `TEMPORARY`: the board export task encountered a temporary error. Retry the board export task results link creation 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 results link creation after some time.",
 56        alias="errorType",
 57    )
 58    additional_properties: Dict[str, Any] = {}
 59    __properties: ClassVar[List[str]] = [
 60        "status",
 61        "exportLink",
 62        "artifactExpiredAt",
 63        "linkExpiredAt",
 64        "errorMessage",
 65        "errorType",
 66    ]
 67
 68    model_config = {
 69        "populate_by_name": True,
 70        "validate_assignment": True,
 71        "protected_namespaces": (),
 72    }
 73
 74    def to_str(self) -> str:
 75        """Returns the string representation of the model using alias"""
 76        return pprint.pformat(self.model_dump(by_alias=True))
 77
 78    def to_json(self) -> str:
 79        """Returns the JSON representation of the model using alias"""
 80        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 81        return json.dumps(self.to_dict())
 82
 83    @classmethod
 84    def from_json(cls, json_str: str) -> Optional[Self]:
 85        """Create an instance of BoardExportTaskExportLink from a JSON string"""
 86        return cls.from_dict(json.loads(json_str))
 87
 88    def to_dict(self) -> Dict[str, Any]:
 89        """Return the dictionary representation of the model using alias.
 90
 91        This has the following differences from calling pydantic's
 92        `self.model_dump(by_alias=True)`:
 93
 94        * `None` is only added to the output dict for nullable fields that
 95          were set at model initialization. Other fields with value `None`
 96          are ignored.
 97        * Fields in `self.additional_properties` are added to the output dict.
 98        """
 99        excluded_fields: Set[str] = set(
100            [
101                "additional_properties",
102            ]
103        )
104
105        _dict = self.model_dump(
106            by_alias=True,
107            exclude=excluded_fields,
108            exclude_none=True,
109        )
110        # puts key-value pairs in additional_properties in the top level
111        if self.additional_properties is not None:
112            for _key, _value in self.additional_properties.items():
113                _dict[_key] = _value
114
115        return _dict
116
117    @classmethod
118    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
119        """Create an instance of BoardExportTaskExportLink from a dict"""
120        if obj is None:
121            return None
122
123        if not isinstance(obj, dict):
124            return cls.model_validate(obj)
125
126        _obj = cls.model_validate(
127            {
128                "status": obj.get("status"),
129                "exportLink": obj.get("exportLink"),
130                "artifactExpiredAt": obj.get("artifactExpiredAt"),
131                "linkExpiredAt": obj.get("linkExpiredAt"),
132                "errorMessage": obj.get("errorMessage"),
133                "errorType": obj.get("errorType"),
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 task results link.

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

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

artifact_expired_at: Optional[datetime.datetime]

link_expired_at: Optional[datetime.datetime]

error_message: Optional[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

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

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

83    @classmethod
84    def from_json(cls, json_str: str) -> Optional[Self]:
85        """Create an instance of BoardExportTaskExportLink from a JSON string"""
86        return cls.from_dict(json.loads(json_str))

Create an instance of BoardExportTaskExportLink from a JSON string

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

 88    def to_dict(self) -> Dict[str, Any]:
 89        """Return the dictionary representation of the model using alias.
 90
 91        This has the following differences from calling pydantic's
 92        `self.model_dump(by_alias=True)`:
 93
 94        * `None` is only added to the output dict for nullable fields that
 95          were set at model initialization. Other fields with value `None`
 96          are ignored.
 97        * Fields in `self.additional_properties` are added to the output dict.
 98        """
 99        excluded_fields: Set[str] = set(
100            [
101                "additional_properties",
102            ]
103        )
104
105        _dict = self.model_dump(
106            by_alias=True,
107            exclude=excluded_fields,
108            exclude_none=True,
109        )
110        # puts key-value pairs in additional_properties in the top level
111        if self.additional_properties is not None:
112            for _key, _value in self.additional_properties.items():
113                _dict[_key] = _value
114
115        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

117    @classmethod
118    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
119        """Create an instance of BoardExportTaskExportLink from a dict"""
120        if obj is None:
121            return None
122
123        if not isinstance(obj, dict):
124            return cls.model_validate(obj)
125
126        _obj = cls.model_validate(
127            {
128                "status": obj.get("status"),
129                "exportLink": obj.get("exportLink"),
130                "artifactExpiredAt": obj.get("artifactExpiredAt"),
131                "linkExpiredAt": obj.get("linkExpiredAt"),
132                "errorMessage": obj.get("errorMessage"),
133                "errorType": obj.get("errorType"),
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 BoardExportTaskExportLink 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 = {'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)]), '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.'), 'artifact_expired_at': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='artifactExpiredAt', alias_priority=2, description='The date and time when the artifact will no longer be available in the S3 storage. After this time, the link will no longer be valid and the exported files will not be accessible. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).'), 'link_expired_at': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='linkExpiredAt', alias_priority=2, description='The date and time when the export link will expire. After this time, the link will no longer be valid. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).'), '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 results link creation.'), '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 results link creation. Possible values: `TEMPORARY`: the board export task encountered a temporary error. Retry the board export task results link creation 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 results link creation 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