miro_api.models.pagination

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.

  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, StrictInt, StrictStr
 21from typing import Any, ClassVar, Dict, List, Optional
 22from typing_extensions import Annotated
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class Pagination(BaseModel):
 28    """
 29    Pagination
 30    """  # noqa: E501
 31
 32    size: Optional[StrictInt] = Field(
 33        default=None,
 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. 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    total: Optional[StrictInt] = Field(default=None, description="Total number of results in the collection.")
 37    cursor: Optional[StrictStr] = Field(
 38        default=None,
 39        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.",
 40    )
 41    limit: Optional[Annotated[int, Field(le=100, strict=True, ge=1)]] = Field(
 42        default=100,
 43        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.",
 44    )
 45    type: Optional[StrictStr] = Field(
 46        default="cursor-list", description="Type of the response, in this case it's always 'cursor-list'."
 47    )
 48    additional_properties: Dict[str, Any] = {}
 49    __properties: ClassVar[List[str]] = ["size", "total", "cursor", "limit", "type"]
 50
 51    model_config = {
 52        "populate_by_name": True,
 53        "validate_assignment": True,
 54        "protected_namespaces": (),
 55    }
 56
 57    def to_str(self) -> str:
 58        """Returns the string representation of the model using alias"""
 59        return pprint.pformat(self.model_dump(by_alias=True))
 60
 61    def to_json(self) -> str:
 62        """Returns the JSON representation of the model using alias"""
 63        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 64        return json.dumps(self.to_dict())
 65
 66    @classmethod
 67    def from_json(cls, json_str: str) -> Optional[Self]:
 68        """Create an instance of Pagination from a JSON string"""
 69        return cls.from_dict(json.loads(json_str))
 70
 71    def to_dict(self) -> Dict[str, Any]:
 72        """Return the dictionary representation of the model using alias.
 73
 74        This has the following differences from calling pydantic's
 75        `self.model_dump(by_alias=True)`:
 76
 77        * `None` is only added to the output dict for nullable fields that
 78          were set at model initialization. Other fields with value `None`
 79          are ignored.
 80        * Fields in `self.additional_properties` are added to the output dict.
 81        """
 82        excluded_fields: Set[str] = set(
 83            [
 84                "additional_properties",
 85            ]
 86        )
 87
 88        _dict = self.model_dump(
 89            by_alias=True,
 90            exclude=excluded_fields,
 91            exclude_none=True,
 92        )
 93        # puts key-value pairs in additional_properties in the top level
 94        if self.additional_properties is not None:
 95            for _key, _value in self.additional_properties.items():
 96                _dict[_key] = _value
 97
 98        return _dict
 99
100    @classmethod
101    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
102        """Create an instance of Pagination from a dict"""
103        if obj is None:
104            return None
105
106        if not isinstance(obj, dict):
107            return cls.model_validate(obj)
108
109        _obj = cls.model_validate(
110            {
111                "size": obj.get("size"),
112                "total": obj.get("total"),
113                "cursor": obj.get("cursor"),
114                "limit": obj.get("limit") if obj.get("limit") is not None else 100,
115                "type": obj.get("type") if obj.get("type") is not None else "cursor-list",
116            }
117        )
118        # store additional fields in additional_properties
119        for _key in obj.keys():
120            if _key not in cls.__properties:
121                _obj.additional_properties[_key] = obj.get(_key)
122
123        return _obj
class Pagination(pydantic.main.BaseModel): 
 28class Pagination(BaseModel):
 29    """
 30    Pagination
 31    """  # noqa: E501
 32
 33    size: Optional[StrictInt] = Field(
 34        default=None,
 35        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. ",
 36    )
 37    total: Optional[StrictInt] = Field(default=None, description="Total number of results in the collection.")
 38    cursor: Optional[StrictStr] = Field(
 39        default=None,
 40        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.",
 41    )
 42    limit: Optional[Annotated[int, Field(le=100, strict=True, ge=1)]] = Field(
 43        default=100,
 44        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.",
 45    )
 46    type: Optional[StrictStr] = Field(
 47        default="cursor-list", description="Type of the response, in this case it's always 'cursor-list'."
 48    )
 49    additional_properties: Dict[str, Any] = {}
 50    __properties: ClassVar[List[str]] = ["size", "total", "cursor", "limit", "type"]
 51
 52    model_config = {
 53        "populate_by_name": True,
 54        "validate_assignment": True,
 55        "protected_namespaces": (),
 56    }
 57
 58    def to_str(self) -> str:
 59        """Returns the string representation of the model using alias"""
 60        return pprint.pformat(self.model_dump(by_alias=True))
 61
 62    def to_json(self) -> str:
 63        """Returns the JSON representation of the model using alias"""
 64        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 65        return json.dumps(self.to_dict())
 66
 67    @classmethod
 68    def from_json(cls, json_str: str) -> Optional[Self]:
 69        """Create an instance of Pagination from a JSON string"""
 70        return cls.from_dict(json.loads(json_str))
 71
 72    def to_dict(self) -> Dict[str, Any]:
 73        """Return the dictionary representation of the model using alias.
 74
 75        This has the following differences from calling pydantic's
 76        `self.model_dump(by_alias=True)`:
 77
 78        * `None` is only added to the output dict for nullable fields that
 79          were set at model initialization. Other fields with value `None`
 80          are ignored.
 81        * Fields in `self.additional_properties` are added to the output dict.
 82        """
 83        excluded_fields: Set[str] = set(
 84            [
 85                "additional_properties",
 86            ]
 87        )
 88
 89        _dict = self.model_dump(
 90            by_alias=True,
 91            exclude=excluded_fields,
 92            exclude_none=True,
 93        )
 94        # puts key-value pairs in additional_properties in the top level
 95        if self.additional_properties is not None:
 96            for _key, _value in self.additional_properties.items():
 97                _dict[_key] = _value
 98
 99        return _dict
100
101    @classmethod
102    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
103        """Create an instance of Pagination from a dict"""
104        if obj is None:
105            return None
106
107        if not isinstance(obj, dict):
108            return cls.model_validate(obj)
109
110        _obj = cls.model_validate(
111            {
112                "size": obj.get("size"),
113                "total": obj.get("total"),
114                "cursor": obj.get("cursor"),
115                "limit": obj.get("limit") if obj.get("limit") is not None else 100,
116                "type": obj.get("type") if obj.get("type") is not None else "cursor-list",
117            }
118        )
119        # store additional fields in additional_properties
120        for _key in obj.keys():
121            if _key not in cls.__properties:
122                _obj.additional_properties[_key] = obj.get(_key)
123
124        return _obj

Pagination

size: Optional[Annotated[int, Strict(strict=True)]]
total: Optional[Annotated[int, Strict(strict=True)]]
cursor: Optional[Annotated[str, Strict(strict=True)]]
limit: Optional[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])]]
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: 
58    def to_str(self) -> str:
59        """Returns the string representation of the model using alias"""
60        return pprint.pformat(self.model_dump(by_alias=True))

