google-apis-civicinfo_v2 0.24.0 → 0.26.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/OVERVIEW.md +1 -1
- data/lib/google/apis/civicinfo_v2/classes.rb +239 -439
- data/lib/google/apis/civicinfo_v2/gem_version.rb +3 -3
- data/lib/google/apis/civicinfo_v2/representations.rb +95 -175
- data/lib/google/apis/civicinfo_v2/service.rb +16 -107
- metadata +5 -8
|
@@ -22,19 +22,233 @@ 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
|
+
# The result of a voter info lookup query.
|
|
138
|
+
class CivicinfoApiprotosV2VoterInfoResponse
|
|
139
|
+
include Google::Apis::Core::Hashable
|
|
140
|
+
|
|
141
|
+
# Contests that will appear on the voter's ballot.
|
|
142
|
+
# Corresponds to the JSON property `contests`
|
|
143
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Contest>]
|
|
144
|
+
attr_accessor :contests
|
|
145
|
+
|
|
146
|
+
# Locations where a voter is eligible to drop off a completed ballot. The voter
|
|
147
|
+
# must have received and completed a ballot prior to arriving at the location.
|
|
148
|
+
# The location may not have ballots available on the premises. These locations
|
|
149
|
+
# could be open on or before election day as indicated in the pollingHours field.
|
|
150
|
+
# Corresponds to the JSON property `dropOffLocations`
|
|
151
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2PollingLocation>]
|
|
152
|
+
attr_accessor :drop_off_locations
|
|
153
|
+
|
|
154
|
+
# Locations where the voter is eligible to vote early, prior to election day.
|
|
155
|
+
# Corresponds to the JSON property `earlyVoteSites`
|
|
156
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2PollingLocation>]
|
|
157
|
+
attr_accessor :early_vote_sites
|
|
158
|
+
|
|
159
|
+
# Information about the election that was queried.
|
|
160
|
+
# Corresponds to the JSON property `election`
|
|
161
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2Election]
|
|
162
|
+
attr_accessor :election
|
|
163
|
+
|
|
164
|
+
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
|
165
|
+
# voterInfoResponse".
|
|
166
|
+
# Corresponds to the JSON property `kind`
|
|
167
|
+
# @return [String]
|
|
168
|
+
attr_accessor :kind
|
|
169
|
+
|
|
170
|
+
# Specifies whether voters in the precinct vote only by mailing their ballots (
|
|
171
|
+
# with the possible option of dropping off their ballots as well).
|
|
172
|
+
# Corresponds to the JSON property `mailOnly`
|
|
173
|
+
# @return [Boolean]
|
|
174
|
+
attr_accessor :mail_only
|
|
175
|
+
alias_method :mail_only?, :mail_only
|
|
176
|
+
|
|
177
|
+
# A simple representation of an address.
|
|
178
|
+
# Corresponds to the JSON property `normalizedInput`
|
|
179
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType]
|
|
180
|
+
attr_accessor :normalized_input
|
|
181
|
+
|
|
182
|
+
# When there are multiple elections for a voter address, the otherElections
|
|
183
|
+
# field is populated in the API response and there are two possibilities: 1. If
|
|
184
|
+
# the earliest election is not the intended election, specify the election ID of
|
|
185
|
+
# the desired election in a second API request using the electionId field. 2. If
|
|
186
|
+
# these elections occur on the same day, the API doesn?t return any polling
|
|
187
|
+
# location, contest, or election official information to ensure that an
|
|
188
|
+
# additional query is made. For user-facing applications, we recommend
|
|
189
|
+
# displaying these elections to the user to disambiguate. A second API request
|
|
190
|
+
# using the electionId field should be made for the election that is relevant to
|
|
191
|
+
# the user.
|
|
192
|
+
# Corresponds to the JSON property `otherElections`
|
|
193
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Election>]
|
|
194
|
+
attr_accessor :other_elections
|
|
195
|
+
|
|
196
|
+
# Locations where the voter is eligible to vote on election day.
|
|
197
|
+
# Corresponds to the JSON property `pollingLocations`
|
|
198
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2PollingLocation>]
|
|
199
|
+
attr_accessor :polling_locations
|
|
200
|
+
|
|
201
|
+
#
|
|
202
|
+
# Corresponds to the JSON property `precinctId`
|
|
203
|
+
# @return [String]
|
|
204
|
+
attr_accessor :precinct_id
|
|
205
|
+
|
|
206
|
+
# The precincts that match this voter's address. Will only be returned for
|
|
207
|
+
# project IDs which have been allowlisted as "partner projects".
|
|
208
|
+
# Corresponds to the JSON property `precincts`
|
|
209
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Precinct>]
|
|
210
|
+
attr_accessor :precincts
|
|
211
|
+
|
|
212
|
+
# Local Election Information for the state that the voter votes in. For the US,
|
|
213
|
+
# there will only be one element in this array.
|
|
214
|
+
# Corresponds to the JSON property `state`
|
|
215
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2AdministrationRegion>]
|
|
216
|
+
attr_accessor :state
|
|
217
|
+
|
|
218
|
+
def initialize(**args)
|
|
219
|
+
update!(**args)
|
|
220
|
+
end
|
|
221
|
+
|
|
222
|
+
# Update properties of this object
|
|
223
|
+
def update!(**args)
|
|
224
|
+
@contests = args[:contests] if args.key?(:contests)
|
|
225
|
+
@drop_off_locations = args[:drop_off_locations] if args.key?(:drop_off_locations)
|
|
226
|
+
@early_vote_sites = args[:early_vote_sites] if args.key?(:early_vote_sites)
|
|
227
|
+
@election = args[:election] if args.key?(:election)
|
|
228
|
+
@kind = args[:kind] if args.key?(:kind)
|
|
229
|
+
@mail_only = args[:mail_only] if args.key?(:mail_only)
|
|
230
|
+
@normalized_input = args[:normalized_input] if args.key?(:normalized_input)
|
|
231
|
+
@other_elections = args[:other_elections] if args.key?(:other_elections)
|
|
232
|
+
@polling_locations = args[:polling_locations] if args.key?(:polling_locations)
|
|
233
|
+
@precinct_id = args[:precinct_id] if args.key?(:precinct_id)
|
|
234
|
+
@precincts = args[:precincts] if args.key?(:precincts)
|
|
235
|
+
@state = args[:state] if args.key?(:state)
|
|
236
|
+
end
|
|
237
|
+
end
|
|
238
|
+
|
|
25
239
|
# Describes information about a regional election administrative area.
|
|
26
|
-
class
|
|
240
|
+
class CivicinfoSchemaV2AdministrationRegion
|
|
27
241
|
include Google::Apis::Core::Hashable
|
|
28
242
|
|
|
29
243
|
# Information about an election administrative body (e.g. County Board of
|
|
30
244
|
# Elections).
|
|
31
245
|
# Corresponds to the JSON property `electionAdministrationBody`
|
|
32
|
-
# @return [Google::Apis::CivicinfoV2::
|
|
246
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2AdministrativeBody]
|
|
33
247
|
attr_accessor :election_administration_body
|
|
34
248
|
|
|
35
249
|
# Describes information about a regional election administrative area.
|
|
36
250
|
# Corresponds to the JSON property `local_jurisdiction`
|
|
37
|
-
# @return [Google::Apis::CivicinfoV2::
|
|
251
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2AdministrationRegion]
|
|
38
252
|
attr_accessor :local_jurisdiction
|
|
39
253
|
|
|
40
254
|
# The name of the jurisdiction.
|
|
@@ -45,7 +259,7 @@ module Google
|
|
|
45
259
|
# A list of sources for this area. If multiple sources are listed the data has
|
|
46
260
|
# been aggregated from those sources.
|
|
47
261
|
# Corresponds to the JSON property `sources`
|
|
48
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
|
262
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Source>]
|
|
49
263
|
attr_accessor :sources
|
|
50
264
|
|
|
51
265
|
def initialize(**args)
|
|
@@ -63,7 +277,7 @@ module Google
|
|
|
63
277
|
|
|
64
278
|
# Information about an election administrative body (e.g. County Board of
|
|
65
279
|
# Elections).
|
|
66
|
-
class
|
|
280
|
+
class CivicinfoSchemaV2AdministrativeBody
|
|
67
281
|
include Google::Apis::Core::Hashable
|
|
68
282
|
|
|
69
283
|
# A URL provided by this administrative body for information on absentee voting.
|
|
@@ -79,7 +293,7 @@ module Google
|
|
|
79
293
|
|
|
80
294
|
# A simple representation of an address.
|
|
81
295
|
# Corresponds to the JSON property `correspondenceAddress`
|
|
82
|
-
# @return [Google::Apis::CivicinfoV2::
|
|
296
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType]
|
|
83
297
|
attr_accessor :correspondence_address
|
|
84
298
|
|
|
85
299
|
# A URL provided by this administrative body for looking up general election
|
|
@@ -102,7 +316,7 @@ module Google
|
|
|
102
316
|
|
|
103
317
|
# The election officials for this election administrative body.
|
|
104
318
|
# Corresponds to the JSON property `electionOfficials`
|
|
105
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
|
319
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2ElectionOfficial>]
|
|
106
320
|
attr_accessor :election_officials
|
|
107
321
|
|
|
108
322
|
# A URL provided by this administrative body for confirming that the voter is
|
|
@@ -135,7 +349,7 @@ module Google
|
|
|
135
349
|
|
|
136
350
|
# A simple representation of an address.
|
|
137
351
|
# Corresponds to the JSON property `physicalAddress`
|
|
138
|
-
# @return [Google::Apis::CivicinfoV2::
|
|
352
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType]
|
|
139
353
|
attr_accessor :physical_address
|
|
140
354
|
|
|
141
355
|
# A description of the services this administrative body may provide.
|
|
@@ -173,7 +387,7 @@ module Google
|
|
|
173
387
|
end
|
|
174
388
|
|
|
175
389
|
# Information about a candidate running for elected office.
|
|
176
|
-
class
|
|
390
|
+
class CivicinfoSchemaV2Candidate
|
|
177
391
|
include Google::Apis::Core::Hashable
|
|
178
392
|
|
|
179
393
|
# The URL for the candidate's campaign web site.
|
|
@@ -183,7 +397,7 @@ module Google
|
|
|
183
397
|
|
|
184
398
|
# A list of known (social) media channels for this candidate.
|
|
185
399
|
# Corresponds to the JSON property `channels`
|
|
186
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
|
400
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Channel>]
|
|
187
401
|
attr_accessor :channels
|
|
188
402
|
|
|
189
403
|
# The email address for the candidate's campaign.
|
|
@@ -236,7 +450,7 @@ module Google
|
|
|
236
450
|
end
|
|
237
451
|
|
|
238
452
|
# A social media or web channel for a candidate.
|
|
239
|
-
class
|
|
453
|
+
class CivicinfoSchemaV2Channel
|
|
240
454
|
include Google::Apis::Core::Hashable
|
|
241
455
|
|
|
242
456
|
# The unique public identifier for the candidate's channel.
|
|
@@ -263,7 +477,7 @@ module Google
|
|
|
263
477
|
end
|
|
264
478
|
|
|
265
479
|
# Information about a contest that appears on a voter's ballot.
|
|
266
|
-
class
|
|
480
|
+
class CivicinfoSchemaV2Contest
|
|
267
481
|
include Google::Apis::Core::Hashable
|
|
268
482
|
|
|
269
483
|
# A number specifying the position of this contest on the voter's ballot.
|
|
@@ -278,12 +492,12 @@ module Google
|
|
|
278
492
|
|
|
279
493
|
# The candidate choices for this contest.
|
|
280
494
|
# Corresponds to the JSON property `candidates`
|
|
281
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
|
495
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Candidate>]
|
|
282
496
|
attr_accessor :candidates
|
|
283
497
|
|
|
284
498
|
# Describes the geographic scope of a contest.
|
|
285
499
|
# Corresponds to the JSON property `district`
|
|
286
|
-
# @return [Google::Apis::CivicinfoV2::
|
|
500
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2ElectoralDistrict]
|
|
287
501
|
attr_accessor :district
|
|
288
502
|
|
|
289
503
|
# A description of any additional eligibility requirements for voting in this
|
|
@@ -392,7 +606,7 @@ module Google
|
|
|
392
606
|
# A list of sources for this contest. If multiple sources are listed, the data
|
|
393
607
|
# has been aggregated from those sources.
|
|
394
608
|
# Corresponds to the JSON property `sources`
|
|
395
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
|
609
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Source>]
|
|
396
610
|
attr_accessor :sources
|
|
397
611
|
|
|
398
612
|
# "Yes" or "No" depending on whether this a contest being held outside the
|
|
@@ -441,94 +655,8 @@ module Google
|
|
|
441
655
|
end
|
|
442
656
|
end
|
|
443
657
|
|
|
444
|
-
#
|
|
445
|
-
class DivisionByAddressResponse
|
|
446
|
-
include Google::Apis::Core::Hashable
|
|
447
|
-
|
|
448
|
-
#
|
|
449
|
-
# Corresponds to the JSON property `divisions`
|
|
450
|
-
# @return [Hash<String,Google::Apis::CivicinfoV2::GeographicDivision>]
|
|
451
|
-
attr_accessor :divisions
|
|
452
|
-
|
|
453
|
-
# A simple representation of an address.
|
|
454
|
-
# Corresponds to the JSON property `normalizedInput`
|
|
455
|
-
# @return [Google::Apis::CivicinfoV2::SimpleAddressType]
|
|
456
|
-
attr_accessor :normalized_input
|
|
457
|
-
|
|
458
|
-
def initialize(**args)
|
|
459
|
-
update!(**args)
|
|
460
|
-
end
|
|
461
|
-
|
|
462
|
-
# Update properties of this object
|
|
463
|
-
def update!(**args)
|
|
464
|
-
@divisions = args[:divisions] if args.key?(:divisions)
|
|
465
|
-
@normalized_input = args[:normalized_input] if args.key?(:normalized_input)
|
|
466
|
-
end
|
|
467
|
-
end
|
|
468
|
-
|
|
469
|
-
# The result of a division search query.
|
|
470
|
-
class SearchDivisionResponse
|
|
471
|
-
include Google::Apis::Core::Hashable
|
|
472
|
-
|
|
473
|
-
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
|
474
|
-
# divisionSearchResponse".
|
|
475
|
-
# Corresponds to the JSON property `kind`
|
|
476
|
-
# @return [String]
|
|
477
|
-
attr_accessor :kind
|
|
478
|
-
|
|
479
|
-
#
|
|
480
|
-
# Corresponds to the JSON property `results`
|
|
481
|
-
# @return [Array<Google::Apis::CivicinfoV2::DivisionSearchResult>]
|
|
482
|
-
attr_accessor :results
|
|
483
|
-
|
|
484
|
-
def initialize(**args)
|
|
485
|
-
update!(**args)
|
|
486
|
-
end
|
|
487
|
-
|
|
488
|
-
# Update properties of this object
|
|
489
|
-
def update!(**args)
|
|
490
|
-
@kind = args[:kind] if args.key?(:kind)
|
|
491
|
-
@results = args[:results] if args.key?(:results)
|
|
492
|
-
end
|
|
493
|
-
end
|
|
494
|
-
|
|
495
|
-
# Represents a political geographic division that matches the requested query.
|
|
496
|
-
class DivisionSearchResult
|
|
497
|
-
include Google::Apis::Core::Hashable
|
|
498
|
-
|
|
499
|
-
# Other Open Civic Data identifiers that refer to the same division -- for
|
|
500
|
-
# example, those that refer to other political divisions whose boundaries are
|
|
501
|
-
# defined to be coterminous with this one. For example, ocd-division/country:us/
|
|
502
|
-
# state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since
|
|
503
|
-
# Wyoming has only one Congressional district.
|
|
504
|
-
# Corresponds to the JSON property `aliases`
|
|
505
|
-
# @return [Array<String>]
|
|
506
|
-
attr_accessor :aliases
|
|
507
|
-
|
|
508
|
-
# The name of the division.
|
|
509
|
-
# Corresponds to the JSON property `name`
|
|
510
|
-
# @return [String]
|
|
511
|
-
attr_accessor :name
|
|
512
|
-
|
|
513
|
-
# The unique Open Civic Data identifier for this division
|
|
514
|
-
# Corresponds to the JSON property `ocdId`
|
|
515
|
-
# @return [String]
|
|
516
|
-
attr_accessor :ocd_id
|
|
517
|
-
|
|
518
|
-
def initialize(**args)
|
|
519
|
-
update!(**args)
|
|
520
|
-
end
|
|
521
|
-
|
|
522
|
-
# Update properties of this object
|
|
523
|
-
def update!(**args)
|
|
524
|
-
@aliases = args[:aliases] if args.key?(:aliases)
|
|
525
|
-
@name = args[:name] if args.key?(:name)
|
|
526
|
-
@ocd_id = args[:ocd_id] if args.key?(:ocd_id)
|
|
527
|
-
end
|
|
528
|
-
end
|
|
529
|
-
|
|
530
658
|
# Information about the election that was queried.
|
|
531
|
-
class
|
|
659
|
+
class CivicinfoSchemaV2Election
|
|
532
660
|
include Google::Apis::Core::Hashable
|
|
533
661
|
|
|
534
662
|
# Day of the election in YYYY-MM-DD format.
|
|
@@ -574,7 +702,7 @@ module Google
|
|
|
574
702
|
end
|
|
575
703
|
|
|
576
704
|
# Information about individual election officials.
|
|
577
|
-
class
|
|
705
|
+
class CivicinfoSchemaV2ElectionOfficial
|
|
578
706
|
include Google::Apis::Core::Hashable
|
|
579
707
|
|
|
580
708
|
# The email address of the election official.
|
|
@@ -616,34 +744,8 @@ module Google
|
|
|
616
744
|
end
|
|
617
745
|
end
|
|
618
746
|
|
|
619
|
-
# The list of elections available for this version of the API.
|
|
620
|
-
class QueryElectionsResponse
|
|
621
|
-
include Google::Apis::Core::Hashable
|
|
622
|
-
|
|
623
|
-
# A list of available elections
|
|
624
|
-
# Corresponds to the JSON property `elections`
|
|
625
|
-
# @return [Array<Google::Apis::CivicinfoV2::Election>]
|
|
626
|
-
attr_accessor :elections
|
|
627
|
-
|
|
628
|
-
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
|
629
|
-
# electionsQueryResponse".
|
|
630
|
-
# Corresponds to the JSON property `kind`
|
|
631
|
-
# @return [String]
|
|
632
|
-
attr_accessor :kind
|
|
633
|
-
|
|
634
|
-
def initialize(**args)
|
|
635
|
-
update!(**args)
|
|
636
|
-
end
|
|
637
|
-
|
|
638
|
-
# Update properties of this object
|
|
639
|
-
def update!(**args)
|
|
640
|
-
@elections = args[:elections] if args.key?(:elections)
|
|
641
|
-
@kind = args[:kind] if args.key?(:kind)
|
|
642
|
-
end
|
|
643
|
-
end
|
|
644
|
-
|
|
645
747
|
# Describes the geographic scope of a contest.
|
|
646
|
-
class
|
|
748
|
+
class CivicinfoSchemaV2ElectoralDistrict
|
|
647
749
|
include Google::Apis::Core::Hashable
|
|
648
750
|
|
|
649
751
|
# An identifier for this district, relative to its scope. For example, the 34th
|
|
@@ -678,7 +780,7 @@ module Google
|
|
|
678
780
|
end
|
|
679
781
|
|
|
680
782
|
# Describes a political geography.
|
|
681
|
-
class
|
|
783
|
+
class CivicinfoSchemaV2GeographicDivision
|
|
682
784
|
include Google::Apis::Core::Hashable
|
|
683
785
|
|
|
684
786
|
# Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs
|
|
@@ -717,133 +819,14 @@ module Google
|
|
|
717
819
|
end
|
|
718
820
|
end
|
|
719
821
|
|
|
720
|
-
# Information about an Office held by one or more Officials.
|
|
721
|
-
class Office
|
|
722
|
-
include Google::Apis::Core::Hashable
|
|
723
|
-
|
|
724
|
-
# The OCD ID of the division with which this office is associated.
|
|
725
|
-
# Corresponds to the JSON property `divisionId`
|
|
726
|
-
# @return [String]
|
|
727
|
-
attr_accessor :division_id
|
|
728
|
-
|
|
729
|
-
# The levels of government of which this office is part. There may be more than
|
|
730
|
-
# one in cases where a jurisdiction effectively acts at two different levels of
|
|
731
|
-
# government; for example, the mayor of the District of Columbia acts at "
|
|
732
|
-
# locality" level, but also effectively at both "administrative-area-2" and "
|
|
733
|
-
# administrative-area-1".
|
|
734
|
-
# Corresponds to the JSON property `levels`
|
|
735
|
-
# @return [Array<String>]
|
|
736
|
-
attr_accessor :levels
|
|
737
|
-
|
|
738
|
-
# The human-readable name of the office.
|
|
739
|
-
# Corresponds to the JSON property `name`
|
|
740
|
-
# @return [String]
|
|
741
|
-
attr_accessor :name
|
|
742
|
-
|
|
743
|
-
# List of indices in the officials array of people who presently hold this
|
|
744
|
-
# office.
|
|
745
|
-
# Corresponds to the JSON property `officialIndices`
|
|
746
|
-
# @return [Array<Fixnum>]
|
|
747
|
-
attr_accessor :official_indices
|
|
748
|
-
|
|
749
|
-
# The roles which this office fulfills. Roles are not meant to be exhaustive, or
|
|
750
|
-
# to exactly specify the entire set of responsibilities of a given office, but
|
|
751
|
-
# are meant to be rough categories that are useful for general selection from or
|
|
752
|
-
# sorting of a list of offices.
|
|
753
|
-
# Corresponds to the JSON property `roles`
|
|
754
|
-
# @return [Array<String>]
|
|
755
|
-
attr_accessor :roles
|
|
756
|
-
|
|
757
|
-
# A list of sources for this office. If multiple sources are listed, the data
|
|
758
|
-
# has been aggregated from those sources.
|
|
759
|
-
# Corresponds to the JSON property `sources`
|
|
760
|
-
# @return [Array<Google::Apis::CivicinfoV2::Source>]
|
|
761
|
-
attr_accessor :sources
|
|
762
|
-
|
|
763
|
-
def initialize(**args)
|
|
764
|
-
update!(**args)
|
|
765
|
-
end
|
|
766
|
-
|
|
767
|
-
# Update properties of this object
|
|
768
|
-
def update!(**args)
|
|
769
|
-
@division_id = args[:division_id] if args.key?(:division_id)
|
|
770
|
-
@levels = args[:levels] if args.key?(:levels)
|
|
771
|
-
@name = args[:name] if args.key?(:name)
|
|
772
|
-
@official_indices = args[:official_indices] if args.key?(:official_indices)
|
|
773
|
-
@roles = args[:roles] if args.key?(:roles)
|
|
774
|
-
@sources = args[:sources] if args.key?(:sources)
|
|
775
|
-
end
|
|
776
|
-
end
|
|
777
|
-
|
|
778
|
-
# Information about a person holding an elected office.
|
|
779
|
-
class Official
|
|
780
|
-
include Google::Apis::Core::Hashable
|
|
781
|
-
|
|
782
|
-
# Addresses at which to contact the official.
|
|
783
|
-
# Corresponds to the JSON property `address`
|
|
784
|
-
# @return [Array<Google::Apis::CivicinfoV2::SimpleAddressType>]
|
|
785
|
-
attr_accessor :address
|
|
786
|
-
|
|
787
|
-
# A list of known (social) media channels for this official.
|
|
788
|
-
# Corresponds to the JSON property `channels`
|
|
789
|
-
# @return [Array<Google::Apis::CivicinfoV2::Channel>]
|
|
790
|
-
attr_accessor :channels
|
|
791
|
-
|
|
792
|
-
# The direct email addresses for the official.
|
|
793
|
-
# Corresponds to the JSON property `emails`
|
|
794
|
-
# @return [Array<String>]
|
|
795
|
-
attr_accessor :emails
|
|
796
|
-
|
|
797
|
-
# The official's name.
|
|
798
|
-
# Corresponds to the JSON property `name`
|
|
799
|
-
# @return [String]
|
|
800
|
-
attr_accessor :name
|
|
801
|
-
|
|
802
|
-
# The full name of the party the official belongs to.
|
|
803
|
-
# Corresponds to the JSON property `party`
|
|
804
|
-
# @return [String]
|
|
805
|
-
attr_accessor :party
|
|
806
|
-
|
|
807
|
-
# The official's public contact phone numbers.
|
|
808
|
-
# Corresponds to the JSON property `phones`
|
|
809
|
-
# @return [Array<String>]
|
|
810
|
-
attr_accessor :phones
|
|
811
|
-
|
|
812
|
-
# A URL for a photo of the official.
|
|
813
|
-
# Corresponds to the JSON property `photoUrl`
|
|
814
|
-
# @return [String]
|
|
815
|
-
attr_accessor :photo_url
|
|
816
|
-
|
|
817
|
-
# The official's public website URLs.
|
|
818
|
-
# Corresponds to the JSON property `urls`
|
|
819
|
-
# @return [Array<String>]
|
|
820
|
-
attr_accessor :urls
|
|
821
|
-
|
|
822
|
-
def initialize(**args)
|
|
823
|
-
update!(**args)
|
|
824
|
-
end
|
|
825
|
-
|
|
826
|
-
# Update properties of this object
|
|
827
|
-
def update!(**args)
|
|
828
|
-
@address = args[:address] if args.key?(:address)
|
|
829
|
-
@channels = args[:channels] if args.key?(:channels)
|
|
830
|
-
@emails = args[:emails] if args.key?(:emails)
|
|
831
|
-
@name = args[:name] if args.key?(:name)
|
|
832
|
-
@party = args[:party] if args.key?(:party)
|
|
833
|
-
@phones = args[:phones] if args.key?(:phones)
|
|
834
|
-
@photo_url = args[:photo_url] if args.key?(:photo_url)
|
|
835
|
-
@urls = args[:urls] if args.key?(:urls)
|
|
836
|
-
end
|
|
837
|
-
end
|
|
838
|
-
|
|
839
822
|
# A location where a voter can vote. This may be an early vote site, an election
|
|
840
823
|
# day voting location, or a drop off location for a completed ballot.
|
|
841
|
-
class
|
|
824
|
+
class CivicinfoSchemaV2PollingLocation
|
|
842
825
|
include Google::Apis::Core::Hashable
|
|
843
826
|
|
|
844
827
|
# A simple representation of an address.
|
|
845
828
|
# Corresponds to the JSON property `address`
|
|
846
|
-
# @return [Google::Apis::CivicinfoV2::
|
|
829
|
+
# @return [Google::Apis::CivicinfoV2::CivicinfoSchemaV2SimpleAddressType]
|
|
847
830
|
attr_accessor :address
|
|
848
831
|
|
|
849
832
|
# The last date that this early vote site or drop off location may be used. This
|
|
@@ -883,7 +866,7 @@ module Google
|
|
|
883
866
|
# A list of sources for this location. If multiple sources are listed the data
|
|
884
867
|
# has been aggregated from those sources.
|
|
885
868
|
# Corresponds to the JSON property `sources`
|
|
886
|
-
# @return [Array<Google::Apis::CivicinfoV2::
|
|
869
|
+
# @return [Array<Google::Apis::CivicinfoV2::CivicinfoSchemaV2Source>]
|
|
887
870
|
attr_accessor :sources
|
|
888
871
|
|
|
889
872
|
# The first date that this early vote site or drop off location may be used.
|
|
@@ -918,7 +901,7 @@ module Google
|
|
|
918
901
|
end
|
|
919
902
|
|
|
920
903
|
#
|
|
921
|
-
class
|
|
904
|
+
class CivicinfoSchemaV2Precinct
|
|
922
905
|
include Google::Apis::Core::Hashable
|
|
923
906
|
|
|
924
907
|
# ID of the AdministrationRegion message for this precinct. Corresponds to
|
|
@@ -1019,89 +1002,8 @@ module Google
|
|
|
1019
1002
|
end
|
|
1020
1003
|
end
|
|
1021
1004
|
|
|
1022
|
-
#
|
|
1023
|
-
class RepresentativeInfoData
|
|
1024
|
-
include Google::Apis::Core::Hashable
|
|
1025
|
-
|
|
1026
|
-
# A map of political geographic divisions that contain the requested address,
|
|
1027
|
-
# keyed by the unique Open Civic Data identifier for this division.
|
|
1028
|
-
# Corresponds to the JSON property `divisions`
|
|
1029
|
-
# @return [Hash<String,Google::Apis::CivicinfoV2::GeographicDivision>]
|
|
1030
|
-
attr_accessor :divisions
|
|
1031
|
-
|
|
1032
|
-
# Elected offices referenced by the divisions listed above. Will only be present
|
|
1033
|
-
# if includeOffices was true in the request.
|
|
1034
|
-
# Corresponds to the JSON property `offices`
|
|
1035
|
-
# @return [Array<Google::Apis::CivicinfoV2::Office>]
|
|
1036
|
-
attr_accessor :offices
|
|
1037
|
-
|
|
1038
|
-
# Officials holding the offices listed above. Will only be present if
|
|
1039
|
-
# includeOffices was true in the request.
|
|
1040
|
-
# Corresponds to the JSON property `officials`
|
|
1041
|
-
# @return [Array<Google::Apis::CivicinfoV2::Official>]
|
|
1042
|
-
attr_accessor :officials
|
|
1043
|
-
|
|
1044
|
-
def initialize(**args)
|
|
1045
|
-
update!(**args)
|
|
1046
|
-
end
|
|
1047
|
-
|
|
1048
|
-
# Update properties of this object
|
|
1049
|
-
def update!(**args)
|
|
1050
|
-
@divisions = args[:divisions] if args.key?(:divisions)
|
|
1051
|
-
@offices = args[:offices] if args.key?(:offices)
|
|
1052
|
-
@officials = args[:officials] if args.key?(:officials)
|
|
1053
|
-
end
|
|
1054
|
-
end
|
|
1055
|
-
|
|
1056
|
-
# The result of a representative info lookup query.
|
|
1057
|
-
class RepresentativeInfoResponse
|
|
1058
|
-
include Google::Apis::Core::Hashable
|
|
1059
|
-
|
|
1060
|
-
# A map of political geographic divisions that contain the requested address,
|
|
1061
|
-
# keyed by the unique Open Civic Data identifier for this division.
|
|
1062
|
-
# Corresponds to the JSON property `divisions`
|
|
1063
|
-
# @return [Hash<String,Google::Apis::CivicinfoV2::GeographicDivision>]
|
|
1064
|
-
attr_accessor :divisions
|
|
1065
|
-
|
|
1066
|
-
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
|
1067
|
-
# representativeInfoResponse".
|
|
1068
|
-
# Corresponds to the JSON property `kind`
|
|
1069
|
-
# @return [String]
|
|
1070
|
-
attr_accessor :kind
|
|
1071
|
-
|
|
1072
|
-
# A simple representation of an address.
|
|
1073
|
-
# Corresponds to the JSON property `normalizedInput`
|
|
1074
|
-
# @return [Google::Apis::CivicinfoV2::SimpleAddressType]
|
|
1075
|
-
attr_accessor :normalized_input
|
|
1076
|
-
|
|
1077
|
-
# Elected offices referenced by the divisions listed above. Will only be present
|
|
1078
|
-
# if includeOffices was true in the request.
|
|
1079
|
-
# Corresponds to the JSON property `offices`
|
|
1080
|
-
# @return [Array<Google::Apis::CivicinfoV2::Office>]
|
|
1081
|
-
attr_accessor :offices
|
|
1082
|
-
|
|
1083
|
-
# Officials holding the offices listed above. Will only be present if
|
|
1084
|
-
# includeOffices was true in the request.
|
|
1085
|
-
# Corresponds to the JSON property `officials`
|
|
1086
|
-
# @return [Array<Google::Apis::CivicinfoV2::Official>]
|
|
1087
|
-
attr_accessor :officials
|
|
1088
|
-
|
|
1089
|
-
def initialize(**args)
|
|
1090
|
-
update!(**args)
|
|
1091
|
-
end
|
|
1092
|
-
|
|
1093
|
-
# Update properties of this object
|
|
1094
|
-
def update!(**args)
|
|
1095
|
-
@divisions = args[:divisions] if args.key?(:divisions)
|
|
1096
|
-
@kind = args[:kind] if args.key?(:kind)
|
|
1097
|
-
@normalized_input = args[:normalized_input] if args.key?(:normalized_input)
|
|
1098
|
-
@offices = args[:offices] if args.key?(:offices)
|
|
1099
|
-
@officials = args[:officials] if args.key?(:officials)
|
|
1100
|
-
end
|
|
1101
|
-
end
|
|
1102
|
-
|
|
1103
1005
|
# A simple representation of an address.
|
|
1104
|
-
class
|
|
1006
|
+
class CivicinfoSchemaV2SimpleAddressType
|
|
1105
1007
|
include Google::Apis::Core::Hashable
|
|
1106
1008
|
|
|
1107
1009
|
# The city or town for the address.
|
|
@@ -1156,7 +1058,7 @@ module Google
|
|
|
1156
1058
|
end
|
|
1157
1059
|
|
|
1158
1060
|
# Contains information about the data source for the element containing it.
|
|
1159
|
-
class
|
|
1061
|
+
class CivicinfoSchemaV2Source
|
|
1160
1062
|
include Google::Apis::Core::Hashable
|
|
1161
1063
|
|
|
1162
1064
|
# The name of the data source.
|
|
@@ -1180,108 +1082,6 @@ module Google
|
|
|
1180
1082
|
@official = args[:official] if args.key?(:official)
|
|
1181
1083
|
end
|
|
1182
1084
|
end
|
|
1183
|
-
|
|
1184
|
-
# The result of a voter info lookup query.
|
|
1185
|
-
class VoterInfoResponse
|
|
1186
|
-
include Google::Apis::Core::Hashable
|
|
1187
|
-
|
|
1188
|
-
# Contests that will appear on the voter's ballot.
|
|
1189
|
-
# Corresponds to the JSON property `contests`
|
|
1190
|
-
# @return [Array<Google::Apis::CivicinfoV2::Contest>]
|
|
1191
|
-
attr_accessor :contests
|
|
1192
|
-
|
|
1193
|
-
# Locations where a voter is eligible to drop off a completed ballot. The voter
|
|
1194
|
-
# must have received and completed a ballot prior to arriving at the location.
|
|
1195
|
-
# The location may not have ballots available on the premises. These locations
|
|
1196
|
-
# could be open on or before election day as indicated in the pollingHours field.
|
|
1197
|
-
# Corresponds to the JSON property `dropOffLocations`
|
|
1198
|
-
# @return [Array<Google::Apis::CivicinfoV2::PollingLocation>]
|
|
1199
|
-
attr_accessor :drop_off_locations
|
|
1200
|
-
|
|
1201
|
-
# Locations where the voter is eligible to vote early, prior to election day.
|
|
1202
|
-
# Corresponds to the JSON property `earlyVoteSites`
|
|
1203
|
-
# @return [Array<Google::Apis::CivicinfoV2::PollingLocation>]
|
|
1204
|
-
attr_accessor :early_vote_sites
|
|
1205
|
-
|
|
1206
|
-
# Information about the election that was queried.
|
|
1207
|
-
# Corresponds to the JSON property `election`
|
|
1208
|
-
# @return [Google::Apis::CivicinfoV2::Election]
|
|
1209
|
-
attr_accessor :election
|
|
1210
|
-
|
|
1211
|
-
# Identifies what kind of resource this is. Value: the fixed string "civicinfo#
|
|
1212
|
-
# voterInfoResponse".
|
|
1213
|
-
# Corresponds to the JSON property `kind`
|
|
1214
|
-
# @return [String]
|
|
1215
|
-
attr_accessor :kind
|
|
1216
|
-
|
|
1217
|
-
# Specifies whether voters in the precinct vote only by mailing their ballots (
|
|
1218
|
-
# with the possible option of dropping off their ballots as well).
|
|
1219
|
-
# Corresponds to the JSON property `mailOnly`
|
|
1220
|
-
# @return [Boolean]
|
|
1221
|
-
attr_accessor :mail_only
|
|
1222
|
-
alias_method :mail_only?, :mail_only
|
|
1223
|
-
|
|
1224
|
-
# A simple representation of an address.
|
|
1225
|
-
# Corresponds to the JSON property `normalizedInput`
|
|
1226
|
-
# @return [Google::Apis::CivicinfoV2::SimpleAddressType]
|
|
1227
|
-
attr_accessor :normalized_input
|
|
1228
|
-
|
|
1229
|
-
# When there are multiple elections for a voter address, the otherElections
|
|
1230
|
-
# field is populated in the API response and there are two possibilities: 1. If
|
|
1231
|
-
# the earliest election is not the intended election, specify the election ID of
|
|
1232
|
-
# the desired election in a second API request using the electionId field. 2. If
|
|
1233
|
-
# these elections occur on the same day, the API doesn?t return any polling
|
|
1234
|
-
# location, contest, or election official information to ensure that an
|
|
1235
|
-
# additional query is made. For user-facing applications, we recommend
|
|
1236
|
-
# displaying these elections to the user to disambiguate. A second API request
|
|
1237
|
-
# using the electionId field should be made for the election that is relevant to
|
|
1238
|
-
# the user.
|
|
1239
|
-
# Corresponds to the JSON property `otherElections`
|
|
1240
|
-
# @return [Array<Google::Apis::CivicinfoV2::Election>]
|
|
1241
|
-
attr_accessor :other_elections
|
|
1242
|
-
|
|
1243
|
-
# Locations where the voter is eligible to vote on election day.
|
|
1244
|
-
# Corresponds to the JSON property `pollingLocations`
|
|
1245
|
-
# @return [Array<Google::Apis::CivicinfoV2::PollingLocation>]
|
|
1246
|
-
attr_accessor :polling_locations
|
|
1247
|
-
|
|
1248
|
-
#
|
|
1249
|
-
# Corresponds to the JSON property `precinctId`
|
|
1250
|
-
# @return [String]
|
|
1251
|
-
attr_accessor :precinct_id
|
|
1252
|
-
|
|
1253
|
-
# The precincts that match this voter's address. Will only be returned for
|
|
1254
|
-
# project IDs which have been allowlisted as "partner projects".
|
|
1255
|
-
# Corresponds to the JSON property `precincts`
|
|
1256
|
-
# @return [Array<Google::Apis::CivicinfoV2::Precinct>]
|
|
1257
|
-
attr_accessor :precincts
|
|
1258
|
-
|
|
1259
|
-
# Local Election Information for the state that the voter votes in. For the US,
|
|
1260
|
-
# there will only be one element in this array.
|
|
1261
|
-
# Corresponds to the JSON property `state`
|
|
1262
|
-
# @return [Array<Google::Apis::CivicinfoV2::AdministrationRegion>]
|
|
1263
|
-
attr_accessor :state
|
|
1264
|
-
|
|
1265
|
-
def initialize(**args)
|
|
1266
|
-
update!(**args)
|
|
1267
|
-
end
|
|
1268
|
-
|
|
1269
|
-
# Update properties of this object
|
|
1270
|
-
def update!(**args)
|
|
1271
|
-
@contests = args[:contests] if args.key?(:contests)
|
|
1272
|
-
@drop_off_locations = args[:drop_off_locations] if args.key?(:drop_off_locations)
|
|
1273
|
-
@early_vote_sites = args[:early_vote_sites] if args.key?(:early_vote_sites)
|
|
1274
|
-
@election = args[:election] if args.key?(:election)
|
|
1275
|
-
@kind = args[:kind] if args.key?(:kind)
|
|
1276
|
-
@mail_only = args[:mail_only] if args.key?(:mail_only)
|
|
1277
|
-
@normalized_input = args[:normalized_input] if args.key?(:normalized_input)
|
|
1278
|
-
@other_elections = args[:other_elections] if args.key?(:other_elections)
|
|
1279
|
-
@polling_locations = args[:polling_locations] if args.key?(:polling_locations)
|
|
1280
|
-
@precinct_id = args[:precinct_id] if args.key?(:precinct_id)
|
|
1281
|
-
@precincts = args[:precincts] if args.key?(:precincts)
|
|
1282
|
-
@state = args[:state] if args.key?(:state)
|
|
1283
|
-
end
|
|
1284
|
-
end
|
|
1285
1085
|
end
|
|
1286
1086
|
end
|
|
1287
1087
|
end
|