Class: Google::Apis::CivicinfoV2::VoterInfoResponse

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/civicinfo_v2/classes.rb,
lib/google/apis/civicinfo_v2/representations.rb,
lib/google/apis/civicinfo_v2/representations.rb

Overview

The result of a voter info lookup query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VoterInfoResponse

Returns a new instance of VoterInfoResponse.



1240
1241
1242
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1240

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#contests ⇒ Array<Google::Apis::CivicinfoV2::Contest>

Contests that will appear on the voter's ballot. Corresponds to the JSON property contests

Returns:



1166
1167
1168
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1166

def contests
  @contests
end

#drop_off_locations ⇒ Array<Google::Apis::CivicinfoV2::PollingLocation>

Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field. Corresponds to the JSON property dropOffLocations

Returns:



1174
1175
1176
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1174

def drop_off_locations
  @drop_off_locations
end

#early_vote_sites ⇒ Array<Google::Apis::CivicinfoV2::PollingLocation>

Locations where the voter is eligible to vote early, prior to election day. Corresponds to the JSON property earlyVoteSites

Returns:



1179
1180
1181
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1179

def early_vote_sites
  @early_vote_sites
end

#election ⇒ Google::Apis::CivicinfoV2::Election

Information about the election that was queried. Corresponds to the JSON property election

Returns:



1184
1185
1186
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1184

def election
  @election
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "civicinfo# voterInfoResponse". Corresponds to the JSON property kind

Returns:

  • (String) 


1190
1191
1192
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1190

def kind
  @kind
end

#mail_only ⇒ Boolean Also known as: mail_only?

Specifies whether voters in the precinct vote only by mailing their ballots ( with the possible option of dropping off their ballots as well). Corresponds to the JSON property mailOnly

Returns:

  • (Boolean) 


1196
1197
1198
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1196

def mail_only
  @mail_only
end

#normalized_input ⇒ Google::Apis::CivicinfoV2::SimpleAddressType

A simple representation of an address. Corresponds to the JSON property normalizedInput

Returns:



1202
1203
1204
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1202

def normalized_input
  @normalized_input
end

#other_elections ⇒ Array<Google::Apis::CivicinfoV2::Election>

When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user. Corresponds to the JSON property otherElections

Returns:



1216
1217
1218
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1216

def other_elections
  @other_elections
end

#polling_locations ⇒ Array<Google::Apis::CivicinfoV2::PollingLocation>

Locations where the voter is eligible to vote on election day. Corresponds to the JSON property pollingLocations

Returns:



1221
1222
1223
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1221

def polling_locations
  @polling_locations
end

#precinct_id ⇒ String

Corresponds to the JSON property precinctId

Returns:

  • (String) 


1226
1227
1228
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1226

def precinct_id
  @precinct_id
end

#precincts ⇒ Array<Google::Apis::CivicinfoV2::Precinct>

The precincts that match this voter's address. Will only be returned for project IDs which have been allowlisted as "partner projects". Corresponds to the JSON property precincts

Returns:



1232
1233
1234
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1232

def precincts
  @precincts
end

#state ⇒ Array<Google::Apis::CivicinfoV2::AdministrationRegion>

Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array. Corresponds to the JSON property state

Returns:



1238
1239
1240
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1238

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/google/apis/civicinfo_v2/classes.rb', line 1245

def update!(**args)
  @contests = args[:contests] if args.key?(:contests)
  @drop_off_locations = args[:drop_off_locations] if args.key?(:drop_off_locations)
  @early_vote_sites = args[:early_vote_sites] if args.key?(:early_vote_sites)
  @election = args[:election] if args.key?(:election)
  @kind = args[:kind] if args.key?(:kind)
  @mail_only = args[:mail_only] if args.key?(:mail_only)
  @normalized_input = args[:normalized_input] if args.key?(:normalized_input)
  @other_elections = args[:other_elections] if args.key?(:other_elections)
  @polling_locations = args[:polling_locations] if args.key?(:polling_locations)
  @precinct_id = args[:precinct_id] if args.key?(:precinct_id)
  @precincts = args[:precincts] if args.key?(:precincts)
  @state = args[:state] if args.key?(:state)
end