everyaction.services.CanvassResponses

class everyaction.services.CanvassResponses(ea: EAClient)

Represents the Canvass Responses service.

Methods

contact_types(**kwargs)

See GET /canvassResponses/contactTypes.

find_contact_type(name)

Finds the ContactType with the given name, case insensitive.

find_input_type(name)

Finds the InputType with the given name, case insensitive.

find_result_code(name)

Finds the ResultCode with the given name, case insensitive.

input_types()

See GET /canvassResponses/inputTypes.

name_to_contact_type()

Gives a mapping from names to the ContactTypes .ContactType of the same name, case-insensitive.

name_to_input_type()

Gives a mapping from names to the InputTypes .InputType of the same name, case-insensitive.

name_to_result_code()

Gives a mapping from names to the ResultCodes .ResultCode of the same name, case-insensitive.

result_codes(**kwargs)

See GET /canvassResponses/resultCodes.
contact_types(**kwargs: EAValue) → List[ContactType]

See GET /canvassResponses/contactTypes.

Parameters

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

Returns

List of the resulting ContactType objects.

Keyword Arguments
find_contact_type(name: str) → ContactType

Finds the ContactType with the given name, case insensitive.

Parameters

name – Name of contact type to find.

Returns

The resulting ContactType object.

Raises

EAFindFailedException – If the contact type could not be found.

find_input_type(name: str) → InputType

Finds the InputType with the given name, case insensitive.

Parameters

name – Name of input type to find.

Returns

The resulting InputType object.

Raises

EAFindFailedException – If the input type could not be found.

find_result_code(name: str) → ResultCode

Finds the ResultCode with the given name, case insensitive.

Parameters

name – Name of result code to find.

Returns

The resulting ResultCode object.

Raises

EAFindFailedException – If the result code could not be found.

input_types() → List[InputType]

See GET /canvassResponses/inputTypes.

Returns

List of the resulting InputType objects.

name_to_contact_type() → Dict[str, ContactType]

Gives a mapping from names to the ContactTypes .ContactType of the same name, case-insensitive.

Returns

Name of Contact Type to the resulting ContactType objects.

name_to_input_type() → Dict[str, InputType]

Gives a mapping from names to the InputTypes .InputType of the same name, case-insensitive.

Returns

Name of Input Type to the resulting InputType objects.

name_to_result_code() → Dict[str, ResultCode]

Gives a mapping from names to the ResultCodes .ResultCode of the same name, case-insensitive.

Returns

Name of Result Code to the resulting ResultCode objects.

result_codes(**kwargs: EAValue) → List[ResultCode]

See GET /canvassResponses/resultCodes.

Parameters

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

Returns

List of the resulting ResultCode objects.

Keyword Arguments