Skip to content

Board assignees

BoardAssignees

Bases: GenericRequestMethod

Class responsible to make calls to Kanbanize board assignees endpoints

Source code in kanbanize_sdk/endpoints/board_assignees.py 
 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
class BoardAssignees(GenericRequestMethod):
    """
    Class responsible to make calls to Kanbanize board assignees endpoints
    """

    endpoint = '/boards'

    def list(self, board_id: int, *args, **kwargs) -> list:
        """
        This method is responsible to list all board assignees from the board into the platform.

        Parameters:
            board_id: An integer parameter that represents the board assignee

        Returns:
            An array of objects that represents the board assignees

        """
        return self.service.get(self.endpoint + f'/{board_id}/userRoles')

    def get(self, board_id: int, user_id: int, *args, **kwargs) -> dict:
        """
        This method is responsible to get a board assignees from the board into the platform.

        Parameters:
            board_id: An integer parameter that represents the board identification.
            user_id: An integer parameter that represents the user identification.

        Returns:
            A board assignee object with the basic information data.
        """
        return self.service.get(self.endpoint + f'/{board_id}/userRoles/{user_id}')

    def update(self, board_id: int, user_id: int, body: BoardAssigneesUpdateBody | dict, *args, **kwargs) -> None:

        """
        This method is responsible to get a board assignees from the board into the platform.

        Parameters:
            board_id: An integer parameter that represents the board identification.
            user_id: An integer parameter that represents the user identification.
            body: It's a dataclass object that provide the essential request body needed to update a board assignees to the
                board into the platform.
        """

        payload = body.to_dict() if isinstance(body, BoardAssigneesUpdateBody) else body

        return self.service.put(
            self.endpoint + f'/{board_id}/userRoles/{user_id}',
            data=payload
        )

    def delete(self, board_id: int, user_id: int, *args, **kwargs) -> None:

        """
        This method is responsible to get a board assignees from the board into the platform.

        Parameters:
            board_id: An integer parameter that represents the board identification.
            user_id: An integer parameter that represents the user identification.
        """
        return self.service.delete(self.endpoint + f'/{board_id}/userRoles/{user_id}')

delete(board_id, user_id, *args, **kwargs)

This method is responsible to get a board assignees from the board into the platform.

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
user_id int

An integer parameter that represents the user identification.

 required
Source code in kanbanize_sdk/endpoints/board_assignees.py 
57
58
59
60
61
62
63
64
65
66
def delete(self, board_id: int, user_id: int, *args, **kwargs) -> None:

    """
    This method is responsible to get a board assignees from the board into the platform.

    Parameters:
        board_id: An integer parameter that represents the board identification.
        user_id: An integer parameter that represents the user identification.
    """
    return self.service.delete(self.endpoint + f'/{board_id}/userRoles/{user_id}')

get(board_id, user_id, *args, **kwargs)

This method is responsible to get a board assignees from the board into the platform.

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
user_id int

An integer parameter that represents the user identification.

 required

Returns:

Type Description
dict

A board assignee object with the basic information data.
Source code in kanbanize_sdk/endpoints/board_assignees.py 
25
26
27
28
29
30
31
32
33
34
35
36
def get(self, board_id: int, user_id: int, *args, **kwargs) -> dict:
    """
    This method is responsible to get a board assignees from the board into the platform.

    Parameters:
        board_id: An integer parameter that represents the board identification.
        user_id: An integer parameter that represents the user identification.

    Returns:
        A board assignee object with the basic information data.
    """
    return self.service.get(self.endpoint + f'/{board_id}/userRoles/{user_id}')

list(board_id, *args, **kwargs)

This method is responsible to list all board assignees from the board into the platform.

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board assignee

 required

Returns:

Type Description
list

An array of objects that represents the board assignees
Source code in kanbanize_sdk/endpoints/board_assignees.py 
12
13
14
15
16
17
18
19
20
21
22
23
def list(self, board_id: int, *args, **kwargs) -> list:
    """
    This method is responsible to list all board assignees from the board into the platform.

    Parameters:
        board_id: An integer parameter that represents the board assignee

    Returns:
        An array of objects that represents the board assignees

    """
    return self.service.get(self.endpoint + f'/{board_id}/userRoles')

update(board_id, user_id, body, *args, **kwargs)

This method is responsible to get a board assignees from the board into the platform.

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
user_id int

An integer parameter that represents the user identification.

 required
body BoardAssigneesUpdateBody | dict

It's a dataclass object that provide the essential request body needed to update a board assignees to the board into the platform.

 required
Source code in kanbanize_sdk/endpoints/board_assignees.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def update(self, board_id: int, user_id: int, body: BoardAssigneesUpdateBody | dict, *args, **kwargs) -> None:

    """
    This method is responsible to get a board assignees from the board into the platform.

    Parameters:
        board_id: An integer parameter that represents the board identification.
        user_id: An integer parameter that represents the user identification.
        body: It's a dataclass object that provide the essential request body needed to update a board assignees to the
            board into the platform.
    """

    payload = body.to_dict() if isinstance(body, BoardAssigneesUpdateBody) else body

    return self.service.put(
        self.endpoint + f'/{board_id}/userRoles/{user_id}',
        data=payload
    )