summaryrefslogtreecommitdiff
path: root/gitlab/v4/objects/invitations.py
blob: 43fbb2d2786476bdeee4b759a654d5b1db57c08a (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
from typing import Any, cast, Union

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

__all__ = [
    "ProjectInvitation",
    "ProjectInvitationManager",
    "GroupInvitation",
    "GroupInvitationManager",
]


class InvitationMixin(CRUDMixin):
    def create(self, *args: Any, **kwargs: Any) -> RESTObject:
        invitation = super().create(*args, **kwargs)

        if invitation.status == "error":
            raise GitlabInvitationError(invitation.message)

        return invitation


class ProjectInvitation(SaveMixin, ObjectDeleteMixin, RESTObject):
    _id_attr = "email"


class ProjectInvitationManager(InvitationMixin, RESTManager):
    _path = "/projects/{project_id}/invitations"
    _obj_cls = ProjectInvitation
    _from_parent_attrs = {"project_id": "id"}
    _create_attrs = RequiredOptional(
        required=("access_level",),
        optional=(
            "expires_at",
            "invite_source",
            "tasks_to_be_done",
            "tasks_project_id",
        ),
        exclusive=("email", "user_id"),
    )
    _update_attrs = RequiredOptional(
        optional=("access_level", "expires_at"),
    )
    _list_filters = ("query",)
    _types = {
        "email": CommaSeparatedListAttribute,
        "user_id": CommaSeparatedListAttribute,
        "tasks_to_be_done": ArrayAttribute,
    }

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


class GroupInvitation(SaveMixin, ObjectDeleteMixin, RESTObject):
    _id_attr = "email"


class GroupInvitationManager(InvitationMixin, RESTManager):
    _path = "/groups/{group_id}/invitations"
    _obj_cls = GroupInvitation
    _from_parent_attrs = {"group_id": "id"}
    _create_attrs = RequiredOptional(
        required=("access_level",),
        optional=(
            "expires_at",
            "invite_source",
            "tasks_to_be_done",
            "tasks_project_id",
        ),
        exclusive=("email", "user_id"),
    )
    _update_attrs = RequiredOptional(
        optional=("access_level", "expires_at"),
    )
    _list_filters = ("query",)
    _types = {
        "email": CommaSeparatedListAttribute,
        "user_id": CommaSeparatedListAttribute,
        "tasks_to_be_done": ArrayAttribute,
    }

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