Api-roll 45: 2017-02-13

generated/googleapis/lib/sheets/v4.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.sheets.v4;
 
 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 293 matching lines @@
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [spreadsheetId] - The ID of the spreadsheet to update.
    *
    * [range] - The A1 notation of a range to search for a logical table of data.
    * Values will be appended after the last row of the table.
    *
+   * [includeValuesInResponse] - Determines if the update response should
+   * include the values
+   * of the cells that were appended. By default, responses
+   * do not include the updated values.
+   *
    * [responseValueRenderOption] - Determines how values in the response should
    * be rendered.
    * The default render option is ValueRenderOption.FORMATTED_VALUE.
    * Possible string values are:
    * - "FORMATTED_VALUE" : A FORMATTED_VALUE.
    * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
    * - "FORMULA" : A FORMULA.
    *
+   * [insertDataOption] - How the input data should be inserted.
+   * Possible string values are:
+   * - "OVERWRITE" : A OVERWRITE.
+   * - "INSERT_ROWS" : A INSERT_ROWS.
+   *
    * [valueInputOption] - How the input data should be interpreted.
    * Possible string values are:
    * - "INPUT_VALUE_OPTION_UNSPECIFIED" : A INPUT_VALUE_OPTION_UNSPECIFIED.
    * - "RAW" : A RAW.
    * - "USER_ENTERED" : A USER_ENTERED.
    *
    * [responseDateTimeRenderOption] - Determines how dates, times, and durations
    * in the response should be
    * rendered. This is ignored if response_value_render_option is
    * FORMATTED_VALUE.
    * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
    * Possible string values are:
    * - "SERIAL_NUMBER" : A SERIAL_NUMBER.
    * - "FORMATTED_STRING" : A FORMATTED_STRING.
    *
