miro_api.models.organization

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, StrictStr, field_validator
 21from typing import Any, ClassVar, Dict, List, Optional
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class Organization(BaseModel):
 27    """
 28    Organization
 29    """  # noqa: E501
 30
 31    id: StrictStr = Field(description="Id of the organization")
 32    full_licenses_purchased: StrictInt = Field(description="Purchased FULL licenses", alias="fullLicensesPurchased")
 33    name: StrictStr = Field(description="Name of the organization")
 34    plan: StrictStr = Field(description="Organization plan type")
 35    type: Optional[StrictStr] = Field(default="organization", description="Type of the object returned.")
 36    additional_properties: Dict[str, Any] = {}
 37    __properties: ClassVar[List[str]] = ["id", "fullLicensesPurchased", "name", "plan", "type"]
 38
 39    @field_validator("plan")
 40    def plan_validate_enum(cls, value):
 41        """Validates the enum"""
 42        if value not in set(
 43            [
 44                "company",
 45                "consultant",
 46                "consultant_slf",
 47                "business",
 48                "paid_team_org",
 49                "integration_org",
 50                "professional_2022",
 51                "edu_team_org",
 52                "free_team_org",
 53                "dev_team_org",
 54                "unknown",
 55            ]
 56        ):
 57            raise ValueError(
 58                "must be one of enum values ('company', 'consultant', 'consultant_slf', 'business', 'paid_team_org', 'integration_org', 'professional_2022', 'edu_team_org', 'free_team_org', 'dev_team_org', 'unknown')"
 59            )
 60        return value
 61
 62    model_config = {
 63        "populate_by_name": True,
 64        "validate_assignment": True,
 65        "protected_namespaces": (),
 66    }
 67
 68    def to_str(self) -> str:
 69        """Returns the string representation of the model using alias"""
 70        return pprint.pformat(self.model_dump(by_alias=True))
 71
 72    def to_json(self) -> str:
 73        """Returns the JSON representation of the model using alias"""
 74        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 75        return json.dumps(self.to_dict())
 76
 77    @classmethod
 78    def from_json(cls, json_str: str) -> Optional[Self]:
 79        """Create an instance of Organization from a JSON string"""
 80        return cls.from_dict(json.loads(json_str))
 81
 82    def to_dict(self) -> Dict[str, Any]:
 83        """Return the dictionary representation of the model using alias.
 84
 85        This has the following differences from calling pydantic's
 86        `self.model_dump(by_alias=True)`:
 87
 88        * `None` is only added to the output dict for nullable fields that
 89          were set at model initialization. Other fields with value `None`
 90          are ignored.
 91        * Fields in `self.additional_properties` are added to the output dict.
 92        """
 93        excluded_fields: Set[str] = set(
 94            [
 95                "additional_properties",
 96            ]
 97        )
 98
 99        _dict = self.model_dump(
100            by_alias=True,
101            exclude=excluded_fields,
102            exclude_none=True,
103        )
104        # puts key-value pairs in additional_properties in the top level
105        if self.additional_properties is not None:
106            for _key, _value in self.additional_properties.items():
107                _dict[_key] = _value
108
109        return _dict
110
111    @classmethod
112    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
113        """Create an instance of Organization from a dict"""
114        if obj is None:
115            return None
116
117        if not isinstance(obj, dict):
118            return cls.model_validate(obj)
119
120        _obj = cls.model_validate(
121            {
122                "id": obj.get("id"),
123                "fullLicensesPurchased": obj.get("fullLicensesPurchased"),
124                "name": obj.get("name"),
125                "plan": obj.get("plan"),
126                "type": obj.get("type") if obj.get("type") is not None else "organization",
127            }
128        )
129        # store additional fields in additional_properties
130        for _key in obj.keys():
131            if _key not in cls.__properties:
132                _obj.additional_properties[_key] = obj.get(_key)
133
134        return _obj

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

 27class Organization(BaseModel):
 28    """
 29    Organization
 30    """  # noqa: E501
 31
 32    id: StrictStr = Field(description="Id of the organization")
 33    full_licenses_purchased: StrictInt = Field(description="Purchased FULL licenses", alias="fullLicensesPurchased")
 34    name: StrictStr = Field(description="Name of the organization")
 35    plan: StrictStr = Field(description="Organization plan type")
 36    type: Optional[StrictStr] = Field(default="organization", description="Type of the object returned.")
 37    additional_properties: Dict[str, Any] = {}
 38    __properties: ClassVar[List[str]] = ["id", "fullLicensesPurchased", "name", "plan", "type"]
 39
 40    @field_validator("plan")
 41    def plan_validate_enum(cls, value):
 42        """Validates the enum"""
 43        if value not in set(
 44            [
 45                "company",
 46                "consultant",
 47                "consultant_slf",
 48                "business",
 49                "paid_team_org",
 50                "integration_org",
 51                "professional_2022",
 52                "edu_team_org",
 53                "free_team_org",
 54                "dev_team_org",
 55                "unknown",
 56            ]
 57        ):
 58            raise ValueError(
 59                "must be one of enum values ('company', 'consultant', 'consultant_slf', 'business', 'paid_team_org', 'integration_org', 'professional_2022', 'edu_team_org', 'free_team_org', 'dev_team_org', 'unknown')"
 60            )
 61        return value
 62
 63    model_config = {
 64        "populate_by_name": True,
 65        "validate_assignment": True,
 66        "protected_namespaces": (),
 67    }
 68
 69    def to_str(self) -> str:
 70        """Returns the string representation of the model using alias"""
 71        return pprint.pformat(self.model_dump(by_alias=True))
 72
 73    def to_json(self) -> str:
 74        """Returns the JSON representation of the model using alias"""
 75        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 76        return json.dumps(self.to_dict())
 77
 78    @classmethod
 79    def from_json(cls, json_str: str) -> Optional[Self]:
 80        """Create an instance of Organization from a JSON string"""
 81        return cls.from_dict(json.loads(json_str))
 82
 83    def to_dict(self) -> Dict[str, Any]:
 84        """Return the dictionary representation of the model using alias.
 85
 86        This has the following differences from calling pydantic's
 87        `self.model_dump(by_alias=True)`:
 88
 89        * `None` is only added to the output dict for nullable fields that
 90          were set at model initialization. Other fields with value `None`
 91          are ignored.
 92        * Fields in `self.additional_properties` are added to the output dict.
 93        """
 94        excluded_fields: Set[str] = set(
 95            [
 96                "additional_properties",
 97            ]
 98        )
 99
