miro_api.models.user_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.user_resource import UserResource
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class UserListResponse(BaseModel):
 27    """
 28    UserListResponse
 29    """  # noqa: E501
 30
 31    schemas: Optional[List[StrictStr]] = Field(
 32        default=None,
 33        description="An array of URNs that identify the 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 — a paginated wrapper around a set of resources (such as Users or Groups).",
 34    )
 35    total_results: Optional[Union[StrictFloat, StrictInt]] = Field(
 36        default=None, description="The total number of results matching the request.", alias="totalResults"
 37    )
 38    start_index: Optional[Union[StrictFloat, StrictInt]] = Field(
 39        default=None, description="The index of the first returned result in the current page.", alias="startIndex"
 40    )
 41    items_per_page: Optional[Union[StrictFloat, StrictInt]] = Field(
 42        default=None, description="The number of items returned in the response.", alias="itemsPerPage"
 43    )
 44    resources: Optional[List[UserResource]] = Field(default=None, alias="Resources")
 45    additional_properties: Dict[str, Any] = {}
 46    __properties: ClassVar[List[str]] = ["schemas", "totalResults", "startIndex", "itemsPerPage", "Resources"]
 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 UserListResponse 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 resources (list)
 91        _items = []
 92        if self.resources:
 93            for _item in self.resources:
 94                if _item:
 95                    _items.append(_item.to_dict())
 96            _dict["Resources"] = _items
 97        # puts key-value pairs in additional_properties in the top level
 98        if self.additional_properties is not None:
 99            for _key, _value in self.additional_properties.items():
100                _dict[_key] = _value
101
102        return _dict
103
104    @classmethod
105    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
106        """Create an instance of UserListResponse from a dict"""
107        if obj is None:
108            return None
109
110        if not isinstance(obj, dict):
111            return cls.model_validate(obj)
112
113        _obj = cls.model_validate(
114            {
115                "schemas": obj.get("schemas"),
116                "totalResults": obj.get("totalResults"),
117                "startIndex": obj.get("startIndex"),
118                "itemsPerPage": obj.get("itemsPerPage"),
119                "Resources": (
120                    [UserResource.from_dict(_item) for _item in obj["Resources"]]
121                    if obj.get("Resources") is not None
122                    else None
123                ),
124            }
125        )
126        # store additional fields in additional_properties
127        for _key in obj.keys():
128            if _key not in cls.__properties:
129                _obj.additional_properties[_key] = obj.get(_key)
130
131        return _obj

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

 27class UserListResponse(BaseModel):
 28    """
 29    UserListResponse
 30    """  # noqa: E501
 31
 32    schemas: Optional[List[StrictStr]] = Field(
 33        default=None,
 34        description="An array of URNs that identify the 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 — a paginated wrapper around a set of resources (such as Users or Groups).",
 35    )
 36    total_results: Optional[Union[StrictFloat, StrictInt]] = Field(
 37        default=None, description="The total number of results matching the request.", alias="totalResults"
 38    )
 39    start_index: Optional[Union[StrictFloat, StrictInt]] = Field(
 40        default=None, description="The index of the first returned result in the current page.", alias="startIndex"
 41    )
 42    items_per_page: Optional[Union[StrictFloat, StrictInt]] = Field(
 43        default=None, description="The number of items returned in the response.", alias="itemsPerPage"
 44    )
 45    resources: Optional[List[UserResource]] = Field(default=None, alias="Resources")
 46    additional_properties: Dict[str, Any] = {}
 47    __properties: ClassVar[List[str]] = ["schemas", "totalResults", "startIndex", "itemsPerPage", "Resources"]
 48
 49    model_config = {
 50        "populate_by_name": True,
 51        "validate_assignment": True,
 52        "protected_namespaces": (),
 53    }
 54
 55    def to_str(self) -> str:
 56        """Returns the string representation of the model using alias"""
 57        return pprint.pformat(self.model_dump(by_alias=True))
 58
 59    def to_json(self) -> str:
 60        """Returns the JSON representation of the model using alias"""
 61        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 62        return json.dumps(self.to_dict())
 63
 64    @classmethod
 65    def from_json(cls, json_str: str) -> Optional[Self]:
 66        """Create an instance of UserListResponse from a JSON string"""
 67        return cls.from_dict(json.loads(json_str))
 68
 69    def to_dict(self) -> Dict[str, Any]:
 70        """Return the dictionary representation of the model using alias.
 71
 72        This has the following differences from calling pydantic's
 73        `self.model_dump(by_alias=True)`:
 74
 75        * `None` is only added to the output dict for nullable fields that
 76          were set at model initialization. Other fields with value `None`
 77          are ignored.
 78        * Fields in `self.additional_properties` are added to the output dict.
 79        """
 80        excluded_fields: Set[str] = set(
 81            [
 82                "additional_properties",
 83            ]
 84        )
 85
 86        _dict = self.model_dump(
 87            by_alias=True,
 88            exclude=excluded_fields,
 89            exclude_none=True,
 90        )
 91        # override the default output from pydantic by calling `to_dict()` of each item in resources (list)
 92        _items = []
 93        if self.resources:
 94            for _item in self.resources:
 95                if _item:
 96                    _items.append(_item.to_dict())
 97            _dict["Resources"] = _items
 98        # puts key-value pairs in additional_properties in the top level
 99        if self.additional_properties is not None:
100            for _key, _value in self.additional_properties.items():
101                _dict[_key] = _value
102
103        return _dict
104
105    @classmethod
106    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
107        """Create an instance of UserListResponse from a dict"""
108        if obj is None:
109            return None
110
111        if not isinstance(obj, dict):
112            return cls.model_validate(obj)
113
114        _obj = cls.model_validate(
115            {
116                "schemas": obj.get("schemas"),
117                "totalResults": obj.get("totalResults"),
118                "startIndex": obj.get("startIndex"),
119                "itemsPerPage": obj.get("itemsPerPage"),
120                "Resources": (
121                    [UserResource.from_dict(_item) for _item in obj["Resources"]]
122                    if obj.get("Resources") is not None
123                    else None
124                ),
125            }
126        )
127        # store additional fields in additional_properties
128        for _key in obj.keys():
129            if _key not in cls.__properties:
130                _obj.additional_properties[_key] = obj.get(_key)
131
132        return _obj

UserListResponse

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

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

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

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

resources: Optional[List[miro_api.models.user_resource.UserResource]]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

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

Create an instance of UserListResponse from a JSON string

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

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

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

Create an instance of UserListResponse 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='An array of URNs that identify the 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 — a paginated wrapper around a set of resources (such as Users or Groups).'), 'total_results': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, alias='totalResults', alias_priority=2, description='The total number of results matching the request.'), 'start_index': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, alias='startIndex', alias_priority=2, description='The index of the first returned result in the current page.'), 'items_per_page': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, alias='itemsPerPage', alias_priority=2, description='The number of items returned in the response.'), 'resources': FieldInfo(annotation=Union[List[miro_api.models.user_resource.UserResource], NoneType], required=False, alias='Resources', alias_priority=2), '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