summaryrefslogtreecommitdiff
path: root/gitlab/v4/objects/broadcast_messages.py
blob: e3bda6871932e2fb489e32e20904d65185e92a57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
from typing import Any, cast, Union

from gitlab.base import RESTManager, RESTObject
from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin
from gitlab.types import ArrayAttribute, RequiredOptional

__all__ = [
    "BroadcastMessage",
    "BroadcastMessageManager",
]


class BroadcastMessage(SaveMixin, ObjectDeleteMixin, RESTObject):
    pass


class BroadcastMessageManager(CRUDMixin, RESTManager):
    _path = "/broadcast_messages"
    _obj_cls = BroadcastMessage

    _create_attrs = RequiredOptional(
        required=("message",),
        optional=("starts_at", "ends_at", "color", "font", "target_access_levels"),
    )
    _update_attrs = RequiredOptional(
        optional=(
            "message",
            "starts_at",
            "ends_at",
            "color",
            "font",
            "target_access_levels",
        )
    )
    _types = {"target_access_levels": ArrayAttribute}

    def get(
        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
    ) -> BroadcastMessage:
        return cast(BroadcastMessage, super().get(id=id, lazy=lazy, **kwargs))