Api-Roll 53: 2017-08-21

generated/googleapis/lib/script/v1.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.script.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;
 
 export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
     ApiRequestError, DetailedApiRequestError;
 
 const core.String USER_AGENT = 'dart-api-client script/v1';
 
-/** Executes Google Apps Script projects. */
+/** Executes functions in Google Apps Script projects. */
 class ScriptApi {
   /** 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 contacts */
   static const WwwGoogleComM8FeedsScope = "https://www.google.com/m8/feeds";
 
@@ skipping 45 matching lines @@
    * 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 project key of the script to be executed. To find the
-   * project key, open
+   * [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.
    */
@@ skipping 193 matching lines @@
   core.Map<core.String, core.Object> toJson() {
     final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
     if (result != null) {
       _json["result"] = result;
     }
     return _json;
   }
 }
 
 /**
- * A request to retrieve the results from a collection of requests,
- * specified by the operation resource names.
- */
-class JoinAsyncRequest {
-  /**
-   * List of operation resource names that we want to join,
-   * as returned from a call to RunAsync.
-   */
-  core.List<core.String> names;
-  /**
-   * The script id which specifies the script which all processes in the names
-   * field must be from.
-   */
-  core.String scriptId;
-  /** Timeout for information retrieval in milliseconds. */
-  core.String timeout;
-
-  JoinAsyncRequest();
-
-  JoinAsyncRequest.fromJson(core.Map _json) {
-    if (_json.containsKey("names")) {
-      names = _json["names"];
-    }
-    if (_json.containsKey("scriptId")) {
-      scriptId = _json["scriptId"];
-    }
-    if (_json.containsKey("timeout")) {
-      timeout = _json["timeout"];
-    }
-  }
-
-  core.Map<core.String, core.Object> toJson() {
-    final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
-    if (names != null) {
-      _json["names"] = names;
-    }
-    if (scriptId != null) {
-      _json["scriptId"] = scriptId;
-    }
-    if (timeout != null) {
-      _json["timeout"] = timeout;
-    }
-    return _json;
-  }
-}
-
-/** An object that provides the return value for the JoinAsync method. */
-class JoinAsyncResponse {
-  /**
-   * The return values for each script function, in a map of operation resource
-   * names to the Operation containing the result of the process. The response
-   * will contain either an error or the result of the script function.
-   */
-  core.Map<core.String, Operation> results;
-
-  JoinAsyncResponse();
-
-  JoinAsyncResponse.fromJson(core.Map _json) {
-    if (_json.containsKey("results")) {
-      results = commons.mapMap<core.Map<core.String, core.Object>, Operation>(_json["results"], (core.Map<core.String, core.Object> item) => new Operation.fromJson(item));
-    }
-  }
-
-  core.Map<core.String, core.Object> toJson() {
-    final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
-    if (results != null) {
-      _json["results"] = commons.mapMap<Operation, core.Map<core.String, core.Object>>(results, (Operation item) => (item).toJson());
-    }
-    return _json;
-  }
-}
-
-/**
  * 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 not used. */
+  /**
+   * 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.
    */
   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.
    */
   core.Map<core.String, core.Object> metadata;
-  /** This field is not used. */
+  /**
+   * 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.
    */
   core.Map<core.String, core.Object> response;
@@ skipping 70 matching lines @@
 }
 
 /**
  * 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 INVALID_ARGUMENT error.
+   * 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.
    */
   core.List<core.Map<core.String, core.Object>> details;
@@ skipping 26 matching lines @@
     }
     if (details != null) {
       _json["details"] = details;
     }
     if (message != null) {
       _json["message"] = message;
     }
     return _json;
   }
 }