Skip to content

Commit 26e51c3

Browse files
feat(civicinfo): update the api
#### civicinfo:v2 The following keys were deleted: - schemas.FeatureIdProto (Total Keys: 7) - schemas.GeocodingSummary (Total Keys: 8) - schemas.MessageSet (Total Keys: 2) - schemas.Official.properties.geocodingSummaries (Total Keys: 2) The following keys were added: - resources.elections.methods.electionQuery.parameters.productionDataOnly (Total Keys: 3) - resources.elections.methods.voterInfoQuery.parameters.productionDataOnly (Total Keys: 3)
1 parent ba8ef2b commit 26e51c3

File tree

3 files changed

+23
-842
lines changed

3 files changed

+23
-842
lines changed

docs/dyn/civicinfo_v2.elections.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ <h2>Instance Methods</h2>
7878
<code><a href="#close">close()</a></code></p>
7979
<p class="firstline">Close httplib2 connections.</p>
8080
<p class="toc_element">
81-
<code><a href="#electionQuery">electionQuery(x__xgafv=None)</a></code></p>
81+
<code><a href="#electionQuery">electionQuery(productionDataOnly=None, x__xgafv=None)</a></code></p>
8282
<p class="firstline">List of available elections to query.</p>
8383
<p class="toc_element">
84-
<code><a href="#voterInfoQuery">voterInfoQuery(address, electionId=None, officialOnly=None, returnAllAvailableData=None, x__xgafv=None)</a></code></p>
84+
<code><a href="#voterInfoQuery">voterInfoQuery(address, electionId=None, officialOnly=None, productionDataOnly=None, returnAllAvailableData=None, x__xgafv=None)</a></code></p>
8585
<p class="firstline">Looks up information relevant to a voter based on the voter's registered address.</p>
8686
<h3>Method Details</h3>
8787
<div class="method">
@@ -90,10 +90,11 @@ <h3>Method Details</h3>
9090
</div>
9191

9292
<div class="method">
93-
<code class="details" id="electionQuery">electionQuery(x__xgafv=None)</code>
93+
<code class="details" id="electionQuery">electionQuery(productionDataOnly=None, x__xgafv=None)</code>
9494
<pre>List of available elections to query.
9595

9696
Args:
97+
productionDataOnly: boolean, Whether to include data that has not been allowlisted yet
9798
x__xgafv: string, V1 error format.
9899
Allowed values
99100
1 - v1 error format
@@ -117,13 +118,14 @@ <h3>Method Details</h3>
117118
</div>
118119

119120
<div class="method">
120-
<code class="details" id="voterInfoQuery">voterInfoQuery(address, electionId=None, officialOnly=None, returnAllAvailableData=None, x__xgafv=None)</code>
121+
<code class="details" id="voterInfoQuery">voterInfoQuery(address, electionId=None, officialOnly=None, productionDataOnly=None, returnAllAvailableData=None, x__xgafv=None)</code>
121122
<pre>Looks up information relevant to a voter based on the voter&#x27;s registered address.
122123