Returns the string representation of the model using alias

def to_json(self) -> str: 
62    def to_json(self) -> str:
63        """Returns the JSON representation of the model using alias"""
64        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
65        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]: 
67    @classmethod
68    def from_json(cls, json_str: str) -> Optional[Self]:
69        """Create an instance of Pagination from a JSON string"""
70        return cls.from_dict(json.loads(json_str))

Create an instance of Pagination from a JSON string

def to_dict(self) -> Dict[str, Any]: 
72    def to_dict(self) -> Dict[str, Any]:
73        """Return the dictionary representation of the model using alias.
74
75        This has the following differences from calling pydantic's
76        `self.model_dump(by_alias=True)`:
77
78        * `None` is only added to the output dict for nullable fields that
79          were set at model initialization. Other fields with value `None`
80          are ignored.
81        * Fields in `self.additional_properties` are added to the output dict.
82        """
83        excluded_fields: Set[str] = set(
84            [
85                "additional_properties",
86            ]
87        )
88
89        _dict = self.model_dump(
90            by_alias=True,
91            exclude=excluded_fields,
92            exclude_none=True,
93        )
94        # puts key-value pairs in additional_properties in the top level
95        if self.additional_properties is not None:
96            for _key, _value in self.additional_properties.items():
97                _dict[_key] = _value
98
99        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]: 
101    @classmethod
102    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
103        """Create an instance of Pagination from a dict"""
104        if obj is None:
105            return None
106
107        if not isinstance(obj, dict):
108            return cls.model_validate(obj)
109
110        _obj = cls.model_validate(
111            {
112                "size": obj.get("size"),
113                "total": obj.get("total"),
114                "cursor": obj.get("cursor"),
115                "limit": obj.get("limit") if obj.get("limit") is not None else 100,
116                "type": obj.get("type") if obj.get("type") is not None else "cursor-list",
117            }
118        )
119        # store additional fields in additional_properties
120        for _key in obj.keys():
121            if _key not in cls.__properties:
122                _obj.additional_properties[_key] = obj.get(_key)
123
124        return _obj

Create an instance of Pagination from a dict

def model_post_init(self: pydantic.main.BaseModel, __context: Any) -> None: 
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=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, 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. '), 'total': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, description='Total number of results in the collection.'), '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.'), 'limit': FieldInfo(annotation=Union[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])], NoneType], required=False, default=100, 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.'), 'type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='cursor-list', description="Type of the response, in this case it's always 'cursor-list'."), '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