everyaction.services.Signups¶
- class everyaction.services.Signups(ea: EAClient)¶
Represents the Signups service.
Methods
create_or_update(**kwargs)See POST /signups.
delete(signup_id, /)get(signup_id, /)list(*[, limit])See GET /signups.
statuses(**kwargs)update(signup_id, /, **kwargs)- create_or_update(**kwargs: EAValue) Signup¶
See POST /signups.
- Parameters
kwargs – The applicable query arguments and JSON data for the request. A
Signupis appropriate to unpack here.- Returns
The created
Signupobject.- Keyword Arguments
dateModified (date_modified, modified)
endTimeOverride (end_time_override, end_override, end)
eventSignupId (event_signup_id, id)
isOfflineSignup (is_offline_signup, offline_property, offline)
modifiedBy (modified_by, modifier)
notes
startTimeOverride (start_time_override, start_override, start)
supporterGroupId (supporter_group_id, supporter_group, group)
- delete(signup_id: int, /) None¶
See DELETE /signups/{eventSignupId}.
- Parameters
signup_id – The eventSignupId path parameter.
- get(signup_id: int, /) Signup¶
See GET /signups/{eventSignupId}.
- Parameters
signup_id – The eventSignupId path parameter.
- Returns
The resulting
Signupobject.
- list(*, limit: Optional[int] = None, **kwargs: EAValue) List[Signup]¶
See GET /signups.
- 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
Signupobjects.- Keyword Arguments
eventId (event_id, event)
vanId (van_id, van)
- statuses(**kwargs: EAValue) List[Status]¶
-
- Parameters
kwargs – The applicable query arguments and JSON data for the request.
- Returns
The resulting
Statusobjects.- Keyword Arguments
eventId (event_id, event)
eventTypeId (event_type_id, event_type, type)
- update(signup_id: int, /, **kwargs: EAValue) None¶
See PUT /signups/{eventSignupId}.
- Parameters
signup_id – The eventSignupId path parameter.
kwargs – The applicable query arguments and JSON data for the request. A
Signupis appropriate to unpack here.
- Keyword Arguments
dateModified (date_modified, modified)
endTimeOverride (end_time_override, end_override, end)
eventSignupId (event_signup_id, id)
isOfflineSignup (is_offline_signup, offline_property, offline)
modifiedBy (modified_by, modifier)
notes
startTimeOverride (start_time_override, start_override, start)
supporterGroupId (supporter_group_id, supporter_group, group)