miro_api.models.create_board_export_request

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, field_validator
 21from typing import Any, ClassVar, Dict, List, Optional
 22from typing_extensions import Annotated
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class CreateBoardExportRequest(BaseModel):
 28    """
 29    List of board IDs to be exported.
 30    """  # noqa: E501
 31
 32    board_ids: Optional[Annotated[List[StrictStr], Field(min_length=1, max_length=50)]] = Field(
 33        default=None, description="List of board IDs to be exported.", alias="boardIds"
 34    )
 35    board_format: Optional[StrictStr] = Field(
 36        default="SVG",
 37        description="Specifies the format of the file to which the board will be exported. Supported formats include SVG (default), HTML, and PDF.",
 38        alias="boardFormat",
 39    )
 40    additional_properties: Dict[str, Any] = {}
 41    __properties: ClassVar[List[str]] = ["boardIds", "boardFormat"]
 42
 43    @field_validator("board_format")
 44    def board_format_validate_enum(cls, value):
 45        """Validates the enum"""
 46        if value is None:
 47            return value
 48
 49        if value not in set(["SVG", "HTML", "PDF"]):
 50            raise ValueError("must be one of enum values ('SVG', 'HTML', 'PDF')")
 51        return value
 52
 53    model_config = {
 54        "populate_by_name": True,
 55        "validate_assignment": True,
 56        "protected_namespaces": (),
 57    }
 58
 59    def to_str(self) -> str:
 60        """Returns the string representation of the model using alias"""
 61        return pprint.pformat(self.model_dump(by_alias=True))
 62
 63    def to_json(self) -> str:
 64        """Returns the JSON representation of the model using alias"""
 65        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 66        return json.dumps(self.to_dict())
 67
 68    @classmethod
 69    def from_json(cls, json_str: str) -> Optional[Self]:
 70        """Create an instance of CreateBoardExportRequest from a JSON string"""
 71        return cls.from_dict(json.loads(json_str))
 72
 73    def to_dict(self) -> Dict[str, Any]:
 74        """Return the dictionary representation of the model using alias.
 75
 76        This has the following differences from calling pydantic's
 77        `self.model_dump(by_alias=True)`:
 78
 79        * `None` is only added to the output dict for nullable fields that
 80          were set at model initialization. Other fields with value `None`
 81          are ignored.
 82        * Fields in `self.additional_properties` are added to the output dict.
 83        """
 84        excluded_fields: Set[str] = set(
 85            [
 86                "additional_properties",
 87            ]
 88        )
 89
 90        _dict = self.model_dump(
 91            by_alias=True,
 92            exclude=excluded_fields,
 93            exclude_none=True,
 94        )
 95        # puts key-value pairs in additional_properties in the top level
 96        if self.additional_properties is not None:
 97            for _key, _value in self.additional_properties.items():
 98                _dict[_key] = _value
 99
