miro_api.models.board_format

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 json
16from enum import Enum
17from typing_extensions import Self
18
19
20class BoardFormat(str, Enum):
21    """
22    Specifies the format of the file to which the board will be exported. Supported formats include SVG (default), HTML, and PDF.
23    """
24
25    """
26    allowed enum values
27    """
28    SVG = "SVG"
29    HTML = "HTML"
30    PDF = "PDF"
31
32    @classmethod
33    def from_json(cls, json_str: str) -> Self:
34        """Create an instance of BoardFormat from a JSON string"""
35        return cls(json.loads(json_str))

class BoardFormat(builtins.str, enum.Enum): View Source

21class BoardFormat(str, Enum):
22    """
23    Specifies the format of the file to which the board will be exported. Supported formats include SVG (default), HTML, and PDF.
24    """
25
26    """
27    allowed enum values
28    """
29    SVG = "SVG"
30    HTML = "HTML"
31    PDF = "PDF"
32
33    @classmethod
34    def from_json(cls, json_str: str) -> Self:
35        """Create an instance of BoardFormat from a JSON string"""
36        return cls(json.loads(json_str))

Specifies the format of the file to which the board will be exported. Supported formats include SVG (default), HTML, and PDF.

SVG = <BoardFormat.SVG: 'SVG'>

HTML = <BoardFormat.HTML: 'HTML'>

PDF = <BoardFormat.PDF: 'PDF'>

@classmethod

def from_json(cls, json_str: str) -> typing_extensions.Self: View Source

33    @classmethod
34    def from_json(cls, json_str: str) -> Self:
35        """Create an instance of BoardFormat from a JSON string"""
36        return cls(json.loads(json_str))

Create an instance of BoardFormat from a JSON string

Inherited Members

enum.Enum: name; value
builtins.str: encode; replace; split; rsplit; join; capitalize; casefold; title; center; count; expandtabs; find; partition; index; ljust; lower; lstrip; rfind; rindex; rjust; rstrip; rpartition; splitlines; strip; swapcase; translate; upper; startswith; endswith; removeprefix; removesuffix; isascii; islower; isupper; istitle; isspace; isdecimal; isdigit; isnumeric; isalpha; isalnum; isidentifier; isprintable; zfill; format; format_map; maketrans