Skip to content

Workspace history

WorkspaceHistory

Bases: Workspaces

Class responsible to make calls to Kanbanize Workspace histories endpoints

Source code in kanbanize_sdk/endpoints/workspace_history.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
class WorkspaceHistory(Workspaces):
    """
    Class responsible to make calls to Kanbanize Workspace histories endpoints
    """

    # post= private
    # insert = private
    # get = private
    # update = private

    def list(self, params: WorkspaceHistoryListParams | dict | None = None) -> list:
        """
        This method is responsible for listing all workspace histories.

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

        Returns:
            An array of objects representing the workspace histories
        """

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

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

list(params=None)

This method is responsible for listing all workspace histories.

Parameters:

Name Type Description Default
params WorkspaceHistoryListParams | dict | None

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

 None

Returns:

Type Description
list

An array of objects representing the workspace histories
Source code in kanbanize_sdk/endpoints/workspace_history.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
def list(self, params: WorkspaceHistoryListParams | dict | None = None) -> list:
    """
    This method is responsible for listing all workspace histories.

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

    Returns:
        An array of objects representing the workspace histories
    """

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

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