everyaction.services.People

class everyaction.services.People(ea: EAClient)

Represents the People service.

Methods

activist_codes(van_id, /, *[, limit])	See GET /people/{vanId}/activistCodes.
add_canvass_responses(van_id, /, **kwargs)	See POST /people/{vanId}/canvassResponses.
add_canvass_responses_(person_id_type, ...)	See POST /people/{personIdType}:{personId}/canvassResponses.
add_code(van_id, **kwargs)	See POST /people/{vanId}/codes.
add_code_(person_id_type, person_id, /, **kwargs)	See POST /people/{personIdType}:{personId}/codes.
add_my_activist_flag(van_id, /)	See PUT /people/{vanId}/myActivistFlags.
add_notes(van_id, /, **kwargs)	See POST /people/{vanId}/notes.
add_notes_(person_id_type, person_id, /, ...)	See POST /people/{personIdType}:{personId}/notes.
add_relationship(van_id, /, **kwargs)	See POST /people/{vanId}/relationships.
apply_activist_code(activist_code, **kwargs)	Apply the given activist code to the person distinguished by the specified data.
apply_notes(notes, **kwargs)	Apply the given notes to the person distinguished by the specified data.
apply_result_code(result_code, **kwargs)	Apply the given result code to the person distinguished by the given data.
find(**kwargs)	See POST /people/find.
find_by_phone(**kwargs)	See POST /people/findByPhone.
find_or_create(**kwargs)	See POST /people/findOrCreate.
get(van_id, /, **kwargs)	See GET /people/{vanId}.
get_(person_id_type, person_id, /, **kwargs)	See GET /people/{personIdType}:{personId}.
list(*[, limit])	See GET /people.
lookup(*[, expand])	Attempt to find a person using the data in kwargs by invoking POST /people/find.
membership(van_id, /)	See GET /people/{vanId}/membership.
merge_into(van_id, /, **kwargs)	See PUT /people/{vanId}/mergeInto.
notes(van_id, /, *[, limit])	See GET /people/{vanId}/notes.
remove_activist_code(activist_code, **kwargs)	Remove the given activist code from the person distinguished by the specified data.
remove_code(van_id, code_id, /)	See DELETE /people/{vanId}/codes/{codeId}.
remove_code_(person_id_type, person_id, ...)	See DELETE /people/{personIdType}:{personId}/codes/{codeId}.
remove_my_activist_flag(van_id, /)	See DELETE /people/{vanId}/myActivistFlags.
set_disclosures_fields(van_id, /, **kwargs)	See POST /people/{vanId}/disclosureFieldValues.
set_disclosures_fields_(person_id_type, ...)	See POST /people/{personIdType}:{personId}/disclosureFieldValues.
update(van_id, /, **kwargs)	See POST /people/{vanId}.
update_(person_id_type, person_id, /, **kwargs)	See POST /people/{personIdType}:{personId}.
update_if_exists(lookup_args, update_args)	Update a person with the given properties if they already exist as a record.
update_names(van_id, /, **kwargs)	See PATCH /people/{vanId}/names.
update_note(van_id, note_id, /, **kwargs)	See PUT /people/{vanId}/notes/{noteId}.

activist_codes(van_id: int, /, *, limit: Optional[int] = None, **kwargs: EAValue) → List[ActivistCodeData]

See GET /people/{vanId}/activistCodes.

Parameters

• van_id – The vanId path parameter.

• 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 ActivistCodeData objects.

add_canvass_responses(van_id: int, /, **kwargs: EAValue) → None

See POST /people/{vanId}/canvassResponses.

Parameters

• van_id – The vanId path parameter.

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

Keyword Arguments

• canvassContext (canvass_context, context)

• responses (response (singular))

• resultCodeId (result_code_id, result_code)

add_canvass_responses_(person_id_type: str, person_id: str, /, **kwargs: EAValue) → None

See POST /people/{personIdType}:{personId}/canvassResponses.

Parameters

• person_id_type – The personIdType path parameter.

