miro_api.models.create_board_subscription_request

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.

  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 CreateBoardSubscriptionRequest(BaseModel):
 28    """
 29    Contains the board ID associated with the webhook subscription, the webhook callback URL, and the status of the webhook subscription.
 30    """  # noqa: E501
 31
 32    board_id: Optional[StrictStr] = Field(
 33        default=None,
 34        description="[Unique identifier (ID) of the board](https://developers.miro.com/reference/board-model) that you want to associate with the webhook subscription.",
 35        alias="boardId",
 36    )
 37    callback_url: Optional[Annotated[str, Field(min_length=8, strict=True, max_length=256)]] = Field(
 38        default=None,
 39        description="Indicates the HTTPS URL to which Miro sends a webhook when an event occurs.",
 40        alias="callbackUrl",
 41    )
 42    status: Optional[StrictStr] = Field(
 43        default="enabled",
 44        description="Indicates whether the status of the webhook subscription.`enabled`: Miro sends a webhook when an event occurs in the associated board. `disabled`: Miro does not send a webhook even when an event occurs in the associated board. `lost_access`: The user with which the webhook subscription is associated has lost access to the board. The user needs to regain access to the board, and then reenable the webhook subscription by updating the webhook subscription status to `enabled` by using the update webhook endpoint.",
 45    )
 46    additional_properties: Dict[str, Any] = {}
 47    __properties: ClassVar[List[str]] = ["boardId", "callbackUrl", "status"]
 48
 49    @field_validator("callback_url")
 50    def callback_url_validate_regular_expression(cls, value):
 51        """Validates the regular expression"""
 52        if value is None:
 53            return value
 54
 55        if not re.match(r"^https:\/\/(.*)", value):
 56            raise ValueError(r"must validate the regular expression /^https:\/\/(.*)/")
 57        return value
 58
 59    @field_validator("status")
 60    def status_validate_enum(cls, value):
 61        """Validates the enum"""
 62        if value is None:
 63            return value
 64
 65        if value not in set(["enabled", "disabled"]):
 66            raise ValueError("must be one of enum values ('enabled', 'disabled')")
 67        return value
 68
 69    model_config = {
 70        "populate_by_name": True,
 71        "validate_assignment": True,
 72        "protected_namespaces": (),
 73    }
 74
 75    def to_str(self) -> str:
 76        """Returns the string representation of the model using alias"""
 77        return pprint.pformat(self.model_dump(by_alias=True))
 78
 79    def to_json(self) -> str:
 80        """Returns the JSON representation of the model using alias"""
 81        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 82        return json.dumps(self.to_dict())
 83
 84    @classmethod
 85    def from_json(cls, json_str: str) -> Optional[Self]:
 86        """Create an instance of CreateBoardSubscriptionRequest from a JSON string"""
 87        return cls.from_dict(json.loads(json_str))
 88
 89    def to_dict(self) -> Dict[str, Any]:
 90        """Return the dictionary representation of the model using alias.
 91
 92        This has the following differences from calling pydantic's
 93        `self.model_dump(by_alias=True)`:
 94
 95        * `None` is only added to the output dict for nullable fields that
 96          were set at model initialization. Other fields with value `None`
 97          are ignored.
 98        * Fields in `self.additional_properties` are added to the output dict.
 99        """
