miro_api.models.teams_page

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, StrictStr
 21from typing import Any, ClassVar, Dict, List, Optional
 22from typing_extensions import Annotated
 23from miro_api.models.team import Team
 24from typing import Optional, Set
 25from typing_extensions import Self
 26
 27
 28class TeamsPage(BaseModel):
 29    """
 30    Page of teams that match the search query.
 31    """  # noqa: E501
 32
 33    limit: Annotated[int, Field(le=100, strict=True, ge=1)] = Field(
 34        description="The maximum number of results to return per call. If the number of project in the response is greater than the limit specified, the response returns the cursor parameter with a value."
 35    )
 36    size: Annotated[int, Field(le=100, strict=True, ge=0)] = Field(
 37        description="Number of results returned in the response considering the cursor and the limit values sent in the request. For example, if there are 20 results, the request does not have a cursor value, and the limit set to 10, the size of the results will be 10. In this example, the response will also return a cursor value that can be used to retrieve the next set of 10 remaining results in the collection."
 38    )
 39    data: List[Team] = Field(description="List of teams")
 40    cursor: Optional[StrictStr] = Field(
 41        default=None,
 42        description="Indicator of the position of the next page of the result. To retrieve the next page, make another query setting its cursor field to the value returned by the current query. If the value is empty, there are no more pages to fetch.",
 43    )
 44    type: Optional[StrictStr] = Field(default="cursor-list", description="Type of the object returned.")
 45    additional_properties: Dict[str, Any] = {}
 46    __properties: ClassVar[List[str]] = ["limit", "size", "data", "cursor", "type"]
 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 TeamsPage 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 data (list)
 91        _items = []
 92        if self.data:
 93            for _item in self.data:
 94                if _item:
 95                    _items.append(_item.to_dict())
 96            _dict["data"] = _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 TeamsPage 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                "limit": obj.get("limit") if obj.get("limit") is not None else 100,
116                "size": obj.get("size") if obj.get("size") is not None else 100,
117                "data": [Team.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
118                "cursor": obj.get("cursor"),
119                "type": obj.get("type") if obj.get("type") is not None else "cursor-list",
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 TeamsPage(pydantic.main.BaseModel): View Source

 29class TeamsPage(BaseModel):
 30    """
 31    Page of teams that match the search query.
 32    """  # noqa: E501
 33
 34    limit: Annotated[int, Field(le=100, strict=True, ge=1)] = Field(
 35        description="The maximum number of results to return per call. If the number of project in the response is greater than the limit specified, the response returns the cursor parameter with a value."
 36    )
 37    size: Annotated[int, Field(le=100, strict=True, ge=0)] = Field(
 38        description="Number of results returned in the response considering the cursor and the limit values sent in the request. For example, if there are 20 results, the request does not have a cursor value, and the limit set to 10, the size of the results will be 10. In this example, the response will also return a cursor value that can be used to retrieve the next set of 10 remaining results in the collection."
 39    )
 40    data: List[Team] = Field(description="List of teams")
 41    cursor: Optional[StrictStr] = Field(
 42        default=None,
 43        description="Indicator of the position of the next page of the result. To retrieve the next page, make another query setting its cursor field to the value returned by the current query. If the value is empty, there are no more pages to fetch.",
 44    )
 45    type: Optional[StrictStr] = Field(default="cursor-list", description="Type of the object returned.")
 46    additional_properties: Dict[str, Any] = {}
 47    __properties: ClassVar[List[str]] = ["limit", "size", "data", "cursor", "type"]
 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 TeamsPage 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 data (list)
 92        _items = []
 93        if self.data:
 94            for _item in self.data:
 95                if _item:
 96                    _items.append(_item.to_dict())
 97            _dict["data"] = _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 TeamsPage 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                "limit": obj.get("limit") if obj.get("limit") is not None else 100,
117                "size": obj.get("size") if obj.get("size") is not None else 100,
118                "data": [Team.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
119                "cursor": obj.get("cursor"),
120                "type": obj.get("type") if obj.get("type") is not None else "cursor-list",
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

Page of teams that match the search query.

limit: typing.Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])]

size: typing.Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0), Le(le=100)])]

data: List[miro_api.models.team.Team]

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

type: 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

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 TeamsPage from a JSON string"""
67        return cls.from_dict(json.loads(json_str))

Create an instance of TeamsPage 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 data (list)
 92        _items = []
 93        if self.data:
 94            for _item in self.data:
 95                if _item:
 96                    _items.append(_item.to_dict())
 97            _dict["data"] = _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 TeamsPage 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                "limit": obj.get("limit") if obj.get("limit") is not None else 100,
117                "size": obj.get("size") if obj.get("size") is not None else 100,
118                "data": [Team.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
119                "cursor": obj.get("cursor"),
120                "type": obj.get("type") if obj.get("type") is not None else "cursor-list",
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 TeamsPage 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 = {'limit': FieldInfo(annotation=int, required=True, description='The maximum number of results to return per call. If the number of project in the response is greater than the limit specified, the response returns the cursor parameter with a value.', metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)]), 'size': FieldInfo(annotation=int, required=True, description='Number of results returned in the response considering the cursor and the limit values sent in the request. For example, if there are 20 results, the request does not have a cursor value, and the limit set to 10, the size of the results will be 10. In this example, the response will also return a cursor value that can be used to retrieve the next set of 10 remaining results in the collection.', metadata=[Strict(strict=True), Ge(ge=0), Le(le=100)]), 'data': FieldInfo(annotation=List[miro_api.models.team.Team], required=True, description='List of teams'), 'cursor': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Indicator of the position of the next page of the result. To retrieve the next page, make another query setting its cursor field to the value returned by the current query. If the value is empty, there are no more pages to fetch.'), 'type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='cursor-list', description='Type of the object returned.'), '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