Skip to content

Board custom field allowed values

BoardCustomFieldAllowedValues

Bases: GenericRequestMethod

Class responsible to make calls to Kanbanize board custom field allowed values endpoints

Source code in kanbanize_sdk/endpoints/board_custom_field_allowed_values.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
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
class BoardCustomFieldAllowedValues(GenericRequestMethod):
    """
    Class responsible to make calls to Kanbanize board custom field allowed values endpoints
    """

    endpoint = '/boards'

    def list(self, board_id: int, field_id: int, *args, **kwargs) -> list:
        """
        This method is responsible to list all board custom field allowed values from the board into the platform.

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

        Returns:
            An array of objects that represents the board custom field allowed values

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

    def get(self, board_id: int, field_id: int, value_id: int, *args, **kwargs) -> dict:
        """
        This method is responsible to get a board custom field allowed values 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 field identification.
            value_id: An integer parameter that represents the value identification.

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

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

        """
        This method is responsible to get a board custom field allowed values 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 field identification.
            value_id: An integer parameter that represents the value identification.
            body: It's a dataclass object that provide the essential request body needed to update a board custom field allowed values to the
                board into the platform.

        Returns:
              An object that represents the board custom field allowed value.

        """

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

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

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

        """
        This method is responsible to get a board custom field allowed values 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 field identification.
            value_id: An integer parameter that represents the value identification.
            body: It's a dataclass object that provide the essential request body needed to update a board custom field allowed values to the
                board into the platform.
        """

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

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

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

        """
        This method is responsible to get a board custom field allowed values 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 field identification.
            value_id: An integer parameter that represents the value identification.

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

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

This method is responsible to get a board custom field allowed values 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 field identification.

 required
value_id int

An integer parameter that represents the value identification.

 required
Source code in kanbanize_sdk/endpoints/board_custom_field_allowed_values.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def delete(self, board_id: int, field_id: int, value_id: int, *args, **kwargs) -> None:

    """
    This method is responsible to get a board custom field allowed values 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 field identification.
        value_id: An integer parameter that represents the value identification.

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

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

This method is responsible to get a board custom field allowed values 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 field identification.

 required
value_id int

An integer parameter that represents the value identification.

 required

Returns:

Type Description
dict

A board custom field allowed value object with the basic information data.
Source code in kanbanize_sdk/endpoints/board_custom_field_allowed_values.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
def get(self, board_id: int, field_id: int, value_id: int, *args, **kwargs) -> dict:
    """
    This method is responsible to get a board custom field allowed values 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 field identification.
        value_id: An integer parameter that represents the value identification.

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

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

This method is responsible to get a board custom field allowed values 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 field identification.

 required
value_id int

An integer parameter that represents the value identification.

 required
body BoardCustomFieldAllowedValuesInsertBody | dict

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

 required

Returns:

Type Description
dict

An object that represents the board custom field allowed value.
Source code in kanbanize_sdk/endpoints/board_custom_field_allowed_values.py 
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
def insert(self,
           board_id: int,
           field_id: int,
           value_id: int,
           body: BoardCustomFieldAllowedValuesInsertBody | dict,
           *args,
           **kwargs) -> dict:

    """
    This method is responsible to get a board custom field allowed values 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 field identification.
        value_id: An integer parameter that represents the value identification.
        body: It's a dataclass object that provide the essential request body needed to update a board custom field allowed values to the
            board into the platform.

    Returns:
          An object that represents the board custom field allowed value.

    """

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

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

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

This method is responsible to list all board custom field allowed values from the board into the platform.

Parameters:

Name Type Description Default
board_id int

An integer parameter that represents the board assignee

 required
field_id int

An integer parameter that represents the field identification.

 required

Returns:

Type Description
list

An array of objects that represents the board custom field allowed values
Source code in kanbanize_sdk/endpoints/board_custom_field_allowed_values.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
def list(self, board_id: int, field_id: int, *args, **kwargs) -> list:
    """
    This method is responsible to list all board custom field allowed values from the board into the platform.

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

    Returns:
        An array of objects that represents the board custom field allowed values

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

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

This method is responsible to get a board custom field allowed values 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 field identification.

 required
value_id int

An integer parameter that represents the value identification.

 required
body BoardCustomFieldAllowedValuesUpdateBody | dict

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

 required
Source code in kanbanize_sdk/endpoints/board_custom_field_allowed_values.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def update(self,
           board_id: int,
           field_id: int,
           value_id: int,
           body: BoardCustomFieldAllowedValuesUpdateBody | dict,
           *args,
           **kwargs) -> dict:

    """
    This method is responsible to get a board custom field allowed values 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 field identification.
        value_id: An integer parameter that represents the value identification.
        body: It's a dataclass object that provide the essential request body needed to update a board custom field allowed values to the
            board into the platform.
    """

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

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