miro_api.models.page_links_platform_experimental_features

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