miro_api.models.page_links

  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 import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class PageLinks(BaseModel):
 27    """
 28    Contains pagination links for the collection.
 29    """  # noqa: E501
 30
 31    first: Optional[StrictStr] = Field(
 32        default=None, description="Link to retrieve information in the first page of the collection."
 33    )
 34    last: Optional[StrictStr] = Field(
 35        default=None, description="Link to the retrieve information in the last page of the collection."
 36    )
 37    next: Optional[StrictStr] = Field(
 38        default=None, description="Link to retrieve information in the next page of the collection."
 39    )
 40    prev: Optional[StrictStr] = Field(
 41        default=None, description="Link to retrieve information in the previous page of the collection."
 42    )
 43    var_self: Optional[StrictStr] = Field(
 44        default=None, description="Link to retrieve information in the current page of the collection.", alias="self"
 45    )
 46    additional_properties: Dict[str, Any] = {}
 47    __properties: ClassVar[List[str]] = ["first", "last", "next", "prev", "self"]
 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 PageLinks 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        # puts key-value pairs in additional_properties in the top level
 92        if self.additional_properties is not None:
 93            for _key, _value in self.additional_properties.items():
 94                _dict[_key] = _value
 95
 96        return _dict
 97
 98    @classmethod
 99    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
100        """Create an instance of PageLinks from a dict"""
101        if obj is None:
102            return None
103
104        if not isinstance(obj, dict):
105            return cls.model_validate(obj)
106
107        _obj = cls.model_validate(
108            {
109                "first": obj.get("first"),
110                "last": obj.get("last"),
111                "next": obj.get("next"),
112                "prev": obj.get("prev"),
113                "self": obj.get("self"),
114            }
115        )
116        # store additional fields in additional_properties
117        for _key in obj.keys():
118            if _key not in cls.__properties:
119                _obj.additional_properties[_key] = obj.get(_key)
120
121        return _obj