google-apis-civicinfo_v2 0.23.0 → 0.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/lib/google/apis/civicinfo_v2/classes.rb +325 -300
- data/lib/google/apis/civicinfo_v2/gem_version.rb +3 -3
- data/lib/google/apis/civicinfo_v2/representations.rb +148 -132
- data/lib/google/apis/civicinfo_v2/service.rb +49 -20
- metadata +4 -7
@@ -22,19 +22,314 @@ module Google
|
|
22
22
|
module Apis
|
23
23
|
module CivicinfoV2
|
24
24
|
|
25
|
+
#
|
26
|
+
class CivicinfoApiprotosV2DivisionByAddressResponse
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
#
|
30
|
+
# Corresponds to the JSON property `divisions`
|
31
|
+
# @return [Hash<String,Google::Apis::CivicinfoV2::CivicinfoSchemaV2GeographicDivision>]
|
32
|
+
attr_accessor :divisions
|
33
|
+
|
34
|
+
# A simple representation of an address.
|
35
|
+
# Corresponds to the JSON property `normalizedInput`
|
36
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType]
|
37
|
+
attr_accessor :normalized_input
|
38
|
+
|
39
|
+
def initialize(**args)
|
40
|
+
update!(**args)
|
41
|
+
end
|
42
|
+
|
43
|
+
# Update properties of this object
|
44
|
+
def update!(**args)
|
45
|
+
@divisions = args[:divisions] if args.key?(:divisions)
|
46
|
+
@normalized_input = args[:normalized_input] if args.key?(:normalized_input)
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
# The result of a division search query.
|
51
|
+
class CivicinfoApiprotosV2DivisionSearchResponse
|
52
|
+
include Google::Apis::Core::Hashable
|
53
|
+
|
54
|
+
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
55
|
+
# divisionSearchResponse".
|
56
|
+
# Corresponds to the JSON property `kind`
|
57
|
+
# @return [String]
|
58
|
+
attr_accessor :kind
|
59
|
+
|
60
|
+
#
|
61
|
+
# Corresponds to the JSON property `results`
|
62
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoApiprotosV2DivisionSearchResult>]
|
63
|
+
attr_accessor :results
|
64
|
+
|
65
|
+
def initialize(**args)
|
66
|
+
update!(**args)
|
67
|
+
end
|
68
|
+
|
69
|
+
# Update properties of this object
|
70
|
+
def update!(**args)
|
71
|
+
@kind = args[:kind] if args.key?(:kind)
|
72
|
+
@results = args[:results] if args.key?(:results)
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
# Represents a political geographic division that matches the requested query.
|
77
|
+
class CivicinfoApiprotosV2DivisionSearchResult
|
78
|
+
include Google::Apis::Core::Hashable
|
79
|
+
|
80
|
+
# Other Open Civic Data identifiers that refer to the same division -- for
|
81
|
+
# example, those that refer to other political divisions whose boundaries are
|
82
|
+
# defined to be coterminous with this one. For example, ocd-division/country:us/
|
83
|
+
# state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since
|
84
|
+
# Wyoming has only one Congressional district.
|
85
|
+
# Corresponds to the JSON property `aliases`
|
86
|
+
# @return [Array<String>]
|
87
|
+
attr_accessor :aliases
|
88
|
+
|
89
|
+
# The name of the division.
|
90
|
+
# Corresponds to the JSON property `name`
|
91
|
+
# @return [String]
|
92
|
+
attr_accessor :name
|
93
|
+
|
94
|
+
# The unique Open Civic Data identifier for this division
|
95
|
+
# Corresponds to the JSON property `ocdId`
|
96
|
+
# @return [String]
|
97
|
+
attr_accessor :ocd_id
|
98
|
+
|
99
|
+
def initialize(**args)
|
100
|
+
update!(**args)
|
101
|
+
end
|
102
|
+
|
103
|
+
# Update properties of this object
|
104
|
+
def update!(**args)
|
105
|
+
@aliases = args[:aliases] if args.key?(:aliases)
|
106
|
+
@name = args[:name] if args.key?(:name)
|
107
|
+
@ocd_id = args[:ocd_id] if args.key?(:ocd_id)
|
108
|
+
end
|
109
|
+
end
|
110
|
+
|
111
|
+
# The list of elections available for this version of the API.
|
112
|
+
class CivicinfoApiprotosV2ElectionsQueryResponse
|
113
|
+
include Google::Apis::Core::Hashable
|
114
|
+
|
115
|
+
# A list of available elections
|
116
|
+
# Corresponds to the JSON property `elections`
|
117
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Election>]
|
118
|
+
attr_accessor :elections
|
119
|
+
|
120
|
+
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
121
|
+
# electionsQueryResponse".
|
122
|
+
# Corresponds to the JSON property `kind`
|
123
|
+
# @return [String]
|
124
|
+
attr_accessor :kind
|
125
|
+
|
126
|
+
def initialize(**args)
|
127
|
+
update!(**args)
|
128
|
+
end
|
129
|
+
|
130
|
+
# Update properties of this object
|
131
|
+
def update!(**args)
|
132
|
+
@elections = args[:elections] if args.key?(:elections)
|
133
|
+
@kind = args[:kind] if args.key?(:kind)
|
134
|
+
end
|
135
|
+
end
|
136
|
+
|
137
|
+
#
|
138
|
+
class CivicinfoApiprotosV2RepresentativeInfoData
|
139
|
+
include Google::Apis::Core::Hashable
|
140
|
+
|
141
|
+
# A map of political geographic divisions that contain the requested address,
|
142
|
+
# keyed by the unique Open Civic Data identifier for this division.
|
143
|
+
# Corresponds to the JSON property `divisions`
|
144
|
+
# @return [Hash<String,Google::Apis::CivicinfoV2::CivicinfoSchemaV2GeographicDivision>]
|
145
|
+
attr_accessor :divisions
|
146
|
+
|
147
|
+
# Elected offices referenced by the divisions listed above. Will only be present
|
148
|
+
# if includeOffices was true in the request.
|
149
|
+
# Corresponds to the JSON property `offices`
|
150
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Office>]
|
151
|
+
attr_accessor :offices
|
152
|
+
|
153
|
+
# Officials holding the offices listed above. Will only be present if
|
154
|
+
# includeOffices was true in the request.
|
155
|
+
# Corresponds to the JSON property `officials`
|
156
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Official>]
|
157
|
+
attr_accessor :officials
|
158
|
+
|
159
|
+
def initialize(**args)
|
160
|
+
update!(**args)
|
161
|
+
end
|
162
|
+
|
163
|
+
# Update properties of this object
|
164
|
+
def update!(**args)
|
165
|
+
@divisions = args[:divisions] if args.key?(:divisions)
|
166
|
+
@offices = args[:offices] if args.key?(:offices)
|
167
|
+
@officials = args[:officials] if args.key?(:officials)
|
168
|
+
end
|
169
|
+
end
|
170
|
+
|
171
|
+
# The result of a representative info lookup query.
|
172
|
+
class CivicinfoApiprotosV2RepresentativeInfoResponse
|
173
|
+
include Google::Apis::Core::Hashable
|
174
|
+
|
175
|
+
# A map of political geographic divisions that contain the requested address,
|
176
|
+
# keyed by the unique Open Civic Data identifier for this division.
|
177
|
+
# Corresponds to the JSON property `divisions`
|
178
|
+
# @return [Hash<String,Google::Apis::CivicinfoV2::CivicinfoSchemaV2GeographicDivision>]
|
179
|
+
attr_accessor :divisions
|
180
|
+
|
181
|
+
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
182
|
+
# representativeInfoResponse".
|
183
|
+
# Corresponds to the JSON property `kind`
|
184
|
+
# @return [String]
|
185
|
+
attr_accessor :kind
|
186
|
+
|
187
|
+
# A simple representation of an address.
|
188
|
+
# Corresponds to the JSON property `normalizedInput`
|
189
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType]
|
190
|
+
attr_accessor :normalized_input
|
191
|
+
|
192
|
+
# Elected offices referenced by the divisions listed above. Will only be present
|
193
|
+
# if includeOffices was true in the request.
|
194
|
+
# Corresponds to the JSON property `offices`
|
195
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Office>]
|
196
|
+
attr_accessor :offices
|
197
|
+
|
198
|
+
# Officials holding the offices listed above. Will only be present if
|
199
|
+
# includeOffices was true in the request.
|
200
|
+
# Corresponds to the JSON property `officials`
|
201
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Official>]
|
202
|
+
attr_accessor :officials
|
203
|
+
|
204
|
+
def initialize(**args)
|
205
|
+
update!(**args)
|
206
|
+
end
|
207
|
+
|
208
|
+
# Update properties of this object
|
209
|
+
def update!(**args)
|
210
|
+
@divisions = args[:divisions] if args.key?(:divisions)
|
211
|
+
@kind = args[:kind] if args.key?(:kind)
|
212
|
+
@normalized_input = args[:normalized_input] if args.key?(:normalized_input)
|
213
|
+
@offices = args[:offices] if args.key?(:offices)
|
214
|
+
@officials = args[:officials] if args.key?(:officials)
|
215
|
+
end
|
216
|
+
end
|
217
|
+
|
218
|
+
# The result of a voter info lookup query.
|
219
|
+
class CivicinfoApiprotosV2VoterInfoResponse
|
220
|
+
include Google::Apis::Core::Hashable
|
221
|
+
|
222
|
+
# Contests that will appear on the voter's ballot.
|
223
|
+
# Corresponds to the JSON property `contests`
|
224
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Contest>]
|
225
|
+
attr_accessor :contests
|
226
|
+
|
227
|
+
# Locations where a voter is eligible to drop off a completed ballot. The voter
|
228
|
+
# must have received and completed a ballot prior to arriving at the location.
|
229
|
+
# The location may not have ballots available on the premises. These locations
|
230
|
+
# could be open on or before election day as indicated in the pollingHours field.
|
231
|
+
# Corresponds to the JSON property `dropOffLocations`
|
232
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2PollingLocation>]
|
233
|
+
attr_accessor :drop_off_locations
|
234
|
+
|
235
|
+
# Locations where the voter is eligible to vote early, prior to election day.
|
236
|
+
# Corresponds to the JSON property `earlyVoteSites`
|
237
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2PollingLocation>]
|
238
|
+
attr_accessor :early_vote_sites
|
239
|
+
|
240
|
+
# Information about the election that was queried.
|
241
|
+
# Corresponds to the JSON property `election`
|
242
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2Election]
|
243
|
+
attr_accessor :election
|
244
|
+
|
245
|
+
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
246
|
+
# voterInfoResponse".
|
247
|
+
# Corresponds to the JSON property `kind`
|
248
|
+
# @return [String]
|
249
|
+
attr_accessor :kind
|
250
|
+
|
251
|
+
# Specifies whether voters in the precinct vote only by mailing their ballots (
|
252
|
+
# with the possible option of dropping off their ballots as well).
|
253
|
+
# Corresponds to the JSON property `mailOnly`
|
254
|
+
# @return [Boolean]
|
255
|
+
attr_accessor :mail_only
|
256
|
+
alias_method :mail_only?, :mail_only
|
257
|
+
|
258
|
+
# A simple representation of an address.
|
259
|
+
# Corresponds to the JSON property `normalizedInput`
|
260
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType]
|
261
|
+
attr_accessor :normalized_input
|
262
|
+
|
263
|
+
# When there are multiple elections for a voter address, the otherElections
|
264
|
+
# field is populated in the API response and there are two possibilities: 1. If
|
265
|
+
# the earliest election is not the intended election, specify the election ID of
|
266
|
+
# the desired election in a second API request using the electionId field. 2. If
|
267
|
+
# these elections occur on the same day, the API doesn?t return any polling
|
268
|
+
# location, contest, or election official information to ensure that an
|
269
|
+
# additional query is made. For user-facing applications, we recommend
|
270
|
+
# displaying these elections to the user to disambiguate. A second API request
|
271
|
+
# using the electionId field should be made for the election that is relevant to
|
272
|
+
# the user.
|
273
|
+
# Corresponds to the JSON property `otherElections`
|
274
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Election>]
|
275
|
+
attr_accessor :other_elections
|
276
|
+
|
277
|
+
# Locations where the voter is eligible to vote on election day.
|
278
|
+
# Corresponds to the JSON property `pollingLocations`
|
279
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2PollingLocation>]
|
280
|
+
attr_accessor :polling_locations
|
281
|
+
|
282
|
+
#
|
283
|
+
# Corresponds to the JSON property `precinctId`
|
284
|
+
# @return [String]
|
285
|
+
attr_accessor :precinct_id
|
286
|
+
|
287
|
+
# The precincts that match this voter's address. Will only be returned for
|
288
|
+
# project IDs which have been allowlisted as "partner projects".
|
289
|
+
# Corresponds to the JSON property `precincts`
|
290
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Precinct>]
|
291
|
+
attr_accessor :precincts
|
292
|
+
|
293
|
+
# Local Election Information for the state that the voter votes in. For the US,
|
294
|
+
# there will only be one element in this array.
|
295
|
+
# Corresponds to the JSON property `state`
|
296
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2AdministrationRegion>]
|
297
|
+
attr_accessor :state
|
298
|
+
|
299
|
+
def initialize(**args)
|
300
|
+
update!(**args)
|
301
|
+
end
|
302
|
+
|
303
|
+
# Update properties of this object
|
304
|
+
def update!(**args)
|
305
|
+
@contests = args[:contests] if args.key?(:contests)
|
306
|
+
@drop_off_locations = args[:drop_off_locations] if args.key?(:drop_off_locations)
|
307
|
+
@early_vote_sites = args[:early_vote_sites] if args.key?(:early_vote_sites)
|
308
|
+
@election = args[:election] if args.key?(:election)
|
309
|
+
@kind = args[:kind] if args.key?(:kind)
|
310
|
+
@mail_only = args[:mail_only] if args.key?(:mail_only)
|
311
|
+
@normalized_input = args[:normalized_input] if args.key?(:normalized_input)
|
312
|
+
@other_elections = args[:other_elections] if args.key?(:other_elections)
|
313
|
+
@polling_locations = args[:polling_locations] if args.key?(:polling_locations)
|
314
|
+
@precinct_id = args[:precinct_id] if args.key?(:precinct_id)
|
315
|
+
@precincts = args[:precincts] if args.key?(:precincts)
|
316
|
+
@state = args[:state] if args.key?(:state)
|
317
|
+
end
|
318
|
+
end
|
319
|
+
|
25
320
|
# Describes information about a regional election administrative area.
|
26
|
-
class
|
321
|
+
class CivicinfoSchemaV2AdministrationRegion
|
27
322
|
include Google::Apis::Core::Hashable
|
28
323
|
|
29
324
|
# Information about an election administrative body (e.g. County Board of
|
30
325
|
# Elections).
|
31
326
|
# Corresponds to the JSON property `electionAdministrationBody`
|
32
|
-
# @return [Google::Apis::CivicinfoV2::
|
327
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2AdministrativeBody]
|
33
328
|
attr_accessor :election_administration_body
|
34
329
|
|
35
330
|
# Describes information about a regional election administrative area.
|
36
331
|
# Corresponds to the JSON property `local_jurisdiction`
|
37
|
-
# @return [Google::Apis::CivicinfoV2::
|
332
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2AdministrationRegion]
|
38
333
|
attr_accessor :local_jurisdiction
|
39
334
|
|
40
335
|
# The name of the jurisdiction.
|
@@ -45,7 +340,7 @@ module Google
|
|
45
340
|
# A list of sources for this area. If multiple sources are listed the data has
|
46
341
|
# been aggregated from those sources.
|
47
342
|
# Corresponds to the JSON property `sources`
|
48
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
343
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Source>]
|
49
344
|
attr_accessor :sources
|
50
345
|
|
51
346
|
def initialize(**args)
|
@@ -63,7 +358,7 @@ module Google
|
|
63
358
|
|
64
359
|
# Information about an election administrative body (e.g. County Board of
|
65
360
|
# Elections).
|
66
|
-
class
|
361
|
+
class CivicinfoSchemaV2AdministrativeBody
|
67
362
|
include Google::Apis::Core::Hashable
|
68
363
|
|
69
364
|
# A URL provided by this administrative body for information on absentee voting.
|
@@ -79,7 +374,7 @@ module Google
|
|
79
374
|
|
80
375
|
# A simple representation of an address.
|
81
376
|
# Corresponds to the JSON property `correspondenceAddress`
|
82
|
-
# @return [Google::Apis::CivicinfoV2::
|
377
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType]
|
83
378
|
attr_accessor :correspondence_address
|
84
379
|
|
85
380
|
# A URL provided by this administrative body for looking up general election
|
@@ -102,7 +397,7 @@ module Google
|
|
102
397
|
|
103
398
|
# The election officials for this election administrative body.
|
104
399
|
# Corresponds to the JSON property `electionOfficials`
|
105
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
400
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2ElectionOfficial>]
|
106
401
|
attr_accessor :election_officials
|
107
402
|
|
108
403
|
# A URL provided by this administrative body for confirming that the voter is
|
@@ -135,7 +430,7 @@ module Google
|
|
135
430
|
|
136
431
|
# A simple representation of an address.
|
137
432
|
# Corresponds to the JSON property `physicalAddress`
|
138
|
-
# @return [Google::Apis::CivicinfoV2::
|
433
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType]
|
139
434
|
attr_accessor :physical_address
|
140
435
|
|
141
436
|
# A description of the services this administrative body may provide.
|
@@ -173,7 +468,7 @@ module Google
|
|
173
468
|
end
|
174
469
|
|
175
470
|
# Information about a candidate running for elected office.
|
176
|
-
class
|
471
|
+
class CivicinfoSchemaV2Candidate
|
177
472
|
include Google::Apis::Core::Hashable
|
178
473
|
|
179
474
|
# The URL for the candidate's campaign web site.
|
@@ -183,7 +478,7 @@ module Google
|
|
183
478
|
|
184
479
|
# A list of known (social) media channels for this candidate.
|
185
480
|
# Corresponds to the JSON property `channels`
|
186
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
481
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Channel>]
|
187
482
|
attr_accessor :channels
|
188
483
|
|
189
484
|
# The email address for the candidate's campaign.
|
@@ -236,7 +531,7 @@ module Google
|
|
236
531
|
end
|
237
532
|
|
238
533
|
# A social media or web channel for a candidate.
|
239
|
-
class
|
534
|
+
class CivicinfoSchemaV2Channel
|
240
535
|
include Google::Apis::Core::Hashable
|
241
536
|
|
242
537
|
# The unique public identifier for the candidate's channel.
|
@@ -263,7 +558,7 @@ module Google
|
|
263
558
|
end
|
264
559
|
|
265
560
|
# Information about a contest that appears on a voter's ballot.
|
266
|
-
class
|
561
|
+
class CivicinfoSchemaV2Contest
|
267
562
|
include Google::Apis::Core::Hashable
|
268
563
|
|
269
564
|
# A number specifying the position of this contest on the voter's ballot.
|
@@ -278,12 +573,12 @@ module Google
|
|
278
573
|
|
279
574
|
# The candidate choices for this contest.
|
280
575
|
# Corresponds to the JSON property `candidates`
|
281
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
576
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Candidate>]
|
282
577
|
attr_accessor :candidates
|
283
578
|
|
284
579
|
# Describes the geographic scope of a contest.
|
285
580
|
# Corresponds to the JSON property `district`
|
286
|
-
# @return [Google::Apis::CivicinfoV2::
|
581
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2ElectoralDistrict]
|
287
582
|
attr_accessor :district
|
288
583
|
|
289
584
|
# A description of any additional eligibility requirements for voting in this
|
@@ -392,7 +687,7 @@ module Google
|
|
392
687
|
# A list of sources for this contest. If multiple sources are listed, the data
|
393
688
|
# has been aggregated from those sources.
|
394
689
|
# Corresponds to the JSON property `sources`
|
395
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
690
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Source>]
|
396
691
|
attr_accessor :sources
|
397
692
|
|
398
693
|
# "Yes" or "No" depending on whether this a contest being held outside the
|
@@ -441,69 +736,8 @@ module Google
|
|
441
736
|
end
|
442
737
|
end
|
443
738
|
|
444
|
-
# The result of a division search query.
|
445
|
-
class SearchDivisionResponse
|
446
|
-
include Google::Apis::Core::Hashable
|
447
|
-
|
448
|
-
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
449
|
-
# divisionSearchResponse".
|
450
|
-
# Corresponds to the JSON property `kind`
|
451
|
-
# @return [String]
|
452
|
-
attr_accessor :kind
|
453
|
-
|
454
|
-
#
|
455
|
-
# Corresponds to the JSON property `results`
|
456
|
-
# @return [Array<Google::Apis::CivicinfoV2::DivisionSearchResult>]
|
457
|
-
attr_accessor :results
|
458
|
-
|
459
|
-
def initialize(**args)
|
460
|
-
update!(**args)
|
461
|
-
end
|
462
|
-
|
463
|
-
# Update properties of this object
|
464
|
-
def update!(**args)
|
465
|
-
@kind = args[:kind] if args.key?(:kind)
|
466
|
-
@results = args[:results] if args.key?(:results)
|
467
|
-
end
|
468
|
-
end
|
469
|
-
|
470
|
-
# Represents a political geographic division that matches the requested query.
|
471
|
-
class DivisionSearchResult
|
472
|
-
include Google::Apis::Core::Hashable
|
473
|
-
|
474
|
-
# Other Open Civic Data identifiers that refer to the same division -- for
|
475
|
-
# example, those that refer to other political divisions whose boundaries are
|
476
|
-
# defined to be coterminous with this one. For example, ocd-division/country:us/
|
477
|
-
# state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since
|
478
|
-
# Wyoming has only one Congressional district.
|
479
|
-
# Corresponds to the JSON property `aliases`
|
480
|
-
# @return [Array<String>]
|
481
|
-
attr_accessor :aliases
|
482
|
-
|
483
|
-
# The name of the division.
|
484
|
-
# Corresponds to the JSON property `name`
|
485
|
-
# @return [String]
|
486
|
-
attr_accessor :name
|
487
|
-
|
488
|
-
# The unique Open Civic Data identifier for this division
|
489
|
-
# Corresponds to the JSON property `ocdId`
|
490
|
-
# @return [String]
|
491
|
-
attr_accessor :ocd_id
|
492
|
-
|
493
|
-
def initialize(**args)
|
494
|
-
update!(**args)
|
495
|
-
end
|
496
|
-
|
497
|
-
# Update properties of this object
|
498
|
-
def update!(**args)
|
499
|
-
@aliases = args[:aliases] if args.key?(:aliases)
|
500
|
-
@name = args[:name] if args.key?(:name)
|
501
|
-
@ocd_id = args[:ocd_id] if args.key?(:ocd_id)
|
502
|
-
end
|
503
|
-
end
|
504
|
-
|
505
739
|
# Information about the election that was queried.
|
506
|
-
class
|
740
|
+
class CivicinfoSchemaV2Election
|
507
741
|
include Google::Apis::Core::Hashable
|
508
742
|
|
509
743
|
# Day of the election in YYYY-MM-DD format.
|
@@ -549,7 +783,7 @@ module Google
|
|
549
783
|
end
|
550
784
|
|
551
785
|
# Information about individual election officials.
|
552
|
-
class
|
786
|
+
class CivicinfoSchemaV2ElectionOfficial
|
553
787
|
include Google::Apis::Core::Hashable
|
554
788
|
|
555
789
|
# The email address of the election official.
|
@@ -591,34 +825,8 @@ module Google
|
|
591
825
|
end
|
592
826
|
end
|
593
827
|
|
594
|
-
# The list of elections available for this version of the API.
|
595
|
-
class QueryElectionsResponse
|
596
|
-
include Google::Apis::Core::Hashable
|
597
|
-
|
598
|
-
# A list of available elections
|
599
|
-
# Corresponds to the JSON property `elections`
|
600
|
-
# @return [Array<Google::Apis::CivicinfoV2::Election>]
|
601
|
-
attr_accessor :elections
|
602
|
-
|
603
|
-
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
604
|
-
# electionsQueryResponse".
|
605
|
-
# Corresponds to the JSON property `kind`
|
606
|
-
# @return [String]
|
607
|
-
attr_accessor :kind
|
608
|
-
|
609
|
-
def initialize(**args)
|
610
|
-
update!(**args)
|
611
|
-
end
|
612
|
-
|
613
|
-
# Update properties of this object
|
614
|
-
def update!(**args)
|
615
|
-
@elections = args[:elections] if args.key?(:elections)
|
616
|
-
@kind = args[:kind] if args.key?(:kind)
|
617
|
-
end
|
618
|
-
end
|
619
|
-
|
620
828
|
# Describes the geographic scope of a contest.
|
621
|
-
class
|
829
|
+
class CivicinfoSchemaV2ElectoralDistrict
|
622
830
|
include Google::Apis::Core::Hashable
|
623
831
|
|
624
832
|
# An identifier for this district, relative to its scope. For example, the 34th
|
@@ -653,7 +861,7 @@ module Google
|
|
653
861
|
end
|
654
862
|
|
655
863
|
# Describes a political geography.
|
656
|
-
class
|
864
|
+
class CivicinfoSchemaV2GeographicDivision
|
657
865
|
include Google::Apis::Core::Hashable
|
658
866
|
|
659
867
|
# Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs
|
@@ -693,7 +901,7 @@ module Google
|
|
693
901
|
end
|
694
902
|
|
695
903
|
# Information about an Office held by one or more Officials.
|
696
|
-
class
|
904
|
+
class CivicinfoSchemaV2Office
|
697
905
|
include Google::Apis::Core::Hashable
|
698
906
|
|
699
907
|
# The OCD ID of the division with which this office is associated.
|
@@ -732,7 +940,7 @@ module Google
|
|
732
940
|
# A list of sources for this office. If multiple sources are listed, the data
|
733
941
|
# has been aggregated from those sources.
|
734
942
|
# Corresponds to the JSON property `sources`
|
735
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
943
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Source>]
|
736
944
|
attr_accessor :sources
|
737
945
|
|
738
946
|
def initialize(**args)
|
@@ -751,17 +959,17 @@ module Google
|
|
751
959
|
end
|
752
960
|
|
753
961
|
# Information about a person holding an elected office.
|
754
|
-
class
|
962
|
+
class CivicinfoSchemaV2Official
|
755
963
|
include Google::Apis::Core::Hashable
|
756
964
|
|
757
965
|
# Addresses at which to contact the official.
|
758
966
|
# Corresponds to the JSON property `address`
|
759
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
967
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType>]
|
760
968
|
attr_accessor :address
|
761
969
|
|
762
970
|
# A list of known (social) media channels for this official.
|
763
971
|
# Corresponds to the JSON property `channels`
|
764
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
972
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Channel>]
|
765
973
|
attr_accessor :channels
|
766
974
|
|
767
975
|
# The direct email addresses for the official.
|
@@ -813,12 +1021,12 @@ module Google
|
|
813
1021
|
|
814
1022
|
# A location where a voter can vote. This may be an early vote site, an election
|
815
1023
|
# day voting location, or a drop off location for a completed ballot.
|
816
|
-
class
|
1024
|
+
class CivicinfoSchemaV2PollingLocation
|
817
1025
|
include Google::Apis::Core::Hashable
|
818
1026
|
|
819
1027
|
# A simple representation of an address.
|
820
1028
|
# Corresponds to the JSON property `address`
|
821
|
-
# @return [Google::Apis::CivicinfoV2::
|
1029
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType]
|
822
1030
|
attr_accessor :address
|
823
1031
|
|
824
1032
|
# The last date that this early vote site or drop off location may be used. This
|
@@ -858,7 +1066,7 @@ module Google
|
|
858
1066
|
# A list of sources for this location. If multiple sources are listed the data
|
859
1067
|
# has been aggregated from those sources.
|
860
1068
|
# Corresponds to the JSON property `sources`
|
861
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
1069
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Source>]
|
862
1070
|
attr_accessor :sources
|
863
1071
|
|
864
1072
|
# The first date that this early vote site or drop off location may be used.
|
@@ -893,7 +1101,7 @@ module Google
|
|
893
1101
|
end
|
894
1102
|
|
895
1103
|
#
|
896
|
-
class
|
1104
|
+
class CivicinfoSchemaV2Precinct
|
897
1105
|
include Google::Apis::Core::Hashable
|
898
1106
|
|
899
1107
|
# ID of the AdministrationRegion message for this precinct. Corresponds to
|
@@ -994,89 +1202,8 @@ module Google
|
|
994
1202
|
end
|
995
1203
|
end
|
996
1204
|
|
997
|
-
#
|
998
|
-
class RepresentativeInfoData
|
999
|
-
include Google::Apis::Core::Hashable
|
1000
|
-
|
1001
|
-
# A map of political geographic divisions that contain the requested address,
|
1002
|
-
# keyed by the unique Open Civic Data identifier for this division.
|
1003
|
-
# Corresponds to the JSON property `divisions`
|
1004
|
-
# @return [Hash<String,Google::Apis::CivicinfoV2::GeographicDivision>]
|
1005
|
-
attr_accessor :divisions
|
1006
|
-
|
1007
|
-
# Elected offices referenced by the divisions listed above. Will only be present
|
1008
|
-
# if includeOffices was true in the request.
|
1009
|
-
# Corresponds to the JSON property `offices`
|
1010
|
-
# @return [Array<Google::Apis::CivicinfoV2::Office>]
|
1011
|
-
attr_accessor :offices
|
1012
|
-
|
1013
|
-
# Officials holding the offices listed above. Will only be present if
|
1014
|
-
# includeOffices was true in the request.
|
1015
|
-
# Corresponds to the JSON property `officials`
|
1016
|
-
# @return [Array<Google::Apis::CivicinfoV2::Official>]
|
1017
|
-
attr_accessor :officials
|
1018
|
-
|
1019
|
-
def initialize(**args)
|
1020
|
-
update!(**args)
|
1021
|
-
end
|
1022
|
-
|
1023
|
-
# Update properties of this object
|
1024
|
-
def update!(**args)
|
1025
|
-
@divisions = args[:divisions] if args.key?(:divisions)
|
1026
|
-
@offices = args[:offices] if args.key?(:offices)
|
1027
|
-
@officials = args[:officials] if args.key?(:officials)
|
1028
|
-
end
|
1029
|
-
end
|
1030
|
-
|
1031
|
-
# The result of a representative info lookup query.
|
1032
|
-
class RepresentativeInfoResponse
|
1033
|
-
include Google::Apis::Core::Hashable
|
1034
|
-
|
1035
|
-
# A map of political geographic divisions that contain the requested address,
|
1036
|
-
# keyed by the unique Open Civic Data identifier for this division.
|
1037
|
-
# Corresponds to the JSON property `divisions`
|
1038
|
-
# @return [Hash<String,Google::Apis::CivicinfoV2::GeographicDivision>]
|
1039
|
-
attr_accessor :divisions
|
1040
|
-
|
1041
|
-
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
1042
|
-
# representativeInfoResponse".
|
1043
|
-
# Corresponds to the JSON property `kind`
|
1044
|
-
# @return [String]
|
1045
|
-
attr_accessor :kind
|
1046
|
-
|
1047
|
-
# A simple representation of an address.
|
1048
|
-
# Corresponds to the JSON property `normalizedInput`
|
1049
|
-
# @return [Google::Apis::CivicinfoV2::SimpleAddressType]
|
1050
|
-
attr_accessor :normalized_input
|
1051
|
-
|
1052
|
-
# Elected offices referenced by the divisions listed above. Will only be present
|
1053
|
-
# if includeOffices was true in the request.
|
1054
|
-
# Corresponds to the JSON property `offices`
|
1055
|
-
# @return [Array<Google::Apis::CivicinfoV2::Office>]
|
1056
|
-
attr_accessor :offices
|
1057
|
-
|
1058
|
-
# Officials holding the offices listed above. Will only be present if
|
1059
|
-
# includeOffices was true in the request.
|
1060
|
-
# Corresponds to the JSON property `officials`
|
1061
|
-
# @return [Array<Google::Apis::CivicinfoV2::Official>]
|
1062
|
-
attr_accessor :officials
|
1063
|
-
|
1064
|
-
def initialize(**args)
|
1065
|
-
update!(**args)
|
1066
|
-
end
|
1067
|
-
|
1068
|
-
# Update properties of this object
|
1069
|
-
def update!(**args)
|
1070
|
-
@divisions = args[:divisions] if args.key?(:divisions)
|
1071
|
-
@kind = args[:kind] if args.key?(:kind)
|
1072
|
-
@normalized_input = args[:normalized_input] if args.key?(:normalized_input)
|
1073
|
-
@offices = args[:offices] if args.key?(:offices)
|
1074
|
-
@officials = args[:officials] if args.key?(:officials)
|
1075
|
-
end
|
1076
|
-
end
|
1077
|
-
|
1078
1205
|
# A simple representation of an address.
|
1079
|
-
class
|
1206
|
+
class CivicinfoSchemaV2SimpleAddressType
|
1080
1207
|
include Google::Apis::Core::Hashable
|
1081
1208
|
|
1082
1209
|
# The city or town for the address.
|
@@ -1131,7 +1258,7 @@ module Google
|
|
1131
1258
|
end
|
1132
1259
|
|
1133
1260
|
# Contains information about the data source for the element containing it.
|
1134
|
-
class
|
1261
|
+
class CivicinfoSchemaV2Source
|
1135
1262
|
include Google::Apis::Core::Hashable
|
1136
1263
|
|
1137
1264
|
# The name of the data source.
|
@@ -1155,108 +1282,6 @@ module Google
|
|
1155
1282
|
@official = args[:official] if args.key?(:official)
|
1156
1283
|
end
|
1157
1284
|
end
|
1158
|
-
|
1159
|
-
# The result of a voter info lookup query.
|
1160
|
-
class VoterInfoResponse
|
1161
|
-
include Google::Apis::Core::Hashable
|
1162
|
-
|
1163
|
-
# Contests that will appear on the voter's ballot.
|
1164
|
-
# Corresponds to the JSON property `contests`
|
1165
|
-
# @return [Array<Google::Apis::CivicinfoV2::Contest>]
|
1166
|
-
attr_accessor :contests
|
1167
|
-
|
1168
|
-
# Locations where a voter is eligible to drop off a completed ballot. The voter
|
1169
|
-
# must have received and completed a ballot prior to arriving at the location.
|
1170
|
-
# The location may not have ballots available on the premises. These locations
|
1171
|
-
# could be open on or before election day as indicated in the pollingHours field.
|
1172
|
-
# Corresponds to the JSON property `dropOffLocations`
|
1173
|
-
# @return [Array<Google::Apis::CivicinfoV2::PollingLocation>]
|
1174
|
-
attr_accessor :drop_off_locations
|
1175
|
-
|
1176
|
-
# Locations where the voter is eligible to vote early, prior to election day.
|
1177
|
-
# Corresponds to the JSON property `earlyVoteSites`
|
1178
|
-
# @return [Array<Google::Apis::CivicinfoV2::PollingLocation>]
|
1179
|
-
attr_accessor :early_vote_sites
|
1180
|
-
|
1181
|
-
# Information about the election that was queried.
|
1182
|
-
# Corresponds to the JSON property `election`
|
1183
|
-
# @return [Google::Apis::CivicinfoV2::Election]
|
1184
|
-
attr_accessor :election
|
1185
|
-
|
1186
|
-
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
1187
|
-
# voterInfoResponse".
|
1188
|
-
# Corresponds to the JSON property `kind`
|
1189
|
-
# @return [String]
|
1190
|
-
attr_accessor :kind
|
1191
|
-
|
1192
|
-
# Specifies whether voters in the precinct vote only by mailing their ballots (
|
1193
|
-
# with the possible option of dropping off their ballots as well).
|
1194
|
-
# Corresponds to the JSON property `mailOnly`
|
1195
|
-
# @return [Boolean]
|
1196
|
-
attr_accessor :mail_only
|
1197
|
-
alias_method :mail_only?, :mail_only
|
1198
|
-
|
1199
|
-
# A simple representation of an address.
|
1200
|
-
# Corresponds to the JSON property `normalizedInput`
|
1201
|
-
# @return [Google::Apis::CivicinfoV2::SimpleAddressType]
|
1202
|
-
attr_accessor :normalized_input
|
1203
|
-
|
1204
|
-
# When there are multiple elections for a voter address, the otherElections
|
1205
|
-
# field is populated in the API response and there are two possibilities: 1. If
|
1206
|
-
# the earliest election is not the intended election, specify the election ID of
|
1207
|
-
# the desired election in a second API request using the electionId field. 2. If
|
1208
|
-
# these elections occur on the same day, the API doesn?t return any polling
|
1209
|
-
# location, contest, or election official information to ensure that an
|
1210
|
-
# additional query is made. For user-facing applications, we recommend
|
1211
|
-
# displaying these elections to the user to disambiguate. A second API request
|
1212
|
-
# using the electionId field should be made for the election that is relevant to
|
1213
|
-
# the user.
|
1214
|
-
# Corresponds to the JSON property `otherElections`
|
1215
|
-
# @return [Array<Google::Apis::CivicinfoV2::Election>]
|
1216
|
-
attr_accessor :other_elections
|
1217
|
-
|
1218
|
-
# Locations where the voter is eligible to vote on election day.
|
1219
|
-
# Corresponds to the JSON property `pollingLocations`
|
1220
|
-
# @return [Array<Google::Apis::CivicinfoV2::PollingLocation>]
|
1221
|
-
attr_accessor :polling_locations
|
1222
|
-
|
1223
|
-
#
|
1224
|
-
# Corresponds to the JSON property `precinctId`
|
1225
|
-
# @return [String]
|
1226
|
-
attr_accessor :precinct_id
|
1227
|
-
|
1228
|
-
# The precincts that match this voter's address. Will only be returned for
|
1229
|
-
# project IDs which have been allowlisted as "partner projects".
|
1230
|
-
# Corresponds to the JSON property `precincts`
|
1231
|
-
# @return [Array<Google::Apis::CivicinfoV2::Precinct>]
|
1232
|
-
attr_accessor :precincts
|
1233
|
-
|
1234
|
-
# Local Election Information for the state that the voter votes in. For the US,
|
1235
|
-
# there will only be one element in this array.
|
1236
|
-
# Corresponds to the JSON property `state`
|
1237
|
-
# @return [Array<Google::Apis::CivicinfoV2::AdministrationRegion>]
|
1238
|
-
attr_accessor :state
|
1239
|
-
|
1240
|
-
def initialize(**args)
|
1241
|
-
update!(**args)
|
1242
|
-
end
|
1243
|
-
|
1244
|
-
# Update properties of this object
|
1245
|
-
def update!(**args)
|
1246
|
-
@contests = args[:contests] if args.key?(:contests)
|
1247
|
-
@drop_off_locations = args[:drop_off_locations] if args.key?(:drop_off_locations)
|
1248
|
-
@early_vote_sites = args[:early_vote_sites] if args.key?(:early_vote_sites)
|
1249
|
-
@election = args[:election] if args.key?(:election)
|
1250
|
-
@kind = args[:kind] if args.key?(:kind)
|
1251
|
-
@mail_only = args[:mail_only] if args.key?(:mail_only)
|
1252
|
-
@normalized_input = args[:normalized_input] if args.key?(:normalized_input)
|
1253
|
-
@other_elections = args[:other_elections] if args.key?(:other_elections)
|
1254
|
-
@polling_locations = args[:polling_locations] if args.key?(:polling_locations)
|
1255
|
-
@precinct_id = args[:precinct_id] if args.key?(:precinct_id)
|
1256
|
-
@precincts = args[:precincts] if args.key?(:precincts)
|
1257
|
-
@state = args[:state] if args.key?(:state)
|
1258
|
-
end
|
1259
|
-
end
|
1260
1285
|
end
|
1261
1286
|
end
|
1262
1287
|
end
|