Skip to content

Group

Exposes FIO group data. All Group data requires a FIO API KEY. You will need to have access to the data the user has in FIO in order to access it.

Groups can be created and modified in the FIO Settings.

Examples

All groups & their information

1
2
3
4
5
6
7
8
# Get all groups 
groups = fio.Group.all()

# Iterate through group IDs and print group details
for id in groups.ids():
    # Get information of specific group by Id
    group = fio.Group.get(groupid=id)
    print(group)

Members of a specific Group and Hub information

1
2
3
4
5
# Get group users
group_user = fio.Group.get(groupid=123456).users()

# Get hub information
data = fio.Group.hub(group_user)

Members Burn information

1
2
# Get Burn information
data = fio.Group.burn(groupid=123456)

Endpoints

Group

Bases: AbstractGroup, AbstractEndpoint

all 

1
all(timeout=None)

Gets all groups from FIO

Note

FIO API Key Required

Parameters:

Name Type Description Default
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
UnknownFIOResponse

FIO returned an unknown response

Returns:

Name Type Description
GroupList GroupList

List of Groups
Source code in fio_wrapper/endpoints/endpoints_v1/group.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
@apikey_required
def all(self, timeout: Optional[float] = None) -> GroupList:
    """Gets all groups from FIO

    Note:
        FIO API Key Required

    Args:
        timeout (float, optional): Request timeout in seconds. Defaults to None.

    Raises:
        UnknownFIOResponse: FIO returned an unknown response

    Returns:
        GroupList: List of Groups
    """
    (status, data) = self.adapter.get(
        endpoint=self.urls.group_all_url(), timeout=timeout
    )

    if status == 200:
        return GroupList.model_validate(data)

get 

1
get(groupid, timeout=None)

Gets group information for specified GroupID from FIO

Note

FIO API Key Required

Parameters:

Name Type Description Default
groupid int

GroupModelId

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
UnknownFIOResponse

FIO returned an unknown response

Returns:

Name Type Description
GroupModel Group

GroupModel
Source code in fio_wrapper/endpoints/endpoints_v1/group.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
@apikey_required
def get(self, groupid: int, timeout: Optional[float] = None) -> GroupModel:
    """Gets group information for specified GroupID from FIO

    Note:
        FIO API Key Required

    Args:
        groupid (int): GroupModelId
        timeout (float, optional): Request timeout in seconds. Defaults to None.

    Raises:
        UnknownFIOResponse: FIO returned an unknown response

    Returns:
        GroupModel: GroupModel
    """
    (status, data) = self.adapter.get(
        endpoint=self.urls.group_get_url(groupid=groupid), timeout=timeout
    )

    if status == 200:
        return GroupModel.model_validate(data)

memberships 

1
memberships(timeout=None)

Gets all groups the FIO API Key is member of

Note

FIO API Key Required

Parameters:

Name Type Description Default
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
UnknownFIOResponse

FIO returned an unknown response

Returns:

Name Type Description
GroupMembershipList GroupMembershipList

List of Group Memberships
Source code in fio_wrapper/endpoints/endpoints_v1/group.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
@apikey_required
def memberships(self, timeout: Optional[float] = None) -> GroupMembershipList:
    """Gets all groups the FIO API Key is member of

    Note:
        FIO API Key Required

    Args:
        timeout (float, optional): Request timeout in seconds. Defaults to None.

    Raises:
        UnknownFIOResponse: FIO returned an unknown response

    Returns:
        GroupMembershipList: List of Group Memberships
    """
    (status, data) = self.adapter.get(
        endpoint=self.urls.group_memberships_url(), timeout=timeout
    )

    if status == 200:
        return GroupMembershipList.model_validate(data)

hub 

1
hub(members, timeout=None)

Gets the groups Hub information from FIO

Note

FIO API Key Required

Parameters:

Name Type Description Default
members List[str]

List of members, e.g. ["NAME1", "NAME2"]

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
UnknownFIOResponse

FIO returned an unknown response

Returns:

Name Type Description
GroupHub GroupHub

GroupHub data from FIO
Source code in fio_wrapper/endpoints/endpoints_v1/group.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
@apikey_required
def hub(self, members: List[str], timeout: Optional[float] = None) -> GroupHub:
    """Gets the groups Hub information from FIO

    Note:
        FIO API Key Required

    Args:
        members (List[str]): List of members, e.g. ["NAME1", "NAME2"]
        timeout (float, optional): Request timeout in seconds. Defaults to None.

    Raises:
        UnknownFIOResponse: FIO returned an unknown response

    Returns:
        GroupHub: GroupHub data from FIO
    """
    (status, data) = self.adapter.post(
        endpoint=self.urls.group_hub_url(), data=members, timeout=timeout
    )

    if status == 200:
        return GroupHub.model_validate(data)

burn 

1
burn(groupid, timeout=None)

Gets the groups Burn information from FIO

Note

FIO API Key Required

Parameters:

Name Type Description Default
groupid int

GroupModelId

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
UnknownFIOResponse

FIO returned an unknown response

Returns:

Name Type Description
BurnList BurnList

List of Burn data
Source code in fio_wrapper/endpoints/endpoints_v1/group.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
@apikey_required
def burn(self, groupid: int, timeout: Optional[float] = None) -> BurnList:
    """Gets the groups Burn information from FIO

    Note:
        FIO API Key Required

    Args:
        groupid (int): GroupModelId
        timeout (float, optional): Request timeout in seconds. Defaults to None.

    Raises:
        UnknownFIOResponse: FIO returned an unknown response

    Returns:
        BurnList: List of Burn data
    """
    (status, data) = self.adapter.get(
        endpoint=self.urls.group_burn_url(groupid=groupid), timeout=timeout
    )

    if status == 200:
        return BurnList.model_validate(data)