• person_id – The personId path parameter.

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

Keyword Arguments

• canvassContext (canvass_context, context)

• responses (response (singular))

• resultCodeId (result_code_id, result_code)

add_code(van_id: int, **kwargs: EAValue) → None

See POST /people/{vanId}/codes.

Parameters

• van_id – The vanId path parameter.

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

Keyword Arguments

• codeId (code_id, id)

• codeType (code_type, type)

• dateCreated (date_created, created)

• dateModified (date_modified, modified)

• description (desc)

• name

• parentCodeId (parent_code_id, parent_code)

• supportedEntities (supported_entities, entities, entity (singular))

add_code_(person_id_type: str, person_id: str, /, **kwargs: EAValue) → None

See POST /people/{personIdType}:{personId}/codes.

Parameters

• person_id_type – The personIdType path parameter.

• person_id – The personId path parameter.

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

Keyword Arguments

• codeId (code_id, id)

• codeType (code_type, type)

• dateCreated (date_created, created)

• dateModified (date_modified, modified)

• description (desc)

• name

• parentCodeId (parent_code_id, parent_code)

• supportedEntities (supported_entities, entities, entity (singular))

add_my_activist_flag(van_id: int, /) → None

See PUT /people/{vanId}/myActivistFlags.

Parameters

van_id – The vanId path parameter.

add_notes(van_id: int, /, **kwargs: EAValue) → None

See POST /people/{vanId}/notes.

Parameters

• van_id – The vanId path parameter.

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

Keyword Arguments

• category

• contactHistory (contact_history, history)

• createdDate (created_date, created)

• isViewRestricted (is_view_restricted, view_restricted)

• noteId (note_id, id)

• text

add_notes_(person_id_type: str, person_id: str, /, **kwargs: EAValue) → None

See POST /people/{personIdType}:{personId}/notes.

Parameters

• person_id_type – The personIdType path parameter.

• person_id – The personId path parameter.

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

Keyword Arguments

• category

• contactHistory (contact_history, history)

• createdDate (created_date, created)

• isViewRestricted (is_view_restricted, view_restricted)

• noteId (note_id, id)

• text

add_relationship(van_id: int, /, **kwargs: EAValue) → None

See POST /people/{vanId}/relationships.

Parameters

• van_id – The vanId path parameter.

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

Keyword Arguments

• relationshipId (relationship_id, relationship)

• vanId (van_id, van)

apply_activist_code(activist_code: Union[int, str], **kwargs: EAValue) → None

Apply the given activist code to the person distinguished by the specified data. Does not create a contact history.

Parameters

• activist_code – The activist code name or ID.

• kwargs – The JSON data to lookup the person with. A Person is appropriate to unpack here.

Raises

EAFindFailedException – If either the given activist code or a person could not be found.

apply_notes(notes: Note, **kwargs: EAValue) → None

Apply the given notes to the person distinguished by the specified data.

Parameters

• notes – The notes to add.

• kwargs – The JSON data to lookup the person with. A Person is appropriate to unpack here.

Raises

EAFindFailedException – If a person could not be found.

apply_result_code(result_code: Union[int, str], **kwargs: EAValue) → None

Apply the given result code to the person distinguished by the given data.

Parameters

• result_code – The ID or name of the result code to apply.

• kwargs – The JSON data to lookup the person with. A Person is appropriate to unpack here.

Raises

EAFindFailedException – If either the given result code or a person could not be found.

find(**kwargs: EAValue) → Optional[Person]

See POST /people/find.

Parameters

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

Returns

The found Person object, or None if no person could be found.

Keyword Arguments

• additionalEnvelopeName (additional_envelope_name, additional_envelope)

• additionalSalutation (additional_salutation)

• addresses (address (singular))

• biographyImageUrl (biography_image_url, biography_image, bio_image_url, bio_image)

• caseworkCases (casework_cases, cases, case (singular))

• caseworkIssues (casework_issues, issues, issue (singular))

• caseworkStories (casework_stories, stories, story (singular))