100        _dict = self.model_dump(
101            by_alias=True,
102            exclude=excluded_fields,
103            exclude_none=True,
104        )
105        # puts key-value pairs in additional_properties in the top level
106        if self.additional_properties is not None:
107            for _key, _value in self.additional_properties.items():
108                _dict[_key] = _value
109
110        return _dict
111
112    @classmethod
113    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
114        """Create an instance of Organization from a dict"""
115        if obj is None:
116            return None
117
118        if not isinstance(obj, dict):
119            return cls.model_validate(obj)
120
121        _obj = cls.model_validate(
122            {
123                "id": obj.get("id"),
124                "fullLicensesPurchased": obj.get("fullLicensesPurchased"),
125                "name": obj.get("name"),
126                "plan": obj.get("plan"),
127                "type": obj.get("type") if obj.get("type") is not None else "organization",
128            }
129        )
130        # store additional fields in additional_properties
131        for _key in obj.keys():
132            if _key not in cls.__properties:
133                _obj.additional_properties[_key] = obj.get(_key)
134
135        return _obj

Organization

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

full_licenses_purchased: typing.Annotated[int, Strict(strict=True)]

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

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

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

additional_properties: Dict[str, Any]

@field_validator('plan')

def plan_validate_enum(cls, value): View Source

40    @field_validator("plan")
41    def plan_validate_enum(cls, value):
42        """Validates the enum"""
43        if value not in set(
44            [
45                "company",
46                "consultant",
47                "consultant_slf",
48                "business",
49                "paid_team_org",
50                "integration_org",
51                "professional_2022",
52                "edu_team_org",
53                "free_team_org",
54                "dev_team_org",
55                "unknown",
56            ]
57        ):
58            raise ValueError(
59                "must be one of enum values ('company', 'consultant', 'consultant_slf', 'business', 'paid_team_org', 'integration_org', 'professional_2022', 'edu_team_org', 'free_team_org', 'dev_team_org', 'unknown')"
60            )
61        return value

Validates the enum

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

def to_str(self) -> str: View Source

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

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

78    @classmethod
79    def from_json(cls, json_str: str) -> Optional[Self]:
80        """Create an instance of Organization from a JSON string"""
81        return cls.from_dict(json.loads(json_str))

Create an instance of Organization from a JSON string

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

 83    def to_dict(self) -> Dict[str, Any]:
 84        """Return the dictionary representation of the model using alias.
 85
 86        This has the following differences from calling pydantic's
 87        `self.model_dump(by_alias=True)`:
 88
 89        * `None` is only added to the output dict for nullable fields that
 90          were set at model initialization. Other fields with value `None`
 91          are ignored.
 92        * Fields in `self.additional_properties` are added to the output dict.
 93        """
 94        excluded_fields: Set[str] = set(
 95            [
 96                "additional_properties",
 97            ]
 98        )
 99
100        _dict = self.model_dump(
101            by_alias=True,
102            exclude=excluded_fields,
103            exclude_none=True,
104        )
105        # puts key-value pairs in additional_properties in the top level
106        if self.additional_properties is not None:
107            for _key, _value in self.additional_properties.items():
108                _dict[_key] = _value
109
110        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

112    @classmethod
113    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
114        """Create an instance of Organization from a dict"""
115        if obj is None:
116            return None
117
118        if not isinstance(obj, dict):
119            return cls.model_validate(obj)
120
121        _obj = cls.model_validate(
122            {
123                "id": obj.get("id"),
124                "fullLicensesPurchased": obj.get("fullLicensesPurchased"),
125                "name": obj.get("name"),
126                "plan": obj.get("plan"),
127                "type": obj.get("type") if obj.get("type") is not None else "organization",
128            }
129        )
130        # store additional fields in additional_properties
131        for _key in obj.keys():
132            if _key not in cls.__properties:
133                _obj.additional_properties[_key] = obj.get(_key)
134
135        return _obj

Create an instance of Organization 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='Id of the organization', metadata=[Strict(strict=True)]), 'full_licenses_purchased': FieldInfo(annotation=int, required=True, alias='fullLicensesPurchased', alias_priority=2, description='Purchased FULL licenses', metadata=[Strict(strict=True)]), 'name': FieldInfo(annotation=str, required=True, description='Name of the organization', metadata=[Strict(strict=True)]), 'plan': FieldInfo(annotation=str, required=True, description='Organization plan type', metadata=[Strict(strict=True)]), 'type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='organization', description='Type of the object returned.'), '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