miro_api.models.app_card_data_platform

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 AppCardDataPlatform(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,
 34        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,
 42        description="Defines whether the card is owned by the application making the call.",
 43    )
 44    status: Optional[StrictStr] = Field(
 45        default=None,
 46        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`.",
 47    )
 48    title: Optional[StrictStr] = Field(default=None, description="A short text header to identify the app card.")
 49    additional_properties: Dict[str, Any] = {}
 50    __properties: ClassVar[List[str]] = [
 51        "description",
 52        "fields",
 53        "owned",
 54        "status",
 55        "title",
 56    ]
 57
 58    @field_validator("status")
 59    def status_validate_enum(cls, value):
 60        """Validates the enum"""
 61        if value is None:
 62            return value
 63
 64        if value not in set(["disconnected", "connected", "disabled"]):
 65            raise ValueError("must be one of enum values ('disconnected', 'connected', 'disabled')")
 66        return value
 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 AppCardDataPlatform 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        # override the default output from pydantic by calling `to_dict()` of each item in fields (list)
111        _items = []
112        if self.fields:
113            for _item in self.fields:
114                if _item:
115                    _items.append(_item.to_dict())
116            _dict["fields"] = _items
117        # puts key-value pairs in additional_properties in the top level
118        if self.additional_properties is not None:
119            for _key, _value in self.additional_properties.items():
120                _dict[_key] = _value
121
122        return _dict
123
124    @classmethod
125    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
126        """Create an instance of AppCardDataPlatform from a dict"""
127        if obj is None:
128            return None
129
130        if not isinstance(obj, dict):
131            return cls.model_validate(obj)
132
133        _obj = cls.model_validate(
134            {
135                "description": obj.get("description"),
136                "fields": (
137                    [CustomField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None
138                ),
139                "owned": obj.get("owned"),
140                "status": obj.get("status"),
141                "title": obj.get("title"),
142            }
143        )
144        # store additional fields in additional_properties
145        for _key in obj.keys():
146            if _key not in cls.__properties:
147                _obj.additional_properties[_key] = obj.get(_key)
148
149        return _obj

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

 28class AppCardDataPlatform(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,
 35        description="A short text description to add context about the app card.",
 36    )
 37    fields: Optional[List[CustomField]] = Field(
 38        default=None,
 39        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.",
 40    )
 41    owned: Optional[StrictBool] = Field(
 42        default=None,
 43        description="Defines whether the card is owned by the application making the call.",
 44    )
 45    status: Optional[StrictStr] = Field(
 46        default=None,
 47        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`.",
 48    )
 49    title: Optional[StrictStr] = Field(default=None, description="A short text header to identify the app card.")
 50    additional_properties: Dict[str, Any] = {}
 51    __properties: ClassVar[List[str]] = [
 52        "description",
 53        "fields",
 54        "owned",
 55        "status",
 56        "title",
 57    ]
 58
 59    @field_validator("status")
 60    def status_validate_enum(cls, value):
 61        """Validates the enum"""
 62        if value is None:
 63            return value
 64
 65        if value not in set(["disconnected", "connected", "disabled"]):
 66            raise ValueError("must be one of enum values ('disconnected', 'connected', 'disabled')")
 67        return value
 68
 69    model_config = {
 70        "populate_by_name": True,
 71        "validate_assignment": True,
 72        "protected_namespaces": (),
 73    }
 74
 75    def to_str(self) -> str:
 76        """Returns the string representation of the model using alias"""
 77        return pprint.pformat(self.model_dump(by_alias=True))
 78
 79    def to_json(self) -> str:
 80        """Returns the JSON representation of the model using alias"""
 81        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 82        return json.dumps(self.to_dict())
 83
 84    @classmethod
 85    def from_json(cls, json_str: str) -> Optional[Self]:
 86        """Create an instance of AppCardDataPlatform from a JSON string"""
 87        return cls.from_dict(json.loads(json_str))
 88
 89    def to_dict(self) -> Dict[str, Any]:
 90        """Return the dictionary representation of the model using alias.
 91
 92        This has the following differences from calling pydantic's
 93        `self.model_dump(by_alias=True)`:
 94
 95        * `None` is only added to the output dict for nullable fields that
 96          were set at model initialization. Other fields with value `None`
 97          are ignored.
 98        * Fields in `self.additional_properties` are added to the output dict.
 99        """
100        excluded_fields: Set[str] = set(
101            [
102                "additional_properties",
103            ]
104        )
105
106        _dict = self.model_dump(
107            by_alias=True,
108            exclude=excluded_fields,
109            exclude_none=True,
110        )
111        # override the default output from pydantic by calling `to_dict()` of each item in fields (list)
112        _items = []
113        if self.fields:
114            for _item in self.fields:
115                if _item:
116                    _items.append(_item.to_dict())
117            _dict["fields"] = _items
118        # puts key-value pairs in additional_properties in the top level
119        if self.additional_properties is not None:
120            for _key, _value in self.additional_properties.items():
121                _dict[_key] = _value
122
123        return _dict
124
125    @classmethod
126    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
127        """Create an instance of AppCardDataPlatform from a dict"""
128        if obj is None:
129            return None
130
131        if not isinstance(obj, dict):
132            return cls.model_validate(obj)
133
134        _obj = cls.model_validate(
135            {
136                "description": obj.get("description"),
137                "fields": (
138                    [CustomField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None
139                ),
140                "owned": obj.get("owned"),
141                "status": obj.get("status"),
142                "title": obj.get("title"),
143            }
144        )
145        # store additional fields in additional_properties
146        for _key in obj.keys():
147            if _key not in cls.__properties:
148                _obj.additional_properties[_key] = obj.get(_key)
149
150        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

59    @field_validator("status")
60    def status_validate_enum(cls, value):
61        """Validates the enum"""
62        if value is None:
63            return value
64
65        if value not in set(["disconnected", "connected", "disabled"]):
66            raise ValueError("must be one of enum values ('disconnected', 'connected', 'disabled')")
67        return value

Validates the enum

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

def to_str(self) -> str: View Source

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

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

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

Create an instance of AppCardDataPlatform from a JSON string

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

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

125    @classmethod
126    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
127        """Create an instance of AppCardDataPlatform from a dict"""
128        if obj is None:
129            return None
130
131        if not isinstance(obj, dict):
132            return cls.model_validate(obj)
133
134        _obj = cls.model_validate(
135            {
136                "description": obj.get("description"),
137                "fields": (
138                    [CustomField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None
139                ),
140                "owned": obj.get("owned"),
141                "status": obj.get("status"),
142                "title": obj.get("title"),
143            }
144        )
145        # store additional fields in additional_properties
146        for _key in obj.keys():
147            if _key not in cls.__properties:
148                _obj.additional_properties[_key] = obj.get(_key)
149
150        return _obj

Create an instance of AppCardDataPlatform 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