• collectedLocationId (collected_location_id, collected_location, location)

• contactMethodPreferenceCode (contact_method_preference_code, contact_preference_code, contact_preference, preference_code)

• contactMode (contact_mode)

• contactModeId (contact_mode_id)

• contactSource (contact_source)

• customFieldValues (custom_field_values, custom_values, custom_value (singular))

• customProperties (custom_properties, properties, property (singular))

• cycle

• dateAcquired (date_acquired)

• dateCreated (date_created, created)

• dateOfBirth (date_of_birth, birthday)

• disclosureFieldValues (disclosure_field_values, field_values, disclosures, values, disclosure (singular))

• districts (district (singular))

• electionRecords (election_records, election_record (singular))

• electionType (election_type)

• emails (email (singular))

• employer

• envelopeName (envelope_name, envelope)

• finderNumber (finder_number, finder)

• firstName (first_name, first)

• formalEnvelopeName (formal_envelope_name, formal_envelope)

• formalSalutation (formal_salutation)

• identifiers (identifier (singular))

• isDeceased (is_deceased, deceased)

• jobTitle (job_title)

• lastName (last_name, last)

• middleName (middle_name, middle)

• nickname

• occupation

• organizationContactCommonName (organization_contact_common_name, organization_contact, org_contact_common, org_common)

• organizationContactOfficialName (organization_contact_official_name, organization_contact_official, org_contact_official, org_official)

• organizationRoles (organization_roles, org_roles, org_role (singular))

• partialDateOfBirth (partial_date_of_birth, partial_birthday)

• party

• phones (phone (singular))

• primaryContact (primary_contact)

• pronouns (preferredPronoun, pronoun)

• recordedAddresses (recorded_addresses, recorded_address (singular))

• salutation

• scores (score (singular))

• selfReportedEthnicities (self_reported_ethnicities, ethnicities)

• selfReportedEthnicity (self_reported_ethnicity, ethnicity)

• selfReportedGenders (self_reported_genders, genders, gender (singular))

• selfReportedLanguagePreference (self_reported_language_preference, language_preference, language)

• selfReportedRace (self_reported_race, race)

• selfReportedRaces (self_reported_races, races)

• selfReportedSexualOrientations (self_reported_sexual_orientations, sexual_orientations, sexual_orientation (singular))

• sex

• suffix

• suppressions (suppression (singular))

• surveyQuestionResponses (survey_question_responses, responses, response (singular))

• title

• vanId (van_id, id)

• website

find_by_phone(**kwargs: EAValue) → Optional[Person]

See POST /people/findByPhone.

Parameters

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

Returns

The resulting Person object.

Keyword Arguments

• phoneNumber (phone_number, number)

find_or_create(**kwargs: EAValue) → Person

See POST /people/findOrCreate.

Parameters

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

Returns

The found or else created Person object.

Keyword Arguments

• additionalEnvelopeName (additional_envelope_name, additional_envelope)

• additionalSalutation (additional_salutation)

• addresses (address (singular))

• biographyImageUrl (biography_image_url, biography_image, bio_image_url, bio_image)

• caseworkCases (casework_cases, cases, case (singular))

• caseworkIssues (casework_issues, issues, issue (singular))

• caseworkStories (casework_stories, stories, story (singular))

• collectedLocationId (collected_location_id, collected_location, location)

• contactMethodPreferenceCode (contact_method_preference_code, contact_preference_code, contact_preference, preference_code)

• contactMode (contact_mode)

• contactModeId (contact_mode_id)

• contactSource (contact_source)

• customFieldValues (custom_field_values, custom_values, custom_value (singular))

• customProperties (custom_properties, properties, property (singular))

• cycle

• dateAcquired (date_acquired)

• dateCreated (date_created, created)

• dateOfBirth (date_of_birth, birthday)

• disclosureFieldValues (disclosure_field_values, field_values, disclosures, values, disclosure (singular))

• districts (district (singular))

• electionRecords (election_records, election_record (singular))

• electionType (election_type)

