Api-Roll 51: 2017-07-10

generated/googleapis/lib/classroom/v1.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.classroom.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 236 matching lines @@
    * restricted to those that match the request.
    *
    * This method returns the following error codes:
    *
    * * `PERMISSION_DENIED` for access errors.
    * * `INVALID_ARGUMENT` if the query argument is malformed.
    * * `NOT_FOUND` if any users specified in the query arguments do not exist.
    *
    * Request parameters:
    *
+   * [pageSize] - Maximum number of items to return. Zero or unspecified
+   * indicates that the
+   * server may assign a maximum.
+   *
+   * The server may return fewer than the specified number of results.
+   *
+   * [courseStates] - Restricts returned courses to those in one of the
+   * specified states
+   * The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
+   *
+   * [teacherId] - Restricts returned courses to those having a teacher with the
+   * specified
+   * identifier. The identifier can be one of the following:
+   *
+   * * the numeric identifier for the user
+   * * the email address of the user
+   * * the string literal `"me"`, indicating the requesting user
+   *
    * [studentId] - Restricts returned courses to those having a student with the
    * specified
    * identifier. The identifier can be one of the following:
    *
    * * the numeric identifier for the user
    * * the email address of the user
    * * the string literal `"me"`, indicating the requesting user
    *
    * [pageToken] - nextPageToken
    * value returned from a previous
    * list call,
    * indicating that the subsequent page of results should be returned.
    *
    * The list request must be
    * otherwise identical to the one that resulted in this token.
    *
