Skip to content

Board custom field default contributors

BoardCustomFieldDefaultContributors

Bases: GenericRequestMethod

Class responsible to make calls to Kanbanize board custom field default contributors endpoints

Source code in kanbanize_sdk/endpoints/board_custom_field_default_contributors.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
59
60
61
62
63
64
65
66
67
class BoardCustomFieldDefaultContributors(GenericRequestMethod):
    """
    Class responsible to make calls to Kanbanize board custom field default contributors 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 default contributors 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 default contributors

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

    def get(self, board_id: int, field_id: int, user_id: int, *args, **kwargs) -> None:
        """
        This method is responsible to get a board custom field default contributors 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.
            user_id: An integer parameter that represents the user identification.

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

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

        """
        This method is responsible to get a board custom field default contributors 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.
            user_id: An integer parameter that represents the user identification.
        """
        return self.service.put(self.endpoint + f'/{board_id}/customFields/{field_id}/defaultContributors/{user_id}')

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

        """
        This method is responsible to get a board custom field default contributors 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.
            user_id: An integer parameter that represents the user identification.

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

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

This method is responsible to get a board custom field default contributors 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
user_id int

An integer parameter that represents the user identification.

 required
Source code in kanbanize_sdk/endpoints/board_custom_field_default_contributors.py 
56
57
58
59
60
61
62
63
64
65
66
67
def delete(self, board_id: int, field_id: int, user_id: int, *args, **kwargs) -> None:

    """
    This method is responsible to get a board custom field default contributors 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.
        user_id: An integer parameter that represents the user identification.

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

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

This method is responsible to get a board custom field default contributors 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
user_id int

An integer parameter that represents the user identification.

 required

Returns:

Type Description
None

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

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

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

This method is responsible to list all board custom field default contributors 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 default contributors
Source code in kanbanize_sdk/endpoints/board_custom_field_default_contributors.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
def list(self, board_id: int, field_id: int, *args, **kwargs) -> list:
    """
    This method is responsible to list all board custom field default contributors 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 default contributors

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

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

This method is responsible to get a board custom field default contributors 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
user_id int

An integer parameter that represents the user identification.

 required
Source code in kanbanize_sdk/endpoints/board_custom_field_default_contributors.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def update(self,
           board_id: int,
           field_id: int,
           user_id: int,
           *args,
           **kwargs) -> None:

    """
    This method is responsible to get a board custom field default contributors 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.
        user_id: An integer parameter that represents the user identification.
    """
    return self.service.put(self.endpoint + f'/{board_id}/customFields/{field_id}/defaultContributors/{user_id}')