miro_api.models.board_export_jobs_list

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