@googleapis/sheets 5.0.0 → 5.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v4.ts CHANGED
@@ -3566,7 +3566,7 @@ export namespace sheets_v4 {
3566
3566
  */
3567
3567
  randomizeRange?: Schema$RandomizeRangeRequest;
3568
3568
  /**
3569
- * Refreshs one or multiple data sources and associated dbobjects.
3569
+ * Refreshes one or multiple data sources and associated dbobjects.
3570
3570
  */
3571
3571
  refreshDataSource?: Schema$RefreshDataSourceRequest;
3572
3572
  /**
@@ -4941,65 +4941,6 @@ export namespace sheets_v4 {
4941
4941
 
4942
4942
  /**
4943
4943
  * Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.
4944
- * @example
4945
- * ```js
4946
- * // Before running the sample:
4947
- * // - Enable the API at:
4948
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
4949
- * // - Login into gcloud by running:
4950
- * // `$ gcloud auth application-default login`
4951
- * // - Install the npm module by running:
4952
- * // `$ npm install googleapis`
4953
- *
4954
- * const {google} = require('googleapis');
4955
- * const sheets = google.sheets('v4');
4956
- *
4957
- * async function main() {
4958
- * const auth = new google.auth.GoogleAuth({
4959
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4960
- * scopes: [
4961
- * 'https://www.googleapis.com/auth/drive',
4962
- * 'https://www.googleapis.com/auth/drive.file',
4963
- * 'https://www.googleapis.com/auth/spreadsheets',
4964
- * ],
4965
- * });
4966
- *
4967
- * // Acquire an auth client, and bind it to all future calls
4968
- * const authClient = await auth.getClient();
4969
- * google.options({auth: authClient});
4970
- *
4971
- * // Do the magic
4972
- * const res = await sheets.spreadsheets.batchUpdate({
4973
- * // The spreadsheet to apply the updates to.
4974
- * spreadsheetId: 'placeholder-value',
4975
- *
4976
- * // Request body metadata
4977
- * requestBody: {
4978
- * // request body parameters
4979
- * // {
4980
- * // "includeSpreadsheetInResponse": false,
4981
- * // "requests": [],
4982
- * // "responseIncludeGridData": false,
4983
- * // "responseRanges": []
4984
- * // }
4985
- * },
4986
- * });
4987
- * console.log(res.data);
4988
- *
4989
- * // Example response
4990
- * // {
4991
- * // "replies": [],
4992
- * // "spreadsheetId": "my_spreadsheetId",
4993
- * // "updatedSpreadsheet": {}
4994
- * // }
4995
- * }
4996
- *
4997
- * main().catch(e => {
4998
- * console.error(e);
4999
- * throw e;
5000
- * });
5001
- *
5002
- * ```
5003
4944
  *
5004
4945
  * @param params - Parameters for request
5005
4946
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5095,71 +5036,6 @@ export namespace sheets_v4 {
5095
5036
 
5096
5037
  /**
5097
5038
  * Creates a spreadsheet, returning the newly created spreadsheet.
5098
- * @example
5099
- * ```js
5100
- * // Before running the sample:
5101
- * // - Enable the API at:
5102
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
5103
- * // - Login into gcloud by running:
5104
- * // `$ gcloud auth application-default login`
5105
- * // - Install the npm module by running:
5106
- * // `$ npm install googleapis`
5107
- *
5108
- * const {google} = require('googleapis');
5109
- * const sheets = google.sheets('v4');
5110
- *
5111
- * async function main() {
5112
- * const auth = new google.auth.GoogleAuth({
5113
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5114
- * scopes: [
5115
- * 'https://www.googleapis.com/auth/drive',
5116
- * 'https://www.googleapis.com/auth/drive.file',
5117
- * 'https://www.googleapis.com/auth/spreadsheets',
5118
- * ],
5119
- * });
5120
- *
5121
- * // Acquire an auth client, and bind it to all future calls
5122
- * const authClient = await auth.getClient();
5123
- * google.options({auth: authClient});
5124
- *
5125
- * // Do the magic
5126
- * const res = await sheets.spreadsheets.create({
5127
- * // Request body metadata
5128
- * requestBody: {
5129
- * // request body parameters
5130
- * // {
5131
- * // "dataSourceSchedules": [],
5132
- * // "dataSources": [],
5133
- * // "developerMetadata": [],
5134
- * // "namedRanges": [],
5135
- * // "properties": {},
5136
- * // "sheets": [],
5137
- * // "spreadsheetId": "my_spreadsheetId",
5138
- * // "spreadsheetUrl": "my_spreadsheetUrl"
5139
- * // }
5140
- * },
5141
- * });
5142
- * console.log(res.data);
5143
- *
5144
- * // Example response
5145
- * // {
5146
- * // "dataSourceSchedules": [],
5147
- * // "dataSources": [],
5148
- * // "developerMetadata": [],
5149
- * // "namedRanges": [],
5150
- * // "properties": {},
5151
- * // "sheets": [],
5152
- * // "spreadsheetId": "my_spreadsheetId",
5153
- * // "spreadsheetUrl": "my_spreadsheetUrl"
5154
- * // }
5155
- * }
5156
- *
5157
- * main().catch(e => {
5158
- * console.error(e);
5159
- * throw e;
5160
- * });
5161
- *
5162
- * ```
5163
5039
  *
5164
5040
  * @param params - Parameters for request
5165
5041
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5244,65 +5120,6 @@ export namespace sheets_v4 {
5244
5120
 
5245
5121
  /**
5246
5122
  * Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.
5247
- * @example
5248
- * ```js
5249
- * // Before running the sample:
5250
- * // - Enable the API at:
5251
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
5252
- * // - Login into gcloud by running:
5253
- * // `$ gcloud auth application-default login`
5254
- * // - Install the npm module by running:
5255
- * // `$ npm install googleapis`
5256
- *
5257
- * const {google} = require('googleapis');
5258
- * const sheets = google.sheets('v4');
5259
- *
5260
- * async function main() {
5261
- * const auth = new google.auth.GoogleAuth({
5262
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5263
- * scopes: [
5264
- * 'https://www.googleapis.com/auth/drive',
5265
- * 'https://www.googleapis.com/auth/drive.file',
5266
- * 'https://www.googleapis.com/auth/drive.readonly',
5267
- * 'https://www.googleapis.com/auth/spreadsheets',
5268
- * 'https://www.googleapis.com/auth/spreadsheets.readonly',
5269
- * ],
5270
- * });
5271
- *
5272
- * // Acquire an auth client, and bind it to all future calls
5273
- * const authClient = await auth.getClient();
5274
- * google.options({auth: authClient});
5275
- *
5276
- * // Do the magic
5277
- * const res = await sheets.spreadsheets.get({
5278
- * // True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
5279
- * includeGridData: 'placeholder-value',
5280
- * // The ranges to retrieve from the spreadsheet.
5281
- * ranges: 'placeholder-value',
5282
- * // The spreadsheet to request.
5283
- * spreadsheetId: 'placeholder-value',
5284
- * });
5285
- * console.log(res.data);
5286
- *
5287
- * // Example response
5288
- * // {
5289
- * // "dataSourceSchedules": [],
5290
- * // "dataSources": [],
5291
- * // "developerMetadata": [],
5292
- * // "namedRanges": [],
5293
- * // "properties": {},
5294
- * // "sheets": [],
5295
- * // "spreadsheetId": "my_spreadsheetId",
5296
- * // "spreadsheetUrl": "my_spreadsheetUrl"
5297
- * // }
5298
- * }
5299
- *
5300
- * main().catch(e => {
5301
- * console.error(e);
5302
- * throw e;
5303
- * });
5304
- *
5305
- * ```
5306
5123
  *
5307
5124
  * @param params - Parameters for request
5308
5125
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5389,68 +5206,6 @@ export namespace sheets_v4 {
5389
5206
 
5390
5207
  /**
5391
5208
  * Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.
5392
- * @example
5393
- * ```js
5394
- * // Before running the sample:
5395
- * // - Enable the API at:
5396
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
5397
- * // - Login into gcloud by running:
5398
- * // `$ gcloud auth application-default login`
5399
- * // - Install the npm module by running:
5400
- * // `$ npm install googleapis`
5401
- *
5402
- * const {google} = require('googleapis');
5403
- * const sheets = google.sheets('v4');
5404
- *
5405
- * async function main() {
5406
- * const auth = new google.auth.GoogleAuth({
5407
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5408
- * scopes: [
5409
- * 'https://www.googleapis.com/auth/drive',
5410
- * 'https://www.googleapis.com/auth/drive.file',
5411
- * 'https://www.googleapis.com/auth/spreadsheets',
5412
- * ],
5413
- * });
5414
- *
5415
- * // Acquire an auth client, and bind it to all future calls
5416
- * const authClient = await auth.getClient();
5417
- * google.options({auth: authClient});
5418
- *
5419
- * // Do the magic
5420
- * const res = await sheets.spreadsheets.getByDataFilter({
5421
- * // The spreadsheet to request.
5422
- * spreadsheetId: 'placeholder-value',
5423
- *
5424
- * // Request body metadata
5425
- * requestBody: {
5426
- * // request body parameters
5427
- * // {
5428
- * // "dataFilters": [],
5429
- * // "includeGridData": false
5430
- * // }
5431
- * },
5432
- * });
5433
- * console.log(res.data);
5434
- *
5435
- * // Example response
5436
- * // {
5437
- * // "dataSourceSchedules": [],
5438
- * // "dataSources": [],
5439
- * // "developerMetadata": [],
5440
- * // "namedRanges": [],
5441
- * // "properties": {},
5442
- * // "sheets": [],
5443
- * // "spreadsheetId": "my_spreadsheetId",
5444
- * // "spreadsheetUrl": "my_spreadsheetUrl"
5445
- * // }
5446
- * }
5447
- *
5448
- * main().catch(e => {
5449
- * console.error(e);
5450
- * throw e;
5451
- * });
5452
- *
5453
- * ```
5454
5209
  *
5455
5210
  * @param params - Parameters for request
5456
5211
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5590,58 +5345,6 @@ export namespace sheets_v4 {
5590
5345
 
5591
5346
  /**
5592
5347
  * Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId.
5593
- * @example
5594
- * ```js
5595
- * // Before running the sample:
5596
- * // - Enable the API at:
5597
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
5598
- * // - Login into gcloud by running:
5599
- * // `$ gcloud auth application-default login`
5600
- * // - Install the npm module by running:
5601
- * // `$ npm install googleapis`
5602
- *
5603
- * const {google} = require('googleapis');
5604
- * const sheets = google.sheets('v4');
5605
- *
5606
- * async function main() {
5607
- * const auth = new google.auth.GoogleAuth({
5608
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5609
- * scopes: [
5610
- * 'https://www.googleapis.com/auth/drive',
5611
- * 'https://www.googleapis.com/auth/drive.file',
5612
- * 'https://www.googleapis.com/auth/spreadsheets',
5613
- * ],
5614
- * });
5615
- *
5616
- * // Acquire an auth client, and bind it to all future calls
5617
- * const authClient = await auth.getClient();
5618
- * google.options({auth: authClient});
5619
- *
5620
- * // Do the magic
5621
- * const res = await sheets.spreadsheets.developerMetadata.get({
5622
- * // The ID of the developer metadata to retrieve.
5623
- * metadataId: 'placeholder-value',
5624
- * // The ID of the spreadsheet to retrieve metadata from.
5625
- * spreadsheetId: 'placeholder-value',
5626
- * });
5627
- * console.log(res.data);
5628
- *
5629
- * // Example response
5630
- * // {
5631
- * // "location": {},
5632
- * // "metadataId": 0,
5633
- * // "metadataKey": "my_metadataKey",
5634
- * // "metadataValue": "my_metadataValue",
5635
- * // "visibility": "my_visibility"
5636
- * // }
5637
- * }
5638
- *
5639
- * main().catch(e => {
5640
- * console.error(e);
5641
- * throw e;
5642
- * });
5643
- *
5644
- * ```
5645
5348
  *
5646
5349
  * @param params - Parameters for request
5647
5350
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5732,60 +5435,6 @@ export namespace sheets_v4 {
5732
5435
 
5733
5436
  /**
5734
5437
  * Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.
5735
- * @example
5736
- * ```js
5737
- * // Before running the sample:
5738
- * // - Enable the API at:
5739
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
5740
- * // - Login into gcloud by running:
5741
- * // `$ gcloud auth application-default login`
5742
- * // - Install the npm module by running:
5743
- * // `$ npm install googleapis`
5744
- *
5745
- * const {google} = require('googleapis');
5746
- * const sheets = google.sheets('v4');
5747
- *
5748
- * async function main() {
5749
- * const auth = new google.auth.GoogleAuth({
5750
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5751
- * scopes: [
5752
- * 'https://www.googleapis.com/auth/drive',
5753
- * 'https://www.googleapis.com/auth/drive.file',
5754
- * 'https://www.googleapis.com/auth/spreadsheets',
5755
- * ],
5756
- * });
5757
- *
5758
- * // Acquire an auth client, and bind it to all future calls
5759
- * const authClient = await auth.getClient();
5760
- * google.options({auth: authClient});
5761
- *
5762
- * // Do the magic
5763
- * const res = await sheets.spreadsheets.developerMetadata.search({
5764
- * // The ID of the spreadsheet to retrieve metadata from.
5765
- * spreadsheetId: 'placeholder-value',
5766
- *
5767
- * // Request body metadata
5768
- * requestBody: {
5769
- * // request body parameters
5770
- * // {
5771
- * // "dataFilters": []
5772
- * // }
5773
- * },
5774
- * });
5775
- * console.log(res.data);
5776
- *
5777
- * // Example response
5778
- * // {
5779
- * // "matchedDeveloperMetadata": []
5780
- * // }
5781
- * }
5782
- *
5783
- * main().catch(e => {
5784
- * console.error(e);
5785
- * throw e;
5786
- * });
5787
- *
5788
- * ```
5789
5438
  *
5790
5439
  * @param params - Parameters for request
5791
5440
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5913,71 +5562,6 @@ export namespace sheets_v4 {
5913
5562
 
5914
5563
  /**
5915
5564
  * Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.
5916
- * @example
5917
- * ```js
5918
- * // Before running the sample:
5919
- * // - Enable the API at:
5920
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
5921
- * // - Login into gcloud by running:
5922
- * // `$ gcloud auth application-default login`
5923
- * // - Install the npm module by running:
5924
- * // `$ npm install googleapis`
5925
- *
5926
- * const {google} = require('googleapis');
5927
- * const sheets = google.sheets('v4');
5928
- *
5929
- * async function main() {
5930
- * const auth = new google.auth.GoogleAuth({
5931
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5932
- * scopes: [
5933
- * 'https://www.googleapis.com/auth/drive',
5934
- * 'https://www.googleapis.com/auth/drive.file',
5935
- * 'https://www.googleapis.com/auth/spreadsheets',
5936
- * ],
5937
- * });
5938
- *
5939
- * // Acquire an auth client, and bind it to all future calls
5940
- * const authClient = await auth.getClient();
5941
- * google.options({auth: authClient});
5942
- *
5943
- * // Do the magic
5944
- * const res = await sheets.spreadsheets.sheets.copyTo({
5945
- * // The ID of the sheet to copy.
5946
- * sheetId: 'placeholder-value',
5947
- * // The ID of the spreadsheet containing the sheet to copy.
5948
- * spreadsheetId: 'placeholder-value',
5949
- *
5950
- * // Request body metadata
5951
- * requestBody: {
5952
- * // request body parameters
5953
- * // {
5954
- * // "destinationSpreadsheetId": "my_destinationSpreadsheetId"
5955
- * // }
5956
- * },
5957
- * });
5958
- * console.log(res.data);
5959
- *
5960
- * // Example response
5961
- * // {
5962
- * // "dataSourceSheetProperties": {},
5963
- * // "gridProperties": {},
5964
- * // "hidden": false,
5965
- * // "index": 0,
5966
- * // "rightToLeft": false,
5967
- * // "sheetId": 0,
5968
- * // "sheetType": "my_sheetType",
5969
- * // "tabColor": {},
5970
- * // "tabColorStyle": {},
5971
- * // "title": "my_title"
5972
- * // }
5973
- * }
5974
- *
5975
- * main().catch(e => {
5976
- * console.error(e);
5977
- * throw e;
5978
- * });
5979
- *
5980
- * ```
5981
5565
  *
5982
5566
  * @param params - Parameters for request
5983
5567
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6089,76 +5673,6 @@ export namespace sheets_v4 {
6089
5673
 
6090
5674
  /**
6091
5675
  * Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.
6092
- * @example
6093
- * ```js
6094
- * // Before running the sample:
6095
- * // - Enable the API at:
6096
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
6097
- * // - Login into gcloud by running:
6098
- * // `$ gcloud auth application-default login`
6099
- * // - Install the npm module by running:
6100
- * // `$ npm install googleapis`
6101
- *
6102
- * const {google} = require('googleapis');
6103
- * const sheets = google.sheets('v4');
6104
- *
6105
- * async function main() {
6106
- * const auth = new google.auth.GoogleAuth({
6107
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6108
- * scopes: [
6109
- * 'https://www.googleapis.com/auth/drive',
6110
- * 'https://www.googleapis.com/auth/drive.file',
6111
- * 'https://www.googleapis.com/auth/spreadsheets',
6112
- * ],
6113
- * });
6114
- *
6115
- * // Acquire an auth client, and bind it to all future calls
6116
- * const authClient = await auth.getClient();
6117
- * google.options({auth: authClient});
6118
- *
6119
- * // Do the magic
6120
- * const res = await sheets.spreadsheets.values.append({
6121
- * // Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.
6122
- * includeValuesInResponse: 'placeholder-value',
6123
- * // How the input data should be inserted.
6124
- * insertDataOption: 'placeholder-value',
6125
- * // The [A1 notation](/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.
6126
- * range: 'placeholder-value',
6127
- * // 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 SERIAL_NUMBER.
6128
- * responseDateTimeRenderOption: 'placeholder-value',
6129
- * // Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
6130
- * responseValueRenderOption: 'placeholder-value',
6131
- * // The ID of the spreadsheet to update.
6132
- * spreadsheetId: 'placeholder-value',
6133
- * // How the input data should be interpreted.
6134
- * valueInputOption: 'placeholder-value',
6135
- *
6136
- * // Request body metadata
6137
- * requestBody: {
6138
- * // request body parameters
6139
- * // {
6140
- * // "majorDimension": "my_majorDimension",
6141
- * // "range": "my_range",
6142
- * // "values": []
6143
- * // }
6144
- * },
6145
- * });
6146
- * console.log(res.data);
6147
- *
6148
- * // Example response
6149
- * // {
6150
- * // "spreadsheetId": "my_spreadsheetId",
6151
- * // "tableRange": "my_tableRange",
6152
- * // "updates": {}
6153
- * // }
6154
- * }
6155
- *
6156
- * main().catch(e => {
6157
- * console.error(e);
6158
- * throw e;
6159
- * });
6160
- *
6161
- * ```
6162
5676
  *
6163
5677
  * @param params - Parameters for request
6164
5678
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6250,61 +5764,6 @@ export namespace sheets_v4 {
6250
5764
 
6251
5765
  /**
6252
5766
  * Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept.
6253
- * @example
6254
- * ```js
6255
- * // Before running the sample:
6256
- * // - Enable the API at:
6257
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
6258
- * // - Login into gcloud by running:
6259
- * // `$ gcloud auth application-default login`
6260
- * // - Install the npm module by running:
6261
- * // `$ npm install googleapis`
6262
- *
6263
- * const {google} = require('googleapis');
6264
- * const sheets = google.sheets('v4');
6265
- *
6266
- * async function main() {
6267
- * const auth = new google.auth.GoogleAuth({
6268
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6269
- * scopes: [
6270
- * 'https://www.googleapis.com/auth/drive',
6271
- * 'https://www.googleapis.com/auth/drive.file',
6272
- * 'https://www.googleapis.com/auth/spreadsheets',
6273
- * ],
6274
- * });
6275
- *
6276
- * // Acquire an auth client, and bind it to all future calls
6277
- * const authClient = await auth.getClient();
6278
- * google.options({auth: authClient});
6279
- *
6280
- * // Do the magic
6281
- * const res = await sheets.spreadsheets.values.batchClear({
6282
- * // The ID of the spreadsheet to update.
6283
- * spreadsheetId: 'placeholder-value',
6284
- *
6285
- * // Request body metadata
6286
- * requestBody: {
6287
- * // request body parameters
6288
- * // {
6289
- * // "ranges": []
6290
- * // }
6291
- * },
6292
- * });
6293
- * console.log(res.data);
6294
- *
6295
- * // Example response
6296
- * // {
6297
- * // "clearedRanges": [],
6298
- * // "spreadsheetId": "my_spreadsheetId"
6299
- * // }
6300
- * }
6301
- *
6302
- * main().catch(e => {
6303
- * console.error(e);
6304
- * throw e;
6305
- * });
6306
- *
6307
- * ```
6308
5767
  *
6309
5768
  * @param params - Parameters for request
6310
5769
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6398,61 +5857,6 @@ export namespace sheets_v4 {
6398
5857
 
6399
5858
  /**
6400
5859
  * Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
6401
- * @example
6402
- * ```js
6403
- * // Before running the sample:
6404
- * // - Enable the API at:
6405
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
6406
- * // - Login into gcloud by running:
6407
- * // `$ gcloud auth application-default login`
6408
- * // - Install the npm module by running:
6409
- * // `$ npm install googleapis`
6410
- *
6411
- * const {google} = require('googleapis');
6412
- * const sheets = google.sheets('v4');
6413
- *
6414
- * async function main() {
6415
- * const auth = new google.auth.GoogleAuth({
6416
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6417
- * scopes: [
6418
- * 'https://www.googleapis.com/auth/drive',
6419
- * 'https://www.googleapis.com/auth/drive.file',
6420
- * 'https://www.googleapis.com/auth/spreadsheets',
6421
- * ],
6422
- * });
6423
- *
6424
- * // Acquire an auth client, and bind it to all future calls
6425
- * const authClient = await auth.getClient();
6426
- * google.options({auth: authClient});
6427
- *
6428
- * // Do the magic
6429
- * const res = await sheets.spreadsheets.values.batchClearByDataFilter({
6430
- * // The ID of the spreadsheet to update.
6431
- * spreadsheetId: 'placeholder-value',
6432
- *
6433
- * // Request body metadata
6434
- * requestBody: {
6435
- * // request body parameters
6436
- * // {
6437
- * // "dataFilters": []
6438
- * // }
6439
- * },
6440
- * });
6441
- * console.log(res.data);
6442
- *
6443
- * // Example response
6444
- * // {
6445
- * // "clearedRanges": [],
6446
- * // "spreadsheetId": "my_spreadsheetId"
6447
- * // }
6448
- * }
6449
- *
6450
- * main().catch(e => {
6451
- * console.error(e);
6452
- * throw e;
6453
- * });
6454
- *
6455
- * ```
6456
5860
  *
6457
5861
  * @param params - Parameters for request
6458
5862
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6550,63 +5954,6 @@ export namespace sheets_v4 {
6550
5954
 
6551
5955
  /**
6552
5956
  * Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.
6553
- * @example
6554
- * ```js
6555
- * // Before running the sample:
6556
- * // - Enable the API at:
6557
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
6558
- * // - Login into gcloud by running:
6559
- * // `$ gcloud auth application-default login`
6560
- * // - Install the npm module by running:
6561
- * // `$ npm install googleapis`
6562
- *
6563
- * const {google} = require('googleapis');
6564
- * const sheets = google.sheets('v4');
6565
- *
6566
- * async function main() {
6567
- * const auth = new google.auth.GoogleAuth({
6568
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6569
- * scopes: [
6570
- * 'https://www.googleapis.com/auth/drive',
6571
- * 'https://www.googleapis.com/auth/drive.file',
6572
- * 'https://www.googleapis.com/auth/drive.readonly',
6573
- * 'https://www.googleapis.com/auth/spreadsheets',
6574
- * 'https://www.googleapis.com/auth/spreadsheets.readonly',
6575
- * ],
6576
- * });
6577
- *
6578
- * // Acquire an auth client, and bind it to all future calls
6579
- * const authClient = await auth.getClient();
6580
- * google.options({auth: authClient});
6581
- *
6582
- * // Do the magic
6583
- * const res = await sheets.spreadsheets.values.batchGet({
6584
- * // 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 SERIAL_NUMBER.
6585
- * dateTimeRenderOption: 'placeholder-value',
6586
- * // The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=["A1:B2"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=["A1:B2"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
6587
- * majorDimension: 'placeholder-value',
6588
- * // The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.
6589
- * ranges: 'placeholder-value',
6590
- * // The ID of the spreadsheet to retrieve data from.
6591
- * spreadsheetId: 'placeholder-value',
6592
- * // How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
6593
- * valueRenderOption: 'placeholder-value',
6594
- * });
6595
- * console.log(res.data);
6596
- *
6597
- * // Example response
6598
- * // {
6599
- * // "spreadsheetId": "my_spreadsheetId",
6600
- * // "valueRanges": []
6601
- * // }
6602
- * }
6603
- *
6604
- * main().catch(e => {
6605
- * console.error(e);
6606
- * throw e;
6607
- * });
6608
- *
6609
- * ```
6610
5957
  *
6611
5958
  * @param params - Parameters for request
6612
5959
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6700,64 +6047,6 @@ export namespace sheets_v4 {
6700
6047
 
6701
6048
  /**
6702
6049
  * Returns one or more ranges of values that match the specified data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.
6703
- * @example
6704
- * ```js
6705
- * // Before running the sample:
6706
- * // - Enable the API at:
6707
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
6708
- * // - Login into gcloud by running:
6709
- * // `$ gcloud auth application-default login`
6710
- * // - Install the npm module by running:
6711
- * // `$ npm install googleapis`
6712
- *
6713
- * const {google} = require('googleapis');
6714
- * const sheets = google.sheets('v4');
6715
- *
6716
- * async function main() {
6717
- * const auth = new google.auth.GoogleAuth({
6718
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6719
- * scopes: [
6720
- * 'https://www.googleapis.com/auth/drive',
6721
- * 'https://www.googleapis.com/auth/drive.file',
6722
- * 'https://www.googleapis.com/auth/spreadsheets',
6723
- * ],
6724
- * });
6725
- *
6726
- * // Acquire an auth client, and bind it to all future calls
6727
- * const authClient = await auth.getClient();
6728
- * google.options({auth: authClient});
6729
- *
6730
- * // Do the magic
6731
- * const res = await sheets.spreadsheets.values.batchGetByDataFilter({
6732
- * // The ID of the spreadsheet to retrieve data from.
6733
- * spreadsheetId: 'placeholder-value',
6734
- *
6735
- * // Request body metadata
6736
- * requestBody: {
6737
- * // request body parameters
6738
- * // {
6739
- * // "dataFilters": [],
6740
- * // "dateTimeRenderOption": "my_dateTimeRenderOption",
6741
- * // "majorDimension": "my_majorDimension",
6742
- * // "valueRenderOption": "my_valueRenderOption"
6743
- * // }
6744
- * },
6745
- * });
6746
- * console.log(res.data);
6747
- *
6748
- * // Example response
6749
- * // {
6750
- * // "spreadsheetId": "my_spreadsheetId",
6751
- * // "valueRanges": []
6752
- * // }
6753
- * }
6754
- *
6755
- * main().catch(e => {
6756
- * console.error(e);
6757
- * throw e;
6758
- * });
6759
- *
6760
- * ```
6761
6050
  *
6762
6051
  * @param params - Parameters for request
6763
6052
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6854,69 +6143,6 @@ export namespace sheets_v4 {
6854
6143
 
6855
6144
  /**
6856
6145
  * Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.
6857
- * @example
6858
- * ```js
6859
- * // Before running the sample:
6860
- * // - Enable the API at:
6861
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
6862
- * // - Login into gcloud by running:
6863
- * // `$ gcloud auth application-default login`
6864
- * // - Install the npm module by running:
6865
- * // `$ npm install googleapis`
6866
- *
6867
- * const {google} = require('googleapis');
6868
- * const sheets = google.sheets('v4');
6869
- *
6870
- * async function main() {
6871
- * const auth = new google.auth.GoogleAuth({
6872
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6873
- * scopes: [
6874
- * 'https://www.googleapis.com/auth/drive',
6875
- * 'https://www.googleapis.com/auth/drive.file',
6876
- * 'https://www.googleapis.com/auth/spreadsheets',
6877
- * ],
6878
- * });
6879
- *
6880
- * // Acquire an auth client, and bind it to all future calls
6881
- * const authClient = await auth.getClient();
6882
- * google.options({auth: authClient});
6883
- *
6884
- * // Do the magic
6885
- * const res = await sheets.spreadsheets.values.batchUpdate({
6886
- * // The ID of the spreadsheet to update.
6887
- * spreadsheetId: 'placeholder-value',
6888
- *
6889
- * // Request body metadata
6890
- * requestBody: {
6891
- * // request body parameters
6892
- * // {
6893
- * // "data": [],
6894
- * // "includeValuesInResponse": false,
6895
- * // "responseDateTimeRenderOption": "my_responseDateTimeRenderOption",
6896
- * // "responseValueRenderOption": "my_responseValueRenderOption",
6897
- * // "valueInputOption": "my_valueInputOption"
6898
- * // }
6899
- * },
6900
- * });
6901
- * console.log(res.data);
6902
- *
6903
- * // Example response
6904
- * // {
6905
- * // "responses": [],
6906
- * // "spreadsheetId": "my_spreadsheetId",
6907
- * // "totalUpdatedCells": 0,
6908
- * // "totalUpdatedColumns": 0,
6909
- * // "totalUpdatedRows": 0,
6910
- * // "totalUpdatedSheets": 0
6911
- * // }
6912
- * }
6913
- *
6914
- * main().catch(e => {
6915
- * console.error(e);
6916
- * throw e;
6917
- * });
6918
- *
6919
- * ```
6920
6146
  *
6921
6147
  * @param params - Parameters for request
6922
6148
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7010,69 +6236,6 @@ export namespace sheets_v4 {
7010
6236
 
7011
6237
  /**
7012
6238
  * Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.
7013
- * @example
7014
- * ```js
7015
- * // Before running the sample:
7016
- * // - Enable the API at:
7017
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
7018
- * // - Login into gcloud by running:
7019
- * // `$ gcloud auth application-default login`
7020
- * // - Install the npm module by running:
7021
- * // `$ npm install googleapis`
7022
- *
7023
- * const {google} = require('googleapis');
7024
- * const sheets = google.sheets('v4');
7025
- *
7026
- * async function main() {
7027
- * const auth = new google.auth.GoogleAuth({
7028
- * // Scopes can be specified either as an array or as a single, space-delimited string.
7029
- * scopes: [
7030
- * 'https://www.googleapis.com/auth/drive',
7031
- * 'https://www.googleapis.com/auth/drive.file',
7032
- * 'https://www.googleapis.com/auth/spreadsheets',
7033
- * ],
7034
- * });
7035
- *
7036
- * // Acquire an auth client, and bind it to all future calls
7037
- * const authClient = await auth.getClient();
7038
- * google.options({auth: authClient});
7039
- *
7040
- * // Do the magic
7041
- * const res = await sheets.spreadsheets.values.batchUpdateByDataFilter({
7042
- * // The ID of the spreadsheet to update.
7043
- * spreadsheetId: 'placeholder-value',
7044
- *
7045
- * // Request body metadata
7046
- * requestBody: {
7047
- * // request body parameters
7048
- * // {
7049
- * // "data": [],
7050
- * // "includeValuesInResponse": false,
7051
- * // "responseDateTimeRenderOption": "my_responseDateTimeRenderOption",
7052
- * // "responseValueRenderOption": "my_responseValueRenderOption",
7053
- * // "valueInputOption": "my_valueInputOption"
7054
- * // }
7055
- * },
7056
- * });
7057
- * console.log(res.data);
7058
- *
7059
- * // Example response
7060
- * // {
7061
- * // "responses": [],
7062
- * // "spreadsheetId": "my_spreadsheetId",
7063
- * // "totalUpdatedCells": 0,
7064
- * // "totalUpdatedColumns": 0,
7065
- * // "totalUpdatedRows": 0,
7066
- * // "totalUpdatedSheets": 0
7067
- * // }
7068
- * }
7069
- *
7070
- * main().catch(e => {
7071
- * console.error(e);
7072
- * throw e;
7073
- * });
7074
- *
7075
- * ```
7076
6239
  *
7077
6240
  * @param params - Parameters for request
7078
6241
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7170,61 +6333,6 @@ export namespace sheets_v4 {
7170
6333
 
7171
6334
  /**
7172
6335
  * Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
7173
- * @example
7174
- * ```js
7175
- * // Before running the sample:
7176
- * // - Enable the API at:
7177
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
7178
- * // - Login into gcloud by running:
7179
- * // `$ gcloud auth application-default login`
7180
- * // - Install the npm module by running:
7181
- * // `$ npm install googleapis`
7182
- *
7183
- * const {google} = require('googleapis');
7184
- * const sheets = google.sheets('v4');
7185
- *
7186
- * async function main() {
7187
- * const auth = new google.auth.GoogleAuth({
7188
- * // Scopes can be specified either as an array or as a single, space-delimited string.
7189
- * scopes: [
7190
- * 'https://www.googleapis.com/auth/drive',
7191
- * 'https://www.googleapis.com/auth/drive.file',
7192
- * 'https://www.googleapis.com/auth/spreadsheets',
7193
- * ],
7194
- * });
7195
- *
7196
- * // Acquire an auth client, and bind it to all future calls
7197
- * const authClient = await auth.getClient();
7198
- * google.options({auth: authClient});
7199
- *
7200
- * // Do the magic
7201
- * const res = await sheets.spreadsheets.values.clear({
7202
- * // The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear.
7203
- * range: 'placeholder-value',
7204
- * // The ID of the spreadsheet to update.
7205
- * spreadsheetId: 'placeholder-value',
7206
- *
7207
- * // Request body metadata
7208
- * requestBody: {
7209
- * // request body parameters
7210
- * // {}
7211
- * },
7212
- * });
7213
- * console.log(res.data);
7214
- *
7215
- * // Example response
7216
- * // {
7217
- * // "clearedRange": "my_clearedRange",
7218
- * // "spreadsheetId": "my_spreadsheetId"
7219
- * // }
7220
- * }
7221
- *
7222
- * main().catch(e => {
7223
- * console.error(e);
7224
- * throw e;
7225
- * });
7226
- *
7227
- * ```
7228
6336
  *
7229
6337
  * @param params - Parameters for request
7230
6338
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7314,64 +6422,6 @@ export namespace sheets_v4 {
7314
6422
 
7315
6423
  /**
7316
6424
  * Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.
7317
- * @example
7318
- * ```js
7319
- * // Before running the sample:
7320
- * // - Enable the API at:
7321
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
7322
- * // - Login into gcloud by running:
7323
- * // `$ gcloud auth application-default login`
7324
- * // - Install the npm module by running:
7325
- * // `$ npm install googleapis`
7326
- *
7327
- * const {google} = require('googleapis');
7328
- * const sheets = google.sheets('v4');
7329
- *
7330
- * async function main() {
7331
- * const auth = new google.auth.GoogleAuth({
7332
- * // Scopes can be specified either as an array or as a single, space-delimited string.
7333
- * scopes: [
7334
- * 'https://www.googleapis.com/auth/drive',
7335
- * 'https://www.googleapis.com/auth/drive.file',
7336
- * 'https://www.googleapis.com/auth/drive.readonly',
7337
- * 'https://www.googleapis.com/auth/spreadsheets',
7338
- * 'https://www.googleapis.com/auth/spreadsheets.readonly',
7339
- * ],
7340
- * });
7341
- *
7342
- * // Acquire an auth client, and bind it to all future calls
7343
- * const authClient = await auth.getClient();
7344
- * google.options({auth: authClient});
7345
- *
7346
- * // Do the magic
7347
- * const res = await sheets.spreadsheets.values.get({
7348
- * // 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 SERIAL_NUMBER.
7349
- * dateTimeRenderOption: 'placeholder-value',
7350
- * // The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
7351
- * majorDimension: 'placeholder-value',
7352
- * // The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.
7353
- * range: 'placeholder-value',
7354
- * // The ID of the spreadsheet to retrieve data from.
7355
- * spreadsheetId: 'placeholder-value',
7356
- * // How values should be represented in the output. The default render option is FORMATTED_VALUE.
7357
- * valueRenderOption: 'placeholder-value',
7358
- * });
7359
- * console.log(res.data);
7360
- *
7361
- * // Example response
7362
- * // {
7363
- * // "majorDimension": "my_majorDimension",
7364
- * // "range": "my_range",
7365
- * // "values": []
7366
- * // }
7367
- * }
7368
- *
7369
- * main().catch(e => {
7370
- * console.error(e);
7371
- * throw e;
7372
- * });
7373
- *
7374
- * ```
7375
6425
  *
7376
6426
  * @param params - Parameters for request
7377
6427
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -7458,77 +6508,6 @@ export namespace sheets_v4 {
7458
6508
 
7459
6509
  /**
7460
6510
  * Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.
7461
- * @example
7462
- * ```js
7463
- * // Before running the sample:
7464
- * // - Enable the API at:
7465
- * // https://console.developers.google.com/apis/api/sheets.googleapis.com
7466
- * // - Login into gcloud by running:
7467
- * // `$ gcloud auth application-default login`
7468
- * // - Install the npm module by running:
7469
- * // `$ npm install googleapis`
7470
- *
7471
- * const {google} = require('googleapis');
7472
- * const sheets = google.sheets('v4');
7473
- *
7474
- * async function main() {
7475
- * const auth = new google.auth.GoogleAuth({
7476
- * // Scopes can be specified either as an array or as a single, space-delimited string.
7477
- * scopes: [
7478
- * 'https://www.googleapis.com/auth/drive',
7479
- * 'https://www.googleapis.com/auth/drive.file',
7480
- * 'https://www.googleapis.com/auth/spreadsheets',
7481
- * ],
7482
- * });
7483
- *
7484
- * // Acquire an auth client, and bind it to all future calls
7485
- * const authClient = await auth.getClient();
7486
- * google.options({auth: authClient});
7487
- *
7488
- * // Do the magic
7489
- * const res = await sheets.spreadsheets.values.update({
7490
- * // 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 the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).
7491
- * includeValuesInResponse: 'placeholder-value',
7492
- * // The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.
7493
- * range: 'placeholder-value',
7494
- * // 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 SERIAL_NUMBER.
7495
- * responseDateTimeRenderOption: 'placeholder-value',
7496
- * // Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
7497
- * responseValueRenderOption: 'placeholder-value',
7498
- * // The ID of the spreadsheet to update.
7499
- * spreadsheetId: 'placeholder-value',
7500
- * // How the input data should be interpreted.
7501
- * valueInputOption: 'placeholder-value',
7502
- *
7503
- * // Request body metadata
7504
- * requestBody: {
7505
- * // request body parameters
7506
- * // {
7507
- * // "majorDimension": "my_majorDimension",
7508
- * // "range": "my_range",
7509
- * // "values": []
7510
- * // }
7511
- * },
7512
- * });
7513
- * console.log(res.data);
7514
- *
7515
- * // Example response
7516
- * // {
7517
- * // "spreadsheetId": "my_spreadsheetId",
7518
- * // "updatedCells": 0,
7519
- * // "updatedColumns": 0,
7520
- * // "updatedData": {},
7521
- * // "updatedRange": "my_updatedRange",
7522
- * // "updatedRows": 0
7523
- * // }
7524
- * }
7525
- *
7526
- * main().catch(e => {
7527
- * console.error(e);
7528
- * throw e;
7529
- * });
7530
- *
7531
- * ```
7532
6511
  *
7533
6512
  * @param params - Parameters for request
7534
6513
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.