miro_api.models.app_card_data

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, StrictBool, StrictStr, field_validator
 21from typing import Any, ClassVar, Dict, List, Optional
 22from miro_api.models.custom_field import CustomField
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class AppCardData(BaseModel):
 28    """
 29    Contains app card item data, such as the title, description, or fields.
 30    """  # noqa: E501
 31
 32    description: Optional[StrictStr] = Field(
 33        default=None, description="A short text description to add context about the app card."
 34    )
 35    fields: Optional[List[CustomField]] = Field(
 36        default=None,
 37        description="Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.",
 38    )
 39    owned: Optional[StrictBool] = Field(
 40        default=None, description="Defines whether the card is owned by the application making the call."
 41    )
 42    status: Optional[StrictStr] = Field(
 43        default=None,
 44        description="Status indicating whether an app card is connected and in sync with the source. When the source for the app card is deleted, the status returns `disabled`.",
 45    )
 46    title: Optional[StrictStr] = Field(default=None, description="A short text header to identify the app card.")
 47    additional_properties: Dict[str, Any] = {}
 48    __properties: ClassVar[List[str]] = ["description", "fields", "owned", "status", "title"]
 49
 50    @field_validator("status")
 51    def status_validate_enum(cls, value):
 52        """Validates the enum"""
 53        if value is None:
 54            return value
 55
 56        if value not in set(["disconnected", "connected", "disabled"]):
 57            raise ValueError("must be one of enum values ('disconnected', 'connected', 'disabled')")
 58        return value
 59
 60    model_config = {
 61        "populate_by_name": True,
 62        "validate_assignment": True,
 63        "protected_namespaces": (),
 64    }
 65
 66    def to_str(self) -> str:
 67        """Returns the string representation of the model using alias"""
 68        return pprint.pformat(self.model_dump(by_alias=True))
 69
 70    def to_json(self) -> str:
 71        """Returns the JSON representation of the model using alias"""
 72        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 73        return json.dumps(self.to_dict())
 74
 75    @classmethod
 76    def from_json(cls, json_str: str) -> Optional[Self]:
 77        """Create an instance of AppCardData from a JSON string"""
 78        return cls.from_dict(json.loads(json_str))
 79
 80    def to_dict(self) -> Dict[str, Any]:
 81        """Return the dictionary representation of the model using alias.
 82
 83        This has the following differences from calling pydantic's
 84        `self.model_dump(by_alias=True)`:
 85
 86        * `None` is only added to the output dict for nullable fields that
 87          were set at model initialization. Other fields with value `None`
 88          are ignored.
 89        * Fields in `self.additional_properties` are added to the output dict.
 90        """
 91        excluded_fields: Set[str] = set(
 92            [
 93                "additional_properties",
 94            ]
 95        )
 96
 97        _dict = self.model_dump(
 98            by_alias=True,
 99            exclude=excluded_fields,
100            exclude_none=True,
101        )
102        # override the default output from pydantic by calling `to_dict()` of each item in fields (list)
103        _items = []
104        if self.fields:
105            for _item in self.fields:
106                if _item:
107                    _items.append(_item.to_dict())
108            _dict["fields"] = _items
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 AppCardData 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                "description": obj.get("description"),
128                "fields": (
129                    [CustomField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None
130                ),
131                "owned": obj.get("owned"),
132                "status": obj.get("status"),
133                "title": obj.get("title"),
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

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

 28class AppCardData(BaseModel):
 29    """
 30    Contains app card item data, such as the title, description, or fields.
 31    """  # noqa: E501
 32
 33    description: Optional[StrictStr] = Field(
 34        default=None, description="A short text description to add context about the app card."
 35    )
 36    fields: Optional[List[CustomField]] = Field(
 37        default=None,
 38        description="Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.",
 39    )
 40    owned: Optional[StrictBool] = Field(
 41        default=None, description="Defines whether the card is owned by the application making the call."
 42    )
 43    status: Optional[StrictStr] = Field(
 44        default=None,
 45        description="Status indicating whether an app card is connected and in sync with the source. When the source for the app card is deleted, the status returns `disabled`.",
 46    )
 47    title: Optional[StrictStr] = Field(default=None, description="A short text header to identify the app card.")
 48    additional_properties: Dict[str, Any] = {}
 49    __properties: ClassVar[List[str]] = ["description", "fields", "owned", "status", "title"]
 50
 51    @field_validator("status")
 52    def status_validate_enum(cls, value):
 53        """Validates the enum"""
 54        if value is None:
 55            return value
 56
 57        if value not in set(["disconnected", "connected", "disabled"]):
 58            raise ValueError("must be one of enum values ('disconnected', 'connected', 'disabled')")
 59        return value
 60
 61    model_config = {
 62        "populate_by_name": True,
 63        "validate_assignment": True,
 64        "protected_namespaces": (),
 65    }
 66
 67    def to_str(self) -> str:
 68        """Returns the string representation of the model using alias"""
 69        return pprint.pformat(self.model_dump(by_alias=True))
 70
 71    def to_json(self) -> str:
 72        """Returns the JSON representation of the model using alias"""
 73        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 74        return json.dumps(self.to_dict())
 75
 76    @classmethod
 77    def from_json(cls, json_str: str) -> Optional[Self]:
 78        """Create an instance of AppCardData from a JSON string"""
 79        return cls.from_dict(json.loads(json_str))
 80
 81    def to_dict(self) -> Dict[str, Any]:
 82        """Return the dictionary representation of the model using alias.
 83
 84        This has the following differences from calling pydantic's
 85        `self.model_dump(by_alias=True)`:
 86
 87        * `None` is only added to the output dict for nullable fields that
 88          were set at model initialization. Other fields with value `None`
 89          are ignored.
 90        * Fields in `self.additional_properties` are added to the output dict.
 91        """
 92        excluded_fields: Set[str] = set(
 93            [
 94                "additional_properties",
 95            ]
 96        )
 97
 98        _dict = self.model_dump(
 99            by_alias=True,
100            exclude=excluded_fields,
101            exclude_none=True,
102        )
103        # override the default output from pydantic by calling `to_dict()` of each item in fields (list)
104        _items = []
105        if self.fields:
106            for _item in self.fields:
107                if _item:
108                    _items.append(_item.to_dict())
109            _dict["fields"] = _items
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 AppCardData 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                "description": obj.get("description"),
129                "fields": (
130                    [CustomField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None
131                ),
132                "owned": obj.get("owned"),
133                "status": obj.get("status"),
134                "title": obj.get("title"),
135            }
136        )
137        # store additional fields in additional_properties
138        for _key in obj.keys():
139            if _key not in cls.__properties:
140                _obj.additional_properties[_key] = obj.get(_key)
141
142        return _obj