• emails (email (singular))

• employer

• envelopeName (envelope_name, envelope)

• finderNumber (finder_number, finder)

• firstName (first_name, first)

• formalEnvelopeName (formal_envelope_name, formal_envelope)

• formalSalutation (formal_salutation)

• identifiers (identifier (singular))

• isDeceased (is_deceased, deceased)

• jobTitle (job_title)

• lastName (last_name, last)

• middleName (middle_name, middle)

• nickname

• occupation

• organizationContactCommonName (organization_contact_common_name, organization_contact, org_contact_common, org_common)

• organizationContactOfficialName (organization_contact_official_name, organization_contact_official, org_contact_official, org_official)

• organizationRoles (organization_roles, org_roles, org_role (singular))

• partialDateOfBirth (partial_date_of_birth, partial_birthday)

• party

• phones (phone (singular))

• primaryContact (primary_contact)

• pronouns (preferredPronoun, pronoun)

• recordedAddresses (recorded_addresses, recorded_address (singular))

• salutation

• scores (score (singular))

• selfReportedEthnicities (self_reported_ethnicities, ethnicities)

• selfReportedEthnicity (self_reported_ethnicity, ethnicity)

• selfReportedGenders (self_reported_genders, genders, gender (singular))

• selfReportedLanguagePreference (self_reported_language_preference, language_preference, language)

• selfReportedRace (self_reported_race, race)

• selfReportedRaces (self_reported_races, races)

• selfReportedSexualOrientations (self_reported_sexual_orientations, sexual_orientations, sexual_orientation (singular))

• sex

• suffix

• suppressions (suppression (singular))

• surveyQuestionResponses (survey_question_responses, responses, response (singular))

• title

• vanId (van_id, id)

• website

get(van_id: int, /, **kwargs: EAValue) → Person

See GET /people/{vanId}.

Parameters

• van_id – The vanId path parameter.

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

Returns

The resulting Person object.

Keyword Arguments

• expand

get_(person_id_type: str, person_id: str, /, **kwargs: EAValue) → Person

See GET /people/{personIdType}:{personId}.

Parameters

• person_id_type – The personIdType path parameter.

• person_id – The personId path parameter.

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

Returns

The resulting Person object.

Keyword Arguments

• expand

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

See GET /people.

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

Keyword Arguments

• city

• commonName (common_name, common)

• contactMode (contact_mode)

• email

• expand

• firstName (first_name, first)

• lastName (last_name, last)

• middleName (middle_name, middle)

• officialName (official_name, official)

• orderby (order_by)

• phoneNumber (phone_number, number)

• stateOrProvince (state_or_province, province, state)

• streetAddress (street_address, address)

• zipOrPostalCode (zip_or_postal_code, postal_code, zip_code, postal, zip)

lookup(*, expand: Union[str, Iterable[str]] = '', **kwargs: EAValue) → Optional[Person]

Attempt to find a person using the data in kwargs by invoking POST /people/find. Then, if a person was found, use their VAN ID to retrieve their stored Person record by invoking GET /people/{vanId}.

Parameters

• expand – List or comma-separated string of names of properties to get for the person.

• kwargs – The JSON data to lookup the person with. A Person is appropriate to unpack here.

Returns

The resulting Person object if found, otherwise None.

membership(van_id: int, /) → Membership

See GET /people/{vanId}/membership.

Parameters

van_id – The vanId path parameter.

Returns

The resulting Membership object.

merge_into(van_id: int, /, **kwargs: EAValue) → Person

See PUT /people/{vanId}/mergeInto.

Parameters

• van_id – The vanId path parameter.

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

Returns

The resulting Person object.

Keyword Arguments

• vanId (van_id, van)

• whatIf (what_if)

notes(van_id: int, /, *, limit: Optional[int] = None, **kwargs: EAValue) → List[Note]

See GET /people/{vanId}/notes.

Parameters

• van_id – The vanId path parameter.

• 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 Note objects.

remove_activist_code(activist_code: Union[int, str], **kwargs: EAValue) → None

