miro_api.models.invitation_result

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, StrictInt
 21from typing import Any, ClassVar, Dict, List, Optional
 22from miro_api.models.invitation_error import InvitationError
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class InvitationResult(BaseModel):
 28    """
 29    InvitationResult
 30    """  # noqa: E501
 31
 32    failed: Optional[List[InvitationError]] = Field(
 33        default=None, description="Contains information about the invites that failed."
 34    )
 35    successful: Optional[List[StrictInt]] = Field(
 36        default=None, description="Contains information about the invites that were successfully sent."
 37    )
 38    additional_properties: Dict[str, Any] = {}
 39    __properties: ClassVar[List[str]] = ["failed", "successful"]
 40
 41    model_config = {
 42        "populate_by_name": True,
 43        "validate_assignment": True,
 44        "protected_namespaces": (),
 45    }
 46
 47    def to_str(self) -> str:
 48        """Returns the string representation of the model using alias"""
 49        return pprint.pformat(self.model_dump(by_alias=True))
 50
 51    def to_json(self) -> str:
 52        """Returns the JSON representation of the model using alias"""
 53        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 54        return json.dumps(self.to_dict())
 55
 56    @classmethod
 57    def from_json(cls, json_str: str) -> Optional[Self]:
 58        """Create an instance of InvitationResult from a JSON string"""
 59        return cls.from_dict(json.loads(json_str))
 60
 61    def to_dict(self) -> Dict[str, Any]:
 62        """Return the dictionary representation of the model using alias.
 63
 64        This has the following differences from calling pydantic's
 65        `self.model_dump(by_alias=True)`:
 66
 67        * `None` is only added to the output dict for nullable fields that
 68          were set at model initialization. Other fields with value `None`
 69          are ignored.
 70        * Fields in `self.additional_properties` are added to the output dict.
 71        """
 72        excluded_fields: Set[str] = set(
 73            [
 74                "additional_properties",
 75            ]
 76        )
 77
 78        _dict = self.model_dump(
 79            by_alias=True,
 80            exclude=excluded_fields,
 81            exclude_none=True,
 82        )
 83        # override the default output from pydantic by calling `to_dict()` of each item in failed (list)
 84        _items = []
 85        if self.failed:
 86            for _item in self.failed:
 87                if _item:
 88                    _items.append(_item.to_dict())
 89            _dict["failed"] = _items
 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 InvitationResult 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                "failed": (
109                    [InvitationError.from_dict(_item) for _item in obj["failed"]]
110                    if obj.get("failed") is not None
111                    else None
112                ),
113                "successful": obj.get("successful"),
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

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

 28class InvitationResult(BaseModel):
 29    """
 30    InvitationResult
 31    """  # noqa: E501
 32
 33    failed: Optional[List[InvitationError]] = Field(
 34        default=None, description="Contains information about the invites that failed."
 35    )
 36    successful: Optional[List[StrictInt]] = Field(
 37        default=None, description="Contains information about the invites that were successfully sent."
 38    )
 39    additional_properties: Dict[str, Any] = {}
 40    __properties: ClassVar[List[str]] = ["failed", "successful"]
 41
 42    model_config = {
 43        "populate_by_name": True,
 44        "validate_assignment": True,
 45        "protected_namespaces": (),
 46    }
 47
 48    def to_str(self) -> str:
 49        """Returns the string representation of the model using alias"""
 50        return pprint.pformat(self.model_dump(by_alias=True))
 51
 52    def to_json(self) -> str:
 53        """Returns the JSON representation of the model using alias"""
 54        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 55        return json.dumps(self.to_dict())
 56
 57    @classmethod
 58    def from_json(cls, json_str: str) -> Optional[Self]:
 59        """Create an instance of InvitationResult from a JSON string"""
 60        return cls.from_dict(json.loads(json_str))
 61
 62    def to_dict(self) -> Dict[str, Any]:
 63        """Return the dictionary representation of the model using alias.
 64
 65        This has the following differences from calling pydantic's
 66        `self.model_dump(by_alias=True)`:
 67
 68        * `None` is only added to the output dict for nullable fields that
 69          were set at model initialization. Other fields with value `None`
 70          are ignored.
 71        * Fields in `self.additional_properties` are added to the output dict.
 72        """
 73        excluded_fields: Set[str] = set(
 74            [
 75                "additional_properties",
 76            ]
 77        )
 78
 79        _dict = self.model_dump(
 80            by_alias=True,
 81            exclude=excluded_fields,
 82            exclude_none=True,
 83        )
 84        # override the default output from pydantic by calling `to_dict()` of each item in failed (list)
 85        _items = []
 86        if self.failed:
 87            for _item in self.failed:
 88                if _item:
 89                    _items.append(_item.to_dict())
 90            _dict["failed"] = _items
 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 InvitationResult 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                "failed": (
110                    [InvitationError.from_dict(_item) for _item in obj["failed"]]
111                    if obj.get("failed") is not None
112                    else None
113                ),
114                "successful": obj.get("successful"),
115            }
116        )
117        # store additional fields in additional_properties
118        for _key in obj.keys():
119            if _key not in cls.__properties:
120                _obj.additional_properties[_key] = obj.get(_key)
121
122        return _obj

InvitationResult

failed: Optional[List[miro_api.models.invitation_error.InvitationError]]

successful: Optional[List[Annotated[int, Strict(strict=True)]]]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

57    @classmethod
58    def from_json(cls, json_str: str) -> Optional[Self]:
59        """Create an instance of InvitationResult from a JSON string"""
60        return cls.from_dict(json.loads(json_str))

Create an instance of InvitationResult from a JSON string

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

62    def to_dict(self) -> Dict[str, Any]:
63        """Return the dictionary representation of the model using alias.
64
65        This has the following differences from calling pydantic's
66        `self.model_dump(by_alias=True)`:
67
68        * `None` is only added to the output dict for nullable fields that
69          were set at model initialization. Other fields with value `None`
70          are ignored.
71        * Fields in `self.additional_properties` are added to the output dict.
72        """
73        excluded_fields: Set[str] = set(
74            [
75                "additional_properties",
76            ]
77        )
78
79        _dict = self.model_dump(
80            by_alias=True,
81            exclude=excluded_fields,
82            exclude_none=True,
83        )
84        # override the default output from pydantic by calling `to_dict()` of each item in failed (list)
85        _items = []
86        if self.failed:
87            for _item in self.failed:
88                if _item:
89                    _items.append(_item.to_dict())
90            _dict["failed"] = _items
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

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

 98    @classmethod
 99    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
100        """Create an instance of InvitationResult 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                "failed": (
110                    [InvitationError.from_dict(_item) for _item in obj["failed"]]
111                    if obj.get("failed") is not None
112                    else None
113                ),
114                "successful": obj.get("successful"),
115            }
116        )
117        # store additional fields in additional_properties
118        for _key in obj.keys():
119            if _key not in cls.__properties:
120                _obj.additional_properties[_key] = obj.get(_key)
121
122        return _obj

Create an instance of InvitationResult 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 = {'failed': FieldInfo(annotation=Union[List[miro_api.models.invitation_error.InvitationError], NoneType], required=False, description='Contains information about the invites that failed.'), 'successful': FieldInfo(annotation=Union[List[Annotated[int, Strict(strict=True)]], NoneType], required=False, description='Contains information about the invites that were successfully sent.'), '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