miro_api.models.schema_list_response_resources_inner

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 pydantic import BaseModel, Field, StrictStr
 20from typing import Any, ClassVar, Dict, List, Optional
 21from miro_api.models.schema_list_response_resources_inner_attributes_inner import (
 22    SchemaListResponseResourcesInnerAttributesInner,
 23)
 24from miro_api.models.schema_list_response_resources_inner_meta import SchemaListResponseResourcesInnerMeta
 25from typing import Optional, Set
 26from typing_extensions import Self
 27
 28
 29class SchemaListResponseResourcesInner(BaseModel):
 30    """
 31    SchemaListResponseResourcesInner
 32    """  # noqa: E501
 33
 34    schemas: Optional[List[StrictStr]] = Field(
 35        default=None, description="Schema(s) that define the structure of this resource."
 36    )
 37    id: Optional[StrictStr] = Field(default=None, description="Identifier of the resource.")
 38    name: Optional[StrictStr] = Field(default=None, description="Name of the resource.")
 39    description: Optional[StrictStr] = Field(default=None, description="Description of the resource.")
 40    attributes: Optional[List[SchemaListResponseResourcesInnerAttributesInner]] = Field(
 41        default=None, description="Attributes that are currently supported."
 42    )
 43    meta: Optional[SchemaListResponseResourcesInnerMeta] = None
 44    additional_properties: Dict[str, Any] = {}
 45    __properties: ClassVar[List[str]] = ["schemas", "id", "name", "description", "attributes", "meta"]
 46
 47    model_config = {
 48        "populate_by_name": True,
 49        "validate_assignment": True,
 50        "protected_namespaces": (),
 51    }
 52
 53    def to_str(self) -> str:
 54        """Returns the string representation of the model using alias"""
 55        return pprint.pformat(self.model_dump(by_alias=True))
 56
 57    def to_json(self) -> str:
 58        """Returns the JSON representation of the model using alias"""
 59        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 60        return json.dumps(self.to_dict())
 61
 62    @classmethod
 63    def from_json(cls, json_str: str) -> Optional[Self]:
 64        """Create an instance of SchemaListResponseResourcesInner from a JSON string"""
 65        return cls.from_dict(json.loads(json_str))
 66
 67    def to_dict(self) -> Dict[str, Any]:
 68        """Return the dictionary representation of the model using alias.
 69
 70        This has the following differences from calling pydantic's
 71        `self.model_dump(by_alias=True)`:
 72
 73        * `None` is only added to the output dict for nullable fields that
 74          were set at model initialization. Other fields with value `None`
 75          are ignored.
 76        * Fields in `self.additional_properties` are added to the output dict.
 77        """
 78        excluded_fields: Set[str] = set(
 79            [
 80                "additional_properties",
 81            ]
 82        )
 83
 84        _dict = self.model_dump(
 85            by_alias=True,
 86            exclude=excluded_fields,
 87            exclude_none=True,
 88        )
 89        # override the default output from pydantic by calling `to_dict()` of each item in attributes (list)
 90        _items = []
 91        if self.attributes:
 92            for _item in self.attributes:
 93                if _item:
 94                    _items.append(_item.to_dict())
 95            _dict["attributes"] = _items
 96        # override the default output from pydantic by calling `to_dict()` of meta
 97        if self.meta:
 98            _dict["meta"] = self.meta.to_dict()
 99        # puts key-value pairs in additional_properties in the top level