Remove the given activist code from the person distinguished by the specified data. Does not create a contact history.

Parameters

• activist_code – The activist code name or ID.

• kwargs – The JSON data to lookup the person with. A Person is appropriate to unpack here.

Raises

EAFindFailedException – If either the given activist code or a person could not be found.

remove_code(van_id: int, code_id: int, /) → None

See DELETE /people/{vanId}/codes/{codeId}.

Parameters

• van_id – The vanId path parameter.

• code_id – The code_id path parameter.

remove_code_(person_id_type: str, person_id: str, code_id: int, /) → None

See DELETE /people/{personIdType}:{personId}/codes/{codeId}.

Parameters

• person_id_type – The personIdType path parameter.

• person_id – The personId path parameter.

• code_id – The codeId path parameter.

remove_my_activist_flag(van_id: int, /) → None

See DELETE /people/{vanId}/myActivistFlags.

Parameters

van_id – The vanId path parameter.

set_disclosures_fields(van_id: int, /, **kwargs: EAValue) → None

See POST /people/{vanId}/disclosureFieldValues.

Parameters

• van_id – The vanId path parameter.

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

Keyword Arguments

• disclosureFieldValues (disclosure_field_values, field_values, disclosures, values, disclosure (singular))

set_disclosures_fields_(person_id_type: str, person_id: str, /, **kwargs: EAValue) → None

See POST /people/{personIdType}:{personId}/disclosureFieldValues.

Parameters

• person_id_type – The personIdType path parameter.

• person_id – The personId path parameter.

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

Keyword Arguments

• disclosureFieldValues (disclosure_field_values, field_values, disclosures, values, disclosure (singular))

update(van_id: int, /, **kwargs: EAValue) → Optional[Person]

See POST /people/{vanId}.

Parameters

• van_id – The vanId path parameter.

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

Returns

The found Person object, or None if no person could be found.

Keyword Arguments

• additionalEnvelopeName (additional_envelope_name, additional_envelope)

• additionalSalutation (additional_salutation)

• addresses (address (singular))

• biographyImageUrl (biography_image_url, biography_image, bio_image_url, bio_image)

• caseworkCases (casework_cases, cases, case (singular))

• caseworkIssues (casework_issues, issues, issue (singular))

• caseworkStories (casework_stories, stories, story (singular))

• collectedLocationId (collected_location_id, collected_location, location)

• contactMethodPreferenceCode (contact_method_preference_code, contact_preference_code, contact_preference, preference_code)

• contactMode (contact_mode)

• contactModeId (contact_mode_id)

• contactSource (contact_source)

• customFieldValues (custom_field_values, custom_values, custom_value (singular))

• customProperties (custom_properties, properties, property (singular))

• cycle

• dateAcquired (date_acquired)

• dateCreated (date_created, created)

• dateOfBirth (date_of_birth, birthday)

• disclosureFieldValues (disclosure_field_values, field_values, disclosures, values, disclosure (singular))

• districts (district (singular))

• electionRecords (election_records, election_record (singular))

• electionType (election_type)

• emails (email (singular))

• employer

• envelopeName (envelope_name, envelope)

• finderNumber (finder_number, finder)

• firstName (first_name, first)

• formalEnvelopeName (formal_envelope_name, formal_envelope)

• formalSalutation (formal_salutation)

• identifiers (identifier (singular))

• isDeceased (is_deceased, deceased)

• jobTitle (job_title)

• lastName (last_name, last)

• middleName (middle_name, middle)

• nickname

• occupation

• organizationContactCommonName (organization_contact_common_name, organization_contact, org_contact_common, org_common)

• organizationContactOfficialName (organization_contact_official_name, organization_contact_official, org_contact_official, org_official)

• organizationRoles (organization_roles, org_roles, org_role (singular))

• partialDateOfBirth (partial_date_of_birth, partial_birthday)

• party

• phones (phone (singular))

• primaryContact (primary_contact)

• pronouns (preferredPronoun, pronoun)