-   * [pageSize] - Maximum number of items to return. Zero or unspecified
-   * indicates that the
-   * server may assign a maximum.
-   *
-   * The server may return fewer than the specified number of results.
-   *
-   * [teacherId] - Restricts returned courses to those having a teacher with the
-   * specified
-   * identifier. The identifier can be one of the following:
-   *
-   * * the numeric identifier for the user
-   * * the email address of the user
-   * * the string literal `"me"`, indicating the requesting user
-   *
-   * [courseStates] - Restricts returned courses to those in one of the
-   * specified states
-   * The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
-   *
    * Completes with a [ListCoursesResponse].
    *
    * 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<ListCoursesResponse> list({core.String studentId, core.String pageToken, core.int pageSize, core.String teacherId, core.List<core.String> courseStates}) {
+  async.Future<ListCoursesResponse> list({core.int pageSize, core.List<core.String> courseStates, core.String teacherId, core.String studentId, 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 (courseStates != null) {
+      _queryParams["courseStates"] = courseStates;
+    }
+    if (teacherId != null) {
+      _queryParams["teacherId"] = [teacherId];
+    }
     if (studentId != null) {
       _queryParams["studentId"] = [studentId];
     }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
-    if (pageSize != null) {
-      _queryParams["pageSize"] = ["${pageSize}"];
-    }
-    if (teacherId != null) {
-      _queryParams["teacherId"] = [teacherId];
-    }
-    if (courseStates != null) {
-      _queryParams["courseStates"] = courseStates;
-    }
 
     _url = 'v1/courses';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 515 matching lines @@
    * the requested course or for access errors.
    * * `INVALID_ARGUMENT` if the request is malformed.
    * * `NOT_FOUND` if the requested course does not exist.
    *
    * Request parameters:
    *
    * [courseId] - Identifier of the course.
    * This identifier can be either the Classroom-assigned identifier or an
    * alias.
    *
-   * [pageSize] - Maximum number of items to return. Zero or unspecified
-   * indicates that the
-   * server may assign a maximum.
+   * [pageToken] - nextPageToken
+   * value returned from a previous
+   * list call,
+   * indicating that the subsequent page of results should be returned.
    *
-   * The server may return fewer than the specified number of results.
-   *
-   * [courseWorkStates] - Restriction on the work status to return. Only
-   * courseWork that matches
-   * is returned. If unspecified, items with a work status of `PUBLISHED`
-   * is returned.
+   * The list request
+   * must be otherwise identical to the one that resulted in this token.
    *
    * [orderBy] - Optional sort ordering for results. A comma-separated list of
    * fields with
    * an optional sort direction keyword. Supported fields are `updateTime`
    * and `dueDate`. Supported direction keywords are `asc` and `desc`.
    * If not specified, `updateTime desc` is the default behavior.
    * Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`
    *
-   * [pageToken] - nextPageToken
-   * value returned from a previous
-   * list call,
-   * indicating that the subsequent page of results should be returned.
+   * [pageSize] - Maximum number of items to return. Zero or unspecified
+   * indicates that the
+   * server may assign a maximum.
    *
-   * The list request
-   * must be otherwise identical to the one that resulted in this token.
+   * The server may return fewer than the specified number of results.
+   *
+   * [courseWorkStates] - Restriction on the work status to return. Only
+   * courseWork that matches
+   * is returned. If unspecified, items with a work status of `PUBLISHED`
+   * is returned.
    *
    * Completes with a [ListCourseWorkResponse].
    *
    * 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<ListCourseWorkResponse> list(core.String courseId, {core.int pageSize, core.List<core.String> courseWorkStates, core.String orderBy, core.String pageToken}) {
+  async.Future<ListCourseWorkResponse> list(core.String courseId, {core.String pageToken, core.String orderBy, core.int pageSize, core.List<core.String> courseWorkStates}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (courseId == null) {
       throw new core.ArgumentError("Parameter courseId is required.");
     }
+    if (pageToken != null) {
+      _queryParams["pageToken"] = [pageToken];
+    }
+    if (orderBy != null) {
+      _queryParams["orderBy"] = [orderBy];
+    }
     if (pageSize != null) {
       _queryParams["pageSize"] = ["${pageSize}"];
     }
     if (courseWorkStates != null) {
       _queryParams["courseWorkStates"] = courseWorkStates;
     }
-    if (orderBy != null) {
-      _queryParams["orderBy"] = [orderBy];
-    }
-    if (pageToken != null) {
-      _queryParams["pageToken"] = [pageToken];
-    }
 
     _url = 'v1/courses/' + commons.Escaper.ecapeVariable('$courseId') + '/courseWork';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 41 matching lines @@
    * not set in the CourseWork object, an `INVALID_ARGUMENT` error will be
    * returned.
    *
    * The following fields may be specified by teachers:
    * * `title`
    * * `description`
    * * `state`
    * * `due_date`
    * * `due_time`
    * * `max_points`
+   * * `scheduled_time`
    * * `submission_modification_mode`
    *
    * Completes with a [CourseWork].
    *
    * 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 116 matching lines @@
    * Request parameters:
    *
    * [courseId] - Identifier of the course.
    * This identifier can be either the Classroom-assigned identifier or an
    * alias.
    *
    * [courseWorkId] - Identifer of the student work to request.
    * This may be set to the string literal `"-"` to request student work for
    * all course work in the specified course.
    *
-   * [late] - Requested lateness value. If specified, returned student
-   * submissions are
-   * restricted by the requested value.
-   * If unspecified, submissions are returned regardless of `late` value.
-   * Possible string values are:
-   * - "LATE_VALUES_UNSPECIFIED" : A LATE_VALUES_UNSPECIFIED.
-   * - "LATE_ONLY" : A LATE_ONLY.
-   * - "NOT_LATE_ONLY" : A NOT_LATE_ONLY.
-   *
    * [pageToken] - nextPageToken
    * value returned from a previous
    * list call,
    * indicating that the subsequent page of results should be returned.
    *
    * The list request
    * must be otherwise identical to the one that resulted in this token.
    *
    * [pageSize] - Maximum number of items to return. Zero or unspecified
    * indicates that the
    * server may assign a maximum.
    *
    * The server may return fewer than the specified number of results.
    *
    * [states] - Requested submission states. If specified, returned student
    * submissions
    * match one of the specified submission states.
    *
    * [userId] - Optional argument to restrict returned student work to those
    * owned by the
    * student with the specified identifier. The identifier can be one of the
    * following:
    *
    * * the numeric identifier for the user
    * * the email address of the user
    * * the string literal `"me"`, indicating the requesting user
    *
+   * [late] - Requested lateness value. If specified, returned student
+   * submissions are
+   * restricted by the requested value.
+   * If unspecified, submissions are returned regardless of `late` value.
+   * Possible string values are:
+   * - "LATE_VALUES_UNSPECIFIED" : A LATE_VALUES_UNSPECIFIED.
+   * - "LATE_ONLY" : A LATE_ONLY.
+   * - "NOT_LATE_ONLY" : A NOT_LATE_ONLY.
+   *
    * Completes with a [ListStudentSubmissionsResponse].
    *
    * 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<ListStudentSubmissionsResponse> list(core.String courseId, core.String courseWorkId, {core.String late, core.String pageToken, core.int pageSize, core.List<core.String> states, core.String userId}) {
+  async.Future<ListStudentSubmissionsResponse> list(core.String courseId, core.String courseWorkId, {core.String pageToken, core.int pageSize, core.List<core.String> states, core.String userId, core.String late}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (courseId == null) {
       throw new core.ArgumentError("Parameter courseId is required.");
     }
     if (courseWorkId == null) {
       throw new core.ArgumentError("Parameter courseWorkId is required.");
     }
-    if (late != null) {
-      _queryParams["late"] = [late];
-    }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
     if (pageSize != null) {
       _queryParams["pageSize"] = ["${pageSize}"];
     }
     if (states != null) {
       _queryParams["states"] = states;
     }
     if (userId != null) {
       _queryParams["userId"] = [userId];
     }
+    if (late != null) {
+      _queryParams["late"] = [late];
+    }
 
     _url = 'v1/courses/' + commons.Escaper.ecapeVariable('$courseId') + '/courseWork/' + commons.Escaper.ecapeVariable('$courseWorkId') + '/studentSubmissions';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 588 matching lines @@
    *
    * * `NOT_FOUND` if the course does not exist.
    * * `PERMISSION_DENIED` for access errors.
    *
    * Request parameters:
    *
    * [courseId] - Identifier of the course.
    * This identifier can be either the Classroom-assigned identifier or an
    * alias.
    *
-   * [pageSize] - Maximum number of items to return. Zero means no maximum.
-   *
-   * The server may return fewer than the specified number of results.
-   *
    * [pageToken] - nextPageToken
    * value returned from a previous
    * list call, indicating that
    * the subsequent page of results should be returned.
    *
    * The list request must be
    * otherwise identical to the one that resulted in this token.
    *
+   * [pageSize] - Maximum number of items to return. Zero means no maximum.
+   *
+   * The server may return fewer than the specified number of results.
+   *
    * Completes with a [ListStudentsResponse].
    *
    * 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<ListStudentsResponse> list(core.String courseId, {core.int pageSize, core.String pageToken}) {
+  async.Future<ListStudentsResponse> list(core.String courseId, {core.String pageToken, core.int pageSize}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (courseId == null) {
       throw new core.ArgumentError("Parameter courseId is required.");
     }
+    if (pageToken != null) {
+      _queryParams["pageToken"] = [pageToken];
+    }
     if (pageSize != null) {
       _queryParams["pageSize"] = ["${pageSize}"];
     }
-    if (pageToken != null) {
-      _queryParams["pageToken"] = [pageToken];
-    }
 
     _url = 'v1/courses/' + commons.Escaper.ecapeVariable('$courseId') + '/students';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 461 matching lines @@
    *
    * *Note:* At least one of `user_id` or `course_id` must be supplied. Both
    * fields can be supplied.
    *
    * This method returns the following error codes:
    *
    * * `PERMISSION_DENIED` for access errors.
    *
    * Request parameters:
    *
-   * [userId] - Restricts returned invitations to those for a specific user. The
-   * identifier
-   * can be one of the following:
-   *
-   * * the numeric identifier for the user
-   * * the email address of the user
-   * * the string literal `"me"`, indicating the requesting user
-   *
    * [pageToken] - nextPageToken
    * value returned from a previous
    * list call, indicating
    * that the subsequent page of results should be returned.
    *
    * The list request must be
    * otherwise identical to the one that resulted in this token.
    *
+   * [userId] - Restricts returned invitations to those for a specific user. The
+   * identifier
+   * can be one of the following:
+   *
+   * * the numeric identifier for the user
+   * * the email address of the user
+   * * the string literal `"me"`, indicating the requesting user
+   *
    * [pageSize] - Maximum number of items to return. Zero means no maximum.
    *
    * The server may return fewer than the specified number of results.
    *
    * [courseId] - Restricts returned invitations to those for a course with the
    * specified
    * identifier.
    *
    * Completes with a [ListInvitationsResponse].
    *
    * 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<ListInvitationsResponse> list({core.String userId, core.String pageToken, core.int pageSize, core.String courseId}) {
+  async.Future<ListInvitationsResponse> list({core.String pageToken, core.String userId, core.int pageSize, core.String courseId}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
+    if (pageToken != null) {
+      _queryParams["pageToken"] = [pageToken];
+    }
     if (userId != null) {
       _queryParams["userId"] = [userId];
     }
-    if (pageToken != null) {
-      _queryParams["pageToken"] = [pageToken];
-    }
     if (pageSize != null) {
       _queryParams["pageSize"] = ["${pageSize}"];
     }
     if (courseId != null) {
       _queryParams["courseId"] = [courseId];
     }
 
     _url = 'v1/invitations';
 
     var _response = _requester.request(_url,
@@ skipping 242 matching lines @@
    *   invitations.
    *
    * [pageToken] - nextPageToken
    * value returned from a previous
    * list call,
    * indicating that the subsequent page of results should be returned.
    *
    * The list request
    * must be otherwise identical to the one that resulted in this token.
    *
-   * [invitedEmailAddress] - If specified, only results with the specified
-   * `invited_email_address`
-   * will be returned.
-   *
-   * [states] - If specified, only results with the specified `state` values
-   * will be
-   * returned. Otherwise, results with a `state` of `PENDING` will be returned.
-   *
    * [pageSize] - Maximum number of items to return. Zero or unspecified
    * indicates that the
    * server may assign a maximum.
    *
    * The server may return fewer than the specified number of results.
    *
+   * [states] - If specified, only results with the specified `state` values
+   * will be
+   * returned. Otherwise, results with a `state` of `PENDING` will be returned.
+   *
+   * [invitedEmailAddress] - If specified, only results with the specified
+   * `invited_email_address`
+   * will be returned.
+   *
    * Completes with a [ListGuardianInvitationsResponse].
    *
    * 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<ListGuardianInvitationsResponse> list(core.String studentId, {core.String pageToken, core.String invitedEmailAddress, core.List<core.String> states, core.int pageSize}) {
+  async.Future<ListGuardianInvitationsResponse> list(core.String studentId, {core.String pageToken, core.int pageSize, core.List<core.String> states, core.String invitedEmailAddress}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (studentId == null) {
       throw new core.ArgumentError("Parameter studentId is required.");
     }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
+    if (pageSize != null) {
+      _queryParams["pageSize"] = ["${pageSize}"];
+    }
+    if (states != null) {
+      _queryParams["states"] = states;
+    }
     if (invitedEmailAddress != null) {
       _queryParams["invitedEmailAddress"] = [invitedEmailAddress];
     }
-    if (states != null) {
-      _queryParams["states"] = states;
-    }
-    if (pageSize != null) {
-      _queryParams["pageSize"] = ["${pageSize}"];
-    }
 
     _url = 'v1/userProfiles/' + commons.Escaper.ecapeVariable('$studentId') + '/guardianInvitations';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 252 matching lines @@
    *   all students that the requesting user has access to view.
    *
    * [pageToken] - nextPageToken
    * value returned from a previous
    * list call,
    * indicating that the subsequent page of results should be returned.
    *
    * The list request
    * must be otherwise identical to the one that resulted in this token.
    *
-   * [invitedEmailAddress] - Filter results by the email address that the
-   * original invitation was sent
-   * to, resulting in this guardian link.
-   * This filter can only be used by domain administrators.
-   *
    * [pageSize] - Maximum number of items to return. Zero or unspecified
    * indicates that the
    * server may assign a maximum.
    *
    * The server may return fewer than the specified number of results.
    *
+   * [invitedEmailAddress] - Filter results by the email address that the
+   * original invitation was sent
+   * to, resulting in this guardian link.
+   * This filter can only be used by domain administrators.
+   *
    * Completes with a [ListGuardiansResponse].
    *
    * 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<ListGuardiansResponse> list(core.String studentId, {core.String pageToken, core.String invitedEmailAddress, core.int pageSize}) {
+  async.Future<ListGuardiansResponse> list(core.String studentId, {core.String pageToken, core.int pageSize, core.String invitedEmailAddress}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (studentId == null) {
       throw new core.ArgumentError("Parameter studentId is required.");
     }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
+    if (pageSize != null) {
+      _queryParams["pageSize"] = ["${pageSize}"];
+    }
     if (invitedEmailAddress != null) {
       _queryParams["invitedEmailAddress"] = [invitedEmailAddress];
     }
-    if (pageSize != null) {
-      _queryParams["pageSize"] = ["${pageSize}"];
-    }
 
     _url = 'v1/userProfiles/' + commons.Escaper.ecapeVariable('$studentId') + '/guardians';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 2301 matching lines @@
    * Read-only.
    */
   core.List<GlobalPermission> permissions;
   /**
    * URL of user's profile photo.
    *
    * Read-only.
    */
   core.String photoUrl;
   /**
-   * Whether or not the user is a verified teacher
+   * Represents whether a G Suite for Education user's domain administrator has
+   * explicitly verified them as being a teacher. If the user is not a member of
+   * a G Suite for Education domain, than this field will always be false.
    *
    * Read-only
    */
   core.bool verifiedTeacher;
 
   UserProfile();
 
   UserProfile.fromJson(core.Map _json) {
     if (_json.containsKey("emailAddress")) {
       emailAddress = _json["emailAddress"];
@@ skipping 89 matching lines @@
     }
     if (thumbnailUrl != null) {
       _json["thumbnailUrl"] = thumbnailUrl;
     }
     if (title != null) {
       _json["title"] = title;
     }
     return _json;
   }
 }