Api-Roll 54: 2017-09-11

generated/googleapis/lib/script/v1.dart

Index: generated/googleapis/lib/script/v1.dart
diff --git a/generated/googleapis/lib/script/v1.dart b/generated/googleapis/lib/script/v1.dart
index 86e443b0019180c5b7990059c0c00ba109e9ea29..5bd4e06cb12ac9cc5cda9fd9360c1278097ac24a 100644
--- a/generated/googleapis/lib/script/v1.dart
+++ b/generated/googleapis/lib/script/v1.dart
@@ -9,89 +9,95 @@ import 'dart:convert' as convert;
 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
 import 'package:http/http.dart' as http;
 
-export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
-    ApiRequestError, DetailedApiRequestError;
+export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
+    show ApiRequestError, DetailedApiRequestError;
 
 const core.String USER_AGENT = 'dart-api-client script/v1';
 
-/** Executes functions in Google Apps Script projects. */
+/// Executes functions in Google Apps Script projects.
 class ScriptApi {
-  /** Read, send, delete, and manage your email */
+  /// Read, send, delete, and manage your email
   static const MailGoogleComScope = "https://mail.google.com/";
 
-  /** Manage your calendars */
-  static const WwwGoogleComCalendarFeedsScope = "https://www.google.com/calendar/feeds";
+  /// Manage your calendars
+  static const WwwGoogleComCalendarFeedsScope =
+      "https://www.google.com/calendar/feeds";
 
-  /** Manage your contacts */
+  /// Manage your contacts
   static const WwwGoogleComM8FeedsScope = "https://www.google.com/m8/feeds";
 
-  /** View and manage the provisioning of groups on your domain */
-  static const AdminDirectoryGroupScope = "https://www.googleapis.com/auth/admin.directory.group";
+  /// View and manage the provisioning of groups on your domain
+  static const AdminDirectoryGroupScope =
+      "https://www.googleapis.com/auth/admin.directory.group";
 
-  /** View and manage the provisioning of users on your domain */
-  static const AdminDirectoryUserScope = "https://www.googleapis.com/auth/admin.directory.user";
+  /// View and manage the provisioning of users on your domain
+  static const AdminDirectoryUserScope =
+      "https://www.googleapis.com/auth/admin.directory.user";
 
-  /** View and manage the files in your Google Drive */
+  /// View and manage the files in your Google Drive
   static const DriveScope = "https://www.googleapis.com/auth/drive";
 
-  /** View and manage your forms in Google Drive */
+  /// View and manage your forms in Google Drive
   static const FormsScope = "https://www.googleapis.com/auth/forms";
 
-  /** View and manage forms that this application has been installed in */
-  static const FormsCurrentonlyScope = "https://www.googleapis.com/auth/forms.currentonly";
+  /// View and manage forms that this application has been installed in
+  static const FormsCurrentonlyScope =
+      "https://www.googleapis.com/auth/forms.currentonly";
 
-  /** View and manage your Google Groups */
+  /// View and manage your Google Groups
   static const GroupsScope = "https://www.googleapis.com/auth/groups";
 
-  /** View and manage your spreadsheets in Google Drive */
-  static const SpreadsheetsScope = "https://www.googleapis.com/auth/spreadsheets";
-
-  /** View your email address */
-  static const UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email";
+  /// View and manage your spreadsheets in Google Drive
+  static const SpreadsheetsScope =
+      "https://www.googleapis.com/auth/spreadsheets";
 
+  /// View your email address
+  static const UserinfoEmailScope =
+      "https://www.googleapis.com/auth/userinfo.email";
 
   final commons.ApiRequester _requester;
 
   ScriptsResourceApi get scripts => new ScriptsResourceApi(_requester);
 
-  ScriptApi(http.Client client, {core.String rootUrl: "https://script.googleapis.com/", core.String servicePath: ""}) :
-      _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
+  ScriptApi(http.Client client,
+      {core.String rootUrl: "https://script.googleapis.com/",
+      core.String servicePath: ""})
+      : _requester =
+            new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
 }
 