100        if self.additional_properties is not None:
101            for _key, _value in self.additional_properties.items():
102                _dict[_key] = _value
103
104        return _dict
105
106    @classmethod
107    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
108        """Create an instance of SchemaListResponseResourcesInner from a dict"""
109        if obj is None:
110            return None
111
112        if not isinstance(obj, dict):
113            return cls.model_validate(obj)
114
115        _obj = cls.model_validate(
116            {
117                "schemas": obj.get("schemas"),
118                "id": obj.get("id"),
119                "name": obj.get("name"),
120                "description": obj.get("description"),
121                "attributes": (
122                    [SchemaListResponseResourcesInnerAttributesInner.from_dict(_item) for _item in obj["attributes"]]
123                    if obj.get("attributes") is not None
124                    else None
125                ),
126                "meta": (
127                    SchemaListResponseResourcesInnerMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None
128                ),
129            }
130        )
131        # store additional fields in additional_properties
132        for _key in obj.keys():
133            if _key not in cls.__properties:
134                _obj.additional_properties[_key] = obj.get(_key)
135
136        return _obj

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

 30class SchemaListResponseResourcesInner(BaseModel):
 31    """
 32    SchemaListResponseResourcesInner
 33    """  # noqa: E501
 34
 35    schemas: Optional[List[StrictStr]] = Field(
 36        default=None, description="Schema(s) that define the structure of this resource."
 37    )
 38    id: Optional[StrictStr] = Field(default=None, description="Identifier of the resource.")
 39    name: Optional[StrictStr] = Field(default=None, description="Name of the resource.")
 40    description: Optional[StrictStr] = Field(default=None, description="Description of the resource.")
 41    attributes: Optional[List[SchemaListResponseResourcesInnerAttributesInner]] = Field(
 42        default=None, description="Attributes that are currently supported."
 43    )
 44    meta: Optional[SchemaListResponseResourcesInnerMeta] = None
 45    additional_properties: Dict[str, Any] = {}
 46    __properties: ClassVar[List[str]] = ["schemas", "id", "name", "description", "attributes", "meta"]
 47
 48    model_config = {
 49        "populate_by_name": True,
 50        "validate_assignment": True,
 51        "protected_namespaces": (),
 52    }
 53
 54    def to_str(self) -> str:
 55        """Returns the string representation of the model using alias"""
 56        return pprint.pformat(self.model_dump(by_alias=True))
 57
 58    def to_json(self) -> str:
 59        """Returns the JSON representation of the model using alias"""
 60        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 61        return json.dumps(self.to_dict())
 62
 63    @classmethod
 64    def from_json(cls, json_str: str) -> Optional[Self]:
 65        """Create an instance of SchemaListResponseResourcesInner from a JSON string"""
 66        return cls.from_dict(json.loads(json_str))
 67
 68    def to_dict(self) -> Dict[str, Any]:
 69        """Return the dictionary representation of the model using alias.
 70
 71        This has the following differences from calling pydantic's
 72        `self.model_dump(by_alias=True)`:
 73
 74        * `None` is only added to the output dict for nullable fields that
 75          were set at model initialization. Other fields with value `None`
 76          are ignored.
 77        * Fields in `self.additional_properties` are added to the output dict.
 78        """
 79        excluded_fields: Set[str] = set(
 80            [
 81                "additional_properties",
 82            ]
 83        )
 84
 85        _dict = self.model_dump(
 86            by_alias=True,
 87            exclude=excluded_fields,
 88            exclude_none=True,
 89        )
 90        # override the default output from pydantic by calling `to_dict()` of each item in attributes (list)
 91        _items = []
 92        if self.attributes:
 93            for _item in self.attributes:
 94                if _item:
 95                    _items.append(_item.to_dict())
 96            _dict["attributes"] = _items
 97        # override the default output from pydantic by calling `to_dict()` of meta
 98        if self.meta:
 99            _dict["meta"] = self.meta.to_dict()
100        # puts key-value pairs in additional_properties in the top level
101        if self.additional_properties is not None:
102            for _key, _value in self.additional_properties.items():
103                _dict[_key] = _value
104
105        return _dict
106
107    @classmethod
108    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
109        """Create an instance of SchemaListResponseResourcesInner from a dict"""
110        if obj is None:
111            return None
112
113        if not isinstance(obj, dict):
114            return cls.model_validate(obj)
115
116        _obj = cls.model_validate(
117            {
118                "schemas": obj.get("schemas"),
119                "id": obj.get("id"),
120                "name": obj.get("name"),
121                "description": obj.get("description"),
122                "attributes": (
123                    [SchemaListResponseResourcesInnerAttributesInner.from_dict(_item) for _item in obj["attributes"]]
124                    if obj.get("attributes") is not None
125                    else None
126                ),
127                "meta": (
128                    SchemaListResponseResourcesInnerMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None
129                ),
130            }
131        )
132        # store additional fields in additional_properties
133        for _key in obj.keys():
134            if _key not in cls.__properties:
135                _obj.additional_properties[_key] = obj.get(_key)
136
137        return _obj

SchemaListResponseResourcesInner

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

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

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

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

attributes: Optional[List[miro_api.models.schema_list_response_resources_inner_attributes_inner.SchemaListResponseResourcesInnerAttributesInner]]

meta: Optional[miro_api.models.schema_list_response_resources_inner_meta.SchemaListResponseResourcesInnerMeta]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

63    @classmethod
64    def from_json(cls, json_str: str) -> Optional[Self]:
65        """Create an instance of SchemaListResponseResourcesInner from a JSON string"""
66        return cls.from_dict(json.loads(json_str))

Create an instance of SchemaListResponseResourcesInner from a JSON string

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

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

107    @classmethod
108    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
109        """Create an instance of SchemaListResponseResourcesInner from a dict"""
110        if obj is None:
111            return None
112
113        if not isinstance(obj, dict):
114            return cls.model_validate(obj)
115
116        _obj = cls.model_validate(
117            {
118                "schemas": obj.get("schemas"),
119                "id": obj.get("id"),
120                "name": obj.get("name"),
121                "description": obj.get("description"),
122                "attributes": (
123                    [SchemaListResponseResourcesInnerAttributesInner.from_dict(_item) for _item in obj["attributes"]]
124                    if obj.get("attributes") is not None
125                    else None
126                ),
127                "meta": (
128                    SchemaListResponseResourcesInnerMeta.from_dict(obj["meta"]) if obj.get("meta") is not None else None
129                ),
130            }
131        )
132        # store additional fields in additional_properties
133        for _key in obj.keys():
134            if _key not in cls.__properties:
135                _obj.additional_properties[_key] = obj.get(_key)
136
137        return _obj

Create an instance of SchemaListResponseResourcesInner 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 = {'schemas': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, description='Schema(s) that define the structure of this resource.'), 'id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Identifier of the resource.'), 'name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Name of the resource.'), 'description': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Description of the resource.'), 'attributes': FieldInfo(annotation=Union[List[miro_api.models.schema_list_response_resources_inner_attributes_inner.SchemaListResponseResourcesInnerAttributesInner], NoneType], required=False, description='Attributes that are currently supported.'), 'meta': FieldInfo(annotation=Union[SchemaListResponseResourcesInnerMeta, NoneType], required=False), '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