miro_api.models.schema_list_response

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

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

 27class SchemaListResponse(BaseModel):
 28    """
 29    Metadata about Users, Groups and extension attributes that are currently supported.
 30    """  # noqa: E501
 31
 32    schemas: Optional[List[StrictStr]] = Field(
 33        default=None,
 34        description="Schema(s) that define the structure of this response. <br><br> In this case, it contains urn:ietf:params:scim:api:messages:2.0:ListResponse, which indicates that this is a SCIM ListResponse.",
 35    )
 36    total_results: Optional[Union[StrictFloat, StrictInt]] = Field(
 37        default=None, description="Number of schemas returned in the response.", alias="totalResults"
 38    )
 39    resources: Optional[List[SchemaListResponseResourcesInner]] = Field(
 40        default=None,
 41        description="Resources containing metadata about attributes that are currently supported.",
 42        alias="Resources",
 43    )
 44    additional_properties: Dict[str, Any] = {}
 45    __properties: ClassVar[List[str]] = ["schemas", "totalResults", "Resources"]
 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 SchemaListResponse 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 resources (list)
 90        _items = []
 91        if self.resources:
 92            for _item in self.resources:
 93                if _item:
 94                    _items.append(_item.to_dict())
 95            _dict["Resources"] = _items
 96        # puts key-value pairs in additional_properties in the top level
 97        if self.additional_properties is not None:
 98            for _key, _value in self.additional_properties.items():
 99                _dict[_key] = _value
100
101        return _dict
102
103    @classmethod
104    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
105        """Create an instance of SchemaListResponse from a dict"""
106        if obj is None:
107            return None
108
109        if not isinstance(obj, dict):
110            return cls.model_validate(obj)
111
112        _obj = cls.model_validate(
113            {
114                "schemas": obj.get("schemas"),
115                "totalResults": obj.get("totalResults"),
116                "Resources": (
117                    [SchemaListResponseResourcesInner.from_dict(_item) for _item in obj["Resources"]]
118                    if obj.get("Resources") is not None
119                    else None
120                ),
121            }
122        )
123        # store additional fields in additional_properties
124        for _key in obj.keys():
125            if _key not in cls.__properties:
126                _obj.additional_properties[_key] = obj.get(_key)
127
128        return _obj

Metadata about Users, Groups and extension attributes that are currently supported.

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

total_results: Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType]

resources: Optional[List[miro_api.models.schema_list_response_resources_inner.SchemaListResponseResourcesInner]]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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))

Returns the string representation of the model using alias

def to_json(self) -> str: View Source

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())

Returns the JSON representation of the model using alias

@classmethod

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

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

Create an instance of SchemaListResponse from a JSON string

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

 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 resources (list)
 90        _items = []
 91        if self.resources:
 92            for _item in self.resources:
 93                if _item:
 94                    _items.append(_item.to_dict())
 95            _dict["Resources"] = _items
 96        # puts key-value pairs in additional_properties in the top level
 97        if self.additional_properties is not None:
 98            for _key, _value in self.additional_properties.items():
 99                _dict[_key] = _value
100
101        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

103    @classmethod
104    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
105        """Create an instance of SchemaListResponse from a dict"""
106        if obj is None:
107            return None
108
109        if not isinstance(obj, dict):
110            return cls.model_validate(obj)
111
112        _obj = cls.model_validate(
113            {
114                "schemas": obj.get("schemas"),
115                "totalResults": obj.get("totalResults"),
116                "Resources": (
117                    [SchemaListResponseResourcesInner.from_dict(_item) for _item in obj["Resources"]]
118                    if obj.get("Resources") is not None
119                    else None
120                ),
121            }
122        )
123        # store additional fields in additional_properties
124        for _key in obj.keys():
125            if _key not in cls.__properties:
126                _obj.additional_properties[_key] = obj.get(_key)
127
128        return _obj

Create an instance of SchemaListResponse 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 response. <br><br> In this case, it contains urn:ietf:params:scim:api:messages:2.0:ListResponse, which indicates that this is a SCIM ListResponse.'), 'total_results': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, alias='totalResults', alias_priority=2, description='Number of schemas returned in the response.'), 'resources': FieldInfo(annotation=Union[List[miro_api.models.schema_list_response_resources_inner.SchemaListResponseResourcesInner], NoneType], required=False, alias='Resources', alias_priority=2, description='Resources containing metadata about attributes that are currently supported.'), '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