• recordedAddresses (recorded_addresses, recorded_address (singular))

• salutation

• scores (score (singular))

• selfReportedEthnicities (self_reported_ethnicities, ethnicities)

• selfReportedEthnicity (self_reported_ethnicity, ethnicity)

• selfReportedGenders (self_reported_genders, genders, gender (singular))

• selfReportedLanguagePreference (self_reported_language_preference, language_preference, language)

• selfReportedRace (self_reported_race, race)

• selfReportedRaces (self_reported_races, races)

• selfReportedSexualOrientations (self_reported_sexual_orientations, sexual_orientations, sexual_orientation (singular))

• sex

• suffix

• suppressions (suppression (singular))

• surveyQuestionResponses (survey_question_responses, responses, response (singular))

• title

• vanId (van_id, id)

• website

update_(person_id_type: str, person_id: str, /, **kwargs: EAValue) → Optional[Person]

See POST /people/{personIdType}:{personId}.

Parameters

• person_id_type – The personIdType path parameter.

• person_id – The personId path parameter.

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

Returns

The found Person object, or None if no person could be found.

Keyword Arguments

• additionalEnvelopeName (additional_envelope_name, additional_envelope)

• additionalSalutation (additional_salutation)

• addresses (address (singular))

• biographyImageUrl (biography_image_url, biography_image, bio_image_url, bio_image)

• caseworkCases (casework_cases, cases, case (singular))

• caseworkIssues (casework_issues, issues, issue (singular))

• caseworkStories (casework_stories, stories, story (singular))

• collectedLocationId (collected_location_id, collected_location, location)

• contactMethodPreferenceCode (contact_method_preference_code, contact_preference_code, contact_preference, preference_code)

• contactMode (contact_mode)

• contactModeId (contact_mode_id)

• contactSource (contact_source)

• customFieldValues (custom_field_values, custom_values, custom_value (singular))

• customProperties (custom_properties, properties, property (singular))

• cycle

• dateAcquired (date_acquired)

• dateCreated (date_created, created)

• dateOfBirth (date_of_birth, birthday)

• disclosureFieldValues (disclosure_field_values, field_values, disclosures, values, disclosure (singular))

• districts (district (singular))

• electionRecords (election_records, election_record (singular))

• electionType (election_type)

• emails (email (singular))

• employer

• envelopeName (envelope_name, envelope)

• finderNumber (finder_number, finder)

• firstName (first_name, first)

• formalEnvelopeName (formal_envelope_name, formal_envelope)

• formalSalutation (formal_salutation)

• identifiers (identifier (singular))

• isDeceased (is_deceased, deceased)

• jobTitle (job_title)

• lastName (last_name, last)

• middleName (middle_name, middle)

• nickname

• occupation

• organizationContactCommonName (organization_contact_common_name, organization_contact, org_contact_common, org_common)

• organizationContactOfficialName (organization_contact_official_name, organization_contact_official, org_contact_official, org_official)

• organizationRoles (organization_roles, org_roles, org_role (singular))

• partialDateOfBirth (partial_date_of_birth, partial_birthday)

• party

• phones (phone (singular))

• primaryContact (primary_contact)

• pronouns (preferredPronoun, pronoun)

• recordedAddresses (recorded_addresses, recorded_address (singular))

• salutation

• scores (score (singular))

• selfReportedEthnicities (self_reported_ethnicities, ethnicities)

• selfReportedEthnicity (self_reported_ethnicity, ethnicity)

• selfReportedGenders (self_reported_genders, genders, gender (singular))

• selfReportedLanguagePreference (self_reported_language_preference, language_preference, language)

• selfReportedRace (self_reported_race, race)

• selfReportedRaces (self_reported_races, races)

• selfReportedSexualOrientations (self_reported_sexual_orientations, sexual_orientations, sexual_orientation (singular))

• sex

• suffix

• suppressions (suppression (singular))

• surveyQuestionResponses (survey_question_responses, responses, response (singular))

• title

• vanId (van_id, id)

