Skip to content

Board custom fields

BoardCustomFields

Bases: GenericRequestMethod

Class responsible to make calls to Kanbanize board custom fields endpoints

Source code in kanbanize_sdk/endpoints/board_custom_fields.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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class BoardCustomFields(GenericRequestMethod):
    """
    Class responsible to make calls to Kanbanize board custom fields endpoints
    """

    endpoint = '/boards'

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

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

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

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

        Returns:
            A board custom field object with the basic information data.
        """
        return self.service.get(self.endpoint + f'/{board_id}/customFields/{field_id}')

    def insert(self, board_id: int, field_id: int, body: BoardCustomFieldsInsertBody | dict, *args, **kwargs) -> dict:

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

        Parameters:
            board_id: An integer parameter that represents the board identification.
            field_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 custom fields to the
                board into the platform.

        Returns:
              An object that represents the board custom field.

        """

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

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

    def update(self, board_id: int, field_id: int, body: BoardCustomFieldsUpdateBody | dict, *args, **kwargs) -> dict:

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

        Parameters:
            board_id: An integer parameter that represents the board identification.
            field_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 custom fields to the
                board into the platform.
        """

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

        return self.service.patch(self.endpoint + f'/{board_id}/customFields/{field_id}', data=payload)

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

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

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

        """
        return self.service.delete(self.endpoint + f'/{board_id}/customFields/{field_id}')

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

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

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
field_id int

An integer parameter that represents the user identification.

 required
Source code in kanbanize_sdk/endpoints/board_custom_fields.py 
74
75
76
77
78
79
80
81
82
83
84
def delete(self, board_id: int, field_id: int, *args, **kwargs) -> None:

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

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

    """
    return self.service.delete(self.endpoint + f'/{board_id}/customFields/{field_id}')

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

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

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
field_id int

An integer parameter that represents the user identification.

 required

Returns:

Type Description
dict

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

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

    Returns:
        A board custom field object with the basic information data.
    """
    return self.service.get(self.endpoint + f'/{board_id}/customFields/{field_id}')

insert(board_id, field_id, body, *args, **kwargs)

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

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
field_id int

An integer parameter that represents the user identification.

 required
body BoardCustomFieldsInsertBody | dict

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

 required

Returns:

Type Description
dict

An object that represents the board custom field.
Source code in kanbanize_sdk/endpoints/board_custom_fields.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def insert(self, board_id: int, field_id: int, body: BoardCustomFieldsInsertBody | dict, *args, **kwargs) -> dict:

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

    Parameters:
        board_id: An integer parameter that represents the board identification.
        field_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 custom fields to the
            board into the platform.

    Returns:
          An object that represents the board custom field.

    """

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

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

list(board_id, *args, **kwargs)

This method is responsible to list all board custom 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 custom fields
Source code in kanbanize_sdk/endpoints/board_custom_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 custom 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 custom fields

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

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

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

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board identification.

 required
field_id int

An integer parameter that represents the user identification.

 required
body BoardCustomFieldsUpdateBody | dict

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

 required
Source code in kanbanize_sdk/endpoints/board_custom_fields.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def update(self, board_id: int, field_id: int, body: BoardCustomFieldsUpdateBody | dict, *args, **kwargs) -> dict:

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

    Parameters:
        board_id: An integer parameter that represents the board identification.
        field_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 custom fields to the
            board into the platform.
    """

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

    return self.service.patch(self.endpoint + f'/{board_id}/customFields/{field_id}', data=payload)