100        excluded_fields: Set[str] = set(
101            [
102                "additional_properties",
103            ]
104        )
105
106        _dict = self.model_dump(
107            by_alias=True,
108            exclude=excluded_fields,
109            exclude_none=True,
110        )
111        # puts key-value pairs in additional_properties in the top level
112        if self.additional_properties is not None:
113            for _key, _value in self.additional_properties.items():
114                _dict[_key] = _value
115
116        return _dict
117
118    @classmethod
119    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
120        """Create an instance of CreateBoardSubscriptionRequest from a dict"""
121        if obj is None:
122            return None
123
124        if not isinstance(obj, dict):
125            return cls.model_validate(obj)
126
127        _obj = cls.model_validate(
128            {
129                "boardId": obj.get("boardId"),
130                "callbackUrl": obj.get("callbackUrl"),
131                "status": obj.get("status") if obj.get("status") is not None else "enabled",
132            }
133        )
134        # store additional fields in additional_properties
135        for _key in obj.keys():
136            if _key not in cls.__properties:
137                _obj.additional_properties[_key] = obj.get(_key)
138
139        return _obj
class CreateBoardSubscriptionRequest(pydantic.main.BaseModel): 
 28class CreateBoardSubscriptionRequest(BaseModel):
 29    """
 30    Contains the board ID associated with the webhook subscription, the webhook callback URL, and the status of the webhook subscription.
 31    """  # noqa: E501
 32
 33    board_id: Optional[StrictStr] = Field(
 34        default=None,
 35        description="[Unique identifier (ID) of the board](https://developers.miro.com/reference/board-model) that you want to associate with the webhook subscription.",
 36        alias="boardId",
 37    )
 38    callback_url: Optional[Annotated[str, Field(min_length=8, strict=True, max_length=256)]] = Field(
 39        default=None,
 40        description="Indicates the HTTPS URL to which Miro sends a webhook when an event occurs.",
 41        alias="callbackUrl",
 42    )
 43    status: Optional[StrictStr] = Field(
 44        default="enabled",
 45        description="Indicates whether the status of the webhook subscription.`enabled`: Miro sends a webhook when an event occurs in the associated board. `disabled`: Miro does not send a webhook even when an event occurs in the associated board. `lost_access`: The user with which the webhook subscription is associated has lost access to the board. The user needs to regain access to the board, and then reenable the webhook subscription by updating the webhook subscription status to `enabled` by using the update webhook endpoint.",
 46    )
 47    additional_properties: Dict[str, Any] = {}
 48    __properties: ClassVar[List[str]] = ["boardId", "callbackUrl", "status"]
 49
 50    @field_validator("callback_url")
 51    def callback_url_validate_regular_expression(cls, value):
 52        """Validates the regular expression"""
 53        if value is None:
 54            return value
 55
 56        if not re.match(r"^https:\/\/(.*)", value):
 57            raise ValueError(r"must validate the regular expression /^https:\/\/(.*)/")
 58        return value
 59
 60    @field_validator("status")
 61    def status_validate_enum(cls, value):
 62        """Validates the enum"""
 63        if value is None:
 64            return value
 65
 66        if value not in set(["enabled", "disabled"]):
 67            raise ValueError("must be one of enum values ('enabled', 'disabled')")
 68        return value
 69
 70    model_config = {
 71        "populate_by_name": True,
 72        "validate_assignment": True,
 73        "protected_namespaces": (),
 74    }
 75
 76    def to_str(self) -> str:
 77        """Returns the string representation of the model using alias"""
 78        return pprint.pformat(self.model_dump(by_alias=True))
 79
 80    def to_json(self) -> str:
 81        """Returns the JSON representation of the model using alias"""
 82        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 83        return json.dumps(self.to_dict())
 84
 85    @classmethod
 86    def from_json(cls, json_str: str) -> Optional[Self]:
 87        """Create an instance of CreateBoardSubscriptionRequest from a JSON string"""
 88        return cls.from_dict(json.loads(json_str))
 89
 90    def to_dict(self) -> Dict[str, Any]:
 91        """Return the dictionary representation of the model using alias.
 92
 93        This has the following differences from calling pydantic's
 94        `self.model_dump(by_alias=True)`:
 95
 96        * `None` is only added to the output dict for nullable fields that
 97          were set at model initialization. Other fields with value `None`
 98          are ignored.
 99        * Fields in `self.additional_properties` are added to the output dict.
100        """
101        excluded_fields: Set[str] = set(
102            [
103                "additional_properties",
104            ]
105        )
106
107        _dict = self.model_dump(
108            by_alias=True,
109            exclude=excluded_fields,
110            exclude_none=True,
111        )
112        # puts key-value pairs in additional_properties in the top level
113        if self.additional_properties is not None:
114            for _key, _value in self.additional_properties.items():
115                _dict[_key] = _value
116
117        return _dict
118
119    @classmethod
120    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
121        """Create an instance of CreateBoardSubscriptionRequest from a dict"""
122        if obj is None:
123            return None
124
125        if not isinstance(obj, dict):
126            return cls.model_validate(obj)
127
128        _obj = cls.model_validate(
129            {
130                "boardId": obj.get("boardId"),
131                "callbackUrl": obj.get("callbackUrl"),
132                "status": obj.get("status") if obj.get("status") is not None else "enabled",
133            }
134        )
135        # store additional fields in additional_properties
136        for _key in obj.keys():
137            if _key not in cls.__properties:
138                _obj.additional_properties[_key] = obj.get(_key)
139
140        return _obj