-
 class ScriptsResourceApi {
   final commons.ApiRequester _requester;
 
-  ScriptsResourceApi(commons.ApiRequester client) : 
-      _requester = client;
-
-  /**
-   * Runs a function in an Apps Script project. The project must be deployed
-   * for use with the Apps Script Execution API.
-   *
-   * This method requires authorization with an OAuth 2.0 token that includes at
-   * least one of the scopes listed in the [Authorization](#authorization)
-   * section; script projects that do not require authorization cannot be
-   * executed through this API. To find the correct scopes to include in the
-   * authentication token, open the project in the script editor, then select
-   * **File > Project properties** and click the **Scopes** tab.
-   *
-   * [request] - The metadata request object.
-   *
-   * Request parameters:
-   *
-   * [scriptId] - The script ID of the script to be executed. To find the script
-   * ID, open
-   * the project in the script editor and select **File > Project properties**.
-   *
-   * Completes with a [Operation].
-   *
-   * 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.
-   */
+  ScriptsResourceApi(commons.ApiRequester client) : _requester = client;
+
+  /// Runs a function in an Apps Script project. The project must be deployed
+  /// for use with the Apps Script Execution API.
+  ///
+  /// This method requires authorization with an OAuth 2.0 token that includes
+  /// at
+  /// least one of the scopes listed in the [Authorization](#authorization)
+  /// section; script projects that do not require authorization cannot be
+  /// executed through this API. To find the correct scopes to include in the
+  /// authentication token, open the project in the script editor, then select
+  /// **File > Project properties** and click the **Scopes** tab.
+  ///
+  /// [request] - The metadata request object.
+  ///
+  /// Request parameters:
+  ///
+  /// [scriptId] - The script ID of the script to be executed. To find the
+  /// script ID, open
+  /// the project in the script editor and select **File > Project
+  /// properties**.
+  ///
+  /// Completes with a [Operation].
+  ///
+  /// 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<Operation> run(ExecutionRequest request, core.String scriptId) {
     var _url = null;
     var _queryParams = new core.Map();
@@ -109,44 +115,36 @@ class ScriptsResourceApi {
 
     _url = 'v1/scripts/' + commons.Escaper.ecapeVariable('$scriptId') + ':run';
 
-    var _response = _requester.request(_url,
-                                       "POST",
-                                       body: _body,
-                                       queryParams: _queryParams,
-                                       uploadOptions: _uploadOptions,
-                                       uploadMedia: _uploadMedia,
-                                       downloadOptions: _downloadOptions);
+    var _response = _requester.request(_url, "POST",
+        body: _body,
+        queryParams: _queryParams,
+        uploadOptions: _uploadOptions,
+        uploadMedia: _uploadMedia,
+        downloadOptions: _downloadOptions);
     return _response.then((data) => new Operation.fromJson(data));
   }
-
 }
 
