Api-roll 42: 2016-11-08

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 223 matching lines @@
    * [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
    *
    * [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
+   *
    * [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.
    *
    * [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.
    *
    * 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 teacherId, core.int pageSize, core.String pageToken}) {
+  async.Future<ListCoursesResponse> list({core.String studentId, core.String teacherId, core.List<core.String> courseStates, core.int pageSize, 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 (studentId != null) {
       _queryParams["studentId"] = [studentId];
     }
     if (teacherId != null) {
       _queryParams["teacherId"] = [teacherId];
     }
+    if (courseStates != null) {
+      _queryParams["courseStates"] = courseStates;
+    }
     if (pageSize != null) {
       _queryParams["pageSize"] = ["${pageSize}"];
     }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
 
     _url = 'v1/courses';
 
     var _response = _requester.request(_url,
@@ skipping 1846 matching lines @@
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new GuardianInvitation.fromJson(data));
   }
 
   /**
    * Returns a list of guardian invitations that the requesting user is
    * permitted to view, filtered by the parameters provided. This method returns
    * the following error codes: * `PERMISSION_DENIED` if a `student_id` is
    * specified, and the requesting user is not permitted to view guardian
-   * invitations for that student, if guardians are not enabled for the domain
-   * in question, or for other access errors. * `INVALID_ARGUMENT` if a
-   * `student_id` is specified, but its format cannot be recognized (it is not
+   * invitations for that student, if `"-"` is specified as the `student_id` and
+   * the user is not a domain administrator, if guardians are not enabled for
+   * the domain in question, or for other access errors. * `INVALID_ARGUMENT` if
+   * a `student_id` is specified, but its format cannot be recognized (it is not
    * an email address, nor a `student_id` from the API, nor the literal string
    * `me`). May also be returned if an invalid `page_token` or `state` is
    * provided. * `NOT_FOUND` if a `student_id` is specified, and its format can
    * be recognized, but Classroom has no record of that student.
    *
    * Request parameters:
    *
    * [studentId] - The ID of the student whose guardian invitations are to be
    * returned. 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
+   * literal `"me"`, indicating the requesting user * the string literal `"-"`,
+   * indicating that results should be returned for all students that the
+   * requesting user is permitted to view guardian invitations.
    *
    * [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.
    *
    * [pageToken] - nextPageToken value returned from a previous list call,
    * indicating that the subsequent page of results should be returned. The list
@@ skipping 230 matching lines @@
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Guardian.fromJson(data));
   }
 
   /**
    * Returns a list of guardians that the requesting user is permitted to view,
-   * restricted to those that match the request. This method returns the
-   * following error codes: * `PERMISSION_DENIED` if a `student_id` is
-   * specified, and the requesting user is not permitted to view guardian
-   * information for that student, if guardians are not enabled for the domain
-   * in question, if the `invited_email_address` filter is set by a user who is
-   * not a domain administrator, or for other access errors. *
-   * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be
-   * recognized (it is not an email address, nor a `student_id` from the API,
-   * nor the literal string `me`). May also be returned if an invalid
-   * `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and
-   * its format can be recognized, but Classroom has no record of that student.
+   * restricted to those that match the request. To list guardians for any
+   * student that the requesting user may view guardians for, use the literal
+   * character `-` for the student ID. This method returns the following error
+   * codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the
+   * requesting user is not permitted to view guardian information for that
+   * student, if `"-"` is specified as the `student_id` and the user is not a
+   * domain administrator, if guardians are not enabled for the domain in
+   * question, if the `invited_email_address` filter is set by a user who is not
+   * a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if
+   * a `student_id` is specified, but its format cannot be recognized (it is not
+   * an email address, nor a `student_id` from the API, nor the literal string
+   * `me`). May also be returned if an invalid `page_token` is provided. *
+   * `NOT_FOUND` if a `student_id` is specified, and its format can be
+   * recognized, but Classroom has no record of that student.
    *
    * Request parameters:
    *
    * [studentId] - Filter results by the student who the guardian is linked to.
    * 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
+   * indicating the requesting user * the string literal `"-"`, indicating that
+   * results should be returned for all students that the requesting user has
+   * access to view.
    *
    * [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.
    *
    * [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
@@ skipping 190 matching lines @@
    * Biology." If set, this field must be a valid UTF-8 string and no longer
    * than 3600 characters.
    */
   core.String descriptionHeading;
   /**
    * Enrollment code to use when joining this course. Specifying this field in a
    * course update mask results in an error. Read-only.
    */
   core.String enrollmentCode;
   /**
+   * Whether or not guardian notifications are enabled for this course.
+   * Read-only.
+   */
+  core.bool guardiansEnabled;
+  /**
    * Identifier for this course assigned by Classroom. When creating a course,
    * you may optionally set this identifier to an alias string in the request to
    * create a corresponding alias. The `id` is still assigned by Classroom and
    * cannot be updated after the course is created. Specifying this field in a
    * course update mask results in an error.
    */
   core.String id;
   /**
    * Name of the course. For example, "10th Grade Biology". The name is
    * required. It must be between 1 and 750 characters and a valid UTF-8 string.
@@ skipping 56 matching lines @@
     }
     if (_json.containsKey("description")) {
       description = _json["description"];
     }
     if (_json.containsKey("descriptionHeading")) {
       descriptionHeading = _json["descriptionHeading"];
     }
     if (_json.containsKey("enrollmentCode")) {
       enrollmentCode = _json["enrollmentCode"];
     }
+    if (_json.containsKey("guardiansEnabled")) {
+      guardiansEnabled = _json["guardiansEnabled"];
+    }
     if (_json.containsKey("id")) {
       id = _json["id"];
     }
     if (_json.containsKey("name")) {
       name = _json["name"];
     }
     if (_json.containsKey("ownerId")) {
       ownerId = _json["ownerId"];
     }
     if (_json.containsKey("room")) {
@@ skipping 32 matching lines @@
     }
     if (description != null) {
       _json["description"] = description;
     }
     if (descriptionHeading != null) {
       _json["descriptionHeading"] = descriptionHeading;
     }
     if (enrollmentCode != null) {
       _json["enrollmentCode"] = enrollmentCode;
     }
+    if (guardiansEnabled != null) {
+      _json["guardiansEnabled"] = guardiansEnabled;
+    }
     if (id != null) {
       _json["id"] = id;
     }
     if (name != null) {
       _json["name"] = name;
     }
     if (ownerId != null) {
       _json["ownerId"] = ownerId;
     }
     if (room != null) {
@@ skipping 1779 matching lines @@
     }
     if (thumbnailUrl != null) {
       _json["thumbnailUrl"] = thumbnailUrl;
     }
     if (title != null) {
       _json["title"] = title;
     }
     return _json;
   }
 }