100        return _dict
101
102    @classmethod
103    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
104        """Create an instance of CreateBoardExportRequest from a dict"""
105        if obj is None:
106            return None
107
108        if not isinstance(obj, dict):
109            return cls.model_validate(obj)
110
111        _obj = cls.model_validate(
112            {
113                "boardIds": obj.get("boardIds"),
114                "boardFormat": obj.get("boardFormat") if obj.get("boardFormat") is not None else "SVG",
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 CreateBoardExportRequest(pydantic.main.BaseModel): View Source

 28class CreateBoardExportRequest(BaseModel):
 29    """
 30    List of board IDs to be exported.
 31    """  # noqa: E501
 32
 33    board_ids: Optional[Annotated[List[StrictStr], Field(min_length=1, max_length=50)]] = Field(
 34        default=None, description="List of board IDs to be exported.", alias="boardIds"
 35    )
 36    board_format: Optional[StrictStr] = Field(
 37        default="SVG",
 38        description="Specifies the format of the file to which the board will be exported. Supported formats include SVG (default), HTML, and PDF.",
 39        alias="boardFormat",
 40    )
 41    additional_properties: Dict[str, Any] = {}
 42    __properties: ClassVar[List[str]] = ["boardIds", "boardFormat"]
 43
 44    @field_validator("board_format")
 45    def board_format_validate_enum(cls, value):
 46        """Validates the enum"""
 47        if value is None:
 48            return value
 49
 50        if value not in set(["SVG", "HTML", "PDF"]):
 51            raise ValueError("must be one of enum values ('SVG', 'HTML', 'PDF')")
 52        return value
 53
 54    model_config = {
 55        "populate_by_name": True,
 56        "validate_assignment": True,
 57        "protected_namespaces": (),
 58    }
 59
 60    def to_str(self) -> str:
 61        """Returns the string representation of the model using alias"""
 62        return pprint.pformat(self.model_dump(by_alias=True))
 63
 64    def to_json(self) -> str:
 65        """Returns the JSON representation of the model using alias"""
 66        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 67        return json.dumps(self.to_dict())
 68
 69    @classmethod
 70    def from_json(cls, json_str: str) -> Optional[Self]:
 71        """Create an instance of CreateBoardExportRequest from a JSON string"""
 72        return cls.from_dict(json.loads(json_str))
 73
 74    def to_dict(self) -> Dict[str, Any]:
 75        """Return the dictionary representation of the model using alias.
 76
 77        This has the following differences from calling pydantic's
 78        `self.model_dump(by_alias=True)`:
 79
 80        * `None` is only added to the output dict for nullable fields that
 81          were set at model initialization. Other fields with value `None`
 82          are ignored.
 83        * Fields in `self.additional_properties` are added to the output dict.
 84        """
 85        excluded_fields: Set[str] = set(
 86            [
 87                "additional_properties",
 88            ]
 89        )
 90
 91        _dict = self.model_dump(
 92            by_alias=True,
 93            exclude=excluded_fields,
 94            exclude_none=True,
 95        )
 96        # puts key-value pairs in additional_properties in the top level
 97        if self.additional_properties is not None:
 98            for _key, _value in self.additional_properties.items():
 99                _dict[_key] = _value
100
101        return _dict
102
103    @classmethod
104    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
105        """Create an instance of CreateBoardExportRequest from a dict"""
106        if obj is None:
107            return None
108
109        if not isinstance(obj, dict):
110            return cls.model_validate(obj)
111
112        _obj = cls.model_validate(
113            {
114                "boardIds": obj.get("boardIds"),
115                "boardFormat": obj.get("boardFormat") if obj.get("boardFormat") is not None else "SVG",
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

List of board IDs to be exported.

board_ids: Optional[Annotated[List[Annotated[str, Strict(strict=True)]], FieldInfo(annotation=NoneType, required=True, metadata=[MinLen(min_length=1), MaxLen(max_length=50)])]]

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

additional_properties: Dict[str, Any]

@field_validator('board_format')

def board_format_validate_enum(cls, value): View Source

44    @field_validator("board_format")
45    def board_format_validate_enum(cls, value):
46        """Validates the enum"""
47        if value is None:
48            return value
49
50        if value not in set(["SVG", "HTML", "PDF"]):
51            raise ValueError("must be one of enum values ('SVG', 'HTML', 'PDF')")
52        return value

Validates the enum

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

def to_str(self) -> str: View Source

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

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

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

Create an instance of CreateBoardExportRequest from a JSON string

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

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

103    @classmethod
104    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
105        """Create an instance of CreateBoardExportRequest from a dict"""
106        if obj is None:
107            return None
108
109        if not isinstance(obj, dict):
110            return cls.model_validate(obj)
111
112        _obj = cls.model_validate(
113            {
114                "boardIds": obj.get("boardIds"),
115                "boardFormat": obj.get("boardFormat") if obj.get("boardFormat") is not None else "SVG",
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 CreateBoardExportRequest 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_ids': FieldInfo(annotation=Union[Annotated[List[Annotated[str, Strict(strict=True)]], FieldInfo(annotation=NoneType, required=True, metadata=[MinLen(min_length=1), MaxLen(max_length=50)])], NoneType], required=False, alias='boardIds', alias_priority=2, description='List of board IDs to be exported.'), 'board_format': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='SVG', alias='boardFormat', alias_priority=2, description='Specifies the format of the file to which the board will be exported. Supported formats include SVG (default), HTML, and PDF.'), '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