Contains app card item data, such as the title, description, or fields.

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

fields: Optional[List[miro_api.models.custom_field.CustomField]]

owned: Optional[Annotated[bool, Strict(strict=True)]]

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

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

additional_properties: Dict[str, Any]

@field_validator('status')

def status_validate_enum(cls, value): View Source

51    @field_validator("status")
52    def status_validate_enum(cls, value):
53        """Validates the enum"""
54        if value is None:
55            return value
56
57        if value not in set(["disconnected", "connected", "disabled"]):
58            raise ValueError("must be one of enum values ('disconnected', 'connected', 'disabled')")
59        return value

Validates the enum

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

def to_str(self) -> str: View Source

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

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

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

Create an instance of AppCardData from a JSON string

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

 81    def to_dict(self) -> Dict[str, Any]:
 82        """Return the dictionary representation of the model using alias.
 83
 84        This has the following differences from calling pydantic's
 85        `self.model_dump(by_alias=True)`:
 86
 87        * `None` is only added to the output dict for nullable fields that
 88          were set at model initialization. Other fields with value `None`
 89          are ignored.
 90        * Fields in `self.additional_properties` are added to the output dict.
 91        """
 92        excluded_fields: Set[str] = set(
 93            [
 94                "additional_properties",
 95            ]
 96        )
 97
 98        _dict = self.model_dump(
 99            by_alias=True,
100            exclude=excluded_fields,
101            exclude_none=True,
102        )
103        # override the default output from pydantic by calling `to_dict()` of each item in fields (list)
104        _items = []
105        if self.fields:
106            for _item in self.fields:
107                if _item:
108                    _items.append(_item.to_dict())
109            _dict["fields"] = _items
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 AppCardData 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                "description": obj.get("description"),
129                "fields": (
130                    [CustomField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None
131                ),
132                "owned": obj.get("owned"),
133                "status": obj.get("status"),
134                "title": obj.get("title"),
135            }
136        )
137        # store additional fields in additional_properties
138        for _key in obj.keys():
139            if _key not in cls.__properties:
140                _obj.additional_properties[_key] = obj.get(_key)
141
142        return _obj

Create an instance of AppCardData 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 = {'description': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='A short text description to add context about the app card.'), 'fields': FieldInfo(annotation=Union[List[miro_api.models.custom_field.CustomField], NoneType], required=False, description='Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.'), 'owned': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, description='Defines whether the card is owned by the application making the call.'), 'status': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Status indicating whether an app card is connected and in sync with the source. When the source for the app card is deleted, the status returns `disabled`.'), 'title': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='A short text header to identify the app card.'), '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