Skip to content

Board history

BoardHistory

Bases: Boards

Class responsible to make calls to Kanbanize board history endpoints

Source code in kanbanize_sdk/endpoints/board_history.py 
 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
class BoardHistory(Boards):
    """
    Class responsible to make calls to Kanbanize board history endpoints
    """

    get = private

    insert = private

    update = private

    delete = private

    def list(self, params: BoardHistoryListParams | dict | None = None, *args, **kwargs) -> list:
        """
        This method is responsible to list all board history in the platform.

        Parameters:
            params: It's a dataclass object that provide all possible parameters to be used to list the board history.

        Returns:
            An array of objects that represents the boards
        """

        params = params.to_dict() if isinstance(params, BoardHistoryListParams) else params

        return self.service.get(self.endpoint + '/history', params=params)

list(params=None, *args, **kwargs)

This method is responsible to list all board history in the platform.

Parameters:

Name Type Description Default
params BoardHistoryListParams | dict | None

It's a dataclass object that provide all possible parameters to be used to list the board history.

 None

Returns:

Type Description
list

An array of objects that represents the boards
Source code in kanbanize_sdk/endpoints/board_history.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def list(self, params: BoardHistoryListParams | dict | None = None, *args, **kwargs) -> list:
    """
    This method is responsible to list all board history in the platform.

    Parameters:
        params: It's a dataclass object that provide all possible parameters to be used to list the board history.

    Returns:
        An array of objects that represents the boards
    """

    params = params.to_dict() if isinstance(params, BoardHistoryListParams) else params

    return self.service.get(self.endpoint + '/history', params=params)