• website

update_if_exists(lookup_args: EAMap, update_args: EAMap) → Optional[int]

Update a person with the given properties if they already exist as a record. Works by invoking POST /people/find followed by POST /people/{vanId} if the person exists.

Parameters

• lookup_args – The JSON data to lookup the person with. A Person is an appropriate argument here.

• update_args – The JSON data to update the person with. A Person is an appropriate argument here.

Returns

The VAN ID of the person, or None is no such record was found.

update_names(van_id: int, /, **kwargs: EAValue) → Person

See PATCH /people/{vanId}/names.

Parameters

• van_id – The vanId path parameter.

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

Returns

The resulting Person object.

Keyword Arguments

• additionalEnvelopeName (additional_envelope_name, additional_envelope)

• additionalSalutation (additional_salutation)

• addresses (address (singular))

• biographyImageUrl (biography_image_url, biography_image, bio_image_url, bio_image)

• caseworkCases (casework_cases, cases, case (singular))

• caseworkIssues (casework_issues, issues, issue (singular))

• caseworkStories (casework_stories, stories, story (singular))

• collectedLocationId (collected_location_id, collected_location, location)

• contactMethodPreferenceCode (contact_method_preference_code, contact_preference_code, contact_preference, preference_code)

• contactMode (contact_mode)

• contactModeId (contact_mode_id)

• contactSource (contact_source)

• customFieldValues (custom_field_values, custom_values, custom_value (singular))

• customProperties (custom_properties, properties, property (singular))

• cycle

• dateAcquired (date_acquired)

• dateCreated (date_created, created)

• dateOfBirth (date_of_birth, birthday)

• disclosureFieldValues (disclosure_field_values, field_values, disclosures, values, disclosure (singular))

• districts (district (singular))

• electionRecords (election_records, election_record (singular))

• electionType (election_type)

• emails (email (singular))

• employer

• envelopeName (envelope_name, envelope)

• finderNumber (finder_number, finder)

• firstName (first_name, first)

• formalEnvelopeName (formal_envelope_name, formal_envelope)

• formalSalutation (formal_salutation)

• identifiers (identifier (singular))

• isDeceased (is_deceased, deceased)

• jobTitle (job_title)

• lastName (last_name, last)

• middleName (middle_name, middle)

• nickname

• occupation

• organizationContactCommonName (organization_contact_common_name, organization_contact, org_contact_common, org_common)

• organizationContactOfficialName (organization_contact_official_name, organization_contact_official, org_contact_official, org_official)

• organizationRoles (organization_roles, org_roles, org_role (singular))

• partialDateOfBirth (partial_date_of_birth, partial_birthday)

• party

• phones (phone (singular))

• primaryContact (primary_contact)

• pronouns (preferredPronoun, pronoun)

• recordedAddresses (recorded_addresses, recorded_address (singular))

• salutation

• scores (score (singular))

• selfReportedEthnicities (self_reported_ethnicities, ethnicities)

• selfReportedEthnicity (self_reported_ethnicity, ethnicity)

• selfReportedGenders (self_reported_genders, genders, gender (singular))

• selfReportedLanguagePreference (self_reported_language_preference, language_preference, language)

• selfReportedRace (self_reported_race, race)

• selfReportedRaces (self_reported_races, races)

• selfReportedSexualOrientations (self_reported_sexual_orientations, sexual_orientations, sexual_orientation (singular))

• sex

• suffix

• suppressions (suppression (singular))

• surveyQuestionResponses (survey_question_responses, responses, response (singular))

• title

• vanId (van_id, id)

• website

update_note(van_id: int, note_id: int, /, **kwargs: EAValue) → None

See PUT /people/{vanId}/notes/{noteId}.

Parameters

• van_id – The vanId path parameter.

• note_id – The noteId path parameter.

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

Keyword Arguments

• category

• contactHistory (contact_history, history)

• createdDate (created_date, created)

• isViewRestricted (is_view_restricted, view_restricted)

• noteId (note_id, id)

• text