everyaction.services.Ballots

class everyaction.services.Ballots(ea: EAClient)

Represents the Ballots service.

Methods

request_type(type_id, /)	See GET /ballotRequestTypes/{ballotRequestTypeId}.
request_types(*[, limit])	See GET /ballotRequestTypes.
return_status(status_id, /)	See GET /ballotReturnStatuses/{ballotRequestTypeId}.
return_statuses(*[, limit])	See GET /ballotReturnStatuses.
type(type_id, /)	See GET /ballotTypes/{ballotTypeId}.
types(*[, limit])	See GET /ballotTypes.

request_type(type_id: str, /) → BallotRequestType

See GET /ballotRequestTypes/{ballotRequestTypeId}.

Returns

The resulting BallotRequestType object.

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

See GET /ballotRequestTypes.

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 BallotRequestType objects.

return_status(status_id: int, /) → BallotReturnStatus

See GET /ballotReturnStatuses/{ballotRequestTypeId}.

Parameters

status_id – The ballotReturnStatusId path parameter.

Returns

The resulting BallotReturnStatus object.

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

See GET /ballotReturnStatuses.

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 BallotReturnStatus objects.

type(type_id: int, /) → BallotType

See GET /ballotTypes/{ballotTypeId}.

Parameters

type_id – The ballotTypeId path parameter.

Returns

The resulting BallotType object.

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

See GET /ballotTypes.

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 BallotType objects.