everyaction.services.SupporterGroups

class everyaction.services.SupporterGroups(ea: EAClient)

Represents the Supporter Groups service.

Methods

add_person(group_id, van_id, /)	See PUT /supporterGroups/{supporterGroupId}/people/{vanId}.
create(**kwargs)	See POST /supporterGroups.
delete(group_id, /)	See DELETE /supporterGroups/{supporterGroupId}.
get(group_id, /)	See GET /supporterGroups/{supporterGroupId}.
list(*[, limit])	See GET /supporterGroups.
remove_person(group_id, van_id, /)	See DELETE /supporterGroups/{supporterGroupId}/people/{vanId}.

add_person(group_id: int, van_id: int, /) → None

See PUT /supporterGroups/{supporterGroupId}/people/{vanId}.

Parameters

• group_id – The groupId path parameter.

• van_id – The vanId path parameter.

create(**kwargs: EAValue) → SupporterGroup

See POST /supporterGroups.

Parameters

kwargs – The applicable query arguments and JSON data for the request. A SupporterGroup is appropriate to unpack here.

Returns

The created SupporterGroup object.

Keyword Arguments

• description (desc)

• id

• name

delete(group_id: int, /) → None

See DELETE /supporterGroups/{supporterGroupId}.

Parameters

group_id – The supporterGroupId path parameter.

get(group_id: int, /) → SupporterGroup

See GET /supporterGroups/{supporterGroupId}.

Parameters

group_id – The supporterGroupId path parameter.

Returns

The resulting SupporterGroup object.

list(*, limit: Optional[int] = None, **kwargs: EAValue) → List[SupporterGroup]

See GET /supporterGroups.

Parameters

• limit – Maximum number of records to get for this request.

• kwargs – The applicable query arguments and JSON data for the request.

Returns

List of the resulting SupporterGroup objects.

remove_person(group_id: int, van_id: int, /) → None

See DELETE /supporterGroups/{supporterGroupId}/people/{vanId}.

Parameters

• group_id – The groupId path parameter.

• van_id – The vanId path parameter.