Clean and regen docs (#401)
diff --git a/docs/dyn/people_v1.people.html b/docs/dyn/people_v1.people.html
index 168b82a..2aa289b 100644
--- a/docs/dyn/people_v1.people.html
+++ b/docs/dyn/people_v1.people.html
@@ -81,14 +81,14 @@
<p class="toc_element">
<code><a href="#get">get(resourceName, x__xgafv=None, requestMask_includeField=None)</a></code></p>
-<p class="firstline">Provides information about a person resource for a resource name. Use</p>
+<p class="firstline">Provides information about a person by specifying a resource name. Use</p>
<p class="toc_element">
<code><a href="#getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None)</a></code></p>
<p class="firstline">Provides information about a list of specific people by specifying a list</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(resourceName, x__xgafv=None, requestMask_includeField=None)</code>
- <pre>Provides information about a person resource for a resource name. Use
+ <pre>Provides information about a person by specifying a resource name. Use
`people/me` to indicate the authenticated user.
Args:
@@ -102,24 +102,19 @@
Allowed values
1 - v1 error format
2 - v2 error format
- requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting
-this field will include all fields except for connections.list requests,
-which have a default mask that includes common fields like metadata, name,
-photo, and profile url.
-Each path should start with `person.`: for example, `person.names` or
-`person.photos`.
+ requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the
+response. Each path should start with `person.`: for example,
+`person.names` or `person.photos`.
Returns:
An object of the form:
{ # Information about a person merged from various data sources such as the
- # authenticated user's contacts and profile data. Fields other than IDs,
- # metadata, and group memberships are user-edited.
+ # authenticated user's contacts and profile data.
#
# Most fields can have multiple items. The items in a field have no guaranteed
# order, but each non-empty field is guaranteed to have exactly one field with
# `metadata.primary` set to true.
- # NEXT_ID: 31
"braggingRights": [ # The person's bragging rights.
{ # A person's bragging rights.
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
@@ -232,6 +227,24 @@
{ # A person's phone number.
"formattedType": "A String", # The read-only type of the phone number translated and formatted in the
# viewer's account locale or the the `Accept-Language` HTTP header locale.
+ "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
+ # form of the phone number.
+ "type": "A String", # The type of the phone number. The type can be custom or predefined.
+ # Possible values include, but are not limited to, the following:
+ #
+ # * `home`
+ # * `work`
+ # * `mobile`
+ # * `homeFax`
+ # * `workFax`
+ # * `otherFax`
+ # * `pager`
+ # * `workMobile`
+ # * `workPager`
+ # * `main`
+ # * `googleVoice`
+ # * `other`
+ "value": "A String", # The phone number.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"source": { # The source of a field. # The source of the field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -249,24 +262,6 @@
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
# field.
},
- "type": "A String", # The type of the phone number. The type can be custom or predefined.
- # Possible values include, but are not limited to, the following:
- #
- # * `home`
- # * `work`
- # * `mobile`
- # * `homeFax`
- # * `workFax`
- # * `otherFax`
- # * `pager`
- # * `workMobile`
- # * `workPager`
- # * `main`
- # * `googleVoice`
- # * `other`
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
- # form of the phone number.
},
],
"names": [ # The person's names.
@@ -307,7 +302,7 @@
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
- # with a max length of 27 characters. Always starts with `people/`.
+ # with a max length of 27 characters, in the form of `people/<person_id>`.
"ageRanges": [ # The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
@@ -369,26 +364,8 @@
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "person": "A String", # The name of the other person this relation refers to.
"formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
# locale or the locale specified in the Accept-Language HTTP header.
- "type": "A String", # The person's relation to the other person. The type can be custom or predefined.
- # Possible values include, but are not limited to, the following values:
- #
- # * `spouse`
- # * `child`
- # * `mother`
- # * `father`
- # * `parent`
- # * `brother`
- # * `sister`
- # * `friend`
- # * `relative`
- # * `domesticPartner`
- # * `manager`
- # * `assistant`
- # * `referredBy`
- # * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
"source": { # The source of a field. # The source of the field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -406,6 +383,24 @@
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
# field.
},
+ "type": "A String", # The person's relation to the other person. The type can be custom or predefined.
+ # Possible values include, but are not limited to, the following values:
+ #
+ # * `spouse`
+ # * `child`
+ # * `mother`
+ # * `father`
+ # * `parent`
+ # * `brother`
+ # * `sister`
+ # * `friend`
+ # * `relative`
+ # * `domesticPartner`
+ # * `manager`
+ # * `assistant`
+ # * `referredBy`
+ # * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -608,7 +603,9 @@
"photos": [ # The person's photos.
{ # A person's read-only photo. A picture shown next to the person's name to
# help others recognize the person.
- "url": "A String", # The URL of the photo.
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query
+ # parameter `sz=<size>` at the end of the url. Example:
+ # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
"metadata": { # Metadata about a field. # Metadata about the photo.
"source": { # The source of a field. # The source of the field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -735,8 +732,19 @@
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are
# permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
+ # of day and time zone are either specified elsewhere or are not
+ # significant. The date is relative to the
+ # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
+ # The day may be 0 to represent a year and month where the day is not
+ # significant. The year may be 0 to represent a month and day independent
+ # of year; for example, anniversary date.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
"domain": "A String", # The domain name associated with the organization; for example, `google.com`.
"endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
# of day and time zone are either specified elsewhere or are not
@@ -752,27 +760,16 @@
# a year.
},
"name": "A String", # The name of the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
+ "title": "A String", # The person's job title at the organization.
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
# symbol, abbreviation, or acronym.
- "title": "A String", # The person's job title at the organization.
"current": True or False, # True if the organization is the person's current organization;
# false if the organization is a past organization.
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # The read-only type of the organization translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the organization. The type can be custom or predefined.
# Possible values include, but are not limited to, the following:
#
@@ -946,14 +943,14 @@
],
"emailAddresses": [ # The person's email addresses.
{ # A person's email address.
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the email address. The type can be custom or predefined.
# Possible values include, but are not limited to, the following:
#
# * `home`
# * `work`
# * `other`
+ "formattedType": "A String", # The read-only type of the email address translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
"displayName": "A String", # The display name of the email.
"value": "A String", # The email address.
"metadata": { # Metadata about a field. # Metadata about the email address.
@@ -993,12 +990,9 @@
Allowed values
1 - v1 error format
2 - v2 error format
- requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting
-this field will include all fields except for connections.list requests,
-which have a default mask that includes common fields like metadata, name,
-photo, and profile url.
-Each path should start with `person.`: for example, `person.names` or
-`person.photos`.
+ requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the
+response. Each path should start with `person.`: for example,
+`person.names` or `person.photos`.
Returns:
An object of the form:
@@ -1013,13 +1007,11 @@
# contact and profile such as a verified email, verified phone number, or a
# profile URL.
"person": { # Information about a person merged from various data sources such as the # The person.
- # authenticated user's contacts and profile data. Fields other than IDs,
- # metadata, and group memberships are user-edited.
+ # authenticated user's contacts and profile data.
#
# Most fields can have multiple items. The items in a field have no guaranteed
# order, but each non-empty field is guaranteed to have exactly one field with
# `metadata.primary` set to true.
- # NEXT_ID: 31
"braggingRights": [ # The person's bragging rights.
{ # A person's bragging rights.
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
@@ -1132,6 +1124,24 @@
{ # A person's phone number.
"formattedType": "A String", # The read-only type of the phone number translated and formatted in the
# viewer's account locale or the the `Accept-Language` HTTP header locale.
+ "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
+ # form of the phone number.
+ "type": "A String", # The type of the phone number. The type can be custom or predefined.
+ # Possible values include, but are not limited to, the following:
+ #
+ # * `home`
+ # * `work`
+ # * `mobile`
+ # * `homeFax`
+ # * `workFax`
+ # * `otherFax`
+ # * `pager`
+ # * `workMobile`
+ # * `workPager`
+ # * `main`
+ # * `googleVoice`
+ # * `other`
+ "value": "A String", # The phone number.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"source": { # The source of a field. # The source of the field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -1149,24 +1159,6 @@
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
# field.
},
- "type": "A String", # The type of the phone number. The type can be custom or predefined.
- # Possible values include, but are not limited to, the following:
- #
- # * `home`
- # * `work`
- # * `mobile`
- # * `homeFax`
- # * `workFax`
- # * `otherFax`
- # * `pager`
- # * `workMobile`
- # * `workPager`
- # * `main`
- # * `googleVoice`
- # * `other`
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
- # form of the phone number.
},
],
"names": [ # The person's names.
@@ -1207,7 +1199,7 @@
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
- # with a max length of 27 characters. Always starts with `people/`.
+ # with a max length of 27 characters, in the form of `people/<person_id>`.
"ageRanges": [ # The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
@@ -1269,26 +1261,8 @@
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "person": "A String", # The name of the other person this relation refers to.
"formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
# locale or the locale specified in the Accept-Language HTTP header.
- "type": "A String", # The person's relation to the other person. The type can be custom or predefined.
- # Possible values include, but are not limited to, the following values:
- #
- # * `spouse`
- # * `child`
- # * `mother`
- # * `father`
- # * `parent`
- # * `brother`
- # * `sister`
- # * `friend`
- # * `relative`
- # * `domesticPartner`
- # * `manager`
- # * `assistant`
- # * `referredBy`
- # * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
"source": { # The source of a field. # The source of the field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -1306,6 +1280,24 @@
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
# field.
},
+ "type": "A String", # The person's relation to the other person. The type can be custom or predefined.
+ # Possible values include, but are not limited to, the following values:
+ #
+ # * `spouse`
+ # * `child`
+ # * `mother`
+ # * `father`
+ # * `parent`
+ # * `brother`
+ # * `sister`
+ # * `friend`
+ # * `relative`
+ # * `domesticPartner`
+ # * `manager`
+ # * `assistant`
+ # * `referredBy`
+ # * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -1508,7 +1500,9 @@
"photos": [ # The person's photos.
{ # A person's read-only photo. A picture shown next to the person's name to
# help others recognize the person.
- "url": "A String", # The URL of the photo.
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query
+ # parameter `sz=<size>` at the end of the url. Example:
+ # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
"metadata": { # Metadata about a field. # Metadata about the photo.
"source": { # The source of a field. # The source of the field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -1635,8 +1629,19 @@
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are
# permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
+ # of day and time zone are either specified elsewhere or are not
+ # significant. The date is relative to the
+ # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
+ # The day may be 0 to represent a year and month where the day is not
+ # significant. The year may be 0 to represent a month and day independent
+ # of year; for example, anniversary date.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
"domain": "A String", # The domain name associated with the organization; for example, `google.com`.
"endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
# of day and time zone are either specified elsewhere or are not
@@ -1652,27 +1657,16 @@
# a year.
},
"name": "A String", # The name of the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
+ "title": "A String", # The person's job title at the organization.
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
# symbol, abbreviation, or acronym.
- "title": "A String", # The person's job title at the organization.
"current": True or False, # True if the organization is the person's current organization;
# false if the organization is a past organization.
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # The read-only type of the organization translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the organization. The type can be custom or predefined.
# Possible values include, but are not limited to, the following:
#
@@ -1846,14 +1840,14 @@
],
"emailAddresses": [ # The person's email addresses.
{ # A person's email address.
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the email address. The type can be custom or predefined.
# Possible values include, but are not limited to, the following:
#
# * `home`
# * `work`
# * `other`
+ "formattedType": "A String", # The read-only type of the email address translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
"displayName": "A String", # The display name of the email.
"value": "A String", # The email address.
"metadata": { # Metadata about a field. # Metadata about the email address.
@@ -1876,7 +1870,72 @@
},
],
},
- "httpStatusCode": 42, # [HTTP 1.1 status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
+ "httpStatusCode": 42, # DEPRECATED(Please use status instead).
+ # [HTTP 1.1 status
+ # code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
+ "status": { # The `Status` type defines a logical error model that is suitable for different # The status of the response.
+ # programming environments, including REST APIs and RPC APIs. It is used by
+ # [gRPC](https://github.com/grpc). The error model is designed to be:
+ #
+ # - Simple to use and understand for most users
+ # - Flexible enough to meet unexpected needs
+ #
+ # # Overview
+ #
+ # The `Status` message contains three pieces of data: error code, error message,
+ # and error details. The error code should be an enum value of
+ # google.rpc.Code, but it may accept additional error codes if needed. The
+ # error message should be a developer-facing English message that helps
+ # developers *understand* and *resolve* the error. If a localized user-facing
+ # error message is needed, put the localized message in the error details or
+ # localize it in the client. The optional error details may contain arbitrary
+ # information about the error. There is a predefined set of error detail types
+ # in the package `google.rpc` that can be used for common error conditions.
+ #
+ # # Language mapping
+ #
+ # The `Status` message is the logical representation of the error model, but it
+ # is not necessarily the actual wire format. When the `Status` message is
+ # exposed in different client libraries and different wire protocols, it can be
+ # mapped differently. For example, it will likely be mapped to some exceptions
+ # in Java, but more likely mapped to some error codes in C.
+ #
+ # # Other uses
+ #
+ # The error model and the `Status` message can be used in a variety of
+ # environments, either with or without APIs, to provide a
+ # consistent developer experience across different environments.
+ #
+ # Example uses of this error model include:
+ #
+ # - Partial errors. If a service needs to return partial errors to the client,
+ # it may embed the `Status` in the normal response to indicate the partial
+ # errors.
+ #
+ # - Workflow errors. A typical workflow has multiple steps. Each step may
+ # have a `Status` message for error reporting.
+ #
+ # - Batch operations. If a client uses batch request and batch response, the
+ # `Status` message should be used directly inside batch response, one for
+ # each error sub-response.
+ #
+ # - Asynchronous operations. If an API call embeds asynchronous operation
+ # results in its response, the status of those operations should be
+ # represented directly using the `Status` message.
+ #
+ # - Logging. If some API errors are stored in logs, the message `Status` could
+ # be used directly after any stripping needed for security/privacy reasons.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a
+ # common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
},
],
}</pre>