docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/civicinfo_v2.representatives.html b/docs/dyn/civicinfo_v2.representatives.html
index 28921bd..d2e795f 100644
--- a/docs/dyn/civicinfo_v2.representatives.html
+++ b/docs/dyn/civicinfo_v2.representatives.html
@@ -78,10 +78,10 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#representativeInfoByAddress">representativeInfoByAddress(roles=None, address=None, levels=None, includeOffices=None, x__xgafv=None)</a></code></p>
+ <code><a href="#representativeInfoByAddress">representativeInfoByAddress(address=None, includeOffices=None, levels=None, roles=None, x__xgafv=None)</a></code></p>
<p class="firstline">Looks up political geography and representative information for a single address.</p>
<p class="toc_element">
- <code><a href="#representativeInfoByDivision">representativeInfoByDivision(ocdId, roles=None, levels=None, recursive=None, x__xgafv=None)</a></code></p>
+ <code><a href="#representativeInfoByDivision">representativeInfoByDivision(ocdId, roles=None, recursive=None, levels=None, x__xgafv=None)</a></code></p>
<p class="firstline">Looks up representative information for a single geographic division.</p>
<h3>Method Details</h3>
<div class="method">
@@ -90,10 +90,23 @@
</div>
<div class="method">
- <code class="details" id="representativeInfoByAddress">representativeInfoByAddress(roles=None, address=None, levels=None, includeOffices=None, x__xgafv=None)</code>
+ <code class="details" id="representativeInfoByAddress">representativeInfoByAddress(address=None, includeOffices=None, levels=None, roles=None, x__xgafv=None)</code>
<pre>Looks up political geography and representative information for a single address.
Args:
+ address: string, The address to look up. May only be specified if the field ocdId is not given in the URL
+ includeOffices: boolean, Whether to return information about offices and officials. If false, only the top-level district information will be returned.
+ levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned. (repeated)
+ Allowed values
+ international -
+ country -
+ administrativeArea1 -
+ regional -
+ administrativeArea2 -
+ locality -
+ subLocality1 -
+ subLocality2 -
+ special -
roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned. (repeated)
Allowed values
headOfState -
@@ -107,19 +120,6 @@
judge -
schoolBoard -
specialPurposeOfficer -
- address: string, The address to look up. May only be specified if the field ocdId is not given in the URL
- levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned. (repeated)
- Allowed values
- international -
- country -
- administrativeArea1 -
- regional -
- administrativeArea2 -
- locality -
- subLocality1 -
- subLocality2 -
- special -
- includeOffices: boolean, Whether to return information about offices and officials. If false, only the top-level district information will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -130,74 +130,74 @@
{ # The result of a representative info lookup query.
"normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
- "state": "A String", # The US two letter state abbreviation of the address.
- "line3": "A String", # The third line of the address, if needed.
- "city": "A String", # The city or town for the address.
"locationName": "A String", # The name of the location.
- "line2": "A String", # The second line the address, if needed.
- "zip": "A String", # The US Postal Zip Code of the address.
+ "line3": "A String", # The third line of the address, if needed.
"line1": "A String", # The street name and number of this address.
+ "zip": "A String", # The US Postal Zip Code of the address.
+ "line2": "A String", # The second line the address, if needed.
+ "state": "A String", # The US two letter state abbreviation of the address.
+ "city": "A String", # The city or town for the address.
},
- "officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
- { # Information about a person holding an elected office.
- "urls": [ # The official's public website URLs.
- "A String",
- ],
- "emails": [ # The direct email addresses for the official.
- "A String",
- ],
- "channels": [ # A list of known (social) media channels for this official.
- { # A social media or web channel for a candidate.
- "type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
- "id": "A String", # The unique public identifier for the candidate's channel.
- },
- ],
- "address": [ # Addresses at which to contact the official.
- { # A simple representation of an address.
- "state": "A String", # The US two letter state abbreviation of the address.
- "line3": "A String", # The third line of the address, if needed.
- "city": "A String", # The city or town for the address.
- "locationName": "A String", # The name of the location.
- "line2": "A String", # The second line the address, if needed.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line1": "A String", # The street name and number of this address.
- },
- ],
- "phones": [ # The official's public contact phone numbers.
- "A String",
- ],
- "party": "A String", # The full name of the party the official belongs to.
- "name": "A String", # The official's name.
- "photoUrl": "A String", # A URL for a photo of the official.
- },
- ],
"divisions": { # A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.
"a_key": { # Describes a political geography.
+ "officeIndices": [ # List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
+ 42,
+ ],
"alsoKnownAs": [ # Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
"A String",
],
"name": "A String", # The name of the division.
- "officeIndices": [ # List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
- 42,
- ],
},
},
"kind": "civicinfo#representativeInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse".
+ "officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
+ { # Information about a person holding an elected office.
+ "channels": [ # A list of known (social) media channels for this official.
+ { # A social media or web channel for a candidate.
+ "id": "A String", # The unique public identifier for the candidate's channel.
+ "type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
+ },
+ ],
+ "address": [ # Addresses at which to contact the official.
+ { # A simple representation of an address.
+ "locationName": "A String", # The name of the location.
+ "line3": "A String", # The third line of the address, if needed.
+ "line1": "A String", # The street name and number of this address.
+ "zip": "A String", # The US Postal Zip Code of the address.
+ "line2": "A String", # The second line the address, if needed.
+ "state": "A String", # The US two letter state abbreviation of the address.
+ "city": "A String", # The city or town for the address.
+ },
+ ],
+ "photoUrl": "A String", # A URL for a photo of the official.
+ "emails": [ # The direct email addresses for the official.
+ "A String",
+ ],
+ "party": "A String", # The full name of the party the official belongs to.
+ "name": "A String", # The official's name.
+ "phones": [ # The official's public contact phone numbers.
+ "A String",
+ ],
+ "urls": [ # The official's public website URLs.
+ "A String",
+ ],
+ },
+ ],
"offices": [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
{ # Information about an Office held by one or more Officials.
+ "sources": [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
+ { # Contains information about the data source for the element containing it.
+ "official": True or False, # Whether this data comes from an official government source.
+ "name": "A String", # The name of the data source.
+ },
+ ],
+ "divisionId": "A String", # The OCD ID of the division with which this office is associated.
"officialIndices": [ # List of indices in the officials array of people who presently hold this office.
42,
],
- "divisionId": "A String", # The OCD ID of the division with which this office is associated.
"roles": [ # The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.
"A String",
],
- "sources": [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "name": "A String", # The name of the data source.
- "official": True or False, # Whether this data comes from an official government source.
- },
- ],
"levels": [ # The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
"A String",
],
@@ -208,7 +208,7 @@
</div>
<div class="method">
- <code class="details" id="representativeInfoByDivision">representativeInfoByDivision(ocdId, roles=None, levels=None, recursive=None, x__xgafv=None)</code>
+ <code class="details" id="representativeInfoByDivision">representativeInfoByDivision(ocdId, roles=None, recursive=None, levels=None, x__xgafv=None)</code>
<pre>Looks up representative information for a single geographic division.
Args:
@@ -226,6 +226,7 @@
judge -
schoolBoard -
specialPurposeOfficer -
+ recursive: boolean, If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.
levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned. (repeated)
Allowed values
international -
@@ -237,7 +238,6 @@
subLocality1 -
subLocality2 -
special -
- recursive: boolean, If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -249,69 +249,69 @@
{
"divisions": { # A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.
"a_key": { # Describes a political geography.
+ "officeIndices": [ # List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
+ 42,
+ ],
"alsoKnownAs": [ # Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
"A String",
],
"name": "A String", # The name of the division.
- "officeIndices": [ # List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
- 42,
- ],
},
},
- "officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
- { # Information about a person holding an elected office.
- "urls": [ # The official's public website URLs.
- "A String",
- ],
- "emails": [ # The direct email addresses for the official.
- "A String",
- ],
- "channels": [ # A list of known (social) media channels for this official.
- { # A social media or web channel for a candidate.
- "type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
- "id": "A String", # The unique public identifier for the candidate's channel.
- },
- ],
- "address": [ # Addresses at which to contact the official.
- { # A simple representation of an address.
- "state": "A String", # The US two letter state abbreviation of the address.
- "line3": "A String", # The third line of the address, if needed.
- "city": "A String", # The city or town for the address.
- "locationName": "A String", # The name of the location.
- "line2": "A String", # The second line the address, if needed.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line1": "A String", # The street name and number of this address.
- },
- ],
- "phones": [ # The official's public contact phone numbers.
- "A String",
- ],
- "party": "A String", # The full name of the party the official belongs to.
- "name": "A String", # The official's name.
- "photoUrl": "A String", # A URL for a photo of the official.
- },
- ],
"offices": [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
{ # Information about an Office held by one or more Officials.
+ "sources": [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
+ { # Contains information about the data source for the element containing it.
+ "official": True or False, # Whether this data comes from an official government source.
+ "name": "A String", # The name of the data source.
+ },
+ ],
+ "divisionId": "A String", # The OCD ID of the division with which this office is associated.
"officialIndices": [ # List of indices in the officials array of people who presently hold this office.
42,
],
- "divisionId": "A String", # The OCD ID of the division with which this office is associated.
"roles": [ # The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.
"A String",
],
- "sources": [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "name": "A String", # The name of the data source.
- "official": True or False, # Whether this data comes from an official government source.
- },
- ],
"levels": [ # The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
"A String",
],
"name": "A String", # The human-readable name of the office.
},
],
+ "officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
+ { # Information about a person holding an elected office.
+ "channels": [ # A list of known (social) media channels for this official.
+ { # A social media or web channel for a candidate.
+ "id": "A String", # The unique public identifier for the candidate's channel.
+ "type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
+ },
+ ],
+ "address": [ # Addresses at which to contact the official.
+ { # A simple representation of an address.
+ "locationName": "A String", # The name of the location.
+ "line3": "A String", # The third line of the address, if needed.
+ "line1": "A String", # The street name and number of this address.
+ "zip": "A String", # The US Postal Zip Code of the address.
+ "line2": "A String", # The second line the address, if needed.
+ "state": "A String", # The US two letter state abbreviation of the address.
+ "city": "A String", # The city or town for the address.
+ },
+ ],
+ "photoUrl": "A String", # A URL for a photo of the official.
+ "emails": [ # The direct email addresses for the official.
+ "A String",
+ ],
+ "party": "A String", # The full name of the party the official belongs to.
+ "name": "A String", # The official's name.
+ "phones": [ # The official's public contact phone numbers.
+ "A String",
+ ],
+ "urls": [ # The official's public website URLs.
+ "A String",
+ ],
+ },
+ ],
}</pre>
</div>