-
-
-/**
- * An object that provides information about the nature of an error in the Apps
- * Script Execution API. If an
- * `run` call succeeds but the
- * script function (or Apps Script itself) throws an exception, the response
- * body's `error` field contains a
- * `Status` object. The `Status` object's `details` field
- * contains an array with a single one of these `ExecutionError` objects.
- */
+/// An object that provides information about the nature of an error in the
+/// Apps
+/// Script Execution API. If an
+/// `run` call succeeds but the
+/// script function (or Apps Script itself) throws an exception, the response
+/// body's `error` field contains a
+/// `Status` object. The `Status` object's `details` field
+/// contains an array with a single one of these `ExecutionError` objects.
 class ExecutionError {
-  /**
-   * The error message thrown by Apps Script, usually localized into the user's
-   * language.
-   */
+  /// The error message thrown by Apps Script, usually localized into the
+  /// user's
+  /// language.
   core.String errorMessage;
-  /**
-   * The error type, for example `TypeError` or `ReferenceError`. If the error
-   * type is unavailable, this field is not included.
-   */
+
+  /// The error type, for example `TypeError` or `ReferenceError`. If the error
+  /// type is unavailable, this field is not included.
   core.String errorType;
-  /**
-   * An array of objects that provide a stack trace through the script to show
-   * where the execution failed, with the deepest call first.
-   */
+
+  /// An array of objects that provide a stack trace through the script to show
+  /// where the execution failed, with the deepest call first.
   core.List<ScriptStackTraceElement> scriptStackTraceElements;
 
   ExecutionError();
@@ -159,12 +157,15 @@ class ExecutionError {
       errorType = _json["errorType"];
     }
     if (_json.containsKey("scriptStackTraceElements")) {
-      scriptStackTraceElements = _json["scriptStackTraceElements"].map((value) => new ScriptStackTraceElement.fromJson(value)).toList();
+      scriptStackTraceElements = _json["scriptStackTraceElements"]
+          .map((value) => new ScriptStackTraceElement.fromJson(value))
+          .toList();
     }
   }
 
   core.Map<core.String, core.Object> toJson() {
-    final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+    final core.Map<core.String, core.Object> _json =
+        new core.Map<core.String, core.Object>();
     if (errorMessage != null) {
       _json["errorMessage"] = errorMessage;
     }
@@ -172,53 +173,52 @@ class ExecutionError {
       _json["errorType"] = errorType;
     }
     if (scriptStackTraceElements != null) {
-      _json["scriptStackTraceElements"] = scriptStackTraceElements.map((value) => (value).toJson()).toList();
+      _json["scriptStackTraceElements"] =
+          scriptStackTraceElements.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }
 
-/**
- * A request to run the function in a script. The script is identified by the
- * specified `script_id`. Executing a function on a script returns results
- * based on the implementation of the script.
- */
+/// A request to run the function in a script. The script is identified by the
+/// specified `script_id`. Executing a function on a script returns results
+/// based on the implementation of the script.
 class ExecutionRequest {
-  /**
-   * If `true` and the user is an owner of the script, the script runs at the
-   * most recently saved version rather than the version deployed for use with
-   * the Execution API. Optional; default is `false`.
-   */
+  /// If `true` and the user is an owner of the script, the script runs at the
+  /// most recently saved version rather than the version deployed for use with
+  /// the Execution API. Optional; default is `false`.
   core.bool devMode;
-  /**
-   * The name of the function to execute in the given script. The name does not
-   * include parentheses or parameters.
-   */
+
+  /// The name of the function to execute in the given script. The name does
+  /// not
+  /// include parentheses or parameters.
   core.String function;
-  /**
-   * The parameters to be passed to the function being executed. The object type
-   * for each parameter should match the expected type in Apps Script.
-   * Parameters cannot be Apps Script-specific object types (such as a
-   * `Document` or a `Calendar`); they can only be primitive types such as
-   * `string`, `number`, `array`, `object`, or `boolean`. Optional.
-   *
-   * The values for Object must be JSON objects. It can consist of `num`,
-   * `String`, `bool` and `null` as well as `Map` and `List` values.
-   */
+
+  /// The parameters to be passed to the function being executed. The object
+  /// type
+  /// for each parameter should match the expected type in Apps Script.
+  /// Parameters cannot be Apps Script-specific object types (such as a
+  /// `Document` or a `Calendar`); they can only be primitive types such as
+  /// `string`, `number`, `array`, `object`, or `boolean`. Optional.
+  ///
+  /// The values for Object must be JSON objects. It can consist of `num`,
+  /// `String`, `bool` and `null` as well as `Map` and `List` values.
   core.List<core.Object> parameters;
-  /**
-   * For Android add-ons only. An ID that represents the user's current session
-   * in the Android app for Google Docs or Sheets, included as extra data in the
-   * [`Intent`](https://developer.android.com/guide/components/intents-filters.html)
-   * that launches the add-on. When an Android add-on is run with a session
-   * state, it gains the privileges of a
-   * [bound](https://developers.google.com/apps-script/guides/bound) script
-   * &mdash;
-   * that is, it can access information like the user's current cursor position
-   * (in Docs) or selected cell (in Sheets). To retrieve the state, call
-   * `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`.
-   * Optional.
-   */
+
+  /// For Android add-ons only. An ID that represents the user's current
+  /// session
+  /// in the Android app for Google Docs or Sheets, included as extra data in
+  /// the
+  /// [`Intent`](https://developer.android.com/guide/components/intents-filters.html)
+  /// that launches the add-on. When an Android add-on is run with a session
+  /// state, it gains the privileges of a
+  /// [bound](https://developers.google.com/apps-script/guides/bound) script
+  /// &mdash;
+  /// that is, it can access information like the user's current cursor
+  /// position
+  /// (in Docs) or selected cell (in Sheets). To retrieve the state, call
+  /// `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`.
+  /// Optional.
   core.String sessionState;
 
   ExecutionRequest();
@@ -239,7 +239,8 @@ class ExecutionRequest {
   }
 
   core.Map<core.String, core.Object> toJson() {
-    final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+    final core.Map<core.String, core.Object> _json =
+        new core.Map<core.String, core.Object>();
     if (devMode != null) {
       _json["devMode"] = devMode;
     }
@@ -256,25 +257,24 @@ class ExecutionRequest {
   }
 }
 
-/**
- * An object that provides the return value of a function executed through the
- * Apps Script Execution API. If a
- * `run` call succeeds and the
- * script function returns successfully, the response body's
- * `response` field contains this
- * `ExecutionResponse` object.
- */
+/// An object that provides the return value of a function executed through the
+/// Apps Script Execution API. If a
+/// `run` call succeeds and the
+/// script function returns successfully, the response body's
+/// `response` field contains this
+/// `ExecutionResponse` object.
 class ExecutionResponse {
-  /**
-   * The return value of the script function. The type matches the object type
-   * returned in Apps Script. Functions called through the Execution API cannot
-   * return Apps Script-specific objects (such as a `Document` or a `Calendar`);
-   * they can only return primitive types such as a `string`, `number`, `array`,
-   * `object`, or `boolean`.
-   *
-   * The values for Object must be JSON objects. It can consist of `num`,
-   * `String`, `bool` and `null` as well as `Map` and `List` values.
-   */
+  /// The return value of the script function. The type matches the object type
+  /// returned in Apps Script. Functions called through the Execution API
+  /// cannot
+  /// return Apps Script-specific objects (such as a `Document` or a
+  /// `Calendar`);
+  /// they can only return primitive types such as a `string`, `number`,
+  /// `array`,
+  /// `object`, or `boolean`.
+  ///
+  /// The values for Object must be JSON objects. It can consist of `num`,
+  /// `String`, `bool` and `null` as well as `Map` and `List` values.
   core.Object result;
 
   ExecutionResponse();
@@ -286,7 +286,8 @@ class ExecutionResponse {
   }
 
   core.Map<core.String, core.Object> toJson() {
-    final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+    final core.Map<core.String, core.Object> _json =
+        new core.Map<core.String, core.Object>();
     if (result != null) {
       _json["result"] = result;
     }
@@ -294,60 +295,47 @@ class ExecutionResponse {
   }
 }
 
-/**
- * The response will not arrive until the function finishes executing. The
- * maximum runtime is listed in the guide to [limitations in Apps
- * Script](https://developers.google.com/apps-script/guides/services/quotas#current_limitations).
- * <p>If the script function returns successfully, the `response` field will
- * contain an `ExecutionResponse` object with the function's return value in the
- * object's `result` field.</p>
- * <p>If the script function (or Apps Script itself) throws an exception, the
- * `error` field will contain a `Status` object. The `Status` object's `details`
- * field will contain an array with a single `ExecutionError` object that
- * provides information about the nature of the error.</p>
- * <p>If the `run` call itself fails (for example, because of a malformed
- * request or an authorization error), the method will return an HTTP response
- * code in the 4XX range with a different format for the response body. Client
- * libraries will automatically convert a 4XX response into an exception
- * class.</p>
- */
+/// The response will not arrive until the function finishes executing. The
+/// maximum runtime is listed in the guide to [limitations in Apps
+/// Script](https://developers.google.com/apps-script/guides/services/quotas#current_limitations).
+/// <p>If the script function returns successfully, the `response` field will
+/// contain an `ExecutionResponse` object with the function's return value in
+/// the object's `result` field.</p>
+/// <p>If the script function (or Apps Script itself) throws an exception, the
+/// `error` field will contain a `Status` object. The `Status` object's
+/// `details` field will contain an array with a single `ExecutionError` object
+/// that provides information about the nature of the error.</p>
+/// <p>If the `run` call itself fails (for example, because of a malformed
+/// request or an authorization error), the method will return an HTTP response
+/// code in the 4XX range with a different format for the response body. Client
+/// libraries will automatically convert a 4XX response into an exception
+/// class.</p>
 class Operation {
-  /**
-   * This field is only used with asynchronous executions and indicates whether
-   * or not the script execution has completed. A completed execution has a
-   * populated response field containing the `ExecutionResponse` from function
-   * that was executed.
-   */
+  /// This field is only used with asynchronous executions and indicates
+  /// whether or not the script execution has completed. A completed execution
+  /// has a populated response field containing the `ExecutionResponse` from
+  /// function that was executed.
   core.bool done;
-  /**
-   * If a `run` call succeeds but the script function (or Apps Script itself)
-   * throws an exception, this field will contain a `Status` object. The
-   * `Status` object's `details` field will contain an array with a single
-   * `ExecutionError` object that provides information about the nature of the
-   * error.
-   */
+
+  /// If a `run` call succeeds but the script function (or Apps Script itself)
+  /// throws an exception, this field will contain a `Status` object. The
+  /// `Status` object's `details` field will contain an array with a single
+  /// `ExecutionError` object that provides information about the nature of the
+  /// error.
   Status error;
-  /**
-   * This field is not used.
-   *
-   * The values for Object must be JSON objects. It can consist of `num`,
-   * `String`, `bool` and `null` as well as `Map` and `List` values.
-   */
+
+  /// This field is not used.
+  ///
+  /// The values for Object must be JSON objects. It can consist of `num`,
+  /// `String`, `bool` and `null` as well as `Map` and `List` values.
   core.Map<core.String, core.Object> metadata;
-  /**
-   * This field is only used with asynchronous executions and contains a unique
-   * identifier that can be used to subsequently invoke a `get` `cancel` or
-   * `join` on the asynchronous script execution identified by this name.
-   */
-  core.String name;
-  /**
-   * If the script function returns successfully, this field will contain an
-   * `ExecutionResponse` object with the function's return value as the object's
-   * `result` field.
-   *
-   * The values for Object must be JSON objects. It can consist of `num`,
-   * `String`, `bool` and `null` as well as `Map` and `List` values.
-   */
+
+  /// If the script function returns successfully, this field will contain an
+  /// `ExecutionResponse` object with the function's return value as the
+  /// object's `result` field.
+  ///
+  /// The values for Object must be JSON objects. It can consist of `num`,
+  /// `String`, `bool` and `null` as well as `Map` and `List` values.
   core.Map<core.String, core.Object> response;
 
   Operation();
@@ -362,16 +350,14 @@ class Operation {
     if (_json.containsKey("metadata")) {
       metadata = _json["metadata"];
     }
-    if (_json.containsKey("name")) {
-      name = _json["name"];
-    }
     if (_json.containsKey("response")) {
       response = _json["response"];
     }
   }
 
   core.Map<core.String, core.Object> toJson() {
-    final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+    final core.Map<core.String, core.Object> _json =
+        new core.Map<core.String, core.Object>();
     if (done != null) {
       _json["done"] = done;
     }
@@ -381,9 +367,6 @@ class Operation {
     if (metadata != null) {
       _json["metadata"] = metadata;
     }
-    if (name != null) {
-      _json["name"] = name;
-    }
     if (response != null) {
       _json["response"] = response;
     }
@@ -391,11 +374,12 @@ class Operation {
   }
 }
 
-/** A stack trace through the script that shows where the execution failed. */
+/// A stack trace through the script that shows where the execution failed.
 class ScriptStackTraceElement {
-  /** The name of the function that failed. */
+  /// The name of the function that failed.
   core.String function;
-  /** The line number where the script failed. */
+
+  /// The line number where the script failed.
   core.int lineNumber;
 
   ScriptStackTraceElement();
@@ -410,7 +394,8 @@ class ScriptStackTraceElement {
   }
 
   core.Map<core.String, core.Object> toJson() {
-    final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+    final core.Map<core.String, core.Object> _json =
+        new core.Map<core.String, core.Object>();
     if (function != null) {
       _json["function"] = function;
     }
@@ -421,31 +406,25 @@ class ScriptStackTraceElement {
   }
 }
 
-/**
- * If a `run` call succeeds but the script function (or Apps Script itself)
- * throws an exception, the response body's `error` field will contain this
- * `Status` object.
- */
+/// If a `run` call succeeds but the script function (or Apps Script itself)
+/// throws an exception, the response body's `error` field will contain this
+/// `Status` object.
 class Status {
-  /**
-   * The status code. For this API, this value will always be 3, corresponding
-   * to an <code>INVALID_ARGUMENT</code> error.
-   */
+  /// The status code. For this API, this value will always be 3, corresponding
+  /// to an <code>INVALID_ARGUMENT</code> error.
   core.int code;
-  /**
-   * An array that contains a single `ExecutionError` object that provides
-   * information about the nature of the error.
-   *
-   * The values for Object must be JSON objects. It can consist of `num`,
-   * `String`, `bool` and `null` as well as `Map` and `List` values.
-   */
+
+  /// An array that contains a single `ExecutionError` object that provides
+  /// information about the nature of the error.
+  ///
+  /// The values for Object must be JSON objects. It can consist of `num`,
+  /// `String`, `bool` and `null` as well as `Map` and `List` values.
   core.List<core.Map<core.String, core.Object>> details;
-  /**
-   * A developer-facing error message, which is in English. Any user-facing
-   * error message is localized and sent in the
-   * [`google.rpc.Status.details`](google.rpc.Status.details) field, or
-   * localized by the client.
-   */
+
+  /// A developer-facing error message, which is in English. Any user-facing
+  /// error message is localized and sent in the
+  /// [`google.rpc.Status.details`](google.rpc.Status.details) field, or
+  /// localized by the client.
   core.String message;
 
   Status();
@@ -463,7 +442,8 @@ class Status {
   }
 
   core.Map<core.String, core.Object> toJson() {
-    final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+    final core.Map<core.String, core.Object> _json =
+        new core.Map<core.String, core.Object>();
     if (code != null) {
       _json["code"] = code;
     }