miro_api.models.items_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
 14from __future__ import annotations
 15import pprint
 16import re  # noqa: F401
 17import json
 18
 19from pydantic import BaseModel, Field, StrictInt, StrictStr
 20from typing import Any, ClassVar, Dict, List
 21from miro_api.models.item import Item
 22from miro_api.models.page_links import PageLinks
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class ItemsPage(BaseModel):
 28    """
 29    Contains cursor-based items page information.
 30    """  # noqa: E501
 31
 32    size: StrictInt = Field(
 33        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`.<br>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."
 34    )
 35    limit: StrictInt = Field(
 36        description="Maximum number of results returned based on the `limit` specified in the request. For example, if there are `20` results, the request has no `cursor` value, and the `limit` is set to `20`,the `size` of the results will be `20`. The rest of the results will not be returned. To retrieve the rest of the results, you must make another request and set the appropriate value for the `cursor` parameter value that you obtained from the response."
 37    )
 38    total: StrictInt = Field(description="Total number of results available for the given request.")
 39    data: List[Item] = Field(description="Contains the result data.")
 40    links: PageLinks
 41    type: StrictStr = Field(description="Type of the object.")
 42    additional_properties: Dict[str, Any] = {}
 43    __properties: ClassVar[List[str]] = ["size", "limit", "total", "data", "links", "type"]
 44
 45    model_config = {
 46        "populate_by_name": True,
 47        "validate_assignment": True,
 48        "protected_namespaces": (),
 49    }
 50
 51    def to_str(self) -> str:
 52        """Returns the string representation of the model using alias"""
 53        return pprint.pformat(self.model_dump(by_alias=True))
 54
 55    def to_json(self) -> str:
 56        """Returns the JSON representation of the model using alias"""
 57        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 58        return json.dumps(self.to_dict())
 59
 60    @classmethod
 61    def from_json(cls, json_str: str) -> Optional[Self]:
 62        """Create an instance of ItemsPage from a JSON string"""
 63        return cls.from_dict(json.loads(json_str))
 64
 65    def to_dict(self) -> Dict[str, Any]:
 66        """Return the dictionary representation of the model using alias.
 67
 68        This has the following differences from calling pydantic's
 69        `self.model_dump(by_alias=True)`:
 70
 71        * `None` is only added to the output dict for nullable fields that
 72          were set at model initialization. Other fields with value `None`
 73          are ignored.
 74        * Fields in `self.additional_properties` are added to the output dict.
 75        """
 76        excluded_fields: Set[str] = set(
 77            [
 78                "additional_properties",
 79            ]
 80        )
 81
 82        _dict = self.model_dump(
 83            by_alias=True,
 84            exclude=excluded_fields,
 85            exclude_none=True,
 86        )
 87        # override the default output from pydantic by calling `to_dict()` of each item in data (list)
 88        _items = []
 89        if self.data:
 90            for _item in self.data:
 91                if _item:
 92                    _items.append(_item.to_dict())
 93            _dict["data"] = _items
 94        # override the default output from pydantic by calling `to_dict()` of links
 95        if self.links:
 96            _dict["links"] = self.links.to_dict()
 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 ItemsPage 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                "size": obj.get("size"),
116                "limit": obj.get("limit"),
117                "total": obj.get("total"),
118                "data": [Item.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
119                "links": PageLinks.from_dict(obj["links"]) if obj.get("links") is not None else None,
120                "type": obj.get("type"),
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

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

 28class ItemsPage(BaseModel):
 29    """
 30    Contains cursor-based items page information.
 31    """  # noqa: E501
 32
 33    size: StrictInt = Field(
 34        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`.<br>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."
 35    )
 36    limit: StrictInt = Field(
 37        description="Maximum number of results returned based on the `limit` specified in the request. For example, if there are `20` results, the request has no `cursor` value, and the `limit` is set to `20`,the `size` of the results will be `20`. The rest of the results will not be returned. To retrieve the rest of the results, you must make another request and set the appropriate value for the `cursor` parameter value that you obtained from the response."
 38    )
 39    total: StrictInt = Field(description="Total number of results available for the given request.")
 40    data: List[Item] = Field(description="Contains the result data.")
 41    links: PageLinks
 42    type: StrictStr = Field(description="Type of the object.")
 43    additional_properties: Dict[str, Any] = {}
 44    __properties: ClassVar[List[str]] = ["size", "limit", "total", "data", "links", "type"]
 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 ItemsPage 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 data (list)
 89        _items = []
 90        if self.data:
 91            for _item in self.data:
 92                if _item:
 93                    _items.append(_item.to_dict())
 94            _dict["data"] = _items
 95        # override the default output from pydantic by calling `to_dict()` of links
 96        if self.links:
 97            _dict["links"] = self.links.to_dict()
 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 ItemsPage 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                "size": obj.get("size"),
117                "limit": obj.get("limit"),
118                "total": obj.get("total"),
119                "data": [Item.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
120                "links": PageLinks.from_dict(obj["links"]) if obj.get("links") is not None else None,
121                "type": obj.get("type"),
122            }
123        )
124        # store additional fields in additional_properties
125        for _key in obj.keys():
126            if _key not in cls.__properties:
127                _obj.additional_properties[_key] = obj.get(_key)
128
129        return _obj

Contains cursor-based items page information.

size: typing.Annotated[int, Strict(strict=True)]

limit: typing.Annotated[int, Strict(strict=True)]

total: typing.Annotated[int, Strict(strict=True)]

data: List[miro_api.models.item.Item]

links: miro_api.models.page_links.PageLinks

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

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

Returns the string representation of the model using alias

def to_json(self) -> str: View Source

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

Returns the JSON representation of the model using alias

@classmethod

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

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

Create an instance of ItemsPage from a JSON string

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

 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 data (list)
 89        _items = []
 90        if self.data:
 91            for _item in self.data:
 92                if _item:
 93                    _items.append(_item.to_dict())
 94            _dict["data"] = _items
 95        # override the default output from pydantic by calling `to_dict()` of links
 96        if self.links:
 97            _dict["links"] = self.links.to_dict()
 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 ItemsPage 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                "size": obj.get("size"),
117                "limit": obj.get("limit"),
118                "total": obj.get("total"),
119                "data": [Item.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
120                "links": PageLinks.from_dict(obj["links"]) if obj.get("links") is not None else None,
121                "type": obj.get("type"),
122            }
123        )
124        # store additional fields in additional_properties
125        for _key in obj.keys():
126            if _key not in cls.__properties:
127                _obj.additional_properties[_key] = obj.get(_key)
128
129        return _obj

Create an instance of ItemsPage 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 = {'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`.<br>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)]), 'limit': FieldInfo(annotation=int, required=True, description='Maximum number of results returned based on the `limit` specified in the request. For example, if there are `20` results, the request has no `cursor` value, and the `limit` is set to `20`,the `size` of the results will be `20`. The rest of the results will not be returned. To retrieve the rest of the results, you must make another request and set the appropriate value for the `cursor` parameter value that you obtained from the response.', metadata=[Strict(strict=True)]), 'total': FieldInfo(annotation=int, required=True, description='Total number of results available for the given request.', metadata=[Strict(strict=True)]), 'data': FieldInfo(annotation=List[miro_api.models.item.Item], required=True, description='Contains the result data.'), 'links': FieldInfo(annotation=PageLinks, required=True), 'type': FieldInfo(annotation=str, required=True, description='Type of the object.', metadata=[Strict(strict=True)]), '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