-   * [includeValuesInResponse] - Determines if the update response should
-   * include the values
-   * of the cells that were appended. By default, responses
-   * do not include the updated values.
-   *
-   * [insertDataOption] - How the input data should be inserted.
-   * Possible string values are:
-   * - "OVERWRITE" : A OVERWRITE.
-   * - "INSERT_ROWS" : A INSERT_ROWS.
-   *
    * Completes with a [AppendValuesResponse].
    *
    * 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<AppendValuesResponse> append(ValueRange request, core.String spreadsheetId, core.String range, {core.String responseValueRenderOption, core.String valueInputOption, core.String responseDateTimeRenderOption, core.bool includeValuesInResponse, core.String insertDataOption}) {
+  async.Future<AppendValuesResponse> append(ValueRange request, core.String spreadsheetId, core.String range, {core.bool includeValuesInResponse, core.String responseValueRenderOption, core.String insertDataOption, core.String valueInputOption, core.String responseDateTimeRenderOption}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (request != null) {
       _body = convert.JSON.encode((request).toJson());
     }
     if (spreadsheetId == null) {
       throw new core.ArgumentError("Parameter spreadsheetId is required.");
     }
     if (range == null) {
       throw new core.ArgumentError("Parameter range is required.");
     }
+    if (includeValuesInResponse != null) {
+      _queryParams["includeValuesInResponse"] = ["${includeValuesInResponse}"];
+    }
     if (responseValueRenderOption != null) {
       _queryParams["responseValueRenderOption"] = [responseValueRenderOption];
     }
+    if (insertDataOption != null) {
+      _queryParams["insertDataOption"] = [insertDataOption];
+    }
     if (valueInputOption != null) {
       _queryParams["valueInputOption"] = [valueInputOption];
     }
     if (responseDateTimeRenderOption != null) {
       _queryParams["responseDateTimeRenderOption"] = [responseDateTimeRenderOption];
     }
-    if (includeValuesInResponse != null) {
-      _queryParams["includeValuesInResponse"] = ["${includeValuesInResponse}"];
-    }
-    if (insertDataOption != null) {
-      _queryParams["insertDataOption"] = [insertDataOption];
-    }
 
     _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values/' + commons.Escaper.ecapeVariable('$range') + ':append';
 
     var _response = _requester.request(_url,
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 48 matching lines @@
   }
 
   /**
    * Returns one or more ranges of values from a spreadsheet.
    * The caller must specify the spreadsheet ID and one or more ranges.
    *
    * Request parameters:
    *
    * [spreadsheetId] - The ID of the spreadsheet to retrieve data from.
    *
-   * [ranges] - The A1 notation of the values to retrieve.
-   *
    * [valueRenderOption] - How values should be represented in the output.
    * The default render option is ValueRenderOption.FORMATTED_VALUE.
    * Possible string values are:
    * - "FORMATTED_VALUE" : A FORMATTED_VALUE.
    * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
    * - "FORMULA" : A FORMULA.
    *
    * [dateTimeRenderOption] - How dates, times, and durations should be
    * represented in the output.
    * This is ignored if value_render_option is
    * FORMATTED_VALUE.
    * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
    * Possible string values are:
    * - "SERIAL_NUMBER" : A SERIAL_NUMBER.
    * - "FORMATTED_STRING" : A FORMATTED_STRING.
    *
+   * [ranges] - The A1 notation of the values to retrieve.
+   *
    * [majorDimension] - The major dimension that results should use.
    *
    * For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
    * then requesting `range=A1:B2,majorDimension=ROWS` will return
    * `[[1,2],[3,4]]`,
    * whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
    * `[[1,3],[2,4]]`.
    * Possible string values are:
    * - "DIMENSION_UNSPECIFIED" : A DIMENSION_UNSPECIFIED.
    * - "ROWS" : A ROWS.
    * - "COLUMNS" : A COLUMNS.
    *
    * Completes with a [BatchGetValuesResponse].
    *
    * 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<BatchGetValuesResponse> batchGet(core.String spreadsheetId, {core.List<core.String> ranges, core.String valueRenderOption, core.String dateTimeRenderOption, core.String majorDimension}) {
+  async.Future<BatchGetValuesResponse> batchGet(core.String spreadsheetId, {core.String valueRenderOption, core.String dateTimeRenderOption, core.List<core.String> ranges, core.String majorDimension}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (spreadsheetId == null) {
       throw new core.ArgumentError("Parameter spreadsheetId is required.");
     }
-    if (ranges != null) {
-      _queryParams["ranges"] = ranges;
-    }
     if (valueRenderOption != null) {
       _queryParams["valueRenderOption"] = [valueRenderOption];
     }
     if (dateTimeRenderOption != null) {
       _queryParams["dateTimeRenderOption"] = [dateTimeRenderOption];
     }
+    if (ranges != null) {
+      _queryParams["ranges"] = ranges;
+    }
     if (majorDimension != null) {
       _queryParams["majorDimension"] = [majorDimension];
     }
 
     _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values:batchGet';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
@@ skipping 190 matching lines @@
    * a valueInputOption.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [spreadsheetId] - The ID of the spreadsheet to update.
    *
    * [range] - The A1 notation of the values to update.
    *
-   * [responseValueRenderOption] - Determines how values in the response should
-   * be rendered.
-   * The default render option is ValueRenderOption.FORMATTED_VALUE.
-   * Possible string values are:
-   * - "FORMATTED_VALUE" : A FORMATTED_VALUE.
-   * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
-   * - "FORMULA" : A FORMULA.
-   *
    * [valueInputOption] - How the input data should be interpreted.
    * Possible string values are:
    * - "INPUT_VALUE_OPTION_UNSPECIFIED" : A INPUT_VALUE_OPTION_UNSPECIFIED.
    * - "RAW" : A RAW.
    * - "USER_ENTERED" : A USER_ENTERED.
    *
    * [responseDateTimeRenderOption] - Determines how dates, times, and durations
    * in the response should be
    * rendered. This is ignored if response_value_render_option is
    * FORMATTED_VALUE.
    * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
    * Possible string values are:
    * - "SERIAL_NUMBER" : A SERIAL_NUMBER.
    * - "FORMATTED_STRING" : A FORMATTED_STRING.
    *
    * [includeValuesInResponse] - Determines if the update response should
    * include the values
    * of the cells that were updated. By default, responses
    * do not include the updated values.
    * If the range to write was larger than than the range actually written,
    * the response will include all values in the requested range (excluding
    * trailing empty rows and columns).
    *
+   * [responseValueRenderOption] - Determines how values in the response should
+   * be rendered.
+   * The default render option is ValueRenderOption.FORMATTED_VALUE.
+   * Possible string values are:
+   * - "FORMATTED_VALUE" : A FORMATTED_VALUE.
+   * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
+   * - "FORMULA" : A FORMULA.
+   *
    * Completes with a [UpdateValuesResponse].
    *
    * 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<UpdateValuesResponse> update(ValueRange request, core.String spreadsheetId, core.String range, {core.String responseValueRenderOption, core.String valueInputOption, core.String responseDateTimeRenderOption, core.bool includeValuesInResponse}) {
+  async.Future<UpdateValuesResponse> update(ValueRange request, core.String spreadsheetId, core.String range, {core.String valueInputOption, core.String responseDateTimeRenderOption, core.bool includeValuesInResponse, core.String responseValueRenderOption}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (request != null) {
       _body = convert.JSON.encode((request).toJson());
     }
     if (spreadsheetId == null) {
       throw new core.ArgumentError("Parameter spreadsheetId is required.");
     }
     if (range == null) {
       throw new core.ArgumentError("Parameter range is required.");
     }
-    if (responseValueRenderOption != null) {
-      _queryParams["responseValueRenderOption"] = [responseValueRenderOption];
-    }
     if (valueInputOption != null) {
       _queryParams["valueInputOption"] = [valueInputOption];
     }
     if (responseDateTimeRenderOption != null) {
       _queryParams["responseDateTimeRenderOption"] = [responseDateTimeRenderOption];
     }
     if (includeValuesInResponse != null) {
       _queryParams["includeValuesInResponse"] = ["${includeValuesInResponse}"];
     }
+    if (responseValueRenderOption != null) {
+      _queryParams["responseValueRenderOption"] = [responseValueRenderOption];
+    }
 
     _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values/' + commons.Escaper.ecapeVariable('$range');
 
     var _response = _requester.request(_url,
                                        "PUT",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 4016 matching lines @@
     if (type != null) {
       _json["type"] = type;
     }
     if (value != null) {
       _json["value"] = value;
     }
     return _json;
   }
 }
 
+/**
+ * Settings to control how circular dependencies are resolved with iterative
+ * calculation.
+ */
+class IterativeCalculationSettings {
+  /**
+   * When iterative calculation is enabled, the threshold value such that
+   * calculation rounds stop when succesive results differ by less.
+   */
+  core.double convergenceThreshold;
+  /**
+   * When iterative calculation is enabled, the maximum number of calculation
+   * rounds to perform during iterative calculation.
+   */
+  core.int maxIterations;
+
+  IterativeCalculationSettings();
+
+  IterativeCalculationSettings.fromJson(core.Map _json) {
+    if (_json.containsKey("convergenceThreshold")) {
+      convergenceThreshold = _json["convergenceThreshold"];
+    }
+    if (_json.containsKey("maxIterations")) {
+      maxIterations = _json["maxIterations"];
+    }
+  }
+
+  core.Map toJson() {
+    var _json = new core.Map();
+    if (convergenceThreshold != null) {
+      _json["convergenceThreshold"] = convergenceThreshold;
+    }
+    if (maxIterations != null) {
+      _json["maxIterations"] = maxIterations;
+    }
+    return _json;
+  }
+}
+
 /** Merges all cells in the range. */
 class MergeCellsRequest {
   /**
    * How the cells should be merged.
    * Possible string values are:
    * - "MERGE_ALL" : Create a single merge from the range
    * - "MERGE_COLUMNS" : Create a merge for each column in the range
    * - "MERGE_ROWS" : Create a merge for each row in the range
    */
   core.String mergeType;
@@ skipping 1884 matching lines @@
    */
   core.String autoRecalc;
   /**
    * The default format of all cells in the spreadsheet.
    * CellData.effectiveFormat will not be set if the
    * cell's format is equal to this default format.
    * This field is read-only.
    */
   CellFormat defaultFormat;
   /**
+   * Determines whether and how circular references are resolved with iterative
+   * calculation.  Absence of this field means that circular references will
+   * result in calculation errors.
+   */
+  IterativeCalculationSettings iterativeCalculationSettings;
+  /**
    * The locale of the spreadsheet in one of the following formats:
    *
    * * an ISO 639-1 language code such as `en`
    *
    * * an ISO 639-2 language code such as `fil`, if no 639-1 code exists
    *
    * * a combination of the ISO language code and country code, such as `en_US`
    *
    * Note: when updating this field, not all locales/languages are supported.
    */
   core.String locale;
   /**
    * The time zone of the spreadsheet, in CLDR format such as
    * `America/New_York`. If the time zone isn't recognized, this may
    * be a custom time zone such as `GMT-07:00`.
    */
   core.String timeZone;
   /** The title of the spreadsheet. */
   core.String title;
 
   SpreadsheetProperties();
 
   SpreadsheetProperties.fromJson(core.Map _json) {
     if (_json.containsKey("autoRecalc")) {
       autoRecalc = _json["autoRecalc"];
     }
     if (_json.containsKey("defaultFormat")) {
       defaultFormat = new CellFormat.fromJson(_json["defaultFormat"]);
     }
+    if (_json.containsKey("iterativeCalculationSettings")) {
+      iterativeCalculationSettings = new IterativeCalculationSettings.fromJson(_json["iterativeCalculationSettings"]);
+    }
     if (_json.containsKey("locale")) {
       locale = _json["locale"];
     }
     if (_json.containsKey("timeZone")) {
       timeZone = _json["timeZone"];
     }
     if (_json.containsKey("title")) {
       title = _json["title"];
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (autoRecalc != null) {
       _json["autoRecalc"] = autoRecalc;
     }
     if (defaultFormat != null) {
       _json["defaultFormat"] = (defaultFormat).toJson();
     }
+    if (iterativeCalculationSettings != null) {
+      _json["iterativeCalculationSettings"] = (iterativeCalculationSettings).toJson();
+    }
     if (locale != null) {
       _json["locale"] = locale;
     }
     if (timeZone != null) {
       _json["timeZone"] = timeZone;
     }
     if (title != null) {
       _json["title"] = title;
     }
     return _json;
@@ skipping 938 matching lines @@
     }
     if (range != null) {
       _json["range"] = range;
     }
     if (values != null) {
       _json["values"] = values;
     }
     return _json;
   }
 }