miro_api.models.legal_hold_content_items_response

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
 14
 15from __future__ import annotations
 16import pprint
 17import re  # noqa: F401
 18import json
 19
 20from pydantic import BaseModel, Field, StrictStr, field_validator
 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 LegalHoldContentItemsResponse(BaseModel):
 28    """
 29    LegalHoldContentItemsResponse
 30    """  # noqa: E501
 31
 32    id: Annotated[str, Field(strict=True)] = Field(description="Unique identifier of the content item.")
 33    content_id: Optional[StrictStr] = Field(
 34        default=None,
 35        description="Identifier for the piece of content referenced by a content item. In the case of a board, this represents the `boardKey` and can be used to export a board using the Discovery APIs.",
 36        alias="contentId",
 37    )
 38    type: StrictStr = Field(description="Type of the content item that is returned. ")
 39    additional_properties: Dict[str, Any] = {}
 40    __properties: ClassVar[List[str]] = ["id", "contentId", "type"]
 41
 42    @field_validator("id")
 43    def id_validate_regular_expression(cls, value):
 44        """Validates the regular expression"""
 45        if not re.match(r"^[0-9]+$", value):
 46            raise ValueError(r"must validate the regular expression /^[0-9]+$/")
 47        return value
 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 LegalHoldContentItemsResponse 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 LegalHoldContentItemsResponse 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({"id": obj.get("id"), "contentId": obj.get("contentId"), "type": obj.get("type")})
108        # store additional fields in additional_properties
109        for _key in obj.keys():
110            if _key not in cls.__properties:
111                _obj.additional_properties[_key] = obj.get(_key)
112
113        return _obj

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

 28class LegalHoldContentItemsResponse(BaseModel):
 29    """
 30    LegalHoldContentItemsResponse
 31    """  # noqa: E501
 32
 33    id: Annotated[str, Field(strict=True)] = Field(description="Unique identifier of the content item.")
 34    content_id: Optional[StrictStr] = Field(
 35        default=None,
 36        description="Identifier for the piece of content referenced by a content item. In the case of a board, this represents the `boardKey` and can be used to export a board using the Discovery APIs.",
 37        alias="contentId",
 38    )
 39    type: StrictStr = Field(description="Type of the content item that is returned. ")
 40    additional_properties: Dict[str, Any] = {}
 41    __properties: ClassVar[List[str]] = ["id", "contentId", "type"]
 42
 43    @field_validator("id")
 44    def id_validate_regular_expression(cls, value):
 45        """Validates the regular expression"""
 46        if not re.match(r"^[0-9]+$", value):
 47            raise ValueError(r"must validate the regular expression /^[0-9]+$/")
 48        return value
 49
 50    model_config = {
 51        "populate_by_name": True,
 52        "validate_assignment": True,
 53        "protected_namespaces": (),
 54    }
 55
 56    def to_str(self) -> str:
 57        """Returns the string representation of the model using alias"""
 58        return pprint.pformat(self.model_dump(by_alias=True))
 59
 60    def to_json(self) -> str:
 61        """Returns the JSON representation of the model using alias"""
 62        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 63        return json.dumps(self.to_dict())
 64
 65    @classmethod
 66    def from_json(cls, json_str: str) -> Optional[Self]:
 67        """Create an instance of LegalHoldContentItemsResponse from a JSON string"""
 68        return cls.from_dict(json.loads(json_str))
 69
 70    def to_dict(self) -> Dict[str, Any]:
 71        """Return the dictionary representation of the model using alias.
 72
 73        This has the following differences from calling pydantic's
 74        `self.model_dump(by_alias=True)`:
 75
 76        * `None` is only added to the output dict for nullable fields that
 77          were set at model initialization. Other fields with value `None`
 78          are ignored.
 79        * Fields in `self.additional_properties` are added to the output dict.
 80        """
 81        excluded_fields: Set[str] = set(
 82            [
 83                "additional_properties",
 84            ]
 85        )
 86
 87        _dict = self.model_dump(
 88            by_alias=True,
 89            exclude=excluded_fields,
 90            exclude_none=True,
 91        )
 92        # puts key-value pairs in additional_properties in the top level
 93        if self.additional_properties is not None:
 94            for _key, _value in self.additional_properties.items():
 95                _dict[_key] = _value
 96
 97        return _dict
 98
 99    @classmethod