Contains the board ID associated with the webhook subscription, the webhook callback URL, and the status of the webhook subscription.

board_id: Optional[Annotated[str, Strict(strict=True)]]
callback_url: Optional[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=8), MaxLen(max_length=256)])]]
status: Optional[Annotated[str, Strict(strict=True)]]
additional_properties: Dict[str, Any]
@field_validator('callback_url')
def callback_url_validate_regular_expression(cls, value): 
50    @field_validator("callback_url")
51    def callback_url_validate_regular_expression(cls, value):
52        """Validates the regular expression"""
53        if value is None:
54            return value
55
56        if not re.match(r"^https:\/\/(.*)", value):
57            raise ValueError(r"must validate the regular expression /^https:\/\/(.*)/")
58        return value

Validates the regular expression

@field_validator('status')
def status_validate_enum(cls, value): 
60    @field_validator("status")
61    def status_validate_enum(cls, value):
62        """Validates the enum"""
63        if value is None:
64            return value
65
66        if value not in set(["enabled", "disabled"]):
67            raise ValueError("must be one of enum values ('enabled', 'disabled')")
68        return value

Validates the enum

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}
def to_str(self) -> str: 
76    def to_str(self) -> str:
77        """Returns the string representation of the model using alias"""
78        return pprint.pformat(self.model_dump(by_alias=True))

Returns the string representation of the model using alias

def to_json(self) -> str: 
80    def to_json(self) -> str:
81        """Returns the JSON representation of the model using alias"""
82        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
83        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]: 
85    @classmethod
86    def from_json(cls, json_str: str) -> Optional[Self]:
87        """Create an instance of CreateBoardSubscriptionRequest from a JSON string"""
88        return cls.from_dict(json.loads(json_str))

Create an instance of CreateBoardSubscriptionRequest from a JSON string

def to_dict(self) -> Dict[str, Any]: 
 90    def to_dict(self) -> Dict[str, Any]:
 91        """Return the dictionary representation of the model using alias.
 92
 93        This has the following differences from calling pydantic's
 94        `self.model_dump(by_alias=True)`:
 95
 96        * `None` is only added to the output dict for nullable fields that
 97          were set at model initialization. Other fields with value `None`
 98          are ignored.
 99        * Fields in `self.additional_properties` are added to the output dict.
100        """
101        excluded_fields: Set[str] = set(
102            [
103                "additional_properties",
104            ]
105        )
106
107        _dict = self.model_dump(
108            by_alias=True,
109            exclude=excluded_fields,
110            exclude_none=True,
111        )
112        # puts key-value pairs in additional_properties in the top level
113        if self.additional_properties is not None:
114            for _key, _value in self.additional_properties.items():
115                _dict[_key] = _value
116
117        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]: 
119    @classmethod
120    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
121        """Create an instance of CreateBoardSubscriptionRequest from a dict"""
122        if obj is None:
123            return None
124
125        if not isinstance(obj, dict):
126            return cls.model_validate(obj)
127
128        _obj = cls.model_validate(
129            {
130                "boardId": obj.get("boardId"),
131                "callbackUrl": obj.get("callbackUrl"),
132                "status": obj.get("status") if obj.get("status") is not None else "enabled",
133            }
134        )
135        # store additional fields in additional_properties
136        for _key in obj.keys():
137            if _key not in cls.__properties:
138                _obj.additional_properties[_key] = obj.get(_key)
139
140        return _obj

Create an instance of CreateBoardSubscriptionRequest from a dict

def model_post_init(self: pydantic.main.BaseModel, __context: Any) -> None: 
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 = {'board_id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='boardId', alias_priority=2, description='[Unique identifier (ID) of the board](https://developers.miro.com/reference/board-model) that you want to associate with the webhook subscription.'), 'callback_url': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=8), MaxLen(max_length=256)])], NoneType], required=False, alias='callbackUrl', alias_priority=2, description='Indicates the HTTPS URL to which Miro sends a webhook when an event occurs.'), 'status': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='enabled', description='Indicates whether the status of the webhook subscription.`enabled`: Miro sends a webhook when an event occurs in the associated board. `disabled`: Miro does not send a webhook even when an event occurs in the associated board. `lost_access`: The user with which the webhook subscription is associated has lost access to the board. The user needs to regain access to the board, and then reenable the webhook subscription by updating the webhook subscription status to `enabled` by using the update webhook endpoint.'), '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