Api-Roll 51: 2017-07-10

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 163 matching lines @@
    * To retrieve only subsets of the spreadsheet, use the
    * ranges URL parameter.
    * Multiple ranges can be specified.  Limiting the range will
    * return only the portions of the spreadsheet that intersect the requested
    * ranges. Ranges are specified using A1 notation.
    *
    * Request parameters:
    *
    * [spreadsheetId] - The spreadsheet to request.
    *
-   * [ranges] - The ranges to retrieve from the spreadsheet.
-   *
    * [includeGridData] - True if grid data should be returned.
    * This parameter is ignored if a field mask was set in the request.
    *
+   * [ranges] - The ranges to retrieve from the spreadsheet.
+   *
    * Completes with a [Spreadsheet].
    *
    * 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<Spreadsheet> get(core.String spreadsheetId, {core.List<core.String> ranges, core.bool includeGridData}) {
+  async.Future<Spreadsheet> get(core.String spreadsheetId, {core.bool includeGridData, core.List<core.String> ranges}) {
     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 (includeGridData != null) {
+      _queryParams["includeGridData"] = ["${includeGridData}"];
+    }
     if (ranges != null) {
       _queryParams["ranges"] = ranges;
     }
-    if (includeGridData != null) {
-      _queryParams["includeGridData"] = ["${includeGridData}"];
-    }
 
     _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId');
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 86 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.
    *
+   * [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.
+   *
    * [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.
-   *
    * 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 insertDataOption, core.String valueInputOption, core.String responseDateTimeRenderOption, core.bool includeValuesInResponse}) {
+  async.Future<AppendValuesResponse> append(ValueRange request, core.String spreadsheetId, core.String range, {core.String responseDateTimeRenderOption, core.bool includeValuesInResponse, core.String responseValueRenderOption, core.String insertDataOption, core.String valueInputOption}) {
     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 (responseDateTimeRenderOption != null) {
+      _queryParams["responseDateTimeRenderOption"] = [responseDateTimeRenderOption];
+    }
+    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}"];
-    }
 
     _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.
    *
-   * [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.
+   * [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.
    *
    * [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.
    *
+   * [ranges] - The A1 notation of the values to retrieve.
+   *
    * 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.String valueRenderOption, core.String dateTimeRenderOption, core.List<core.String> ranges, core.String majorDimension}) {
+  async.Future<BatchGetValuesResponse> batchGet(core.String spreadsheetId, {core.String dateTimeRenderOption, core.String valueRenderOption, core.String majorDimension, core.List<core.String> ranges}) {
     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 (dateTimeRenderOption != null) {
+      _queryParams["dateTimeRenderOption"] = [dateTimeRenderOption];
+    }
     if (valueRenderOption != null) {
       _queryParams["valueRenderOption"] = [valueRenderOption];
     }
-    if (dateTimeRenderOption != null) {
-      _queryParams["dateTimeRenderOption"] = [dateTimeRenderOption];
+    if (majorDimension != null) {
+      _queryParams["majorDimension"] = [majorDimension];
     }
     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,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 102 matching lines @@
   /**
    * Returns a range of values from a spreadsheet.
    * The caller must specify the spreadsheet ID and a range.
    *
    * Request parameters:
    *
    * [spreadsheetId] - The ID of the spreadsheet to retrieve data from.
    *
    * [range] - 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.
+   * [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:
-   * - "FORMATTED_VALUE" : A FORMATTED_VALUE.
-   * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
-   * - "FORMULA" : A FORMULA.
+   * - "DIMENSION_UNSPECIFIED" : A DIMENSION_UNSPECIFIED.
+   * - "ROWS" : A ROWS.
+   * - "COLUMNS" : A COLUMNS.
    *
    * [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.
    *
-   * [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]]`.
+   * [valueRenderOption] - How values should be represented in the output.
+   * The default render option is ValueRenderOption.FORMATTED_VALUE.
    * Possible string values are:
-   * - "DIMENSION_UNSPECIFIED" : A DIMENSION_UNSPECIFIED.
-   * - "ROWS" : A ROWS.
-   * - "COLUMNS" : A COLUMNS.
+   * - "FORMATTED_VALUE" : A FORMATTED_VALUE.
+   * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
+   * - "FORMULA" : A FORMULA.
    *
    * Completes with a [ValueRange].
    *
    * 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<ValueRange> get(core.String spreadsheetId, core.String range, {core.String valueRenderOption, core.String dateTimeRenderOption, core.String majorDimension}) {
+  async.Future<ValueRange> get(core.String spreadsheetId, core.String range, {core.String majorDimension, core.String dateTimeRenderOption, core.String valueRenderOption}) {
     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 (range == null) {
       throw new core.ArgumentError("Parameter range is required.");
     }
+    if (majorDimension != null) {
+      _queryParams["majorDimension"] = [majorDimension];
+    }
+    if (dateTimeRenderOption != null) {
+      _queryParams["dateTimeRenderOption"] = [dateTimeRenderOption];
+    }
     if (valueRenderOption != null) {
       _queryParams["valueRenderOption"] = [valueRenderOption];
     }
-    if (dateTimeRenderOption != null) {
-      _queryParams["dateTimeRenderOption"] = [dateTimeRenderOption];
-    }
-    if (majorDimension != null) {
-      _queryParams["majorDimension"] = [majorDimension];
-    }
 
     _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values/' + commons.Escaper.ecapeVariable('$range');
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 1975 matching lines @@
  * chart</a>.
  */
 class CandlestickChartSpec {
   /**
    * The Candlestick chart data.
    * Only one CandlestickData is supported.
    */
   core.List<CandlestickData> data;
   /**
    * The domain data (horizontal axis) for the candlestick chart.  String data
-   * will be treated as discrete labels, other data will be treated as continous
-   * values.
+   * will be treated as discrete labels, other data will be treated as
+   * continuous values.
    */
   CandlestickDomain domain;
 
   CandlestickChartSpec();
 
   CandlestickChartSpec.fromJson(core.Map _json) {
     if (_json.containsKey("data")) {
       data = _json["data"].map((value) => new CandlestickData.fromJson(value)).toList();
     }
     if (_json.containsKey("domain")) {
@@ skipping 3680 matching lines @@
     if (unprotectedRanges != null) {
       _json["unprotectedRanges"] = unprotectedRanges.map((value) => (value).toJson()).toList();
     }
     if (warningOnly != null) {
       _json["warningOnly"] = warningOnly;
     }
     return _json;
   }
 }
 
+/** Randomizes the order of the rows in a range. */
+class RandomizeRangeRequest {
+  /** The range to randomize. */
+  GridRange range;
+
+  RandomizeRangeRequest();
+
+  RandomizeRangeRequest.fromJson(core.Map _json) {
+    if (_json.containsKey("range")) {
+      range = new GridRange.fromJson(_json["range"]);
+    }
+  }
+
+  core.Map<core.String, core.Object> toJson() {
+    final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+    if (range != null) {
+      _json["range"] = (range).toJson();
+    }
+    return _json;
+  }
+}
+
 /**
  * Updates all cells in the range to the values in the given Cell object.
  * Only the fields listed in the fields field are updated; others are
  * unchanged.
  *
  * If writing a cell with a formula, the formula's ranges will automatically
  * increment for each field in the range.
  * For example, if writing a cell with formula `=A1` into range B2:C4,
  * B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,
  * C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.
@@ skipping 103 matching lines @@
   /** Inserts new rows or columns in a sheet. */
   InsertDimensionRequest insertDimension;
   /** Inserts new cells in a sheet, shifting the existing cells. */
   InsertRangeRequest insertRange;
   /** Merges cells together. */
   MergeCellsRequest mergeCells;
   /** Moves rows or columns to another location in a sheet. */
   MoveDimensionRequest moveDimension;
   /** Pastes data (HTML or delimited) into a sheet. */
   PasteDataRequest pasteData;
+  /** Randomizes the order of the rows in a range. */
+  RandomizeRangeRequest randomizeRange;
   /** Repeats a single cell across a range. */
   RepeatCellRequest repeatCell;
   /** Sets the basic filter on a sheet. */
   SetBasicFilterRequest setBasicFilter;
   /** Sets data validation for one or more cells. */
   SetDataValidationRequest setDataValidation;
   /** Sorts data in a range. */
   SortRangeRequest sortRange;
   /** Converts a column of text into many columns of text. */
   TextToColumnsRequest textToColumns;
@@ skipping 113 matching lines @@
     }
     if (_json.containsKey("mergeCells")) {
       mergeCells = new MergeCellsRequest.fromJson(_json["mergeCells"]);
     }
     if (_json.containsKey("moveDimension")) {
       moveDimension = new MoveDimensionRequest.fromJson(_json["moveDimension"]);
     }
     if (_json.containsKey("pasteData")) {
       pasteData = new PasteDataRequest.fromJson(_json["pasteData"]);
     }
+    if (_json.containsKey("randomizeRange")) {
+      randomizeRange = new RandomizeRangeRequest.fromJson(_json["randomizeRange"]);
+    }
     if (_json.containsKey("repeatCell")) {
       repeatCell = new RepeatCellRequest.fromJson(_json["repeatCell"]);
     }
     if (_json.containsKey("setBasicFilter")) {
       setBasicFilter = new SetBasicFilterRequest.fromJson(_json["setBasicFilter"]);
     }
     if (_json.containsKey("setDataValidation")) {
       setDataValidation = new SetDataValidationRequest.fromJson(_json["setDataValidation"]);
     }
     if (_json.containsKey("sortRange")) {
@@ skipping 131 matching lines @@
     }
     if (mergeCells != null) {
       _json["mergeCells"] = (mergeCells).toJson();
     }
     if (moveDimension != null) {
       _json["moveDimension"] = (moveDimension).toJson();
     }
     if (pasteData != null) {
       _json["pasteData"] = (pasteData).toJson();
     }
+    if (randomizeRange != null) {
+      _json["randomizeRange"] = (randomizeRange).toJson();
+    }
     if (repeatCell != null) {
       _json["repeatCell"] = (repeatCell).toJson();
     }
     if (setBasicFilter != null) {
       _json["setBasicFilter"] = (setBasicFilter).toJson();
     }
     if (setDataValidation != null) {
       _json["setDataValidation"] = (setDataValidation).toJson();
     }
     if (sortRange != null) {
@@ skipping 1695 matching lines @@
     }
     if (range != null) {
       _json["range"] = range;
     }
     if (values != null) {
       _json["values"] = values;
     }
     return _json;
   }
 }