Skip to content

Board visible standard fields

BoardVisibleStandardFields

Bases: GenericRequestMethod

Class responsible to make calls to Kanbanize board visible standard fields endpoints

Source code in kanbanize_sdk/endpoints/board_visible_standard_fields.py 
 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
class BoardVisibleStandardFields(GenericRequestMethod):
    """
    Class responsible to make calls to Kanbanize board visible standard fields endpoints
    """

    endpoint = '/boards'
    ...

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

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

    def get(self, board_id: int, field_name: int, *args, **kwargs) -> None:
        """
        This method is responsible to get a board visible standard field from the board into the platform.

        Parameters:
            board_id: An integer parameter that represents the board identification.
            field_name: An integer parameter that represents the field name identification.

        Returns:
            A board visible standard field object with the basic information data.
        """
        return self.service.get(self.endpoint + f'/{board_id}/visibleStandardFields/{field_name}')

    def update(self, board_id: int, field_name: int, *args, **kwargs) -> None:

        """
        This method is responsible to get a board visible standard field from the board into the platform.

        Parameters:
            board_id: An integer parameter that represents the board identification.
            field_name: An integer parameter that represents the field name identification.
        """
        return self.service.put(self.endpoint + f'/{board_id}/visibleStandardFields/{field_name}')

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

        """
        This method is responsible to get a board visible standard field from the board into the platform.

        Parameters:
            board_id: An integer parameter that represents the board identification.
            field_name: An integer parameter that represents the field name identification.
        """
        return self.service.delete(self.endpoint + f'/{board_id}/visibleStandardFields/{field_name}')

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

This method is responsible to get a board visible standard field from the board into the platform.

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
field_name int

An integer parameter that represents the field name identification.

 required
Source code in kanbanize_sdk/endpoints/board_visible_standard_fields.py 
49
50
51
52
53
54
55
56
57
58
def delete(self, board_id: int, field_name: int, *args, **kwargs) -> None:

    """
    This method is responsible to get a board visible standard field from the board into the platform.

    Parameters:
        board_id: An integer parameter that represents the board identification.
        field_name: An integer parameter that represents the field name identification.
    """
    return self.service.delete(self.endpoint + f'/{board_id}/visibleStandardFields/{field_name}')

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

This method is responsible to get a board visible standard field from the board into the platform.

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
field_name int

An integer parameter that represents the field name identification.

 required

Returns:

Type Description
None

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

    Parameters:
        board_id: An integer parameter that represents the board identification.
        field_name: An integer parameter that represents the field name identification.

    Returns:
        A board visible standard field object with the basic information data.
    """
    return self.service.get(self.endpoint + f'/{board_id}/visibleStandardFields/{field_name}')

list(board_id, *args, **kwargs)

This method is responsible to list all board visible standard fields 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 visible standard fields
Source code in kanbanize_sdk/endpoints/board_visible_standard_fields.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 visible standard fields 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 visible standard fields

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

update(board_id, field_name, *args, **kwargs)

This method is responsible to get a board visible standard field from the board into the platform.

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
field_name int

An integer parameter that represents the field name identification.

 required
Source code in kanbanize_sdk/endpoints/board_visible_standard_fields.py 
38
39
40
41
42
43
44
45
46
47
def update(self, board_id: int, field_name: int, *args, **kwargs) -> None:

    """
    This method is responsible to get a board visible standard field from the board into the platform.

    Parameters:
        board_id: An integer parameter that represents the board identification.
        field_name: An integer parameter that represents the field name identification.
    """
    return self.service.put(self.endpoint + f'/{board_id}/visibleStandardFields/{field_name}')