everyaction.services.VoterRegistrationBatches

class everyaction.services.VoterRegistrationBatches(ea: EAClient)

Represents the Voter Registration Batches service.

Methods

add_registrants(batch_id, /, *, data)	See POST /voterRegistrationBatches/{batchId}/people.
create(**kwargs)	See POST /voterRegistrationBatches.
forms(*[, limit])	See GET /voterRegistrationBatches/registrationForms.
list(*[, limit])	See GET /voterRegistrationBatches.
programs([limit])	See GET /voterRegistrationBatches/programTypes.
supported_fields(state, /, *[, limit])	See GET /voterRegistrationBatches/states/{state}/supportedFields.
update_status(batch_id, /, **kwargs)	See PATCH /voterRegistrationBatches/{batchId}.

add_registrants(batch_id: int, /, *, data: List[Registrant]) → List[AddRegistrantsResponse]

See POST /voterRegistrationBatches/{batchId}/people.

Parameters

• batch_id – The batchId path parameter.

• data – List of the Registrant objects to add.

Returns

The resulting AddRegistrantsResponse objects.

create(**kwargs: EAValue) → VoterRegistrationBatch

See POST /voterRegistrationBatches.

Parameters

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

Returns

The created VoterRegistrationBatch.

Keyword Arguments

• dateCreated (date_created, created)

• description (desc)

• form

• name

• personType (person_type)

• programType (program_type, program)

• stateCode (state_code, state)

• status

• voterRegistrationBatchId (voter_registration_batch_id, id)

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

See GET /voterRegistrationBatches/registrationForms.

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

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

See GET /voterRegistrationBatches.

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

Keyword Arguments

• createdAfter (created_after, after)

• createdBefore (created_before, before)

• onlyMyBatches (only_my_batches, only_mine)

• orderby (order_by)

• personType (person_type)

• programType (program_type, program)

• stateCode (state_code, state)

• status

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

See GET /voterRegistrationBatches/programTypes.

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

supported_fields(state: str, /, *, limit: Optional[int] = None, **kwargs: EAValue) → List[SupportField]

See GET /voterRegistrationBatches/states/{state}/supportedFields.

Parameters

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

• state – The state path parameter.

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

Returns

List of the resulting SupportField objects.

update_status(batch_id: int, /, **kwargs: EAValue) → None

See PATCH /voterRegistrationBatches/{batchId}.

Parameters

• batch_id – The batchId path parameter.

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

Keyword Arguments

• status