EveryAction API Objects

This module contains EveryAction objects, such as Person or CanvassResponse, which represent structured EveryAction data directly corresponding to objects in the EveryAction 8 VAN API docs.

class everyaction.objects.APIKeyProfile(**kwargs: EAValue)

Represents an API key profile.

Properties

• apiKeyTypeName (api_key_type_name, type_name, type)

• committeeId (committee_id)

• committeeName (committee_name, committee)

• databaseName (database_name)

• hasMyCampaign (has_my_campaign, my_campaign)

• hasMyVoters (has_my_voters, my_voters)

• keyReference (key_reference, reference)

• stateId (state_id, state)

• userFirstName (user_first_name, first_name, first)

• userLastName (user_last_name, last_name, last)

• username (user)

class everyaction.objects.AVEVDataFileAction(**kwargs: EAValue)

Represents an AVEV Data File Action.

Properties

• actionType (action_type, type)

class everyaction.objects.ActivistCode(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents an Activist Code.

Properties

• activistCodeId (activist_code_id, id)

• description (desc)

• isMultiAssign (is_multi_assign, multi_assign)

• mediumName (medium_name, medium)

• name

• scriptQuestion (script_question, question)

• shortName (short_name, short)

• status

• type

class everyaction.objects.ActivistCodeData(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents the data associated with responses to getting Activist Codes.

Properties

• activistCodeId (activist_code_id, id)

• activistCodeName (activist_code_name, name)

• activistCodeTypeAndName (activist_code_type_and_name, type_and_name, typeAndName)

• canvassedBy (canvassed_by, canvasser)

• dateCanvassed (date_canvassed, canvassed)

• dateCreated (date_created, created)

class everyaction.objects.ActivistCodeResponse(id: Optional[int] = None, **kwargs: EAValue)

Represents an Activist Code Response.

Properties

• action

• activistCodeId (activist_code_id, id)

• type

class everyaction.objects.AddRegistrantsResponse(**kwargs: EAValue)

Represents the data associated with a response to adding registrants to a Voter Registration Batch.

Properties

• alternateId (alternate_id, alternate, alt)

• errors (error (singular))

• result

• vanId (van_id, van)

class everyaction.objects.Address(id: Optional[int] = None, **kwargs: EAValue)

Represents an Address.

Properties

• addressId (address_id, id)

• addressLine1 (address_line1, line1)

• addressLine2 (address_line2, line2)

• addressLine3 (address_line3, line3)

• city

• countryCode (country_code, country)

• displayMode (display_mode)

• geoLocation (geo_location, location, geo)

• isPreferred (is_preferred, preferred)

• preview

• stateOrProvince (state_or_province, province, state)

• type

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

class everyaction.objects.Adjustment(**kwargs: EAValue)

Represents the data associated with responses to adjusting a Contribution.

Properties

• adjustmentType (adjustment_type, type)

• amount

• datePosted (date_posted, posted)

class everyaction.objects.AdjustmentResponse(**kwargs: EAValue)

Represents the data associated with a response to a Contribution adjustment.

Properties

• contributionId (contribution_id, contribution)

• dateAdjusted (date_adjusted, adjusted, date)

• originalAmount (original_amount, original)

• remainingAmount (remaining_amount, remaining)

class everyaction.objects.Attribution(**kwargs: EAValue)

Represents an Attribution object.

Properties

• amountAttributed (amount_attributed, amount)

• attributionType (attribution_type, type)

• dateThanked (date_thanked, thanked)

• notes

• vanId (van_id, van)

class everyaction.objects.AvailableValue(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents AvailableValues for a Custom Field.

Properties

• id

• name

• parentValueId (parent_value_id, parent_value)

class everyaction.objects.BallotRequestType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Ballot Request Type.

Properties

• ballotRequestTypeId (ballot_request_type_id, id)

• name

class everyaction.objects.BallotReturnStatus(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Ballot Return Status.

Properties

• ballotReturnStatusId (ballot_return_status_id, id)

• name

class everyaction.objects.BallotType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Ballot Type.

Properties

• ballotTypeId (ballot_type_id, id)

• name

class everyaction.objects.BankAccount(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Contribution Bank Account object.

Properties

• bankAccountId (bank_account_id, id)

• name

class everyaction.objects.BargainingUnit(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Bargaining Unit.

Properties

• bargainingUnitId (bargaining_unit_id, id)

• employerBargainingUnitId (employer_bargaining_unit_id, employer_bargaining_unit)

• name

• shortName (short_name, short)

class everyaction.objects.BargainingUnitJobClass(id: Optional[int] = None, **kwargs: EAValue)

Represents an Employer Bargaining Unit Job Class.

Properties

• bargainingUnit (bargaining_unit)

• employerBargainingUnitId (employer_bargaining_unit_id, employer_bargaining_unit)

• employerBargainingUnitJobClassId (employer_bargaining_unit_job_class_id, id)

• jobClass (job_class)

class everyaction.objects.BulkImportAction(**kwargs: EAValue)

Represents a bulk import action.

Properties

• actionType (action_type, type)

• columnsToIncludeInResultsFile (columns_to_include_in_results_file, include_columns, include, include_column (singular))

• mappingTypes (mapping_types, mappings, mapping (singular))

• resourceType (resource_type, resource)

• resultFileSizeKbLimit (result_file_size_kb_limit, size_kb_limit, kb_limit)

class everyaction.objects.BulkImportField(name: Optional[str] = None, **kwargs: EAValue)

Represents a mapping type field.

Properties

• canBeMappedToColumn (can_be_mapped_to_column, column_mappable, mappable)

• description (desc)

• hasPredefinedValues (has_predefined_values, has_predefined)

• isRequired (is_required, required)

• name

• parents (parent (singular))

class everyaction.objects.BulkImportJob(**kwargs: EAValue)

Represents a Bulk Import Job.

Properties

• actions (action (singular))

• description (desc)

• file

class everyaction.objects.BulkImportJobData(id: Optional[int] = None, **kwargs: EAValue)

Represents data for an existing Bulk Import Job.

Properties

• errors (error (singular))

• jobId (job_id, id)

• resourceType (resource_type, resource)

• resultFileSizeLimitKb (result_file_size_limit_kb, size_kb_limit, kb_limit)

• resultFiles (result_files, files, file (singular))

• status

class everyaction.objects.Campaign(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Campaign.

Properties

• campaignDisplayName (campaign_display_name, display_name, displayName, display)

• campaignId (campaign_id, id)

• campaignType (campaign_type, type)

• contents (content (singular))

• displayName (display_name, display)

• name

• status

class everyaction.objects.CampaignType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Campaign Type.

Properties

• campaignTypeId (campaign_type_id, id)

• name

class everyaction.objects.CanvassContext(**kwargs: EAValue)

Represents a Canvass Context.

Properties

• campaignId (campaign_id, campaign)

• contactTypeId (contact_type_id, contact_type)

• contentId (content_id, content)

• dateCanvassed (date_canvassed, canvassed)

• inputTypeId (input_type_id, input_type)

• omitActivistCodeContactHistory (omit_activist_code_contact_history, omit_contact_history, omit_history)

• phone

• phoneId (phone_id, phone)

• skipMatching (skip_matching)

class everyaction.objects.CanvassFileRequest(id: Optional[int] = None, **kwargs: EAValue)

Represents a Canvass File Request.

Properties

• dateExpired (date_expired, expired)

• downloadUrl (download_url, download)

• errorCode (error_code, error)

• guid

• id

• savedListId (saved_list_id, saved_list, list)

• status

• type

• webhookUrl (webhook_url, webhook)

class everyaction.objects.CanvassResponse(**kwargs: EAValue)

Represents a Canvass Response.

Properties

• canvassContext (canvass_context, context)

• responses (response (singular))

• resultCodeId (result_code_id, result_code)

class everyaction.objects.Canvasser(id: Optional[int] = None, **kwargs: EAValue)

Represents a Canvasser.

Properties

• canvasserId (canvasser_id, id)

class everyaction.objects.ChangeType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a changeType.

Properties

• Description (description, desc)

• changeTypeID (change_type_id, id, ID)

• changeTypeName (change_type_name, name)

class everyaction.objects.ChangedEntityBulkImportField(**kwargs: EAValue)

Represents a bulk import field in the context of changed entities.

Properties

• fieldName (field_name, field)

• mappingTypeName (mapping_type_name, mapping_type, mapping)

• relationalMappings (relational_mappings, relations, relation (singular))

class everyaction.objects.ChangedEntityExportJob(id: Optional[int] = None, **kwargs: EAValue)

Represents data for an existing ChangedEntityExportJob.

Properties

• dateChangedFrom (date_changed_from, changed_from)

• dateChangedTo (date_changed_to, changed_to)

• exportJobId (export_job_id, id)

• exportedRecordCount (exported_record_count, exported_records, record_count, records, count)

• files (file (singular))

• jobStatus (job_status, status)

• message

class everyaction.objects.ChangedEntityExportRequest(id: Optional[int] = None, **kwargs: EAValue)

Represents data associated with a request to create a Changed Entity Export Job.

Properties

• dateChangedFrom (date_changed_from, changed_from)

• dateChangedTo (date_changed_to, changed_to)

• excludeChangesFromSelf (exclude_changes_from_self, exclude_self)

• exportJobId (export_job_id, id)

• includeInactive (include_inactive)

• requestedCustomFieldIds (requested_custom_field_ids, custom_field_ids, custom_fields, custom_field (singular))

• requestedFields (requested_fields, fields, field (singular))

• requestedIds (requested_ids, ids, requested_id (singular))

• resourceType (resource_type, resource)

class everyaction.objects.ChangedEntityField(name: Optional[str] = None, **kwargs: EAValue)

Represents a changed entity field.

Properties

• availableValues (available_values, available, values, value (singular))

• bulkImportFields (bulk_import_fields, bulk_import_field (singular))

• fieldName (field_name, name)

• fieldType (field_type, type)

• isCoreField (is_core_field, core_field, is_core, core)

• maxTextboxCharacters (max_textbox_characters, max_box_chars)

parse(value: str) → Union[bool, int, str, datetime]

Parse the raw string value of a field into a typed result. The below table gives the behavior of this function for each field type.

Field Type	Behavior
B	Parses “true” to True and “false” to False.
D	Parses into a naive datetime object.
M	Keeps the original string value.
N	Parses into an int.
T	Keeps the original string value.

Parameters

value – The value to parse.

Returns

The parsed value.

class everyaction.objects.Code(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Code object.

Properties

• 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))

class everyaction.objects.CodeResult(id: Optional[int] = None, **kwargs: EAValue)

Represents the data associated with a response to a code batch request. See POST /codes/batch for an example.

Properties

• codeId (code_id, id)

• message

class everyaction.objects.Column(name: Optional[str] = None, **kwargs: EAValue)

Represents a Column.

Properties

• name

class everyaction.objects.Commitment(id: Optional[int] = None, **kwargs: EAValue)

Represents a Commitment.

Properties

• amount

• ccExpirationMonth (cc_expiration_month, cc_exp_month)

• ccExpirationYear (cc_expiration_year, cc_exp_year)

• commitmentId (commitment_id, id)

• creditCardLast4 (credit_card_last4, cc_last4, last4)

• currency

• designationId (designation_id, designation)

• endDate (end_date, end)

• frequency

• nextTransactionDate (next_transaction_date, next_transaction, next)

• paymentType (payment_type)

• startDate (start_date, start)

• status

class everyaction.objects.ConfirmationEmailData(**kwargs: EAValue)

Represents Confirmation Email Data.

Properties

• copyToEmails (copy_to_emails, copy_to)

• fromEmail (from_email)

• fromName (from_name, sender)

• fromSubject (from_subject, subject)

• isConfirmationEmailEnabled (is_confirmation_email_enabled, confirmation_email_enabled, confirmation_enabled, confirmation)

• isRecurringEmailEnabled (is_recurring_email_enabled, recurring_email_enabled, recurring_enabled, recurring)

• replyToEmail (reply_to_email, reply_to)

class everyaction.objects.Constraints(**kwargs: EAValue)

Represents a description of the violated constraints for Error objects.

Properties

• invalidCharacters (invalid_characters, invalid_chars)

• maxLength (max_length)

class everyaction.objects.ContactHistory(**kwargs: EAValue)

Represents a Contact History object.

Properties

• contactTypeId (contact_type_id, contact_type)

• dateCanvassed (date_canvassed, canvassed)

• inputTypeId (input_type_id, input_type)

• resultCodeId (result_code_id, result_code)

class everyaction.objects.ContactType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Contact Type.

Properties

• channelTypeName (channel_type_name, channel_type, channel)

• contactTypeId (contact_type_id, id)

• name

class everyaction.objects.Content(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Content object.

Properties

• contentId (content_id, id)

• contentType (content_type, type)

• description (desc)

• displayName (display_name, display)

• disposition

• name

• shortName (short_name, short)

class everyaction.objects.ContentType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Content Type.

Properties

• contentTypeId (content_type_id, id)

• name

class everyaction.objects.Contribution(**kwargs: EAValue)

Represents a Contribution.

Properties

• acceptedOneTimeAmount (accepted_one_time_amount, accepted_one_time)

• acceptedRecurringAmount (accepted_recurring_amount, accepted_recurring, recurring)

• amount

• bankAccount (bank_account, account)

• checkDate (check_date)

• checkNumber (check_number)

• codes (code (singular))

• contact

• contactAttributions (contact_attributions, attributions)

• contributionBankAccount (contribution_bank_account, contribution_account, account_obj)

• contributionId (contribution_id, contribution)

• coverCostsAmount (cover_costs_amount, cover_costs)

• dateReceived (date_received, received)

• dateThanked (date_thanked, thanked)

• depositDate (deposit_date)

• depositNumber (deposit_number)

• designation

• directMarketingCode (direct_marketing_code, marketing_code)

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

• extendedSourceCode (extended_source_code, extended_source)

• identifiers (identifier (singular))

• isUpsellAccepted (is_upsell_accepted, upsell_accepted)

• isUpsellShown (is_upsell_shown, upsell_shown)

• linkedJointFundraisingContributionId (linked_joint_fundraising_contribution_id, joint_fundraising_contribution, fundraising_contribution, fundraising)

• linkedPartnershipContributionId (linked_partnership_contribution_id, partnership_contribution, partnership)

• notes

• onlineReferenceNumber (online_reference_number, reference_number, ref_number)

• paymentType (payment_type)

• pledge

• processedAmount (processed_amount)

• processedCurrency (processed_currency)

• selectedOneTimeAmount (selected_one_time_amount, selected_one_time)

• status

• upsellType (upsell_type, upsell)

class everyaction.objects.Currency(**kwargs: EAValue)

Represents the type and the amount of a currency. Found, for instance, in the response of GET /people/{vanId}/membership.

Properties

• amount

• currencyType (currency_type, type)

class everyaction.objects.CustomField(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Custom Field.

Properties

• availableValues (available_values, available, values, value (singular))

• customFieldGroupId (custom_field_group_id, group_id, groupId)

• customFieldGroupName (custom_field_group_name, group_name, groupName)

• customFieldGroupType (custom_field_group_type, group_type, groupType)

• customFieldId (custom_field_id, id)

• customFieldName (custom_field_name, name)

• customFieldParentId (custom_field_parent_id, parent_id, parentId, parent)

• customFieldTypeId (custom_field_type_id, type_id, typeId, type)

• isEditable (is_editable, editable)

• isExportable (is_exportable, exportable)

• maxTextboxCharacters (max_textbox_characters, max_box_chars)

class everyaction.objects.CustomFieldValue(customFieldId: Optional[int] = None, customFieldGroupId: Optional[int] = None, assignedValue: Optional[str] = None, **kwargs: EAValue)

Represents a CustomFieldValue.

Properties

• assignedValue (assigned_value, value)

• customFieldGroupId (custom_field_group_id, group)

• customFieldId (custom_field_id, field)

class everyaction.objects.Department(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Department.

Properties

• departmentId (department_id, id)

• employer

• name

• parentDepartmentId (parent_department_id, parent_department, parent)

class everyaction.objects.Designation(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Designation.

Properties

• designationId (designation_id, id)

• name

class everyaction.objects.Disbursement(id: Optional[int] = None, **kwargs: EAValue)

Represents a Disbursement.

Properties

• amount

• batchCode (batch_code, batch)

• checkDate (check_date)

• checkNumber (check_number)

• codes (code (singular))

• contact

• dateIssued (date_issued, issued)

• designation

• disbursementId (disbursement_id, id)

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

• linkedCreditCardPaymentDisbursementId (linked_credit_card_payment_disbursement_id, credit_card_payment)

• linkedReimbursementDisbursementId (linked_reimbursement_disbursement_id, reimbursement)

• notes

class everyaction.objects.DisclosureFieldValue(disclosureFieldId: Optional[int] = None, disclosureFieldValue: Optional[str] = None, designationId: Optional[int] = None, **kwargs: EAValue)

Represents a Disclosure Field Value.

Properties

• designationId (designation_id, designation)

• disclosureFieldId (disclosure_field_id, id)

• disclosureFieldValue (disclosure_field_value, value)

class everyaction.objects.DistrictField(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a District Field.

Properties

• districtFieldId (district_field_id, id)

• districtFieldValues (district_field_values, values, value (singular))

• isCustomDistrict (is_custom_district, custom_district, is_custom, custom)

• name

• parentFieldId (parent_field_id, parent_field, parent)

class everyaction.objects.DistrictFieldValue(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a District Field Value.

Properties

• id

• name

• parentId (parent_id, parent)

class everyaction.objects.Email(email: Optional[str] = None, **kwargs: EAValue)

Represents an Email.

Properties

• dateCreated (date_created, created)

• email

• isPreferred (is_preferred, preferred)

• isSubscribed (is_subscribed, subscribed)

• subscriptionStatus (subscription_status, status)

• type

class everyaction.objects.EmailMessage(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents an email message.

Properties

• campaignID (campaign)

• createdBy (created_by, creator)

• dateCreated (date_created, created)

• dateModified (date_modified, modified)

• dateScheduled (date_scheduled, scheduled)

• emailMessageContent (email_message_content, content (singular))

• foreignMessageId (foreign_message_id, id)

• name

class everyaction.objects.EmailMessageContent(**kwargs: EAValue)

Represents an email message content object.

Properties

• createdBy (created_by, creator)

• dateCreated (date_created, created)

• emailMessageContentDistributions (email_message_content_distributions, distributions)

• name

• senderDisplayName (sender_display_name, sender_display, sender_name)

• senderEmailAddress (sender_email_address, sender_email)

• subject (subject)

class everyaction.objects.EmailMessageContentDistributions(**kwargs: EAValue)

Represents an Email Message Content Distributions object.

Properties

• bounceCount (bounce_count, bounces)

• contributionCount (contribution_count, contributions)

• contributionTotal (contribution_total)

• dateSent (date_sent, sent)

• formSubmissionCount (form_submission_count, form_submissions, submissions, forms)

• linksClickedCount (links_clicked_count, links_clicked)

• machineOpenCount (machine_open_count)

• openCount (open_count, opens)

• recipientCount (recipient_count, recipients)

• unsubscribeCount (unsubscribe_count, unsubscribes)

class everyaction.objects.Employer(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents an Employer.

Properties

• bargainingUnits (bargaining_units, bargaining_unit (singular))

• departments (department (singular))

• employerId (employer_id, id)

• isMyOrganization (is_my_organization, my_organization, my_org)

• jobClasses (job_classes, job_class (singular))

• name

• parentOrganization (parent_organization, parent)

• phones (phone (singular))

• shifts (shift (singular))

• shortName (short_name, short)

• website

• worksites (worksite (singular))

class everyaction.objects.EmployerBargainingUnit(id: Optional[int] = None, **kwargs: EAValue)

Represents an Employer Bargaining Unit.

Properties

• bargainingUnit (bargaining_unit)

• employerBargainingUnitId (employer_bargaining_unit_id, id)

class everyaction.objects.EmployerPhone(id: Optional[int] = None, **kwargs: EAValue)

Represents a Phone for an employer.

Properties

• confidenceLevel (confidence_level, confidence)

• countryCode (country_code, country)

• dialingPrefix (dialing_prefix, prefix)

• organizationId (organization_id, organization, org)

• organizationPhoneId (organization_phone_id, id)

• phone

• phoneSourceId (phone_source_id, phone_source, source)

• phoneType (type)

class everyaction.objects.Error(**kwargs: EAValue)

Represents an Error object.

Properties

• code

• detailedCode (detailed_code)

• detailedConstraints (detailed_constraints, constraints)

• hint

• properties (property (singular))

• referenceCode (reference_code, reference)

• resourceUrl (resource_url, url)

• text

class everyaction.objects.Event(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents an Event.

Properties

• codes (code (singular))

• createdDate (created_date, created)

• description (desc)

• districtFieldValue (district_field_value)

• dotNetTimeZoneId (dot_net_time_zone_id, dot_net_time_zone, time_zone)

• endDate (end_date, end)

• eventId (event_id, id)

• eventType (event_type, type)

• isActive (is_active, active)

• isOnlyEditableByCreatingUser (is_only_editable_by_creating_user, only_editable_by_creating_user, only_editable_by_creator, only_creator_may_edit)

• isPubliclyViewable (is_publicly_viewable, publicly_viewable, public)

• locations (location (singular))

• name

• notes (note (singular))

• roles (role (singular))

• shifts (shift (singular))

• shortName (short_name, short)

• startDate (start_date, start)

• voterRegistrationBatches (voter_registration_batches, registration_batches, batches, batch (singular))

class everyaction.objects.EventRole(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Role for an Event Type.

Properties

• goal

• isEventLead (is_event_lead, event_lead, lead)

• max

• min

• name

• roleId (role_id, id)

class everyaction.objects.EventShift(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Shift.

Properties

• endTime (end_time, end)

• eventShiftId (event_shift_id, id)

• name

• startTime (start_time, start)

class everyaction.objects.EventType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents an Event Type.

Properties

• canBeRepeatable (can_be_repeatable, allows_repeats)

• canHaveGoals (can_have_goals, allows_goals)

• canHaveMultipleLocations (can_have_multiple_locations, allows_multiple_locations)

• canHaveMultipleShifts (can_have_multiple_shifts, allows_multiple_shifts)

• canHaveRoleMaximums (can_have_role_maximums, allows_role_maximums)

• canHaveRoleMinimums (can_have_role_minimums, allows_role_minimums)

• color

• defaultLocation (default_location)

• eventTypeId (event_type_id, id)

• isAtLeastOneLocationRequired (is_at_least_one_location_required, requires_location, location_required, needs_location)

• isOnlineActionsAvailable (is_online_actions_available, online_actions_available, actions_available)

• isSharedWithChildCommitteesByDefault (is_shared_with_child_committees_by_default, default_share_child)

• isSharedWithMasterCommitteeByDefault (is_shared_with_master_committee_by_default, default_share_master)

• name

• roles (role (singular))

• statuses

class everyaction.objects.ExportJob(id: Optional[int] = None, **kwargs: EAValue)

Represents an Export Job.

Properties

• activistCodes (activist_codes, activist_code (singular))

• canvassFileRequestGuid (canvass_file_request_guid, canvass_guid)

• canvassFileRequestId (canvass_file_request_id, canvass_id)

• customFields (custom_fields, custom_field (singular))

• dateExpired (date_expired, expired)

• districtFields (district_fields, district_field (singular))

• downloadUrl (download_url, download)

• errorCode (error_code, error)

• exportJobGuid (export_job_guid, guid)

• exportJobId (export_job_id, id)

• savedListId (saved_list_id, saved_list, list)

• status

• surveyQuestions (survey_questions, questions, question (singular))

• type

• webhookUrl (webhook_url, webhook)

class everyaction.objects.ExportJobType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents an Export Job Type.

Properties

• exportJobTypeId (export_job_type_id, id)

• name

class everyaction.objects.ExtendedSourceCode(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents an Extended Source Code.

Properties

• createdBy (creator)

• dateCreated (date_created, created)

• dateModified (date_modified, modified)

• extendedSourceCodeId (extended_source_code_id, id)

• extendedSourceCodeName (extended_source_code_name, name)

• modifiedBy (modified_by, modifier)

class everyaction.objects.FieldValueMapping(**kwargs: EAValue)

Represents a fieldValueMapping.

Properties

• columnName (column_name, column)

• fieldName (field_name, field)

• staticValue (static_value, static)

• values (value (singular))

class everyaction.objects.File(**kwargs: EAValue)

Represents a File object in EveryAction. Used in many contexts.

Properties

• dateExpired (date_expired, expired)

• downloadUrl (download_url, download)

• recordCount (record_count, records)

class everyaction.objects.FileLoadingJob(id: Optional[int] = None, **kwargs: EAValue)

Represents a File Loading Job.

Properties

• actions (action (singular))

• description (desc)

• file

• interventionCallbackUrl (intervention_callback_url, intervention_url, callback_url)

• invalidRowsFileUrl (invalid_rows_file_url, invalid_rows_url, invalid_url)

• jobId (job_id, id)

• listeners (listener (singular))

class everyaction.objects.FinancialBatch(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Financial Batch.

Properties

• bankAccountId (bank_account_id, bank_account, account)

• checkDate (check_date)

• checkNumber (check_number)

• dateClosed (date_closed, closed)

• dateDeposited (date_deposited, deposited)

• dateOpened (date_opened, opened)

• depositNumber (deposit_number)

• designationId (designation_id, designation)

• expectedContributionCount (expected_contribution_count, expected_count)

• expectedContributionTotalAmount (expected_contribution_total_amount, expected_amount, expected_total)

• financialBatchId (financial_batch_id, id)

• financialBatchName (financial_batch_name, name)

• financialBatchNumber (financial_batch_number, number)

• isAutoGenerated (is_auto_generated, auto_generated, generated)

• isOpen (is_open, open)

class everyaction.objects.Folder(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a folder.

Properties

• folderId (folder_id, id)

• name

class everyaction.objects.GeoCoordinate(**kwargs: EAValue)

Represents a Geographic Coordinate.

Properties

• lat

• lon

class everyaction.objects.Identifier(**kwargs: EAValue)

Represents an Identifier.

Properties

• externalId (external_id, external)

• type

class everyaction.objects.InputType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents an Input Type.

Properties

• inputTypeId (input_type_id, id)

• name

class everyaction.objects.IsCellStatus(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents an Phone Is a Cell Status.

Properties

• statusId (status_id, id)

• statusName (status_name, name)

class everyaction.objects.JobActionType(**kwargs: EAValue)

Represents a Job Action Type.

Properties

• actionType (action_type, type)

class everyaction.objects.JobClass(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Job Class.

Properties

• jobClassId (job_class_id, id)

• name

• shortName (short_name, short)

class everyaction.objects.JobFile(**kwargs: EAValue)

Represents a file object for a job.

Properties

• columnDelimiter (column_delimiter, delimiter)

• columns (column (singular))

• fileName (file_name, name)

• hasHeader (has_header)

• hasQuotes (has_quotes)

• sourceUrl (source_url, source, url)

class everyaction.objects.JobNotification(**kwargs: EAValue)

Represents a Notification for File Loading Jobs.

Properties

• description (desc)

• message

• status

class everyaction.objects.KeyValuePair(**kwargs: EAValue)

Represents a key value pair for possible values of a Support Field.

Properties

• key

• value

class everyaction.objects.ListLoadCallbackData(**kwargs: EAValue)

Represents Callback Data for a Saved List Load action.

Properties

• description (desc)

• message

• savedList (saved_list, list)

• status

class everyaction.objects.Listener(**kwargs: EAValue)

Represents a Listener for a file-loading job.

Properties

• type

• value

class everyaction.objects.Location(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Location.

Properties

• address

• displayName (display_name, display)

• locationId (location_id, id)

• name

class everyaction.objects.MappingParent(**kwargs: EAValue)

Represents prerequisites for mapping a field as described here.

Properties

• limitedToParentValues (limited_to_parent_values, limited_to)

• parentFieldName (parent_field_name, parent_field, parent)

class everyaction.objects.MappingType(name: Optional[str] = None, **kwargs: EAValue)

Represents a bulk import mapping type.

Properties

• fieldValueMappings (field_value_mappings, value_mappings, field_mappings, mappings, mapping (singular))

• name

• resultFileColumnName (result_file_column_name, result_column_name, result_column, column_name, column)

class everyaction.objects.MappingTypeData(name: Optional[str] = None, **kwargs: EAValue)

Represents data for an existing bulk import mapping type.

Properties

• allowMultipleMode (allow_multiple_mode, multiple_mode, mode)

• displayName (display_name, display)

• fields (field (singular))

• name

• resourceTypes (resource_types, resources, resource (singular))

class everyaction.objects.MappingValue(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a value in the context of bulk import jobs.

Properties

• id

• name

• parentId (parent_id, parent)

• sourceValue (source_value, source)

• targetValue (target_value, target)

class everyaction.objects.MemberStatus(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Member Status.

Properties

• isMember (is_member, member)

• memberStatusId (member_status_id, id)

• name

class everyaction.objects.Membership(**kwargs: EAValue)

Contains membership information for a person.

Properties

• changeTypeName (change_type_name, change_type, change)

• dateCardsSent (date_cards_sent, cards_sent)

• dateExpireMembership (date_expire_membership, expiration_date, expiration, expires)

• dateLastRenewed (date_last_renewed, last_renewed, renewed)

• dateStartMembership (date_start_membership, start_date, started)

• duesAttributionTypeName (dues_attribution_type_name, dues_attribution_type, dues_attribution)

• duesEntityTypeName (dues_entity_type_name, dues_entity_type, dues_entity)

• duesPaid (dues_paid)

• enrollmentTypeName (enrollment_type_name, enrollment_type, enrollment)

• firstMembershipSourceCode (first_membership_source_code, first_source_code, source_code)

• levelId (level_id)

• levelName (level_name)

• numberOfCards (number_of_cards, num_cards, cards)

• numberTimesRenewed (number_times_renewed, times_renewed, renewals)

• statusName (status_name, status)

• totalDuesPaid (total_dues_paid, total_paid)

class everyaction.objects.MembershipSourceCode(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Membership Source Code.

Properties

• codeId (code_id, id)

• codeName (code_name, name)

class everyaction.objects.MiniVANExport(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a MiniVAN Export.

Properties

• canvassers (canvasser (singular))

• createdBy (creator)

• databaseMode (database_mode, mode)

• dateCreated (date_created, created)

• minivanExportId (minivan_export_id, id)

• name

class everyaction.objects.Note(id: Optional[int] = None, **kwargs: EAValue)

Represents a Note.

Properties

• category

• contactHistory (contact_history, history)

• createdDate (created_date, created)

• isViewRestricted (is_view_restricted, view_restricted)

• noteId (note_id, id)

• text

class everyaction.objects.NoteCategory(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Note Category.

Properties

• assignableTypes (assignable_types, assignable_type (singular))

• name

• noteCategoryId (note_category_id, id)

class everyaction.objects.OnlineActionsForm(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents an Online Actions Form.

Properties

• activistCodes (activist_codes, activist_code (singular))

• campaignId (campaign_id, campaign)

• codeId (code_id, code)

• confirmationEmailData (confirmation_email_data, confirmation_email, confirmation_data, confirmation)

• createdByEmail (created_by_email, creator_email, created_by, creator)

• dateCreated (date_created, created)

• dateModified (date_modified, modified)

• designation

• eventId (event_id, event)

• formName (name)

• formTrackingId (form_tracking_id, id)

• formType (type)

• formTypeId (type_id)

• isActive (is_active, active)

• isConfirmedOptInEnabled (is_confirmed_opt_in_enabled, confirmed_opt_in_enabled, opt_in_enabled, opt_in)

• modifiedByEmail (modified_by_email, modifier_email, modified_by, modifier)

class everyaction.objects.Person(id: Optional[int] = None, **kwargs: EAValue)

Represents a Person.

Properties

• 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

add_suppression(suppression: Suppression) → bool

Adds the given suppression to this person if it is not already present.

Parameters

suppression – The suppression to add.

Returns

True if the suppression was added, False if it was already present.

property do_not_call: Optional[bool]

Determine if this contact is marked as “Do Not Call”.

Returns

True is this contact is marked as “Do Not Call”, False is suppressions are present and do not contain “Do Not Call”, or None if no suppression information is available.

property do_not_email: Optional[bool]

Determine if this contact is marked as “Do Not Email”.

Returns

True is this contact is marked as “Do Not Email”, False is suppressions are present and do not contain “Do Not Email”, or None if no suppression information is available.

property do_not_mail: Optional[bool]

Determine if this contact is marked as “Do Not Mail”.

Returns

True is this contact is marked as “Do Not Mail”, False is suppressions are present and do not contain “Do Not Mail”, or None if no suppression information is available.

property do_not_walk: Optional[bool]

Determine if this contact is marked as “Do Not Mail”.

Returns

True is this contact is marked as “Do Not Walk”, False is suppressions are present and do not contain “Do Not Walk”, or None if no suppression information is available.

has_suppression(suppression: Suppression) → Optional[bool]

Determines whether this contact has the given suppression.

Parameters

suppression – The suppression to check for.

Returns

True if this contact has the suppression, False if suppression information is available (when suppressions attribute is not None) and the suppression was not found, or None if no suppression information is available.

property preferred_address: Optional[Address]

Get this contact’s preferred mailing address as an Address object if it exists, or None if this contact has no addresses or if information on what address is preferred is unavailable.

Returns

The preferred mailing address object, or None if no preferred mailing address could be determined.

property preferred_email: Optional[str]

Get the address of this contact’s preferred email if it exists, or None if this contact has no email addresses or if information on what address is preferred is unavailable.

Returns

The preferred email address, or code:None if no preferred email address could be determined.

property preferred_phone: Optional[str]

Get the number of this contact’s preferred phone if it exists, or None if this contact has no phone numbers or if information on what number is preferred is unavailable.

Returns

The preferred phone number, or code:None if no preferred phone number could be determined.

remove_suppression(suppression: Suppression) → bool

Removes the given suppression from this person if it is present.

Parameters

suppression – The suppression to remove.

Returns

True if the suppression was removed, False if the suppression was not found.

set_suppression(suppression: Suppression, value: bool) → bool

Add or remove the given suppression.

Parameters

• suppression – Suppression to add or remove.

• value – True to add the suppression, False to remove it.

Returns

True if suppressions were changed, False otherwise.

class everyaction.objects.Phone(id_or_number: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Phone.

Properties

• countryCode (country_code, country)

• dateCreated (date_created, created)

• dialingPrefix (dialing_prefix, prefix)

• ext

• isCellStatus (is_cell_status, cell_status, is_cell)

• isPreferred (is_preferred, preferred)

• phoneId (phone_id, id)

• phoneNumber (phone_number, number)

• phoneOptInStatus (phone_opt_in_status, opt_in_status, optInStatus, opt_in)

• phoneType (phone_type, type)

• smsOptInStatus (sms_opt_in_status, sms_opt_in)

class everyaction.objects.PhonesFileAction(**kwargs: EAValue)

Represents a Phones File Action.

Properties

• Phone (phone)

• PhoneExt (phone_ext, ext)

• PhoneOptInStatus (phone_opt_in_status, opt_in_status, optInStatus, opt_in)

• PhoneSource (phone_source, source)

• PhoneType (phone_type, type)

• PreferredPhone (preferred_phone, preferred)

• SonarScore (sonar_score, sonar)

• VANID (van_id, vanid, van)

• actionType (action_type, type)

class everyaction.objects.Pledge(id: Optional[int] = None, **kwargs: EAValue)

Represents a Pledge object.

Properties

• pledgeId (pledge_id, id)

class everyaction.objects.PrintedList(name: Optional[str] = None, **kwargs: EAValue)

Represents a Printed List.

Properties

• name

• number

class everyaction.objects.ProgramType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Program Type.

Properties

• name

• programTypeId (program_type_id, id)

class everyaction.objects.Pronoun(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a pronoun.

Properties

• pronounId (preferred_pronoun_id, preferredPronounId, pronoun_id, id)

• pronounName (preferred_pronoun_name, preferredPronounName, pronoun_name, name)

class everyaction.objects.Registrant(**kwargs: EAValue)

Represents a Registrant for a Voter Registration Batch.

Properties

• alternateId (alternate_id, alternate, alt)

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

• person

class everyaction.objects.RegistrationForm(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Registration Form.

Properties

• formId (form_id, id)

• name

class everyaction.objects.RelationalMapping(**kwargs: EAValue)

Represents a Relational Mapping.

Properties

• fieldName (field_name, field)

• value

class everyaction.objects.Relationship(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Relationship.

Properties

• id

• name

• restrictToRelationshipContactMode (restrict_to_relationship_contact_mode, restrict_to_mode)

• restrictToReverseRelationshipContactMode (restrict_to_reverse_relationship_contact_mode, restrict_to_reverse_mode)

class everyaction.objects.ReportedEthnicity(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Reported Ethnicity.

Properties

• reportedEthnicityId (reported_ethnicity_id, id)

• reportedEthnicityName (reported_ethnicity_name, name)

class everyaction.objects.ReportedGender(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Reported Gender.

Properties

• reportedGenderId (reported_gender_id, id)

• reportedGenderName (reported_gender_name, name)

class everyaction.objects.ReportedLanguagePreference(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Reported Language Preference.

Properties

• reportedLanguagePreferenceId (reported_language_preference_id, id)

• reportedLanguagePreferenceName (reported_language_preference_name, name)

class everyaction.objects.ReportedRace(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Reported Race.

Properties

• reportedRaceId (reported_race_id, id)

• reportedRaceName (reported_race_name, name)

class everyaction.objects.ReportedSexualOrientation(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Reported Sexual Orientation.

Properties

• reportedSexualOrientationId (reported_sexual_orientation_id, id)

• reportedSexualOrientationName (reported_sexual_orientation_name, name)

class everyaction.objects.ResultCode(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Result Code.

Properties

• mediumName (medium_name, medium)

• name

• resultCodeId (result_code_id, id)

• resultOutcomeGroup (result_outcome_group, outcome_group)

• shortName (short_name, short)

class everyaction.objects.SavedList(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Saved List.

Properties

• description (desc)

• doorCount (door_count, door)

• listCount (list_count, list)

• name

• savedListId (saved_list_id, id)

class everyaction.objects.SavedListData(id: Optional[int] = None, **kwargs: EAValue)

Represents Saved List Data for Saved List Load actions.

Properties

• matchedRowsCount (matched_rows_count, matched_count, matched)

• originalRowCount (original_row_count, original_count, original)

• savedListId (saved_list_id, id)

• unmatchedRowsCount (unmatched_rows_count, unmatched_count, unmatched)

class everyaction.objects.SavedListLoadAction(**kwargs: EAValue)

Represents a Saved List Load action.

Properties

• actionType (action_type, type)

• folderId (folder_id, folder)

• listDescription (list_description, description, desc)

• listName (list_name, list, name)

• overwriteExistingListId (overwrite_existing_list_id, overwrite_existing_id, overwrite_id, overwrite)

• personIdColumn (person_id_column, id_column, id_col)

• personIdType (person_id_type, person_type)

class everyaction.objects.ScheduleType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Schedule Type.

Properties

• name

• scheduleTypeId (schedule_type_id, id)

class everyaction.objects.Score(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Score.

Properties

• description (desc)

• maxValue (max_value, max)

• minValue (min_value, min)

• name

• scoreId (score_id, id)

• shortName (short_name, short)

class everyaction.objects.ScoreApprovalCriteria(**kwargs: EAValue)

Represents Score Approval Criteria for Score Load actions.

Properties

• average

• tolerance (tolerance)

class everyaction.objects.ScoreLoadAction(**kwargs: EAValue)

Represents a Score Load Action.

Properties

• actionType (action_type, type)

• approvalCriteria (approval_criteria, criteria)

• personIdColumn (person_id_column, id_column, id_col)

• personIdType (person_id_type, person_type)

• scoreColumn (score_column, score_col)

• scoreId (score_id, score)

class everyaction.objects.ScoreUpdate(id: Optional[int] = None, **kwargs: EAValue)

Represents a Score Update.

Properties

• dateProcessed (date_processed, processed)

• loadStatus (load_status, status)

• score

• scoreUpdateId (score_update_id, id)

• updateStatistics (update_statistics, update_stats, statistics, stats)

class everyaction.objects.ScriptResponse(**kwargs: EAValue)

Represents a Script Response.

Properties

• type

class everyaction.objects.ShiftType(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Shift Type.

Properties

• defaultEndTime (default_end_time, default_end)

• defaultStartTime (default_start_time, default_start)

• name

• shiftTypeId (shift_type_id, id)

class everyaction.objects.Signup(id: Optional[int] = None, **kwargs: EAValue)

Represents a Signup.

Properties

• dateModified (date_modified, modified)

• endTimeOverride (end_time_override, end_override, end)

• event

• eventSignupId (event_signup_id, id)

• isOfflineSignup (is_offline_signup, offline_property, offline)

• location

• modifiedBy (modified_by, modifier)

• notes

• person

• role

• shift

• startTimeOverride (start_time_override, start_override, start)

• status

• supporterGroupId (supporter_group_id, supporter_group, group)

class everyaction.objects.Status(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Status in EveryAction. Used in multiple contexts.

Properties

• name

• statusId (status_id, id)

class everyaction.objects.Story(id: Optional[int] = None, **kwargs: EAValue)

Represents a Story.

Properties

• campaignId (campaign_id, campaign)

• storyId (story_id, id)

• storyStatus (story_status, status)

• storyText (story_text, text)

• tags (tag (singular))

• title

• vanId (van_id, van)

class everyaction.objects.StoryStatus(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a StoryStatus.

Properties

• statusName (status_name, status)

• storyStatusId (story_status_id, id)

class everyaction.objects.Subgroup(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Subgroup for a Target.

Properties

• fullName (full_name)

• isAssociatedWithBadges (is_associated_with_badges, associated_with_badges)

• name

• subgroupId (subgroup_id, id)

class everyaction.objects.SupportField(**kwargs: EAValue)

Represents a Support Field for a Voter Registration Batch.

Properties

• customPropertyKey (custom_property_key, property_key, custom_key, key)

• displayName (display_name, display)

• fieldType (field_type, field, type)

• maxFieldLength (max_field_length, max_length, max_len)

• possibleValues (possible_values, possible, possible_value (singular))

class everyaction.objects.SupportedEntity(name: Optional[str] = None, **kwargs: EAValue)

Represents a Supported Entity in the context of codes.

Properties

• isApplicable (is_applicable, applicable)

• isSearchable (is_searchable, searchable)

• name

class everyaction.objects.SupporterGroup(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Supporter Group.

Properties

• description (desc)

• id

• name

class everyaction.objects.Suppression(code_or_name: Optional[str] = None, **kwargs: EAValue)

Represents a Suppression.

Properties

• suppressionCode (suppression_code, code)

• suppressionName (suppression_name, name)

property no_call: bool

Indicates whether this is a “Do Not Call” suppression.

Returns

True if this is a “Do Not Call” suppression, False otherwise.

property no_email: bool

Indicates whether this is a “Do Not Email” suppression.

Returns

True if this is a “Do Not Email” suppression, False otherwise.

property no_mail: bool

Indicates whether this is a “Do Not Mail” suppression.

Returns

True if this is a “Do Not Mail” suppression, False otherwise.

property no_walk: bool

Indicate whether this is a “Do Not Walk” suppression.

Returns

True if this is a “Do Not Walk” suppression, False otherwise.

class everyaction.objects.SurveyCanvassResponse(surveyQuestionId: Optional[int] = None, surveyResponseId: Optional[int] = None, **kwargs: EAValue)

Represents a Survey Response in the context of a canvass response.

Properties

• mediumName (medium_name, medium)

• name

• shortName (short_name, short)

• surveyQuestionId (survey_question_id, question)

• surveyResponseId (survey_response_id, response)

• type

class everyaction.objects.SurveyQuestion(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Survey Question.

Properties

• cycle

• mediumName (medium_name, medium)

• name

• responses (response (singular))

• scriptQuestion (script_question, question)

• shortName (short_name, short)

• status

• surveyQuestionId (survey_question_id, id)

• type

class everyaction.objects.SurveyResponse(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Survey Response.

Properties

• mediumName (medium_name, medium)

• name

• shortName (short_name, short)

• surveyResponseId (survey_response_id, id)

class everyaction.objects.Target(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Target.

Properties

• areSubgroupsSticky (are_subgroups_sticky, sticky_subgroups, sticky_groups)

• description (desc)

• name

• points

• status

• subgroups (subgroup (singular))

• targetId (target_id, id)

• type

class everyaction.objects.TargetExportJob(id: Optional[int] = None, **kwargs: EAValue)

Represents a Target Export Job.

Properties

• exportJobId (export_job_id, id)

• file

• jobStatus (job_status, status)

• targetId (target_id, target)

• webhookUrl (webhook_url, webhook)

class everyaction.objects.UpdateStatistics(**kwargs: EAValue)

Represents an Update Statistics object.

class everyaction.objects.User(id: Optional[int] = None, **kwargs: EAValue)

Represents a VAN User.

Properties

• firstName (first_name, first)

• lastName (last_name, last)

• userId (user_id, id)

class everyaction.objects.ValueMappingData(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents data for an existing value mapping in the context of bulk import jobs.

Properties

• id

• name

• parents (parent (singular))

class everyaction.objects.VolunteerActivityResponse(id: Optional[int] = None, **kwargs: EAValue)

Represents a Volunteer Activity.

Properties

• action

• type

class everyaction.objects.VoterRegistrationBatch(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Voter Registration Batch.

Properties

• 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)

class everyaction.objects.WorkArea(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Work Area.

Properties

• name

• workAreaId (work_area_id, id)

class everyaction.objects.Worksite(id_or_name: Optional[Union[int, str]] = None, **kwargs: EAValue)

Represents a Worksite.

Properties

• address

• employer

• isPreferred (is_preferred, preferred)

• name

• workAreas (work_areas, work_area (singular))

• worksiteId (worksite_id, id)