Api-Roll 52: 2017-07-31

generated/googleapis/lib/people/v1.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.people.v1;
 
 import 'dart:core' as core;
 import 'dart:async' as async;
 import 'dart:convert' as convert;
 
 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
 import 'package:http/http.dart' as http;
@@ skipping 50 matching lines @@
 
   ContactGroupsResourceApi(commons.ApiRequester client) : 
       _requester = client;
 
   /**
    * Get a list of contact groups owned by the authenticated user by specifying
    * a list of contact group resource names.
    *
    * Request parameters:
    *
+   * [resourceNames] - The resource names of the contact groups to get.
+   *
    * [maxMembers] - Specifies the maximum number of members to return for each
    * group.
    *
-   * [resourceNames] - The resource names of the contact groups to get.
-   *
    * Completes with a [BatchGetContactGroupsResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
-  async.Future<BatchGetContactGroupsResponse> batchGet({core.int maxMembers, core.List<core.String> resourceNames}) {
+  async.Future<BatchGetContactGroupsResponse> batchGet({core.List<core.String> resourceNames, core.int maxMembers}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
+    if (resourceNames != null) {
+      _queryParams["resourceNames"] = resourceNames;
+    }
     if (maxMembers != null) {
       _queryParams["maxMembers"] = ["${maxMembers}"];
     }
-    if (resourceNames != null) {
-      _queryParams["resourceNames"] = resourceNames;
-    }
 
     _url = 'v1/contactGroups:batchGet';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 131 matching lines @@
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new ContactGroup.fromJson(data));
   }
 
   /**
    * List all contact groups owned by the authenticated user. Members of the
    * contact groups are not populated.
    *
    * Request parameters:
    *
+   * [pageSize] - The maximum number of resources to return.
+   *
    * [syncToken] - A sync token, returned by a previous call to
    * `contactgroups.list`.
    * Only resources changed since the sync token was created will be returned.
    *
    * [pageToken] - The next_page_token value returned from a previous call to
    * [ListContactGroups](/people/api/rest/v1/contactgroups/list).
    * Requests the next page of resources.
    *
-   * [pageSize] - The maximum number of resources to return.
-   *
    * Completes with a [ListContactGroupsResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
-  async.Future<ListContactGroupsResponse> list({core.String syncToken, core.String pageToken, core.int pageSize}) {
+  async.Future<ListContactGroupsResponse> list({core.int pageSize, core.String syncToken, core.String pageToken}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
+    if (pageSize != null) {
+      _queryParams["pageSize"] = ["${pageSize}"];
+    }
     if (syncToken != null) {
       _queryParams["syncToken"] = [syncToken];
     }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
-    if (pageSize != null) {
-      _queryParams["pageSize"] = ["${pageSize}"];
-    }
 
     _url = 'v1/contactGroups';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new ListContactGroupsResponse.fromJson(data));
   }
 
   /**
    * Update the name of an existing contact group owned by the authenticated
    * user.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [resourceName] - The resource name for the contact group, assigned by the
    * server. An ASCII
-   * string, in the form of `contactGroups/<contact_group_id>`.
+   * string, in the form of `contactGroups/`<var>contact_group_id</var>.
    * Value must have pattern "^contactGroups/[^/]+$".
    *
    * Completes with a [ContactGroup].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
@@ skipping 178 matching lines @@
    * `people/me` to indicate the authenticated user.
    * <br>
    * The request throws a 400 error if 'personFields' is not specified.
    *
    * Request parameters:
    *
    * [resourceName] - The resource name of the person to provide information
    * about.
    *
    * - To get information about the authenticated user, specify `people/me`.
-   * - To get information about a google account, specify `people/<account_id>`.
+   * - To get information about a google account, specify
+   *  `people/`<var>account_id</var>.
    * - To get information about a contact, specify the resource name that
    *   identifies the contact as returned by
    * [`people.connections.list`](/people/api/rest/v1/people.connections/list).
    * Value must have pattern "^people/[^/]+$".
    *
    * [personFields] - **Required.** A field mask to restrict which fields on the
    * person are
    * returned. Valid values are:
    *
    * * addresses
@@ skipping 69 matching lines @@
 
   /**
    * Provides information about a list of specific people by specifying a list
    * of requested resource names. Use `people/me` to indicate the authenticated
    * user.
    * <br>
    * The request throws a 400 error if 'personFields' is not specified.
    *
    * Request parameters:
    *
-   * [requestMask_includeField] - **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`.
-   *
-   * [resourceNames] - The resource name, such as one returned by
-   * [`people.connections.list`](/people/api/rest/v1/people.connections/list),
-   * of one of the people to provide information about. You can include this
-   * parameter up to 50 times in one request.
-   *
    * [personFields] - **Required.** A field mask to restrict which fields on
    * each person are
    * returned. Valid values are:
    *
    * * addresses
    * * ageRanges
    * * biographies
    * * birthdays
    * * braggingRights
    * * coverPhotos
@@ skipping 12 matching lines @@
    * * phoneNumbers
    * * photos
    * * relations
    * * relationshipInterests
    * * relationshipStatuses
    * * residences
    * * skills
    * * taglines
    * * urls
    *
+   * [requestMask_includeField] - **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`.
+   *
+   * [resourceNames] - The resource names of the people to provide information
+   * about.
+   *
+   * - To get information about the authenticated user, specify `people/me`.
+   * - To get information about a google account, specify
+   *   `people/`<var>account_id</var>.
+   * - To get information about a contact, specify the resource name that
+   *   identifies the contact as returned by
+   * [`people.connections.list`](/people/api/rest/v1/people.connections/list).
+   *
+   * You can include up to 50 resource names in one request.
+   *
    * Completes with a [GetPeopleResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
-  async.Future<GetPeopleResponse> getBatchGet({core.String requestMask_includeField, core.List<core.String> resourceNames, core.String personFields}) {
+  async.Future<GetPeopleResponse> getBatchGet({core.String personFields, core.String requestMask_includeField, core.List<core.String> resourceNames}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
+    if (personFields != null) {
+      _queryParams["personFields"] = [personFields];
+    }
     if (requestMask_includeField != null) {
       _queryParams["requestMask.includeField"] = [requestMask_includeField];
     }
     if (resourceNames != null) {
       _queryParams["resourceNames"] = resourceNames;
     }
-    if (personFields != null) {
-      _queryParams["personFields"] = [personFields];
-    }
 
     _url = 'v1/people:batchGet';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 13 matching lines @@
    * different than the contact's etag, which indicates the contact has changed
    * since its data was read. Clients should get the latest person and re-apply
    * their updates to the latest person.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [resourceName] - The resource name for the person, assigned by the server.
    * An ASCII string
-   * with a max length of 27 characters, in the form of `people/<person_id>`.
+   * with a max length of 27 characters, in the form of
+   * `people/`<var>person_id</var>.
    * Value must have pattern "^people/[^/]+$".
    *
    * [updatePersonFields] - **Required.** A field mask to restrict which fields
    * on the person are
    * updated. Valid values are:
    *
    * * addresses
    * * biographies
    * * birthdays
    * * braggingRights
@@ skipping 65 matching lines @@
    * connected profiles.
    * <br>
    * The request throws a 400 error if 'personFields' is not specified.
    *
    * Request parameters:
    *
    * [resourceName] - The resource name to return connections for. Only
    * `people/me` is valid.
    * Value must have pattern "^people/[^/]+$".
    *
-   * [syncToken] - A sync token, returned by a previous call to
-   * `people.connections.list`.
-   * Only resources changed since the sync token was created will be returned.
-   *
    * [personFields] - **Required.** A field mask to restrict which fields on
    * each person are
    * returned. Valid values are:
    *
    * * addresses
    * * ageRanges
    * * biographies
    * * birthdays
    * * braggingRights
    * * coverPhotos
@@ skipping 35 matching lines @@
    *
    * [pageSize] - The number of connections to include in the response. Valid
    * values are
    * between 1 and 2000, inclusive. Defaults to 100.
    *
    * [requestMask_includeField] - **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`.
    *
+   * [syncToken] - A sync token, returned by a previous call to
+   * `people.connections.list`.
+   * Only resources changed since the sync token was created will be returned.
+   *
    * Completes with a [ListConnectionsResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
-  async.Future<ListConnectionsResponse> list(core.String resourceName, {core.String syncToken, core.String personFields, core.String sortOrder, core.bool requestSyncToken, core.String pageToken, core.int pageSize, core.String requestMask_includeField}) {
+  async.Future<ListConnectionsResponse> list(core.String resourceName, {core.String personFields, core.String sortOrder, core.bool requestSyncToken, core.String pageToken, core.int pageSize, core.String requestMask_includeField, core.String syncToken}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (resourceName == null) {
       throw new core.ArgumentError("Parameter resourceName is required.");
     }
-    if (syncToken != null) {
-      _queryParams["syncToken"] = [syncToken];
-    }
     if (personFields != null) {
       _queryParams["personFields"] = [personFields];
     }
     if (sortOrder != null) {
       _queryParams["sortOrder"] = [sortOrder];
     }
     if (requestSyncToken != null) {
       _queryParams["requestSyncToken"] = ["${requestSyncToken}"];
     }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
     if (pageSize != null) {
       _queryParams["pageSize"] = ["${pageSize}"];
     }
     if (requestMask_includeField != null) {
       _queryParams["requestMask.includeField"] = [requestMask_includeField];
     }
+    if (syncToken != null) {
+      _queryParams["syncToken"] = [syncToken];
+    }
 
     _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resourceName') + '/connections';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 345 matching lines @@
   core.List<core.String> memberResourceNames;
   /** Metadata about the contact group. */
   ContactGroupMetadata metadata;
   /**
    * The contact group name set by the group owner or a system provided name
    * for system groups.
    */
   core.String name;
   /**
    * The resource name for the contact group, assigned by the server. An ASCII
-   * string, in the form of `contactGroups/<contact_group_id>`.
+   * string, in the form of `contactGroups/`<var>contact_group_id</var>.
    */
   core.String resourceName;
 
   ContactGroup();
 
   ContactGroup.fromJson(core.Map _json) {
     if (_json.containsKey("etag")) {
       etag = _json["etag"];
     }
     if (_json.containsKey("formattedName")) {
@@ skipping 842 matching lines @@
       _json["metadata"] = (metadata).toJson();
     }
     return _json;
   }
 }
 
 /** A request to modify an existing contact group's members. */
 class ModifyContactGroupMembersRequest {
   /**
    * The resource names of the contact people to add in the form of in the form
-   * `people/<person_id>`.
+   * `people/`<var>person_id</var>.
    */
   core.List<core.String> resourceNamesToAdd;
   /**
    * The resource names of the contact people to remove in the form of in the
-   * form of `people/<person_id>`.
+   * form of `people/`<var>person_id</var>.
    */
   core.List<core.String> resourceNamesToRemove;
 
   ModifyContactGroupMembersRequest();
 
   ModifyContactGroupMembersRequest.fromJson(core.Map _json) {
     if (_json.containsKey("resourceNamesToAdd")) {
       resourceNamesToAdd = _json["resourceNamesToAdd"];
     }
     if (_json.containsKey("resourceNamesToRemove")) {
@@ skipping 32 matching lines @@
       _json["notFoundResourceNames"] = notFoundResourceNames;
     }
     return _json;
   }
 }
 
 /** A person's name. If the name is a mononym, the family name is empty. */
 class Name {
   /**
    * The read-only display name formatted according to the locale specified by
-   * the viewer's account or the <code>Accept-Language</code> HTTP header.
+   * the viewer's account or the `Accept-Language` HTTP header.
    */
   core.String displayName;
   /**
    * The read-only display name with the last name first formatted according to
    * the locale specified by the viewer's account or the
-   * <code>Accept-Language</code> HTTP header.
+   * `Accept-Language` HTTP header.
    */
   core.String displayNameLastFirst;
   /** The family name. */
   core.String familyName;
   /** The given name. */
   core.String givenName;
   /** The honorific prefixes, such as `Mrs.` or `Dr.` */
   core.String honorificPrefix;
   /** The honorific suffixes, such as `Jr.` */
   core.String honorificSuffix;
@@ skipping 403 matching lines @@
   /** The person's relations. */
   core.List<Relation> relations;
   /** The person's read-only relationship interests. */
   core.List<RelationshipInterest> relationshipInterests;
   /** The person's read-only relationship statuses. */
   core.List<RelationshipStatus> relationshipStatuses;
   /** The person's residences. */
   core.List<Residence> residences;
   /**
    * The resource name for the person, assigned by the server. An ASCII string
-   * with a max length of 27 characters, in the form of `people/<person_id>`.
+   * with a max length of 27 characters, in the form of
+   * `people/`<var>person_id</var>.
    */
   core.String resourceName;
   /** The person's skills. */
   core.List<Skill> skills;
   /** The person's read-only taglines. */
   core.List<Tagline> taglines;
   /** The person's associated URLs. */
   core.List<Url> urls;
 
   Person();
@@ skipping 399 matching lines @@
 
 /**
  * A person's read-only photo. A picture shown next to the person's name to
  * help others recognize the person.
  */
 class Photo {
   /** Metadata about the photo. */
   FieldMetadata metadata;
   /**
    * 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:
+   * parameter `sz=`<var>size</var> at the end of the url. Example:
    * `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
    */
   core.String url;
 
   Photo();
 
   Photo.fromJson(core.Map _json) {
     if (_json.containsKey("metadata")) {
       metadata = new FieldMetadata.fromJson(_json["metadata"]);
     }
@@ skipping 290 matching lines @@
     if (value != null) {
       _json["value"] = value;
     }
     return _json;
   }
 }
 
 /** The source of a field. */
 class Source {
   /**
+   * **Only populated in `person.metadata.sources`.**
+   *
    * The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
-   * source. Used for web cache validation. Only populated in
-   * person.metadata.sources.
+   * source. Used for web cache validation.
    */
   core.String etag;
   /** The unique identifier within the source type generated by the server. */
   core.String id;
-  /** Metadata about a source of type PROFILE. */
+  /**
+   * **Only populated in `person.metadata.sources`.**
+   *
+   * Metadata about a source of type PROFILE.
+   */
   ProfileMetadata profileMetadata;
   /**
    * The source type.
    * Possible string values are:
    * - "SOURCE_TYPE_UNSPECIFIED" : Unspecified.
    * - "ACCOUNT" : [Google Account](https://accounts.google.com).
    * - "PROFILE" : [Google profile](https://profiles.google.com). You can view
    * the
    * profile at https://profiles.google.com/<var>id</var> where
    * <var>id</var> is the source id.
    * - "DOMAIN_PROFILE" : [Google Apps domain
    * profile](https://admin.google.com).
    * - "CONTACT" : [Google contact](https://contacts.google.com). You can view
    * the
    * contact at https://contact.google.com/<var>id</var> where <var>id</var>
    * is the source id.
    */
   core.String type;
-  /** Last update timestamp of this source. */
+  /**
+   * **Only populated in `person.metadata.sources`.**
+   *
+   * Last update timestamp of this source.
+   */
   core.String updateTime;
 
   Source();
 
   Source.fromJson(core.Map _json) {
     if (_json.containsKey("etag")) {
       etag = _json["etag"];
     }
     if (_json.containsKey("id")) {
       id = _json["id"];
@@ skipping 241 matching lines @@
     }
     if (type != null) {
       _json["type"] = type;
     }
     if (value != null) {
       _json["value"] = value;
     }
     return _json;
   }
 }