123124
Args:
124125
address: string, The registered address of the voter to look up. (required)
125126
electionId: string, The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections. If no election ID is specified in the query and there is more than one election with data for the given voter, the additional elections are provided in the otherElections response field.
126127
officialOnly: boolean, If set to true, only data from official state sources will be returned.
128+
productionDataOnly: boolean, Whether to include data that has not been vetted yet. Should only be made available to internal IPs or trusted partners. This is a non-discoverable parameter in the One Platform API config.
127129
returnAllAvailableData: boolean, If set to true, the query will return the success code and include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries.
128130
x__xgafv: string, V1 error format.
129131
Allowed values
@@ -304,7 +306,7 @@ <h3>Method Details</h3>
304306
},
305307
],
306308
&quot;precinctId&quot;: &quot;A String&quot;,
307-
&quot;precincts&quot;: [ # The precincts that match this voter&#x27;s address. Will only be returned for project IDs which have been whitelisted as &quot;partner projects&quot;.
309+
&quot;precincts&quot;: [ # The precincts that match this voter&#x27;s address. Will only be returned for project IDs which have been allowlisted as &quot;partner projects&quot;.
308310
{
309311
&quot;administrationRegionId&quot;: &quot;A String&quot;, # ID of the AdministrationRegion message for this precinct. Corresponds to LocalityId xml tag.
310312
&quot;contestId&quot;: [ # ID(s) of the Contest message(s) for this precinct.

docs/dyn/civicinfo_v2.representatives.html

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -194,20 +194,6 @@ <h3>Method Details</h3>
194194
&quot;emails&quot;: [ # The direct email addresses for the official.
195195
&quot;A String&quot;,
196196
],
197-
&quot;geocodingSummaries&quot;: [ # Detailed summary about the official&#x27;s address&#x27;s geocoding
198-
{ # Detailed summary of the result from geocoding an address
199-
&quot;addressUnderstood&quot;: True or False, # Represents the best estimate of whether or not the input address was fully understood and the address is correctly componentized. Mirrors the same-name field in geostore.staging.AddressLinkupScoringProto.
200-
&quot;featureId&quot;: { # A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit &quot;cell id&quot; that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don&#x27;t need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos. # The ID of the FeatureProto returned by the geocoder
201-
&quot;cellId&quot;: &quot;A String&quot;, # The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way.
202-
&quot;fprint&quot;: &quot;A String&quot;, # A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient.
203-
&quot;temporaryData&quot;: { # This is proto2&#x27;s version of MessageSet. # A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts.
204-
},
205-
},
206-
&quot;featureType&quot;: &quot;A String&quot;, # The feature type for the FeatureProto returned by the geocoder
207-
&quot;positionPrecisionMeters&quot;: 3.14, # Precision of the center point (lat/long) of the geocoded FeatureProto
208-
&quot;queryString&quot;: &quot;A String&quot;, # The query sent to the geocoder
209-
},
210-
],
211197
&quot;name&quot;: &quot;A String&quot;, # The official&#x27;s name.
212198
&quot;party&quot;: &quot;A String&quot;, # The full name of the party the official belongs to.
213199
&quot;phones&quot;: [ # The official&#x27;s public contact phone numbers.
@@ -317,20 +303,6 @@ <h3>Method Details</h3>
317303
&quot;emails&quot;: [ # The direct email addresses for the official.
318304
&quot;A String&quot;,
319305
],
320-
&quot;geocodingSummaries&quot;: [ # Detailed summary about the official&#x27;s address&#x27;s geocoding
321-
{ # Detailed summary of the result from geocoding an address
322-
&quot;addressUnderstood&quot;: True or False, # Represents the best estimate of whether or not the input address was fully understood and the address is correctly componentized. Mirrors the same-name field in geostore.staging.AddressLinkupScoringProto.
323-
&quot;featureId&quot;: { # A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit &quot;cell id&quot; that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don&#x27;t need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos. # The ID of the FeatureProto returned by the geocoder
324-
&quot;cellId&quot;: &quot;A String&quot;, # The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way.
325-
&quot;fprint&quot;: &quot;A String&quot;, # A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient.
326-
&quot;temporaryData&quot;: { # This is proto2&#x27;s version of MessageSet. # A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts.
327-
},
328-
},
329-
&quot;featureType&quot;: &quot;A String&quot;, # The feature type for the FeatureProto returned by the geocoder
330-
&quot;positionPrecisionMeters&quot;: 3.14, # Precision of the center point (lat/long) of the geocoded FeatureProto
331-
&quot;queryString&quot;: &quot;A String&quot;, # The query sent to the geocoder
332-
},
333-
],
334306
&quot;name&quot;: &quot;A String&quot;, # The official&#x27;s name.
335307
&quot;party&quot;: &quot;A String&quot;, # The full name of the party the official belongs to.
336308
&quot;phones&quot;: [ # The official&#x27;s public contact phone numbers.

0 commit comments

Comments
 (0)