Skip to content

Board teams

BoardTeams

Bases: GenericRequestMethod

Class responsible to make calls to Kanbanize board teams endpoints

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

    endpoint = '/boards'
    ...

    def list(self, board_id: int, *args, **kwargs) -> list:
        """
        This method is responsible to list all board teams 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 teams

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

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

        Parameters:
            board_id: An integer parameter that represents the board identification.
            team_id: An integer parameter that represents the team identification.

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

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

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

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

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

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

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

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

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

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

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

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
team_id int

An integer parameter that represents the team identification.

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

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

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

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

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

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
team_id int

An integer parameter that represents the team identification.

 required

Returns:

Type Description
list

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

    Parameters:
        board_id: An integer parameter that represents the board identification.
        team_id: An integer parameter that represents the team identification.

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

list(board_id, *args, **kwargs)

This method is responsible to list all board teams 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 teams
Source code in kanbanize_sdk/endpoints/board_teams.py 
13
14
15
16
17
18
19
20
21
22
23
24
def list(self, board_id: int, *args, **kwargs) -> list:
    """
    This method is responsible to list all board teams 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 teams

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

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

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

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
team_id int

An integer parameter that represents the team identification.

 required
body BoardTeamsUpdateBody | dict

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

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

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

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

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

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