OLD | NEW |
1 // This is a generated file (see the discoveryapis_generator project). | 1 // This is a generated file (see the discoveryapis_generator project). |
2 | 2 |
3 library googleapis.sheets.v4; | 3 library googleapis.sheets.v4; |
4 | 4 |
5 import 'dart:core' as core; | 5 import 'dart:core' as core; |
6 import 'dart:async' as async; | 6 import 'dart:async' as async; |
7 import 'dart:convert' as convert; | 7 import 'dart:convert' as convert; |
8 | 8 |
9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; | 9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
10 import 'package:http/http.dart' as http; | 10 import 'package:http/http.dart' as http; |
(...skipping 299 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
310 * | 310 * |
311 * [request] - The metadata request object. | 311 * [request] - The metadata request object. |
312 * | 312 * |
313 * Request parameters: | 313 * Request parameters: |
314 * | 314 * |
315 * [spreadsheetId] - The ID of the spreadsheet to update. | 315 * [spreadsheetId] - The ID of the spreadsheet to update. |
316 * | 316 * |
317 * [range] - The A1 notation of a range to search for a logical table of data. | 317 * [range] - The A1 notation of a range to search for a logical table of data. |
318 * Values will be appended after the last row of the table. | 318 * Values will be appended after the last row of the table. |
319 * | 319 * |
| 320 * [includeValuesInResponse] - Determines if the update response should |
| 321 * include the values |
| 322 * of the cells that were appended. By default, responses |
| 323 * do not include the updated values. |
| 324 * |
320 * [responseValueRenderOption] - Determines how values in the response should | 325 * [responseValueRenderOption] - Determines how values in the response should |
321 * be rendered. | 326 * be rendered. |
322 * The default render option is ValueRenderOption.FORMATTED_VALUE. | 327 * The default render option is ValueRenderOption.FORMATTED_VALUE. |
323 * Possible string values are: | 328 * Possible string values are: |
324 * - "FORMATTED_VALUE" : A FORMATTED_VALUE. | 329 * - "FORMATTED_VALUE" : A FORMATTED_VALUE. |
325 * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE. | 330 * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE. |
326 * - "FORMULA" : A FORMULA. | 331 * - "FORMULA" : A FORMULA. |
327 * | 332 * |
328 * [insertDataOption] - How the input data should be inserted. | 333 * [insertDataOption] - How the input data should be inserted. |
329 * Possible string values are: | 334 * Possible string values are: |
330 * - "OVERWRITE" : A OVERWRITE. | 335 * - "OVERWRITE" : A OVERWRITE. |
331 * - "INSERT_ROWS" : A INSERT_ROWS. | 336 * - "INSERT_ROWS" : A INSERT_ROWS. |
332 * | 337 * |
333 * [valueInputOption] - How the input data should be interpreted. | 338 * [valueInputOption] - How the input data should be interpreted. |
334 * Possible string values are: | 339 * Possible string values are: |
335 * - "INPUT_VALUE_OPTION_UNSPECIFIED" : A INPUT_VALUE_OPTION_UNSPECIFIED. | 340 * - "INPUT_VALUE_OPTION_UNSPECIFIED" : A INPUT_VALUE_OPTION_UNSPECIFIED. |
336 * - "RAW" : A RAW. | 341 * - "RAW" : A RAW. |
337 * - "USER_ENTERED" : A USER_ENTERED. | 342 * - "USER_ENTERED" : A USER_ENTERED. |
338 * | 343 * |
339 * [responseDateTimeRenderOption] - Determines how dates, times, and durations | 344 * [responseDateTimeRenderOption] - Determines how dates, times, and durations |
340 * in the response should be | 345 * in the response should be |
341 * rendered. This is ignored if response_value_render_option is | 346 * rendered. This is ignored if response_value_render_option is |
342 * FORMATTED_VALUE. | 347 * FORMATTED_VALUE. |
343 * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. | 348 * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. |
344 * Possible string values are: | 349 * Possible string values are: |
345 * - "SERIAL_NUMBER" : A SERIAL_NUMBER. | 350 * - "SERIAL_NUMBER" : A SERIAL_NUMBER. |
346 * - "FORMATTED_STRING" : A FORMATTED_STRING. | 351 * - "FORMATTED_STRING" : A FORMATTED_STRING. |
347 * | 352 * |
348 * [includeValuesInResponse] - Determines if the update response should | |
349 * include the values | |
350 * of the cells that were appended. By default, responses | |
351 * do not include the updated values. | |
352 * | |
353 * Completes with a [AppendValuesResponse]. | 353 * Completes with a [AppendValuesResponse]. |
354 * | 354 * |
355 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 355 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
356 * error. | 356 * error. |
357 * | 357 * |
358 * If the used [http.Client] completes with an error when making a REST call, | 358 * If the used [http.Client] completes with an error when making a REST call, |
359 * this method will complete with the same error. | 359 * this method will complete with the same error. |
360 */ | 360 */ |
361 async.Future<AppendValuesResponse> append(ValueRange request, core.String spre
adsheetId, core.String range, {core.String responseValueRenderOption, core.Strin
g insertDataOption, core.String valueInputOption, core.String responseDateTimeRe
nderOption, core.bool includeValuesInResponse}) { | 361 async.Future<AppendValuesResponse> append(ValueRange request, core.String spre
adsheetId, core.String range, {core.bool includeValuesInResponse, core.String re
sponseValueRenderOption, core.String insertDataOption, core.String valueInputOpt
ion, core.String responseDateTimeRenderOption}) { |
362 var _url = null; | 362 var _url = null; |
363 var _queryParams = new core.Map(); | 363 var _queryParams = new core.Map(); |
364 var _uploadMedia = null; | 364 var _uploadMedia = null; |
365 var _uploadOptions = null; | 365 var _uploadOptions = null; |
366 var _downloadOptions = commons.DownloadOptions.Metadata; | 366 var _downloadOptions = commons.DownloadOptions.Metadata; |
367 var _body = null; | 367 var _body = null; |
368 | 368 |
369 if (request != null) { | 369 if (request != null) { |
370 _body = convert.JSON.encode((request).toJson()); | 370 _body = convert.JSON.encode((request).toJson()); |
371 } | 371 } |
372 if (spreadsheetId == null) { | 372 if (spreadsheetId == null) { |
373 throw new core.ArgumentError("Parameter spreadsheetId is required."); | 373 throw new core.ArgumentError("Parameter spreadsheetId is required."); |
374 } | 374 } |
375 if (range == null) { | 375 if (range == null) { |
376 throw new core.ArgumentError("Parameter range is required."); | 376 throw new core.ArgumentError("Parameter range is required."); |
377 } | 377 } |
| 378 if (includeValuesInResponse != null) { |
| 379 _queryParams["includeValuesInResponse"] = ["${includeValuesInResponse}"]; |
| 380 } |
378 if (responseValueRenderOption != null) { | 381 if (responseValueRenderOption != null) { |
379 _queryParams["responseValueRenderOption"] = [responseValueRenderOption]; | 382 _queryParams["responseValueRenderOption"] = [responseValueRenderOption]; |
380 } | 383 } |
381 if (insertDataOption != null) { | 384 if (insertDataOption != null) { |
382 _queryParams["insertDataOption"] = [insertDataOption]; | 385 _queryParams["insertDataOption"] = [insertDataOption]; |
383 } | 386 } |
384 if (valueInputOption != null) { | 387 if (valueInputOption != null) { |
385 _queryParams["valueInputOption"] = [valueInputOption]; | 388 _queryParams["valueInputOption"] = [valueInputOption]; |
386 } | 389 } |
387 if (responseDateTimeRenderOption != null) { | 390 if (responseDateTimeRenderOption != null) { |
388 _queryParams["responseDateTimeRenderOption"] = [responseDateTimeRenderOpti
on]; | 391 _queryParams["responseDateTimeRenderOption"] = [responseDateTimeRenderOpti
on]; |
389 } | 392 } |
390 if (includeValuesInResponse != null) { | |
391 _queryParams["includeValuesInResponse"] = ["${includeValuesInResponse}"]; | |
392 } | |
393 | 393 |
394 _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId')
+ '/values/' + commons.Escaper.ecapeVariable('$range') + ':append'; | 394 _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId')
+ '/values/' + commons.Escaper.ecapeVariable('$range') + ':append'; |
395 | 395 |
396 var _response = _requester.request(_url, | 396 var _response = _requester.request(_url, |
397 "POST", | 397 "POST", |
398 body: _body, | 398 body: _body, |
399 queryParams: _queryParams, | 399 queryParams: _queryParams, |
400 uploadOptions: _uploadOptions, | 400 uploadOptions: _uploadOptions, |
401 uploadMedia: _uploadMedia, | 401 uploadMedia: _uploadMedia, |
402 downloadOptions: _downloadOptions); | 402 downloadOptions: _downloadOptions); |
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
451 } | 451 } |
452 | 452 |
453 /** | 453 /** |
454 * Returns one or more ranges of values from a spreadsheet. | 454 * Returns one or more ranges of values from a spreadsheet. |
455 * The caller must specify the spreadsheet ID and one or more ranges. | 455 * The caller must specify the spreadsheet ID and one or more ranges. |
456 * | 456 * |
457 * Request parameters: | 457 * Request parameters: |
458 * | 458 * |
459 * [spreadsheetId] - The ID of the spreadsheet to retrieve data from. | 459 * [spreadsheetId] - The ID of the spreadsheet to retrieve data from. |
460 * | 460 * |
| 461 * [majorDimension] - The major dimension that results should use. |
| 462 * |
| 463 * For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, |
| 464 * then requesting `range=A1:B2,majorDimension=ROWS` will return |
| 465 * `[[1,2],[3,4]]`, |
| 466 * whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return |
| 467 * `[[1,3],[2,4]]`. |
| 468 * Possible string values are: |
| 469 * - "DIMENSION_UNSPECIFIED" : A DIMENSION_UNSPECIFIED. |
| 470 * - "ROWS" : A ROWS. |
| 471 * - "COLUMNS" : A COLUMNS. |
| 472 * |
| 473 * [ranges] - The A1 notation of the values to retrieve. |
| 474 * |
461 * [dateTimeRenderOption] - How dates, times, and durations should be | 475 * [dateTimeRenderOption] - How dates, times, and durations should be |
462 * represented in the output. | 476 * represented in the output. |
463 * This is ignored if value_render_option is | 477 * This is ignored if value_render_option is |
464 * FORMATTED_VALUE. | 478 * FORMATTED_VALUE. |
465 * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. | 479 * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. |
466 * Possible string values are: | 480 * Possible string values are: |
467 * - "SERIAL_NUMBER" : A SERIAL_NUMBER. | 481 * - "SERIAL_NUMBER" : A SERIAL_NUMBER. |
468 * - "FORMATTED_STRING" : A FORMATTED_STRING. | 482 * - "FORMATTED_STRING" : A FORMATTED_STRING. |
469 * | 483 * |
470 * [valueRenderOption] - How values should be represented in the output. | 484 * [valueRenderOption] - How values should be represented in the output. |
471 * The default render option is ValueRenderOption.FORMATTED_VALUE. | 485 * The default render option is ValueRenderOption.FORMATTED_VALUE. |
472 * Possible string values are: | 486 * Possible string values are: |
473 * - "FORMATTED_VALUE" : A FORMATTED_VALUE. | 487 * - "FORMATTED_VALUE" : A FORMATTED_VALUE. |
474 * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE. | 488 * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE. |
475 * - "FORMULA" : A FORMULA. | 489 * - "FORMULA" : A FORMULA. |
476 * | 490 * |
477 * [majorDimension] - The major dimension that results should use. | |
478 * | |
479 * For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, | |
480 * then requesting `range=A1:B2,majorDimension=ROWS` will return | |
481 * `[[1,2],[3,4]]`, | |
482 * whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return | |
483 * `[[1,3],[2,4]]`. | |
484 * Possible string values are: | |
485 * - "DIMENSION_UNSPECIFIED" : A DIMENSION_UNSPECIFIED. | |
486 * - "ROWS" : A ROWS. | |
487 * - "COLUMNS" : A COLUMNS. | |
488 * | |
489 * [ranges] - The A1 notation of the values to retrieve. | |
490 * | |
491 * Completes with a [BatchGetValuesResponse]. | 491 * Completes with a [BatchGetValuesResponse]. |
492 * | 492 * |
493 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 493 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
494 * error. | 494 * error. |
495 * | 495 * |
496 * If the used [http.Client] completes with an error when making a REST call, | 496 * If the used [http.Client] completes with an error when making a REST call, |
497 * this method will complete with the same error. | 497 * this method will complete with the same error. |
498 */ | 498 */ |
499 async.Future<BatchGetValuesResponse> batchGet(core.String spreadsheetId, {core
.String dateTimeRenderOption, core.String valueRenderOption, core.String majorDi
mension, core.List<core.String> ranges}) { | 499 async.Future<BatchGetValuesResponse> batchGet(core.String spreadsheetId, {core
.String majorDimension, core.List<core.String> ranges, core.String dateTimeRende
rOption, core.String valueRenderOption}) { |
500 var _url = null; | 500 var _url = null; |
501 var _queryParams = new core.Map(); | 501 var _queryParams = new core.Map(); |
502 var _uploadMedia = null; | 502 var _uploadMedia = null; |
503 var _uploadOptions = null; | 503 var _uploadOptions = null; |
504 var _downloadOptions = commons.DownloadOptions.Metadata; | 504 var _downloadOptions = commons.DownloadOptions.Metadata; |
505 var _body = null; | 505 var _body = null; |
506 | 506 |
507 if (spreadsheetId == null) { | 507 if (spreadsheetId == null) { |
508 throw new core.ArgumentError("Parameter spreadsheetId is required."); | 508 throw new core.ArgumentError("Parameter spreadsheetId is required."); |
509 } | 509 } |
| 510 if (majorDimension != null) { |
| 511 _queryParams["majorDimension"] = [majorDimension]; |
| 512 } |
| 513 if (ranges != null) { |
| 514 _queryParams["ranges"] = ranges; |
| 515 } |
510 if (dateTimeRenderOption != null) { | 516 if (dateTimeRenderOption != null) { |
511 _queryParams["dateTimeRenderOption"] = [dateTimeRenderOption]; | 517 _queryParams["dateTimeRenderOption"] = [dateTimeRenderOption]; |
512 } | 518 } |
513 if (valueRenderOption != null) { | 519 if (valueRenderOption != null) { |
514 _queryParams["valueRenderOption"] = [valueRenderOption]; | 520 _queryParams["valueRenderOption"] = [valueRenderOption]; |
515 } | 521 } |
516 if (majorDimension != null) { | |
517 _queryParams["majorDimension"] = [majorDimension]; | |
518 } | |
519 if (ranges != null) { | |
520 _queryParams["ranges"] = ranges; | |
521 } | |
522 | 522 |
523 _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId')
+ '/values:batchGet'; | 523 _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId')
+ '/values:batchGet'; |
524 | 524 |
525 var _response = _requester.request(_url, | 525 var _response = _requester.request(_url, |
526 "GET", | 526 "GET", |
527 body: _body, | 527 body: _body, |
528 queryParams: _queryParams, | 528 queryParams: _queryParams, |
529 uploadOptions: _uploadOptions, | 529 uploadOptions: _uploadOptions, |
530 uploadMedia: _uploadMedia, | 530 uploadMedia: _uploadMedia, |
531 downloadOptions: _downloadOptions); | 531 downloadOptions: _downloadOptions); |
(...skipping 8025 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
8557 } | 8557 } |
8558 if (range != null) { | 8558 if (range != null) { |
8559 _json["range"] = range; | 8559 _json["range"] = range; |
8560 } | 8560 } |
8561 if (values != null) { | 8561 if (values != null) { |
8562 _json["values"] = values; | 8562 _json["values"] = values; |
8563 } | 8563 } |
8564 return _json; | 8564 return _json; |
8565 } | 8565 } |
8566 } | 8566 } |
OLD | NEW |