miro_api.models.schema_list_response_resources_inner_attributes_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, StrictBool, StrictStr
 20from typing import Any, ClassVar, Dict, List, Optional
 21from typing import Optional, Set
 22from typing_extensions import Self
 23
 24
 25class SchemaListResponseResourcesInnerAttributesInner(BaseModel):
 26    """
 27    SchemaListResponseResourcesInnerAttributesInner
 28    """  # noqa: E501
 29
 30    name: Optional[StrictStr] = Field(default=None, description="Name of the attribute.")
 31    type: Optional[StrictStr] = Field(default=None, description="Data type of the attribute.")
 32    multi_valued: Optional[StrictBool] = Field(
 33        default=None, description="Indicates whether the attribute is multi-valued.", alias="multiValued"
 34    )
 35    description: Optional[StrictStr] = Field(default=None, description="Description of the attribute.")
 36    required: Optional[StrictBool] = Field(default=None, description="Indicates whether the attribute is required.")
 37    case_exact: Optional[StrictBool] = Field(
 38        default=None, description="Indicates whether the attribute is case exact.", alias="caseExact"
 39    )
 40    mutability: Optional[StrictStr] = Field(default=None, description="Indicates the mutability of the attribute.")
 41    returned: Optional[StrictStr] = Field(
 42        default=None, description="Indicates when the attribute is returned in a response."
 43    )
 44    uniqueness: Optional[StrictStr] = Field(default=None, description="Indicates the uniqueness of the attribute.")
 45    additional_properties: Dict[str, Any] = {}
 46    __properties: ClassVar[List[str]] = [
 47        "name",
 48        "type",
 49        "multiValued",
 50        "description",
 51        "required",
 52        "caseExact",
 53        "mutability",
 54        "returned",
 55        "uniqueness",
 56    ]
 57
 58    model_config = {
 59        "populate_by_name": True,
 60        "validate_assignment": True,
 61        "protected_namespaces": (),
 62    }
 63
 64    def to_str(self) -> str:
 65        """Returns the string representation of the model using alias"""
 66        return pprint.pformat(self.model_dump(by_alias=True))
 67
 68    def to_json(self) -> str:
 69        """Returns the JSON representation of the model using alias"""
 70        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 71        return json.dumps(self.to_dict())
 72
 73    @classmethod
 74    def from_json(cls, json_str: str) -> Optional[Self]:
 75        """Create an instance of SchemaListResponseResourcesInnerAttributesInner from a JSON string"""
 76        return cls.from_dict(json.loads(json_str))
 77
 78    def to_dict(self) -> Dict[str, Any]:
 79        """Return the dictionary representation of the model using alias.
 80
 81        This has the following differences from calling pydantic's
 82        `self.model_dump(by_alias=True)`:
 83
 84        * `None` is only added to the output dict for nullable fields that
 85          were set at model initialization. Other fields with value `None`
 86          are ignored.
 87        * Fields in `self.additional_properties` are added to the output dict.
 88        """
 89        excluded_fields: Set[str] = set(
 90            [
 91                "additional_properties",
 92            ]
 93        )
 94
 95        _dict = self.model_dump(
 96            by_alias=True,
 97            exclude=excluded_fields,
 98            exclude_none=True,
 99        )
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 SchemaListResponseResourcesInnerAttributesInner 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                "name": obj.get("name"),
119                "type": obj.get("type"),
120                "multiValued": obj.get("multiValued"),
121                "description": obj.get("description"),
122                "required": obj.get("required"),
123                "caseExact": obj.get("caseExact"),
124                "mutability": obj.get("mutability"),
125                "returned": obj.get("returned"),
126                "uniqueness": obj.get("uniqueness"),
127            }
128        )
129        # store additional fields in additional_properties
130        for _key in obj.keys():
131            if _key not in cls.__properties:
132                _obj.additional_properties[_key] = obj.get(_key)
133
134        return _obj

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

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

SchemaListResponseResourcesInnerAttributesInner

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

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

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

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

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

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

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

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

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

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

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

Create an instance of SchemaListResponseResourcesInnerAttributesInner from a JSON string

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

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

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

Create an instance of SchemaListResponseResourcesInnerAttributesInner 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 = {'name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Name of the attribute.'), 'type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Data type of the attribute.'), 'multi_valued': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='multiValued', alias_priority=2, description='Indicates whether the attribute is multi-valued.'), 'description': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Description of the attribute.'), 'required': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, description='Indicates whether the attribute is required.'), 'case_exact': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='caseExact', alias_priority=2, description='Indicates whether the attribute is case exact.'), 'mutability': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Indicates the mutability of the attribute.'), 'returned': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Indicates when the attribute is returned in a response.'), 'uniqueness': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Indicates the uniqueness of the attribute.'), '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