100    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
101        """Create an instance of LegalHoldContentItemsResponse from a dict"""
102        if obj is None:
103            return None
104
105        if not isinstance(obj, dict):
106            return cls.model_validate(obj)
107
108        _obj = cls.model_validate({"id": obj.get("id"), "contentId": obj.get("contentId"), "type": obj.get("type")})
109        # store additional fields in additional_properties
110        for _key in obj.keys():
111            if _key not in cls.__properties:
112                _obj.additional_properties[_key] = obj.get(_key)
113
114        return _obj

LegalHoldContentItemsResponse

id: typing.Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])]

content_id: Optional[Annotated[str, Strict(strict=True)]]

type: typing.Annotated[str, Strict(strict=True)]

additional_properties: Dict[str, Any]

@field_validator('id')

def id_validate_regular_expression(cls, value): View Source

43    @field_validator("id")
44    def id_validate_regular_expression(cls, value):
45        """Validates the regular expression"""
46        if not re.match(r"^[0-9]+$", value):
47            raise ValueError(r"must validate the regular expression /^[0-9]+$/")
48        return value

Validates the regular expression

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}

def to_str(self) -> str: View Source

56    def to_str(self) -> str:
57        """Returns the string representation of the model using alias"""
58        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

60    def to_json(self) -> str:
61        """Returns the JSON representation of the model using alias"""
62        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
63        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

65    @classmethod
66    def from_json(cls, json_str: str) -> Optional[Self]:
67        """Create an instance of LegalHoldContentItemsResponse from a JSON string"""
68        return cls.from_dict(json.loads(json_str))

Create an instance of LegalHoldContentItemsResponse from a JSON string

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

70    def to_dict(self) -> Dict[str, Any]:
71        """Return the dictionary representation of the model using alias.
72
73        This has the following differences from calling pydantic's
74        `self.model_dump(by_alias=True)`:
75
76        * `None` is only added to the output dict for nullable fields that
77          were set at model initialization. Other fields with value `None`
78          are ignored.
79        * Fields in `self.additional_properties` are added to the output dict.
80        """
81        excluded_fields: Set[str] = set(
82            [
83                "additional_properties",
84            ]
85        )
86
87        _dict = self.model_dump(
88            by_alias=True,
89            exclude=excluded_fields,
90            exclude_none=True,
91        )
92        # puts key-value pairs in additional_properties in the top level
93        if self.additional_properties is not None:
94            for _key, _value in self.additional_properties.items():
95                _dict[_key] = _value
96
97        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

 99    @classmethod
100    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
101        """Create an instance of LegalHoldContentItemsResponse from a dict"""
102        if obj is None:
103            return None
104
105        if not isinstance(obj, dict):
106            return cls.model_validate(obj)
107
108        _obj = cls.model_validate({"id": obj.get("id"), "contentId": obj.get("contentId"), "type": obj.get("type")})
109        # store additional fields in additional_properties
110        for _key in obj.keys():
111            if _key not in cls.__properties:
112                _obj.additional_properties[_key] = obj.get(_key)
113
114        return _obj

Create an instance of LegalHoldContentItemsResponse 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 = {'id': FieldInfo(annotation=str, required=True, description='Unique identifier of the content item.', metadata=[Strict(strict=True)]), 'content_id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='contentId', alias_priority=2, description='Identifier for the piece of content referenced by a content item. In the case of a board, this represents the `boardKey` and can be used to export a board using the Discovery APIs.'), 'type': FieldInfo(annotation=str, required=True, description='Type of the content item that is returned. ', 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